geogle 0.2.5 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 353a109106208ca895390a03fa8fe2caaaefeacb
-  data.tar.gz: a2fa5961b9c53d53a598327a5eb5f76b7f7e246f
+  metadata.gz: fc312835c798185f9b4ecc05e853c727e25f0597
+  data.tar.gz: 0bde3ef341b88d5667ed7166a9f252cae58857d7
 SHA512:
-  metadata.gz: aaeda50b03cc403e5dc157f75a04d73ecdf79301a7818de014890e97f12d3e248f910d67d1590a168bf08b998ee91dfe5c2f3115bb81c7cdf2e36f2c532dc58c
-  data.tar.gz: 87c18ca1df52e7a1eeece15bcb3d94b4b41d531442b8ff34b4606a2a117965794f53e12db1dd17e5cb8335a50749e94ceeefce8abca7282db493dd43460baeae
+  metadata.gz: bae6ad2a7a4bb5b2f7f82b413a9af61ffd5585e4de15acad2e0dc22406e2b6d3460002e3b5cfaab4b17e22ece3787821d4bf4c938bf971016e34de5dc7aae173
+  data.tar.gz: f78db15efbafcd71331f36617a3e0d1a2876f71a6bb542b5ae6b737ccd99991737553d115881526cee3959ef8c64f8dcf01ebd5618a33fd9c63eb99d29f39375

data/.gitignore

@@ -16,4 +16,6 @@ test/tmp
 test/version_tmp
 tmp
 spec/integration/business_geocoder_spec.rb
-spec/fixtures/cassettes/business_geocode_by_address.yml
+spec/integration/business_directions_spec.rb
+spec/fixtures/cassettes/business_geocode_by_address.yml
+spec/fixtures/cassettes/business_directions.yml

data/README.md

@@ -1,11 +1,9 @@
 # Geogle
 
-Still in development!
-
-[![wercker status](https://app.wercker.com/status/6122e4f0966ee255949e2eb465aefd10/m "wercker status")](https://app.wercker.com/project/bykey/6122e4f0966ee255949e2eb465aefd10)
-
 Ruby wrapper for the Geocoding and Directions services provided from the Google Maps API.
 
+[![wercker status](https://app.wercker.com/status/6122e4f0966ee255949e2eb465aefd10/m "wercker status")](https://app.wercker.com/project/bykey/6122e4f0966ee255949e2eb465aefd10)
+[![Gem Version](https://badge.fury.io/rb/geogle.svg)](http://badge.fury.io/rb/geogle)
 
 ## Installation
 
@@ -23,46 +21,45 @@ Or install it yourself as:
 
 ## Usage
 
-### Geocoding
+## Geocoding
 Google geocoding documentation:
 https://developers.google.com/maps/documentation/geocoding/
 
-When creating the Geogle::Geocoder instance you can pass:
+### Setting parameters
+
+When creating the Geogle::Geocoder these are the setting parameters:
 
-* **sensor**: true or false (false by default)
-* **language**: ("en" by default).
+* **sensor**:
+    * **true**
+    * **false** (default)
+* **language**: ar, eu, bg, bn, ca, cs, da, de, el, en, en-AU, en-GB, es, eu, fa, fi, fil, fr, gl, gu, hi, hr, hu, id, it, iw, ja, kn, ko, lt, lv, ml, mr, nl, no, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, tl, ta, te, th, tr, uk, vi, zh-CN, zh-TW
+* **raw**:
+    * **true**: returns the raw json that comes in the body from the response.
+    * **false** (default): returns the object created with auxiliar funtions.
 
-In case you wanna use Google Maps API for Business, you'll need to pass the following attributes in order to sign the URL.
-* **client_id**: ID of the client. It starts with "gme-" prefix.
-* **crypto_key**: Criptographic key.
+* **client_id** (required for business API): ID of the client. It starts with "gme-" prefix.
+* **crypto_key** (required for business API): Criptographic key.
 
 Here's more information about Google Maps API for Business:
 https://developers.google.com/maps/documentation/business/webservices
 
-There are two methods that can be called:
-* **address**: Geocoding by name of the location.
-* **latlng**:  Reverse geocode.
+#### Data model
 
 Both methods return an array of Geogle::Model::Place. Each place is composed by:
-* **geometry**:
-    * **location**:
-        * **lat**: Float
-        * **lng**: Float
+
+* **Coordinates**:
+    * **lat**: Float
+    * **lng**: Float
+
+* **Area**:
+    * **northeast**: Coordinates
+    * **southwest**: Coordinates
+
+* **Geometry**:
+    * **location**: Coordinates
     * **location_type**: String
-    * **bounds**:
-        * **northeast**:
-            * **lat**: Float
-            * **lng**: Float
-        * **southwest**:
-            * **lat**: Float
-            * **lng**: Float
-    * **viewport**:
-        * **northeast**:
-            * **lat**: Float
-            * **lng**: Float
-        * **southwest**:
-            * **lat**: Float
-            * **lng**: Float
+    * **bounds**: Area
+    * **viewport**: Area
 * **address**:
     * **street_number**: String
     * **street**: String
@@ -75,33 +72,92 @@ Both methods return an array of Geogle::Model::Place. Each place is composed by:
     * **country_code**: String
     * **formatted**: String
 
+
 ### By address without an account
 
-    $ client = Geogle::Geocoder.new({ sensor: false, language: "es" })
-    $ client.address("Blasco Ibañez, Valencia")
+```ruby
+client = Geogle::Geocoder.new({ sensor: false, language: "es" })
+client.address("Blasco Ibañez, Valencia")
+```
 
 ### By address making use of the components
 
-    $ client = Geogle::Geocoder.new({ sensor: false, language: "es" })
-    $ components = { country: 'ES' }
-    $ client.address("Blasco Ibañez, Valencia", components)
+```ruby
+client = Geogle::Geocoder.new({ sensor: false, language: "es" })
+components = { country: 'ES' }
+client.address("Blasco Ibañez, Valencia", components)
+```
 
   Available components to be used can be found here:
   https://developers.google.com/maps/documentation/geocoding/#ComponentFiltering
 
 ### Reverse geocoding (by latitude and longitude)
 
-    $ Geogle::Geocoder.new.latlng(39.5073225, -0.2914778)
+```ruby
+Geogle::Geocoder.new.latlng(39.5073225, -0.2914778)
+```
 
 ### Using a business account
 
-    $ client = Geogle::Geocoder.new({ client_id: "gme-client-id", crypto_key: "crypto-key" })
-    $ client.latlng(39.5073225, -0.2914778)
+```ruby
+client = Geogle::Geocoder.new({ client_id: "gme-client-id", crypto_key: "crypto-key" })
+client.latlng(39.5073225, -0.2914778)
+```
+
+  The signature required to do the request will be appended in the URL.
+
+## Directions
+
+### Setting parameters
+
+The same as with **Geocode**.
+
+#### Data model
+
+Return an array of Geogle::Model::Route. Each route is composed by:
+
+* **Time**:
+    * **value**: Integer
+    * **text**: String
+    * **time_zone**: String
+
+* **TextValue**:
+    * **value**: Integer
+    * **text**: String
+
+* **Leg**:
+    * **steps**: Step
+    * **distance**: TextValue
+    * **duration**: TextValue
+    * **arrival_time**: Time
+    * **departure_time**: Time
+    * **start_address**: String
+    * **end_address**: String
+    * **start_location**: Coordinates
+    * **end_location**: Coordinates
+
+* **Route**:
+    * **summary**: String
+    * **legs**: Array[Leg]
+    * **waypoint_order**: Array[Integer]
+    * **bounds**: Area
+    * **copyrights**: String
+    * **warnings**: Array[String]
+
+
+### Search using address names for origin and destination
+
+```ruby
+client = Geogle::Directions.new
+client.routes("Berlin", "Munich", { region: "de" })
+```
 
-  The signature required to do the request will be included in the URL.
+### Search using geo-locations for origin and destination
 
-### Directions
-Directions service is still in development
+```ruby
+client = Geogle::Directions.new
+client.routes("39.4699889,-0.3759178", "40.4167158,-3.7037799")
+```
 
 
 ## Contributing

data/lib/geogle.rb

@@ -5,6 +5,7 @@ module Geogle
   require "geogle/model"
   require "geogle/base"
   require "geogle/geocoder"
+  require "geogle/directions"
   require "geogle/error"
   require "geogle/error_handler"
   require "geogle/parametizer"

data/lib/geogle/base.rb

@@ -5,15 +5,16 @@ require "net/http"
 
 module Geogle
   class Base
-    def initialize(args = {})
-      @args        = args
-      @parametizer = Parametizer.new(args)
+    def initialize(settings = {})
+      @settings    = settings
+      @parametizer = Parametizer.new(settings)
+      @raw         = settings[:raw] || false
     end
 
     protected
 
     def request(url, params)
-      uri = UrlBuilder.new(url, @args).build(params)
+      uri = UrlBuilder.new(url, @settings).build(params)
       response = Net::HTTP.get_response(uri)
       raise InvalidKeyError if response.code == "403"
       body = JSON.parse(response.body)

data/lib/geogle/directions.rb

@@ -2,6 +2,11 @@
 
 module Geogle
   class Directions < Base
-
+    def routes(origin, destination, options = {})
+      params = @parametizer.directions(origin, destination, options)
+      body = request(URL::DIRECTIONS, params)
+      return body["routes"] if @raw
+      Parser.routes(body["routes"])
+    end
   end
 end

data/lib/geogle/geocoder.rb

@@ -14,6 +14,7 @@ module Geogle
 
     def executor(method, arg1, arg2)
       body = request(URL::GEOCODE, @parametizer.send(method, arg1, arg2))
+      return body["results"] if @raw
       Parser.places(body["results"])
     end
   end

data/lib/geogle/model.rb

@@ -2,10 +2,16 @@
 
 module Geogle
   module Model
+    require "geogle/model/place"
     require "geogle/model/address"
     require "geogle/model/area"
     require "geogle/model/coordinates"
     require "geogle/model/geometry"
-    require "geogle/model/place"
+
+    require "geogle/model/route"
+    require "geogle/model/leg"
+    require "geogle/model/step"
+    require "geogle/model/time"
+    require "geogle/model/text_value"
   end
 end

data/lib/geogle/model/area.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
 require 'virtus'
-require_relative 'coordinates'
+require 'geogle/model/coordinates'
 
 module Geogle
   module Model

data/lib/geogle/model/geometry.rb

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 
 require 'virtus'
-require_relative 'area'
-require_relative 'coordinates'
+require 'geogle/model/area'
+require 'geogle/model/coordinates'
 
 module Geogle
   module Model

data/lib/geogle/model/leg.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+require 'virtus'
+require 'geogle/model/step'
+require 'geogle/model/time'
+require 'geogle/model/text_value'
+require 'geogle/model/coordinates'
+
+module Geogle
+  module Model
+
+    class Leg
+      include Virtus.model
+
+      attribute :steps,          Array[Step]
+      attribute :distance,       TextValue
+      attribute :duration,       TextValue
+      attribute :arrival_time,   Time
+      attribute :departure_time, Time
+      attribute :start_address,  String
+      attribute :end_address,    String
+      attribute :start_location, Coordinates
+      attribute :end_location,   Coordinates
+    end
+  end
+end

data/lib/geogle/model/place.rb

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 
 require 'virtus'
-require_relative 'address'
-require_relative 'geometry'
+require 'geogle/model/address'
+require 'geogle/model/geometry'
 
 module Geogle
   module Model

data/lib/geogle/model/route.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+
+require 'virtus'
+require 'geogle/model/leg'
+require 'geogle/model/area'
+
+module Geogle
+  module Model
+
+    class Route
+      include Virtus.model
+
+      attribute :summary,           String
+      attribute :legs,              Array[Leg]
+      attribute :waypoint_order,    Array[Integer]
+      attribute :overview_polyline, String
+      attribute :bounds,            Area
+      attribute :copyrights,        String
+      attribute :warnings,          Array[String]
+    end
+  end
+end

data/lib/geogle/model/step.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+
+require 'virtus'
+require 'geogle/model/coordinates'
+require 'geogle/model/text_value'
+
+module Geogle
+  module Model
+
+    class Step
+      include Virtus.model
+
+      attribute :html_instructions, String
+      attribute :distance,          TextValue
+      attribute :duration,          TextValue
+      attribute :start_location,    Coordinates
+      attribute :end_location,      Coordinates
+      attribute :travel_mode,       String
+      # Only travel_mode is transit
+      # attribute :sub_steps,         String
+      # attribute :transit_details,   String
+    end
+  end
+end

data/lib/geogle/model/text_value.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+
+require 'virtus'
+
+module Geogle
+  module Model
+
+    class TextValue
+      include Virtus.model
+
+      attribute :text,  String
+      attribute :value, Integer
+    end
+  end
+end

data/lib/geogle/model/time.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+require 'virtus'
+
+module Geogle
+  module Model
+
+    class Time
+      include Virtus.model
+
+      attribute :text,      String
+      attribute :value,     Integer
+      attribute :time_zone, String
+    end
+  end
+end

data/lib/geogle/parametizer.rb

@@ -8,20 +8,46 @@ module Geogle
     end
 
     def address(address, components = {})
-      options = { }
-      options[:address]    = address
-      options[:language]   = @language
-      options[:components] = components(components) unless components.empty?
-      options[:sensor]     = @sensor
-      options
+      options = {
+        address:    address,
+        language:   @language,
+        components: components(components),
+        sensor:     @sensor
+      }
+      compact_hash(options)
     end
 
     def latlng(lat, lng)
-      { latlng: "#{lat},#{lng}", language: @language, sensor: @sensor }
+      {
+        latlng:   "#{lat},#{lng}",
+        language: @language,
+        sensor:   @sensor
+      }
+    end
+
+    def directions(origin, destination, params)
+      waypoints = params[:waypoints] || []
+      options = {
+        origin:         origin,
+        destination:    destination,
+        waypoints:      waypoints.join("|"),
+        alternatives:   params[:alternatives],
+        avoid:          params[:avoid],
+        units:          params[:units],
+        region:         params[:region],
+        departure_time: params[:departure_time],
+        arrival_time:   params[:arrival_time],
+        sensor:         @sensor
+      }
+      compact_hash(options)
     end
 
     private
 
+    def compact_hash(hash)
+      hash.select { |k,v| !v.nil? && !v.to_s.empty? }
+    end
+
     def components(components)
       components.collect do |component, value|
         "#{component}:#{value}"