lockitron 0.0.3 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0246c86899da0c2aef15c8eabd4de799cddcf17a
+  data.tar.gz: eb8954188083b4be0f7f219fc0388f357c4f78c6
+SHA512:
+  metadata.gz: 959d22f19aca2ddda63f8e4b1675adf1ea75e8e3041d0bb2c1a28eef1ba39c27d4de32e6de02a505ba6155c8625b3396a123096cb0ec4d20056ab0e14e9bc928
+  data.tar.gz: 7017e0f1361f7431796cc5cc167e441cfae3c8d8c3d6bc8ec9c144fdf2546d3b14c9560af206453bc7878079d26082d0c3bc5f3cf40db42aaf346e16c9a7ada9

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -1,9 +1,8 @@
 *.gem
 *.rbc
-*.sublime-project
-*.sublime-workspace
 .bundle
 .config
+.env
 .yardoc
 Gemfile.lock
 InstalledFiles

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p195

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+    - 1.9.3
+    - 2.0.0
+script: rspec spec

data/{LICENSE → LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Jarred Sumner
+Copyright (c) 2013 Kurt Nelson
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,79 +1,60 @@
-# Lockitron
-[Lockitron](https://lockitron.com) lets you unlock your front door from anywhere in the world, including your smartphone. We have an iPhone app, an Android app, a webapp, a mobile web app, a REST API, and now, a RubyGem.
+#Lockitron
+[![Build Status](https://secure.travis-ci.org/kurtisnelson/lockitron.png)](http://travis-ci.org/kurtisnelson/lockitron)
+[![Gem Version](https://badge.fury.io/rb/lockitron.png)](http://badge.fury.io/rb/lockitron)
+[![Code Climate](https://codeclimate.com/github/kurtisnelson/lockitron.png)](https://codeclimate.com/github/kurtisnelson/lockitron)
+[![Coverage Status](https://coveralls.io/repos/kurtisnelson/lockitron/badge.png?branch=master)](https://coveralls.io/r/kurtisnelson/lockitron)
+[![Dependency Status](https://gemnasium.com/kurtisnelson/lockitron.png)](https://gemnasium.com/kurtisnelson/lockitron)
+[Documentation](http://rubydoc.info/gems/lockitron/)
 
-This is a very early version of the gem. With it, you can lock, or unlock Lockitrons by their name.
+Communicates with the [Lockitron API](http://api.lockitron.com)
 
-## Prerequisites
+##Usage
 
-You need two things for this gem. Firstly, you need a Lockitron-powered door lock, which you can buy at https://lockitron.com. Secondly, you'll need an access token. If you'll only use this for yourself, then go grab [your access token](https://api.lockitron.com/v1/oauth/applications). Right now, the gem doesn't handle authorization, so you'll need to manually switch out access tokens. We use OAuth2, and we have a guide on [authenticating with it](https://api.lockitron.com/v1/getting_started/authenticating_with_oauth).
+  `gem install lockitron`
 
-### Setting an Access Token
-To use the Lockitron gem or as a shell script, you'll need to set an access token. You can set it in Ruby or in bash, and it'll work either way. Although, I recommend that you set the access token as an environment variable. I've shown how to do that below
+If you don't have an OAuth2 token already for the user of your app
 
-#### From Bash
+  ``ruby
+  auther = Lockitron::Auth.new(client_id: 'YOUR_OAUTH_CLIENT_ID', client_secret: 'YOUR_OAUTH_CLIENT_SECRET', redirect_uri: 'URI_FOR_CODE')
+  auther.authorization_url #Send your user to this URL to authenticate your app
+  auther.token_from_code 'code parameter on the redirect uri'
+  auther.token # Store this, it is your token
+  ``
 
-Storing the access token as an environment variable: (Remember to replace MY_ACCESS_TOKEN with your access token!)
-```bash
-echo "export LOCKITRON_ACCESS_TOKEN=MY_ACCESS_TOKEN" >> ~/.bashrc && exec $SHELL
-```
+To use, you will want a User object
 
-#### From Ruby:
+  `user = Lockitron::User('user oauth token')`
 
-```ruby
-Lockitron::Locks.access_token = MY_ACCESS_TOKEN
-```
+Get all the user's locks
 
-## Usage (Bash)
-You can lock or unlock your Lockitron-powered locks, and list the available locks.
+  `locks = user.locks`
 
-### Locking or Unlocking
+This returns an array of Lock objects, which have a name and uuid method to find the one you want.
 
-To lock, run:
+Then to actually do something
 
-```bash
-lockitron lock LOCK_NAME
-```
+  ``ruby
+  lock.as user do |l|
+    l.unlock
+  end
+  ``
 
-To unlock, run:
+For more examples, check the request tests in spec/request or the documentation.
 
-```bash
-lockitron unlock LOCK_NAME
-```
+##Contributing to lockitron
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-### Listing Locks
+If you want messages from Faraday, set DEBUG in your environment to true.
 
-To list all available locks, run:
-
-```bash
-lockitron list
-```
-
-###
-
-## Usage (Ruby)
-
-You can lock or unlock your locks by their name. 
-
-### Locking & Unlocking
-
-To unlock by name, run:
-
-```ruby
-Lockitron::Locks.unlock("Lock Name")
-```
-
-To lock by name, run:
-
-```ruby
-Lockitron::Locks.lock("Lock Name")
-```
-
-### Listing Locks
-
-To list all available locks, run:
-
-```ruby
-Lockitron::Locks.list
-```
+##Copyright
 
+Copyright (c) 2012 Kurt Nelson. See LICENSE.txt for
+further details.
 

data/Rakefile

@@ -1,2 +1 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"

data/lib/lockitron.rb

@@ -1,5 +1,7 @@
-require 'rubygems'
-require 'json'
-require 'rest-client'
-
-require 'lockitron/locks'
+require "lockitron/version"
+require 'lockitron/auth'
+require 'lockitron/user'
+
+module Lockitron
+  API_ENDPOINT = "https://api.lockitron.com/v1"
+end

data/lib/lockitron/auth.rb

@@ -0,0 +1,24 @@
+require 'oauth2'
+module Lockitron
+  class Auth
+    def initialize(params = {})
+      @client_id = params[:client_id]
+      @client_secret = params[:client_secret]
+      @redirect_uri = params[:redirect_uri]
+      @oauth_client = OAuth2::Client.new(@client_id, @client_secret, site: API_ENDPOINT)
+      @oauth_client.options[:token_url] = "/v1/oauth/token"
+    end
+
+    def token_from_code auth_code
+      @token = @oauth_client.auth_code.get_token(auth_code, redirect_uri: @redirect_uri)
+    end
+
+    def token
+      @token.token
+    end
+
+    def authorization_url
+      "#{Lockitron::API_ENDPOINT}/oauth/authorize?client_id=#{@client_id}&response_type=code&redirect_uri=#{@redirect_uri}"
+    end
+  end
+end

data/lib/lockitron/lock.rb

@@ -0,0 +1,88 @@
+module Lockitron
+  class Lock
+    attr_reader :name
+    attr_reader :uuid
+
+    # Initializes a lock from a Lockitron JSON representation
+    # @param [Hash] JSON
+    # @return [Lockitron::Lock]
+    def self.from_json blob
+      id = blob['id']
+      name = blob['name']
+      self.new(name: name, uuid: id)
+    end
+
+    # A lock
+    # @param [Hash] options
+    # @options params [String] UUID (Required)
+    # @options params [String] Name
+    def initialize(params={})
+      @uuid = params[:uuid]
+      @name = params[:name]
+    end
+
+    # Takes a block of actions to perform as user
+    # @param user [Lockitron::User]
+    def as user
+      @user = user
+      yield self
+      @user = nil
+    end
+
+    # Sets up the user context 
+    # @param user [Lockitron::User]
+    def insert_key user
+      @user = user
+    end
+
+    # Tears down the user context
+    def remove_key
+      @user = nil
+    end
+
+    # Locks this lock
+    # @note Must be performed in user context
+    # @return [Hash] API response
+    def lock
+      require_user
+      @user.post "locks/#{@uuid}/lock"
+    end
+
+    # Unlocks this lock
+    # @note Must be performed in user context
+    # @return [Hash] API response
+    def unlock
+      require_user
+      @user.post "locks/#{@uuid}/unlock"
+    end
+
+    # Invites a user to this lock.
+    # @note Must be performed in user context
+    #
+    # @param [Hash] Options
+    # @options params [String] :phone
+    # @options params [String] :email
+    # @options params [String] :role Defaults to guest
+    # @options params [String] :fullname
+    # @options params [Time] :start Optional key start time
+    # @options params [Time] :expiration Optional key stop time
+    # @return [Hash] API response
+    def invite(params={})
+      require_user
+      params[:role] ||= 'guest' 
+      raise InvalidArgument, "Phone or email required" unless params[:email] or params[:phone]
+      if params[:start]
+        params[:start] = params[:start].to_i
+      else
+        params[:start] = Time.now.to_i
+      end
+      params[:expiration] = params[:expiration].to_i if params[:expiration]
+      @user.post "locks/#{@uuid}/add", params
+    end
+
+    private
+    def require_user
+      raise InvalidArgument, "Not in user context" unless @user
+    end
+  end
+end

data/lib/lockitron/user.rb

@@ -0,0 +1,30 @@
+require 'json'
+require_relative 'lock'
+module Lockitron
+  class User
+    def initialize token
+      @token = token
+    end
+
+    def locks
+      get('locks').map {|lock| Lockitron::Lock.from_json lock['lock']} 
+    end
+
+    def get action
+      resp = Faraday.get "#{API_ENDPOINT}/#{action}", {access_token: @token}
+      process resp
+    end
+    def post action, params = {}
+      params.merge!({access_token: @token})
+      resp = Faraday.post "#{API_ENDPOINT}/#{action}", params
+      process resp
+    end
+
+    private
+    def process resp
+      raise "Not authorized" if resp.status == 403
+      raise "Bad API Request: #{resp.status}" unless resp.status == 200
+      data = JSON.parse resp.body
+    end
+  end
+end

data/lib/lockitron/version.rb

@@ -1,3 +1,3 @@
 module Lockitron
-  VERSION = "0.0.3"
+  VERSION = "1.0.0"
 end

data/lockitron.gemspec

@@ -1,20 +1,40 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/lockitron/version', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lockitron/version'
 
-Gem::Specification.new do |gem|
-  gem.name = "lockitron"
-  gem.homepage = "http://github.com/jarred-sumner/lockitron"
-  gem.license = "MIT"
-  gem.summary = %Q{Lock and unlock your lock your Lockitron-powered locks from bash and Ruby}
-  gem.description = %Q{Lockitron lets you unlock your front door from anywhere in the world, including your smartphone. We have an iPhone app, an Android app, a webapp, a mobile web app, a REST API, and now, a RubyGem.}
-  gem.email = "jarred@lockitron.com"
-  gem.authors = ["Jarred Sumner"]
-  gem.add_dependency 'rest-client'
-  gem.add_dependency 'thor'
-  gem.add_dependency 'json'
+Gem::Specification.new do |s|
+  s.name = "lockitron"
+  s.version = Lockitron::VERSION
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.require_paths = ["lib"]
-  gem.version       = Lockitron::VERSION
+  s.authors = ["Kurt Nelson"]
+  s.date = "2013-06-22"
+  s.description = "Communicate with a Lockitron"
+  s.email = "kurtisnelson@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.homepage = "http://github.com/kurtisnelson/lockitron"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Access the Lockitron API"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'faraday', ">= 0.8.4"
+  s.add_dependency 'hashie'
+  s.add_dependency 'oauth2'
+  s.add_development_dependency 'rspec', ">= 2.8.0"
+  s.add_development_dependency 'rdoc', ">= 3.12"
+  s.add_development_dependency 'bundler', ">= 1.0.0"
+  s.add_development_dependency 'dotenv'
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'webmock'
 end
+

data/spec/fixtures/vcr_cassettes/invite.yml

@@ -0,0 +1,101 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.lockitron.com/v1/locks/a397ef51-7b33-46dd-9a96-53eb1a7ea07f/add
+    body:
+      encoding: US-ASCII
+      string: email=someone%40example.com&role=guest&start=1372028005&access_token=<OAUTH_TOKEN>
+    headers:
+      User-Agent:
+      - Faraday v0.8.7
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 23 Jun 2013 22:52:18 GMT
+      Server:
+      - Apache
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - '"1b8915afe54cbed95ed2e53529d49aee"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 18e6903a65af48755c9e3711e1ee0e26
+      X-Runtime:
+      - '1.318250'
+      X-Rack-Cache:
+      - invalidate, pass
+      Status:
+      - '200'
+      Strict-Transport-Security:
+      - max-age=15768000
+      Content-Length:
+      - '383'
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: '{"id":"7f02c05a-b94d-4c5a-814e-3bb5a07603b9","start":null,"expire":null,"lock_id":"a397ef51-7b33-46dd-9a96-53eb1a7ea07f","role":"guest","valid":true,"visible":true,"user":{"id":"41d0322d-b03d-4eef-935b-904e05831496","email":"someone@example.com","phone":null,"human_phone":null,"first_name":null,"last_name":null,"full_name":null,"best_name":"someone@example.com","activated":false}}'
+    http_version: 
+  recorded_at: Sun, 23 Jun 2013 22:53:27 GMT
+- request:
+    method: post
+    uri: https://api.lockitron.com/v1/locks/a397ef51-7b33-46dd-9a96-53eb1a7ea07f/add
+    body:
+      encoding: US-ASCII
+      string: email=someone2%40example.com&start=1372031207&role=guest&access_token=<OAUTH_TOKEN>
+    headers:
+      User-Agent:
+      - Faraday v0.8.7
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 23 Jun 2013 22:52:19 GMT
+      Server:
+      - Apache
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - '"95b36bd88e1fb7dcb089e1535bee7815"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 4f18fb69a1be7b921bc49b97e5756bfb
+      X-Runtime:
+      - '1.410540'
+      X-Rack-Cache:
+      - invalidate, pass
+      Status:
+      - '200'
+      Strict-Transport-Security:
+      - max-age=15768000
+      Content-Length:
+      - '395'
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: '{"id":"402d031d-21be-4442-9bbb-2ce07ccf84b0","start":-18864896400.0,"expire":null,"lock_id":"a397ef51-7b33-46dd-9a96-53eb1a7ea07f","role":"guest","valid":true,"visible":true,"user":{"id":"40d877eb-03f4-4d66-b631-80f3d54fd832","email":"someone2@example.com","phone":null,"human_phone":null,"first_name":null,"last_name":null,"full_name":null,"best_name":"someone2@example.com","activated":false}}'
+    http_version: 
+  recorded_at: Sun, 23 Jun 2013 22:53:29 GMT
+recorded_with: VCR 2.5.0