geogle 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 420f8dc09e9f029c43118d8657382817e7c3c4f8
-  data.tar.gz: 307cf748f3fcb120c21f6022dc11613e84b4c140
+  metadata.gz: f470b89b70dfc743b33fa0acc1efd0da3bfebc84
+  data.tar.gz: 059ef9de83990d21fb60370b919c36354883b398
 SHA512:
-  metadata.gz: 7dbffd7b45e1688419d70177f8b3762050bb499b766fff93838886706f3cb568fd81ccf69c4701114f0ef88cd83c6851bb8223e9fff8002bd0d5e44e00c2f603
-  data.tar.gz: fc46aa55ac9c5126a4001132f81a4d83b369a6bb587a8e6c6e8499a85d20b6059aca31b613db433250f6dd1ca6babe687459ab23f5b463252c7ded7fc8f48464
+  metadata.gz: 252efd684801b8f1398f35f1e4fa49b080cc4c67c1f3b8904e4761d1f5e3dc64f67e29983e70e2270dd45015436ba0655e8c69aee09727d4fd960631263ae634
+  data.tar.gz: 6df63d56ec93a7415ce1bcab5d8839ae9b5a4ca621197269d90902aa7ae3c1ec941b51193dbe7471fc5ae7974f3602d929e5f090bf26685626ce9b4084fed2b6

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/integration/business_geocoder_spec.rb
+spec/fixtures/cassettes/business_geocode_by_address.yml

data/README.md

@@ -1,12 +1,10 @@
 # Geogle
 
-[![wercker status](https://app.wercker.com/status/6122e4f0966ee255949e2eb465aefd10/m "wercker status")](https://app.wercker.com/project/bykey/6122e4f0966ee255949e2eb465aefd10)
+Still in development!
 
-Still in development. Ruby wrapper for the Geocoding service provided from the Google Maps API.
+[![wercker status](https://app.wercker.com/status/6122e4f0966ee255949e2eb465aefd10/m "wercker status")](https://app.wercker.com/project/bykey/6122e4f0966ee255949e2eb465aefd10)
 
-
-Documentation
-https://developers.google.com/maps/documentation/geocoding/
+Ruby wrapper for the Geocoding and Directions services provided from the Google Maps API.
 
 
 ## Installation
@@ -25,39 +23,86 @@ Or install it yourself as:
 
 ## Usage
 
-When creating the Geogle::Client instance you can pass:
+### Geocoding
+Google geocoding documentation:
+https://developers.google.com/maps/documentation/geocoding/
+
+When creating the Geogle::Geocoder instance you can pass:
 
-* sensor: true or false (false by default)
-* language: ("en" by default).
+* **sensor**: true or false (false by default)
+* **language**: ("en" by default).
 
 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**: ID of the client. It starts with "gme-" prefix.
+* **crypto_key**: Criptographic key.
 
 Here's more information about Google Maps API for Business:
 https://developers.google.com/maps/documentation/business/webservices
 
-### Geocode by address with non-Business account
-
-    $ client = Geogle::Client.new({ sensor: false, language: "es" })
+There are two methods that can be called:
+* **address**: Geocoding by name of the location.
+* **latlng**:  Reverse geocode.
+
+Both methods return an array of Geogle::Model::Place. Each place is composed by:
+* **geometry**:
+    * **location**:
+        * **lat**: Float
+        * **lng**: Float
+    * **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
+* **address**:
+    * **street_number**: String
+    * **street**: String
+    * **locality**: String
+    * **area_level_1**: String
+    * **area_level_1_code**: String
+    * **area_level_2**: String
+    * **area_level_2_code**: String
+    * **country**: String
+    * **country_code**: String
+    * **formatted**: String
+
+### By address without an account
+
+    $ client = Geogle::Geocoder.new({ sensor: false, language: "es" })
     $ client.address("Blasco Ibañez, Valencia")
 
-### Geocode by address making use of the components
+### By address making use of the components
 
-    $ client = Geogle::Client.new({ sensor: false, language: "es" })
+    $ 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)
+
 ### Using a business account
 
-    $ client = Geogle::Client.new({ client_id: "gme-client-id", crypto_key: "crypto-key" })
-    $ Geogle::Client.new.latlng(39.5073225, -0.2914778)
+    $ 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 included in the URL.
 
+### Directions
+Directions service is still in development
+
 
 ## Contributing
 

data/geogle.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'faraday'
   spec.add_dependency 'virtus'
   spec.add_dependency 'ruby-hmac'
 

data/lib/geogle/base.rb

@@ -1,20 +1,21 @@
 # encoding: UTF-8
 
-require "faraday"
 require "json"
+require "net/http"
 
 module Geogle
   class Base
     def initialize(args = {})
       @args        = args
       @parametizer = Parametizer.new(args)
-      @conn        = Faraday.new
     end
 
     protected
 
     def request(url, params)
-      response = @conn.get(UrlBuilder.new(url, @args).build(params))
+      uri = UrlBuilder.new(url, @args).build(params)
+      response = Net::HTTP.get_response(uri)
+      raise InvalidKeyError if response.code == "403"
       body = JSON.parse(response.body)
       ErrorHandler.check(body['status'])
       body

data/lib/geogle/url_builder.rb

@@ -33,7 +33,7 @@ module Geogle
 
       # encode the signature into base64 for url use form.
       signature = url_safe_base64_encode(raw_signature)
-      "#{url.scheme}://#{url.host}#{url_to_sign}&signature=#{signature}"
+      URI("#{url.scheme}://#{url.host}#{url_to_sign}&signature=#{signature}")
     end
 
     def url_safe_base64_decode(base64_string)

data/lib/geogle/version.rb

@@ -1,3 +1,3 @@
 module Geogle
-  VERSION = "0.2.2"
+  VERSION = "0.2.4"
 end

data/spec/fixtures/cassettes/geocode_by_address_DE.yml

@@ -0,0 +1,99 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://maps.googleapis.com/maps/api/geocode/json?address=Berlin&components=country:DE&language=de&sensor=false
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Date:
+      - Thu, 28 Aug 2014 08:52:39 GMT
+      Expires:
+      - Fri, 29 Aug 2014 08:52:39 GMT
+      Cache-Control:
+      - public, max-age=86400
+      Access-Control-Allow-Origin:
+      - "*"
+      Server:
+      - mafe
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Frame-Options:
+      - SAMEORIGIN
+      Alternate-Protocol:
+      - 443:quic
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: |
+        {
+           "results" : [
+              {
+                 "address_components" : [
+                    {
+                       "long_name" : "Berlin",
+                       "short_name" : "Berlin",
+                       "types" : [ "locality", "political" ]
+                    },
+                    {
+                       "long_name" : "Berlin",
+                       "short_name" : "Berlin",
+                       "types" : [ "administrative_area_level_1", "political" ]
+                    },
+                    {
+                       "long_name" : "Deutschland",
+                       "short_name" : "DE",
+                       "types" : [ "country", "political" ]
+                    }
+                 ],
+                 "formatted_address" : "Berlin, Deutschland",
+                 "geometry" : {
+                    "bounds" : {
+                       "northeast" : {
+                          "lat" : 52.6754542,
+                          "lng" : 13.7611176
+                       },
+                       "southwest" : {
+                          "lat" : 52.33962959999999,
+                          "lng" : 13.0911663
+                       }
+                    },
+                    "location" : {
+                       "lat" : 52.52000659999999,
+                       "lng" : 13.404954
+                    },
+                    "location_type" : "APPROXIMATE",
+                    "viewport" : {
+                       "northeast" : {
+                          "lat" : 52.6754542,
+                          "lng" : 13.7611176
+                       },
+                       "southwest" : {
+                          "lat" : 52.33962959999999,
+                          "lng" : 13.0911663
+                       }
+                    }
+                 },
+                 "types" : [ "locality", "political" ]
+              }
+           ],
+           "status" : "OK"
+        }
+    http_version: 
+  recorded_at: Thu, 28 Aug 2014 08:52:39 GMT
+recorded_with: VCR 2.8.0

data/spec/fixtures/cassettes/geocode_by_latlng_invalid_business.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://maps.googleapis.com/maps/api/geocode/json?client=gme-foo&language=en&latlng=39.4699075,-0.3762881&sensor=false&signature=hDQSukmnhjyDe6y81ph3C_tbs_M=
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Content-Type:
+      - text/plain; charset=UTF-8
+      Date:
+      - Thu, 28 Aug 2014 12:31:17 GMT
+      Pragma:
+      - no-cache
+      Expires:
+      - Fri, 01 Jan 1990 00:00:00 GMT
+      Cache-Control:
+      - no-cache, must-revalidate
+      Access-Control-Allow-Origin:
+      - "*"
+      Server:
+      - mafe
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Frame-Options:
+      - SAMEORIGIN
+      Alternate-Protocol:
+      - 443:quic
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: 'Unable to authenticate the request. Provided ''signature'' is not valid
+        for the provided client ID, or the provided ''client'' is not valid. Learn
+        more: https://developers.google.com/maps/documentation/business/webservices/auth'
+    http_version: 
+  recorded_at: Thu, 28 Aug 2014 12:31:17 GMT
+recorded_with: VCR 2.8.0

data/spec/geogle/{client_spec.rb → geocoder_spec.rb}

@@ -11,6 +11,18 @@ describe Geogle::Geocoder do
     end
   end
 
+  describe 'searching with a non-default locale' do
+    let(:places) do
+      VCR.use_cassette('geocode_by_address_DE') do
+        described_class.new(language: "de").address('Berlin', { country: 'DE' })
+      end
+    end
+
+    it "returns an array" do
+      expect(places).to be_kind_of(Array)
+    end
+  end
+
   describe 'searching by latlng' do
     let(:places) do
       VCR.use_cassette('geocode_by_latlng') do
@@ -32,4 +44,17 @@ describe Geogle::Geocoder do
       end
     end
   end
+
+  describe "when using non-valid business credentials" do
+    let(:places) do
+      VCR.use_cassette('geocode_by_latlng_invalid_business') do
+        geocoder = described_class.new(client_id: "gme-foo", crypto_key: "bar")
+        geocoder.latlng(39.4699075, -0.3762881)
+      end
+    end
+
+    it "an exception InvalidKeyError is raised" do
+      expect{ places }.to raise_error(Geogle::InvalidKeyError)
+    end
+  end
 end

data/spec/geogle/url_builder_spec.rb

@@ -4,6 +4,7 @@ describe Geogle::UrlBuilder do
   let(:params) do
     {
       address: "Street FooBar",
+      language: "de",
       sensor:  true
     }
   end
@@ -13,7 +14,7 @@ describe Geogle::UrlBuilder do
     let(:business_attrs) { {} }
 
     it "the built url doesn't contain a query param signature" do
-      expect(built_url.to_s).to eq("https://www.foo.com?address=Street+FooBar&sensor=true")
+      expect(built_url.to_s).to eq("https://www.foo.com?address=Street+FooBar&language=de&sensor=true")
     end
   end
 
@@ -26,7 +27,7 @@ describe Geogle::UrlBuilder do
     end
 
     it "the built url contains a query param signature" do
-      expect(built_url).to eq("https://www.foo.com?client=gme-clientid&address=Street+FooBar&sensor=true&signature=JiUf5yTKyPSuD8TebiKdA5kg-kg=\n")
+      expect(built_url.to_s).to eq("https://www.foo.com?client=gme-clientid&address=Street+FooBar&language=de&sensor=true&signature=1klekRivPNXr3vOpOixX16LNGuI=")
     end
   end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: geogle
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - yone_lc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-27 00:00:00.000000000 Z
+date: 2014-08-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: virtus
   requirement: !ruby/object:Gem::Requirement
@@ -183,8 +169,10 @@ files:
 - lib/geogle/url_builder.rb
 - lib/geogle/version.rb
 - spec/fixtures/cassettes/geocode_by_address.yml
+- spec/fixtures/cassettes/geocode_by_address_DE.yml
 - spec/fixtures/cassettes/geocode_by_latlng.yml
-- spec/geogle/client_spec.rb
+- spec/fixtures/cassettes/geocode_by_latlng_invalid_business.yml
+- spec/geogle/geocoder_spec.rb
 - spec/geogle/parser_spec.rb
 - spec/geogle/url_builder_spec.rb
 - spec/spec_helper.rb
@@ -216,8 +204,10 @@ summary: Provides a Ruby interface to geocode requests to Google Maps API V3 and
   the response
 test_files:
 - spec/fixtures/cassettes/geocode_by_address.yml
+- spec/fixtures/cassettes/geocode_by_address_DE.yml
 - spec/fixtures/cassettes/geocode_by_latlng.yml
-- spec/geogle/client_spec.rb
+- spec/fixtures/cassettes/geocode_by_latlng_invalid_business.yml
+- spec/geogle/geocoder_spec.rb
 - spec/geogle/parser_spec.rb
 - spec/geogle/url_builder_spec.rb
 - spec/spec_helper.rb