affiliate_window 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 879c6696972ede3c678d902070ada3515332070a
-  data.tar.gz: 99fdd2cc8dcbc40799a681eb1dbe33e981c95e02
+  metadata.gz: 1f599f12f683a8242dc1e001853e42ed561102f8
+  data.tar.gz: c1d5e58a250b962fe56aa559e12afbcdb19d26eb
 SHA512:
-  metadata.gz: add29aba090cd27d2cb35652d4b8236c425538a84029b9008d9d34d9e5fd0fb4952b7ae62cce4b406469f3f4ebbb6ebc47a3d8efcd4fc44a30371f316d38c414
-  data.tar.gz: 20b094621c3c50d30c623ac5f1f24891b7f3139e9dd42bdea3bc77d85adc7578b4b50feae194dacd53ce7f888d8dacfee32054991f4f2584c8606a8b7c95f77b
+  metadata.gz: 3f57cd4ef2d9c07c0981eec18375789c3343fcbb5286ce661d7c390480ce8ec735bca2b4005767e3e7084aa44cebab56353b6959864581816e5e82c2b554f5f8
+  data.tar.gz: 10b9264d5c7c972bfbc6c13f4af6e7dfaa059512712a7d558b1fcc9ea29cafa614782af57d597bab69cbdfed56f0ae17cb73881ea111a6f1b530684a2637ddd9

data/README.md

@@ -55,6 +55,19 @@ response
 #  }
 ```
 
+## Quota
+
+The API provides a daily quota of 15,000 requests per account. The remaining
+quota is returned in the header of each response. If this quota is reached,
+subsequent requests to the API will raise errors.
+
+You can check the remaining quota with:
+
+```ruby
+client.remaining_quota
+#=> 14997
+```
+
 ## Debugging
 
 You can print the SOAP request bodies by enabling debug mode:

data/lib/affiliate_window/base.rb

@@ -2,7 +2,7 @@
 # http://wiki.affiliatewindow.com/index.php/Publisher_Service_API
 
 class AffiliateWindow
-  attr_accessor :client, :error_handler, :parser, :debug
+  attr_accessor :client, :error_handler, :parser, :debug, :remaining_quota
 
   def self.login(account_id:, affiliate_api_password:)
     client = Client.new(
@@ -114,6 +114,12 @@ class AffiliateWindow
     )
   end
 
+  def remaining_quota
+    @remaining_quota || raise(UnknownQuotaError,
+      "No requests have been made, so the remaining quota is unknown."
+    )
+  end
+
   private
 
   def call(method, params)
@@ -123,10 +129,14 @@ class AffiliateWindow
       client.call(method, params, debug)
     end
 
+    self.remaining_quota = parser.parse_quota(response)
+
     parser.parse(response, method)
   end
 
   def remove_nils(params)
     params.reject { |_, value| value.nil? }
   end
+
+  class UnknownQuotaError < StandardError; end
 end

data/lib/affiliate_window/client.rb

@@ -10,6 +10,7 @@ class AffiliateWindow
             "api:sPassword" => affiliate_api_password,
             "api:sType" => "affiliate",
           },
+          "api:getQuota" => true,
         },
       )
     end

data/lib/affiliate_window/parser.rb

@@ -13,5 +13,12 @@ class AffiliateWindow
         results
       end
     end
+
+    def self.parse_quota(response)
+      header = response.header
+      quota = header.fetch(:get_quota_response)
+
+      Integer(quota)
+    end
   end
 end

data/lib/affiliate_window/version.rb

@@ -1,3 +1,3 @@
 class AffiliateWindow
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: affiliate_window
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Reevoo Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-21 00:00:00.000000000 Z
+date: 2016-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon