chrome_data 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8afb6ab74cdffac02f50225de7260a9ef4e1456a
+  data.tar.gz: 33e84a8718d9cfe54b5e255ddf68a474a93138cd
+SHA512:
+  metadata.gz: e6cdddc5b6a76f2d4d5e103f17961daa30945f5fb8e8abb9be8c10f5316415061dc4fd8bab1a7026dddfb8da1338d834e822136a0b4512a51a9d7c43fe910d90
+  data.tar.gz: c9cec11f40b545fdcb87ab665b0b9b73d1584ba2c4a06a9cb972bfa0a82260ef22be0be34d8a01cab9ce323dee0a0646567d98b3338055315360a22554d3fcae

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Room 118 Solutions, Inc.
+
+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,114 @@
+# ChromeData
+
+Provides a simple ruby interface for Chrome Data's API. Read more about it here: http://www.chromedata.com/
+
+The wonderful [lolsoap](https://github.com/loco2/lolsoap) gem does most of the heavy lifting.
+
+## Installation
+
+Add this gem to your application's Gemfile:
+
+    gem 'chrome_data'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chrome_data
+
+## Usage
+
+### Configuration
+Valid options:
+
+  * account_number (required)
+  * account_secret (required)
+  * country (default: 'US')
+  * language (default: 'en')
+  * cache_store
+  
+Configuration:
+
+    ChromeData.config.merge! { account_number: 1234, account_secret: '5678' }
+    
+### Requests
+#### Data Collection
+#### Makes (Divisions)  
+Fields:
+
+* id (Integer)
+* name (String)
+
+Request a set of divisions:
+
+    ChromeData::Division.find_all_by_year(1999)
+
+Request models for a division (same as ChromeData::Model.find_all_by_year_and_division_id)
+
+	mazda = ChromeData::Division.new(id: 26, name: "Mazda")
+	mazda_models = mazda.models_for_year(1999)
+	
+#### Models
+Fields:
+
+* id (Integer)
+* name (String)
+
+Find models for year and division
+
+	mazda_models = ChromeData::Model.find_all_by_year_and_division_id(1999, 26)
+	
+Find styles for a specific model (same as ChromeData::Style.find_all_by_model_id)
+	
+	miata = ChromeData::Model.new(id: 4768, name: "MX-5 Miata") # 1999 Mazda MX-5 Miata
+	miata_styles = miata.styles
+
+#### Styles
+Fields:
+
+* id (Integer)
+* name (String)
+
+Only loaded through a Vehicle:
+
+* trim (String)
+* name_without_trim (String)
+
+Find styles for a model by model id
+
+    miata_styles = ChromeData::Style.find_all_by_model_id(4768)
+    
+#### Vehicle
+Fields:
+
+* division (String)
+* engines (Array of Engine)
+* model (String)
+* model_year (Integer)
+* styles (Array of Style)
+
+Find a vehicle by VIN
+
+    vehicle = ChromeData::Vehicle.find_by_vin('JM1NB3536X0131402')
+
+#### Engine
+Engines are only loaded through a find_by_vin request
+
+Fields:
+
+* type (String)
+    
+#### Model Years
+Years start at 1981 due to VIN standardization
+
+    ChromeData::ModelYears.all
+
+## 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 "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end

data/chrome_data.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chrome_data/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chrome_data"
+  spec.version       = ChromeData::VERSION
+  spec.authors       = ["Jim Ryan"]
+  spec.email         = ["jim@room118solutions.com"]
+  spec.description   = %q{Provides a ruby interface for Chrome Data's API. Read more about it here: http://www.chromedata.com/}
+  spec.summary       = %q{A ruby interface for Chrome Data's API}
+  spec.homepage      = "http://github.com/room118solutions/chrome_data"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock", '~> 1.10.0' # Locked at 1.10.x to prevent VCR warnings
+  spec.add_development_dependency "mocha"
+
+  spec.add_dependency "symboltable"
+  spec.add_dependency "activesupport", '>= 3.0'
+  spec.add_dependency "lolsoap", "~> 0.2.0"
+end

data/lib/chrome_data/base_request.rb

@@ -0,0 +1,88 @@
+require "net/http"
+require "lolsoap"
+
+module ChromeData
+  class BaseRequest
+    def initialize(attrs={})
+      attrs.each do |k, v|
+        send "#{k}=", v
+      end
+    end
+
+    class << self
+      # Builds request, sets additional data on request element, makes request,
+      # and returns array of child elements wrapped in instances of this class
+      def request(data)
+        request = build_request
+
+        request.body do |b|
+          # Set configured account info on builder
+          b.accountInfo(
+            number: ChromeData.config.account_number,
+            secret: ChromeData.config.account_secret,
+            country: ChromeData.config.country,
+            language: ChromeData.config.language
+          )
+
+          # Set additional elements on builder
+          data.each do |k, v|
+            # Add the key/value pair as an attribute to the request element if that's what it should be,
+            # otherwise add it as a sub-element
+            # NOTE: This basically mirrors LolSoap::Builder#method_missing
+            #       because Builder undefines most methods, including #send
+            if b.__type__.has_attribute?(k)
+              b.__attribute__ k, v
+            else
+              b.__tag__ k, v
+            end
+          end
+        end
+
+        # Make the request
+        response = make_request(request)
+
+        parse_response(response)
+      end
+
+      # Makes request, returns LolSoap::Response
+      def make_request(request)
+        raw_response = Net::HTTP.start(endpoint_uri.host, endpoint_uri.port) do |http|
+          http.request_post(endpoint_uri.path, request.content, request.headers)
+        end
+
+        client.response(request, raw_response.body)
+      end
+
+      # Builds request, returns LolSoap::Request
+      def build_request
+        client.request request_name
+      end
+
+      def client
+        @@client ||= LolSoap::Client.new(wsdl_body)
+      end
+
+      def wsdl_body
+        @@wsdl_body ||= Net::HTTP.get_response(URI('http://services.chromedata.com/Description/7a?wsdl')).body
+      end
+
+      def endpoint_uri
+        @@endpoint_uri ||= URI(client.wsdl.endpoint)
+      end
+
+      # Given an element_name and LolSoap::Response, returns an array of Nokogiri::XML::Elements
+      def find_elements(element_name, response)
+        response.body.xpath(".//x:#{element_name}", 'x' => response.body.namespace.href)
+      end
+
+      # Internal: Given a LolSoap::Response, returns appropriately parsed response
+      def parse_response(response)
+        raise NotImplementedError, '.parse_response should be implemented in subclass'
+      end
+
+      def request_name
+        raise NotImplementedError, '.request_name should be implemented in subclass'
+      end
+    end
+  end
+end

data/lib/chrome_data/caching.rb

@@ -0,0 +1,31 @@
+module ChromeData::Caching
+  # Creates CacheStore object based on config.cache_store options
+  # reverse merges 'chromedata' namespace to options hash
+  def _cache_store
+    return @@_cache_store if defined? @@_cache_store
+
+    if ChromeData.config.cache_store
+      cache_opts = { namespace: 'chromedata' }
+
+      if ChromeData.config.cache_store.is_a?(Array)
+        if ChromeData.config.cache_store.last.is_a?(Hash)
+          ChromeData.config.cache_store.last.reverse_merge! cache_opts
+        else
+          ChromeData.config.cache_store << cache_opts
+        end
+      elsif ChromeData.config.cache_store.is_a?(Symbol)
+        ChromeData.config.cache_store = [ChromeData.config.cache_store, cache_opts]
+      end
+
+      @@_cache_store = ActiveSupport::Cache.lookup_store(ChromeData.config.cache_store)
+    end
+  end
+
+  def cache(key, &blk)
+    if ChromeData._cache_store
+      ChromeData._cache_store.fetch key, &blk
+    else
+      blk.call
+    end
+  end
+end

data/lib/chrome_data/collection_request.rb

@@ -0,0 +1,19 @@
+module ChromeData
+  class CollectionRequest < BaseRequest
+    attr_accessor :id, :name
+
+    class << self
+      def request_name
+        # Cheap-o inflector
+        "get#{name.split('::').last}s"
+      end
+
+      # Find elements matching class name and instantiate them using their id attribute and text
+      def parse_response(response)
+        find_elements(name.split('::').last.downcase, response).map do |e|
+          new id: e.attr('id').to_i, name: e.text
+        end
+      end
+    end
+  end
+end

data/lib/chrome_data/division.rb

@@ -0,0 +1,14 @@
+module ChromeData
+  class Division < CollectionRequest
+
+    def models_for_year(year)
+      Model.find_all_by_year_and_division_id year, id
+    end
+
+    def self.find_all_by_year(year)
+      ChromeData.cache "#{request_name.underscore}-model_year-#{year}" do
+        request 'modelYear' => year
+      end
+    end
+  end
+end

data/lib/chrome_data/model.rb

@@ -0,0 +1,13 @@
+module ChromeData
+  class Model < CollectionRequest
+    def styles
+      Style.find_all_by_model_id id
+    end
+
+    def self.find_all_by_year_and_division_id(year, division_id)
+      ChromeData.cache "#{request_name.underscore}-model_year-#{year}-division_id-#{division_id}" do
+        request 'modelYear' => year, 'divisionId' => division_id
+      end
+    end
+  end
+end

data/lib/chrome_data/model_year.rb

@@ -0,0 +1,16 @@
+# NOTE: Chrome Data's API offers a getModelYears method that returns every year from 1981 through to next year.
+#       We could hit the API for that data, but I think that's silly, so this class calculates the years
+#       that Chrome Data would return.
+
+module ChromeData
+  class ModelYear
+
+    # Chrome Data returns years in the opposite order, but that's not typically
+    # how selects are built, so they're reversed here,
+    # since that's the only purpose that I can see for this method.
+    def self.all
+      (Time.now.year + 1).downto(1981).to_a
+    end
+
+  end
+end

data/lib/chrome_data/style.rb

@@ -0,0 +1,15 @@
+module ChromeData
+  class Style < CollectionRequest
+    class BodyType < Struct.new(:id, :name); end
+
+    # These are only populated when accessing a style through a Vehicle
+    attr_accessor :trim, :name_without_trim, :body_types
+
+    def self.find_all_by_model_id(model_id)
+      ChromeData.cache "#{request_name.underscore}-model_id-#{model_id}" do
+        request 'modelId' => model_id
+      end
+    end
+
+  end
+end

data/lib/chrome_data/vehicle.rb

@@ -0,0 +1,43 @@
+module ChromeData
+  class Vehicle < BaseRequest
+    class Engine < Struct.new(:type); end
+
+    attr_accessor :model_year, :division, :model, :styles, :engines
+
+    class << self
+      def request_name
+        "describeVehicle"
+      end
+
+      def find_by_vin(vin)
+        request 'vin' => vin
+      end
+
+      def parse_response(response)
+        if vin_description = find_elements('vinDescription', response).first
+          new.tap do |v|
+            v.model_year = vin_description.attr('modelYear').to_i
+            v.division = vin_description.attr('division')
+            v.model = vin_description.attr('modelName')
+
+            v.styles = find_elements('style', response).map do |e|
+              Style.new(
+                id: e.attr('id').to_i,
+                name: e.attr('name'),
+                trim: e.attr('trim'),
+                name_without_trim: e.attr('nameWoTrim'),
+                body_types: e.xpath("x:bodyType", 'x' => response.body.namespace.href).map do |bt|
+                  Style::BodyType.new(bt.attr('id').to_i, bt.text)
+                end
+              )
+            end
+
+            v.engines = find_elements('engine', response).map do |e|
+              Engine.new(e.at_xpath("x:engineType", 'x' => response.body.namespace.href).text)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chrome_data/version.rb

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

data/lib/chrome_data.rb

@@ -0,0 +1,32 @@
+require "chrome_data/version"
+require "chrome_data/caching"
+require "chrome_data/base_request"
+require "chrome_data/collection_request"
+require "chrome_data/division"
+require "chrome_data/model"
+require "chrome_data/style"
+require "chrome_data/model_year"
+require "chrome_data/vehicle"
+require "active_support/cache"
+require "active_support/core_ext/hash"
+
+require "symboltable"
+
+module ChromeData
+  extend Caching
+  extend self
+
+  def configure
+    yield config
+  end
+
+  # Valid options:
+  #   account_number
+  #   account_secret
+  #   country (default: 'US')
+  #   language (default: 'en')
+  #   cache_store
+  def config
+    @@config ||= SymbolTable.new country: 'US', language: 'en'
+  end
+end

data/test/chrome_data/caching_test.rb

@@ -0,0 +1,74 @@
+require_relative '../minitest_helper'
+
+describe ChromeData::Caching do
+  before do
+    ChromeData.remove_class_variable :@@config if ChromeData.class_variable_defined? :@@config
+    ChromeData::Caching.remove_class_variable :@@_cache_store  if ChromeData::Caching.class_variable_defined? :@@_cache_store
+  end
+
+  describe '.cache' do
+    it 'caches request when caching is on' do
+      ChromeData.config.cache_store = :memory_store
+
+      foo = stub('foo')
+      foo.expects(:bar).once.returns 'bar'
+
+      2.times do
+        ChromeData.cache 'foo' do
+          foo.bar
+        end.must_equal 'bar'
+      end
+    end
+
+    it 'does not cache request when caching is off' do
+      foo = stub('foo')
+      foo.expects(:bar).twice.returns 'bar'
+
+      2.times do
+        ChromeData.cache 'foo' do
+          foo.bar
+        end.must_equal 'bar'
+      end
+    end
+  end
+
+  describe '._cache_store' do
+    before { ChromeData::Caching.remove_class_variable :@@_cache_store  if ChromeData::Caching.class_variable_defined? :@@_cache_store }
+
+    it 'returns nil with no cache_store config' do
+      ChromeData._cache_store.must_equal nil
+    end
+
+    it 'looks up cache with appropriate namespace when cache_store is an array without options hash' do
+      ChromeData.config.cache_store = :file_store, '/path/to/cache'
+
+      ActiveSupport::Cache.expects(:lookup_store).with([:file_store, '/path/to/cache', { namespace: 'chromedata' }])
+
+      ChromeData._cache_store
+    end
+
+    it 'looks up cache with appropriate namespace when cache_store is an array with an options hash' do
+      ChromeData.config.cache_store = :memory_store, { foo: 'bar' }
+
+      ActiveSupport::Cache.expects(:lookup_store).with([:memory_store, { foo: 'bar', namespace: 'chromedata' }])
+
+      ChromeData._cache_store
+    end
+
+    it 'does not replace user-defined namespace' do
+      ChromeData.config.cache_store = :memory_store, { namespace: 'mynamespace' }
+
+      ActiveSupport::Cache.expects(:lookup_store).with([:memory_store, { namespace: 'mynamespace' }])
+
+      ChromeData._cache_store
+    end
+
+    it 'looks up cache with appropriate namespace when cache_store is a symbol' do
+      ChromeData.config.cache_store = :memory_store
+
+      ActiveSupport::Cache.expects(:lookup_store).with([:memory_store, { namespace: 'chromedata' }])
+
+      ChromeData._cache_store
+    end
+  end
+end

data/test/chrome_data/division_test.rb

@@ -0,0 +1,57 @@
+require_relative '../minitest_helper'
+
+describe ChromeData::Division do
+  it 'returns a proper request name' do
+    ChromeData::Division.request_name.must_equal 'getDivisions'
+  end
+
+  describe '.find_all_by_year' do
+    before do
+      ChromeData.configure do |c|
+        c.account_number = '123456'
+        c.account_secret = '1111111111111111'
+      end
+    end
+
+    def find_divisions
+      VCR.use_cassette('wsdl') do
+        VCR.use_cassette('2013/divisions') do
+          @divisions = ChromeData::Division.find_all_by_year(2013)
+        end
+      end
+    end
+
+    it 'returns array of Division objects' do
+      find_divisions
+
+      @divisions.first.must_be_instance_of ChromeData::Division
+      @divisions.size.must_equal 38
+    end
+
+    it 'sets ID on Division objects' do
+      find_divisions
+
+      @divisions.first.id.must_equal 1
+    end
+
+    it 'sets name on Division objects' do
+      find_divisions
+
+      @divisions.first.name.must_equal 'Acura'
+    end
+
+    it 'caches with proper key' do
+      ChromeData.expects(:cache).with('get_divisions-model_year-2013')
+
+      find_divisions
+    end
+  end
+
+  describe '#models_for_year' do
+    it 'finds models for given year and Division ID' do
+      ChromeData::Model.expects(:find_all_by_year_and_division_id).with(2013, 13)
+
+      ChromeData::Division.new(id: 13, name: 'Ford').models_for_year 2013
+    end
+  end
+end

data/test/chrome_data/model_test.rb

@@ -0,0 +1,57 @@
+require_relative '../minitest_helper'
+
+describe ChromeData::Model do
+  it 'returns a proper request name' do
+    ChromeData::Model.request_name.must_equal 'getModels'
+  end
+
+  describe '.find_all_by_year_and_division_id' do
+    before do
+      ChromeData.configure do |c|
+        c.account_number = '123456'
+        c.account_secret = '1111111111111111'
+      end
+    end
+
+    def find_models
+      VCR.use_cassette('wsdl') do
+        VCR.use_cassette('2013/divisions/13/models') do
+          @models = ChromeData::Model.find_all_by_year_and_division_id(2013, 13) # 2013 Fords
+        end
+      end
+    end
+
+    it 'returns array of Model objects' do
+      find_models
+
+      @models.first.must_be_instance_of ChromeData::Model
+      @models.size.must_equal 39
+    end
+
+    it 'sets ID on Model objects' do
+      find_models
+
+      @models.first.id.must_equal 25459
+    end
+
+    it 'sets name on Model objects' do
+      find_models
+
+      @models.first.name.must_equal 'C-Max Energi'
+    end
+
+    it 'caches with proper key' do
+      ChromeData.expects(:cache).with('get_models-model_year-2013-division_id-13')
+
+      find_models
+    end
+  end
+
+  describe '#styles' do
+    it 'finds styles for Model' do
+      ChromeData::Style.expects(:find_all_by_model_id).with(24997)
+
+      ChromeData::Model.new(id: 24997, name: 'Mustang').styles
+    end
+  end
+end