yelpster 1.1.4 → 1.2.0

data/README.md

@@ -1,6 +1,7 @@
 ## Yelpster
 
 [![Build Status](https://travis-ci.org/nvd/yelpster.png?branch=develop)](https://travis-ci.org/nvd/yelpster)
+[![Dependency Status](https://gemnasium.com/nvd/yelpster.png)](https://gemnasium.com/nvd/yelpster)
 
 A Ruby object-oriented interface to the local business content available
 on Yelp at http://www.yelp.com.  Functionality is provided to perform
@@ -36,8 +37,8 @@ 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'
+ % export YELP_TOKEN='YOUR_TOKEN_HERE'
+ % export YELP_TOKEN_SECRET='YOUR_TOKEN_SECRET_HERE'
 ```
 
 ## Installing
@@ -73,6 +74,19 @@ original pure JSON) can be specified on request record construction via the
 Yelp::[V1/V2]::Request ```response_format``` parameter, available in all request record
 types.
 
+### One Time Client Configuration (Recommended)
+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.
+
+```ruby
+Yelp.configure(:yws_id          => 'YOUR_YWSID',
+               :consumer_key    => 'YOUR_CONSUMER_KEY',
+               :consumer_secret => 'YOUR_CONSUMER_SECRET',
+               :token           => 'YOUR_TOKEN',
+               :token_secret    => 'YOUR_TOKEN_SECRET')
+```
+Then create a client object (or use Yelp::Base.client) and call ```search``` method with the request object.
+
 A few examples:
 
 ```ruby
@@ -86,23 +100,20 @@ A few examples:
              :city => 'San Francisco',
              :state => 'CA',
              :radius => 2,
-             :term => 'cream puffs',
-             :yws_id => 'YOUR_YWSID_HERE')
+             :term => 'cream puffs')
  response = client.search(request)
 
  # perform a location-based category search for either ice cream or donut shops in SF
  request = Location.new(
              :city => 'San Francisco',
              :state => 'CA',
-             :category => ['donuts', 'icecream'],
-             :yws_id => 'YOUR_YWSID_HERE')
+             :category => ['donuts', 'icecream'])
  response = client.search(request)
 
  # perform a neighborhood name lookup for a specific geo-location point
  request = GeoPoint.new(
              :latitude => 37.782093,
-             :longitude => -122.483230,
-             :yws_id => 'YOUR_YWSID_HERE')
+             :longitude => -122.483230)
  response = client.search(request)
 
  # -------------------------------------------------------
@@ -110,8 +121,7 @@ A few examples:
  include Yelp::V1::Phone::Request
  # perform a business review search based on a business phone number
  request = Number.new(
-             :phone_number => '4155551212',
-             :yws_id => 'YOUR_YWSID_HERE')
+             :phone_number => '4155551212')
  response = client.search(request)
 
  # -------------------------------------------------------
@@ -119,11 +129,7 @@ A few examples:
  include Yelp::V2::Business::Request
  # retrieve details of business vi yelp business id
  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')
+             :yelp_business_id => "pjb2WMwa0AfK3L-dWimO8w")
  response = client.search(request)
 
  # -------------------------------------------------------
@@ -136,43 +142,27 @@ A few examples:
              :sw_longitude => -122.500000,
              :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')
+             :limit => 3)
  response = client.search(request)
 
  # search for businesses via lat/long geo point'
  request = GeoPoint.new(
              :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')
+             :longitude => -122.399797)
  response = client.search(request)
 
  # search for businesses via location (address, neighbourhood, city, state, zip, country, latitude, longitude)'
  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')
+             :city => "San Francisco")
  response = client.search(request)
 
  request = Location.new(
              :term => "german food",
              :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')
+             :longitude => -122.419415)
  response = client.search(request)
 ```
 
@@ -187,5 +177,5 @@ This library is provided via the GNU LGPL license at http://www.gnu.org/licenses
 
 Copyright 2007 - 2009, Walter Korman <shaper@fatgoose.com>, http://lemurware.blogspot.com
 
-2011 – Yelp V2 Additions by Naveed Siddiqui <naveed@10eighteen.com>
+2011 – Yelp V2 Additions by Naveed Siddiqui <n@10eighteen.com>
 

data/lib/yelpster.rb

@@ -1,3 +1,4 @@
+require 'yelpster/base'
 require 'yelpster/client'
 require 'yelpster/record'
 require 'yelpster/response_format'
@@ -18,3 +19,9 @@ require 'yelpster/v2/search/request/base'
 require 'yelpster/v2/search/request/geo_point'
 require 'yelpster/v2/search/request/bounding_box'
 require 'yelpster/v2/search/request/location'
+
+module Yelp
+  def self.configure(options)
+    Base.client = Client.new(options)
+  end
+end

data/lib/yelpster/base.rb

@@ -0,0 +1,11 @@
+module Yelp
+  class Base
+    class << self
+      attr_accessor :client
+    end
+
+    def self.client
+      @client || Base.client
+    end
+  end
+end

data/lib/yelpster/client.rb

@@ -37,16 +37,21 @@ module Yelp
     # defaulting to output to STDOUT
     attr_accessor :logger
 
+    attr_accessor :yws_id, :consumer_key, :consumer_secret, :token, :token_secret
+
     # the default user agent submitted with search requests
     DEFAULT_AGENT = 'yelp for Ruby (http://www.rubyforge.org/projects/yelp/)'
 
     # Constructs a new client that uses the supplied YWSID for submitting
     # search requests.
     #
-    def initialize
+    def initialize(attributes = {})
       @agent = DEFAULT_AGENT
       @debug = false
       @logger = nil
+      attributes.each do |attr, value|
+        self.send("#{attr}=", value)
+      end
     end
 
     # Submits the supplied search request to Yelp and returns the response in

data/lib/yelpster/v1/request.rb

@@ -31,7 +31,7 @@ module Yelp
 
       def to_yelp_params
         params = {
-          :ywsid => yws_id
+          :ywsid => yws_id || Yelp::Base.client.yws_id
         }
 
         # if they specified anything other than a json variant, we

data/lib/yelpster/v2/request.rb

@@ -51,6 +51,23 @@ module Yelp
         access_token = OAuth::AccessToken.new(consumer, token, token_secret)
         access_token.get(url).body
       end
+
+      # For backwards compatibility
+      def consumer_key
+        @consumer_key || Yelp::Base.client.consumer_key
+      end
+
+      def consumer_secret
+        @consumer_secret || Yelp::Base.client.consumer_secret
+      end
+
+      def token
+        @token || Yelp::Base.client.token
+      end
+
+      def token_secret
+        @token_secret || Yelp::Base.client.token_secret
+      end
     end
   end
 end

data/lib/yelpster/version.rb

@@ -1,3 +1,3 @@
 module Yelp
-  VERSION = '1.1.4'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/spec/business_retrieve_spec.rb

@@ -2,15 +2,19 @@ require 'spec_helper'
 
 module Yelp::V2::Business::Request
   describe Id do
-    let!(:client) { create_client(AdditionalSpecHelpers::API_V2) }
+    before(:all) { Yelp.configure(:consumer_key => Credentials.consumer_key,
+                                  :consumer_secret => Credentials.consumer_secret,
+                                  :token => Credentials.token,
+                                  :token_secret => Credentials.token_secret) }
+    let(:client) { Yelp::Base.client }
 
     subject do
       client.search(Id.new(
         :yelp_business_id => 'pjb2WMwa0AfK3L-dWimO8w',
-        :consumer_key => @consumer_key,
-        :consumer_secret => @consumer_secret,
-        :token => @token,
-        :token_secret => @token_secret))
+        :consumer_key => Credentials.consumer_key,
+        :consumer_secret => Credentials.consumer_secret,
+        :token => Credentials.token,
+        :token_secret => Credentials.token_secret))
     end
 
     it 'returns a valid business hash' do

data/spec/business_search_spec.rb

@@ -2,9 +2,13 @@ require 'spec_helper'
 
 module Yelp::V2::Search::Request
   describe 'Business Search' do
-    let!(:client)   { create_client(AdditionalSpecHelpers::API_V2) }
-    let(:latitude)  { 37.782303 }
-    let(:longitude) { -122.484101 }
+    before(:all) { Yelp.configure(:consumer_key => Credentials.consumer_key,
+                                  :consumer_secret => Credentials.consumer_secret,
+                                  :token => Credentials.token,
+                                  :token_secret => Credentials.token_secret) }
+    let(:client) { Yelp::Base.client }
+    let(:latitude)  { 37.7821868 }
+    let(:longitude) { -122.4841149 }
     let(:location)  { {
       'cross_streets'   => '24th Ave & 25th Ave',
       'city'            => 'San Francisco', 
@@ -25,11 +29,7 @@ module Yelp::V2::Search::Request
           :sw_longitude    => -122.5,
           :ne_latitude     =>  37.788022,
           :ne_longitude    => -122.399797,
-          :term            => 'yelp',
-          :consumer_key    => @consumer_key,
-          :consumer_secret => @consumer_secret,
-          :token           => @token,
-          :token_secret    => @token_secret)
+          :term            => 'yelp')
         expect(client.search(request)).to be_valid_response_hash
       end
     end
@@ -37,11 +37,7 @@ module Yelp::V2::Search::Request
     describe 'by GeoPoint' do
       it 'returns business at geo point' do
         request = GeoPoint.new(:latitude        => latitude,
-                               :longitude       => longitude,
-                               :consumer_key    => @consumer_key,
-                               :consumer_secret => @consumer_secret,
-                               :token           => @token,
-                               :token_secret    => @token_secret)
+                               :longitude       => longitude)
         response = client.search(request)
         expect(response).to be_valid_response_hash
         expect(response['businesses'].first['location']).to eq(location)
@@ -53,11 +49,7 @@ module Yelp::V2::Search::Request
         request = Location.new(:address         => '2308 Clement St',
                                :city            => 'San Francisco',
                                :state           => 'CA',
-                               :zipcode         => 94121,
-                               :consumer_key    => @consumer_key,
-                               :consumer_secret => @consumer_secret,
-                               :token           => @token,
-                               :token_secret    => @token_secret)
+                               :zipcode         => 94121)
         response = client.search(request)
         expect(response).to be_valid_response_hash
         expect(response['businesses'].first['location']['postal_code']).to eq('94121')

data/spec/configuration_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe 'Configuration' do
+  describe 'per request (for backwards compatibility)' do
+    it 'configures correctly on V1 request' do
+      client = create_client(AdditionalSpecHelpers::API_V1)
+      request = Yelp::V1::Neighborhood::Request::Location.new(
+                             :address => '2252 Clement Street',
+                             :city    => 'San Francisco',
+                             :state   => 'CA',
+                             :zipcode => 94121,
+                             :yws_id  => Credentials.yws_id)
+      expect(client.search(request)).to be_valid_response_hash
+    end
+
+    it 'configures correctly on V2' do
+      client = create_client(AdditionalSpecHelpers::API_V2)
+      request = Yelp::V2::Business::Request::Id.new(
+                      :yelp_business_id => 'pjb2WMwa0AfK3L-dWimO8w',
+                      :consumer_key     => Credentials.consumer_key,
+                      :consumer_secret  => Credentials.consumer_secret,
+                      :token            => Credentials.token,
+                      :token_secret     => Credentials.token_secret)
+      expect(client.search(request)).to be_valid_business_hash
+    end
+  end
+end

data/spec/neighborhood_search_spec.rb

@@ -2,13 +2,13 @@ require 'spec_helper'
 
 module Yelp::V1::Neighborhood::Request
   describe 'Neighborhood Search' do
-    let!(:client) { create_client(AdditionalSpecHelpers::API_V1) }
+    before(:all) { Yelp.configure(:yws_id => Credentials.yws_id) }
+    let(:client) { Yelp::Base.client }
 
     describe 'by GeoPoint' do
       it 'returns neighbourhoods at point' do
         request = GeoPoint.new(:latitude => 37.782093,
-                               :longitude => -122.483230,
-                               :yws_id => @yws_id)
+                               :longitude => -122.483230)
         response = client.search(request)
         expect(response).to be_valid_response_hash
         expect(response['neighborhoods'].first['name']).to eq('Outer Richmond')
@@ -20,8 +20,7 @@ module Yelp::V1::Neighborhood::Request
         request = Location.new(:address => '2252 Clement Street',
                                :city => 'San Francisco',
                                :state => 'CA',
-                               :zipcode => 94121,
-                               :yws_id => @yws_id)
+                               :zipcode => 94121)
         response = client.search(request)
         expect(response).to be_valid_response_hash
         expect(response['neighborhoods'].first['name']).to eq('Outer Richmond')

data/spec/phone_search_spec.rb

@@ -2,10 +2,11 @@ require 'spec_helper'
 
 module Yelp::V1::Phone::Request
   describe 'Search by phone number' do
-    let!(:client) { create_client(AdditionalSpecHelpers::API_V1) }
+    before(:all) { Yelp.configure(:yws_id => Credentials.yws_id) }
+    let(:client) { Yelp::Base.client }
 
     it 'returns business with specified phone number' do
-      request = Number.new(:phone_number => '4155666011', :yws_id => @yws_id)
+      request = Number.new(:phone_number => '4155666011')
       expect(client.search(request)).to be_valid_response_hash
     end
   end

data/spec/review_search_spec.rb

@@ -2,7 +2,8 @@ require 'spec_helper'
 
 module Yelp::V1::Review::Request
   describe 'Review Search' do
-    let!(:client) { create_client(AdditionalSpecHelpers::API_V1) }
+    before(:all) { Yelp.configure(:yws_id => Credentials.yws_id) }
+    let(:client) { Yelp::Base.client }
 
     describe 'by Bounding Box' do
       it 'returns reviews in box' do
@@ -11,8 +12,7 @@ module Yelp::V1::Review::Request
           :bottom_right_longitude => -122.399797,
           :top_left_latitude => 37.9,
           :top_left_longitude => -122.5,
-          :term => 'yelp',
-          :yws_id => @yws_id)
+          :term => 'yelp')
         expect(client.search(request)).to be_valid_response_hash
       end
     end
@@ -23,8 +23,7 @@ module Yelp::V1::Review::Request
           :latitude => 37.78022,
           :longitude => -122.399797,
           :radius => 2,
-          :term => 'yelp',
-          :yws_id => @yws_id)
+          :term => 'yelp')
         expect(client.search(request)).to be_valid_response_hash
       end
     end
@@ -36,8 +35,7 @@ module Yelp::V1::Review::Request
           :city => 'San Francisco',
           :state => 'CA',
           :radius => 2,
-          :term => 'cream puffs',
-          :yws_id => @yws_id)
+          :term => 'cream puffs')
         expect(client.search(request)).to be_valid_response_hash
       end
     end
@@ -49,8 +47,7 @@ module Yelp::V1::Review::Request
           :latitude => 37.78022,
           :longitude => -122.399797,
           :radius => 5,
-          :term => 'yelp',
-          :yws_id => @yws_id)
+          :term => 'yelp')
         response = client.search(request)
 
         # perform the same search focusing only on playgrounds
@@ -59,8 +56,7 @@ module Yelp::V1::Review::Request
           :longitude => -122.399797,
           :radius => 5,
           :term => 'yelp',
-          :category => 'playgrounds',
-          :yws_id => @yws_id)
+          :category => 'playgrounds')
         narrowed_response = client.search(narrowed_request)
 
         # make sure we got less for the second
@@ -95,7 +91,6 @@ module Yelp::V1::Review::Request
       params = {
         :city => 'San Francisco',
         :state => 'CA',
-        :yws_id => @yws_id,
         :category => 'donuts'
       }
       request = Location.new(params)
@@ -138,8 +133,7 @@ module Yelp::V1::Review::Request
       default_params = {
         :city => 'San Francisco',
         :state => 'CA',
-        :term => 'gordo',
-        :yws_id => @yws_id
+        :term => 'gordo'
       }
       Location.new(default_params.merge(options))
     end

data/spec/spec_helper.rb

@@ -12,20 +12,15 @@ module AdditionalSpecHelpers
 
     case api_ver
     when API_V1
-      ENV['YWSID'].should_not be_nil, "Missing YWSID. Obtain from http://www.yelp.com/developers and set in your shell environment under 'YWSID'."
-      @yws_id = ENV['YWSID']
+      expect(Credentials.yws_id).to_not be_nil, "Missing YWSID. Obtain from http://www.yelp.com/developers and set in your shell environment under 'YWSID'."
     when API_V2
-      ENV['YELP_CONSUMER_KEY'].should_not be_nil, "Missing YELP_CONSUMER_KEY. Obtain from http://www.yelp.com/developers and set in your shell environment under 'YELP_CONSUMER_KEY'."
-      @consumer_key = ENV['YELP_CONSUMER_KEY']
+      expect(Credentials.consumer_key).to_not be_nil, "Missing YELP_CONSUMER_KEY. Obtain from http://www.yelp.com/developers and set in your shell environment under 'YELP_CONSUMER_KEY'."
 
-      ENV['YELP_CONSUMER_SECRET'].should_not be_nil, "Missing YELP_CONSUMER_SECRET. Obtain from http://www.yelp.com/developers and set in your shell environment under 'YELP_CONSUMER_SECRET'."
-      @consumer_secret = ENV['YELP_CONSUMER_SECRET']
+      expect(Credentials.consumer_secret).to_not be_nil, "Missing YELP_CONSUMER_SECRET. Obtain from http://www.yelp.com/developers and set in your shell environment under 'YELP_CONSUMER_SECRET'."
 
-      ENV['YELP_TOKEN'].should_not be_nil, "Missing YELP_TOKEN. Obtain from http://www.yelp.com/developers and set in your shell environment under 'YELP_TOKEN'."
-      @token = ENV['YELP_TOKEN']
+      expect(Credentials.token).to_not be_nil, "Missing YELP_TOKEN. Obtain from http://www.yelp.com/developers and set in your shell environment under 'YELP_TOKEN'."
 
-      ENV['YELP_TOKEN_SECRET'].should_not be_nil, "Missing YELP_TOKEN_SECRET. Obtain from http://www.yelp.com/developers and set in your shell environment under 'YELP_TOKEN_SECRET'."
-      @token_secret = ENV['YELP_TOKEN_SECRET']
+      expect(Credentials.token_secret).to_not be_nil, "Missing YELP_TOKEN_SECRET. Obtain from http://www.yelp.com/developers and set in your shell environment under 'YELP_TOKEN_SECRET'."
     else
       assert_false('No api version specified in test case; cannot continue')
     end
@@ -35,6 +30,30 @@ module AdditionalSpecHelpers
 
 end
 
+module Credentials
+  class << self
+    def yws_id
+      @yws_id ||= ENV['YWSID']
+    end
+
+    def consumer_key
+      @consumer_key ||= ENV['YELP_CONSUMER_KEY']
+    end
+
+    def consumer_secret
+      @consumer_secret ||= ENV['YELP_CONSUMER_SECRET']
+    end
+
+    def token
+      @token ||= ENV['YELP_TOKEN']
+    end
+
+    def token_secret
+      @token_secret ||= ENV['YELP_TOKEN_SECRET']
+    end
+  end
+end
+
 #TODO: These matchers are quite lame and need to meaningfully test
 # No point in testing ruby conversion of json to hashes
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yelpster
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-29 00:00:00.000000000 Z
+date: 2013-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -52,6 +52,7 @@ files:
 - CHANGELOG.rdoc
 - LICENSE.txt
 - README.md
+- lib/yelpster/base.rb
 - lib/yelpster/client.rb
 - lib/yelpster/record.rb
 - lib/yelpster/response_format.rb
@@ -75,6 +76,7 @@ files:
 - spec/business_retrieve_spec.rb
 - spec/business_search_spec.rb
 - spec/client_spec.rb
+- spec/configuration_spec.rb
 - spec/neighborhood_search_spec.rb
 - spec/phone_search_spec.rb
 - spec/review_search_spec.rb
@@ -94,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1283160560018612419
+      hash: 3290065746868731034
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -103,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1283160560018612419
+      hash: 3290065746868731034
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -114,6 +116,7 @@ test_files:
 - spec/business_retrieve_spec.rb
 - spec/business_search_spec.rb
 - spec/client_spec.rb
+- spec/configuration_spec.rb
 - spec/neighborhood_search_spec.rb
 - spec/phone_search_spec.rb
 - spec/review_search_spec.rb