Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 10 additions & 0 deletions .fern/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"cliVersion": "5.91.0",
"generatorName": "fernapi/fern-ruby-sdk",
"generatorVersion": "1.21.1",
"originGitCommit": "c5976f4e10573f4dc0d26937222caeb948fce09e",
"originGitCommitIsDirty": false,
"invokedBy": "ci",
"requestedVersion": "3.0.0.alpha.0",
"ciProvider": "github"
}
21 changes: 21 additions & 0 deletions .github/workflows/sdk-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: SDK CI

on:
pull_request:
push:
branches: [main]

permissions:
contents: read

jobs:
build:
name: Build and validate
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ruby/setup-ruby@v1
with:
ruby-version: '3.3'
- run: ruby -e 'Dir["lib/**/*.rb"].each { |file| RubyVM::InstructionSequence.compile_file(file) }'
- run: gem build cloudpdf.gemspec --output /tmp/cloudpdf-ruby.gem
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.gem
103 changes: 103 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
plugins:
- rubocop-minitest

AllCops:
TargetRubyVersion: 3.3
NewCops: enable

Style/StringLiterals:
EnforcedStyle: double_quotes

Style/StringLiteralsInInterpolation:
EnforcedStyle: double_quotes

Style/AccessModifierDeclarations:
Enabled: false

Lint/ConstantDefinitionInBlock:
Enabled: false

Metrics/AbcSize:
Enabled: false

Metrics/BlockLength:
Enabled: false

Metrics/ClassLength:
Enabled: false

Metrics/MethodLength:
Enabled: false

Metrics/ParameterLists:
Enabled: false

Metrics/PerceivedComplexity:
Enabled: false

Metrics/CyclomaticComplexity:
Enabled: false

Metrics/ModuleLength:
Enabled: false

Layout/LineLength:
Enabled: false

Naming/VariableNumber:
EnforcedStyle: normalcase
Severity: warning

Style/Documentation:
Enabled: false

Style/Lambda:
EnforcedStyle: literal

Minitest/MultipleAssertions:
Enabled: false

Minitest/UselessAssertion:
Enabled: false

# Dynamic snippets are code samples for documentation, not standalone Ruby files.
Style/FrozenStringLiteralComment:
Exclude:
- "dynamic-snippets/**/*"

# Indent hash elements 2 spaces from the start of the enclosing line rather than
# aligning with the preceding paren or bracket. Generated code nests hashes inside
# arrays and method calls; the "consistent" style is more readable there.
Layout/FirstHashElementIndentation:
EnforcedStyle: consistent
Exclude:
- "dynamic-snippets/**/*"

# Match Layout/FirstHashElementIndentation: indent the first argument 2 spaces
# from the start of the method call's line, regardless of parenthesis position.
# Dynamic snippets are code samples, not standalone Ruby files; exclude them to
# keep this config symmetric with Layout/FirstHashElementIndentation above.
Layout/FirstArgumentIndentation:
EnforcedStyle: consistent
Exclude:
- "dynamic-snippets/**/*"

# The generator emits non-idiomatic class names (e.g. Get_With_Query, JSON_)
# derived from IR type names whose wire form contains underscores or digits.
# Rubocop never auto-corrected these (naming cops have no autocorrecter), so
# disabling the cop keeps CI green without changing customer output. Fixing at
# source would rename public types across every existing SDK and therefore
# requires a ruby-v2 major-version bump with a generator migration.
Naming/ClassAndModuleCamelCase:
Enabled: false

# Integer literals are emitted unformatted (e.g. 1000000, not 1_000_000).
# Rubocop has an autocorrecter for this cop, but the only caller of integer
# emission is the dynamic-snippets path, which feeds customer-facing surfaces:
# (1) snippet markdown in reference docs, (2) dynamic-snippets/*.rb sample
# files. Neither is rubocop-gated (markdown isn't Ruby, dynamic-snippets/**/*
# is excluded above), so formatting integers there would change docs/dashboard
# output without any rubocop benefit. Disabling the cop keeps integers raw
# everywhere and avoids customer-visible diffs.
Style/NumericLiterals:
Enabled: false
120 changes: 120 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
# Contributing

Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.

## Getting Started

### Prerequisites

- Ruby 3.0+
- Bundler

### Installation

Install the project dependencies:

```bash
bundle install
```

### Building

Build the gem:

```bash
gem build *.gemspec
```

### Testing

Run the test suite:

```bash
bundle exec rspec
```

### Linting and Formatting

Check code style:

```bash
bundle exec rubocop
```

Fix code style issues:

```bash
bundle exec rubocop -a
```

## About Generated Code

**Important**: Most files in this SDK are automatically generated by [Fern](https://buildwithfern.com) from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.

### Generated Files

The following directories contain generated code:
- `lib/` - API client classes and types
- Most Ruby files in the project

### How to Customize

If you need to customize the SDK, you have two options:

#### Option 1: Use `.fernignore`

For custom code that should persist across SDK regenerations:

1. Create a `.fernignore` file in the project root
2. Add file patterns for files you want to preserve (similar to `.gitignore` syntax)
3. Add your custom code to those files

Files listed in `.fernignore` will not be overwritten when the SDK is regenerated.

For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).

#### Option 2: Contribute to the Generator

If you want to change how code is generated for all users of this SDK:

1. The Ruby SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
2. Generator code is located at `generators/ruby-v2/`
3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
4. Submit a pull request with your changes to the generator

This approach is best for:
- Bug fixes in generated code
- New features that would benefit all users
- Improvements to code generation patterns

## Making Changes

### Workflow

1. Create a new branch for your changes
2. Make your modifications
3. Run tests to ensure nothing breaks: `bundle exec rspec`
4. Run linting: `bundle exec rubocop`
5. Build the gem: `gem build *.gemspec`
6. Commit your changes with a clear commit message
7. Push your branch and create a pull request

### Commit Messages

Write clear, descriptive commit messages that explain what changed and why.

### Code Style

This project uses RuboCop for code formatting. Run `bundle exec rubocop` before committing to ensure your code meets the project's style guidelines.

## Questions or Issues?

If you have questions or run into issues:

1. Check the [Fern documentation](https://buildwithfern.com)
2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
3. Open a new issue if your question hasn't been addressed

## License

By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
19 changes: 19 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# frozen_string_literal: true

source "https://rubygems.org"

gemspec

group :test, :development do
gem "minitest", "~> 5.16"
gem "minitest-rg"
gem "pry"
gem "rake", "~> 13.0"
gem "rubocop", "~> 1.21"
gem "rubocop-minitest"
gem "webmock"
end

# Load custom Gemfile configuration if it exists
custom_gemfile = File.join(__dir__, "Gemfile.custom")
eval_gemfile(custom_gemfile) if File.exist?(custom_gemfile)
14 changes: 14 additions & 0 deletions Gemfile.custom
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# frozen_string_literal: true

# Custom Gemfile configuration file
# This file is automatically loaded by the main Gemfile. You can add custom gems,
# groups, or other Gemfile configurations here. If you do make changes to this file,
# you will need to add it to the .fernignore file to prevent your changes from being
# overwritten by the generator.

# Example usage:
# group :test, :development do
# gem 'custom-gem', '~> 2.0'
# end

# Add your custom gem dependencies here
41 changes: 16 additions & 25 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
Copyright 2026 CloudPDF LTD

Licensed under the Apache License, Version 2.0 (the "License");
you may not use files in this distribution except in compliance with the License.
You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-----------------------------------------------------------------------

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
Expand Down Expand Up @@ -174,28 +190,3 @@
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Loading
Loading