honest_renter 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c8358538a5ebe627ece107b6e93a7bcdda7a05d
-  data.tar.gz: b3344c770695ee716e5a3078628b8603782b4e0c
+  metadata.gz: ccbb52f5083804432a3d0ddf577d1aed423cf278
+  data.tar.gz: 550c0b4670c360d7bb5cc92cd3261e6658ea687c
 SHA512:
-  metadata.gz: b80d7e826bcd59e1c20d1fb2c3e435b65b80f4b0873ef887bb24647f889db57705b13f5b9c4516c8b5548c4fa684ca7a850014ffb51fd3e99a63782393a2149b
-  data.tar.gz: 2f8352e77c4e6bad859ce739e697eeeb09b5b26133e96876041ff205e4a19d16ff0e0f9501337643e570716c74afc46229ed094d4728df2e4e12a20b5e016b6d
+  metadata.gz: e9accc40c66b3dbfe09eb0dfa554abd0432dc81be538677fafec2050bb4cd11be0b3a5e29ba4c1f284616960cf9f6d10efb61bae4a34d6bc9ea98f6a6082eacc
+  data.tar.gz: eefe7cafdd2119037e0e182284a86a88f2f8d8323351b4b75f5f4878d891bf508bea6e89188256a070f6d5a580af802a18ecf14be51a2eafe175c879079575cb

data/README.md

@@ -57,6 +57,10 @@ auth.session
 # => HonestRenter::Session
 ```
 
+### API Key
+
+All Honest Renter requests require an API key. To have this gem automatically use your API key, the environment variable `HONEST_RENTER_API_KEY` should be set.
+
 ## 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`.
@@ -77,6 +81,8 @@ The model will automatically return an instance of the class upon with the `.fin
 
 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.
 
+*Note: Not all models are able to issue a `find_all` request. Unsupported models will throw an `Unrequestable::Unsupported` error.*
+
 Like the `.find` method, a `session` is the required parameter.
 
 ```ruby

data/Rakefile

@@ -9,3 +9,27 @@ Rake::TestTask.new do |t|
   t.test_files = FileList['test/**/*_test.rb']
   t.verbose = true
 end
+
+namespace :fixtures do
+  desc 'reload fixtures from remote API'
+  task :reload do
+    fail 'No API key given' if ENV['HONEST_RENTER_API_KEY'].nil?
+    fail 'No MEMBER_ID' if ENV['MEMBER_ID'].nil?
+    fail 'No Secret Key' if ENV['HONEST_RENTER_SECRET_KEY'].nil?
+
+    ethniticites_find_all = "#{ File.expand_path('..', __FILE__) }/test/fixtures/ethnicities/find_all.json"
+    members_find = "#{ File.expand_path('..', __FILE__) }/test/fixtures/members/find.json"
+    titles_find_all_by_filters = "#{ File.expand_path('..', __FILE__) }/test/fixtures/titles/find_all_by_filters.json"
+
+    session = HonestRenter::Authenticator.from_secret_key_member_id(ENV['HONEST_RENTER_SECRET_KEY'], ENV['MEMBER_ID']).session
+
+    ethniticites_find_all_results = HonestRenter::Ethnicities.find_all(session)
+    members_find_results = HonestRenter::Member.find(ENV['MEMBER_ID'], session)
+    filters = [HonestRenter::Filter.new(:id, 3)]
+    titles_find_all_by_filters_results = HonestRenter::Title.find_all_by_filters(filters, session)
+
+    File.open(ethniticites_find_all, 'w') { |f| f.write(JSON(ethniticites_find_all_results)) }
+    File.open(members_find, 'w') { |f| f.write(JSON(members_find_results)) }
+    File.open(titles_find_all_by_filters, 'w') { |f| f.write(JSON(titles_find_all_by_filters_results)) }
+  end
+end

data/lib/client.rb

@@ -5,7 +5,9 @@ module HonestRenter
     end
 
     def connection
-      @connection ||= Faraday.new
+      @connection ||= Faraday.new do |conn|
+        conn.adapter(@faraday_adapter)
+      end
     end
   end
 end

data/lib/request.rb

@@ -5,8 +5,6 @@ module HonestRenter
     attr_reader :client, :session
 
     BASE_URL = 'https://honestrenter.com/api/'.freeze
-    EXPIRES_LENGTH = 3600
-    RENEWABLE_MULTIPLIER = 3
 
     def initialize(client, session = nil)
       @client = client

data/lib/requests/find_all.rb

@@ -12,16 +12,18 @@ module HonestRenter
     def call
       client = HonestRenter::Client.new
       request = HonestRenter::Request.new(client, @session)
-      query = {}.tap do |params|
+
+      request.get(@resource_name, query)
+    end
+
+    def query
+      {}.tap do |params|
         unless @expansions.nil? || @expansions.empty?
           params[:expand] = JSON(@expansions)
         end
-
         params[:limit] = @limit unless @limit.nil?
         params[:offset] = @offset unless @offset.nil?
       end
-
-      request.get(@resource_name, query)
     end
   end
 end

data/lib/requires.rb

@@ -5,7 +5,6 @@ require_relative 'response'
 require_relative 'session'
 require_relative 'authenticator'
 require_relative '../models/base_model'
-require_relative 'requests/expandable'
 
 [
   '../../modules',

data/modules/unrequestable.rb

@@ -2,22 +2,14 @@ module HonestRenter
   module Unrequestable
     class Unsupported < StandardError; end
 
-    def included(base)
+    def self.included(base)
       base.extend(ClassMethods)
     end
 
     module ClassMethods
-      class << self
-        def find_all(*)
-          raise Unsupported, "this model may not use the #{__method__} method."
-        end
-
-        def find(*)
-          raise Unsupported, "this model may not use the #{__method__} method."
-        end
+      def find_all(*)
+        raise Unsupported, "this model may not use the #{__method__} method."
       end
     end
-
-    private_constant :Unsupported
   end
 end

data/test/lib/honest_renter_test.rb

@@ -0,0 +1,12 @@
+require_relative '../test_helper'
+
+module HonestRenter
+  class HonestRenterTest < MiniTest::Unit::TestCase
+    def test_snake_case
+      input = 'SnakeCaseTest'
+      expected = 'snake_case_test'
+
+      assert_equal(expected, HonestRenter.snake_case(input))
+    end
+  end
+end

data/test/models/base_model_test.rb

@@ -42,6 +42,16 @@ module HonestRenter
       TestModel.find_all(session)
     end
 
+    def test_find_all_by_filters
+      find_all_by_filter_request = instance_double(HonestRenter::FindAllByFilter)
+      response = instance_double(HonestRenter::Response, body: { 'data' => {} }, success?: true)
+      session = instance_double(HonestRenter::Session, honr_session: '', honr_authentication_token: '')
+      expect(HonestRenter::FindAllByFilter).to receive(:new).with(TestModel.attr_name, session) { find_all_by_filter_request }
+      expect(find_all_by_filter_request).to receive(:call) { response }
+
+      TestModel.find_all_by_filters([], session)
+    end
+
     def test_find
       id = 1234
       find_request = instance_double(HonestRenter::FindById)

data/test/modules/expandable_test.rb

@@ -0,0 +1,32 @@
+require_relative '../test_helper'
+require_relative '../../modules/expandable'
+
+module HonestRenter
+  class ExpandableTest < MiniTest::Unit::TestCase
+
+    class ExampleExpandableClass
+      include Expandable
+    end
+
+    def setup
+      @subject = ExampleExpandableClass.new
+    end
+
+    def test_included_methods
+      assert_equal(true, @subject.respond_to?(:expanding))
+    end
+
+    def test_adding_to_array
+      assert_equal(nil, @subject.instance_variable_get(:@expansions))
+
+      test_value = 'something'
+      @subject.expanding(test_value)
+      assert_equal([test_value], @subject.instance_variable_get(:@expansions))
+
+      another_test_value = 'something_else'
+      @subject.expanding(another_test_value)
+      assert_equal([test_value, another_test_value],
+                   @subject.instance_variable_get(:@expansions))
+    end
+  end
+end

data/test/modules/unrequestable_test.rb

@@ -0,0 +1,22 @@
+require_relative '../test_helper'
+require_relative '../../models/base_model'
+require_relative '../../modules/unrequestable'
+
+module HonestRenter
+  class UnrequestableTest < MiniTest::Unit::TestCase
+
+    class ExampleUnrequestableObject < BaseModel
+      include Unrequestable
+    end
+
+    def test_included_methods_present
+      assert_equal(true, ExampleUnrequestableObject.respond_to?(:find_all))
+    end
+
+    def test_raise_error
+      assert_raises(Unrequestable::Unsupported) do
+        ExampleUnrequestableObject.find_all
+      end
+    end
+  end
+end

data/version.rb

@@ -1,7 +1,7 @@
 module HonestRenter
   MAJOR = 1
   MINOR = 0
-  TINY = 0
+  TINY = 1
 
   VERSION = [MAJOR, MINOR, TINY].join('.').freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honest_renter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jake Yesbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-16 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -113,7 +113,6 @@ files:
 - lib/client.rb
 - lib/honest_renter.rb
 - lib/request.rb
-- lib/requests/expandable.rb
 - lib/requests/filter.rb
 - lib/requests/find_all.rb
 - lib/requests/find_all_by_filter.rb
@@ -163,7 +162,7 @@ files:
 - models/title.rb
 - models/user.rb
 - models/vehicle.rb
-- modules/requests_unsupported.rb
+- modules/expandable.rb
 - modules/unrequestable.rb
 - test/fixtures/ethnicities/find_all.json
 - test/fixtures/members/find.json
@@ -172,6 +171,7 @@ files:
 - test/integration/find_all_test.rb
 - test/integration/find_test.rb
 - test/lib/authenticator_test.rb
+- test/lib/honest_renter_test.rb
 - test/lib/requests/filter_test.rb
 - test/lib/requests/find_all_by_filter_test.rb
 - test/lib/requests/find_all_test.rb
@@ -180,6 +180,8 @@ files:
 - test/lib/response_test.rb
 - test/lib/session_test.rb
 - test/models/base_model_test.rb
+- test/modules/expandable_test.rb
+- test/modules/unrequestable_test.rb
 - test/test_helper.rb
 - version.rb
 homepage: http://rubygems.org/gems/honest_renter

data/modules/requests_unsupported.rb

@@ -1,21 +0,0 @@
-module HonestRenter
-  module Unrequestable
-    class Unsupported < StandardError; end
-
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      def find_all(*)
-        raise Unsupported, "this model may not use the #{__method__} method."
-      end
-
-      def find(*)
-        raise Unsupported, "this model may not use the #{__method__} method."
-      end
-    end
-
-    private_constant :Unsupported
-  end
-end