sesame-ruby 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 081f92b213e23a8c277f645f5e12c36cf8cfad72
-  data.tar.gz: f2ef6fa38cfcb145621ca1fd872d55764ab31223
+SHA256:
+  metadata.gz: 2fc54666ff84ba64050d56a9e709518af3d1d9b987e2043faf2fe9569648187e
+  data.tar.gz: a87fcae71e0d571d1f52b21e260cda68d2a561100c55ae6de77fb3c27330ac0b
 SHA512:
-  metadata.gz: 4b634285cb4210d1b201e5d71feb158e69a2e4522f1db9c42c06ef5fc354b7895fbc3d1e154deeb8309d470cd0020a2bd828cb82b1a21f73cba99350b262d7c8
-  data.tar.gz: 6c861edb1b86e1dcff6eec9a4d196a7356a67e2a5ea1de989d23dd739403e0481a52275e8078683564a566912285e6ad4e83580f901dfd90c40446dbadd977e1
+  metadata.gz: e4a8c929f826776b4862de1a4ab5a9c5d988902470937ae008fafdef4d80bc434ca8adcd0d63e2838b5033c3dd52bc56c95730a2df338586d3134483a3f2b21b
+  data.tar.gz: eae3efe057655f100512f5d46354017834a5595da65d3360a1c4ca7573ae7c6395c7bed1bc4155f790f2ece123a96f39d7ea1380ccc2748db46e69408fd427c2

data/.rubocop.yml

@@ -7,10 +7,19 @@ Naming/AccessorMethodName:
   Exclude:
     - 'lib/sesame/api.rb'
 
-Style/MethodMissing:
+Style/MethodMissingSuper:
+  Exclude:
+    - 'spec/*.rb'
+
+Style/MissingRespondToMissing:
   Exclude:
     - 'spec/*.rb'
 
 Metrics/BlockLength:
   Exclude:
     - 'spec/*.rb'
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false

data/.rubocop_todo.yml

@@ -10,7 +10,7 @@
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 100
+  Max: 115
 
 # Offense count: 5
 Style/Documentation:

data/README.md

@@ -25,18 +25,19 @@ Or install it yourself as:
 
 ## Usage
 
-    # Log into the API
-    > client = Sesame::Client.new(email: 'abc@i-lovecandyhouse.co', password: 'super-strong-password')
-    => #<Sesame::Client:0x007fa1a81771d0 user: abc@i-lovecandyhouse.co>
+Please create the your auth token by logging into the [CANDY HOUSE Dashboard](https://my.candyhouse.co/) with your CANDY HOUSE account.
 
-    # Get an array of all API-enabled devices associated with the account
+    > client = Sesame::Client.new(auth_token: 'your_auth_token')
+    => #<Sesame::Client:0x007fa1a81771d0>
+
+    # Get an array of all devices associated with the account
     > client.sesames
-    => [#<Sesame::Sesame:0x007fa1aa3bb188 device_id: ABC1234567, nickname: Front door, is_unlocked: true, api_enabled: true, battery: 100>,
-    #<Sesame::Sesame:0x007fa1aa3bb160 device_id: DEF7654321, nickname: Back door, is_unlocked: false, api_enabled: false, battery: 80>]
+    => [#<Sesame::Sesame:0x007fa1aa3bb188 device_id: ABC1234567>,
+    #<Sesame::Sesame:0x007fa1aa3bb160 device_id: DEF7654321>]
 
     # Get a single device
     > sesame = client.sesame(device_id: 'ABC1234567')
-    => #<Sesame::Sesame:0x007fa1aa3bb188 device_id: ABC1234567, nickname: Front door, is_unlocked: true, api_enabled: true, battery: 100>
+    => [#<Sesame::Sesame:0x007fa1aa3bb188 device_id: ABC1234567>
 
     # Control the device
     > sesame.unlock
@@ -44,6 +45,16 @@ Or install it yourself as:
     > sesame.lock
     => true
 
+    # Show the device status
+    > sesame.locked?
+    => true
+    > sesame.battery
+    => 100
+
+    # Sync the device status
+    > sesame.refresh!
+    => [#<Sesame::Sesame:0x007fa1aa3bb188 device_id: ABC1234567>
+
 ## Contributing
 
 1. Fork it

data/lib/sesame-ruby.rb

@@ -1 +1 @@
-require File.expand_path('../sesame', __FILE__)
+require File.expand_path('sesame', __dir__)

data/lib/sesame/api.rb

@@ -3,11 +3,7 @@ require 'json'
 
 module Sesame
   module Api
-    ENDPOINT_URL = 'https://api.candyhouse.co/v1/'.freeze
-
-    def authorized?
-      !@auth_token.nil?
-    end
+    ENDPOINT_URL = 'https://api.candyhouse.co/public'.freeze
 
     def client
       @client ||= Faraday.new(url: ENDPOINT_URL)
@@ -18,21 +14,16 @@ module Sesame
       self
     end
 
-    def login(email:, password:)
-      auth_response = post('accounts/login', email: email, password: password)
-      auth_token(auth_response['authorization'])
-    end
-
     def get_sesames
       get('sesames')
     end
 
     def get_sesame(device_id:)
-      get("sesames/#{device_id}")
+      get("sesame/#{device_id}")
     end
 
-    def control_sesame(device_id:, type:)
-      post("sesames/#{device_id}/control", type: type)
+    def control_sesame(device_id:, command:)
+      post("sesame/#{device_id}", command: command)
     end
 
     def get(path)
@@ -47,7 +38,7 @@ module Sesame
       response = client.send(method) do |req|
         req.url path
         req.headers['Content-Type'] = 'application/json'
-        req.headers['X-Authorization'] = @auth_token unless @auth_token.nil?
+        req.headers['Authorization'] = @auth_token unless @auth_token.nil?
         req.body = params.to_json unless params.nil?
       end
       parse_response(response)
@@ -56,6 +47,7 @@ module Sesame
     def parse_response(response)
       parsed_response = response.headers['Content-Length'].to_i > 0 ? JSON.parse(response.body) : ''
       raise Error.new(response.status, parsed_response) if response.status >= 400
+
       parsed_response
     end
   end

data/lib/sesame/client.rb

@@ -2,13 +2,12 @@ module Sesame
   class Client
     include Api
 
-    def initialize(email:, password:)
-      login(email: email, password: password)
-      @email = email
+    def initialize(auth_token:)
+      auth_token(auth_token)
     end
 
     def sesames
-      get_sesames['sesames'].collect do |sesame_attrs|
+      get_sesames.collect do |sesame_attrs|
         Sesame.new(sesame_attrs).auth_token(@auth_token)
       end
     end
@@ -18,7 +17,7 @@ module Sesame
     end
 
     def inspect
-      %(#<#{self.class.name}:#{format('0x%.14x', (object_id << 1))} user: #{@email}>)
+      %(#<#{self.class.name}:#{format('0x%<object_id>.14x', object_id: (object_id << 1))}>)
     end
   end
 end

data/lib/sesame/error.rb

@@ -3,14 +3,13 @@ module Sesame
     attr_reader :status, :code
 
     def initialize(status, data)
-      super(data['message'])
+      super(data['error'])
       @data = data
       @status = status
-      @code = data['code'].to_i
     end
 
     def to_s
-      %(#{@data['message']} HTTP: #{status}, API: #{@data['code']})
+      %(#{@data['error']} HTTP: #{status})
     end
   end
 end

data/lib/sesame/sesame.rb

@@ -10,39 +10,29 @@ module Sesame
       @state['device_id']
     end
 
-    def nickname
-      @state['nickname']
+    def locked?
+      truthy?(@state['locked'])
     end
-
-    def unlocked?
-      truthy?(@state['is_unlocked'])
-    end
-    alias is_unlocked unlocked?
+    alias locked locked?
 
     def state
-      unlocked? ? 'unlocked' : 'locked'
-    end
-
-    def api_enabled?
-      truthy?(@state['api_enabled'])
+      locked? ? 'locked' : 'unlocked'
     end
-    alias api_enabled api_enabled?
 
     def battery
       @state['battery'].to_i
     end
 
     def lock
-      control(type: 'lock')
+      control(command: 'lock')
     end
 
     def unlock
-      control(type: 'unlock')
+      control(command: 'unlock')
     end
 
     def inspect
-      details = @state.keys.collect { |k| "#{k}: #{send(k.to_sym)}" }.join(', ')
-      %(#<#{self.class.name}:#{format('0x%.14x', (object_id << 1))} #{details}>)
+      %(#<#{self.class.name}:#{format('0x%<object_id>.14x', object_id: (object_id << 1))} device_id: #{device_id}>)
     end
 
     def refresh!
@@ -56,8 +46,8 @@ module Sesame
       (value == true) || (value == 'true')
     end
 
-    def control(type:)
-      control_sesame(device_id: device_id, type: type)
+    def control(command:)
+      control_sesame(device_id: device_id, command: command)
       refresh!
       true
     end

data/lib/sesame/version.rb

@@ -1,3 +1,3 @@
 module Sesame
-  VERSION = '0.1.2'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/sesame.gemspec

@@ -1,5 +1,4 @@
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sesame/version'
 
@@ -18,18 +17,18 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'json'
   spec.add_dependency 'faraday'
+  spec.add_dependency 'json'
 
   spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'faraday-detailed_logger'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'faraday-detailed_logger'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: sesame-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael B. Klein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-18 00:00:00.000000000 Z
+date: 2019-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,33 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: faraday-detailed_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -109,35 +109,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday-detailed_logger
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -235,8 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the CANDYHOUSE Sesame API (https://docs.candyhouse.co/)