reittiopas2 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8b3c7b2da73211b4625740a06095a6b5311ac5c
-  data.tar.gz: 3da51d3fa7d8be313364e1f0ce4dab1619bdf26e
+  metadata.gz: 31fc0c7d85affb2fb20f9997bb0c269e55d322db
+  data.tar.gz: e320d9f0e2cad1f809c5cfd31a73ae8bcda48308
 SHA512:
-  metadata.gz: a5b9646c750f603ac549fa18769a65961aa3e8e3b577453700f98049d2262de4f759253937beb69a6fb1847e07f6f7db5c02c9c5c909ec9220d8740aa25bb45e
-  data.tar.gz: 9edc016afdc19c8daf25543f5f07da1b98e5753e260218012ab97213b6296e3a0fba61fe40f473ea7eb6d6dc5fbad09b02f2227ebe6d1aa4e90998b8b9aa3e2b
+  metadata.gz: 7bfa10688c67662e66c25af1cd8f3efdaede9a277ec62861ff4eab32ad83ca1cd844407554389d0b460ce56c9ba11c20a9edca120ebad59997126d3d0bee162e
+  data.tar.gz: e8f247cdd0a7f6dc867a057f3ca3dcfd4c081f694034f0f2d8f7b8c5e4effd6c91b1679fb09bf90c416b4adc049ac54bedc9d4fba13a394e13f98ba6cbcbdfff

data/Guardfile

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

data/README.md

@@ -1,32 +1,19 @@
-# Reittiopas2
+# Reittiopas 2
 
-Barebones gem wrapping
-[reittiopas v2 API](http://developer.reittiopas.fi/pages/fi/reittiopas-api.php),
-providing simple route searching and geocoding.
+Reittiopas 2 is a simple Ruby library for accessing the [Reittiopas API][API].
 
+  [API]: http://developer.reittiopas.fi/pages/en/http-get-interface-version-2.php
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'reittiopas2'
 
-And then execute:
-
-    $ bundle
+## Installation
 
-Or install it yourself as:
+Install using [Bundler][]:
 
-    $ gem install reittiopas2
+    gem 'reittiopas2', '~> 0.0.3'
 
-## Usage
+  [Bundler]: http://bundler.io/
 
-Sadly, you have to dive into docstrings for documentation.
 
-## Contributing
+## License
 
-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
+Reittiopas 2 is released under the MIT License. See `LICENSE` for details.

data/Rakefile

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

data/lib/reittiopas2.rb

@@ -1,15 +1,15 @@
-require "reittiopas2/connection"
-require "reittiopas2/geocoding"
-require "reittiopas2/routing"
-require "reittiopas2/util"
-require "reittiopas2/version"
+require 'reittiopas2/client'
+require 'reittiopas2/geocoding'
+require 'reittiopas2/routing'
+require 'reittiopas2/utilities'
+require 'reittiopas2/version'
 
 class Reittiopas2
   include Geocoding
   include Routing 
 
   def initialize(username, password)
-    @connection = Reittiopas2::Connection.new(username, password)
+    @client = Reittiopas2::Client.new(username, password)
   end
 end
 

data/lib/reittiopas2/client.rb

@@ -0,0 +1,58 @@
+require 'reittiopas2/utilities'
+
+require 'addressable/uri'
+require 'json'
+require 'net/http'
+
+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 Client
+    include Utilities
+
+    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 = convert_array_values(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
+
+  end
+
+end

data/lib/reittiopas2/geocoding.rb

@@ -1,111 +1,109 @@
-require "reittiopas2/util"
+require 'reittiopas2/utilities'
 
 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.
+  # Module containing public API to perform geocoding and reverse geocoding
+  # operations.
   #
-  # @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.
+  # 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'
+  #           ]
+  #       }
+  #     }
+  #   ]
   #
-  # @return [Array<Hash>] array containing location hashes matched given query.
-  # @see #reverse_geocode
-  def geocode(place_name, opts={})
-    clean = Util.select_keys(opts, GEOCODE_KEYS)
-    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.
+  # @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',
+  #       }
+  #     }
+  #   ]
   #
-  # @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 = Util.select_keys(opts, REVERSE_GEOCODE_KEYS)
-    query = {'request' => 'reverse_geocode', 'coordinate' => coords}.merge(clean)
-    @connection.perform_query(query)
-  end
+  module Geocoding
+    include Utilities
 
+    # 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 = select_keys(opts, GEOCODE_KEYS)
+      query = {'request' =>'geocode', 'key' => place_name}.merge(clean)
+      @client.perform_query(query)
+    end
 
-  GEOCODE_KEYS = ['key', 'cities', 'loc_types', 'disable_error_correction',
-    'disable_unique_stop_names']
+    # 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 = select_keys(opts, REVERSE_GEOCODE_KEYS)
+      query = {'request' => 'reverse_geocode', 'coordinate' => coords}.merge(clean)
+      @client.perform_query(query)
+    end
 
-  REVERSE_GEOCODE_KEYS = ['coordinate', 'limit', 'radius', 'result_contains']
+    GEOCODE_KEYS = ['key', 'cities', 'loc_types', 'disable_error_correction',
+      'disable_unique_stop_names']
 
-end
+    REVERSE_GEOCODE_KEYS = ['coordinate', 'limit', 'radius', 'result_contains']
 
+  end
 
 end

data/lib/reittiopas2/routing.rb

@@ -1,138 +1,137 @@
-require 'reittiopas2/util'
+require 'reittiopas2/utilities'
 
 class Reittiopas2
 
-# Routing module contains all needed functionality to query route information.
-module Routing
+  # Routing module contains all needed functionality to query route information.
+  module Routing
+    include Utilities
 
-  # 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
+    # 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
 
-    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'}
+      clean_opts = select_keys(opts, KEYS + MODE_COSTS)
+      @client.perform_query(clean_opts.merge(query))
     end
 
-    clean_opts = Util.select_keys(opts, KEYS + MODE_COSTS)
-    @connection.perform_query(clean_opts.merge(query))
-  end
+    private
 
+    def route_query_from_strings(from, to)
+      {
+        'request' => 'route',
+        'from' => from,
+        'to' => to
+      }
+    end
 
-  private
+    def route_query_from_locations(from, to)
+      {
+        'request' => 'route',
+        'from' => from['coordinate'],
+        'to' => to['coordinate']
+      }
+    end
 
+    KEYS = ['via', 'date', 'time', 'timetype', 'via_time', 'zone',
+      'transport_types', 'optimize', 'change_margin', 'change_cost',
+      'wait_cost', 'walk_cost', 'walk_speed', 'detail', 'show']
 
-  def route_query_from_strings(from, to)
-    {
-      'request' => 'route',
-      'from' => from,
-      'to' => to
-    }
-  end
+    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']
 
-  def route_query_from_locations(from, to)
-    {
-      'request' => 'route',
-      'from' => from['coordinate'],
-      'to' => to['coordinate']
-    }
   end
 
-  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']
-
-end
-
 end

data/lib/reittiopas2/utilities.rb

@@ -0,0 +1,29 @@
+class Reittiopas2
+  module Utilities
+    module_function
+
+    # Converts array values into string values containing array members joined
+    # by pipe ('|') characters.
+    #
+    # @param [Hash] a hash
+    # @return [Hash] a hash
+    def convert_array_values(hash)
+      result = hash.map do |key, value|
+        if value.is_a? Array
+          [key, value.join('|')]
+        else
+          [key, value]
+        end
+      end
+
+      Hash[result]
+    end
+
+    def select_keys(hash, keys)
+      hash.select do |key, value|
+        keys.include? key
+      end
+    end
+
+  end
+end

data/lib/reittiopas2/version.rb

@@ -1,3 +1,3 @@
 class Reittiopas2
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/reittiopas2.gemspec

@@ -10,10 +10,8 @@ Gem::Specification.new do |gem|
   gem.license       = "MIT"
 
   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.test_files    = gem.files.grep(%r{^spec/})
   gem.name          = "reittiopas2"
-  gem.require_paths = ["lib"]
   gem.version       = Reittiopas2::VERSION
 
   gem.add_dependency "json",        "~> 1.8"

data/spec/{connection_spec.rb → client_spec.rb}

@@ -1,17 +1,15 @@
-require "spec_helper"
+require 'spec_helper'
 
-describe Reittiopas2::Connection do
+describe Reittiopas2::Client do
   before :each do
     @user = "username"
     @pwd = "password"
-    @conn = Reittiopas2::Connection.new @user, @pwd
+    @client = Reittiopas2::Client.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"] })
@@ -20,21 +18,19 @@ describe Reittiopas2::Connection do
       stub_request(:get, @base_url).
         with(:query => expected_q)
 
-      @conn.perform_query(q)
+      @client.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
+      @client.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}'
@@ -44,11 +40,10 @@ describe Reittiopas2::Connection do
         with(:query => query).
         to_return(:body => body)
 
-      ret = @conn.perform_query(query)
+      ret = @client.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!"
 
@@ -56,11 +51,10 @@ describe Reittiopas2::Connection do
         with(:query => @query).
         to_return(:status => 500, :body => body)
 
-      ret = @conn.perform_query
+      ret = @client.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"
 
@@ -68,7 +62,7 @@ describe Reittiopas2::Connection do
         with(:query => @query).
         to_return(:body => body)
 
-      ret = @conn.perform_query
+      ret = @client.perform_query
       ret['error'].should_not be_nil
     end
 
@@ -77,7 +71,7 @@ describe Reittiopas2::Connection do
         with(:query => @query).
         to_return(:body => '')
 
-      ret = @conn.perform_query
+      ret = @client.perform_query
       ret.should == {'error' => 'Response body was empty!'}
     end
   end

data/spec/geocoding_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Reittiopas2::Geocoding do
 
@@ -11,14 +11,12 @@ describe Reittiopas2::Geocoding do
     @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)
@@ -29,7 +27,6 @@ describe Reittiopas2::Geocoding do
         with(:query => @query).should have_been_made.once
     end
 
-
     it "should send only valid keys to API" do
       valid_opts = {
         'cities' => ["helsinki", "espoo"],
@@ -45,7 +42,6 @@ describe Reittiopas2::Geocoding do
         "disable_unique_stop_names" => 0
       }
 
-
       query = @query.merge(opts_query_form)
       opts = valid_opts.merge('not_valid_key' => 'or value')
 
@@ -58,7 +54,6 @@ describe Reittiopas2::Geocoding do
         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'}
 
@@ -72,7 +67,6 @@ describe Reittiopas2::Geocoding do
       locs[0].should be_kind_of(Hash)
     end
   end
-
   
   describe "reverse geocoding" do
     before :each do
@@ -81,7 +75,6 @@ describe Reittiopas2::Geocoding do
                                  'coordinate' => @coords)
     end
 
-
     it "should perform request to API reverse_geocode endpoint." do
       stub_request(:get, @base_url).
         with(:query => @query)
@@ -92,7 +85,6 @@ describe Reittiopas2::Geocoding do
         with(:query => @query).should have_been_made.once
     end
 
-
     it "should send only valid keys to API" do
       valid_opts = {
         'coordinate' => '2552335,6673660',
@@ -108,7 +100,6 @@ describe Reittiopas2::Geocoding do
         "result_contains" => "stop"
       }
 
-
       opts = valid_opts.merge('not_valid_key' => 'or value')
       query = @query.merge(opts_query_form)
 
@@ -121,7 +112,6 @@ describe Reittiopas2::Geocoding do
         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).

data/spec/routing_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Reittiopas2::Routing do
   before :each do

data/spec/spec_helper.rb

@@ -1,12 +1,13 @@
-require "rubygems"
-require "bundler/setup"
-require "webmock/rspec"
+require 'rubygems'
+require 'bundler/setup'
+require 'webmock/rspec'
 
-require "simplecov"
-SimpleCov.start
-
-require "reittiopas2"
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/vendor/"
+end
 
+require 'reittiopas2'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reittiopas2
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Iivari Äikäs
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-01 00:00:00.000000000 Z
+date: 2014-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -124,13 +124,13 @@ files:
 - README.md
 - Rakefile
 - lib/reittiopas2.rb
-- lib/reittiopas2/connection.rb
+- lib/reittiopas2/client.rb
 - lib/reittiopas2/geocoding.rb
 - lib/reittiopas2/routing.rb
-- lib/reittiopas2/util.rb
+- lib/reittiopas2/utilities.rb
 - lib/reittiopas2/version.rb
 - reittiopas2.gemspec
-- spec/connection_spec.rb
+- spec/client_spec.rb
 - spec/data/geocode.json
 - spec/data/reverse_geocode.json
 - spec/geocoding_spec.rb
@@ -156,12 +156,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+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/client_spec.rb
 - spec/data/geocode.json
 - spec/data/reverse_geocode.json
 - spec/geocoding_spec.rb

data/lib/reittiopas2/connection.rb

@@ -1,58 +0,0 @@
-require 'reittiopas2/util'
-
-require 'addressable/uri'
-require 'json'
-require 'net/http'
-
-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 = Util.convert_array_values(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
-
-end
-
-end

data/lib/reittiopas2/util.rb

@@ -1,30 +0,0 @@
-class Reittiopas2
-
-module Util
-
-  # Converts array values into string values containing array members joined
-  # by pipe ('|') characters.
-  #
-  # @param [Hash] a hash
-  # @return [Hash] a hash
-  def self.convert_array_values(hash)
-    result = hash.map do |key, value|
-      if value.is_a? Array
-        [key, value.join('|')]
-      else
-        [key, value]
-      end
-    end
-
-    Hash[result]
-  end
-
-  def self.select_keys(hash, keys)
-    hash.select do |key, value|
-      keys.include? key
-    end
-  end
-
-end
-
-end