reittiopas 0.0.2 → 0.1.0

data/.rspec

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

data/.yardoc/checksums

@@ -0,0 +1,9 @@
+lib/reittiopas.rb cced8096a3f0992a8d81ae358594e52a6149fff2
+lib/reittiopas/reittiopas.rb 5019a3c332476f0e31f7416adfef3944c74ac649
+lib/reittiopas/location.rb ddaf1913f5f6cc3267c5b97295c8daa3dc5375ac
+lib/reittiopas/utils.rb 67f54e983f78e319fb239d173359fedf7d5187f6
+lib/reittiopas/routing.rb 5833a35b3953e8f1d88e4ef48e6df43a4c72be47
+lib/reittiopas/http.rb e5fccc0834481a6b2a1d732e2f7fa9007a291247
+lib/reittiopas/geocoding.rb 41aacb43af4a7b178571646e7c4c2413dab250eb
+lib/reittiopas/exceptions.rb c3d2abd5037e5971a29bc760b14171f8bba8c0b0
+lib/reittiopas/coordinates.rb e4114495a73f43c51d040f3147f963fe28fcd1b6

data/.yardoc/object_types

@@ -0,0 +1,4 @@
+{
+:module[
+"
+class["Reittiopas"Reittiopas::HTTP"Nokogiri::XML::Element"	Hash"Reittiopas::Routing::Route"!Reittiopas::Routing::Section"Reittiopas::Routing::Point"%Reittiopas::Routing::MapLocation"Reittiopas::Routing::Stop"%Reittiopas::Routing::SectionTime"!Reittiopas::Routing::Arrival"#Reittiopas::Routing::Departure"Reittiopas::Routing::Part"Reittiopas::Routing::Walk"Reittiopas::Routing::Line"Reittiopas::Location"*Reittiopas::Location::PointOfInterest"Reittiopas::Location::Stop"!Reittiopas::Location::Street"Reittiopas::AccessError"+Reittiopas::Location::Coordinates::WGS"+Reittiopas::Location::Coordinates::KKJ:	root[;:

data/History.txt

@@ -1,3 +1,13 @@
+=== 0.1.0 2012-08-12
+
+* Routing support from Matti Paksula
+* Updated the project to use Rspec 2
+* Use YARD for docs instead of Rdoc
+
+=== 0.0.2 2010-04-22
+
+* Fixed incorrectly configured runtime dependencies.
+
 === 0.0.1 2010-04-05
 
 * 1 major enhancement:

data/Manifest.txt

@@ -1,6 +1,11 @@
+.rspec
+.yardoc/checksums
+.yardoc/object_types
+.yardoc/objects/root.dat
+.yardoc/proxy_types
 History.txt
 Manifest.txt
-README.rdoc
+README.md
 Rakefile
 lib/reittiopas.rb
 lib/reittiopas/coordinates.rb
@@ -9,15 +14,19 @@ lib/reittiopas/geocoding.rb
 lib/reittiopas/http.rb
 lib/reittiopas/location.rb
 lib/reittiopas/reittiopas.rb
+lib/reittiopas/routing.rb
 lib/reittiopas/utils.rb
 script/console
 script/destroy
 script/generate
+spec/fixtures/kallion_kirjasto.xml
 spec/fixtures/key.xml
 spec/fixtures/no_access
 spec/fixtures/reverse_geocoding.xml
+spec/fixtures/route_ulvilantie_19-kallion_kirjasto.xml
+spec/fixtures/ulvilantie_19_helsinki.xml
+spec/reittiopas_routing_spec.rb
 spec/reittiopas_spec.rb
-spec/spec.opts
 spec/spec_helper.rb
 tasks/rdoc.rake
 tasks/rspec.rake

data/README.md

@@ -0,0 +1,103 @@
+# Reittiopas
+
+* [Documentation at Github](http://raneksi.github.com/reittiopas/)
+* [Specifications](http://raneksi.github.com/reittiopas/specdoc)
+
+## 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 coordinates](http://fi.wikipedia.org/wiki/Kartastokoordinaattij%C3%A4rjestelm%C3%A4).
+
+	location = reittiopas.location(:x => 2546445, :y => 6675512).first
+	puts "#{location}, #{location.city}"
+	
+	=> Otakaari 9, Espoo
+
+### Routing
+
+Search for routes between two locations: show 3 routes and do not use metro.
+
+	from = reittiopas.locations('mannerheimintie 5').first
+	to   = reittiopas.location('kallion kirjasto').first
+
+	routes = reittiopas.routing(from, to, {"show" => 3, "use_metro" => 0})
+	routes.each do |route|
+		puts "#{route.distance} #{route.time}"
+		puts "Lines: "
+
+		route.lines.each do |line|
+			puts "#{line.code} starts from: #{line.stops.first.code}"
+		end
+	end
+
+Options for routing are passed to Reittiopas. See Reittiopas developer API for the possible options.
+
+
+## INSTALLATION
+
+	gem install reittiopas
+
+or to use latest upstream:
+
+	git clone git://github.com/raneksi/reittiopas.git
+	cd reittiopas
+	rake newb
+	rake install_gem
+
+## REQUIREMENTS
+
+* [Nokogiri](htttp://nokogiri.org)
+* [Addressable](http://github.com/sporkmonger/addressable)
+
+## TODO
+
+* Support for determining the closest stop within radius
+
+## LICENSE
+
+(The MIT License)
+
+Copyright (c) 2010 - 2011:
+
+* [Raine Virta](https://github.com/raneksi)
+* [Matti Paksula](https://github.com/matti)
+
+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

@@ -1,27 +1,33 @@
-require 'rubygems'
-gem 'hoe', '>= 2.1.0'
-require 'hoe'
-require 'fileutils'
-
-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_deps << [dep, '>= 0']
-  end
-
-  self.url              = "http://github.com/raneksi/reittiopas"
-  self.extra_dev_deps   = [
-    ['webmock', ">= 0.9.1"],
-    ['rspec', ">= 0"],
-    ['darkfish-rdoc', ">= 0"]
-  ]
-  self.readme_file      = "README.rdoc"
-  self.extra_rdoc_files = FileList['*.rdoc']
-end
-
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+
+Hoe.plugin :newgem
+Hoe.plugin :yard
+
+$hoe = Hoe.spec 'reittiopas' do
+  developer 'Raine Virta', 'raine.virta@gmail.com'
+  self.rubyforge_name = self.name
+
+  self.extra_deps = [
+    [ 'addressable', '= 2.2.8' ],
+    [ 'nokogiri', '>= 0']
+  ]
+
+  self.readme_file      = "README.md"
+  self.urls             = ["http://github.com/raneksi/reittiopas"]
+  self.extra_dev_deps   = [
+    ['webmock', "= 1.8.8"],
+    ['rspec', "= 2.11.0"],
+    ['yard', ">= 0.8.2.1"],
+    ['hoe-yard', ">= 0"]
+  ]
+
+  self.yard_title = 'Reittiopas (0.1.0)'
+  self.yard_markup = "markdown"
+  self.yard_opts = ['--protected']
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/reittiopas.rb

@@ -3,6 +3,7 @@ require 'cgi'
 require 'net/http'
 require 'nokogiri'
 require 'addressable/uri'
+require 'date'
 
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
@@ -12,12 +13,13 @@ require 'reittiopas/utils'
 require 'reittiopas/coordinates'
 require 'reittiopas/location'
 require 'reittiopas/geocoding'
+require 'reittiopas/routing'
 require 'reittiopas/reittiopas'
 require 'reittiopas/http'
 
 class Reittiopas
   # The version of Reittiopas you are using.
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end
 
 # Shorter way for Reittiopas instance creation.

data/lib/reittiopas/coordinates.rb

@@ -19,6 +19,10 @@ class Location
         @x = opts[:x].to_i
         @y = opts[:y].to_i
       end
+      
+      def to_routing_string
+        "#{@x},#{@y}"
+      end
     end
   end
 end

data/lib/reittiopas/reittiopas.rb

@@ -3,7 +3,8 @@
 #
 class Reittiopas
   include Geocoding
-
+  include Routing
+  
   # Instantiate a Reittiopas object.
   #
   # [account] A hash containing the keys +:username+ and +:password+ with

data/lib/reittiopas/routing.rb

@@ -0,0 +1,310 @@
+class Reittiopas
+  
+  module Routing
+  
+    # Route between two Locations.  Returns an array of Routes that contain all sub elements
+    
+    def routing(from, to, opts)
+      @from = from
+      @to = to
+      @options = opts
+      
+      params = { :a => @from.coordinates[:kkj].to_routing_string,
+                 :b => @to.coordinates[:kkj].to_routing_string}.merge(@options)
+      
+      xml = @http.get(params)
+      doc = Nokogiri::XML(xml)
+    
+      routes = []
+      
+      doc.search("ROUTE").each do |route|
+        routes << Route.parse(route)
+      end
+    
+      return routes
+    end
+  
+  
+    class Route
+      
+      attr_reader :time, :distance, :parts, :walks, :lines
+      
+      def initialize(opts)
+        @time = opts[:time].to_f if opts[:time]
+        @distance = opts[:distance].to_f if opts[:distance]
+        
+        @parts, @walks, @lines = opts[:parts], opts[:walks], opts[:lines]      
+      end
+      
+      
+      # Parse the route and sub elements
+      def self.parse(xml)
+        length_element = xml.search("LENGTH").first
+        
+        time = length_element.get_attr_value "time"
+        dist = length_element.get_attr_value "dist"
+          
+        parts, walks, lines = [], [], []
+        
+        xml.elements.each do |e|
+          next if e.name == "LENGTH"
+          case e.name
+            when "POINT"
+              parts << Point.parse(e)
+            when "WALK"
+              walk = Walk.parse(e)
+              parts << walk
+              walks << walk
+            when "LINE"
+              line = Line.parse(e)
+              parts << line
+              lines << line
+          end
+
+        end
+
+        new(:time => time,
+            :distance => dist,
+            :parts => parts,
+            :walks => walks,
+            :lines => lines)
+            
+      end
+      
+    end
+    
+    
+    # Points, MapLocations and Stops are Sections
+    class Section
+      attr_reader :x, :y, :arrival, :departure
+      
+      def initialize(opts)
+        @x = opts[:x].to_f if opts[:x]
+        @y = opts[:y].to_f if opts[:y]
+        @arrival = opts[:arrival]
+        @departure = opts[:departure]
+      end
+
+      def self.parse(xml)
+        x = xml.get_attr_value "x"
+        y = xml.get_attr_value "y"
+        
+        arrival_element = xml.search("ARRIVAL").first
+        departure_element = xml.search("DEPARTURE").first
+        
+        arrival = Arrival.parse arrival_element
+        departure = Departure.parse departure_element
+        
+        { :x => x,
+          :y => y,
+          :arrival => arrival,
+          :departure => departure }
+      end
+
+    end
+     
+    class Point < Section
+      
+      attr_reader :uid
+      
+      def initialize(opts)
+        super
+        @uid = opts[:uid]
+      end
+
+      def self.parse(xml)
+        opts = super
+        
+        uid = xml.get_attr_value "uid"
+        
+        opts.merge!( :uid => uid )
+        new(opts)
+      end
+    end
+    
+    class MapLocation < Section
+      
+      attr_reader :location_type, :name
+      
+      def initialize(opts)
+        super
+        @location_type = opts[:location_type].to_i if opts[:location_type]
+        @name = opts[:name]
+      end
+      
+      def self.parse(xml)
+        opts = super
+        location_type = xml.get_attr_value "type"
+        
+        name_elements = xml.search("NAME")
+        name = name_elements.first.get_attr_value "val" if name_elements.first
+        
+        opts.merge!(:location_type => location_type,
+                    :name => name)
+                    
+        new(opts)
+      end
+    end
+    
+    class Stop < Section
+      
+      attr_reader :code, :stop_id,
+                  :names
+      
+      def initialize(opts)
+        super
+        @code = opts[:code]
+        @stop_id = opts[:stop_id]
+        @names = opts[:names]
+      end
+      
+      def self.parse(xml)
+        opts = super
+        
+        code = xml.get_attr_value "code"
+        stop_id = xml.get_attr_value "id"
+        
+        name_elements = xml.search("NAME")
+        
+        names = {}
+        name_elements.each do |e|
+          lang = e.get_attr_value "lang"
+          val = e.get_attr_value "val"
+          
+          names[lang] = val
+        end
+        
+        opts.merge!(:code => code,
+                    :stop_id => stop_id,
+                    :names => names)
+        new(opts)
+      end
+      
+    end
+    
+    # Each Section has Arrival and Departure times (and seems that those are always the same)
+    
+    class SectionTime
+      
+      attr_reader :date_time
+      
+      def initialize(opts)
+        @date_time = DateTime.parse("#{opts[:date]} #{opts[:time]}")
+      end
+      
+      def self.parse(xml)
+        date = xml.get_attr_value "date"
+        time = xml.get_attr_value "time"
+
+        new(:date => date,
+            :time => time)
+      end
+    end
+    
+    class Arrival < SectionTime ; end
+    
+    class Departure < SectionTime ; end
+    
+    
+    # Part represents Walks and Lines.    
+    class Part
+  
+      attr_reader :time, :distance,
+                  :sections, :map_locations, :points, :stops
+                  
+      def initialize(opts)
+        @time = opts[:time].to_f if opts[:time]
+        @distance = opts[:distance].to_f if opts[:time]
+        @sections, @map_locations, @points, @stops = opts[:sections], opts[:map_locations], opts[:points], opts[:stops]
+      end
+
+      def self.parse(xml)
+        length_element = xml.search("LENGTH").first
+        
+        time = length_element.get_attr_value "time"
+        distance = length_element.get_attr_value "dist"
+        
+        sections, map_locations, points, stops = [], [], [], []
+        
+        xml.elements.each do |e|
+          next if e.name == "LENGTH"
+          
+          case e.name
+            when "POINT"
+              point = Point.parse(e)
+              sections << point
+              points << point
+            when "MAPLOC"
+              map_location = MapLocation.parse(e)
+              sections << map_location
+              map_locations << map_location
+            when "STOP"
+              stop = Stop.parse(e)
+              sections << stop
+              stops << stop
+          end
+        end
+        
+        { :time => time,
+          :distance => distance,
+          :sections => sections,
+          :map_locations => map_locations,
+          :points => points,
+          :stops => stops }
+      end
+
+    end
+    
+    class Walk < Part
+      
+      def self.parse(xml)
+        opts = super
+        
+        new opts
+      end
+    end
+    
+    class Line < Part
+      attr_reader :line_id, :code, :line_type, :mobility
+      
+      def initialize(opts)
+        super
+        
+        @line_id = opts[:line_id]
+        @code = opts[:code]
+        @line_type = opts[:line_type].to_i if opts[:line_type]
+        @mobility = opts[:mobility].to_i if opts[:mobility]
+        
+        @stops = opts[:stops] || []
+      end
+
+      def self.parse(xml)
+        opts = super
+        
+        line_id = xml.get_attr_value "id"
+        code = xml.get_attr_value "code"
+        line_type = xml.get_attr_value "type"
+        mobility = xml.get_attr_value "mobility"
+        
+        stops = []
+        
+        opts[:sections].each do |section|
+          stops << section if section.is_a? Stop
+        end            
+        
+        opts.merge!(:line_id => line_id,
+                    :code => code,
+                    :line_type => line_type,
+                    :mobility => mobility,
+                    :stops => stops)
+      
+        new(opts)
+      end
+    end
+    
+    
+  end
+  
+  
+  
+end