gtfs_engine 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e84da8bed1f68352eaf059a895bd270f31e7d0a
+  data.tar.gz: 2f5e288cfce8186cc9e54ec22d664ff972866c65
+SHA512:
+  metadata.gz: c98750840af8e9d732371abfb185f3fd9b5c036c503cccb95975ec4e0c4f9b1be063b9647d3b345c52ba3edcb318beb53833201661e43aa986b42b1d00b8cc54
+  data.tar.gz: def1c054d81f293665ec81b1afd38f2a4d42562092e7df5461aed213355172e2c9fc2a70b931acca02cb432009533459d6e4508d218d2f4a5d12ff1b1ee83fa5

data/README.textile

@@ -0,0 +1,11 @@
+h1. gtfs_engine
+
+@gtfs_engine@ is a "Rails Engine":http://guides.rubyonrails.org/engines.html which will add GTFS(General Transit Feed Specification) support to your application. It provides both the resources and controller actions necessary to provide a RESTful interface to one or more GTFS data sets.
+
+See "*sangster.github.io/gtfs_engine*"://sangster.github.io/gtfs_engine more more information on how to use this engine.
+
+h2. Sub-Components
+
+This Rails Engine relies on the "gtfs_reader"://github.com/sangster/gtfs_reader rubygem to process the actual ZIP files in which GTFS data sets are provided.
+
+

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'jeweler'
+require File.dirname(__FILE__) + '/lib/gtfs_engine/version'
+
+Jeweler::Tasks.new do |gem|
+  gem.name = 'gtfs_engine'
+  gem.version = GtfsEngine::Version.to_s
+  gem.homepage = 'http://github.com/sangster/gtfs_engine'
+  gem.license = 'GPL 3'
+  gem.summary = 'Read General Transit Feed Specification zip files'
+  gem.description = <<-EOF.strip.gsub /\s+/, ' '
+    A Rails Engine to provide a basic RESTful interface for GTFS feeds.
+
+    GTFS Spec: https://developers.google.com/transit/gtfs
+  EOF
+  gem.email = 'jon@ertt.ca'
+  gem.authors = ['Jon Sangster']
+
+  gem.files = Dir['{app,config,db,lib}/**/*', 'Rakefile']
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+task bump: ['bump:patch']
+namespace :bump do
+  %i[major minor patch].each do |part|
+    bumper = GtfsEngine::Version::Bumper.new part
+    desc "Bump the version to #{bumper}"
+    task(part) { bumper.bump }
+  end
+end

data/app/controllers/gtfs_engine/agencies_controller.rb

@@ -0,0 +1,24 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class AgenciesController < ApplicationController
+    include Concerns::Controllers::Gtfs
+
+    filters :agency_name,
+            :agency_url,
+            :agency_timezone,
+            :agency_lang
+  end
+end

data/app/controllers/gtfs_engine/application_controller.rb

@@ -0,0 +1,21 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class ApplicationController < ActionController::Base
+    include Concerns::Controllers::DataAccess
+    respond_to :json
+    self.responder = GtfsEngine::JsonResponder
+  end
+end

data/app/controllers/gtfs_engine/calendar_dates_controller.rb

@@ -0,0 +1,22 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class CalendarDatesController < ApplicationController
+    include Concerns::Controllers::Gtfs
+    gtfs_id :service_id
+    filters :date,
+            :exception_type
+  end
+end

data/app/controllers/gtfs_engine/calendars_controller.rb

@@ -0,0 +1,51 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class CalendarsController < ApplicationController
+    include Concerns::Controllers::Gtfs
+
+    gtfs_id :service_id
+
+    filters :monday,
+            :tuesday,
+            :wednesday,
+            :thursday,
+            :friday,
+            :saturday,
+            :sunday,
+            :start_date,
+            :end_date
+
+    def for_date
+      date = params[:YYYY_MM_DD]
+      check_format! date
+      @records = Calendar.from_date_string date
+      respond_with @records, template: 'gtfs_engine/gtfs/index'
+    end
+
+    def dates
+      @dates = record.dates
+      render :dates
+    end
+
+    private
+
+    def check_format!(date_str)
+      unless %r{^\d{4}-\d\d-\d\d$} === date_str
+        raise DateFormatError, "Got '#{date_str}. Expected format: YYYY-MM-DD'"
+      end
+    end
+  end
+end

data/app/controllers/gtfs_engine/data_sets_controller.rb

@@ -0,0 +1,47 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class DataSetsController < ApplicationController
+    def index
+      expires_in 3.hours
+
+      @data_sets = Rails.cache.fetch('data_sets_index') do
+        {}.tap do |sets|
+          DataSet.order(:created_at).each do |set|
+            (sets[set.name] ||= []) << set
+          end
+        end
+      end
+
+      dates = @data_sets.values.flatten.collect &:created_at
+      if stale? last_modified: dates.max, public: true
+        respond_with @data_sets
+      end
+    end
+
+    def show
+      expires_in 2.hours
+
+      @data_set = data :id
+
+      # Set location if the given id is a data-source name and not an ID
+      if param_is_data_set_name? :id
+        respond_with @data_set, location: data_set_url(@data_set)
+      else
+        respond_with @data_set
+      end
+    end
+  end
+end

data/app/controllers/gtfs_engine/fare_attributes_controller.rb

@@ -0,0 +1,27 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class FareAttributesController < ApplicationController
+    include Concerns::Controllers::Gtfs
+
+    gtfs_id :fare_id
+
+    filters :price,
+            :currency_type,
+            :payment_method,
+            :transfers,
+            :transfer_duration
+  end
+end

data/app/controllers/gtfs_engine/fare_rules_controller.rb

@@ -0,0 +1,26 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class FareRulesController < ApplicationController
+    include Concerns::Controllers::Gtfs
+
+    gtfs_id :fare_id
+
+    filters :route_id,
+            :origin_id,
+            :destination_id,
+            :contains_id
+  end
+end

data/app/controllers/gtfs_engine/feed_infos_controller.rb

@@ -0,0 +1,26 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class FeedInfosController < ApplicationController
+    include Concerns::Controllers::Gtfs
+
+    filters :feed_publisher_name,
+            :feed_publisher_url,
+            :feed_lang,
+            :feed_start_date,
+            :feed_end_date,
+            :feed_version
+  end
+end

data/app/controllers/gtfs_engine/frequencies_controller.rb

@@ -0,0 +1,26 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class FrequenciesController < ApplicationController
+    include Concerns::Controllers::Gtfs
+
+    gtfs_id :trip_id
+
+    filters :start_time,
+            :end_time,
+            :headway_secs,
+            :exact_times
+  end
+end

data/app/controllers/gtfs_engine/routes_controller.rb

@@ -0,0 +1,25 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class RoutesController < ApplicationController
+    include Concerns::Controllers::Gtfs
+
+    filters :agency_id,
+            :route_short_name,
+            :route_long_name,
+            :route_type,
+            :agency
+  end
+end

data/app/controllers/gtfs_engine/shapes_controller.rb

@@ -0,0 +1,23 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class ShapesController < ApplicationController
+    include Concerns::Controllers::Gtfs
+
+    filters :shape_pt_lat,
+            :shape_pt_lon,
+            :shape_pt_sequence
+  end
+end

data/app/controllers/gtfs_engine/stop_times_controller.rb

@@ -0,0 +1,28 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class StopTimesController < ApplicationController
+    include Concerns::Controllers::Gtfs
+
+    gtfs_id :route_id
+
+    filters :arrival_time,
+            :departure_time,
+            :stop_sequence,
+            :stop_headsign,
+            :pickup_type,
+            :drop_off_type
+  end
+end

data/app/controllers/gtfs_engine/stops_controller.rb

@@ -0,0 +1,30 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class StopsController < ApplicationController
+    include Concerns::Controllers::Gtfs
+
+    filters :stop_code,
+            :stop_name,
+            :stop_desc,
+            :stop_lat,
+            :stop_lon,
+            :zone_id,
+            :location_type,
+            :parent_station,
+            :stop_timezone,
+            :wheelchair_boarding
+  end
+end

data/app/controllers/gtfs_engine/transfers_controller.rb

@@ -0,0 +1,38 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class TransfersController < ApplicationController
+    include Concerns::Controllers::Gtfs
+
+    filters :transfer_type,
+            :min_transfer_time
+
+    def from
+      @transfers = collection.where from_stop_id: params[:stop_id]
+      respond_with @transfers
+    end
+
+    def to
+      @transfers = collection.where to_stop_id: params[:stop_id]
+      respond_with @transfers
+    end
+
+    def from_to
+      @transfer = collection.find_by from_stop_id: params[:from_id],
+                                       to_stop_id: params[:to_id]
+      respond_with @transfer
+    end
+  end
+end

data/app/controllers/gtfs_engine/trips_controller.rb

@@ -0,0 +1,34 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class TripsController < ApplicationController
+    include Concerns::Controllers::Gtfs
+
+    filters :service_id,
+            :trip_headsign,
+            :short_name,
+            :direction_id,
+            :block_id,
+            :route_id,
+            :shape_id,
+            :wheelchair_accessible,
+            :bikes_allowed
+
+    def block
+      @trips = collection.where block_id: params[:id]
+      respond_with @trips
+    end
+  end
+end

data/app/helpers/gtfs_engine/default_views_helper.rb

@@ -0,0 +1,38 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  module DefaultViewsHelper
+    def index(json, records)
+      json.cache! [controller_name, filter] do
+        json.ignore_nil! true
+
+        json.status 'success'
+        json.data do
+          json.array!(records) {|record| json.extract! record, *fields }
+        end
+      end
+    end
+
+    def show(json, record)
+      json.cache! record do
+        json.ignore_nil! true
+        json.status 'success'
+        json.data do
+          json.extract! record, *fields
+        end
+      end
+    end
+  end
+end

data/app/helpers/gtfs_engine/fields_helper.rb

@@ -0,0 +1,32 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  module FieldsHelper
+    def fields
+      (@fields ||= {})[model] ||= create_fields
+    end
+
+    private
+
+    def model
+      @model ||= controller_name.classify
+    end
+
+    def create_fields
+      attributes = GtfsEngine.const_get(model).attribute_names
+      attributes - %w(id data_set_id)
+    end
+  end
+end

data/app/models/gtfs_engine/agency.rb

@@ -0,0 +1,19 @@
+# This file is part of the KNOWtime server.
+#
+# The KNOWtime server is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# The KNOWtime server is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License
+# along with the KNOWtime server.  If not, see <http://www.gnu.org/licenses/>.
+module GtfsEngine
+  class Agency < ActiveRecord::Base
+    belongs_to :data_set, inverse_of: :agencies
+  end
+end