yelp 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 084eed60efb387e4e9ff29a1efaa55b9a956ac6d
-  data.tar.gz: cd0c27b10455857f1ec7a8eb252a3f2bea5c7a99
+  metadata.gz: 710d6c122e7ae066c91a091792306a3750d7b2ac
+  data.tar.gz: 2d11f7b9635da6bc2bff6225f15f53e3f9104fbe
 SHA512:
-  metadata.gz: 37dd0feece6d826fb97373c91f6765a019dab1724a4ba8df88856a0d0d1a405e8a4e793280dfa68f07edf3df2ea418c679fc5cff1f5ab6a950643c73e8528bd4
-  data.tar.gz: 8a5895e8cc5c19e248b4e286490e3c6a6aac080c73e155d7806199cab48d7b05f50a6504635db0be8acbbb68e0500a46b316bc41a2dbd0cc062de774ade296dd
+  metadata.gz: 34b6db5b4727c5352c0a94d24b190463b05e810c364863144955b6de97a8405fa4cf2c1021d0bb2f481112accb5302bc9a25a7f39250cd2aa5d97676bce8f9a8
+  data.tar.gz: 3ca2121ebc48b5c19352654828e39ee66c032e4a9bc5d931147aeb722a163bafe6ca6780162a858d5573c32044f8ab6d642003f414ea1ec4ca858e2c8be585a3

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+env:
+  - YELP_CONSUMER_KEY='abcdefg' YELP_CONSUMER_SECRET='hijklmn' YELP_TOKEN='12345' YELP_TOKEN_SECRET='67890'

data/README.md

@@ -1,6 +1,8 @@
 # yelp-ruby
 
-This is a Ruby Gem for the Yelp API. It'll simplifies the process of consuming data from the Yelp API for developers using Ruby. The library encompasses both Search and Business API functions.
+[![Gem Version](https://badge.fury.io/rb/yelp.svg)](http://badge.fury.io/rb/yelp) [![Build Status](https://travis-ci.org/Yelp/yelp-ruby.svg)](https://travis-ci.org/Yelp/yelp-ruby) [![Code Climate](https://codeclimate.com/github/Yelp/yelp-ruby.png)](https://codeclimate.com/github/Yelp/yelp-ruby)
+
+This is a Ruby Gem for the Yelp API. It'll simplify the process of consuming data from the Yelp API for developers using Ruby. The library encompasses both Search and Business API functions.
 
 Please remember to read and follow the [Terms of Use](http://www.yelp.com/developers/getting_started/api_terms) and [display requirements](http://www.yelp.com/developers/getting_started/display_requirements) before creating your applications.
 

data/Rakefile

@@ -1,5 +1,12 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
 
 Dir["tasks/**/*.rake"].each do |file|
   load(file)
-end
+end
+
+# Setup new RSpec for rake task
+RSpec::Core::RakeTask.new(:spec)
+
+# make default task to run specs
+task :default => :spec

data/lib/yelp/client.rb

@@ -40,7 +40,7 @@ module Yelp
     #     config.token_secret = 'jkl'
     #   end
     def configure
-      raise AlreadyConfigured unless @configuration.nil?
+      raise Error::AlreadyConfigured unless @configuration.nil?
 
       @configuration = Configuration.new
       yield(@configuration)
@@ -51,7 +51,7 @@ module Yelp
     def check_api_keys
       if configuration.nil? || !configuration.valid?
         @configuration = nil
-        raise MissingAPIKeys
+        raise Error::MissingAPIKeys
       else
         # Freeze the configuration so it cannot be modified once the gem is
         # configured.  This prevents the configuration changing while the gem

data/lib/yelp/endpoint/search.rb

@@ -83,7 +83,8 @@ module Yelp
       #
       #   response = client.search(bounding_box, params)
       def search_by_bounding_box(bounding_box, params = {}, locale = {})
-        raise BoundingBoxNotComplete if BOUNDING_BOX.any? { |corner| bounding_box[corner].nil? }
+        raise Error::BoundingBoxNotComplete if BOUNDING_BOX.any? { |corner|
+          bounding_box[corner].nil? }
 
         options = { bounds: build_bounding_box(bounding_box) }
         options.merge!(params)
@@ -128,7 +129,8 @@ module Yelp
       #
       #   response = client.search(coordinates, params)
       def search_by_coordinates(coordinates, params = {}, locale = {})
-        raise MissingLatLng if coordinates[:latitude].nil? || coordinates[:longitude].nil?
+        raise Error::MissingLatLng if coordinates[:latitude].nil? ||
+            coordinates[:longitude].nil?
 
         options = { ll: build_coordinates_string(coordinates) }
         options.merge!(params)

data/lib/yelp/error.rb

@@ -1,55 +1,88 @@
 module Yelp
-  class Error < StandardError
-    def self.check_for_error(data)
-      # Check if the status is in the range of non-error status codes
-      return if (200..399).include?(data.status)
+  module Error
+    # Validates Yelp API responses.  This class shouldn't be used directly, but
+    # should be accessed through the Yelp::Error.check_for_error interface.
+    # @see check_for_error
+    class ResponseValidator
 
-      body = JSON.parse(data.body)
-      @error_classes ||= Hash.new do |hash, key|
-        class_name = key.split('_').map(&:capitalize).join('').gsub('Oauth', 'OAuth')
-        hash[key] = Yelp.const_get(class_name)
+      # If the request is not successful, raise an appropriate Yelp::Error
+      # exception with the error text from the request response.
+      # @param response from the Yelp API
+      def validate(response)
+        return if successful_response?(response)
+        raise error_from_response(response)
       end
 
-      klass = @error_classes[body['error']['id']]
-      raise klass.new(body['error']['text'])
+      private
+
+      def successful_response?(response)
+        # Check if the status is in the range of non-error status codes
+        (200..399).include?(response.status)
+      end
+
+      # Create an initialized exception from the response
+      # @return [Yelp::Error::Base] exception corresponding to API error
+      def error_from_response(response)
+        body = JSON.parse(response.body)
+        klass = error_classes[body['error']['id']]
+        klass.new(body['error']['text'])
+      end
+
+      # Maps from API Error id's to Yelp::Error exception classes.
+      def error_classes
+        @@error_classes ||= Hash.new do |hash, key|
+          class_name = key.split('_').map(&:capitalize).join('').gsub('Oauth', 'OAuth')
+          hash[key] = Yelp::Error.const_get(class_name)
+        end
+      end
     end
-  end
 
-  class AlreadyConfigured < Error
-    def initialize(msg = 'Gem cannot be reconfigured.  Initialize a new ' +
-        'instance of Yelp::Client.')
-      super
+    # Check the response for errors, raising an appropriate exception if
+    # necessary
+    # @param (see ResponseValidator#validate)
+    def self.check_for_error(response)
+      @response_validator ||= ResponseValidator.new
+      @response_validator.validate(response)
     end
-  end
 
-  class MissingAPIKeys < Error
-    def initialize(msg = "You're missing an API key")
-      super
+    class Base < StandardError; end
+
+    class AlreadyConfigured < Base
+      def initialize(msg = 'Gem cannot be reconfigured.  Initialize a new ' +
+          'instance of Yelp::Client.')
+        super
+      end
     end
-  end
 
-  class MissingLatLng < Error
-    def initialize(msg = 'Missing required latitude or longitude parameters')
-      super
+    class MissingAPIKeys < Base
+      def initialize(msg = "You're missing an API key")
+        super
+      end
     end
-  end
 
-  class BoundingBoxNotComplete < Error
-    def initialize(msg = 'Missing required values for bounding box')
-      super
+    class MissingLatLng < Base
+      def initialize(msg = 'Missing required latitude or longitude parameters')
+        super
+      end
     end
-  end
 
-  class InternalError           < Error; end
-  class ExceededRequests        < Error; end
-  class MissingParameter        < Error; end
-  class InvalidParameter        < Error; end
-  class InvalidSignature        < Error; end
-  class InvalidOAuthCredentials < Error; end
-  class InvalidOAuthUser        < Error; end
-  class AccountUnconfirmed      < Error; end
-  class UnavailableForLocation  < Error; end
-  class AreaTooLarge            < Error; end
-  class MultipleLocations       < Error; end
-  class BusinessUnavailable     < Error; end
+    class BoundingBoxNotComplete < Base
+      def initialize(msg = 'Missing required values for bounding box')
+        super
+      end
+    end
+
+    class InternalError           < Base; end
+    class ExceededRequests        < Base; end
+    class MissingParameter        < Base; end
+    class InvalidParameter        < Base; end
+    class InvalidSignature        < Base; end
+    class InvalidOAuthCredentials < Base; end
+    class InvalidOAuthUser        < Base; end
+    class AccountUnconfirmed      < Base; end
+    class UnavailableForLocation  < Base; end
+    class AreaTooLarge            < Base; end
+    class MultipleLocations       < Base; end
+    class BusinessUnavailable     < Base; end
+  end
 end

data/lib/yelp/version.rb

@@ -1,3 +1,3 @@
 module Yelp
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/spec/support/request_error.rb

@@ -5,7 +5,7 @@ shared_examples 'a request error' do
 
     it 'should raise an error' do
       client.stub_chain(:connection, :get).and_return(bad_response)
-      expect { request }.to raise_error(Yelp::InternalError)
+      expect { request }.to raise_error(Yelp::Error::InternalError)
     end
   end
 end

data/spec/yelp/endpoint/search_spec.rb

@@ -57,11 +57,11 @@ describe Yelp::Endpoint::Search do
   describe 'errors' do
     context 'search' do
       it 'raises when #search_by_coordinates params are empty' do
-        expect { client.search_by_coordinates({}, params) }.to raise_error(Yelp::MissingLatLng)
+        expect { client.search_by_coordinates({}, params) }.to raise_error(Yelp::Error::MissingLatLng)
       end
 
       it 'raises when #search_by_bounding_box params are empty' do
-        expect { client.search_by_bounding_box({}, params) }.to raise_error(Yelp::BoundingBoxNotComplete)
+        expect { client.search_by_bounding_box({}, params) }.to raise_error(Yelp::Error::BoundingBoxNotComplete)
       end
     end
 

data/spec/yelp/error_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'yelp'
 
 describe Yelp::Error do
   context '#from_request' do
@@ -16,7 +15,7 @@ describe Yelp::Error do
     it 'should raise an internal error' do
       expect {
         Yelp::Error.check_for_error(bad_response)
-      }.to raise_error(Yelp::InternalError, 'error message')
+      }.to raise_error(Yelp::Error::InternalError, 'error message')
     end
   end
 end

data/yelp.gemspec

@@ -6,11 +6,11 @@ require 'yelp/version'
 Gem::Specification.new do |spec|
   spec.name          = 'yelp'
   spec.version       = Yelp::VERSION
-  spec.authors       = ['Tomer Elmalem', 'Yelp']
+  spec.authors       = ['Tomer Elmalem', 'Justin Cunningham', 'Yelp']
   spec.email         = ['telmalem@gmail.com', 'partnerships@yelp.com']
   spec.summary       = %q{Ruby client library for the Yelp API}
   spec.description   = 'Provides easy way to interact with the Yelp API in any kind of application'
-  spec.homepage      = 'https://github.com/yelp/yelp.rb'
+  spec.homepage      = 'https://github.com/Yelp/yelp-ruby'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 1.9.2'
+
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake', '~> 10.0', '>= 10.0.0'
   spec.add_development_dependency 'rspec', '~> 2.6'

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: yelp
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Tomer Elmalem
+- Justin Cunningham
 - Yelp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
+date: 2014-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -202,6 +203,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -230,7 +232,7 @@ files:
 - spec/yelp/yelp_spec.rb
 - tasks/console.rake
 - yelp.gemspec
-homepage: https://github.com/yelp/yelp.rb
+homepage: https://github.com/Yelp/yelp-ruby
 licenses:
 - MIT
 metadata: {}
@@ -242,7 +244,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="