currency_cloud 0.10.0 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ebec99730dd5705d4cf2c166f6df611617818e42
-  data.tar.gz: 397acffa929fd40cf630618f28540497bafd53e9
+SHA256:
+  metadata.gz: a3d86d137b05ff91df7c4347269163febf64ef026b7937aa85bfa1e5c005415a
+  data.tar.gz: d02b48b511db91cf9123b35db168d14bfba85d55a52b8b30342f6faf5b5bbc76
 SHA512:
-  metadata.gz: ff21d17e42f741459e92125e8551a6b93f5e9ee37d59af9dddd24182cbfbc185b9491fc6b39b9564ab94afcd1491ebc502e35ca2fa8019bcd88249a78b448394
-  data.tar.gz: 1e69916dc9465acbeadfead6d459c097b1281066ca984a2916d11678473e6a1a7390a2bb60c1e28ba5cceb8e19dd0726d82c70b79d69ddb952305ae0b824baf4
+  metadata.gz: 6e703590da55833c1ae5a04f5ba8a8ab2abb243ae2d9d459023d8d2a2a03467ea4c0fc1f57c11a9f21be6ed54db0b3ca1e964d245b1fc1195762b0287a91db9c
+  data.tar.gz: ff6b0dc8a71a8236afaddf54700f935d27530f19db5d1b0634600c99967c945137e4688fd48fd5a8caa1c04cf08606fa53a1b62cd907dd269938a6466f1b5d68

data/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+### **We welcome pull requests from everyone!**
+
+By making a contribution to this project, you certify that:
+
+**(1)** The contribution was created in whole or in part by you and you have the right to submit it under the [MIT License (MIT)][MIT]; or
+
+**(2)** The contribution is based upon previous work that, to the best of your knowledge, is covered under the MIT or an MIT compatible open source license and you have the right under that license to submit that work with modifications, whether created in whole or in part by you; or
+
+**(3)** The contribution was provided directly to you by some other person who certified **(1)**, **(2)** or **(3)** and you have not modified it.
+
+**(4)** You are not expected to provide support for the contribution, except to the extent you desire to provide support. You may provide support for free, for a fee, or not at all.
+
+**(5)** You understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information you submit with it, including your sign-off)
+is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
+
+## Steps
+**1. Fork, then clone the repo:**
+```Shell
+	git clone git@github.com:your-username/currencycloud-ruby.git
+```
+
+**2. Work on your changes:**
+- Make your change.
+- Add tests for your change.
+- Make commits of logical and atomic units.
+- Check for unnecessary whitespace with `git diff --check` before committing.
+- *nix users, verify file and directory permissions are 644 and 755 respectively before committing.
+- Ensure your commit messages are clear, brief and to the point.
+- If the commit fixes a bug, create an [issue][iss] and include the issue number in the commit message.
+
+**3. Make sure ALL the tests pass:**
+```Shell
+	bundle exec rspec
+```
+
+**4. Push to your fork and [submit a pull request][pr] across forks.**
+
+**5. At this point you're waiting on us.** We like to at least comment on pull requests within a week, but sometimes we may take longer. We may suggest some changes, improvements or alternatives. We may decline your contribution but we will explain our reasons. In all cases, the maintainer's decision is final.
+
+Some things that will increase the chance that your pull request is accepted, in karma order:
+- changes that are cosmetic in nature, or do not add anything substantial to the stability, functionality, or testability of the SDK will generally not be accepted.
+- add tests for your changes and ensure **all** tests pass. The first thing our maintainers check on every pull request is whether Travis has given the All-OK. If there are valid reasons why the tests cannot pass, make your case in the comments section.
+- follow the SDK's code style. Start reading our code and you'll get the hang of it. We try to optimize for readability which in turn leads to maintainability.
+- don't change the SDK's version number. Our maintainers will assign one upon commit.
+- don't add your name to the build. Our maintainers will include you in our [Hall of Fame][hof] upon commit, unless you **explicitly** tell us not to.
+
+## Acknowledgement
+Our sincere thanks for helping us create the best API for moving money anywhere around the world!
+
+[MIT]: LICENSE.md
+[iss]: https://github.com/CurrencyCloud/currencycloud-ruby/issues
+[pr]:  https://github.com/CurrencyCloud/currencycloud-ruby/compare
+[hof]: HALL_OF_FAME.md

data/HALL_OF_FAME.md

@@ -0,0 +1,15 @@
+# Hall of Fame
+### **Moving money shouldn’t be hard**
+Here at [Currencycloud][ccy] we are totally committed to remove the complexity and red tape of international payments so that our customers can focus on delivering a great experience for their customers.
+
+Just as it takes a village to raise a child, it takes a community of people volunteering their time, knowledge and skills to help us further develop our SDKs to levels of quality and usability that otherwise would be very difficult to achieve completely on our own.
+
+Many people have helped us along the way and we are sincerely grateful to all of them but we would like to single out, and in a small way honour, the following individuals for their meaningful contributions (listed in alphabetical order):
+
+|Name|Link/e-mail|
+|--|--|
+
+ In our book, they have reached [**honorificabilitudinitatibus**][sesqui] :-)
+
+[ccy]: https://www.currencycloud.com/
+[sesqui]: https://en.wikipedia.org/wiki/Honorificabilitudinitatibus

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2018 Currencycloud
+Copyright (c) 2015-2019 Currencycloud
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -130,6 +130,11 @@ error in any correspondence can be very helpful.
 Test cases can be run with: `bundle exec rspec`. There is also a `Guardfile` that
 is useful for continuously rerunning tests while you develop.
 
+## Contributing
+**We welcome pull requests from everyone!** Please see [CONTRIBUTING][contr]
+
+Our sincere thanks for [helping us][hof] create the best API for moving money anywhere around the world!
+
 ## Dependencies
 
 * [HTTParty][httparty]
@@ -141,9 +146,28 @@ This project uses [semantic versioning][semver]. You can safely
 express a dependency on a major version and expect all minor and patch versions
 to be backwards compatible.
 
+## Deprecation Policy
+Technology evolves quickly and we are always looking for better ways to serve our customers. From time to time we need to make room for innovation by removing sections of code that are no longer necessary. We understand this can be disruptive and consequently we have designed a Deprecation Policy that protects our customers' investment and that allows us to take advantage of modern tools, frameworks and practices in developing software.
+
+Deprecation means that we discourage the use of a feature, design or practice because it has been superseded or is no longer considered efficient or safe but instead of removing it immediately, we mark it as **@deprecated** to provide backwards compatibility and time for you to update your projects. While the deprecated feature remains in the SDK for a period of time, we advise that you replace it with the recommended alternative which is explained in the relevant section of the code.
+
+We remove deprecated features after **three months** from the time of announcement.
+
+The security of our customers' assets is of paramount importance to us and sometimes we have to deprecate features because they may pose a security threat or because new, more secure, ways are available. On such occasions we reserve the right to set a different deprecation period which may range from **immediate removal** to the standard **three months**. 
+
+Once a feature has been marked as deprecated, we no longer develop the code or implement bug fixes. We only do security fixes.
+
+### List of features being deprecated
+```
+(No features are currently being deprecated)
+```
+
+# Support
+We actively support the latest version of the SDK. We support the immediate previous version on best-efforts basis. All other versions are no longer supported nor maintained.
+
 # Copyright
 
-Copyright (c) 2016 Currencycloud. See [LICENSE][license] for details.
+Copyright (c) 2016-2019 Currencycloud. See [LICENSE][license] for details.
 
 [developer]: https://developer.currencycloud.com/documentation/getting-started/introduction/
 [travis]:    https://travis-ci.org/CurrencyCloud/currencycloud-ruby
@@ -153,3 +177,5 @@ Copyright (c) 2016 Currencycloud. See [LICENSE][license] for details.
 [json]:      https://github.com/intridea/multi_json
 [semver]:    http://semver.org/
 [license]:   LICENSE.md
+[contr]:     CONTRIBUTING.md
+[hof]:       HALL_OF_FAME.md

data/lib/currency_cloud/bank_details.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class BankDetails
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/conversion.rb

@@ -19,5 +19,30 @@ module CurrencyCloud
       attrs = client.post("#{id}/split", params)
       ConversionSplitResult.new(attrs)
     end
+
+    def self.retrieve_profit_and_loss(params = {})
+      attrs = client.get("profit_and_loss", params)
+      ConversionProfitAndLoss.new(attrs)
+    end
+
+    def date_change_quote(params)
+      attrs = client.get("#{id}/date_change_quote", params)
+      ConversionDateChangeQuoteResult.new(attrs)
+    end
+
+    def split_preview(params)
+      attrs = client.get("#{id}/split_preview", params)
+      ConversionSplitPreviewResult.new(attrs)
+    end
+
+    def split_history
+      attrs = client.get("#{id}/split_history")
+      ConversionSplitHistoryResult.new(attrs)
+    end
+
+    def cancellation_quote
+      attrs = client.get("#{id}/cancellation_quote")
+      ConversionCancellationQuoteResult.new(attrs)
+    end
   end
 end

data/lib/currency_cloud/conversion_cancellation_quote_result.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class ConversionCancellationQuoteResult
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/conversion_date_change_quote_result.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class ConversionDateChangeQuoteResult
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/conversion_profit_and_loss.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class ConversionProfitAndLoss
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/conversion_report_result.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class ConversionReportResult
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/conversion_split_history_result.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class ConversionSplitHistoryResult
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/conversion_split_preview_result.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class ConversionSplitPreviewResult
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/find_report_requests_result.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class FindReportRequestsResult
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/payment.rb

@@ -14,5 +14,15 @@ module CurrencyCloud
       result = client.post("authorise", payment_ids: ids)['authorisations']
       result.map { |pa| PaymentAuthorisationResult.new(pa) }
     end
+
+    def confirmation(params = {})
+      result = client.get("#{id}/confirmation", params)
+      PaymentConfirmationResult.new(result)
+    end
+
+    def self.payment_delivery_date(params)
+      result = client.get("payment_delivery_date", params)
+      PaymentDeliveryDateResult.new(result)
+    end
   end
 end

data/lib/currency_cloud/payment_confirmation_result.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CurrencyCloud
+  class PaymentConfirmationResult
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/payment_delivery_date_result.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class PaymentDeliveryDateResult
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/payment_report_result.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class PaymentReportResult
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/reference.rb

@@ -37,5 +37,11 @@ module CurrencyCloud
       response = client.get('settlement_accounts', params)
       response['settlement_accounts'].map { |s| SettlementAccount.new(s) }
     end
+
+    def self.bank_details(params = {})
+      bank_details = client.get('bank_details', params)
+      BankDetails.new(bank_details)
+    end
+
   end
 end

data/lib/currency_cloud/report_request_result.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class ReportRequestResult
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/reports.rb

@@ -0,0 +1,28 @@
+module CurrencyCloud
+  class Reports
+    include CurrencyCloud::Resource
+
+    resource :reports
+    actions :create, :retrieve
+
+    def self.create_conversions_report(params = {})
+      response = client.post('conversions/create', params)
+      ConversionReportResult.new(response)
+    end
+
+    def self.create_payments_report(params = {})
+      response = client.post('payments/create', params)
+      PaymentReportResult.new(response)
+    end
+
+    def self.find_report_requests(params = {})
+      response = client.get('report_requests/find', params)
+      FindReportRequestsResult.new(response)
+    end
+
+    def self.retrieve_report_request(report_id, params = {})
+      response = client.get("report_requests/#{report_id}", params)
+      ReportRequestResult.new(response)
+    end
+  end
+end

data/lib/currency_cloud/sender.rb

@@ -0,0 +1,8 @@
+module CurrencyCloud
+  class Sender
+    include CurrencyCloud::Resource
+
+    resource :sender
+    actions :retrieve
+  end
+end

data/lib/currency_cloud/sender_details_result.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CurrencyCloud
+  class SenderDetailsResult
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/transaction.rb

@@ -4,5 +4,10 @@ module CurrencyCloud
 
     resource :transactions
     actions :retrieve, :find
+
+    def self.retrieve_sender_details(sender_id)
+      response = client.get("sender/#{sender_id}")
+      SenderDetailsResult.new(response)
+    end
   end
 end

data/lib/currency_cloud/version.rb

@@ -2,5 +2,5 @@
 
 module CurrencyCloud
   API_VERSION = 'v2'.freeze # API Version
-  VERSION = '0.10.0'.freeze # Gem Version
+  VERSION = '0.11.2'.freeze # Gem Version
 end

data/spec/integration/conversions_spec.rb

@@ -91,4 +91,124 @@ describe 'Conversions', vcr: true do
     expect(split_conversion.child_conversion['conversion_date']).to eq('2018-07-18T00:00:00+00:00')
     expect(split_conversion.child_conversion['status']).to eq('awaiting_funds')
   end
+
+  it 'can #retrieve_profit_and_loss' do
+    profit_and_loss = CurrencyCloud::Conversion.retrieve_profit_and_loss()
+
+    expect(profit_and_loss.conversion_profit_and_losses[0]['account_id']).to eq('72970a7c-7921-431c-b95f-3438724ba16f')
+    expect(profit_and_loss.conversion_profit_and_losses[0]['contact_id']).to eq('a66ca63f-e668-47af-8bb9-74363240d781')
+    expect(profit_and_loss.conversion_profit_and_losses[0]['event_account_id']).to eq(nil)
+    expect(profit_and_loss.conversion_profit_and_losses[0]['event_contact_id']).to eq(nil)
+    expect(profit_and_loss.conversion_profit_and_losses[0]['conversion_id']).to eq('515eaa18-0756-42b9-9899-49bfea5d3e8a')
+    expect(profit_and_loss.conversion_profit_and_losses[0]['event_type']).to eq('self_service_cancellation')
+    expect(profit_and_loss.conversion_profit_and_losses[0]['amount']).to eq('-0.01')
+    expect(profit_and_loss.conversion_profit_and_losses[0]['currency']).to eq('GBP')
+
+    expect(profit_and_loss.conversion_profit_and_losses[1]['account_id']).to eq('72970a7c-7921-431c-b95f-3438724ba16f')
+    expect(profit_and_loss.conversion_profit_and_losses[1]['contact_id']).to eq('a66ca63f-e668-47af-8bb9-74363240d781')
+    expect(profit_and_loss.conversion_profit_and_losses[1]['event_account_id']).to eq(nil)
+    expect(profit_and_loss.conversion_profit_and_losses[1]['event_contact_id']).to eq(nil)
+    expect(profit_and_loss.conversion_profit_and_losses[1]['conversion_id']).to eq('10c79aba-a9ee-41c2-b0ce-89a0941a8599')
+    expect(profit_and_loss.conversion_profit_and_losses[1]['event_type']).to eq('self_service_cancellation')
+    expect(profit_and_loss.conversion_profit_and_losses[1]['amount']).to eq('-0.01')
+    expect(profit_and_loss.conversion_profit_and_losses[1]['currency']).to eq('GBP')
+    end
+
+  it 'can retrieve #date_change_quote' do
+    new_settlement_date = '2018-11-29'
+    conversion = CurrencyCloud::Conversion.create(conversion_params)
+
+    date_change_quote = conversion.date_change_quote(new_settlement_date: new_settlement_date)
+
+    expect(date_change_quote.conversion_id).to eq('d391e0a1-2643-44ff-b063-bbe39c98a2b5')
+    expect(date_change_quote.amount).to eq('-0.01')
+    expect(date_change_quote.currency).to eq('GBP')
+    expect(date_change_quote.new_conversion_date).to eq('2018-11-20T00:00:00+00:00')
+    expect(date_change_quote.new_settlement_date).to eq('2018-11-20T16:30:00+00:00')
+    expect(date_change_quote.old_conversion_date).to eq('2018-11-19T00:00:00+00:00')
+    expect(date_change_quote.old_settlement_date).to eq('2018-11-19T16:30:00+00:00')
+    expect(date_change_quote.event_date_time).to eq('2018-11-15T14:08:01+00:00')
+  end
+
+  it 'can #split_preview' do
+    conversion = CurrencyCloud::Conversion.create(conversion_params)
+
+    split_preview = conversion.split_preview(amount: 100)
+
+    expect(split_preview.parent_conversion['id']).to eq('b401a1bc-ba02-4bd6-920e-8bf6fd97282b')
+    expect(split_preview.parent_conversion['short_reference']).to eq('20180622-XCRNWB')
+    expect(split_preview.parent_conversion['sell_amount']).to eq('70.93')
+    expect(split_preview.parent_conversion['sell_currency']).to eq('GBP')
+    expect(split_preview.parent_conversion['buy_amount']).to eq('100.00')
+    expect(split_preview.parent_conversion['buy_currency']).to eq('USD')
+    expect(split_preview.parent_conversion['settlement_date']).to eq('2018-07-02T15:30:00+00:00')
+    expect(split_preview.parent_conversion['conversion_date']).to eq('2018-07-02T00:00:00+00:00')
+    expect(split_preview.parent_conversion['status']).to eq('awaiting_funds')
+
+    expect(split_preview.child_conversion['id']).to eq('13575890-f1a3-466d-81ce-f9444d2816a7')
+    expect(split_preview.child_conversion['short_reference']).to eq('20180622-GXWQPV')
+    expect(split_preview.child_conversion['sell_amount']).to eq('35.46')
+    expect(split_preview.child_conversion['sell_currency']).to eq('GBP')
+    expect(split_preview.child_conversion['buy_amount']).to eq('50.00')
+    expect(split_preview.child_conversion['buy_currency']).to eq('USD')
+    expect(split_preview.child_conversion['settlement_date']).to eq('2018-07-02T15:30:00+00:00')
+    expect(split_preview.child_conversion['conversion_date']).to eq('2018-07-02T00:00:00+00:00')
+    expect(split_preview.child_conversion['status']).to eq('awaiting_funds')
+  end
+
+  it 'can #split_history' do
+    conversion = CurrencyCloud::Conversion.create(conversion_params)
+
+    split_history = conversion.split_history
+
+    expect(split_history.parent_conversion['id']).to eq('24d2ee7f-c7a3-4181-979e-9c58dbace992')
+    expect(split_history.parent_conversion['short_reference']).to eq('20180716-XMXMMS')
+    expect(split_history.parent_conversion['sell_amount']).to eq('2417.10')
+    expect(split_history.parent_conversion['sell_currency']).to eq('GBP')
+    expect(split_history.parent_conversion['buy_amount']).to eq('3000.00')
+    expect(split_history.parent_conversion['buy_currency']).to eq('EUR')
+    expect(split_history.parent_conversion['settlement_date']).to eq('2018-06-28T13:00:00+00:00')
+    expect(split_history.parent_conversion['conversion_date']).to eq('2018-06-28T00:00:00+00:00')
+    expect(split_history.parent_conversion['status']).to eq('awaiting_funds')
+
+    expect(split_history.origin_conversion['id']).to eq('9d7919b5-c72d-41e1-9745-d2d5dc35e338')
+    expect(split_history.origin_conversion['short_reference']).to eq('20180626-YVRVTT')
+    expect(split_history.origin_conversion['sell_amount']).to eq('3222.80')
+    expect(split_history.origin_conversion['sell_currency']).to eq('GBP')
+    expect(split_history.origin_conversion['buy_amount']).to eq('4000.00')
+    expect(split_history.origin_conversion['buy_currency']).to eq('EUR')
+    expect(split_history.origin_conversion['settlement_date']).to eq('2018-06-28T13:00:00+00:00')
+    expect(split_history.origin_conversion['conversion_date']).to eq('2018-06-28T00:00:00+00:00')
+    expect(split_history.origin_conversion['status']).to eq('awaiting_funds')
+
+    expect(split_history.child_conversions[0]['id']).to eq('c8a323d8-7366-4bf3-b7c5-a6590e07eda3')
+    expect(split_history.child_conversions[0]['short_reference']).to eq('20180716-KWQYDK')
+    expect(split_history.child_conversions[0]['sell_amount']).to eq('1208.55')
+    expect(split_history.child_conversions[0]['sell_currency']).to eq('GBP')
+    expect(split_history.child_conversions[0]['buy_amount']).to eq('1500.00')
+    expect(split_history.child_conversions[0]['buy_currency']).to eq('EUR')
+    expect(split_history.child_conversions[0]['settlement_date']).to eq('2018-06-28T13:00:00+00:00')
+    expect(split_history.child_conversions[0]['conversion_date']).to eq('2018-06-28T00:00:00+00:00')
+    expect(split_history.child_conversions[0]['status']).to eq('awaiting_funds')
+
+    expect(split_history.child_conversions[1]['id']).to eq('615227c4-a955-4a6c-a415-68accc3ae47f')
+    expect(split_history.child_conversions[1]['short_reference']).to eq('20180716-EARWAY')
+    expect(split_history.child_conversions[1]['sell_amount']).to eq('1208.55')
+    expect(split_history.child_conversions[1]['sell_currency']).to eq('GBP')
+    expect(split_history.child_conversions[1]['buy_amount']).to eq('1500.00')
+    expect(split_history.child_conversions[1]['buy_currency']).to eq('EUR')
+    expect(split_history.child_conversions[1]['settlement_date']).to eq('2018-06-28T13:00:00+00:00')
+    expect(split_history.child_conversions[1]['conversion_date']).to eq('2018-06-28T00:00:00+00:00')
+    expect(split_history.child_conversions[1]['status']).to eq('awaiting_funds')
+  end
+
+  it 'can retrieve #cancellation_quote' do
+    conversion = CurrencyCloud::Conversion.create(conversion_params)
+
+    cancellation_quote = conversion.cancellation_quote
+
+    expect(cancellation_quote.amount).to eq('-0.01')
+    expect(cancellation_quote.currency).to eq('GBP')
+    expect(cancellation_quote.event_date_time).to eq('2018-11-15T14:08:07+00:00')
+  end
 end