yelpster 1.1.2 → 1.1.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTBmZGM4MzdmNGI0OGRiNjRiNjc4YzEzYTJlZmJkZDg1ZTc5NTJlMQ==
+    MDhiOTVjZGU2NWRiMTI1ZjU4OGJjMWVmOWI5MWMxNTZhMGVmODA5Yg==
   data.tar.gz: !binary |-
-    OTY2NmY2ZjJlMGMxY2EwMDM3MzkzODE4NTI0ZDhjYzRkYWJiOThmMw==
+    MmUyZjBmNmUzZTJkMjE1M2QyMzUzNjNkZTA1Y2VkMmVhMTJhMTFjNQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MWUxYzViMTVjNWM1NGMyZTk3ZmMzODYyYTAxMTFlOTY4MTZkMmQ2MWQ3MDAy
-    NDZlNDE1NWQ3OWU4YzY0MmY4NTRhNmY0MDNkMDQ1ZTBmZWU0YmUwYjI2M2Mw
-    MmM0MGJjMjllODY3ZGQ3OWViNjZkNGI4MTczYTEzZjk4YzlkZTM=
+    OTc2MzAyOTdhN2I4NWFmMTA1OTUyYzI3MDc0ZDdiNGRkMWNmNjg5NDA0ODI1
+    Zjc5OWZlOTQxYzNlZWNjNmQ4NmJhOWJhOGMyOTliZjY0ZjRmMzdkNDExNWQ0
+    MWIxMmE1MDdiZDk1MjE4ZjIzNDc5NzA5ODQxYWRiOGNhYzQ1ZTQ=
   data.tar.gz: !binary |-
-    YWU0MWJmMTU2NjIxOWM3ZjM0NzFlM2UyN2MyZmZhMTc5ZGZmNGY0NWI3M2Fl
-    NjkyNDhlNDNlNWY1ZmIyYjczOTZjYzk3ZjRlMzUzZDgzYjcyN2EwNTdiN2M3
-    OWMzYTA0NmJmYWExNDFhMDNmN2EwYTY0NGE1Njk0MTJhNGEwYjY=
+    YTg4Mzc5MGIwYWRjMzNjMDEyYzhjODdkODZkYzU1ZGNjYzQ3NGQzMjAyMzNl
+    NzU3ZGU0ZTRlZGQyODIwNmY1MGEzODc5ZjY1NmJhYWI3MmNjOTJlZTdjNzYz
+    M2QzYjU5OWVmOGFiNzM3ODcwNjVjM2ZhODY4N2IwMWE5MTI0MjU=

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+== YELPSTER_20130608_1_1_3
+* [naveed] Combine address components with ',' rather than space
+
+* [naveed] Refactor build_url
+
 == YELPSTER_20130429_1_1_2
 * [naveed] switched testing and deployment libraries
 

data/{README.rdoc → README.md}

@@ -1,4 +1,4 @@
-== Yelpster
+## Yelpster
 
 A Ruby object-oriented interface to the local business content available
 on Yelp at http://www.yelp.com.  Functionality is provided to perform
@@ -12,11 +12,11 @@ all searches available via the developer API including:
 
 More detailed information on the underlying Yelp API, error response codes, and so forth is available at http://www.yelp.com/developers/getting_started.
 
-The RubyForge project is hosted at http://rubyforge.org/projects/yelpster.  This documentation is available at http://yelpster.rubyforge.org.
+This documentation is available at http://rubydoc.info/github/nvd/yelpster.
 
 The latest source code is at http://github.com/nvd/yelpster.
 
-== Requirements
+## Requirements
 
 You must have a Yelp Web Service ID (YWSID) if you're using v1 of the api or Consumer Key, Consumer Secret, Token and a Token Secret for version 2. These are available at http://www.yelp.com/developers/getting_started/api_access.
 
@@ -25,20 +25,26 @@ retrieved via their API, documented at http://www.yelp.com/developers/getting_st
 
 For tests to execute successfully you must have the YWSID (for v1) or YELP_CONSUMER_KEY, YELP_CONSUMER_SECRET, YELP_TOKEN and YELP_TOKEN_SECRET(for v2) set in your environment via (shell-dependent, bash example provided):
 
+```console
  % export YWSID='YOUR_ID_HERE'
+```
 
 or
 
+```console
  % export YELP_CONSUMER_KEY='YOUR_CONSUMER_KEY_HERE'
  % export YELP_CONSUMER_SECRET='YOUR_CONSUMER_SECRET_HERE'
  % export YELP_PTOKEN='YOUR_TOKEN_HERE'
  % export YELPP_TOKEN_SECRET='YOUR_TOKEN_SECRET_HERE'
+```
 
-== Installing
+## Installing
 
+```console
  % gem install yelpster
+```
 
-== Usage
+## Usage
 
 Instantiate a Yelp::Client and use its +search+ method to make requests of
 the Yelp server.
@@ -64,6 +70,7 @@ types.
 
 A few examples:
 
+```ruby
  # construct a client instance
  client = Yelp::Client.new
 
@@ -101,10 +108,10 @@ A few examples:
  # retrieve details of business vi yelp business id
  request = Yelp::V2::Business::Request::Id.new(
 			:yelp_business_id => "pjb2WMwa0AfK3L-dWimO8w",
-			:consumer_key => ‘YOUR_CONSUMER_KEY’,
-			:consumer_secret => ‘YOUR_CONSUMER_SECRET’,
-			:token => ‘YOUR_TOKEN’,
-			:token_secret => ‘YOUR_TOKEN_SECRET’)
+			:consumer_key => 'YOUR_CONSUMER_KEY',
+			:consumer_secret => 'YOUR_CONSUMER_SECRET',
+			:token => 'YOUR_TOKEN',
+			:token_secret => 'YOUR_TOKEN_SECRET')
  response = client.search(request)
 
  # search for businesses via bounding box geo coords'
@@ -115,10 +122,10 @@ A few examples:
 			:ne_latitude => 37.788022,
 			:ne_longitude => -122.399797,
 			:limit => 3,
-			:consumer_key => ‘YOUR_CONSUMER_KEY’,
-			:consumer_secret => ‘YOUR_CONSUMER_SECRET’,
-			:token => ‘YOUR_TOKEN’,
-			:token_secret => ‘YOUR_TOKEN_SECRET’)
+			:consumer_key => 'YOUR_CONSUMER_KEY',
+			:consumer_secret => 'YOUR_CONSUMER_SECRET',
+			:token => 'YOUR_TOKEN',
+			:token_secret => 'YOUR_TOKEN_SECRET')
  response = client.search(request)
 
  # search for businesses via lat/long geo point'
@@ -126,20 +133,20 @@ A few examples:
 			:term => "cream puffs",
 			:latitude => 37.788022,
 			:longitude => -122.399797,
-			:consumer_key => ‘YOUR_CONSUMER_KEY’,
-			:consumer_secret => ‘YOUR_CONSUMER_SECRET’,
-			:token => ‘YOUR_TOKEN’,
-			:token_secret => ‘YOUR_TOKEN_SECRET’)
+			:consumer_key => 'YOUR_CONSUMER_KEY',
+			:consumer_secret => 'YOUR_CONSUMER_SECRET',
+			:token => 'YOUR_TOKEN',
+			:token_secret => 'YOUR_TOKEN_SECRET')
  response = client.search(request)
 
  # search for businesses via location (address, neighbourhood, city, state, zip, country, latitude, longitude)'
  request = Yelp::V2::Search::Request::Location.new(
 			:term => "cream puffs",
 			:city => "San Francisco",
-			:consumer_key => ‘YOUR_CONSUMER_KEY’,
-			:consumer_secret => ‘YOUR_CONSUMER_SECRET’,
-			:token => ‘YOUR_TOKEN’,
-			:token_secret => ‘YOUR_TOKEN_SECRET’)
+			:consumer_key => 'YOUR_CONSUMER_KEY',
+			:consumer_secret => 'YOUR_CONSUMER_SECRET',
+			:token => 'YOUR_TOKEN',
+			:token_secret => 'YOUR_TOKEN_SECRET')
  response = client.search(request)
 
  request = Yelp::V2::Search::Request::Location.new(
@@ -147,20 +154,21 @@ A few examples:
 			:address => "Hayes",
 			:latitude => 37.77493,
 			:longitude => -122.419415,
-			:consumer_key => ‘YOUR_CONSUMER_KEY’,
-			:consumer_secret => ‘YOUR_CONSUMER_SECRET’,
-			:token => ‘YOUR_TOKEN’,
-			:token_secret => ‘YOUR_TOKEN_SECRET’)
+			:consumer_key => 'YOUR_CONSUMER_KEY',
+			:consumer_secret => 'YOUR_CONSUMER_SECRET',
+			:token => 'YOUR_TOKEN',
+			:token_secret => 'YOUR_TOKEN_SECRET')
  response = client.search(request)
+```
 
 If you want to convert some addresses to latitude/longitude, or vice
 versa, for testing or what have you -- try http://stevemorse.org/jcal/latlon.php.
 
-== License
+## License
 
 This library is provided via the GNU LGPL license at http://www.gnu.org/licenses/lgpl.html.
 
-== Authors
+## Authors
 
 Copyright 2007 - 2009, Walter Korman <shaper@fatgoose.com>, http://lemurware.blogspot.com
 

data/lib/yelpster.rb

@@ -20,5 +20,5 @@ require 'yelpster/v2/search/request/bounding_box'
 require 'yelpster/v2/search/request/location'
 
 class Yelp
-  VERSION = '1.1.2'
+  VERSION = '1.1.3'
 end

data/lib/yelpster/client.rb

@@ -29,10 +29,10 @@ class Yelp
   class Client
     # allows specifying the user agent string to submit with search requests
     attr_accessor :agent
-    
+
     # whether debug mode is enabled for logging purposes, defaulting to false
     attr_accessor :debug
-    
+
     # the Logger compatible object with which log messages are outputted,
     # defaulting to output to STDOUT
     attr_accessor :logger
@@ -48,7 +48,7 @@ class Yelp
       @debug = false
       @logger = nil
     end
-    
+
     # Submits the supplied search request to Yelp and returns the response in
     # the format specified by the request.
     #
@@ -61,10 +61,10 @@ class Yelp
       debug_msg "submitting search [url=#{url}, request=#{request.to_yaml}]."
 
       # submit the http request for the results
-	    # http_request_params not used in v2 as OAuth (implemented in v2) only takes response params
-	    http_params = { 'User-Agent' => @agent }
-	    http_params['Accept-Encoding'] = 'gzip,deflate' if request.compress_response?
-	    content = request.pull_results(url, http_params)
+      # http_request_params not used in v2 as OAuth (implemented in v2) only takes response params
+      http_params = { 'User-Agent' => @agent }
+      http_params['Accept-Encoding'] = 'gzip,deflate' if request.compress_response?
+      content = request.pull_results(url, http_params)
 
       # read the response content
       debug_msg((request.response_format.serialized?) ? "received response [content_length=#{content.length}]." : "received response [content_length=#{content.length}, content=#{content}].")
@@ -75,31 +75,29 @@ class Yelp
 
     protected
 
-      def format_content (response_format, content)
-        (response_format == Yelp::ResponseFormat::JSON_TO_RUBY) ? JSON.parse(content) : content
-      end
-
-      def debug_msg (message)
-        return if !@debug
-        @logger = Logger.new(STDOUT) if (!@logger)
-        @logger.debug message
-      end
-
-      def build_url (base_url, params)
-        url = base_url.clone
-		    unless params.nil?
-			    url << '?'
-			    param_count = 0
-			    params.each do |key, value|
-			      next if value.nil?
-			      url << '&' if (param_count > 0)
-			      key_str = (params[key].kind_of?(Array)) ? 
-				    params[key].map { |k| CGI.escape(k.to_s) }.join("+") : CGI.escape(params[key].to_s)
-			      url << "#{CGI.escape(key.to_s)}=#{key_str}"
-			      param_count += 1
-			    end
-		    end
-        url
-      end
+    def format_content (response_format, content)
+      (response_format == Yelp::ResponseFormat::JSON_TO_RUBY) ? JSON.parse(content) : content
+    end
+
+    def debug_msg (message)
+      return if !@debug
+      @logger = Logger.new(STDOUT) if (!@logger)
+      @logger.debug message
+    end
+
+    def build_url (base_url, params)
+      "#{base_url}?#{to_query_string(params)}"
+    end
+
+    def to_query_string(params)
+      params.delete_if { |_, v| v.nil? }
+            .to_a
+            .map { |key, value| "#{escape(key)}=#{escape(value)}" }
+            .join('&')
+    end
+
+    def escape(object)
+      object.kind_of?(Array) ? object.map { |v| CGI.escape(v.to_s) }.join('+') : CGI.escape(object.to_s)
+    end
   end
 end

data/lib/yelpster/v1/neighborhood/request/base.rb

@@ -2,13 +2,13 @@ require 'yelpster/v1/request'
 
 class Yelp
   module V1
-	  module Neighborhood
-		  module Request
-		    class Base < Yelp::V1::Request
-			    def base_url
-			      'http://api.yelp.com/neighborhood_search'
-			    end
-		    end
+    module Neighborhood
+      module Request
+        class Base < Yelp::V1::Request
+          def base_url
+            'http://api.yelp.com/neighborhood_search'
+          end
+        end
       end
     end
   end

data/lib/yelpster/v1/neighborhood/request/geo_point.rb

@@ -2,23 +2,23 @@ require 'yelpster/v1/neighborhood/request/base'
 
 class Yelp
   module V1
-	  module Neighborhood
-		  module Request
-		    # Describes a request to search for the name of a neighborhood at a
-		    # specific geo-point location.
-		    #
-		    class GeoPoint < Yelp::V1::Neighborhood::Request::Base
-			    # latitude of geo-point for which a neighborhood name is desired
-			    attr_reader :latitude
+    module Neighborhood
+      module Request
+        # Describes a request to search for the name of a neighborhood at a
+        # specific geo-point location.
+        #
+        class GeoPoint < Yelp::V1::Neighborhood::Request::Base
+          # latitude of geo-point for which a neighborhood name is desired
+          attr_reader :latitude
 
-			    # longitude of geo-point for which a neighborhood name is desired
-			    attr_reader :longitude
+          # longitude of geo-point for which a neighborhood name is desired
+          attr_reader :longitude
 
-			    def to_yelp_params
-			      super.merge(:lat => latitude,
-						            :long => longitude)
-			    end
-		    end
+          def to_yelp_params
+            super.merge(:lat => latitude,
+                        :long => longitude)
+          end
+        end
       end
     end
   end

data/lib/yelpster/v1/neighborhood/request/location.rb

@@ -2,52 +2,52 @@ require 'yelpster/v1/neighborhood/request/base'
 
 class Yelp
   module V1
-	  module Neighborhood
-   		module Request
-  		  # Describes a request to search for a neighborhood name for a specific
-  		  # address/location.  You do not need to specify all of the address
-  		  # attributes -- some subset of the core +address+, +city+,
-  		  # +state+ and +zipcode+ will suffice.
-  		  #
-  		  class Location < Yelp::V1::Neighborhood::Request::Base
-  			# the street address of the location sought
-  			attr_reader :address
-
-  			# the city of the location sought
-  			attr_reader :city
-
-  			# the state of the location sought
-  			attr_reader :state
-
-  			# the zipcode of the location sought
-  			attr_reader :zipcode
-
-  			def initialize (params)
-  			  # we explicitly initialize the location fields since we reference
-  			  # them later when building a full location string and we want
-  			  # to know they were initialized properly (and avoid warnings)
-  			  super({
-  				:address => nil,
-  				:city => nil,
-  				:state => nil,
-  				:zipcode => nil
-  				}.merge(params))
-  			end
-
-  			def to_yelp_params
-  			  super.merge(:location => build_location_string)
-  			end
-			
-  			protected
-
-  			  # Returns the Yelp-compatible concatenated string with the various
-  			  # possible bits of an address-oriented location.
-  			  #
-  			  def build_location_string
-  				# per the Yelp documentation, the location string is to be built
-  				# as some combination of "address, city, state, or zip".
-  				[ @address, @city, @state, @zipcode ].compact.join(" ")
-  			  end
+    module Neighborhood
+      module Request
+        # Describes a request to search for a neighborhood name for a specific
+        # address/location.  You do not need to specify all of the address
+        # attributes -- some subset of the core +address+, +city+,
+        # +state+ and +zipcode+ will suffice.
+        #
+        class Location < Yelp::V1::Neighborhood::Request::Base
+          # the street address of the location sought
+          attr_reader :address
+
+          # the city of the location sought
+          attr_reader :city
+
+          # the state of the location sought
+          attr_reader :state
+
+          # the zipcode of the location sought
+          attr_reader :zipcode
+
+          def initialize (params)
+            # we explicitly initialize the location fields since we reference
+            # them later when building a full location string and we want
+            # to know they were initialized properly (and avoid warnings)
+            super({
+              :address => nil,
+              :city => nil,
+              :state => nil,
+              :zipcode => nil
+            }.merge(params))
+          end
+
+          def to_yelp_params
+            super.merge(:location => build_location_string)
+          end
+
+          protected
+
+          # Returns the Yelp-compatible concatenated string with the various
+          # possible bits of an address-oriented location.
+          #
+          def build_location_string
+            # per the Yelp documentation, the location string is to be built
+            # as some combination of "address, city, state, or zip".
+            [ @address, @city, @state, @zipcode ].compact.join(',')
+          end
         end
       end
     end

data/lib/yelpster/v1/phone/request/number.rb

@@ -2,24 +2,24 @@ require 'yelpster/v1/request'
 
 class Yelp
   module V1
-	  module Phone
-  		module Request
-  		  # Describes a request to search for a business review for the business
-  		  # associated with a specific phone number.
-  		  #
-  		  class Number < Yelp::V1::Request
-    			# the phone number of the business to search for, formatted as
-    			# '1112223333'.  Make sure you don't have any hyphens or parentheses.
-    			attr_reader :phone_number
+    module Phone
+      module Request
+        # Describes a request to search for a business review for the business
+        # associated with a specific phone number.
+        #
+        class Number < Yelp::V1::Request
+          # the phone number of the business to search for, formatted as
+          # '1112223333'.  Make sure you don't have any hyphens or parentheses.
+          attr_reader :phone_number
 
-    			def base_url
-    			  'http://api.yelp.com/phone_search'
-    			end
+          def base_url
+            'http://api.yelp.com/phone_search'
+          end
 
-    			def to_yelp_params
-    			  super.merge(:phone => phone_number)
-    			end
-  		  end
+          def to_yelp_params
+            super.merge(:phone => phone_number)
+          end
+        end
       end
     end
   end