adyen-ruby-api-library 4.0.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 57203cec793176b8f389062f66cf734dcc43e183
-  data.tar.gz: 6680ea0897e40cad89569ed46c841dcf45b900a4
+SHA256:
+  metadata.gz: 5d77315c126cb7ae2f8600f5bc8e853fd868a6bc6c30c36add08cfbe93285488
+  data.tar.gz: bf4c1f6498020da769aecba45b4fe6ce43f017ca71e083723b2bfa8903d3932e
 SHA512:
-  metadata.gz: 16075771ada5ca4afb71c798e7823fcd1c2b162a6d0d21919b0a3ea8db301ec5379525c726ebc3d71b0b39d87ada719b539b7457fe927a5aa6ef4754b7dca3be
-  data.tar.gz: 968d9f0cb9a426ce89d8bc17a00cdf50766f1f48dacbb58a1966e3d29ae5fe99a3e784e6d0f40fa86f4f0ef5bfad27576124ad1504746e121af9998abd06f8a1
+  metadata.gz: dd3c31163dae11854ef0d921ff772ddd3d5b526c2bef106a26edd150e2f517fd306cde43e7839313e134dd72f86eb6f0c37a2a19cb52efc169892e8849b9ceb0
+  data.tar.gz: c51e518693653f525a5dc06ee71d859614f5a741b4109ded91a29e9327c768c9b7c0c5f1783fdceeb740b1e6f95074bfc7f0336b7228eb1a3e66a34bd3730bd1

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/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,8 @@ The Library supports all APIs under the following services:
 * payouts
 * recurring
 * marketpay
+* postfmapi
+* data_protection
 
 ## Requirements
 
@@ -77,6 +79,7 @@ adyen.checkout.version = 50
 - payment_methods
 - payments
 - payments.details
+- payment_links
 
 **checkout utility:**
 - origin_keys
@@ -91,6 +94,7 @@ adyen.checkout.version = 50
 - refund
 - cancel_or_refund
 - adjust_authorisation
+- donate
 
 **payouts:**
 - confirm_third_party
@@ -136,9 +140,19 @@ 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
 
-If you have any problems, questions or suggestions, create an issue here or send your inquiry to support@adyen.com.
+**data_protection:**
+- request_subject_erasure
+
+## 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,15 +7,8 @@ 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"
-
-# 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
+require_relative "adyen/services/data_protection"
+require_relative "adyen/hash_with_accessors"
+require_relative "adyen/utils/hmac_validator"

data/lib/adyen/client.rb

@@ -2,7 +2,6 @@ require "faraday"
 require "json"
 require_relative "./errors"
 require_relative "./result"
-require_relative "./util"
 
 module Adyen
   class Client
@@ -46,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"
           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"
+          url = "https://ca-#{@env}.adyen.com/ca/services"
+          supports_live_url_prefix = false
         else
           raise ArgumentError, "Invalid service specified"
         end
@@ -67,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}"
@@ -188,5 +193,13 @@ 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
   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

data/lib/adyen/hash_with_accessors.rb

@@ -0,0 +1,38 @@
+# This utility method inherits from Hash, but allows keys to be read
+# and updated with dot notation. Usage is entirely optional (i.e.,  hash values
+# can still be accessed via symbol and string keys).
+#
+# Based on: https://gist.github.com/winfred/2185384#file-ruby-dot-hash-access-rb
+module Adyen
+  class HashWithAccessors < Hash
+    def method_missing(method, *args)
+      string_key = method.to_s.sub(/=\z/, '')
+      sym_key = string_key.to_sym
+
+      key = if has_key?(string_key)
+        string_key
+      elsif has_key?(sym_key)
+        sym_key
+      end
+
+      return super unless key
+
+      assignment = sym_key != method
+
+      if assignment
+        raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 1)" unless args.size == 1
+
+        self[key] = args.first
+      else
+        raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 0)" unless args.size == 0
+
+        self[key]
+      end
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      string_key = method.to_s.sub(/=\z/, '')
+      has_key?(string_key) || has_key?(string_key.to_sym) || super
+    end
+  end
+end

data/lib/adyen/result.rb

@@ -5,11 +5,11 @@ module Adyen
     attr_reader :response, :header, :status
 
     def initialize(response, header, status)
-      @response = JSON.parse(response)
+      @response = JSON.parse(response, object_class: HashWithAccessors)
 
       # `header` in Faraday response is not a JSON string, but rather a
       # Faraday `Headers` object. Convert first before parsing
-      @header = JSON.parse(header.to_json)
+      @header = JSON.parse(header.to_json, object_class: HashWithAccessors)
       @status = status
     end
   end