hopo-ruby 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 181e5c6cf047a790539ca4cc364618d5d30bc6e2
+  data.tar.gz: 03d7ef77b7a55c5011d34644d5370d5a9cff3955
+SHA512:
+  metadata.gz: cce29ce73cdfb6a520c58bd1cd95040c0bfd7727d5ce12dcf87bb141c41f5d389e729599d3ed7465bd827712910f5ce8fbcc1f72c2e3a9ecca2edf6f61a8fad5
+  data.tar.gz: 4ac570b7263262b466638b0b1de80270a42a7d030499c5b8c90933a88e9d6ebb38d1eb006477885fa95bb4c632829efe9b4de0fa2ba361687cdd359c0e0aa8b9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mike Reinmiller
+
+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,37 @@
+
+# Hopo::Ruby
+
+A library for using the Honest Policy API, currently supports Auto and Home Raters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hopo-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hopo-ruby
+
+
+## Setup
+
+You need to set the **api_key** given by honestpolicy before you can use the raters.  This can be set as simply as:
+
+```ruby
+Hopo.api_key = 'your-unique-api-key'
+```
+
+If you are using rails, you can run the generator to setup a config/initializer file for you.  This file will require the hopo library and add a line to set your api_key.  Make sure you do not commit your actual key to your repository.
+
+    $ rails g hopo:install
+
+
+## Usage
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+# Will load PRY with GEM required.  Could also run `pry --gem`
+task :console do
+  require 'pry'
+  require 'hopo'
+  ARGV.clear
+  Pry.start
+end
+
+task :c => :console

data/hopo-ruby.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hopo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hopo-ruby"
+  spec.version       = Hopo::VERSION
+  spec.authors       = ["Mike Reinmiller"]
+  spec.email         = ["mike@honestpolicy.com"]
+  spec.summary       = %q{A simple library for communicating with the Honest Policy API}
+  spec.description   = %q{Easily connect to multiple Honest Policy APIs including the Rater, Leads, Vehicles and Carrier Quality}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency 'pry', "~> 0.10.1"
+
+end

data/lib/extend/object.rb

@@ -0,0 +1,46 @@
+# Borrowed from Rails source
+
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, '', '   ', +nil+, [], and {} are all blank.
+  #
+  # This simplifies
+  #
+  #   address.nil? || address.empty?
+  #
+  # to
+  #
+  #   address.blank?
+  #
+  # @return [true, false]
+  def blank?
+    respond_to?(:empty?) ? !!empty? : !self
+  end
+
+  # An object is present if it's not blank.
+  #
+  # @return [true, false]
+  def present?
+    !blank?
+  end
+
+  # Returns the receiver if it's present otherwise returns +nil+.
+  # <tt>object.presence</tt> is equivalent to
+  #
+  #    object.present? ? object : nil
+  #
+  # For example, something like
+  #
+  #   state   = params[:state]   if params[:state].present?
+  #   country = params[:country] if params[:country].present?
+  #   region  = state || country || 'US'
+  #
+  # becomes
+  #
+  #   region = params[:state].presence || params[:country].presence || 'US'
+  #
+  # @return [Object]
+  def presence
+    self if present?
+  end
+end

data/lib/generators/hopo/install_generator.rb

@@ -0,0 +1,13 @@
+module Hopo
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Creates Hopo Initializer File"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializer
+        template 'hopo_config.rb', 'config/initializers/hopo.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/hopo/templates/hopo_config.rb

@@ -0,0 +1,6 @@
+# Do not put the API_KEY directly in this file.  It is recommended to set
+# the appropriate environment variable.
+
+require 'hopo'
+
+Hopo.api_key = ENV['HOPO_API_KEY']

data/lib/hopo.rb

@@ -0,0 +1,46 @@
+# Hopo Ruby libs
+require 'net/http'
+require 'uri'
+require 'openssl'
+require 'json'
+require 'ostruct'
+
+# Version
+require "hopo/version"
+
+# Extend Ruby Classes
+require 'extend/object' unless defined?(::Rails)
+
+# General
+require 'hopo/errors'
+
+# API Connections
+require 'hopo/connections/request'
+require 'hopo/connections/response'
+require 'hopo/api'
+
+# Rater - Auto, Home, Health, Life
+require 'hopo/rater'
+require 'hopo/rater/auto_rater'
+require 'hopo/rater/home_rater'
+
+# Base Hopo Module
+module Hopo
+  class << self
+    attr_accessor :api_key
+
+    def new_request(line)
+      Rater.new(line)
+    end
+
+    def home_request
+      HomeRater.new
+    end
+
+    def auto_request
+      AutoRater.new
+    end
+
+  end
+end
+

data/lib/hopo/api.rb

@@ -0,0 +1,66 @@
+module Hopo
+  class API
+    include Hopo::Connections::Request
+    include Hopo::Connections::Response
+
+    attr_reader :url, :path, :ssl, :default_params
+    attr_accessor :uri, :http
+
+    def initialize(url, path=nil, ssl=false)
+      @default_params = {}
+      @params = {}
+      @url = url
+      @path = path
+      @ssl = ssl
+      setup_connections
+    end
+
+    def params=(parameters)
+      raise ArgumentError, 'parameters must be a hash {}' unless parameters.is_a?(Hash)
+      @params = parameters
+    end
+
+    def params
+      @params
+    end
+
+    def full_path
+      "#{url}#{path}"
+    end
+
+    private
+
+    def setup_connections
+      @uri = URI.parse(full_path)
+      @http = Net::HTTP.new(uri.host, uri.port)
+
+      if @ssl
+        @http.use_ssl = true
+        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      false
+    end
+
+    def perform_request(method, parameters, type)
+      request = method.new( encode_params( parameters ) )
+      response = http.request(request)
+      self.send("response_#{type}", response)
+    end
+
+    def encode_params(parameters)
+      uri.query = URI.encode_www_form( merge_parameters(parameters) )
+      uri
+    end
+
+    def merge_parameters(parameters)
+      raise ParameterError, 'parameters must be a hash {}' unless parameters.is_a?(Hash)
+      hash_merge(self.default_params, self.params, parameters)
+    end
+
+    def hash_merge(*hashes)
+      hashes.inject :merge
+    end
+
+  end
+end

data/lib/hopo/connections/request.rb

@@ -0,0 +1,38 @@
+module Hopo
+  module Connections
+    module Request
+      module ClassMethods
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      # Perform a GET request to a path
+      def get(parameters={}, type='json')
+        perform_request Net::HTTP::Get, parameters, type
+      end
+
+      # Perform a POST request to a path
+      def post(parameters={}, type='json')
+        perform_request Net::HTTP::Post, parameters, type
+      end
+
+      # Perform a PATCH request to a path
+      def patch(parameters={}, type='json')
+        perform_request Net::HTTP::Patch, parameters, type
+      end
+
+      # Perform a PUT request to a path
+      def put(parameters={}, type='json')
+        perform_request Net::HTTP::Put, parameters, type
+      end
+
+      # Perform a DELETE request to a path
+      def delete(parameters={}, type='json')
+        perform_request Net::HTTP::Delete, parameters, type
+      end
+
+    end
+  end
+end

data/lib/hopo/connections/response.rb

@@ -0,0 +1,30 @@
+module Hopo
+  module Connections
+    module Response
+      module ClassMethods
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      private
+
+      # RAW response
+      def response_raw(response)
+        response.body
+      end
+
+      # Formatted JSON response
+      def response_json(response)
+        JSON.parse(response.body)
+      end
+
+      # Formatted OpenStruct response
+      def response_struct(response)
+        OpenStruct.new( request_json(response) )
+      end
+
+    end
+  end
+end

data/lib/hopo/errors.rb

@@ -0,0 +1,8 @@
+module Hopo
+  class Error < Exception
+  end
+  class AuthenticationError < Error
+  end
+  class ParameterError < Error
+  end
+end

data/lib/hopo/rater.rb

@@ -0,0 +1,73 @@
+module Hopo
+  class Rater < API
+    attr_accessor :line, :premium_mode, :sorter
+
+    BASE_URL = 'https://integral.honestpolicy.com/api'
+
+    def initialize(line, premium_mode='annually', sorter='premiums-asc', version=1, path='rates')
+      unless Hopo.api_key
+        raise AuthenticationError, 'No API key provided.  Set your API key using "Hopo.api_key = <API-KEY>".'
+      end
+
+      super(BASE_URL, "/v#{version}/#{path}", true)
+
+      @premium_mode = premium_mode
+      @sorter = sorter
+
+      @default_params = {
+        :key => Hopo.api_key,
+        :line => line
+      }
+
+    end
+
+    private
+
+    def response_json(response)
+      format_response( JSON.parse(response.body) )
+    end
+
+    def format_response(response)
+      # TEMP Hack Until Integral API is cleaned Up....
+      if response['status']
+        hash = { :errors => [response['message']] }
+
+      else
+        hash = {}
+        rates = response['results']['rates']
+        errors = response['results']['errors']
+        risk = response['risk']
+
+        hash.merge!( {:rates => factor_premiums(rates) } ) unless rates.blank?
+        hash.merge!( {:errors => errors} ) unless errors.blank?
+        hash.merge!( {:risk => risk} ) unless risk.blank?
+
+      end
+
+      hash
+    end
+
+    def factor_premiums(rates)
+      premiums = {:monthly => 12, :triannually => 3, :quarterly => 4, :biannually => 2, :annually => 1}
+      divisor = premiums[premium_mode.to_sym] || 1
+
+      rates.each do |k, v|
+        rates[k] = v / divisor
+      end
+
+      sort_rates(rates) unless sorter.blank?
+    end
+
+    def sort_rates(rates)
+      sort = sorter.split('-')
+
+      sorted_rates =
+        if sort[1] == 'desc'
+          Hash[rates.sort_by {|k, v| sort[0]=='companies' ? k : v }.reverse]
+        else
+          Hash[rates.sort_by {|k, v| sort[0]=='companies' ? k : v }]
+        end
+    end
+
+  end
+end

data/lib/hopo/rater/auto_rater.rb

@@ -0,0 +1,26 @@
+module Hopo
+  class AutoRater < Rater
+
+    def initialize(premium_mode='annually', sorter='premiums-asc', version=1, path='rates')
+      super('auto', premium_mode, sorter, version, path)
+    end
+
+    def required_fields?
+      {
+        :zip => 'Five diging Zip Code for location',
+        :model_year => 'Not Required - defaults to 2012',
+        :make => 'Not Required - defaults to Toyota',
+        :model => 'Not Required - defaults to Camry'
+      }
+    end
+
+    def optional_fields?
+      {
+        :test1 => 'test 1',
+        :test2 => 'test 2',
+        :test3 => 'test 3'
+      }
+    end
+
+  end
+end

data/lib/hopo/rater/home_rater.rb

@@ -0,0 +1,26 @@
+module Hopo
+  class HomeRater < Rater
+
+    def initialize(premium_mode='annually', sorter='premiums-asc', version=1, path='rates')
+      super('home', premium_mode, sorter, version, path)
+    end
+
+    def required_fields?
+      {
+        :zip => 'Five diging Zip Code for location',
+        :cov_a => 'The Coverage Amount for the Home - Minimum 10000',
+        :year_built => 'Year Home was built - 1800 to 2014',
+        :construction_type => 'Material used for Home - [Frame, Masonry, Adobe, Log]'
+      }
+    end
+
+    def optional_fields?
+      {
+        :test1 => 'test 1',
+        :test2 => 'test 2',
+        :test3 => 'test 3'
+      }
+    end
+
+  end
+end

data/lib/hopo/version.rb

@@ -0,0 +1,3 @@
+module Hopo
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: hopo-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Mike Reinmiller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+description: Easily connect to multiple Honest Policy APIs including the Rater, Leads,
+  Vehicles and Carrier Quality
+email:
+- mike@honestpolicy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hopo-ruby.gemspec
+- lib/extend/object.rb
+- lib/generators/hopo/install_generator.rb
+- lib/generators/hopo/templates/hopo_config.rb
+- lib/hopo.rb
+- lib/hopo/api.rb
+- lib/hopo/connections/request.rb
+- lib/hopo/connections/response.rb
+- lib/hopo/errors.rb
+- lib/hopo/rater.rb
+- lib/hopo/rater/auto_rater.rb
+- lib/hopo/rater/home_rater.rb
+- lib/hopo/version.rb
+homepage: ''
+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: A simple library for communicating with the Honest Policy API
+test_files: []