fma_realestate 0.1.0

data/spec/fixtures/tiger.json

@@ -0,0 +1,32 @@
+{
+    "address_type": "S",
+    "census_block": "3015",
+    "census_tract": "012204",
+    "city": "Boulder",
+    "county_name": "Boulder",
+    "county_number": "013",
+    "dpbc": "25",
+    "dpv_confirmation_indicator": "Y",
+    "fips": "08013",
+    "in_city": "Boulder",
+    "in_state": "CO",
+    "in_street_address": "1325 Pearl Street",
+    "in_zip": "80302",
+    "latitude": 40.01831,
+    "longitude": -105.278027,
+    "post_directional": "",
+    "pre_directional": "",
+    "return_code": "1",
+    "search_key": "80302524725",
+    "state": "CO",
+    "state_number": "08",
+    "street_address": "1325 Pearl St",
+    "street_name": "PEARL",
+    "street_number": "1325",
+    "street_suffix": "ST",
+    "unit_number": "",
+    "unit_type": "",
+    "zip_4": "5247",
+    "zip_5": "80302",
+    "zip_9": "80302-5247"
+}

data/spec/fma_realestate/cass_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe FmaRealestate::Cass do
+  let(:authenticated_client) { described_class.new(:access_token => 'test', :raise_errors => true) }
+  let(:anonymous_client) { described_class.new(:raise_errors => true) }
+  
+  describe "#tiger" do
+    context "with :raise_errors => false" do
+      let(:authenticated_client) { described_class.new(:access_token => 'test', :raise_errors => false) }
+
+      it_behaves_like "handles error suppression" do
+        let(:action) { authenticated_client.tiger }
+      end
+    end
+
+    context "with :raise_errors => true" do
+
+      it_behaves_like "requires valid authentication" do
+        let(:action) { anonymous_client.tiger }
+      end
+
+      it_behaves_like "handles 404 response" do
+        let(:action) { authenticated_client.tiger }
+      end
+
+      it_behaves_like "handles 400 response" do
+        let(:action) { authenticated_client.tiger }
+      end
+
+      it_behaves_like "handles 400 response" do
+        let(:action) { authenticated_client.tiger }
+      end
+    end
+
+    context "with valid access_token" do
+      let(:fixture) { request_fixture('tiger') }
+      it "should get response" do
+        Excon.stub({ :method => :get, :path => '/api/cass/tiger', :headers => { 'Authorization' => "Token token=test" }}, {:status => 200, :body => fixture })
+        params = {:street_address => "1325 Pearl Street", :city => "Boulder", :state => "CO", :zip => "80302"}
+        response = authenticated_client.tiger(params)
+        expect(response.keys.count).to eq(30)
+        expect(response['return_code']).to eq('1')
+        expect(response['dpv_confirmation_indicator']).to eq('Y')
+      end
+    end
+  end
+end

data/spec/fma_realestate/public_record_spec.rb

@@ -0,0 +1,184 @@
+require 'spec_helper'
+
+describe FmaRealestate::PublicRecord do
+  let(:authenticated_client) { described_class.new(:access_token => 'test', :raise_errors => true) }
+  let(:anonymous_client) { described_class.new(:raise_errors => true) }
+
+  describe "#search_by_address" do
+    context "with :raise_errors => false" do
+      let(:authenticated_client) { described_class.new(:access_token => 'test', :raise_errors => false) }
+
+      it_behaves_like "handles error suppression" do
+        let(:action) { authenticated_client.search_by_address }
+      end
+    end
+
+    context "with :raise_errors => true" do
+
+      it_behaves_like "requires valid authentication" do
+        let(:action) { anonymous_client.search_by_address }
+      end
+
+      it_behaves_like "handles 404 response" do
+        let(:action) { authenticated_client.search_by_address }
+      end
+
+      it_behaves_like "handles 400 response" do
+        let(:action) { authenticated_client.search_by_address }
+      end
+
+      it_behaves_like "handles 400 response" do
+        let(:action) { authenticated_client.search_by_address }
+      end
+    end
+
+    context "with valid access_token" do
+      let(:fixture) { request_fixture('search_by_address') }
+
+      it "should get response" do
+        Excon.stub({ :method => :get, :path => '/api/public_records/search_by_address', :headers => { 'Authorization' => "Token token=test" }}, {:status => 200, :body => fixture })
+        params = {:street_address => "1325 Pearl Street", :city => "Boulder", :state => "CO", :zip => "80302"}
+        response = authenticated_client.search_by_address(params)
+        expect(response["cass"]).to be_a Hash
+        expect(response["count"]).to be_a Integer
+        expect(response["results"]).to be_a Array
+        expect(response["results"].count).to eq(1)
+        expect(response["results"].first).to be_a Hash
+      end
+    end
+  end
+
+  describe "#search_by_advanced" do
+    context "with :raise_errors => false" do
+      let(:authenticated_client) { described_class.new(:access_token => 'test', :raise_errors => false) }
+
+      it_behaves_like "handles error suppression" do
+        let(:action) { authenticated_client.search_by_advanced }
+      end
+    end
+
+    context "with :raise_errors => true" do
+
+      it_behaves_like "requires valid authentication" do
+        let(:action) { anonymous_client.search_by_advanced }
+      end
+
+      it_behaves_like "handles 404 response" do
+        let(:action) { authenticated_client.search_by_advanced }
+      end
+
+      it_behaves_like "handles 400 response" do
+        let(:action) { authenticated_client.search_by_advanced }
+      end
+
+      it_behaves_like "handles 400 response" do
+        let(:action) { authenticated_client.search_by_advanced }
+      end
+    end
+
+    context "with valid access_token" do
+      let(:fixture) { request_fixture('search_by_advanced') }
+
+      it "should get response" do
+        Excon.stub({ :method => :get, :path => '/api/public_records/search_by_advanced', :headers => { 'Authorization' => "Token token=test" }}, {:status => 200, :body => fixture })
+        params = {:street_address => "1325 Pearl Street", :city => "Boulder", :state => "CO", :zip => "80302"}
+        response = authenticated_client.search_by_advanced(params)
+        expect(response["count"]).to be_a Integer
+        expect(response["results"]).to be_a Array
+        expect(response["results"].count).to eq(1)
+        expect(response["results"].first).to be_a Hash
+        expect(response["results"][0]["result"]).to be_a Hash
+        expect(response["results"][0]["weight"]).to be_a Integer
+      end
+    end
+  end
+
+  describe "#search_by_address_advanced" do
+    context "with :raise_errors => false" do
+      let(:authenticated_client) { described_class.new(:access_token => 'test', :raise_errors => false) }
+
+      it_behaves_like "handles error suppression" do
+        let(:action) { authenticated_client.search_by_address_advanced }
+      end
+    end
+
+    context "with :raise_errors => true" do
+
+      it_behaves_like "requires valid authentication" do
+        let(:action) { anonymous_client.search_by_address_advanced }
+      end
+
+      it_behaves_like "handles 404 response" do
+        let(:action) { authenticated_client.search_by_address_advanced }
+      end
+
+      it_behaves_like "handles 400 response" do
+        let(:action) { authenticated_client.search_by_address_advanced }
+      end
+
+      it_behaves_like "handles 400 response" do
+        let(:action) { authenticated_client.search_by_address_advanced }
+      end
+    end
+
+    context "with valid access_token" do
+      let(:fixture) { request_fixture('search_by_address_advanced') }
+
+      it "should get response" do
+        Excon.stub({ :method => :get, :path => '/api/public_records/search_by_address_advanced', :headers => { 'Authorization' => "Token token=test" }}, {:status => 200, :body => fixture })
+        params = {:street_address => "1325 Pearl Street", :city => "Boulder", :state => "CO", :zip => "80302"}
+        response = authenticated_client.search_by_address_advanced(params)
+        expect(response["cass"]).to be_a Hash
+        expect(response["count"]).to be_a Integer
+        expect(response["results"]).to be_a Array
+        expect(response["results"].count).to eq(1)
+        expect(response["results"].first).to be_a Hash
+      end
+    end
+  end
+
+  describe "#search_by_global" do
+    context "with :raise_errors => false" do
+      let(:authenticated_client) { described_class.new(:access_token => 'test', :raise_errors => false) }
+
+      it_behaves_like "handles error suppression" do
+        let(:action) { authenticated_client.search_by_global }
+      end
+    end
+
+    context "with :raise_errors => true" do
+
+      it_behaves_like "requires valid authentication" do
+        let(:action) { anonymous_client.search_by_global }
+      end
+
+      it_behaves_like "handles 404 response" do
+        let(:action) { authenticated_client.search_by_global }
+      end
+
+      it_behaves_like "handles 400 response" do
+        let(:action) { authenticated_client.search_by_global }
+      end
+
+      it_behaves_like "handles 400 response" do
+        let(:action) { authenticated_client.search_by_global }
+      end
+    end
+
+    context "with valid access_token" do
+      let(:fixture) { request_fixture('search_by_global') }
+
+      it "should get response" do
+        Excon.stub({ :method => :get, :path => '/api/public_records/search_by_global', :headers => { 'Authorization' => "Token token=test" }}, {:status => 200, :body => fixture })
+        params = {:q => "1325 Pearl Street"}
+        response = authenticated_client.search_by_global(params)
+        expect(response["count"]).to be_a Integer
+        expect(response["results"]).to be_a Array
+        expect(response["results"].count).to eq(20)
+        expect(response["results"].first).to be_a Hash
+        expect(response["results"][0]["result"]).to be_a Hash
+        expect(response["results"][0]["weight"]).to be_a Integer
+      end
+    end
+  end
+end

data/spec/fma_realestate_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe FmaRealestate do
+  it 'has a version number' do
+    expect(FmaRealestate::VERSION).not_to be nil
+  end
+
+  describe ".configure" do
+    it 'should set the access_token' do
+      FmaRealestate.configure do |config|
+        config.access_token = "some_token"
+      end
+      expect(FmaRealestate.access_token).to eq("some_token")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rspec'
+require 'fma_realestate'
+
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f }
+
+RSpec.configure do |config|
+  config.include RequestFixturesHelper
+
+  config.before(:all) do
+    Excon.defaults[:mock] = true
+  end
+
+  config.after(:each) do
+    Excon.stubs.clear
+  end
+end

data/spec/support/request_fixture_helper.rb

@@ -0,0 +1,5 @@
+module RequestFixturesHelper
+  def request_fixture(name)
+    File.read("spec/fixtures/#{name}.json")
+  end
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,50 @@
+shared_examples "requires valid authentication" do
+  it "raises authentication error" do
+    Excon.stub({}, {:status => 401 })
+    expect {action}.to raise_error(FmaRealestate::AuthenticationError)
+  end
+end
+
+shared_examples "handles 404 response" do
+  it "raises not found error" do
+    Excon.stub({}, {:status => 404 })
+    expect {action}.to raise_error(FmaRealestate::ResourceNotFound)
+  end
+end
+
+shared_examples "handles 400 response" do
+  it "raises not found error" do
+    Excon.stub({}, {:status => 400 })
+    expect {action}.to raise_error(FmaRealestate::BadRequest)
+  end
+end
+
+shared_examples "handles unexpected response" do
+  it "raises not found error" do
+    Excon.stub({}, {:status => 403 })
+    expect {action}.to raise_error(FmaRealestate::HTTPError)
+  end
+end
+
+shared_examples "handles error suppression" do
+  it 'suppresses request error' do
+    connection = double("connection")
+    allow(connection).to receive(:request) { raise FmaRealestate::RequestError }
+    authenticated_client.instance_variable_set(:@connection, connection)
+    expect {action}.to_not raise_error
+  end
+
+  it 'returns false when request error is suppressed' do
+    connection = double("connection")
+    allow(connection).to receive(:request) { raise FmaRealestate::RequestError }
+    authenticated_client.instance_variable_set(:@connection, connection)
+    expect(action).to be false
+  end
+
+  it "doesn't suppress non request errors" do
+    connection = double("connection")
+    allow(connection).to receive(:request) { raise StandardError }
+    authenticated_client.instance_variable_set(:@connection, connection)
+    expect {action}.to raise_error
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: fma_realestate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Blaine Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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'
+description: 
+email:
+- customer.service@firstmoversadvantage.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fma_realestate.gemspec
+- lib/fma_realestate.rb
+- lib/fma_realestate/cass.rb
+- lib/fma_realestate/client.rb
+- lib/fma_realestate/exceptions.rb
+- lib/fma_realestate/public_record.rb
+- lib/fma_realestate/version.rb
+- spec/fixtures/search_by_address.json
+- spec/fixtures/search_by_address_advanced.json
+- spec/fixtures/search_by_advanced.json
+- spec/fixtures/search_by_global.json
+- spec/fixtures/tiger.json
+- spec/fma_realestate/cass_spec.rb
+- spec/fma_realestate/public_record_spec.rb
+- spec/fma_realestate_spec.rb
+- spec/spec_helper.rb
+- spec/support/request_fixture_helper.rb
+- spec/support/shared_examples.rb
+homepage: http://realestate.firstmoversadvantage.com/
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: FMA Real Estate and CASS Ruby Client
+test_files:
+- spec/fixtures/search_by_address.json
+- spec/fixtures/search_by_address_advanced.json
+- spec/fixtures/search_by_advanced.json
+- spec/fixtures/search_by_global.json
+- spec/fixtures/tiger.json
+- spec/fma_realestate/cass_spec.rb
+- spec/fma_realestate/public_record_spec.rb
+- spec/fma_realestate_spec.rb
+- spec/spec_helper.rb
+- spec/support/request_fixture_helper.rb
+- spec/support/shared_examples.rb