reittiopas2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd7af7e068a579e9245cfb7ca79121e9a4310fdd
+  data.tar.gz: 5445ce3e8a5846c31ac8ccad61c557eb3375594c
+SHA512:
+  metadata.gz: 9377560e0fa31558ccc6f733a4c0de539b47d86686d7adb62240c833bf49a67a5959270518c2d1bbae3495a13a2d3a225acb7b9b60c78d16b052c0bd7da91a5b
+  data.tar.gz: 7fc721b52e394ae44299c1e32a9fab26a157dfe139fd97f421adac22be4d68378494288748f2281becf3733627593a35626f76f7fed7ddd6787b276303cd244d

data/.gitignore

@@ -0,0 +1,20 @@
+*.swp
+*.swo
+
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/reittiopas2/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Iivari Äikäs, Jussi Virtanen
+
+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.

data/README.md

@@ -0,0 +1,32 @@
+# Reittiopas2
+
+Barebones gem wrapping
+[reittiopas v2 API](http://developer.reittiopas.fi/pages/fi/reittiopas-api.php),
+providing simple route searching and geocoding.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'reittiopas2'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reittiopas2
+
+## Usage
+
+Sadly, you have to dive into docstrings for documentation.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/reittiopas2/connection.rb

@@ -0,0 +1,84 @@
+class Reittiopas2
+
+# Handles connectting to Reittiopas API and transforms query hashes into form
+# that Reittiopas API can digest them. This class is also responsible for
+# parsing response into Ruby readable form.
+#
+# @api private
+class Connection
+
+  def initialize(username, password)
+    @base_url = "http://api.reittiopas.fi/hsl/prod/"
+    @base_query = {"user" => username, "pass" => password}
+  end
+
+ 
+  # Forms proper query from credentials + given query and sends it to API
+  # endpoint. Also parses response into Ruby readable form.
+  #
+  # In case of errors, be those from API endpoint or from internal processes,
+  # return value will be hash with one field 'error' which contains error
+  # message.
+  #
+  # In fatal error situations Exception will be thrown, only exception for this
+  # rule is JSON::ParserException which is caught and returned as value of
+  # 'error' field.
+  #
+  # @param [Hash] query the query which is to be sent to API endpoint
+  # @return [Hash] the whatever data was requested from API, or Hash containing
+  #   key 'error' containing error message.
+  def perform_query(query={})
+    query = fix_arrays(query)
+    uri = Addressable::URI.parse(@base_url)
+    uri.query_values = @base_query.merge(query)
+
+    res = Net::HTTP.get_response(uri)
+
+    if res.code == '500'
+      # In case of errors, code 500 is returned and there is explanation in
+      # response body as HTML.
+      {'error' => res.body}
+    elsif res.body.nil? or res.body.empty?
+      {'error' => "Response body was empty!"}
+    else
+      JSON.load res.body.to_s
+    end
+  rescue JSON::ParserError => ex
+    {'error' => ex.class}
+  end
+
+
+  private
+
+
+  # Reittiopas API wants arrays as values seperated with pipes. This method
+  # checks query for arrays and converts them to API friendly versions.
+  #
+  # @param [Hash] query the query to be checked for arrays to convert.
+  # @return [Hash] hash where arrays are converted to pipe presentation.
+  def fix_arrays(query)
+    retval = {}
+    query.each do |key, val|
+      if val.is_a? Array
+        retval[key] = array_to_query_form(val)
+      else
+        retval[key] = val
+      end
+    end
+    retval
+  end
+
+
+  def array_to_query_form(arr)
+    raise(ArgumentError, "arr is not Array") unless arr.is_a? Array
+
+    retval = ""
+    arr.each do |val|
+      retval << val << "|"
+    end
+
+    retval[0..-2] # Remove last pipe
+  end
+end
+
+end

data/lib/reittiopas2/geocoding.rb

@@ -0,0 +1,123 @@
+class Reittiopas2
+
+# Module containing public API to perform geocoding and reverse geocoding
+# operations.
+#
+# Location info returned from geocode methods is following form:
+# @example geocode location info
+#   [ 
+#     {
+#       'locType' => 'stop',
+#       'locTypeId' => '10',
+#       'name' => 'Elielinaukio',
+#       'matchedName' => 'Elielinaukio', 
+#       'lang' => 'fi',
+#       'city' => 'Helsinki',
+#       'coords' => '2552335,6673660',
+#       'details' => {
+#           'address' => 'Elielinaukio',
+#           'code' => '1020128',
+#           'shortCode' => '2020',
+#           'lines' => [
+#               '1015A 1:Länsiterminaali',
+#               '1015A 2:Elielinaukio'
+#           ]
+#       }
+#     }
+#   ]
+#
+#
+# @example reverse_geocode location info
+#   [ 
+#     {
+#       'locType' => 'address',
+#       'locTypeId' => '900',
+#       'name' => 'Purotie 8, Helsinki',
+#       'matchedName' => nil, 
+#       'lang' => 'fi',
+#       'city' => 'Helsinki',
+#       'coords' => '2552335,6673660',
+#       'distance' => '38.4187454245971',
+#       'details' => {
+#           'address' => nil,
+#           'houseNumber' => '8',
+#       }
+#     }
+#   ]
+#
+module Geocoding
+
+  # Search for information about place.
+  #
+  # @param [String] place_name the name of place to be searched. This can be
+  #   street name, point of interest, bus stop, etc.
+  # @param [Hash] opts the optional parameters which can be used to alter search
+  #   results. Any invalid keys are removed from query parameters, but values
+  #   are never checked.
+  #
+  # @option opts [String] 'cities' ('all') List of cities which are accepted.
+  # @option opts [String] 'loc_types' ('all') List of location types which are
+  #   accepted.
+  # @option opts [Integer] 'disable_error_correction' (0) Disable levenshtein 
+  #   error correction. 1 = Error correction NOT in use, 0 = error correction in
+  #   use.
+  # @option opts [Integer] 'disable_unique_stop_names' (1) Disable unique stop
+  #   names in the result. 1 = all stops are shown in the result, 0 = only one
+  #   stop is included in the result for stops with same name.
+  #
+  # @return [Array<Hash>] array containing location hashes matched given query.
+  # @see #reverse_geocode
+  def geocode(place_name, opts={})
+    clean = geocode_remove_invalid_keys(opts)
+    query = {'request' =>'geocode', 'key' => place_name}.merge(clean)
+    @connection.perform_query(query)
+  end
+
+
+  # Do reverse geocode search to find information about given coordinates.
+  #
+  # @param [String] coords the coordinate pair "<x_coordinate>,<y_coordinate>"
+  # @param [Hash] opts the optional parameters which can be used to alter query
+  #   results. Any invalid keys are removed from query parameters, but values
+  #   are never checked.
+  #
+  # @option opts [Integer] 'limit' (1) Limit for the number of locations
+  #   returned. 
+  # @option opts [Integer] 'radius' (1000) Radius of the search in meters. Range
+  #   1-1000.
+  # @option opts [String] 'result_contains' ('address') Limit the search to
+  #   given location types. Possible values are: address, stop, poi
+  #
+  # @return [Array<Hash>] array containing location hashes matching given
+  #   coordinates.
+  # @see #geocode
+  def reverse_geocode(coords, opts={})
+    clean = reverse_geocode_remove_invalid_keys(opts)
+    query = {'request' => 'reverse_geocode', 'coordinate' => coords}.merge(clean)
+    @connection.perform_query(query)
+  end
+
+
+  private 
+
+
+  def geocode_remove_invalid_keys(query)
+    whitelist = [ 'key', 'cities', 'loc_types', 'disable_error_correction', 
+      'disable_unique_stop_names' ]
+
+    query.select do |key, val|
+      whitelist.include? key
+    end
+  end
+
+  def reverse_geocode_remove_invalid_keys(query)
+    whitelist = [ 'coordinate', 'limit', 'radius', 'result_contains' ]
+
+    query.select do |key, val|
+      whitelist.include? key
+    end
+  end
+end
+
+
+end

data/lib/reittiopas2/routing.rb

@@ -0,0 +1,145 @@
+
+class Reittiopas2
+
+# Routing module contains all needed functionality to query route information.
+module Routing
+
+  # Query the route between two coordinate points. In routing it is recommended
+  # to use street addresses (their coordinates) as it is difficult for the end
+  # user to know where exactly a stop is located. There might be several stops
+  # with the same name that are located far away from each other (for example
+  # the stop 'Sturenkatu' in Helsinki).
+  #
+  # @param [String, Hash] from Coordinates where route begins.
+  # @param [String, Hash] to Coordinates where route ends.
+  # @param [Hash] opts Optional parameters to query.
+  # @return [Hash] the route between given points.
+  #
+  # @option opts [String] via
+  # @option opts [Number] date (Current date) YYYYMMDD
+  # @option opts [Number] time (Current time) HHMM
+  # @option opts [String] timetype ('departure') Time of the request is either
+  #   * 'departure' 
+  #   * 'arrival'
+  # @option opts [Number] via_time Minimum time spent at a via_point in 
+  #   minutes.
+  # @option opts [String] zone (No restriction) Ticket zone, possible values 
+  #   are: 
+  #   * 'helsinki', 
+  #   * 'espoo', 
+  #   * 'vantaa', 
+  #   * 'whole' (Helsinki, Espoo, Kauniainen, Vantaa, Kirkkonummi and Kerava.
+  #     Whole region, excluding non HSL areas),
+  #   * 'region' (Helsinki, Espoo, Kauniainen and Vantaa region)
+  # @option opts [String, Array<String>] transport_types ('all') Transport 
+  #   types included in the request. Possible types are: 
+  #   * 'all', 
+  #   * 'bus', 
+  #   * 'train',
+  #   * 'metro', 
+  #   * 'tram', 
+  #   * 'service', 
+  #   * 'U-line', 
+  #   * 'ferry', 
+  #   * 'walk' (ONLY walking)
+  # @option opts [String] optimize ('default') Routing profile. Possible
+  #   values: 
+  #   * 'default' = (wait cost=1.0, walk cost=1.2, change cost=6),
+  #   * 'fastest' = (wait cost=1.0, walk cost=1.0, change cost=0), 
+  #   * 'least_transfers' = (wait cost=1.0, walk cost=1.5, change cost=20), 
+  #   * 'least_walking' = (wait cost=1.0, walk cost=5.0, change cost=6)
+  # @option opts [Number] change_margin (3) The minimum number of minutes
+  #   between changes. Range 0-10.
+  # @option opts [Number] change_cost Penalty for a change, user is rather
+  #   N minutes later at the destination than changes to another vehicle. Range
+  #   1-99. This parameter overrides the setting from optimize.
+  # @option opts [Number] wait_cost With this parameter you can weigh wait
+  #   time cost when calculating fastest route. Range 0.1 – 10.0.  This
+  #   parameter overrides optimize parameter.
+  # @option opts [Number] walk_speed (70) Walking speed.  m/min, range 1-500.
+  # @option opts [String] detail ('normal') Detail level of the response. 
+  #   Possible values: 
+  #   * 'limited' = only legs are returned, 
+  #   * 'normal' = intermiediate stops are returned, 
+  #   * 'full' = route share coordinates are returned
+  # @option opts [Number] show (3) Number of routes in the response.
+  # @option opts [Number] mode_cost_|transport_type_id| Mode costs for different
+  #   transport types. These settings override previous values set with
+  #   transport_types-parameter. Values may range from 0.1 to 10 or it can be -1
+  #   when the transport type is excluded from routing. 
+  #
+  #   transport_type_id in the parameter name may be any of the following:
+  #   1. Helsinki internal bus lines
+  #   2. trams
+  #   3. Espoo internal bus lines
+  #   4. Vantaa internal bus lines
+  #   5. regional bus lines
+  #   6. metro
+  #   7. ferry
+  #   8. U-lines
+  #   12. commuter trains
+  #   21. Helsinki service lines
+  #   22. Helsinki night buses
+  #   23. Espoo service lines
+  #   24. Vantaa service lines
+  #   25. region night buses
+  #   36. Kirkkonummi internal bus lines
+  #   39. Kerava internal bus lines
+  def route(from, to, opts={})
+    if from.class != to.class
+      return {'error' => 'ArgumentError: from.class != to.class'}
+    end
+
+    if from.is_a? String
+      query = route_query_from_strings(from, to)
+    elsif from.is_a? Hash and from['coordinate'] and to['coordinate']
+      query = route_query_from_locations(from, to)
+    else
+      return {'error' => 'ArgumentError: locations were not acceptable types'}
+    end
+
+    clean_opts = route_remove_invalid_keys(opts)
+    @connection.perform_query(clean_opts.merge(query))
+  end
+
+
+  private
+
+
+  def route_query_from_strings(from, to)
+    {
+      'request' => 'route',
+      'from' => from,
+      'to' => to
+    }
+  end
+
+  def route_query_from_locations(from, to)
+    {
+      'request' => 'route',
+      'from' => from['coordinate'],
+      'to' => to['coordinate']
+    }
+  end
+
+  def route_remove_invalid_keys(opts)
+    keys = ['via', 'date', 'time', 'timetype', 'via_time', 'zone',
+      'transport_types', 'optimize', 'change_margin', 'change_cost', 
+      'wait_cost', 'walk_cost', 'walk_speed', 'detail', 'show'] 
+    mode_costs = ['mode_cost_1', 'mode_cost_2', 'mode_cost_3', 'mode_cost_4',
+      'mode_cost_5', 'mode_cost_6', 'mode_cost_7', 'mode_cost_7', 
+      'mode_cost_8', 'mode_cost_12', 'mode_cost_21', 'mode_cost_22',
+      'mode_cost_23', 'mode_cost_24', 'mode_cost_25', 'mode_cost_36', 
+      'mode_cost_39']
+
+    whitelist = []  
+    whitelist.concat keys
+    whitelist.concat mode_costs
+
+    opts.select do |key, val|
+      whitelist.include? key
+    end
+  end
+end
+
+end

data/lib/reittiopas2/version.rb

@@ -0,0 +1,3 @@
+class Reittiopas2
+  VERSION = "0.0.1"
+end

data/lib/reittiopas2.rb

@@ -0,0 +1,19 @@
+require "net/http"
+require "addressable/uri"
+require "json"
+
+require "reittiopas2/version"
+
+require "reittiopas2/connection"
+require "reittiopas2/geocoding"
+require "reittiopas2/routing"
+
+class Reittiopas2
+  include Geocoding
+  include Routing 
+
+  def initialize(username, password)
+    @connection = Reittiopas2::Connection.new(username, password)
+  end
+end
+

data/reittiopas2.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/reittiopas2/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Iivari Äikäs", "Jussi Virtanen"]
+  gem.email         = ["iivari.aikas@gmail.com"]
+  gem.description   = %q{Reittiopas version 2 API library.}
+  gem.summary       = %q{Gem providing easy access to reittiopas version 2 API.}
+  gem.homepage      = "https://github.com/orva/reittiopas2"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "reittiopas2"
+  gem.require_paths = ["lib"]
+  gem.version       = Reittiopas2::VERSION
+
+  gem.add_dependency "json",        "~> 1.8"
+  gem.add_dependency "addressable", "~> 2.3"
+
+  gem.add_development_dependency "rspec",       "~> 2.14"
+  gem.add_development_dependency "webmock",     "~> 1.15"
+  gem.add_development_dependency "guard-rspec", "~> 4.0"
+  gem.add_development_dependency "simplecov",   "~> 0.7"
+end

data/spec/connection_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+describe Reittiopas2::Connection do
+  before :each do
+    @user = "username"
+    @pwd = "password"
+    @conn = Reittiopas2::Connection.new @user, @pwd
+
+    @base_url = "http://api.reittiopas.fi/hsl/prod/"
+    @query = {"user" => @user, "pass" => @pwd}
+  end
+
+
+
+  describe "query forming" do
+    it "should put pipes into arrays" do
+      q = @query.merge({ "array" => ["one", "two", "three"] })
+      expected_q = @query.merge({ "array" => "one|two|three"})
+
+      stub_request(:get, @base_url).
+        with(:query => expected_q)
+
+      @conn.perform_query(q)
+      a_request(:get, @base_url).with(:query => expected_q).should have_been_made
+    end
+
+
+    it "should form query only with credentials in case no query given." do
+      stub_request(:get, @base_url).
+        with(:query => @query)
+
+      @conn.perform_query
+      a_request(:get, @base_url).with(:query => @query).should have_been_made
+    end
+  end
+
+
+  describe "perform_query return value" do
+    it "should be hash filled with data in case of succesful query." do
+      body = '{"max":5000,"used":44}'
+      query = @query.merge({ "request" => "stats" })
+
+      stub_request(:get, @base_url).
+        with(:query => query).
+        to_return(:body => body)
+
+      ret = @conn.perform_query(query)
+      ret.should == {"max" => 5000, "used" => 44}
+    end
+
+
+    it "should have response body in error field in case of 500 code" do
+      body = "Hello! Error!"
+
+      stub_request(:get, @base_url).
+        with(:query => @query).
+        to_return(:status => 500, :body => body)
+
+      ret = @conn.perform_query
+      ret.should == {'error' => body}
+    end
+
+
+    it "should error field in case of JSON parse error" do
+      body = "well this is not valid JSON"
+
+      stub_request(:get, @base_url).
+        with(:query => @query).
+        to_return(:body => body)
+
+      ret = @conn.perform_query
+      ret['error'].should_not be_nil
+    end
+
+    it "should have error field in case of empty response body" do
+      stub_request(:get, @base_url).
+        with(:query => @query).
+        to_return(:body => '')
+
+      ret = @conn.perform_query
+      ret.should == {'error' => 'Response body was empty!'}
+    end
+  end
+end

data/spec/data/geocode.json

@@ -0,0 +1,2 @@
+[{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552335,6673660","details":{"address":"Elielinaukio","code":"1020128","shortCode":"2020","changeCost":0.6,"lines":["1015A 1:L\u00e4nsiterminaali","1015A 2:Elielinaukio","1018N 1:Elielinaukio","1039N 1:Konala-Malminkartano","1040  2:Elielinaukio","1042  2:Elielinaukio","1043  2:Elielinaukio","1063  2:Elielinaukio","1069  2:Elielinaukio","1102N 1:Kannelm\u00e4ki"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552355,6673705","details":{"address":"Laituri 21","code":"1020129","shortCode":"2021","changeCost":0.3,"lines":["1040  1:Pohjois-Haagan asema","1102N 1:Kannelm\u00e4ki"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552310,6673680","details":{"address":"Elielinaukio","code":"1020130","shortCode":"","changeCost":0.6,"lines":["2210N 1:Espoon keskus-Eliel","2220N 1:Jupperi-Eliel"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552355,6673712","details":{"address":"Laituri 22","code":"1020131","shortCode":"2022","changeCost":0.3,"lines":["1043  1:Hakuninmaa"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552355,6673733","details":{"address":"Laituri 25","code":"1020132","shortCode":"2025","changeCost":0.6,"lines":["1042  1:Kannelm\u00e4ki"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552355,6673719","details":{"address":"Laituri 23","code":"1020133","shortCode":"2023","changeCost":0.3,"lines":["1018N 1:Elielinaukio","1063  1:Palohein\u00e4"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552355,6673726","details":{"address":"Laituri 24","code":"1020135","shortCode":"2024","changeCost":0.3,"lines":["1039N 1:Konala-Malminkartano","1069  1:Malmi"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552335,6673662","details":{"address":"Elielinaukio","code":"1020228","shortCode":"2020","changeCost":0.6,"lines":["2194  2:Elielinaukio, l. 36","2194A 2:Elielinaukio, l. 36","2195  2:Elielinaukio, l. 36","2195N 2:Elielinaukio, l. 36","2206  2:Elielinaukio, l. 35","2206A 2:Elielinaukio, l. 35","2212  2:Elielinaukio, l. 35","2213  2:Elielinaukio, l. 35","2213N 2:Elielinaukio, l. 35","2231  2:Elielinaukio, l. 34","2231K 2:Elielinaukio, l. 34","2231N 2:Elielinaukio, l. 34","2247  2:Elielinaukio, l. 34","2247A 2:Elielinaukio, l. 34","2248  2:Elielinaukio, l. 34","2248A 2:Elielinaukio, l. 34","2270  2:Elielinaukio, l. 34","2270A 2:Elielinaukio, l. 34","2270N 2:Elielinaukio, l. 34","2315  2:Elielinaukio, l. 26","2321  2:Elielinaukio, l. 26","2324  2:Elielinaukio, l. 27","2324K 2:Elielinaukio, l. 27","2324N 2:Elielinaukio, l. 27","2345  2:Elielinaukio, l. 27","2345N 2:Elielinaukio, l. 27","4300N 2:Elielinaukio, l. 28","4360  2:Elielinaukio, l. 29","4360K 2:Elielinaukio, l. 29","4361  2:Elielinaukio, l. 29","4362  2:Elielinaukio, l. 29","4362N 2:Elielinaukio, l. 29","4362T 2:Elielinaukio, l. 29","4363  2:Elielinaukio, l. 28","4363A 2:Elielinaukio, l. 28","4364  2:Elielinaukio, l. 29","4415  2:Elielinaukio, l. 31","4451  2:Elielinaukio, l. 31","4452  2:Elielinaukio, l. 32","4452K 2:Elielinaukio, l. 32","4453  2:Elielinaukio, l. 33","4453Z 2:Elielinaukio, l. 33","4474  2:Elielinaukio,l.31","4474A 2:Elielinaukio,l.31","4474AK2:Elielinaukio,l.31","4474K 2:Elielinaukio,l.31","4474V 2:Elielinaukio,l.31","4474VK2:Elielinaukio,l.31"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552355,6673740","details":{"address":"Laituri 26","code":"1020239","shortCode":"2026","changeCost":0.3,"lines":["2315  1:Vanhakartano","2321  1:Koskelo"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552355,6673747","details":{"address":"Laituri 27","code":"1020241","shortCode":"2027","changeCost":0.3,"lines":["2324  1:Kalaj\u00e4rvi","2324K 1:Kalaj\u00e4rvi","2324N 1:Kalaj\u00e4rvi","2345  1:Rinnekoti","2345N 1:Rinnekoti"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552355,6673754","details":{"address":"Laituri 28","code":"1020243","shortCode":"2028","changeCost":0.3,"lines":["4300N 1:H\u00e4meenkyl\u00e4","4363  1:H\u00e4meenkyl\u00e4","4363A 1:Askisto"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552355,6673761","details":{"address":"Laituri 29","code":"1020245","shortCode":"2029","changeCost":0.3,"lines":["4360  1:Petikko","4360K 1:Petikko","4361  1:Petikko","4362  1:Petikko","4362N 1:Askisto","4362T 1:Petikko","4364  1:Askisto"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552305,6673698","details":{"address":"Laituri 31","code":"1020249","shortCode":"2031","changeCost":0.3,"lines":["4415  1:Lentoasema, lait. 4","4451  1:Lentoasema, lait. 4","4474  1:Katriinan sairaala","4474A 1:Reuna","4474AK1:Reuna","4474K 1:Katriinan sairaala","4474V 1:Koivup\u00e4\u00e4","4474VK1:Koivup\u00e4\u00e4"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552304,6673705","details":{"address":"Laituri 32","code":"1020251","shortCode":"2032","changeCost":0.3,"lines":["4400N 1:Pakkala","4452  1:Myyrm\u00e4en as, lait. 7","4452K 1:Myyrm\u00e4en as, lait. 7"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552303,6673712","details":{"address":"Laituri 33","code":"1020253","shortCode":"2033","changeCost":0.3,"lines":["4453  1:Martinlaakso, lait.3","4453Z 1:Martinlaakso, lait.3"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552302,6673719","details":{"address":"Laituri 34","code":"1020255","shortCode":"2034","changeCost":0.3,"lines":["2210N 1:Espoon keskus-Eliel","2220N 1:Jupperi-Eliel","2231  1:H\u00e4mevaara","2231K 1:H\u00e4mevaara","2231N 1:J\u00e4rvenper\u00e4","2247  1:L\u00e4hderanta","2247A 1:Jupperi","2248  1:L\u00e4hderanta","2248A 1:Jupperi","2270  1:Tuomarila","2270A 1:Kuurinniitty","2270N 1:Kuurinniitty"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552301,6673726","details":{"address":"Laituri 35","code":"1020257","shortCode":"2035","changeCost":0.3,"lines":["2206  1:Karamalmi","2206A 1:Karamalmi","2212  1:Kauniainen","2213  1:Kauklahti","2213N 1:Kauklahti"],"transport_type_id":1}},{"locType":"stop","locTypeId":10,"name":"Elielinaukio","matchedName":"Elielinaukio","lang":"fi","city":"Helsinki","coords":"2552300,6673733","details":{"address":"Laituri 36","code":"1020259","shortCode":"2036","changeCost":0.3,"lines":["2194  1:Tapiola","2194A 1:Orion","2195  1:Latokaski","2195N 1:Latokaski"],"transport_type_id":1}}]
+

data/spec/data/reverse_geocode.json

@@ -0,0 +1,2 @@
+[{"locType":"address","locTypeId":"900","name":"Purotie 8, Helsinki","matchedName":null,"lang":"fi","city":"Helsinki","coords":"2548220,6678498","distance":"38.4187454245971","details":{"address":null,"houseNumber":"8"}}]
+

data/spec/geocoding_spec.rb

@@ -0,0 +1,136 @@
+require "spec_helper"
+
+describe Reittiopas2::Geocoding do
+
+  before :each do
+    user = "username"
+    pwd = "password"
+    @reitti = Reittiopas2.new(user, pwd)
+
+    @base_query = {'user' => user, 'pass' => pwd}
+    @base_url = "http://api.reittiopas.fi/hsl/prod/"
+  end
+
+
+  describe "geocoding" do
+    before :each do
+      @city = 'Helsinki'
+      @query = @base_query.merge('request' => 'geocode', 'key' => @city)
+    end
+
+
+    it "should perform request to API geocode endpoint." do
+      stub_request(:get, @base_url).
+        with(:query => @query)
+
+      @reitti.geocode(@city)
+
+      a_request(:get, @base_url).
+        with(:query => @query).should have_been_made.once
+    end
+
+
+    it "should send only valid keys to API" do
+      valid_opts = {
+        'cities' => ["helsinki", "espoo"],
+        'loc_types' => ['stop', 'address'],
+        'disable_error_correction' => 0,
+        'disable_unique_stop_names' => 0
+      }
+      
+      opts_query_form = {
+        "cities" => "helsinki|espoo",
+        "loc_types" => "stop|address",
+        "disable_error_correction" => 0,
+        "disable_unique_stop_names" => 0
+      }
+
+
+      query = @query.merge(opts_query_form)
+      opts = valid_opts.merge('not_valid_key' => 'or value')
+
+      stub_request(:get, @base_url).
+        with(:query => query)
+
+      @reitti.geocode(@city, opts)
+
+      a_request(:get, @base_url).
+        with(:query => query).should have_been_made.once
+    end
+
+
+    it "should return hash of location hashes if query is success" do
+      opts = {'loc_types' => 'stop'}
+
+      json = File.new('spec/data/geocode.json')
+      stub_request(:get, @base_url).
+        with(:query => @query.merge(opts)).
+        to_return(:body => json)
+
+      locs = @reitti.geocode("Helsinki", opts)
+      locs.should be_kind_of(Array)
+      locs[0].should be_kind_of(Hash)
+    end
+  end
+
+  
+  describe "reverse geocoding" do
+    before :each do
+      @coords = '2548196,6678528'
+      @query = @base_query.merge('request' => 'reverse_geocode', 
+                                 'coordinate' => @coords)
+    end
+
+
+    it "should perform request to API reverse_geocode endpoint." do
+      stub_request(:get, @base_url).
+        with(:query => @query)
+
+      @reitti.reverse_geocode(@coords)
+
+      a_request(:get, @base_url).
+        with(:query => @query).should have_been_made.once
+    end
+
+
+    it "should send only valid keys to API" do
+      valid_opts = {
+        'coordinate' => '2552335,6673660',
+        'limit' => 1,
+        'radius' => 1000,
+        'result_contains' => 'stop'
+      }
+
+      opts_query_form = {
+        "coordinate" => "2552335,6673660",
+        "limit" => 1,
+        "radius" => 1000,
+        "result_contains" => "stop"
+      }
+
+
+      opts = valid_opts.merge('not_valid_key' => 'or value')
+      query = @query.merge(opts_query_form)
+
+      stub_request(:get, @base_url).
+        with(:query => query)
+
+      @reitti.reverse_geocode(@coords, opts)
+
+      a_request(:get, @base_url).
+        with(:query => query).should have_been_made.once
+    end
+
+
+    it "should return hash of location hashes if query is success" do
+      json = File.new('spec/data/reverse_geocode.json')
+      stub_request(:get, @base_url).
+        with(:query => @query).
+        to_return(:body => json)
+
+      locs = @reitti.reverse_geocode(@coords)
+      locs.should be_kind_of(Array)
+      locs[0].should be_kind_of(Hash)
+    end
+  end
+end

data/spec/routing_spec.rb

@@ -0,0 +1,83 @@
+require "spec_helper"
+
+describe Reittiopas2::Routing do
+  before :each do
+    user = "username"
+    pass = "password"
+    @reitti = Reittiopas2.new(user, pass)
+
+    @base_query = {'user' => user, 'pass' => pass}
+    @base_url = "http://api.reittiopas.fi/hsl/prod/"
+  end
+
+  describe "route fetching" do
+    before :each  do
+      @from = '2546445,6675512'
+      @to = '2549445,6675513'
+      @query = @base_query.merge('request' => 'route',
+                                 'from' => @from,
+                                 'to' => @to)
+    end
+
+    it "should accept coordinates as strings." do
+      stub_request(:get, @base_url).
+        with(:query => @query)
+
+      @reitti.route(@from, @to)
+      a_request(:get, @base_url).
+        with(:query => @query).should have_been_made.once
+    end
+
+    it "should accept location hashes as coordinates." do
+      from_hash = {'coordinate' => @from}
+      to_hash = {'coordinate' => @to}
+
+      stub_request(:get, @base_url).
+        with(:query => @query)
+
+      @reitti.route(from_hash, to_hash)
+      a_request(:get, @base_url).
+        with(:query => @query).should have_been_made.once
+    end
+
+    it "should reject hashes without coordinates." do
+      from_hash = {'fake' => @from}
+      to_hash = {'fake' => @to}
+
+      ret = @reitti.route(from_hash, to_hash)
+      ret['error'].should == 'ArgumentError: locations were not acceptable types'
+    end
+
+    it "should reject coordinates which are different types." do
+      from_hash = {'fake' => @from}
+      ret = @reitti.route(from_hash, @to)
+      ret['error'].should == 'ArgumentError: from.class != to.class'
+    end
+
+    # This test works because we are not checking values, only keys
+    it "should reject keys that are not valid query parameters" do
+      keys = ['via', 'date', 'time', 'timetype', 'via_time', 'zone',
+        'transport_types', 'optimize', 'change_margin', 'change_cost', 
+        'wait_cost', 'walk_cost', 'walk_speed', 'detail', 'show'] 
+      mode_costs = ['mode_cost_1', 'mode_cost_2', 'mode_cost_3', 'mode_cost_4',
+        'mode_cost_5', 'mode_cost_6', 'mode_cost_7', 'mode_cost_7', 
+        'mode_cost_8', 'mode_cost_12', 'mode_cost_21', 'mode_cost_22',
+        'mode_cost_23', 'mode_cost_24', 'mode_cost_25', 'mode_cost_36', 
+        'mode_cost_39']
+
+      opts = {}
+      keys.each { |key| opts[key] = "_" }
+      mode_costs.each { |key| opts[key] = "_" }
+
+      query = @query.merge(opts)
+      stub_request(:get, @base_url).
+        with(:query => query)
+
+      invalid = query.merge('not valid' => 'at all')
+      @reitti.route(@from, @to, invalid)
+
+      a_request(:get, @base_url).
+        with(:query => query).should have_been_made.once
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "rubygems"
+require "bundler/setup"
+require "webmock/rspec"
+
+require "simplecov"
+SimpleCov.start
+
+require "reittiopas2"
+
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: reittiopas2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Iivari Äikäs
+- Jussi Virtanen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Reittiopas version 2 API library.
+email:
+- iivari.aikas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/reittiopas2.rb
+- lib/reittiopas2/connection.rb
+- lib/reittiopas2/geocoding.rb
+- lib/reittiopas2/routing.rb
+- lib/reittiopas2/version.rb
+- reittiopas2.gemspec
+- spec/connection_spec.rb
+- spec/data/geocode.json
+- spec/data/reverse_geocode.json
+- spec/geocoding_spec.rb
+- spec/routing_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/orva/reittiopas2
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Gem providing easy access to reittiopas version 2 API.
+test_files:
+- spec/connection_spec.rb
+- spec/data/geocode.json
+- spec/data/reverse_geocode.json
+- spec/geocoding_spec.rb
+- spec/routing_spec.rb
+- spec/spec_helper.rb