basecamp-sdk 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c53198686c7bf2b7f9fc25f60c14dec77dada2f3bbf7b6070f9a3e0639f7b529
-  data.tar.gz: f25233709c5a99476ed38728cf9ed005eb55e39457cc6dd4ea3250ac72583e60
+  metadata.gz: a1df4a43587230e1bfbf0403175de3fdf93b50635c42a91a71d3c2e29bb835c8
+  data.tar.gz: c2a9eb831ecd48967fdb706a808fe13a923570f97edcf7b6ed96b7e2372dfcd2
 SHA512:
-  metadata.gz: 3d17039b8cddadbbc8ee270f46f0f3e4665651091c0cd0371728693398002dfdc9def64bc081316c496ca477e43a1e2b4e55b65bc53a2d47124694989d5a0437
-  data.tar.gz: 9bf77edeae08a13c60d1f25f3e9d16ad9d39298dffa7cc430fa319aee4ecfa208d62c1c3ccec629473058ac9b48569faea8190b4373313923caa48556a1ab83a
+  metadata.gz: 25fb53f7d538f519dfd7f7091e687dec7a0f9ce59f65df4c612f44fcea5cf2f3d65d8b8257dcccb8a0bc2b535e340efe911b9f435ef54f022ac0f9752953f6d5
+  data.tar.gz: 6a7f120b233a4d4dc07f5a233c97ee4c8fb3861181143bdd492a7e48998903eb8e0a465b6cfc8816511ef03ecfa0657c0af951b05f3d5a761019130332401a27

data/lib/basecamp/client.rb

@@ -516,11 +516,6 @@ module Basecamp
       service(:lineup) { Services::LineupService.new(self) }
     end
 
-    # @return [Services::AutomationService]
-    def automation
-      service(:automation) { Services::AutomationService.new(self) }
-    end
-
     # @return [Services::MessageTypesService]
     def message_types
       service(:message_types) { Services::MessageTypesService.new(self) }

data/lib/basecamp/generated/services/lineup_service.rb

@@ -7,6 +7,14 @@ module Basecamp
     # @generated from OpenAPI spec
     class LineupService < BaseService
 
+      # List all lineup markers for the account
+      # @return [Array<Hash>] response data
+      def list_lineup_markers()
+        with_operation(service: "lineup", operation: "list_lineup_markers", is_mutation: false) do
+          http_get("/lineup/markers.json", operation: "ListLineupMarkers").json(operation: "ListLineupMarkers")
+        end
+      end
+
       # Create a new lineup marker
       # @param name [String] name
       # @param date [String] date

data/lib/basecamp/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Basecamp
-  VERSION = "0.19.0"
+  VERSION = "0.20.0"
   API_VERSION = "2026-09-02"
 end

data/scripts/generate-metadata.rb

@@ -13,7 +13,46 @@ require 'time'
 
 # Extract metadata from OpenAPI spec
 class MetadataExtractor
-  METHODS = %w[get post put patch delete].freeze
+  # A Path Item Object is read by EXCLUSION: its non-operation fields are a
+  # closed, spec-defined set, its extensions are `x-` prefixed, and every other
+  # field is an operation. A verb list here dropped an operation's metadata in
+  # silence for any method outside the five it knew (#925). Nothing in this
+  # file is verb-specific — metadata is keyed by operationId — so the walk is
+  # total and no verb bound belongs here.
+  NON_OPERATION_FIELDS = %w[summary description servers parameters].freeze
+
+  # Membership is decided above, by exclusion. The shared declaration every
+  # generator reads (spec/generated-verbs.json) is ORDERED, and that order is
+  # reused here to keep metadata.json byte-stable. Order is not membership: a
+  # verb absent from the declaration sorts deterministically to the end by name
+  # and is still extracted, because nothing in this file is verb-specific.
+  # The self-test points this at a crafted declaration to prove the bound is
+  # sourced from the shared file rather than a private literal; production runs
+  # never set it.
+  GENERATED_VERBS_FILE = ENV.fetch(
+    'BASECAMP_GENERATED_VERBS', File.expand_path('../../spec/generated-verbs.json', __dir__)
+  )
+
+  METHOD_ORDER = begin
+    verbs = JSON.parse(File.read(GENERATED_VERBS_FILE, encoding: 'UTF-8'))['verbs']
+    # An HTTP method is a TOKEN, so the rule is a positive character class rather
+    # than a blankness predicate: `[a-z]+`, identical in all six loaders. Two
+    # review rounds chased "blank" across languages — Kotlin and Rust rejected a
+    # space while the others accepted it, then Ruby's ASCII `strip` accepted a
+    # non-breaking space the Unicode-aware ones rejected — and the next
+    # disagreement was guaranteed, because every language defines whitespace
+    # differently (Java's Character.isWhitespace excludes U+00A0; Rust's
+    # char::is_whitespace includes it; Ruby's String#strip is ASCII-only). A
+    # closed positive rule has no such seam: "", " ", "\u00a0", "GET" and 1 are
+    # all rejected the same way everywhere.
+    unless verbs.is_a?(Array) && !verbs.empty? && verbs.all? { |v| v.is_a?(String) && v.match?(/\A[a-z]+\z/) }
+      abort "Error: #{GENERATED_VERBS_FILE} must declare a non-empty `verbs` array of lowercase " \
+            'ASCII method names (/\A[a-z]+\z/).'
+    end
+    verbs.freeze
+  rescue Errno::ENOENT, JSON::ParserError => e
+    abort "Error: cannot read the generated-verb declaration #{GENERATED_VERBS_FILE}: #{e.message}"
+  end
 
   def initialize(openapi_path)
     # Read as UTF-8 regardless of process locale (LC_ALL=C would otherwise read
@@ -24,13 +63,9 @@ class MetadataExtractor
   def extract
     operations = {}
 
-    (@openapi['paths'] || {}).each_value do |path_item|
-      METHODS.each do |method|
-        operation = path_item[method]
-        next unless operation
-
+    (@openapi['paths'] || {}).each do |path, path_item|
+      each_operation(path, path_item) do |_method, operation|
         operation_id = operation['operationId']
-        next unless operation_id
 
         metadata = extract_operation_metadata(operation)
         operations[operation_id] = metadata if metadata.any?
@@ -61,11 +96,8 @@ class MetadataExtractor
   # in "[]" names an array of people. "$" is the body itself.
   def person_id_sites
     sites = {}
-    (@openapi['paths'] || {}).each_value do |path_item|
-      METHODS.each do |method|
-        operation = path_item[method]
-        next unless operation && operation['operationId']
-
+    (@openapi['paths'] || {}).each do |path, path_item|
+      each_operation(path, path_item) do |_method, operation|
         paths = (operation['responses'] || {}).flat_map do |code, response|
           next [] unless code.to_s.start_with?('2')
 
@@ -117,6 +149,57 @@ class MetadataExtractor
     raise "person id site under additionalProperties at #{nested.first} has no runtime path syntax" if nested.any?
   end
 
+  # Yields [verb, operation] for every operation in a path item. A field that is
+  # neither a known non-operation field nor a readable operation object stops
+  # the run by name rather than being stepped over.
+  def each_operation(path, path_item)
+    unless path_item.is_a?(Hash)
+      abort "Error: openapi.json path #{path} is a #{path_item.class}, not a path item object."
+    end
+
+    if path_item.key?('$ref')
+      abort "Error: openapi.json path #{path} is a $ref to #{path_item['$ref'].inspect}. " \
+            'This extractor cannot resolve a path-item reference, and skipping it would leave ' \
+            'every operation behind it without runtime metadata.'
+    end
+
+    # OpenAPI 3.2's `additionalOperations` is a MAP of method to Operation, not an
+    # operation. Read as one it carries no operationId, so it would drop every
+    # operation inside it without saying so. Refuse by name until the walk learns
+    # the map shape.
+    if path_item.key?('additionalOperations')
+      abort "Error: openapi.json path #{path} declares `additionalOperations`, which OpenAPI 3.2 " \
+            'defines as a map of method to Operation. This walk reads a path-item field as a ' \
+            'single operation, so it would drop every operation inside it. Teach the walk the map ' \
+            'shape, or take the field out of the spec.'
+    end
+
+    fields = path_item.keys.reject { |f| NON_OPERATION_FIELDS.include?(f) || f.start_with?('x-') }
+    fields.sort_by! { |f| [ METHOD_ORDER.index(f) || METHOD_ORDER.length, f ] }
+
+    fields.each do |field|
+      operation = path_item[field]
+
+      unless operation.is_a?(Hash)
+        abort "Error: openapi.json path #{path} field #{field.inspect} is a #{operation.class}, " \
+              'which is neither a known non-operation field nor an operation object. If a later ' \
+              'OpenAPI version added it, add it to NON_OPERATION_FIELDS with a reason.'
+      end
+
+      # An operation has to be IDENTIFIABLE. OpenAPI lets operationId be omitted,
+      # and every walker here used to step over one that was — a silent drop of a
+      # real operation, which is #925 wearing a different field.
+      op_id = operation['operationId']
+      unless op_id.is_a?(String) && !op_id.empty?
+        abort "Error: openapi.json declares #{field.upcase} #{path} with no operationId. " \
+              'Everything downstream is keyed by it, and skipping the operation would drop it ' \
+              'from the SDK in silence.'
+      end
+
+      yield field, operation
+    end
+  end
+
   private
 
   def extract_operation_metadata(operation)

data/scripts/generate-services.rb

@@ -17,7 +17,54 @@ require 'set'
 
 # Service generator for Ruby SDK
 class ServiceGenerator
-  METHODS = %w[get post put patch delete].freeze
+  # A Path Item Object is read by EXCLUSION. Its non-operation fields are a
+  # closed, spec-defined set and its extensions are `x-` prefixed, so every
+  # OTHER field is an operation. Enumerating the verbs instead is the defect
+  # this replaces (#925): Smithy's `@http` trait takes the method as a
+  # free-form string it "will use literally and will perform no validation
+  # on", so a model author writing `method: "HEAD"` produced a valid model, a
+  # valid openapi.json, and no method on any service — the verb was not in the
+  # list, so the operation was stepped over in silence.
+  NON_OPERATION_FIELDS = %w[summary description servers parameters].freeze
+
+  # Discovery above is total; emission is bounded by the ONE declaration every
+  # generator reads (spec/generated-verbs.json), whose header carries the
+  # reasoning. Each verb in it has an `Http` helper (`http_get`, `http_post`, …)
+  # the emitted method body calls. An operation on any other verb stops this
+  # generator by name instead of vanishing from the SDK — a loud refusal is the
+  # acceptable outcome, a silent drop never was.
+  #
+  # The declaration is ORDERED, and that order is emission order. Ordering is a
+  # different job from deciding membership and cannot reproduce #925: membership
+  # is decided by exclusion above, so a verb absent from the declaration is
+  # refused, never skipped.
+  # The self-test points this at a crafted declaration to prove the bound is
+  # sourced from the shared file rather than a private literal; production runs
+  # never set it.
+  GENERATED_VERBS_FILE = ENV.fetch(
+    'BASECAMP_GENERATED_VERBS', File.expand_path('../../spec/generated-verbs.json', __dir__)
+  )
+
+  EMITTABLE_METHODS = begin
+    verbs = JSON.parse(File.read(GENERATED_VERBS_FILE, encoding: 'UTF-8'))['verbs']
+    # An HTTP method is a TOKEN, so the rule is a positive character class rather
+    # than a blankness predicate: `[a-z]+`, identical in all six loaders. Two
+    # review rounds chased "blank" across languages — Kotlin and Rust rejected a
+    # space while the others accepted it, then Ruby's ASCII `strip` accepted a
+    # non-breaking space the Unicode-aware ones rejected — and the next
+    # disagreement was guaranteed, because every language defines whitespace
+    # differently (Java's Character.isWhitespace excludes U+00A0; Rust's
+    # char::is_whitespace includes it; Ruby's String#strip is ASCII-only). A
+    # closed positive rule has no such seam: "", " ", "\u00a0", "GET" and 1 are
+    # all rejected the same way everywhere.
+    unless verbs.is_a?(Array) && !verbs.empty? && verbs.all? { |v| v.is_a?(String) && v.match?(/\A[a-z]+\z/) }
+      abort "Error: #{GENERATED_VERBS_FILE} must declare a non-empty `verbs` array of lowercase " \
+            'ASCII method names (/\A[a-z]+\z/).'
+    end
+    verbs.freeze
+  rescue Errno::ENOENT, JSON::ParserError => e
+    abort "Error: cannot read the generated-verb declaration #{GENERATED_VERBS_FILE}: #{e.message}"
+  end
 
   # Schema reference cache for resolving $ref
   attr_reader :schemas
@@ -33,7 +80,6 @@ class ServiceGenerator
     'Schedule' => 'Schedules',
     'People' => 'People',
     'Projects' => 'Projects',
-    'Automation' => 'Automation',
     'ClientFeatures' => 'ClientFeatures',
     'Boosts' => 'Boosts',
     'Untagged' => 'Miscellaneous'
@@ -72,22 +118,11 @@ class ServiceGenerator
       'CloudFiles' => %w[GetCloudFile CreateCloudFile UpdateCloudFile],
       'GoogleDocuments' => %w[GetGoogleDocument CreateGoogleDocument UpdateGoogleDocument]
     },
-    'Automation' => {
-      'Tools' => %w[GetTool UpdateTool DeleteTool CreateTool EnableTool DisableTool RepositionTool],
-      'Recordings' => %w[ArchiveRecording UnarchiveRecording TrashRecording ListRecordings SpotlightRecording UnspotlightRecording],
-      'Webhooks' => %w[ListWebhooks CreateWebhook GetWebhook UpdateWebhook DeleteWebhook],
-      'Events' => %w[ListEvents],
-      'Lineup' => %w[CreateLineupMarker UpdateLineupMarker DeleteLineupMarker],
-      'Search' => %w[Search GetSearchMetadata],
-      'Templates' => %w[
-        ListTemplates CreateTemplate GetTemplate UpdateTemplate
-        DeleteTemplate CreateProjectFromTemplate GetProjectConstruction
-        GetTemplateLibrary CreateTemplateLibraryCopy GetTemplateLibraryCopy
-      ],
-      'Checkins' => %w[
-        GetQuestionnaire ListQuestions CreateQuestion GetQuestion
-        UpdateQuestion ListAnswers CreateAnswer GetAnswer UpdateAnswer
-      ]
+    'Dock' => {
+      'Tools' => %w[GetTool UpdateTool DeleteTool CreateTool EnableTool DisableTool RepositionTool]
+    },
+    'Recordings' => {
+      'Events' => %w[ListEvents]
     },
     'Messages' => {
       'Messages' => %w[GetMessage UpdateMessage CreateMessage ListMessages PinMessage UnpinMessage],
@@ -366,14 +401,78 @@ class ServiceGenerator
 
   private
 
+  # Yields [verb, operation] for every operation in a path item, identifying an
+  # operation by what it is NOT (see NON_OPERATION_FIELDS). Anything this
+  # generator cannot render aborts the run naming the operation.
+  def each_operation(path, path_item)
+    unless path_item.is_a?(Hash)
+      abort "Error: openapi.json path #{path} is a #{path_item.class}, not a path item object."
+    end
+
+    # A `$ref` path item points at operations this generator cannot see without
+    # resolving the reference. Skipping it is the same silent under-count the
+    # exclusion walk exists to prevent, so refuse until someone teaches it to
+    # follow one.
+    if path_item.key?('$ref')
+      abort "Error: openapi.json path #{path} is a $ref to #{path_item['$ref'].inspect}. " \
+            'This generator cannot resolve a path-item reference, and skipping it would hide ' \
+            'every operation behind it from the SDK. Inline the path item, or teach this ' \
+            'generator to resolve local references.'
+    end
+
+    # OpenAPI 3.2's `additionalOperations` is a MAP of method to Operation, not an
+    # operation. Read as one it carries no operationId, so it would drop every
+    # operation inside it without saying so. Refuse by name until the walk learns
+    # the map shape.
+    if path_item.key?('additionalOperations')
+      abort "Error: openapi.json path #{path} declares `additionalOperations`, which OpenAPI 3.2 " \
+            'defines as a map of method to Operation. This walk reads a path-item field as a ' \
+            'single operation, so it would drop every operation inside it. Teach the walk the map ' \
+            'shape, or take the field out of the spec.'
+    end
+
+    fields = path_item.keys.reject { |f| NON_OPERATION_FIELDS.include?(f) || f.start_with?('x-') }
+    fields.sort_by! { |f| [ EMITTABLE_METHODS.index(f) || EMITTABLE_METHODS.length, f ] }
+
+    fields.each do |field|
+      operation = path_item[field]
+
+      unless operation.is_a?(Hash)
+        abort "Error: openapi.json path #{path} field #{field.inspect} is a #{operation.class}, " \
+              'which is neither a known non-operation field nor an operation object. If a later ' \
+              'OpenAPI version added it, add it to NON_OPERATION_FIELDS with a reason.'
+      end
+
+      unless EMITTABLE_METHODS.include?(field)
+        op_id = operation['operationId'] || '(no operationId)'
+        abort "Error: openapi.json declares #{field.upcase} #{path} (#{op_id}), and this generator " \
+              "emits only #{EMITTABLE_METHODS.map(&:upcase).join('/')}. Generating the rest of the " \
+              'SDK without it would drop the operation from every Ruby client in silence, which is ' \
+              'the failure #925 closed. Give Basecamp::Http a ' \
+              "http_#{field} helper, add #{field.inspect} to spec/generated-verbs.json (read that " \
+              'file first — the other five SDKs need the same helper), or take the operation out ' \
+              'of the Smithy model.'
+      end
+
+      # An operation has to be IDENTIFIABLE. OpenAPI lets operationId be omitted,
+      # and every walker here used to step over one that was — a silent drop of a
+      # real operation, which is #925 wearing a different field.
+      op_id = operation['operationId']
+      unless op_id.is_a?(String) && !op_id.empty?
+        abort "Error: openapi.json declares #{field.upcase} #{path} with no operationId. " \
+              'Everything downstream is keyed by it, and skipping the operation would drop it ' \
+              'from the SDK in silence.'
+      end
+
+      yield field, operation
+    end
+  end
+
   def group_operations
     services = {}
 
     @openapi['paths'].each do |path, path_item|
-      METHODS.each do |method|
-        operation = path_item[method]
-        next unless operation
-
+      each_operation(path, path_item) do |method, operation|
         tag = operation['tags']&.first || 'Untagged'
         parsed = parse_operation(path, method, operation)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: basecamp-sdk
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Basecamp
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-16 00:00:00.000000000 Z
+date: 2026-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -183,7 +183,6 @@ files:
 - lib/basecamp/generated/metadata.json
 - lib/basecamp/generated/services/account_service.rb
 - lib/basecamp/generated/services/attachments_service.rb
-- lib/basecamp/generated/services/automation_service.rb
 - lib/basecamp/generated/services/base_service.rb
 - lib/basecamp/generated/services/bookmarks_service.rb
 - lib/basecamp/generated/services/boosts_service.rb

data/lib/basecamp/generated/services/automation_service.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Basecamp
-  module Services
-    # Service for Automation operations
-    #
-    # @generated from OpenAPI spec
-    class AutomationService < BaseService
-
-      # List all lineup markers for the account
-      # @return [Array<Hash>] response data
-      def list_lineup_markers()
-        with_operation(service: "automation", operation: "list_lineup_markers", is_mutation: false) do
-          http_get("/lineup/markers.json", operation: "ListLineupMarkers").json(operation: "ListLineupMarkers")
-        end
-      end
-    end
-  end
-end