mangopay 3.0.27 → 3.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96bc27cb89ac223b63f92df2b3829e9916b88783
-  data.tar.gz: eff362d7ca2ca3678a37ca0a8aacc3297c26c2aa
+  metadata.gz: 879da1ad5c54a140ae4e9b9349ad40d72e44e8af
+  data.tar.gz: 774607d7039aff485fa77244f1d932eebfb5d32e
 SHA512:
-  metadata.gz: 9f544a5e67d734e3aab210e388ae2307fa087856a9acc142aafc2b598fa94a086a95896ae8ddce70a077695b8a1ead6168fbb5ca17a6acf15a5c41ca7e64414f
-  data.tar.gz: 84aa434caaf6d4144d986ca711ca310c337f2761fe0ea59bee93ecdc13d1abf067c2dee5ca057787c36a76c4c9a7663e2b971aa8d7305d1e53c75d5db0c2105e
+  metadata.gz: 1c4ae1839b1b35a570d22f92cc1eea8453623dc28f946a09836ab2e90cd95744c3d89d7dd8b42f9df60aec6749586c3fad5ea677a491d748a119dcb9106417ea
+  data.tar.gz: 192a9df0d3376c343b7fa85ebae21e710f0d59b2307e99f8d4864f0335a7f12535106565d80caa7873d6ed273c1ed97ae9d822928b57ed8185d53dd287c3e005

data/README.md

@@ -84,6 +84,25 @@ rescue MangoPay::ResponseError => ex
 end
 ```
 
+### Accessing RateLimit Headers
+Along with each request, the rate limiting headers are automatically updated in MangoPay object:
+
+* X-RateLimit-Limit
+* X-RateLimit-Remaining
+* X-RateLimit-Reset
+
+```
+  MangoPay.ratelimit
+
+  {
+    :limit=>["74", "74", "75", "908"], 
+    :remaining=>["2226", "4426", "8725", "104692"], 
+    :reset=>["1495615620", "1495616520", "1495618320", "1495701060"]
+  }
+```
+
+Read more about rate limiting on [our documetiation](https://docs.mangopay.com/guide/rate-limiting).
+
 ### Log requests and responses
 You can easily enable logs by setting the ```log_file``` configuration option (see the section **configuration** above). If you don't want logs, remove the ```log_file``` line.
 

data/lib/mangopay.rb

@@ -99,6 +99,14 @@ module MangoPay
       MangoPay.configuration = original_config
     end
 
+    def ratelimit
+      @ratelimit
+    end
+
+    def ratelimit=(obj)
+      @ratelimit = obj
+    end
+
     #
     # - +method+: HTTP method; lowercase symbol, e.g. :get, :post etc.
     # - +url+: the part after Configuration#root_url
@@ -139,6 +147,14 @@ module MangoPay
         filters[k.gsub('x-number-of-', 'total_')] = res[k].to_i if res[k]
       }
 
+      if res['x-ratelimit']
+        self.ratelimit = {
+          limit: res['x-ratelimit'].split(", "),
+          remaining: res['x-ratelimit-remaining'].split(", "),
+          reset: res['x-ratelimit-reset'].split(", ")
+        } 
+      end
+
       data
     end
 

data/lib/mangopay/report.rb

@@ -8,7 +8,14 @@ module MangoPay
 
       # +params+: hash; see https://docs.mangopay.com/endpoints/v2.01/reporting#e825_create-a-transaction-report
       def create(params, idempotency_key = nil)
-        url = url() + '/transactions/'
+        if params[:ReportType] == 'transactions'
+          url = url() + '/transactions/'
+        elsif params[:ReportType] == 'wallets'
+          url = url() + '/wallets/'
+        else
+          raise 'When creating a report, ReportType is required. Ex: ("transactions", "wallets")'
+        end
+
         MangoPay.request(:post, url, params, {}, idempotency_key)
       end
 

data/lib/mangopay/version.rb

@@ -1,3 +1,3 @@
 module MangoPay
-  VERSION = '3.0.27'
+  VERSION = '3.0.28'
 end

data/spec/mangopay/report_spec.rb

@@ -8,7 +8,8 @@ describe MangoPay::Report do
       Sort: 'CreationDate:DESC',
       Preview: false,
       Filters: {},
-      Columns: [ 'Id', 'CreationDate' ]
+      Columns: [ 'Id', 'CreationDate' ],
+      ReportType: 'transactions'
     }
     MangoPay::Report.create(params)
   end

data/spec/mangopay/report_wallets_spec.rb

@@ -0,0 +1,40 @@
+describe MangoPay::Report do
+
+  def create
+    params = {
+      Tag: 'custom meta',
+      CallbackURL: 'http://www.my-site.com/callbackURL/',
+      DownloadFormat: 'CSV',
+      Sort: 'CreationDate:DESC',
+      Preview: false,
+      Filters: {},
+      Columns: [ 'Id', 'CreationDate' ],
+      ReportType: 'wallets'
+    }
+    MangoPay::Report.create(params)
+  end
+
+  describe 'CREATE' do
+    it 'creates a report' do
+      created = create
+      expect(created['Id']).to_not be_nil
+    end
+  end
+
+  describe 'FETCH' do
+
+    it 'fetches a report' do
+      created = create
+      fetched = MangoPay::Report.fetch(created['Id'])
+      expect(fetched['Id']).to eq(created['Id'])
+    end
+
+    it 'fetches all the reports' do
+      reports = MangoPay::Report.fetch()
+      expect(reports).to be_kind_of(Array)
+      expect(reports).not_to be_empty
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mangopay
 version: !ruby/object:Gem::Version
-  version: 3.0.27
+  version: 3.0.28
 platform: ruby
 authors:
 - Geoffroy Lorieux
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-05 00:00:00.000000000 Z
+date: 2017-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -131,6 +131,7 @@ files:
 - spec/mangopay/preauthorization_spec.rb
 - spec/mangopay/refund_spec.rb
 - spec/mangopay/report_spec.rb
+- spec/mangopay/report_wallets_spec.rb
 - spec/mangopay/shared_resources.rb
 - spec/mangopay/transaction_spec.rb
 - spec/mangopay/transfer_spec.rb
@@ -191,6 +192,7 @@ test_files:
 - spec/mangopay/preauthorization_spec.rb
 - spec/mangopay/refund_spec.rb
 - spec/mangopay/report_spec.rb
+- spec/mangopay/report_wallets_spec.rb
 - spec/mangopay/shared_resources.rb
 - spec/mangopay/transaction_spec.rb
 - spec/mangopay/transfer_spec.rb