tfl_api_client 0.2.1 → 0.3.1

data/spec/support/helpers.rb

@@ -1,81 +0,0 @@
-#
-# Copyright (c) 2015 - 2017 Luke Hackett
-#
-# 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.
-#
-
-require 'uri'
-
-module Helpers
-
-  # Returns a new instance of the TflApi::Client class using authorised details.
-  # All calls to the API using this object should return the expected data.
-  #
-  # @return [TflApi::Client] A TflApi::Client instance created with valid credentials
-  #
-  def authorised_client
-    # Fail early if the Application private and public keys are not set
-    fail 'Please set your app id via the TFL_APP_ID environment variable' unless ENV['TFL_APP_ID']
-    fail 'Please set your app key via the TFL_APP_KEY environment variable' unless ENV['TFL_APP_KEY']
-
-    TflApi::Client.new(app_id: ENV['TFL_APP_ID'], app_key: ENV['TFL_APP_KEY'], log_location: '/dev/null')
-  end
-
-  # Returns a new instance of the TflApi::Client class using unauthorised details.
-  # All calls to the API using this object should result in unauthorised access
-  # errors from the TFL API.
-  #
-  # @return [TflApi::Client] A TflApi::Client instance created with invalid credentials
-  #
-  def unauthorised_client
-    TflApi::Client.new(app_id: 123, app_key: 456, log_location: '/dev/null')
-  end
-
-  # Returns a new instance of the TflApi::Client class using test details.
-  # This client should only be used within Unit Tests, as the host has been
-  # fixed to a dummy value.
-  #
-  # @return [TflApi::Client] A TflApi::Client instance created with invalid credentials
-  #
-  def test_client
-    TflApi::Client.new(app_id: 12345, app_key: 6789, host: 'https://somehost', log_location: '/dev/null')
-  end
-
-  # Performs a HTTP stubbed request for the given method upon the given resource.
-  # Optional params can be given to be appended to the URL, whilst the to_return
-  # allows for specific return information to be set.
-  #
-  # @param method [Symbol] The type of stub request, e.g. :get, :post etc
-  # @param resource [String] The resource path to stub
-  # @param to_return [Hash] Response to return upon issuing the request
-  #
-  # @option params [Hash] A hash of URL params to add to the URI
-  #
-  # @return [WebMock::RequestStub] A WebMock::RequestStub instance
-  #
-  def stub_api_request(method, resource, params={}, to_return)
-    params_string = URI.encode_www_form(params)
-    uri = URI.parse("https://somehost/#{resource}?#{params_string}&app_id=12345&app_key=6789")
-    stub_request(method.to_sym, uri).to_return(to_return)
-  end
-
-end

data/spec/unit/bike_point_spec.rb

@@ -1,87 +0,0 @@
-#
-# Copyright (c) 2015 - 2017 Luke Hackett
-#
-# 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.
-#
-
-require_relative '../spec_helper'
-
-
-describe TflApi::Client::BikePoint do
-  let!(:client) { TflApi::Client.new(app_id: 123, app_key: 456) }
-  let!(:bike_point) { TflApi::Client::BikePoint.new(client) }
-  let(:sample_response) do
-    [{
-      'id' => 1,
-      'url' => 'https://someurl/path/to/resource',
-      'name' => 'Test Response',
-      'additionalProperties' => [
-          { 'foo' => 'bar', 'age' => 1234 },
-          { 'baz' => 'foo', 'age' => 5678 }
-      ]
-    }]
-  end
-  
-  describe '#locations' do
-    before  { allow(client).to receive(:get).with('/BikePoint').and_return(sample_response) }
-    subject { bike_point.locations }
-
-    it { is_expected.to be_an(Array) }
-    it { is_expected.to eq(sample_response) }
-  end
-
-  describe '#location' do
-    before  { allow(client).to receive(:get).with('/BikePoint/SOME_ID').and_return(sample_response.first) }
-    subject { bike_point.location('SOME_ID') }
-
-    it { is_expected.to be_a(Hash) }
-    it { is_expected.to eq(sample_response.first) }
-  end
-
-  describe '#locations_within_locus' do
-    let(:query) { { lat: 1, lon: 2, radius: 3 } }
-    before  {  allow(client).to receive(:get).with('/BikePoint', query).and_return(sample_response) }
-    subject { bike_point.locations_within_locus(query[:lat], query[:lon], query[:radius]) }
-
-    it { is_expected.to be_an(Array) }
-    it { is_expected.to eq(sample_response) }
-  end
-
-  describe '#locations_within_bounding_box' do
-    let(:query) { { swLat: 1, swLon: 2, neLat: 3, neLon: 4 } }
-    before  { allow(client).to receive(:get).with('/BikePoint', query).and_return(sample_response) }
-    subject { bike_point.locations_within_bounding_box(query[:swLat], query[:swLon], query[:neLat], query[:neLon]) }
-
-    it { is_expected.to be_an(Array) }
-    it { is_expected.to eq(sample_response) }
-  end
-
-  describe '#search' do
-    let(:query) { { query: 'St. James Park' } }
-    before  { allow(client).to receive(:get).with('/BikePoint/Search', query).and_return(sample_response) }
-    subject { bike_point.search(query[:query]) }
-
-    it { is_expected.to be_an(Array) }
-    it { is_expected.to eq(sample_response) }
-  end
-
-end

data/spec/unit/client_spec.rb

@@ -1,199 +0,0 @@
-#
-# Copyright (c) 2015 - 2017 Luke Hackett
-#
-# 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.
-#
-
-require 'logger'
-require_relative '../spec_helper'
-
-describe TflApi::Client do
-  let(:nil_log_path) { '/dev/null' }
-
-  describe '#initialize' do
-    context 'mandatory attributes' do
-      it 'should raise an exception when Application ID is not present' do
-        expect {
-          TflApi::Client.new(app_key: 123456789)
-        }.to raise_error(ArgumentError)
-      end
-
-      it 'should raise an exception when Application Key is not present' do
-        expect {
-          TflApi::Client.new(app_id: 12345)
-        }.to raise_error(ArgumentError)
-      end
-    end
-
-    context 'default attributes' do
-      subject(:client) { TflApi::Client.new(app_id: 12345, app_key: 6789) }
-
-      it 'should set the host to a "https://api.tfl.gov.uk" when not present' do
-        expect(client.host).to eq(URI.parse('https://api.tfl.gov.uk'))
-      end
-
-      it 'should set the log level to INFO' do
-        expect(client.log_level).to eq(Logger::INFO)
-      end
-
-      it 'should set the log location to STDOUT' do
-        expect(client.log_location).to eq(STDOUT)
-      end
-    end
-
-    context 'when providing optional attributes' do
-      it 'should allow a custom host' do
-        client = TflApi::Client.new(app_id: 12345, app_key: 6789, host: 'http://myhost.com', log_location: nil_log_path)
-        expect(client.host).to eq(URI.parse('http://myhost.com'))
-      end
-
-      it 'should allow a custom log level' do
-        client = TflApi::Client.new(app_id: 12345, app_key: 6789, log_level: Logger::DEBUG)
-        expect(client.log_level).to eq(Logger::DEBUG)
-      end
-
-      it 'should allow a custom log location' do
-        client = TflApi::Client.new(app_id: 12345, app_key: 6789, log_location: '/dev/null')
-        expect(client.log_location).to eq('/dev/null')
-      end
-
-      context 'when setting a custom logger' do
-        let!(:logger) { Logger.new('/dev/null') }
-
-        it 'should create a valid client object' do
-          client = TflApi::Client.new(app_id: 12345, app_key: 6789, logger: logger)
-          expect(client.logger).to eq(logger)
-        end
-
-        it 'should not allow a custom logger that is not a logger' do
-          expect {
-            TflApi::Client.new(app_id: 12345, app_key: 6789, logger: 'some_logger')
-          }.to raise_error(ArgumentError)
-        end
-
-        it 'should not allow setting the log level with a custom logger' do
-          expect {
-            TflApi::Client.new(app_id: 12345, app_key: 6789, logger: logger, log_level: Logger::ERROR)
-          }.to raise_error(ArgumentError)
-        end
-
-        it 'should not allow setting the log location with a custom logger' do
-          expect {
-            TflApi::Client.new(app_id: 12345, app_key: 6789, logger: logger, log_location: nil_log_path)
-          }.to raise_error(ArgumentError)
-        end
-      end
-    end
-  end
-
-  describe '#bike_point' do
-    it 'should return a Client::BikePoint object' do
-      expect(test_client.bike_point).to be_an_instance_of(TflApi::Client::BikePoint)
-    end
-  end
-
-  describe '#get' do
-    subject(:client) { test_client }
-
-    context 'when issuing the request' do
-      it 'should correctly format the request url' do
-        stub = stub_api_request(:get, 'SomeResource', { status: 200, body: '{"status": "ok"}' })
-        client.get('/SomeResource')
-        expect(stub).to have_requested(:get, 'https://somehost/SomeResource?app_id=12345&app_key=6789').once
-      end
-
-      it 'should correctly format the request url with optional parameters' do
-        stub = stub_api_request(:get, 'SomeResource', { foo: 'bar', version: 1 }, { body: '{"status": "ok"}' })
-        client.get('/SomeResource', foo: 'bar', version: 1)
-        expect(stub).to have_requested(:get, 'https://somehost/SomeResource?foo=bar&version=1&app_id=12345&app_key=6789').once
-      end
-    end
-
-    context 'when the resource returns successfully' do
-      it 'should return a json response as a hash on a successful response' do
-        stub_api_request(:get, 'SomeResource', { status: 200, body: '{"status": "ok"}' })
-        response = client.get('/SomeResource')
-        expect(response).to be_a(Hash)
-      end
-
-      it 'should raise an ApiException if the JSON is unparsable' do
-        stub_api_request(:get, 'SomeResource', { status: 200, body: 'invalid json' })
-        expect {
-          client.get('/SomeResource')
-        }.to raise_exception(TflApi::Exceptions::ApiException)
-      end
-    end
-
-    context 'when the resource requires authorisation' do
-      before { stub_api_request(:get, 'SomeUnauthorisedResource', { status: 401 }) }
-      subject { -> { client.get('/SomeUnauthorisedResource') } }
-
-      it { is_expected.to raise_exception(TflApi::Exceptions::Unauthorized) }
-    end
-
-    context 'when the resource forbids access' do
-      before { stub_api_request(:get, 'SomeForbiddenResource', { status: 403 }) }
-      subject { -> { client.get('/SomeForbiddenResource') } }
-
-      it { is_expected.to raise_exception(TflApi::Exceptions::Forbidden) }
-    end
-
-    context 'when the resource is not found' do
-      before { stub_api_request(:get, 'SomeNotFoundResource', { status: 404 }) }
-      subject { -> { client.get('/SomeNotFoundResource') } }
-
-      it { is_expected.to raise_exception(TflApi::Exceptions::NotFound) }
-    end
-
-    context 'when the resource has malfunctioned' do
-      before { stub_api_request(:get, 'SomeInternalErrorResource', { status: 500 }) }
-      subject { -> { client.get('/SomeInternalErrorResource') } }
-
-      it { is_expected.to raise_exception(TflApi::Exceptions::InternalServerError) }
-    end
-
-    context 'when the resource is unavailable' do
-      before { stub_api_request(:get, 'SomeUnavailableResource', { status: 503 }) }
-      subject { -> { client.get('/SomeUnavailableResource') } }
-
-      it { is_expected.to raise_exception(TflApi::Exceptions::ServiceUnavailable) }
-    end
-
-    context 'when the resource errors unexpectedly' do
-      before { stub_api_request(:get, 'SomeUnknownErrorResource', { status: 444 }) }
-      subject { -> { client.get('/SomeUnknownErrorResource') } }
-
-      it { is_expected.to raise_exception(TflApi::Exceptions::ApiException) }
-    end
-  end
-
-  describe '#inspect' do
-    let!(:client) { TflApi::Client.new(app_id: 12345, app_key: 6789) }
-    subject { client.inspect }
-
-    it { is_expected.to_not include('app_id=12345') }
-    it { is_expected.to_not include('app_key=6789') }
-    it { is_expected.to include('host=https://api.tfl.gov.uk') }
-    it { is_expected.to include('log_level=1') }
-    it { is_expected.to include('log_location=#<IO:<STDOUT>>') }
-  end
-end

data/spec/unit/cycle_spec.rb

@@ -1,66 +0,0 @@
-#
-# Copyright (c) 2015 - 2017 Luke Hackett
-#
-# 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.
-#
-
-require_relative '../spec_helper'
-
-describe TflApi::Client::Cycle do
-  let!(:client) { TflApi::Client.new(app_id: 123, app_key: 456) }
-  let!(:cycle) { TflApi::Client::Cycle.new(client) }
-  let(:sample_response) do
-    [{
-       'id' => 'CS-1',
-       'label' => 'CS Route 1',
-       'labelShort' => 'CS-1',
-       'segmented' => true,
-       'geography' => {
-         'type' => 'LineString',
-         'coordinates' => [],
-         'crs' => {
-           'type' => 'name',
-           'properties' => {
-             'name' => 'ABC:1234'
-           }
-         }
-       }
-     }]
-  end
-
-  describe '#superhighways' do
-    before  { allow(client).to receive(:get).with('/CycleSuperhighway').and_return(sample_response) }
-    subject { cycle.superhighways }
-
-    it { is_expected.to be_an(Array) }
-    it { is_expected.to eq(sample_response) }
-  end
-
-  describe '#superhighway' do
-    before  { allow(client).to receive(:get).with('/CycleSuperhighway/SOME_ID').and_return(sample_response.first) }
-    subject { cycle.superhighway('SOME_ID') }
-
-    it { is_expected.to be_an(Hash) }
-    it { is_expected.to eq(sample_response.first) }
-  end
-
-end

data/tfl_api_client.gemspec

@@ -1,37 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'tfl_api_client/version'
-
-Gem::Specification.new do |spec|
-  spec.name                  = 'tfl_api_client'
-  spec.version               = TflApi::VERSION
-  spec.author                = 'Luke Hackett'
-  spec.email                 = 'Luke.Hackett@live.co.uk'
-  spec.homepage              = 'https://github.com/LukeHackett/tfl_api_client'
-  spec.license               = 'MIT'
-  spec.platform              = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.0'
-  spec.summary               = 'Transport for London API Client'
-  spec.description           = <<-eof
-    This gem aims to provide a simple, programmatic ruby client that allows
-    native ruby applications to seamlessly interact with the Transport for
-    London's live APIs.
-  eof
-
-  spec.files                 = `git ls-files -z`.split("\x0")
-  spec.require_paths         = ['lib']
-  spec.executables           = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files            = spec.files.grep(%r{^(test|spec|features)/})
-
-  spec.add_development_dependency 'bundler', '~> 1.14'
-  spec.add_development_dependency 'rake', '~> 11.3'
-  spec.add_development_dependency 'yard', '~> 0.8.7'
-
-  spec.add_development_dependency 'rspec', '~> 3.5'
-  spec.add_development_dependency 'fuubar', '~> 2.2'
-  spec.add_development_dependency 'vcr', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 2.3'
-  spec.add_development_dependency 'simplecov', '~> 0.12'
-  spec.add_development_dependency 'coveralls', '~> 0.8.2'
-end