housecanary-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89ec389874ba91ad835c4bcf0d06c51a89fa37fa
+  data.tar.gz: 87369ebf011c3dbaf3de659460b90e9cb4086ed2
+SHA512:
+  metadata.gz: '02829c7246cec460c0c5f4ce61f0d9fe0787f97ba9630a8548e6ec8425ed78c8c709821ff07751e2feee72dbdbd26b0ef6d73488984781f643b3b8d3294343f9'
+  data.tar.gz: e7b7c02a92175fc295f2070a69dc104373b208d97e54c711492a484bb8a81c63a0afb35ce30b684ca829def72d8ccef9351773f2aaf2cbe6d7dfd3fba8497a06

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.irbrc

@@ -0,0 +1,7 @@
+begin
+  require 'pry'
+  Pry.start
+  exit
+rescue LoadError
+  puts "Pry not found, using 'irb' instead. Try\n  gem install pry"
+end

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/AccessModifierIndentation:
+  EnforcedStyle: indent
+  SupportedStyles:
+    - outdent
+    - indent
+
+Metrics/MethodLength:
+  Max: 25
+Metrics/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.13.6
+script:
+  - bundle exec rspec
+branches:
+  only:
+    - master

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 JetRockets
+
+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,88 @@
+# The Housecanary Ruby Gem
+[![Gem Version](https://badge.fury.io/rb/housecanary-ruby.svg)](https://badge.fury.io/rb/housecanary-ruby)
+[![Build Status](https://travis-ci.org/jetrockets/housecanary-ruby.svg?branch=master)](https://travis-ci.org/jetrockets/housecanary-ruby)
+
+Ruby wrapper for the HouseCanary Data & Analytics API.
+[https://www.housecanary.com/real-estate-data-api](https://www.housecanary.com/real-estate-data-api)
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'housecanary-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install housecanary-ruby
+
+## Configuration
+You can pass configuration options as a block:
+
+```ruby
+Housecanary.configure do |config|
+    config.api_key = 'your_api_key'
+    config.api_secret = 'your_api_secret'
+end
+```
+## Usage
+### Sales History
+Search sales and ownership transfer history. [Original documentation](https://api-docs.housecanary.com/#property-sales_history).
+
+Example:
+```ruby
+sales = Housecanary.properties.sales_history(address: '000 Some Street', zipcode: '01234', limit: '1')
+```
+If sales information is found, the `sales` will contain `Housecanary::API::SalesHistory` object.
+`sales.result` will contain an array of `Housecanary::API::Sale` objects.
+```ruby
+=> #<Housecanary::API::SalesHistory:0x007fa0dd2f3d18
+ @api_code=0,
+ @api_code_description="ok",
+ @result=
+  [#<Housecanary::API::Sale:0x007fa0dd2f3b60
+    @amount=00.0,
+    @apn="000-00-0000",
+    @event_type="event_type",
+    @fips="11111",
+    @grantee_1="Grantee1",
+    @grantee_1_forenames="Grantee1forenames",
+    @grantee_2=nil,
+    @grantee_2_forenames=nil,
+    @grantor_1="Grantor1",
+    @grantor_1_forenames="Grantor1forenames",
+    @grantor_2="",
+    @record_book="0000",
+    @record_date="1999-01-01",
+    @record_doc="00000",
+    @record_page="0000">]
+```
+## Exception Handling
+
+If Housecanary will return anything different from 200 OK status code, `Housecanary::Error` will be raised. It contains `#message` and `#code` returned from API.
+
+For example with invalid credentials you will receive:
+``` ruby
+sales = Housecanary.properties.sales_history(address: '000 Some Street', zipcode: '01234')
+#=> Housecanary::Error::Unauthorized: Invalid credentials
+```
+Or with invalid zipcode:
+```ruby
+sales = Housecanary.properties.sales_history( address: '000 Sample', zipcode: '0')
+#=> Housecanary::Error::BadRequest: not a valid value for dictionary value @ data[0]['zipcode']
+```
+## Credits
+
+Sponsored by [JetRockets](http://www.jetrockets.pro).
+
+![JetRockets](http://jetrockets.pro/JetRockets.jpg)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "housecanary"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/housecanary-ruby.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'housecanary/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'housecanary-ruby'
+  spec.version       = Housecanary::VERSION
+  spec.authors       = ['Ilia Kriachkov']
+  spec.email         = ['ilia.kriachkov@jetrockets.ru']
+
+  spec.summary       = %q(Ruby wrapper for the HouseCanary Data & Analytics API.)
+  spec.description   = %q(Ruby wrapper for the HouseCanary Data & Analytics API. https://www.housecanary.com/real-estate-data-api)
+  spec.homepage      = %q(https://github.com/jetrockets/housecanary-ruby)
+  spec.license       = 'MIT'
+
+  spec.bindir        = 'bin'
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.3'
+
+  # a b c d e f g h i j k l m n o p q r s t u v w x y z
+  spec.add_dependency 'dry-auto_inject'
+  spec.add_dependency 'dry-container'
+  spec.add_dependency 'dry-initializer'
+  spec.add_dependency 'dry-types'
+  spec.add_dependency 'http', '~> 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  # spec.add_development_dependency 'factory_bot'
+  # spec.add_development_dependency 'faker', '~> 1.9'
+  spec.add_development_dependency 'pry', '~> 0.11.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'simplecov', '>= 0.6.2'
+  spec.add_development_dependency 'webmock', '~> 3.4'
+end

data/lib/housecanary/api/helpers.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Housecanary
+  module API
+    module Helpers
+      def _perform_response(parser, connection, method, path, params = {})
+        parser.perform(perform_request(method, connection, path, params))
+      end
+
+      def perform_request(method, connection, path, params)
+        args = connection, path, params
+        case method&.to_sym
+        when :get
+          perform_get(*args)
+        when :post
+          perform_post(*args)
+        else
+          raise NotImplementedError, "Method <#{method}> Not Supported"
+        end
+      end
+
+      def perform_get(connection, path, params)
+        connection.get(path, params: params)
+      end
+
+      def perform_post(connection, path, params)
+        connection.post(path, json: params)
+      end
+    end
+  end
+end

data/lib/housecanary/api/repository.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'housecanary/api/helpers'
+require 'housecanary/api/sales_history'
+
+module Housecanary
+  module API
+    class Repository
+      include Housecanary::API::Helpers
+      include Housecanary::AutoInject['connection', 'response_parser']
+
+      SALES_HISTORY_PATH = 'property/sales_history'
+
+      def sales_history(params = {})
+        if response = perform_response(:get, SALES_HISTORY_PATH, params)
+          SalesHistory.new(response&.first&.fetch("property/sales_history".to_sym, nil))
+        end
+      end
+
+      private
+
+      def perform_response(method, path, params = {})
+        _perform_response(response_parser, connection, method, path, params)
+      end
+    end
+  end
+end

data/lib/housecanary/api/sale.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'dry-initializer'
+require 'dry-types'
+
+module Housecanary
+  module API
+    class Sale
+      extend Dry::Initializer
+      option :amount
+      option :apn, optional: true
+      option :event_type, optional: true
+      option :fips, optional: true
+      option :grantee_1_forenames
+      option :grantee_1
+      option :grantee_2_forenames, optional: true
+      option :grantee_2, optional: true
+      option :grantor_1_forenames
+      option :grantor_1
+      option :grantor_2, optional: true
+      option :record_book, optional: true
+      option :record_date, optional: true
+      option :record_doc, optional: true
+      option :record_page, optional: true
+
+      def self.call(*args)
+        self.new(*args)
+      end
+    end
+  end
+end

data/lib/housecanary/api/sales_history.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'dry-initializer'
+require 'dry-types'
+
+require 'housecanary/api/sale'
+
+module Housecanary
+  module API
+    class SalesHistory
+      extend Dry::Initializer
+      option :api_code_description, optional: true
+      option :api_code, optional: true
+      option :result, type: Dry::Types['coercible.array'].of(Sale)
+    end
+  end
+end

data/lib/housecanary/connection.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'dry-initializer'
+require 'http'
+
+module Housecanary
+  class Connection #:nodoc:
+    extend Dry::Initializer
+    BASE_URL = 'https://api.housecanary.com/v2/'
+
+    option :api_key
+    option :api_secret
+
+    def post(path, params = {})
+      HTTP.basic_auth(user: api_key, pass: api_secret).post(url(path), params)
+    end
+
+    def get(path, params = {})
+      HTTP.basic_auth(user: api_key, pass: api_secret).get(url(path), params)
+    end
+
+    private
+
+    def url(path)
+      URI.join(BASE_URL, path)
+    end
+  end
+end

data/lib/housecanary/error.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Housecanary
+  class Error < StandardError #:nodoc:
+    attr_reader :code
+
+    BadRequest = Class.new(self)
+    Unauthorized = Class.new(self)
+    Forbidden = Class.new(self)
+    NotFound = Class.new(self)
+    InternalServerError = Class.new(self)
+    TooManyRequests = Class.new(self)
+
+    ERRORS_MAP = {
+      400 => Housecanary::Error::BadRequest,
+      401 => Housecanary::Error::Unauthorized,
+      403 => Housecanary::Error::Forbidden,
+      404 => Housecanary::Error::NotFound,
+      429 => Housecanary::Error::TooManyRequests,
+      500 => Housecanary::Error::InternalServerError
+    }.freeze
+
+    class << self
+      def from_response(body)
+        message, status = parse_error(body)
+        new(message, status)
+      end
+
+      def parse_error(body)
+        message = body.fetch(:message, nil)
+        status = body.fetch(:status, nil)
+        [message, status]
+      end
+    end
+
+    private
+
+    def initialize(message = '', code = nil)
+      super(message)
+      @code = code
+    end
+  end
+end

data/lib/housecanary/response_parser.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'housecanary/error'
+require 'housecanary/utils'
+
+module Housecanary
+  class ResponseParser #:nodoc:
+    class << self
+      def perform(response)
+        response_body = response.body.empty? ? '' : utils.deep_symbolize_keys(response.parse(:json))
+        api_error_filter(response.code, response_body)
+      end
+
+      private
+
+      def utils
+        Housecanary::Utils
+      end
+
+      def error(code, body)
+        Housecanary::Error::ERRORS_MAP[code]&.from_response(body)
+      end
+
+      def api_error_filter(code, body)
+        error = error(code, body)
+        raise(error) if error
+        body
+      end
+    end
+  end
+end

data/lib/housecanary/utils.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Housecanary
+  module Utils #:nodoc:
+    def deep_symbolize_keys(hash)
+      deep_transform_keys(hash) { |key| key.to_sym rescue key }
+    end
+    module_function :deep_symbolize_keys
+
+    private
+
+    def deep_transform_keys(object, &block)
+      case object
+      when Hash
+        object.each_with_object({}) do |(key, value), result|
+          result[yield(key)] = deep_transform_keys(value, &block)
+        end
+      when Array
+        object.map { |e| deep_transform_keys(e, &block) }
+      else
+        object
+      end
+    end
+    module_function :deep_transform_keys
+  end
+end

data/lib/housecanary/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Housecanary
+  VERSION = '0.1.0'
+end

data/lib/housecanary.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'dry-container'
+require 'dry-auto_inject'
+require 'ostruct'
+
+require 'housecanary/version'
+require 'housecanary/connection'
+require 'housecanary/response_parser'
+
+module Housecanary #:nodoc:
+  @container = ::Dry::Container.new
+  AutoInject = ::Dry::AutoInject(@container)
+
+  def self.configure
+    yield(configuration)
+    register!
+  end
+
+  def self.container
+    @container
+  end
+
+  def self.properties
+    Housecanary::API::Repository.new
+  end
+
+  class << self
+    private
+
+    def configuration
+      @configuration ||= OpenStruct.new
+    end
+
+    def register!
+      connection = ::Housecanary::Connection.new(configuration.to_h)
+      parser_class = ::Housecanary::ResponseParser
+      container.register :connection, -> { connection }
+      container.register :response_parser, -> { parser_class }
+    end
+  end
+end
+
+require 'housecanary/api/repository'

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: housecanary-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ilia Kriachkov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-auto_inject
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Ruby wrapper for the HouseCanary Data & Analytics API. https://www.housecanary.com/real-estate-data-api
+email:
+- ilia.kriachkov@jetrockets.ru
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".irbrc"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- housecanary-ruby.gemspec
+- lib/housecanary.rb
+- lib/housecanary/api/helpers.rb
+- lib/housecanary/api/repository.rb
+- lib/housecanary/api/sale.rb
+- lib/housecanary/api/sales_history.rb
+- lib/housecanary/connection.rb
+- lib/housecanary/error.rb
+- lib/housecanary/response_parser.rb
+- lib/housecanary/utils.rb
+- lib/housecanary/version.rb
+homepage: https://github.com/jetrockets/housecanary-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the HouseCanary Data & Analytics API.
+test_files: []