reittiopas 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-03-29
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,21 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+deps.rip
+lib/reittiopas.rb
+lib/reittiopas/coordinates.rb
+lib/reittiopas/geocoding.rb
+lib/reittiopas/http.rb
+lib/reittiopas/location.rb
+lib/reittiopas/reittiopas.rb
+lib/reittiopas/utils.rb
+script/console
+script/destroy
+script/generate
+spec/fixtures/key.xml
+spec/fixtures/reverse_geocoding.xml
+spec/reittiopas_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,58 @@
+= Reittiopas
+
+* {Documentation at Github}[http://raneksi.github.com/reittiopas/]
+
+== DESCRIPTION:
+
+Reittiopas is a Ruby library for accessing the {Reittiopas Developer API}[http://developer.reittiopas.fi/pages/fi/reittiopas-api.php].
+
+Requires an account to the service that can be requested through {the account request page}[http://developer.reittiopas.fi/pages/fi/accountrequest.php].
+
+== SYNOPSIS:
+ require 'reittiopas'
+ reittiopas = Reittiopas.new(:username => 'myuser', :password => 'lolcats')
+
+=== Geocoding
+Search for location by keyword _tee_.
+  location = reittiopas.location('tee').first
+  puts "#{location}, #{location.city}"
+  puts "http://maps.google.com/maps?q=#{URI.escape location.coordinates[:wgs]}"
+Teeripuisto, Helsinki
+
+http://maps.google.com/maps?q=60.2528,%2025.02051
+
+=== Reverse geocoding
+Search for a location by KKJ[http://fi.wikipedia.org/wiki/Kartastokoordinaattij%C3%A4rjestelm%C3%A4] coordinates.
+  location = reittiopas.location(:x => 2546445, :y => 6675512).first
+  puts "#{location}, #{location.city}"
+Otakaari 9, Espoo
+
+== REQUIREMENTS:
+
+* Nokogiri[http://nokogiri.org/]
+* Addressable[http://github.com/sporkmonger/addressable]
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Raine Virta
+
+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/Rakefile

@@ -0,0 +1,34 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/reittiopas'
+
+Hoe.plugin :newgem
+
+$hoe = Hoe.spec 'reittiopas' do
+  developer 'Raine Virta', 'raine.virta@gmail.com'
+  self.rubyforge_name   = self.name
+
+  %w{ addressable nokogiri }.each do |dep|
+    self.extra_dev_deps << [dep, '>= 0']
+  end
+
+  self.url              = "http://github.com/raneksi/reittiopas"
+  self.extra_dev_deps   = [['webmock', ">= 0"]]
+  self.readme_file      = "README.rdoc"
+  self.extra_rdoc_files = FileList['*.rdoc']
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# remove_task :default
+# task :default => [:spec, :features]
+
+require 'gokdok'
+Gokdok::Dokker.new do |gd|
+  gd.repo_url  = "git@github.com:raneksi/reittiopas.git"
+  gd.rdoc_task = :docs
+  gd.doc_home  = 'doc'
+end

data/deps.rip

@@ -0,0 +1 @@
+http://github.com/sporkmonger/addressable.git

data/lib/reittiopas.rb

@@ -0,0 +1,28 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'uri'
+require 'cgi'
+require 'net/http'
+require 'nokogiri'
+require 'addressable/uri'
+
+require 'reittiopas/utils'
+require 'reittiopas/coordinates'
+require 'reittiopas/location'
+require 'reittiopas/geocoding'
+require 'reittiopas/reittiopas'
+require 'reittiopas/http'
+
+class Reittiopas
+  # The version of Reittiopas you are using.
+  VERSION = "0.0.1"
+end
+
+# Shorter way for Reittiopas instance creation.
+# In actuality, this doesn't make much sense since it just hides
+# the +new+ method. FIXME
+def Reittiopas(account)
+  return Reittiopas.new(account)
+end

data/lib/reittiopas/coordinates.rb

@@ -0,0 +1,25 @@
+class Reittiopas
+class Location
+  module Coordinates # :nodoc:
+    class WGS
+      attr_accessor :latitude, :longitude
+      def initialize(opts)
+        @latitude  = opts[:lat].to_f
+        @longitude = opts[:lon].to_f
+      end
+
+      def to_s
+        [@latitude, @longitude].join(', ')
+      end
+    end
+
+    class KKJ
+      attr_accessor :x, :y
+      def initialize(opts)
+        @x = opts[:x].to_i
+        @y = opts[:y].to_i
+      end
+    end
+  end
+end
+end

data/lib/reittiopas/geocoding.rb

@@ -0,0 +1,53 @@
+class Reittiopas
+
+# Module implementing the geocoding features of the Reittiopas API
+# documented at http://developer.reittiopas.fi/pages/fi/http-get-interface.php
+module Geocoding
+
+  # Send a geocode location query to the API.
+  # Both geocoding, and reverse geocoding data is accessed through this method.
+  #
+  # Returns results as an array containing Reittiopas::Location objects.
+  #
+  # === Examples:
+  # * Search for location by keyword _tee_.
+  #  reittiopas.location('tee')
+  #
+  # * Search for location by KKJ coordinates x: _2546445_, y: _6675512_.
+  #  reittiopas.location(:x => 2546445, :y => 6675512)
+  #
+  def location(opts)
+    params = if opts.is_a? String
+      {:key => opts}
+    elsif opts.is_a? Hash
+      opts
+    end
+
+    parse @http.get(params), opts
+  end
+
+private
+  # Parse XML received from a geocoding API query.
+  def parse(xml, opts)
+    doc = Nokogiri::XML(xml)
+
+    locations = doc.search('LOC').map do |loc|
+      Reittiopas::Location.parse(loc)
+    end
+
+    # Add KKJ coordinates from REVERSE tag to each Location returned
+    # in case it was a reverse geocoding query
+    if opts.is_a? Hash
+      reverse = doc.search('REVERSE').last
+      x = reverse.get_attr_value('x').to_i
+      y = reverse.get_attr_value('y').to_i
+
+      locations.each do |loc|
+        loc.coordinates = { :kkj => Reittiopas::Location::Coordinates::KKJ.new(:x => x, :y => y) }
+      end
+    end
+
+    return locations
+  end
+end
+end

data/lib/reittiopas/http.rb

@@ -0,0 +1,40 @@
+class Reittiopas
+
+# Reittiopas::HTTP is initialized with account details upon initialization
+# of a Reittiopas object.
+#
+# Since Reittiopas API is to be queried using
+# GET requests with appropriate query parameters, Reittiopas::HTTP exists
+# to simplify the process by offering a +get+ method that accepts a hash
+# containing the query parameters as an argument.
+#
+class HTTP
+  # Base URI for the Reittiopas API service.
+  API_BASE_URI = "http://api.reittiopas.fi/public-ytv/fi/api/"
+
+  # Addressable::URI instance of the API URI with account details set as
+  # query parameters.
+  attr_reader :api_uri
+
+  # Create a new Reittiopas::HTTP object.
+  #
+  # +account+ should be a hash containing +:username+ and +:password+.
+  def initialize(account)
+    @api_uri = Addressable::URI.parse(API_BASE_URI)
+    @api_uri.query_values = {:user => account[:username], :pass => account[:password]}
+  end
+
+  # Send a GET request to the API with account details and +opts+ as query
+  # parameters.
+  #
+  # * +opts+ — A hash containing query parameters. Values are automatically
+  # encoded by Addressable::URI.
+  def get(opts)
+    raise ArgumentError if opts.empty?
+    uri = @api_uri.dup
+    opts.merge!(opts){ |k,ov| ov.to_s } # Coordinates to string
+    uri.query_values = uri.query_values.merge(opts)
+    return Net::HTTP.get(uri)
+  end
+end
+end

data/lib/reittiopas/location.rb

@@ -0,0 +1,87 @@
+class Reittiopas
+
+# This class represents a Location.
+class Location
+
+  # Get the name of the location.
+  attr_accessor :name
+
+  # Get the city of the location.
+  attr_accessor :city
+
+  # Get the type of the location.
+  attr_accessor :type
+
+  # Get coordinates of the location as a Hash containing Coordinates objects.
+  attr_accessor :coordinates
+
+  # Get the street number of the location.
+  attr_accessor :number
+
+  # Create a Location object from Nokogiri::XML::Element object containing
+  # location data.
+  def self.parse(xml)
+    attr = xml.attributes
+
+    category = xml.get_attr_value('category')
+
+    loc = case category
+      when "street" then Street.new
+      when "stop"   then Stop.new
+      when "poi"    then PointOfInterest.new
+      else Location.new
+    end
+
+    loc.name = xml.get_attr_value 'name1'
+    loc.city = xml.get_attr_value 'city'
+    type     = xml.get_attr_value 'type'
+    code     = xml.get_attr_value 'code'
+    number   = xml.get_attr_value 'number'
+    address  = xml.get_attr_value 'address'
+
+    loc.type    = type.to_i   if type
+    loc.code    = code.to_i   if code
+    loc.number  = number.to_i if number
+    loc.address = address     if address
+
+    coordinates = {}
+
+    if attr["x"] && attr["y"]
+      coordinates[:kkj] = Coordinates::KKJ.new(Hash[*%w(x y).map { |e| [e.to_sym, attr[e].value.to_i] }.flatten])
+    end
+
+    if attr["lat"] && attr["lon"]
+      coordinates[:wgs] = Coordinates::WGS.new(Hash[*%w(lat lon).map { |e| [e.to_sym, attr[e].value.to_f] }.flatten])
+    end
+
+    loc.coordinates = coordinates unless coordinates.empty?
+
+    return loc
+  end
+
+  # Get the name and street number (if applicable) of the location.
+  def to_s
+    "#{name} #{number}".strip
+  end
+
+class PointOfInterest < Location
+  # Get the code of the point of interest location.
+  attr_accessor :code
+end
+
+class Stop < Location
+  # Get the address of the bus stop.
+  #
+  # To follow the API's response format, only bus stops have an address. FIXME?
+  attr_accessor :address
+
+  # Get the code of the bus stop.
+  attr_accessor :code
+end
+
+class Street < Location
+  # Get the street number of the location.
+  attr_accessor :number
+end
+end
+end

data/lib/reittiopas/reittiopas.rb

@@ -0,0 +1,15 @@
+# Reittiopas is a Ruby library for accessing the
+# {Reittiopas Developer API}[http://developer.reittiopas.fi/pages/fi/reittiopas-api.php].
+#
+class Reittiopas
+  include Geocoding
+  
+  # Instantiate a Reittiopas object.
+  #
+  # +account+ should be a hash containing +:username+ and +:password+.
+  #
+  #   Reittiopas.new(:username => 'exampleuser', :password => 'lolcat')
+  def initialize(account)
+    @http = Reittiopas::HTTP.new(account)
+  end
+end

data/lib/reittiopas/utils.rb

@@ -0,0 +1,11 @@
+# Ugly, get rid of
+module Nokogiri #:nodoc: all
+module XML
+class Element
+  def get_attr_value(attr)
+    # Might be better to just discard empty attributes
+    (a = attribute(attr); a && !a.value.empty? ? a.value : nil)
+  end
+end
+end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/reittiopas.rb'}"
+puts "Loading reittiopas gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/fixtures/key.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?><MTRXML version="1.0">
+<GEOCODE key="tee">
+<LOC name1="Teeripuisto" number="" city="Helsinki" code="1700" address="" type="3" category="poi" x="2556686" y="6682815" lon="25.02051" lat="60.2528" />
+<LOC name1="Teemuntie" number="" city="Helsinki" code="" address="" type="900" category="street" x="2558052" y="6685202" lon="25.04586" lat="60.27403" />
+<LOC name1="Teerenpelinpolku" number="" city="Helsinki" code="" address="" type="900" category="street" x="2556598" y="6682627" lon="25.01887" lat="60.25113" />
+<LOC name1="Teerentie" number="" city="Kirkkonummi" code="" address="" type="900" category="street" x="2524975" y="6686648" lon="24.44833" lat="60.29037" />
+<LOC name1="Teerikuja" number="" city="Vantaa" code="" address="" type="900" category="street" x="2559103" y="6693697" lon="25.06733" lat="60.35011" />
+<LOC name1="Teerikukonkuja" number="" city="Helsinki" code="" address="" type="900" category="street" x="2556898" y="6683026" lon="25.0244" lat="60.25466" />
+<LOC name1="Teerikukontie" number="" city="Helsinki" code="" address="" type="900" category="street" x="2556907" y="6682892" lon="25.02453" lat="60.25346" />
+<LOC name1="Teerimäentie" number="" city="Kerava" code="" address="" type="900" category="street" x="2560257" y="6698983" lon="25.08981" lat="60.39737" />
+<LOC name1="Teerimäentie" number="" city="Vantaa" code="" address="" type="900" category="street" x="2562514" y="6686983" lon="25.12703" lat="60.28935" />
+<LOC name1="Teeripolku" number="" city="Vantaa" code="" address="" type="900" category="street" x="2559133" y="6693811" lon="25.06791" lat="60.35113" />
+<LOC name1="Teeririnne" number="" city="Vantaa" code="" address="" type="900" category="street" x="2559169" y="6693364" lon="25.06843" lat="60.34711" />
+<LOC name1="Teerisuonkuja" number="" city="Helsinki" code="" address="" type="900" category="street" x="2556995" y="6682667" lon="25.02605" lat="60.25143" />
+<LOC name1="Teerisuontie" number="" city="Helsinki" code="" address="" type="900" category="street" x="2557034" y="6682586" lon="25.02673" lat="60.2507" />
+<LOC name1="Teeritie" number="" city="Vantaa" code="" address="" type="900" category="street" x="2559070" y="6693600" lon="25.06671" lat="60.34924" />
+<LOC name1="Teekkarikylä" number="" city="Espoo" code="2222208" address="Otakaari" type="10" category="stop" x="2546445" y="6675512" lon="24.83393" lat="60.18855" />
+<LOC name1="Teerisuonkuja" number="" city="Helsinki" code="1382186" address="Teerisuontie" type="10" category="stop" x="2556964" y="6682609" lon="25.02547" lat="60.25091" />
+<LOC name1="Teerisuontie" number="" city="Helsinki" code="1382141" address="Teerisuontie" type="10" category="stop" x="2556740" y="6682861" lon="25.0215" lat="60.25321" />
+<LOC name1="Teeritie" number="" city="Vantaa" code="4810204" address="Korsontie" type="10" category="stop" x="2559002" y="6694007" lon="25.06559" lat="60.35291" />
+</GEOCODE>
+</MTRXML>

data/spec/fixtures/reverse_geocoding.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?><MTRXML version="1.0">
+<REVERSE x="2546445" y="6675512">
+<LOC name1="Otakaari" number="9" city="Espoo"  />
+</REVERSE>
+</MTRXML>

data/spec/reittiopas_spec.rb

@@ -0,0 +1,245 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "Reittiopas()" do
+  before { @account = {:username => 'foo', :password => 'bar'} }
+
+  context "when called with an account hash as argument" do
+    subject { Reittiopas(@account) }
+
+    it "should return a Reittiopas object" do
+      should be_a_kind_of(Reittiopas)
+    end
+  end
+end
+
+describe Reittiopas do
+  before { @account = {:username => 'foo', :password => 'bar'} }
+
+  context "when initialized with an account" do
+    subject { Reittiopas.new(@account) }
+
+    it { should respond_to(:location) }
+  end
+
+  describe "#location" do
+    before  { @reittiopas = Reittiopas.new(@account) }
+
+    context "when given key 'tee' that returns 18 locations from API" do
+      before do
+        response = File.read(File.dirname(__FILE__) + '/fixtures/key.xml')
+        stub_request(:any, /.*key=tee.*/).to_return(:body => response, :status => 200)
+      end
+
+      subject { @reittiopas.location('tee') }
+
+      it "should return 18 locations in an array" do
+        should have(18).items
+
+        subject.each do |obj|
+          obj.should be_a Reittiopas::Location
+        end
+      end
+    end
+
+    context "when given KKJ coordinates that return one location from API" do
+      before do
+        response = File.read(File.dirname(__FILE__) + '/fixtures/reverse_geocoding.xml')
+        stub_request(:any, /(?:x|y)=\d+&(?:x|y)=\d+/).to_return(:body => response, :status => 200)
+      end
+
+      subject { @reittiopas.location(:x => 2546445, :y => 6675512) }
+
+      it "should return one result" do
+        should have(1).item
+      end
+
+      it "should return a location" do
+        subject.first.should be_a Reittiopas::Location
+      end
+
+      it "should return a location with KKJ coordinates" do
+        subject.last.coordinates[:kkj].x.should eql 2546445
+        subject.last.coordinates[:kkj].y.should eql 6675512
+      end
+    end
+  end
+end
+
+describe Reittiopas::HTTP do
+  it "should have the proper base API URI" do
+    Reittiopas::HTTP::API_BASE_URI.should eql(BASE_URI)
+  end
+
+  before do
+    @account = {:username => 'foo', :password => 'bar'}
+    @http = Reittiopas::HTTP.new(@account)
+  end
+
+  context "when initialized with an account" do
+    subject { Reittiopas::HTTP.new(@account) }
+    it { should respond_to(:get) }
+
+    it "should create an API URI with account details" do
+      subject.api_uri.query_values.
+        should eql('user' => @account[:username], 'pass' => @account[:password])
+    end
+  end
+
+  describe "#get" do
+    context "with empty hash as argument" do
+      it { lambda { @http.get({}) }.should raise_error(ArgumentError) }
+    end
+
+    context "with proper hash as argument" do
+      before do
+        @opts = {'key' => 'Keihäänheittäjänkuja 12'}
+        @uri  = @http.api_uri
+        @uri.query_values = @uri.query_values.merge(@opts)
+      end
+
+      it "should create a request" do
+        stub_request(:get, Regexp.new(BASE_URI))
+        @http.get(@opts)
+        request(:get, @uri.to_s).should have_been_made
+      end
+
+      it "should return response body on successful request" do
+        stub_request(:get, @uri.to_s).to_return(:body => 'hello', :status => 200)
+        @http.get(@opts).should eql('hello')
+      end
+    end
+  end
+end
+
+describe Reittiopas::Location do
+  it { should respond_to :name }
+  it { should respond_to :city }
+  it { should respond_to :type }
+
+  describe "#parse" do
+    context "when given LOC" do
+      context "example 1" do
+        xml = parse_elem '<LOC name1="Sello" number="" city="Espoo" code="2112201" address="Ratsukuja" type="10" category="stop" x="2545011" y="6678850" lon="24.80882" lat="60.21867"/>'
+        subject { Reittiopas::Location.parse xml }
+
+        it { subject.should be_a Reittiopas::Location::Stop }
+        it { subject.address.should eql 'Ratsukuja' }
+        it { subject.city.should eql 'Espoo' }
+        it { subject.name.should eql 'Sello' }
+        it { subject.type.should eql 10 }
+        it { subject.code.should eql 2112201 }
+        it { subject.coordinates[:kkj].x.should eql 2545011 }
+        it { subject.coordinates[:kkj].y.should eql 6678850 }
+        it { subject.coordinates[:wgs].longitude.should eql 24.80882 }
+        it { subject.coordinates[:wgs].latitude.should  eql 60.21867 }
+        it { subject.to_s.should eql 'Sello' }
+      end
+
+      context "example 2" do
+        xml = parse_elem '<LOC name1="Kahisevantie" number="2" city="Espoo" code="" address="" type="900" category="street" x="2541494" y="6680344" lon="24.74568" lat="60.23245"/>'
+        subject { Reittiopas::Location.parse xml }
+
+        it { subject.should be_a Reittiopas::Location::Street }
+        it { subject.should_not respond_to :address }
+        it { subject.should_not respond_to :code }
+        it { subject.city.should eql 'Espoo' }
+        it { subject.name.should eql 'Kahisevantie' }
+        it { subject.type.should eql 900 }
+        it { subject.number.should eql 2 }
+        it { subject.coordinates[:kkj].x.should eql 2541494 }
+        it { subject.coordinates[:kkj].y.should eql 6680344 }
+        it { subject.coordinates[:wgs].longitude.should eql 24.74568 }
+        it { subject.coordinates[:wgs].latitude.should  eql 60.23245 }
+        it { subject.to_s.should eql 'Kahisevantie 2'  }
+      end
+
+      context "example 3" do
+        xml = parse_elem '<LOC name1="Teeripuisto" number="" city="Helsinki" code="1700" address="" type="3" category="poi" x="2556686" y="6682815" lon="25.02051" lat="60.2528" />'
+        subject { Reittiopas::Location.parse xml }
+
+        it { subject.should be_a Reittiopas::Location::PointOfInterest }
+        it { subject.should_not respond_to :address }
+        it { subject.city.should eql 'Helsinki' }
+        it { subject.name.should eql 'Teeripuisto' }
+        it { subject.type.should eql 3 }
+        it { subject.coordinates[:kkj].x.should eql 2556686 }
+        it { subject.coordinates[:kkj].y.should eql 6682815 }
+        it { subject.coordinates[:wgs].longitude.should eql 25.02051 }
+        it { subject.coordinates[:wgs].latitude.should  eql 60.2528 }
+        it { subject.to_s.should eql 'Teeripuisto' }
+      end
+
+      context "example 4" do
+        xml = parse_elem '<LOC name1="Otakaari" number="9" city="Espoo"  />'
+        subject { Reittiopas::Location.parse xml }
+
+        it { subject.should be_a Reittiopas::Location }
+        it { subject.city.should eql 'Espoo' }
+        it { subject.name.should eql 'Otakaari' }
+        it { subject.number.should eql 9 }
+        it { subject.should_not respond_to :address }
+        it { subject.should_not respond_to :code }
+        it { subject.type.should_not be }
+        it { subject.coordinates.should_not be }
+        it { subject.to_s.should eql 'Otakaari 9' }
+      end
+    end
+
+    context "when given LOC has 'poi' as category" do
+      xml = parse_elem '<LOC name1="Teeripuisto" number="" city="Helsinki" code="1700" address="" type="3" category="poi" x="2556686" y="6682815" lon="25.02051" lat="60.2528" />'
+      subject { Reittiopas::Location.parse xml }
+
+      it "should return a Location" do
+        should be_a Reittiopas::Location::PointOfInterest
+      end
+    end
+
+    context "when given LOC has 'stop' as category" do
+      xml = parse_elem '<LOC name1="Teeritie" number="" city="Vantaa" code="4810204" address="Korsontie" type="10" category="stop" x="2559002" y="6694007" lon="25.06559" lat="60.35291" />'
+      subject { Reittiopas::Location.parse xml }
+
+      it "should return a Stop" do
+        should be_a Reittiopas::Location::Stop
+      end
+    end
+
+    context "when given LOC has 'street' as category" do
+      xml = parse_elem '<LOC name1="Kahisevantie" number="2" city="Espoo" code="" address="" type="900" category="street" x="2541494" y="6680344" lon="24.74568" lat="60.23245"/>'
+      subject { Reittiopas::Location.parse xml }
+
+      it "should return a Street" do
+        should be_a Reittiopas::Location::Street
+      end
+    end
+  end
+end
+
+describe Reittiopas::Location::PointOfInterest do
+  it { should respond_to :code }
+end
+
+describe Reittiopas::Location::Stop do
+  it { should respond_to :address }
+  it { should respond_to :code }
+end
+
+describe Reittiopas::Location::Street do
+  it { should     respond_to :number }
+  it { should_not respond_to :code }
+end
+
+describe Reittiopas::Location::Coordinates::KKJ do
+  subject { Reittiopas::Location::Coordinates::KKJ.new(:x => 2541494, :y => 6680344) }
+
+  it { should respond_to :x }
+  it { should respond_to :y }
+end
+
+describe Reittiopas::Location::Coordinates::WGS do
+  subject { Reittiopas::Location::Coordinates::WGS.new(:lon => 24.74568, :lat => 60.23245) }
+
+  it { should respond_to :latitude }
+  it { should respond_to :longitude }
+  
+  it { subject.to_s.should eql '60.23245, 24.74568' }
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format specdoc
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'reittiopas'
+
+require 'webmock/rspec'
+include WebMock
+
+BASE_URI = "http://api.reittiopas.fi/public-ytv/fi/api/"
+
+def parse_elem(xml)
+  Nokogiri::XML(xml).children[0]
+end

data/tasks/rspec.rake

@@ -0,0 +1,38 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  desc "Run all examples with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = [
+      '--exclude', 'spec'
+    ]
+  end
+  
+  desc "Browse the code coverage report."
+  task :browse => "spec:rcov" do
+    require "launchy"
+    Launchy::Browser.run("coverage/index.html")
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: reittiopas
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Raine Virta
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-05 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id002
+description: |-
+  Reittiopas is a Ruby library for accessing the {Reittiopas Developer API}[http://developer.reittiopas.fi/pages/fi/reittiopas-api.php].
+  
+  Requires an account to the service that can be requested through {the account request page}[http://developer.reittiopas.fi/pages/fi/accountrequest.php].
+email: 
+- raine.virta@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- deps.rip
+- lib/reittiopas.rb
+- lib/reittiopas/coordinates.rb
+- lib/reittiopas/geocoding.rb
+- lib/reittiopas/http.rb
+- lib/reittiopas/location.rb
+- lib/reittiopas/reittiopas.rb
+- lib/reittiopas/utils.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/fixtures/key.xml
+- spec/fixtures/reverse_geocoding.xml
+- spec/reittiopas_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/raneksi/reittiopas
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: reittiopas
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Reittiopas is a Ruby library for accessing the {Reittiopas Developer API}[http://developer.reittiopas.fi/pages/fi/reittiopas-api.php]
+test_files: []
+