carquery 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6defa7e4ce72d8b2a63b5710685969a961fcaf28
+  data.tar.gz: cb457d301d27c4e0e4fec9a841c59ad0f4311faa
+SHA512:
+  metadata.gz: 900e1ef8a3ad500bf31fbddb9b390e406253ca5f5ad871164ef6f9770ce2cea20d1a2233b2305f7cee75367ca0eda0d9c49c86d5daeab86f46e3f3f31de4b222
+  data.tar.gz: cc310a34978a82524fc3d8bc846978fdf94e037d3709152ec703bab0a8ec565ba56cc5cbdaa5cc5dbe3c81fd84d96ff29add3b31c28dd13b9d72fc678539389f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in carquery.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry-debugger'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rustam Sharshenov
+
+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,48 @@
+# Carquery
+
+Provides DSL for a [www.carqueryapi.com](http://www.carqueryapi.com) API. Read more about CarQuery database API [here](http://www.carqueryapi.com/about/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'carquery'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carquery
+
+## Usage
+
+Get car makes
+
+    Carquery.get_makes year: 2009
+
+Get car model list by make
+
+    Carquery.get_models_for 'volvo'
+
+Get car model trim list
+
+    Carquery.get_trims
+
+Get car model trim by id
+
+    Carquery.get_trim 12345
+
+Get range of available years from the CarQuery database
+
+    Carquery.get_years_range
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/carquery.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carquery/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "carquery"
+  spec.version       = Carquery::VERSION
+  spec.authors       = ["Rustam Sharshenov"]
+  spec.email         = ["rustam@sharshenov.com"]
+  spec.description   = %q{www.carqueryapi.com API client}
+  spec.summary       = %q{Provides DSL for a www.carqueryapi.com API.}
+  spec.homepage      = ""
+  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 'httparty'
+  spec.add_dependency 'addressable'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+end

data/lib/carquery.rb

@@ -0,0 +1,15 @@
+require "carquery/errors"
+require "carquery/version"
+require "carquery/request"
+require "carquery/resources/base_struct"
+Dir[File.dirname(__FILE__) + "/carquery/dsl/*.rb"].each { |f| require f  }
+Dir[File.dirname(__FILE__) + "/carquery/resources/*.rb"].each { |f| require f  }
+
+# @TODO remove
+require "pry"
+
+module Carquery
+
+  API_URL="http://www.carqueryapi.com/api/0.3"
+
+end

data/lib/carquery/dsl/get_makes.rb

@@ -0,0 +1,14 @@
+module Carquery
+
+  # Returns auto makes
+  # Optional params:
+  #   @year       [optional] - all makes which produced a model in the specified year
+  #   @sold_in_us [optional] - setting it to “1″ will restrict results to models sold in the USA.
+  # Usage:
+  #   Carquery.get_makes year: 2009 => [#<struct Carquery::Make code="abarth", title="Abarth", is_common=false, country="Italy">, ...]
+  def self.get_makes params={}
+    response = request 'getMakes', params
+    response['Makes'].map {|make| Make.build make }
+  end
+
+end

data/lib/carquery/dsl/get_models.rb

@@ -0,0 +1,23 @@
+module Carquery
+
+  class << self
+
+    # Returns car models by the manufacturer
+    # Input: auto make code
+    # Optional params:
+    #   @year       [optional]  - omitting it will retrieve all model names ever produced by the manufacturer.
+    #   @sold_in_us [optional]  - setting it to “1″ will restrict results to models sold in the USA.
+    #   @body       [optional]  - including it will restrict results to models of the specified body type (SUV, Sedan, etc)
+    # Usage:
+    #   Carquery.get_models_for 'volvo', year: 2010 => [#<struct Carquery::CarModel title="120">, ...]
+    def get_models make_code, params={}
+      params.merge! make: make_code
+      response = request 'getModels', params
+      response['Models'].map {|make| CarModel.build make }
+    end
+
+    alias_method :get_models_for, :get_models
+
+  end
+
+end

data/lib/carquery/dsl/get_trim.rb

@@ -0,0 +1,17 @@
+module Carquery
+
+  class << self
+
+    # Returns car model trim by specified id
+    # Input: auto make code
+    # Optional params: none
+    # Usage:
+    #   Carquery.get_trim 12343 => #<struct Carquery::Trim id=12343, title="Tempra", make_code="fiat", trim="1.6", ...>
+    def get_trim id
+      response = request 'getModel', model: id
+      Trim.build response
+    end
+
+  end
+
+end

data/lib/carquery/dsl/get_trims.rb

@@ -0,0 +1,45 @@
+module Carquery
+
+  class << self
+
+    # Returns trim data for models meeting specified criteria.
+    # Optional params:
+    #   @make             - Make code
+    #   @model            - Model Name
+    #   @body             - Coupe, Sedan, SUV, Pickup, Crossover, Minivan, etc.
+    #   @doors            - number of doors
+    #   @drive            - Front, Rear, AWD, 4WD, etc
+    #   @engine_position  - Front, Middle, Rear
+    #   @engine_type      - V, in-line, etc
+    #   @fuel_type        - Gasoline, Diesel, etc
+    #   @full_results     - 1 by default. Set to 0 to include only basic year / make /model / trim data (improves load times)
+    #   @keyword          - Keyword search. Searches year, make, model, and trim values
+    #   @min_cylinders    - Minimum Number of cylinders
+    #   @min_lkm_hwy      - Maximum fuel efficiency (highway, l/100km)
+    #   @min_power        - Minimum engine power (PS)
+    #   @min_top_speed    - Minimum Top Speed (km/h)
+    #   @min_torque       - Minimum Torque (nm)
+    #   @min_weight       - Minimum Weight (kg)
+    #   @min_year         - Earliest Model Year
+    #   @max_cylinders    - Maximum Number of cylinders
+    #   @max_lkm_hwy      - Minimum fuel efficiency (highway, l/100km)
+    #   @max_power        - Minimum engine power (HP)
+    #   @max_top_speed    - Maximum Top Speed (km/h)
+    #   @max_torque       - Maximum Torque (nm)
+    #   @max_weight       - Maximum Weight (kg)
+    #   @max_year         - Latest Model Year
+    #   @seats            - Number of Seats
+    #   @sold_in_us       - 1(sold in US), 0(not sold in US)
+    #   @year             - Model Year
+    # Usage:
+    #   Carquery.get_trims 'volvo', year: 2010 => [#<struct Carquery::Trim id=12343, title="Tempra", make_code="fiat", ...>, ...]
+    # Notes:
+    #   Results are sorted by year, make, model, and trim. Results are limited to 500 records.
+    def get_trims params={}
+      response = request 'getTrims', params
+      response['Trims'].map {|make| Trim.build make }
+    end
+
+  end
+
+end

data/lib/carquery/dsl/get_years_range.rb

@@ -0,0 +1,17 @@
+module Carquery
+
+  class << self
+
+    # Returns range of available years from the CarQuery database.
+    # Input: none
+    # Usage:
+    #   Carquery.get_years_range => 1941..2012
+    def get_years_range
+      response = request 'getYears'
+      min = response["Years"]["min_year"].to_i
+      max = response["Years"]["max_year"].to_i
+      min..max
+    end
+  end
+
+end

data/lib/carquery/errors.rb

@@ -0,0 +1,3 @@
+module Carquery
+  class RequestError < StandardError; end
+end

data/lib/carquery/request.rb

@@ -0,0 +1,29 @@
+require "httparty"
+require "addressable/uri"
+
+module Carquery
+
+  class << self
+
+    protected
+
+    def request cmd, params={}
+      params.merge! cmd: cmd
+      response = HTTParty.get _build_url(params)
+
+      if cmd == 'getModel'
+        raise RequestError, "Not found" unless response.first.has_key? "model_id"
+        response.parsed_response.first
+      else
+        raise RequestError, response["error"] if response.has_key? "error"
+        response.parsed_response
+      end
+    end
+
+    def _build_url params={}
+      uri = Addressable::URI.parse API_URL
+      uri.query_values = params
+      uri.to_s
+    end
+  end
+end

data/lib/carquery/resources/base_struct.rb

@@ -0,0 +1,28 @@
+module Carquery
+
+  class BaseStruct < Struct
+    class << self
+
+      protected
+
+      def get_i str
+        return nil if str.nil?
+        str.to_i
+      end
+
+      def get_f str
+        return nil if str.nil?
+        str.to_f
+      end
+
+      def get_boolean str
+        str == '1'
+      end
+
+      def get_str str
+        str.to_s.strip
+      end
+    end
+  end
+
+end

data/lib/carquery/resources/car_model.rb

@@ -0,0 +1,9 @@
+module Carquery
+  CarModel = BaseStruct.new :title do
+
+    def self.build raw
+      title = get_str raw['model_name']
+      new title
+    end
+  end
+end

data/lib/carquery/resources/make.rb

@@ -0,0 +1,13 @@
+module Carquery
+  Make = BaseStruct.new :code, :title, :is_common, :country do
+
+    def self.build raw
+      code =      get_str raw['make_id']
+      title =     get_str raw['make_display']
+      is_common = get_boolean raw['make_is_common']
+      country =   get_str raw['make_country']
+
+      new code, title, is_common, country
+    end
+  end
+end

data/lib/carquery/resources/trim.rb

@@ -0,0 +1,62 @@
+module Carquery
+  Trim = BaseStruct.new :id, :title, :make_code, :trim, :year, :body, :engine_position,
+                        :engine_cc, :engine_cyl, :engine_type, :engine_valves_per_cyl,
+                        :engine_power_ps, :engine_power_rpm, :engine_torque_nm, :engine_torque_rpm,
+                        :engine_bore_mm, :engine_stroke_mm, :engine_compression, :engine_fuel,
+                        :top_speed_kph, :speedup_0_to_100_kph, :drive, :transmission_type,
+                        :seats, :doors, :weight_kg, :length_mm, :width_mm, :height_mm,
+                        :wheelbase_mm, :lkm_hwy, :lkm_mixed, :lkm_city, :fuel_cap_l, :sold_in_us,
+                        :co2, :make_title, :make_country do
+
+    def self.build raw
+      id =                    get_i   raw["model_id"]
+      title =                 get_str raw["model_name"]
+      make_code =             get_str raw["model_make_id"]
+      trim =                  get_str raw["model_trim"]
+      year =                  get_i   raw["model_year"]
+      body =                  get_str raw["model_body"]
+      engine_position =       get_str raw["model_engine_position"]
+      engine_cc =             get_i   raw["model_engine_cc"]
+      engine_cyl =            get_i   raw["model_engine_cyl"]
+      engine_type =           get_str raw["model_engine_type"]
+      engine_valves_per_cyl = get_i   raw["model_engine_valves_per_cyl"]
+      engine_power_ps =       get_i   raw["model_engine_power_ps"]
+      engine_power_rpm =      get_i   raw["model_engine_power_rpm"]
+      engine_torque_nm =      get_i   raw["model_engine_torque_nm"]
+      engine_torque_rpm =     get_i   raw["model_engine_torque_rpm"]
+      engine_bore_mm =        get_f   raw["model_engine_bore_mm"]
+      engine_stroke_mm =      get_f   raw["model_engine_stroke_mm"]
+      engine_compression =    get_f   raw["model_engine_compression"]
+      engine_fuel =           get_str raw["model_engine_fuel"]
+      top_speed_kph =         get_i   raw["model_top_speed_kph"]
+      speedup_0_to_100_kph =  get_f   raw["model_0_to_100_kph"]
+      drive =                 get_str raw["model_drive"]
+      transmission_type =     get_str raw["model_transmission_type"]
+      seats =                 get_i   raw["model_seats"]
+      doors =                 get_i   raw["model_doors"]
+      weight_kg =             get_i   raw["model_weight_kg"]
+      length_mm =             get_i   raw["model_length_mm"]
+      width_mm =              get_i   raw["model_width_mm"]
+      height_mm =             get_i   raw["model_height_mm"]
+      wheelbase_mm =          get_i   raw["model_wheelbase_mm"]
+      lkm_hwy =               get_f   raw["model_lkm_hwy"]
+      lkm_mixed =             get_f   raw["model_lkm_mixed"]
+      lkm_city =              get_f   raw["model_lkm_city"]
+      fuel_cap_l =            get_i   raw["model_fuel_cap_l"]
+      sold_in_us =            get_boolean raw["model_sold_in_us"]
+      co2 =                   get_i   raw["model_co2"]
+      make_title =            get_str raw["make_display"]
+      make_country =          get_str raw["make_country"]
+
+      new id, title, make_code, trim, year, body, engine_position, engine_cc,
+          engine_cyl, engine_type, engine_valves_per_cyl, engine_power_ps,
+          engine_power_rpm, engine_torque_nm, engine_torque_rpm, engine_bore_mm,
+          engine_stroke_mm, engine_compression, engine_fuel, top_speed_kph,
+          speedup_0_to_100_kph, drive, transmission_type, seats, doors, weight_kg,
+          length_mm, width_mm, height_mm, wheelbase_mm, lkm_hwy, lkm_mixed, lkm_city,
+          fuel_cap_l, sold_in_us, co2, make_title, make_country
+    end
+  end
+end
+
+

data/lib/carquery/version.rb

@@ -0,0 +1,3 @@
+module Carquery
+  VERSION = "0.1.0"
+end