seamapi 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c482430d7a10dda3c715ba9d02a82f6a5be2bb5f7ae842fab31ef3ffa34c596c
-  data.tar.gz: a82f3c59221478295809af1c8573eef3618fb782a6874166d6674d6da7b9bad4
+  metadata.gz: b1201d5f8298e96925130f8e386e4df34a3d0bef7a17aa0152844755e23e0ba7
+  data.tar.gz: e9696958ff2d4456fe2189b84cf595dc1dab166894d46e40f39f3b5cf0957d41
 SHA512:
-  metadata.gz: 484070fa50f932bc4a0779ef2f7bbcda82ed9590a6724b3cb35ad0eaf15f2fe63651de0c86596abab6699627620f55b7e5870bd5112d8b868f4e9ed9571bb13d
-  data.tar.gz: b31182797acb6350387bf3dd9284a8a7adca3238b044c539cbfaa2beb7f3887a9299a5ca683af192ffc1d267273de714fae79c3ec1969653af24fe2422554235
+  metadata.gz: 96a1fa6d22023d1552a05a99e375879ca046297b6d66a95d2652d5c494040f15f35e529bf81391cdb848b16a833043806ba71a559b65997e1383cfe268118a67
+  data.tar.gz: cb3a6158e31b084aaf11117b3cc4fc9f45028bf48cd975e4a1093c1b08f6563958e31fc6477af8fd3020927e76fd713671f024281e960586d7e58d1791305b97

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    seamapi (1.2.0)
+    seamapi (1.3.1)
       http (~> 5.0.0)
 
 GEM

data/README.md

@@ -16,7 +16,7 @@ This library includes:
 
 - A predefined set of classes for API resources that
   initialize themselves dynamically from API responses.
-- Methods for all [Seam API endpoints].
+- 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

data/lib/seam/client.rb

@@ -44,6 +44,10 @@ module Seam
       @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/lib/seam/clients/access_codes.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class AccessCodes < BaseClient
+      def get(access_code_id)
+        request_seam_object(
+          :get,
+          "/access_codes/get",
+          Seam::AccessCode,
+          "access_code",
+          params: {access_code_id: access_code_id}
+        )
+      end
+
+      def list(device_or_id)
+        device_id = device_or_id.is_a?(Seam::Device) ? device_or_id.device_id : device_or_id
+
+        request_seam_object(
+          :get,
+          "/access_codes/list",
+          Seam::AccessCode,
+          "access_codes",
+          params: {device_id: device_id}
+        )
+      end
+
+      def create(device_id: nil, name: nil, code: nil, starts_at: nil, ends_at: nil)
+        action_attempt = request_seam_object(
+          :post,
+          "/access_codes/create",
+          Seam::ActionAttempt,
+          "action_attempt",
+          body: {device_id: device_id, code: code, starts_at: starts_at, ends_at: ends_at, name: name}.compact
+        )
+        action_attempt.wait_until_finished
+        # TODO: check if failed
+        Seam::AccessCode.new(action_attempt.result["access_code"], @client)
+      end
+
+      def delete(access_code_id)
+        action_attempt = request_seam_object(
+          :post,
+          "/access_codes/delete",
+          Seam::ActionAttempt,
+          "action_attempt",
+          body: {access_code_id: access_code_id}
+        )
+        action_attempt.wait_until_finished
+        action_attempt
+      end
+
+      def update(access_code_id: nil, name: nil, code: nil, starts_at: nil, ends_at: nil)
+        action_attempt = request_seam_object(
+          :post,
+          "/access_codes/update",
+          Seam::ActionAttempt,
+          "action_attempt",
+          body: {
+            access_code_id: access_code_id,
+            name: name,
+            code: code,
+            starts_at: starts_at,
+            ends_at: ends_at
+          }.compact
+        )
+        action_attempt.wait_until_finished
+        action_attempt
+      end
+    end
+  end
+end

data/lib/seam/clients/action_attempts.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class ActionAttempts < BaseClient
+      def get(action_attempt_id)
+        request_seam_object(
+          :get,
+          "/action_attempts/get",
+          Seam::ActionAttempt,
+          "action_attempt",
+          params: {action_attempt_id: action_attempt_id}
+        )
+      end
+    end
+  end
+end

data/lib/seam/clients/connect_webviews.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class ConnectWebviews < BaseClient
+      def get(connect_webview_id = nil)
+        request_seam_object(
+          :get,
+          "/connect_webviews/get",
+          Seam::ConnectWebview,
+          "connect_webview",
+          params: {connect_webview_id: connect_webview_id}
+        )
+      end
+
+      def list
+        request_seam_object(
+          :get,
+          "/connect_webviews/list",
+          Seam::ConnectWebview,
+          "connect_webviews",
+          params: {}
+        )
+      end
+
+      def create(accepted_providers: nil)
+        request_seam_object(
+          :post,
+          "/connect_webviews/create",
+          Seam::ConnectWebview,
+          "connect_webview",
+          body: {accepted_providers: accepted_providers}
+        )
+      end
+    end
+  end
+end

data/lib/seam/clients/connected_accounts.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class ConnectedAccounts < BaseClient
+      def get(connected_account_id_or_params)
+        params = if connected_account_id_or_params.is_a?(String)
+          {connected_account_id: connected_account_id_or_params}
+        else
+          connected_account_id_or_params
+        end
+
+        request_seam_object(
+          :get,
+          "/connected_accounts/get",
+          Seam::ConnectedAccount,
+          "connected_account",
+          params: params
+        )
+      end
+
+      def list(params = {})
+        request_seam_object(
+          :get,
+          "/connected_accounts/list",
+          Seam::ConnectedAccount,
+          "connected_accounts",
+          params: params
+        )
+      end
+    end
+  end
+end

data/lib/seam/clients/devices.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class Devices < BaseClient
+      def list(params = {})
+        request_seam_object(
+          :get,
+          "/devices/list",
+          Seam::Device,
+          "devices",
+          params: params
+        )
+      end
+
+      def get(device_id)
+        request_seam_object(
+          :get,
+          "/devices/get",
+          Seam::Device,
+          "device",
+          params: {device_id: device_id}
+        )
+      end
+    end
+  end
+end

data/lib/seam/clients/events.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class Events < BaseClient
+      def get(event_id: nil, event_type: nil, device_id: nil)
+        request_seam_object(
+          :get,
+          "/events/get",
+          Seam::Event,
+          "event",
+          params: {event_id: event_id, event_type: event_type, device_id: device_id}.compact
+        )
+      end
+
+      def list(since: str, event_type: nil, event_types: nil, device_id: nil, device_ids: nil)
+        request_seam_object(
+          :get,
+          "/events/list",
+          Seam::Event,
+          "events",
+          params: {event_type: event_type, event_types: event_types, device_id: device_id,
+                   device_ids: device_ids, since: since}.compact
+        )
+      end
+    end
+  end
+end

data/lib/seam/clients/locks.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class Locks < BaseClient
+      # Unlocks a door
+      #
+      # @param [String] device_id
+      # @return [Seam::ActionAttempt]
+      def unlock_door(device_or_id)
+        request_seam_object(
+          :post,
+          "/locks/unlock_door",
+          Seam::ActionAttempt,
+          "action_attempt",
+          body: {
+            device_id: device_id(device_or_id)
+          }
+        )
+      end
+
+      # Locks a door
+      #
+      # @param [String] device_id
+      # @return [Seam::ActionAttempt]
+      def lock_door(device_or_id)
+        request_seam_object(
+          :post,
+          "/locks/lock_door",
+          Seam::ActionAttempt,
+          "action_attempt",
+          body: {
+            device_id: device_id(device_or_id)
+          }
+        )
+      end
+
+      def list(params = {})
+        request_seam_object(
+          :get,
+          "/locks/list",
+          Seam::Device,
+          "locks",
+          params: params
+        )
+      end
+
+      def get(device_or_id)
+        request_seam_object(
+          :get,
+          "/locks/get",
+          Seam::Device,
+          "lock",
+          params: {
+            device_id: device_id(device_or_id)
+          }
+        )
+      end
+
+      protected
+
+      def device_id(device_or_id)
+        device_or_id.is_a?(Seam::Device) ? device_or_id.device_id : device_or_id
+      end
+    end
+  end
+end

data/lib/seam/clients/workspaces.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class Workspaces < BaseClient
+      def get(workspace_id = nil)
+        request_seam_object(
+          :get,
+          "/workspaces/get",
+          Seam::Workspace,
+          "workspace",
+          params: {workspace_id: workspace_id}
+        )
+      end
+
+      def list
+        request_seam_object(
+          :get,
+          "/workspaces/list",
+          Seam::Workspace,
+          "workspaces",
+          params: {}
+        )
+      end
+
+      def reset_sandbox(workspace_id)
+        request_seam(
+          :post,
+          "/workspaces/reset_sandbox",
+          params: {workspace_id: workspace_id}
+        )
+      end
+    end
+  end
+end

data/lib/seam/resources/access_code.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Seam
+  class AccessCode < BaseResource
+    attr_reader :access_code_id, :name, :type, :code
+
+    date_accessor :starts_at, :ends_at
+
+    include Seam::ResourceErrorsSupport
+    include Seam::ResourceWarningsSupport
+  end
+end

data/lib/seam/resources/base_resource.rb

@@ -0,0 +1,58 @@
+# 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

data/lib/seam/resources/device.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Seam
+  class Device < BaseResource
+    attr_accessor :device_id, :device_type, :properties
+
+    date_accessor :created_at
+
+    include Seam::ResourceErrorsSupport
+    include Seam::ResourceWarningsSupport
+  end
+end

data/lib/seam/resources/event.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Seam
+  class Event < BaseResource
+    attr_accessor :event_id, :event_type, :payload, :workspace_id, :device_id
+
+    date_accessor :created_at
+  end
+end

data/lib/seam/resources/workspace.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Seam
+  class Workspace < BaseResource
+    attr_accessor :workspace_id, :name, :connect_partner_name, :is_sandbox
+  end
+end

data/lib/seam/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Seam
-  VERSION = "1.2.0"
+  VERSION = "1.3.1"
 end

data/lib/seamapi.rb

@@ -12,6 +12,7 @@ require_relative "seam/clients/connect_webviews"
 require_relative "seam/clients/connected_accounts"
 require_relative "seam/clients/access_codes"
 require_relative "seam/clients/action_attempts"
+require_relative "seam/clients/events"
 require_relative "seam/resources/base_resource"
 require_relative "seam/resources/resource_warning"
 require_relative "seam/resources/resource_error"
@@ -23,6 +24,7 @@ require_relative "seam/resources/action_attempt"
 require_relative "seam/resources/connect_webview"
 require_relative "seam/resources/connected_account"
 require_relative "seam/resources/workspace"
+require_relative "seam/resources/event"
 
 module Seam
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seamapi
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Seam Labs, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 2022-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -162,16 +162,29 @@ files:
 - README.md
 - Rakefile
 - lib/seam/client.rb
+- lib/seam/clients/access_codes.rb
+- lib/seam/clients/action_attempts.rb
 - lib/seam/clients/base_client.rb
+- lib/seam/clients/connect_webviews.rb
+- lib/seam/clients/connected_accounts.rb
+- lib/seam/clients/devices.rb
+- lib/seam/clients/events.rb
+- lib/seam/clients/locks.rb
+- lib/seam/clients/workspaces.rb
 - lib/seam/logger.rb
 - lib/seam/request.rb
+- lib/seam/resources/access_code.rb
 - lib/seam/resources/action_attempt.rb
+- lib/seam/resources/base_resource.rb
 - lib/seam/resources/connect_webview.rb
 - lib/seam/resources/connected_account.rb
+- lib/seam/resources/device.rb
+- lib/seam/resources/event.rb
 - lib/seam/resources/resource_error.rb
 - lib/seam/resources/resource_errors_support.rb
 - lib/seam/resources/resource_warning.rb
 - lib/seam/resources/resource_warnings_support.rb
+- lib/seam/resources/workspace.rb
 - lib/seam/version.rb
 - lib/seamapi.rb
 homepage: https://github.com/seamapi/ruby