CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

[0.8.1] - 2024-07-22

• Fix: Nested hash types are recursively resolved in from_json such that they come back as true hashes, as opposed to structs

• Fix: Pass through additional params from request options even if the original request did not have those types of params (ex: query parameters)

[0.8.0] - 2024-07-03

• Fix: Date snippets now wrap their examples in quotation marks to correctly use .parse

[0.8.0-rc0] - 2024-07-01

• Improvement: allow users to specify additional dependencies and dev dependencies for Ruby SDKs. Example config:

  generators:
    - name: fernapi/fern-ruby-sdk
      config:
        extraDependencies:
          faraday-multipart:
            upperBound:
              version: "1.0.4"
              specifier: ">="
            lowerBound:
              version: "1.0"
              specifier: "~>"
        extraDevDependencies:
          dotenv: "2.1"
          faraday:
            upperBound:
              version: "0.17.3"
              specifier: ">"
            lowerBound:
              version: "0.20.0"

[0.7.0-rc5] - 2024-06-24

• Fix: additional fix for the same issue within 0.7.0-rc4 (regression introduced within the 0.7.0 RCs where the token prefix was dropped from requests).

[0.7.0-rc4] - 2024-06-24

• Fix: fixes regression introduced within the 0.7.0 RCs where the token prefix was dropped from requests.

[0.7.0-rc3] - 2024-06-20

• Fix: service module path matches across LocationGenerator functions, this fixes a bug in the new flattenModuleStructure below where top level services module paths do not match between the class reference and the class definition.

[0.7.0-rc2] - 2024-06-20

• Fix: the ruby generator now nests types under a type module to avoid naming conflicts, this is behind a configuration flag

  generators:
    - name: fernapi/fern-ruby-sdk
      config:
        flattenModuleStructure: true

[0.7.0-rc1] - 2024-06-13

• Fix: nested loops leverage different variable names to deconflict
• Fix: nested loops do not call to_json prior to the subsequent loop

[0.7.0-rc0] - 2024-06-13

• Feature: The Ruby SDK now generates an OAuth client to automate token refresh.
• Fix: The Ruby SDK now no longer requires users specify literals in method signatures

[0.6.3] - 2024-05-27

• Fix: Generated SDK snippets now leverage the full function module path.

[0.6.2] - 2024-05-17

• Internal: The generator now uses the latest FDR SDK.

[0.6.1] - 2024-05-09

• No changes.

[0.6.1-rc0] - 2024-04-23

• Internal: Improve logging within the Ruby generator

[0.6.0-rc1] - 2024-04-12

• Fix: fix regression where sometimes the parsed_json variable would not be instantiated, and so there'd be a nil ref in the generated code

[0.6.0-rc0] - 2024-04-12

• Feature: Introduce code snippets and examples for Ruby SDKs.

[0.5.0-rc2] - 2024-04-12

• Fix: Call JSON.parse prior to iterating through an iterable response

[0.5.0-rc0] - 2024-04-09

• Improvement: Consumers of the SDK can now pass in a base URL override into the root client, as well as the request's RequestOptions

• Fix: this PR includes a number of typing annotation and cleanliness/QOL fixes.

[0.4.0] - 2024-04-08

• Improvement: The generators now create a rakefile to run any tests prefixed with test_ in the test directory. A step is also added to CI to run these test. The dummy test now running also provides a sanity check on the health of the build of the gem, even if no tests are added given the gem is imported.

[0.3.3] - 2024-03-22

• Internal: Shared generator notification and config parsing logic.

[0.3.2] - 2024-03-18

• Improvement: type bytes requests to also take in IO types, indicating to users that they may pass in a stream of bytes

[0.3.1] - 2024-03-12

• Fix: use strings instead of UUIDs, which are helper classes in Ruby

[0.3.0] - 2024-02-27

• Fix: Ensure the name passed into the 'X-Fern-SDK-Name' header is the name of the gem, not the client class

• Fix: If an envvar is specified as a fallback for an auth header, the SDK will now mark that parameter as optional to allow fallback to actually happen

• Fix: Generated yardoc now appropriately reflects the typehint of the value type in maps

[0.2.0] - 2024-02-20

• Improvement: Ruby enum construct now leverages class constants instead of hashes to support better autocomplete For example, previously enums would be constructed as:

  # operand.rb
  module SeedEnumClient
    OPERAND = { greater_than: ">", equal_to: "=", less_than: "less_than" }.freeze
  end
  
  # main.rb
  ...
  SeedEnum::OPERAND[:equal_to]

  and are now constructed as:

  # operand.rb
  module SeedEnumClient
    # Tests enum name and value can be
    # different.
    class Operand
      GREATER_THAN = ">"
      EQUAL_TO = "="
      LESS_THAN = "less_than"
    end
  end
  
  # main.rb
  ...
  SeedEnum::Operand::EQUAL_TO

• Improvement: Discriminated unions are no longer wrapped within a parent object, rather, any field or parameter that depends on a discriminated union now explicitly references the member types in support of better autocomplete.

• Improvement: Undiscriminated unions are no longer allowed as hashes as input to SDK functions, this is in support of better autocomplete as well.

• Feature: The generated Ruby SDKs now support idempotency headers, users may specify idempotency headers within the RequestOptions object:

  imdb = Imdb::Client(api_key: "...")
  
  request_options = IdempotencyRequestOptions.new(
    idempotency_key: "key",
    idempotency_expiration: 60
  )
  
  resp = imbd.ticket.purchase(id: "", request_options: request_options)

[0.1.1] - 2024-02-15

• Fix: ensure the Ruby generators do not have strict dependencies on the IR. The generators have been updated to allow non breaking changes for the IR and the Fern CLI to happen without issue.

[0.1.0-rc0] - 2024-02-12

• Improvement: loosen the Faraday dependencies within the generated SDKs, now we are supporting Faraday 1.x, while continuing to support the same upperbound (specifically supporting the latest major version as well).
• Release a minor version as the Ruby generator is now being used in beta!

[0.0.6] - 2024-02-09

• Improvement: license files are now specified within the gem config if they are provided

generators:
  - name: fernapi/fern-ruby-sdk
    version: 0.0.6
    github:
      repository: org/repo-name
      mode: pull-request
      license: MIT

• Improvement: we now create a Github workflow file for publishing the gem automatically, in the presence of a publishing configuration

generators:
  - name:
     output:  # <-- Publishing configuration
       location: rubygems
       api-key: ${API_KEY}
       package-name: "petstore"

[0.0.5] - 2024-02-06

• This release contains no changes to the API.

• Bug fixes:

  • Syntactic error in block parameter usage: we now ensure block parameters are the final parameter for functions
  • Add properties to subpackages: previously properties on subpackages were not being exposed
  • Ensure optional properties in from_json are only parsed if present

[0.0.4] - 2024-02-05

• This release contains no changes to the API.

• Bug fixes: ensures files are written at the gem name path over client name, and addresses string escaping on one of the Fern headers.

[0.0.3] - 2024-02-05

• This release contains no changes to the API.

• Bug fixes: addresses a number of typos and other issues previously contained within the generation code.

[0.0.2] - 2024-02-01

• Improvement: Consolidate imports into the main file for easier gem usage, as opposed to directly importing the specific file (e.g. require "fern" vs. require "fern/types/folder_a/object")

• Improvement: Added rubygems output block to generators.yml. To publish your ruby gem, setup your generators.ym like this:

# generators.yml

groups:
 - name: ...
    version: ...
    output:
       location: rubygems
       api-key: ${API_KEY}
       package-name: "petstore"

[0.0.1] - 2024-02-01

• Improvement: Support client generation (async and async) as well as most endpoint types (except streaming)

[0.0.0] - 2024-01-30

• Chore: Intialize this changelog