blockchyp 2.0.0.pre.alpha7 → 2.0.1.pre.rc8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a9aa280f6f893a65d19ac1cc81c1fbb2787138110a4cf422e696cf196153322
-  data.tar.gz: afa2bebafe119454a5ce2ec9b39bd15686c7c5ebb215add0186197dee1489968
+  metadata.gz: e4cfbc9a579219f0cf12513d527ca1811ad9ea462d3de1cb3dda0e18af1de6be
+  data.tar.gz: efbfbde71b79e73555f14962f2ff76ff7070c27a99023d50f16696f97c04a96d
 SHA512:
-  metadata.gz: b3a3e83881142f842869e0bf48aeb3fe37cd2e0f4a183f56624b8ff256472b4491af6a28cc4f56eeb73501b6ec0db2948fef77b8956ca52bdc022bc05193f028
-  data.tar.gz: 51d975d45c58bbbeb722027e3bb3fa5b63e75e969ef30bf2551891da2f3605d2b6aa4526465b49b80de2d42b983f3afd313d308d6ff9f619fa8b85dbb730361f
+  metadata.gz: 84c1d4170dc3f0d3d7e3f0f12abea1192059eb0468a83787675ad7e3de62cfa35a18914dbe19edd1618dd0ab1f028b112013fa3ecf39546693a057fcf92e4009
+  data.tar.gz: 62677b578309e34f1946c775fbd13d59fbac2b0813f4f091e04f308ceec9b6674be32872f970381db8a761bf5dcc0cbcda4cbbe6636d51be0107745fffec2858

data/Makefile

@@ -6,8 +6,24 @@ RELEASE := $(or $(BUILD_NUMBER), 1)
 VERSION := $(or $(TAG:v%=%),$(LASTTAG:v%=%))-$(or $(BUILD_NUMBER), 1)$(if $(TAG),,.$(SNAPINFO))
 
 # Executables
+DOCKER = docker
+BUNDLE = bundle
 SED = sed
 
+# Integration test config
+export BC_TEST_DELAY := 5
+IMAGE := circleci/ruby
+SCMROOT := $(shell git rev-parse --show-toplevel)
+PWD := $(shell pwd)
+CACHE := $(HOME)/.local/share/blockchyp/itest-cache
+CONFIGFILE := $(HOME)/.config/blockchyp/sdk-itest-config.json
+CACHEPATHS := $(dir $(CONFIGFILE)) $(HOME)/.bundle
+ifeq ($(shell uname -s), Linux)
+HOSTIP = $(shell ip -4 addr show docker0 | grep -Po 'inet \K[\d.]+')
+else
+HOSTIP = host.docker.internal
+endif
+
 # Default target
 .PHONY: all
 all: clean build test
@@ -15,10 +31,12 @@ all: clean build test
 # Clean build artifacts
 .PHONY: clean
 clean:
+	$(RM) ./*.gem
 
 # Build compiles the package
 .PHONY: build
 build:
+	$(BUNDLE) exec rake build
 
 # Runs unit tests
 .PHONY: test
@@ -27,6 +45,20 @@ test:
 # Runs integration tests
 .PHONY: integration
 integration:
+	$(if $(LOCALBUILD), \
+		$(BUNDLE) exec rake test $(if $(TEST),TEST=$(TEST),,), \
+		$(foreach path,$(CACHEPATHS),mkdir -p $(CACHE)/$(path) ; ) \
+		sed 's/localhost/$(HOSTIP)/' $(CONFIGFILE) >$(CACHE)/$(CONFIGFILE) ; \
+		$(DOCKER) run \
+		-u $(shell id -u):$(shell id -g) \
+		-v $(SCMROOT):$(SCMROOT):Z \
+		-v /etc/passwd:/etc/passwd:ro \
+		$(foreach path,$(CACHEPATHS),-v $(CACHE)/$(path):$(path):Z) \
+		-e BC_TEST_DELAY=$(BC_TEST_DELAY) \
+		-e HOME=$(HOME) \
+		-w $(PWD) \
+		--rm -it $(IMAGE) \
+		bash -c "$(BUNDLE) install --path $(HOME)/.bundle/vendor && $(BUNDLE) exec rake test $(if $(TEST),TEST=$(TEST),)")
 
 # Performs any tasks necessary before a release build
 .PHONY: stage
@@ -36,3 +68,4 @@ stage:
 # Publish
 .PHONY: publish
 publish:
+	$(BUNDLE) exec rake publish

data/README.md

@@ -97,15 +97,16 @@ stuff you can do with the BlockChyp Ruby SDK and a few basic examples.
 
 Executes a standard direct preauth and capture.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -116,12 +117,7 @@ request['amount'] = '55.00'
 
 response = blockchyp.charge(request)
 
-if response['approved']
-  puts 'Approved'
-end
-
-puts 'authCode:' + response['authCode']
-puts 'authorizedAmount:' + response['authorizedAmount']
+puts "Response: #{response.inspect}"
 
 
 ```
@@ -130,15 +126,16 @@ puts 'authorizedAmount:' + response['authorizedAmount']
 
 Executes a preauthorization intended to be captured later.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -149,12 +146,7 @@ request['amount'] = '27.00'
 
 response = blockchyp.preauth(request)
 
-if response['approved']
-  puts 'Approved'
-end
-
-puts 'authCode:' + response['authCode']
-puts 'authorizedAmount:' + response['authorizedAmount']
+puts "Response: #{response.inspect}"
 
 
 ```
@@ -163,15 +155,16 @@ puts 'authorizedAmount:' + response['authorizedAmount']
 
 Tests connectivity with a payment terminal.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -180,10 +173,7 @@ request['terminalName'] = 'Test Terminal'
 
 response = blockchyp.ping(request)
 
-if response['success']
-  puts 'Success'
-end
-
+puts "Response: #{response.inspect}"
 
 
 ```
@@ -192,15 +182,16 @@ end
 
 Checks the remaining balance on a payment method.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -211,10 +202,7 @@ request['cardType'] = CardType::EBT
 
 response = blockchyp.balance(request)
 
-if response['success']
-  puts 'Success'
-end
-
+puts "Response: #{response.inspect}"
 
 
 ```
@@ -223,15 +211,16 @@ end
 
 Clears the line item display and any in progress transaction.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -241,10 +230,7 @@ request['terminalName'] = 'Test Terminal'
 
 response = blockchyp.clear(request)
 
-if response['success']
-  puts 'Success'
-end
-
+puts "Response: #{response.inspect}"
 
 
 ```
@@ -253,15 +239,16 @@ end
 
 Prompts the user to accept terms and conditions.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -277,31 +264,27 @@ request['sigRequired'] = true
 
 response = blockchyp.termsAndConditions(request)
 
-if response['success']
-  puts 'Success'
-end
-
-puts 'sig:' + response['sig']
-puts 'sigFile:' + response['sigFile']
+puts "Response: #{response.inspect}"
 
 
 ```
 
 #### Update Transaction Display
 
-Appends items to an existing transaction display Subtotal, Tax, and Total are
+Appends items to an existing transaction display.  Subtotal, Tax, and Total are
 overwritten by the request. Items with the same description are combined into
 groups.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -312,10 +295,7 @@ request['transaction'] = new_transaction_display_transaction
 
 response = blockchyp.updateTransactionDisplay(request)
 
-if response['success']
-  puts 'Succeded'
-end
-
+puts "Response: #{response.inspect}"
 def new_transaction_display_transaction
   val = {}
   val['subtotal'] = '60.00'
@@ -356,22 +336,22 @@ end
 
 
 
-
 ```
 
 #### New Transaction Display
 
 Displays a new transaction on the terminal.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -382,10 +362,7 @@ request['transaction'] = new_transaction_display_transaction
 
 response = blockchyp.newTransactionDisplay(request)
 
-if response['success']
-  puts 'Succeded'
-end
-
+puts "Response: #{response.inspect}"
 def new_transaction_display_transaction
   val = {}
   val['subtotal'] = '60.00'
@@ -426,22 +403,22 @@ end
 
 
 
-
 ```
 
 #### Text Prompt
 
-Asks the consumer text based question.
+Asks the consumer a text based question.
+
 
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -452,11 +429,7 @@ request['promptType'] = PromptType::EMAIL
 
 response = blockchyp.textPrompt(request)
 
-if response['success']
-  puts 'Success'
-end
-
-puts 'response:' + response['response']
+puts "Response: #{response.inspect}"
 
 
 ```
@@ -465,15 +438,16 @@ puts 'response:' + response['response']
 
 Asks the consumer a yes/no question.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -486,11 +460,7 @@ request['noCaption'] = 'No'
 
 response = blockchyp.booleanPrompt(request)
 
-if response['success']
-  puts 'Success'
-end
-
-puts 'response:' + response['response']
+puts "Response: #{response.inspect}"
 
 
 ```
@@ -499,15 +469,16 @@ puts 'response:' + response['response']
 
 Displays a short message on the terminal.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -518,10 +489,7 @@ request['message'] = 'Thank you for your business.'
 
 response = blockchyp.message(request)
 
-if response['success']
-  puts 'Success'
-end
-
+puts "Response: #{response.inspect}"
 
 
 ```
@@ -530,15 +498,16 @@ end
 
 Executes a refund.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -549,10 +518,7 @@ request['amount'] = '5.00'
 
 response = blockchyp.refund(request)
 
-if response['approved']
-  puts 'Approved'
-end
-
+puts "Response: #{response.inspect}"
 
 
 ```
@@ -561,15 +527,16 @@ end
 
 Adds a new payment method to the token vault.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -579,11 +546,7 @@ request['terminalName'] = 'Test Terminal'
 
 response = blockchyp.enroll(request)
 
-if response['approved']
-  puts 'Approved'
-end
-
-puts 'token:' + response['token']
+puts "Response: #{response.inspect}"
 
 
 ```
@@ -592,15 +555,16 @@ puts 'token:' + response['token']
 
 Activates or recharges a gift card.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -611,13 +575,7 @@ request['amount'] = '50.00'
 
 response = blockchyp.giftActivate(request)
 
-if response['approved']
-  puts 'Approved'
-end
-
-puts 'amount:' + response['amount']
-puts 'currentBalance:' + response['currentBalance']
-puts 'publicKey:' + response['publicKey']
+puts "Response: #{response.inspect}"
 
 
 ```
@@ -634,15 +592,16 @@ transaction you're trying to reverse because we may not have assigned it an id
 yet. And if we did assign it an id, you wouldn't know what it is because your
 request to the terminal timed out before you got a response.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -652,10 +611,7 @@ request['transactionRef'] = '<LAST TRANSACTION REF>'
 
 response = blockchyp.reverse(request)
 
-if response['approved']
-  puts 'Approved'
-end
-
+puts "Response: #{response.inspect}"
 
 
 ```
@@ -664,15 +620,16 @@ end
 
 Captures a preauthorization.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -682,10 +639,7 @@ request['transactionId'] = '<PREAUTH TRANSACTION ID>'
 
 response = blockchyp.capture(request)
 
-if response['approved']
-  puts 'Approved'
-end
-
+puts "Response: #{response.inspect}"
 
 
 ```
@@ -694,15 +648,16 @@ end
 
 Closes the current credit card batch.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -711,12 +666,7 @@ request['test'] = true
 
 response = blockchyp.closeBatch(request)
 
-if response['success']
-  puts 'Success'
-end
-
-puts 'capturedTotal:' + response['capturedTotal']
-puts 'openPreauths:' + response['openPreauths']
+puts "Response: #{response.inspect}"
 
 
 ```
@@ -725,15 +675,16 @@ puts 'openPreauths:' + response['openPreauths']
 
 Discards a previous preauth transaction.
 
+
 ```ruby
 # frozen_string_literal: true
 
 require 'blockchyp'
 
-blockchyp = BlockChyp.new(
-  'SPBXTSDAQVFFX5MGQMUMIRINVI',
-  '7BXBTBUPSL3BP7I6Z2CFU6H3WQ',
-  'bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e'
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
 )
 
 # setup request object
@@ -743,10 +694,34 @@ request['transactionId'] = '<PREVIOUS TRANSACTION ID>'
 
 response = blockchyp.void(request)
 
-if response['approved']
-  puts 'Approved'
-end
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Terminal Status
+
+Returns the current status of a terminal.
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# setup request object
+request = {}
+request['terminalName'] = 'Test Terminal'
+
+response = blockchyp.terminalStatus(request)
 
+puts "Response: #{response.inspect}"
 
 
 ```