Module: Yelp

Defined in:
lib/yelp.rb,
lib/yelp/error.rb,
lib/yelp/client.rb,
lib/yelp/version.rb,
lib/yelp/configuration.rb,
lib/yelp/responses/base.rb,
lib/yelp/endpoint/search.rb,
lib/yelp/responses/search.rb,
lib/yelp/endpoint/business.rb,
lib/yelp/responses/business.rb,
lib/yelp/endpoint/phone_search.rb,
lib/yelp/responses/models/deal.rb,
lib/yelp/responses/models/user.rb,
lib/yelp/responses/phone_search.rb,
lib/yelp/responses/models/region.rb,
lib/yelp/responses/models/review.rb,
lib/yelp/responses/models/business.rb,
lib/yelp/responses/models/location.rb,
lib/yelp/responses/models/coordinate.rb,
lib/yelp/responses/models/deal_option.rb,
lib/yelp/responses/models/region_span.rb,
lib/yelp/responses/models/region_center.rb,
lib/yelp/responses/models/gift_certificate.rb,
lib/yelp/responses/models/gift_certificate_option.rb

Defined Under Namespace

Modules: Endpoint, Error, Response Classes: Client, Configuration

Constant Summary collapse

VERSION = 
"2.1.5"

Class Method Summary collapse

Class Method Details

.client ⇒ Client

Returns an initially-unconfigured instance of the client.

Examples:

Configuring and using the client

Yelp.client.configure do |config|
  config.consumer_key = 'abc'
  config.consumer_secret = 'def'
  config.token = 'ghi'
  config.token_secret = 'jkl'
end

Yelp.client.search('San Francisco', { term: 'food' })

Returns:

  • (Client) —

    an instance of the client



18
19
20
 
# File 'lib/yelp.rb', line 18

def self.client
  @client ||= Yelp::Client.new
end