fipextractor 0.0.1 → 1.0.0

data/lib/fipextractor/api_parameter/parameter_converter.rb

@@ -1,39 +0,0 @@
-module FipeApi
-  class ParameterConverter
-
-    CONVERSION_PARAMETER = {
-      reference_table_id: :codigoTabelaReferencia,
-      vehicle_type_id: :codigoTipoVeiculo,
-      brand_id: :codigoMarca,
-      model_id: :codigoModelo,
-      year: :ano,
-      model_year: :anoModelo,
-      fuel_type_id: :codigoTipoCombustivel,
-      search: :tipoConsulta,
-      vehicle_type: :codigoTipoVeiculo
-    }
-
-    VEHICLE_TYPE = {
-      car: 1,
-      motorcycle: 2,
-      truck: 3
-    }
-
-    def self.to_fipe_pattern(application_parameters)
-      converted_parameters = {}
-      application_parameters.each do |parameter, value|
-        converted_parameters[CONVERSION_PARAMETER[parameter]] = value
-      end
-      converted_parameters
-    end
-
-    def self.vehicle_type_to_id(vehicle)
-      VEHICLE_TYPE[vehicle]
-    end
-
-    def self.add_search_type
-      'tradicional'
-    end
-
-  end
-end

data/lib/fipextractor/api_parameter/parameter_validator.rb

@@ -1,46 +0,0 @@
-module FipeApi
-  class ParameterValidator
-
-    attr_reader :status, :message
-
-    PARAMETERS = %w{reference_table_id vehicle_type brand_id model_id year model_year fuel_type_id vehicle_type}
-
-    METHOD_PARAMS = {
-      reference_table: {},
-      brand: PARAMETERS.select { |param| param.match(/reference_table_id|vehicle_type/) },
-      model: PARAMETERS.select { |param| param.match(/reference_table_id|vehicle_type|brand_id/) },
-      model_year: PARAMETERS.select { |param| param.match(/reference_table_id|vehicle_type|brand_id|model_id/) },
-      model_through_year: PARAMETERS.select { |param| param.match(/reference_table_id|vehicle_type|brand_id|model_id|year|model_year|fuel_type_id/) },
-      full: PARAMETERS
-    }
-
-    def initialize(method, params)
-      @method = method
-      @params = params
-      @message = []
-      validate
-    end
-
-    def is_ok?
-      @status
-    end
-
-    private
-
-    def validate
-      METHOD_PARAMS[@method].each do |param|
-        @message.push("#{param} does not exists, and is mandatory for #{@method} method!") unless param_exists?(param)
-      end
-      generate_status
-    end
-
-    def param_exists?(param)
-      @params.has_key?(param.to_sym)
-    end
-
-    def generate_status
-      @status = @message.empty?
-    end
-
-  end
-end

data/lib/fipextractor/api_response/brand_response_converter.rb

@@ -1,10 +0,0 @@
-module FipeApi
-  class BrandResponseConverter < ResponseConverter
-    
-    CONVERSION_TEMPLATE = {
-      Label: :brand_name,
-      Value: :brand_id
-    }
-
-  end
-end

data/lib/fipextractor/api_response/model_response_converter.rb

@@ -1,45 +0,0 @@
-module FipeApi
-  class ModelResponseConverter < ResponseConverter
-
-    CONVERSION_TEMPLATE = {
-      Label: :model,
-      Value: :model_id
-    }
-
-    YEAR_CONVERSION_TEMPLATE = {
-      Label: :year,
-      Value: :year_fuel
-    }
-
-    def convert
-      converted_hash_collection = {}
-      converted_hash_collection[:models] = convert_by_object_type(@fipe_response['Modelos'])
-      converted_hash_collection[:year] = convert_fuel_collection(@fipe_response['Anos'])
-      converted_hash_collection
-    end
-
-    private
-
-    def convert_fuel_collection(fipe_fuel_collection)
-      converted_collection = []
-      fipe_fuel_collection.each do |item|
-        converted_collection.push(convert_by_fuel_pattern(item))
-      end
-      converted_collection
-    end
-
-    def convert_by_fuel_pattern(fipe_fuel_response)
-      converted_item = {}
-      fipe_fuel_response.each do |parameter, value|
-        converted_item[:fuel_type_id] = extract_fuel_id(value) if (parameter.to_sym == :Value)
-        converted_item[YEAR_CONVERSION_TEMPLATE[parameter.to_sym]] = value
-      end
-      converted_item
-    end
-
-    def extract_fuel_id(fuel_item)
-      fuel_item.split('-').last
-    end
-
-  end
-end

data/lib/fipextractor/api_response/model_through_year_response_converter.rb

@@ -1,10 +0,0 @@
-module FipeApi
-  class ModelThroughYearResponseConverter < ResponseConverter
-
-    CONVERSION_TEMPLATE = {
-      Label: :model,
-      Value: :model_id
-    }
-
-  end
-end

data/lib/fipextractor/api_response/response_converter.rb

@@ -1,60 +0,0 @@
-module FipeApi
-  class ResponseConverter
-
-    CONVERSION_TEMPLATE = {
-      Codigo: :reference_table_id,
-      Mes: :reference_table_month,
-      Label: :label,
-      Value: :value_id,
-      Valor: :cost ,
-      Marca: :brand,
-      Modelo: :model,
-      AnoModelo: :model_year,
-      Combustivel: :fuel,
-      CodigoFipe: :fipe_id,
-      MesReferencia: :reference_month,
-      Autenticacao: :authentication_hash,
-      TipoVeiculo: :vehicle_type,
-      SiglaCombustivel: :fuel_symbol,
-      DataConsulta: :query_date,
-      codigo: :request_fipe_code,
-      erro: :fipe_error_message
-    }
-
-    def initialize(method, fipe_response)
-      @method = method
-      @fipe_response = fipe_response
-    end
-
-    def convert
-      convert_by_object_type(@fipe_response)
-    end
-
-    private
-
-    def convert_by_object_type(response_object)
-      if response_object.is_a?(Array)
-        collection_of_items(response_object)
-      else
-        convert_item(response_object)
-      end
-    end
-
-    def convert_item(item)
-      converted_item = {}
-      item.each do |parameter, value|
-        converted_item[self.class::CONVERSION_TEMPLATE[parameter.to_sym]] = value
-      end
-      converted_item
-    end
-
-    def collection_of_items(response_collection)
-      converted_collection = []
-      response_collection.each do |item|
-        converted_collection.push(convert_item(item))
-      end
-      converted_collection
-    end
-
-  end
-end

data/lib/fipextractor/api_response/response_converter_builder.rb

@@ -1,22 +0,0 @@
-module FipeApi
-  require_relative 'response_converter'
-  require_relative 'brand_response_converter'
-  require_relative 'model_response_converter'
-  require_relative 'model_through_year_response_converter'
-  class ResponseConverterBuilder
-
-    def self.build(method, fipe_response)
-      case(method)
-      when :brand
-        FipeApi::BrandResponseConverter.new(method, fipe_response)
-      when :model
-        FipeApi::ModelResponseConverter.new(method, fipe_response)
-      when :model_through_year
-        FipeApi::ModelThroughYearResponseConverter.new(method, fipe_response)
-      else
-        FipeApi::ResponseConverter.new(method, fipe_response)
-      end
-    end
-
-  end
-end

data/lib/fipextractor/fipe_api/api_factory.rb

@@ -1,12 +0,0 @@
-module FipeApi
-  require_relative 'api_requester'
-  require_relative 'api_response'
-
-  class ApiFactory
-
-    def self.create_requester(method, params = {})
-      ApiRequester.new(method, params)
-    end
-
-  end
-end

data/lib/fipextractor/fipe_api/api_requester.rb

@@ -1,49 +0,0 @@
-require 'unirest'
-require 'net/http'
-require 'json'
-
-module FipeApi
-  class ApiRequester
-
-    API_METHOD = {
-      reference_table:     "/ConsultarTabelaDeReferencia",
-      brand:               "/ConsultarMarcas",
-      model:               "/ConsultarModelos",
-      model_year:          "/ConsultarAnoModelo",
-      model_through_year:  "/ConsultarModelosAtravesDoAno",
-      full:                "/ConsultarValorComTodosParametros" }
-
-    FIPE_URL = "http://veiculos.fipe.org.br"
-    FIPE_API = "/api/veiculos"
-
-    def initialize(method, parameters)
-      @method = method
-      @parameters = parameters
-    end
-
-    def send
-      response = Unirest.post(api_request_url, headers: configure_header, parameters: @parameters)
-      FipeApi::ApiResponse.new(@method, response.body)
-    end
-
-    private
-
-    def api_request_url
-      "#{FIPE_URL + FIPE_API + API_METHOD[@method]}"
-    end
-
-    def configure_header
-      { 'Host'              => FIPE_URL.gsub("http://", ""),
-        'User-Agent'        => 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:41.0) Gecko/20100101 Firefox/41.0',
-        'Accept'            => 'application/json, text/javascript, */*; q=0.01',
-        'Accept-Language'   => 'pt-BR,pt;q=0.8,en-US;q=0.5,en;q=0.3',
-        'Accept-Encoding'   => 'gzip, deflate',
-        'Content-Type'      => 'text/plain; charset=UTF-8',
-        'X-Requested-With'  => 'XMLHttpRequest',
-        'Pragma'            => 'no-cache',
-        'Cache-Control'     => 'max-age=0',
-        'Referer'           => "#{FIPE_URL}/",
-        'Connection'        => 'keep-alive' }
-    end
-  end
-end

data/lib/fipextractor/fipe_api/api_response.rb

@@ -1,23 +0,0 @@
-module FipeApi
-  class ApiResponse
-
-    attr_reader :response
-
-    def initialize(method, response)
-      @method = method
-      @response = convert_response_receipt(response)
-    end
-
-    def valid_response?
-      !@response.has_key?(:fipe_error_message)
-    end
-
-    private
-
-    def convert_response_receipt(response)
-      converter = FipeApi::ResponseConverterBuilder.build(@method, response)
-      converter.convert
-    end
-
-  end
-end

data/test/parameter_converter_spec.rb

@@ -1,23 +0,0 @@
-require 'minitest/autorun'
-require_relative '../lib/fipextractor/api_parameter/parameter_converter'
-
-describe FipeApi::ParameterConverter do
-
-  it "should parameters of full method would be converted" do
-    parameters = { reference_table_id: 189, vehicle_type: 1, brand_id: 3, model_id: 7, model_year: "1999", year: "1999", fuel_type_id: 1 }
-    FipeApi::ParameterConverter.to_fipe_pattern(parameters).must_equal({
-      codigoTabelaReferencia: 189,
-      codigoTipoVeiculo: 1,
-      codigoMarca: 3,
-      codigoModelo: 7,
-      anoModelo: "1999",
-      ano: "1999",
-      codigoTipoCombustivel: 1 })
-  end
-
-  it "should vehicle_type :car converted to value 1" do
-    FipeApi::ParameterConverter.vehicle_type_to_id(:car).must_equal 1
-  end
-
-
-end

data/test/parameter_validator_spec.rb

@@ -1,67 +0,0 @@
-require 'minitest/autorun'
-require_relative '../lib/fipextractor/api_parameter/parameter_validator'
-
-describe FipeApi::ParameterValidator do
-
-  it "should reference_table pass through validation" do
-    validator = FipeApi::ParameterValidator.new(:reference_table, {})
-    validator.is_ok?.must_equal true
-  end
-
-  it "should have valid parameters for brand method" do
-    validator = FipeApi::ParameterValidator.new(:brand, {reference_table_id: 189, vehicle_type: :truck})
-    validator.is_ok?.must_equal true
-  end
-
-  it "should have invalid parameters for brand method" do
-    validator = FipeApi::ParameterValidator.new(:brand, {reference_table_id: 189})
-    validator.is_ok?.must_equal false
-  end
-
-  it "should have valid parameters for model method" do
-    validator = FipeApi::ParameterValidator.new(:model, {reference_table_id: 189, vehicle_type: :truck, brand_id: 102})
-    validator.is_ok?.must_equal true
-  end
-
-  it "should have invalid parameters for model method" do
-    validator = FipeApi::ParameterValidator.new(:model, {reference_table_id: 189, vehicle_type: :truck})
-    validator.is_ok?.must_equal false
-  end
-
-  it "should have valid parameters for model_year method" do
-    validator = FipeApi::ParameterValidator.new(:model_year, {reference_table_id: 189, vehicle_type: :truck, brand_id: 102, model_id: 6704})
-    validator.is_ok?.must_equal true
-  end
-
-  it "should have invalid parameters for model_year method" do
-    validator = FipeApi::ParameterValidator.new(:model_year, {reference_table_id: 189, vehicle_type: :truck, brand_id: 102})
-    validator.is_ok?.must_equal false
-  end
-
-  it "should have valid parameters for model_through_year method" do
-    validator = FipeApi::ParameterValidator.new(:model_through_year, {reference_table_id: 205, vehicle_type: :car, brand_id: 3, model_id: 7, year: '1997-1', model_year: '1997', fuel_type_id: 1})
-    validator.is_ok?.must_equal true
-  end
-
-  it "should have invalid parameters for model_through_year method" do
-    validator = FipeApi::ParameterValidator.new(:model_through_year, {reference_table_id: 205, vehicle_type: :car, brand_id: 3, model_id: 7, year: '1997-1'})
-    validator.is_ok?.must_equal false
-  end
-
-  it "should have valid parameters for full method" do
-    validator = FipeApi::ParameterValidator.new(:full, {reference_table_id: 189, vehicle_type: :car, brand_id: 3, model_id: 7, model_year: "1999", year: "1999", fuel_type_id: 1})
-    validator.is_ok?.must_equal true
-  end
-
-  it "should have invalid parameters for full method" do
-    validator = FipeApi::ParameterValidator.new(:full, {reference_table_id: 189, vehicle_type: :car, brand_id: 3, model_id: 7, model_year: "1999", year: "1999"})
-    validator.is_ok?.must_equal false
-  end
-
-  it "should have invalid parameters reports with a array of messages" do
-    validator = FipeApi::ParameterValidator.new(:model_through_year, {reference_table_id: 205, vehicle_type: :car, brand_id: 3, model_id: 7, year: '1997-1'})
-    validator.message.must_equal ["model_year does not exists, and is mandatory for model_through_year method!", "fuel_type_id does not exists, and is mandatory for model_through_year method!"]
-  end
-
-
-end

data/test/response_converter_spec.rb

@@ -1,35 +0,0 @@
-require 'minitest/autorun'
-require_relative '../lib/fipextractor/api_response/response_converter_builder'
-
-describe FipeApi::ResponseConverter do
-
-  it "should response of full method converted to application pattern" do
-    response ={
-      "Valor"=>"R$ 15.577,00",
-      "Marca"=>"Alfa Romeo",
-      "Modelo"=>"145 Quadrifoglio 2.0",
-      "AnoModelo"=>1999,
-      "Combustivel"=>"Gasolina",
-      "CodigoFipe"=>"006002-0",
-      "MesReferencia"=>"março de 2016 ",
-      "Autenticacao"=>"fictional_hash",
-      "TipoVeiculo"=>1,
-      "SiglaCombustivel"=>"G",
-      "DataConsulta"=>"quarta-feira, 22 de fevereiro de 2017 22:35" }
-    converter = FipeApi::ResponseConverterBuilder.build(:full, response)
-    converter.convert.must_equal({
-      cost: "R$ 15.577,00",
-      brand: "Alfa Romeo",
-      model: "145 Quadrifoglio 2.0",
-      model_year: 1999,
-      fuel: "Gasolina",
-      fipe_id: "006002-0",
-      reference_month: "março de 2016 ",
-      authentication_hash: "fictional_hash",
-      vehicle_type: 1,
-      fuel_symbol: "G",
-      query_date: "quarta-feira, 22 de fevereiro de 2017 22:35" })
-  end
-
-
-end