fizzy-sdk 0.1.0

data/scripts/generate-types.rb

@@ -0,0 +1,160 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Generates Ruby type stubs from OpenAPI schema definitions.
+#
+# Usage: ruby scripts/generate-types.rb [--openapi ../openapi.json] [--output lib/fizzy/generated/types.rb]
+#
+# Produces a types.rb file with:
+# - Struct-based domain types for each schema
+# - Nested type support for composed schemas
+# - Documentation from OpenAPI descriptions
+
+require "json"
+require "fileutils"
+
+# Generates Ruby type stubs from OpenAPI schema definitions.
+class TypeGenerator
+  def initialize(openapi_path)
+    @openapi = JSON.parse(File.read(openapi_path))
+    @schemas = @openapi.dig("components", "schemas") || {}
+  end
+
+  def generate(output_path)
+    FileUtils.mkdir_p(File.dirname(output_path))
+
+    lines = []
+    lines << "# frozen_string_literal: true"
+    lines << ""
+    lines << "# @generated from OpenAPI spec — do not edit by hand"
+    lines << "#"
+    lines << "# These types provide structured access to API response data."
+    lines << "# Each type is a Data.define (Ruby 3.2+) with keyword initialization."
+    lines << ""
+    lines << "module Fizzy"
+    lines << "  module Types"
+
+    sorted_schemas.each do |name, schema|
+      next if internal_schema?(name)
+
+      type_lines = generate_type(name, schema)
+      type_lines.each { |l| lines << "    #{l}" }
+      lines << ""
+    end
+
+    lines << "  end"
+    lines << "end"
+    lines << ""
+
+    File.write(output_path, lines.join("\n"))
+    puts "Generated #{output_path} (#{sorted_schemas.count { |n, _| !internal_schema?(n) }} types)"
+  end
+
+  private
+
+  def sorted_schemas
+    @schemas.sort_by { |name, _| name }
+  end
+
+  def internal_schema?(name)
+    name.end_with?("Input", "Request") || name.start_with?("__")
+  end
+
+  def generate_type(name, schema)
+    lines = []
+    properties = schema["properties"] || {}
+    required_fields = schema["required"] || []
+    description = schema["description"]
+
+    lines << "# #{description}" if description
+    lines << "# @generated"
+
+    fields = properties.map do |field_name, field_schema|
+      ruby_name = to_snake_case(field_name)
+      ruby_type = schema_to_ruby_type(field_schema)
+      required = required_fields.include?(field_name)
+      { name: ruby_name, json_name: field_name, type: ruby_type, required: required, \
+        description: field_schema["description"] }
+    end
+
+    if fields.empty?
+      lines << "#{name} = Data.define"
+      return lines
+    end
+
+    field_names = fields.map { |f| ":#{f[:name]}" }.join(", ")
+    lines << "#{name} = Data.define(#{field_names}) do"
+
+    lines << "  # @param data [Hash] raw JSON response"
+    lines << "  def self.from_json(data)"
+    lines << "    new("
+
+    fields.each_with_index do |f, i|
+      comma = i < fields.length - 1 ? "," : ""
+      accessor = "data[\"#{f[:json_name]}\"]"
+      lines << "      #{f[:name]}: #{accessor}#{comma}"
+    end
+
+    lines << "    )"
+    lines << "  end"
+    lines << "end"
+
+    lines
+  end
+
+  def schema_to_ruby_type(schema)
+    return "Object" unless schema
+
+    if schema["$ref"]
+      ref_name = schema["$ref"].split("/").last
+      return ref_name
+    end
+
+    case schema["type"]
+    when "integer" then "Integer"
+    when "number" then "Float"
+    when "boolean" then "Boolean"
+    when "array"
+      item_type = schema_to_ruby_type(schema["items"])
+      "Array<#{item_type}>"
+    when "object" then "Hash"
+    else "String"
+    end
+  end
+
+  def to_snake_case(str)
+    str.gsub(/([a-z\d])([A-Z])/, '\1_\2')
+       .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+       .downcase
+  end
+end
+
+if __FILE__ == $PROGRAM_NAME
+  openapi_path = nil
+  output_path = nil
+
+  i = 0
+  while i < ARGV.length
+    case ARGV[i]
+    when "--openapi"
+      openapi_path = ARGV[i + 1]
+      i += 2
+    when "--output"
+      output_path = ARGV[i + 1]
+      i += 2
+    else
+      i += 1
+    end
+  end
+
+  openapi_path ||= File.expand_path("../../openapi.json", __dir__)
+  output_path ||= File.expand_path("../lib/fizzy/generated/types.rb", __dir__)
+
+  unless File.exist?(openapi_path)
+    warn "Error: OpenAPI file not found: #{openapi_path}"
+    exit 1
+  end
+
+  generator = TypeGenerator.new(openapi_path)
+  generator.generate(output_path)
+end

metadata

@@ -0,0 +1,252 @@
+--- !ruby/object:Gem::Specification
+name: fizzy-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Basecamp
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-37signals
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A Ruby SDK for the Fizzy API with automatic retry, exponential backoff,
+  Link header pagination, and observability hooks.
+email:
+- support@basecamp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Rakefile
+- fizzy-sdk.gemspec
+- lib/fizzy.rb
+- lib/fizzy/auth_strategy.rb
+- lib/fizzy/bulkhead.rb
+- lib/fizzy/cache.rb
+- lib/fizzy/chain_hooks.rb
+- lib/fizzy/circuit_breaker.rb
+- lib/fizzy/client.rb
+- lib/fizzy/config.rb
+- lib/fizzy/cookie_auth.rb
+- lib/fizzy/errors.rb
+- lib/fizzy/generated/metadata.json
+- lib/fizzy/generated/services/boards_service.rb
+- lib/fizzy/generated/services/cards_service.rb
+- lib/fizzy/generated/services/columns_service.rb
+- lib/fizzy/generated/services/comments_service.rb
+- lib/fizzy/generated/services/devices_service.rb
+- lib/fizzy/generated/services/identity_service.rb
+- lib/fizzy/generated/services/miscellaneous_service.rb
+- lib/fizzy/generated/services/notifications_service.rb
+- lib/fizzy/generated/services/pins_service.rb
+- lib/fizzy/generated/services/reactions_service.rb
+- lib/fizzy/generated/services/sessions_service.rb
+- lib/fizzy/generated/services/steps_service.rb
+- lib/fizzy/generated/services/tags_service.rb
+- lib/fizzy/generated/services/uploads_service.rb
+- lib/fizzy/generated/services/users_service.rb
+- lib/fizzy/generated/services/webhooks_service.rb
+- lib/fizzy/generated/types.rb
+- lib/fizzy/hooks.rb
+- lib/fizzy/http.rb
+- lib/fizzy/logger_hooks.rb
+- lib/fizzy/magic_link_flow.rb
+- lib/fizzy/noop_hooks.rb
+- lib/fizzy/operation_info.rb
+- lib/fizzy/rate_limiter.rb
+- lib/fizzy/request_info.rb
+- lib/fizzy/request_result.rb
+- lib/fizzy/resilience.rb
+- lib/fizzy/security.rb
+- lib/fizzy/services/base_service.rb
+- lib/fizzy/static_token_provider.rb
+- lib/fizzy/token_provider.rb
+- lib/fizzy/version.rb
+- lib/fizzy/webhooks/verify.rb
+- scripts/generate-metadata.rb
+- scripts/generate-services.rb
+- scripts/generate-types.rb
+homepage: https://github.com/basecamp/fizzy-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/basecamp/fizzy-sdk
+  source_code_uri: https://github.com/basecamp/fizzy-sdk
+  changelog_uri: https://github.com/basecamp/fizzy-sdk/releases
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Official Ruby SDK for the Fizzy API
+test_files: []