fipextractor 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86bfa1930e1374a1c6e65b1b466f6103ae0da70a
-  data.tar.gz: 3bbd65e7bebeef4ce48afaa6a9e92a2d57fd2136
+  metadata.gz: 947417125d10b74d823ed81ebc3834a8ac6d505d
+  data.tar.gz: 51ef7702055873c3db28fa3d088ed95c7144b209
 SHA512:
-  metadata.gz: ab6ba54eedef1e09c98ba6c4d51847252061dd313169eb15593eb53a4b6d616609a07128bc0541138a0970b2bc4fca34937e612af89b9013952512711658ebcb
-  data.tar.gz: 426aa8c17105c2a2c735f52b1b17cf7beee7efd7747dc029b6e566cf495e487d04fd83c570e35442e90947d7f8f5ba6762e73e4b82742f8455cc4331411872cb
+  metadata.gz: 5f57812ad1e28187eacddda651ca87db6844a2adee0058f862aa359cd25562b1bdfacfec04812e61cb0ac6f935a3342e19cc2c1c0417ec07ab89922bf695c43d
+  data.tar.gz: e634ac79351a2691182c9fd63e9c7aae1a05c540ea6f16c2048feb6df8da0dc1ad39ff96a7548d5f87e630be98a646285448b8ab0a6873bcc1fbc73e348ec873

data/.gitignore

@@ -1,50 +1,50 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rspec_status

@@ -0,0 +1,31 @@
+example_id                                                      | status | run_time        |
+--------------------------------------------------------------- | ------ | --------------- |
+./spec/lib/fipextractor/brand_spec.rb[1:1:1]                    | passed | 0.00105 seconds |
+./spec/lib/fipextractor/brand_spec.rb[1:2:1]                    | passed | 0.00031 seconds |
+./spec/lib/fipextractor/converter/vehicle_type_spec.rb[1:1:1:1] | passed | 0.00016 seconds |
+./spec/lib/fipextractor/converter/vehicle_type_spec.rb[1:1:2:1] | passed | 0.00013 seconds |
+./spec/lib/fipextractor/converter/vehicle_type_spec.rb[1:1:3:1] | passed | 0.00012 seconds |
+./spec/lib/fipextractor/converter/vehicle_type_spec.rb[1:1:4:1] | passed | 0.00013 seconds |
+./spec/lib/fipextractor/model_response_spec.rb[1:1:1]           | passed | 0.00044 seconds |
+./spec/lib/fipextractor/model_response_spec.rb[1:2:1]           | passed | 0.00028 seconds |
+./spec/lib/fipextractor/model_spec.rb[1:1:1]                    | passed | 0.00022 seconds |
+./spec/lib/fipextractor/model_spec.rb[1:2:1]                    | passed | 0.0003 seconds  |
+./spec/lib/fipextractor/model_through_year_spec.rb[1:1:1]       | passed | 0.0002 seconds  |
+./spec/lib/fipextractor/model_through_year_spec.rb[1:2:1:1]     | passed | 0.00052 seconds |
+./spec/lib/fipextractor/model_through_year_spec.rb[1:2:1:2:1]   | passed | 0.00034 seconds |
+./spec/lib/fipextractor/model_year_spec.rb[1:1:1]               | passed | 0.00015 seconds |
+./spec/lib/fipextractor/model_year_spec.rb[1:2:1]               | passed | 0.00025 seconds |
+./spec/lib/fipextractor/reference_table_spec.rb[1:1:1]          | passed | 0.0002 seconds  |
+./spec/lib/fipextractor/request_spec.rb[1:1:1:1]                | passed | 0.0072 seconds  |
+./spec/lib/fipextractor/request_spec.rb[1:1:2:1]                | passed | 0.0016 seconds  |
+./spec/lib/fipextractor/request_spec.rb[1:2:1]                  | passed | 0.00311 seconds |
+./spec/lib/fipextractor/request_spec.rb[1:3:1]                  | passed | 0.00017 seconds |
+./spec/lib/fipextractor/request_spec.rb[1:4:1]                  | passed | 0.00035 seconds |
+./spec/lib/fipextractor/request_spec.rb[1:5:1]                  | passed | 0.00079 seconds |
+./spec/lib/fipextractor/request_spec.rb[1:6:1]                  | passed | 0.00022 seconds |
+./spec/lib/fipextractor/request_spec.rb[1:7:1]                  | passed | 0.00043 seconds |
+./spec/lib/fipextractor/resource_spec.rb[1:1:1]                 | passed | 0.0004 seconds  |
+./spec/lib/fipextractor/response_spec.rb[1:1:1:1]               | passed | 0.00034 seconds |
+./spec/lib/fipextractor/response_spec.rb[1:1:2:1]               | passed | 0.00035 seconds |
+./spec/lib/fipextractor/vehicle_spec.rb[1:1:1]                  | passed | 0.00023 seconds |
+./spec/lib/fipextractor/vehicle_spec.rb[1:2:1]                  | passed | 0.00043 seconds |

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -1,3 +1,7 @@
-source "https://rubygems.org"
-
-gemspec
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem 'coveralls', require: false
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Henrique Aparecido Lavezzo
+
+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

@@ -1,118 +1,88 @@
-## FipExtractor
----
-FipExtractor is a easy-to-use translator of the FIPE API.
-
-Actually FIPE only release the information about their vehicle market search on
-your website. To get information generally you need to do many DOM manipulations,
-with your user common behaviour (clicking in selects, and buttons).
-
-FipExtractor is here for you! We consumes the FIPE API directly, and
-translates the some parameters that have non-sense labels. Making this gem more useful for you.
-
-### Using FipExtractor
----
-
-FipExtractor only provides a easy way to consume FIPE informations, we don't create any
-conversions to generate SQL, or another way to insert data into databases.
-You can do this with the FipExtractor application result data.
-
-We use the FIPE API, and with this information, we clearly need to work under their
-API rules. FipExtractor provides a validator that shows to you if your request parameters
-are malformed.
-
-FipExtractor creates a huge and simple abstraction around API requests.
-
-The API routes are:
-
-|Route|Parameters|
-|------|----------|
-|reference_table|none|
-|brand|reference_table_id, vehicle_type|
-|model|reference_table_id, vehicle_type, brand_id|
-|model_through_year|reference_table_id, vehicle_type, brand_id, model_id|
-|model_year|reference_table_id, vehicle_type, brand_id, model_id, year, model_year, fuel_type_id|
-|full|reference_table_id, vehicle_type, brand_id, model_id, year, model_year, fuel_type_id, vehicle_type|
-
----
-#### Building a request
-
-````ruby
-extractor = FipExtractor.new(:full, {reference_table_id: 189, vehicle_type: :car, brand_id: 3, model_id: 7, model_year: "1999", year: "1999", fuel_type_id: 1})
-````
-
-You only need to create your FipExtractor object, and fill the parameters ``method`` and ``parameters``
-
-The ``method`` only accepts the Symbol reference.
-
-The ``parameters`` only accepts a Hash. (optional on ``:reference_table`` method)
-
----
-#### Checking the request parameters
-
-FipExtractor allows to submit a request directly, or check your parameters. You can choose, if you will validate your parameters, or not.
-
-Example of validation:
-
-````ruby
-extractor = FipExtractor.new(:brand, {reference_table_id: 189, vehicle_type: :truck})
-validator = extractor.validate_parameters
-if validator.is_ok?
-  api = extractor.request
-  api = api.send
-  puts api.response
-else
-  puts validator.message
-end
-````
-
-The validation layer is a object like everything in Ruby. Calling ``validate_parameters``, you automatic validate your parameters and generate a object with the ``is_ok?`` and ``message`` methods.
-
-``is_ok?`` Returns a ``boolean``, if all parameters are OK, you get a ``true`` value here, otherwise a ``false`` value appears.
-
-``message`` Returns an array of String with the parameters problems with the request method, if have one.
-
----
-#### Getting the data
-
-FipExtractor provides a friendly response data layout. All original API parameters are converted to a FipExtractor pattern. This pattern is more developer-like.
-
-The original API response layout provides some JSON keys like ``Label`` and ``Value``. This patterns isn't a good pattern. FipExtractor converts these kind of parameters, in a specific Hash based on request method.
-
-Getting data response:
-````ruby
-extractor = FipExtractor.new(:model, {reference_table_id: 189, vehicle_type: :truck, brand_id: 102})
-api = extractor.request
-api = api.send
-puts api.response
-````
-
-Output:
-
-````ruby
-{:brand_name=>"AGRALE", :brand_id=>"102"}
-{:brand_name=>"CHEVROLET", :brand_id=>"103"}
-{:brand_name=>"CICCOBUS", :brand_id=>"121"}
-{:brand_name=>"DAF", :brand_id=>"197"}
-{:brand_name=>"EFFA-JMC", :brand_id=>"179"}
-{:brand_name=>"FIAT", :brand_id=>"104"}
-{:brand_name=>"FORD", :brand_id=>"105"}
-{:brand_name=>"FOTON", :brand_id=>"191"}
-{:brand_name=>"GMC", :brand_id=>"106"}
-{:brand_name=>"HYUNDAI", :brand_id=>"181"}
-{:brand_name=>"IVECO", :brand_id=>"122"}
-{:brand_name=>"MAN", :brand_id=>"184"}
-{:brand_name=>"MARCOPOLO", :brand_id=>"108"}
-{:brand_name=>"MASCARELLO", :brand_id=>"196"}
-{:brand_name=>"MAXIBUS", :brand_id=>"194"}
-{:brand_name=>"MERCEDES-BENZ", :brand_id=>"109"}
-{:brand_name=>"NAVISTAR", :brand_id=>"110"}
-{:brand_name=>"NEOBUS", :brand_id=>"111"}
-{:brand_name=>"PUMA-ALFA", :brand_id=>"112"}
-{:brand_name=>"SAAB-SCANIA", :brand_id=>"113"}
-{:brand_name=>"SCANIA", :brand_id=>"114"}
-{:brand_name=>"SHACMAN", :brand_id=>"193"}
-{:brand_name=>"SINOTRUK", :brand_id=>"166"}
-{:brand_name=>"VOLKSWAGEN", :brand_id=>"115"}
-{:brand_name=>"VOLVO", :brand_id=>"116"}
-{:brand_name=>"WALKBUS", :brand_id=>"144"}
-````
+# FipExtractor
+
+Unofficial client gem for FIPE vehicle table.
+
+## Installation
+
+Add this line in your Gemfile:
+
+```ruby
+gem 'fipextractor', '~> 1.0'
+```
+
+    $ bundle
+
+Or
+
+    $ gem install fipextractor
+
+## Implemented Calls
+
+- [ReferenceTable](#referencetable)
+- [Brand](#brand)
+- [Model](#Model)
+- [ModelYear](#modelyear)
+- [ModelThroughYear](#modelthroughyear)
+- [Vehicle](#vehicle)
+
+### ReferenceTable
+
+```ruby
+response = FipExtractor::ReferenceTable.new.call
+response.all # array of reference tables id
+```
+
+### Brand
+
+```ruby
+response = FipExtractor::Brand.new(vehicle_type: :car, reference_table_id: 66).call
+response.all # array of vehicle brands
+```
+
+### Model
+
+```ruby
+response = FipExtractor::Model.new(vehicle_type: :car, reference_table_id: 66, brand_id: 44).call
+response.all # array of model and years
+response.models # array of model hashes
+response.years # array of year designated
+```
+
+### ModelYear
+
+```ruby
+response = FipExtractor::ModelYear.new(vehicle_type: :car, reference_table_id: 66, brand_id: 44, model_id: 1878).call
+response.all # array of models with aging
+```
+
+### ModelThroughYear
+
+```ruby
+response = FipExtractor::ModelThroughYear.new(vehicle_type: :car, reference_table_id: 66, brand_id: 44, year: 1999, fuel: 1).call
+response.all # array of models ordered by year, and/or fuel filter
+```
+
+### Vehicle
+
+```ruby
+response = FipExtractor::Vehicle.new(vehicle_type: :car, reference_table_id: 237, brand_id: 59, model_id: 2365, year: 1999, fuel: 3).call
+response.details # detailed fipe information of vehicle
+```
+
+#### Vehicle Types
+
+```ruby
+  { car: 1, motorcycle: 2, truck: 3 }
+```
+
+### Tests
+
+`rake spec`
+
+### Console
+
+`bundle console`
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,10 +1,6 @@
-require 'rake/testtask'
-
-desc "Run all tests in folder test/*_test.rb"
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/*_spec.rb']
-  t.verbose = true
-end
-
-task :default => :test
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/fipextractor.gemspec

@@ -1,21 +1,29 @@
-Gem::Specification.new do |s|
-  s.name        = 'fipextractor'
-  s.version     = '0.0.1'
-  s.summary     = 'FipExtractor'
-  s.description = 'Consume, and extract data about vehicles from FIPE API'
-  s.authors     = ["Rynaro"]
-  s.email       = 'iam@henriquelavezzo.com.br'
-  s.homepage    = 'https://github.com/Rynaro/fipextractor'
-  s.license     = 'MIT'
-
-  s.add_dependency('unirest', '~> 1.1')
-
-  s.add_development_dependency('minitest', '~> 5.10')
-  s.add_development_dependency('rake')
-
-  s.required_ruby_version = '~> 2.0'
-
-  s.files       = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- test/*`.split("\n")
-  s.require_paths = ['lib']
-end
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fipextractor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fipextractor"
+  spec.version       = FipExtractor::VERSION
+  spec.authors       = ["Henrique A. Lavezzo"]
+  spec.email         = ["me@hlavezzo.run"]
+
+  spec.summary       = %q{Parsing fixed width files made easy}
+  spec.homepage      = "https://github.com/Rynaro/estratto"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('faraday', '~> 0.15')
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-nav"
+end