rome2rio 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03ec9441a72831df297c2ac4281c433169c7d08e
+  data.tar.gz: 9629577e4d586cbd3522ab82dcd7216903418063
+SHA512:
+  metadata.gz: 8b34778ea682a760038375d3e3d5929eede320dcac96d1bd73a04ce7f7cdccd28942e2f63e765799c0f9959a0699e4ddc73cda79ddbb4e9f1912ee1aa54acb34
+  data.tar.gz: f97f41bd12a419cb0cdbde70f993fc4f5bc9da8c9513857e49cf2f5c874653af9d445e07361fa14ad1c0447f27b9fd0d5ba999d057c9bd3e4465eae49c59518b

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Alex Beregszaszi
+
+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,42 @@
+Rome2rio
+========
+
+A Ruby wrapper for the Rome2rio API. See http://www.rome2rio.com/documentation/search for the official documentation.
+
+Installation
+------------
+
+```
+gem install rome2rio
+```
+
+
+Usage
+-----
+
+```
+require 'rome2rio'
+results = Rome2rio::Connection.new.search(search options)
+puts results.routes[0].duration
+```
+
+All field names (both request and response) use the original naming as in the API documentation.
+
+The API key and endpoint URL both can be set when creating an instance, but they can be overwritten by passing them for a request.
+
+Complex datatypes (such as Position, Size, Offset, DayFlags) will be parsed.
+
+Using Position for input:
+
+```
+Rome2rio::Connection.new.search({:oPos => Rome2rio::Position.new(41.79443,12.25108), :dPos => Rome2rio::Position.new(-22.81215,-43.24721)})
+```
+
+The original JSON response is also available in the ```verbatim``` field.
+
+Copyright
+---------
+
+Made for Soundtravel (http://soundtravel.co/).
+
+Copyright (c) 2013 Alex Beregszaszi. See LICENSE for details.

data/lib/rome2rio.rb

@@ -0,0 +1,14 @@
+require 'faraday'
+require 'multi_json'
+
+require 'rome2rio/connection'
+
+require 'rome2rio/helper/encoded_number_pair'
+require 'rome2rio/helper/offset'
+require 'rome2rio/helper/position'
+require 'rome2rio/helper/size'
+require 'rome2rio/helper/encoded_flags'
+require 'rome2rio/helper/day_flags'
+require 'rome2rio/helper/search_request_flags'
+
+Dir[File.dirname(__FILE__) + '/rome2rio/response/*.rb'].each { |file| require file }

data/lib/rome2rio/connection.rb

@@ -0,0 +1,37 @@
+module Rome2rio
+  class Connection
+    def initialize(opts = {})
+      @apikey = opts[:apikey]
+      @endpoint = opts[:endpoint] || "http://evaluate.rome2rio.com"
+    end
+
+    def handle_response(response)
+      if response.status == 200
+        SearchResponse.new(MultiJson.decode(response.body))
+      else
+        {:status => response.status, :body => response.body}
+      end
+    end
+
+    def encode_params(params)
+      URI.encode_www_form(params)
+    end
+
+    def search(opts)
+      opts[:key] ||= @apikey if @apikey
+
+      # format SearchFlags
+      flags = opts[:flags]
+      opts[:flags] = SearchRequestFlags.new(flags)  if flags.is_a?(Symbol) or flags.is_a?(Array)
+
+      request = "/api/1.2/json/Search?#{encode_params(opts)}"
+
+      handle_response(Faraday.new(:url => @endpoint).get(request))
+
+      #      handle_response(conn.get do |req|
+      #	  req.headers['Content-Type'] = 'application/json'
+      #	  req.url request_url
+      #      end)
+    end
+  end
+end

data/lib/rome2rio/helper/day_flags.rb

@@ -0,0 +1,23 @@
+module Rome2rio
+  class DayFlags < EncodedFlags
+    FLAG_VALUES = {
+      :sunday    => 0x01,
+      :sun       => 0x01,
+      :monday    => 0x02,
+      :mon       => 0x02,
+      :tuesday   => 0x04,
+      :tue       => 0x04,
+      :wednesday => 0x08,
+      :wed       => 0x08,
+      :thursday  => 0x10,
+      :thu       => 0x10,
+      :friday    => 0x20,
+      :fri       => 0x20,
+      :saturday  => 0x40,
+      :sat       => 0x40,
+      :weekdays  => 0x3E,
+      :weekends  => 0x41,
+      :all       => 0x7F
+    }
+  end
+end

data/lib/rome2rio/helper/encoded_flags.rb

@@ -0,0 +1,51 @@
+module Rome2rio
+  class EncodedFlags
+    attr_accessor :flags
+
+    def initialize(flags = nil)
+      @flags = flags
+    end
+
+    def self.parse(str)
+      value = Integer(str)
+      ret = new
+      ret.flags = []
+      self::FLAG_VALUES.each { |key, flag| ret.flags << key if (value & flag) == flag }
+      ret
+    end
+
+    def to_a
+      return flags.map { |k, v| k if v == true || v == 1 }.select { |k| k != nil } if flags.is_a?(Hash)
+      return [ flags.to_sym ] if flags.is_a?(String)
+      return [ flags ] if flags.is_a?(Symbol)
+      flags
+    end
+
+    def method_missing(meth, *args, &block)
+      if meth.to_s.end_with?("?") then
+        key = meth.to_s.chop.to_sym
+
+        return true if to_a.include?(key)
+
+        #	    return flags.include?(key) if flags.is_a?(Array)
+        #	    return flags[key] if flags.is_a?(Hash)
+        #	    return true if flags == key
+
+      end
+
+      super(meth, *args, &block)
+    end
+
+    def to_s
+      to_i.to_s
+    end
+
+    def to_i
+      keys = to_a
+
+      ret = 0
+      self.class::FLAG_VALUES.each { |key, flag| ret |= flag if keys.include?(key) }
+      ret
+    end
+  end
+end

data/lib/rome2rio/helper/encoded_number_pair.rb

@@ -0,0 +1,23 @@
+module Rome2rio
+  class EncodedNumberPair
+    attr_accessor :a, :b
+
+    def initialize(a = nil, b = nil)
+      @a = a
+      @b = b
+    end
+
+    def self.parse(str)
+      # failsafe for empty data
+      return if not str or str.strip.length == 0
+
+      ret = new
+      str.scan(/([\d\.]+), ([\d\.]+)/).collect { |a, b| ret.a, ret.b = a, b }
+      ret
+    end
+
+    def to_s
+      "#{a}, #{b}"
+    end
+  end
+end

data/lib/rome2rio/helper/offset.rb

@@ -0,0 +1,7 @@
+module Rome2rio
+  class Offset < EncodedNumberPair
+    attr_accessor :x, :y
+    alias :x :a
+    alias :y :b
+  end
+end

data/lib/rome2rio/helper/position.rb

@@ -0,0 +1,7 @@
+module Rome2rio
+  class Position < EncodedNumberPair
+    attr_accessor :lat, :lng
+    alias :lat :a
+    alias :lng :b
+  end
+end

data/lib/rome2rio/helper/search_request_flags.rb

@@ -0,0 +1,24 @@
+module Rome2rio
+  class SearchRequestFlags < EncodedFlags
+    FLAG_VALUES = {
+      :all                     => 0x00000000,
+      :no_segments             => 0x000fffff,
+      :no_flight_segments      => 0x00000001,
+      :no_flight_itineraries   => 0x00000002,
+      :no_train_segments       => 0x00000010,
+      :no_train_itineraries    => 0x00000020,
+      :no_bus_segments         => 0x00000100,
+      :no_bus_itineraries      => 0x00000200,
+      :no_ferry_segments       => 0x00001000,
+      :no_ferry_itineraries    => 0x00002000,
+      :no_car_segments         => 0x00010000,
+      :no_commuter_hops        => 0x00100000,
+      :no_special_hops         => 0x00200000,
+      :no_minor_start_segments => 0x00400000,
+      :no_minor_end_segments   => 0x00800000,
+      :no_paths                => 0x01000000,
+      :no_prices               => 0x04000000,
+      :no_scoring              => 0x10000000,
+    }
+  end
+end

data/lib/rome2rio/helper/size.rb

@@ -0,0 +1,7 @@
+module Rome2rio
+  class Size < EncodedNumberPair
+    attr_accessor :w, :h
+    alias :w :a
+    alias :h :b
+  end
+end

data/lib/rome2rio/response/agency.rb

@@ -0,0 +1,13 @@
+module Rome2rio
+  class Agency
+    attr_reader :code, :name, :url, :iconPath, :iconSize, :iconOffset
+    def initialize(json)
+      @code = json["code"]
+      @name = json["name"]
+      @url = json["url"]
+      @iconPath = json["iconPath"]
+      @iconSize = Size.parse(json["iconSize"])
+      @iconOffset = Offset.parse(json["iconOffset"])
+    end
+  end
+end

data/lib/rome2rio/response/airline.rb

@@ -0,0 +1,13 @@
+module Rome2rio
+  class Airline
+    attr_reader :code, :name, :url, :iconPath, :iconSize, :iconOffset
+    def initialize(json)
+      @code = json["code"]
+      @name = json["name"]
+      @url = json["url"]
+      @iconPath = json["iconPath"]
+      @iconSize = Size.parse(json["iconSize"])
+      @iconOffset = Offset.parse(json["iconOffset"])
+    end
+  end
+end

data/lib/rome2rio/response/airport.rb

@@ -0,0 +1,10 @@
+module Rome2rio
+  class Airport
+    attr_reader :code, :name, :pos
+    def initialize(json)
+      @code = json["code"]
+      @name = json["name"]
+      @pos = Position.parse(json["pos"])
+    end
+  end
+end

data/lib/rome2rio/response/flight_hop.rb

@@ -0,0 +1,18 @@
+module Rome2rio
+  class FlightHop
+    attr_reader :sCode, :tCode, :sTime, :tTime, :airline, :flight,
+    :duration, :dayChange, :lDuration, :lDayChange
+    def initialize(json)
+      @sCode = json["sCode"]
+      @tCode = json["tCode"]
+      @sTime = json["sTime"]
+      @tTime = json["tTime"]
+      @airline = json["airline"]
+      @flight = json["flight"]
+      @duration = json["duration"]
+      @dayChange = json["dayChange"] if json["dayChange"]
+      @lDuration = json["lDuration"] if json["lDuration"]
+      @lDayChange = json["lDayChange"] if json["lDayChange"]
+    end
+  end
+end

data/lib/rome2rio/response/flight_itinerary.rb

@@ -0,0 +1,9 @@
+module Rome2rio
+  class FlightItinerary
+    attr_reader :legs
+    def initialize(json)
+      @legs = []
+      json["legs"].each { |leg| @legs << FlightLeg.new(leg) }
+    end
+  end
+end

data/lib/rome2rio/response/flight_leg.rb

@@ -0,0 +1,10 @@
+module Rome2rio
+  class FlightLeg
+    attr_reader :days, :hops
+    def initialize(json)
+      @days = DayFlags.parse(json["days"])
+      @hops = []
+      json["hops"].each { |hop| @hops << FlightHop.new(hop) }
+    end
+  end
+end

data/lib/rome2rio/response/indicative_price.rb

@@ -0,0 +1,12 @@
+module Rome2rio
+  class IndicativePrice
+    attr_reader :price, :currency, :nativePrice, :nativeCurrency, :isFreeTransfer
+    def initialize(json)
+      @price = json["price"] if json["price"]
+      @currency = json["currency"] if json["currency"]
+      @nativePrice = json["nativePrice"] if json["nativePrice"]
+      @nativeCurrency = json["nativeCurrency"] if json["nativeCurrency"]
+      @isFreeTransfer = json["isFreeTransfer"] == 1 if json["isFreeTransfer"]
+    end
+  end
+end

data/lib/rome2rio/response/route.rb

@@ -0,0 +1,14 @@
+module Rome2rio
+  class Route
+    attr_reader :name, :distance, :duration, :stops, :segments
+    def initialize(json)
+      @name = json["name"]
+      @distance = json["distance"]
+      @duration = json["duration"]
+      @stops = []
+      json["stops"].each { |stop| @stops << Stop.new(stop) }
+      @segments = []
+      json["segments"].each { |segment| @segments << Segment.new(segment) }
+    end
+  end
+end

data/lib/rome2rio/response/search_response.rb

@@ -0,0 +1,20 @@
+module Rome2rio
+  class SearchResponse
+    attr_reader :agencies, :airlines, :airports, :routes, :verbatim
+    def initialize(json)
+      @verbatim = json
+
+      @agencies = []
+      json["agencies"].each { |agency| @agencies << Agency.new(agency) }
+
+      @airlines = []
+      json["airlines"].each { |airline| @airlines << Airline.new(airline) }
+
+      @airports = []
+      json["airports"].each { |airport| @airports << Airport.new(airport) }
+
+      @routes = []
+      json["routes"].each { |route| @routes << Route.new(route) }
+    end
+  end
+end

data/lib/rome2rio/response/segment.rb

@@ -0,0 +1,33 @@
+module Rome2rio
+  class Segment
+    attr_reader :kind, :isMajor, :distance, :duration, :indicativePrice, :isImperial,
+    :sName, :sPos, :sCode, :tName, :tPos, :tCode, :path, :itineraries
+    def initialize(json)
+      # Possible kinds: walk, car, train, bus, ferry, flight
+      @kind = json["kind"]
+      @isMajor = json["isMajor"]
+      @distance = json["distance"]
+      @duration = json["duration"]
+      @indicativePrice = IndicativePrice.new(json["indicativePrice"])
+
+      if @kind != "flight" then
+        @isImperial = json["isImperial"]
+        @sName = json["sName"]
+        @sPos = Position.parse(json["sPos"])
+        @tName = json["tName"]
+        @tPos = Position.parse(json["tPos"])
+        @path = json["path"]
+      else
+        @sCode = json["sCode"]
+        @tCode = json["tCode"]
+        @itineraries = []
+        json["itineraries"].each { |itinerary| @itineraries << FlightItinerary.new(itinerary) }
+      end
+
+      if [ "train", "bus", "ferry" ].include?(@kind) then
+        @itineraries = []
+        json["itineraries"].each { |itinerary| @itineraries << TransitItinerary.new(itinerary) }
+      end
+    end
+  end
+end

data/lib/rome2rio/response/stop.rb

@@ -0,0 +1,11 @@
+module Rome2rio
+  class Stop
+    attr_reader :kind, :name, :pos, :code
+    def initialize(json)
+      @kind = json["kind"]
+      @name = json["name"]
+      @pos = Position.parse(json["pos"])
+      @code = json["code"]
+    end
+  end
+end

data/lib/rome2rio/response/transit_hop.rb

@@ -0,0 +1,16 @@
+module Rome2rio
+  class TransitHop
+    attr_reader :sName, :sPos, :tName, :tPos, :frequency, :duration, :indicativePrice, :lines
+    def initialize(json)
+      @sName = json["sName"]
+      @sPos = Position.parse(json["sPos"])
+      @tName = json["tName"]
+      @tPos = Position.parse(json["tPos"])
+      @frequency = json["frequency"]
+      @duration = json["duration"]
+      @indicativePrice = IndicativePrice.new(json["indicativePrice"])
+      @lines = []
+      json["lines"].each { |line| @lines << TransitLine.new(line) }
+    end
+  end
+end

data/lib/rome2rio/response/transit_itinerary.rb

@@ -0,0 +1,9 @@
+module Rome2rio
+  class TransitItinerary
+    attr_reader :legs
+    def initialize(json)
+      @legs = []
+      json["legs"].each { |leg| @legs << TransitLeg.new(leg) }
+    end
+  end
+end

data/lib/rome2rio/response/transit_leg.rb

@@ -0,0 +1,10 @@
+module Rome2rio
+  class TransitLeg
+    attr_reader :url, :hops
+    def initialize(json)
+      @url = json["url"]
+      @hops = []
+      json["hops"].each { |hop| @hops << TransitHop.new(hop) }
+    end
+  end
+end

data/lib/rome2rio/response/transit_line.rb

@@ -0,0 +1,13 @@
+module Rome2rio
+  class TransitLine
+    attr_reader :name, :vehicle, :code, :agency, :frequency, :duration
+    def initialize(json)
+      @name = json["name"]
+      @vehicle = json["vehicle"]
+      @code = json["code"]
+      @agency = json["agency"]
+      @frequency = json["frequency"]
+      @duration = json["duration"]
+    end
+  end
+end

data/rome2rio.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name = "rome2rio"
+  gem.version = "0.1"
+  gem.authors = ["Alex Beregszaszi"]
+  gem.email = ["alex@rtfs.hu"]
+  gem.description = "A Ruby wrapper for the Rome2rio API. See http://www.rome2rio.com/documentation/search for the official documentation."
+  gem.summary = "A Ruby wrapper for the Rome2rio API."
+  gem.homepage = "http://github.com/axic/rome2rio"
+
+  gem.add_dependency 'faraday'
+  gem.add_dependency 'multi_json'
+
+  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.require_paths = ["lib"]
+
+  gem.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: rome2rio
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Alex Beregszaszi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby wrapper for the Rome2rio API. See http://www.rome2rio.com/documentation/search
+  for the official documentation.
+email:
+- alex@rtfs.hu
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .gitignore
+- LICENSE
+- README.md
+- lib/rome2rio.rb
+- lib/rome2rio/connection.rb
+- lib/rome2rio/helper/day_flags.rb
+- lib/rome2rio/helper/encoded_flags.rb
+- lib/rome2rio/helper/encoded_number_pair.rb
+- lib/rome2rio/helper/offset.rb
+- lib/rome2rio/helper/position.rb
+- lib/rome2rio/helper/search_request_flags.rb
+- lib/rome2rio/helper/size.rb
+- lib/rome2rio/response/agency.rb
+- lib/rome2rio/response/airline.rb
+- lib/rome2rio/response/airport.rb
+- lib/rome2rio/response/flight_hop.rb
+- lib/rome2rio/response/flight_itinerary.rb
+- lib/rome2rio/response/flight_leg.rb
+- lib/rome2rio/response/indicative_price.rb
+- lib/rome2rio/response/route.rb
+- lib/rome2rio/response/search_response.rb
+- lib/rome2rio/response/segment.rb
+- lib/rome2rio/response/stop.rb
+- lib/rome2rio/response/transit_hop.rb
+- lib/rome2rio/response/transit_itinerary.rb
+- lib/rome2rio/response/transit_leg.rb
+- lib/rome2rio/response/transit_line.rb
+- rome2rio.gemspec
+homepage: http://github.com/axic/rome2rio
+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: A Ruby wrapper for the Rome2rio API.
+test_files: []