travel_time 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f918df7122a8d61288cb1f7b35ba225db9bada0dd5fadeeba2eda1bacc274ab9
+  data.tar.gz: 7974b295fd53a2cae24b19903aade4677784dcc375da89ad79e0c79865c83669
+SHA512:
+  metadata.gz: 3f24c74fd8d0d3ab608b9954388fdcf77b6fbc48c1043941dadf93ec04f67c95be539ea234dd0bf386cb8e7c8ea36717fac4cdb1de494e1a839bac358f72aa42
+  data.tar.gz: af39ca592a3a8c016b91adf8832f1de9dbb9ec514f29a18acc6b39ef6087a5b9d4f6f67c8c583b341793541ff30b149b84d17a1ebf9091926bcf76ee4845cecf

data/README.md

@@ -0,0 +1,82 @@
+# TravelTime Ruby SDK
+
+This open-source library allows you to access [TravelTime API](http://docs.traveltime.com/overview/introduction)
+endpoints.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'travel_time'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install travel_time
+
+## Usage
+
+In order to be able to call the API, you'll first need to set your Application ID and API Key:
+
+```ruby
+TravelTime.configure do |config|
+  config.application_id = '<your app id>'
+  config.api_key = '<your api key>'
+end
+```
+
+After that, you can instantiate a client to initiate the API connection:
+
+```ruby
+client = TimeTravel::Client.new
+```
+
+You can then use the clint to call API endpoints:
+
+```ruby
+response = client.map_info
+#=> #<TravelTime::Response:0x00000001452e94b0 @status=200, @headers={...}, @body={...}
+```
+
+### A note on Time
+
+If you're calling an API endpoint that expects a time in "extended ISO-8601 format" (
+e.g. `departure_searches.departure_time`), you can use the standard Ruby Time serializer:
+
+```ruby
+# This require will add the #iso8601 method to Time objects
+require 'time'
+
+departure_search = {
+  id: "forward search example",
+  departure_location_id: "London center",
+  arrival_location_ids: ["Hyde Park", "ZSL London Zoo"],
+  transportation: { type: "bus" },
+  departure_time: Time.now.iso8601,
+  travel_time: 1800,
+  properties: ["travel_time"],
+  range: { enabled: true, max_results: 3, width: 600 }
+}
+
+client.time_map(departure_searches: [departure_search])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can
+also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb` and then create a GitHub release. This will trigger
+a GitHub Action which will push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/traveltime-dev/travel_time.
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'travel_time'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/travel_time/client.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'travel_time/middleware/authentication'
+
+module TravelTime
+  # The Client class provides the main interface to interact with the TravelTime API
+  class Client # rubocop:disable Metrics/ClassLength
+    API_BASE_URL = 'https://api.traveltimeapp.com/v4/'
+
+    attr_reader :connection
+
+    def initialize
+      @connection = Faraday.new(API_BASE_URL) do |f|
+        f.request :json
+        f.response :raise_error if TravelTime.config.raise_on_failure
+        f.response :logger if TravelTime.config.enable_logging
+        f.response :json
+        f.use TravelTime::Middleware::Authentication
+        f.adapter TravelTime.config.http_adapter || Faraday.default_adapter
+      end
+    end
+
+    def unwrap(response)
+      Response.from_object(response)
+    end
+
+    def perform_request
+      unwrap(yield)
+    rescue Faraday::Error => e
+      raise TravelTime::Error.new(response: Response.from_hash(e.response)) if e.response
+
+      raise TravelTime::Error.new(exception: e)
+    rescue StandardError => e
+      raise TravelTime::Error.new(exception: e)
+    end
+
+    def map_info
+      perform_request { connection.get('map-info') }
+    end
+
+    def supported_locations(locations:)
+      perform_request { connection.post('supported-locations', { locations: locations }) }
+    end
+
+    def geocoding(query:, within_country: nil, exclude: nil, limit: nil, force_postcode: nil)
+      query = {
+        query: query,
+        'within.country': within_country,
+        'exclude.location.types': exclude,
+        limit: limit,
+        'force.add.postcode': force_postcode
+      }.compact!
+      perform_request { connection.get('geocoding/search', query) }
+    end
+
+    def reverse_geocoding(lat:, lng:, within_country: nil, exclude: nil)
+      query = {
+        lat: lat,
+        lng: lng,
+        'within.country': within_country,
+        'exclude.location.types': exclude
+      }.compact!
+      perform_request { connection.get('geocoding/reverse', query) }
+    end
+
+    def time_map(departure_searches: nil, arrival_searches: nil, unions: nil, intersections: nil)
+      payload = {
+        departure_searches: departure_searches,
+        arrival_searches: arrival_searches,
+        unions: unions,
+        intersections: intersections
+      }.compact!
+      perform_request { connection.post('time-map', payload) }
+    end
+
+    def time_filter(locations:, departure_searches: nil, arrival_searches: nil)
+      payload = {
+        locations: locations,
+        departure_searches: departure_searches,
+        arrival_searches: arrival_searches
+      }.compact!
+      perform_request { connection.post('time-filter', payload) }
+    end
+
+    def time_filter_fast(locations:, arrival_searches:)
+      payload = {
+        locations: locations,
+        arrival_searches: arrival_searches
+      }.compact!
+      perform_request { connection.post('time-filter/fast', payload) }
+    end
+
+    def time_filter_postcodes(departure_searches: nil, arrival_searches: nil)
+      payload = {
+        departure_searches: departure_searches,
+        arrival_searches: arrival_searches
+      }.compact!
+      perform_request { connection.post('time-filter/postcodes', payload) }
+    end
+
+    def time_filter_postcode_districts(departure_searches: nil, arrival_searches: nil)
+      payload = {
+        departure_searches: departure_searches,
+        arrival_searches: arrival_searches
+      }.compact!
+      perform_request { connection.post('time-filter/postcode-districts', payload) }
+    end
+
+    def time_filter_postcode_sectors(departure_searches: nil, arrival_searches: nil)
+      payload = {
+        departure_searches: departure_searches,
+        arrival_searches: arrival_searches
+      }.compact!
+      perform_request { connection.post('time-filter/postcode-sectors', payload) }
+    end
+
+    def routes(locations:, departure_searches: nil, arrival_searches: nil)
+      payload = {
+        locations: locations,
+        departure_searches: departure_searches,
+        arrival_searches: arrival_searches
+      }.compact!
+      perform_request { connection.post('routes', payload) }
+    end
+  end
+end

data/lib/travel_time/error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module TravelTime
+  # The Error class wraps exceptions and provide useful information.
+  class Error < StandardError
+    DEFAULT_MESSAGE = 'Error while processing the request'
+
+    attr_reader :response, :wrapped_exception
+
+    def initialize(message = nil, response: nil, exception: nil)
+      @response = response
+      @wrapped_exception = exception
+      exc = super(parse_message(message))
+      exc.set_backtrace(exception.backtrace) unless exception.nil?
+    end
+
+    def parse_message(message)
+      message || wrapped_exception&.message || response&.body&.[]('description') || DEFAULT_MESSAGE
+    end
+  end
+end

data/lib/travel_time/middleware/authentication.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module TravelTime
+  module Middleware
+    # The Authentication middleware is responsible for setting the auth headers
+    # on each request. These are automatically taken from the `TravelTime.config`.
+    class Authentication < Faraday::Middleware
+      APP_ID_HEADER = 'X-Application-Id'
+      API_KEY_HEADER = 'X-Api-Key'
+
+      def on_request(env)
+        env.request_headers[APP_ID_HEADER] = TravelTime.config.application_id
+        env.request_headers[API_KEY_HEADER] = TravelTime.config.api_key
+      end
+    end
+  end
+end

data/lib/travel_time/response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module TravelTime
+  # The Response class represent an API response.
+  class Response
+    attr_reader :status, :body, :headers
+
+    def self.from_object(response)
+      new(
+        status: response.status,
+        headers: response.headers,
+        body: response.body
+      )
+    end
+
+    def self.from_hash(response)
+      new(
+        status: response[:status],
+        headers: response[:headers],
+        body: response[:body]
+      )
+    end
+
+    def initialize(status: nil, headers: nil, body: nil)
+      @status = status
+      @headers = headers
+      @body = body
+    end
+
+    def success?
+      (200..299).cover?(status)
+    end
+  end
+end

data/lib/travel_time/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TravelTime
+  VERSION = '0.1.0'
+end

data/lib/travel_time.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'dry/configurable'
+require 'travel_time/client'
+require 'travel_time/error'
+require 'travel_time/response'
+require 'travel_time/version'
+
+# Main TravelTime module
+module TravelTime
+  extend Dry::Configurable
+
+  # Authentication
+  setting :application_id
+  setting :api_key
+
+  # HTTP Client
+  setting :http_adapter
+  setting :enable_logging, default: false
+  setting :raise_on_failure, default: false
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: travel_time
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TravelTime Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: TravelTime SDK for Ruby programming language
+email:
+- support@traveltime.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/travel_time.rb
+- lib/travel_time/client.rb
+- lib/travel_time/error.rb
+- lib/travel_time/middleware/authentication.rb
+- lib/travel_time/response.rb
+- lib/travel_time/version.rb
+homepage: https://traveltime.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://traveltime.com
+  source_code_uri: https://github.com/traveltime-dev/traveltime-sdk-ruby
+  changelog_uri: https://github.com/traveltime-dev/traveltime-sdk-ruby/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: TravelTime SDK for Ruby programming language
+test_files: []