gtfs_engine 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e84da8bed1f68352eaf059a895bd270f31e7d0a
-  data.tar.gz: 2f5e288cfce8186cc9e54ec22d664ff972866c65
+  metadata.gz: 41bacc2ca460c53a0d6bfab8dad6a6accba8d24d
+  data.tar.gz: 92aad173090d8dd6105e35e1e40d9603e197d5ea
 SHA512:
-  metadata.gz: c98750840af8e9d732371abfb185f3fd9b5c036c503cccb95975ec4e0c4f9b1be063b9647d3b345c52ba3edcb318beb53833201661e43aa986b42b1d00b8cc54
-  data.tar.gz: def1c054d81f293665ec81b1afd38f2a4d42562092e7df5461aed213355172e2c9fc2a70b931acca02cb432009533459d6e4508d218d2f4a5d12ff1b1ee83fa5
+  metadata.gz: a7ee299a9408d4d277c9006cf08d1184d98c1e81e4a7fb16127bb5b9b639e4256bf3da6f88a2abd6f6431f068a9b711d9162443a5a6e86463b7da819a9c1a7d8
+  data.tar.gz: 30b80c487979031d30a18af1ab036f5f2fd0cd85fcb4a447df21d9aae97a65a8fa154a6809c37287562a063f138451d63741b3430de6a97cd0478e82814b2d81

data/app/helpers/gtfs_engine/default_views_helper.rb

@@ -17,21 +17,15 @@ module GtfsEngine
     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
+        json.array!(records) {|record| json.extract! record, *fields }
       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
+        json.extract! record, *fields
       end
     end
   end

data/app/views/gtfs_engine/data_sets/{show.json.jbuilder → index.json.jsend}

@@ -12,8 +12,11 @@
 #
 # 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/>.
-json.status 'success'
-json.data do
-  json.extract! @data_set, *%i(id name title url etag created_at)
-  json.details @data_set.details
+json.ignore_nil! true
+@data_sets.each do |name, sets|
+  json.set! name do
+    json.array! sets do |set|
+      json.extract! set, *%i(id name title url etag created_at)
+    end
+  end
 end

data/app/views/gtfs_engine/data_sets/show.json.jsend

@@ -0,0 +1,16 @@
+# 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/>.
+json.extract! @data_set, *%i(id name title url etag created_at)
+json.details @data_set.details

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

@@ -1,8 +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/>.
+
 # 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)
@@ -17,12 +33,12 @@ module GtfsEngine::Concerns::Controllers::DataAccess
         end
   end
 
+
   def data_cache(key)
-    Rails.cache.fetch "#{data.id}::#{key}" do
-      yield
-    end
+    Rails.cache.fetch("#{data.id}::#{key}") { yield }
   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)

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

@@ -18,6 +18,7 @@
 module GtfsEngine::Concerns::Controllers::Gtfs
   extend ActiveSupport::Concern
 
+
   included do
     around_filter :gtfs_cache, only: [:index, :show]
 
@@ -35,12 +36,14 @@ module GtfsEngine::Concerns::Controllers::Gtfs
       @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
@@ -58,12 +61,14 @@ module GtfsEngine::Concerns::Controllers::Gtfs
     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
@@ -73,8 +78,7 @@ module GtfsEngine::Concerns::Controllers::Gtfs
         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
@@ -83,39 +87,48 @@ require 'pry'
     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
@@ -131,28 +144,34 @@ require 'pry'
     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
+    render status: :bad_request, jsend: {
+      error: 'unknown filter', data: ex.to_h
+    }
   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
+        render status: :bad_request, jsend: {
+          message: 'invalid date', data: {$1 => 'invalid date'}
+        }
       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
+    render status: :not_found, jsend: {
+      error: 'record not found', data: {gtfs_id => params[:id]}
+    }
   end
 end

data/lib/gtfs_engine/engine.rb

@@ -12,6 +12,11 @@
 #
 # 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/>.
+
+# The following line is required for jsend_wrapper/rails to be available when
+# mounted in another rails application.
+require 'jsend_wrapper/rails'
+
 module GtfsEngine
   class Engine < ::Rails::Engine
     isolate_namespace GtfsEngine

data/lib/gtfs_engine/exceptions.rb

@@ -19,17 +19,18 @@ module GtfsEngine
   class UnknownFilters < Error
     attr_reader :fields
 
+
     #@param fields [Array<String>] the names of the unknown fields which the
     # caller tried to filter with
     def initialize(fields)
       @fields = fields
     end
 
+
     def to_hash
-      fields.each_with_object({}) do |field, hash|
+      fields.each_with_object( {} ) do |field, hash|
         hash[field] = message
       end
     end
   end
 end
-

data/lib/gtfs_engine/json_responder.rb

@@ -24,8 +24,10 @@ class GtfsEngine::JsonResponder < ActionController::Responder
   protected
 
   def display_errors
-    status_code = options[:status] || :unprocessable_entity
-    data = { status: 'error', data: resource_errors[:errors] }
-    controller.render format => data, status: status_code
+    options[:status] ||= :unprocessable_entity
+
+    controller.render status: options[:status], jsend: {
+        error: 'could not process request', data: resource_errors[:errors]
+    }
   end
 end

data/lib/gtfs_engine/version.rb

@@ -16,7 +16,7 @@ module GtfsEngine
   module Version
     # The following four lines are generated, so don't mess with them.
     MAJOR = 1
-    MINOR = 2
+    MINOR = 3
     PATCH = 0
     BUILD = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gtfs_engine
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Jon Sangster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-18 00:00:00.000000000 Z
+date: 2014-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: jsend_wrapper-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: pry-rails
   requirement: !ruby/object:Gem::Requirement
@@ -122,8 +150,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-description: 'A Rails Engine to provide a basic RESTful interface for GTFS feeds.
-  GTFS Spec: https://developers.google.com/transit/gtfs'
+description: 'Reads and parses zip files conforming to Google''s GTFS spec. GTFS Spec:
+  https://developers.google.com/transit/gtfs'
 email: jon@ertt.ca
 executables:
 - rails
@@ -164,15 +192,15 @@ files:
 - app/models/gtfs_engine/stop_time.rb
 - app/models/gtfs_engine/transfer.rb
 - app/models/gtfs_engine/trip.rb
-- app/views/gtfs_engine/calendars/dates.json.jbuilder
-- app/views/gtfs_engine/data_sets/index.json.jbuilder
-- app/views/gtfs_engine/data_sets/show.json.jbuilder
-- app/views/gtfs_engine/gtfs/index.json.jbuilder
-- app/views/gtfs_engine/gtfs/show.json.jbuilder
-- app/views/gtfs_engine/transfers/from.json.jbuilder
-- app/views/gtfs_engine/transfers/from_to.json.jbuilder
-- app/views/gtfs_engine/transfers/to.json.jbuilder
-- app/views/gtfs_engine/trips/block.json.jbuilder
+- app/views/gtfs_engine/calendars/dates.json.jsend
+- app/views/gtfs_engine/data_sets/index.json.jsend
+- app/views/gtfs_engine/data_sets/show.json.jsend
+- app/views/gtfs_engine/gtfs/index.json.jsend
+- app/views/gtfs_engine/gtfs/show.json.jsend
+- app/views/gtfs_engine/transfers/from.json.jsend
+- app/views/gtfs_engine/transfers/from_to.json.jsend
+- app/views/gtfs_engine/transfers/to.json.jsend
+- app/views/gtfs_engine/trips/block.json.jsend
 - bin/rails
 - config/initializers/extensions_loader.rb
 - config/routes.rb

data/app/views/gtfs_engine/data_sets/index.json.jbuilder

@@ -1,26 +0,0 @@
-# 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/>.
-json.ignore_nil! true
-
-json.status 'success'
-json.data do
-  @data_sets.each do |name, sets|
-    json.set! name do
-      json.array! sets do |set|
-        json.extract! set, *%i(id name title url etag created_at)
-      end
-    end
-  end
-end