sesame-ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c01ae5ee19a7b5bb25718ea32393fd410caf53e
+  data.tar.gz: dba18b3e28a9efad5904bfc587bd5895bcc274f3
+SHA512:
+  metadata.gz: 7985e3d5d683dd25b9bc4b6c1c0d347eaafeb27d71f42b6a125e02eb49d6a7dcc7e03be653f252cb89f884ed45f9c010d5bb6044ff2a784cab3a5f6c982b03ef
+  data.tar.gz: a38d66aa41820de7bbaadafc6d38e50a5a6c22ac3482f9da1e721d43866467a82168b2501afd05bcbc4f1e0cc75e26a9bcddab6f40d52106857b621a9b027f79

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,16 @@
+inherit_from: .rubocop_todo.yml
+Naming/FileName:
+  Exclude:
+    - 'lib/sesame-ruby.rb'
+
+Naming/AccessorMethodName:
+  Exclude:
+    - 'lib/sesame/api.rb'
+
+Style/MethodMissing:
+  Exclude:
+    - 'spec/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/*.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,24 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-10-06 10:22:19 -0500 using RuboCop version 0.50.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 100
+
+# Offense count: 5
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/sesame.rb'
+    - 'lib/sesame/api.rb'
+    - 'lib/sesame/client.rb'
+    - 'lib/sesame/error.rb'
+    - 'lib/sesame/sesame.rb'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sesame.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Michael Klein
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+[![Gem Version](https://badge.fury.io/rb/sesame-ruby.png)](http://badge.fury.io/rb/sesame-ruby)
+[![Build Status](https://travis-ci.org/mbklein/sesame-ruby.svg?branch=master)](https://travis-ci.org/mbklein/sesame-ruby)
+[![Coverage Status](https://coveralls.io/repos/mbklein/sesame-ruby/badge.svg?branch=master&service=github)](https://coveralls.io/github/mbklein/sesame-ruby?branch=master)
+
+# Sesame
+
+This gem provides a simple Ruby wrapper around the [CANDY HOUSE Sesame API](https://docs.candyhouse.co/) to control
+Sesame Bluetooth and Internet-connected locks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sesame-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sesame-ruby
+
+## 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>
+
+    # Get an array of all API-enabled 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>]
+
+    # 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>
+
+    # Control the device
+    > sesame.unlock
+    => true
+    > sesame.lock
+    => true
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run style checker'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+end
+
+desc 'Run all tests.'
+task :ci do
+  Rake::Task[:rubocop].invoke
+  Rake::Task[:spec].invoke
+end
+
+task default: :ci

data/lib/sesame-ruby.rb

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

data/lib/sesame.rb

@@ -0,0 +1,9 @@
+require 'sesame/version'
+require 'sesame/error'
+require 'sesame/api'
+require 'sesame/client'
+require 'sesame/sesame'
+
+module Sesame
+  # Your code goes here...
+end

data/lib/sesame/api.rb

@@ -0,0 +1,62 @@
+require 'faraday'
+require 'json'
+
+module Sesame
+  module Api
+    ENDPOINT_URL = 'https://api.candyhouse.co/v1/'.freeze
+
+    def authorized?
+      !@auth_token.nil?
+    end
+
+    def client
+      @client ||= Faraday.new(url: ENDPOINT_URL)
+    end
+
+    def auth_token(value)
+      @auth_token = value
+      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("sesame/#{device_id}")
+    end
+
+    def control_sesame(device_id:, type:)
+      post("sesame/#{device_id}/control", type: type)
+    end
+
+    def get(path)
+      call(:get, path)
+    end
+
+    def post(path, params)
+      call(:post, path, params)
+    end
+
+    def call(method, path, params = nil)
+      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.body = params.to_json unless params.nil?
+      end
+      parse_response(response)
+    end
+
+    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
+end

data/lib/sesame/client.rb

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

data/lib/sesame/error.rb

@@ -0,0 +1,16 @@
+module Sesame
+  class Error < StandardError
+    attr_reader :status, :code
+
+    def initialize(status, data)
+      super(data['message'])
+      @data = data
+      @status = status
+      @code = data['code'].to_i
+    end
+
+    def to_s
+      %(#{@data['message']} HTTP: #{status}, API: #{@data['code']})
+    end
+  end
+end

data/lib/sesame/sesame.rb

@@ -0,0 +1,65 @@
+module Sesame
+  class Sesame
+    include Api
+
+    def initialize(attrs = {})
+      @state = attrs
+    end
+
+    def device_id
+      @state['device_id']
+    end
+
+    def nickname
+      @state['nickname']
+    end
+
+    def unlocked?
+      truthy?(@state['is_unlocked'])
+    end
+    alias is_unlocked unlocked?
+
+    def state
+      unlocked? ? 'unlocked' : 'locked'
+    end
+
+    def api_enabled?
+      truthy?(@state['api_enabled'])
+    end
+    alias api_enabled api_enabled?
+
+    def battery
+      @state['battery'].to_i
+    end
+
+    def lock
+      control(type: 'lock')
+    end
+
+    def unlock
+      control(type: '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}>)
+    end
+
+    def refresh!
+      @state.merge!(get_sesame(device_id: device_id))
+      self
+    end
+
+    private
+
+    def truthy?(value)
+      (value == true) || (value == 'true')
+    end
+
+    def control(type:)
+      control_sesame(device_id: device_id, type: type)
+      refresh!
+      true
+    end
+  end
+end

data/lib/sesame/version.rb

@@ -0,0 +1,3 @@
+module Sesame
+  VERSION = '0.1.1'.freeze
+end

data/sesame.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sesame/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sesame-ruby'
+  spec.version       = Sesame::VERSION
+  spec.authors       = ['Michael B. Klein']
+  spec.email         = ['mbklein@gmail.com']
+
+  spec.summary       = 'Ruby wrapper for the CANDYHOUSE Sesame API (https://docs.candyhouse.co/)'
+  spec.homepage      = 'https://github.com/mbklein/sesame-ruby'
+  spec.license       = 'Apache2'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'json'
+  spec.add_dependency 'faraday'
+
+  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 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  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

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: sesame-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Michael B. Klein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-detailed_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- mbklein@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sesame-ruby.rb
+- lib/sesame.rb
+- lib/sesame/api.rb
+- lib/sesame/client.rb
+- lib/sesame/error.rb
+- lib/sesame/sesame.rb
+- lib/sesame/version.rb
+- sesame.gemspec
+homepage: https://github.com/mbklein/sesame-ruby
+licenses:
+- Apache2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the CANDYHOUSE Sesame API (https://docs.candyhouse.co/)
+test_files: []