citywrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48ace1ed0874f727cd99677a7cdc8dfa0d91b233
+  data.tar.gz: eff3079f4b193a51378adcd4dd9502f24db95a31
+SHA512:
+  metadata.gz: 64cbbfa1829be778d21822e3098c505683f6846d2584e40c61a6a51378be2c169d777e3b1f4757f6215fc14041b95de3acaa27b45fdc20b528797435b7be78d0
+  data.tar.gz: b8c31b46301af22fb61203cafae42fd4043e169bf96af5de2e465c852d07bd8ef0af5a7e638ea1e21e4accd9ef837a295df34ab9785a6d715931800740d9816c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2.5
+  - 2.3.1
+
+cache: bundler
+before_install: gem update
+script: bundle exec rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joseph Southan
+
+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,69 @@
+# Citywrapper
+[![Build Status](https://travis-ci.org/JoeSouthan/citywrapper.svg?branch=master)](https://travis-ci.org/JoeSouthan/citywrapper)
+[![Code Climate](https://codeclimate.com/github/JoeSouthan/citywrapper/badges/gpa.svg)](https://codeclimate.com/github/JoeSouthan/citywrapper)
+#### WIP
+
+TODO:
+- Better documentation
+
+A very light wrapper around the [Citymapper API](https://citymapper.3scale.net/).
+
+This is in very early development, the Ruby API may change drastically.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'citywrapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install citywrapper
+
+## Usage
+
+Set your API key
+
+```ruby
+Citywrapper.configure do |c|
+  c.api_key = 'API_KEY'
+end
+
+```
+
+Try making a request:
+
+```ruby
+t = Citywrapper::TravelTime.between(
+  start_coordinates: [51.525246, 0.084672],
+  end_coordinates: [51.559098, 0.074503],
+  time: Time.new(2016, 9, 7, 21, 00),
+  time_type: :arrival,
+)
+
+t.travel_time_minutes # 43
+
+```
+
+
+## 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 run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joesouthan/citywrapper.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "citywrapper"
+
+# 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

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/citywrapper.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'citywrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'citywrapper'
+  spec.version       = Citywrapper::VERSION
+  spec.authors       = ['Joseph Southan']
+  spec.email         = ['joe+github@sthn.io']
+
+  spec.summary       = 'Wraps the Citymapper API'
+  spec.description   = 'Simple wrapper around the Citymapper API'
+  spec.homepage      = 'https://www.github.com/joesouthan/citywrapper'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr', '~> 3'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'fuubar', '~> 2.2'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.6'
+end

data/lib/citywrapper.rb

@@ -0,0 +1,27 @@
+require 'net/http'
+require 'ostruct'
+require 'json'
+require 'citywrapper/version'
+require 'citywrapper/api_base'
+require 'citywrapper/configuration'
+require 'citywrapper/resources/travel_time'
+require 'citywrapper/resources/coverage'
+require 'citywrapper/resources/single_point_coverage'
+
+module Citywrapper
+  BASE_URL = 'https://developer.citymapper.com/api'.freeze
+  API_VERSION = '1'.freeze
+
+  class << self
+    attr_accessor :api_key
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/citywrapper/api_base.rb

@@ -0,0 +1,73 @@
+module Citywrapper
+  class ApiBase
+    attr_accessor :config, :response
+
+    JSON_HEADERS = {
+      'Content-Type' => 'application/json',
+      'Accept' => 'application/json'
+    }.freeze
+
+    def initialize
+      @config = Citywrapper.configuration
+    end
+
+    def request(params: {}, method: :get)
+      raise 'Please set your API key' unless config.api_key
+
+      @method = method
+      @params = params
+      @query_uri = build_query
+
+      run_request
+      process_response
+    end
+
+    private
+
+    def build_query
+      base_api_uri.tap do |uri|
+        uri.query = [parameters_for_query, uri.query].compact.join('&')
+      end
+    end
+
+    def parameters_for_query
+      URI.encode_www_form(@params) unless @method == :post
+    end
+
+    def process_response
+      case @response
+      when Net::HTTPNotFound
+        raise "Please check the resource type - #{@resource}"
+      when Net::HTTPForbidden
+        raise 'Please check your API key'
+      end
+
+      JSON.parse(@response.body, object_class: OpenStruct)
+    end
+
+    def run_request
+      case @method
+      when :get
+        @response = Net::HTTP.get_response(@query_uri)
+      when :post
+        request = Net::HTTP.new(@query_uri.host, @query_uri.port)
+        request.use_ssl = true
+        @response = request.post(("#{@query_uri.path}?#{@query_uri.query}"), @params.to_json, JSON_HEADERS)
+      else
+        raise 'Only GET or POST'
+      end
+    end
+
+    def base_api_uri
+      URI(base_api_url)
+    end
+
+    def base_api_url
+      if @resource
+        "#{BASE_URL}/#{API_VERSION}/#{@resource}/?key=#{config.api_key}"
+      else
+        "#{BASE_URL}/#{API_VERSION}/?key=#{config.api_key}"
+      end
+    end
+  end
+end

data/lib/citywrapper/configuration.rb

@@ -0,0 +1,5 @@
+module Citywrapper
+  class Configuration
+    attr_accessor :api_key
+  end
+end

data/lib/citywrapper/resources/coverage.rb

@@ -0,0 +1,17 @@
+module Citywrapper
+  class Coverage < ApiBase
+    def initialize
+      super
+      @resource = 'coverage'
+    end
+
+    def self.for_points(points = [])
+      new.request(
+        params: {
+          points: points
+        },
+        method: :post
+      )
+    end
+  end
+end

data/lib/citywrapper/resources/single_point_coverage.rb

@@ -0,0 +1,16 @@
+module Citywrapper
+  class SinglePointCoverage < ApiBase
+    def initialize
+      super
+      @resource = 'singlepointcoverage'
+    end
+
+    def self.at(coordinates: [])
+      new.request(
+        params: {
+          coord: coordinates.join(',')
+        }
+      )
+    end
+  end
+end

data/lib/citywrapper/resources/travel_time.rb

@@ -0,0 +1,19 @@
+module Citywrapper
+  class TravelTime < ApiBase
+    def initialize
+      super
+      @resource = 'traveltime'
+    end
+
+    def self.between(start_coordinates: [], end_coordinates: [], time: nil, time_type: nil)
+      new.request(
+        params: {
+          startcoord: start_coordinates.join(','),
+          endcoord: end_coordinates.join(','),
+          time: time ? time.to_i : nil,
+          time_type: time_type
+        }
+      )
+    end
+  end
+end

data/lib/citywrapper/version.rb

@@ -0,0 +1,3 @@
+module Citywrapper
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: citywrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Southan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !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: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Simple wrapper around the Citymapper API
+email:
+- joe+github@sthn.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- citywrapper.gemspec
+- lib/citywrapper.rb
+- lib/citywrapper/api_base.rb
+- lib/citywrapper/configuration.rb
+- lib/citywrapper/resources/coverage.rb
+- lib/citywrapper/resources/single_point_coverage.rb
+- lib/citywrapper/resources/travel_time.rb
+- lib/citywrapper/version.rb
+homepage: https://www.github.com/joesouthan/citywrapper
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Wraps the Citymapper API
+test_files: []