gtfs_data_exchange_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55227cd2cfda719fe4fa5dbcdccdbc5fe2d31892
+  data.tar.gz: 134868f0fc8283efd1e42eec70f2ce8ad74e5367
+SHA512:
+  metadata.gz: a3759c02a0e565d847a9fbad33813d288d13b080d224272b9703271dbde519606715a4b3ec0b0fd465ab6b176fb4389068356502a5ffb7b25b43e06fea7b4ed9
+  data.tar.gz: 48851796bf87c0709e4864daeaa8dfdf8d1ed8a927c6477e0e3595bac5696564c43865a1889ec62a9c02e168ed364c3efa2cfce0eca62c90c518b2828eac05bb

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gtfs-data_exchange.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 MJ Rossetti (@s2t2)
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# GTFS DataExchange API
+
+A ruby wrapper for the [gtfs-data-exchange.com](http://www.gtfs-data-exchange.com) [api](http://www.gtfs-data-exchange.com/api).
+
+List all agencies, or find a specific agency by its data exchange identifier.
+
+[![Gem Version](https://badge.fury.io/rb/gtfs-data_exchange.svg)](http://badge.fury.io/rb/gtfs-data_exchange)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gtfs_data_exchange_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gtfs_data_exchange_api
+
+## Usage
+
+### Agencies
+
+List all agencies.
+
+```` rb
+agencies = GTFSDataExchangeAPI.agencies
+````
+
+By default, this will return an `Array` of Ruby `Hash` objects. Pass the 'csv' format option to return a CSV `String` instead.
+
+```` rb
+agencies = GTFSDataExchangeAPI.agencies(:format => "csv")
+````
+
+### Agency
+
+Find an agency by its data exchange identifier.
+
+```` rb
+agency = GTFSDataExchangeAPI.agency(:dataexchange_id => "shore-line-east")
+````
+
+By default, this will return a Ruby `Hash` object.
+
+## Contributing
+
+1. [Fork the repo](https://github.com/data-creative/gtfs-data_exchange/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Test your changes (optional, but encouraged `rspec spec/`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+## Releasing
+
+> For instructions below, *X.X.X* refers to the gem version.
+
+1. Build gem (`gem build gtfs_data_exchange_api.gemspec`)
+2. Install gem locally (`gem install ./gtfs_data_exchange_api-X.X.X.gem`)
+3. Run tests (`bundle exec rspec spec/`) 
+4. Manually test, as desired:
+  + `pry`
+  + `require 'gtfs/data_exchange'`
+  + test functionality
+5. Merge version-named branch into master, if applicable
+6. Create and tag a version-named [release](https://github.com/data-creative/gtfs-data-exchange-api-ruby/releases/new)
+7. Push gem build to rubygems (`gem push gtfs-data_exchange-X.X.X.gem`)
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/gtfs_data_exchange_api.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gtfs_data_exchange_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gtfs_data_exchange_api"
+  spec.version       = GTFSDataExchangeAPI::VERSION
+  spec.authors       = ["MJ Rossetti (@s2t2)"]
+  spec.email         = ["s2t2mail+rubygems@gmail.com"]
+  spec.summary       = %q{A ruby wrapper for the gtfs-data-exchange.com api.}
+  spec.description   = %q{A ruby wrapper for the gtfs-data-exchange.com api. List all agencies, or find a specific agency by its data exchange identifier.}
+  spec.homepage      = "https://github.com/data-creative/gtfs-data-exchange-api-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_dependency "httparty", "~> 0.13"
+end

data/lib/gtfs_data_exchange_api.rb

@@ -0,0 +1,70 @@
+require "gtfs_data_exchange_api/version"
+require "httparty"
+
+# Contains all data exchange api (http://www.gtfs-data-exchange.com/api) methods and exceptions.
+module GTFSDataExchangeAPI
+
+  # The base url for api endpoints. This page also acts as the primary source for api reference documentation.
+  BASE_URL = "http://www.gtfs-data-exchange.com/api"
+
+  # List all agencies.
+  # @param [Hash] options the request options.
+  # @option options [String] :format ('json') the requested data format.
+  # @raise [UnsupportedRequestFormat] if the requested data format is not supported by the service.
+  # @raise [ResponseCodeError, ResponseDataError] for unexpected responses.
+  # @return [Array, String] the agencies data in the requested format.
+  def self.agencies(options = {})
+    format = options[:format] || "json"
+    raise UnsupportedRequestFormat, "The requested data format, '#{format}', is not supported by the service. Try 'csv' or 'json' instead." unless ["json","csv"].include?(format)
+
+    request_url = "#{BASE_URL}/agencies?format=#{format}"
+    response = HTTParty.get(request_url)
+
+    case format
+    when "json"
+      raise ResponseCodeError unless response["status_code"] == 200
+      raise ResponseDataError unless response["data"]
+      parsed_response_data = response["data"].map{|a| Hash[a.map{|k,v| [k.to_sym, (v == "" ? nil : v)]}]}
+      return parsed_response_data
+    when "csv"
+      raise ResponseCodeError unless response.code == 200
+      raise ResponseDataError unless response.body
+      return response.body
+    end
+  end
+
+  # Find an agency by its data exchange identifier.
+  # @param [Hash] options the request options.
+  # @option options [String] :dataexchange_id ('shore-line-east') the requested agency identifier.
+  # @raise [UnrecognizedDataExchangeId] if the requested agency identifier is unrecognized by the service.
+  # @raise [ResponseCodeError, ResponseDataError, ResponseAgencyError] for unexpected responses.
+  # @return [Hash] the agency data.
+  def self.agency(options = {})
+    dataexchange_id = options[:dataexchange_id] || options[:data_exchange_id] || "shore-line-east"
+
+    request_url = "#{BASE_URL}/agency?agency=#{dataexchange_id}"
+    response = HTTParty.get(request_url)
+    raise UnrecognizedDataExchangeId, "The requested dataexchange_id, '#{dataexchange_id}', was not recognized by the service." if response["status_code"] == 404 && response["status_txt"] == "AGENCY_NOT_FOUND"
+    raise ResponseCodeError unless response["status_code"] == 200
+    raise ResponseDataError unless response["data"]
+    raise ResponseAgencyError unless response["data"]["agency"]
+
+    parsed_agency_data = Hash[response["data"]["agency"].map{|k,v| [k.to_sym, (v == "" ? nil : v)]}]
+    return parsed_agency_data
+  end
+
+  # Exception raised if the service does not recognize the requested *dataexchange_id*.
+  class UnrecognizedDataExchangeId < ArgumentError ; end
+
+  # Exception raised if the service does not support the requested data format.
+  class UnsupportedRequestFormat < ArgumentError ; end
+
+  # Exception raised if the service returns an unexpected response code.
+  class ResponseCodeError < StandardError ; end
+
+  # Exception raised if the service returns unexpected or missing response data.
+  class ResponseDataError < StandardError ; end
+
+  # Exception raised if the service returns unexpected or missing agency data.
+  class ResponseAgencyError < StandardError ; end
+end

data/lib/gtfs_data_exchange_api/version.rb

@@ -0,0 +1,4 @@
+module GTFSDataExchangeAPI
+  # The current gem version. Reference the releases list (https://github.com/data-creative/gtfs-data-exchange-api-ruby/releases) for previous releases.
+  VERSION = "0.1.0"
+end

data/spec/gtfs_data_exchange_api_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+module GTFSDataExchangeAPI
+  describe "#agencies" do
+    it 'lists all agencies' do
+      agencies_response = [
+        {
+          "date_last_updated"=>1354248333.0,
+          "feed_baseurl"=>"",
+          "name"=>"A. Reich GmbH Busbetrieb",
+          "area"=>"",
+          "url"=>"http://www.vbb.de",
+          "country"=>"",
+          "state"=>"",
+          "license_url"=>"",
+          "dataexchange_url"=>"http://www.gtfs-data-exchange.com/agency/a-reich-gmbh-busbetrieb/",
+          "date_added"=>1354248333.0,
+          "is_official"=>false,
+          "dataexchange_id"=>"a-reich-gmbh-busbetrieb"
+        },
+        {
+          "date_last_updated"=>1417658131.0,
+          "feed_baseurl"=>"http://data.cabq.gov/transit/gtfs/google_transit.zip",
+          "name"=>"ABQ Ride",
+          "area"=>"Albuquerque",
+          "url"=>"http://myabqride.com",
+          "country"=>"United States",
+          "state"=>"New Mexico",
+          "license_url"=>"",
+          "dataexchange_url"=>"http://www.gtfs-data-exchange.com/agency/abq-ride/",
+          "date_added"=>1340739867.0,
+          "is_official"=>true,
+          "dataexchange_id"=>"abq-ride"
+        }
+      ]
+      parsed_agencies_response = agencies_response.map{|a| Hash[a.map{|k,v| [k.to_sym, (v == "" ? nil : v)]}]}
+      expect(parsed_agencies_response).to be_kind_of(Array)
+      expect(parsed_agencies_response.first).to be_kind_of(Hash)
+      expect(parsed_agencies_response.first[:dataexchange_id]).to be_kind_of(String)
+      expect(parsed_agencies_response.first[:feed_baseurl]).to be(nil)
+    end
+
+    it 'lists all agencies in CSV format' do
+      agencies = GTFSDataExchangeAPI.agencies(:format => "csv")
+      expect(agencies).to be_kind_of(String)
+      csv_result = CSV.parse(agencies, :headers => true)
+      expect(csv_result.headers).to include("dataexchange_id")
+      expect(csv_result.first).to be_kind_of(CSV::Row)
+      expect(csv_result.first.to_hash["dataexchange_id"]).to be_kind_of(String)
+    end
+
+    it 'explains why it is unable to return agencies data in an unsupported format' do
+      unsupported_format = "sql"
+      expect{ GTFSDataExchangeAPI.agencies(:format => unsupported_format) }.to raise_error
+    end
+  end
+
+  describe '#agency' do
+    it 'finds a specific agency by its data exchange identifier' do
+      requested_identifier = "metro-north-railroad"
+      agency_response = {
+        "date_last_updated"=>1394241933.0,
+         "feed_baseurl"=>"http://www.mta.info/developers/",
+         "name"=>"Metro North Railroad",
+         "area"=>"",
+         "url"=>" http://www.mta.info/mnr/index.html",
+         "country"=>"United States",
+         "state"=>"New York",
+         "license_url"=>"",
+         "dataexchange_url"=>"http://www.gtfs-data-exchange.com/agency/metro-north-railroad/",
+         "date_added"=>1263414635.0,
+         "is_official"=>true,
+         "dataexchange_id"=>"metro-north-railroad"
+      }
+      parsed_agency_response = Hash[agency_response.map{|k,v| [k.to_sym, (v == "" ? nil : v)]}]
+      expect(parsed_agency_response).to be_kind_of(Hash)
+      expect(parsed_agency_response[:dataexchange_id]).to eql(requested_identifier)
+      expect(parsed_agency_response[:area]).to be(nil)
+    end
+
+    it 'explains why it is unable to find an unrecognized agency' do
+      unrecognized_identifier = "my-railroad"
+      expect{ GTFSDataExchangeAPI.agency(:dataexchange_id => unrecognized_identifier) }.to raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+# http://stackoverflow.com/questions/4398262/setup-rspec-to-test-a-gem-not-rails
+require 'bundler/setup'
+Bundler.setup
+require 'gtfs_data_exchange_api'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: gtfs_data_exchange_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MJ Rossetti (@s2t2)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: A ruby wrapper for the gtfs-data-exchange.com api. List all agencies,
+  or find a specific agency by its data exchange identifier.
+email:
+- s2t2mail+rubygems@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gtfs_data_exchange_api.gemspec
+- lib/gtfs_data_exchange_api.rb
+- lib/gtfs_data_exchange_api/version.rb
+- spec/gtfs_data_exchange_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/data-creative/gtfs-data-exchange-api-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for the gtfs-data-exchange.com api.
+test_files:
+- spec/gtfs_data_exchange_api_spec.rb
+- spec/spec_helper.rb