gtfs-data_exchange 0.0.2 → 0.0.3

data/.gitignore

@@ -13,3 +13,4 @@
 *.a
 mkmf.log
 *.gem
+.DS_Store

data/.rspec

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

data/README.md

@@ -1,6 +1,6 @@
 # GTFS::DataExchange
 
-A ruby wrapper for the [gtfs-data-exchange.com api](http://www.gtfs-data-exchange.com/api). List all agencies, or find a specific agency by its `dataexchange_id`.
+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.
 
 ## Installation
 
@@ -36,7 +36,7 @@ agencies = GTFS::DataExchange::API.agencies(:format => "csv")
 
 ### Agency
 
-Find an agency by its `dataexchange_id`.
+Find an agency by its data exchange identifier.
 
 ```` rb
 agency = GTFS::DataExchange::API.agency(:dataexchange_id => "shore-line-east")
@@ -48,6 +48,7 @@ By default, this will return a Ruby `Hash` object.
 
 1. Fork it ( https://github.com/databyday/gtfs-data_exchange/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+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

data/gtfs-data_exchange.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = GTFS::DataExchange::VERSION
   spec.authors       = ["MJ Rossetti (@s2t2)"]
   spec.email         = ["s2t2mail@gmail.com"]
-  spec.summary       = %q{A ruby wrapper for the [gtfs-data-exchange.com api](http://www.gtfs-data-exchange.com/api).}
-  spec.description   = %q{A ruby wrapper for the [gtfs-data-exchange.com api](http://www.gtfs-data-exchange.com/api). List all agencies, or find a specific agency by its `dataexchange_id`.}
+  spec.summary       = %q{A ruby wrapper for the gtfs-data-exchange.com api (http://www.gtfs-data-exchange.com/api).}
+  spec.description   = %q{A ruby wrapper for the 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.}
   spec.homepage      = "https://github.com/databyday/gtfs-data-exchange-api-ruby"
   spec.license       = "MIT"
 
@@ -21,5 +21,6 @@ Gem::Specification.new do |spec|
   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

@@ -1,23 +1,21 @@
 require "httparty"
 
-# Top-level namespace referencing the [General Transit Feed Specification](https://developers.google.com/transit/gtfs/).
+# Top-level namespace referencing the General Transit Feed Specification (https://developers.google.com/transit/gtfs/).
 module GTFS
 
-  # Namespace referencing the [data exchange](http://www.gtfs-data-exchange.com/), 
-  #   a third-party site "designed to help developers and transit agencies efficiently share and retrieve GTFS data."
+  # Namespace referencing the data exchange (http://www.gtfs-data-exchange.com/), a third-party site "designed to help developers and transit agencies efficiently share and retrieve GTFS data."
   module DataExchange
 
     # Contains all data exchange api methods and exceptions.
     class API
 
-      # The base url for api endpoints.
-      #   This page also acts as the primary source for api reference documentation.
+      # 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 request format is not supported by the service.
+      # @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 = {})
@@ -39,9 +37,9 @@ module GTFS
         end
       end
 
-      # Find an agency by its `dataexchange_id`.
+      # Find an agency by its data exchange identifier.
       # @param [Hash] options the request options.
-      # @option options [String] :dataexchange_id ('shore-line-east') the requested data format.
+      # @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.

data/lib/gtfs/data_exchange/version.rb

@@ -1,7 +1,7 @@
 module GTFS
   module DataExchange
 
-    # The current gem version. Reference the [releases list](https://github.com/databyday/gtfs-data-exchange-api-ruby/releases) for previous releases. 
-    VERSION = "0.0.2"
+    # The current gem version. Reference the releases list (https://github.com/databyday/gtfs-data-exchange-api-ruby/releases) for previous releases.
+    VERSION = "0.0.3"
   end
 end

data/spec/gtfs/data_exchange/api_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'pry'
+
+module GTFS
+  module DataExchange
+    describe API do
+
+      # Agencies
+
+      it 'lists all agencies' do
+        agencies = GTFS::DataExchange::API.agencies
+        expect(agencies).to be_kind_of(Array)
+        expect(agencies.first).to be_kind_of(Hash)
+        expect(agencies.first["dataexchange_id"]).to be_kind_of(String)
+      end
+
+      it 'lists all agencies in CSV format' do
+        agencies = GTFS::DataExchange::API.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{ GTFS::DataExchange::API.agencies(:format => unsupported_format) }.to raise_error
+      end
+
+      # Agency
+
+      it 'finds a specific agency by its data exchange identifier' do
+        specified_identifier = "metro-north-railroad"
+        agency = GTFS::DataExchange::API.agency(:dataexchange_id => specified_identifier)
+        expect(agency).to be_kind_of(Hash)
+        expect(agency["dataexchange_id"]).to eql(specified_identifier)
+      end
+
+      it 'explains why it is unable to find an unrecognized agency' do
+        unrecognized_identifier = "my-railroad"
+        expect{ GTFS::DataExchange::API.agency(:dataexchange_id => unrecognized_identifier) }.to raise_error
+      end
+    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'
+
+# 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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gtfs-data_exchange
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-28 00:00:00.000000000 Z
+date: 2014-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +59,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -75,8 +91,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.13'
-description: A ruby wrapper for the [gtfs-data-exchange.com api](http://www.gtfs-data-exchange.com/api).
-  List all agencies, or find a specific agency by its `dataexchange_id`.
+description: A ruby wrapper for the 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.
 email:
 - s2t2mail@gmail.com
 executables: []
@@ -84,6 +100,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -93,6 +110,8 @@ files:
 - lib/gtfs/data_exchange.rb
 - lib/gtfs/data_exchange/api.rb
 - lib/gtfs/data_exchange/version.rb
+- spec/gtfs/data_exchange/api_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/databyday/gtfs-data-exchange-api-ruby
 licenses:
 - MIT
@@ -117,6 +136,8 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: A ruby wrapper for the [gtfs-data-exchange.com api](http://www.gtfs-data-exchange.com/api).
-test_files: []
+summary: A ruby wrapper for the gtfs-data-exchange.com api (http://www.gtfs-data-exchange.com/api).
+test_files:
+- spec/gtfs/data_exchange/api_spec.rb
+- spec/spec_helper.rb
 has_rdoc: