transprt 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37769de876d6c551e33027f937f972c6a7b8c3bd
-  data.tar.gz: 0ea98dc958a2df6b632b2af56cb24d569fa0e97e
+  metadata.gz: 50047652bf414068ce0972cef66b2b1606f98773
+  data.tar.gz: 2af08e598c7326f1aa257f1ee0b03761ec321d65
 SHA512:
-  metadata.gz: 9e6f58ee195a1124a6ce8a8e8014ed7be496217da5beb6fc571122d610960d65d575ed92eb5472fe784c732d99f7830991ae0a2133342804bc6c5a11349e72dd
-  data.tar.gz: 9677cca5e16aa134cd8fb547e7a992a79d628bc8c1ca68844a664d9805934bddab2d2f26502720904affa11c4abf670949ede1faa6ae29a5933172986e787918
+  metadata.gz: d64dd8bf69522d816c2da877982d628552254b3cabfda9fa9109be859ec768f9c9a511aca1d33892f20a9b697a745b83b62128570d3820e51f44d18afebe76ab
+  data.tar.gz: f977ef47116e658412936c0a0da04aa7593a3a9e67d68ab6417e75981fb008af9718e38bc2c2332ce4633f85af76cc80214db7ebfcf21e355b83f7bac469538e

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Style/Documentation:
+  Include: []
+Metrics/MethodLength:
+  Max: 20

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+sudo: true
+rvm:
+ - 2.3.0
+ - 2.2.4
+
+script: bundle exec rake test

data/Gemfile

@@ -1,4 +1,3 @@
 source 'http://rubygems.org'
 
-# Specify your gem's dependencies in bramipsum.gemspec
 gemspec

data/Gemfile.lock

@@ -2,8 +2,8 @@ PATH
   remote: .
   specs:
     transprt (0.2.1)
-      json (>= 1.8.0)
-      rest-client (>= 1.6.7, < 2.1.0)
+      json
+      rest-client
 
 GEM
   remote: http://rubygems.org/
@@ -22,6 +22,7 @@ GEM
     mime-types-data (3.2016.0521)
     minitest (5.8.4)
     netrc (0.11.0)
+    rake (11.2.2)
     rest-client (2.0.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
@@ -39,7 +40,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  bundler
   minitest (~> 5.8.4)
+  rake
   transprt!
   webmock (~> 2.1.0)
 

data/README.md

@@ -1,7 +1,8 @@
 #transprt
 
-[![Gem Version](https://badge.fury.io/rb/transprt.png)](http://badge.fury.io/rb/transprt)
-[![Dependency Status](https://gemnasium.com/ghn/transprt.png)](https://gemnasium.com/ghn/transprt)
+[![Gem Version](https://badge.fury.io/rb/transprt.svg)](https://badge.fury.io/rb/transprt)
+[![Dependency Status](https://gemnasium.com/badges/github.com/ghn/transprt.svg)](https://gemnasium.com/github.com/ghn/transprt)
+[![Build Status](https://travis-ci.org/ghn/transprt.svg?branch=master)](https://travis-ci.org/ghn/transprt)
 
 Ruby client for the Swiss public transport API at http://transport.opendata.ch
 
@@ -61,6 +62,6 @@ Running the tests
 rake test
 ```
 
-##Licence
+## License
 
 MIT License (MIT)

data/Rakefile

@@ -2,5 +2,5 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
-  t.pattern = "test/*_test.rb"
+  t.pattern = 'test/*_test.rb'
 end

data/lib/transprt.rb

@@ -1,78 +1 @@
-require 'rubygems'
-require 'rest_client'
-require 'json'
-
-module Transprt
-  class Client
-    DEFAULT_DOMAIN = 'http://transport.opendata.ch'
-    VERSION = 'v1'
-
-    def initialize(domain=DEFAULT_DOMAIN, version=VERSION)
-      @domain = domain
-      @version = version
-    end
-
-    #
-    # => find locations
-    #
-    def locations(parameters)
-      allowed_parameters = ['query', 'x', 'y', 'type']
-
-      query = create_query(parameters, allowed_parameters)
-      locations = perform('locations', query)
-
-      locations['stations']
-    end
-
-    #
-    # => find connections
-    #
-    def connections(parameters)
-      allowed_parameters = ['from', 'to', 'via', 'date', 'time', 'isArrivalTime', 'transportations', 'limit', 'page',
-                            'direct', 'sleeper', 'couchette', 'bike']
-
-      query = create_query(parameters, allowed_parameters)
-      locations = perform('connections', query)
-
-      locations['connections']
-    end
-
-    #
-    # => find station boards
-    #
-    def stationboard(parameters)
-      allowed_parameters = ['station', 'id', 'limit', 'transportations', 'datetime']
-
-      query = create_query(parameters, allowed_parameters)
-      locations = perform('stationboard', query)
-
-      locations['stationboard']
-    end
-
-    private
-    attr_reader :domain, :version
-
-    def perform(endpoint, query)
-      url = "#{create_url(endpoint)}#{query}"
-      response = RestClient.get(url)
-
-      # Uncomment the line below to dump the response in order to generate
-      # a file to use as response stub in tests.
-      # File.write('/tmp/response.json', response)
-
-      JSON.parse(response)
-    end
-
-    def create_url(endpoint)
-      [domain, version, endpoint].join('/') + '?'
-    end
-
-    def create_query(parameters, allowed_parameters)
-      parameters.map do |k,v|
-        next unless allowed_parameters.include?(k.to_s)
-
-        "#{k}=#{URI.escape(v)}"
-      end.join('&')
-    end
-  end
-end
+require 'transprt/client'

data/lib/transprt/client.rb

@@ -0,0 +1,87 @@
+require 'rubygems'
+require 'rest_client'
+require 'json'
+
+require_relative 'rate_limiting'
+
+module Transprt
+  class Client
+    DEFAULT_DOMAIN = 'http://transport.opendata.ch'.freeze
+    VERSION = 'v1'.freeze
+
+    def initialize(domain = DEFAULT_DOMAIN, version = VERSION)
+      @domain = domain
+      @version = version
+    end
+
+    #
+    # => find locations
+    #
+    def locations(parameters)
+      allowed_parameters = %w(query x y type)
+
+      query = create_query(parameters, allowed_parameters)
+      locations = perform('locations', query)
+
+      locations['stations']
+    end
+
+    #
+    # => find connections
+    #
+    def connections(parameters)
+      allowed_parameters = %w(from to via date time isArrivalTime
+                              transportations limit page direct sleeper
+                              couchette bike)
+
+      query = create_query(parameters, allowed_parameters)
+      locations = perform('connections', query)
+
+      locations['connections']
+    end
+
+    #
+    # => find station boards
+    #
+    def stationboard(parameters)
+      allowed_parameters = %w(station id limit transportations datetime)
+
+      query = create_query(parameters, allowed_parameters)
+      locations = perform('stationboard', query)
+
+      locations['stationboard']
+    end
+
+    private
+
+    attr_reader :domain, :version
+
+    def perform(endpoint, query)
+      url = "#{create_url(endpoint)}#{query}"
+
+      response = limiter.get(url)
+
+      # Uncomment the line below to dump the response in order to generate
+      # a file to use as response stub in tests.
+      # File.write('/tmp/response.json', response)
+
+      JSON.parse(response)
+    end
+
+    def create_url(endpoint)
+      [domain, version, endpoint].join('/') + '?'
+    end
+
+    def create_query(parameters, allowed_parameters)
+      parameters.map do |k, v|
+        next unless allowed_parameters.include?(k.to_s)
+
+        "#{k}=#{CGI.escape(v)}"
+      end.join('&')
+    end
+
+    def limiter
+      @limiter ||= RateLimiting.new
+    end
+  end
+end

data/lib/transprt/rate_limiting.rb

@@ -0,0 +1,48 @@
+module Transprt
+  class RateLimiting
+    # Performs HTTP queries while respecting the rate limit.
+
+    # @param wait_for_quota [Boolean] whether to wait for quota reset
+    #        and query again if the rate limit (300 requests/s) is exceeded.
+    def initialize(wait_for_quota = true)
+      @wait_for_quota = wait_for_quota
+    end
+
+    # @return The HTTP response or nil if we're hitting the rate limit and
+    #         wait_for_quota is false (@see #initialize).
+    def get(url)
+      begin
+        response = perform_get(url)
+      rescue RestClient::TooManyRequests => e
+        # API uses HTTP 429 to notify us,
+        # @see https://github.com/OpendataCH/Transport/blob/master/lib/Transport/Application.php
+
+        return nil unless wait_for_quota
+
+        sleep_until_quota_reset(e.response)
+        response = perform_get(url)
+      end
+
+      response
+    end
+
+    private
+
+    attr_reader :wait_for_quota
+
+    def perform_get(url)
+      RestClient.get(url)
+    end
+
+    def sleep_until_quota_reset(response)
+      # NOTE We rely on the local clock being synchronized
+      # with the server clock.
+
+      reset_at = response.headers['X-Rate-Limit-Reset'].to_i
+      delta = reset_at - Time.now.to_i
+
+      return if delta < 0
+      sleep delta
+    end
+  end
+end

data/test/client_test.rb

@@ -2,7 +2,6 @@ require 'test_helper'
 require 'pp'
 
 class ClientTest < Minitest::Test
-
   def setup
     WebMock.reset!
 
@@ -18,8 +17,8 @@ class ClientTest < Minitest::Test
 
     first_location = locations.first
 
-    assert first_location['id'] == "008501008"
-    assert first_location['name'] == "Genève"
+    assert first_location['id'] == '008501008'
+    assert first_location['name'] == 'Genève'
   end
 
   def test_connections
@@ -38,15 +37,40 @@ class ClientTest < Minitest::Test
   end
 
   def test_escaping
-    # This makes sure the umlaut below gets escaped, if not we'll see an URI::InvalidURIError
-    stub_request(:get, /.*/).to_return(status: 200, body: {'connections': nil}.to_json)
+    stub_request(:get, /.*/).to_return(
+      status: 200,
+      body: { connections: nil }.to_json)
+
+    # The following line fails with an URI::InvalidURIError
+    # should the umlaut in 'Zurich' not get escaped.
+    @client.connections from: 'Lausanne', to: 'Zürich'
+  end
 
-    connections = @client.connections from: 'Lausanne', to: 'Zürich'
+  def test_rate_limit
+    request_count = 0
+
+    stub_request(:get, /.*/).to_return do
+      request_count += 1
+
+      if request_count == 1 # First request fails.
+        # Mock "rate limit hit" response code
+        { status: 429,
+          headers: { 'X-Rate-Limit-Reset' => Time.now.to_i.to_s } }
+      elsif request_count == 2 # Second request succeeds.
+        { status: 200, body: { connections: nil }.to_json }
+      else
+        raise "Did not expect request_count to be #{request_count}"
+      end
+    end
+
+    @client.connections from: 'Lausanne', to: 'Bern'
+    assert request_count == 2
   end
 
-  def stub_response(name, url=/.*/, method=:get)
-    # Uncomment lines below should you feel the urge to test against the live API
-    # as the stubbing isn't very thorough as of now. (e.g. URLs requested aren't checked)
+  def stub_response(name, url = /.*/, method = :get)
+    # Uncomment lines below should you feel the urge to test against the live
+    # API as the stubbing isn't very thorough as of now. (e.g. URLs requested
+    # aren't checked)
     # WebMock.allow_net_connect!
     # return
 

data/test/test_helper.rb

@@ -5,4 +5,3 @@ require 'minitest/pride'
 require 'webmock/minitest'
 
 require 'transprt'
-

data/transprt.gemspec

@@ -1,24 +1,22 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-
 Gem::Specification.new do |gem|
-  gem.name = "transprt"
-  gem.version = '0.2.1'
-  gem.authors = ["ghn"]
-  gem.email = ["ghugon@gmail.com"]
-  gem.description = %q{Ruby client for the Swiss public transport API}
-  gem.summary = "Swiss public transport API"
+  gem.name = 'transprt'
+  gem.version = '0.2.2'
+  gem.authors = ['ghn']
+  gem.email = ['ghugon@gmail.com']
+  gem.description = 'Ruby client for the Swiss public transport API'
+  gem.summary = 'Ruby client for the Swiss public transport API'
   gem.homepage = 'https://github.com/ghn/transprt'
-  gem.license = "MIT"
+  gem.license = 'MIT'
 
-  gem.files = `git ls-files`.split($/)
+  gem.files = `git ls-files`.split($RS)
   gem.executables = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
   gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
-  gem.add_dependency('rest-client', '>=1.6.7', '<2.1.0')
-  gem.add_dependency('json', '>= 1.8.0')
+  gem.add_dependency('rest-client')
+  gem.add_dependency('json')
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency('rake')
   gem.add_development_dependency('minitest', '~> 5.8.4')
   gem.add_development_dependency('webmock', '~> 2.1.0')
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transprt
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - ghn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-15 00:00:00.000000000 Z
+date: 2016-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,34 +16,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.7
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.7
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +102,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -87,6 +112,8 @@ files:
 - Rakefile
 - example.rb
 - lib/transprt.rb
+- lib/transprt/client.rb
+- lib/transprt/rate_limiting.rb
 - test/client_test.rb
 - test/responses/client_test_test_connections.json
 - test/responses/client_test_test_locations.json
@@ -115,7 +142,7 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Swiss public transport API
+summary: Ruby client for the Swiss public transport API
 test_files:
 - test/client_test.rb
 - test/responses/client_test_test_connections.json