yelpster 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea5f96fd6a51f4571eb7f1db0f3aba2f9ec74097
-  data.tar.gz: 1e8ae7365887cba09c1e5eebc66cdaefe672264c
+  metadata.gz: 8a75f537e21edaea19815d27e1916e6aa89997a4
+  data.tar.gz: 1f246a02f2a564b0e24748e70ea1f0ee1bb0493d
 SHA512:
-  metadata.gz: 7f53b513568ba71f13f43eb17f012d3cd904dd6c3dd12e5d775fca756e2b181a517c4df2516142d8b5f05563d8eb875d0b928eb502b8b07f44c07321bcc58956
-  data.tar.gz: 1102dd29d49374dce029cdff0d085ad76f6178569baba4ebaac123bf11112e6f06d7b0f63c58b6b6c19e402e2242fb84b1c55f4211d28663c2431c6adf5ad6ef
+  metadata.gz: 09acfa27d785f39dc9cf7557e4e10e133d8497c77f891024e72ed63951182b5a1b232085aeb53de08ddfeed9d32699e77bc7e92732b7fe6a00acf9551c359132
+  data.tar.gz: d7db033f5ddfa508a3b5f959c675f1e004a36b6bb6282ef452f8f5df3581b299e55ac8b42a4a782a63ddbfdfed6b55e3f072ebf7d51b387de7b776f6f7df9c98

data/CHANGELOG.rdoc

@@ -1,4 +1,7 @@
-== YELPSTER_20141010_1_2_1
+=== YELPSTER_20141010_1_3_0
+* [naveed] Deprecate and remove compress_response param from requests (Yelp has stopped compressing v1 responses)
+
+= YELPSTER_20141010_1_2_1
 * [Leslie Viljoen] Add cc (country_code) parameter to v1 phone search
 
 * [naveed] Check encoding before uncompressing v1 responses

data/README.md

@@ -29,22 +29,28 @@ 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'
+ 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_TOKEN='YOUR_TOKEN_HERE'
- % export YELP_TOKEN_SECRET='YOUR_TOKEN_SECRET_HERE'
+ export YELP_CONSUMER_KEY='YOUR_CONSUMER_KEY_HERE'
+ export YELP_CONSUMER_SECRET='YOUR_CONSUMER_SECRET_HERE'
+ export YELP_TOKEN='YOUR_TOKEN_HERE'
+ export YELP_TOKEN_SECRET='YOUR_TOKEN_SECRET_HERE'
 ```
 
 ## Installing
 
 ```console
- % gem install yelpster
+ gem install yelpster
+```
+
+and in your gemfile:
+
+```ruby
+ gem 'yelpster'
 ```
 
 ## Usage
@@ -78,6 +84,8 @@ types.
 To configure token/keys, add the following in a pre-loader file (eg: in initializers dir for Rails).
 Although currently available, support for specifying keys in request object will be deprecated in the future.
 
+For example, you might have a 'yelp.rb' file in your 'config/initializers' directory that looks like the following:
+
 ```ruby
 Yelp.configure(:yws_id          => 'YOUR_YWSID',
                :consumer_key    => 'YOUR_CONSUMER_KEY',
@@ -166,6 +174,34 @@ A few examples:
  response = client.search(request)
 ```
 
+Here is another example, let's say I wanted to make a call to the API in a controller action:
+
+```ruby
+ class FoodsController < ApplicationController
+   include Yelp::V2::Search::Request
+
+   def search
+     client = Yelp::Client.new
+
+     request = GeoPoint.new(
+                 :term => 'thai',
+                 :category_filter => 'food,restaurants',
+                 :limit => 20,
+                 :radius_filter => 8047,
+                 :latitude => params[:latitude],
+                 :longitude => params[:longitude])
+     response = client.search(request)
+
+     # rest of your code
+   end
+ end
+ ```
+
+You can check out all the parameters you can pass in the Yelp API Documentation.
+
+For V1 - http://www.yelp.com/developers/documentation/search_api.
+For V2 - http://www.yelp.com/developers/documentation/v2/search_api
+
 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.
 

data/lib/yelpster/client.rb

@@ -68,7 +68,6 @@ module Yelp
       # 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?
       http_params[:proxy] = nil
       content = request.pull_results(url, http_params)
 

data/lib/yelpster/v1/request.rb

@@ -5,10 +5,6 @@ require 'zlib'
 module Yelp
   module V1
     class Request < Yelp::Record
-      # specifies whether the response content should be transmitted
-      # over the wire compressed, defaulting to true.
-      attr_reader :compress_response
-
       # one of the Yelp::ResponseFormat format specifiers detailing the
       # desired format of the search results, defaulting to
       # Yelp::ResponseFormat::JSON_TO_RUBY.
@@ -19,11 +15,8 @@ module Yelp
       # to get your own.
       attr_reader :yws_id
 
-      alias :compress_response? :compress_response
-
       def initialize (params)
         default_params = {
-          :compress_response => true,
           :response_format => Yelp::ResponseFormat::JSON_TO_RUBY
         }
         super(default_params.merge(params))
@@ -46,9 +39,8 @@ module Yelp
         params
       end
 
-      def pull_results (url, http_params)
-        response = open(url, http_params)
-        response.content_encoding.include?('gzip') ? Zlib::GzipReader.new(response).read : response.read
+      def pull_results(url, http_params)
+        open(url, http_params).read
       end
     end
   end

data/lib/yelpster/v2/request.rb

@@ -4,10 +4,6 @@ require 'oauth'
 module Yelp
   module V2
     class Request < Yelp::Record
-      # specifies whether the response content should be transmitted
-      # over the wire compressed, defaulting to true.
-      attr_reader :compress_response
-
       # one of the Yelp::ResponseFormat format specifiers detailing the
       # desired format of the search results, defaulting to
       # Yelp::ResponseFormat::JSON_TO_RUBY.
@@ -21,11 +17,8 @@ module Yelp
       attr_reader :token
       attr_reader :token_secret
 
-      alias :compress_response? :compress_response
-
-      def initialize (params)
+      def initialize(params)
         default_params = {
-          :compress_response => true,
           :response_format => Yelp::ResponseFormat::JSON_TO_RUBY
         }
         super(default_params.merge(params))
@@ -46,7 +39,7 @@ module Yelp
         params
       end
 
-      def pull_results (url, http_params)
+      def pull_results(url, _)
         consumer = OAuth::Consumer.new(consumer_key, consumer_secret, {:site => "http://api.yelp.com"})
         access_token = OAuth::AccessToken.new(consumer, token, token_secret)
         access_token.get(url).body

data/lib/yelpster/version.rb

@@ -1,3 +1,3 @@
 module Yelp
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.3.0'.freeze
 end

data/spec/business_search_spec.rb

@@ -10,15 +10,15 @@ module Yelp::V2::Search::Request
     let(:latitude)  { 37.7821868 }
     let(:longitude) { -122.4841149 }
     let(:location) { {
-      "cross_streets"=>"21st Ave & 22nd Ave", 
-      "city"=>"San Francisco", 
+      "cross_streets"=>"21st Ave & 22nd Ave",
+      "city"=>"San Francisco",
       "coordinate" => {"latitude"=>37.78221, "longitude"=>-122.480624},
-      "display_address"=>["2001 Clement St", "(b/t 21st Ave & 22nd Ave)", "Outer Richmond", "San Francisco, CA 94121"], 
       "geo_accuracy" => 9,
-      "neighborhoods"=>["Outer Richmond"], 
-      "postal_code"=>"94121", 
-      "country_code"=>"US", 
-      "address"=>["2001 Clement St"], 
+      "display_address" => ["2001 Clement St", "Outer Richmond", "San Francisco, CA 94121"],
+      "neighborhoods"=>["Outer Richmond"],
+      "postal_code"=>"94121",
+      "country_code"=>"US",
+      "address"=>["2001 Clement St"],
       "state_code"=>"CA"
     } }
 
@@ -40,7 +40,7 @@ module Yelp::V2::Search::Request
                                :longitude       => longitude)
         response = client.search(request)
         expect(response).to be_valid_response_hash
-        expect(response['businesses'].first['location']).to eq(location)
+        expect(response['businesses'].first['location']).to include(location)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yelpster
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Naveed Siddiqui
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-10 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json