gtfs 0.1.0 → 0.2.0

data/.gitignore

@@ -0,0 +1,4 @@
+Session.vim
+coverage
+.rvmrc
+*.gem

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+gem 'rake'
+gem 'rspec'
+gem 'multi_json', '1.0.4'
+gem 'simplecov', :require => false
+gem 'rubyzip'
+gem 'vcr'
+gem 'fakeweb'

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    fakeweb (1.3.0)
+    multi_json (1.0.4)
+    rake (0.9.2.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    rubyzip (0.9.5)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    vcr (1.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb
+  multi_json (= 1.0.4)
+  rake
+  rspec
+  rubyzip
+  simplecov
+  vcr

data/README.md

@@ -1,6 +1,6 @@
 ### GTFS Ruby
 
-A Ruby wrapper for the General Transit Feed Specification
+A Ruby wrapper for the [General Transit Feed Specification](https://developers.google.com/transit/gtfs/)
 
 ### Getting started
 
@@ -15,10 +15,31 @@ Accessing GTFS data from the source:
     source.routes
     source.trips
     source.stop_times
-    source.calendar
-    source.calendar_dates
-    source.fare_attributes
-    source.fare_rules
+    source.calendars
+    source.calendar_dates     
+    source.fare_attributes    
+    source.fare_rules         
     source.shapes
-    source.frequencies
-    source.transfers
+    source.frequencies        
+    source.transfers          
+
+### License
+
+Copyright (C) 2012 Ed Schmalzle
+
+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

@@ -1,7 +1,6 @@
-#!/usr/bin/env rake
 require 'rubygems'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new do |t|
-  t.pattern = "./spec/**/*_spec.rb"
+  t.pattern = './spec/**/*_spec.rb'
 end

data/gtfs.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require './lib/gtfs/version'
+
+Gem::Specification.new do |gem|
+  gem.name    = 'gtfs'
+  gem.version = GTFS::VERSION
+  gem.date    = Date.today.to_s
+ 
+  gem.summary = 'Load and read GTFS data from zip bundles'
+  gem.description = 'gtfs reads GTFS data from a google-compliant Zip bundle 
+                     and returns an object representing the CSV data inside'
+
+  gem.authors     = ['nerdEd']
+  gem.email       = ['ed@nerded.net']
+  gem.homepage    = 'https://github.com/nerdEd/gtfs'
+
+  gem.add_dependency 'rake'
+  gem.add_dependency 'multi_json'
+  gem.add_dependency 'rubyzip'
+
+  gem.add_development_dependency 'rspec', ['>= 2.0.0']
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'ruby-debug19'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'fakeweb'
+
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.require_paths = ['lib']
+end

data/lib/gtfs.rb

@@ -3,12 +3,17 @@ require 'gtfs/model'
 require 'gtfs/agency'
 require 'gtfs/calendar'
 require 'gtfs/calendar_date'
-require 'gtfs/source'
-require 'gtfs/url_source'
-require 'gtfs/local_source'
 require 'gtfs/route'
 require 'gtfs/shape'
 require 'gtfs/stop'
 require 'gtfs/stop_time'
 require 'gtfs/trip'
 require 'gtfs/custom_exceptions'
+require 'gtfs/fare_attribute'
+require 'gtfs/fare_rule'
+require 'gtfs/frequency'
+require 'gtfs/transfer'
+
+require 'gtfs/source'
+require 'gtfs/url_source'
+require 'gtfs/local_source'

data/lib/gtfs/agency.rb

@@ -8,6 +8,10 @@ module GTFS
 
     column_prefix :agency_
 
+    collection_name :agencies
+    required_file true
+    uses_filename 'agency.txt'
+
     def self.parse_agencies(data)
       return parse_models(data)
     end

data/lib/gtfs/calendar.rb

@@ -5,6 +5,10 @@ module GTFS
     has_required_attrs :service_id, :monday, :tuesday, :wednesday, :thursday, :friday, :saturday, :sunday, :start_date, :end_date
     attr_accessor *attrs
 
+    collection_name :calendars
+    required_file true
+    uses_filename 'calendars.txt'
+
     def self.parse_calendars(data)
       return parse_models(data)
     end

data/lib/gtfs/calendar_date.rb

@@ -5,6 +5,10 @@ module GTFS
     has_required_attrs :service_id, :date, :exception_type
     attr_accessor *attrs
 
+    collection_name :calendar_dates
+    required_file true
+    uses_filename 'calendar_dates.txt'
+
     def self.parse_calendar_dates(data)
       return parse_models(data)
     end

data/lib/gtfs/fare_attribute.rb

@@ -0,0 +1,17 @@
+module GTFS
+  class FareAttribute
+    include GTFS::Model
+
+    has_required_attrs :fare_id, :price, :currency_type, :payment_method, :transfers
+    has_optional_attrs :transfer_duration
+    attr_accessor *attrs
+
+    collection_name :fare_attributes
+    required_file false
+    uses_filename 'fare_attributes.txt'
+
+    def self.parse_fare_attributes(data)
+      return parse_models(data)
+    end
+  end
+end

data/lib/gtfs/fare_rule.rb

@@ -0,0 +1,17 @@
+module GTFS
+  class FareRule
+    include GTFS::Model
+
+    has_required_attrs :fare_id
+    has_optional_attrs :route_id, :origin_id, :destination_id, :contains_id
+    attr_accessor *attrs
+
+    collection_name :fare_rules
+    required_file false
+    uses_filename 'fare_rules.txt'
+
+    def self.parse_fare_rules(data)
+      return parse_models(data)
+    end
+  end
+end

data/lib/gtfs/frequency.rb

@@ -0,0 +1,17 @@
+module GTFS
+  class Frequency
+    include GTFS::Model
+
+    has_required_attrs :trip_id, :start_time, :end_time, :headway_secs
+    has_optional_attrs :exact_times
+    attr_accessor *attrs
+
+    collection_name :frequencies
+    required_file false
+    uses_filename 'frequencies.txt'
+
+    def self.parse_frequencies(data)
+      return parse_models(data)
+    end
+  end
+end

data/lib/gtfs/model.rb

@@ -1,4 +1,4 @@
-require 'CSV'
+require 'csv'
 
 module GTFS
   module Model
@@ -58,6 +58,18 @@ module GTFS
         self.class_variable_set('@@prefix', prefix)
       end
 
+      def required_file(required)
+        self.define_singleton_method(:required_file?) {required}
+      end
+
+      def collection_name(collection_name)
+        self.define_singleton_method(:name) {collection_name}
+      end
+      
+      def uses_filename(filename) 
+        self.define_singleton_method(:filename) {filename}
+      end
+
       def parse_models(data)
         return [] if data.nil? || data.empty?
 

data/lib/gtfs/route.rb

@@ -8,6 +8,10 @@ module GTFS
 
     column_prefix :route_
 
+    collection_name :routes
+    required_file true
+    uses_filename 'routes.txt'
+
     def self.parse_routes(data)
       return parse_models(data)
     end

data/lib/gtfs/shape.rb

@@ -6,6 +6,10 @@ module GTFS
     has_optional_attrs :dist_traveled
     attr_accessor *attrs
 
+    collection_name :shapes
+    required_file false
+    uses_filename 'shapes.txt'
+
     column_prefix :shape_
 
     def self.parse_shapes(data)

data/lib/gtfs/source.rb

@@ -5,9 +5,13 @@ require 'zip/zip'
 module GTFS
   class Source
 
-    REQUIRED_SOURCE_FILES = %w{agency.txt stops.txt routes.txt trips.txt stop_times.txt calendar.txt}
-    OPTIONAL_SOURCE_FILES = %w{calendar_dates.txt fare_attributes.txt fare_rules.txt shapes.txt frequencies.txt transfers.txt}
-    SOURCE_FILES = REQUIRED_SOURCE_FILES + OPTIONAL_SOURCE_FILES
+    ENTITIES = [GTFS::Agency, GTFS::Stop, GTFS::Route, GTFS::Trip, GTFS::StopTime, 
+                GTFS::Calendar, GTFS::CalendarDate, GTFS::Shape, GTFS::FareAttribute,
+                GTFS::FareRule, GTFS::Frequency, GTFS::Transfer]
+
+    REQUIRED_SOURCE_FILES = ENTITIES.select(&:required_file?).map(&:filename)
+    OPTIONAL_SOURCE_FILES = ENTITIES.reject(&:required_file?).map(&:filename)
+    SOURCE_FILES = ENTITIES.map(&:filename)
 
     attr_accessor :source, :archive
 
@@ -19,8 +23,6 @@ module GTFS
 
       @source = source
       load_archive(@source)
-
-      raise InvalidSourceException.new('Missing required source files') if missing_sources?
     end
 
     def self.finalize(directory)
@@ -40,10 +42,10 @@ module GTFS
     end
 
     def self.build(data_root)
-      if data_root.match(/http|www/) 
-        URLSource.new(data_root) 
-      else
+      if File.exists?(data_root)
         LocalSource.new(data_root)
+      else
+        URLSource.new(data_root) 
       end
     end
 
@@ -51,64 +53,28 @@ module GTFS
       Dir.entries(@tmp_dir)
     end
 
-    def missing_sources?
-      return true if @source.nil?
-
-      REQUIRED_SOURCE_FILES.each do |rf|
-        return true if !entries.include?(rf)
-      end
-      false
-    end
-
-    def agencies
-      open(File.join(@tmp_dir, '/', 'agency.txt')) do |f|
-        @agencies ||= Agency.parse_agencies(f.read)
-      end
-      @agencies
-    end
-
-    def stops
-      open(File.join(@tmp_dir, '/', 'stops.txt')) do |f|
-        @stops ||= Stop.parse_stops(f.read)
-      end
-      @stops
-    end
-
-    def calendars
-      open(File.join(@tmp_dir, '/', 'calendar.txt')) do |f|
-        @calendars ||= Calendar.parse_calendars(f.read)
-      end
-      @calendars
+    def raise_if_missing_source(filename)
+      file_missing = !entries.include?(filename)
+      raise InvalidSourceException.new("Missing required source file: #{filename}") if file_missing
     end
 
-    def routes
-      open(File.join(@tmp_dir, '/', 'routes.txt')) do |f|
-        @routes ||= Route.parse_routes(f.read)
-      end
-      @routes
-    end
-
-    # TODO: huge, isn't practical to parse all at once
-    def shapes
-      open(File.join(@tmp_dir, '/', 'shapes.txt')) do |f|
-        @shapes ||= Shape.parse_shapes(f.read)
+    ENTITIES.each do |entity|
+      define_method entity.name.to_sym do
+        parse_file entity.filename do |f|
+          entity.send("parse_#{entity.name}".to_sym, f.read) 
+        end
       end
-      @shapes
     end
 
-    def trips
-      open(File.join(@tmp_dir, '/', 'trips.txt')) do |f|
-        @trips ||= Trip.parse_trips(f.read)
-      end
-      @trips
+    def files
+      @files ||= {}
     end
 
-    # TODO: huge, isn't practical to parse all at once
-    def stop_times
-      open(File.join(@tmp_dir, '/', 'stop_times.txt')) do |f|
-        @stop_times ||= StopTime.parse_stop_times(f.read)
+    def parse_file(filename)
+      raise_if_missing_source filename
+      open File.join(@tmp_dir, '/', filename) do |f|
+        files[filename] ||= yield f
       end
-      @stop_times
     end
   end
 end

data/lib/gtfs/stop.rb

@@ -7,6 +7,10 @@ module GTFS
     column_prefix :stop_
     attr_accessor *attrs
 
+    collection_name :stops
+    required_file true
+    uses_filename 'stops.txt'
+
     LOCATION_TYPE_STOP = 0
     LOCATION_TYPE_STATION = 1
 

data/lib/gtfs/stop_time.rb

@@ -6,6 +6,10 @@ module GTFS
     has_optional_attrs :stop_headsign, :pickup_type, :drop_off_type, :shape_dist_traveled
     attr_accessor *attrs
 
+    collection_name :stop_times
+    required_file true
+    uses_filename 'stop_times.txt'
+
     def self.parse_stop_times(data)
       return parse_models(data)
     end

data/lib/gtfs/transfer.rb

@@ -0,0 +1,19 @@
+module GTFS
+  class Transfer
+    include GTFS::Model
+  
+    has_required_attrs :from_stop_id, :to_stop_id, :type
+    has_optional_attrs :min_transfer_time
+    attr_accessor *attrs
+
+    column_prefix :transfer_
+
+    collection_name :transfers
+    required_file false
+    uses_filename 'transfers.txt'
+
+    def self.parse_transfers(data)
+      return parse_models(data)
+    end
+  end
+end

data/lib/gtfs/trip.rb

@@ -8,6 +8,10 @@ module GTFS
 
     column_prefix :trip_
 
+    collection_name :trips
+    required_file true
+    uses_filename 'trips.txt'
+
     def self.parse_trips(data)
       return parse_models(data)
     end

data/lib/gtfs/url_source.rb

@@ -1,5 +1,5 @@
 require 'net/http'
-require 'URI'
+require 'uri'
 
 module GTFS
   class URLSource < Source

data/lib/gtfs/version.rb

@@ -1,4 +1,4 @@
 module GTFS
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end
 

data/spec/gtfs/source_spec.rb

@@ -23,13 +23,11 @@ describe GTFS::Source do
 
       it {should == 'LocalSource'}
     end
-  end
 
-  describe '#build' do
-    context 'when the source lacks a required file' do
-      it 'should raise an exception if the source is missing a file' do 
-        lambda {GTFS::Source.build(source_missing_required_fields)}.should raise_exception
-      end
+    context 'with a file object as a data root' do
+      let(:data_source) {File.open(valid_local_source)}
+
+      it {should == 'LocalSource'}
     end
   end
 
@@ -55,6 +53,13 @@ describe GTFS::Source do
   end
 
   describe '#routes' do
+    context 'when the source is missing routes' do
+      let(:source) { GTFS::Source.build source_missing_required_files }
+
+      it do
+        expect { source.routes }.to raise_exception GTFS::InvalidSourceException
+      end
+    end
   end
 
   describe '#trips' do

data/spec/spec_helper.rb

@@ -7,7 +7,6 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'bundler/setup'
 require 'rspec'
 require 'vcr'
-require 'ruby-debug'
 require 'gtfs'
 
 require File.expand_path(File.dirname(__FILE__) + '/support/model_shared_examples')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gtfs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-03 00:00:00.000000000 Z
+date: 2012-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -139,19 +139,29 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: gtfs reads GTFS data from a google-compliant Zip bundle and returns an
-  object representing the CSV data inside
+description: ! "gtfs reads GTFS data from a google-compliant Zip bundle \n                     and
+  returns an object representing the CSV data inside"
 email:
-- nerdEd
+- ed@nerded.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
 - Rakefile
+- gtfs.gemspec
+- lib/gtfs.rb
 - lib/gtfs/agency.rb
 - lib/gtfs/calendar.rb
 - lib/gtfs/calendar_date.rb
 - lib/gtfs/custom_exceptions.rb
+- lib/gtfs/fare_attribute.rb
+- lib/gtfs/fare_rule.rb
+- lib/gtfs/frequency.rb
 - lib/gtfs/local_source.rb
 - lib/gtfs/model.rb
 - lib/gtfs/route.rb
@@ -159,10 +169,10 @@ files:
 - lib/gtfs/source.rb
 - lib/gtfs/stop.rb
 - lib/gtfs/stop_time.rb
+- lib/gtfs/transfer.rb
 - lib/gtfs/trip.rb
 - lib/gtfs/url_source.rb
 - lib/gtfs/version.rb
-- lib/gtfs.rb
 - spec/fixtures/cassettes/invalid_gtfs_uri.yml
 - spec/fixtures/cassettes/valid_gtfs_uri.yml
 - spec/fixtures/missing_files.zip
@@ -180,7 +190,6 @@ files:
 - spec/gtfs/url_source_spec.rb
 - spec/spec_helper.rb
 - spec/support/model_shared_examples.rb
-- README.md
 homepage: https://github.com/nerdEd/gtfs
 licenses: []
 post_install_message: 
@@ -205,4 +214,21 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Load and read GTFS data from zip bundles
-test_files: []
+test_files:
+- spec/fixtures/cassettes/invalid_gtfs_uri.yml
+- spec/fixtures/cassettes/valid_gtfs_uri.yml
+- spec/fixtures/missing_files.zip
+- spec/fixtures/valid_gtfs.zip
+- spec/gtfs/agency_spec.rb
+- spec/gtfs/calendar_date_spec.rb
+- spec/gtfs/calendar_spec.rb
+- spec/gtfs/local_source_spec.rb
+- spec/gtfs/route_spec.rb
+- spec/gtfs/shape_spec.rb
+- spec/gtfs/source_spec.rb
+- spec/gtfs/stop_spec.rb
+- spec/gtfs/stop_time_spec.rb
+- spec/gtfs/trip_spec.rb
+- spec/gtfs/url_source_spec.rb
+- spec/spec_helper.rb
+- spec/support/model_shared_examples.rb