fb-support 1.0.0.alpha6 → 1.0.0.alpha7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 84710c0524e0f1372564277a6c79c58c488518eb0c5bd3aa3b77bbcb0ed1e2b7
-  data.tar.gz: 9b76c1b8de6609b3291228c736fbc518a44fec6e998f8d602aa29ecee3fdc03f
+SHA1:
+  metadata.gz: 463e709b2076a5a3a4a72c51f1cc6795478cd0fa
+  data.tar.gz: 56d439b1477fb44290a50a51b92c09739b19434f
 SHA512:
-  metadata.gz: a1660a6e93d37e1d3300052030f1dd7ae716ff8186ce0657e36cbbabd0386c3e4ee3e016c8e6e028046feea6583f53bf149e0beaa1d83619155b489741756743
-  data.tar.gz: a8890a505edaba286a35d35c933008f8a44c784f876915c5ca4cfc07284ba4c5a9cadb284d9440a7ed3ff09c8ff3ab543fac145f0b9ad16f5f38a7149c2a7270
+  metadata.gz: e08bf5b55cbc777ee8d08bd2b311d81884881cc4498927ae8f0b1e50bdeace0dcd0742224f216a6ed57807fcdd929528e2a9943e6decbd36a2df12a735f90d69
+  data.tar.gz: 21a256c7f3f669603627401ac4642352e8ff0264c544a109aab1355f9b3d92391e3b743ada0b2b93426eb1b343e95bbfedd1b846225e116409b70c12c4bfb2c0

data/CHANGELOG.md

@@ -6,6 +6,9 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 1.0.0.alpha7 - 2019-01-15
+
+* Remove `waiting_time` and add `on_response` callback.
 
 ## 1.0.0.alpha6 - 2018-08-24
 

data/README.md

@@ -20,14 +20,23 @@ Fb::Support provides:
 * [Fb::HTTPRequest](http://www.rubydoc.info/gems/fb-support/Fb/HTTPRequest)
 * [Fb::HTTPError](http://www.rubydoc.info/gems/fb-support/Fb/HTTPError)
 
-## Waiting Time
+## Response callback
 
-Facebook has [hourly rate limiting](https://developers.facebook.com/docs/graph-api/advanced/rate-limiting/#application-level-rate-limiting). `Fb::HTTPRequest` has `waiting_time` class variable
-to sleep the amount of time (in seconds) when it is approaching (with 85% of usage)
-in case the variable is set as follows.
+`Fb::HTTPRequest` has an `on_response` callback which is invoked with
+the request object and the HTTP response object on a successful
+response. This can be used for introspecting responses, performing some
+action when rate limit is near, etc.
 
 ```rb
-Fb::HTTPRequest.waiting_time = 360
+Fb::HTTPRequest.on_response = lambda do |request, response|
+  usage = request.rate_limiting_header
+  Librato.measure 'fb.call_count', usage['call_count']
+  Librato.measure 'fb.total_cputime', usage['total_cputime']
+  Librato.measure 'fb.total_time', usage['total_time']
+  if usage.values.any? {|value| value > 85 }
+    sleep 180
+  end
+end
 ```
 
 How to test

data/lib/fb/http_request.rb

@@ -34,10 +34,22 @@ module Fb
       @params = options.fetch :params, {}
     end
 
+    # Callback invoked with the response object on a successful response. Defaults to a noop.
+    # The callback invoked with two parameters: the HTTPRequest object
+    # and the Net::HTTP response object.
+    @@on_response = lambda {|_, _|}
+
     class << self
-      # @return [Integer] time in seconds for waiting when hourly rate limit
-      #   for the Facebook app reached over 85%
-      attr_accessor :waiting_time
+
+      # Reader for @@on_response
+      def on_response
+        @@on_response
+      end
+
+      # Writer for @@on_response
+      def on_response=(callback)
+        @@on_response = callback
+      end
     end
 
     # Sends the request and returns the response with the body parsed from JSON.
@@ -45,10 +57,7 @@ module Fb
     # @raise [Fb::HTTPError] if the request fails.
     def run
       if response.is_a? @expected_response
-        if (waiting_time = self.class.waiting_time) && rate_limiting_header &&
-          rate_limiting_header.values.any? {|value| value > 85 }
-          sleep waiting_time
-        end
+        self.class.on_response.call(self, response)
         response.tap do
           parse_response!
         end

data/lib/fb/support/version.rb

@@ -3,6 +3,6 @@ module Fb
   module Support
     # @return [String] the SemVer-compatible gem version.
     # @see http://semver.org
-    VERSION = '1.0.0.alpha6'
+    VERSION = '1.0.0.alpha7'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fb-support
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha6
+  version: 1.0.0.alpha7
 platform: ruby
 authors:
 - Claudio Baccigalupo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-31 00:00:00.000000000 Z
+date: 2019-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: Support utilities for Fb gems