seamapi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 173cc34127a115428d6d17298a4766932b8c27384528bbe2127d6afa581f2cae
+  data.tar.gz: 91a107fa9a2e9b88dec0afd88cb1f0cb95ec17496903261738e50d103d656636
+SHA512:
+  metadata.gz: 63dbdd58445cc484106ebeae1bd1c0a36638bbe01c66fef315bc79abb04ea50cdffd6cfbeb92d3776849abf1ed01894434bc1f688c23fe1e21cc2f65133fc587
+  data.tar.gz: 5b5a89d6c4ab8944ac322db1f555c59bc4f199c9e440a806d74b79c6169dc6864612f886e67859766fc525bec0b6f6a59759b4c6597db6b00eecb7803de6d2f3

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  IgnoredMethods: ['describe', 'context', 'xdescribe']
+
+Gemspec/RequireMFA:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    seamapi (0.1.0)
+      http (~> 5.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.5)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashdiff (1.0.1)
+    http (5.0.4)
+      addressable (~> 2.8)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.4.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    llhttp-ffi (0.4.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.31.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.2.0)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  seamapi!
+  webmock (~> 3.0.0)
+
+BUNDLED WITH
+   2.3.16

data/README.md

@@ -0,0 +1,41 @@
+# Seam API Ruby Gem
+
+The Seam Ruby library provides convenient access to the Seam API from applications written
+in the Ruby language. It includes a pre-defined set of classes for API resources that
+initialize themselves dynamically from API responses.
+
+This library also includes:
+
+- [All Seam Web API Methods](https://docs.seam.co/latest/api-endpoints/overview)
+- Simplified asynchronous flows, including listening for events or actions to finish
+
+## Installation
+
+Add the following line to your Gemfile
+
+    gem "seamapi"
+
+Then execute
+
+    $ bundle
+
+## Usage
+
+> To use this sdk, you'll need to generate an API Key on the [Seam Dashboard](https://dashboard.getseam.com)
+
+```ruby
+seam = Seam::Client.new(api_key: "MY_API_KEY")
+
+devices = seam.devices.list
+
+my_door = devices.first
+
+seam.locks.unlock(my_door).wait_until_finished
+
+```
+
+## Development
+
+To play around with this module interactively in development, first run `bundle`
+then run `bin/console` to get an interactive console. You can then use a sandbox
+API key to play with the any new features you're testing!

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/seam/client.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Seam
+  class Client
+    attr_accessor :api_key, :base_uri, :debug
+
+    def initialize(api_key:, base_uri: "https://connect.getseam.com", debug: false)
+      @api_key = api_key
+      @base_uri = base_uri
+      @debug = debug
+    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 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 request_seam_object(method, path, klass, inner_object, config = {})
+      response = request_seam(method, path, config)
+
+      data = response[inner_object]
+
+      klass.load_from_response(data, @client)
+    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

data/lib/seam/clients/access_codes.rb

@@ -0,0 +1,52 @@
+# 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_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
+    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/base_client.rb

@@ -0,0 +1,17 @@
+# 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
+    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,17 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class ConnectedAccounts < BaseClient
+      def get(connected_account_id = nil)
+        request_seam_object(
+          :get,
+          "/connected_accounts/get",
+          Seam::ConnectedAccount,
+          "connected_account",
+          params: { connected_account_id: connected_account_id }
+        )
+      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/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,
+          "devices",
+          params: params
+        )
+      end
+
+      def get(device_or_id)
+        request_seam_object(
+          :get,
+          "/locks/get",
+          Seam::Device,
+          "device",
+          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,36 @@
+# 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
+        Seam::Request.new(
+          @client.api_key,
+          @client.base_uri
+        ).perform(
+          :post, "/workspaces/reset_sandbox", {}
+        )
+      end
+    end
+  end
+end

data/lib/seam/logger.rb

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

data/lib/seam/request.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "http"
+
+module Seam
+  class Request
+    attr_reader :base_uri, :api_key, :debug
+
+    class Error < StandardError
+      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 && (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

data/lib/seam/resources/access_code.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Seam
+  class AccessCode < BaseResource
+    attr_reader :access_code_id, :name, :starts_at, :ends_at, :type, :created_at, :code
+  end
+end

data/lib/seam/resources/action_attempt.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Seam
+  class ActionAttempt < BaseResource
+    attr_accessor :action_attempt_id, :action_type, :status, :result
+
+    def wait_until_finished
+      while @status == "pending"
+        res = Seam::Request.new(@client.api_key, @client.base_uri).perform(
+          :get,
+          "/action_attempts/get",
+          params: { action_attempt_id: @action_attempt_id }
+        )
+        update_from_response(res["action_attempt"])
+        sleep(0.2)
+      end
+      self
+    end
+  end
+end

data/lib/seam/resources/base_resource.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Seam
+  class BaseResource
+    attr_accessor :data
+
+    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
+  end
+end

data/lib/seam/resources/connect_webview.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Seam
+  class ConnectWebview < BaseResource
+    attr_accessor :connect_webview_id, :custom_redirect_url, :url, :workspace_id, :device_selection_mode,
+                  :accepted_providers, :accepted_devices, :any_provider_allowed, :any_device_allowed, :created_at,
+                  :login_successful, :status
+  end
+end

data/lib/seam/resources/connected_account.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Seam
+  class ConnectedAccount < BaseResource
+    attr_accessor :connected_account_id, :created_at, :user_identifier, :account_type
+  end
+end

data/lib/seam/resources/device.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Seam
+  class Device < BaseResource
+    attr_accessor :device_id, :device_type, :properties
+  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

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

data/lib/seam.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "seam/version"
+require_relative "seam/request"
+require_relative "seam/logger"
+require_relative "seam/client"
+require_relative "seam/clients/base_client"
+require_relative "seam/clients/devices"
+require_relative "seam/clients/locks"
+require_relative "seam/clients/workspaces"
+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/resources/base_resource"
+require_relative "seam/resources/device"
+require_relative "seam/resources/access_code"
+require_relative "seam/resources/action_attempt"
+require_relative "seam/resources/connect_webview"
+require_relative "seam/resources/connected_account"
+require_relative "seam/resources/workspace"
+
+module Seam
+end

data/sig/seamapi.rbs

@@ -0,0 +1,4 @@
+module Seam
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: seamapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Abimael Martell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: seamapi is a Ruby gem that provides a simple interface to Seam Connect's
+  API.
+email:
+- abi@getseam.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/seam.rb
+- 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/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/workspace.rb
+- lib/seam/version.rb
+- sig/seamapi.rbs
+homepage: https://github.com/seamapi/ruby
+licenses: []
+metadata:
+  homepage_uri: https://github.com/seamapi/ruby
+  source_code_uri: https://github.com/seamapi/ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Seam API Ruby Library
+test_files: []