fipextractor 0.0.1 → 1.0.0

data/lib/fipextractor.rb

@@ -1,40 +1,9 @@
-require_relative 'fipextractor/fipe_api/api_factory'
-require_relative 'fipextractor/api_parameter/parameter_converter'
-require_relative 'fipextractor/api_parameter/parameter_validator'
-require_relative 'fipextractor/api_response/response_converter_builder'
-
-class FipExtractor
-
-  attr_accessor :method, :parameters
-
-  def initialize(method, parameters = {})
-    @method = method
-    @parameters = parameters
-  end
-
-  def validate_parameters
-    FipeApi::ParameterValidator.new(@method, @parameters)
-  end
-
-  def request
-    @parameters = convert_parameters_to_api_pattern(@parameters)
-    FipeApi::ApiFactory.create_requester(@method, @parameters)
-  end
-
-  private
-
-  def convert_parameters_to_api_pattern(parameters)
-    parameters[:vehicle_type] = convert_humanized_vehicle_id(parameters[:vehicle_type])
-    parameters[:search] = add_non_obstrutive_search_type if @method == :full
-    FipeApi::ParameterConverter.to_fipe_pattern(parameters)
-  end
-
-  def convert_humanized_vehicle_id(vehicle_type)
-    FipeApi::ParameterConverter.vehicle_type_to_id(vehicle_type)
-  end
-
-  def add_non_obstrutive_search_type
-    'tradicional'
-  end
-
-end
+require 'fipextractor/reference_table'
+require 'fipextractor/brand'
+require 'fipextractor/model'
+require 'fipextractor/model_year'
+require 'fipextractor/model_through_year'
+require 'fipextractor/vehicle'
+
+module FipExtractor
+end

data/lib/fipextractor/brand.rb

@@ -0,0 +1,24 @@
+require_relative 'resource'
+require_relative 'brand_response'
+
+module FipExtractor
+  class Brand < Resource
+    attr_reader :vehicle_type, :reference_table_id
+
+    def initialize(vehicle_type:, reference_table_id:)
+      @vehicle_type = vehicle_type
+      @reference_table_id = reference_table_id
+    end
+
+    def route
+      'ConsultarMarcas'
+    end
+
+    def params
+      {
+        codigoTipoVeiculo: vehicle_type_id,
+        codigoTabelaReferencia: reference_table_id
+      }
+    end
+  end
+end

data/lib/fipextractor/brand_response.rb

@@ -0,0 +1,7 @@
+require_relative 'response'
+
+module FipExtractor
+  class BrandResponse < Response
+
+  end
+end

data/lib/fipextractor/converter/vehicle_type.rb

@@ -0,0 +1,16 @@
+module FipExtractor
+  module Converter
+    class VehicleType
+      REMOTE_TYPE = {
+        car: 1,
+        motorcycle: 2,
+        truck: 3,
+      }
+
+      def self.to_id(type)
+        return type if type.is_a?(Integer)
+        REMOTE_TYPE[type]
+      end
+    end
+  end
+end

data/lib/fipextractor/model.rb

@@ -0,0 +1,26 @@
+require_relative 'resource'
+require_relative 'model_response'
+
+module FipExtractor
+  class Model < Resource
+    attr_reader :vehicle_type, :reference_table_id, :brand_id
+
+    def initialize(vehicle_type:, reference_table_id:, brand_id:)
+      @vehicle_type = vehicle_type
+      @reference_table_id = reference_table_id
+      @brand_id = brand_id
+    end
+
+    def route
+      'ConsultarModelos'
+    end
+
+    def params
+      {
+        codigoTipoVeiculo: vehicle_type_id,
+        codigoTabelaReferencia: reference_table_id,
+        codigoMarca: brand_id
+      }
+    end
+  end
+end

data/lib/fipextractor/model_response.rb

@@ -0,0 +1,15 @@
+require_relative 'response'
+
+module FipExtractor
+  class ModelResponse < Response
+
+    def models
+      all[:Modelos]
+    end
+
+    def years
+      all[:Anos]
+    end
+
+  end
+end

data/lib/fipextractor/model_through_year.rb

@@ -0,0 +1,30 @@
+require_relative 'resource'
+require_relative 'model_through_year_response'
+
+module FipExtractor
+  class ModelThroughYear < Resource
+    attr_reader :vehicle_type, :reference_table_id, :brand_id, :year, :fuel
+
+    def initialize(vehicle_type:, reference_table_id:, brand_id:, year:, fuel: nil)
+      @vehicle_type = vehicle_type
+      @reference_table_id = reference_table_id
+      @brand_id = brand_id
+      @year = year
+      @fuel = fuel
+    end
+
+    def route
+      'ConsultarModelosAtravesDoAno'
+    end
+
+    def params
+      {
+        codigoTipoVeiculo: vehicle_type_id,
+        codigoTabelaReferencia: reference_table_id,
+        codigoMarca: brand_id,
+        anoModelo: year,
+        codigoTipoCombustivel: fuel
+      }
+    end
+  end
+end

data/lib/fipextractor/model_through_year_response.rb

@@ -0,0 +1,7 @@
+require_relative 'response'
+
+module FipExtractor
+  class ModelThroughYearResponse < Response
+
+  end
+end

data/lib/fipextractor/model_year.rb

@@ -0,0 +1,28 @@
+require_relative 'resource'
+require_relative 'model_year_response'
+
+module FipExtractor
+  class ModelYear < Resource
+    attr_reader :vehicle_type, :reference_table_id, :brand_id, :model_id
+
+    def initialize(vehicle_type:, reference_table_id:, brand_id:, model_id:)
+      @vehicle_type = vehicle_type
+      @reference_table_id = reference_table_id
+      @brand_id = brand_id
+      @model_id = model_id
+    end
+
+    def route
+      'ConsultarAnoModelo'
+    end
+
+    def params
+      {
+        codigoTipoVeiculo: vehicle_type_id,
+        codigoTabelaReferencia: reference_table_id,
+        codigoMarca: brand_id,
+        codigoModelo: model_id
+      }
+    end
+  end
+end

data/lib/fipextractor/model_year_response.rb

@@ -0,0 +1,7 @@
+require_relative 'response'
+
+module FipExtractor
+  class ModelYearResponse < Response
+
+  end
+end

data/lib/fipextractor/reference_table.rb

@@ -0,0 +1,10 @@
+require_relative 'request'
+require_relative 'reference_table_response'
+
+module FipExtractor
+  class ReferenceTable < Request
+    def route
+      'ConsultarTabelaDeReferencia'
+    end
+  end
+end

data/lib/fipextractor/reference_table_response.rb

@@ -0,0 +1,7 @@
+require_relative 'response'
+
+module FipExtractor
+  class ReferenceTableResponse < Response
+
+  end
+end

data/lib/fipextractor/request.rb

@@ -0,0 +1,53 @@
+require 'faraday'
+require_relative 'response'
+
+module FipExtractor
+  class RouteNotFoundError < StandardError; end
+  class ResourceNotFoundError < StandardError; end
+
+  class Request
+    HOST = "veiculos.fipe.org.br".freeze
+    API = "api/veiculos".freeze
+
+    def call
+      response_class.new(request).tap do |response|
+        raise ResourceNotFoundError if response.error?
+      end
+    end
+
+    def response_class
+      Object.const_get("#{self.class}Response")
+    end
+
+    def request
+      Faraday.new(url: resource, headers: headers).send(:post) do |request|
+        request.body = params
+      end
+    end
+
+    def base_url
+      "https://#{HOST}/#{API}"
+    end
+
+    def route
+      raise RouteNotFoundError
+    end
+
+    def resource
+      "#{base_url}/#{route}"
+    end
+
+    def params
+      {}
+    end
+
+    private
+
+    def headers
+      {
+        'Host' => HOST,
+        'Referer' => "https://#{HOST}"
+      }
+    end
+  end
+end

data/lib/fipextractor/resource.rb

@@ -0,0 +1,10 @@
+require_relative 'request'
+require_relative 'converter/vehicle_type'
+
+module FipExtractor
+  class Resource < Request
+    def vehicle_type_id
+      Converter::VehicleType.to_id(vehicle_type)
+    end
+  end
+end

data/lib/fipextractor/response.rb

@@ -0,0 +1,16 @@
+require 'json'
+
+module FipExtractor
+  class Response
+    attr_reader :status, :all
+
+    def initialize(raw)
+      @status = raw.status
+      @all = JSON.parse(raw.body, symbolize_names: true)
+    end
+
+    def error?
+      status >= 400
+    end
+  end
+end

data/lib/fipextractor/vehicle.rb

@@ -0,0 +1,39 @@
+require_relative 'resource'
+require_relative 'vehicle_response'
+
+module FipExtractor
+  class Vehicle < Resource
+    attr_reader :vehicle_type, :reference_table_id, :brand_id, :model_id, :year, :fuel
+
+    def initialize(vehicle_type:, reference_table_id:, brand_id:, model_id:, year:, fuel:)
+      @vehicle_type = vehicle_type
+      @reference_table_id = reference_table_id
+      @brand_id = brand_id
+      @model_id = model_id
+      @year = year
+      @fuel = fuel
+    end
+
+    def route
+      'ConsultarValorComTodosParametros'
+    end
+
+    def params
+      {
+        codigoTipoVeiculo: vehicle_type_id,
+        codigoTabelaReferencia: reference_table_id,
+        codigoModelo: model_id,
+        codigoMarca: brand_id,
+        anoModelo: year,
+        codigoTipoCombustivel: fuel,
+        tipoConsulta: search_type
+      }
+    end
+
+    private
+
+    def search_type
+      'tradicional'.freeze
+    end
+  end
+end

data/lib/fipextractor/vehicle_response.rb

@@ -0,0 +1,7 @@
+require_relative 'response'
+
+module FipExtractor
+  class VehicleResponse < Response
+    alias_method :details, :all
+  end
+end

data/lib/fipextractor/version.rb

@@ -0,0 +1,3 @@
+module FipExtractor
+  VERSION = '1.0.0'
+end

metadata

@@ -1,45 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: fipextractor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
-- Rynaro
+- Henrique A. Lavezzo
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2017-02-24 00:00:00.000000000 Z
+date: 2019-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: unirest
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,32 +80,41 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Consume, and extract data about vehicles from FIPE API
-email: iam@henriquelavezzo.com.br
+description: 
+email:
+- me@hlavezzo.run
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rspec_status"
+- ".travis.yml"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - fipextractor.gemspec
 - lib/fipextractor.rb
-- lib/fipextractor/api_parameter/parameter_converter.rb
-- lib/fipextractor/api_parameter/parameter_validator.rb
-- lib/fipextractor/api_response/brand_response_converter.rb
-- lib/fipextractor/api_response/model_response_converter.rb
-- lib/fipextractor/api_response/model_through_year_response_converter.rb
-- lib/fipextractor/api_response/response_converter.rb
-- lib/fipextractor/api_response/response_converter_builder.rb
-- lib/fipextractor/fipe_api/api_factory.rb
-- lib/fipextractor/fipe_api/api_requester.rb
-- lib/fipextractor/fipe_api/api_response.rb
-- test/parameter_converter_spec.rb
-- test/parameter_validator_spec.rb
-- test/response_converter_spec.rb
-homepage: https://github.com/Rynaro/fipextractor
+- lib/fipextractor/brand.rb
+- lib/fipextractor/brand_response.rb
+- lib/fipextractor/converter/vehicle_type.rb
+- lib/fipextractor/model.rb
+- lib/fipextractor/model_response.rb
+- lib/fipextractor/model_through_year.rb
+- lib/fipextractor/model_through_year_response.rb
+- lib/fipextractor/model_year.rb
+- lib/fipextractor/model_year_response.rb
+- lib/fipextractor/reference_table.rb
+- lib/fipextractor/reference_table_response.rb
+- lib/fipextractor/request.rb
+- lib/fipextractor/resource.rb
+- lib/fipextractor/response.rb
+- lib/fipextractor/vehicle.rb
+- lib/fipextractor/vehicle_response.rb
+- lib/fipextractor/version.rb
+homepage: https://github.com/Rynaro/estratto
 licenses:
 - MIT
 metadata: {}
@@ -87,9 +124,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -100,8 +137,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: FipExtractor
-test_files:
-- test/parameter_converter_spec.rb
-- test/parameter_validator_spec.rb
-- test/response_converter_spec.rb
+summary: Parsing fixed width files made easy
+test_files: []