google_places 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 749f35ddb5c9ce15000ca1d2b3aecb6154d2c227
-  data.tar.gz: dc73e83a3d8d21d9fa11e61c155e5aae827f80dc
+SHA256:
+  metadata.gz: 7ef64d115e171e95f7bfb5d9fbc65a7ad8a70055e341e618dd9289d7bec31254
+  data.tar.gz: fef848705c73ccf177f7c97400436c9ca20f3dfec579cfa05f25c583fd0ec6fe
 SHA512:
-  metadata.gz: 2b3f62a1f9298f31581e3590f69593160cc5e4ef7841014f1b91ab2a5957e1a16b6451b900cc02cd7c573f09e8a8599e5625966e37db923c2fa8da6261496085
-  data.tar.gz: 1f701b72843382e71d22f39b1f32761232d0b6ed0b5541c01177b2a88f6ec827c1f19ed3addf78c94f0592afc498dadb87ce1f788b02675469db69a632d96f70
+  metadata.gz: 7b558547b58dc4d26a8cfc306694c2b9e94a8b3bb9be8f1d908c6daa00aaf130e8df5bde7711b2555719bbb0bad0781709b2394168a157e6e785f6b8551a1e9b
+  data.tar.gz: ec44110e4b2bdd04fa86a24ab34d947dd400c3f4d507333ee20704b8c000ef2a841e6cb34baa10c1e67fafa203f5dd7e1252fedcb91ac8b3e59cd8646b91427f

data/.travis.yml

@@ -1,10 +1,10 @@
 language: ruby
 rvm:
-  - 2.1.3
-  - 2.2.5
-  - 2.3.1
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 script: bundle exec rspec
 before_script: cp spec/api_key.travis.rb spec/api_key.rb
 after_script: rm spec/api_key.rb
 before_install:
-  - gem install bundler -v 1.14.6
+  - gem install bundler -v 1.17

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 2.0.0
+### Breaking Changes for 2.0.0:
+- Removed the `spots_by_radar` method
+- Remove support for all unsupported versions of Ruby (< 2.4)
+
+### Added
+- Expose the `json_result_object` field on a Spot object
+
 ## 1.2.0
 ### Added
 - Add a region option to the `spots` and `spots_by_query` methods

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    google_places (1.2.0)
+    google_places (2.0.0)
       httparty (>= 0.13.1)
 
 GEM
@@ -46,4 +46,4 @@ DEPENDENCIES
   webmock (~> 1.18)
 
 BUNDLED WITH
-   1.14.6
+   1.17.2

data/README.rdoc

@@ -7,9 +7,7 @@ not support OAuth authentication and will only work with an API key.
 == Obtaining an API key
 
 To be able to use this gem, you'll need a Google Places API key. To request an API key, point your browser to
-https://code.google.com/apis/console and follow the instructions there. You'll find your API key on the
-*API Access* tab under *Simple API Access*.
-
+https://developers.google.com/places/web-service/get-api-key and follow the instructions there.
 
 == Installing the gem
 
@@ -44,6 +42,8 @@ However <tt>address_components</tt>, <tt>city</tt>, <tt>country</tt>, <tt>format
 
 * To get these values: You can use <tt>@client.spot(place_id)</tt>. This returns the complete information for the spot by making an extra API call per returned spot.
 * To get a collection of these detailed spots: You can use <tt>@client.spots(lat, lng, detail: true)</tt>. This makes an extra call per each spot and returns a collection of the detailed spots.
+* To only retrieve specific fields for an individual spot, use a comma delimited string of acceptable fields <tt>@client.spot(place_id, fields:'place_id,name')</tt>
+
 
 === Retrieving a list of spots
 

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     = '1.2.0'
+  s.version     = '2.0.0'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Marcel de Graaf']
   s.email       = ['mail@marceldegraaf.net']

data/lib/google_places/client.rb

@@ -235,7 +235,6 @@ module GooglePlaces
       )
     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
@@ -270,15 +269,6 @@ module GooglePlaces
     #   A boolean to return spots with full detail information(its complete address, phone number, user rating, reviews, etc)
     #   Note) This makes an extra call for each spot for more information.
     #
-    # @see https://developers.google.com/places/documentation/search#RadarSearchRequests
-    def spots_by_radar(lat, lng, options = {})
-      options = @options.merge(options)
-      detail = options.delete(:detail)
-      collection_detail_level(
-        Spot.list_by_radar(lat, lng, @api_key, options),
-        detail
-      )
-    end
 
     # Query for Place Predictions
     #

data/lib/google_places/request.rb

@@ -318,8 +318,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
-
       return unless retry_options[:max] > 0 && retry_options[:status].include?(@response.parsed_response['status'])
 
       retry_request = proc do

data/lib/google_places/spot.rb

@@ -1,7 +1,11 @@
 require 'google_places/review'
 module GooglePlaces
   class Spot
-    attr_accessor :lat, :lng, :viewport, :name, :icon, :reference, :vicinity, :types, :id, :formatted_phone_number, :international_phone_number, :formatted_address, :address_components, :street_number, :street, :city, :region, :postal_code, :country, :rating, :url, :cid, :website, :reviews, :aspects, :zagat_selected, :zagat_reviewed, :photos, :review_summary, :nextpagetoken, :price_level, :opening_hours, :events, :utc_offset, :place_id, :permanently_closed
+    attr_accessor :lat, :lng, :viewport, :name, :icon, :reference, :vicinity, :types, :id, :formatted_phone_number,
+    :international_phone_number, :formatted_address, :address_components, :street_number, :street, :city, :region,
+    :postal_code, :country, :rating, :url, :cid, :website, :reviews, :aspects, :zagat_selected, :zagat_reviewed,
+    :photos, :review_summary, :nextpagetoken, :price_level, :opening_hours, :events, :utc_offset, :place_id, :permanently_closed,
+    :json_result_object
 
     # Search for Spots at the provided location
     #
@@ -249,6 +253,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 self.find(place_id, api_key, options = {})
+      fields = options.delete(:fields)
       language  = options.delete(:language)
       region = options.delete(:region)
       retry_options = options.delete(:retry_options) || {}
@@ -259,7 +264,8 @@ module GooglePlaces
         :key => api_key,
         :language => language,
         :extensions => extensions,
-        :retry_options => retry_options
+        :retry_options => retry_options,
+        :fields => fields
       }
       request_options[:region] = region unless region.nil?
       response = Request.spot(request_options)
@@ -423,12 +429,13 @@ 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)
+      @json_result_object         = json_result_object
       @reference                  = json_result_object['reference']
       @place_id                   = json_result_object['place_id']
       @vicinity                   = json_result_object['vicinity']
-      @lat                        = json_result_object['geometry']['location']['lat']
-      @lng                        = json_result_object['geometry']['location']['lng']
-      @viewport                   = json_result_object['geometry']['viewport']
+      @lat                        = json_result_object['geometry'] ? json_result_object['geometry']['location']['lat'] : nil
+      @lng                        = json_result_object['geometry'] ? json_result_object['geometry']['location']['lng'] : nil
+      @viewport                   = json_result_object['geometry'] ? json_result_object['geometry']['viewport'] : nil
       @name                       = json_result_object['name']
       @icon                       = json_result_object['icon']
       @types                      = json_result_object['types']

data/spec/google_places/client_spec.rb

@@ -162,47 +162,6 @@ describe GooglePlaces::Client do
     end
   end
 
-  describe '::spots_by_radar' do
-    let(:keywords) { 'landmarks' }
-    let(:lat) { '51.511627' }
-    let(:lng) { '-0.183778' }
-    let(:radius) { 5000 }
-
-    it 'should request spots by radar' do
-      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 'does not call find on GooglePlces::Spot' do
-      allow(GooglePlaces::Spot).to receive(:list_by_radar) { [fake_spot] }
-      expect(GooglePlaces::Spot).not_to receive(:find)
-      client.spots_by_radar(lat, lng, radius: radius, keyword: keywords)
-    end
-
-    context 'with detail set to true' do
-      it 'calls find on GooglePlaces::Spot' do
-        allow(GooglePlaces::Spot).to receive(:list_by_radar) { [fake_spot] }
-        expect(GooglePlaces::Spot).to receive(:find)
-        client.spots_by_radar(
-          lat,
-          lng,
-          radius: radius,
-          keyword: keywords,
-          detail: true
-        )
-      end
-    end
-
-    context 'with options' do
-      let(:client_options) { {radius: 1000} }
-      let(:method_options) { {radius: radius, keyword: keywords} }
-      it 'preserves client options while merging with method options' do
-        allow(GooglePlaces::Spot).to receive(:list_by_radar).with(lat, lng, api_key, method_options)
-        expect { client.spots_by_radar(lat, lng, method_options) }.not_to change(client, :options)
-      end
-    end
-  end
-
   describe '::predictions_by_input' do
     let(:input) { 'Atlanta' }
 

data/spec/google_places/request_spec.rb

@@ -194,88 +194,6 @@ describe GooglePlaces::Request do
     end
   end
 
-
-
-  context 'Listing spots by radar', vcr: { cassette_name: 'list_spots_by_radar' } do
-
-    context 'with valid options' do
-      context 'with keyword' do
-        it do
-          response = GooglePlaces::Request.spots_by_radar(
-            :location => @location,
-            :keyword => @keyword,
-            :radius => @radius,
-            :key => api_key
-          )
-          expect(response['results']).to_not be_empty
-        end
-      end
-
-      context 'with name' do
-        it do
-          response = GooglePlaces::Request.spots_by_radar(
-            :location => @location,
-            :name => 'park',
-            :radius => @radius,
-            :key => api_key
-          )
-          expect(response['results']).to_not be_empty
-        end
-      end
-    end
-
-   context 'without keyword' do
-      context 'without retry options' do
-        it do
-          expect(lambda {
-            GooglePlaces::Request.spots_by_radar(
-              :location => @location,
-              :radius => @radius,
-              :key => api_key
-            )
-          }).to raise_error GooglePlaces::InvalidRequestError
-        end
-      end
-
-      context 'with retry options' do
-        context 'without timeout' do
-          it do
-            expect(lambda {
-              GooglePlaces::Request.spots_by_radar(
-                :location => @location,
-                :radius => @radius,
-                :key => api_key,
-                :retry_options => {
-                  :max => 3,
-                  :status => 'INVALID_REQUEST',
-                  :delay => 1
-                }
-              )
-            }).to raise_error GooglePlaces::RetryError
-          end
-        end
-
-        context 'with timeout' do
-          it do
-            expect(lambda {
-              GooglePlaces::Request.spots_by_radar(
-                :location => @location,
-                :radius => @radius,
-                :key => api_key,
-                :retry_options => {
-                  :max => 3,
-                  :status => 'INVALID_REQUEST',
-                  :delay => 10,
-                  :timeout => 1
-                }
-              )
-            }).to raise_error GooglePlaces::RetryTimeoutError
-          end
-        end
-      end
-    end
-  end
-
   context 'with an API key not authorized to use the Places API' do
     it 'includes the error_message in the exception' do
       stub_request(:get, "https://maps.googleapis.com/maps/api/place/details/json").

data/spec/google_places/spot_spec.rb

@@ -5,7 +5,7 @@ describe GooglePlaces::Spot do
   before :each do
     @lat = '-33.8670522'
     @lng = '151.1957362'
-    @radius = 200
+    @radius = 500
     @pagetoken = 'CmRVAAAAqKK43TjXKnyEx4-XTWd4bC-iBq88Olspwga_JQbEpznYpfwXYbWBrxmb-1QYD4DMtq8gym5YruCEVjByOlKn8PWKQO5fHvuYD8rWKHUeBvMleM7k3oh9TUG8zqcyuhPmEhCG_C2XuypmkQ20hRvxro4sGhQN3nbWCjgpjyG_E_ayjVIoTGbViw'
     @place_id = 'ChIJN1t_tDeuEmsRUsoyG83frY4'
   end
@@ -21,7 +21,7 @@ describe GooglePlaces::Spot do
         false,
         {
           location: "-33.86705220,151.19573620",
-          radius: 200,
+          radius: 500,
           rankby: "prominence",
           key: RSPEC_API_KEY,
           name: nil,
@@ -30,11 +30,9 @@ describe GooglePlaces::Spot do
           retry_options: {}
         })
     end
-
   end
 
   context 'List spots', vcr: { cassette_name: 'list_spots' } do
-
     after(:each) do
       expect(@collection.map(&:class).uniq).to eq [GooglePlaces::Spot]
     end
@@ -57,25 +55,12 @@ describe GooglePlaces::Spot do
 
     describe 'with multiple types', vcr: { cassette_name: 'list_spots_with_multiple_types' } do
       before(:each) do
-        @collection = GooglePlaces::Spot.list(@lat, @lng, api_key, :radius => @radius, :types => ['food','establishment'])
+        @collection = GooglePlaces::Spot.list(@lat, @lng, api_key, :radius => @radius, :types => ["atm", "lodging"])
       end
 
       it 'should have Spots with specific types' do
         @collection.each do |spot|
-          expect(spot.types & ['food', 'establishment']).to be_any
-        end
-      end
-    end
-
-    describe 'searching by name and types', vcr: { cassette_name: 'list_spots_with_name_and_types' } do
-
-      before(:each) do
-        @collection = GooglePlaces::Spot.list(@lat, @lng, api_key, :radius => @radius, :types => ['food','establishment'], :name => 'italian')
-      end
-
-      it 'should have Spots with specific types' do
-        @collection.each do |spot|
-          expect(spot.types & ['food', 'establishment']).to be_any
+          expect(spot.types & ['atm', 'lodging']).to be_any
         end
       end
     end
@@ -83,7 +68,7 @@ describe GooglePlaces::Spot do
     describe 'searching by types with exclusion', vcr: { cassette_name: 'list_spots_with_types_and_exclusion' } do
 
       it 'should exclude spots with type "restaurant"' do
-        @collection = GooglePlaces::Spot.list(@lat, @lng, api_key, :radius => @radius, :types => ['food','establishment'], :exclude => 'restaurant')
+        @collection = GooglePlaces::Spot.list(@lat, @lng, api_key, :radius => @radius, :types => ['atm','lodging'], :exclude => 'restaurant')
 
         @collection.map(&:types).each do |types|
           expect(types).to_not include('restaurant')
@@ -143,29 +128,16 @@ describe GooglePlaces::Spot do
     it 'should include country in formatted address' do
       @collection = GooglePlaces::Spot.list_by_query('Statue of liberty, New York', api_key, region: 'ca')
       @collection.each do |spot|
-        expect(spot.formatted_address).to end_with('United States')
+        expect(spot.formatted_address).to end_with('USA')
       end
     end
 
     it 'should not include country in formatted address' do
       @collection = GooglePlaces::Spot.list_by_query('Statue of liberty, New York', api_key, region: 'us')
       @collection.each do |spot|
-        expect(spot.formatted_address).to_not end_with('United States')
+        expect(spot.formatted_address).to_not end_with('USA')
       end
     end
-
-  end
-
-  context 'List spots by radar', vcr: { cassette_name: 'list_spots_by_radar' } do
-
-    after(:each) do
-      expect(@collection.map(&:class).uniq).to eq [GooglePlaces::Spot]
-    end
-
-    it 'should be a collection of Spots' do
-      @collection = GooglePlaces::Spot.list_by_radar('48.8567', '2.3508', api_key, :radius => @radius, :keyword => 'attractions')
-    end
-
   end
 
   context 'Find a single spot', vcr: { cassette_name: 'single_spot' } do
@@ -209,4 +181,20 @@ describe GooglePlaces::Spot do
       expect(@spot.formatted_address).to_not end_with('Australia')
     end
   end
+
+  context 'Find a single spot with specified params', vcr: { cassette_name: 'single_spot_with_specified_params' } do
+    it 'should include the specified params in the response' do
+      @spot = GooglePlaces::Spot.find(@place_id, api_key, fields:'place_id,name')
+      expect(@spot.place_id).to eq(@place_id)
+      expect(@spot.name).to eq('Google Australia')
+    end
+
+    it 'should not include unspecified fields' do
+      @spot = GooglePlaces::Spot.find(@place_id, api_key, region: 'place_id,name')
+      spot_instance_variable_return_values = (@spot.instance_variables - [@place_id, @name]).map do |iv|
+        @post.instance_variable_get(iv.to_sym)
+      end
+      expect(spot_instance_variable_return_values.compact).to eq([])
+    end
+  end
 end

data/spec/vcr_cassettes/http_502.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: http://httpstat.us/502?key=AIzaSyAKeN0XMV5LqJmqBrZZ1K8qMipFW7-Eybg&reference=CnRsAAAASc4grenwL0h3X5VPNp5fkDNfqbjt3iQtWIPlKS-3ms9GbnCxR_FLHO0B0ZKCgJSg19qymkeHagjQFB4aUL87yhp4mhFTc17DopK1oiYDaeGthztSjERic8TmFNe-6zOpKSdiZWKE6xlQvcbSiWIJchIQOEYZqunSSZqNDoBSs77bWRoUJcMMVANtSlhy0llKI0MI6VcC7DU
+    uri: http://httpstat.us/502?key=<API_KEY>&reference=CnRsAAAASc4grenwL0h3X5VPNp5fkDNfqbjt3iQtWIPlKS-3ms9GbnCxR_FLHO0B0ZKCgJSg19qymkeHagjQFB4aUL87yhp4mhFTc17DopK1oiYDaeGthztSjERic8TmFNe-6zOpKSdiZWKE6xlQvcbSiWIJchIQOEYZqunSSZqNDoBSs77bWRoUJcMMVANtSlhy0llKI0MI6VcC7DU
     body:
       encoding: US-ASCII
       string: ''
@@ -25,7 +25,7 @@ http_interactions:
       Content-Type:
       - text/plain; charset=utf-8
       Server:
-      - Microsoft-IIS/8.0
+      - Microsoft-IIS/10.0
       X-Aspnetmvc-Version:
       - '5.1'
       Access-Control-Allow-Origin:
@@ -35,12 +35,12 @@ http_interactions:
       X-Powered-By:
       - ASP.NET
       Set-Cookie:
-      - ARRAffinity=5f087fd6a40a6d05f0b0eb568d99070a0e7b27a443c43c64047aae88fa2e0bea;Path=/;HttpOnly;Domain=httpstat.us
+      - ARRAffinity=580ecdc04582a8c27680686941822edec8921fe0a4244b99f898ac1d3a4de89a;Path=/;HttpOnly;Domain=httpstat.us
       Date:
-      - Tue, 07 Nov 2017 10:30:02 GMT
+      - Tue, 18 Jun 2019 10:51:49 GMT
     body:
       encoding: UTF-8
       string: 502 Bad Gateway
     http_version: 
-  recorded_at: Tue, 07 Nov 2017 10:30:03 GMT
+  recorded_at: Tue, 18 Jun 2019 10:51:49 GMT
 recorded_with: VCR 2.9.3