@seamapi/nextlove-sdk-generator 1.4.0

package/src/lib/generate-ruby-sdk/templates/base_client.rb.template.ts

@@ -0,0 +1,21 @@
+export default () => `# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class BaseClient
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def request_seam_object(*attrs)
+        client.request_seam_object(*attrs)
+      end
+
+      def request_seam(*attrs)
+        client.request_seam(*attrs)
+      end
+    end
+  end
+end`

package/src/lib/generate-ruby-sdk/templates/base_resource.rb.template.ts

@@ -0,0 +1,58 @@
+export default () => `# frozen_string_literal: true
+
+module Seam
+  class BaseResource
+    attr_accessor :data, :client
+
+    def initialize(data, client = nil)
+      @data = data
+      @client = client
+
+      @data.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def update_from_response(data)
+      @data = data
+      @data.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def self.load_from_response(data, client = nil)
+      if data.is_a?(Array)
+        data.map { |d| new(d, client) }
+      else
+        new(data, client)
+      end
+    end
+
+    def inspect
+      "<#{self.class.name}:#{"0x00%x" % (object_id << 1)}\n" + # rubocop:disable Style/StringConcatenation, Style/FormatString
+        instance_variables
+          .map { |k| k.to_s.sub("@", "") }
+          .filter { |k| k != "data" and k != "client" and respond_to? k }
+          .map { |k| "  #{k}=#{send(k).inspect}" }
+          .join("\n") + ">"
+    end
+
+    def self.date_accessor(*attrs)
+      attrs.each do |attr|
+        define_method(attr) do
+          value = instance_variable_get("@#{attr}")
+
+          raise "No value for #{attr} set" if value.nil?
+
+          parse_datetime(value)
+        end
+      end
+    end
+
+    protected
+
+    def parse_datetime(value)
+      Time.parse(value)
+    end
+  end
+end`

package/src/lib/generate-ruby-sdk/templates/client.rb.template.ts

@@ -0,0 +1,73 @@
+export default () => `# frozen_string_literal: true
+
+module Seam
+  class Client
+    attr_accessor :api_key, :base_uri, :debug
+
+    def initialize(api_key: nil, base_uri: "https://connect.getseam.com", debug: false)
+      @api_key = api_key || ENV.fetch("SEAM_API_KEY", nil)
+      @base_uri = base_uri
+      @debug = debug
+
+      raise ArgumentError, "SEAM_API_KEY not found in environment, and api_key not provided" unless @api_key
+    end
+
+    def health
+      request_seam(:get, "/health")
+    end
+
+    def locks
+      @locks ||= Seam::Clients::Locks.new(self)
+    end
+
+    def devices
+      @devices ||= Seam::Clients::Devices.new(self)
+    end
+
+    def unmanaged_devices
+      @unmanaged_devices ||= Seam::Clients::UnmanagedDevices.new(self)
+    end
+
+    def action_attempts
+      @action_attempts ||= Seam::Clients::ActionAttempts.new(self)
+    end
+
+    def access_codes
+      @access_codes ||= Seam::Clients::AccessCodes.new(self)
+    end
+
+    def connect_webviews
+      @connect_webviews ||= Seam::Clients::ConnectWebviews.new(self)
+    end
+
+    def connected_accounts
+      @connected_accounts ||= Seam::Clients::ConnectedAccounts.new(self)
+    end
+
+    def workspaces
+      @workspaces ||= Seam::Clients::Workspaces.new(self)
+    end
+
+    def events
+      @events ||= Seam::Clients::Events.new(self)
+    end
+
+    def request_seam_object(method, path, klass, inner_object, config = {})
+      response = request_seam(method, path, config)
+
+      data = response[inner_object]
+
+      klass.load_from_response(data, self)
+    end
+
+    def request_seam(method, path, config = {})
+      Seam::Request.new(
+        api_key: api_key,
+        base_uri: base_uri,
+        debug: debug
+      ).perform(
+        method, path, config
+      )
+    end
+  end
+end`

package/src/lib/generate-ruby-sdk/templates/gemfile.template.ts

@@ -0,0 +1,6 @@
+export default () => `# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in seamapi.gemspec.
+gemspec`

package/src/lib/generate-ruby-sdk/templates/logger.rb.template.ts

@@ -0,0 +1,12 @@
+export default () => `# frozen_string_literal: true
+
+require "logger"
+
+module Seam
+  class Logger
+    def self.info(message)
+      logger = ::Logger.new($stdout)
+      logger.info(message)
+    end
+  end
+end`

package/src/lib/generate-ruby-sdk/templates/rakefile.template.ts

@@ -0,0 +1,22 @@
+export default () => `# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[lint test]
+
+task test: "spec"
+task lint: "standard"
+task format: "standard:fix"
+
+desc "Open an interactive ruby console"
+task :console do
+  require "irb"
+  require "bundler/setup"
+  require "seamapi"
+  ARGV.clear
+  IRB.start
+end`

package/src/lib/generate-ruby-sdk/templates/readme.md.template.ts

@@ -0,0 +1,183 @@
+export default () => `# Seam API Ruby SDK
+
+[![RubyGems.org](https://img.shields.io/gem/v/seamapi)](https://rubygems.org/gems/seamapi)
+[![GitHub Actions](https://github.com/seamapi/ruby/workflows/main/badge.svg)](https://github.com/seamapi/ruby/actions)
+[![Docs](https://img.shields.io/badge/docs-latest-blue)](https://docs.seam.co/)
+
+Official interface to the [Seam Connect API].
+
+[Seam Connect API]: https://docs.seam.co/
+
+## Description
+
+This SDK provides convenient access to the [Seam Connect API] for Ruby applications.
+
+This library includes:
+
+- A predefined set of classes for API resources that
+  initialize themselves dynamically from API responses.
+- Methods for all [Seam API endpoints](https://docs.seam.co/latest/api-clients/overview).
+- Simplified asynchronous flows, e.g., listening for events or actions to finish.
+
+[Seam API endpoints]: https://docs.seam.co/latest/api-endpoints/overview
+
+## Installation
+
+Add this as a dependency to your project using [Bundler] with
+
+\`\`\`
+$ bundle add seamapi
+\`\`\`
+
+[bundler]: https://bundler.io/
+
+## Usage
+
+_Refer to the [Seam Connect API documentation][Seam Connect API]._
+
+### Requirements
+
+- Ruby version 3 or later.
+- An API Key generated via the [Seam Dashboard].
+
+[Seam Dashboard]: https://dashboard.getseam.com
+
+### Example
+
+\`\`\`ruby
+seam = Seam::Client.new(api_key: "MY_SEAM_API_KEY")
+devices = seam.devices.list
+my_door = devices.first
+seam.locks.unlock(my_door).wait_until_finished
+\`\`\`
+
+## Development and Testing
+
+### Quickstart
+
+\`\`\`
+$ git clone https://github.com/seamapi/ruby.git
+$ cd ruby
+$ bundle install
+\`\`\`
+
+Run the command below
+
+\`\`\`
+$ bundle exec rake
+\`\`\`
+
+Open an interactive ruby console with
+
+\`\`\`
+$ bundle exec rake
+\`\`\`
+
+Primary development tasks are defined as [rake] tasks in the \`Rakefile\`
+and available via \`rake\`.
+View them with
+
+\`\`\`
+$ bundle exec rake -T
+\`\`\`
+
+[rake]: https://ruby.github.io/rake/
+
+### Interactive Console
+
+Play around with this module inside an interactive console with
+
+\`\`\`
+$ rake console
+\`\`\`
+
+Use a sandbox API key to play with the SDK without touching real devices.
+
+### Source code
+
+The [source code] is hosted on GitHub.
+Clone the project with
+
+\`\`\`
+$ git clone git@github.com:seamapi/ruby.git
+\`\`\`
+
+[source code]: https://github.com/seamapi/ruby
+
+### Requirements
+
+You will need [Ruby] with [Bundler].
+
+Be sure that all commands run under the correct Ruby version, e.g.,
+if using [rbenv], install the correct version with
+
+\`\`\`
+$ rbenv install
+\`\`\`
+
+Install the development dependencies with
+
+\`\`\`
+$ bundle install
+\`\`\`
+
+[bundler]: https://bundler.io/
+[ruby]: https://www.ruby-lang.org/
+[rbenv]: https://github.com/rbenv/rbenv
+
+### Publishing
+
+Releases are handled automatically by [semantic-release].
+Publishing may be triggered manually using a [workflow_dispatch on GitHub Actions].
+
+[semantic-release]: https://semantic-release.gitbook.io/
+[workflow_dispatch on github actions]: https://github.com/seamapi/ruby/actions?query=workflow%3Aversion
+
+## GitHub Actions
+
+_GitHub Actions should already be configured: this section is for reference only._
+
+The following repository secrets must be set on [GitHub Actions]:
+
+- \`RUBYGEMS_API_KEY\`: RubyGems.org token for publishing packages.
+- \`GH_TOKEN\`: A personal access token for the user.
+- \`GIT_USER_NAME\`: The GitHub user's real name.
+- \`GIT_USER_EMAIL\`: The GitHub user's email.
+- \`GPG_PRIVATE_KEY\`: The GitHub user's [GPG private key].
+- \`GPG_PASSPHRASE\`: The GitHub user's GPG passphrase.
+
+These are set at the organization level.
+
+[github actions]: https://github.com/features/actions
+[gpg private key]: https://github.com/marketplace/actions/import-gpg#prerequisites
+
+## Contributing
+
+Please submit and comment on bug reports and feature requests.
+
+To submit a patch:
+
+1. Fork it (https://github.com/seamapi/ruby/fork).
+2. Create your feature branch (\`git checkout -b my-new-feature\`).
+3. Make changes.
+4. Commit your changes (\`git commit -am 'Add some feature'\`).
+5. Push to the branch (\`git push origin my-new-feature\`).
+6. Create a new Pull Request.
+
+## License
+
+This Ruby gem is licensed under the MIT license.
+
+## Warranty
+
+This software is provided by the copyright holders and contributors "as is" and
+any express or implied warranties, including, but not limited to, the implied
+warranties of merchantability and fitness for a particular purpose are
+disclaimed. In no event shall the copyright holder or contributors be liable for
+any direct, indirect, incidental, special, exemplary, or consequential damages
+(including, but not limited to, procurement of substitute goods or services;
+loss of use, data, or profits; or business interruption) however caused and on
+any theory of liability, whether in contract, strict liability, or tort
+(including negligence or otherwise) arising in any way out of the use of this
+software, even if advised of the possibility of such damage.
+`

package/src/lib/generate-ruby-sdk/templates/request.rb.template.ts

@@ -0,0 +1,70 @@
+export default () => `# frozen_string_literal: true
+
+require "http"
+
+module Seam
+  class Request
+    attr_reader :base_uri, :api_key, :debug
+
+    class Error < StandardError
+      attr_reader :status, :response
+
+      def initialize(message, status, response)
+        super(message)
+        @status = status
+        @response = response
+      end
+    end
+
+    def initialize(api_key:, base_uri:, debug: false)
+      @api_key = api_key
+      @base_uri = base_uri
+      @debug = debug
+    end
+
+    def perform(method, uri, config = {})
+      Logger.info("Request: #{method} #{uri} #{config}") if debug
+
+      config[:body] = config[:body].to_json if config[:body]
+
+      response = HTTP.request(
+        method,
+        build_url(uri),
+        {headers: headers}.merge(config)
+      )
+
+      return response.parse if response.status.success?
+
+      handle_error_response(response, method, uri)
+    end
+
+    protected
+
+    def handle_error_response(response, method, uri)
+      msg = "Api Error #{response.status.code} #{method} #{uri}"
+      code = response.status.code
+
+      if code >= 400 && code < 500 && (err = response.parse["error"])
+        msg = "Api Error #{err["type"]}\nrequest_id: #{err["request_id"]}\n#{err["message"]}"
+      end
+
+      raise Error.new(msg, code, response)
+    end
+
+    def build_url(uri)
+      "#{base_uri}#{uri}"
+    end
+
+    def headers
+      {
+        "User-Agent" => user_agent,
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{api_key}"
+      }
+    end
+
+    def user_agent
+      "seam-ruby/#{Seam::VERSION}"
+    end
+  end
+end`

package/src/lib/generate-ruby-sdk/templates/resource_error.rb.template.ts

@@ -0,0 +1,7 @@
+export default () => `# frozen_string_literal: true
+
+module Seam
+  class ResourceError < BaseResource
+    attr_accessor :error_code, :message
+  end
+end`

package/src/lib/generate-ruby-sdk/templates/resource_errors_support.rb.template.ts

@@ -0,0 +1,9 @@
+export default () => `# frozen_string_literal: true
+
+module Seam
+  module ResourceErrorsSupport
+    def errors
+      @errors_converted ||= @errors.is_a?(Array) ? Seam::ResourceError.load_from_response(@errors) : []
+    end
+  end
+end`

package/src/lib/generate-ruby-sdk/templates/resource_warning.rb.template.ts

@@ -0,0 +1,7 @@
+export default () => `# frozen_string_literal: true
+
+module Seam
+  class ResourceWarning < BaseResource
+    attr_accessor :warning_code, :message
+  end
+end`

package/src/lib/generate-ruby-sdk/templates/resource_warnings_support.rb.template.ts

@@ -0,0 +1,9 @@
+export default () => `# frozen_string_literal: true
+
+module Seam
+  module ResourceWarningsSupport
+    def warnings
+      @warnings_converted ||= @warnings.is_a?(Array) ? Seam::ResourceWarning.load_from_response(@warnings) : []
+    end
+  end
+end`

package/src/lib/generate-ruby-sdk/templates/seamapi.gemspec.template.ts

@@ -0,0 +1,40 @@
+export default () => `# frozen_string_literal: true
+
+require_relative "lib/seam/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "seamapi"
+  spec.version = Seam::VERSION
+  spec.author = "Seam Labs, Inc."
+  spec.email = "support@getseam.com"
+
+  spec.summary = "Seam API Ruby SDK"
+  spec.description = "Official interface to the Seam Connect API."
+  spec.homepage = "https://github.com/seamapi/ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["bug_tracker_uri"] = "#{spec.metadata["source_code_uri"]}/issues"
+  spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/releases"
+  spec.metadata["github_repo"] = "git@github.com:seamapi/ruby.git"
+
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{\A#{spec.bindir}/}) { |f| File.basename(f) }
+
+  spec.files = Dir["lib/**/*.rb"]
+  spec.files += Dir["[A-Z]*"]
+
+  spec.add_dependency "http", "~> 5.0.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "gem-release", "~> 2.2"
+  spec.add_development_dependency "parse_gemspec-cli", "~> 1.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.21"
+  spec.add_development_dependency "simplecov-console", "~> 0.9"
+  spec.add_development_dependency "standard", "~> 1.3"
+  spec.add_development_dependency "webmock", "~> 3.0.0"
+end`

package/src/lib/generate-ruby-sdk/templates/snippets/resource.rb.template.ts

@@ -0,0 +1,24 @@
+export default ({
+  pascal_name,
+  attrs,
+  date_attrs,
+}: {
+  pascal_name: string
+  attrs: string[]
+  date_attrs: string[]
+}) => `# frozen_string_literal: true
+
+module Seam
+  class ${pascal_name} < BaseResource
+    attr_reader ${attrs.map((attr) => `:${attr}`).join(", ")}
+
+    ${
+      date_attrs.length > 0
+        ? `date_accessor ${date_attrs.map((attr) => `:${attr}`).join(", ")}`
+        : ""
+    }
+
+    include Seam::ResourceErrorsSupport
+    include Seam::ResourceWarningsSupport
+  end
+end`

package/src/lib/generate-ruby-sdk/templates/version.rb.template.ts

@@ -0,0 +1,5 @@
+export default () => `# frozen_string_literal: true
+
+module Seam
+  VERSION = "1.11.2"
+end`

package/src/lib/index.ts

@@ -0,0 +1,2 @@
+export * from "./openapi/index.js"
+export * from "./fs-util/index.js"

package/src/lib/openapi/flatten-obj-schema.ts

@@ -0,0 +1,124 @@
+import type {
+  AllOfSchema,
+  ArraySchema,
+  ObjSchema,
+  PrimitiveSchema,
+  PropertySchema,
+} from "lib/types.js"
+import lodash from "lodash"
+const { intersectionWith, isEqual } = lodash
+
+export const flattenObjSchema = (
+  s:
+    | ObjSchema
+    | {
+        oneOf: Array<ObjSchema>
+      }
+): ObjSchema => {
+  if ("type" in s && s.type === "object") return s
+
+  if ("oneOf" in s) {
+    if (!s.oneOf[0]) {
+      throw new Error("oneOf must have at least one element")
+    }
+
+    const super_obj: ObjSchema = {
+      type: "object",
+      properties: {},
+      required: [...s.oneOf[0].required],
+    }
+    for (const obj of s.oneOf) {
+      for (const [k, v] of Object.entries(obj.properties)) {
+        super_obj.properties[k] = v
+      }
+      super_obj.required = intersectionWith(
+        super_obj.required,
+        obj.required,
+        isEqual
+      )
+    }
+    return super_obj as ObjSchema
+  }
+  throw new Error(`Unknown schema type "${s.type}"`)
+}
+
+export const deepFlattenAllOfSchema = (
+  s: AllOfSchema
+): Exclude<PropertySchema, AllOfSchema> | undefined => {
+  if (s.allOf.length === 1 && s.allOf[0]) {
+    const recursive = s.allOf[0]
+
+    if ("allOf" in recursive) {
+      return deepFlattenAllOfSchema(recursive)
+    }
+
+    return recursive
+  }
+
+  const properties: Record<string, PropertySchema[]> = {}
+  const required = new Set<string>()
+  const primitives: (PrimitiveSchema | ArraySchema)[] = []
+
+  for (let subschema of s.allOf) {
+    if ("allOf" in subschema) {
+      const recursive = deepFlattenAllOfSchema(subschema)
+      if (!recursive) continue
+
+      subschema = recursive
+    }
+
+    if ("oneOf" in subschema) {
+      console.error("oneOf not currently supported when flattening allOf")
+      continue
+    }
+
+    if ("$ref" in subschema) {
+      console.error("$ref not currently supported when flattening allOf")
+      continue
+    }
+
+    if (subschema.type === "object") {
+      for (const [k, v] of Object.entries(subschema.properties)) {
+        if (!properties[k]) properties[k] = []
+        properties[k]!.push(v)
+
+        if (subschema.required?.includes(k)) required.add(k)
+      }
+
+      continue
+    }
+
+    primitives.push(subschema)
+  }
+
+  if (Object.keys(properties).length > 0 && primitives.length > 0) {
+    console.error(
+      "Found invalid allOf schema with both properties and primitives",
+      new Error(JSON.stringify(s, null, 2))
+    )
+  }
+
+  if (primitives.length > 0) {
+    // TODO: check that all primitives are the same, then merge nullability/unions
+    return primitives[0]
+  }
+
+  if (Object.keys(properties).length > 0) {
+    return {
+      type: "object",
+      required: [...required],
+      properties: Object.fromEntries(
+        Object.entries(properties)
+          .map(([k, v]) => [
+            k,
+            deepFlattenAllOfSchema({
+              allOf: v,
+            }),
+          ])
+          .filter(([, v]) => v)
+      ),
+    }
+  }
+
+  return undefined
+}