mygasfeed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e7c7a4d2b39c6a40877903f33ef998828ae5a10
+  data.tar.gz: 43c5b35f9126d73c4d4c6c0e98641ad0f22f65ae
+SHA512:
+  metadata.gz: b1cd6e01c95e4278e076e63fb04393abd1489a54bfffe03c11091e6cc2951e1ea9fee9933e8cb6ad860406550dfe44a7885d920229f04dbd51536545573d2937
+  data.tar.gz: fa5a0b75c835a9b1bbbd2029d2b1febb0e58c604f0e1f5e77c31d929ed6c0afd94a3ac215f3ac764f3bfd9cb1861e4f13ab03915fb8a7420e8f39f3c4442ab39

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mygasfeed.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Mason Wiley
+
+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

@@ -0,0 +1,80 @@
+# Mygasfeed
+
+Ruby API client for [www.mygasfeed.org](http://www.mygasfeed.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mygasfeed'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mygasfeed
+
+## Obtaining an API Key
+
+You need to get an API key from [here](http://www.mygasfeed.com/keys/submit).
+
+You can use it by setting an environment variable from the command line
+
+    export MYGASFEED_API_KEY=your_api_key
+
+Use it when running `rails s`
+
+    MYGASFEED_API_KEY=your_api_key rails s
+
+Or store it in a `.env` file and either use [Foreman](https://github.com/ddollar/foreman) or the [dotenv](https://github.com/bkeepers/dotenv) gem.
+
+    MYGASFEED_API_KEY=your_api_key
+
+## Usage
+
+### Get nearby stations
+**Params:** latitude, longitude, distance, fuel_type, sort_by
+
+    Mygasfeed.get_stations 39.7400, -121.8356, 50, "reg", "distance"
+
+### Get price history for a station
+**Params:** station_id
+
+    Mygasfeed.get_history 33862
+
+### Get details for a station
+**Params:** station_id
+
+    Mygasfeed.get_details 33862
+
+### Get a list of all gas station brands
+**Params:** none
+
+    Mygasfeed.get_brands
+
+### Update a gas price
+**Params:** price, fuel_type, station_id
+
+    Mygasfeed 4.15, "reg", 33862
+
+### Get an address by latitude and longitude
+**Params:** latitude, longitude
+
+    Mygasfeed.get_adddress 39.7400, -121.8356
+
+### Get stations close by another station
+**Params:** station_id, limit
+
+    Mygasfeed.get_close_by 33862, 50
+
+## Contributing
+
+1. Fork it ( https://github.com/mwiley/mygasfeed/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mygasfeed"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mygasfeed.rb

@@ -0,0 +1,14 @@
+require "mygasfeed/version"
+require "mygasfeed/request"
+Dir[File.dirname(__FILE__) + "/mygasfeed/dsl/*.rb"].each { |f| require f  }
+Dir[File.dirname(__FILE__) + "/mygasfeed/resources/*.rb"].each { |f| require f  }
+
+module Mygasfeed
+
+   API_URL = 'http://api.mygasfeed.com'
+   API_KEY = ENV["MYGASFEED_API_KEY"]
+
+   #API_URL = 'http://devapi.mygasfeed.com/'
+   #API_KEY = 'rfej9napna'
+
+end

data/lib/mygasfeed/dsl/get_address.rb

@@ -0,0 +1,13 @@
+module Mygasfeed
+
+  class << self
+
+    # Providing the latitude & longitude of the current location, you will retrieve the full address.
+    def get_address latitude, longitude
+      response = request('/locations/geoaddress/', [latitude, longitude])
+      Location.build response['location']
+    end
+
+  end
+
+end

data/lib/mygasfeed/dsl/get_brands.rb

@@ -0,0 +1,13 @@
+module Mygasfeed
+
+  class << self
+
+    # Retrieves a list of all gas station brands.
+    def get_brands
+      response = request "/stations/brands/"
+      response['stations'].map { |brand| Brand.build brand }
+    end
+
+  end
+
+end

data/lib/mygasfeed/dsl/get_close_by.rb

@@ -0,0 +1,14 @@
+module Mygasfeed
+
+  class << self
+
+    # Retrieve a list of other gas stations that are close by to a
+    # particular station by just suppling the station id. 
+    def get_close_by station_id, limit
+      response = request '/locations/otherclosebystations/', [station_id, limit]
+      response['stations'].map { |station| Station.build station }
+    end
+
+  end
+
+end

data/lib/mygasfeed/dsl/get_details.rb

@@ -0,0 +1,14 @@
+module Mygasfeed
+
+  class << self
+
+    # Retrieves gas station details by providing the station id.
+    # The station id can be retrieved when making a request for a list of stations.
+    def get_details station_id
+      response = request '/stations/details/', [station_id]
+      Station.build response['details']
+    end
+
+  end
+
+end

data/lib/mygasfeed/dsl/get_history.rb

@@ -0,0 +1,13 @@
+module Mygasfeed
+
+  class << self
+
+    # Retrieves a list of gas price histroy for a particular gas station by id.
+    def get_history station_id
+        response = request '/locations/pricehistory/', [station_id]
+        response['histroy'].map { |price| PreviousPrice.build price }
+    end
+
+  end
+
+end

data/lib/mygasfeed/dsl/get_stations.rb

@@ -0,0 +1,17 @@
+module Mygasfeed
+
+  class << self
+
+    # Retrieves nearby gas stations according to a user's geo location.
+    # `Distance` - a number of miles under 50.
+    # `fuel_type` - reg, mid, pre, or diesel
+    # `sort_by` - distance or price
+    def get_stations latitude, longitude, distance, fuel_type, sort_by
+        params = [latitude, longitude, distance, fuel_type, sort_by]
+        response = request "/stations/radius/", params
+        response['stations'].map { |station| Station.build station }
+    end
+
+  end
+
+end

data/lib/mygasfeed/dsl/update_price.rb

@@ -0,0 +1,15 @@
+module Mygasfeed
+
+  class << self
+
+    # Updates gas prices for a particular station.
+    # `price` - Actual gas price. Format (3.64)
+    # `fuel_type` - reg, mid, pre, or diesel
+    def update_price price, fuel_type, station_id
+      response = post '/locations/price/', body: {price: price, fueltype: fuel_type, stationid: station_id}
+      Station.build response['details']
+    end
+
+  end
+
+end

data/lib/mygasfeed/request.rb

@@ -0,0 +1,25 @@
+require 'httparty'
+require 'addressable/uri'
+
+module Mygasfeed
+
+  class << self
+
+    def request path, params=[]
+      response = HTTParty.get _build_url(path, params)
+      JSON.parse response.body
+    end
+
+    def post path, params={}
+      response = HTTParty.post _build_url(path), params
+      JSON.parse response.body
+    end
+
+    def _build_url path, params=[]
+      uri = API_URL + path
+      params.each { |param| uri = uri + param.to_s + '/' }
+      uri = uri + API_KEY + ".json"
+    end
+
+  end
+end

data/lib/mygasfeed/resources/base_struct.rb

@@ -0,0 +1,28 @@
+module Mygasfeed
+
+    class BaseStruct < Struct
+    class << self
+
+      protected
+
+      def get_i str
+        return nil if str.nil?
+        str.to_i
+      end
+
+      def get_f str
+        return nil if str.nil?
+        str.to_f
+      end
+
+      def get_bool str
+        str == '1'
+      end
+
+      def get_str str
+        str.to_s.strip
+      end
+    end
+  end
+
+end

data/lib/mygasfeed/resources/brand.rb

@@ -0,0 +1,10 @@
+module Mygasfeed
+  Brand = BaseStruct.new :name, :id do
+
+    def self.build raw
+      new get_str(raw["name"]),
+          get_i(raw["id"])
+    end
+
+  end
+end

data/lib/mygasfeed/resources/location.rb

@@ -0,0 +1,20 @@
+module Mygasfeed
+  Location = BaseStruct.new :country_short, :lat, :lng, :country_long,
+                              :region_short, :region_long, :city_long,
+                              :city_short, :address, :result  do
+
+    def self.build raw
+      new get_str(raw["country_short"]),
+          get_f(raw["lat"]),
+          get_f(raw["lng"]),
+          get_str(raw["country_long"]),
+          get_str(raw["region_short"]),
+          get_str(raw["region_long"]),
+          get_str(raw["city_long"]),
+          get_str(raw["city_short"]),
+          get_str(raw["address"]),
+          get_str(raw["result"])
+    end
+
+  end
+end

data/lib/mygasfeed/resources/previous_price.rb

@@ -0,0 +1,12 @@
+module Mygasfeed
+  PreviousPrice = BaseStruct.new :type, :price, :date, :via do
+
+    def self.build raw
+      new get_str(raw["type"]),
+          get_f(raw["price"]),
+          get_str(raw["date"]),
+          get_str(raw["via"])
+    end
+
+  end
+end

data/lib/mygasfeed/resources/station.rb

@@ -0,0 +1,28 @@
+module Mygasfeed
+  Station = BaseStruct.new :country, :reg_price, :mid_price, :pre_price, :diesel_price, :address,
+                           :diesel, :id, :lat, :lng, :station, :region, :city,
+                           :reg_date, :mid_date, :pre_date, :diesel_date, :distance do
+
+    def self.build raw
+      new get_str(raw["country"]),
+          get_f(raw["reg_price"]),
+          get_f(raw["mid_price"]),
+          get_f(raw["pre_price"]),
+          get_f(raw["diesel_price"]),
+          get_str(raw["address"]),
+          get_bool(raw["diesel"]),
+          get_i(raw["id"]),
+          get_f(raw["lat"]),
+          get_f(raw["lng"]),
+          get_str(raw["station"]),
+          get_str(raw["region"]),
+          get_str(raw["city"]),
+          get_str(raw["reg_date"]),
+          get_str(raw["mid_date"]),
+          get_str(raw["pre_date"]),
+          get_str(raw["diesel_date"]),
+          get_str(raw["distance"])
+    end
+
+  end
+end

data/lib/mygasfeed/version.rb

@@ -0,0 +1,3 @@
+module Mygasfeed
+  VERSION = "0.1.0"
+end

data/mygasfeed.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mygasfeed/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mygasfeed"
+  spec.version       = Mygasfeed::VERSION
+  spec.authors       = ["Mason Wiley"]
+  spec.email         = ["masonwiley92@gmail.com"]
+
+  spec.summary       = %q{Ruby API client for www.mygasfeed.org}
+  spec.description   = %q{Provides a Ruby gem wrapper for MyGasFeed API.}
+  spec.homepage      = "https://github.com/mwiley/mygasfeed"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'addressable'
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: mygasfeed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mason Wiley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a Ruby gem wrapper for MyGasFeed API.
+email:
+- masonwiley92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mygasfeed.rb
+- lib/mygasfeed/dsl/get_address.rb
+- lib/mygasfeed/dsl/get_brands.rb
+- lib/mygasfeed/dsl/get_close_by.rb
+- lib/mygasfeed/dsl/get_details.rb
+- lib/mygasfeed/dsl/get_history.rb
+- lib/mygasfeed/dsl/get_stations.rb
+- lib/mygasfeed/dsl/update_price.rb
+- lib/mygasfeed/request.rb
+- lib/mygasfeed/resources/base_struct.rb
+- lib/mygasfeed/resources/brand.rb
+- lib/mygasfeed/resources/location.rb
+- lib/mygasfeed/resources/previous_price.rb
+- lib/mygasfeed/resources/station.rb
+- lib/mygasfeed/version.rb
+- mygasfeed.gemspec
+homepage: https://github.com/mwiley/mygasfeed
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby API client for www.mygasfeed.org
+test_files: []