google_places 0.18.0 → 0.19.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDQxZDY1Nzk5N2RjMGFkNzMxNWZjZWVjMzA5YTc3YjVkYzExNTQwMw==
+    MGY1NTVkOWNjZDRlZjlmZTNjNzE2MmZlODg3NjNhNzM2YzIxMWE3NA==
   data.tar.gz: !binary |-
-    NjIzMmFjY2EyYzI1ZDMxMmVhMWNhMjIzYTlkNDVkN2Y2YzAzYzEzOQ==
-!binary "U0hBNTEy":
+    YzczNDA5NzE4ZjkxMDA4MWFlMTg5YmI5ZmQzY2EyZTI2MDE0MGZjMg==
+SHA512:
   metadata.gz: !binary |-
-    Yjc5YTc2YzYyMzczN2FjNDNhNTIyNWNiNGZiMjI1YzhmMGU1OGNkY2ZhNjMz
-    ZjYxZGRmZTkwMWNjYjdlNjlhYjIwMjk1Nzk4YTY5MDg1NDBhM2JlMThjMDBl
-    NzIzZjI5MzU1YjhhOGQ5ODE4NzExYjFmMTlmOWM4MThmYTk4NjY=
+    YjJjMmNmNDkzYjkwM2VmYWFkOTVlOTY0ZWRmMTVlMjc0MDE0M2JmZmIwM2Mx
+    Y2U5MzJiYzExNTQyNTE0MWJhOWMxY2NhMGU3MWYwM2Q5ZjhhMjM4NjU1Nzdh
+    MmViZDk1OTI4MTVjMmY3YmE4MTBjYjEzOThmOWU1MTk0MGFlMTQ=
   data.tar.gz: !binary |-
-    NzNhNjI1NDVhOWIwMzZjODI2YzZmNjU3ZDQ0YzgzZDFjYmVkODMyOGRkOWEx
-    MDI4Yzc1NzFkODRmZWZhMDQxZmJiZjIyOTk1OTRiY2M3MTZjNDBjYmZhZmFk
-    YTk0OTcxNzFmZjIzN2JjN2E4ZjMxMGUwNzQ5MjhjZGRmN2MzNDc=
+    OGFjOTExYzIxYWJlYjNkNDc0MDZkMGJjZWY2N2Q4ZGI1MGYzZWYzZTA2Mzgy
+    MGRmNjhiODMxNWJjNWFhMDYxNTg1MTcwNTE4MjFjMzAyMWRjYWUyY2FjMGYy
+    MDRlMWZjNjg3YjlkNDE0YWE3MjQzZDQwMjU2YTU4OGUxMjk2MzY=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    google_places (0.17.0)
+    google_places (0.18.0)
       httparty
 
 GEM

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2011 - 2013, Marcel de Graaf
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -92,6 +92,20 @@ Then retrieve the spot:
 
   @client.spot('CmRYAAA...upoTH3g')
 
+=== Retrieving a single photo's url
+
+First register a new Client:
+
+  @client = GooglePlaces::Client.new(API_KEY)
+
+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)
+
 
 == 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.18.0'
+  s.version     = '0.19.0'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Marcel de Graaf"]
   s.email       = ["mail@marceldegraaf.net"]

data/lib/google_places.rb

@@ -1,7 +1,18 @@
 require 'rubygems'
 require 'httparty'
 
-
-%w(client location request spot error).each do |file|
+%w(client location request spot error photo).each do |file|
   require File.join(File.dirname(__FILE__), 'google_places', file)
 end
+
+module GooglePlaces
+  class << self
+
+    attr_accessor :api_key
+
+    def configuration
+      yield self
+    end
+
+  end
+end

data/lib/google_places/client.rb

@@ -43,8 +43,9 @@ 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, sensor = false, options = {})
-      @api_key = api_key
+
+    def initialize(api_key = @api_key, sensor = false, options = {})
+      api_key ? @api_key = api_key : @api_key = GooglePlaces.api_key
       @sensor = sensor
       @options = options
     end

data/lib/google_places/photo.rb

@@ -0,0 +1,44 @@
+module GooglePlaces
+  class Photo
+    attr_accessor :width, :height, :photo_reference, :html_attributions
+
+    def initialize(width, height, photo_reference, html_attributions, api_key, sensor)
+      @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
+    # @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 fetch_url(maxwidth, options = {})
+      language  = options.delete(:language)
+      retry_options = options.delete(:retry_options) || {}
+
+      unless @fetched_url
+        @fetched_url = Request.photo_url(
+          :maxwidth => maxwidth,
+          :photoreference => @photo_reference,
+          :sensor => @sensor,
+          :key => @api_key,
+          :retry_options => retry_options
+        )
+      end
+      @fetched_url
+    end
+  end
+end

data/lib/google_places/request.rb

@@ -10,6 +10,7 @@ module GooglePlaces
 
     NEARBY_SEARCH_URL = 'https://maps.googleapis.com/maps/api/place/nearbysearch/json'
     DETAILS_URL       = 'https://maps.googleapis.com/maps/api/place/details/json'
+    PHOTO_URL         = 'https://maps.googleapis.com/maps/api/place/photo'
     TEXT_SEARCH_URL   = 'https://maps.googleapis.com/maps/api/place/textsearch/json'
     PAGETOKEN_URL     = 'https://maps.googleapis.com/maps/api/place/search/json'
 
@@ -142,6 +143,33 @@ module GooglePlaces
       request.parsed_response
     end
 
+    # Search for a Photo's URL with a reference key
+    #
+    # @return [URL]
+    # @param [Hash] options
+    # @option options [String] :key
+    #   the provided api key.
+    #   <b>Note that this is a mandatory parameter</b>
+    # @option options [Integer] :maxwidth
+    #   The maximum width of the photo url to be returned
+    #   <b>Note that this is a mandatory parameter</b>
+    # @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] ([])
+    # @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.photo_url(options = {})
+      request = new(PHOTO_URL, options, false)
+      request.parsed_response
+    end
+
     # Create a new Request for a given uri and the provided params
     #
     # @return [Request]
@@ -183,7 +211,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 initialize(url, options)
+    def initialize(url, options, follow_redirects = true)
       retry_options = options.delete(:retry_options) || {}
 
       retry_options[:status] ||= []
@@ -191,8 +219,8 @@ module GooglePlaces
       retry_options[:delay]  ||= 5
 
       retry_options[:status] = [retry_options[:status]] unless retry_options[:status].is_a?(Array)
+      @response = self.class.get(url, :query => options, :follow_redirects => follow_redirects)
 
-      @response = self.class.get(url, :query => options)
       # puts "@response.request.last_uri.to_s"
       # puts @response.request.last_uri.to_s
 
@@ -202,7 +230,7 @@ module GooglePlaces
         for i in (1..retry_options[:max])
           sleep(retry_options[:delay])
 
-          @response = self.class.get(url, :query => options)
+          @response = self.class.get(url, :query => options, :follow_redirects => follow_redirects)
 
           break unless retry_options[:status].include?(@response.parsed_response['status'])
         end
@@ -224,7 +252,7 @@ module GooglePlaces
     end
 
     def execute
-      @response = self.class.get(url, :query => options)
+      @response = self.class.get(url, :query => options, :follow_redirects => follow_redirects)
     end
 
     # Parse errors from the server respons, if any
@@ -235,6 +263,7 @@ module GooglePlaces
     # @raise [NotFoundError] when server response object includes 'NOT_FOUND'
     # @return [String] the response from the server as JSON
     def parsed_response
+      return @response.headers["location"] if @response.code >= 300 and @response.code < 400
       case @response.parsed_response['status']
       when 'OK', 'ZERO_RESULTS'
         @response.parsed_response

data/lib/google_places/spot.rb

@@ -2,7 +2,7 @@ require 'google_places/review'
 
 module GooglePlaces
   class Spot
-    attr_accessor :lat, :lng, :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
+    attr_accessor :lat, :lng, :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
 
     # Search for Spots at the provided location
     #
@@ -119,7 +119,7 @@ module GooglePlaces
         :retry_options => retry_options
       )
 
-      self.new(response['result'])
+      self.new(response['result'], api_key, sensor)
     end
 
     # Search for Spots with a pagetoken
@@ -239,7 +239,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) if result['types'].nil? || (result['types'] & exclude) == []
+        results << self.new(result, options[:key], options[:sensor]) if result['types'].nil? || (result['types'] & exclude) == []
       end
 
       results
@@ -278,7 +278,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)
+    def initialize(json_result_object, api_key, sensor)
       @reference                  = json_result_object['reference']
       @vicinity                   = json_result_object['vicinity']
       @lat                        = json_result_object['geometry']['location']['lat']
@@ -307,9 +307,11 @@ 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'])
+      @photos                     = photos_component(json_result_object['photos'], api_key, sensor)
       @reviews                    = reviews_component(json_result_object['reviews'])
       @nextpagetoken              = json_result_object['nextpagetoken']
+      @events                     = events_component(json_result_object['events'])
+      @utc_offset                 = json_result_object['utc_offset']
     end
 
     def [] (key)
@@ -346,8 +348,24 @@ module GooglePlaces
       json_aspects.to_a.map{ |r| { :type => r['type'], :rating => r['rating'] } }
     end
 
-    def photos_component(json_photos)
-      json_photos.to_a.map{ |r| { :width => r['width'], :height => r['height'], :width => r['width'], :photo_reference => r['photo_reference'], :html_attributions => r['html_attributions'] } }
+    def photos_component(json_photos, api_key, sensor)
+      if json_photos
+        json_photos.map{ |p| 
+          Photo.new(
+            p['width'], 
+            p['height'],
+            p['photo_reference'],
+            p['html_attributions'], 
+            api_key, 
+            sensor
+          )
+        }
+      else []
+      end
+    end
+
+    def events_component(json_events)
+      json_events.to_a.map{ |r| {:event_id => r['event_id'], :summary => r['summary'], :url => r['url'], :start_time => r['start_time']} }
     end
   end
 end

data/spec/google_places.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe GooglePlaces do
+  it "should be able to initialize client without any params" do
+    client = GooglePlaces::Client.new
+    client.api_key.should == nil
+  end
+
+  shared_examples "config api_key" do
+    it "should be able to config api_key" do
+      GooglePlaces.configuration do |config|
+        config.api_key = '456'
+      end
+      client = GooglePlaces::Client.new
+      client.api_key.should == '456'
+    end
+  end
+
+  include_examples "config api_key" do
+    it "should be able to config api_key and being overwrite" do
+      client = GooglePlaces::Client.new
+      client.api_key.should_not == nil
+      client = GooglePlaces::Client.new '123'
+      client.api_key.should == '123'
+    end
+  end
+end

data/spec/google_places/client_spec.rb

@@ -2,10 +2,6 @@ require 'spec_helper'
 
 describe GooglePlaces::Client do
 
-  it 'should not initialize without an api_key' do
-    lambda { GooglePlaces::Client.new }.should raise_error
-  end
-
   it 'should initialize with an api_key' do
     @client = GooglePlaces::Client.new(api_key)
     @client.api_key.should == api_key

data/spec/google_places/photo_spec.rb

@@ -0,0 +1,29 @@
+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' do
+    use_vcr_cassette 'photo'
+    before :each do
+      @photo = GooglePlaces::Photo.new(400, 400, @photo_reference, [], api_key, @sensor)
+    end
+    it 'should be a Photo' do
+      @photo.class.should == GooglePlaces::Photo
+    end
+    %w(width height photo_reference html_attributions).each do |attribute|
+      it "should have the attribute: #{attribute}" do
+        @photo.respond_to?(attribute).should == true
+      end
+    end
+    it 'should return a url when fetched' do
+      url = @photo.fetch_url(@max_width)
+      url.should_not be_empty
+    end
+  end
+end

data/spec/google_places/spot_spec.rb

@@ -190,7 +190,7 @@ describe GooglePlaces::Spot do
     it 'should be a Spot' do
       @spot.class.should == GooglePlaces::Spot
     end
-    %w(reference vicinity lat lng name icon types id formatted_phone_number international_phone_number formatted_address address_components street_number street city region postal_code country rating url types website price_level opening_hours).each do |attribute|
+    %w(reference vicinity lat lng name icon types id formatted_phone_number international_phone_number formatted_address address_components street_number street city region postal_code country rating url types website price_level opening_hours events utc_offset).each do |attribute|
       it "should have the attribute: #{attribute}" do
         @spot.respond_to?(attribute).should == true
       end

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'bundler/setup'
 require 'vcr_setup'
 require 'api_key'
-require 'google_places'
+require File.dirname(__FILE__) + "/../lib/" + 'google_places'
 
 def api_key
   RSPEC_API_KEY

data/spec/vcr_cassettes/photo.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://maps.googleapis.com/maps/api/place/photo?maxwidth=400&photoreference=CnRtAAAACQQXR83Jc3Pffxt1Zx7QbCe6AfY2negSNzkk2IeSf0q5nxHgartLzkr1fltSlkEDSS-EZqswWAW2eQDbiOl12J-V4Rmn_JNko9e9gSnMwxHBdmScu_84NMSe-0RwB9BM6AEqE8sENXQ8cpWaiEsC_RIQLzIJxpRdoqSPrPtrjTrOhxoUWb8uwObkV4duXfKIiNB20gfnu88&sensor=false&key=AIzaSyATGBjcfrRXQtNEMMyt8Fw7tSGEY8PQwv0
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 302
+      message: Found
+    headers:
+      date:
+      - Fri, 18 Oct 2013 10:27:29 GMT
+      pragma:
+      - no-cache
+      expires:
+      - Fri, 01 Jan 1990 00:00:00 GMT
+      cache-control:
+      - no-cache, must-revalidate
+      location:
+      - https://lh4.googleusercontent.com/-1wzlVdxiW14/USSFZnhNqxI/AAAAAAAABGw/YpdANqaoGh4/s1600-w400/Google%2BSydney
+      content-type:
+      - text/html; charset=UTF-8
+      server:
+      - mafe
+      content-length:
+      - '306'
+      x-xss-protection:
+      - 1; mode=block
+      x-frame-options:
+      - SAMEORIGIN
+      alternate-protocol:
+      - 443:quic
+      connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: ! "<HTML><HEAD><meta http-equiv=\"content-type\" content=\"text/html;charset=utf-8\">\n<TITLE>302
+        Moved</TITLE></HEAD><BODY>\n<H1>302 Moved</H1>\nThe document has moved\n<A
+        HREF=\"https://lh4.googleusercontent.com/-1wzlVdxiW14/USSFZnhNqxI/AAAAAAAABGw/YpdANqaoGh4/s1600-w400/Google%2BSydney\">here</A>.\r\n</BODY></HTML>\r\n"
+    http_version: '1.1'
+  recorded_at: Fri, 18 Oct 2013 10:27:29 GMT
+recorded_with: VCR 2.2.5

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_places
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Marcel de Graaf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2013-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -78,6 +78,7 @@ files:
 - .travis.yml
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.rdoc
 - Rakefile
 - google_places.gemspec
@@ -85,13 +86,16 @@ files:
 - lib/google_places/client.rb
 - lib/google_places/error.rb
 - lib/google_places/location.rb
+- lib/google_places/photo.rb
 - lib/google_places/request.rb
 - lib/google_places/review.rb
 - lib/google_places/spot.rb
 - spec/api_key.sample.rb
 - spec/api_key.travis.rb
+- spec/google_places.rb
 - spec/google_places/client_spec.rb
 - spec/google_places/location_spec.rb
+- spec/google_places/photo_spec.rb
 - spec/google_places/request_spec.rb
 - spec/google_places/spot_spec.rb
 - spec/spec_helper.rb
@@ -102,6 +106,7 @@ files:
 - spec/vcr_cassettes/list_spots_with_single_type.yml
 - spec/vcr_cassettes/list_spots_with_types_and_exclusion.yml
 - spec/vcr_cassettes/multiple_page_request.yml
+- spec/vcr_cassettes/photo.yml
 - spec/vcr_cassettes/premium_list_spots_with_data.yml
 - spec/vcr_cassettes/single_spot.yml
 - spec/vcr_setup.rb
@@ -125,15 +130,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.1.3
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper around the Google Places API.
 test_files:
 - spec/api_key.sample.rb
 - spec/api_key.travis.rb
+- spec/google_places.rb
 - spec/google_places/client_spec.rb
 - spec/google_places/location_spec.rb
+- spec/google_places/photo_spec.rb
 - spec/google_places/request_spec.rb
 - spec/google_places/spot_spec.rb
 - spec/spec_helper.rb
@@ -144,6 +151,7 @@ test_files:
 - spec/vcr_cassettes/list_spots_with_single_type.yml
 - spec/vcr_cassettes/list_spots_with_types_and_exclusion.yml
 - spec/vcr_cassettes/multiple_page_request.yml
+- spec/vcr_cassettes/photo.yml
 - spec/vcr_cassettes/premium_list_spots_with_data.yml
 - spec/vcr_cassettes/single_spot.yml
 - spec/vcr_setup.rb