mangopay 3.35.1 → 3.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15264b27e3c6d9543eb22df8793bb0fb37870aa19d6c12c5d9c41f7ae3e37f7a
-  data.tar.gz: 8333f909cf729a462acd645a4b68aa03a048a6490fe16881eb675a818e25a0c8
+  metadata.gz: ab053280c45aa0899adbc045b9448a52439934da351049f226ebd2eb1815354b
+  data.tar.gz: e9abd7fadd084609d8820bd1147baa2ca12a3ccc4bc52cb559441d3af259c61f
 SHA512:
-  metadata.gz: 2522a4843d777f4db554b7df2ab8c331d592155288fd641deaf17e19de28e426df70eeca7041e8007c9732aae4663c1fe93677d1c9a71fcb8244b7b8cf766490
-  data.tar.gz: 607684d9029548a5798d1274938f74d8c0fad61591d3ca68bf56a8a90247741d475a34ddb0dbe06c20def8f06810d6d3cdd6ceb47a75221086baf480cb30ec3b
+  metadata.gz: 7f418382b075cee36e01da7c7e6b766d6538561c082a78ba7c7f31dad0998f0deb77dccfffe7088530183ad80aaac85fe509452192f5564abebb840d404078e0
+  data.tar.gz: 36d54dd71d50dab4a573e0c06775a902471d24e904c0b6621634677309e4115f6e2d631ccde8e8b08525ad80f2acbb7342d9a0e330d0ff1768059f0a8b86d306

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [3.37.0] - 2025-06-24
+### Changed
+- `multi_json` library version updated to 1.15.0 (latest, release 2020) to enable compatibility with later versions of Ruby
+
+> ⚠️ **Caution - Breaking change**
+>
+> If you use version 1.7.7 (2013) of the `multi_json` [gem](https://rubygems.org/gems/multi_json/versions/1.15.0) in your project, you need to update to 1.15.0 to use this version v3.37.0 of the Mangopay Ruby SDK
+
+## [3.36.0] - 2025-06-24
+### Added
+
+[New Reporting Service](https://docs.mangopay.com/release-notes/api/2025-06-05) endpoints (#287 ):
+- [POST Create a Report](https://docs.mangopay.com/api-reference/reporting/create-report)
+- [GET View a Report](https://docs.mangopay.com/api-reference/reporting/view-report)
+- [GET List all Reports](https://docs.mangopay.com/api-reference/reporting/list-reports)
+
+Support for:
+- [GET List Disputes for a PayIn](https://docs.mangopay.com/api-reference/disputes/list-disputes-payin) (#287)
+- [GET List Transactions for a Card Fingerprint](https://docs.mangopay.com/api-reference/transactions/list-transactions-card-fingerprint) (#289)
+
 ## [3.35.1] - 2025-06-05
 ### Added
 - Support for `RecipientScope` query parameter on [GET List Recipients for a User](https://docs.mangopay.com/api-reference/recipients/list-recipients-user)

data/README.md

@@ -1,33 +1,25 @@
-# Mangopay Ruby SDK [![Build Status](https://travis-ci.org/Mangopay/mangopay2-ruby-sdk.svg?branch=master)](https://travis-ci.org/Mangopay/mangopay2-ruby-sdk)
+# Mangopay Ruby SDK
 
-The gem for interacting with the version 2 of the Mangopay API.
-See the [API documentation](http://docs.mangopay.com/api-references/)
-for more details on the API.
+[![Gem Version](https://badge.fury.io/rb/mangopay.svg)](https://rubygems.org/gems/mangopay) 
 
-Tested on the following versions of Ruby: 1.9.2, 1.9.3, 2.0.0 and 2.x up to 2.5
+Official [Mangopay Gem](https://rubygems.org/gems/mangopay) to access the [Mangopay API](https://docs.mangopay.com/api-reference) from applications written in Ruby.
 
-## NEWS
+See the [Mangopay API documentation](https://docs.mangopay.com/) for Ruby samples and details on product features. See the [SDK tests](#tests) for further usage examples.
 
-### Version 3.*
-**BREAKING CHANGES:** This version (3.\*) of the gem is targeting the Mangopay API Version 2. It has a brand new structure to make the api calls easier to use and is not backward compatible with 2.\* series.
+## Prerequisites
+- * A `ClientId` and an API key – if you don't have these, <a href="https://mangopay.com/contact" target="_blank">contact Sales</a> to get access to the <a href="https://hub.mangopay.com/" target="_blank">Mangopay Dashboard</a>
+- Ruby 1.9.2 or higher (tested from 1.9.2 up to 3.4.4)
 
-Since [v3.0.17](https://github.com/Mangopay/mangopay2-ruby-sdk/releases/tag/v3.0.17) of the SDK, you must be using at least v2.01 of the API (more information about the changes required [here](https://docs.mangopay.com/api-v2-01-overview/))
+Since SDK [v3.0.17](https://github.com/Mangopay/mangopay2-ruby-sdk/releases/tag/v3.0.17), the library uses v2.01 of the API. The older API version (v2) is no longer available.
 
-Account creation
--------------------------------------------------
-You can get yourself a free sandbox account or sign up for a production account by [registering on the Mangopay site](https://www.mangopay.com/start/) (note that validation of your production account involves several steps, so think about doing it in advance of when you actually want to go live).
-
-## Usage
-
-### Install
-* You can get yourself a free sandbox account or sign up for a production account [on the Mangopay site](https://www.mangopay.com/start/) (note that validation of your production account will involve several steps, so think about doing it in advance of when you actually want to go live).
+## Installation
 
 * Install the gem by either running ```gem install mangopay```
 or by adding it to your Gemfile ```gem 'mangopay'```
 
-* Using the credential info from the signup process above, call ```MangoPay.configure``` in your script as shown in the snippet below.
+* Call ```MangoPay.configure``` in your script as shown in the snippet below.
 
-### Examples
+### Usage
 
 ```ruby
 require 'mangopay'
@@ -85,8 +77,8 @@ rescue MangoPay::ResponseError => ex
 end
 ```
 
-### Using multiple clientIDs
-You can effortlessly create multiple configuration objects tailored to your specific needs:
+### Using multiple Client IDs 
+The Ruby SDK offers the option to create multiple configuration objects tailored to your specific needs:
 
 ```
 config = MangoPay::Configuration.new
@@ -94,18 +86,19 @@ config.client_id = 'your-client-id'
 config.client_apiKey = 'your-api-key'
 config.preproduction = true
 ```
-add them using :
+
+Add them using:
 
 `MangoPay.add_config('config1', config)`
 
-and perform a call with them using :
+And perform a call with them using:
 
 `MangoPay.get_config('config1').apply_configuration`
 
-The previous method configure() is still working.
+The previous method `configure()` is still working.
 
-### Accessing RateLimit Headers
-Along with each request, the rate limiting headers are automatically updated in MangoPay object:
+### Accessing rate limiting headers
+The API returns rate limiting headers which are automatically updated in the `MangoPay` object:
 
 * X-RateLimit-Limit
 * X-RateLimit-Remaining
@@ -121,18 +114,28 @@ Along with each request, the rate limiting headers are automatically updated in
   }
 ```
 
-Read more about rate limiting on [our documentation](https://docs.mangopay.com/guide/rate-limiting).
+For more information, see the [rate limiting](https://docs.mangopay.com/api-reference/overview/rate-limiting) article on the Mangopay docs.
 
 ### 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.
+You can enable logs by setting the ```log_file``` configuration option (see [usage](#usage) above). If you don't want logs, remove the ```log_file``` line.
 
 Requests and responses are filtered, so confidential data is not saved in logs.
 
 ### Tests
-Make sure that you have run: ```bundle install```
-Then you just have to run rspec ```rspec``` to run all the test suite.
-Feel free to report any test failure by creating an issue
-on the [Gem's Github](https://github.com/Mangopay/mangopay2-ruby-sdk/issues)
+Make sure that you have run: 
+```
+bundle install
+```
+Then to run the test suite, run: 
+```
+rspec
+```
+
+## Issues
+
+Create a [GitHub issue](https://github.com/Mangopay/mangopay2-ruby-sdk/issues) to report any problems or request features.
+
+We aim to reply to issues and contributions in a timely manner. For additional followup or anything that can't be shared over GitHub, please get in touch with our Support teams via the <a href="https://hub.mangopay.com/" target="_blank">Mangopay Dashboard</a>.
 
 ## Contributing
 
@@ -149,10 +152,6 @@ a test!
 
 5. Push to your fork and submit a pull request.
 
-At this point you're waiting on us. We like to at least comment on, if not
-accept, pull requests within three business days (and, typically, one business
-day). We may suggest some changes or improvements or alternatives.
-
 Syntax:
 
 * Two spaces, no tabs.
@@ -160,9 +159,4 @@ Syntax:
 * Prefer &&/|| over and/or.
 * MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
 * a = b and not a=b.
-* Follow the conventions you see used in the source already.
-
-A contribution can also be as simple as a +1 on issues tickets to show us
-what you would like to see in this gem.
-
-That's it for now. Good Hacking...
+* Follow the conventions you see used in the source already.

data/lib/mangopay/card.rb

@@ -45,6 +45,10 @@ module MangoPay
         url = "#{MangoPay.api_path}/cards/#{card_id}/validation/#{validation_id}"
         MangoPay.request(:get, url)
       end
+
+      def get_transactions_by_fingerprint(fingerprint, filters = {})
+        MangoPay.request(:get, "#{fingerprint_url(fingerprint)}/transactions", {}, filters)
+      end
     end
   end
 end

data/lib/mangopay/dispute.rb

@@ -40,6 +40,11 @@ module MangoPay
         MangoPay.request(:get, url, {}, filters)
       end
 
+      def fetch_for_pay_in(pay_in_id, filters = {})
+        url = "#{MangoPay.api_path}/payins/#{pay_in_id}/disputes"
+        MangoPay.request(:get, url, {}, filters)
+      end
+
       def fetch_pending_settlement(filters = {})
         url = "#{MangoPay.api_path}/disputes/pendingsettlement"
         MangoPay.request(:get, url, {}, filters)

data/lib/mangopay/report_v2.rb

@@ -0,0 +1,21 @@
+module MangoPay
+
+  # See https://docs.mangopay.com/endpoints/v2.01/reporting
+  class ReportV2 < Resource
+
+    class << self
+      def create(params, idempotency_key = nil)
+        MangoPay.request(:post, "#{MangoPay.api_path}/reporting/reports", params, {}, idempotency_key)
+      end
+
+      def get(id)
+        MangoPay.request(:get, "#{MangoPay.api_path}/reporting/reports/#{id}")
+      end
+
+      def get_all(params = nil)
+        MangoPay.request(:get, "#{MangoPay.api_path}/reporting/reports", params)
+      end
+
+    end
+  end
+end

data/lib/mangopay/version.rb

@@ -1,3 +1,3 @@
 module MangoPay
-  VERSION = '3.35.1'
+  VERSION = '3.37.0'
 end

data/lib/mangopay.rb

@@ -38,6 +38,7 @@ module MangoPay
   autoload :Dispute, 'mangopay/dispute'
   autoload :Mandate, 'mangopay/mandate'
   autoload :Report, 'mangopay/report'
+  autoload :ReportV2, 'mangopay/report_v2'
   autoload :JSON, 'mangopay/json'
   autoload :AuthorizationToken, 'mangopay/authorization_token'
   autoload :FilterParameters, 'mangopay/filter_parameters'

data/mangopay.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 1.9.2'
 
-  s.add_dependency('multi_json', '>= 1.7.7')
+  s.add_dependency('multi_json', '>= 1.15.0')
 
-  s.add_development_dependency('rake', '>= 10.1.0')
-  s.add_development_dependency('rspec', '>= 3.0.0')
+  s.add_development_dependency('rake', '>= 13.2.1')
+  s.add_development_dependency('rspec', '>= 3.13.0')
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- spec/*`.split("\n")

data/spec/mangopay/card_registration_spec.rb

@@ -107,4 +107,17 @@ describe MangoPay::CardRegistration do
       expect(card_validation['Id']).equal? fetched_card_validation['Id']
     end
   end
+
+  describe 'Get transactions by card fingerprint' do
+    it 'retrieves list of transactions for a fingerprint' do
+      completed = new_card_registration_completed
+      card_id = completed['CardId']
+      card = MangoPay::Card.fetch(card_id)
+      fingerprint = card['Fingerprint']
+      result = MangoPay::Card.get_transactions_by_fingerprint(fingerprint)
+
+      expect(result).to be_kind_of(Array)
+      expect(result.count).to be > 0
+    end
+  end
 end

data/spec/mangopay/dispute_spec.rb

@@ -49,14 +49,17 @@ and it's infact not suitable like that
       expect(disputes).not_to be_empty
     end
     it 'fetches disputes for wallet' do
-      dispute = @disputes.find {|disp| disp['InitialTransactionId'] != nil}
-      expect(dispute).not_to be_nil, "Cannot test fetching disputes for wallet because there's no disputes with transaction ID in the disputes list."
-      payin = MangoPay::PayIn.fetch(dispute['InitialTransactionId'])
+      payin = MangoPay::PayIn.fetch("133379281")
       wallet_id = payin['CreditedWalletId']
       disputes = MangoPay::Dispute.fetch_for_wallet(wallet_id, {'per_page' => 1})
       expect(disputes).to be_kind_of(Array)
       expect(disputes).not_to be_empty
     end
+    it 'fetches disputes for payin' do
+      disputes = MangoPay::Dispute.fetch_for_pay_in("133379281", {'per_page' => 1})
+      expect(disputes).to be_kind_of(Array)
+      expect(disputes).not_to be_empty
+    end
   end
 
   describe 'UPDATE' do

data/spec/mangopay/recipient_spec.rb

@@ -5,7 +5,7 @@ describe MangoPay::Recipient do
     it 'creates a new recipient' do
       recipient = new_recipient
       assert_recipient(recipient)
-      expect(recipient['PendingUserAction']).not_to be_nil
+      expect(recipient['Status']).to eq('PENDING')
     end
   end
 
@@ -19,7 +19,7 @@ describe MangoPay::Recipient do
 
   describe 'GET User Recipients' do
     it 'fetches recipients without query param' do
-      john = create_new_natural_user_sca_owner
+      john = create_new_natural_user_sca_payer
       create_new_recipient(john['Id'])
       fetched = MangoPay::Recipient.get_user_recipients(john['Id'])
       expect(fetched).not_to be_nil
@@ -28,7 +28,7 @@ describe MangoPay::Recipient do
     end
 
     it 'fetches recipients with scope PAYOUT' do
-      john = create_new_natural_user_sca_owner
+      john = create_new_natural_user_sca_payer
       create_new_recipient(john['Id'])
       fetched = MangoPay::Recipient.get_user_recipients(john['Id'], {RecipientScope: "PAYOUT"})
       expect(fetched).not_to be_nil
@@ -37,7 +37,7 @@ describe MangoPay::Recipient do
     end
 
     it 'fetches recipients with scope PAYIN' do
-      john = create_new_natural_user_sca_owner
+      john = create_new_natural_user_sca_payer
       create_new_recipient(john['Id'])
       fetched = MangoPay::Recipient.get_user_recipients(john['Id'], {RecipientScope: "PAYIN"})
       expect(fetched).not_to be_nil
@@ -92,7 +92,7 @@ describe MangoPay::Recipient do
   describe 'VALIDATE' do
     it 'validates a recipient' do
       recipient = define_new_recipient
-      john = create_new_natural_user_sca_owner
+      john = create_new_natural_user_sca_payer
       # it should pass
       MangoPay::Recipient.validate(recipient, john['Id'])
 

data/spec/mangopay/report_v2_spec.rb

@@ -0,0 +1,38 @@
+describe MangoPay::ReportV2 do
+
+  def create
+    params = {
+      "Tag": "Created using the Mangopay API Postman collection",
+      "DownloadFormat": "CSV",
+      "ReportType": "COLLECTED_FEES",
+      "AfterDate": 1740787200,
+      "BeforeDate": 1743544740
+    }
+    MangoPay::ReportV2.create(params)
+  end
+
+  describe 'CREATE' do
+    it 'creates a report v2' do
+      created = create
+      expect(created['Id']).to_not be_nil
+      expect(created['Status']).to eq("PENDING")
+    end
+  end
+
+  describe 'GET' do
+
+    it 'gets a report' do
+      created = create
+      fetched = MangoPay::ReportV2.get(created['Id'])
+      expect(fetched['Id']).to eq(created['Id'])
+    end
+
+    it 'gets all the reports' do
+      reports = MangoPay::ReportV2.get_all
+      expect(reports).to be_kind_of(Array)
+      expect(reports).not_to be_empty
+    end
+
+  end
+
+end

data/spec/mangopay/shared_resources.rb

@@ -1273,7 +1273,7 @@ end
 shared_context 'recipient' do
   include_context 'users'
 
-  let(:new_recipient) { create_new_recipient(create_new_natural_user_sca_owner['Id']) }
+  let(:new_recipient) { create_new_recipient(create_new_natural_user_sca_payer['Id']) }
 
   def create_new_recipient(user_id)
     MangoPay::Recipient.create(define_new_recipient, user_id)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mangopay
 version: !ruby/object:Gem::Version
-  version: 3.35.1
+  version: 3.37.0
 platform: ruby
 authors:
 - Geoffroy Lorieux
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-05 00:00:00.000000000 Z
+date: 2025-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -17,42 +17,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 1.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 13.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 13.2.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.13.0
 description: |2
     The mangopay Gem makes interacting with MANGOPAY Services much easier.
     For any questions regarding the use of MANGOPAY's Services feel free to contact us at http://www.mangopay.com/get-started-2/
@@ -106,6 +106,7 @@ files:
 - lib/mangopay/refund.rb
 - lib/mangopay/regulatory.rb
 - lib/mangopay/report.rb
+- lib/mangopay/report_v2.rb
 - lib/mangopay/resource.rb
 - lib/mangopay/transaction.rb
 - lib/mangopay/transfer.rb
@@ -166,6 +167,7 @@ files:
 - spec/mangopay/refund_spec.rb
 - spec/mangopay/regulatory_spec.rb
 - spec/mangopay/report_spec.rb
+- spec/mangopay/report_v2_spec.rb
 - spec/mangopay/report_wallets_spec.rb
 - spec/mangopay/shared_resources.rb
 - spec/mangopay/transaction_spec.rb
@@ -251,6 +253,7 @@ test_files:
 - spec/mangopay/refund_spec.rb
 - spec/mangopay/regulatory_spec.rb
 - spec/mangopay/report_spec.rb
+- spec/mangopay/report_v2_spec.rb
 - spec/mangopay/report_wallets_spec.rb
 - spec/mangopay/shared_resources.rb
 - spec/mangopay/transaction_spec.rb