intercom 2.2.2 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1105afd003920f148d703151927542f8174aae57
-  data.tar.gz: 13cd1a35776e6b353ed85884157992b9f7750a77
+  metadata.gz: d9e9fc89a1afe0812e99ba788f34abb10a2efee6
+  data.tar.gz: 22a8b523d0118dca4f92f9429ddc046ab3126d1d
 SHA512:
-  metadata.gz: 37bf3114fcb13dda58f34ce37623ab33adee640ded7d45c1aeb4e452ee4ebe7492fcc3f76ce48d53bfddd559795e1dc83e76e6e0a48eef696b3590a866729769
-  data.tar.gz: 8bc6eb1b8e44ca74e095ea3f74ea848bba15cafadf1421802921b3f43f599d31154d2f5fc124824eb72a703ff8a70a239a0e31377be7f0d310c7d2bcfa952235
+  metadata.gz: 06825933a4db65f7ea657c6525bc350d9df83cb3ad84a5baf4bb7043f061f32ccd8d7480d8a0bbe73614dda861375f4bd990c80d140f5b6feb90b60bab99ea94
+  data.tar.gz: f7059cecea4a6add02f0fcf1d28ea717a78829631393ed7f6d4e017e342e366da481affe6c9d4bf0aa95fa37f5d94f106f723126a30999f60e0594848d8c6e88

data/README.md

@@ -19,7 +19,7 @@ Additionally, the new version uses Ruby 2.
 
 Using bundler:
 
-    gem 'intercom', "~> 2.2.2"
+    gem 'intercom', "~> 2.2.3"
 
 ## Basic Usage
 
@@ -343,3 +343,13 @@ Intercom::BadRequestError
 Intercom::RateLimitExceeded
 Intercom::AttributeNotSetError # Raised when you try to call a getter that does not exist on an object
 ```
+
+### Rate Limiting
+
+Calling `Intercom.rate_limit_details` returns a Hash that contains details about your app's current rate limit.
+
+```ruby
+Intercom.rate_limit_details
+#=> {:limit=>180, :remaining=>179, :reset_at=>2014-10-07 14:58:00 +0100}
+```
+

data/changes.txt

@@ -1,3 +1,6 @@
+2.2.3
+ - Add rate limiting details to Intercom.rate_limiting_details
+
 2.2.2
  - Improve spec strings (thanks to @jkeyes)
  - Improve README readability (thanks to @jkeyes)

data/lib/intercom.rb

@@ -36,6 +36,7 @@ module Intercom
   @current_endpoint = nil
   @app_id = nil
   @app_api_key = nil
+  @rate_limit_details = {}
 
   def self.app_id=(app_id)
     @app_id = app_id
@@ -48,10 +49,19 @@ module Intercom
   def self.app_api_key=(app_api_key)
     @app_api_key = app_api_key
   end
+
   def self.app_api_key
     @app_api_key
   end
 
+  def self.rate_limit_details=(rate_limit_details)
+    @rate_limit_details = rate_limit_details
+  end
+
+  def self.rate_limit_details
+    @rate_limit_details
+  end
+
   # This method is obsolete and used to warn of backwards incompatible changes on upgrading
   def self.api_key=(val)
     raise ArgumentError, "#{compatibility_warning_text} #{compatibility_workaround_text} #{related_docs_text}"

data/lib/intercom/request.rb

@@ -61,6 +61,7 @@ module Intercom
         client(base_uri).start do |http|
           begin
             response = http.request(net_http_method)
+            set_rate_limit_details(response)
             decoded = decode(response['content-encoding'], response.body)
             unless decoded.strip.empty?
               parsed_body = JSON.parse(decoded)
@@ -77,6 +78,14 @@ module Intercom
       end
     end
 
+    def set_rate_limit_details(response)
+      rate_limit_details = {}
+      rate_limit_details[:limit] = response['X-RateLimit-Limit'].to_i if response['X-RateLimit-Limit']
+      rate_limit_details[:remaining] = response['X-RateLimit-Remaining'].to_i if response['X-RateLimit-Remaining']
+      rate_limit_details[:reset_at] = Time.at(response['X-RateLimit-Reset'].to_i) if response['X-RateLimit-Reset']
+      Intercom.rate_limit_details = rate_limit_details
+    end
+
     def decode(content_encoding, body)
       return body if (!body) || body.empty? || content_encoding != 'gzip'
       Zlib::GzipReader.new(StringIO.new(body)).read

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "2.2.2"
+  VERSION = "2.2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.3
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-03 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest