gassy 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.2 
+  - 1.9.3
+  - rbx-19mode
+  - jruby-19mode
+before_script:
+  - gem install nokogiri
+  - gem install rspec
+script: rake spec

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in gassy.gemspec
+gemspec
+
+gem 'rspec'
+gem 'nokogiri'

data/README.rdoc

@@ -0,0 +1,68 @@
+
+= Gassy {<img src="https://secure.travis-ci.org/bballer320xu/Gassy.png?branch=master&rvm=1.9.3" alt="Build Status" />}[http://travis-ci.org/bballer320xu/Gassy]
+
+* https://github.com/bballer320xu/Gassy
+
+== DESCRIPTION:
+
+Gassy is a simple gem that processes Gas price data publicly available on the U.S. Energy Information Administration website. 
+
+== FEATURES:
+
+* Quick Gas Price lookup for Major Cities, States, and Regions
+* Extracts live data from the U.S. Energy Information Administration website
+
+== SYNOPSIS:
+
+  # First Initiate Gassy
+  require 'gassy'
+
+
+  # Then get lots of data & process it.
+  Gassy.get_all_price_data.each_pair do |entity, sub_entities|
+    puts "processing #{entity}"
+    sub_entities.each_pair do |sub_entity, price|
+      puts "The gas price in #{sub_entity} is #{price}."
+    end
+  end
+
+
+  #Or get a specific piece of data	
+  price = Gassy.extract_one_price("Boston")
+  puts "The gas price in Boston is #{price}."
+	
+	
+== REQUIREMENTS:
+
+* ruby 1.9
+
+== INSTALL:
+
+* sudo gem install gassy
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 - 2012:
+
+* {Matt Lucas}[https://github.com/bballer320xu]
+
+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/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/gassy.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "gassy/version"
+
+Gem::Specification.new do |s|
+  s.name        = "gassy"
+  s.version     = Gassy::VERSION
+  s.authors     = ["Matt Lucas"]
+  s.email       = ["matt.k.lucas@gmail.com"]
+  s.summary     = %q{Gas Price Retrieval Gem}
+  s.description = %q{This gem will gather weekly gas prices from the U.S. Energy Information Information site}
+  s.homepage    = "https://github.com/bballer320xu/Gassy"
+
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "nokogiri"
+
+end

data/lib/gassy.rb

@@ -0,0 +1,118 @@
+require "open-uri"
+require "gassy/gassy_utils"
+require "gassy/gassy_constants"
+
+
+# Gassy is a simple gem that processes Gas price data publicly available on the U.S. Energy Information Administration website. 
+# 
+# Features:
+# * Quick Gas Price lookup for Major Cities, States, and Regions
+# * Extracts live data from the U.S. Energy Information Administration website
+#
+module Gassy
+  
+  @file = nil
+  
+  class << self
+    attr_reader :file
+  
+  
+  
+    # Get all Price Data and return it as a nested hash
+    #
+    # Example:
+    #   >> price_hash = gassy.get_all_price_data
+    #
+    def get_all_price_data
+      @data = {:cities => {}, :states => {}, :regions => {}}
+      @data.each_key do |key|
+        GassyUtils.send("#{key}").each do |entity|
+          @data[key][entity] = extract_one_price(entity)
+        end
+      end
+      @data
+    end
+
+
+
+    # Get one Price for an entity and return it as a Float.  Return nil if the entity is not found
+    #
+    # Example:
+    #   >> boston_price = gassy.extract_one_price("Boston")
+    #
+    # * +entity+ - An entity to look up a price for.  Can be a city, state, or region.
+    #  
+    def extract_one_price(entity)
+      init_file
+      condensed = GassyUtils.condense_xml(@file)
+      remove_diesel = condensed.match(/.*On-Highway/).to_s
+      listing = remove_diesel.match(/\d*.\d*\D*#{entity.gsub(/\s+/, "")}(&lt;)/).to_s
+      price = listing.match(/\d*.\d*/).to_s.to_f  
+    end
+   
+   
+    
+    # This will force the cached datafile to be refreshed with new data from the website.  
+    #
+    # Example:
+    #   >> Gassy.refresh_datafile
+    #
+    def refresh_datafile
+      init_file(true)
+    end
+    
+    
+    
+    # This will force the cached datafile to be refreshed with a locally provided file.
+    #
+    # Example:
+    #   >> Gassy.load_datafile
+    #
+    # * +file_path+ - The path to the file to process
+    #
+    def load_datafile(file_path)
+        init_file(true, file_path)
+    end
+    
+    
+    
+    private
+    
+    
+    
+    # 
+    # Method to initialize or retrieved the data file.
+    #
+    def init_file(refresh = false, file = nil)
+      if (@file.nil? || refresh == true)
+        unless !file.nil?
+          file = GassyConstants::SOURCE_FILE
+        end     
+        @file = GassyUtils.rename(open(file).read, "West Coast less California", "North West Coast") 
+        if @file.nil?
+          raise IOError, "A source file could not be read at #{file}" 
+        end
+      else
+        @file
+      end
+    end
+  end
+
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

data/lib/gassy/gassy_constants.rb

@@ -0,0 +1,39 @@
+module Gassy
+  module GassyConstants
+
+    SOURCE_FILE = 'http://www.eia.gov/petroleum/gasdiesel/includes/gas_diesel_rss.xml'
+  
+    ENTITIES = ["cities", "regions", "states"]
+  
+    CITIES = ["Boston",
+              "Chicago",
+              "Cleveland",
+              "Denver",
+              "Houston",
+              "Los Angeles",
+              "Miami",
+              "New York City",
+              "San Francisco",
+              "Seattle"]
+
+    REGIONS = ["U.S.","East Coast", 
+                "New England", 
+                "Central Atlantic", 
+                "Lower Atlantic",
+                "Midwest",
+                "Gulf Coast",
+                "Rocky Mountain",
+                "West Coast",
+                "North West Coast"]
+
+    STATES = ["California",
+              "Colorado", 
+              "Florida", 
+              "Massachusetts", 
+              "Minnesota",
+              "New York",
+              "Ohio",
+              "Texas",
+              "Washington"]
+  end
+end

data/lib/gassy/gassy_utils.rb

@@ -0,0 +1,39 @@
+#
+# Utility classes used by GassyUtils
+#
+module Gassy
+  module GassyUtils
+
+    # Condense the provided XML file by removing all spaces and new lines
+    #
+    # Example:
+    #   >> condensed = GassyUtils.condense_xml(file)
+    #
+    def self.condense_xml(file)
+      file = file.gsub(/\r/,"")
+      file = file.gsub(/\n/,"")
+      file = file.gsub(/\t/,"")
+      file = file.gsub(/\s+/,"")
+    end
+  
+    # Simple string substitution method alias 
+    #
+    # Example:
+    #   >> file_with_renamed_entry = GassyUtils.rename(file, "Joe", "Sam")
+    #
+    def self.rename(file, old_name, new_name)
+      file.sub(old_name, new_name)  
+    end
+
+    # Automatically generate methods that returns data for the Entities listed in the Gassy::GassyConstants::ENTITIES array. 
+    #
+    # Example:
+    #   >> array_of_city_names = GassyUtils.cities
+    #
+    def self.method_missing(name, *args)
+      super unless GassyConstants::ENTITIES.include?(name.to_s)
+        eval("GassyConstants::#{name.upcase}")
+    end
+  
+  end
+end

data/lib/gassy/version.rb

@@ -0,0 +1,3 @@
+module Gassy
+  VERSION = "1.0.0"
+end

data/spec/gassy_data_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe "The Gassy main class" do
+  
+  describe "should have a method 'get_all_price_data'" do
+    it "that returns a proper hash" do
+      Gassy.get_all_price_data.should be_an_instance_of(Hash)
+    end
+  end
+  
+  describe "should have a method 'extract_one_price'" do
+    it "that returns a proper Float value for a correct entity" do
+      Gassy.extract_one_price("Boston").should be_an_instance_of(Float)
+    end
+    
+    it "that returns nil for an incorrect entity" do
+      Gassy.extract_one_price("Ottawa").should be_an_instance_of(Float)
+    end
+  end
+end
+
+
+describe "The Gassy Utils class" do
+  describe "should have a method to return all vaild cities" do
+    it "as an array" do
+      Gassy::GassyUtils.cities.should be_an_instance_of(Array)
+    end
+  end
+  describe "should have a method to return all vaild states" do
+    it "as an array" do
+      Gassy::GassyUtils.states.should be_an_instance_of(Array)
+    end
+  end
+  describe "should have a method to return all vaild regions" do
+    it "as an array" do
+      Gassy::GassyUtils.regions.should be_an_instance_of(Array)
+    end
+  end
+  describe "should handle invalid method names" do
+    it "by raising an error" do
+       proc{Gassy.garbagemethod}.should raise_error
+    end
+  end
+end
+
+

data/spec/gassy_xml_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe "The XML Gasoline Data File" do
+  before(:all) do
+    #Compress the XML file for simplified regex processing
+    @compressed_file = Gassy::GassyUtils.condense_xml(Gassy.file)
+  end
+  
+  it "should return a vaild XML file for processing" do
+    parsed_doc = Nokogiri::XML(Gassy.file) do |config| 
+      config.options = Nokogiri::XML::ParseOptions::STRICT 
+    end
+    parsed_doc.errors.count.should eq(0)
+  end
+  
+  
+  describe "will contain cities" do
+    Gassy::GassyConstants::CITIES.each do |city|
+      it "and should contain the city of '#{city}'" do 
+        @compressed_file.scan(/Cities.*#{city.gsub(/\s+/, "")}/).should_not be_empty 
+      end
+    
+      it "and should extract a gas price for the city of '#{city}' as a float" do 
+        Gassy.extract_one_price(city).should be_an_instance_of(Float)
+      end
+    
+      it "and should extract a gas price for the city of '#{city}' greater than 0" do 
+        Gassy.extract_one_price(city).should be > 0
+      end
+    end
+  end
+  
+  describe "will contain states" do
+    Gassy::GassyConstants::STATES.each do |state|
+      it "and should contain the state of '#{state}'" do 
+        @compressed_file.scan(/States.*#{state.gsub(/\s+/, "")}/).should_not be_empty 
+      end
+    
+      it "and should extract a gas price for the state of '#{state}' as a float" do 
+        Gassy.extract_one_price(state).should be_an_instance_of(Float)
+      end
+    
+      it "and should extract a gas price for the state of '#{state}' greater than 0" do 
+        Gassy.extract_one_price(state).should be > 0
+      end
+    end
+  end
+  
+  describe "will contain regions" do
+    Gassy::GassyConstants::REGIONS.each do |region|
+      it "and should contain the region of '#{region}'" do 
+        @compressed_file.scan(/RegularGasolineRetailPrice.*#{region.gsub(/\s+/, "")}/).should_not be_empty 
+      end
+    
+      it "and should extract a gas price for the region of '#{region}' as a float" do 
+        Gassy.extract_one_price(region).should be_an_instance_of(Float)
+      end
+    
+      it "and should extract a gas price for the region of '#{region}' greater than 0" do 
+        Gassy.extract_one_price(region).should be > 0
+      end
+    end
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require "nokogiri"
+require 'gassy'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: gassy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Matt Lucas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70197516102840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70197516102840
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70197516101880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70197516101880
+description: This gem will gather weekly gas prices from the U.S. Energy Information
+  Information site
+email:
+- matt.k.lucas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.rdoc
+- Rakefile
+- gassy.gemspec
+- lib/.DS_Store
+- lib/gassy.rb
+- lib/gassy/gassy_constants.rb
+- lib/gassy/gassy_utils.rb
+- lib/gassy/version.rb
+- spec/gassy_data_spec.rb
+- spec/gassy_xml_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bballer320xu/Gassy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Gas Price Retrieval Gem
+test_files:
+- spec/gassy_data_spec.rb
+- spec/gassy_xml_spec.rb
+- spec/spec_helper.rb