koala 3.0.0.beta3 → 3.0.0.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ed893e5254cc1e5b3007301dc847bd025b592c1
-  data.tar.gz: 3ad942cb33ac7e7a36304250dd3cc7c6b36712f8
+  metadata.gz: f4f00f2411c9a02ce7505dd449f8d2ae4782ebd5
+  data.tar.gz: 3d54abde36f96607babc134fd48ceb86935d4d19
 SHA512:
-  metadata.gz: 6d4cac2752f9b72f7c1c1cf4632dfaf10b7ba9b72753699540587e3b636b35fde33ca2035b47e468d51d59c490ce9dcbc624618d5eb10e1da3b5fc4c2a11f034
-  data.tar.gz: 4728dfc6777f3e1b29d2dcab6608c9a40f24e8ee8a2136940ed2b463846ddcffa9c0f0afd96a1ab8d21b2d2c0203bdde5ddfe0c4a8ee1d250650921361343c90
+  metadata.gz: 89f355e9ad1162a1a41ded724e27e878a542139941893985528e784f0f8db8b5448bed368670bb2a8a7cfc47a8a0315050c22840cd54a0927e035b284d71c46c
+  data.tar.gz: 716ce03878f4bf59f67ddd959d1fc3182deffe68c5d25b6aac74b434fccc58423fd0c8e55304406c74dea3b81d99e42f1a9e44f73c8a009fa1887484f580a767

data/changelog.md

@@ -29,6 +29,7 @@ Updated features:
 * Koala.config now uses a dedicated Koala::Configuration object
 * TestUser#befriend will provide the appsecret_proof if a secret is set (thanks, kwasimensah!)
 * API#search now requires an object type parameter to be included, matching Facebook's API (#575)
+* RealtimeUpdates will now only fetch the app access token if necessary, avoiding unnecessary calls
 
 Removed features:
 

data/lib/koala/api/graph_batch_api.rb

@@ -8,6 +8,9 @@ module Koala
       # inside a batch call we can do anything a regular Graph API can do
       include GraphAPIMethods
 
+      # Limits from @see https://developers.facebook.com/docs/marketing-api/batch-requests/v2.8
+      MAX_CALLS = 50
+
       attr_reader :original_api
       def initialize(api)
         @original_api = api
@@ -35,26 +38,34 @@ module Koala
         nil # batch operations return nothing immediately
       end
 
-      # execute the queued batch calls
+      # execute the queued batch calls. limits it to 50 requests per call.
+      # NOTE: if you use `name` and JsonPath references, you should ensure to call `execute` for each
+      # co-reference group and that the group size is not greater than the above limits.
       def execute(http_options = {})
         return [] if batch_calls.empty?
 
-        # Turn the call args collected into what facebook expects
-        args = {"batch" => batch_args}
-        batch_calls.each do |call|
-          args.merge! call.files || {}
-        end
+        batch_results = []
+        batch_calls.each_slice(MAX_CALLS) do |batch|
+          # Turn the call args collected into what facebook expects
+          args = {"batch" => batch_args(batch)}
+          batch.each do |call|
+            args.merge!(call.files || {})
+          end
 
-        original_api.graph_call("/", args, "post", http_options) do |response|
-          raise bad_response if response.nil?
-          generate_results(response)
+          original_api.graph_call("/", args, "post", http_options) do |response|
+            raise bad_response if response.nil?
+
+            batch_results += generate_results(response, batch)
+          end
         end
+
+        batch_results
       end
 
-      def generate_results(response)
+      def generate_results(response, batch)
         index = 0
         response.map do |call_result|
-          batch_op = batch_calls[index]
+          batch_op = batch[index]
           index += 1
           post_process = batch_op.post_processing
 
@@ -104,8 +115,8 @@ module Koala
         GraphErrorChecker.new(code, body, headers).error_if_appropriate
       end
 
-      def batch_args
-        calls = batch_calls.map do |batch_op|
+      def batch_args(calls_for_batch)
+        calls = calls_for_batch.map do |batch_op|
           batch_op.to_batch_params(access_token, app_secret)
         end
 

data/lib/koala/realtime_updates.rb

@@ -7,9 +7,6 @@ module Koala
       # @note: to subscribe to real-time updates, you must have an application access token
       #        or provide the app secret when initializing your RealtimeUpdates object.
 
-      # The application API interface used to communicate with Facebook.
-      # @return [Koala::Facebook::API]
-      attr_reader :api
       attr_reader :app_id, :app_access_token, :secret
 
       # Create a new RealtimeUpdates instance.
@@ -29,14 +26,21 @@ module Koala
         unless @app_id && (@app_access_token || @secret) # make sure we have what we need
           raise ArgumentError, "Initialize must receive a hash with :app_id and either :app_access_token or :secret! (received #{options.inspect})"
         end
+      end
 
-        # fetch the access token if we're provided a secret
-        if @secret && !@app_access_token
-          oauth = Koala::Facebook::OAuth.new(@app_id, @secret)
-          @app_access_token = oauth.get_app_access_token
-        end
+      # The app access token, either provided on initialization or fetched from Facebook using the
+      # app_id and secret.
+      def app_access_token
+        # If a token isn't provided but we need it, fetch it
+        @app_access_token ||= Koala::Facebook::OAuth.new(@app_id, @secret).get_app_access_token
+      end
 
-        @api = API.new(@app_access_token)
+      # The application API interface used to communicate with Facebook.
+      # @return [Koala::Facebook::API]
+      def api
+        # Only instantiate the API if needed. validate_update doesn't require it, so we shouldn't
+        # make an unnecessary request to get the app_access_token.
+        @api ||= API.new(app_access_token)
       end
 
       # Subscribe to realtime updates for certain fields on a given object (user, page, etc.).
@@ -60,7 +64,7 @@ module Koala
           :callback_url => callback_url,
         }.merge(verify_token ? {:verify_token => verify_token} : {})
         # a subscription is a success if Facebook returns a 200 (after hitting your server for verification)
-        @api.graph_call(subscription_path, args, 'post', options)
+        api.graph_call(subscription_path, args, 'post', options)
       end
 
       # Unsubscribe from updates for a particular object or from updates.
@@ -71,7 +75,7 @@ module Koala
       #
       # @raise A subclass of Koala::Facebook::APIError if the subscription request failed.
       def unsubscribe(object = nil, options = {})
-        @api.graph_call(subscription_path, object ? {:object => object} : {}, "delete", options)
+        api.graph_call(subscription_path, object ? {:object => object} : {}, "delete", options)
       end
 
       # List all active subscriptions for this application.
@@ -80,7 +84,7 @@ module Koala
       #
       # @return [Array] a list of active subscriptions
       def list_subscriptions(options = {})
-        @api.graph_call(subscription_path, {}, "get", options)
+        api.graph_call(subscription_path, {}, "get", options)
       end
 
       # As a security measure (to prevent DDoS attacks), Facebook sends a verification request to your server
@@ -129,12 +133,13 @@ module Koala
           raise AppSecretNotDefinedError, "You must init RealtimeUpdates with your app secret in order to validate updates"
         end
 
-        if request_signature = headers['X-Hub-Signature'] || headers['HTTP_X_HUB_SIGNATURE'] and
-           signature_parts = request_signature.split("sha1=")
-          request_signature = signature_parts[1]
-          calculated_signature = OpenSSL::HMAC.hexdigest('sha1', @secret, body)
-          calculated_signature == request_signature
-        end
+        request_signature = headers['X-Hub-Signature'] || headers['HTTP_X_HUB_SIGNATURE']
+        return unless request_signature
+
+        signature_parts = request_signature.split("sha1=")
+        request_signature = signature_parts[1]
+        calculated_signature = OpenSSL::HMAC.hexdigest('sha1', @secret, body)
+        calculated_signature == request_signature
       end
 
       # The Facebook subscription management URL for your application.

data/lib/koala/version.rb

@@ -1,3 +1,3 @@
 module Koala
-  VERSION = "3.0.0.beta3"
+  VERSION = "3.0.0.rc"
 end

data/readme.md

@@ -32,7 +32,9 @@ Otherwise:
 Configuration
 -------------
 
-Most applications will only use one application configuration. Rather than having toprovide that
+**Available with 3.0.0.beta3**
+
+Most applications will only use one application configuration. Rather than having to provide that
 value every time, you can configure Koala to use global settings:
 
 ```ruby

data/spec/cases/graph_api_batch_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'json' unless Hash.respond_to?(:to_json)
 
 describe "Koala::Facebook::GraphAPI in batch mode" do
 
@@ -468,6 +469,46 @@ describe "Koala::Facebook::GraphAPI in batch mode" do
         expect(thread_one_count).to eq(first_count)
         expect(thread_two_count).to eq(second_count)
       end
+
+    end
+  end
+
+  describe '#big_batches' do
+    before :each do
+      payload = [{code: 200, headers: [{name: "Content-Type", value: "text/javascript; charset=UTF-8"}], body: "{\"id\":\"1234\"}"}]
+      allow(Koala).to receive(:make_request) do |_request, args, _verb, _options|
+        request_count = JSON.parse(args['batch']).length
+        expect(request_count).to be <= 50   # check FB's limit
+        Koala::HTTPService::Response.new(200, (payload * request_count).to_json, {})
+      end
+    end
+
+    it 'stays within fb limits' do
+      count_calls = 0
+      expected_calls = 100
+      @api.batch do |batch_api|
+        expected_calls.times { |_i| batch_api.get_object('me') { |_ret| count_calls += 1 } }
+      end
+
+      expect(count_calls).to eq(expected_calls)
+    end
+
+    it 'is recursive safe' do
+      # ensure batch operations whose callbacks call batch operations don't resubmit
+      call_count = 0
+      iterations = 60
+      @api.batch do |batch_api|
+        # must do enough calls to provoke a batch submission
+        iterations.times { |_i|
+          batch_api.get_object('me') { |_ret|
+            call_count += 1
+            batch_api.get_object('me') { |_ret|
+              call_count += 1
+            }
+          }
+        }
+      end
+      expect(call_count).to eq(2 * iterations)
     end
   end
 

data/spec/cases/realtime_updates_spec.rb

@@ -106,25 +106,24 @@ describe "Koala::Facebook::RealtimeUpdates" do
       expect(updates).to be_a(Koala::Facebook::RealtimeUpdates)
     end
 
-    it "fetches an app_token from Facebook when provided an app_id and a secret" do
-      updates = Koala::Facebook::RealtimeUpdates.new(:app_id => @app_id, :secret => @secret)
-      expect(updates.app_access_token).not_to be_nil
+    it "sets up the API with the app access token" do
+      updates = Koala::Facebook::RealtimeUpdates.new(:app_id => @app_id, :app_access_token => @app_access_token)
+      expect(updates.api).to be_a(Koala::Facebook::API)
+      expect(updates.api.access_token).to eq(@app_access_token)
     end
+  end
 
-    it "uses the OAuth class to fetch a token when provided an app_id and a secret" do
-      oauth = Koala::Facebook::OAuth.new(@app_id, @secret)
-      token = oauth.get_app_access_token
-      expect(oauth).to receive(:get_app_access_token).and_return(token)
-      expect(Koala::Facebook::OAuth).to receive(:new).with(@app_id, @secret).and_return(oauth)
+  describe "#app_access_token" do
+    it "fetches an app_token from Facebook when provided an app_id and a secret" do
+      # integration test
       updates = Koala::Facebook::RealtimeUpdates.new(:app_id => @app_id, :secret => @secret)
+      expect(updates.app_access_token).not_to be_nil
     end
 
-    it "sets up the with the app acces token" do
-      updates = Koala::Facebook::RealtimeUpdates.new(:app_id => @app_id, :app_access_token => @app_access_token)
-      expect(updates.api).to be_a(Koala::Facebook::API)
-      expect(updates.api.access_token).to eq(@app_access_token)
+    it "returns the provided token if provided" do
+      updates = Koala::Facebook::RealtimeUpdates.new(app_id: @app_id, app_access_token: @app_access_token)
+      expect(updates.app_access_token).to eq(@app_access_token)
     end
-
   end
 
   describe "#subscribe" do

data/spec/fixtures/facebook_data.yml

@@ -5,9 +5,7 @@
 # by enter an OAuth token, code, and session_key (for real users) or changing the app_id and secret (for test users)
 # (note for real users: this will leave some photos and videos posted to your wall, since they can't be deleted through the API)
 
-# These values are configured to work with the OAuth Playground app by default
-# Of course, you can change this to work with your own app.
-# Check out http://oauth.twoalex.com/ to easily generate tokens, cookies, etc.
+# These values are configured to work with a test app. If you want, you can change this to work with your own app.
 
 # Your OAuth token should have the read_stream, publish_stream, user_photos, user_videos, and read_insights permissions.
 oauth_token:
@@ -22,7 +20,7 @@ oauth_test_data:
   # These values will work out of the box
   app_id: 119908831367602
   secret: e45e55a333eec232d4206d2703de1307
-  callback_url: http://oauth.twoalex.com/
+  callback_url: http://testdomain.koalatest.test/
   app_access_token: 119908831367602|o3wswWQ88LYjEC9-ukR_gjRIOMw.
   raw_token_string: "access_token=119908831367602|2.6GneoQbnEqtSiPppZzDU4Q__.3600.1273366800-2905623|3OLa3w0x1K4C1S5cOgbs07TytAk.&expires=6621"
   raw_offline_access_token_string: access_token=119908831367602|2.6GneoQbnEqtSiPppZzDU4Q__.3600.1273366800-2905623|3OLa3w0x1K4C1S5cOgbs07TytAk.
@@ -54,7 +52,7 @@ oauth_test_data:
       issued_at: 1301917299
 
 subscription_test_data:
-  subscription_path: https://oauth.twoalex.com/subscriptions
+  subscription_path: https://testdomain.koalatest.test/subscriptions
   verify_token: "myverificationtoken|1f54545d5f722733e17faae15377928f"
   challenge_data:
     "hub.challenge": "1290024882"
@@ -62,4 +60,4 @@ subscription_test_data:
     "hub.mode": "subscribe"
 
 vcr_data:
-  oauth_token: CAACEdEose0cBAKuiUM40KZBEsq2l0iggaMGZBPI74svGQRMmZCPXb7eZCYPhNUbVXnnYZCjXKFKIc7HgYllr4RDIKrANHm6kKncOx0Y3UpDqLliRGZAnSEUypyFworUnBMOQJBlAuB1wlwYJZB7LIZCobCcnT2q9QwrZBpK3qAZB3u7ZAJaZAdsMZBsyALkAXatoj75leWXhgXfT1QiJHZBGoRlz07Q85z1dZBReK4ZD
+  oauth_token: CAACEdEose0cBAKuiUM40KZBEsq2l0iggaMGZBPI74svGQRMmZCPXb7eZCYPhNUbVXnnYZCjXKFKIc7HgYllr4RDIKrANHm6kKncOx0Y3UpDqLliRGZAnSEUypyFworUnBMOQJBlAuB1wlwYJZB7LIZCobCcnT2q9QwrZBpK3qAZB3u7ZAJaZAdsMZBsyALkAXatoj75leWXhgXfT1QiJHZBGoRlz07Q85z1dZBReK4ZD

data/spec/fixtures/mock_facebook_responses.yml

@@ -144,10 +144,10 @@ graph_api:
     message=Hello, world, from the test suite batch API!:
       post:
         with_token: '{"id": "FEED_ITEM_BATCH"}'
-    link=http://oauth.twoalex.com/&message=Hello, world, from the test suite again!&name=OAuth Playground:
+    link=http://testdomain.koalatest.test/&message=Hello, world, from the test suite again!&name=OAuth Playground:
       post:
         with_token: '{"id": "FEED_ITEM_CONTEXT"}'
-    link=http://oauth.twoalex.com/&message=body&name=It's a big question&picture=http://oauth.twoalex.com//images/logo.png&properties=<%= JSON.dump({"Link1"=>{"text"=>"Left", "href"=>"http://oauth.twoalex.com/"}, "other" => {"text"=>"Straight ahead", "href"=>"http://oauth.twoalex.com/?"}}) %>&type=link:
+    link=http://testdomain.koalatest.test/&message=body&name=It's a big question&picture=http://testdomain.koalatest.test//images/logo.png&properties=<%= JSON.dump({"Link1"=>{"text"=>"Left", "href"=>"http://testdomain.koalatest.test/"}, "other" => {"text"=>"Straight ahead", "href"=>"http://testdomain.koalatest.test/?"}}) %>&type=link:
       post:
         with_token: '{"id": "FEED_ITEM_DICTIONARY"}'
 
@@ -367,12 +367,12 @@ graph_api:
         with_token:
           code: 200
       get:
-        with_token: '{"data":[{"callback_url":"https://oauth.twoalex.com/subscriptions", "fields":["name"], "object":"user", "active":true}]}'
+        with_token: '{"data":[{"callback_url":"https://testdomain.koalatest.test/subscriptions", "fields":["name"], "object":"user", "active":true}]}'
 
 
     callback_url=<%= SUBSCRIPTION_DATA["subscription_path"] %>:
       get:
-        with_token: '{"data":[{"callback_url":"https://oauth.twoalex.com/subscriptions", "fields":["name"], "object":"user", "active":true}]}'
+        with_token: '{"data":[{"callback_url":"https://testdomain.koalatest.test/subscriptions", "fields":["name"], "object":"user", "active":true}]}'
 
 # -- Mock Item Responses --
 
@@ -394,13 +394,13 @@ graph_api:
     no_args:
       <<: *item_deleted
       get:
-        with_token: '{"link":"http://oauth.twoalex.com/", "name": "OAuth Playground"}'
+        with_token: '{"link":"http://testdomain.koalatest.test/", "name": "OAuth Playground"}'
 
   /FEED_ITEM_DICTIONARY:
     no_args:
       <<: *item_deleted
       get:
-        with_token: '{"link":"http://oauth.twoalex.com/", "name": "OAuth Playground", "properties": {}}'
+        with_token: '{"link":"http://testdomain.koalatest.test/", "name": "OAuth Playground", "properties": {}}'
 
   /FEED_ITEM_CATS:
     no_args:

data/spec/support/graph_api_shared_examples.rb

@@ -175,7 +175,7 @@ shared_examples_for "Koala GraphAPI with an access token" do
   end
 
   it "can post a message with an attachment to a feed" do
-    result = @api.put_wall_post("Hello, world, from the test suite again!", {:name => "OAuth Playground", :link => "http://oauth.twoalex.com/"})
+    result = @api.put_wall_post("Hello, world, from the test suite again!", {:name => "OAuth Playground", :link => "http://testdomain.koalatest.test/"})
     @temporary_object_id = result["id"]
     expect(@temporary_object_id).not_to be_nil
   end
@@ -311,7 +311,7 @@ shared_examples_for "Koala GraphAPI with an access token" do
   end
 
   it "can verify a message with an attachment posted to a feed" do
-    attachment = {"name" => "OAuth Playground", "link" => "http://oauth.twoalex.com/"}
+    attachment = {"name" => "OAuth Playground", "link" => "http://testdomain.koalatest.test/"}
     result = @api.put_wall_post("Hello, world, from the test suite again!", attachment)
     @temporary_object_id = result["id"]
     get_result = @api.get_object(@temporary_object_id)
@@ -508,7 +508,7 @@ shared_examples_for "Koala GraphAPI without an access token" do
   # but are here for completeness
   it "can't post to a feed" do
     expect(lambda do
-      attachment = {:name => "OAuth Playground", :link => "http://oauth.twoalex.com/"}
+      attachment = {:name => "OAuth Playground", :link => "http://testdomain.koalatest.test/"}
       @result = @api.put_wall_post("Hello, world", attachment, "facebook")
     end).to raise_error(Koala::Facebook::AuthenticationError)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: koala
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta3
+  version: 3.0.0.rc
 platform: ruby
 authors:
 - Alex Koppel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2017-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday