gtfs-engine 1.0.0

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,
+            :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,42 @@
+# 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.set! controller_name do
+            json.array!(records) {|record| json.extract! record, *fields }
+          end
+        end
+      end
+    end
+
+    def show(json, record)
+      json.cache! record do
+        json.ignore_nil! true
+        json.status 'success'
+        json.data do
+          json.set! controller_name.singularize do
+            json.extract! record, *fields
+          end
+        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

data/app/models/gtfs_engine/calendar.rb

@@ -0,0 +1,78 @@
+# 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 Calendar < ActiveRecord::Base
+    belongs_to :data_set, inverse_of: :calendars
+
+    has_many :calendar_dates, inverse_of: :calendar, shared_key: :service_id
+    has_many :trips,          inverse_of: :calendar, shared_key: :service_id
+
+    has_many :routes, through: :trips
+    has_many :shapes, through: :trips
+
+    alias_attribute :dates, :calendar_dates
+
+
+    class << self
+      # @return <ActiveRecord_Relation> the set of Calendars that include the
+      #   given date.
+      # This method will add/remove entries listed in CalendarDate and will also
+      # filter out entries which don't match the correct day-of-week.
+      #
+      # TODO: Currently, this method does 3 SQL queries. Try to lower this.
+      def from_date_string(date)
+        dates = GtfsEngine::CalendarDate.where date: date
+
+        add = dates.where(exception_type: 1).pluck :service_id
+        query =
+          if add.any?
+            where '((start_date <= :date AND end_date >= :date)
+                   OR service_id IN (:ids)', date: date, ids: add
+          else
+            where '(start_date <= :date AND end_date >= :date)', date: date
+          end
+
+        query = where_day_of_week query, date
+
+        rem = dates.where(exception_type: 2).pluck :service_id
+        if rem.any?
+          query.where '(service_id NOT IN (?))', rem
+        else
+          query
+        end
+      end
+
+      private
+
+      # Modifies the given query to only matches the day of the week represented
+      # by the given date (format: YYYY-MM-DD)
+      def where_day_of_week(query, date_str)
+        case Date.new( *date_str.split('-').map(&:to_i) ).cwday
+        when 1 then query.where monday:    true
+        when 2 then query.where tuesday:   true
+        when 3 then query.where wednesday: true
+        when 4 then query.where thursday:  true
+        when 5 then query.where friday:    true
+        when 6 then query.where saturday:  true
+        else        query.where sunday:    true
+        end
+      end
+
+    end
+
+  end
+
+  DateFormatError = Class.new StandardError
+end

data/app/models/gtfs_engine/calendar_date.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
+  class CalendarDate < ActiveRecord::Base
+    belongs_to :data_set, inverse_of: :calendar_dates
+    belongs_to :calendar, inverse_of: :calendar_dates, shared_key: :service_id
+  end
+end

data/app/models/gtfs_engine/data_set.rb

@@ -0,0 +1,73 @@
+# 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 DataSet < ActiveRecord::Base
+    with_options inverse_of: :data_set, dependent: :delete_all do |set|
+      set.has_many :agencies
+      set.has_many :calendars
+      set.has_many :calendar_dates
+      set.has_many :fare_attributes
+      set.has_many :fare_rules
+      set.has_many :feed_infos
+      set.has_many :frequencies
+      set.has_many :routes
+      set.has_many :shapes
+      set.has_many :stops
+      set.has_many :stop_times
+      set.has_many :transfers
+      set.has_many :trips
+    end
+
+    scope :newest, -> { order(created_at: :desc).first }
+
+    #@return [Hash] a hash of each record type and the number of records in
+    #  this data set
+    def details
+      Rails.cache.fetch("gtfs_data_set_details_#{id}") { create_details }
+    end
+
+    def calendars_for_date(date_string)
+      Rails.cache.fetch "data[#{id}]_calendars[#{date_string}]" do
+        Calendar.from_date_string(date_string).where(data_set_id: id).to_a
+      end
+    end
+
+    private
+
+    def create_details
+      self.class.reflections.select do |name, assoc|
+        assoc.macro == :has_many && assoc.options[:inverse_of] == :data_set
+      end.each_with_object({}) do |(name, _), hash|
+        controller_class = association_controller_class name
+        hash[name] = {
+            count: send(name).count,
+            filters: controller_class.filters
+        }
+      end
+    end
+
+    def association_controller_class(name)
+      mod = self.class.name.deconstantize
+      controller = "#{name}_controller".classify
+      "#{mod}::#{controller}".constantize
+    end
+
+    def association_model_class(name)
+      mod = self.class.name.deconstantize
+      model = name.to_s.classify
+      "#{mod}::#{model}".constantize
+    end
+  end
+end

data/app/models/gtfs_engine/fare_attribute.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 FareAttribute < ActiveRecord::Base
+    belongs_to :data_set, inverse_of: :fare_attributes
+  end
+end

data/app/models/gtfs_engine/fare_rule.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 FareRule < ActiveRecord::Base
+    belongs_to :data_set, inverse_of: :trips
+    belongs_to :fare_attribute, inverse_of: :fare_rules,   shared_key: :fare_id
+    belongs_to :route,          inverse_of: :fare_rules,   shared_key: :route_id
+
+    with_options class_name: 'Stop', primary_key: :zone_id do |rule|
+      rule.belongs_to :origin,      inverse_of: :origin_rules,
+                                   foreign_key: :origin_id
+      rule.belongs_to :destination, inverse_of: :destination_rules,
+                                   foreign_key: :destination_id
+    end
+  end
+end

data/app/models/gtfs_engine/feed_info.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 FeedInfo < ActiveRecord::Base
+    belongs_to :data_set, inverse_of: :feed_infos
+  end
+end

data/app/models/gtfs_engine/frequency.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
+  class Frequency < ActiveRecord::Base
+    belongs_to :data_set, inverse_of: :frequencies
+    belongs_to :trip,     inverse_of: :frequencies, shared_key: :trip_id
+  end
+end

data/app/models/gtfs_engine/route.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 Route < ActiveRecord::Base
+    belongs_to :data_set, inverse_of: :routes
+
+    has_many :trips, inverse_of: :route, shared_key: :route_id
+
+    has_many :calendars, through: :trips
+    has_many :shapes,    through: :trips
+  end
+end