gtfs-engine 1.0.0

data/db/migrate/20140320051140_create_gtfs_engine_routes.rb

@@ -0,0 +1,22 @@
+class CreateGtfsEngineRoutes < ActiveRecord::Migration
+  TABLE = :gtfs_engine_routes
+
+  def change
+    create_table TABLE do |t|
+      t.string  :route_id,         null: false
+      t.string  :agency_id
+      t.string  :route_short_name, null: false
+      t.string  :route_long_name,  null: false
+      t.string  :route_desc
+      t.integer :route_type,       null: false
+      t.integer :route_url
+      t.string  :route_color
+      t.string  :route_text_color
+
+      t.references :data_set, null: false, index: true
+    end
+
+    add_index TABLE, :route_id
+    add_index TABLE, :route_short_name
+  end
+end

data/db/migrate/20140320052005_create_gtfs_engine_stops.rb

@@ -0,0 +1,28 @@
+class CreateGtfsEngineStops < ActiveRecord::Migration
+  TABLE = :gtfs_engine_stops
+
+  def change
+    create_table TABLE do |t|
+      t.string  :stop_id,             null: false
+      t.string  :stop_code
+      t.string  :stop_name,           null: false
+      t.string  :stop_desc
+      t.float   :stop_lat,            null: false
+      t.float   :stop_lon,            null: false
+      t.string  :zone_id
+      t.string  :stop_url
+      t.integer :location_type
+      t.integer :parent_station
+      t.string  :stop_timezone
+      t.integer :wheelchair_boarding
+
+      t.references :data_set, null: false, index: true
+    end
+
+    add_index TABLE, :stop_id
+    add_index TABLE, :stop_code
+    add_index TABLE, :stop_lat
+    add_index TABLE, :stop_lon
+    add_index TABLE, :zone_id
+  end
+end

data/db/migrate/20140320052508_create_gtfs_engine_trips.rb

@@ -0,0 +1,26 @@
+class CreateGtfsEngineTrips < ActiveRecord::Migration
+  TABLE = :gtfs_engine_trips
+
+  def change
+    create_table TABLE do |t|
+      t.string  :trip_id,               null: false
+      t.string  :service_id,            null: false
+      t.string  :trip_headsign
+      t.string  :trip_short_name
+      t.integer :direction_id
+      t.string  :block_id
+      t.string  :route_id,              null: false
+      t.string  :shape_id
+      t.integer :wheelchair_accessible
+      t.integer :bikes_allowed
+
+      t.references :data_set, null: false, index: true
+    end
+
+    add_index TABLE, :trip_id
+    add_index TABLE, :service_id
+    add_index TABLE, :block_id
+    add_index TABLE, :route_id
+    add_index TABLE, :shape_id
+  end
+end

data/db/migrate/20140320052907_create_gtfs_engine_stop_times.rb

@@ -0,0 +1,24 @@
+class CreateGtfsEngineStopTimes < ActiveRecord::Migration
+  TABLE = :gtfs_engine_stop_times
+
+  def change
+    create_table TABLE do |t|
+      t.string  :stop_id,             null: false
+      t.string  :trip_id,             null: false
+      t.string  :arrival_time,        null: false
+      t.string  :departure_time,      null: false
+      t.integer :stop_sequence,       null: false
+      t.string  :stop_headsign
+      t.integer :pickup_type
+      t.integer :drop_off_type
+      t.float   :shape_dist_traveled
+
+      t.references :data_set, null: false, index: true
+    end
+
+    add_index TABLE, :stop_id
+    add_index TABLE, :trip_id
+    add_index TABLE, :arrival_time
+    add_index TABLE, :departure_time
+  end
+end

data/db/migrate/20140401032609_create_gtfs_engine_agencies.rb

@@ -0,0 +1,19 @@
+class CreateGtfsEngineAgencies < ActiveRecord::Migration
+  TABLE = :gtfs_engine_agencies
+
+  def change
+    create_table TABLE do |t|
+      t.string :agency_id
+      t.string :agency_name,     null: false
+      t.string :agency_url,      null: false
+      t.string :agency_timezone, null: false
+      t.string :agency_lang
+      t.string :agency_fare_url
+      t.string :agency_phone
+
+      t.references :data_set, null: false, index: true
+    end
+
+    add_index TABLE, :agency_id
+  end
+end

data/db/migrate/20140405235947_create_gtfs_engine_fare_attributes.rb

@@ -0,0 +1,18 @@
+class CreateGtfsEngineFareAttributes < ActiveRecord::Migration
+  TABLE = :gtfs_engine_fare_attributes
+
+  def change
+    create_table TABLE do |t|
+      t.string  :fare_id,           null: false
+      t.float   :price,             null: false
+      t.string  :currency_type,     null: false
+      t.integer :payment_method,    null: false
+      t.integer :transfers
+      t.integer :transfer_duration
+
+      t.references :data_set, null: false, index: true
+    end
+
+    add_index TABLE, :fare_id
+  end
+end

data/db/migrate/20140406063500_create_gtfs_engine_fare_rules.rb

@@ -0,0 +1,17 @@
+class CreateGtfsEngineFareRules < ActiveRecord::Migration
+  TABLE = :gtfs_engine_fare_rules
+
+  def change
+    create_table TABLE do |t|
+      t.string :fare_id,        null: false
+      t.string :route_id
+      t.string :origin_id
+      t.string :destination_id
+      t.string :contains_id
+
+      t.references :data_set, null: false, index: true
+    end
+
+    add_index TABLE, :fare_id
+  end
+end

data/db/migrate/20140406071922_create_gtfs_engine_frequencies.rb

@@ -0,0 +1,17 @@
+class CreateGtfsEngineFrequencies < ActiveRecord::Migration
+  TABLE = :gtfs_engine_frequencies
+
+  def change
+    create_table TABLE do |t|
+      t.string  :trip_id,      null: false
+      t.integer :start_time,   null: false
+      t.integer :end_time,     null: false
+      t.integer :headway_secs, null: false
+      t.boolean :exact_times
+
+      t.references :data_set, null: false, index: true
+    end
+
+    add_index TABLE, :trip_id
+  end
+end

data/db/migrate/20140406072309_create_gtfs_engine_transfers.rb

@@ -0,0 +1,17 @@
+class CreateGtfsEngineTransfers < ActiveRecord::Migration
+  TABLE = :gtfs_engine_transfers
+
+  def change
+    create_table TABLE do |t|
+      t.string  :from_stop_id,      null: false
+      t.string  :to_stop_id,        null: false
+      t.integer :transfer_type,     null: false
+      t.integer :min_transfer_time
+
+      t.references :data_set, null: false, index: true
+    end
+
+    add_index TABLE, :from_stop_id
+    add_index TABLE, :to_stop_id
+  end
+end

data/db/migrate/20140406073548_create_gtfs_engine_feed_infos.rb

@@ -0,0 +1,16 @@
+class CreateGtfsEngineFeedInfos < ActiveRecord::Migration
+  TABLE = :gtfs_engine_feed_infos
+
+  def change
+    create_table TABLE do |t|
+      t.string :feed_publisher_name, null: false
+      t.string :feed_publisher_url,  null: false
+      t.string :feed_lang,           null: false
+      t.date   :feed_start_date
+      t.date   :feed_end_date
+      t.string :feed_version
+
+      t.references :data_set, null: false, index: true
+    end
+  end
+end

data/lib/ext.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/>.
+dir = File.dirname(__FILE__) + '/'
+
+Dir[dir + 'ext/**/*.rb'].each do |extension|
+  require extension[dir.length..-1]
+end

data/lib/ext/active_record/associations/association.rb

@@ -0,0 +1,41 @@
+# 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/>.
+#
+# Many GTFS associations reference arbitrary fields in the referenced table.
+# This requires the use of the +primary_key:+ named parameter. Coincidentally,
+# the name of the +foreign_key:+ is often the same as the referenced field. As
+# a convenience, this file adds a +shared_key:+ named parameter which simply
+# sets these two parameters to the same value.
+module ActiveRecord
+  module Associations
+    class Association
+      def build_record_with_shared_key(attributes)
+        share_key attributes
+        build_record_without_shared_key attributes
+      end
+      alias_method_chain :build_record, :shared_key
+
+      private
+
+      def share_key(attributes)
+        h = attributes.last
+        if Hash === h and h.key? :shared_key
+          key = h.delete :shared_key
+          h.reverse_merge! foreign_key: key, primary_key: key
+        end
+      end
+    end
+  end
+end

data/lib/gtfs_engine.rb

@@ -0,0 +1,33 @@
+# 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/>.
+require 'gtfs_reader'
+
+require 'gtfs_engine/engine'
+require 'gtfs_engine/exceptions'
+require 'gtfs_engine/json_responder'
+require 'gtfs_engine/sources'
+
+module GtfsEngine
+  extend ActiveSupport::Autoload
+
+  autoload :Concerns
+
+  class << self
+    def sources(&block)
+      @sources ||= Sources.new GtfsReader.config
+      block.call @sources
+    end
+  end
+end

data/lib/gtfs_engine/concerns.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::Concerns
+  extend ActiveSupport::Autoload
+
+  autoload :Controllers
+end

data/lib/gtfs_engine/concerns/controllers.rb

@@ -0,0 +1,20 @@
+# 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::Concerns::Controllers
+  extend ActiveSupport::Autoload
+
+  autoload :DataAccess
+  autoload :Gtfs
+end

data/lib/gtfs_engine/concerns/controllers/data_access.rb

@@ -0,0 +1,31 @@
+# A Controller +Concern+ for convenient access to the +DataSet+ specified in
+# the URL.
+module GtfsEngine::Concerns::Controllers::DataAccess
+  extend ActiveSupport::Concern
+
+  #@param param_key <Symbol> The key of the URL param to use as the feed's ID
+  #@return <DataSet>
+  def data(param_key=:data_set_id)
+    key = params[param_key]
+    (@data_sets ||= {})[key] =
+        Rails.cache.fetch "data_set_#{key}" do
+          if param_is_data_set_name? param_key
+            GtfsEngine::DataSet.where(name: key).newest
+          else
+            GtfsEngine::DataSet.find params[param_key]
+          end
+        end
+  end
+
+  def data_cache(key)
+    Rails.cache.fetch "#{data.id}::#{key}" do
+      yield
+    end
+  end
+
+  #@return <Bool> +true+ if the key is the name of the GTFS feed,
+  # instead of its ID
+  def param_is_data_set_name?(param_key)
+    not /[[:digit:]]/ === params[param_key].try(:first)
+  end
+end

data/lib/gtfs_engine/concerns/controllers/gtfs.rb

@@ -0,0 +1,158 @@
+# 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/>.
+#
+# This controller +Concern+ provides the functionality common among most of
+# the GTFS controllers.
+module GtfsEngine::Concerns::Controllers::Gtfs
+  extend ActiveSupport::Concern
+
+  included do
+    around_filter :gtfs_cache, only: [:index, :show]
+
+    rescue_from GtfsEngine::UnknownFilters,     with: :unknown_filter
+    rescue_from ActiveRecord::StatementInvalid, with: :statement_invalid
+    rescue_from ActiveRecord::RecordNotFound,   with: :record_not_found
+    helper_method :filter
+  end
+
+
+  module ClassMethods
+    #@return [Symbol] the unique key for this GTFS association
+    def gtfs_id(id=nil)
+      @gtfs_id = id unless id.nil?
+      @gtfs_id or controller_name.singularize.foreign_key
+    end
+
+    def filters(*attrs)
+      attrs.flatten!
+      @filters = attrs unless attrs.empty?
+      @filters ||= []
+    end
+
+    #@return [Class] the +ActiveRecord::Base+ class associated with this
+    #  controller
+    def record_class
+      @record_class ||= begin
+        "#{name.deconstantize}::#{controller_name.classify}".constantize
+      end
+    end
+  end
+
+
+  # GET / collection of elements for the given GTFS type
+  # The returned collection may be filtered with query parameters
+  def index
+    @records = query.empty? ? collection : filtered_collection
+    respond_with @records, template: 'gtfs_engine/gtfs/index'
+  end
+
+  # GET /:id for a specific element of the given GTFS type
+  def show
+    @record = record
+    respond_with @record, template: 'gtfs_engine/gtfs/show'
+  end
+
+  #@return <ActionController::Parameters> the map of fields to filter;
+  # derived from the query string
+  def filter
+    @filter ||= begin
+      query = self.query
+      unknown = query.map do |q, v|
+        query[q] = true if v.blank? # blank value indicates boolean filter
+        filters.include?(q.to_sym) ? nil : q
+      end.compact
+require 'pry'
+      binding.pry
+      unless unknown.empty?
+        raise GtfsEngine::UnknownFilters.new(unknown), 'unknown filter'
+      end
+      query_params = ActionController::Parameters.new query
+      query_params.permit filters
+    end
+  end
+
+  protected
+
+  #@return [ActiveRecord::Relation] all the records in this GTFS association
+  def collection
+    data.send controller_name
+  end
+
+  #@return [ActiveRecord::Relation] all the records in this GTFS
+  #  association that match the filter specified in the query string
+  def filtered_collection
+    collection.where filter
+  end
+
+  #@return [ActiveRecord::Base] the record identified by +params[:id]+ in this
+  #  GTFS association
+  def record
+    collection.find_by! gtfs_id => params[:id]
+  end
+
+  def gtfs_id
+    self.class.gtfs_id
+  end
+
+  def filters
+    self.class.filters
+  end
+
+  def query
+    request.query_parameters
+  end
+
+  private
+
+  def format
+    request.format.to_sym
+  end
+
+  def gtfs_cache
+    options = {
+      etag: [controller_name, data, query],
+      last_modified: data.updated_at,
+      public: true
+    }
+
+    expires_in 3.hours
+    yield if stale? options
+  end
+
+  #@param ex [GtfsEngine::UnknownFilter]
+  def unknown_filter(ex)
+    json = {status: 'fail', data: ex.to_hash}
+    render status: :bad_request, format => json
+  end
+
+  def statement_invalid(ex)
+    inner = ex.original_exception
+    case inner
+    when PG::InvalidDatetimeFormat, PG::DatetimeFieldOverflow
+      lines = inner.message.split "\n"
+      /.*"([^"]+)"[^"]+/ === lines[1][0..lines[2].size] and begin
+        json = {status: 'fail', data: {$1 => 'invalid date'}}
+        render status: :bad_request, format => json
+      end
+    else
+      raise ex
+    end
+  end
+
+  def record_not_found(ex)
+    json = {status: 'fail', data: {gtfs_id => params[:id]}}
+    render status: :not_found, format => json
+  end
+end