Guzzler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f33bba74d4ff58dc087677dc2c09b4398ee665c6cbd9562c429ace61f4f51e9e
+  data.tar.gz: cde3c359fbd25f25448b7c2f1ebca25c24dc121648170b6ad5aa4f5a74e4b6dd
+SHA512:
+  metadata.gz: bb2010b6931b787753e610e6723fac5865a1aaf6e82dd687e3312fcf1f6a1789c2f6c88da76801fdf06a4b5751d22dd67c8b6a7123b6f4ec9869476f29c0a1cd
+  data.tar.gz: e0c3b9c16a15de742c19db9b8fb304a4e7b97da0b2933566cdccd80f6d40b8df5fc1de3622db7f8f9b580573915df3c9d8f7abb2b0d3b9b11cf3fa44b48d8ef8

data/lib/guzzler.rb

@@ -0,0 +1,56 @@
+require_relative 'guzzler/fuel_eco_api'
+
+module Guzzler
+
+  class Vehicle < FuelEcoAPI
+    def initialize(vehicle_code)
+      raise ArgumentError.new("Vehicle code is not a valid vehicle") unless vehicle_code_valid?(vehicle_code)
+      @vehicle_code = vehicle_code
+    end
+
+    def fuel_eco(**args)  
+      valid_arg_options_values = { driving_type: ['city', 'highway', 'combo'],
+                                  unit: ['mpg', 'kpg'],
+                                  round: [true, false] }
+                    
+      args.each do |key, value| # confirms arg options are valid, and values for options are valid
+        unless valid_arg_options_values.keys.include?(key) && valid_arg_options_values[key].include?(value)
+          if !valid_arg_options_values.keys.include?(key)
+            raise ArgumentError.new("#{key} is not a valid argument option, please select from these: #{valid_arg_options_values.keys.join(', ')}.")
+          else
+            valid_value_class = valid_arg_options_values[key].map(&:class).uniq
+            raise ArgumentError.new("#{value} is not a valid value for #{key}. 
+            Please select from #{valid_arg_options_values[key].join(', ')} (#{valid_value_class.join(',')}).")
+          end
+        end
+      end
+
+      driving_type = args[:driving_type] ||= 'combo'
+      unit = args[:unit] ||= 'mpg'
+      round =  args[:round] == nil ? true : args[:round]
+      
+      fuel_economy = get_fuel_economy(driving_type).to_f
+
+      if unit.downcase == 'kpg'
+        fuel_economy = convert_mpg_to_kpg(fuel_economy) 
+      end
+
+      round ? fuel_economy.round(1).to_s : fuel_economy.to_s
+    end
+
+    private
+
+    def vehicle_code_valid?(vehicle_code)
+      FuelEcoAPI.verify_vehicle_code(vehicle_code)
+    end
+
+    def get_fuel_economy(driving_type)
+      FuelEcoAPI.fetch_fuel_economy(@vehicle_code , driving_type)
+    end
+
+    def convert_mpg_to_kpg(mpg)
+      mpg * 1.609
+    end
+  end
+
+end

data/lib/guzzler/fuel_eco_api.rb

@@ -0,0 +1,76 @@
+require 'uri'
+require 'net/http'
+require 'openssl'
+require 'json'
+require 'crack'
+require 'resolv-replace'
+
+class FuelEcoAPI
+  def self.years
+    url = URI('https://www.fueleconomy.gov/ws/rest/vehicle/menu/year')
+    data_response = http_response(url)
+
+    #[{"text"=>"2022", "value"=>"2022"}] -> ["2022"]
+    year_make_model_options_values(data_response)
+  end
+
+  def self.makes(year)
+    url = URI("https://www.fueleconomy.gov/ws/rest/vehicle/menu/make?year=#{year}")
+    data_response = http_response(url)
+
+    # [{"text"=>"Acura", "value"=>"Acura"}] -> ["Acura"]
+    year_make_model_options_values(data_response)
+  end
+
+  def self.models(year, make)
+    url = URI("https://www.fueleconomy.gov/ws/rest/vehicle/menu/model?year=#{year}&make=#{make}")
+    data_response = http_response(url)
+
+    # [{"text"=>"Avalon", "value"=>"Avalon"}] -> ["Avalon"]
+    year_make_model_options_values(data_response)
+  end
+
+  def self.vehicle_options(year, make, model)
+    url = URI("https://www.fueleconomy.gov/ws/rest/vehicle/menu/options?year=#{year}&make=#{make}&model=#{model}")
+    data_response = http_response(url)
+
+    data_response['menuItems']['menuItem']
+  end
+
+  def self.fetch_vehicle(vehicle_code)
+    url = URI("https://www.fueleconomy.gov/ws/rest/vehicle/#{vehicle_code}")
+    data_response = http_response(url)
+  end
+
+  def self.verify_vehicle_code(vehicle_code)
+    fetch_vehicle(vehicle_code).has_key?('vehicle')
+  end
+
+  def self.fetch_fuel_economy(vehicle_code, driving_type)
+    driving_type_converter = {'city' => 'city08U', 'highway' => 'highway08', 'combo' => 'comb08' }
+    driving_type = driving_type_converter[driving_type]
+
+    data_response = fetch_vehicle(vehicle_code)
+
+    data_response['vehicle'][driving_type]
+  end
+
+  private
+
+  def self.http_response(url)
+    http = Net::HTTP.new(url.host, url.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    request = Net::HTTP::Get.new(url)
+    @response = http.request(request)
+    Crack::XML.parse(@response.read_body)
+  end
+
+  def self.year_make_model_options_values(hash)
+    if hash['menuItems']['menuItem'].is_a?(Array)
+      hash['menuItems']['menuItem'].map {|hash| hash['value']}
+    else
+      [hash['menuItems']['menuItem']['value']]
+    end
+  end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: Guzzler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Salazar
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-08 00:00:00.000000000 Z
+dependencies: []
+description: A ruby gem to retrieve Fuel Economy information for vehicle from the
+  FuelEconomy.gov API.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/guzzler.rb
+- lib/guzzler/fuel_eco_api.rb
+homepage: https://rubygems.org/gems/guzzler
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/CsalazarGH/Guzzler
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Access info from https://www.fueleconomy.gov/ API
+test_files: []