blockchyp 2.10.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfa58d2ca1b9dced275caf2d275cc8365c01253ae9da66a98f69674c3eac94c9
-  data.tar.gz: a73a9b7015fac83379021f425c57802c4f078575116311ceff795d1352e985fd
+  metadata.gz: '0386059a39ae5610e197ad1ec670c6dff70341d7cc2a5a0dab7331f76cecb2e2'
+  data.tar.gz: fdcfaed2c9345ccba05aac145fec1d4ed67e11094548f2239daa30e35a318fd8
 SHA512:
-  metadata.gz: cc39925a046375cee1ddfb9bca6dce5584085a272ae2d8998c0af52fce2aa6fa70ae3d5b158c4c2acc1d7bdc1fa8a1ab30504cbaa2a1cd91c84d678fe2523f07
-  data.tar.gz: 3851804bdd7ba2c9525bdc678d546e098869da2ccc76857b3425bc1ebbd785e810514aa5b61dc5f239635162442e294f2881b025ed3177f5aa1b371436689247
+  metadata.gz: bc35d1405ca25dfb34c72e1ad3af2bed582d1fa8f18c8f20c64f5fb394a241f2914d820f6bd1ee751fbe5322c9654f6ce115021745ee71de7ae89e09bdd09923
+  data.tar.gz: d8882653dfd8cc174adcab2148fe2d3e5ec0ac45128bdccff26ec1b021482a06b472160277820d7d8b54d5f818411e489dd5d640e9c0d223c0a00d9a9972e636

data/README.md

@@ -1685,6 +1685,15 @@ None of the above filters are mutually exclusive.  You can combine any of the
 above properties in a single request to restrict transaction results to a
 narrower set of results.
 
+**Searching Transaction History**
+
+You can search transaction history by passing in search criteria with the 
+`query` option.  The search system will match on amount (requested and authorized),
+last four of the card number, cardholder name, and the auth code.
+
+Note that when search queries are used, terminalName or 
+batch id filters are not supported.
+
 
 
 
@@ -1875,6 +1884,114 @@ response = blockchyp.deleteToken(request)
 puts "Response: #{response.inspect}"
 
 
+```
+
+#### Token Metadata
+
+
+
+Retrieves status and metadata information about a token, 
+including any links to customer records.  
+
+This will also return any customer records related to the card
+behind the token.  If the underlying card has been tokenized
+multiple times, all customers related to the card will be returned,
+even if those customer associations are related to other tokens.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+  token: 'Token to retrieve'
+}
+
+response = blockchyp.tokenMetadata(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Link Token
+
+
+
+Links a payment token with a customer record.  Usually this would only be used
+to reverse a previous unlink operation.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+  token: 'Token to link',
+  customerId: 'Customer to link'
+}
+
+response = blockchyp.linkToken(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Unlink Token
+
+
+
+Removes a payment token link from a customer record.
+
+This will remove links between the customer record and all tokens
+for the same underlying card.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+  token: 'Token to unlink',
+  customerId: 'Customer to unlink'
+}
+
+response = blockchyp.unlinkToken(request)
+
+puts "Response: #{response.inspect}"
+
+
 ```
 
 ## Running Integration Tests

data/lib/blockchyp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BlockChyp
-  VERSION = '2.10.0'
+  VERSION = '2.11.0'
 end

data/lib/blockchyp.rb

@@ -244,5 +244,20 @@ module BlockChyp
       gateway_request('DELETE', '/api/token/' + request[:token], request)
     end
 
+    # Retrieves payment token metadata.
+    def token_metadata(request)
+      gateway_request('GET', '/api/token/' + request[:token], request)
+    end
+
+    # Links a token to a customer record.
+    def link_token(request)
+      gateway_request('POST', '/api/link-token', request)
+    end
+
+    # Removes a link between a customer and a token.
+    def unlink_token(request)
+      gateway_request('POST', '/api/unlink-token', request)
+    end
+
   end
 end

data/test/delete_token_test.rb

@@ -26,7 +26,12 @@ module BlockChyp
       # Set request parameters
       setup_request = {
         pan: '4111111111111111',
-        test: true
+        test: true,
+        customer: {
+          customerRef: 'TESTCUSTOMER',
+          firstName: 'Test',
+          lastName: 'Customer'
+        }
       }
 
       response = blockchyp.enroll(setup_request)

data/test/link_token_test.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright 2019 BlockChyp, Inc. All rights reserved. Use of this code is
+# governed by a license that can be found in the LICENSE file.
+#
+# This file was generated automatically. Changes to this file will be lost
+# every time the code is regenerated.
+
+require ::File.expand_path('test_helper', __dir__)
+
+module BlockChyp
+  class LinkTokenTest < TestCase
+    def test_link_token
+      config = load_test_config
+
+      blockchyp = BlockChyp.new(
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+
+      test_delay(blockchyp, 'link_token_test', config[:defaultTerminalName])
+
+      # Set request parameters
+      setup_request = {
+        pan: '4111111111111111',
+        test: true,
+        customer: {
+          customerRef: 'TESTCUSTOMER',
+          firstName: 'Test',
+          lastName: 'Customer'
+        }
+      }
+
+      response = blockchyp.enroll(setup_request)
+
+      # Set request parameters
+      request = {
+        token: response[:token],
+        customerId: response[:customer][:id]
+      }
+
+      response = blockchyp.link_token(request)
+
+      assert_not_nil(response)
+      # response assertions
+      assert(response[:success])
+    end
+  end
+end

data/test/pan_enroll_test.rb

@@ -26,7 +26,12 @@ module BlockChyp
       # Set request parameters
       request = {
         pan: '4111111111111111',
-        test: true
+        test: true,
+        customer: {
+          customerRef: 'TESTCUSTOMER',
+          firstName: 'Test',
+          lastName: 'Customer'
+        }
       }
 
       response = blockchyp.enroll(request)

data/test/simple_ping_test.rb

@@ -26,7 +26,7 @@ module BlockChyp
       # Set request parameters
       request = {
         test: true,
-        terminalName: '$testTerminal'
+        terminalName: config[:defaultTerminalName]
       }
 
       response = blockchyp.ping(request)

data/test/terminal_charge_test.rb

@@ -25,7 +25,7 @@ module BlockChyp
 
       # Set request parameters
       request = {
-        terminalName: '$testTerminal',
+        terminalName: config[:defaultTerminalName],
         amount: '25.15',
         test: true
       }

data/test/token_metadata_test.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright 2019 BlockChyp, Inc. All rights reserved. Use of this code is
+# governed by a license that can be found in the LICENSE file.
+#
+# This file was generated automatically. Changes to this file will be lost
+# every time the code is regenerated.
+
+require ::File.expand_path('test_helper', __dir__)
+
+module BlockChyp
+  class TokenMetadataTest < TestCase
+    def test_token_metadata
+      config = load_test_config
+
+      blockchyp = BlockChyp.new(
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+
+      test_delay(blockchyp, 'token_metadata_test', config[:defaultTerminalName])
+
+      # Set request parameters
+      setup_request = {
+        pan: '4111111111111111',
+        test: true,
+        customer: {
+          customerRef: 'TESTCUSTOMER',
+          firstName: 'Test',
+          lastName: 'Customer'
+        }
+      }
+
+      response = blockchyp.enroll(setup_request)
+
+      # Set request parameters
+      request = {
+        token: response[:token]
+      }
+
+      response = blockchyp.token_metadata(request)
+
+      assert_not_nil(response)
+      # response assertions
+      assert(response[:success])
+    end
+  end
+end

data/test/unlink_token_test.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright 2019 BlockChyp, Inc. All rights reserved. Use of this code is
+# governed by a license that can be found in the LICENSE file.
+#
+# This file was generated automatically. Changes to this file will be lost
+# every time the code is regenerated.
+
+require ::File.expand_path('test_helper', __dir__)
+
+module BlockChyp
+  class UnlinkTokenTest < TestCase
+    def test_unlink_token
+      config = load_test_config
+
+      blockchyp = BlockChyp.new(
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+
+      test_delay(blockchyp, 'unlink_token_test', config[:defaultTerminalName])
+
+      # Set request parameters
+      setup_request = {
+        pan: '4111111111111111',
+        test: true,
+        customer: {
+          customerRef: 'TESTCUSTOMER',
+          firstName: 'Test',
+          lastName: 'Customer'
+        }
+      }
+
+      response = blockchyp.enroll(setup_request)
+
+      # Set request parameters
+      request = {
+        token: response[:token],
+        customerId: response[:customer][:id]
+      }
+
+      response = blockchyp.unlink_token(request)
+
+      assert_not_nil(response)
+      # response assertions
+      assert(response[:success])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blockchyp
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.11.0
 platform: ruby
 authors:
 - BlockChyp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-10-08 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
@@ -32,6 +32,7 @@ files:
 - test/gateway_timeout_test.rb
 - test/get_customer_test.rb
 - test/heartbeat_test.rb
+- test/link_token_test.rb
 - test/merchant_profile_test.rb
 - test/new_transaction_display_test.rb
 - test/pan_charge_test.rb
@@ -62,7 +63,9 @@ files:
 - test/terms_and_conditions_test.rb
 - test/test_helper.rb
 - test/text_prompt_test.rb
+- test/token_metadata_test.rb
 - test/transaction_history_test.rb
+- test/unlink_token_test.rb
 - test/update_customer_test.rb
 - test/update_transaction_display_test.rb
 homepage: https://github.com/blockchyp/blockchyp-ruby