seam 2.0.0b5 → 2.0.0.prerelease.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 153a1125c70c291a174d633ade80bd679c7273bc7a822399e28c7d674585467f
-  data.tar.gz: b014b0d28966949583b2aff44deb03ed2572145aefdb87ae5a8d4fc82f4976e2
+  metadata.gz: 633608dcbbd2c43fd668b46a8a6aa3ee7d23663a81ed92b84885d50dcedae3b4
+  data.tar.gz: 1f6c28b4b491077046e4b6d87cf26375871ba3a8a55df2c2c26c47ba52bea88f
 SHA512:
-  metadata.gz: b62accc3cb7bc70e25e34199264dc2eccbbbecfc7527be0bb3de40e8f283e23c833872af9b78044eb0de6c51e522ba634dd24be91968f1a40762e6e02040453a
-  data.tar.gz: 1a25544329a7d4a44b034d5dfa4f866b6b3efd8b819d3933b96099734bd3b6548a4c2e68a2d2c05d7c88cd35bf3c5536b11c8b9d8bc6d793393af7047dd0013e
+  metadata.gz: b231444fe73cc6baae32e5ef0af4d9490892bc881f0a56ddc3d6dce6011a18ae80d0805e537a5db1d65bbaf8bd73b498ead3e7391400dd3ce94e70400779b5f5
+  data.tar.gz: 38504e2b53afb62af4ba3808dbf0c2345284c45833a07a6dea1774ae2a6a64edb45c1b66ae9ff87eafb12ff2402e148ad89230d78b9b423be046fee4cad796b8

data/Gemfile.lock

@@ -1,113 +1,117 @@
 PATH
   remote: .
   specs:
-    seam (2.0.0b5)
-      faraday (~> 2.7)
-      faraday-retry (~> 2.2)
-      svix (~> 1.30)
+    seam (2.0.0.prerelease.1)
+      http (~> 5.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
     ansi (1.5.0)
     ast (2.4.2)
-    bigdecimal (3.1.8)
+    base64 (0.2.0)
+    bigdecimal (3.1.7)
     crack (1.0.0)
       bigdecimal
       rexml
     diff-lcs (1.5.1)
-    docile (1.4.1)
-    faraday (2.12.0)
-      faraday-net_http (>= 2.0, < 3.4)
-      json
-      logger
-    faraday-net_http (3.3.0)
-      net-http
-    faraday-retry (2.2.1)
-      faraday (~> 2.0)
+    docile (1.4.0)
+    domain_name (0.6.20240107)
+    ffi (1.16.3)
+    ffi-compiler (1.3.2)
+      ffi (>= 1.15.5)
+      rake
     gem-release (2.2.2)
-    hashdiff (1.1.2)
-    json (2.8.1)
+    hashdiff (1.1.0)
+    http (5.2.0)
+      addressable (~> 2.8)
+      base64 (~> 0.1)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.5.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
-    logger (1.6.1)
+    llhttp-ffi (0.5.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
     multi_json (1.15.0)
-    net-http (0.5.0)
-      uri
-    parallel (1.26.3)
+    parallel (1.24.0)
     parse_gemspec (1.0.0)
     parse_gemspec-cli (1.0.0)
       multi_json
       parse_gemspec
       thor
-    parser (3.3.6.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
-    public_suffix (6.0.1)
-    racc (1.8.1)
+    public_suffix (5.0.5)
+    racc (1.7.3)
     rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.9.2)
-    rexml (3.3.9)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.2)
+    rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.66.1)
+    rubocop (1.62.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rubocop-ast (>= 1.32.2, < 2.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.35.0)
-      parser (>= 3.3.1.0)
-    rubocop-performance (1.22.1)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-performance (1.20.2)
       rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-console (0.9.2)
+    simplecov-console (0.9.1)
       ansi
       simplecov
       terminal-table
-    simplecov-html (0.13.1)
+    simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.41.1)
+    standard (1.35.1)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.66.0)
+      rubocop (~> 1.62.0)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.5)
+      standard-performance (~> 1.3)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.5.0)
+    standard-performance (1.3.1)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.22.0)
-    svix (1.40.0)
+      rubocop-performance (~> 1.20.2)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    thor (1.3.2)
-    unicode-display_width (2.6.0)
-    uri (1.0.1)
+    thor (1.3.1)
+    unicode-display_width (2.5.0)
     webmock (3.0.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -130,4 +134,4 @@ DEPENDENCIES
   webmock (~> 3.0.0)
 
 BUNDLED WITH
-   2.5.16
+   2.4.19

data/README.md

@@ -7,337 +7,17 @@ SDK for the Seam API written in Ruby.
 
 ## Description
 
-[Seam](https://seam.co) makes it easy to integrate IoT devices with your applications.
-This is an official SDK for the Seam API.
-Please refer to the official [Seam Docs](https://docs.seam.co/latest/) to get started.
-
-Parts of this SDK are generated from always up-to-date type information
-provided by [@seamapi/types](https://github.com/seamapi/types/).
-This ensures all API methods, request shapes, and response shapes are
-accurate and fully typed.
-
-<!-- toc -->
-
-- [Installation](#installation)
-- [Usage](#usage)
-  - [Examples](#examples)
-    - [List devices](#list-devices)
-    - [Unlock a door](#unlock-a-door)
-  - [Authentication Method](#authentication-method)
-    - [API Key](#api-key)
-    - [Personal Access Token](#personal-access-token)
-  - [Action Attempts](#action-attempts)
-  - [Interacting with Multiple Workspaces](#interacting-with-multiple-workspaces)
-  - [Webhooks](#webhooks)
-  - [Advanced Usage](#advanced-usage)
-    - [Additional Options](#additional-options)
-    - [Setting the endpoint](#setting-the-endpoint)
-    - [Configuring the Faraday Client](#configuring-the-faraday-client)
-    - [Using the Faraday Client](#using-the-faraday-client)
-    - [Overriding the Client](#overriding-the-client)
-- [Development and Testing](#development-and-testing)
-  - [Quickstart](#quickstart)
-  - [Source code](#source-code)
-  - [Requirements](#requirements)
-  - [Publishing](#publishing)
-    - [Automatic](#automatic)
-    - [Manual](#manual)
-- [GitHub Actions](#github-actions)
-  - [Secrets for Optional GitHub Actions](#secrets-for-optional-github-actions)
-- [Contributing](#contributing)
-- [License](#license)
-- [Warranty](#warranty)
-
-<!-- tocstop -->
+TODO
 
 ## Installation
 
-Add this as a dependency to your project using [Bundler] with:
+Add this as a dependency to your project using [Bundler] with
 
 ```
 $ bundle add seam
 ```
 
-[Bundler]: https://bundler.io/
-
-## Usage
-
-### Examples
-
-> [!NOTE]
-> These examples assume `SEAM_API_KEY` is set in your environment.
-
-#### List devices
-
-```ruby
-require "seam"
-
-seam = Seam.new
-devices = seam.devices.list
-```
-
-#### Unlock a door
-
-```ruby
-require "seam"
-
-seam = Seam.new
-lock = seam.locks.get(name: "Front Door")
-seam.locks.unlock_door(device_id: lock.device_id)
-```
-
-### Authentication Method
-
-The SDK supports API key and personal access token authentication mechanisms.
-Authentication may be configured by passing the corresponding options directly to the `Seam` constructor, or with the more ergonomic static factory methods.
-
-#### API Key
-
-An API key is scoped to a single workspace and should only be used on the server.
-Obtain one from the Seam Console.
-
-```ruby
-# Set the `SEAM_API_KEY` environment variable
-seam = Seam.new
-
-# Pass as a keyword argument to the constructor
-seam = Seam.new(api_key: "your-api-key")
-
-# Use the factory method
-seam = Seam.from_api_key("your-api-key")
-```
-
-#### Personal Access Token
-
-A Personal Access Token is scoped to a Seam Console user.
-Obtain one from the Seam Console.
-A workspace ID must be provided when using this method and all requests will be scoped to that workspace.
-
-```ruby
-# Pass as an option to the constructor
-seam = Seam.new(
-  personal_access_token: "your-personal-access-token",
-  workspace_id: "your-workspace-id"
-)
-
-# Use the factory method
-seam = Seam.from_personal_access_token(
-  "your-personal-access-token",
-  "your-workspace-id"
-)
-```
-
-### Action Attempts
-
-Some asynchronous operations, e.g., unlocking a door, return an
-[action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).
-Seam tracks the progress of the requested operation and updates the action attempt
-when it succeeds or fails.
-
-To make working with action attempts more convenient for applications,
-this library provides the `wait_for_action_attempt` option and enables it by default.
-
-When the `wait_for_action_attempt` option is enabled, the SDK:
-
-- Polls the action attempt up to the `timeout`
-  at the `polling_interval` (both in seconds).
-- Resolves with a fresh copy of the successful action attempt.
-- Raises a `Seam::ActionAttemptFailedError` if the action attempt is unsuccessful.
-- Raises a `Seam::ActionAttemptTimeoutError` if the action attempt is still pending when the `timeout` is reached.
-- Both errors expose an `action_attempt` property.
-
-If you already have an action attempt ID
-and want to wait for it to resolve, simply use:
-
-```ruby
-seam.action_attempts.get(action_attempt_id: action_attempt_id)
-```
-
-Or, to get the current state of an action attempt by ID without waiting:
-
-```ruby
-seam.action_attempts.get(
-  action_attempt_id: action_attempt_id,
-  wait_for_action_attempt: false
-)
-```
-
-To disable this behavior, set the default option for the client:
-
-```ruby
-seam = Seam.new(
-  api_key: "your-api-key",
-  wait_for_action_attempt: false
-)
-
-seam.locks.unlock_door(device_id: device_id)
-```
-
-or the behavior may be configured per-request:
-
-```ruby
-seam.locks.unlock_door(
-  device_id: device_id,
-  wait_for_action_attempt: false
-)
-```
-
-The `polling_interval` and `timeout` may be configured for the client or per-request.
-For example:
-
-```ruby
-require "seam"
-
-seam = Seam.new("your-api-key")
-
-locks = seam.locks.list
-
-if locks.empty?
-  raise "No locks in this workspace"
-end
-
-lock = locks.first
-
-begin
-  seam.locks.unlock_door(
-    device_id: lock.device_id,
-    wait_for_action_attempt: {
-      timeout: 5.0,
-      polling_interval: 1.0
-    }
-  )
-
-  puts "Door unlocked"
-rescue Seam::ActionAttemptFailedError
-  puts "Could not unlock the door"
-rescue Seam::ActionAttemptTimeoutError
-  puts "Door took too long to unlock"
-end
-```
-
-### Interacting with Multiple Workspaces
-
-Some Seam API endpoints interact with multiple workspaces. The `Seam::Http::SeamMultiWorkspace` client is not bound to a specific workspace and may use those endpoints with a personal access token authentication method.
-
-A Personal Access Token is scoped to a Seam Console user. Obtain one from the Seam Console.
-
-```ruby
-# Pass as an option to the constructor
-seam = Seam::Http::SeamMultiWorkspace.new(personal_access_token: "your-personal-access-token")
-
-# Use the factory method
-seam = Seam::Http::SeamMultiWorkspace.from_personal_access_token("your-personal-access-token")
-
-# List workspaces authorized for this Personal Access Token
-workspaces = seam.workspaces.list
-```
-
-### Webhooks
-
-The Seam API implements webhooks using [Svix](https://www.svix.com).This SDK exports a thin wrapper `Seam::Webhook` around the svix package.
-Use it to parse and validate Seam webhook events.
-
-> [!TIP]
-> This example is for [Sinatra](https://sinatrarb.com/), see the [Svix docs for more examples in specific frameworks](https://docs.svix.com/receiving/verifying-payloads/how).
-
-```ruby
-require "sinatra"
-require "seam"
-
-webhook = Seam::Webhook.new(ENV["SEAM_WEBHOOK_SECRET"])
-
-post "/webhook" do
-  begin
-    headers = {
-      "svix-id" => request.env["HTTP_SVIX_ID"],
-      "svix-signature" => request.env["HTTP_SVIX_SIGNATURE"],
-      "svix-timestamp" => request.env["HTTP_SVIX_TIMESTAMP"]
-    }
-    data = webhook.verify(request.body.read, headers)
-  rescue Seam::WebhookVerificationError
-    halt 400, "Bad Request"
-  end
-
-  begin
-    store_event(data)
-  rescue
-    halt 500, "Internal Server Error"
-  end
-
-  204
-end
-
-def store_event(data)
-  puts data
-end
-```
-
-### Advanced Usage
-
-#### Additional Options
-
-In addition to the various authentication options,
-the constructor takes some advanced options that affect behavior.
-
-```ruby
-seam = Seam.new(
-  api_key: "your-api-key",
-  endpoint: "https://example.com",
-  faraday_options: {},
-  faraday_retry_options: {}
-)
-```
-
-When using the static factory methods,
-these options may be passed in as keyword arguments.
-
-```ruby
-seam = Seam.from_api_key("some-api-key",
-  endpoint: "https://example.com",
-  faraday_options: {},
-  faraday_retry_options: {})
-```
-
-#### Setting the endpoint
-
-Some contexts may need to override the API endpoint,
-e.g., testing or proxy setups. This option corresponds to the [Faraday](https://lostisland.github.io/faraday/#/) `url` setting.
-
-Either pass the `endpoint` option, or set the `SEAM_ENDPOINT` environment variable.
-
-#### Configuring the Faraday Client
-
-The Faraday client and retry behavior may be configured with custom initiation options
-via [`faraday_option`][faraday_option] and [`faraday_retry_option`][faraday_retry_option].
-
-[faraday_option]: https://lostisland.github.io/faraday/#/customization/connection-options?id=connection-options
-[faraday_retry_option]: https://github.com/lostisland/faraday-retry
-
-#### Using the Faraday Client
-
-The Faraday client is exposed and may be used or configured directly:
-
-```ruby
-require "seam"
-require "faraday"
-
-class MyMiddleware < Faraday::Middleware
-  def on_complete(env)
-    puts env.response.inspect
-  end
-end
-
-seam = Seam.new
-
-seam.client.builder.use MyMiddleware
-
-devices = seam.client.get("/devices/list").body["devices"]
-```
-
-#### Overriding the Client
-
-A Faraday compatible client may be provided to create a `Seam` instance.
-This API is used internally and is not directly supported.
+[bundler]: https://bundler.io/
 
 ## Development and Testing
 

data/Rakefile

@@ -5,10 +5,7 @@ require "rspec/core/rake_task"
 require "standard/rake"
 
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = [
-    "spec/**/*_spec.rb",
-    "lib/seam/*_spec.rb"
-  ]
+  t.rspec_opts = "--pattern spec/**/*_spec.rb"
 end
 
 task default: %i[lint test]

data/lib/seam/client.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Seam
+  class Client
+    attr_accessor :api_key, :base_uri, :debug, :wait_for_action_attempt
+
+    def self.lts_version
+      Seam::LTS_VERSION
+    end
+
+    def initialize(api_key: nil, base_uri: nil, wait_for_action_attempt: false, debug: false)
+      @api_key = api_key || ENV["SEAM_API_KEY"]
+      @base_uri = base_uri || ENV["SEAM_API_URL"] || ENV["SEAM_ENDPOINT"] || "https://connect.getseam.com"
+      @debug = debug
+      @wait_for_action_attempt = wait_for_action_attempt
+
+      raise ArgumentError, "SEAM_API_KEY not found in environment, and api_key not provided" if @api_key.to_s.empty?
+
+      if ENV["SEAM_API_URL"]
+        warn "Using the SEAM_API_URL environment variable is deprecated. " \
+             "Support will be removed in a later major version. Use SEAM_ENDPOINT instead."
+      end
+    end
+
+    def lts_version
+      Seam::LTS_VERSION
+    end
+
+    def access_codes
+      @access_codes ||= Seam::Clients::AccessCodes.new(self)
+    end
+
+    def acs
+      @acs ||= Seam::Clients::Acs.new(self)
+    end
+
+    def action_attempts
+      @action_attempts ||= Seam::Clients::ActionAttempts.new(self)
+    end
+
+    def client_sessions
+      @client_sessions ||= Seam::Clients::ClientSessions.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 devices
+      @devices ||= Seam::Clients::Devices.new(self)
+    end
+
+    def events
+      @events ||= Seam::Clients::Events.new(self)
+    end
+
+    def locks
+      @locks ||= Seam::Clients::Locks.new(self)
+    end
+
+    def networks
+      @networks ||= Seam::Clients::Networks.new(self)
+    end
+
+    def noise_sensors
+      @noise_sensors ||= Seam::Clients::NoiseSensors.new(self)
+    end
+
+    def phones
+      @phones ||= Seam::Clients::Phones.new(self)
+    end
+
+    def thermostats
+      @thermostats ||= Seam::Clients::Thermostats.new(self)
+    end
+
+    def user_identities
+      @user_identities ||= Seam::Clients::UserIdentities.new(self)
+    end
+
+    def webhooks
+      @webhooks ||= Seam::Clients::Webhooks.new(self)
+    end
+
+    def workspaces
+      @workspaces ||= Seam::Clients::Workspaces.new(self)
+    end
+
+    def health
+      request_seam(:get, "/health")
+    end
+
+    # @deprecated Please use {#devices.unmanaged} instead.
+    def unmanaged_devices
+      warn "[DEPRECATION] 'unmanaged_devices' is deprecated. Please use 'devices.unmanaged' instead."
+
+      @unmanaged_devices ||= Seam::Clients::DevicesUnmanaged.new(self)
+    end
+
+    # @deprecated Please use {#access_codes.unmanaged} instead.
+    def unmanaged_access_codes
+      warn "[DEPRECATION] 'unmanaged_access_codes' is deprecated. Please use 'access_codes.unmanaged' instead."
+
+      @unmanaged_access_codes ||= Seam::Clients::AccessCodesUnmanaged.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