honest_renter 0.0.0 → 1.0.0

data/test/lib/requests/filter_test.rb

@@ -0,0 +1,14 @@
+require_relative '../../test_helper'
+require_relative '../../../lib/requests/filter'
+
+module HonestRenter
+  class FilterTest < MiniTest::Unit::TestCase
+    def test_instance_variables
+      key = 'some key'
+      value = 'some value'
+      filter = Filter.new(key, value)
+      assert_equal(key, filter.key)
+      assert_equal(value, filter.value)
+    end
+  end
+end

data/test/lib/requests/find_all_by_filter_test.rb

@@ -0,0 +1,44 @@
+require_relative '../../test_helper'
+require_relative '../../../lib/requests/find_all_by_filter'
+
+module HonestRenter
+  class FindAllByFilterTest < Minitest::Unit::TestCase
+    def setup
+      @id = 1234
+      @resource_name = 'some resource'
+      @session = instance_double(Session)
+      @request = FindAllByFilter.new(@resource_name, @session)
+    end
+
+    def test_ivars
+      assert_equal(@resource_name, @request.instance_variable_get(:@resource_name))
+      assert_equal(@session, @request.instance_variable_get(:@session))
+    end
+
+    def test_expanding
+      @request.expanding('some attribute')
+      assert_equal(['some attribute'], @request.instance_variable_get(:@expansions))
+
+      @request.expanding('another attribute')
+      assert_equal(['some attribute', 'another attribute'], @request.instance_variable_get(:@expansions))
+    end
+
+    def test_expanding_contract
+      assert_equal(@request, @request.expanding(anything))
+    end
+
+    def test_add_filter
+      some_filter = Filter.new('key', 'value')
+      @request.add_filter(some_filter)
+      assert_equal([some_filter], @request.instance_variable_get(:@filters))
+
+      another_filter = Filter.new('another_key', 'another_value')
+      @request.add_filter(another_filter)
+      assert_equal([some_filter, another_filter], @request.instance_variable_get(:@filters))
+    end
+
+    def test_add_filter_contract
+      assert_equal(@request, @request.add_filter(anything))
+    end
+  end
+end

data/test/lib/requests/find_all_test.rb

@@ -0,0 +1,59 @@
+require_relative '../../test_helper'
+require_relative '../../../lib/requests/find_all'
+
+module HonestRenter
+  class FindAllTest < Minitest::Unit::TestCase
+    def setup
+      @resource_name = 'some resource'
+      @session = instance_double(Session)
+      @request = FindAll.new(@resource_name, @session)
+    end
+
+    def test_ivars
+      assert_equal(@resource_name, @request.instance_variable_get(:@resource_name))
+      assert_equal(@session, @request.instance_variable_get(:@session))
+    end
+
+    def test_expanding
+      @request.expanding('some attribute')
+      assert_equal(['some attribute'], @request.instance_variable_get(:@expansions))
+      @request.expanding('another attribute')
+      assert_equal(['some attribute', 'another attribute'], @request.instance_variable_get(:@expansions))
+    end
+
+    def test_expanding_contract
+      assert_equal(@request, @request.expanding(anything))
+    end
+
+    def call_setup
+      mock_client = instance_double(Client)
+      mock_request = instance_double(Request)
+      expect(Request)
+        .to receive(:new)
+        .with(instance_of(Client), @session) { mock_request }
+
+      mock_request
+    end
+
+    def test_call
+      mock_request = call_setup
+      expect(mock_request)
+        .to receive(:get)
+        .with(@resource_name, {})
+
+      @request.call
+    end
+
+    def test_call_with_expanding
+      mock_request = call_setup
+      expansions = ['foo', 'bar']
+      expansions.each { |e| @request.expanding(e) }
+
+      expect(mock_request)
+        .to receive(:get)
+        .with(@resource_name, { expand: JSON(expansions) })
+
+      @request.call
+    end
+  end
+end

data/test/lib/requests/find_by_id_test.rb

@@ -0,0 +1,30 @@
+require_relative '../../test_helper'
+require_relative '../../../lib/requests/find_by_id'
+
+module HonestRenter
+  class FindByIdTest < Minitest::Unit::TestCase
+    def setup
+      @id = 1234
+      @resource_name = 'some resource'
+      @session = instance_double(Session)
+      @request = FindById.new(@id, @resource_name, @session)
+    end
+
+    def test_ivars
+      assert_equal(@id, @request.instance_variable_get(:@id))
+      assert_equal(@resource_name, @request.instance_variable_get(:@resource_name))
+      assert_equal(@session, @request.instance_variable_get(:@session))
+    end
+
+    def test_expanding
+      @request.expanding('some attribute')
+      assert_equal(['some attribute'], @request.instance_variable_get(:@expansions))
+      @request.expanding('another attribute')
+      assert_equal(['some attribute', 'another attribute'], @request.instance_variable_get(:@expansions))
+    end
+
+    def test_expanding_contract
+      assert_equal(@request, @request.expanding(anything))
+    end
+  end
+end

data/test/lib/requests/post_test.rb

@@ -0,0 +1,38 @@
+require_relative '../../test_helper'
+require_relative '../../../lib/requests/post'
+
+module HonestRenter
+  class PostTest < Minitest::Unit::TestCase
+    def setup
+      @resource_name = 'some resource'
+      @session = instance_double(Session)
+      @body = {}
+      @request = Post.new(@resource_name, @body, @session)
+    end
+
+    def test_ivars
+      assert_equal(@resource_name, @request.instance_variable_get(:@resource_name))
+      assert_equal(@body, @request.instance_variable_get(:@body))
+      assert_equal(@session, @request.instance_variable_get(:@session))
+    end
+
+    def call_setup
+      mock_client = instance_double(Client)
+      mock_request = instance_double(Request)
+      expect(Request)
+        .to receive(:new)
+        .with(instance_of(Client), @session) { mock_request }
+
+      mock_request
+    end
+
+    def test_call
+      mock_request = call_setup
+      expect(mock_request)
+        .to receive(:post)
+        .with(@resource_name, {})
+
+      @request.call
+    end
+  end
+end

data/test/lib/response_test.rb

@@ -0,0 +1,46 @@
+require_relative '../test_helper'
+require_relative '../../lib/response'
+
+module HonestRenter
+  class ResponseTest < MiniTest::Unit::TestCase
+    class FakeResponse
+      attr_reader :status, :headers, :body
+
+      def initialize(status, headers, body)
+        @status = status
+        @headers = headers
+        @body = body
+      end
+    end
+
+    def test_successful_response_is_not_error
+      happy_response = Response.new(
+                        FakeResponse.new(
+                            200,
+                            {},
+                            JSON({ data: 'this is some data' })
+                        )
+                      )
+      assert_equal true, happy_response.success?
+    end
+
+    def test_errorful_response_is_error
+      sad_response = Response.new(
+                        FakeResponse.new(
+                            500,
+                            {},
+                            JSON({ error: { message: 'this is an error' } })
+                        )
+                      )
+      assert_equal false, sad_response.success?
+      assert_equal 'this is an error', sad_response.error.to_s
+    end
+
+    def test_malformed_json_raises_error
+      assert_raises(Response::MalformedResponse) do
+        invalid_response = FakeResponse.new(200, {}, 1234)
+        Response.new(invalid_response)
+      end
+    end
+  end
+end

data/test/lib/session_test.rb

@@ -0,0 +1,45 @@
+require_relative '../test_helper'
+require_relative '../../lib/session'
+
+module HonestRenter
+  class SessionTest < MiniTest::Unit::TestCase
+    def test_valid_json
+      session = Session.new('', JSON({}))
+      assert_equal({}, session.honr_session)
+    end
+
+    def test_invalid_json
+      session = Session.new('', 1234)
+      assert_equal(nil, session.honr_session)
+    end
+
+    def test_expires_at_when_nil_session
+      session = Session.new('', nil)
+      formatting = '%H:%M:%S'
+
+      assert_equal(Time.now.strftime(formatting),
+                   session.expires_at.strftime(formatting))
+    end
+
+    def test_expired_when_nil_session
+      session = Session.new('', nil)
+
+      assert_equal(true, session.expired?)
+    end
+
+    def test_expired_session_is_expired
+      session = Session.new('',
+                            JSON({ expires: Time.now.to_i - 180 }))
+
+      assert_equal(true, session.expired?)
+    end
+
+    def test_expired_at
+      expires_time = Time.now + 180
+      session = Session.new('',
+                            JSON({ expires: expires_time.to_i }))
+
+      assert_equal(expires_time.to_s, session.expires_at.to_s)
+    end
+  end
+end

data/test/models/base_model_test.rb

@@ -0,0 +1,62 @@
+require_relative '../test_helper'
+require_relative '../../models/base_model'
+
+module HonestRenter
+  class TestModel < BaseModel
+    attr_accessor :foo, :bar_baz, :qux
+
+    class << self
+      def attr_name
+        'test'
+      end
+    end
+  end
+
+  class BaseModelTest < MiniTest::Unit::TestCase
+    def setup
+      @foo = :foo
+      @bar_baz = :bar_baz
+      @qux = :qux
+      data_hash = { foo: @foo, barBaz: @bar_baz, qux: @qux }
+      @test_model = TestModel.new(data_hash)
+    end
+
+    def test_initialize_sets_proper_attributes
+      assert_equal(@test_model.foo, @foo)
+      assert_equal(@test_model.bar_baz, @bar_baz)
+      assert_equal(@test_model.qux, @qux)
+    end
+
+    def test_to_h
+      expected_hash = { 'foo' => @foo, 'bar_baz' => @bar_baz, 'qux' => @qux }
+      assert_equal(@test_model.to_h, expected_hash)
+    end
+
+    def test_find_all
+      find_request = instance_double(HonestRenter::FindAll)
+      response = instance_double(HonestRenter::Response, body: { 'data' => {} }, success?: true)
+      session = instance_double(HonestRenter::Session, honr_session: '', honr_authentication_token: '')
+      expect(HonestRenter::FindAll).to receive(:new).with(TestModel.attr_name, session) { find_request }
+      expect(find_request).to receive(:call) { response }
+
+      TestModel.find_all(session)
+    end
+
+    def test_find
+      id = 1234
+      find_request = instance_double(HonestRenter::FindById)
+      response = instance_double(HonestRenter::Response, body: { 'data' => {} }, success?: true)
+      session = instance_double(HonestRenter::Session, honr_session: '', honr_authentication_token: '')
+      expect(HonestRenter::FindById).to receive(:new).with(id, TestModel.attr_name, session) { find_request }
+      expect(find_request).to receive(:call) { response }
+
+      TestModel.find(id, session)
+    end
+
+    def test_visibility
+      assert_raises(NameError) do
+        ::HonestRenter::BaseModel.new
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,76 @@
+require_relative '../lib/honest_renter'
+require 'minitest/autorun'
+require 'rspec/mocks'
+require 'webmock/minitest'
+
+WebMock.disable_net_connect!
+
+class WebMockingTest < MiniTest::Unit::TestCase
+  TEST_MEMBER_ID = 'TYJH7ptuju'.freeze
+  TEST_TITLES_ID = 3
+  FIXTURES_DIR = "#{ File.dirname(__FILE__) }/fixtures"
+
+  def setup
+    WebMock.stub_request(
+      :get,
+      "https://honestrenter.com/api/members/#{TEST_MEMBER_ID}?apiKey")
+      .with(headers: headers)
+      .to_return(
+        status: 200,
+        body: File.read("#{ FIXTURES_DIR }/members/find.json"),
+        headers: {})
+
+    WebMock.stub_request(
+      :get,
+      "https://honestrenter.com/api/ethnicities?apiKey")
+      .with(headers: headers)
+      .to_return(
+        status: 200,
+        body: File.read("#{ FIXTURES_DIR }/ethnicities/find_all.json"),
+        headers: {})
+
+    WebMock.stub_request(
+      :get,
+      "https://honestrenter.com/api/titles?apiKey&id=#{TEST_TITLES_ID}")
+      .with(headers: headers)
+      .to_return(
+        status: 200,
+        body: File.read("#{ FIXTURES_DIR }/titles/find_all_by_filters.json"),
+        headers: {})
+  end
+
+  def test_session
+    @test_session ||= HonestRenter::Session.new('sometoken',
+                                                {
+                                                  expires: Time.now.to_i + 86400
+                                                }.to_json)
+  end
+
+  def headers
+    {
+       'Accept' => 'Application/vnd.honestrenter.v1+json',
+       'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+       'Honr-Authentication-Token'=>'sometoken',
+       'Honr-Session'=>test_session.honr_session.to_json,
+       'User-Agent'=>'Ruby'
+     }
+  end
+end
+
+module MinitestRSpecMocksIntegration
+  include ::RSpec::Mocks::ExampleMethods
+
+  def before_setup
+    ::RSpec::Mocks.setup
+    super
+  end
+
+  def after_teardown
+    super
+    ::RSpec::Mocks.verify
+  ensure
+    ::RSpec::Mocks.teardown
+  end
+end
+
+MiniTest::Unit::TestCase.send(:include, MinitestRSpecMocksIntegration)

data/version.rb

@@ -1,5 +1,5 @@
 module HonestRenter
-  MAJOR = 0
+  MAJOR = 1
   MINOR = 0
   TINY = 0
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: honest_renter
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jake Yesbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-22 00:00:00.000000000 Z
+date: 2016-04-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,48 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Find out who will pay rent on time, follow rules, and treat your property
   with respect.
 email: yesbeckjs@gmail.com
@@ -45,10 +101,86 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .travis.yml
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
+- Rakefile
 - honest_renter.gemspec
+- lib/authenticator.rb
+- 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
+- lib/requests/find_by_id.rb
+- lib/requests/post.rb
+- lib/requires.rb
+- lib/response.rb
+- lib/session.rb
+- models/applicant.rb
+- models/base_model.rb
+- models/candidate.rb
+- models/child.rb
+- models/code.rb
+- models/cooccupant.rb
+- models/country.rb
+- models/email.rb
+- models/emergency_contact.rb
+- models/ethnicity.rb
+- models/failed_login.rb
+- models/gender.rb
+- models/inbox_filters.rb
+- models/invite_settings.rb
+- models/member.rb
+- models/name.rb
+- models/notification.rb
+- models/notification_type.rb
+- models/organization.rb
+- models/participant.rb
+- models/person.rb
+- models/pet.rb
+- models/pet_age_category.rb
+- models/pet_size_category.rb
+- models/pet_type.rb
+- models/phone.rb
+- models/phone_type.rb
+- models/position.rb
+- models/reason_for_archive.rb
+- models/reason_for_eviction.rb
+- models/reason_for_exclusion.rb
+- models/reference.rb
+- models/relationship_type.rb
+- models/reminder.rb
+- models/residence.rb
+- models/smoking_status_category.rb
+- models/sort_by_option.rb
+- models/time_of_day.rb
+- models/title.rb
+- models/user.rb
+- models/vehicle.rb
+- modules/requests_unsupported.rb
+- modules/unrequestable.rb
+- test/fixtures/ethnicities/find_all.json
+- test/fixtures/members/find.json
+- test/fixtures/titles/find_all_by_filters.json
+- test/integration/find_all_by_filters_test.rb
+- test/integration/find_all_test.rb
+- test/integration/find_test.rb
+- test/lib/authenticator_test.rb
+- test/lib/requests/filter_test.rb
+- test/lib/requests/find_all_by_filter_test.rb
+- test/lib/requests/find_all_test.rb
+- test/lib/requests/find_by_id_test.rb
+- test/lib/requests/post_test.rb
+- test/lib/response_test.rb
+- test/lib/session_test.rb
+- test/models/base_model_test.rb
+- test/test_helper.rb
 - version.rb
 homepage: http://rubygems.org/gems/honest_renter
 licenses: