honest_renter 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b494a11487cac01e41c828d91b7e4c867a39844
-  data.tar.gz: 3320d13a682183ec172bc8073dc6744cbcd5a68f
+  metadata.gz: 6c8358538a5ebe627ece107b6e93a7bcdda7a05d
+  data.tar.gz: b3344c770695ee716e5a3078628b8603782b4e0c
 SHA512:
-  metadata.gz: 5652e2a0952c4cea25c294d664536c31168f573b421589432f247e4a1d8b12c16d07f468a98ff10b03e32b99b422bdc03ff7b6afc4e24d8f7d7ab1843942c89a
-  data.tar.gz: 7952b85e388d1b3aa788b064cd6f50f91ec042d63aa55134ed35967935d2afd375b8e9c70ce74d59efca6daca2058da877074eb3107186bc140f8f8ea6f09808
+  metadata.gz: b80d7e826bcd59e1c20d1fb2c3e435b65b80f4b0873ef887bb24647f889db57705b13f5b9c4516c8b5548c4fa684ca7a850014ffb51fd3e99a63782393a2149b
+  data.tar.gz: 2f8352e77c4e6bad859ce739e697eeeb09b5b26133e96876041ff205e4a19d16ff0e0f9501337643e570716c74afc46229ed094d4728df2e4e12a20b5e016b6d

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+console.sh

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.1
+  - 2.3.0
+script: bundle exec rake test

data/Gemfile.lock

@@ -1,12 +1,31 @@
 PATH
   remote: .
   specs:
-    honest_renter (0.0.0)
+    honest_renter (1.0.0)
+      faraday (~> 0.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.0)
+    minitest (4.3.2)
+    multipart-post (2.0.0)
     rake (10.5.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    safe_yaml (1.0.4)
+    webmock (1.24.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
@@ -14,7 +33,10 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.3)
   honest_renter!
+  minitest (= 4.3.2)
   rake (~> 10)
+  rspec-mocks (~> 3)
+  webmock (~> 1.0)
 
 BUNDLED WITH
    1.11.2

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Jake Yesbeck
+
+MIT License
+
+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

@@ -1,3 +1,118 @@
 ## Honest Renter API Wrapper
 
-[Docs](https://www.honestrenter.com/api/docs)
+[![Build Status](https://travis-ci.org/yez/honest_renter.svg?branch=master)](https://travis-ci.org/yez/honest_renter)
+
+## Basic Objects
+
+All supported objects have their own class. Each of these classes inherits from the `BaseModel` class.
+
+It is suggested that when using this gem, you create your own wrapper class which inherits from these classes.
+
+For example:
+
+```ruby
+class Person < HonestRenter::Person
+end
+```
+
+### `to_h`
+
+All models in the `honest_renter` gem respond to the `to_h` method. This method iterates over a model's attributes and returns a Hash.
+
+## Authentication
+
+Two authentication methods exist. An authenticated `Session` object must be present for each remote HonestRenter API call.
+
+For more information, check out the [official authentication documentation](https://honestrenter.com/api/docs/general-principles#authorization)
+
+Each of the two authentication methods are initialized via the `HonestRenter::Authenticator` factory methods:
+
+### Address and Password
+
+To authenticate via an (email) address and password, use the `.from_address_and_password` class method.
+
+```ruby
+auth = HonestRenter::Authenticator.from_address_and_password(
+                                    'me@example.com',
+                                    'supersecretpassword')
+# => AddressPasswordAuthenticator
+
+auth.session
+# => HonestRenter::Session
+```
+
+This `HonestRenter::Session` object is used when calling all class level query methods (`find` and  `find_all`, etc)
+
+### Secret Key
+
+To authenticate using a `SecretKey` and `MemberId`, the aptly named `.from_secret_key_member_id` class method can be used.
+
+```ruby
+auth = HonestRenter::Authenticator.from_secret_key_member_id(
+                                    '5up3r53cr3t',
+                                    'mymember_id')
+# => AddressPasswordAuthenticator
+
+auth.session
+# => HonestRenter::Session
+```
+
+## Request Methods
+
+The HonestRenter API supports querying for objects by their ID or by a set of filters. All querying operations require an authenticated `HonestRenter::Session`.
+
+### `find`
+
+To find a specific object by its identifier, simply call the `.find` class method on the object or your application's inherited version of that object:
+
+```ruby
+HonestRenter::Member.find('some_member_id', session)
+```
+
+The `session` variable can be a session created by either the `HonestRenter::AddressPasswordAuthenticator` or the `HonestRenter::SecretKeyMemberIdAuthenticator`.
+
+The model will automatically return an instance of the class upon with the `.find` method was called with its attributes filled.
+
+### `find_all`
+
+To find a complete list of a certain model, the `.find_all` class method exists. This method has 1 required parameter and 2 optional parameters.
+
+Like the `.find` method, a `session` is the required parameter.
+
+```ruby
+HonestRenter::Country.find_all(session)
+```
+
+Optionally, a `limit` and `offset` can be given to the `.find_all` method to enable pagination.
+
+```ruby
+limit = 10
+offset = 5
+HonestRenter::Country.find_all(session, limit, offset)
+```
+
+### `find_all`
+
+To find a list of a certain model that matches a set of passed in filters, the `.find_all_by_filters` class method exists. This method has 2 required parameters and 2 optional parameters.
+
+The first required parameter is an Array or other enumerable structure containing `Filters`. Like the `.find` method, a `session` is the other required parameter.
+
+An `HonestRenter::Filter` is a simple class that accepts two parameters, a `key` and a `value`. The `key` is the field on which to filter.
+
+```ruby
+filters = [HonestRenter::Filter.new(:owner, 'Ted')]
+HonestRenter::Pet.find_all_by_filter(filters, session)
+```
+
+Optionally, a `limit` and `offset` can be given to the `.find_all_by_filters` method to enable pagination.
+
+```ruby
+limit = 10
+offset = 5
+filters = [HonestRenter::Filter.new(owner: 'Ted')]
+HonestRenter::Pet.find_all_by_filter(filters, session, limit, offset)
+```
+
+## More Information
+
+For more information, refer to the [Official Honest Renter API Docs](https://www.honestrenter.com/api/docs)

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+
+task default: [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.libs << 'models'
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end

data/honest_renter.gemspec

@@ -1,5 +1,5 @@
 lib = File.expand_path('../lib/', __FILE__)
-$:.unshift lib unless $:.include?(lib)
+$:.unshift(lib) unless $:.include?(lib)
 require './version'
 
 Gem::Specification.new do |s|
@@ -18,6 +18,11 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.0.0'
 
+  s.add_dependency 'faraday', '~> 0.9'
+
   s.add_development_dependency 'bundler', '~> 1.3'
   s.add_development_dependency 'rake', '~>10'
+  s.add_development_dependency 'minitest', '4.3.2'
+  s.add_development_dependency 'rspec-mocks', '~> 3'
+  s.add_development_dependency 'webmock', '~> 1.0'
 end

data/lib/authenticator.rb

@@ -0,0 +1,76 @@
+module HonestRenter
+  class Authenticator
+    class << self
+      def from_secret_key_member_id(secret_key, member_id)
+        SecretKeyMemberIdAuthenticator.new(secret_key, member_id)
+      end
+
+      def from_address_and_password(address, password)
+        AddressPasswordAuthenticator.new(address, password)
+      end
+    end
+
+    def initialize(*args)
+      after_initialize(*args)
+    end
+
+    def session
+      @session ||= build_session
+    end
+
+    def renew!
+      @session = nil
+      session
+    end
+  end
+
+  class SecretKeyMemberIdAuthenticator < Authenticator
+    require 'openssl'
+
+    ONE_HOUR = 3600
+
+    def after_initialize(secret_key, member_id)
+      @secret_key = secret_key
+      @member_id = member_id
+    end
+
+    def build_session
+      json_hash = JSON(raw_hash)
+      digest = OpenSSL::Digest.new('sha256')
+      encoded = OpenSSL::HMAC.hexdigest(digest, @secret_key, json_hash)
+
+      HonestRenter::Session.new(encoded, json_hash)
+    end
+
+    def raw_hash
+      now = Time.now
+
+      {
+        apiKey: ENV['HONEST_RENTER_API_KEY'],
+        authorization: 'member',
+        expires: now.to_i + ONE_HOUR,
+        person: @member_id,
+        renewableUntil: now.to_i + (3 * ONE_HOUR)
+      }
+    end
+  end
+
+  class AddressPasswordAuthenticator < Authenticator
+    def after_initialize(address, password)
+      @address = address
+      @password = password
+    end
+
+    def build_session
+      raw_session = HonestRenter::Post.new('members/session',
+                                           address: @address,
+                                           password: @password)
+                                      .call
+
+      HonestRenter::Session.new(
+        raw_session.headers['honr-authentication-token'],
+        raw_session.headers['honr-session']
+      )
+    end
+  end
+end

data/lib/client.rb

@@ -0,0 +1,11 @@
+module HonestRenter
+  class Client
+    def initialize(faraday_adapter = Faraday.default_adapter)
+      @faraday_adapter = faraday_adapter
+    end
+
+    def connection
+      @connection ||= Faraday.new
+    end
+  end
+end

data/lib/honest_renter.rb

@@ -0,0 +1,12 @@
+module HonestRenter
+  def snake_case(key)
+    key.to_s.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+  end
+
+  module_function :snake_case
+end
+
+require 'faraday'
+require 'logger'
+require 'json'
+require_relative './requires'

data/lib/request.rb

@@ -0,0 +1,71 @@
+module HonestRenter
+  class Request
+    class ExpiredSession < StandardError; end
+
+    attr_reader :client, :session
+
+    BASE_URL = 'https://honestrenter.com/api/'.freeze
+    EXPIRES_LENGTH = 3600
+    RENEWABLE_MULTIPLIER = 3
+
+    def initialize(client, session = nil)
+      @client = client
+      @session = session
+
+      if !@session.nil? && session.expired?
+        raise ExpiredSession, "session expired at: #{ session.expires_at }, please re-authenticate."
+      end
+    end
+
+    def headers
+      {
+        'Accept' => 'Application/vnd.honestrenter.v1+json'
+      }.tap do |_headers|
+        unless @session.nil?
+          _headers['HONR-Session'] = JSON(@session.honr_session)
+          _headers['HONR-Authentication-Token'] = @session.honr_authentication_token
+        end
+      end
+    end
+
+    def get(url, query_params = {})
+      raw_response = client.connection.get("#{BASE_URL}#{url}") do |request|
+        request.headers = headers
+        request.params['apiKey'] = api_key
+        query_params.each_pair do |key, value|
+          request.params[key] = value
+        end
+      end
+
+      respond(raw_response)
+    end
+
+    def post(url, body, query_params = {})
+      _body = post_body(body.merge(apiKey: api_key))
+
+      raw_response = client.connection.post("#{BASE_URL}#{url}", _body) do |request|
+        request.headers = headers
+      end
+
+      respond(raw_response)
+    end
+
+    private
+
+    def respond(raw_response)
+      response = Response.new(raw_response)
+
+      raise response.error unless response.success?
+
+      response
+    end
+
+    def post_body(hash)
+      hash.map { |k, v| "#{k}=#{v}" }.join('&')
+    end
+
+    def api_key
+      ENV['HONEST_RENTER_API_KEY']
+    end
+  end
+end

data/lib/requests/expandable.rb

@@ -0,0 +1,10 @@
+module HonestRenter
+  module Expandable
+    def expanding(attribute)
+      @expansions ||= []
+      @expansions << attribute
+
+      self
+    end
+  end
+end

data/lib/requests/filter.rb

@@ -0,0 +1,9 @@
+module HonestRenter
+  class Filter
+    attr_accessor :key, :value
+    def initialize(key, value)
+      @key = key
+      @value = value
+    end
+  end
+end