sailthru-client 4.0.7 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 067482a879f7af281db3f53988a0595665dea658
-  data.tar.gz: 1bf7045b497d4b74ee60b85f14c8139dbc8734de
+  metadata.gz: 861a575aa56944d027c0cc7e3fbd52a9c266abc0
+  data.tar.gz: 55d80097eb3dc65651a27c90e27d2a481f113019
 SHA512:
-  metadata.gz: 8928a8a8858455f45358303db337749c9d4a32c865ffa84d72a809729bcac1194c783a720ff39d6dc82ee095a9bec92c6896b129745f35b59cc0ad59a25bdbc0
-  data.tar.gz: 40776ddd4d7a5f738d0cf57e04eda271d2748799ea8dc2fe54dcf884a7a2b27ac69bcd22d7d931117c670e63034c6d9ae5b0dea1cb3df52d2dbb46f2a58e5a2e
+  metadata.gz: a4d39c922e39970f6bcf10063efdf015b513da719fef606092e69e594603d3a3e83f2631a2b491b7bcd463bd50867b23200c9f87b7ded646b1dc8b969f832f90
+  data.tar.gz: 7b30e7fc8563837c3176de48bc6edc2674d21b240085a6314510a3138811dab377e6e8a0fa6b7b135239a78a3f53a6281f652604c81b9ecda7f8f04cebdf627c

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 4.1.0
+  - added get_last_rate_limit_info method call
+
 ## 4.0.3
   - Explicitly enable TLS (version 1.0)
 

data/README.md

@@ -24,6 +24,28 @@ sailthru = Sailthru::Client.new("api-key", "api-secret", "https://api.sailthru.c
 			          {:http_read_timeout => 30, :http_ssl_timeout => 30, :http_open_timeout => 30})
 ```
 
+## Rate Limit Information
+
+The library allows inspection of the 'X-Rate-Limit-*' headers returned by the Sailthru API. The `get_last_rate_limit_info(endpoint, method)` function allows you to retrieve the last known rate limit information for the given endpoint / method combination. It must follow an API call. For example, if you do a `/send POST`, you can follow up with a call to `get_last_rate_limit_info(:send, :post)` as shown below:
+
+``` ruby
+# make API call as normal
+response = sailthru.send_email template_name, email, {foo: "bar"}
+
+# check rate limit information
+rate_limit_info = sailthru.get_last_rate_limit_info :send, :post
+```
+
+The return type will be `nil` if there is no rate limit information for the given endpoint / method combination (e.g. if you have not yet made a request to that endpoint). Otherwise, it will be a hash in the following format:
+
+``` ruby
+{
+    limit: 1234, # <Number representing the limit of requests/minute for this action / method combination>
+    remaining: 1230, # <Number representing how many requests remain in the current minute>
+    reset: 1459381680 # <Number representing the UNIX epoch timestamp of when the next minute starts, and when the rate limit resets>
+}
+```
+
 ## License
 
 Please see MIT-LICENSE for license.

data/lib/sailthru/client.rb

@@ -29,6 +29,7 @@ module Sailthru
       @proxy_port = proxy_port
       @verify_ssl = true
       @opts = opts
+      @last_rate_limit_info = {}
     end
 
     # params:
@@ -746,6 +747,21 @@ module Sailthru
       api_request(action, data, 'DELETE')
     end
 
+    # params
+    #   endpoint, String a e.g. "user" or "send"
+    #   method, String "GET" or "POST"
+    # returns
+    #   Hash rate info
+    # Get rate info for a particular endpoint/method, as of the last time a request was sent to the given endpoint/method
+    # Includes the following keys:
+    #   limit: the per-minute limit for the given endpoint/method
+    #   remaining: the number of allotted requests remaining in the current minute for the given endpoint/method
+    #   reset: unix timestamp of the top of the next minute, when the rate limit will reset
+    def get_last_rate_limit_info(endpoint, method)
+        rate_info_key = get_rate_limit_info_key(endpoint, method)
+        @last_rate_limit_info[rate_info_key]
+    end
+
     protected
 
     # params:
@@ -774,7 +790,7 @@ module Sailthru
       if !binary_key.nil?
         data[binary_key] = binary_key_data
       end
-      _result = http_request("#{@api_uri}/#{action}", data, request_type, binary_key)
+      _result = http_request(action, data, request_type, binary_key)
 
       # NOTE: don't do the unserialize here
       if data[:format] == 'json'
@@ -817,9 +833,10 @@ module Sailthru
     #   method, String "GET" or "POST"
     # returns:
     #   String, body of response
-    def http_request(uri, data, method = 'POST', binary_key = nil)
+    def http_request(action, data, method = 'POST', binary_key = nil)
       data = flatten_nested_hash(data, false)
 
+      uri = "#{@api_uri}/#{action}"
       if method != 'POST'
         uri += "?" + data.map{ |key, value| "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}" }.join("&")
       end
@@ -866,6 +883,8 @@ module Sailthru
         raise ClientError, "Unable to open stream to #{_uri}: #{e.message}"
       end
 
+      save_rate_limit_info(action, method, response)
+
       response.body || raise(ClientError, "No response received from stream: #{_uri}")
     end
 
@@ -883,5 +902,26 @@ module Sailthru
       payload[:sig] = get_signature_hash(payload, @secret)
       payload
     end
+
+    def save_rate_limit_info(action, method, response)
+      limit = response['x-rate-limit-limit'].to_i
+      remaining = response['x-rate-limit-remaining'].to_i
+      reset = response['x-rate-limit-reset'].to_i
+
+      if limit.nil? or remaining.nil? or reset.nil?
+          return
+      end
+
+      rate_info_key = get_rate_limit_info_key(action, method)
+      @last_rate_limit_info[rate_info_key] = {
+              limit: limit,
+              remaining: remaining,
+              reset: reset
+      }
+    end
+
+    def get_rate_limit_info_key(endpoint, method)
+      :"#{endpoint}_#{method.downcase}"
+    end
   end
 end

data/lib/sailthru/version.rb

@@ -1,3 +1,3 @@
 module Sailthru
-  VERSION = '4.0.7'
+  VERSION = '4.1.0'
 end

data/test/fixtures/templates_get.json

@@ -0,0 +1 @@
+{"templates":[{"template_id": 23},{"template_id": 24}]}

data/test/sailthru/file_upload_test.rb

@@ -3,7 +3,7 @@ require 'mocha/setup'
 
 class FileUploadTest < Minitest::Test
 
-  describe "API Call: blast" do
+  describe "File Upload Functionality" do
 
     before do
       @secret = 'my_secret'
@@ -26,7 +26,8 @@ class FileUploadTest < Minitest::Test
       Net::HTTP.stubs(:Proxy).returns(Net::HTTP)
       Net::HTTP.any_instance.stubs(
           :request => stub(
-            "body" => JSON.unparse({"job_id" => "123"})
+            "body" => JSON.unparse({"job_id" => "123"}),
+            "[]" => nil
           )
         )
 
@@ -50,7 +51,8 @@ class FileUploadTest < Minitest::Test
       Net::HTTP.stubs(:Proxy).returns(Net::HTTP)
       Net::HTTP.any_instance.stubs(
           :request => stub(
-            "body" => JSON.unparse({"job_id" => "123"})
+            "body" => JSON.unparse({"job_id" => "123"}),
+            "[]" => nil
           )
         )
 

data/test/sailthru/rate_info_test.rb

@@ -0,0 +1,94 @@
+require 'test_helper'
+
+class RateInfoTest < Minitest::Test
+    describe "get_last_rate_limit_info() (All API Calls)" do
+        before do
+            @api_url = 'http://api.sailthru.com'
+            @secret = 'my_secret'
+            @api_key = 'my_api_key'
+            @sailthru_client = Sailthru::Client.new(@api_key, @secret, @api_url)
+        end
+
+        it "returns rate limit info for a given endpoint and method" do
+            # perform a /send GET request
+            api_call_url = sailthru_api_call_url(@api_url, 'send')
+            valid_send_id = "TT1ClGdj2bRHAAP6"
+            params = {
+                    'send_id' => valid_send_id
+            }
+            query_string = create_json_payload(@api_key, @secret, params)
+            rate_headers = get_rate_info_headers(3, 2, Time.now.to_i)
+            stub_get(api_call_url + '?' + query_string , 'send_get_valid.json', rate_headers)
+            response = @sailthru_client.get_send(valid_send_id)
+            assert_equal valid_send_id, response['send_id']
+
+            # verify the subsequent rate info for /send GET
+            rate_info = @sailthru_client.get_last_rate_limit_info(:send, :get)
+            assert_equal rate_headers[:x_rate_limit_limit], rate_info[:limit]
+            assert_equal rate_headers[:x_rate_limit_remaining], rate_info[:remaining]
+            assert_equal rate_headers[:x_rate_limit_reset], rate_info[:reset]
+        end
+
+        it "can return distinct rate limit info for different endpoints" do
+            # perform a /send GET request
+            send_api_call_url = sailthru_api_call_url(@api_url, 'send')
+            valid_send_id = "TT1ClGdj2bRHAAP6"
+            send_query_string = create_json_payload(@api_key, @secret, { 'send_id' => valid_send_id })
+            send_rate_headers = get_rate_info_headers(3, 2, Time.now.to_i + 10)
+            stub_get(send_api_call_url + '?' + send_query_string , 'send_get_valid.json', send_rate_headers)
+            response = @sailthru_client.get_send(valid_send_id)
+            assert_equal valid_send_id, response['send_id']
+
+            # perform a /list GET request -- and have this endpoint return different rate info
+            list_api_call_url = sailthru_api_call_url(@api_url, 'list')
+            list = 'list1'
+            list_query_string = create_json_payload(@api_key, @secret, {'list' => list})
+            list_rate_headers = get_rate_info_headers(5, 4, Time.now.to_i + 8)
+            stub_get(list_api_call_url + '?' + list_query_string, 'list_get_valid.json', list_rate_headers)
+            response = @sailthru_client.get_list(list)
+            assert_equal(response['list'], list)
+
+            # verify the rate info for each call
+            send_rate_info = @sailthru_client.get_last_rate_limit_info(:send, :get)
+            assert_equal send_rate_headers[:x_rate_limit_limit], send_rate_info[:limit]
+            assert_equal send_rate_headers[:x_rate_limit_remaining], send_rate_info[:remaining]
+            assert_equal send_rate_headers[:x_rate_limit_reset], send_rate_info[:reset]
+
+            list_rate_info = @sailthru_client.get_last_rate_limit_info(:list, :get)
+            assert_equal list_rate_headers[:x_rate_limit_limit], list_rate_info[:limit]
+            assert_equal list_rate_headers[:x_rate_limit_remaining], list_rate_info[:remaining]
+            assert_equal list_rate_headers[:x_rate_limit_reset], list_rate_info[:reset]
+        end
+
+        it "can return distinct rate limit info for different methods" do
+            api_call_url = sailthru_api_call_url(@api_url, 'send')
+
+            # perform a /send GET request
+            valid_send_id = "TT1ClGdj2bRHAAP6"
+            get_query_string = create_json_payload(@api_key, @secret, { 'send_id' => valid_send_id })
+            get_rate_headers = get_rate_info_headers(3, 2, Time.now.to_i + 10)
+            stub_get(api_call_url + '?' + get_query_string , 'send_get_valid.json', get_rate_headers)
+            response = @sailthru_client.get_send(valid_send_id)
+            assert_equal valid_send_id, response['send_id']
+
+            # perform a /send POST request -- and have this method return different rate info
+            template_name = 'default'
+            email = 'example@example.com'
+            post_rate_headers = get_rate_info_headers(5, 4, Time.now.to_i + 8)
+            stub_post(api_call_url, 'send_get_valid.json', post_rate_headers)
+            response = @sailthru_client.send_email template_name, email, {"name" => "Unix",  "myvar" => [1111,2,3], "mycomplexvar" => {"tags" => ["obama", "aaa", "c"]}}
+            assert_equal template_name, response['template']
+
+            # verify the rate info for each call
+            get_rate_info = @sailthru_client.get_last_rate_limit_info(:send, :get)
+            assert_equal get_rate_headers[:x_rate_limit_limit], get_rate_info[:limit]
+            assert_equal get_rate_headers[:x_rate_limit_remaining], get_rate_info[:remaining]
+            assert_equal get_rate_headers[:x_rate_limit_reset], get_rate_info[:reset]
+
+            post_rate_info = @sailthru_client.get_last_rate_limit_info(:send, :post)
+            assert_equal post_rate_headers[:x_rate_limit_limit], post_rate_info[:limit]
+            assert_equal post_rate_headers[:x_rate_limit_remaining], post_rate_info[:remaining]
+            assert_equal post_rate_headers[:x_rate_limit_reset], post_rate_info[:reset]
+        end
+    end
+end

data/test/sailthru/template_test.rb

@@ -28,6 +28,14 @@ class TemplateTest < Minitest::Test
       assert_equal 14, response['error']
     end
 
+    it "can get a list of all existing templates" do
+      query_string = create_json_payload(@api_key, @secret, {})
+      stub_get(@api_call_url + '?' + query_string, 'templates_get.json')
+      response = @sailthru_client.get_templates  
+      assert response['templates'][0].has_key?('template_id')
+      refute_nil response['templates'][0]['template_id']
+    end
+
     it "can save template with given template name" do
       valid_template_name = 'my-template-new'
       from_email = 'praj@sailthru.com'

data/test/test_helper.rb

@@ -34,18 +34,22 @@ class Minitest::Test
     sailthru_api_base_url(url + action)
   end
 
-  def stub_get(url, filename)
+  def stub_get(url, filename, headers={})
     options = { :body => fixture_file(filename), :content_type => 'application/json' }
+    options.merge!(headers)
     FakeWeb.register_uri(:get, URI.parse(url), options)
   end
 
-  def stub_delete(url, filename)
+  def stub_delete(url, filename, headers={})
     options = { :body => fixture_file(filename), :content_type => 'application/json' }
+    options.merge!(headers)
     FakeWeb.register_uri(:delete, URI.parse(url), options)
   end
 
-  def stub_post(url, filename)
-    FakeWeb.register_uri(:post, URI.parse(url), :body => fixture_file(filename), :content_type => 'application/json')
+  def stub_post(url, filename, headers={})
+      options = { :body => fixture_file(filename), :content_type => 'application/json' }
+      options.merge!(headers)
+    FakeWeb.register_uri(:post, URI.parse(url), options)
   end
 
   def stub_exception(url, filename)
@@ -65,4 +69,13 @@ class Minitest::Test
       data['sig'] = get_signature_hash(data, secret)
       data.map{ |key, value| "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}" }.join("&")
   end
+
+  def get_rate_info_headers(limit, remaining, reset)
+      {
+              :x_rate_limit_limit => limit,
+              :x_rate_limit_remaining => remaining,
+              :x_rate_limit_reset => reset
+      }
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sailthru-client
 version: !ruby/object:Gem::Version
-  version: 4.0.7
+  version: 4.1.0
 platform: ruby
 authors:
 - Prajwal Tuladhar
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -153,6 +153,7 @@ files:
 - test/fixtures/template_save.json
 - test/fixtures/template_save_test_vars.json
 - test/fixtures/template_valid_get.json
+- test/fixtures/templates_get.json
 - test/fixtures/user_update_post_valid.json
 - test/fixtures/user_update_valid.json
 - test/sailthru/blast_test.rb
@@ -163,6 +164,7 @@ files:
 - test/sailthru/helpers_test.rb
 - test/sailthru/list_test.rb
 - test/sailthru/purchase_test.rb
+- test/sailthru/rate_info_test.rb
 - test/sailthru/receive_post_callback_test.rb
 - test/sailthru/send_test.rb
 - test/sailthru/stats_test.rb
@@ -233,6 +235,7 @@ test_files:
 - test/fixtures/template_save.json
 - test/fixtures/template_save_test_vars.json
 - test/fixtures/template_valid_get.json
+- test/fixtures/templates_get.json
 - test/fixtures/user_update_post_valid.json
 - test/fixtures/user_update_valid.json
 - test/sailthru/blast_test.rb
@@ -243,6 +246,7 @@ test_files:
 - test/sailthru/helpers_test.rb
 - test/sailthru/list_test.rb
 - test/sailthru/purchase_test.rb
+- test/sailthru/rate_info_test.rb
 - test/sailthru/receive_post_callback_test.rb
 - test/sailthru/send_test.rb
 - test/sailthru/stats_test.rb