vin_query 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64d3c8bae2cabbbfdab43496ded9b926c8fdd66d
-  data.tar.gz: 01c4cfaab126e3059daa3535623573cfe9460f17
+  metadata.gz: e009eb9349dbfd08405cb85579c97ecd30bc0e07
+  data.tar.gz: 2ac76344b14f533acfa5bf73762580d8e8a056cf
 SHA512:
-  metadata.gz: 077cf12d76ba87dc062d4e48d1354f132de7d5cd6289848ca71c6e4b22ff2ca389af0ca953e9b9d36e68dfb3d571f46bd785a2adfaf48e15b3eda00a2b438985
-  data.tar.gz: 7c7cd37b3b7cb3253dc677c9af0243faad5825b188a7753a0002bf9b8e32f6ed452504eebddebee724bb4d9a31664d1a2b9c51c1140a58091f03534dfc0ba6f5
+  metadata.gz: 19a2ab043fce4cd50b2239d2892297c00d3cb18986d82da20cbf3d05c42aaec258d6a3f2f61c3cb3b4fe9a7c937cbca719e9a4c963c2b89232b7873cafd8b9cd
+  data.tar.gz: 83761294c6cd620c739a6262eaf7769feb10ed2aaafacb9cb7551e79b0c34fb27420dce2e1c47b7766ab4b005cb30e631dd2fed8786220ba718cb0e226cdb5ba

data/.travis.yml

@@ -1,11 +1,6 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 1.9.3
-  - 1.9.2
-  - jruby-18mode
-  - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
-  - 1.8.7
-  - ree
+  - 2.0.0-p648
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v1.1.0 (2016-12-12)
+
+- Add configuration block pattern
+- Dropped testing support for rbx, jruby and MRI 1.9
+
 ## v1.0.2 (2013-03-15)
 
 - Tested against Ruby 2.0

data/Gemfile

@@ -1,5 +1,2 @@
 source 'https://rubygems.org'
-
 gemspec
-
-gem 'rake'

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Jonathan Underwood
+Copyright (c) 2014 Jonathan Underwood
 
 MIT License
 

data/README.md

@@ -26,17 +26,35 @@ Or install it yourself as:
 
 Pass in the URL and access code provided by vinquery.com as well as the report type you want (defaults to report type '2' -- the extended report type).
 
-Note, A VinQuery::Query class has an array of trim levels. This is due to the VinQuery service returning a array of possible trim levels for certain makes/models.
+Note, A `VinQuery::Query` class has an array of trim levels. This is due to the VinQuery service returning a array of possible trim levels for certain makes/models.
 
 ```ruby
-query = VinQuery.get('1C3CC4FB8AN236750', {
-                     :url => 'vinquery-url-here',
-                     :access_code => 'access-code-here',
-                     :report_type => 'report-type-here' })
+query = VinQuery.get('1C3CC4FB8AN236750',
+                     url: 'vinquery-url-here',
+                     access_code: 'access-code-here',
+                     report_type: 'report-type-here')
 
-query.valid?                           # => true
+query.valid? # => true
+```
+
+### Configuration
+
+It also accepts a configuration block to streamline gets.
+
+```ruby
+VinQuery.configure do |config|
+  config.url = 'vinquery-url-here'
+  config.access_code = 'access-code-here'
+  config.report_type = 2
+end
+
+query = VinQuery.get('1C3CC4FB8AN236750')
+query.valid? # => true
+```
 
-# Note, trim_levels will always be an array. Empty, or otherwise.
+_Note, `trim_levels` will always be an array. Empty, or otherwise._
+
+```
 vehicle = query.trim_levels.first
 
 vehicle.attributes[:make]              # => Chrysler

data/lib/vin_query.rb

@@ -1,6 +1,6 @@
-# -*- encoding: utf-8 -*-
 require 'vin_query/version'
 
+require 'vin_query/configuration'
 require 'vin_query/exceptions'
 require 'vin_query/trim_level'
 require 'vin_query/query'

data/lib/vin_query/configuration.rb

@@ -0,0 +1,28 @@
+module VinQuery
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.reset
+    self.configuration = Configuration.new
+  end
+
+  class Configuration
+    attr_accessor :url, :access_code, :report_type
+
+    def initialize
+      @report_type = 2
+    end
+
+    def merge_options(options={})
+      options.each do |k, v|
+        self.send("#{k}=", v)
+      end
+    end
+  end
+end

data/lib/vin_query/exceptions.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 module VinQuery
   class Error < StandardError
   end

data/lib/vin_query/query.rb

@@ -1,18 +1,15 @@
-# -*- encoding: utf-8 -*-
 require 'net/http'
 require 'nokogiri'
 
 module VinQuery
   class Query
-    attr_reader :url, :trim_levels
+    attr_reader :vin, :url, :trim_levels
 
     def initialize(vin, options={})
-      url = options[:url]
-      access_code = options[:access_code]
-      report_type = 2 || options[:report_type]
-
+      VinQuery.configuration.merge_options(options)
+      @vin = vin
       @trim_levels = []
-      @url = "#{url}?accessCode=#{access_code}&vin=#{vin}&reportType=#{report_type}"
+      build_url
     end
 
     def valid?
@@ -20,15 +17,11 @@ module VinQuery
     end
 
     def validate(xml)
-      doc = Nokogiri::XML xml
-
-      if doc.xpath('//VINquery/VIN').size == 0
-        raise ValidationError
-      end
+      doc = Nokogiri::XML(xml)
+      raise ValidationError if doc.xpath('//VINquery/VIN').size == 0
 
-      vin = doc.xpath('//VINquery/VIN').first
-
-      if vin.attributes['Status'].to_s == 'SUCCESS'
+      results_vin = doc.xpath('//VINquery/VIN').first
+      if results_vin.attributes['Status'].to_s == 'SUCCESS'
         @valid = true
       else
         @valid = false
@@ -36,13 +29,10 @@ module VinQuery
     end
 
     def parse(xml)
-      doc = Nokogiri::XML xml
-      vin = doc.xpath('//VINquery/VIN').first
-
-      if doc.xpath('//VINquery/VIN/Vehicle').size == 0
-        raise ParseError
-      end
+      doc = Nokogiri::XML(xml)
+      raise ParseError if doc.xpath('//VINquery/VIN/Vehicle').size == 0
 
+      results_vin = doc.xpath('//VINquery/VIN').first
       doc.xpath('//VINquery/VIN/Vehicle').each do |v|
         vehicle = {}
 
@@ -62,20 +52,25 @@ module VinQuery
           end
         end
 
-        @trim_levels.push(VinQuery::TrimLevel.new(vin.attributes['Number'].to_s, vehicle))
+        @trim_levels.push(VinQuery::TrimLevel.new(results_vin.attributes['Number'].to_s, vehicle))
       end
     end
 
     def get
-      xml = fetch @url
-
-      if validate xml
-        parse xml
-      end
+      xml = fetch(@url)
+      parse(xml) if validate(xml)
     end
 
     private
 
+      def build_url
+        url = VinQuery.configuration.url
+        access_code = VinQuery.configuration.access_code
+        report_type = VinQuery.configuration.report_type
+
+        @url = "#{url}?accessCode=#{access_code}&vin=#{vin}&reportType=#{report_type}"
+      end
+
       def fetch(url)
         Net::HTTP.get(URI.parse(url))
       end

data/lib/vin_query/trim_level.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 module VinQuery
   class TrimLevel
     attr_reader :attributes, :trim_level, :vin

data/lib/vin_query/version.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 module VinQuery
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

data/spec/lib/vin_query/configuration_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe VinQuery::Configuration do
+  before do
+    VinQuery.configure do |config|
+      config.url = 'http://www.vinquery.com/asdf/asdf.aspx'
+      config.access_code = 'asdf1234-asdf1234-asdf1234'
+    end
+  end
+
+  it 'respects set values in a config block' do
+    expect(VinQuery.configuration.url).to eq 'http://www.vinquery.com/asdf/asdf.aspx'
+    expect(VinQuery.configuration.access_code).to eq 'asdf1234-asdf1234-asdf1234'
+  end
+
+  it 'has a default report type' do
+    expect(VinQuery.configuration.report_type).to eq 2
+  end
+
+  context 'when manually given options' do
+    it 'overrides default configuration settings' do
+      VinQuery.configuration.merge_options(report_type: 3)
+      expect(VinQuery.configuration.report_type).to eq 3
+    end
+
+    it 'overrides previously set configuration settings' do
+      VinQuery.configuration.merge_options(access_code: '1234')
+      expect(VinQuery.configuration.access_code).to eq '1234'
+    end
+  end
+
+  after { VinQuery.reset }
+end

data/spec/lib/vin_query/query_spec.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require 'spec_helper'
 
 describe VinQuery::Query do
@@ -39,7 +38,7 @@ describe VinQuery::Query do
 
   describe '#parse' do
     context 'when a single trim level is returned' do
-      before(:each) { client.parse xml_single }
+      before { client.parse xml_single }
 
       it 'populates an array of trim levels with 1 trim level' do
         expect(client.trim_levels.size).to be 1
@@ -63,7 +62,7 @@ describe VinQuery::Query do
     end
 
     context 'when multiple trim levels are returned' do
-      before(:each) { client.parse xml_multi }
+      before { client.parse xml_multi }
 
       it 'populates an array of trim levels with the number of trim levels' do
         expect(client.trim_levels.size).to be 4
@@ -95,8 +94,8 @@ describe VinQuery::Query do
 
   describe '#get' do
     context 'success response' do
-      before(:each) do
-        client.stub(:fetch).and_return xml_multi
+      before do
+        allow(client).to receive(:fetch).and_return(xml_multi)
         client.get
       end
 
@@ -110,8 +109,8 @@ describe VinQuery::Query do
     end
 
     context 'error response' do
-      before(:each) do
-        client.stub(:fetch).and_return xml_error
+      before do
+        allow(client).to receive(:fetch).and_return(xml_error)
         client.get
       end
 
@@ -125,7 +124,7 @@ describe VinQuery::Query do
     end
 
     context '404 response' do
-      before(:each) { client.stub(:fetch).and_return '<html>404</html>' }
+      before { allow(client).to receive(:fetch).and_return('<html>404</html>') }
 
       it 'fetches xml and response cannot be validated' do
         expect{ client.get }.to raise_error VinQuery::ValidationError

data/spec/lib/vin_query/trim_level_spec.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require 'spec_helper'
 
 describe VinQuery::TrimLevel do

data/spec/spec_helper.rb

@@ -1,2 +1 @@
-# -*- encoding: utf-8 -*-
 require 'vin_query'

data/vin_query.gemspec

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require File.expand_path('../lib/vin_query/version', __FILE__)
 
 Gem::Specification.new do |gem|
@@ -18,7 +17,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'nokogiri', '~> 1.5.6'
+  gem.add_dependency 'nokogiri', '> 1.5'
 
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'bundler'
   gem.add_development_dependency 'rspec'
 end

metadata

@@ -1,41 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: vin_query
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonathan Underwood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-15 00:00:00.000000000 Z
+date: 2016-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A ruby library for fetching and parsing VIN information from vinquery.com,
@@ -46,15 +74,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/vin_query.rb
+- lib/vin_query/configuration.rb
 - lib/vin_query/exceptions.rb
 - lib/vin_query/query.rb
 - lib/vin_query/trim_level.rb
@@ -62,6 +91,7 @@ files:
 - spec/fixtures/error.xml
 - spec/fixtures/success_multi.xml
 - spec/fixtures/success_single.xml
+- spec/lib/vin_query/configuration_spec.rb
 - spec/lib/vin_query/query_spec.rb
 - spec/lib/vin_query/trim_level_spec.rb
 - spec/spec_helper.rb
@@ -75,17 +105,17 @@ 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.0.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A ruby library for accessing vinquery.com
@@ -93,6 +123,7 @@ test_files:
 - spec/fixtures/error.xml
 - spec/fixtures/success_multi.xml
 - spec/fixtures/success_single.xml
+- spec/lib/vin_query/configuration_spec.rb
 - spec/lib/vin_query/query_spec.rb
 - spec/lib/vin_query/trim_level_spec.rb
 - spec/spec_helper.rb