vindata 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5caaa6383d01ad194da2c36aaefbf6b46b04baa2
+  data.tar.gz: 25715bbbc39875b5ffb01e4cc0fd3c8277d5798b
+SHA512:
+  metadata.gz: 17c2cbc787a1f06dfdca2a7cce43b01bb53ebd7415ff1aeb713945fb71d529c26c0dfcb72fa71225b649ac91397968639a1cd0d0d514d11a66f93f9e715f3f7f
+  data.tar.gz: f2916cb3732ebac11d3e52b2efbbb63708e1d4b7d57ea7f92f3a8803e66b8be62c40cfc4efa23925a8c67399d82b69be2eb00795b5f76f8e59103b4aa78d240c

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env*
+.gs
+*.gem

data/Gemfile

@@ -0,0 +1 @@
+gem 'rest-client', '>= 1.7.2'

data/README.md

@@ -0,0 +1,2 @@
+vindata
+=======

data/lib/vindata.rb

@@ -0,0 +1,18 @@
+# External gems
+require 'rest_client'
+
+# Internal files
+require 'vindata/configuration'
+require 'vindata/services'
+
+module VinData
+  def self.details_by_vin vin
+    service = Services.get config[:service]
+    service.details_by_vin vin
+  end
+
+  def self.get_acv data
+    service = Services.get config[:service]
+    service.get_acv data
+  end
+end

data/lib/vindata/configuration.rb

@@ -0,0 +1,74 @@
+module VinData
+  def self.configure(options = nil, &block)
+    if !options.nil?
+      Configuration.instance.configure(options)
+    end
+  end
+
+  def self.config
+    Configuration.instance.data
+  end
+
+  class Configuration
+    include Singleton
+
+    OPTIONS = [
+      :service,
+      :api_key
+    ]
+
+    attr_accessor :data
+
+    def self.set_defaults
+      instance.set_defaults
+    end
+
+    OPTIONS.each do |o|
+      define_method o do
+        @data[o]
+      end
+      define_method "#{o}=" do |value|
+        @data[o] = value
+      end
+    end
+
+    def configure(options)
+      @data.rmerge!(options)
+    end
+
+    def initialize # :nodoc
+      @data = VinData::ConfigurationHash.new
+      set_defaults
+    end
+
+    def set_defaults
+
+      # geocoding options
+      @data[:service]      = :edmunds    # Default service to look up vins with
+      @data[:api_key]      = nil         # API key for geocoding service
+
+    end
+
+    instance_eval(OPTIONS.map do |option|
+      o = option.to_s
+      <<-EOS
+      def #{o}
+        instance.data[:#{o}]
+      end
+
+      def #{o}=(value)
+        instance.data[:#{o}] = value
+      end
+      EOS
+    end.join("\n\n"))
+
+  end
+
+  class ConfigurationHash < Hash
+    include HashRecursiveMerge
+
+    def method_missing(meth, *args, &block)
+      has_key?(meth) ? self[meth] : super
+    end
+  end
+end

data/lib/vindata/services.rb

@@ -0,0 +1,48 @@
+module VinData
+  module Services
+    extend self
+
+    # Supported service list
+    def service_list
+      [
+        :edmunds
+      ]
+    end
+
+    def get(name)
+      @services = {} unless defined?(@services)
+      @services[name] = spawn(name) unless @services.include?(name)
+      @services[name]
+    end
+
+    def configuration
+      VinData.config
+    end
+
+    private # -----------------------------------------------------------------
+
+    ##
+    # Spawn a Lookup of the given name.
+    #
+    def spawn(name)
+      if service_list.include?(name)
+        VinData::Services.const_get(classify_name(name)).new
+      else
+        valids = service_list.map(&:inspect).join(", ")
+        raise ConfigurationError, "Please specify a valid service for VinData " +
+          "(#{name.inspect} is not one of: #{valids})."
+      end
+    end
+
+    ##
+    # Convert an "underscore" version of a name into a "class" version.
+    #
+    def classify_name(filename)
+      filename.to_s.split("_").map{ |i| i[0...1].upcase + i[1..-1] }.join
+    end
+  end
+end
+
+VinData::Services.service_list.each do |name|
+  require "vindata/services/#{name}"
+end

data/lib/vindata/services/base.rb

@@ -0,0 +1,27 @@
+module VinData
+  module Services
+    class Base
+      def initialize
+        @cache = nil
+      end
+
+      # Human readable name of this service
+      def name
+        fail
+      end
+
+      # Base URL of the API to query
+      def base_url(query)
+        fail
+      end
+
+      def details_by_vin vin
+        fail
+      end
+
+      def configuration
+        VinData.config
+      end
+    end
+  end
+end

data/lib/vindata/services/edmunds.rb

@@ -0,0 +1,67 @@
+require 'vindata/services/base'
+
+module VinData::Services
+  class Edmunds < Base
+    def name
+      'Edmunds'
+    end
+
+    def base_url
+      'https://api.edmunds.com/api/vehicle/v2/'
+    end
+
+    def details_by_vin vin
+      # Lookup vehicle make/model/year by VIN
+      vinlookup = base_url + 'vins/'+vin
+      response = JSON.parse(RestClient.get vinlookup, {:params => {
+        fmt: 'json',
+        api_key: configuration[:api_key]
+        }})
+
+      # TODO: Check data validity here
+
+      return {
+        make: response['make']['niceName'],
+        model: response['model']['niceName'],
+        year: response['years'][0]['year']
+      }
+    end
+
+    # Required Data:
+    #   :make
+    #   :model
+    #   :year
+    #   :mileage
+    #   :zip
+    def get_acv data
+      # TODO: Make sure all proper data was passed
+
+      # Get the style ID by vehicle make/model/year
+      stylelookup = base_url + data[:make] + '/' + data[:model] + '/' + data[:year].to_s + '/styles'
+      response = JSON.parse(RestClient.get stylelookup, {:params => {
+        fmt: 'json',
+        api_key: configuration[:api_key]
+        }})
+
+      # TODO: Check data validity here
+
+      acvlookup = 'https://api.edmunds.com/v1/api/tmv/tmvservice/calculateusedtmv'
+      response = JSON.parse(RestClient.get acvlookup, {:params => {
+        styleid: response['styles'][0]['id'],
+        condition: 'Clean',
+        mileage: data[:mileage],
+        zip: data[:zip],
+        fmt: 'json',
+        api_key: configuration[:api_key]
+        }})
+
+      # TODO: Check data validity here
+
+      return {
+        retail: response['tmv']['nationalBasePrice']['usedTmvRetail'],
+        private_party: response['tmv']['nationalBasePrice']['usedPrivateParty'],
+        trade_in: response['tmv']['nationalBasePrice']['usedTradeIn']
+      }
+    end
+  end
+end

data/lib/vindata/version.rb

@@ -0,0 +1,3 @@
+module VinData
+  VERSION = "0.0.1"
+end

data/vindata.gemspec

@@ -0,0 +1,16 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'date'
+require 'vindata/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'vindata'
+  s.version     = VinData::VERSION
+  s.date        = Date.today.to_s
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = %q{Query popular VIN databases to get vehicle information.}
+  s.description = %q{Library which queries vehicle databases such as Edmunds for publicly available vehicle information using VIN number}
+  s.authors     = ["Roupen Mouradian"]
+  s.email       = 'roupen@acdcorp.com'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'https://github.com/orgs/acdcorp/'
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: vindata
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Roupen Mouradian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-26 00:00:00.000000000 Z
+dependencies: []
+description: Library which queries vehicle databases such as Edmunds for publicly
+  available vehicle information using VIN number
+email: roupen@acdcorp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- lib/vindata.rb
+- lib/vindata/configuration.rb
+- lib/vindata/services.rb
+- lib/vindata/services/base.rb
+- lib/vindata/services/edmunds.rb
+- lib/vindata/version.rb
+- vindata.gemspec
+homepage: https://github.com/orgs/acdcorp/
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Query popular VIN databases to get vehicle information.
+test_files: []