car_query 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.3-p125@car_query

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+
+  gem "rake", ">= 0.9"
+  gem "httparty", "~> 0.8.3"
+  gem "addressable", "~> 2.2.7"
+
+group :development do
+  gem "yard", "~> 0.7"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.1.3"
+  gem "jeweler", "~> 1.8.3"
+  gem "simplecov", "~> 0.6"
+  gem "ZenTest", "~> 4.7.0"
+end
+
+group :development,:test do
+  gem "rspec", "~> 2.9.0"
+  gem "vcr", "~> 2.1.1"
+  gem "webmock", "~> 1.8.6"
+end

data/Gemfile.lock

@@ -0,0 +1,56 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.7.0)
+    addressable (2.2.7)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.6)
+    multi_json (1.3.2)
+    multi_xml (0.4.4)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    simplecov (0.6.2)
+      multi_json (~> 1.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    vcr (2.1.1)
+    webmock (1.8.6)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest (~> 4.7.0)
+  addressable (~> 2.2.7)
+  bundler (~> 1.1.3)
+  httparty (~> 0.8.3)
+  jeweler (~> 1.8.3)
+  rake (>= 0.9)
+  rdoc (~> 3.12)
+  rspec (~> 2.9.0)
+  simplecov (~> 0.6)
+  vcr (~> 2.1.1)
+  webmock (~> 1.8.6)
+  yard (~> 0.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Orlando Del Aguila
+
+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.markdown

@@ -0,0 +1,25 @@
+# CarQuery
+
+A Ruby wrapper for the www.carqueryapi.com's JSON API
+
+[![Build Status](https://secure.travis-ci.org/orlandodelaguila/car_query.png)](http://travis-ci.org/orlandodelaguila/car\_query)
+
+Use RubyGems to install the gem:
+
+    gem install car_query
+
+## Contributing to CarQuery
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Orlando Del Aguila. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "car_query"
+  gem.homepage = "http://github.com/orlandodelaguila/car_query"
+  gem.license = "MIT"
+  gem.summary = %Q{A Ruby wrapper for the www.carqueryapi.com's JSON API}
+  gem.description = %Q{A Ruby wrapper for the www.carqueryapi.com's JSON API}
+  gem.email = "me@orlandodelaguila.com"
+  gem.authors = ["Orlando Del Aguila"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/car_query.rb

@@ -0,0 +1,149 @@
+# encoding: utf-8
+require 'httparty'
+require 'addressable/uri'
+
+# @author Orlando Del Aguila
+# Holds all CarQuery methods
+module CarQuery
+  # @author Orlando Del Aguila
+  # raised when the api returns error.
+  class APIError < StandardError;end
+
+  class << self; attr_reader :url; end
+  @url = Addressable::URI.parse("http://www.carqueryapi.com/api/0.3/")
+
+  # @author Orlando Del Aguila
+  # Contains query method for years
+  module Years
+  # @author Orlando Del Aguila
+  # Returns max and min years of models. 
+  # @return [Hash] A hash min_year and max_year
+  # @example Returns years
+  #   CarQuery::Years.get #=> {"min_year"=>"1940", "max_year"=>"2012"}
+    def self.get
+      request = CarQuery.url; request.query_values = {:cmd => "getYears"}
+      CarQuery.query(request,"Years")
+    end
+  end
+
+  # @author Orlando Del Aguila
+  # Contains query method for makes
+  module Makes
+    # @author Orlando Del Aguila
+    # Returns Makes.
+    # @param [Hash] params the options to return makes.
+    # @option params [String] :year ('') returns makes that have model of this year
+    # @option params [String] :sold_in_us ('') 1(sold in US), 0(not sold in US)
+    # @return [Hash] with makes
+    # @example Returns makes list that has models from 2012
+    #   CarQuery::Makes.get({:year => 2012}) #=> [{"make_id"=>"acura", "make_display"=>"Acura"...}]
+    def self.get(params={})
+      params.delete(:cmd)
+      request = CarQuery.url
+      request.query_values = {:cmd => "getMakes"}.merge(params)
+      CarQuery.query(request,"Makes")
+    end
+  end
+
+  # @author Orlando Del Aguila
+  # Contains query method for models
+  module Models
+    # @author Orlando Del Aguila
+    # Returns Models
+    # @param [Hash] params the options to return models.
+    # @option params [String] :make The make of the models (required)
+    # @option params [String] :year ('') Model year
+    # @option params [String] :sold_in_us ('') 1(sold in US), 0(not sold in US)
+    # @option params [String] :body ('') the body type. ex Coupe, Sedan, SUV, Pickup, Crossover, Minivan, etc.
+    # @return [Hash] with models
+    # @example Returns makes list that has models from 2012
+    #   CarQuery::Models.get({:make => "ford", :year => "2012"}) #=> [{"model_name"=>"Bantam", "model_make_id"=>"ford"}...]
+    # @raise [APIError] if :make param is missing
+    def self.get(params={})
+      params.delete(:cmd)
+      request = CarQuery.url
+      request.query_values = {:cmd => "getModels"}.merge(params)
+      CarQuery.query(request,"Models")
+    end
+  end
+
+  # @author Orlando Del Aguila
+  # Contains query method for trims
+  module Trims
+    # @author Orlando Del Aguila
+    # Returns Model Trims, all params are optional, if no param is passed then returns full results for all trims from all models (results are limited to 500).
+    # @param [Hash] params the options to return a trim.
+    # @option params [String] :body ('') the body type. ex Coupe, Sedan, SUV, Pickup, Crossover, Minivan, etc. 
+    # @option params [String] :doors ('') number of doors
+    # @option params [String] :drive ('') ex Front, Rear, AWD, 4WD, etc
+    # @option params [String] :engine_position ('') ex Front, Middle, Rear
+    # @option params [String] :engine_type ('') ex V, in-line, etc
+    # @option params [String] :fuel_type ('') ex Gasoline, Diesel, etc
+    # @option params [String] :full_results ('') 1 by default. Set to 0 to include only basic year / make /model / trim data (improves load times)
+    # @option params [String] :keyword ('') Keyword search. Searches year, make, model, and trim values
+    # @option params [String] :make ('') Make ID
+    # @option params [String] :min_cylinders ('') Minimum Number of cylinders
+    # @option params [String] :min_lkm_hwy ('') Maximum fuel efficiency (highway, l/100km)
+    # @option params [String] :min_power ('') Minimum engine power (PS)
+    # @option params [String] :min_top_speed ('') Minimum Top Speed (km/h)
+    # @option params [String] :min_torque ('') Minimum Torque (nm)
+    # @option params [String] :min_weight ('') Minimum Weight (kg)
+    # @option params [String] :min_year ('') Earliest Model Year
+    # @option params [String] :max_cylinders ('') Maximum Number of cylinders
+    # @option params [String] :max_lkm_hwy ('') Minimum fuel efficiency (highway, l/100km)
+    # @option params [String] :max_power ('') Minimum engine power (HP)
+    # @option params [String] :max_top_speed ('') Maximum Top Speed (km/h)
+    # @option params [String] :max_torque ('') Maximum Torque (nm)
+    # @option params [String] :max_weight ('') Maximum Weight (kg)
+    # @option params [String] :max_year ('') Latest Model Year
+    # @option params [String] :model ('') Model Name
+    # @option params [String] :seats ('') Number of Seats
+    # @option params [String] :sold_in_us ('') 1(sold in US), 0(not sold in US)
+    # @option params [String] :year ('') Model Year
+    # @raise [APIError] if :model param is missing.
+    # @return [Hash] Results are sorted by year, make, model, and trim. Results are limited to 500 records
+    # @example Returns trims by keyword and only basic results
+    #   CarQuery::Trims.get({:keyword => "ford f-350", :full_results => 0}) #=> [{"model_id":"48922","model_year":"2012"...}]
+    def self.get(params={})
+      params.delete(:cmd)
+      request = CarQuery.url
+      request.query_values = {:cmd => "getTrims"}.merge(params)
+      CarQuery.query(request,"Trims")
+    end
+  end
+
+  # @author Orlando Del Aguila
+  # Contains query method for model
+  module Model
+    # @author Orlando Del Aguila
+    # Returns Model Trims, all params all optional, if no param is passed then returns full results for all trims from all models.
+    # @param [Hash] params the options to return a model.
+    # @option params [Integer] :model The model_id (required)
+    # @return [Hash] with all model data or empty
+    # @example Returns all data of the Ford F-350 2012
+    #   CarQuery::Model.get({:model =>"48922"}) #=> {"model_id":"48922","model_make_id":"ford"...}
+    def self.get(params={})
+      params.delete(:cmd)
+      request = CarQuery.url
+      request.query_values = {:cmd => "getModel"}.merge(params)
+      CarQuery.query(request,"Model")
+    end
+
+  end
+  
+  protected
+  # @author Orlando Del Aguila
+  # Contains base query method 
+  def self.query(url=self.url,key="")
+    if key == "Model"
+      response = HTTParty.get(url).first
+      raise APIError,response.last if response.first == "error"
+      return response
+    end
+    response = HTTParty.get(url)
+    raise APIError,response["error"] if response.has_key?("error")
+    return response.parsed_response[key] unless key.empty?
+    response.parsed_response
+  end
+  
+end

data/spec/car_query_spec.rb

@@ -0,0 +1,133 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CarQuery do
+  use_vcr_cassette :record => :new_episodes 
+  context "Base" do
+    it "returns an Addressable::URI Object with the base url" do
+      CarQuery.url.to_s.should == "http://www.carqueryapi.com/api/0.3/"
+      CarQuery.url.class.should == Addressable::URI
+    end
+
+    it "raises an error if api returns error" do
+      lambda{CarQuery.query}.should raise_error(CarQuery::APIError)
+    end
+
+    it "returns parsed_response if the query its good" do
+      request = CarQuery.url
+      request.query_values = {:cmd => "getYears"}
+      lambda{CarQuery.query(request.to_s)}.should_not raise_error(CarQuery::APIError)
+    end
+
+    it "returns a non_scoped parsed_response if key is passed as a param" do
+      request = CarQuery.url
+      request.query_values = {:cmd => "getYears"}
+      CarQuery.query(request.to_s).should == {"Years"=>{"min_year"=>"1940", "max_year"=>"2012"}}
+      CarQuery.query(request.to_s,"Years").should == {"min_year"=>"1940", "max_year"=>"2012"}
+    end
+  end
+end
+
+describe CarQuery::Years do
+  use_vcr_cassette :record => :new_episodes 
+  it "returns range of years of models avaible in the db" do
+    CarQuery::Years.get.should == {"min_year"=>"1940", "max_year"=>"2012"}
+  end
+end
+
+describe CarQuery::Makes do
+  use_vcr_cassette :record => :new_episodes
+
+  it "returns all makers" do
+    CarQuery::Makes.get.should_not be_empty
+  end
+
+  it "accepts params as a hash" do
+    lambda{CarQuery::Makes.get({:year => 2000})}.should_not raise_error
+  end
+
+  it "returns all makers that has models in a certain year" do
+    CarQuery::Makes.get({:year => 2012}).should_not be_empty
+  end
+
+  it "returns all makers that sold cars in USA" do
+    CarQuery::Makes.get({:sold_in_us => 1}).should_not be_empty
+  end
+end
+
+describe CarQuery::Models do
+  use_vcr_cassette :record => :new_episodes
+
+  it "should raise error if no maker is passed" do
+    lambda{CarQuery::Models.get}.should raise_error(CarQuery::APIError)
+  end
+
+  it "should not raise error if a maker is passed" do
+    lambda{CarQuery::Models.get({:make => "ford"})}.should_not raise_error(CarQuery::APIError)
+  end
+
+  it "returns all models for a certain maker" do
+    response = CarQuery::Models.get({:make => "ford"})
+    response.should_not be_empty
+    response.first.should == {"model_name"=>"021 C", "model_make_id"=>"ford"}
+  end
+
+  it "returns all models from a maker by year" do
+    response = CarQuery::Models.get({:make => "ford", :year => "2012"})
+    response.should_not be_empty
+    response.first.should == {"model_name"=>"Bantam","model_make_id"=>"ford"}
+  end
+end
+
+describe CarQuery::Trims do
+  use_vcr_cassette :record => :new_episodes
+
+  it "should return 500 first trims" do
+    response = CarQuery::Trims.get
+    response.should_not be_empty
+    response.size.should == 500
+  end
+
+  it "accepts variables like year,model,make etc." do
+    response = CarQuery::Trims.get({:year => 2012, :make => "ford", :model => "f-350"})
+    response.should_not be_empty
+    response.first.should == {"model_id"=>"48922", "model_make_id"=>"ford", "model_name"=>"F-350", "model_trim"=>"Super Duty King Ranch", "model_year"=>"2012", "model_body"=>"Pickup", "model_engine_position"=>"Front", "model_engine_cc"=>"6200", "model_engine_cyl"=>"8", "model_engine_type"=>"V", "model_engine_valves_per_cyl"=>"2", "model_engine_power_ps"=>"390", "model_engine_power_rpm"=>"5500", "model_engine_torque_nm"=>"548", "model_engine_torque_rpm"=>"4500", "model_engine_bore_mm"=>nil, "model_engine_stroke_mm"=>nil, "model_engine_compression"=>nil, "model_engine_fuel"=>"Flex Fuel", "model_top_speed_kph"=>nil, "model_0_to_100_kph"=>nil, "model_drive"=>"Rear", "model_transmission_type"=>"6-speed shiftable automatic", "model_seats"=>nil, "model_doors"=>nil, "model_weight_kg"=>nil, "model_length_mm"=>"6269", "model_width_mm"=>"2029", "model_height_mm"=>"1961", "model_wheelbase_mm"=>"3967", "model_lkm_hwy"=>nil, "model_lkm_mixed"=>nil, "model_lkm_city"=>nil, "model_fuel_cap_l"=>"132", "model_sold_in_us"=>"1", "make_display"=>"Ford", "make_country"=>"USA"}
+  end
+
+  it "accepts a full_results param that give us only model,year and make instead of all data of a trim" do
+    response = CarQuery::Trims.get({:year => 2012, :make => "ford", :model => "f-350", :full_results => 0})
+    response.should_not be_empty
+    response.first.should == {"model_id"=>"48922", "model_year"=>"2012", "model_make_id"=>"ford", "model_name"=>"F-350", "model_trim"=>"Super Duty King Ranch", "make_display"=>"Ford", "make_country"=>"USA"}
+  end
+
+  it "accepts a keyword param that tries to find a trim by keywords" do
+    response = CarQuery::Trims.get({:keyword => "ford f-350", :full_results => 0})
+    response.should_not be_empty
+    response.first.should == {"model_id"=>"48922", "model_year"=>"2012", "model_make_id"=>"ford", "model_name"=>"F-350", "model_trim"=>"Super Duty King Ranch", "make_display"=>"Ford", "make_country"=>"USA"}
+  end
+  
+  it "accepts a keyword param that tries to find a trim by keywords and could return empty if theres no match" do
+    response = CarQuery::Trims.get({:keyword => "no matching keyword here!", :full_results => 0})
+    response.should be_empty
+  end
+ 
+  it "returns an empty hash if theres no match" do
+    response = CarQuery::Trims.get({:year => 2015, :make => "ford", :model => "f-350"})
+    response.should be_empty
+  end
+end
+
+describe CarQuery::Trims do
+  use_vcr_cassette :record => :new_episodes
+
+  it "raises an error if no model param is passed" do
+    lambda{CarQuery::Model.get}.should raise_error(CarQuery::APIError)
+  end
+
+  it "dont raises an error if model param is passed" do
+    lambda{CarQuery::Model.get({:model =>"48922"})}.should_not raise_error(CarQuery::APIError)
+  end
+
+  it "returns all data of a certain model" do
+    response = CarQuery::Model.get({:model =>'48922'})
+  end
+end