em-synchrony-dataone-vin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c877baafea2c7245911ad6694c98d8a623c0fa64
+  data.tar.gz: 3a99bf467ca37e2d9779c867708514ad75af8f42
+SHA512:
+  metadata.gz: c74f30d047628e390420ac38caa7c3d70b604e3e6ac6c81158ba4fb8ef9af483f6d32279d33453f49aa0dcde2698dd2a7af20eea07c200c6a5f677d17a9abe99
+  data.tar.gz: 09a37d24790f4fb8e01fb3bb2e8fcef5f5f5b7bf70e52ff16ab5c26bd48dd4f6ebae55b9a357b135c8edb4436fe1018e1ae12ebb710c525a136dc3cd65e71311

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+dataone-config.rb

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Scott Nielsen
+
+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,29 @@
+# EM::Synchrony::DataoneVin
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'em-synchrony-dataone-vin'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install em-synchrony-dataone-vin
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = ['lib', 'test']
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/em-synchrony-dataone-vin.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'em-synchrony/dataone-vin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "em-synchrony-dataone-vin"
+  spec.version       = EventMachine::Synchrony::DataoneVin::VERSION
+  spec.authors       = ["Scott Nielsen", "Jake Mallory"]
+  spec.email         = ["scottnielsen5@gmail.com", "tinomen@gmail.com"]
+  spec.description   = %q{A client for the Dataone vindecoding service that runs with EM::Synchrony}
+  spec.summary       = %q{A client for the Dataone vindecoding service that runs with EM::Synchrony}
+  spec.homepage      = "https://github.com/scizo/em-synchrony-dataone-vin"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "em-http-request", "~> 1.1.0"
+  spec.add_dependency "em-synchrony",    "~> 1.0.3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 0.9.6"
+end

data/lib/em-synchrony/dataone-vin/version.rb

@@ -0,0 +1,7 @@
+module EventMachine
+  module Synchrony
+    module DataoneVin
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/em-synchrony/dataone-vin/vin_exploder_adapter.rb

@@ -0,0 +1,165 @@
+require 'em-synchrony/dataone-vin'
+
+module EventMachine
+  module Synchrony
+    module DataoneVin
+      class VinExploderAdapter
+        class Error < ::StandardError; end
+
+        DRIVELINE_TYPES = {
+          '4x4' => '4WD',
+          '4X4' => '4WD',
+          '4x2' => 'RWD',
+          '4X2' => 'RWD',
+        }
+
+        FUEL_TYPES = {
+          'B' => 'BIODIESEL',
+          'D' => 'DIESEL',
+          'F' => 'FFV',
+          'G' => 'GAS',
+          'I' => 'HYBRID',
+          'L' => 'ELECTRIC',
+          'N' => 'NATURALGAS',
+          'P' => 'PETROLEUM',
+          'Y' => 'HYBRID',
+        }
+
+        BRAKE_TYPES = {
+          ['Not Available', 'Not Available'] => 'Non-ABS',
+          ['Not Available', 'Standard']      => '4-Wheel ABS',
+          ['Not Available', 'Optional']      => 'Non-ABS | 4-Wheel ABS',
+          ['Standard', 'Not Available'] => '2-Wheel ABS',
+          ['Standard', 'Standard']      => '2-Wheel ABS | 4-Wheel ABS',
+          ['Standard', 'Optional']      => '2-Wheel ABS | 4-Wheel ABS',
+          ['Optional', 'Not Available'] => 'Non-ABS | 2-Wheel ABS',
+          ['Optional', 'Standard']      => '2-Wheel ABS | 4-Wheel ABS',
+          ['Optional', 'Optional']      => 'Non-ABS | 2-Wheel ABS | 4-Wheel ABS',
+        }
+
+        DATA_PATHS = {
+          'year'                  => ['basic_data', 'year'],
+          'make'                  => ['basic_data', 'make'],
+          'model'                 => ['basic_data', 'model'],
+          'trim_level'            => ['basic_data', 'trim'],
+          'engine_type'           => ['engines', 0, 'name'],
+          'engine_displacement'   => ['engines', 0, 'displacement'],
+          'engine_shape'          => ['engines', 0, 'block_type'],
+          'body_style'            => ['basic_data', 'body_type'],
+          'manufactured_in'       => ['basic_data', 'country_of_manufacture'],
+          'driveline'             => ['basic_data', 'drive_type'],
+          'fuel_type'             => ['engines', 0, 'fuel_type'],
+          'transmission-long'     => ['transmissions', 0, 'name'],
+          'gears'                 => ['transmissions', 0, 'gears'],
+          'transmission-type'     => ['transmissions', 0, 'type'],
+          'tank'                  => ['specifications', ['category', 'Fuel Tanks'], 'specifications', ['name', 'Fuel Tank 1 Capacity (Gallons)'], 'value'],
+          'abs_two_wheel'         => ['safety_equipment', 'abs_two_wheel'],
+          'abs_four_wheel'        => ['safety_equipment', 'abs_four_wheel'],
+          'gvwr_class'            => ['specifications', ['category', 'Measurements of Weight'], 'specifications', ['name', 'Gross Vehicle Weight Rating'], 'value'],
+          'vehicle_type'          => ['basic_data', 'vehicle_type'],
+          'number_of_cylinders'   => ['engines', 0, 'cylinders'],
+          'number_of_doors'       => ['basic_data', 'doors'],
+          'standard_seating'      => ['specifications', ['category', 'Seating'], 'specifications', ['name', 'Standard Seating'], 'value'],
+          'optional_seating'      => ['specifications', ['category', 'Seating'], 'specifications', ['name', 'Max Seating'], 'value'],
+          'length'                => ['specifications', ['category', 'Measurements of Size and Shape'], 'specifications', ['name', 'Length'], 'value'],
+          'width'                 => ['specifications', ['category', 'Measurements of Size and Shape'], 'specifications', ['name', 'Width'], 'value'],
+          'height'                => ['specifications', ['category', 'Measurements of Size and Shape'], 'specifications', ['name', 'Height'], 'value'],
+          'production_seq_number' => ['This will always be nil'],
+        }
+
+        def initialize(options)
+          client_id, authorization_code = options.values_at(:client_id, :authorization_code)
+
+          unless client_id && authorization_code
+            raise Error.new "DataoneVin::VinExploderAdapter requires both a client_id and an authorization_code"
+          end
+
+          DataoneVin.configure client_id, authorization_code
+        end
+
+        def explode(vin)
+          format_response DataoneVin.get(vin), vin
+        end
+
+        def format_response(response, vin)
+          errors = errors(response)
+          return {:errors => errors} unless errors.empty?
+
+          data = response['query_responses']['Request-Sample']
+          explosion(data['common_data']).merge \
+            :errors        => [],
+            :vin           => vin,
+            :vin_key       => vin_key(vin),
+            :vendor_result => data
+        end
+
+        def errors(response)
+          query_error = response['query_responses']['Request-Sample']['query_error']['error_message']
+          errors = response['decoder_messages']['decoder_errors']
+          errors << query_error unless query_error.empty?
+          errors
+        end
+
+        def explosion(data)
+          normalize Hash[DATA_PATHS.map do |(key, path)|
+            [key, lookup_data(data, path)]
+          end]
+        end
+
+        def lookup_data(data, path)
+          path.reduce(data) do |d, (k, v)|
+            if v
+              d.find{|h| h[k] == v}
+            else
+              d[k]
+            end
+          end
+        rescue
+          nil
+        end
+
+        def normalize(data)
+          data['driveline'] = normalize_driveline data['driveline']
+          data['fuel_type'] = normalize_fuel_type data['fuel_type']
+          data['vehicle_type'] = data['vehicle_type'].upcase
+          data['has_turbo'] = !!(data['engine_type'] =~ /turbo/i)
+          data['transmission-short'] = "#{data.delete('gears')}#{data.delete('transmission-type')}"
+          data['anti-brake_system'] = normalize_brakes data.delete('abs_two_wheel'), data.delete('abs_four_wheel')
+          data['gvwr_class'] = normalize_gvwr_class data['gvwr_class']
+
+          data
+        end
+
+        def normalize_driveline(driveline)
+          DRIVELINE_TYPES.fetch(driveline, driveline)
+        end
+
+        def normalize_fuel_type(fuel_type)
+          FUEL_TYPES.fetch(fuel_type, 'No data')
+        end
+
+        def normalize_brakes(abs_two_wheel, abs_four_wheel)
+          BRAKE_TYPES.fetch([abs_two_wheel, abs_four_wheel], 'No Data')
+        end
+
+        def normalize_gvwr_class(weight_rating)
+          case weight_rating.to_i
+          when 0..6_000                then '1'
+          when 6_001..10_000           then '2'
+          when 10_001..14_000          then '3'
+          when 14_001..16_000          then '4'
+          when 16_001..19_500          then '5'
+          when 19_501..26_000          then '6'
+          when 26_001..33_000          then '7'
+          when 33_001..Float::INFINITY then '8'
+          else                              '1'
+          end
+        end
+
+        def vin_key(vin)
+          "#{vin[0,8]}#{vin[9,2]}"
+        end
+      end
+    end
+  end
+end

data/lib/em-synchrony/dataone-vin.rb

@@ -0,0 +1,92 @@
+require 'json'
+require 'em-http'
+require 'em-synchrony'
+require 'em-synchrony/em-http'
+require 'em-synchrony/dataone-vin/version'
+
+module EventMachine
+  module Synchrony
+    module DataoneVin
+      module_function
+
+      def configure(client_id, authorization_code)
+        @dataone_config = {
+          :client_id => client_id,
+          :authorization_code => authorization_code
+        }
+      end
+
+      def get(vin)
+        JSON::load EM::HttpRequest.new(request_url).post(
+          :head => {:content_type => 'application/x-www-form-urlencoded'},
+          :body => request_hash(vin)
+        ).response
+      end
+
+      def request_url
+        "https://www.dataonesoftware.com/webservices/vindecoder/decode"
+      end
+
+      def request_hash(vin)
+        @dataone_config.merge :decoder_query => decoder_settings(vin)
+      end
+
+      def decoder_settings(vin)
+        JSON::dump \
+          "decoder_settings"=>
+           {"display"=>"full",
+            "version"=>"7.0.0",
+            "styles"=>"on",
+            "style_data_packs"=>
+             {"basic_data"=>"on",
+              "pricing"=>"on",
+              "engines"=>"on",
+              "transmissions"=>"on",
+              "specifications"=>"on",
+              "optional_equipment"=>"on",
+              "colors"=>"on",
+              "safety_equipment"=>"on",
+              "warranties"=>"on"},
+            "common_data"=>"on",
+            "common_data_packs"=>
+             {"basic_data"=>"on",
+              "pricing"=>"on",
+              "engines"=>"on",
+              "transmissions"=>"on",
+              "specifications"=>"on",
+              "colors"=>"on",
+              "safety_equipment"=>"on",
+              "warranties"=>"on"}},
+          "query_requests"=>
+           {"Request-Sample"=>
+             {"vin"=>vin,
+              "year"=>"",
+              "make"=>"",
+              "model"=>"",
+              "trim"=>"",
+              "model_number"=>"",
+              "package_code"=>"",
+              "drive_type"=>"",
+              "vehicle_type"=>"",
+              "body_type"=>"",
+              "body_subtype"=>"",
+              "doors"=>"",
+              "bedlength"=>"",
+              "wheelbase"=>"",
+              "msrp"=>"",
+              "invoice_price"=>"",
+              "engine"=>
+               {"description"=>"",
+                "block_type"=>"",
+                "cylinders"=>"",
+                "displacement"=>"",
+                "fuel_type"=>""},
+              "transmission"=>{"description"=>"", "trans_type"=>"", "trans_speeds"=>""},
+              "optional_equipment_codes"=>"",
+              "installed_equipment_descriptions"=>"",
+              "interior_color"=>{"description"=>"", "color_code"=>""},
+              "exterior_color"=>{"description"=>"", "color_code"=>""}}}
+      end
+    end
+  end
+end

data/test/em-synchrony/dataone-vin/vin_exploder_adapter_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+require 'em-synchrony/dataone-vin/vin_exploder_adapter.rb'
+
+module EventMachine
+  module Synchrony
+    module DataoneVin
+      describe VinExploderAdapter do
+        include TestHelpers
+
+        let(:adapter) {
+          VinExploderAdapter.new \
+            :client_id => DATAONE_CONFIG[0],
+            :authorization_code => DATAONE_CONFIG[1]
+        }
+
+        it 'should format the raw dataone json to the desired result' do
+          adapter.format_response(expected_result, '1FT7W2BT6BEC91853').must_equal \
+            'year'                  => '2000',
+            'make'                  => 'Toyota',
+            'model'                 => 'Tundra',
+            'trim_level'            => 'SR5',
+            'engine_type'           => 'ED 4L NA V 8 double overhead cam (DOHC) 32V',
+            'engine_displacement'   => '4.7',
+            'engine_shape'          => 'V',
+            'body_style'            => 'Pickup',
+            'manufactured_in'       => '',
+            'driveline'             => 'RWD',
+            'fuel_type'             => 'GAS',
+            'anti-brake_system'     => 'No Data',
+            'gvwr_class'            => '2',
+            'transmission-long'     => '4-Speed Automatic',
+            'transmission-short'    => '4A',
+            'tank'                  => '26',
+            'vehicle_type'          => 'TRUCK',
+            'has_turbo'             => false,
+            'number_of_cylinders'   => '8',
+            'number_of_doors'       => '4',
+            'standard_seating'      => '6',
+            'optional_seating'      => '6',
+            'length'                => '217.5',
+            'width'                 => '75.2',
+            'height'                => '70.5',
+            'production_seq_number' => nil,
+            :errors                 => [],
+            :vin                    => '1FT7W2BT6BEC91853',
+            :vin_key                => '1FT7W2BTBE',
+            :vendor_result          => expected_result['query_responses']['Request-Sample']
+        end
+      end
+    end
+  end
+end

data/test/em-synchrony/dataone-vin_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+require 'em-synchrony/dataone-vin'
+
+module EventMachine
+  module Synchrony
+    describe DataoneVin do
+      include TestHelpers
+
+      before do
+        DataoneVin.configure(*DATAONE_CONFIG)
+      end
+
+      it 'should work' do
+        EM.synchrony do
+          result = EM::Synchrony::DataoneVin.get('5TBRT3418YS094830')
+          result['query_responses']['Request-Sample'].delete('transaction_id')
+          result.must_equal expected_result
+          EM.stop
+        end
+      end
+    end
+  end
+end