nhtsa_vin 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 987b6fadc99bac8045a8288ca6effb187501f19d
-  data.tar.gz: bcdb074f6bf27055805bd9a6821446c3fed38ec6
+  metadata.gz: 81eb7bb2954ef3ebc22afde17e6f70b508020acc
+  data.tar.gz: 6cea7414b6edc216d91ba274bced8d058bd05d59
 SHA512:
-  metadata.gz: 28447017cd5ea2d27cf6cc684085fe2720744cc64a0f37587916574fd138c018e80c0313a694921524a53c0117163a53fd170aa86e8a73533ee5bbc11c6e2ff9
-  data.tar.gz: c82a876e940ca2aea5ae07d0f533614129b644cc7f824c571f89b543779edfac53e734729ba46274b8b4656c3b0f3a331da7398fc137ed592adcacbea938ea33
+  metadata.gz: 703a0437f83f5d03eb8ffc6bbedaf3dd422b77d3327646bca2b0ae0c262e2269dc88d702be9901bbb8b7227a230730f077c9241d0017567576ba77db18e26d56
+  data.tar.gz: f7244387c404bb224cf90585df93141537f7a3dc72e99f8cf543eb57d82b2469fb49f2ed3c47ca8314558e42878122fa78857067d11162a7a03c08d31f5cf1a4

data/.circleci/config.yml

@@ -0,0 +1,49 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    environment:
+      CC_TEST_REPORTER_ID: 2ae3d7a510acfedce89d23528ad0b3e6cfa0a7aec07bd2b978c3b8e996ee0d35
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install
+
+      - run:
+          name: Setup Code Climate test-reporter
+          command: |
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+            chmod +x ./cc-test-reporter
+            
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            ./cc-test-reporter before-build
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+            rspec spec --format progress \
+                       --format RspecJunitFormatter \
+                       --out /tmp/test-results/rspec.xml \
+                       --format progress \
+                       $TEST_FILES
+            ./cc-test-reporter after-build --coverage-input-type simplecov --prefix coverage --exit-code $?          
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/Gemfile

@@ -1,3 +1,9 @@
 source 'https://rubygems.org'
 
+group :test, :development do
+  gem 'rspec_junit_formatter'
+  gem 'codeclimate-test-reporter', require: false
+  gem 'simplecov-json', require: false
+end
+
 gemspec

data/README.md

@@ -1,6 +1,9 @@
 # NHTSA Vin
 
 [![Gem Version](https://badge.fury.io/rb/nhtsa_vin.svg)](https://badge.fury.io/rb/nhtsa_vin)
+[![CircleCI](https://circleci.com/gh/deliv/nhtsa_vin.svg?style=svg)](https://circleci.com/gh/deliv/nhtsa_vin)
+[![Maintainability](https://api.codeclimate.com/v1/badges/5096bcc9d52e5253c532/maintainability)](https://codeclimate.com/github/deliv/nhtsa_vin/maintainability)
+
 
 A ruby gem for fetching and parsing vehicle identification via the vehicle identification number (VIN) from the [NHTSA webservice](https://vpic.nhtsa.dot.gov/api/Home). Note, this gem is not officially affiliated with the NHTSA.
 
@@ -24,20 +27,33 @@ Or install it yourself as:
 
 ## Usage
 
-Usage is fairly simple. Provide a VIN, and the gem will return a struct of vehicle data. 
+Usage is fairly simple, there's an exposed `get` class method that you can pass in a VIN string to, and it will return you a NhtsaVin::Query.  
 
 ```ruby
-query = NhtsaVin.get('1J4BA5H11AL143811')
+query = NhtsaVin.get('1J4BA5H11AL143811') # => <NhtsaVin::Query>
 query.valid? # => true
+```
+
+The actual data from the webservice is contained in the `response` method. This returns a struct containing the various interesting bits from the API.
+
+```ruby
 query.response # => <Struct::NhtsaResponse make="Jeep", model="Grand Cherokee", trim="Laredo/Rocky Mountain Edition", type="SUV", year="2008", size=nil, ... doors=4>
 ```
 
-In the result no match is found, the result will be `nil`, and `#valid?` will return `false`. 
+They query object also contains helper methods for error handling. For example, in the result no match is found, the result will be `nil`, and `#valid?` will return `false`. 
+
+```ruby
+query = NhtsaVin.get('SOME_BAD_VIN') # => <NhtsaVin::Query>
+query.valid? # => false
+query.error_code # => 11
+query.error # => "11- Incorrect Model Year, decoded data may not be accurate"
+```
+
 
 Vehicle Types
 ----
 
-For brievity, we're reducing the `Vehicle Type` response to an enumerated set of `["Car", "Truck", "Van", "SUV", "Minivan"]`. We're doing a rough parse of the type and body style to achieve this. It's probably not perfect. 
+For brevity, we're reducing the `Vehicle Type` response to an enumerated set of `["Car", "Truck", "Van", "SUV", "Minivan"]`. We're doing a rough parse of the type and body style to achieve this. It's probably not perfect. 
 
 
 ## License

data/lib/nhtsa_vin/query.rb

@@ -15,6 +15,7 @@ module NhtsaVin
 
     def get
       @raw_response = fetch
+      return if @raw_response.nil?
       parse(JSON.parse(@raw_response))
     end
 
@@ -90,7 +91,15 @@ module NhtsaVin
       end
 
       def fetch
-        Net::HTTP.get(URI.parse(@url))
+        begin
+          Net::HTTP.get(URI.parse(@url))
+        rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, SocketError,
+               Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
+               Net::ProtocolError, Errno::ECONNREFUSED => e
+          @valid = false
+          @error = e.message
+          nil
+        end
       end
 
   end

data/lib/nhtsa_vin/version.rb

@@ -1,3 +1,3 @@
 module NhtsaVin
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'.freeze
 end

data/nhtsa_vin.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 2.3.0'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'bundler'
-  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec'  
 end

data/spec/lib/nhtsa_vin/query_spec.rb

@@ -66,5 +66,46 @@ describe NhtsaVin::Query do
         expect(client.error_code).to eq 11
       end
     end
+    context 'connection or network error' do
+      before do
+        allow(Net::HTTP).to receive(:get_response).and_raise(Net::ReadTimeout)
+        client.get
+      end
+      it 'should not raise' do
+        expect { client.get }.to_not raise_error
+      end
+      it 'should return nil' do
+        expect(client.get).to be_nil
+      end
+      it 'should not be valid' do
+        expect(client.valid?).to be false
+      end
+      it 'should have an error message' do
+        expect(client.error).to eq 'Net::ReadTimeout'
+      end
+      it 'should not contain a response object' do
+        expect(client.response).to be_nil
+      end
+    end
+  end
+
+  describe '#vehicle_type' do
+    let(:query) { NhtsaVin::Query.new('') }
+    context 'with type of TRUCK' do
+      it 'returns van when the type is truck and body_class includes Van' do
+        expect(query.vehicle_type('Cargo Van', 'TRUCK')).to eq 'Van'
+      end
+      it 'returns truck otherwise' do
+        expect(query.vehicle_type('Light Duty Pickup', 'TRUCK')).to eq 'Truck'
+      end
+    end
+    context 'with type MULTIPURPOSE PASSENGER VEHICLE (MPV)' do
+      it 'returns SUV when the body class supports it' do
+        expect(
+          query.vehicle_type('Sport Utility Vehicle (SUV)',
+                             'MULTIPURPOSE PASSENGER VEHICLE (MPV)')
+          ).to eq 'SUV'
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1 +1,9 @@
-require 'nhtsa_vin'
+require 'simplecov'
+require 'simplecov-json'
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::JSONFormatter,
+]
+
+SimpleCov.start
+require 'nhtsa_vin'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nhtsa_vin
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Barclay Loftus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-02 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -61,6 +61,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md