googlemaps-services 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c10843ca035ec6fe71bd6edc2a338d2c0eee8c22
-  data.tar.gz: 092b6d0d9398c95482a74ad88fd4192af0061517
+  metadata.gz: 79eb630dafebed0e332508c6dc831f9277c0265e
+  data.tar.gz: fe3a16fb698d040c80ad5cdedaf97234d3b6c3bf
 SHA512:
-  metadata.gz: c08995e5da233ce70dc80694b8b5d479cb5a9ce05a253aef8df59bfa696a8e6f5861f1fa9495b393cf21163dd7eb84fc8aa056fe3691c2f552571db4cdff23ac
-  data.tar.gz: 046dca085ea8c8d7000e7bab4adbadbbd680758feb3d752e919e823a4ac5bfc1144c312527db141a7a501c05277b35db294c7acff4d87e8e7a503ee2eec5fc6d
+  metadata.gz: 561e0cc11204546985cc8a970f95cbb6b4c90453af643b2f5edbd71525278e06f0a39be13f18927105462d250e407adc250acd2fa82041a900e31a4f1cec6e42
+  data.tar.gz: 1c6ae80c50a9038f2273b7da4f416bf0a759b9d6ba542a0359aa3e60f74d7404a0eb6e6ceb2a957ace35c7c4f45250322c7110cf9c1cd25c71cc2dbdf3b8c43f

data/lib/googlemaps/services/client.rb

@@ -1,6 +1,7 @@
 require "googlemaps/services/exceptions"
 require "googlemaps/services/version"
 require "googlemaps/services/util"
+require "nokogiri"
 require "net/http"
 require "json"
 
@@ -38,10 +39,12 @@ module GoogleMaps
       attr_accessor :queries_per_second
       # @return [Symbol] keeps track of sent queries.
       attr_accessor :sent_times
+      # @return [Symbol] Response format. Either :json or :xml
+      attr_accessor :response_format
 
       def initialize(key:, client_id: nil, client_secret: nil, timeout: nil,
                      connect_timeout: nil, read_timeout: nil,retry_timeout: 60, request_opts: nil,
-                     queries_per_second: 10, channel: nil)
+                     queries_per_second: 10, channel: nil, response_format: :json)
         if !key && !(client_secret && client_id)
           raise StandardError, "Must provide API key or enterprise credentials when creationg client."
         end
@@ -85,6 +88,11 @@ module GoogleMaps
 
         self.queries_per_second = queries_per_second
         self.sent_times = Array.new
+
+        if response_format
+          raise StandardError, "Unsupported response format. Should be either :json or :xml." unless [:json, :xml].include? response_format
+          self.response_format = response_format
+        end
       end
 
       # Performs HTTP GET requests with credentials, returning the body as JSON or XML
@@ -167,7 +175,12 @@ module GoogleMaps
           if extract_body
             result = extract_body.call(resp)
           else
-            result = get_json_body(resp)
+            case self.response_format
+            when :xml # XML response
+              result = get_xml_body(resp)
+            else # JSON response
+              result = get_json_body(resp)
+            end
           end
           self.sent_times.push(Util.current_time)
           return result
@@ -191,7 +204,7 @@ module GoogleMaps
           return resp["location"]
         end
 
-        if resp.code.to_i != 200
+        if status_code != 200
           raise HTTPError.new(resp.code)
         end
 
@@ -199,7 +212,7 @@ module GoogleMaps
         begin
           body = JSON.parse(resp.body)
         rescue JSON::ParserError
-          raise APIError.new(status_code), "Received a malformed response."
+          raise APIError.new(status_code), "Received a malformed JSON response."
         end
 
         api_status = body["status"]
@@ -218,6 +231,46 @@ module GoogleMaps
         end
       end
 
+      # Extracts the XML body of the HTTP response.
+      #
+      # @private
+      #
+      # @param [Net::HTTPResponse] resp HTTP response object.
+      #
+      # @return [Nokogiri::XML::Document] Valid XML document.
+      def get_xml_body(resp)
+        status_code = resp.code.to_i
+        if status_code >= 300 && status_code < 400
+          return resp["location"]
+        end
+
+        if status_code != 200
+          raise HTTPError.new(resp.code)
+        end
+
+        begin
+          doc = Nokogiri::XML.parse(resp.body)
+        rescue
+          raise APIError.new(status_code), "Received a malformed XML response."
+        end
+
+        api_status = doc.xpath("//status").first.text
+        if api_status == "OK" || api_status == "ZERO_RESULTS"
+          return doc
+        end
+
+        if api_status == "OVER_QUERY_LIMIT"
+          raise RetriableRequest
+        end
+
+        error_message = doc.xpath("//error_message")
+        if error_message
+          raise APIError.new(api_status), error_message.text
+        else
+          raise APIError.new(api_status)
+        end
+      end
+
       # Returns the path and query string portion of the request URL, first adding any necessary parameters.
       #
       # @private
@@ -247,7 +300,7 @@ module GoogleMaps
         raise StandardError, "Must provide API key for this API. It does not accept enterprise credentials."
       end
 
-      private :get_json_body, :generate_auth_url
+      private :get_json_body, :get_xml_body, :generate_auth_url
     end
 
   end

data/lib/googlemaps/services/directions.rb

@@ -42,7 +42,7 @@ module GoogleMaps
       #                               The traffic_model parameter may only be specified for requests where the travel mode is driving, and where the
       #                               request includes a departure_time.
       #
-      # @return [Hash] Valid JSON or XML response.
+      # @return [Array, Nokogiri::XML::NodeSet] Valid JSON or XML response.
       def query(origin:, destination:, mode: nil, waypoints: nil, alternatives: false,
                 avoid: nil, language: nil, units: nil, region: nil, departure_time: nil,
                 arrival_time: nil, optimize_waypoints: false, transit_mode: nil,
@@ -111,7 +111,12 @@ module GoogleMaps
           params["traffic_model"] = traffic_model
         end
 
-        self.client.get(url: "/maps/api/directions/json", params: params)["routes"]
+        case self.client.response_format
+        when :xml
+          self.client.get(url: "/maps/api/directions/xml", params: params).xpath("//route")
+        else
+          self.client.get(url: "/maps/api/directions/json", params: params)["routes"]
+        end
       end
     end
 

data/lib/googlemaps/services/distancematrix.rb

@@ -36,7 +36,7 @@ module GoogleMaps
       # @param [String] traffic_model Specifies the predictive travel time model to use. Valid values are "best_guess" or "optimistic" or "pessimistic".
       #                               The traffic_model parameter may only be specified for requests where the travel mode is driving, and where the request includes a departure_time.
       #
-      # @return [Hash] Matrix of distances.
+      # @return [Hash, Nokogiri::XML::Document] Matrix of distances.
       def query(origins:, destinations:, mode: nil, language: nil, avoid: nil,
                 units: nil, departure_time: nil, arrival_time: nil, transit_mode: nil,
                 transit_routing_preference: nil, traffic_model: nil)
@@ -91,7 +91,7 @@ module GoogleMaps
           params["traffic_model"] = traffic_model
         end
 
-        self.client.get(url: "/maps/api/distancematrix/json", params: params)
+        self.client.get(url: "/maps/api/distancematrix/#{self.client.response_format}", params: params).class
       end
     end
   end

data/lib/googlemaps/services/elevation.rb

@@ -24,7 +24,7 @@ module GoogleMaps
       # @param [String, Array] path An encoded polyline string, or an Array of lat/lng values from which to calculate elevation data.
       # @param [Integer] samples The number of sample points along a path for which to return elevation data.
       #
-      # @return [String] Valid JSON or XML response.
+      # @return [Array, Nokogiri::XML::NodeSet] Valid JSON or XML response.
       def query(locations: [], path: nil, samples: 0)
         params = {}
 
@@ -48,7 +48,12 @@ module GoogleMaps
           params = { "path" => path, "samples" => samples }
         end
 
-        self.client.get(url: "/maps/api/elevation/json", params: params)["results"]
+        case self.client.response_format
+        when :xml
+          self.client.get(url: "/maps/api/elevation/xml", params: params).xpath("//result")
+        else
+          self.client.get(url: "/maps/api/elevation/json", params: params)["results"]
+        end
       end
     end
 

data/lib/googlemaps/services/geocoding.rb

@@ -29,7 +29,7 @@ module GoogleMaps
       # @param [String] region The region code, specified as a ccTLD ("top-level domain") two-character value.
       # @param [String] language The language in which to return results.
       #
-      # @return [String] Valid JSON or XML response.
+      # @return [Array, Nokogiri::XML::NodeSet] Valid JSON or XML response.
       def query(address: nil, components: nil, bounds: nil, region: nil, language: nil)
         params = {}
 
@@ -53,7 +53,12 @@ module GoogleMaps
           params["language"] = language
         end
 
-        self.client.get(url: "/maps/api/geocode/json", params: params)["results"]
+        case self.client.response_format
+        when :xml
+          self.client.get(url: "/maps/api/geocode/xml", params: params).xpath("//result")
+        else
+          self.client.get(url: "/maps/api/geocode/json", params: params)["results"]
+        end
       end
     end
 
@@ -98,7 +103,12 @@ module GoogleMaps
           params["language"] = language
         end
 
-        self.client.get(url: "/maps/api/geocode/json", params: params)["results"]
+        case self.client.response_format
+        when :xml
+          self.client.get(url: "/maps/api/geocode/xml", params: params).xpath("//result")
+        else
+          self.client.get(url: "/maps/api/geocode/json", params: params)["results"]
+        end
       end
     end
 

data/lib/googlemaps/services/places.rb

@@ -24,7 +24,7 @@ module GoogleMaps
       # @param [String] type Restricts the results to places matching the specified type. The full list of supported types is available here: https://developers.google.com/places/supported_types
       # @param [String] page_token Token from a previous search that when provided will returns the next page of results for the same search.
       #
-      # @return [Hash] Valid JSON or XML response.
+      # @return [Hash, Nokogiri::XML::Document] Valid JSON or XML response.
       def search(query:, location: nil, radius: nil, language: nil, min_price: nil,
                  max_price: nil, open_now: false, type: nil, page_token: nil)
         _places(url_part: "text", query: query, location: location, radius: radius,
@@ -46,7 +46,7 @@ module GoogleMaps
       # @param [String] type Restricts the results to places matching the specified type. The full list of supported types is available here: https://developers.google.com/places/supported_types
       # @param [String] page_token Token from a previous search that when provided will returns the next page of results for the same search.
       #
-      # @return [Hash] Valid JSON or XML response.
+      # @return [Hash, Nokogiri::XML::Document] Valid JSON or XML response.
       def nearby(location:, radius: nil, keyword: nil, language: nil, min_price: nil,
                  max_price: nil, name: nil, open_now: false, rank_by: nil, type: nil, page_token: nil)
         if rank_by == "distance"
@@ -73,7 +73,7 @@ module GoogleMaps
       # @param [TrueClass, FalseClass] open_now Return only those places that are open for business at the time the query is sent.
       # @param [String] type: Restricts the results to places matching the specified type. The full list of supported types is available here: https://developers.google.com/places/supported_types
       #
-      # @return [Hash] Valid JSON or XML response.
+      # @return [Hash, Nokogiri::XML::Document] Valid JSON or XML response.
       def radar(location:, radius:, keyword: nil, min_price: nil,
                      max_price: nil, name: nil, open_now: false, type: nil)
         if !(keyword || name || type)
@@ -132,7 +132,7 @@ module GoogleMaps
           params["pagetoken"] = page_token
         end
 
-        self.client.get(url: "/maps/api/place/#{url_part}search/json", params: params)
+        self.client.get(url: "/maps/api/place/#{url_part}search/#{self.client.response_format}", params: params)
       end
 
 
@@ -141,14 +141,14 @@ module GoogleMaps
       # @param [String] place_id A textual identifier that uniquely identifies a place, returned from a Places search.
       # @param [String] language The language in which to return results.
       #
-      # @return [Hash] Valid JSON or XML response.
+      # @return [Hash, Nokogiri::XML::Document] Valid JSON or XML response.
       def place_details(place_id:, language: nil)
         params = { "placeid" => place_id }
         if language
           params["language"] = language
         end
 
-        self.client.get(url: "/maps/api/place/details/json", params: params)
+        self.client.get(url: "/maps/api/place/details/#{self.client.response_format}", params: params)
       end
 
       # Downloads a photo from the Places API.
@@ -186,7 +186,7 @@ module GoogleMaps
       # @param [String] type Restricts the results to places matching the specified type. The full list of supported types is available here: https://developers.google.com/places/web-service/autocomplete#place_types
       # @param [Hash] components A component filter for which you wish to obtain a geocode, e.g. "{'administrative_area': 'TX','country': 'US'}"
       #
-      # @return [Array] Array of predictions.
+      # @return [Array, Nokogiri::XML::NodeSet] Array of predictions.
       def autocomplete(input_text:, offset: nil, location: nil, radius: nil, language: nil, type: nil, components: nil)
         _autocomplete(url_part: "", input_text: input_text, offset: offset, location: location,
                       radius: radius, language: language, type: type, components: components)
@@ -200,7 +200,7 @@ module GoogleMaps
       # @param [Integer] radius Distance in meters within which to bias results.
       # @param [String] language The language in which to return results.
       #
-      # @return [Array] Array of predictions.
+      # @return [Array, Nokogiri::XML::NodeSet] Array of predictions.
       def autocomplete_query(input_text:, offset: nil, location: nil, radius: nil, language: nil)
         _autocomplete(url_part: "query", input_text: input_text, offset: offset,
                       location: location, radius: radius, language: language)
@@ -236,7 +236,12 @@ module GoogleMaps
           params["components"] = Convert.components(components)
         end
 
-        self.client.get(url: "/maps/api/place/#{url_part}autocomplete/json", params: params)["predictions"]
+        case self.client.response_format
+        when :xml
+          self.client.get(url: "/maps/api/place/#{url_part}autocomplete/xml", params: params).xpath("//prediction")
+        else
+          self.client.get(url: "/maps/api/place/#{url_part}autocomplete/json", params: params)["predictions"]
+        end
       end
 
       private :_places, :_autocomplete

data/lib/googlemaps/services/timezone.rb

@@ -35,7 +35,7 @@ module GoogleMaps
           params["language"] = language
         end
 
-        self.client.get(url: "/maps/api/timezone/json", params: params)
+        self.client.get(url: "/maps/api/timezone/#{self.client.response_format}", params: params)
       end
     end
 

data/lib/googlemaps/services/version.rb

@@ -1,5 +1,5 @@
 module GoogleMaps
   module Services
-    VERSION = "1.0.0"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: googlemaps-services
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Faissal Elamraoui
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-07 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,14 +73,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 description: This library brings the Google Maps API Web Services to your Ruby/RoR
-  application
+  application. It supports both JSON and XML response formats.
 email:
 - amr.faissal@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/googlemaps/services.rb
 - lib/googlemaps/services/client.rb
 - lib/googlemaps/services/directions.rb
 - lib/googlemaps/services/distancematrix.rb

data/lib/googlemaps/services.rb

@@ -1 +0,0 @@
-require "googlemaps/services/version"