Minor modifications to v2.4 functionality.

Author: Paul Daigle

.gitignore

@@ -7,4 +7,5 @@ pkg
 .ruby-gemset
 *.swo
 *.swp
-bitpaykey.pem
+bitpaykey.pem
+constants.txt

GUIDE.md

@@ -194,10 +194,10 @@ API Documentation is available on the [BitPay site](https://bitpay.com/api).
 
 In order to run the tests, you must have phantomjs installed and on your PATH.
 
-The tests require that environment variables be set for the bitpay server, user name, and password. First run:
+The tests require that environment variables be set for the bitpay server, user name, password, an invoice id for refunds and a valid testnet bitcoin address for refunds. First run:
 
 ```bash 
-$ source ./spec/set_constants.sh https://test.bitpay.com <yourusername> <yourpassword>
+$ source ./spec/set_constants.sh https://test.bitpay.com <yourusername> <yourpassword> <a-confirmed-invoice-id> <a-valid-testnet-address>
 $ bundle install
 $ bundle exec rake
 ```

config/constants.rb

@@ -11,8 +11,8 @@
 DASHBOARD_URL = "#{ROOT_ADDRESS}/dashboard/merchant/home"
 
 # Specify a bitpay txid which has 6+ confirmations.  Default belongs to 'bitpayrubyclient@gmail.com' test account
-REFUND_TRANSACTION = ENV['REFUND_TRANSACTION'] || 'TKKgh3LJuRXnq6hSR3hhNR'
-REFUND_ADDRESS = ENV['REFUND_ADDRESS'] || '2NCMQ8LRu71SfLMYTi8qotg6VRpBZynpFAh'  # Hamish's Testnet Copay Wallet
+REFUND_TRANSACTION = ENV['REFUND_TRANSACTION']
+REFUND_ADDRESS = ENV['REFUND_ADDRESS']
 
 unless
   ROOT_ADDRESS &&

features/step_definitions/refund_steps.rb

@@ -10,7 +10,7 @@
 
 Given(/^the user requests a specific refund$/) do
   client = new_client_from_stored_values
-  @response = client.get_refund(id: REFUND_TRANSACTION, request_id: @refund_id)
+  @response = client.get_refund(invoice_id: REFUND_TRANSACTION, request_id: @refund_id)
 end
 
 Then(/^they will receive the refund$/) do
@@ -29,9 +29,9 @@
 Given(/^a properly formatted cancellation request$/) do
   client = new_client_from_stored_values
   @refund_id = client.get_all_refunds_for_invoice(id: REFUND_TRANSACTION).first["id"]
-  @response = client.cancel_refund(id: REFUND_TRANSACTION, request_id: @refund_id)
+  @response = client.cancel_refund(invoice_id: REFUND_TRANSACTION, request_id: @refund_id)
 end
 
 Then(/^the refund will be cancelled$/) do
   expect(@response).to eq("Success")
-end
+end

features/step_definitions/step_helpers.rb

@@ -64,7 +64,6 @@ def new_client_from_stored_values
     unless client.verify_tokens then 
       raise "Locally stored tokens are invalid, please remove #{BitPay::TOKEN_FILE_PATH}" end
   else
-    claim_code = get_claim_code_from_server
     pem = BitPay::KeyUtils.generate_pem
     client = BitPay::SDK::Client.new(api_uri: ROOT_ADDRESS, pem: pem, insecure: true)
     sleep 1 # rate limit compliance

lib/bitpay/client.rb

@@ -125,9 +125,9 @@ def get_all_refunds_for_invoice(id:)
       #  @example:
       #    client.get_refund(id: 'JB49z2MsDH7FunczeyDS8j', request_id: '4evCrXq4EDXk4oqDXdWQhX')
       #
-      def get_refund(id:, request_id:)
-        urlpath = "invoices/#{id}/refunds/#{request_id}"
-        invoice = get_invoice(id: id)
+      def get_refund(invoice_id:, request_id:)
+        urlpath = "invoices/#{invoice_id}/refunds/#{request_id}"
+        invoice = get_invoice(id: invoice_id)
         get(path: urlpath, token: invoice["token"])
       end
 
@@ -137,9 +137,9 @@ def get_refund(id:, request_id:)
       #  @example:
       #    client.cancel_refund(id: 'JB49z2MsDH7FunczeyDS8j', request_id: '4evCrXq4EDXk4oqDXdWQhX')
       #
-      def cancel_refund(id:, request_id:)
-        urlpath = "invoices/#{id}/refunds/#{request_id}"
-        refund = get_refund(id: id, request_id: request_id)
+      def cancel_refund(invoice_id:, request_id:)
+        urlpath = "invoices/#{invoice_id}/refunds/#{request_id}"
+        refund = get_refund(invoice_id: invoice_id, request_id: request_id)
         delete(path: urlpath, token: refund["token"])
       end      
 

lib/bitpay/version.rb

@@ -3,5 +3,5 @@
 # or https://github.com/bitpay/php-bitpay-client/blob/master/LICENSE
 
 module BitPay
-  VERSION = '2.3.1'
+  VERSION = '2.4.0'
 end

spec/client_spec.rb

@@ -151,11 +151,11 @@ def tokens
     before {stub_const('ENV', {'BITPAY_PEM' => PEM})}
     it { is_expected.to respond_to(:get_refund) }  
     it 'should get the token for the invoice' do
-      bitpay_client.get_refund(id: 'TEST_INVOICE_ID', request_id: 'TEST_REQUEST_ID')
+      bitpay_client.get_refund(invoice_id: 'TEST_INVOICE_ID', request_id: 'TEST_REQUEST_ID')
       expect(WebMock).to have_requested :get, "#{BitPay::TEST_API_URI}/invoices/TEST_INVOICE_ID?token=MERCHANT_TOKEN"
     end        
     it 'should GET a single refund' do
-      bitpay_client.get_refund(id: 'TEST_INVOICE_ID', request_id: 'TEST_REQUEST_ID')
+      bitpay_client.get_refund(invoice_id: 'TEST_INVOICE_ID', request_id: 'TEST_REQUEST_ID')
       expect(WebMock).to have_requested :get, "#{BitPay::TEST_API_URI}/invoices/TEST_INVOICE_ID/refunds/TEST_REQUEST_ID?token=MERCHANT_INVOICE_TOKEN"
     end
   end

spec/set_constants.sh

@@ -6,5 +6,7 @@ export RCTESTUSER=$2
 echo $RCTESTUSER
 export RCTESTPASSWORD=$3
 echo $RCTESTPASSWORD
-export PRIV_KEY=$4
-echo $PRIV_KEY
+export REFUND_TRANSACTION=$4
+echo $REFUND_TRANSACTION
+export REFUND_ADDRESS=$5
+echo $REFUND_ADDRESS