gtfs-geojson 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf0802ca353854ab37535916e773d218dd124777
-  data.tar.gz: 0fbfd39b2ba56f71fbe012d14d8bcced4ff103a4
+  metadata.gz: 0cf8cde58aae1fc47ea83fc736c9098dda567c7b
+  data.tar.gz: fdafe8a7355e0a96085dc985551bc4a825287adc
 SHA512:
-  metadata.gz: 9c7170ff74b74d89ba3c53eaed0ef0be9c403cd758f645ae0b25792c4f78c2cd29903302bf4c735141d33ed1aa7bc4ac9c1f5e1b651b3505904861cd6c328fa7
-  data.tar.gz: 77f0ff96a0526e6ac966bf4df2b47fe7bbba3323d6c6ac5b0463351f29b0fed0fd02965b9b3ee41bdc4a494420fc755bd94255bb6a89b2d41aba41535e4bef5d
+  metadata.gz: 1e87025d9031bb79f5bf70a8f1abfd84a02bbf6077664b4e4666a8aa883c6a433682b2abfa634b2f4b1682a577a8554e61b3c0835607c53b17c629bdf9cee4bd
+  data.tar.gz: 656d7cdf40cc6269d517b2e3c8d711fa51b668856a74bd001bacbb4a44a3373672179933a3b0df078b1ac41558387e99cf5861c9132cc14b45e2f4caa8ffae94

data/Gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'gtfs'
-gem 'minitest'
-gem 'simplecov'
+gem 'gtfs', '~>0.2.5'
+gem 'minitest', '~>5.8.4'
+gem 'simplecov', '~>0.11.2'
+gem 'gtfs-realtime-bindings', '~>0.0.5'

data/Gemfile.lock

@@ -1,30 +1,50 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
     docile (1.1.5)
     gtfs (0.2.5)
       multi_json
       rake
       rubyzip (~> 1.1)
+    gtfs-realtime-bindings (0.0.5)
+      protobuf (>= 3.0)
+    i18n (0.7.0)
     json (1.8.3)
+    middleware (0.1.0)
     minitest (5.8.4)
-    multi_json (1.11.2)
-    rake (10.5.0)
-    rubyzip (1.1.7)
+    multi_json (1.11.3)
+    protobuf (3.6.7)
+      activesupport (>= 3.2)
+      middleware
+      thor
+      thread_safe
+    rake (11.1.2)
+    rubyzip (1.2.0)
     simplecov (0.11.2)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
   x64-mingw32
 
 DEPENDENCIES
-  gtfs
-  minitest
-  simplecov
+  gtfs (~> 0.2.5)
+  gtfs-realtime-bindings (~> 0.0.5)
+  minitest (~> 5.8.4)
+  simplecov (~> 0.11.2)
 
 BUNDLED WITH
    1.11.2

data/README.md

@@ -1,18 +1,49 @@
 # gtfs-geojson
+[![Circle CI](https://circleci.com/gh/tyleragreen/gtfs-geojson.svg?style=svg)](https://circleci.com/gh/tyleragreen/gtfs-geojson)
 
-A Ruby utility to convert the shapes.txt file of a GTFS feed into a GeoJSON file.
+gtfs-geojson is a Ruby utility to convert the shapes.txt file of a GTFS feed into a GeoJSON file. It uses the [GTFS](https://github.com/nerdEd/gtfs) gem to validate GTFS feeds and wrap the feed data into usable objects. Two command-line utilities are also included with a gem install.
+
+## Installation
+
+Add the following to your Gemfile.
+```
+gem 'gtfs-geojson'
+```
+or install the gem through the command line.
+```
+gem install `gtfs-geojson`
+```
+
+## Command-Line Utilities
+Convert a GTFS feed shapes.txt file into a GeoJSON file.
+```
+gtfs_to_geojson gtfs.zip output.geojson
+```
+Print a human-readable form of a GTFS-realtime feed.
+```
+gtfs-rt_to_json http://developer.mbta.com/lib/GTRTFS/Alerts/VehiclePositions.pb positions.json
+```
+
+## Usage
+
+```
+require 'gtfs-geojson'
+geojson = GTFS::GeoJSON.generate("gtfs.zip")
+File.open("gtfs.geojson",'w') do { |f| f.write(geojson) }
+```
 
 ## Develop Locally
+To develop locally, clone the repository and run bundler to setup the necessary gems.
 ```
 bundle install
 ```
-### Run Tests
+#### Run Tests
 ```
-rake
+bundle exec rake
 ```
-### Run Tests and Collect Code Coverage
+#### Run Tests and Collect Code Coverage
 ```
-rake coverage
+bundle exec rake coverage
 ```
-## Issues
+## Contribute
 Please contact Tyler at [greent@tyleragreen.com](mailto:greent@tyleragreen.com) or file a GitHub Issue with any ideas or suggestions.

data/bin/gtfs-rt_to_json

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+#
+# A command-line tool to convert a GTFS-realtime protocol buffer (*.pb)
+# into a human-readable JSON output. This is useful to verify the
+# data from the GTFS-realtime feed before consuming it in another application.
+#
+# Usage: gtfs-rt_to_json <gtfs-realtime_feed_path> <json_output_path>
+#
+# Author: Tyler A. Green (greent@tyleragreen.com)
+#
+require 'google/transit/gtfs-realtime.pb'
+require 'net/http'
+require 'json'
+
+raise StandardError, "Two arguments required." if ARGV.length < 2
+
+data = Net::HTTP.get(URI.parse(ARGV[0]))
+feed = Transit_realtime::FeedMessage.decode(data)
+
+f = File.open(ARGV[1],'w')
+f.write(JSON.pretty_generate(feed))
+f.close

data/bin/gtfs_to_geojson

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+#
+# A command-line tool to convert a GTFS feed shapes.txt file
+# into a GeoJSON file.
+#
+# Usage: gtfs_to_geojson <gtfs_feed_path> <geojson_output_path>
+#
+# Author: Tyler A. Green (greent@tyleragreen.com)
+#
+require_relative '../lib/gtfs-geojson'
+
+raise StandardError, "Two arguments required." if ARGV.length < 2
+
+geojson = GTFS::GeoJSON.generate(ARGV[0])
+f = File.open(ARGV[1],'w') 
+f.write(geojson)
+f.close

data/gtfs-geojson.gemspec

@@ -14,11 +14,13 @@ Gem::Specification.new do |gem|
   gem.license     = 'MIT'
 
   gem.add_dependency 'gtfs', '0.2.5'
+  gem.add_dependency 'gtfs-realtime-bindings', '0.0.5'
 
   gem.add_development_dependency 'simplecov', '0.11.2'
   gem.add_development_dependency 'minitest',  '5.8.4'
 
   gem.files        = `git ls-files`.split("\n")
   gem.test_files   = `git ls-files -- test/*`.split("\n")
+  gem.executables  = ["gtfs-rt_to_json","gtfs_to_geojson"]
   gem.require_path = 'lib'
 end

data/lib/gtfs-geojson.rb

@@ -8,11 +8,15 @@ module GTFS
   module GeoJSON
 
     def self.generate(path)
+      raise ArgumentError if !File.exist?(path)
+
+      # Confirm the GTFS feed is valid
       source = GTFS::Source.build(path,{strict:true})
       
       routes   = {}
       features = []
-      
+     
+      # Group the routes by the route id 
       source.shapes.each do |shape|
         if routes[shape.id]
           routes[shape.id] << shape
@@ -21,14 +25,21 @@ module GTFS
         end
       end
       
+      # Process the data a route at a time
       routes.each do |route,points|
         coordinates = []
+
+        # Sort the points by their point sequence ID, as it may be
+        # out of order in the GTFS feed, but must be in order to appear
+        # correct for GeoJSON
         points.sort! { |a,b| a.pt_sequence.to_i <=> b.pt_sequence.to_i }
       
+        # Add each sorted point to a list of coordinates for this route
         points.each do |point|
           coordinates << [ point.pt_lon.to_f, point.pt_lat.to_f ]
         end
-      
+
+        # Construct a feature and add it to the feature list for this route
         features << { type: 'Feature',
                       properties: { name: route
                                   },
@@ -39,6 +50,8 @@ module GTFS
       
       end
       
+      # Create the GeoJSON file by generating a JSON string wrapped 
+      # in a FeatureCollection
       return JSON.generate({type: 'FeatureCollection', features: features})
     end
   end

data/lib/gtfs-geojson/version.rb

@@ -1,5 +1,5 @@
 module GTFS
   module GeoJSON
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/test/test.rb

@@ -3,6 +3,11 @@
 require_relative 'test_helper'
 
 class TestGtfs < Minitest::Test
+
+  def test_invalid_file_fails_cleanly
+    assert_raises(ArgumentError) { GTFS::GeoJSON.generate("non_existent_file") }
+  end
+
   def test_valid_gtfs
     geojson = GTFS::GeoJSON.generate("test/fixtures/valid_gtfs.zip")
     shapes  = File.read("test/fixtures/shapes.geojson")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gtfs-geojson
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - tyleragreen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-12 00:00:00.000000000 Z
+date: 2016-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gtfs
@@ -24,6 +24,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.2.5
+- !ruby/object:Gem::Dependency
+  name: gtfs-realtime-bindings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -56,7 +70,9 @@ description: gtfs-geojson is a Ruby utility to convert the shapes.txt file from
   GTFS feed into a GeoJSON file.
 email:
 - greent@tyleragreen.com
-executables: []
+executables:
+- gtfs-rt_to_json
+- gtfs_to_geojson
 extensions: []
 extra_rdoc_files: []
 files:
@@ -65,6 +81,8 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- bin/gtfs-rt_to_json
+- bin/gtfs_to_geojson
 - gtfs-geojson.gemspec
 - lib/gtfs-geojson.rb
 - lib/gtfs-geojson/version.rb
@@ -93,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Convert GTFS to GeoJSON