google_places 0.24.0 → 0.26.0

data/lib/google_places/spot.rb

@@ -10,9 +10,6 @@ module GooglePlaces
     # @param [String,Integer] lat the latitude for the search
     # @param [String,Integer] lng the longitude for the search
     # @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 [Integer] :radius (1000)
     #   Defines the distance (in meters) within which to return Place results.
@@ -50,7 +47,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 self.list(lat, lng, api_key, sensor, options = {})
+    def self.list(lat, lng, api_key, options = {})
       location = Location.new(lat, lng)
       multipage_request = !!options.delete(:multipage)
       rankby = options.delete(:rankby)
@@ -67,7 +64,6 @@ module GooglePlaces
       options = {
         :location => location.format,
         :radius => radius,
-        :sensor => sensor,
         :rankby => rankby,
         :key => api_key,
         :name => name,
@@ -93,9 +89,6 @@ module GooglePlaces
     # @param [String,Integer] lat the latitude for the search
     # @param [String,Integer] lng the longitude for the search
     # @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 [Integer] :radius (1000)
     #   Defines the distance (in meters) within which to return Place results.
@@ -115,12 +108,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
@@ -130,10 +123,10 @@ module GooglePlaces
     #
     # @see https://developers.google.com/places/documentation/search#RadarSearchRequests Radar Search
     # @see https://developers.google.com/maps/documentation/places/supported_types List of supported types
-    def self.list_by_radar(lat, lng, api_key, sensor, options = {})
+    def self.list_by_radar(lat, lng, api_key, options = {})
       location = Location.new(lat, lng)
       multipage_request = !!options.delete(:multipage)
-      radius = options.delete(:radius) || 1000 
+      radius = options.delete(:radius) || 1000
       types  = options.delete(:types)
       name  = options.delete(:name)
       keyword = options.delete(:keyword)
@@ -147,7 +140,6 @@ module GooglePlaces
       options = {
         :location => location.format,
         :radius => radius,
-        :sensor => sensor,
         :key => api_key,
         :name => name,
         :keyword => keyword,
@@ -175,10 +167,6 @@ module GooglePlaces
     # @return [Spot]
     # @param [String] place_id the place_id of the spot
     # @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 [String] :language
     #   The language code, indicating in which language the results should be returned, if possible.
@@ -188,21 +176,20 @@ module GooglePlaces
     # @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.find(place_id, api_key, sensor, options = {})
+    def self.find(place_id, api_key, options = {})
       language  = options.delete(:language)
       retry_options = options.delete(:retry_options) || {}
       extensions = options.delete(:review_summary) ? 'review_summary' : nil
 
       response = Request.spot(
         :placeid => place_id,
-        :sensor => sensor,
         :key => api_key,
         :language => language,
         :extensions => extensions,
         :retry_options => retry_options
       )
 
-      self.new(response['result'], api_key, sensor)
+      self.new(response['result'], api_key)
     end
 
     # Search for Spots with a pagetoken
@@ -210,15 +197,13 @@ module GooglePlaces
     # @return [Array<Spot>]
     # @param [String] pagetoken the token to find next results
     # @param [String] api_key the provided api key
-    # @param [Boolean] sensor
     # @param [Hash] options
-    def self.list_by_pagetoken(pagetoken, api_key, sensor, options = {})
+    def self.list_by_pagetoken(pagetoken, api_key, options = {})
       exclude = options.delete(:exclude) || []
       exclude = [exclude] unless exclude.is_a?(Array)
 
       options = {
           :pagetoken => pagetoken,
-          :sensor => sensor,
           :key => api_key
       }
 
@@ -230,10 +215,6 @@ module GooglePlaces
     # @return [Array<Spot>]
     # @param [String] query the query to search for
     # @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 [String,Integer] :lat
     #   the latitude for the search
@@ -268,7 +249,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 self.list_by_query(query, api_key, sensor, options = {})
+    def self.list_by_query(query, api_key, options = {})
       if options.has_key?(:lat) && options.has_key?(:lng)
         with_location = true
       else
@@ -282,7 +263,6 @@ module GooglePlaces
       end
 
       query = query
-      sensor = sensor
       multipage_request = !!options.delete(:multipage)
       location = Location.new(options.delete(:lat), options.delete(:lng)) if with_location
       radius = options.delete(:radius) if with_radius
@@ -296,7 +276,6 @@ module GooglePlaces
 
       options = {
         :query => query,
-        :sensor => sensor,
         :key => api_key,
         :rankby => rankby,
         :language => language,
@@ -322,7 +301,7 @@ module GooglePlaces
       	# Some places returned by Google do not have a 'types' property. If the user specified 'types', then
       	# this is a non-issue because those places will not be returned. However, if the user did not specify
       	# 'types', then we do not want to filter out places with a missing 'types' property from the results set.
-        results << self.new(result, options[:key], options[:sensor]) if result['types'].nil? || (result['types'] & exclude) == []
+        results << self.new(result, options[:key]) if result['types'].nil? || (result['types'] & exclude) == []
       end
 
       results
@@ -344,8 +323,7 @@ module GooglePlaces
         if multipage_request && !response["next_page_token"].nil?
           options = {
             :pagetoken => response["next_page_token"],
-            :key => options[:key],
-            :sensor => options[:sensor]
+            :key => options[:key]
           }
 
           # There is a short delay between when a next_page_token is issued, and when it will become valid.
@@ -361,7 +339,7 @@ module GooglePlaces
 
     # @param [JSON] json_result_object a JSON object to create a Spot from
     # @return [Spot] a newly created spot
-    def initialize(json_result_object, api_key, sensor)
+    def initialize(json_result_object, api_key)
       @reference                  = json_result_object['reference']
       @place_id                   = json_result_object['place_id']
       @vicinity                   = json_result_object['vicinity']
@@ -392,7 +370,7 @@ module GooglePlaces
       @zagat_selected             = json_result_object['zagat_selected']
       @aspects                    = aspects_component(json_result_object['aspects'])
       @review_summary             = json_result_object['review_summary']
-      @photos                     = photos_component(json_result_object['photos'], api_key, sensor)
+      @photos                     = photos_component(json_result_object['photos'], api_key)
       @reviews                    = reviews_component(json_result_object['reviews'])
       @nextpagetoken              = json_result_object['nextpagetoken']
       @events                     = events_component(json_result_object['events'])
@@ -433,16 +411,15 @@ module GooglePlaces
       json_aspects.to_a.map{ |r| { :type => r['type'], :rating => r['rating'] } }
     end
 
-    def photos_component(json_photos, api_key, sensor)
+    def photos_component(json_photos, api_key)
       if json_photos
-        json_photos.map{ |p| 
+        json_photos.map{ |p|
           Photo.new(
-            p['width'], 
+            p['width'],
             p['height'],
             p['photo_reference'],
-            p['html_attributions'], 
-            api_key, 
-            sensor
+            p['html_attributions'],
+            api_key
           )
         }
       else []

data/spec/google_places/client_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe GooglePlaces::Client do
-
   it 'should initialize with an api_key' do
     @client = GooglePlaces::Client.new(api_key)
     expect(@client.api_key).to eq(api_key)
@@ -10,7 +9,7 @@ describe GooglePlaces::Client do
   it 'should request spots' do
     lat, lng = '-33.8670522', '151.1957362'
     @client = GooglePlaces::Client.new(api_key)
-    expect(GooglePlaces::Spot).to receive(:list).with(lat, lng, api_key, false, {})
+    expect(GooglePlaces::Spot).to receive(:list).with(lat, lng, api_key, {})
 
     @client.spots(lat, lng)
   end
@@ -18,7 +17,7 @@ describe GooglePlaces::Client do
   it 'should request a single spot by place_id' do
     place_id = 'ChIJu46S-ZZhLxMROG5lkwZ3D7k'
     @client = GooglePlaces::Client.new(api_key)
-    expect(GooglePlaces::Spot).to receive(:find).with(place_id, api_key, false, {})
+    expect(GooglePlaces::Spot).to receive(:find).with(place_id, api_key, {})
 
     @client.spot(place_id)
   end
@@ -26,7 +25,7 @@ describe GooglePlaces::Client do
   it 'should request spots by query' do
     query = 'Statue of liberty, New York'
     @client = GooglePlaces::Client.new(api_key)
-    expect(GooglePlaces::Spot).to receive(:list_by_query).with(query, api_key, false, {})
+    expect(GooglePlaces::Spot).to receive(:list_by_query).with(query, api_key, {})
 
     @client.spots_by_query(query)
   end
@@ -36,10 +35,16 @@ describe GooglePlaces::Client do
     lat, lng = '51.511627', '-0.183778'
     radius = 5000
     @client = GooglePlaces::Client.new(api_key)
-    expect(GooglePlaces::Spot).to receive(:list_by_radar).with(lat, lng, api_key, false, {:radius=> radius, :keyword =>  keywords})
+    expect(GooglePlaces::Spot).to receive(:list_by_radar).with(lat, lng, api_key, {:radius=> radius, :keyword =>  keywords})
 
     @client.spots_by_radar(lat, lng, :radius => radius, :keyword =>  keywords)
   end
 
+  it 'should request predictions by input' do
+    input = 'Atlanta'
+    @client = GooglePlaces::Client.new(api_key)
+    expect(GooglePlaces::Prediction).to receive(:list_by_input).with(input, api_key, {})
 
+    @client.predictions_by_input(input)
+  end
 end

data/spec/google_places/location_spec.rb

@@ -1,9 +1,7 @@
 require 'spec_helper'
 
 describe GooglePlaces::Location do
-
   it 'should return a location based on a lat and lng' do
     expect(GooglePlaces::Location.new('123', '456').format).to eq('123.00000000,456.00000000')
   end
-
 end

data/spec/google_places/photo_spec.rb

@@ -1,25 +1,26 @@
 require 'spec_helper'
 
 describe GooglePlaces::Photo do
-
   before :each do
     @max_width = 400
-    @sensor = false
     @photo_reference = "CnRtAAAACQQXR83Jc3Pffxt1Zx7QbCe6AfY2negSNzkk2IeSf0q5nxHgartLzkr1fltSlkEDSS-EZqswWAW2eQDbiOl12J-V4Rmn_JNko9e9gSnMwxHBdmScu_84NMSe-0RwB9BM6AEqE8sENXQ8cpWaiEsC_RIQLzIJxpRdoqSPrPtrjTrOhxoUWb8uwObkV4duXfKIiNB20gfnu88"
   end
 
   context 'Photo', vcr: { cassette_name: 'photo'} do
     before :each do
-      @photo = GooglePlaces::Photo.new(400, 400, @photo_reference, [], api_key, @sensor)
+      @photo = GooglePlaces::Photo.new(400, 400, @photo_reference, [], api_key)
     end
+
     it 'should be a Photo' do
       expect(@photo.class).to eq(GooglePlaces::Photo)
     end
+
     %w(width height photo_reference html_attributions).each do |attribute|
       it "should have the attribute: #{attribute}" do
         expect(@photo.respond_to?(attribute)).to eq(true)
       end
     end
+
     it 'should return a url when fetched' do
       url = @photo.fetch_url(@max_width)
       expect(url).to_not be_empty

data/spec/google_places/prediction_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe GooglePlaces::Prediction, vcr: { cassette_name: 'list_predictions'}  do
+  it "should be a collection of Prediction" do
+    collection = GooglePlaces::Prediction.list_by_input('query', api_key)
+
+    expect(collection.map(&:class).uniq).to eq [GooglePlaces::Prediction]
+  end
+
+  describe 'requests' do
+    before(:each) do
+      allow(GooglePlaces::Request).to receive(:predictions_by_input).and_return('predictions' => [])
+    end
+
+    it "initiates a request with `radius`" do
+      options = request_params(radius: 20, location: "1.00000000,2.00000000")
+      expect(GooglePlaces::Request).to receive(:predictions_by_input).with(options)
+
+      GooglePlaces::Prediction.list_by_input('query', api_key, lat: 1, lng: 2, radius: 20)
+    end
+
+    it "initiates a request with `types`" do
+      options = request_params(types: '(cities)')
+      expect(GooglePlaces::Request).to receive(:predictions_by_input).with(options)
+
+      GooglePlaces::Prediction.list_by_input('query', api_key, types: '(cities)')
+    end
+
+    it "initiates a request with `language`" do
+      options = request_params(language: 'es')
+      expect(GooglePlaces::Request).to receive(:predictions_by_input).with(options)
+
+      GooglePlaces::Prediction.list_by_input('query', api_key, language: 'es')
+    end
+
+    it "initiates a request with `types` joind by |" do
+      options = request_params(types: 'establishment|geocode')
+      expect(GooglePlaces::Request).to receive(:predictions_by_input).with(options)
+
+      GooglePlaces::Prediction.list_by_input('query', api_key, types: ['establishment', 'geocode'])
+    end
+
+    it "initiates a request with `retry_options`" do
+      options = request_params(retry_options: { max: 10, delay: 15 })
+      expect(GooglePlaces::Request).to receive(:predictions_by_input).with(options)
+
+      GooglePlaces::Prediction.list_by_input('query', api_key, retry_options: { max: 10, delay: 15 })
+    end
+  end
+
+  def request_params(options = {})
+    {
+      input: "query",
+      key: api_key,
+      retry_options: {}
+    }.merge(options)
+  end
+end

data/spec/google_places/request_spec.rb

@@ -6,7 +6,6 @@ describe GooglePlaces::Request do
     @location = GooglePlaces::Location.new('-33.8670522', '151.1957362').format
     @query = 'Statue of liberty, New York'
     @radius = 200
-    @sensor = false
     @reference = 'CnRsAAAASc4grenwL0h3X5VPNp5fkDNfqbjt3iQtWIPlKS-3ms9GbnCxR_FLHO0B0ZKCgJSg19qymkeHagjQFB4aUL87yhp4mhFTc17DopK1oiYDaeGthztSjERic8TmFNe-6zOpKSdiZWKE6xlQvcbSiWIJchIQOEYZqunSSZqNDoBSs77bWRoUJcMMVANtSlhy0llKI0MI6VcC7DU'
     @reference_not_found = 'CnRpAAAAlO2WvF_4eOqp02TAWKsXpPSCFz8KxBjraWhB4MSvdUPqXN0yCpxQgblam1LeRENcWZF-9-2CEfUwlHUli61PaYe0e7dUPAU302tk6KkalnKqx7nv07iFA1Ca_Y1WoCLH9adEWwkxKMITlbGhUUz9-hIQPxQ4Bp_dz5nHloUFkj3rkBoUDSPqy2smqMnPEo4ayfbDupeKEZY'
     @keyword = 'attractions'
@@ -18,7 +17,6 @@ describe GooglePlaces::Request do
         response = GooglePlaces::Request.spots(
           :location => @location,
           :radius => @radius,
-          :sensor => @sensor,
           :key => api_key
         )
         expect(response['results']).to_not be_empty
@@ -30,7 +28,6 @@ describe GooglePlaces::Request do
           expect(lambda {
             GooglePlaces::Request.spots(
               :radius => @radius,
-              :sensor => @sensor,
               :key => api_key
             )
           }).to raise_error GooglePlaces::InvalidRequestError
@@ -42,7 +39,6 @@ describe GooglePlaces::Request do
             expect(lambda {
               GooglePlaces::Request.spots(
                 :radius => @radius,
-                :sensor => @sensor,
                 :key => api_key,
                 :retry_options => {
                   :max => 3,
@@ -58,7 +54,6 @@ describe GooglePlaces::Request do
             expect(lambda {
               GooglePlaces::Request.spots(
                 :radius => @radius,
-                :sensor => @sensor,
                 :key => api_key,
                 :retry_options => {
                   :max => 3,
@@ -81,7 +76,6 @@ describe GooglePlaces::Request do
       it 'should retrieve a list of spots' do
         response = GooglePlaces::Request.spots_by_query(
           :query => @query,
-          :sensor => @sensor,
           :key => api_key
         )
 
@@ -94,7 +88,6 @@ describe GooglePlaces::Request do
         it do
           expect(lambda {
             GooglePlaces::Request.spots_by_query(
-              :sensor => @sensor,
               :key => api_key
             )
           }).to raise_error GooglePlaces::InvalidRequestError
@@ -106,7 +99,6 @@ describe GooglePlaces::Request do
           it do
             expect(lambda {
               GooglePlaces::Request.spots_by_query(
-                :sensor => @sensor,
                 :key => api_key,
                 :retry_options => {
                   :max => 3,
@@ -122,7 +114,6 @@ describe GooglePlaces::Request do
           it do
             expect(lambda {
               GooglePlaces::Request.spots_by_query(
-                :sensor => @sensor,
                 :key => api_key,
                 :retry_options => {
                   :max => 3,
@@ -143,7 +134,6 @@ describe GooglePlaces::Request do
       it 'should retrieve a single spot' do
         response = GooglePlaces::Request.spot(
           :reference => @reference,
-          :sensor => @sensor,
           :key => api_key
         )
         expect(response['result']).to_not be_empty
@@ -153,7 +143,6 @@ describe GooglePlaces::Request do
           expect(lambda {
             GooglePlaces::Request.spot(
               :reference => @reference_not_found,
-              :sensor => @sensor,
               :key => api_key
             )
           }).to raise_error GooglePlaces::NotFoundError
@@ -165,7 +154,6 @@ describe GooglePlaces::Request do
         it do
           expect(lambda {
             GooglePlaces::Request.spot(
-              :sensor => @sensor,
               :key => api_key
             )
           }).to raise_error GooglePlaces::InvalidRequestError
@@ -176,7 +164,6 @@ describe GooglePlaces::Request do
           it do
             expect(lambda {
               GooglePlaces::Request.spot(
-                :sensor => @sensor,
                 :key => api_key,
                 :retry_options => {
                   :max => 3,
@@ -191,7 +178,6 @@ describe GooglePlaces::Request do
           it do
             expect(lambda {
               GooglePlaces::Request.spot(
-                :sensor => @sensor,
                 :key => api_key,
                 :retry_options => {
                   :max => 3,
@@ -218,7 +204,6 @@ describe GooglePlaces::Request do
             :location => @location,
             :keyword => @keyword,
             :radius => @radius,
-            :sensor => @sensor,
             :key => api_key
           ) 
           expect(response['results']).to_not be_empty
@@ -231,7 +216,6 @@ describe GooglePlaces::Request do
             :location => @location,
             :name => 'park',
             :radius => @radius,
-            :sensor => @sensor,
             :key => api_key
           )
           expect(response['results']).to_not be_empty
@@ -246,7 +230,6 @@ describe GooglePlaces::Request do
             GooglePlaces::Request.spots_by_radar(
               :location => @location,
               :radius => @radius,
-              :sensor => @sensor,
               :key => api_key
             )
           }).to raise_error GooglePlaces::InvalidRequestError
@@ -260,7 +243,6 @@ describe GooglePlaces::Request do
               GooglePlaces::Request.spots_by_radar(
                 :location => @location,
                 :radius => @radius,
-                :sensor => @sensor,
                 :key => api_key,
                 :retry_options => {
                   :max => 3,
@@ -278,7 +260,6 @@ describe GooglePlaces::Request do
               GooglePlaces::Request.spots_by_radar(
                 :location => @location,
                 :radius => @radius,
-                :sensor => @sensor,
                 :key => api_key,
                 :retry_options => {
                   :max => 3,