flightcaster 0.1.1 → 0.2.0

data/README.md

@@ -0,0 +1,44 @@
+FlightCaster
+============
+
+The [FlightCaster](http://flightcaster.com) ruby gem. Get started by [signing up for a free API
+key](http://docs.flightcaster.com/).
+
+## Examples
+
+    # load your API key
+    flightcaster = FlightCaster.new('api_key')
+
+    # retrieve all flights
+    flights = flightcaster.flights
+
+    # get flights by airline and flight number
+    flight = flightcaster.flights_by_airline('VX', 28)
+
+See more in the [examples
+directory](http://github.com/jarodluebbert/flightcaster/tree/master/examples/).
+
+## Docs
+
+[View the
+documentation](http://rdoc.info/projects/jarodluebbert/flightcaster).
+
+### todo
+
+* Load API key from config file
+* Authenticate with user/pass
+
+### Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+### Copyright
+
+Copyright (c) 2010 Jarod Luebbert. See LICENSE for details.
+

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/flightcaster.gemspec

@@ -5,31 +5,31 @@
 
 Gem::Specification.new do |s|
   s.name = %q{flightcaster}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jarod Luebbert"]
-  s.date = %q{2010-02-26}
+  s.date = %q{2010-03-01}
   s.description = %q{Simple interaction with the flightcaster API. Look up
     flight predictions and information.}
   s.email = %q{jarod.luebbert@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.md"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.md",
      "Rakefile",
      "VERSION",
      "examples/flights.rb",
      "flightcaster.gemspec",
      "lib/flightcaster.rb",
      "lib/flightcaster/base.rb",
+     "lib/flightcaster/rash.rb",
      "lib/flightcaster/request.rb",
-     "lib/flightcaster/result.rb",
      "test/fixtures/airline.xml",
      "test/fixtures/airline_flight.xml",
      "test/fixtures/airline_flights.xml",
@@ -60,7 +60,8 @@ Gem::Specification.new do |s|
      "test/helper.rb",
      "test/test_base.rb",
      "test/test_flightcaster.rb",
-     "test/test_request.rb"
+     "test/test_request.rb",
+     "test/test_result.rb"
   ]
   s.homepage = %q{http://github.com/jarodluebbert/flightcaster}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -72,6 +73,7 @@ Gem::Specification.new do |s|
      "test/test_base.rb",
      "test/test_flightcaster.rb",
      "test/test_request.rb",
+     "test/test_result.rb",
      "examples/flights.rb"
   ]
 
@@ -80,14 +82,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 2.10.2"])
       s.add_development_dependency(%q<shoulda>, [">= 2.10.2"])
       s.add_development_dependency(%q<mhennemeyer-matchy>, [">= 0.3.3"])
       s.add_development_dependency(%q<fakeweb>, [">= 1.2.8"])
       s.add_runtime_dependency(%q<httparty>, [">= 0.5.2"])
       s.add_runtime_dependency(%q<hashie>, [">= 0.1.8"])
     else
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 2.10.2"])
       s.add_dependency(%q<shoulda>, [">= 2.10.2"])
       s.add_dependency(%q<mhennemeyer-matchy>, [">= 0.3.3"])
       s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
@@ -95,7 +97,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<hashie>, [">= 0.1.8"])
     end
   else
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 2.10.2"])
     s.add_dependency(%q<shoulda>, [">= 2.10.2"])
     s.add_dependency(%q<mhennemeyer-matchy>, [">= 0.3.3"])
     s.add_dependency(%q<fakeweb>, [">= 1.2.8"])

data/lib/flightcaster.rb

@@ -1,12 +1,10 @@
 require 'forwardable'
-gem 'httparty', '~> 0.5.2'
 require 'httparty'
-gem 'hashie', '~> 0.1.8'
 require 'hashie'
 
 [ "base",
   "request",
-  "result" ].each do |file|
+  "rash" ].each do |file|
   require File.join(File.dirname(__FILE__), 'flightcaster', file)
 end
 

data/lib/flightcaster/base.rb

@@ -22,7 +22,7 @@ module FlightCaster
       perform_get("/airlines/#{id}.xml")
     end
 
-    # Params
+    # params
     #   :per_page => The number of results per page. Defaults to 30.
     #   :page => The page of results displayed.
     def airports(params={})
@@ -61,87 +61,135 @@ module FlightCaster
       perform_get("/flights/#{id}.xml")
     end
 
-    # Get all flights for a sepcific airline on a given date.
-    def flights_by_airline_on(airline_id, flight_number, date, params={})
-      t = convert_date(date)
-      perform_get("/airlines/#{airline_id}/flights/#{flight_number}/#{t}.xml", params)
-    end
-
-    # Get all flights from one airport to another.
-    def flight_path(from, to, params={})
-      perform_get("/airports/#{from}/departures/#{to}.xml", params)
-    end
-
-    # Get all flights from one airport to another on a given date.
-    def flight_path_on(from, to, date, params={})
-      t = convert_date(date)
-      perform_get("/airports/#{from}/departures/#{to}/#{t}.xml", params)
-    end
-
+    # params
+    #   :per_page => The number of results per page. Defaults to 30.
+    #   :page => The page of results displayed.
     def flights(params={})
       perform_get('/flights.xml', params)
     end
 
-    def flights_by_airline(id, params={})
-      perform_get("/airlines/#{id}/flights.xml", params)
-    end
-
-    def flight_by_airline(airline_id, flight_number, params={})
-      perform_get("/airlines/#{airline_id}/flights/#{flight_number}.xml", params)
-    end
-
+    # airline_id
+    # flight_number
+    # date
+    #   A Ruby Time object
+    #   or a date in the format 'yearmonthday' (ex: 20100226)
+    # params
+    #   :per_page => The number of results per page. Defaults to 30.
+    #   :page => The page of results displayed.
+    def flights_by_airline(airline_id, flight_number=nil, date=nil, params={})
+      args = [airline_id, 'flights', flight_number, format(date)].compact.join('/')
+      perform_get("/airlines/#{args}.xml", params)
+    end
+
+    # origin
+    #   The FlightCaster id of the airport
+    #   The 3 character airport IATA id
+    #   The 4 character airport ICAO id
+    # destination
+    #   The FlightCaster id of the airport
+    #   The 3 character airport IATA id
+    #   The 4 character airport ICAO id
+    # date
+    #   A Ruby Time object
+    #   A date in the format 'yearmonthday' (ex: 20100226)
+    # Returns all flights going from one airport to another
+    def flight_route(origin, destination, date=nil, params={})
+      args = [origin, 'departures', destination, format(date)].compact.join('/')
+      perform_get("/airports/#{args}.xml", params)
+    end
+
+    # params
+    #   :per_page => The number of results per page. Defaults to 30.
+    #   :page => The page of results displayed.
+    # Returns all metars
     def metars(params={})
       perform_get('/metars.xml', params)
     end
 
+    # id
+    #   The FlightCaster id
+    #   The 4 character metar ICAO id. If given the metar that is returned
+    #   is the last one reported at that station.
+    # Returns metar specified by the given id.
     def metar(id)
       perform_get("/metars/#{id}.xml")
     end
 
+    # params
+    #   :per_page => The number of results per page. Defaults to 30.
+    #   :page => The page of results displayed.
+    # Returns all tafs
     def tafs(params={})
       perform_get('/tafs.xml', params)
     end
 
+    # id
+    #   The FlightCaster id
+    #   The 4 character taf ICAO id. If given the taf that is returned
+    #   is the last one reported at that station.
+    # Returns taf specified by the given id.
     def taf(id)
       perform_get("/tafs/#{id}.xml")
     end
 
+    # params
+    #   :per_page => The number of results per page. Defaults to 30.
+    #   :page => The page of results displayed.
+    # Returns a list of ground delays
     def ground_delays(params={})
       perform_get('/ground_delays.xml', params)
     end
 
+    # id
+    #   The FlightCaster id
+    #   The 4 character delay ICAO id. If given, the delay that is returned
+    #   is the last one reported at that station.
+    # Returns a single ground delay.
     def ground_delay(id)
       perform_get("/ground_delays/#{id}.xml")
     end
 
+    # Returns all ground stops, limited to 50 results.
     def ground_stops(params={})
       perform_get('/ground_stops.xml', params)
     end
 
+    # id
+    #   The FlightCaster id
+    #   The 4 character stop ICAO id. If given, the stop that is returned
+    #   is the last one reported at that station.
+    # Returns a single ground stop.
     def ground_stop(id)
       perform_get("/ground_stops/#{id}.xml")
     end
 
+    # params
+    #   :per_page => The number of results per page. Defaults to 30.
+    #   :page => The page of results displayed.
+    # Returns all delays.
     def delays(params={})
       perform_get('/delays.xml', params)
     end
 
+    # id
+    #   The FlightCaster id
+    #   The 4 character delay ICAO id. If given, the delay that is returned
+    #   is the last one reported at that station.
+    # Returns a single delay.
     def delay(id)
       perform_get("/delays/#{id}.xml")
     end
 
     private
 
+    # :nodoc
     def perform_get(path, params={})
       FlightCaster::Request.get(path, params)
     end
 
-    def convert_date(date)
-      if date.class == Time
-        date.strftime("%Y%m%d")
-      else
-        date
-      end
+    # :nodoc
+    def format(date)
+      (date.is_a?(Time)) ? date.strftime("%Y%m%d") : date
     end
 
   end

data/lib/flightcaster/rash.rb

@@ -0,0 +1,31 @@
+module FlightCaster
+  class Rash
+    extend Forwardable
+
+    attr_accessor :hash, :array
+
+    def initialize(h)
+      @array = []
+      @hash = h
+      split_into_rash
+    end
+
+    def_delegators :@hash, :id, :replace, :each_key, :keys, :delete,
+                   :merge!, :method_missing
+    def_delegators :@array, :each, :size, :[]
+
+    private
+
+    def split_into_rash
+      @hash.each_key do |key|
+        if @hash[key].class == Array
+          @hash[key].each {|x| @array << x}
+          @hash.delete(key)
+        elsif @hash[key].class == Hashie::Mash
+          @hash[key] = Rash.new(@hash[key])
+        end
+      end
+    end
+
+  end
+end

data/lib/flightcaster/request.rb

@@ -22,7 +22,9 @@ module FlightCaster
       begin
         raise_errors(response)
         data = parse(response)
-        FlightCaster::Result.new(data)
+        h = Hashie::Mash.new(data)
+        h = h[h.keys[0]]
+        FlightCaster::Rash.new(h)
       rescue
       end
     end

data/test/fixtures/flights.xml

@@ -13,7 +13,7 @@ Age: 0
 Via: 1.1 varnish
 
 <?xml version="1.0" encoding="utf-8"?>
-<flights>
+<flights current-page="1" total-entries="504" total-pages="17">
   <flight>
     <actual-air-time nil="true" type="integer"/>
     <actual-aircraft-type nil="true"/>

data/test/test_flightcaster.rb

@@ -107,27 +107,28 @@ class TestFlightCaster < Test::Unit::TestCase
 
     should "get flights by airline and flight number" do
       stub_get('/airlines/VX/flights/28.xml', 'airline_flight.xml')
-      flights = @flightcaster.flight_by_airline('VX', 28)
+      flights = @flightcaster.flights_by_airline('VX', 28)
       flights.total_entries.should == '5'
+      flights.size.should == 5
       flights.total_pages.should == '1'
     end
 
     should "get flights by airline, flight number, and date" do
       stub_get('/airlines/VX/flights/28/20100226.xml', 'flight_date.xml')
-      flights = @flightcaster.flights_by_airline_on('VX', 28, '20100226')
+      flights = @flightcaster.flights_by_airline('VX', 28, '20100226')
       flights.total_entries.should == '1'
     end
 
     should "find a flight from one airport to another" do
       stub_get('/airports/PDX/departures/DFW.xml', 'flight_path.xml')
-      flights = @flightcaster.flight_path('PDX', 'DFW')
+      flights = @flightcaster.flight_route('PDX', 'DFW')
       flights.total_entries.should == '6'
       flights.total_pages.should == '3'
     end
 
     should "find a flight from one airport to another on a certain day" do
       stub_get('/airports/PDX/departures/DFW/20090911.xml', 'flight_path_date.xml')
-      flights = @flightcaster.flight_path_on('PDX', 'DFW', '20090911')
+      flights = @flightcaster.flight_route('PDX', 'DFW', '20090911')
       flights[0].id.should == 2877686
       flights.size.should == 22
     end
@@ -143,9 +144,9 @@ class TestFlightCaster < Test::Unit::TestCase
     end
 
     should "get predictions for one flight" do
-      #stub_get('/flights/2858102.xml', 'flight.xml')
-      #flight = @flightcaster.flight(2858102)
-      #flight.predictions[0].state.should == 'delayed'
+      stub_get('/flights/2858102.xml', 'flight.xml')
+      flight = @flightcaster.flight(2858102)
+      flight.predictions[0].state.should == 'delayed'
     end
   end
 

data/test/test_request.rb

@@ -1,7 +1,7 @@
 require 'helper'
 
 class TestRequest < Test::Unit::TestCase
-  context "Requesting" do
+  context "Request" do
     should "add API key to base_uri" do
       FlightCaster::Request.set_api_key("foo")
       FlightCaster::Request.full_uri('/').should == "http://api.flightcaster.com/?api_key=foo"

data/test/test_result.rb

@@ -0,0 +1,49 @@
+require 'helper'
+
+class TestResult < Test::Unit::TestCase
+  def setup
+    stub_get('/flights.xml', 'flights.xml')
+    FlightCaster::Request.set_api_key('foo')
+    @flights = FlightCaster::Request.get('/flights.xml')
+  end
+
+  context "Initialization" do
+    should "require data" do
+      lambda { FlightCaster::Result.new }.should raise_error
+    end
+  end
+
+  context "After initialization, Result" do
+    should "get rid of the outside hash" do
+      @flights.flights.should == nil
+    end
+
+    should "extract arrays from hashes" do
+      @flights[0].id.should == 2858102
+      @flights[1].id.should == 2856793
+    end
+
+    should "not create duplicates" do
+      @flights.flight.should == nil
+    end
+
+    should "not remove current page number" do
+      @flights.current_page.should == '1'
+    end
+
+    should "not remove number of entries" do
+      @flights.total_entries.should == '504'
+    end
+
+    should "not remove number of pages" do
+      @flights.total_pages.should == '17'
+    end
+
+    should "return the size of the array" do
+      @flights.size.should == 30
+    end
+
+    should "not duplicate inner arrays" do
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jarod Luebbert
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-26 00:00:00 -06:00
+date: 2010-03-01 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,8 +25,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 0
-        version: "0"
+        - 2
+        - 10
+        - 2
+        version: 2.10.2
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -109,20 +111,20 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - examples/flights.rb
 - flightcaster.gemspec
 - lib/flightcaster.rb
 - lib/flightcaster/base.rb
+- lib/flightcaster/rash.rb
 - lib/flightcaster/request.rb
-- lib/flightcaster/result.rb
 - test/fixtures/airline.xml
 - test/fixtures/airline_flight.xml
 - test/fixtures/airline_flights.xml
@@ -154,6 +156,7 @@ files:
 - test/test_base.rb
 - test/test_flightcaster.rb
 - test/test_request.rb
+- test/test_result.rb
 has_rdoc: true
 homepage: http://github.com/jarodluebbert/flightcaster
 licenses: []
@@ -189,4 +192,5 @@ test_files:
 - test/test_base.rb
 - test/test_flightcaster.rb
 - test/test_request.rb
+- test/test_result.rb
 - examples/flights.rb

data/README.rdoc

@@ -1,26 +0,0 @@
-= flightcaster
-
-The flightcaster ruby gem. Get started by going to http://docs.flightcaster.com/
-and getting an API key.
-
-== examples
-
-See the examples directory.
-
-== docs
-
-http://rdoc.info/projects/jarodluebbert/flightcaster
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Jarod Luebbert. See LICENSE for details.

data/lib/flightcaster/result.rb

@@ -1,51 +0,0 @@
-module FlightCaster
-  class Result
-    extend Forwardable
-
-    def initialize(data)
-      @h = generate_hash(data)
-    end
-
-    def_delegators :@h, :id, :replace, :each_key, :keys, :delete,
-                        :[], :[]=, :merge!, :method_missing
-
-    # When enumerating a hash, look for an array with the
-    # response results and pass it the block.
-    def each(&blk)
-      @h.results.each(&blk)
-    end
-
-    def [](key)
-      @h.results[key]
-    end
-
-    def size
-      @h.results.size
-    end
-
-    private
-
-    def generate_hash(data)
-      h = Hashie::Mash.new(data)
-      # since the hash looks like { :airlines => { stuff we want } },
-      # we just grab the value from the first key
-      h = h[h.keys[0]]
-      # now we have:
-      # { :total_entries => 1, ... , :data_requested => [array of hashes], }
-      # for example if the user requests `.flights` then in order to
-      # iterate over all flights `.flights.flight.each` would be needed.
-      # To get around this, we need to grab out that array of hashes
-      # and store it in a general location so we can overload `.each`
-      h.each_key do |key|
-        if h[key].class == Array
-          results = []
-          h[key].each do |item|
-            results << item
-          end
-          h.delete(key)
-          h.merge!({ :results => results })
-        end
-      end
-    end
-  end
-end