basecamp-sdk 0.2.1

data/scripts/generate-types.rb

@@ -0,0 +1,191 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Generates Ruby type classes from OpenAPI schemas.
+# Creates classes with JSON serialization support.
+#
+# Usage: ruby scripts/ruby/generate-types.rb > lib/basecamp/generated/types.rb
+
+require 'json'
+require 'set'
+require 'time'
+
+# Schemas to skip (internal/generated response wrappers)
+SKIP_PATTERNS = [
+  /ResponseContent$/,
+  /RequestContent$/,
+  /InputPayload$/,
+  /ErrorResponseContent$/
+].freeze
+
+def header
+  <<~HEADER
+    # frozen_string_literal: true
+
+    # Auto-generated from OpenAPI spec. Do not edit manually.
+    # Generated: #{Time.now.utc.iso8601}
+
+    require "json"
+    require "time"
+  HEADER
+end
+
+def generate_helpers
+  <<~HELPERS
+
+    # Type conversion helpers
+    module TypeHelpers
+      module_function
+
+      def identity(value)
+        value
+      end
+
+      def parse_integer(value)
+        return nil if value.nil?
+        value.to_i
+      end
+
+      def parse_float(value)
+        return nil if value.nil?
+        value.to_f
+      end
+
+      def parse_boolean(value)
+        return nil if value.nil?
+        !!value
+      end
+
+      def parse_datetime(value)
+        return nil if value.nil?
+        return value if value.is_a?(Time)
+        Time.parse(value.to_s)
+      rescue ArgumentError
+        nil
+      end
+
+      def parse_type(value, type_name)
+        return nil if value.nil?
+        return value unless value.is_a?(Hash)
+
+        type_class = Basecamp::Types.const_get(type_name)
+        type_class.new(value)
+      rescue NameError
+        value
+      end
+
+      def parse_array(value, type_name)
+        return nil if value.nil?
+        return value unless value.is_a?(Array)
+
+        type_class = Basecamp::Types.const_get(type_name)
+        value.map { |item| item.is_a?(Hash) ? type_class.new(item) : item }
+      rescue NameError
+        value
+      end
+    end
+  HELPERS
+end
+
+# Main execution
+if __FILE__ == $PROGRAM_NAME
+  openapi_path = ARGV[0] || File.expand_path('../../openapi.json', __dir__)
+
+  unless File.exist?(openapi_path)
+    warn "Error: OpenAPI file not found: #{openapi_path}"
+    exit 1
+  end
+
+  puts header
+  puts generate_helpers
+  puts ''
+  puts 'module Basecamp'
+  puts '  module Types'
+  puts '    include TypeHelpers'
+
+  schemas = JSON.parse(File.read(openapi_path))['components']['schemas'] || {}
+  sorted = schemas.keys.sort
+
+  sorted.each do |name|
+    next if SKIP_PATTERNS.any? { |p| name.match?(p) }
+
+    schema = schemas[name]
+    next unless schema['type'] == 'object'
+
+    properties = schema['properties'] || {}
+    next if properties.empty?
+
+    required_fields = schema['required'] || []
+    required_set = required_fields.to_set
+
+    required_props = properties.keys.select { |k| required_set.include?(k) }.sort
+    optional_props = properties.keys.reject { |k| required_set.include?(k) }.sort
+    ordered_props = required_props + optional_props
+
+    puts ''
+    puts "    # #{name}"
+    puts "    class #{name}"
+    puts '      include TypeHelpers'
+
+    attr_names = ordered_props.map { |k| k.gsub(/([A-Z])/, '_\1').downcase.gsub(/^_/, '') }
+    puts "      attr_accessor #{attr_names.map { |n| ":#{n}" }.join(", ")}"
+
+    unless required_props.empty?
+      required_symbols = required_props.map { |k| k.gsub(/([A-Z])/, '_\1').downcase.gsub(/^_/, '') }
+      puts ''
+      puts '      # @return [Array<Symbol>]'
+      puts '      def self.required_fields'
+      puts "        %i[#{required_symbols.join(' ')}].freeze"
+      puts '      end'
+    end
+
+    puts ''
+
+    puts '      def initialize(data = {})'
+    ordered_props.each do |prop_name|
+      prop_schema = properties[prop_name]
+      attr_name = prop_name.gsub(/([A-Z])/, '_\1').downcase.gsub(/^_/, '')
+
+      converter = if prop_schema['$ref']
+                    ref_name = prop_schema['$ref'].split('/').last
+                    "parse_type(data[\"#{prop_name}\"], \"#{ref_name}\")"
+      elsif prop_schema['type'] == 'array' && prop_schema.dig('items', '$ref')
+                    ref_name = prop_schema['items']['$ref'].split('/').last
+                    "parse_array(data[\"#{prop_name}\"], \"#{ref_name}\")"
+      elsif prop_schema['type'] == 'integer'
+                    "parse_integer(data[\"#{prop_name}\"])"
+      elsif prop_schema['type'] == 'number'
+                    "parse_float(data[\"#{prop_name}\"])"
+      elsif prop_schema['type'] == 'boolean'
+                    "parse_boolean(data[\"#{prop_name}\"])"
+      elsif prop_schema['x-go-type'] == 'time.Time'
+                    "parse_datetime(data[\"#{prop_name}\"])"
+      else
+                    "data[\"#{prop_name}\"]"
+      end
+
+      puts "        @#{attr_name} = #{converter}"
+    end
+    puts '      end'
+    puts ''
+
+    puts '      def to_h'
+    puts '        {'
+    ordered_props.each do |prop_name|
+      attr_name = prop_name.gsub(/([A-Z])/, '_\1').downcase.gsub(/^_/, '')
+      puts "          \"#{prop_name}\" => @#{attr_name},"
+    end
+    puts '        }.compact'
+    puts '      end'
+    puts ''
+
+    puts '      def to_json(*args)'
+    puts '        to_h.to_json(*args)'
+    puts '      end'
+
+    puts '    end'
+  end
+
+  puts '  end'
+  puts 'end'
+end

metadata

@@ -0,0 +1,316 @@
+--- !ruby/object:Gem::Specification
+name: basecamp-sdk
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Basecamp
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-02-28 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 Basecamp API with automatic retry, exponential backoff,
+  Link header pagination, and observability hooks.
+email:
+- support@basecamp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".yardopts"
+- README.md
+- Rakefile
+- basecamp-sdk.gemspec
+- lib/basecamp.rb
+- lib/basecamp/auth_strategy.rb
+- lib/basecamp/chain_hooks.rb
+- lib/basecamp/client.rb
+- lib/basecamp/config.rb
+- lib/basecamp/errors.rb
+- lib/basecamp/generated/metadata.json
+- lib/basecamp/generated/services/attachments_service.rb
+- lib/basecamp/generated/services/boosts_service.rb
+- lib/basecamp/generated/services/campfires_service.rb
+- lib/basecamp/generated/services/card_columns_service.rb
+- lib/basecamp/generated/services/card_steps_service.rb
+- lib/basecamp/generated/services/card_tables_service.rb
+- lib/basecamp/generated/services/cards_service.rb
+- lib/basecamp/generated/services/checkins_service.rb
+- lib/basecamp/generated/services/client_approvals_service.rb
+- lib/basecamp/generated/services/client_correspondences_service.rb
+- lib/basecamp/generated/services/client_replies_service.rb
+- lib/basecamp/generated/services/client_visibility_service.rb
+- lib/basecamp/generated/services/comments_service.rb
+- lib/basecamp/generated/services/documents_service.rb
+- lib/basecamp/generated/services/events_service.rb
+- lib/basecamp/generated/services/forwards_service.rb
+- lib/basecamp/generated/services/lineup_service.rb
+- lib/basecamp/generated/services/message_boards_service.rb
+- lib/basecamp/generated/services/message_types_service.rb
+- lib/basecamp/generated/services/messages_service.rb
+- lib/basecamp/generated/services/people_service.rb
+- lib/basecamp/generated/services/projects_service.rb
+- lib/basecamp/generated/services/recordings_service.rb
+- lib/basecamp/generated/services/reports_service.rb
+- lib/basecamp/generated/services/schedules_service.rb
+- lib/basecamp/generated/services/search_service.rb
+- lib/basecamp/generated/services/subscriptions_service.rb
+- lib/basecamp/generated/services/templates_service.rb
+- lib/basecamp/generated/services/timeline_service.rb
+- lib/basecamp/generated/services/timesheets_service.rb
+- lib/basecamp/generated/services/todolist_groups_service.rb
+- lib/basecamp/generated/services/todolists_service.rb
+- lib/basecamp/generated/services/todos_service.rb
+- lib/basecamp/generated/services/todosets_service.rb
+- lib/basecamp/generated/services/tools_service.rb
+- lib/basecamp/generated/services/uploads_service.rb
+- lib/basecamp/generated/services/vaults_service.rb
+- lib/basecamp/generated/services/webhooks_service.rb
+- lib/basecamp/generated/types.rb
+- lib/basecamp/hooks.rb
+- lib/basecamp/http.rb
+- lib/basecamp/logger_hooks.rb
+- lib/basecamp/noop_hooks.rb
+- lib/basecamp/oauth.rb
+- lib/basecamp/oauth/discovery.rb
+- lib/basecamp/oauth/errors.rb
+- lib/basecamp/oauth/exchange.rb
+- lib/basecamp/oauth/pkce.rb
+- lib/basecamp/oauth/types.rb
+- lib/basecamp/oauth_token_provider.rb
+- lib/basecamp/operation_info.rb
+- lib/basecamp/request_info.rb
+- lib/basecamp/request_result.rb
+- lib/basecamp/security.rb
+- lib/basecamp/services/attachments_service.rb
+- lib/basecamp/services/authorization_service.rb
+- lib/basecamp/services/base_service.rb
+- lib/basecamp/services/campfires_service.rb
+- lib/basecamp/services/card_columns_service.rb
+- lib/basecamp/services/card_steps_service.rb
+- lib/basecamp/services/card_tables_service.rb
+- lib/basecamp/services/cards_service.rb
+- lib/basecamp/services/checkins_service.rb
+- lib/basecamp/services/client_approvals_service.rb
+- lib/basecamp/services/client_correspondences_service.rb
+- lib/basecamp/services/client_replies_service.rb
+- lib/basecamp/services/comments_service.rb
+- lib/basecamp/services/documents_service.rb
+- lib/basecamp/services/events_service.rb
+- lib/basecamp/services/forwards_service.rb
+- lib/basecamp/services/lineup_service.rb
+- lib/basecamp/services/message_boards_service.rb
+- lib/basecamp/services/message_types_service.rb
+- lib/basecamp/services/messages_service.rb
+- lib/basecamp/services/people_service.rb
+- lib/basecamp/services/projects_service.rb
+- lib/basecamp/services/recordings_service.rb
+- lib/basecamp/services/reports_service.rb
+- lib/basecamp/services/schedules_service.rb
+- lib/basecamp/services/search_service.rb
+- lib/basecamp/services/subscriptions_service.rb
+- lib/basecamp/services/templates_service.rb
+- lib/basecamp/services/timeline_service.rb
+- lib/basecamp/services/timesheet_service.rb
+- lib/basecamp/services/todolist_groups_service.rb
+- lib/basecamp/services/todolists_service.rb
+- lib/basecamp/services/todos_service.rb
+- lib/basecamp/services/todosets_service.rb
+- lib/basecamp/services/tools_service.rb
+- lib/basecamp/services/uploads_service.rb
+- lib/basecamp/services/vaults_service.rb
+- lib/basecamp/services/webhooks_service.rb
+- lib/basecamp/static_token_provider.rb
+- lib/basecamp/token_provider.rb
+- lib/basecamp/version.rb
+- lib/basecamp/webhooks/event.rb
+- lib/basecamp/webhooks/rack_middleware.rb
+- lib/basecamp/webhooks/receiver.rb
+- lib/basecamp/webhooks/verify.rb
+- scripts/generate-metadata.rb
+- scripts/generate-services.rb
+- scripts/generate-types.rb
+homepage: https://github.com/basecamp/basecamp-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/basecamp/basecamp-sdk
+  source_code_uri: https://github.com/basecamp/basecamp-sdk
+  changelog_uri: https://github.com/basecamp/basecamp-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 Basecamp API
+test_files: []