roadtrip 0.0.1 → 0.0.3

data/PostInstall.txt

@@ -1,7 +1,3 @@
-
-For more information on roadtrip, see http://roadtrip.rubyforge.org
-
-NOTE: Change this information in PostInstall.txt 
-You can also delete it if you don't want it.
+For more information on roadtrip, see http://github.com/kenton/roadtrip
 
 

data/README.rdoc

@@ -1,41 +1,50 @@
 = roadtrip
 
-* http://github.com/#{github_username}/#{project_name}
+* http://github.com/kenton/roadtrip
 
 == DESCRIPTION:
 
 This is a quick little gem that uses Google Maps to determine the distance, duration and fuel costs for driving between two user defined points.  Just like Google Maps, the starting and destination points can be full addresses, city/state combinations, or just ZIP codes.  
 
-== FEATURES/PROBLEMS:
+== EXAMPLE USE:
+Assume a user is traveling from ZIP code 30032 to ZIP code 90210, that gas costs $2.75 per gallon and that the car being driven has a fuel economy of 30mpg.  The following would be used to create an instance of a Roadtrip::Trip, labeled "t" in this case:
 
-* Pending
+  t = Roadtrip::Trip.new(30032, 90210, 2.75, 30)
 
-== SYNOPSIS:
+So in general, the user supplies the following parameters:
 
-  t = Trip.new(30032, 90210, 2.75, 30)
+	* Starting Location
+	* Destination
+	* Cost Per Gallon - the cost for a gallon of gas, on average
+	* Miles Per Gallon -  the MPG for your vehicle
 
-The user supplies the following parameters:
+== FEATURES:
 
-Starting Location
-Destination
-Cost Per Gallon - the cost for a gallon of gas, on average
-Miles Per Gallon -  the MPG for your vehicle
-
-Each object has the following methods available:
+Each "RoadTrip::Trip" object has the following methods available:
 
 	t.distance
 	t.duration
 	t.cost
 	t.round_trip_cost
-  
 
+== TESTS:
+This is a brand new gem (and my first), so I'm still working through adding Cucumber/RSpec tests.  For now, this was just a proof of concept so I knew how to create/deploy a gem.  I plan on going back and continuing development of this gem using BDD/TDD.  More to follow...
+  
 == REQUIREMENTS:
+This gem has the following dependencies:
 
-* FIX (list of requirements)
+* rubygems (of course)
+* httparty (http://github.com/jnunemaker/httparty)
 
 == INSTALL:
 
-sudo gem install roadtrip
+(sudo) gem install roadtrip
+
+Then in your ruby code, add:
+require 'rubygems'
+require 'roadtrip'
+
+Note: This gem is hosted at http://www.rubygems.org.  Be sure you have rubygems.org (or gemcutter.org) listed as a gem source on your system...or see the documentation on their site for how to add this as a source.
 
 == LICENSE:
 

data/lib/roadtrip.rb

@@ -7,7 +7,7 @@ require 'pp'
 require 'ap'
 
 module Roadtrip
-  VERSION = '0.0.1'
+  VERSION = '0.0.3'
   
   dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 
@@ -67,57 +67,4 @@ module Roadtrip
    
   end
 
-end
-
-
-  # puts "Enter Starting Address or Location"
-  # start_location = gets
-  # puts "Enter Destination"
-  # end_location = gets
-  # puts "Enter MPG for your vehicle"
-  # mpg = gets.to_f
-  # puts "Enter gas cost per gallon"
-  # gas_price_per_gallon = gets.to_f
-
-    # trip = Trip.get('http://maps.google.com/maps/api/directions/json?',
-    # :query => {
-    #   :origin  => start_location,
-    #   :destination   => end_location,
-    #   :sensor => "false"
-    # })
-
-    # ap trip["routes"][0]["legs"][0]
-
-    # distance = trip["routes"][0]["legs"][0]["distance"]["value"]
-    # miles = distance * 0.000621371192
-    # cost = (gas_price_per_gallon / mpg) * miles
-
-    # puts "\n"
-    # puts "----------------------------------------------------------------------"
-    # puts "Start Address:      #{trip["routes"][0]["legs"][0]["start_address"]}"
-    # puts "End Address:        #{trip["routes"][0]["legs"][0]["end_address"]}"
-    # puts "Distance:           #{trip["routes"][0]["legs"][0]["distance"]["text"]}"
-    # puts "Duration:           #{trip["routes"][0]["legs"][0]["duration"]["text"]}"
-    # puts "Cost (one-way):     $#{cost.to_f.round}"
-    # puts "Cost (round trip):  $#{cost.to_f.round * 2}"
-    # puts "----------------------------------------------------------------------"
-    # puts "\n"
-    
-    
-    
-    # ap distance["routes"][0]["legs"][0]
-    # puts "#{distance["routes"][0]["legs"]["starting_address"]}"
-    # puts "#{distance["routes"][0]["start_address"]}"
-
-
-# * origin (required) — The address or textual latitude/longitude value from which you wish to calculate directions. *
-# * destination (required) — The address or textual latitude/longitude value from which you wish to calculate directions.*
-# * mode (optional, defaults to driving) — specifies what mode of transport to use when calculating directions. Valid values are specified in Travel Modes.
-# * waypoints (optional) specifies an array of waypoints. Waypoints alter a route by routing it through the specified location(s). A waypoint is specified as either a latitude/longitude coordinate or as an address which will be geocoded. (For more information on waypoints, see Using Waypoints in Routes below.)
-# * alternatives (optional), if set to true, specifies that the Directions service may provide more than one route alternative in the response. Note that providing route alternatives may increase the response time from the server.
-# * avoid (optional) indicates that the calculated route(s) should avoid the indicated features. Currently, this parameter supports the following two arguments:
-#       o tolls indicates that the calculated route should avoid toll roads/bridges.
-#       o highways indicates that the calculated route should avoid highways.
-#   (For more information see Route Restrictions below.)
-# * language (optional) — The language in which to return results. See the supported list of domain languages. Note that we often update supported languages so this list may not be exhaustive. If language is not supplied, the Directions service will attempt to use the native language of the browser wherever possible. You may also explicitly bias the results by using localized domains of http://map.google.com. See Region Biasing for more information.
-# * sensor (required) — Indicates whether or not the directions request comes from a device with a location sensor. This value must be either true or false.
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: roadtrip
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Kenton Newby
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-06 00:00:00 -04:00
+date: 2010-07-12 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -92,7 +92,7 @@ files:
 - spec/spec_helper.rb
 - tasks/rspec.rake
 has_rdoc: true
-homepage: http://github.com/#{github_username}/#{project_name}
+homepage: http://github.com/kenton/roadtrip
 licenses: []
 
 post_install_message: PostInstall.txt