fma_realestate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c85b2b133e4ffb9894d542a7004a4e7b37fda1df
+  data.tar.gz: 3190a4aaaca7faf5f969ddfd7d5d8173e108183e
+SHA512:
+  metadata.gz: 1643524c0b314960ccb8a8fb81ca96698875b79e034b1eeb23ad39e5fdd2acff8f1007eed85348b4944151312a311cfdf384fbfeefee05c3877276d13d8b1159
+  data.tar.gz: af381df429c434bf77c009ba676925c17452027db353a75d61afeb53b91c4820830bb054bc6c8a95fe1dfb7775119c144574459a9e57f8fa62ce3ba72b5c5b1a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fma_realestate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Blaine Johnson
+
+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

@@ -0,0 +1,111 @@
+# FmaRealestate
+
+FMA Real Estate and CASS Ruby Client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fma_realestate'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fma_realestate
+
+## Requirements
+
+* Ruby 1.8.7 or above
+
+## Usage
+
+```ruby
+# Global config
+# if using rails, create initializer: /config/initializers/fma_realestate.rb
+FmaRealestate.configure do |config|
+  config.access_token = 'your_access_token'
+end
+
+# or
+
+FmaRealestate.access_token = 'your_access_token'
+```
+
+```ruby
+# Sample client configuration, shown with default values:
+config = {
+  :access_token => FmaRealestate.access_token,  # initialize the client with an access token
+  :raise_errors => false,                       # choose between returning false or raising a proper exception when API calls fails
+
+  # Connection properties
+  :retries       => 0,    # automatically retry a certain number of times before returning
+  :read_timeout  => 10,   # set longer read_timeout, default is 10 seconds
+  :write_timeout => 10,   # set longer write_timeout, default is 10 seconds
+  :persistent    => false # when true, make multiple requests calls using a single persistent connection. Use +close_connection+ method on the client to manually clean up sockets
+}
+```
+
+```ruby
+# Example Cass client usage
+cass_client = Cass.new # using default config
+response_hash = cass_client.tiger(
+  :street_address => "123 N Easy St.", # optional
+  :city           => "Boulder",        # optional
+  :state          => "CO",             # optional
+  :zip            => ""                # optional
+)
+```
+
+```ruby
+# Example PublicRecord client usage
+public_record_client = RealEstate.new # using default config
+
+# PublicRecord#search_by_address
+response_hash = public_record_client.search_by_address(
+  :street_address => "123 N Easy St.", # optional
+  :city           => "Boulder",        # optional
+  :state          => "CO",             # optional
+  :zip            => ""                # optional
+)
+
+# PublicRecord#search_by_advanced
+response_hash = public_record_client.search_by_advanced(
+  :legal_description => ""                # optional
+  :owner_name        => "Jon Doe"         # optional
+  :street_address    => "123 N Easy St.", # optional
+  :city              => "Boulder",        # optional
+  :state             => "CO",             # optional
+  :zip               => "",               # optional
+  :county            => "Boulder"         # optional
+)
+
+# PublicRecord#search_by_address_advanced
+response_hash = public_record_client.search_by_address_advanced(
+  :legal_description => ""                # optional
+  :owner_name        => "Jon Doe"         # optional
+  :street_address    => "123 N Easy St.", # optional
+  :city              => "Boulder",        # optional
+  :state             => "CO",             # optional
+  :zip               => "",               # optional
+  :county            => "Boulder"         # optional
+)
+
+# PublicRecord#search_by_global
+response_hash = public_record_client.search_by_address_advanced(
+  :q => "123 N Easy St." # required
+)
+```
+
+## FmaRealstate API Reference
+Please refer to the <a href="http://realestate.firstmoversadvantage.com/api_documentation" target="_blank">official api documentation</a>
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fma_realestate/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/fma_realestate.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fma_realestate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fma_realestate"
+  spec.version       = FmaRealestate::VERSION
+  spec.authors       = ["Blaine Johnson"]
+  spec.email         = ["customer.service@firstmoversadvantage.com"]
+  spec.summary       = "FMA Real Estate and CASS Ruby Client"
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = "http://realestate.firstmoversadvantage.com/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'excon', '~> 0.37'
+  spec.add_dependency 'json', '~> 1.5'
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/fma_realestate.rb

@@ -0,0 +1,21 @@
+require 'excon'
+require 'json'
+
+require "fma_realestate/version"
+require "fma_realestate/client"
+require "fma_realestate/cass"
+require "fma_realestate/public_record"
+require "fma_realestate/exceptions"
+
+module FmaRealestate
+
+  def self.configure
+    yield self
+    true
+  end
+
+  class << self
+    attr_accessor :access_token
+  end
+
+end

data/lib/fma_realestate/cass.rb

@@ -0,0 +1,7 @@
+module FmaRealestate
+  class Cass < Client
+    def tiger(params={})
+      get('/api/cass/tiger', params)
+    end
+  end
+end

data/lib/fma_realestate/client.rb

@@ -0,0 +1,79 @@
+module FmaRealestate
+  class Client
+    BASE_URI = 'http://realestate.firstmoversadvantage.com'.freeze
+
+    def initialize(config = {})
+      @access_token  = config[:access_token] || FmaRealestate.access_token
+      @raise_errors  = config[:raise_errors] || false
+      @retries       = config[:retries] || 0
+      @read_timeout  = config[:read_timeout] || 10
+      @write_timeout = config[:write_timeout] || 10
+      @connection    = Excon.new(BASE_URI, :persistent => config[:persistent] || false)
+    end
+
+    # Closes the connection underlying socket.
+    # Use when you employ persistent connections and are done with your requests.
+    def close_connection
+      @connection.reset
+    end
+
+    protected
+
+    def get(path, params = {})
+      run(:get, path, [200], params)
+    end
+
+    def run(verb, path, expected_status_codes, params_or_body = nil, idempotent = true)
+      packet = {
+        :idempotent => idempotent,
+        :expects => expected_status_codes,
+        :method => verb,
+        :path => path,
+        :read_timeout => @read_timeout,
+        :write_timeout => @write_timeout,
+        :retry_limit => @retries,
+        :headers => {
+          'Accept' => 'application/json',
+          'User-Agent'   => 'FmaRealestate Ruby Client'
+        }
+      }
+      if params_or_body.is_a?(Hash)
+        packet.merge!(:query => params_or_body)
+      else
+        packet.merge!(:body => params_or_body)
+      end
+
+      if !@access_token.nil? && @access_token != ''
+        packet[:headers].merge!('Authorization' => "Token token=#{@access_token}")
+      end
+
+      response = request_error_handler do
+        @connection.request(packet)
+      end
+
+      response ? ::JSON.load(response.body) : false
+    end
+
+    def request_error_handler(&blk)
+      begin
+        yield blk if block_given?
+      rescue Excon::Errors::NotFound => exception
+        raise(ResourceNotFound, "Error: #{exception.message}")
+      rescue Excon::Errors::BadRequest => exception
+        raise(BadRequest, "Error: #{exception.message}")
+      rescue Excon::Errors::Unauthorized => exception
+        raise(AuthenticationError, "Error: #{exception.message}")
+      rescue Excon::Errors::Error => exception
+        # Catch all others errors. Samples:
+        #
+        # <Excon::Errors::SocketError: Connection refused - connect(2) (Errno::ECONNREFUSED)>
+        # <Excon::Errors::InternalServerError: Expected([200, 204, 404]) <=> Actual(500 InternalServerError)>
+        # <Excon::Errors::Timeout: read timeout reached>
+        # <Excon::Errors::BadGateway: Expected([200]) <=> Actual(502 Bad Gateway)>
+        raise(HTTPError, "Error: #{exception.message}")
+      end
+    rescue RequestError
+      @raise_errors ? raise : false
+    end
+  end
+end

data/lib/fma_realestate/exceptions.rb

@@ -0,0 +1,7 @@
+module FmaRealestate
+  class RequestError < StandardError; end
+  class AuthenticationError < RequestError; end
+  class HTTPError < RequestError; end
+  class BadRequest < RequestError; end
+  class ResourceNotFound < RequestError; end
+end

data/lib/fma_realestate/public_record.rb

@@ -0,0 +1,19 @@
+module FmaRealestate
+  class PublicRecord < Client
+    def search_by_address(params={})
+      get('/api/public_records/search_by_address', params)
+    end
+
+    def search_by_advanced(params={})
+      get('/api/public_records/search_by_advanced', params)
+    end
+
+    def search_by_address_advanced(params={})
+      get('/api/public_records/search_by_address_advanced', params)
+    end
+
+    def search_by_global(params={})
+      get('/api/public_records/search_by_global', params)
+    end
+  end
+end

data/lib/fma_realestate/version.rb

@@ -0,0 +1,3 @@
+module FmaRealestate
+  VERSION = "0.1.0"
+end

data/spec/fixtures/search_by_address.json

@@ -0,0 +1,244 @@
+{
+    "cass": {
+        "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"
+    },
+    "count": 1,
+    "results": [
+        {
+            "assr_year": "2013",
+            "cass_city": "Boulder",
+            "cass_dpbc": "25",
+            "cass_return_code": 1,
+            "cass_search_key": "80302524725",
+            "cass_state": "CO",
+            "cass_street_address": "1325 Pearl St",
+            "cass_unit_number": "",
+            "cass_unit_type": "",
+            "cass_updated_on": "2014-12-14",
+            "cass_zip_4": "5247",
+            "cass_zip_5": "80302",
+            "core_based_statistical_area_code": "14500",
+            "created_at": "2014-12-15T04:26:34.000Z",
+            "fips_place_code": "07850",
+            "id": 48287440,
+            "last_assr_upd": "20140611",
+            "last_tax_updt": "20140311",
+            "latitude": "40.01831",
+            "longitude": "-105.278027",
+            "minor_civil_division_code": "90342",
+            "mm_fips_county_name": "BOULDER",
+            "mm_fips_muni_code": "013",
+            "mm_fips_state_code": "08",
+            "mm_muni_name": "BOULDER",
+            "mm_state_code": "CO",
+            "process_id": "148404",
+            "sa_addtns_sqft": "0",
+            "sa_appraise_val": "0",
+            "sa_appraise_yr": "2013",
+            "sa_architecture_code": "",
+            "sa_attic_sqft": "0",
+            "sa_bldg_code": "8",
+            "sa_bldg_shape_code": "",
+            "sa_bldg_sqft": "0",
+            "sa_blk_nbr_1": "95",
+            "sa_blk_nbr_2": "",
+            "sa_bsmt_2_code": "",
+            "sa_bsmt_fin_sqft": "0",
+            "sa_bsmt_unfin_sqft": "0",
+            "sa_census_block_group": "3",
+            "sa_census_tract": "012204",
+            "sa_company_flag": "Y",
+            "sa_condition_code": "4.0",
+            "sa_construction_code": "1",
+            "sa_construction_qlty": "8.0",
+            "sa_cool_code": "",
+            "sa_date_noval_transfer": "",
+            "sa_date_transfer": "",
+            "sa_doc_nbr_fmt": "",
+            "sa_doc_nbr_noval": "",
+            "sa_exemp_flag_1": "",
+            "sa_exemp_flag_2": "",
+            "sa_exemp_flag_3": "",
+            "sa_exemp_flag_4": "",
+            "sa_exemp_flag_5": "",
+            "sa_exemp_flag_6": "",
+            "sa_exemp_val_1": "0",
+            "sa_exemp_val_2": "0",
+            "sa_exemp_val_3": "0",
+            "sa_exemp_val_4": "0",
+            "sa_exemp_val_5": "0",
+            "sa_exemp_val_6": "0",
+            "sa_exterior_1_code": "",
+            "sa_fin_sqft_1": "75623",
+            "sa_fin_sqft_2": "0",
+            "sa_fin_sqft_3": "0",
+            "sa_fin_sqft_4": "0",
+            "sa_fin_sqft_tot": "75623",
+            "sa_fireplace_code": "",
+            "sa_foundation_code": "",
+            "sa_garage_carport": "",
+            "sa_geo_qlty_code": "0",
+            "sa_grg_1_code": "",
+            "sa_grg_sqft_1": "0",
+            "sa_heat_code": "",
+            "sa_heat_src_fuel_code": "",
+            "sa_imprv_pct": "30.39",
+            "sa_imprv_pct_appraise": "",
+            "sa_imprv_pct_mrkt": "30",
+            "sa_inactive_parcel_flag": "",
+            "sa_lgl_dscrptn": "PUBLIC SQUARE BLK BETWEEN BLK 94 & 95 BOULDER O T",
+            "sa_lgl_unit": "",
+            "sa_lot_depth": "0",
+            "sa_lot_nbr_1": "1",
+            "sa_lot_nbr_2": "",
+            "sa_lot_nbr_3": "",
+            "sa_lot_width": "0",
+            "sa_lotsize": "89507.0000",
+            "sa_mail_city": "BOULDER",
+            "sa_mail_crrt": "B900",
+            "sa_mail_dir": "",
+            "sa_mail_fraction": "",
+            "sa_mail_house_nbr": "",
+            "sa_mail_plus_4": "0471",
+            "sa_mail_post_dir": "",
+            "sa_mail_state": "CO",
+            "sa_mail_street_name": "PO BOX 471",
+            "sa_mail_suf": "",
+            "sa_mail_unit_pre": "",
+            "sa_mail_unit_val": "",
+            "sa_mail_zip": "80306",
+            "sa_nbr_bath": "0.00",
+            "sa_nbr_bath_1qtr": "0",
+            "sa_nbr_bath_3qtr": "0",
+            "sa_nbr_bath_bsmt_full": "0",
+            "sa_nbr_bath_bsmt_half": "0",
+            "sa_nbr_bath_dq": "0.00",
+            "sa_nbr_bath_full": "0",
+            "sa_nbr_bath_half": "0",
+            "sa_nbr_bedrms": "0",
+            "sa_nbr_rms": "0",
+            "sa_nbr_stories": "0",
+            "sa_nbr_units": "0",
+            "sa_owner_1": "COUNTY OF BOULDER",
+            "sa_owner_1_et_flag": "",
+            "sa_owner_1_first": "COUNTY OF BOULDER",
+            "sa_owner_1_group": "",
+            "sa_owner_1_last": "",
+            "sa_owner_1_mid": "",
+            "sa_owner_1_sp_first": "",
+            "sa_owner_1_sp_mid": "",
+            "sa_owner_1_sp_suf": "",
+            "sa_owner_1_suf": "",
+            "sa_owner_1_trust_flag": "",
+            "sa_owner_1_type": "1",
+            "sa_owner_2": "",
+            "sa_owner_2_et_flag": "",
+            "sa_owner_2_first": "",
+            "sa_owner_2_group": "",
+            "sa_owner_2_last": "",
+            "sa_owner_2_mid": "",
+            "sa_owner_2_sp_first": "",
+            "sa_owner_2_sp_mid": "",
+            "sa_owner_2_sp_suf": "",
+            "sa_owner_2_suf": "",
+            "sa_owner_2_trust_flag": "",
+            "sa_owner_2_type": "",
+            "sa_ownership_status_code": "",
+            "sa_parcel_account_nbr": "",
+            "sa_parcel_nbr_alt": "",
+            "sa_parcel_nbr_change_yr": "2006",
+            "sa_parcel_nbr_previous": "0085095",
+            "sa_parcel_nbr_primary": "R0085095",
+            "sa_parcel_nbr_reference": "146330324001",
+            "sa_patio_porch_code": "",
+            "sa_pool_code": "",
+            "sa_privacy_code": "",
+            "sa_property_id": 20763722,
+            "sa_quarter": "SW",
+            "sa_quarter_quarter": "",
+            "sa_range": "70W",
+            "sa_roof_code": "",
+            "sa_scm_id": 93,
+            "sa_section": "30",
+            "sa_shell_parcel_flag": "",
+            "sa_site_city": "BOULDER",
+            "sa_site_crrt": "C034",
+            "sa_site_dir": "",
+            "sa_site_fraction": "",
+            "sa_site_house_nbr": "1325",
+            "sa_site_mail_same": "N",
+            "sa_site_plus_4": "5247",
+            "sa_site_post_dir": "",
+            "sa_site_state": "CO",
+            "sa_site_street_name": "PEARL",
+            "sa_site_suf": "ST",
+            "sa_site_unit_pre": "",
+            "sa_site_unit_val": "",
+            "sa_site_zip": "80302",
+            "sa_sqft": "75623",
+            "sa_sqft_assr_tot": "75623",
+            "sa_sqft_dq": "0",
+            "sa_structure_code": "12",
+            "sa_structure_nbr": "3",
+            "sa_subdivision": "BOULDER O T EAST & WEST & NORT",
+            "sa_tax_val": "0.00",
+            "sa_tax_year_delinq": "0",
+            "sa_township": "01N",
+            "sa_tract_nbr": "0",
+            "sa_val_appraise_imprv": "0",
+            "sa_val_appraise_land": "0",
+            "sa_val_assd": "4499872",
+            "sa_val_assd_imprv": "1367872",
+            "sa_val_assd_land": "3132000",
+            "sa_val_assd_prev": "4499872",
+            "sa_val_full_cash": "0",
+            "sa_val_market": "15516800",
+            "sa_val_market_imprv": "4716800",
+            "sa_val_market_land": "10800000",
+            "sa_val_transfer": "0",
+            "sa_view_code": "",
+            "sa_x_coord": "-105.278183",
+            "sa_y_coord": "40.018799",
+            "sa_yr_apn_added": "2006",
+            "sa_yr_blt": "1935",
+            "sa_yr_blt_effect": "1970",
+            "sa_yr_land_appraise": "2013",
+            "sa_zoning": "9131",
+            "sr_unique_id": "",
+            "sr_unique_id_noval": "0",
+            "taxyear": "0",
+            "updated_at": "2014-12-15T04:26:34.000Z",
+            "use_code_muni": "9139",
+            "use_code_std": "MGOV"
+        }
+    ]
+}