google_places 0.24.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71b0c22f8ff5d7f4126d7d99bdfe4ba4e02f3ca7
-  data.tar.gz: a9743dff330d99c2d3bebc70cbb2e30373469aff
+  metadata.gz: aa3d60080776cfdf41db6e889d93a4a867cbb21c
+  data.tar.gz: d9bc8d18548afecb8a3cf811c605db6c005b0591
 SHA512:
-  metadata.gz: cefe8b2f0f204e88538d1cf963dd5f7deff967304f7f0933c1fccfbfcdb73efbf9123300d3d63a4adafed95ed69156ed502934f3eb633d84b9c49d2545c1b5d6
-  data.tar.gz: 8cdfd49cb2ae7db142f5543f11e868e2cfeb94de49aa2397d11fa10005da9b3629238ca47a4c17b79b0d53f03ad95c8e5a849c5616a869efe27f128707e4b36a
+  metadata.gz: 11d260b9b3a91ed0866a85b20236fd2d8bd10957972e2a482c06bc2d42ea261792622eb167877add3ade9e4b7474db3a24799f6a76da47f195b5b18ca44f732c
+  data.tar.gz: f5f368bf9522fe018179a2c7c52bc3aa4ad512da3c4b3678c2e9bc432dc554623b0a2073b6228c40c4947341978941fd9dd152613ca6f1beed992278f5f2ab03

data/.gitignore

@@ -8,3 +8,7 @@ spec/api_key.rb
 .yardoc/
 doc/
 .idea
+*.swp
+*.swo
+.ruby-version
+.ruby-gemset

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    google_places (0.22.0)
+    google_places (0.26.0)
       httparty (~> 0.13.1)
 
 GEM

data/README.rdoc

@@ -83,7 +83,7 @@ Get results in specific language:
   @client.spots(-33.8670522, 151.1957362, :language => 'en')
 
 === Retrieving spots based on query
-  
+
   @client.spots_by_query('Pizza near Miami Florida')
 
 Search by multiple types and exclude multiple types
@@ -111,9 +111,35 @@ Then retrieve the spot:
   @spot = @client.spot('CmRYAAA...upoTH3g')
 
 Then request one of the photos url with a max width:
-  
+
   url = @spot.photos[0].fetch_url(800)
 
+=== Places Autocomplete
+
+https://developers.google.com/places/documentation/autocomplete
+
+<em>Note:</em> Autocomplete is often used and better suited on client side (browser/javascript). The Autocomplete API is rate limited, so make sure you check the usage limits before deciding on whether to call the API server/client side.
+
+https://developers.google.com/maps/documentation/business/articles/usage_limits
+
+==== Example usage
+
+Register a new Client:
+
+  @client = GooglePlaces::Client.new(API_KEY)
+
+Then request a prediction based on partial match:
+
+  @client.predictions_by_input(
+      'San F',
+      lat: 0.0,
+      lng: 0.0,
+      radius: 20000000,
+      types: 'geocode',
+      language: I18n.locale,
+  )
+
+The response will be an array of predictions.
 
 == Development
 

data/google_places.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'google_places'
-  s.version     = '0.24.0'
+  s.version     = '0.26.0'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Marcel de Graaf']
   s.email       = ['mail@marceldegraaf.net']

data/lib/google_places.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'httparty'
 
-%w(client location request spot error photo).each do |file|
+%w(client location prediction request spot error photo).each do |file|
   require File.join(File.dirname(__FILE__), 'google_places', file)
 end
 

data/lib/google_places/client.rb

@@ -5,7 +5,6 @@ module GooglePlaces
     attr_reader :api_key
     # @return [Hash] the provided options hash
     attr_reader :options
-    attr_reader :sensor
 
     # Creates a new Client instance which proxies the requests to the certain classes
     #
@@ -19,8 +18,6 @@ module GooglePlaces
     #   Defines the distance (in meters) within which to return Place results.
     #   The maximum allowed radius is 50,000 meters.
     #   Note that radius must not be included if <b>:rankby</b> is specified
-    # @option options [Boolean] :sensor
-    #   Indicates whether or not the Place request came from a device using a location sensor (e.g. a GPS) to determine the location sent in this request.
     # @option options [String,Array] :types
     #   Restricts the results to Spots matching at least one of the specified types
     # @option options [String] :name
@@ -44,9 +41,8 @@ module GooglePlaces
     # @see http://spreadsheets.google.com/pub?key=p9pdwsai2hDMsLkXsoM05KQ&gid=1 List of supported languages
     # @see https://developers.google.com/maps/documentation/places/supported_types List of supported types
 
-    def initialize(api_key = @api_key, sensor = false, options = {})
+    def initialize(api_key = @api_key, options = {})
       api_key ? @api_key = api_key : @api_key = GooglePlaces.api_key
-      @sensor = sensor
       @options = options
     end
 
@@ -70,10 +66,6 @@ module GooglePlaces
     #   - distance. This option sorts results in ascending order by their distance from the specified location.
     #     Ranking results by distance will set a fixed search radius of 50km.
     #     One or more of keyword, name, or types is required.                                                                                                                                                                                                                                                                                       distance. This option sorts results in ascending order by their distance from the specified location. Ranking results by distance will set a fixed search radius of 50km. One or more of keyword, name, or types is required.
-    # @option options [Boolean] :sensor (false)
-    #   Indicates whether or not the Place request came from a device using a location sensor (e.g. a GPS)
-    #   to determine the location sent in this request.
-    #   <b>Note that this is a mandatory parameter</b>
     # @option options [String,Array] :types
     #   Restricts the results to Spots matching at least one of the specified types
     # @option options [String] :name
@@ -97,7 +89,7 @@ module GooglePlaces
     # @see http://spreadsheets.google.com/pub?key=p9pdwsai2hDMsLkXsoM05KQ&gid=1 List of supported languages
     # @see https://developers.google.com/maps/documentation/places/supported_types List of supported types
     def spots(lat, lng, options = {})
-      Spot.list(lat, lng, @api_key, @sensor, @options.merge(options))
+      Spot.list(lat, lng, @api_key, @options.merge(options))
     end
 
     # Search for a Spot with a reference key
@@ -105,9 +97,6 @@ module GooglePlaces
     # @return [Spot]
     # @param [String] place_id the place_id of the spot
     # @param [Hash] options
-    # @option options [Boolean] :sensor (false)
-    #   Indicates whether or not the Place request came from a device using a location sensor (e.g. a GPS) to determine the location sent in this request.
-    #   <b>Note that this is a mandatory parameter</b>
     # @option options [String] :language
     #   The language code, indicating in which language the results should be returned, if possible.
     #
@@ -117,7 +106,7 @@ module GooglePlaces
     # @option options [Integer] :retry_options[:max] (0) the maximum retries
     # @option options [Integer] :retry_options[:delay] (5) the delay between each retry in seconds
     def spot(place_id, options = {})
-      Spot.find(place_id, @api_key, @sensor, @options.merge(options))
+      Spot.find(place_id, @api_key, @options.merge(options))
     end
 
     # Search for Spots with a query
@@ -141,9 +130,6 @@ module GooglePlaces
     #   - distance. This option sorts results in ascending order by their distance from the specified location.
     #     Ranking results by distance will set a fixed search radius of 50km.
     #     One or more of keyword, name, or types is required.                                                                                                                                                                                                                                                                                       distance. This option sorts results in ascending order by their distance from the specified location. Ranking results by distance will set a fixed search radius of 50km. One or more of keyword, name, or types is required.
-    # @option options [Boolean] :sensor (false)
-    #   Indicates whether or not the Place request came from a device using a location sensor (e.g. a GPS) to determine the location sent in this request.
-    #   <b>Note that this is a mandatory parameter</b>
     # @option options [String,Array] :types
     #   Restricts the results to Spots matching at least one of the specified types
     # @option options [String] :language
@@ -160,7 +146,7 @@ module GooglePlaces
     # @see http://spreadsheets.google.com/pub?key=p9pdwsai2hDMsLkXsoM05KQ&gid=1 List of supported languages
     # @see https://developers.google.com/maps/documentation/places/supported_types List of supported types
     def spots_by_query(query, options = {})
-      Spot.list_by_query(query, @api_key, @sensor, @options.merge(options))
+      Spot.list_by_query(query, @api_key, @options.merge(options))
     end
 
     # Search for Spots with a pagetoken
@@ -178,11 +164,11 @@ module GooglePlaces
     #
     # @see https://developers.google.com/maps/documentation/places/supported_types List of supported types
     def spots_by_pagetoken(pagetoken, options = {})
-      Spot.list_by_pagetoken(pagetoken, @api_key, @sensor, @options.merge(options))
+      Spot.list_by_pagetoken(pagetoken, @api_key, @options.merge(options))
     end
 
     # Radar Search Service allows you to search for up to 200 Places at once, but with less detail than is typically returned from a Text Search or Nearby Search request. The search response will include up to 200 Places, identified only by their geographic coordinates and reference. You can send a Place Details request for more information about any of them.
-    # 
+    #
     # @return [Array<Spot>]
     # @param [String,Integer] lat the latitude for the search
     # @param [String,Integer] lng the longitude for the search
@@ -205,18 +191,40 @@ module GooglePlaces
     # @option options [Integer] :maxprice
     #   Restricts results to only those places within the specified price range. Valid values range between 0 (most affordable) to 4 (most expensive), inclusive.
     # @option options [Boolean] :opennow
-    #   Retricts results to those Places that are open for business at the time the query is sent. 
-    #   Places that do not specify opening hours in the Google Places database will not be returned if you include this parameter in your query. 
+    #   Retricts results to those Places that are open for business at the time the query is sent.
+    #   Places that do not specify opening hours in the Google Places database will not be returned if you include this parameter in your query.
     #   Setting openNow to false has no effect.
     # @option options [Boolean] :zagatselected
-    #   Restrict your search to only those locations that are Zagat selected businesses. 
-    #   This parameter does not require a true or false value, simply including the parameter in the request is sufficient to restrict your search. 
+    #   Restrict your search to only those locations that are Zagat selected businesses.
+    #   This parameter does not require a true or false value, simply including the parameter in the request is sufficient to restrict your search.
     #   The zagatselected parameter is experimental, and only available to Places API enterprise customers.
     #
     # @see https://developers.google.com/places/documentation/search#RadarSearchRequests
     def spots_by_radar(lat, lng, options = {})
-      Spot.list_by_radar(lat, lng, @api_key, @sensor, @options.merge(options))
+      Spot.list_by_radar(lat, lng, @api_key, @options.merge(options))
     end
 
+    # Query for Place Predictions
+    #
+    # @return [Array<Prediction>]
+    # @param [String] query the query to search for
+    # @param [Hash] options
+    # @option options [String,Integer] lat the latitude for the search
+    # @option options [String,Integer] lng the longitude for the search
+    # @option options [Integer] :radius (1000)
+    #   Defines the distance (in meters) within which to return Place results.
+    #   The maximum allowed radius is 50,000 meters.
+    #   Note that radius must not be included if :rankby => 'distance' (described below) is specified.
+    #   <b>Note that this is a mandatory parameter</b>
+    # @option options [String,Array] :types
+    #   Restricts the results to Spots matching at least one of the specified types
+    # @option options [String] :language
+    #   The language code, indicating in which language the results should be returned, if possible.
+    #
+    # @see http://spreadsheets.google.com/pub?key=p9pdwsai2hDMsLkXsoM05KQ&gid=1 List of supported languages
+    # @see https://developers.google.com/maps/documentation/places/supported_types List of supported types
+    def predictions_by_input(input, options = {})
+      Prediction.list_by_input(input, @api_key, @options.merge(options))
+    end
   end
 end

data/lib/google_places/error.rb

@@ -7,7 +7,6 @@ module GooglePlaces
   # This can be the case when:
   # - querying the SPOT_LIST_URL <b>without</b> the following parameters:
   # - - key
-  # - - sensor
   class RequestDeniedError < HTTParty::ResponseError
   end
 

data/lib/google_places/photo.rb

@@ -2,23 +2,18 @@ module GooglePlaces
   class Photo
     attr_accessor :width, :height, :photo_reference, :html_attributions
 
-    def initialize(width, height, photo_reference, html_attributions, api_key, sensor)
+    def initialize(width, height, photo_reference, html_attributions, api_key)
       @width             = width
       @height            = height
       @photo_reference   = photo_reference
       @html_attributions = html_attributions
       @api_key           = api_key
-      @sensor            = sensor
     end
 
     # Search for a Photo's url with its reference key
     #
     # @return [URL]
     # @param [String] api_key the provided api key
-    # @param [Boolean] sensor
-    #   Indicates whether or not the Place request came from a device using a location sensor (e.g. a GPS)
-    #   to determine the location sent in this request.
-    #   <b>Note that this is a mandatory parameter</b>
     # @param [Hash] options
     # @option options [Hash] :retry_options ({})
     #   A Hash containing parameters for search retries
@@ -33,7 +28,6 @@ module GooglePlaces
         @fetched_url = Request.photo_url(
           :maxwidth => maxwidth,
           :photoreference => @photo_reference,
-          :sensor => @sensor,
           :key => @api_key,
           :retry_options => retry_options
         )

data/lib/google_places/prediction.rb

@@ -0,0 +1,71 @@
+module GooglePlaces
+  class Prediction
+
+    attr_accessor(
+      :description,
+      :place_id,
+    )
+
+    def initialize(json_result_object)
+      @description = json_result_object['description']
+      @place_id = json_result_object['place_id']
+    end
+
+    # Query for Predictions (optionally at the provided location)
+    #
+    # @option [String,Integer] :lat the latitude for the search
+    # @option [String,Integer] :lng the longitude for the search
+    # @option options [Integer] :radius (1000)
+    #   Defines the distance (in meters) within which to return Place results.
+    #   The maximum allowed radius is 50,000 meters.
+    #   Note that radius must not be included if :rankby => 'distance' (described below) is specified.
+    # @option options [String,Array] :types
+    #   Restricts the results to Spots matching at least one of the specified types
+    # @option options [String] :language
+    #   The language code, indicating in which language the results should be returned, if possible.
+    # @option options [Hash] :retry_options ({})
+    #   A Hash containing parameters for search retries
+    # @option options [Object] :retry_options[:status] ([])
+    # @option options [Integer] :retry_options[:max] (0) the maximum retries
+    # @option options [Integer] :retry_options[:delay] (5) the delay between each retry in seconds
+    def self.list_by_input(input, api_key, options = {})
+      lat = options.delete(:lat)
+      lng = options.delete(:lng)
+      language = options.delete(:language)
+      radius = options.delete(:radius)
+      retry_options = options.delete(:retry_options) || {}
+      types  = options.delete(:types)
+
+      options = {
+        :input => input,
+        :key => api_key,
+        :retry_options => retry_options
+      }
+
+      if lat && lng
+        options[:location] = Location.new(lat, lng).format
+        options[:radius] = radius if radius
+      end
+
+      # Accept Types as a string or array
+      if types
+        types = (types.is_a?(Array) ? types.join('|') : types)
+        options[:types] = types
+      end
+
+      if language
+        options[:language] = language
+      end
+
+      request(:predictions_by_input, options)
+    end
+
+    def self.request(method, options)
+      response = Request.send(method, options)
+
+      response['predictions'].map do |result|
+        self.new(result)
+      end
+    end
+  end
+end

data/lib/google_places/request.rb

@@ -14,6 +14,7 @@ module GooglePlaces
     TEXT_SEARCH_URL   = 'https://maps.googleapis.com/maps/api/place/textsearch/json'
     PAGETOKEN_URL     = 'https://maps.googleapis.com/maps/api/place/search/json'
     RADAR_SEARCH_URL  = 'https://maps.googleapis.com/maps/api/place/radarsearch/json'
+    AUTOCOMPLETE_URL  = 'https://maps.googleapis.com/maps/api/place/autocomplete/json'
 
     # Search for Spots at the provided location
     #
@@ -27,9 +28,6 @@ module GooglePlaces
     #   The maximum allowed radius is 50,000 meters.
     #   Note that radius must not be included if <b>:rankby</b> is specified
     #   <b>Note that this is a mandatory parameter</b>
-    # @option options [Boolean] :sensor
-    #   Indicates whether or not the Place request came from a device using a location sensor (e.g. a GPS) to determine the location sent in this request.
-    #   <b>Note that this is a mandatory parameter</b>
     # @option options [(Integer,Integer),String] :location
     #   The latitude/longitude around which to retrieve Spot information. This must be specified as latitude,longitude
     #   <b>Note that this is a mandatory parameter</b>
@@ -72,9 +70,6 @@ module GooglePlaces
     #   in requests but is snake_cased in responses (place_id)
     #   @see: https://developers.google.com/places/documentation/details
     #   <b>Note that this is a mandatory parameter</b>
-    # @option options [Boolean] :sensor
-    #   Indicates whether or not the Place request came from a device using a location sensor (e.g. a GPS) to determine the location sent in this request.
-    #   <b>Note that this is a mandatory parameter</b>
     # @option options [String] :language
     #   The language code, indicating in which language the results should be returned, if possible.
     #
@@ -94,9 +89,6 @@ module GooglePlaces
     #   <b>Note that this is a mandatory parameter</b>
     # @option options [String] :location
     #   the lat, lng for the search
-    # @option options [Boolean] :sensor
-    #   Indicates whether or not the Place request came from a device using a location sensor (e.g. a GPS) to determine the location sent in this request.
-    #   <b>Note that this is a mandatory parameter</b>
     # @option options [Integer] :radius (1000)
     #   Defines the distance (in meters) within which to return Place results.
     #   The maximum allowed radius is 50,000 meters.
@@ -115,12 +107,12 @@ module GooglePlaces
     # @option options [Integer] :maxprice
     #   Restricts results to only those places within the specified price range. Valid values range between 0 (most affordable) to 4 (most expensive), inclusive.
     # @option options [Boolean] :opennow
-    #   Retricts results to those Places that are open for business at the time the query is sent. 
-    #   Places that do not specify opening hours in the Google Places database will not be returned if you include this parameter in your query. 
+    #   Retricts results to those Places that are open for business at the time the query is sent.
+    #   Places that do not specify opening hours in the Google Places database will not be returned if you include this parameter in your query.
     #   Setting openNow to false has no effect.
     # @option options [Boolean] :zagatselected
-    #   Restrict your search to only those locations that are Zagat selected businesses. 
-    #   This parameter does not require a true or false value, simply including the parameter in the request is sufficient to restrict your search. 
+    #   Restrict your search to only those locations that are Zagat selected businesses.
+    #   This parameter does not require a true or false value, simply including the parameter in the request is sufficient to restrict your search.
     #   The zagatselected parameter is experimental, and only available to Places API enterprise customers.
     # @option options [Hash] :retry_options ({})
     #   A Hash containing parameters for search retries
@@ -150,9 +142,6 @@ module GooglePlaces
     #   The maximum allowed radius is 50,000 meters.
     #   Note that radius must not be included if <b>:rankby</b> is specified
     #   <b>Note that this is a mandatory parameter</b>
-    # @option options [Boolean] :sensor
-    #   Indicates whether or not the Place request came from a device using a location sensor (e.g. a GPS) to determine the location sent in this request.
-    #   <b>Note that this is a mandatory parameter</b>
     # @option options [String,Array] :types
     #   Restricts the results to Spots matching at least one of the specified types
     # @option options [String] :language
@@ -193,6 +182,25 @@ module GooglePlaces
       request.parsed_response
     end
 
+    # Query for Place Predictions
+    #
+    # @return [Array<Prediction>]
+    # @param [String] api_key the provided api key
+    # @param [Hash] options
+    # @option options [String,Array<String>] :exclude ([])
+    #   A String or an Array of <b>types</b> to exclude from results
+    # @option options [Hash] :retry_options ({})
+    #   A Hash containing parameters for search retries
+    # @option options [Object] :retry_options[:status] ([])
+    # @option options [Integer] :retry_options[:max] (0) the maximum retries
+    # @option options [Integer] :retry_options[:delay] (5) the delay between each retry in seconds
+    #
+    # @see https://developers.google.com/maps/documentation/places/supported_types List of supported types
+    def self.predictions_by_input(options = {})
+      request = new(AUTOCOMPLETE_URL, options)
+      request.parsed_response
+    end
+
     # Search for a Photo's URL with a reference key
     #
     # @return [URL]
@@ -206,10 +214,6 @@ module GooglePlaces
     # @option options [String] :photoreference
     #   The reference of a already retrieved Photo
     #   <b>Note that this is a mandatory parameter</b>
-    # @option options [Boolean] :sensor
-    #   Indicates whether or not the Place request came from a device using a location sensor (e.g. a GPS) to determine the location sent in this request.
-    #   <b>Note that this is a mandatory parameter</b>
-    #
     # @option options [Hash] :retry_options ({})
     #   A Hash containing parameters for search retries
     # @option options [Object] :retry_options[:status] ([])
@@ -233,9 +237,6 @@ module GooglePlaces
     #   The maximum allowed radius is 50,000 meters.
     #   Note that radius must not be included if <b>:rankby</b> is specified
     #   <b>Note that this is a mandatory parameter</b>
-    # @option options [Boolean] :sensor
-    #   Indicates whether or not the Place request came from a device using a location sensor (e.g. a GPS) to determine the location sent in this request.
-    #   <b>Note that this is a mandatory parameter</b>
     # @option options [(Integer,Integer),String] :location
     #   The latitude/longitude around which to retrieve Spot information. This must be specified as latitude,longitude
     #   <b>Note that this is a mandatory parameter</b>
@@ -271,7 +272,6 @@ module GooglePlaces
       retry_options[:status] = [retry_options[:status]] unless retry_options[:status].is_a?(Array)
       @response = self.class.get(url, :query => options, :follow_redirects => follow_redirects)
 
-      # puts "@response.request.last_uri.to_s"
       # puts @response.request.last_uri.to_s
 
       return unless retry_options[:max] > 0 && retry_options[:status].include?(@response.parsed_response['status'])