koala 2.2.0 → 2.3.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56b21bc1a1b3fc57084dc12a4627457682c04556
-  data.tar.gz: 0c7c10177f312102ad6f3c0a99e56d83d4dbf3de
+  metadata.gz: 76e59769142ebe10d76554dfdf8c33e1f61cadc6
+  data.tar.gz: 57b9b65c9fd36ff249bc75dac3bab8f795a352db
 SHA512:
-  metadata.gz: 5327a17fda38dbbc4699069c57f7993397f6bceb9a968d4080bf13ade1c81c1a6f58a2e1dc37c01f36f94dba6c80533cebfc5585d8f77b9089d37c14071ecb35
-  data.tar.gz: 64df380a4025e40bc4539c845f9876750a86d744c312a39b3001d6d38dfc1b0a902182c2dbfca52c6fc55cd390b4dff811fef6f686fbc6741e70b3214dfe235f
+  metadata.gz: d6ff1b2181cdbab58b6b2a010349492102b6e598d7021d6bb7bce7949cc327259d37e4a16b51c609323fe410b87fbbfa835bfed377353d2e71a1a3c9f6125f79
+  data.tar.gz: 85c0c8dcf1a629043970be2a6c3eb9f6504ad5c1ca041189b3fe13e63aa70a3b90e68ca98e7cbbb042f8f616c59eac26600627ee20f0fed39419ba49b42a03da

data/.travis.yml

@@ -7,8 +7,8 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
-  # rbx
-  - rbx-2.4.1
+  # Rubinius is failing due to segfaults on Travis (and takes significantly longer to run)
+  # those builds will be restored later
   # jruby
   - jruby-19mode
 bundler_args: --without development

data/Gemfile

@@ -12,7 +12,7 @@ group :development, :test do
 end
 
 group :test do
-  gem "rspec", '~> 3.0.0.beta1'
+  gem "rspec", '~> 3.4'
   gem "vcr"
   gem "webmock"
   gem "codeclimate-test-reporter", require: nil

data/changelog.md

@@ -1,3 +1,24 @@
+v2.3.0
+======
+
+Updated features:
+
+* API#get_user_picture_data is now API#get_picture_data. The old method and API#get_picture both
+  remain with deprecation warnings. (Thanks noahsilas for earlier work on this!)
+* Koala::Facebook::APIError now includes [debug and trace
+  info](https://github.com/arsduo/koala/blob/master/lib/koala/errors.rb) provided by Facebook in the headers
+  (thanks, @elhu!)
+
+Internal Improvements:
+
+* Graph API error handling is now done via the GraphErrorChecker class
+
+Testing improvements:
+
+* Upgraded RSpec to 3.3.0
+* Removed pended specs that were no longer relevant
+* Improved https regex in test suite (thanks, lucaskds!)
+
 v2.2.0
 ======
 

data/code_of_conduct.md

@@ -0,0 +1,22 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/lib/koala/api/graph_api.rb

@@ -2,6 +2,7 @@ require 'addressable/uri'
 
 require 'koala/api/graph_collection'
 require 'koala/http_service/uploadable_io'
+require 'koala/api/graph_error_checker'
 
 module Koala
   module Facebook
@@ -164,9 +165,10 @@ module Koala
         graph_call("#{id}/#{connection_name}", args, "delete", options, &block)
       end
 
-      # Fetches a photo.
-      # (Facebook returns the src of the photo as a response header; this method parses that properly,
-      # unlike using get_connections("photo").)
+      # Fetches a photo url.
+      # Note that this method returns the picture url, not the full API
+      # response. For the hash containing the full metadata for the photo, use
+      # #get_user_picture_data instead.
       #
       # @param options options for Facebook (see #get_object).
       #                        To get a different size photo, pass :type => size (small, normal, large, square).
@@ -176,22 +178,34 @@ module Koala
       #
       # @return the URL to the image
       def get_picture(object, args = {}, options = {}, &block)
-        # Gets a picture object, returning the URL (which Facebook sends as a header)
-        graph_call("#{object}/picture", args, "get", options.merge(:http_component => :headers)) do |result|
-          resolved_result = result ? result["Location"] : nil
-          block ? block.call(resolved_result) : resolved_result
+        Koala::Utils.deprecate("API#get_picture will be removed in a future version. Please use API#get_picture_data, which returns a hash including the url.")
+
+        get_user_picture_data(object, args, options) do |result|
+          # Try to extract the URL
+          result = result.fetch('data', {})['url'] if result.respond_to?(:fetch)
+          block ? block.call(result) : result
         end
       end
 
-      # Fetches a photo data.
+      # Fetches a photo data hash.
       #
       # @param args (see #get_object)
       # @param options (see Koala::Facebook::API#api)
       # @param block (see Koala::Facebook::API#api)
       #
       # @return a hash of object data
-      def get_user_picture_data(object, args = {}, options = {}, &block)
-        graph_call("#{object}/picture", args.merge(:redirect => false), "get", options, &block)
+      def get_picture_data(object, args = {}, options = {}, &block)
+        # The default response for a Graph API query like GET /me/picture is to
+        # return a 302 redirect. This is a surprising difference from the
+        # common return type, so we add the `redirect: false` parameter to get
+        # a RESTful API response instead.
+        args = args.merge(:redirect => false)
+        graph_call("#{object}/picture", args, "get", options, &block)
+      end
+
+      def get_user_picture_data(*args, &block)
+        Koala::Utils.deprecate("API#get_user_picture_data is deprecated and will be removed in a future version. Please use API#get_picture_data, which has the same signature.")
+        get_picture_data(*args, &block)
       end
 
       # Upload a photo.
@@ -511,7 +525,7 @@ module Koala
         # enable appsecret_proof by default
         options = {:appsecret_proof => true}.merge(options) if @app_secret
         result = api(path, args, verb, options) do |response|
-          error = check_response(response.status, response.body)
+          error = check_response(response.status, response.body, response.headers)
           raise error if error
         end
 
@@ -524,39 +538,8 @@ module Koala
 
       private
 
-      def check_response(http_status, response_body)
-        # Check for Graph API-specific errors. This returns an error of the appropriate type
-        # which is immediately raised (non-batch) or added to the list of batch results (batch)
-        http_status = http_status.to_i
-
-        if http_status >= 400
-          begin
-            response_hash = MultiJson.load(response_body)
-          rescue MultiJson::DecodeError
-            response_hash = {}
-          end
-
-          if response_hash['error_code']
-            # Old batch api error format. This can be removed on July 5, 2012.
-            # See https://developers.facebook.com/roadmap/#graph-batch-api-exception-format
-            error_info = {
-              'code' => response_hash['error_code'],
-              'message' => response_hash['error_description']
-            }
-          else
-            error_info = response_hash['error'] || {}
-          end
-
-          if error_info['type'] == 'OAuthException' &&
-             ( !error_info['code'] || [102, 190, 450, 452, 2500].include?(error_info['code'].to_i))
-
-            # See: https://developers.facebook.com/docs/authentication/access-token-expiration/
-            #      https://developers.facebook.com/bugs/319643234746794?browse=search_4fa075c0bd9117b20604672
-            AuthenticationError.new(http_status, response_body, error_info)
-          else
-            ClientError.new(http_status, response_body, error_info)
-          end
-        end
+      def check_response(http_status, body, headers)
+        GraphErrorChecker.new(http_status, body, headers).error_if_appropriate
       end
 
       def parse_media_args(media_args, method)

data/lib/koala/api/graph_batch_api.rb

@@ -22,7 +22,7 @@ module Koala
         # normalize options for consistency
         options = Koala::Utils.symbolize_hash(options)
 
-        # for batch APIs, we queue up the call details (incl. post-processing)        
+        # for batch APIs, we queue up the call details (incl. post-processing)
         batch_calls << BatchOperation.new(
           :url => path,
           :args => args,
@@ -65,7 +65,13 @@ module Koala
 
             raw_result = nil
             if call_result
-              if ( error = check_response(call_result['code'], call_result['body'].to_s) )
+              parsed_headers = if call_result.has_key?('headers')
+                call_result['headers'].inject({}) { |headers, h| headers[h['name']] = h['value']; headers}
+              else
+                {}
+              end
+
+              if (error = check_response(call_result['code'], call_result['body'].to_s, parsed_headers))
                 raw_result = error
               else
                 # (see note in regular api method about JSON parsing)
@@ -77,7 +83,7 @@ module Koala
                   call_result["code"].to_i
                 when :headers
                   # facebook returns the headers as an array of k/v pairs, but we want a regular hash
-                  call_result['headers'].inject({}) { |headers, h| headers[h['name']] = h['value']; headers}
+                  parsed_headers
                 else
                   body
                 end

data/lib/koala/api/graph_error_checker.rb

@@ -0,0 +1,71 @@
+module Koala
+  module Facebook
+    # This class, given a Koala::HTTPService::Response object, will check for Graph API-specific
+    # errors. This returns an error of the appropriate type which can be immediately raised
+    # (non-batch) or added to the list of batch results (batch)
+    class GraphErrorChecker
+      attr_reader :http_status, :body, :headers
+      def initialize(http_status, body, headers)
+        @http_status = http_status.to_i
+        @body = body
+        @headers = headers
+      end
+
+      # Facebook has a set of standardized error codes, some of which represent problems with the
+      # token.
+      AUTHENTICATION_ERROR_CODES = [102, 190, 450, 452, 2500]
+
+      # Facebook can return debug information in the response headers -- see
+      # https://developers.facebook.com/docs/graph-api/using-graph-api#bugdebug
+      DEBUG_HEADERS = ["x-fb-debug", "x-fb-rev", "x-fb-trace-id"]
+
+      def error_if_appropriate
+        if http_status >= 400
+          error_class.new(http_status, body, error_info)
+        end
+      end
+
+      protected
+
+      def error_class
+        if auth_error?
+          # See: https://developers.facebook.com/docs/authentication/access-token-expiration/
+          #      https://developers.facebook.com/bugs/319643234746794?browse=search_4fa075c0bd9117b20604672
+          AuthenticationError
+        else
+          ClientError
+        end
+      end
+
+      def auth_error?
+        # tbh, I'm not sure why we restrict Facebook-reported OAuthExceptions to only those without
+        # codes or whose codes match the list above -- let's investigate changing this later.
+        error_info['type'] == 'OAuthException' &&
+          (!error_info['code'] || AUTHENTICATION_ERROR_CODES.include?(error_info['code'].to_i))
+      end
+
+      def error_info
+        # Build up the complete error info from whatever Facebook gives us plus the header
+        # information
+        @error_info ||= DEBUG_HEADERS.inject(base_error_info) do |hash, error_key|
+          hash[error_key] = headers[error_key] if headers[error_key]
+          hash
+        end
+      end
+
+      def base_error_info
+        response_hash['error'] || {}
+      end
+
+      def response_hash
+        # Normally, we start with the response body. If it isn't valid JSON, we start with an empty
+        # hash and fill it with error data.
+        @response_hash ||= begin
+          MultiJson.load(body)
+        rescue MultiJson::DecodeError
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/koala/errors.rb

@@ -13,8 +13,17 @@ module Koala
     # Facebook responded with an error to an API request. If the exception contains a nil
     # http_status, then the error was detected before making a call to Facebook. (e.g. missing access token)
     class APIError < ::Koala::KoalaError
-      attr_accessor :fb_error_type, :fb_error_code, :fb_error_subcode, :fb_error_message,
-                    :fb_error_user_msg, :fb_error_user_title, :http_status, :response_body
+      attr_accessor :http_status,
+                    :response_body,
+                    :fb_error_type,
+                    :fb_error_code,
+                    :fb_error_subcode,
+                    :fb_error_message,
+                    :fb_error_user_msg,
+                    :fb_error_user_title,
+                    :fb_error_trace_id,
+                    :fb_error_debug,
+                    :fb_error_rev
 
       # Create a new API Error
       #
@@ -54,8 +63,12 @@ module Koala
           self.fb_error_user_msg = error_info["error_user_msg"]
           self.fb_error_user_title = error_info["error_user_title"]
 
+          self.fb_error_trace_id = error_info["x-fb-trace-id"]
+          self.fb_error_debug = error_info["x-fb-debug"]
+          self.fb_error_rev = error_info["x-fb-rev"]
+
           error_array = []
-          %w(type code error_subcode message error_user_title error_user_msg).each do |key|
+          %w(type code error_subcode message error_user_title error_user_msg x-fb-trace-id).each do |key|
             error_array << "#{key}: #{error_info[key]}" if error_info[key]
           end
 

data/lib/koala/oauth.rb

@@ -197,7 +197,7 @@ module Koala
       # @return the application access token
       def get_app_access_token(options = {})
         if info = get_app_access_token_info(options)
-          string = info["access_token"]
+          info["access_token"]
         end
       end
 

data/lib/koala/version.rb

@@ -1,3 +1,3 @@
 module Koala
-  VERSION = "2.2.0"
+  VERSION = "2.3.0rc1"
 end

data/readme.md

@@ -7,12 +7,14 @@ Koala [![Version](https://img.shields.io/gem/v/koala.svg)](https://rubygems.org/
 * Flexible: Koala should be useful to everyone, regardless of their current configuration.  We support JRuby, Rubinius, and REE as well as vanilla Ruby (1.8.7, 1.9.2, 1.9.3, and 2.0.0), and use the Faraday library to provide complete flexibility over how HTTP requests are made.
 * Tested: Koala should have complete test coverage, so you can rely on it.  Our test coverage is complete and can be run against either mocked responses or the live Facebook servers; we're also on [Travis CI](http://travis-ci.org/arsduo/koala/).
 
+**Found a bug? Interested in contributing?** Check out the Maintenance section below!
+
 Installation
----
+------------
 
 In Bundler:
 ```ruby
-gem "koala", "~> 2.0"
+gem "koala", "~> 2.2"
 ```
 
 Otherwise:
@@ -20,8 +22,8 @@ Otherwise:
 [sudo|rvm] gem install koala
 ```
 
-Upgrading to 2.0
----------
+Upgrading to 2.0+
+-----------------
 
 Koala 2.0 is not a major refactor, but rather a set of small, mostly internal
 refactors, which should not require significant changes by users. See changelog.md for more
@@ -112,7 +114,8 @@ the results apart from a long list of array entries:
 Check out the wiki for more details and examples.
 
 The REST API
------
+------------
+
 Where the Graph API and the old REST API overlap, you should choose the Graph API.  Unfortunately, that overlap is far from complete, and there are many important API calls that can't yet be done via the Graph.
 
 Fortunately, Koala supports the REST API using the very same interface; to use this, instantiate an API:
@@ -132,7 +135,8 @@ fql = @api.fql_query(my_fql_query)
 ```
 
 Configuration
-----
+-------------
+
 You can change the host that koala makes requests to (point to a mock server, apigee, runscope etc..)
 ```ruby
 # config/initializers/koala.rb
@@ -150,6 +154,7 @@ tier and video upload matching and replacement strings.
 
 OAuth
 -----
+
 You can use the Graph and REST APIs without an OAuth access token, but the real magic happens when you provide Facebook an OAuth token to prove you're authenticated.  Koala provides an OAuth class to make that process easy:
 ```ruby
 @oauth = Koala::Facebook::OAuth.new(app_id, app_secret, callback_url)
@@ -189,7 +194,8 @@ Or, if for some horrible reason, you're still using session keys, despair not!
 That's it!  It's pretty simple once you get the hang of it.  If you're new to OAuth, though, check out the wiki and the OAuth Playground example site (see below).
 
 Real-time Updates
------
+-----------------
+
 Sometimes, reaching out to Facebook is a pain -- let it reach out to you instead.  The Graph API allows your application to subscribe to real-time updates for certain objects in the graph; check the [official Facebook documentation](http://developers.facebook.com/docs/api/realtime) for more details on what objects you can subscribe to and what limitations may apply.
 
 Koala makes it easy to interact with your applications using the RealtimeUpdates class:
@@ -215,7 +221,7 @@ Koala::Facebook::RealtimeUpdates.meet_challenge(params, your_verify_token)
 For more information about meet_challenge and the RealtimeUpdates class, check out the Real-Time Updates page on the wiki.
 
 Test Users
------
+----------
 
 We also support the test users API, allowing you to conjure up fake users and command them to do your bidding using the Graph or REST API:
 ```ruby
@@ -226,7 +232,7 @@ user_graph_api = Koala::Facebook::API.new(user["access_token"])
 @test_users.create_network(network_size, is_app_installed, common_permissions)
 ```
 Talking to Facebook
------
+-------------------
 
 Koala uses Faraday to make HTTP requests, which means you have complete control over how your app makes HTTP requests to Facebook.  You can set Faraday options globally or pass them in on a per-request (or both):
 ```ruby
@@ -240,7 +246,7 @@ Koala.http_service.http_options = {
 The <a href="https://github.com/arsduo/koala/wiki/HTTP-Services">HTTP Services wiki page</a> has more information on what options are available, as well as on how to configure your own Faraday middleware stack (for instance, to implement request logging).
 
 See examples, ask questions
------
+---------------------------
 
 Some resources to help you as you play with Koala and the Graph API:
 
@@ -257,7 +263,7 @@ issues filed about how to use the Facebook API may be closed with a reference
 to the Facebook Stack Overflow page.
 
 Testing
------
+-------
 
 Unit tests are provided for all of Koala's methods.  By default, these tests run against mock responses and hence are ready out of the box:
 ```bash
@@ -273,3 +279,25 @@ LIVE=true bundle exec rake spec
 LIVE=true BETA=true bundle exec rake spec
 ```
 By default, the live tests are run against test users, so you can run them as frequently as you want.  If you want to run them against a real user, however, you can fill in the OAuth token, code, and access\_token values in spec/fixtures/facebook_data.yml.  See the wiki for more details.
+
+Maintenance
+-----------
+
+_Pull requests_: Koala exists as it does thanks to the amazing support and work of community members of all
+backgrounds and levels of experience. Pull requests are very welcome! If you have any questions,
+just open an issue.
+
+Please note that this project is released with a Contributor Code of Conduct. By participating in
+this project you agree to abide by its terms. See
+[code_of_conduct.md](https://github.com/arsduo/koala/blob/master/code_of_conduct.md) for more information.
+
+_Schedule_: In order to keep Koala moving forward on a regular and predictable schedule, I will
+address issues and pull requests at least three times a year: late July/early August, late
+December/early January, and late March/early April. I may respond to issues in between maintenance
+periods, but it'll depend on other life/work goings-on.
+
+Breaking/new Facebook changes and other urgent issues obviously will get addressed much more
+quickly. (We've never had a security issue, but obviously that would be priority 0.)
+
+Have questions? Found a breaking bug or urgent issue? [Tweet at me](http://twitter.com/arsduo) --
+I'm always happy to respond.

data/spec/cases/error_spec.rb

@@ -5,7 +5,7 @@ describe Koala::Facebook::APIError do
     expect(Koala::Facebook::APIError.new(nil, nil)).to be_a(Koala::KoalaError)
   end
 
-  [:fb_error_type, :fb_error_code, :fb_error_subcode, :fb_error_message, :fb_error_user_msg, :fb_error_user_title, :http_status, :response_body].each do |accessor|
+  [:fb_error_type, :fb_error_code, :fb_error_subcode, :fb_error_message, :fb_error_user_msg, :fb_error_user_title, :fb_error_trace_id, :fb_error_rev, :fb_error_debug, :http_status, :response_body].each do |accessor|
     it "has an accessor for #{accessor}" do
       expect(Koala::Facebook::APIError.instance_methods.map(&:to_sym)).to include(accessor)
       expect(Koala::Facebook::APIError.instance_methods.map(&:to_sym)).to include(:"#{accessor}=")
@@ -29,7 +29,10 @@ describe Koala::Facebook::APIError do
         'code' => 1,
         'error_subcode' => 'subcode',
         'error_user_msg' => 'error user message',
-        'error_user_title' => 'error user title'
+        'error_user_title' => 'error user title',
+        'x-fb-trace-id' => 'fb trace id',
+        'x-fb-debug' => 'fb debug token',
+        'x-fb-rev' => 'fb revision'
       }
       Koala::Facebook::APIError.new(400, '', error_info)
     }
@@ -40,7 +43,10 @@ describe Koala::Facebook::APIError do
       :fb_error_code => 1,
       :fb_error_subcode => 'subcode',
       :fb_error_user_msg => 'error user message',
-      :fb_error_user_title => 'error user title'
+      :fb_error_user_title => 'error user title',
+      :fb_error_trace_id => 'fb trace id',
+      :fb_error_debug => 'fb debug token',
+      :fb_error_rev => 'fb revision'
     }.each_pair do |accessor, value|
       it "sets #{accessor} to #{value}" do
         expect(error.send(accessor)).to eq(value)
@@ -48,7 +54,7 @@ describe Koala::Facebook::APIError do
     end
 
     it "sets the error message appropriately" do
-      expect(error.message).to eq("type: type, code: 1, error_subcode: subcode, message: message, error_user_title: error user title, error_user_msg: error user message [HTTP 400]")
+      expect(error.message).to eq("type: type, code: 1, error_subcode: subcode, message: message, error_user_title: error user title, error_user_msg: error user message, x-fb-trace-id: fb trace id [HTTP 400]")
     end
   end
 

data/spec/cases/graph_api_batch_spec.rb

@@ -401,30 +401,7 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
             }.to raise_exception(Koala::Facebook::BadFacebookResponse)
           end
 
-          context "with the old style" do
-            before :each do
-              allow(Koala).to receive(:make_request).and_return(Koala::HTTPService::Response.new(400, '{"error_code":190,"error_description":"Error validating access token."}', {}))
-            end
-
-            it "throws an error" do
-              expect {
-                Koala::Facebook::API.new("foo").batch {|batch_api| batch_api.get_object('me') }
-              }.to raise_exception(Koala::Facebook::APIError)
-            end
-
-            it "passes all the error details" do
-              begin
-                Koala::Facebook::API.new("foo").batch {|batch_api| batch_api.get_object('me') }
-              rescue Koala::Facebook::APIError => err
-                expect(err.fb_error_code).to eq(190)
-                expect(err.fb_error_message).to eq("Error validating access token.")
-                err.http_status == 400
-                err.response_body == '{"error_code":190,"error_description":"Error validating access token."}'
-              end
-            end
-          end
-
-          context "with the new style" do
+          context "with error info" do
             before :each do
               allow(Koala).to receive(:make_request).and_return(Koala::HTTPService::Response.new(400, '{"error":{"message":"Request 0 cannot depend on an  unresolved request with  name f. Requests can only depend on preceding requests","type":"GraphBatchException"}}', {}))
             end

data/spec/cases/graph_api_spec.rb

@@ -30,7 +30,7 @@ describe 'Koala::Facebook::GraphAPIMethods' do
 
     context '#get_picture' do
       it 'returns result of block' do
-        allow(@api).to receive(:api).and_return("Location" => double("other result"))
+        allow(@api).to receive(:api).and_return({"data" => {"is_silhouette" => false, "url" => result}})
         expect(@api.get_picture('lukeshepard', &post_processing)["result"]).to eq(result)
       end
     end

data/spec/cases/graph_error_checker_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+module Koala
+  module Facebook
+    RSpec.describe GraphErrorChecker do
+      it "defines a set of AUTHENTICATION_ERROR_CODES" do
+        expect(GraphErrorChecker::AUTHENTICATION_ERROR_CODES).to match_array([102, 190, 450, 452, 2500])
+      end
+
+      it "defines a set of DEBUG_HEADERS" do
+        expect(GraphErrorChecker::DEBUG_HEADERS).to match_array([
+          "x-fb-rev",
+          "x-fb-debug",
+          "x-fb-trace-id"
+        ])
+      end
+
+      describe "#error_if_appropriate" do
+        shared_examples_for :returning_no_error do |status|
+          it "returns no error" do
+            expect(GraphErrorChecker.new(status, "{}", {}).error_if_appropriate).to be_nil
+          end
+
+          it "ignores error data even if present" do
+            checker = GraphErrorChecker.new(
+              status,
+              {"error" => {"some" => "error"}},
+              {"x-fb-rev" => "data"}
+            )
+            expect(checker.error_if_appropriate).to be_nil
+          end
+        end
+
+        context "if the status is 2xx" do
+          it_should_behave_like :returning_no_error, 202
+        end
+
+        context "if the status is 3xx" do
+          it_should_behave_like :returning_no_error, 302
+        end
+
+        shared_examples_for :returns_an_error do |status|
+          let(:body) { "{}" }
+          let(:headers) { {} }
+          let(:error) { GraphErrorChecker.new(status, body, headers).error_if_appropriate }
+          it "returns a ClientError for a generic error" do
+            expect(error).to be_a(ClientError)
+            expect(error.response_body).to eq(body)
+          end
+
+          it "returns a ClientError even if the body can't be parsed as JSON" do
+            body.replace("hello from Chicago")
+            expect(error).to be_a(ClientError)
+            expect(error.response_body).to eq(body)
+          end
+
+          it "adds error data from the body" do
+            error_data = {
+              "type" => "FB error type",
+              "code" => "FB error code",
+              "error_subcode" => "FB error subcode",
+              "message" => "An error occurred!",
+              "error_user_msg" => "A user msg",
+              "error_user_title" => "usr title"
+            }
+            body.replace({"error" => error_data}.to_json)
+
+            expect(error.fb_error_type).to eq(error_data["type"])
+            expect(error.fb_error_code).to eq(error_data["code"])
+            expect(error.fb_error_subcode).to eq(error_data["error_subcode"])
+            expect(error.fb_error_message).to eq(error_data["message"])
+            expect(error.fb_error_user_msg).to eq(error_data["error_user_msg"])
+            expect(error.fb_error_user_title).to eq(error_data["error_user_title"])
+          end
+
+          it "adds the FB debug headers to the errors" do
+            headers.merge!(
+              "x-fb-debug" => double("fb debug"),
+              "x-fb-rev" => double("fb rev"),
+              "x-fb-trace-id" => double("fb trace id"),
+            )
+            expect(error.fb_error_trace_id).to eq(headers["x-fb-trace-id"])
+            expect(error.fb_error_debug).to eq(headers["x-fb-debug"])
+            expect(error.fb_error_rev).to eq(headers["x-fb-rev"])
+          end
+
+          context "it returns an AuthenticationError" do
+            it "if FB says it's an OAuthException and it has no code" do
+              body.replace({"error" => {"type" => "OAuthException"}}.to_json)
+              expect(error).to be_an(AuthenticationError)
+            end
+
+            GraphErrorChecker::AUTHENTICATION_ERROR_CODES.each do |error_code|
+              it "if FB says it's an OAuthException and it has code #{error_code}" do
+                body.replace({"error" => {"type" => "OAuthException", "code" => error_code}}.to_json)
+                expect(error).to be_an(AuthenticationError)
+              end
+            end
+          end
+
+          # Note: I'm not sure why this behavior was implemented, it may be incorrect. To
+          # investigate.
+          it "doesn't return an AuthenticationError if FB says it's an OAuthException but the code doesn't match" do
+            body.replace({"error" => {"type" => "OAuthException", "code" => 2499}}.to_json)
+            expect(error).to be_an(ClientError)
+          end
+        end
+
+        context "if the status is 4xx" do
+          it_should_behave_like :returns_an_error, 400
+        end
+      end
+    end
+  end
+end
+

data/spec/cases/oauth_spec.rb

@@ -585,18 +585,18 @@ describe "Koala::Facebook::OAuth" do
       # so we only need to test at a high level that it works
       it "throws an error if the algorithm is unsupported" do
         allow(MultiJson).to receive(:load).and_return("algorithm" => "my fun algorithm")
-        expect { @oauth.parse_signed_request(@signed_request) }.to raise_error
+        expect { @oauth.parse_signed_request(@signed_params) }.to raise_error(Koala::Facebook::OAuthSignatureError)
       end
 
       it "throws an error if the signature is invalid" do
         allow(OpenSSL::HMAC).to receive(:hexdigest).and_return("i'm an invalid signature")
-        expect { @oauth.parse_signed_request(@signed_request) }.to raise_error
+        expect { @oauth.parse_signed_request(@signed_params) }.to raise_error(Koala::Facebook::OAuthSignatureError)
       end
 
       it "throws an error if the signature string is empty" do
         # this occasionally happens due to Facebook error
-        expect { @oauth.parse_signed_request("") }.to raise_error
-        expect { @oauth.parse_signed_request("abc-def") }.to raise_error
+        expect { @oauth.parse_signed_request("") }.to raise_error(Koala::Facebook::OAuthSignatureError)
+        expect { @oauth.parse_signed_request("abc-def") }.to raise_error(Koala::Facebook::OAuthSignatureError)
       end
 
       it "properly parses requests" do

data/spec/cases/realtime_updates_spec.rb

@@ -106,18 +106,6 @@ describe "Koala::Facebook::RealtimeUpdates" do
       @updates.subscribe("user", "name", @subscription_path, @verify_token)
     end
 
-    pending "doesn't require a verify_token" do
-      # see https://github.com/arsduo/koala/issues/150
-      obj = "user"
-      fields = "name"
-      expect(@updates.api).not_to receive(:graph_call).with(anything, hash_including(:verify_token => anything), anything, anything)
-      @updates.subscribe("user", "name", @subscription_path)
-    end
-
-    it "requires verify_token" do
-      expect { @updates.subscribe("user", "name", @subscription_path) }.to raise_exception
-    end
-
     it "accepts an options hash" do
       options = {:a => 2, :b => "c"}
       expect(@updates.api).to receive(:graph_call).with(anything, anything, anything, hash_including(options))
@@ -129,10 +117,6 @@ describe "Koala::Facebook::RealtimeUpdates" do
         expect { @updates.subscribe("user", "name", @subscription_path, @verify_token) }.to_not raise_error
       end
 
-      pending "sends a subscription request without a verify token" do
-        expect { @updates.subscribe("user", "name", @subscription_path) }.to_not raise_error
-      end
-
       it "fails if you try to hit an invalid path on your valid server" do
         expect { result = @updates.subscribe("user", "name", @subscription_path + "foo", @verify_token) }.to raise_exception(Koala::Facebook::APIError)
       end

data/spec/cases/test_users_spec.rb

@@ -261,10 +261,6 @@ describe "Koala::Facebook::TestUsers" do
         expect(result).to be_truthy
       end
 
-      it "does not accept user IDs anymore" do
-        expect { @test_users.befriend(@user1["id"], @user2["id"]) }.to raise_exception
-      end
-
       it "accepts http options passed to both calls" do
         options = {:some_http_option => true}
         # should come twice, once for each user

data/spec/fixtures/mock_facebook_responses.yml

@@ -79,7 +79,10 @@ graph_api:
         with_token: '[{"code": 200, "body":"{\"id\":\"123\"}"}, {"code": 200, "body":"{\"id\":\"456\"}"}]'
     batch=<%= MultiJson.dump([{"method" => "get", "relative_url" => "me/picture"}]) %>:
       post:
-        with_token: '[{"code": 200, "headers":[{"name":"Location","value":"http://google.com"}]}]'
+        with_token: '[{"code": 302, "headers":[{"name":"Location","value":"http://google.com"}]}]'
+    batch=<%= MultiJson.dump([{"method" => "get", "relative_url" => "me/picture?redirect=false"}]) %>:
+      post:
+        with_token: '[{"code": 200, "body":"{\"data\":{\"is_silhouette\":false,\"url\":\"http:\/\/google.com\"}}"}]'
     batch=<%= MultiJson.dump([{"method" => "get", "relative_url" => "me"},{"method" => "get", "relative_url" => "me/friends"}]) %>:
       post:
         with_token: '[{"code": 200, "body":"{\"id\":\"koppel\"}"}, {"code": 200, "body":"{\"data\":[{\"id\":\"lukeshepard\"}],\"paging\":{}}"}]'
@@ -167,6 +170,11 @@ graph_api:
       post:
         with_token: '{"id": "FEED_ITEM_DICTIONARY"}'
 
+  /me/picture:
+    redirect=false:
+      no_token: '{ "data": { "is_silhouette": true, "url": "https://facebook.com" } }'
+      with_token: '{ "data": { "is_silhouette": true, "url": "https://facebook.com" } }'
+
   /me/photos:
     source=[FILE]:
       post:
@@ -248,11 +256,15 @@ graph_api:
           code: 302
           headers:
             Location: https://facebook.com/large
-
     redirect=false:
       get:
-        no_token: '{"is_silhouette": true, "url": "https://facebook.com/large"}'
-        with_token: '{"is_silhouette": true, "url": "https://facebook.com/large"}'
+        no_token: '{ "data": { "is_silhouette": true, "url": "https://facebook.com" } }'
+        with_token: '{ "data": { "is_silhouette": true, "url": "https://facebook.com" } }'
+    redirect=false&type=large:
+      get:
+        no_token: '{ "data": { "is_silhouette": true, "url": "https://facebook.com/large" } }'
+        with_token: '{ "data": { "is_silhouette": true, "url": "https://facebook.com/large" } }'
+
   /comments:
     ids=http://developers.facebook.com/blog/post/472:
       get:

data/spec/spec_helper.rb

@@ -13,3 +13,13 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 KoalaTest.setup_test_environment!
 
 BEACH_BALL_PATH = File.join(File.dirname(__FILE__), "fixtures", "beach.jpg")
+
+RSpec.configure do |config|
+  config.mock_with :rspec do |mocks|
+    # This option should be set when all dependencies are being loaded
+    # before a spec run, as is the case in a typical spec helper. It will
+    # cause any verifying double instantiation for a class that does not
+    # exist to raise, protecting against incorrectly spelt names.
+    mocks.verify_doubled_constant_names = true
+  end
+end

data/spec/support/graph_api_shared_examples.rb

@@ -90,11 +90,11 @@ shared_examples_for "Koala GraphAPI" do
 
   describe "#get_picture" do
     it "can access a user's picture" do
-      expect(@api.get_picture(KoalaTest.user2)).to match(/http[s]*\:\/\//)
+      expect(@api.get_picture(KoalaTest.user2)).to match(/https?\:\/\//)
     end
 
     it "can access a user's picture, given a picture type"  do
-      expect(@api.get_picture(KoalaTest.user2, {:type => 'large'})).to match(/^http[s]*\:\/\//)
+      expect(@api.get_picture(KoalaTest.user2, {:type => 'large'})).to match(/^https?\:\/\//)
     end
 
     it "works even if Facebook returns nil" do
@@ -103,9 +103,24 @@ shared_examples_for "Koala GraphAPI" do
     end
   end
 
-  it "can access a user's picture data" do
-    result = @api.get_user_picture_data(KoalaTest.user2)
-    expect(result.key?("is_silhouette")).to be_truthy
+  describe "#get_picture_data" do
+    it "can access a user's picture data" do
+      result = @api.get_picture_data(KoalaTest.user2)
+      expect(result).to be_kind_of(Hash)
+      expect(result["data"]).to be_kind_of(Hash)
+      expect(result['data']).to be_truthy
+      expect(result['data'].keys).to include('is_silhouette', 'url')
+    end
+  end
+
+  describe "#get_user_picture_data" do
+    it "can access a user's picture data" do
+      result = @api.get_picture_data(KoalaTest.user2)
+      expect(result).to be_kind_of(Hash)
+      expect(result["data"]).to be_kind_of(Hash)
+      expect(result['data']).to be_truthy
+      expect(result['data'].keys).to include('is_silhouette', 'url')
+    end
   end
 
   it "can access connections from public Pages" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: koala
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0rc1
 platform: ruby
 authors:
 - Alex Koppel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-11 00:00:00.000000000 Z
+date: 2016-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -76,6 +76,7 @@ files:
 - Rakefile
 - autotest/discover.rb
 - changelog.md
+- code_of_conduct.md
 - koala.gemspec
 - lib/koala.rb
 - lib/koala/api.rb
@@ -83,6 +84,7 @@ files:
 - lib/koala/api/graph_api.rb
 - lib/koala/api/graph_batch_api.rb
 - lib/koala/api/graph_collection.rb
+- lib/koala/api/graph_error_checker.rb
 - lib/koala/api/rest_api.rb
 - lib/koala/errors.rb
 - lib/koala/http_service.rb
@@ -100,6 +102,7 @@ files:
 - spec/cases/graph_api_batch_spec.rb
 - spec/cases/graph_api_spec.rb
 - spec/cases/graph_collection_spec.rb
+- spec/cases/graph_error_checker_spec.rb
 - spec/cases/http_service_spec.rb
 - spec/cases/koala_spec.rb
 - spec/cases/koala_test_spec.rb
@@ -141,9 +144,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.6
@@ -157,6 +160,7 @@ test_files:
 - spec/cases/graph_api_batch_spec.rb
 - spec/cases/graph_api_spec.rb
 - spec/cases/graph_collection_spec.rb
+- spec/cases/graph_error_checker_spec.rb
 - spec/cases/http_service_spec.rb
 - spec/cases/koala_spec.rb
 - spec/cases/koala_test_spec.rb