adyen-ruby-api-library 4.0.1 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 50ac4158ef06b200711ce1b69d7b6c12cad0df4b
-  data.tar.gz: 338fbfd9fed83cd6a3569dd1f706fdf439e259c1
+SHA256:
+  metadata.gz: e483ea1b71301634db57072423fd8cea1483b160eec7c1ba85fcf62ccbac0414
+  data.tar.gz: fa6dd93d1fe95ccf9ce3e9cc4a9956e523e6f25a20ae49fb2529e560c1aec14a
 SHA512:
-  metadata.gz: c71dfcff2e34dd0244abdd56da08a0ab430b608de4fc095a472711a69269c416ffcee0b6021ed0db56bff3b8a5d1fc25e1fe13bac4f0c844367a61498ad6de1b
-  data.tar.gz: 9ea5ee2a69f6de0523ba4fff25975202583bdf3d1218a8cda8d0abe978b57e30158cccd4bb94921c928531ce40442df067089cdb74a066567a4f2cd1f526bcf5
+  metadata.gz: 50f51f247bb68817b56ef596ad2b435280fedb1dc06806665a5e48b4c1cfb67fda4c1060f882929c0c40c8b225635cc19d36d6f90be4ae1e0e7149dc8f8638bd
+  data.tar.gz: 15273291ffb0122fab7050dc1263028c6a38d6634519c744057d1b3756b62461c028de7982d5c36adfb04e50f25a7d121541d1ef496a91c3c63bd67ee75c7829

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @crrood @hbkwong @KadoBOT @Aleffio @rikterbeek

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**How to reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - ruby Version: [x.y.z]
+ - Library Version: [x.y.z]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**ruby version**: x.y.z
+**Library version**: x.y.z
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+**Description**
+<!-- Please provide a description of the changes proposed in the Pull Request -->
+
+**Tested scenarios**
+<!-- Description of tested scenarios -->
+
+**Fixed issue**:  <!-- #-prefixed issue number -->

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 10

data/.gitignore

@@ -11,3 +11,5 @@ design.txt
 
 .bundle
 .ruby-version
+
+.DS_Store

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at support@adyen.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -2,11 +2,11 @@
 
 source "https://rubygems.org"
 
-ruby "> 2.1.0"
+ruby ">= 2.1.0"
 
 gem "faraday"
 
 gem "bundler", :group => :development
 gem "webmock", :group => :development
 gem "rspec", :group => :development
-gem "activesupport", :group => :development
+gem "activesupport", :group => :development

data/README.md

@@ -13,6 +13,10 @@ The Library supports all APIs under the following services:
 * payouts
 * recurring
 * marketpay
+* postfmapi
+* data_protection
+* dispute
+* bin_lookup
 
 ## Requirements
 
@@ -77,6 +81,7 @@ adyen.checkout.version = 50
 - payment_methods
 - payments
 - payments.details
+- payment_links
 
 **checkout utility:**
 - origin_keys
@@ -91,6 +96,7 @@ adyen.checkout.version = 50
 - refund
 - cancel_or_refund
 - adjust_authorisation
+- donate
 
 **payouts:**
 - confirm_third_party
@@ -136,9 +142,29 @@ adyen.checkout.version = 50
 - update_notification_configuration
 - delete_notification_configurations
 
-## Support
+**marketpay.hop:**
+- get_onboarding_url
+
+**postfmapi:**
+- assign_terminals
+- find_terminal
+- get_terminals_under_account
+
+**data_protection:**
+- request_subject_erasure
 
-If you have any problems, questions or suggestions, create an issue here or send your inquiry to support@adyen.com.
+**dispute:**
+- retrieve_applicable_defense_reasons
+- supply_defense_document
+- delete_dispute_defense_document
+- defend_dispute
+
+**bin_lookup:**
+- get_3ds_availability
+- get_cost_estimate
+
+## Support
+If you have a feature request, or spotted a bug or a technical problem, create a GitHub issue. For other questions, contact our [support team](https://support.adyen.com/hc/en-us/requests/new?ticket_form_id=360000705420).
 
 ## Contributing
 We strongly encourage you to join us in contributing to this repository so everyone can benefit from:

data/docs/checkout.html

@@ -41,6 +41,8 @@
         <li>payments</li>
 
         <li>payments.details</li>
+
+        <li>payment_links</li>
         </ul>
 
         <h2 id="authentication">Authentication</h2>
@@ -99,7 +101,22 @@
 
         <p>A successful call to payment_methods will return a list of supported payment methods along with redirect URL's so that you can send your shoppers directly to the issuer's site without losing control of front-end styling / logic.</p>
 
+        You can also create a link to Adyen's hosted payment form:
+
+        <pre><code class="ruby language-ruby">response = adyen.checkout.payment_links('{
+  "amount": {
+    "value": 1500,
+    "currency": "EUR"
+  },
+  "countryCode": "US",
+  "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+  "reference": "YOUR_REFERENCE"
+}')</code></pre>
+
+        <p>A successful call to payment_links will return a url, which directs a user to Adyen's hosted payment form.</p>
       </section>
+
+
       <footer>
         <p>This project is maintained by <a href="https://github.com/Adyen">Adyen</a></p>
         <p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>

data/lib/adyen-ruby-api-library.rb

@@ -7,17 +7,10 @@ require_relative "adyen/services/payments"
 require_relative "adyen/services/payouts"
 require_relative "adyen/services/recurring"
 require_relative "adyen/services/marketpay"
+require_relative "adyen/services/postfmapi"
 require_relative "adyen/services/service"
+require_relative "adyen/services/data_protection"
+require_relative "adyen/services/dispute"
+require_relative "adyen/services/bin_lookup"
 require_relative "adyen/hash_with_accessors"
 require_relative "adyen/utils/hmac_validator"
-
-# add snake case to camel case converter to String
-# to convert rubinic method names to Adyen API methods
-#
-# i.e. snake_case -> snakeCase
-# note that the first letter is not capitalized as normal
-class String
-  def to_camel_case
-    split("_").collect.with_index{ |x, i| i > 0 ? x.capitalize : x }.join
-  end
-end

data/lib/adyen/client.rb

@@ -45,12 +45,18 @@ module Adyen
         when "CheckoutUtility"
           url = "https://checkout-#{@env}.adyen.com/checkout"
           supports_live_url_prefix = true
-        when "Account", "Fund", "Notification"
+        when "Account", "Fund", "Notification", "Hop"
           url = "https://cal-#{@env}.adyen.com/cal/services"
           supports_live_url_prefix = false
-        when "Recurring", "Payment", "Payout"
+        when "Recurring", "Payment", "Payout", "BinLookup"
           url = "https://pal-#{@env}.adyen.com/pal/servlet"
           supports_live_url_prefix = true
+        when "Terminal"
+          url = "https://postfmapi-#{@env}.adyen.com/postfmapi/terminal"
+          supports_live_url_prefix = false
+        when "DataProtectionService", "DisputeService"
+          url = "https://ca-#{@env}.adyen.com/ca/services"
+          supports_live_url_prefix = false
         else
           raise ArgumentError, "Invalid service specified"
         end
@@ -66,7 +72,7 @@ module Adyen
 
     # construct full URL from service and endpoint
     def service_url(service, action, version)
-      if service == "Checkout" || service == "CheckoutUtility"
+      if service == "Checkout" || service == "CheckoutUtility" || service == "Terminal"
         "#{service_url_base(service)}/v#{version}/#{action}"
       else
         "#{service_url_base(service)}/#{service}/v#{version}/#{action}"
@@ -74,7 +80,7 @@ module Adyen
     end
 
     # send request to adyen API
-    def call_adyen_api(service, action, request_data, headers, version)
+    def call_adyen_api(service, action, request_data, headers, version, with_application_info = false)
       # get URL for requested endpoint
       url = service_url(service, action, version)
 
@@ -119,7 +125,7 @@ module Adyen
       end
 
       # add application only on checkout service
-      if service == 'Checkout' || service == 'CheckoutUtility'
+      if with_application_info
         add_application_info(request_data)
       end
 
@@ -151,16 +157,15 @@ module Adyen
     # add application_info for analytics
     def add_application_info(request_data)
       adyenLibrary = {
-          :name => Adyen::NAME,
-          :version => Adyen::VERSION.to_s
+        :name => Adyen::NAME,
+        :version => Adyen::VERSION.to_s,
       }
 
       if request_data[:applicationInfo].nil?
-        request_data[:applicationInfo] = {};
+        request_data[:applicationInfo] = {}
       end
 
       request_data[:applicationInfo][:adyenLibrary] = adyenLibrary
-      request_data[:applicationInfo][:adyenLibraryTest] = adyenLibrary
     end
 
     # services
@@ -187,5 +192,21 @@ module Adyen
     def marketpay
       @marketpay ||= Adyen::Marketpay::Marketpay.new(self)
     end
+
+    def postfmapi
+      @postfmapi ||= Adyen::PosTerminalManagement.new(self)
+    end
+
+    def data_protection
+      @data_protection ||= Adyen::DataProtection.new(self)
+    end
+
+    def dispute
+      @dispute ||= Adyen::Dispute.new(self)
+    end
+
+    def bin_lookup
+      @bin_lookup ||= Adyen::BinLookup.new(self)
+    end
   end
 end

data/lib/adyen/errors.rb

@@ -3,19 +3,61 @@ module Adyen
     attr_reader :code, :response, :request, :msg
 
     def initialize(request = nil, response = nil, msg = nil, code = nil)
+      mask_fields(request)
+
+      # components of formatted error message
       attributes = {
         code: code,
+        msg: msg,
         request: request,
-        response: response,
-        msg: msg
+        response: response
       }.select { |_k, v| v }.map { |k, v| "#{k}:#{v}" }.join(', ')
       message = "#{self.class.name} #{attributes}"
       super(message)
+
+      # internal variables
       @code = code
       @response = response
       @request = request
       @msg = msg
     end
+
+    # mask PCI data in request
+    def mask_fields(request)
+      return if request.nil?
+
+      # sensitive fields
+      fields_to_mask = [
+        :expiryMonth,
+        :expiryYear,
+        :encryptedCardNumber,
+        :encryptedExpiryMonth,
+        :encryptedExpiryYear,
+        :encryptedSecurityCode
+      ]
+
+      # convert to hash if necessary
+      request = request.is_a?(Hash) ? request : JSON.parse(request)
+
+      # iterate through request to find fields to mask
+      request.each do |k, v|
+        if request[k].is_a?(Hash)
+          # recursively traverse multi-level hashes
+          mask_fields(request[k])
+        else
+          if k == :number
+            # show first 6 and last 4 for cards
+            request[k] = "#{v[0,6]}******#{v[12,16]}"
+          elsif k == :cvc
+            # show length of cvc for debugging
+            request[k] = "*" * v.length
+          elsif fields_to_mask.include? k
+            # generic mask for other fields
+            request[k] = "***"
+          end
+        end
+      end
+    end
   end
 
   class AuthenticationError < AdyenError