flightcaster 0.1.0 → 0.1.1

data/.gitignore

@@ -17,5 +17,6 @@ tmtags
 coverage
 rdoc
 pkg
+*.gem
 
 ## PROJECT::SPECIFIC

data/README.rdoc

@@ -9,6 +9,8 @@ See the examples directory.
 
 == docs
 
+http://rdoc.info/projects/jarodluebbert/flightcaster
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'rake'
 
 begin
@@ -11,7 +10,12 @@ begin
     gem.email = "jarod.luebbert@gmail.com"
     gem.homepage = "http://github.com/jarodluebbert/flightcaster"
     gem.authors = ["Jarod Luebbert"]
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 2.10.2"
+    gem.add_development_dependency "shoulda", ">= 2.10.2"
+    gem.add_development_dependency "mhennemeyer-matchy", ">= 0.3.3"
+    gem.add_development_dependency "fakeweb", ">= 1.2.8"
+    gem.add_dependency "httparty", ">= 0.5.2"
+    gem.add_dependency "hashie", ">= 0.1.8"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/examples/flights.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'flightcaster')
+
+flightcaster = FlightCaster.new('secret')
+
+flights = flightcaster.flights
+
+# all flights
+flights.each do |f|
+  puts "#{f.airline_icao_id}-#{f.number}"
+end
+
+puts "*"*50
+
+# all flights going from PDX to DFW
+flights = flightcaster.flight_path('PDX', 'DFW')
+
+flights.each do |f|
+  puts "#{f.airline_icao_id}-#{f.number}"
+end
+
+puts "*"*50
+
+# all flights with a certain airline
+flights = flightcaster.flights_by_airline('VX')
+
+flights.each do |f|
+  puts "#{f.airline_icao_id}-#{f.number}"
+end

data/flightcaster.gemspec

@@ -0,0 +1,106 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{flightcaster}
+  s.version = "0.1.1"
+
+  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.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"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "examples/flights.rb",
+     "flightcaster.gemspec",
+     "lib/flightcaster.rb",
+     "lib/flightcaster/base.rb",
+     "lib/flightcaster/request.rb",
+     "lib/flightcaster/result.rb",
+     "test/fixtures/airline.xml",
+     "test/fixtures/airline_flight.xml",
+     "test/fixtures/airline_flights.xml",
+     "test/fixtures/airlines.xml",
+     "test/fixtures/airlines_page.xml",
+     "test/fixtures/airlines_per_page.xml",
+     "test/fixtures/airport.xml",
+     "test/fixtures/airports.xml",
+     "test/fixtures/arrivals.xml",
+     "test/fixtures/departures.xml",
+     "test/fixtures/flight.xml",
+     "test/fixtures/flight_date.xml",
+     "test/fixtures/flight_path.xml",
+     "test/fixtures/flight_path_date.xml",
+     "test/fixtures/flights.xml",
+     "test/fixtures/general_delay.xml",
+     "test/fixtures/general_delays.xml",
+     "test/fixtures/ground_delay.xml",
+     "test/fixtures/ground_delays.xml",
+     "test/fixtures/ground_stop.xml",
+     "test/fixtures/ground_stops.xml",
+     "test/fixtures/metar.xml",
+     "test/fixtures/metars.xml",
+     "test/fixtures/notfound.xml",
+     "test/fixtures/oldapi.xml",
+     "test/fixtures/taf.xml",
+     "test/fixtures/tafs.xml",
+     "test/helper.rb",
+     "test/test_base.rb",
+     "test/test_flightcaster.rb",
+     "test/test_request.rb"
+  ]
+  s.homepage = %q{http://github.com/jarodluebbert/flightcaster}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Simple interaction with the flightcaster API}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_base.rb",
+     "test/test_flightcaster.rb",
+     "test/test_request.rb",
+     "examples/flights.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    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<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<shoulda>, [">= 2.10.2"])
+      s.add_dependency(%q<mhennemeyer-matchy>, [">= 0.3.3"])
+      s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
+      s.add_dependency(%q<httparty>, [">= 0.5.2"])
+      s.add_dependency(%q<hashie>, [">= 0.1.8"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    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"])
+    s.add_dependency(%q<httparty>, [">= 0.5.2"])
+    s.add_dependency(%q<hashie>, [">= 0.1.8"])
+  end
+end
+

data/lib/flightcaster.rb

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

data/lib/flightcaster/base.rb

@@ -7,44 +7,72 @@ module FlightCaster
       FlightCaster::Request.set_api_key(@api_key)
     end
 
+    # Params
+    #   :per_page => The number of results per page. Defaults to 30.
+    #   :page => The page of results displayed.
     def airlines(params={})
       perform_get('/airlines.xml', params)
     end
 
+    # id
+    #   The FlightCaster id
+    #   The 2 character IATA id
+    #   The 3 chracter ICAO id of the airline
     def airline(id)
       perform_get("/airlines/#{id}.xml")
     end
 
+    # Params
+    #   :per_page => The number of results per page. Defaults to 30.
+    #   :page => The page of results displayed.
     def airports(params={})
       perform_get('/airports.xml', params)
     end
 
+    # id
+    #   The FlightCaster id
+    #   The 3 character IATA id
+    #   The 4 chracter ICAO id of the airport
     def airport(id)
       perform_get("/airports/#{id}.xml")
     end
 
+    # id
+    #   The FlightCaster id
+    #   The 3 character IATA id
+    #   The 4 chracter ICAO id of the airport
+    # Get all arrivals at an airport.
     def airport_arrivals(id, params={})
       perform_get("/airports/#{id}/arrivals.xml", params)
     end
 
+    # id
+    #   The FlightCaster id
+    #   The 3 character IATA id
+    #   The 4 chracter ICAO id of the airport
+    # Get all departures leaving an airport.
     def airport_departures(id, params={})
       perform_get("/airports/#{id}/departures.xml", params)
     end
 
+    # id
+    #   The id given to the flight by FlightCaster
     def flight(id)
       perform_get("/flights/#{id}.xml")
     end
 
-    # TODO: rename this method to something more obvious
+    # 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)

data/lib/flightcaster/request.rb

@@ -22,10 +22,7 @@ module FlightCaster
       begin
         raise_errors(response)
         data = parse(response)
-        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.keys[0]]
+        FlightCaster::Result.new(data)
       rescue
       end
     end
@@ -50,6 +47,5 @@ module FlightCaster
       end
       final
     end
-
   end
 end

data/lib/flightcaster/result.rb

@@ -0,0 +1,51 @@
+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

data/test/helper.rb

@@ -1,8 +1,8 @@
-require 'rubygems'
 require 'test/unit'
 require 'shoulda'
 require 'matchy'
 require 'fakeweb'
+begin; require 'turn'; rescue LoadError; end
 
 FakeWeb.allow_net_connect = false
 

data/test/test_flightcaster.rb

@@ -35,7 +35,7 @@ class TestFlightCaster < Test::Unit::TestCase
     should "get airlines with 50 on each page" do
       stub_get('/airlines.xml', 'airlines_per_page.xml', '&per_page=50')
       airlines = @flightcaster.airlines(:per_page => 50)
-      airlines.airline.size.should == 50
+      airlines.size.should == 50
     end
 
   end
@@ -62,7 +62,7 @@ class TestFlightCaster < Test::Unit::TestCase
       airports.current_page.should == '1'
       airports.total_entries.should == '2026'
       airports.total_pages.should == '68'
-      airports.airport[0].city.should == 'New York'
+      airports[0].city.should == 'New York'
     end
   end
 
@@ -80,8 +80,8 @@ class TestFlightCaster < Test::Unit::TestCase
     should "get all flights" do
       stub_get('/flights.xml', 'flights.xml')
       flights = @flightcaster.flights
-      flights.flight[0].id.should == 2858102
-      flights.flight[0].status == 'Scheduled'
+      flights[0].id.should == 2858102
+      flights[0].status == 'Scheduled'
     end
 
     should "get flights by airline" do
@@ -128,8 +128,8 @@ class TestFlightCaster < Test::Unit::TestCase
     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.flight[0].id.should == 2877686
-      flights.flight.size.should == 22
+      flights[0].id.should == 2877686
+      flights.size.should == 22
     end
   end
 
@@ -141,6 +141,12 @@ class TestFlightCaster < Test::Unit::TestCase
       flight.status_code.should == 'S'
       flight.flightstats_id.should == '184971694'
     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'
+    end
   end
 
   context "Fetching METARs" do
@@ -180,7 +186,7 @@ class TestFlightCaster < Test::Unit::TestCase
       stub_get('/delays.xml', 'general_delays.xml')
       delays = @flightcaster.delays
       delays.total_entries.should == '2'
-      delays.delay[0].id.should == '394071'
+      delays[0].id.should == '394071'
     end
 
     should "get one general delay" do
@@ -193,7 +199,7 @@ class TestFlightCaster < Test::Unit::TestCase
       stub_get('/ground_delays.xml', 'ground_delays.xml')
       ground_delays = @flightcaster.ground_delays
       ground_delays.total_entries.should == '3'
-      ground_delays.ground_delay[0].id.should == '373404'
+      ground_delays[0].id.should == '373404'
     end
 
     should "get one ground delay" do
@@ -207,7 +213,7 @@ class TestFlightCaster < Test::Unit::TestCase
       stub_get('/ground_stops.xml', 'ground_stops.xml')
       ground_stops = @flightcaster.ground_stops
       ground_stops.total_entries.should == '2'
-      ground_stops.ground_stop[0].id.should == '125918'
+      ground_stops[0].id.should == '125918'
     end
 
     should "get one ground stop" do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Jarod Luebbert
@@ -29,6 +29,76 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 10
+        - 2
+        version: 2.10.2
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mhennemeyer-matchy
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 3
+        version: 0.3.3
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 8
+        version: 1.2.8
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 8
+        version: 0.1.8
+  type: :runtime
+  version_requirements: *id006
 description: |-
   Simple interaction with the flightcaster API. Look up
       flight predictions and information.
@@ -47,9 +117,12 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- examples/flights.rb
+- flightcaster.gemspec
 - lib/flightcaster.rb
 - lib/flightcaster/base.rb
 - lib/flightcaster/request.rb
+- lib/flightcaster/result.rb
 - test/fixtures/airline.xml
 - test/fixtures/airline_flight.xml
 - test/fixtures/airline_flights.xml
@@ -116,3 +189,4 @@ test_files:
 - test/test_base.rb
 - test/test_flightcaster.rb
 - test/test_request.rb
+- examples/flights.rb