blackbook_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60b702466c4b1a606946d37bb030fd12f65b348aecdbcce0d1821b6b7b058ba1
+  data.tar.gz: bf0a0167c3c2c6b2a0ca7742a4cafef41acb70abea8100ef25298d5acdf15368
+SHA512:
+  metadata.gz: 02323e7a1f61a77421c390d752cefdec6e4fe623a5cb19e5768b1c75c4b60745482165eb49332ce4dc4a10c2fa3cf232b4cb011f53a291958e0eabe8f284f985
+  data.tar.gz: 986a776454b1ff7996f5af7acf73b46066d1410e29d3fee32b5de2f6899dc92f2af8cffec42b32527b6e21df74f3b3851aa18eb4fb99253440eafdd932e09362

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+.idea/
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+blackbook_client

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in blackbook_client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    blackbook_client (0.1.0)
+      httparty (~> 0.15)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.7)
+    httparty (0.15.6)
+      multi_xml (>= 0.5.2)
+    multi_xml (0.6.0)
+    public_suffix (3.0.1)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    safe_yaml (1.0.4)
+    vcr (4.0.0)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  blackbook_client!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.7)
+  vcr (~> 4.0)
+  webmock (~> 3.3)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 The Appraisal Lane
+
+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,49 @@
+# BlackbookClient
+
+Wrapper around BlackBook web services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blackbook_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blackbook_client
+
+## Usage
+
+#### Define the username and password
+    BlackbookClient.username = 'username'
+    BlackbookClient.password = 'password'
+
+#### Call the desired method
+
+    BlackbookClient.range_by_vin('19XFC1F79GE216281')
+    
+    BlackbookClient.range_by_vin('19XFC1F79GE216281', { state: 'NY', mileage: 40000 })
+
+#### Wait for the answer
+
+    { range: { xclean: 16950, clean: 16375, average: 15650, rough: 14750 } }
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/theappraisallane/blackbook_client.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "blackbook_client"
+
+# 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(__FILE__)

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/blackbook_client.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "blackbook_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'blackbook_client'
+  spec.version       = BlackbookClient::VERSION
+  spec.authors       = ['Christian Schmeichel']
+  spec.email         = ['cschmeichel@theappraisallane.com']
+  spec.date          = '2018-01-22'
+
+  spec.summary       = %q{Blackbook Client}
+  spec.description   = %q{A wrapper around BlackBook web services.}
+  spec.homepage      = 'https://github.com/theappraisallane/blackbook-client'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty', '~> 0.15'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'vcr', '~> 4.0'
+  spec.add_development_dependency 'webmock', '~> 3.3'
+end

data/lib/blackbook_client/version.rb

@@ -0,0 +1,3 @@
+class BlackbookClient
+  VERSION = "0.1.0"
+end

data/lib/blackbook_client.rb

@@ -0,0 +1,13 @@
+require 'blackbook_client/version'
+require 'trade_service'
+require 'vin_service'
+require 'httparty'
+
+class BlackbookClient
+  extend VinService
+  extend TradeService
+
+  class << self
+    attr_accessor :username, :password
+  end
+end

data/lib/trade_service.rb

@@ -0,0 +1,3 @@
+module TradeService
+  # TODO: Define the mapping between the AR and the BlackBook parameters
+end

data/lib/vin_service.rb

@@ -0,0 +1,48 @@
+module VinService
+
+  BASE_URL = 'https://service.blackbookcloud.com'.freeze
+  VEHICLE_BY_VIN_URL = "#{BASE_URL}/UsedCarWS/UsedCarWS/UsedVehicle/VIN".freeze
+
+  def range_by_vin(vin, query_params = {})
+    url = "#{VEHICLE_BY_VIN_URL}/#{vin}"
+
+    begin
+      response = HTTParty.get(url, headers: headers, query: query_params, :debug_output => $stdout)
+      process_response(JSON.parse(response))
+    rescue => e
+      [{ error: e.to_s }, 500]
+    end
+  end
+
+  def headers
+    token = Base64.encode64("#{username}:#{password}")
+    { Authorization: "Basic #{token}" }
+  end
+
+  def process_response(response)
+    status = 200
+
+    if response['error_count'].positive?
+      response = { error: response['message_list'][0]['description'] }
+      status = 400
+    else
+      response = map_fields(response)
+    end
+
+    [response, status]
+  end
+
+  def map_fields(response)
+    return {} unless response && response['used_vehicles'] && response['used_vehicles']['used_vehicle_list']
+    vehicle_range = response['used_vehicles']['used_vehicle_list'][0]
+
+    return {
+      range: {
+        xclean: vehicle_range['adjusted_whole_xclean'],
+        clean: vehicle_range['adjusted_whole_clean'],
+        average: vehicle_range['adjusted_whole_avg'],
+        rough: vehicle_range['adjusted_whole_rough']
+      }
+    }
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: blackbook_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christian Schmeichel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: A wrapper around BlackBook web services.
+email:
+- cschmeichel@theappraisallane.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blackbook_client.gemspec
+- lib/blackbook_client.rb
+- lib/blackbook_client/version.rb
+- lib/trade_service.rb
+- lib/vin_service.rb
+homepage: https://github.com/theappraisallane/blackbook-client
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Blackbook Client
+test_files: []