bitpay-sdk 2.3.3 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f17aaeed06964a9e0cb8aaa38e8e291b5135e0e2
-  data.tar.gz: c84ffdc47caf825006420824e3f63b61a22bc27a
+  metadata.gz: 934b96a7f24134990a0cfed00c6e3b50502c3823
+  data.tar.gz: 68a05391e925b79b565f7cc2400ce7a101bc5ebf
 SHA512:
-  metadata.gz: 66d9265331b654fa308f0ae24782fe62d9a0b113e5a470341400d329edd0e3a4b71c36964f02a9c5e0c6a793a702e8444c98357728c0efa84c6f65ae9c000117
-  data.tar.gz: 86f177707cbc8f8c2f71d4a4b031153935ce62e3fef1be0077f26de57dd77b9076f4d1a579a60e6266e537f8e571bdd030defb89dff6a5917b0639dae61ce927
+  metadata.gz: b9c62e5a6a700b1c73c928f27c5cff0436ddb33bffd2292e18248046b89ce9c54b65918b151a3f9a32559e42c239da02c20fc326d350f1369cedad6748cc9089
+  data.tar.gz: 56ab8bfb2b86bd9e15a5f7165a0e58b98eb92ac987868e9789d6167a19f15645f99157680fe17c313dcf692f21dcd94779507881710198f3738e05a298222698

data/.gitignore

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

data/GUIDE.md

@@ -154,6 +154,13 @@ client.get_all_refunds_for_invoice(id: 'PvVhgBfA7wKPWhuVC24rJo')
 # To get a specific refund for a specific invoice
 client.get_refund(id: 'JB49z2MsDH7FunczeyDS8j', request_id: '4evCrXq4EDXk4oqDXdWQhX')
 ```
+### Cancel Refund Requests
+
+Requires a `merchant` token.
+
+```ruby
+client.cancel_refund(id: 'JB49z2MsDH7FunczeyDS8j', request_id: '4evCrXq4EDXk4oqDXdWQhX')
+```
 
 ### Make a HTTP request directly against the REST API
 
@@ -187,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
 ```

data/config/capybara.rb

@@ -1,6 +1,6 @@
 Capybara.javascript_driver = :poltergeist
 Capybara.default_driver = :poltergeist
-Capybara.default_wait_time = 5
+Capybara.default_wait_time = 10
 Capybara.register_driver :poltergeist do |app|
 	Capybara::Poltergeist::Driver.new(app, timeout: 60, js_errors: false, phantomjs_options: ['--ignore-ssl-errors=yes', '--ssl-protocol=TLSv1', '--web-security=false'])
 end

data/config/constants.rb

@@ -10,6 +10,10 @@ TEST_USER = ENV['RCTESTUSER']
 TEST_PASS = ENV['RCTESTPASSWORD']
 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']
+REFUND_ADDRESS = ENV['REFUND_ADDRESS']
+
 unless
   ROOT_ADDRESS &&
   TEST_USER &&

data/features/pairing.feature

@@ -6,10 +6,10 @@ Feature: pairing with bitpay
   Scenario: the client has a correct pairing code
     Given the user pairs with BitPay with a valid pairing code
     Then the user is paired with BitPay
-    
+
   Scenario: the client initiates pairing
-    Given the user requests a client-side pairing
-    Then they will receive a claim code
+    Given the user performs a client-side pairing
+    Then the user has a merchant token
 
   Scenario Outline: the client has a bad pairing code
     Given the user fails to pair with a semantically <valid> code <code>

data/features/refunds.feature

@@ -0,0 +1,20 @@
+@refunds
+Feature: issuing a refund
+  The merchant wants to issue a refund
+  So that they can serve their customers
+
+  Scenario: creating a refund
+    Given the user creates a refund
+    Then they will receive a refund id
+  
+  Scenario: retrieving a refund
+    Given the user requests a specific refund
+    Then they will receive the refund 
+    
+  Scenario: retrieving all refunds
+    Given the user requests all refunds for an invoice
+    Then they will receive an array of refunds
+
+  Scenario: canceling a refund
+    Given a properly formatted cancellation request
+    Then the refund will be cancelled

data/features/retrieving_invoices.feature

@@ -2,6 +2,10 @@ Feature: retrieving an invoice
   The user may want to retrieve invoices
   So that they can view them
 
-  Scenario: The request is correct
+  Scenario: Correct public request
     Given that a user knows an invoice id
-    Then they can retrieve that invoice
+    Then they can retrieve the public version of that invoice
+
+  Scenario: Correct merchant request
+    Given that a user knows an invoice id
+    Then they can retrieve the merchant-scoped version of that invoice    

data/features/step_definitions/invoice_steps.rb

@@ -1,6 +1,6 @@
 When(/^the user (?:tries to |)creates? an invoice (?:for|without) "(.*?)" (?:or |and |)"(.*?)"$/) do |price, currency|
   begin
-    @response = @client.create_invoice(price: price, currency: currency)
+    @response = @client.create_invoice(price: price, currency: currency, facade: 'merchant')
    rescue => error
      @error = error
    end
@@ -15,12 +15,17 @@ Given(/^there is an invalid token$/) do
 end
 
 Given(/^that a user knows an invoice id$/) do
-  client = new_client_from_stored_values
-  @id = (client.create_invoice(price: 3, currency: "USD" ))['id']
+  @client = new_client_from_stored_values
+  @id = (@client.create_invoice(price: 3, currency: "USD", facade: 'merchant' ))['id']
 end
 
-Then(/^they can retrieve that invoice$/) do
-  invoice = BitPay::SDK::Client.new(api_uri: ROOT_ADDRESS, insecure: true).get_public_invoice(id: @id)
+Then(/^they can retrieve the public version of that invoice$/) do
+  invoice = @client.get_public_invoice(id: @id)
+  raise "That's the wrong invoice" unless invoice['id'] == @id
+end
+
+Then(/^they can retrieve the merchant\-scoped version of that invoice$/) do
+  invoice = @client.get_invoice(id: @id)
   raise "That's the wrong invoice" unless invoice['id'] == @id
 end
 

data/features/step_definitions/keygen_steps.rb

@@ -31,7 +31,6 @@ Given(/^the user is paired with BitPay$/) do
   raise "Client is not paired" unless @client.verify_tokens
 end
 
-
 Given(/^the user has a bad pairing_code "(.*?)"$/) do |arg1|
     # This is a no-op, pairing codes are transient and never actually saved
 end
@@ -53,13 +52,16 @@ Then(/^they will receive an? (.*?) matching "(.*?)"$/) do |error_class, error_me
   raise "Error: #{@error.class}, message: #{@error.message}" unless Object.const_get(error_class) == @error.class && @error.message.include?(error_message)
 end
 
-Given(/^the user requests a client\-side pairing$/) do
+Given(/^the user performs a client\-side pairing$/) do
   sleep 1
   pem = BitPay::KeyUtils.generate_pem
-  client = BitPay::SDK::Client.new(api_uri: ROOT_ADDRESS, pem: pem, insecure: true)
-  @response = client.pair_client({})
+  @client = BitPay::SDK::Client.new(api_uri: ROOT_ADDRESS, pem: pem, insecure: true)
+  response = @client.pair_client({facade: 'merchant'})
+  @token = response.first["token"]
+  approve_token_on_server(response.first["pairingCode"])
 end
 
-Then(/^they will receive a claim code$/) do
-  expect(@response.first["pairingCode"] ).not_to be_empty
+Then(/^the user has a merchant token$/) do
+  tokens = {'merchant' => @token}
+  raise "Merchant token not authorized" unless @client.verify_tokens(tokens: tokens)
 end

data/features/step_definitions/refund_steps.rb

@@ -0,0 +1,37 @@
+Given(/^the user creates a refund$/) do
+  client = new_client_from_stored_values
+  @response = client.refund_invoice(id: REFUND_TRANSACTION, params: {amount: 1, currency: 'USD', bitcoinAddress: REFUND_ADDRESS})
+end
+
+Then(/^they will receive a refund id$/) do
+  @refund_id = @response["id"]
+  expect(@refund_id).not_to be_empty
+end
+
+Given(/^the user requests a specific refund$/) do
+  client = new_client_from_stored_values
+  @response = client.get_refund(invoice_id: REFUND_TRANSACTION, request_id: @refund_id)
+end
+
+Then(/^they will receive the refund$/) do
+  expect(@response.first["status"]).not_to be_empty
+end
+
+Given(/^the user requests all refunds for an invoice$/) do
+  client = new_client_from_stored_values
+  @response = client.get_all_refunds_for_invoice(id: REFUND_TRANSACTION)
+end
+
+Then(/^they will receive an array of refunds$/) do
+  expect(@response).to be_instance_of Array
+end
+
+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(invoice_id: REFUND_TRANSACTION, request_id: @refund_id)
+end
+
+Then(/^the refund will be cancelled$/) do
+  expect(@response).to eq("Success")
+end

data/features/step_definitions/step_helpers.rb

@@ -29,6 +29,17 @@ def get_claim_code_from_server
   Capybara::find(".token-claimcode", match: :first).text
 end
 
+def approve_token_on_server(pairing_code)
+  Capybara::visit ROOT_ADDRESS
+  log_in unless logged_in
+  Capybara::visit DASHBOARD_URL
+  raise "Bad Login" unless Capybara.current_session.current_url == DASHBOARD_URL
+  Capybara::visit "#{ROOT_ADDRESS}/api-tokens"
+  Capybara::fill_in 'pairingCode', :with => pairing_code
+  Capybara::click_button "Find"
+  Capybara::click_button "Approve"
+end
+
 def log_in
   Capybara::visit "#{ROOT_ADDRESS}/dashboard/login/"
   Capybara::fill_in 'email', :with => TEST_USER
@@ -53,11 +64,15 @@ 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
-    token = client.pair_pos_client(claim_code)
+    response = client.pair_client({facade: 'merchant'})
+    pairing_code = response.first["pairingCode"]
+    token = response  #.first["token"]
+    approve_token_on_server(pairing_code)
+    
+
     FileUtils.mkdir_p(BitPay::BITPAY_CREDENTIALS_DIR)
     File.write(BitPay::PRIVATE_KEY_PATH, pem)
     File.write(BitPay::TOKEN_FILE_PATH, JSON.generate(token))

data/lib/bitpay/client.rb

@@ -47,8 +47,7 @@ module BitPay
       # => Pass {pairingCode: 'WfD01d2'} to claim a server-initiated pairing code
       #
       def pair_client(params={})
-        tokens = post(path: 'tokens', params: params)
-        return tokens["data"]
+        post(path: 'tokens', params: params)
       end
 
       ## Compatibility method for pos pairing
@@ -70,17 +69,80 @@ module BitPay
         raise BitPay::ArgumentError, "Illegal Argument: Currency is invalid." unless /^[[:upper:]]{3}$/.match(currency)
         params.merge!({price: price, currency: currency})
         token = get_token(facade)
-        invoice = post(path: "invoices", token: token, params: params)
-        invoice["data"]
+        post(path: "invoices", token: token, params: params)
+      end
+
+      ## Gets the privileged merchant-version of the invoice		
+      #   Requires merchant facade token		
+      #		
+      def get_invoice(id:)
+        token = get_token('merchant')
+        get(path: "invoices/#{id}", token: token)
       end
 
       ## Gets the public version of the invoice
       #
       def get_public_invoice(id:)
-        invoice = get(path: "invoices/#{id}", public: true)
-        invoice["data"]
+        get(path: "invoices/#{id}", public: true)
       end
       
+      
+      ## Refund paid BitPay invoice
+      #
+      #   If invoice["data"]["flags"]["refundable"] == true the a refund address was 
+      #   provided with the payment and the refund_address parameter is an optional override
+      #  
+      #   Amount and Currency are required fields for fully paid invoices but optional
+      #   for under or overpaid invoices which will otherwise be completely refunded
+      #
+      #   Requires merchant facade token
+      #
+      #  @example
+      #    client.refund_invoice(id: 'JB49z2MsDH7FunczeyDS8j', params: {amount: 10, currency: 'USD', bitcoinAddress: '1Jtcygf8W3cEmtGgepggtjCxtmFFjrZwRV'})
+      #
+      def refund_invoice(id:, params:{})
+        invoice = get_invoice(id: id)
+        post(path: "invoices/#{id}/refunds", token: invoice["token"], params: params)
+      end
+      
+      ## Get All Refunds for Invoice
+      #   Returns an array of all refund requests for a specific invoice, 
+      # 
+      #   Requires merchant facade token
+      #
+      #  @example:
+      #    client.get_all_refunds_for_invoice(id: 'JB49z2MsDH7FunczeyDS8j')
+      #
+      def get_all_refunds_for_invoice(id:)
+        urlpath = "invoices/#{id}/refunds"
+        invoice = get_invoice(id: id)
+        get(path: urlpath, token: invoice["token"])
+      end
+
+      ## Get Refund
+      #   Requires merchant facade token
+      #
+      #  @example:
+      #    client.get_refund(id: 'JB49z2MsDH7FunczeyDS8j', request_id: '4evCrXq4EDXk4oqDXdWQhX')
+      #
+      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
+      
+      ## Cancel Refund
+      #   Requires merchant facade token
+      #
+      #  @example:
+      #    client.cancel_refund(id: 'JB49z2MsDH7FunczeyDS8j', request_id: '4evCrXq4EDXk4oqDXdWQhX')
+      #
+      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      
+
       ## Checks that the passed tokens are valid by
       #  comparing them to those that are authorized by the server
       #

data/lib/bitpay/rest_connector.rb

@@ -8,7 +8,7 @@ module BitPay
       token ||= get_token(facade)
       case verb.upcase
       when "GET"
-        return get(path: path, token:token)
+        return get(path: path, token: token)
       when "POST"
         return post(path: path, token: token, params: params)
       else
@@ -41,6 +41,15 @@ module BitPay
       process_request(request)
     end
 
+    def delete(path:, token: nil)
+      urlpath = '/' + path
+      urlpath = urlpath + '?token=' + token if token
+      request = Net::HTTP::Delete.new urlpath
+      request['X-Signature'] = KeyUtils.sign(@uri.to_s + urlpath, @priv_key) 
+      request['X-Identity'] = @pub_key
+      process_request(request)
+    end
+
     private
 
     ## Processes HTTP Request and returns parsed response
@@ -58,7 +67,7 @@ module BitPay
       end
 
       if response.kind_of? Net::HTTPSuccess
-        return JSON.parse(response.body)
+        return JSON.parse(response.body)["data"]
       elsif JSON.parse(response.body)["error"]
         raise(BitPayError, "#{response.code}: #{JSON.parse(response.body)['error']}")
       else
@@ -71,7 +80,7 @@ module BitPay
     #  updates @tokens
     #
     def refresh_tokens
-      response = get(path: 'tokens')["data"]
+      response = get(path: 'tokens')
       token_array = response || {}
       tokens = {}
       token_array.each do |t|

data/lib/bitpay/version.rb

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

data/spec/client_spec.rb

@@ -19,6 +19,12 @@ describe BitPay::SDK::Client do
         .to_return(:status => 200, :body => tokens.to_json, :headers => {})
       stub_request(:get, "#{BitPay::TEST_API_URI}/invoices/TEST_INVOICE_ID?token=MERCHANT_TOKEN").
         to_return(:body => get_fixture('invoices_{id}-GET.json'))
+      stub_request(:get, "#{BitPay::TEST_API_URI}/invoices/TEST_INVOICE_ID/refunds?token=MERCHANT_INVOICE_TOKEN").
+        to_return(:body => get_fixture('invoices_{id}_refunds-GET.json'))
+      stub_request(:get, "#{BitPay::TEST_API_URI}/invoices/TEST_INVOICE_ID/refunds/TEST_REQUEST_ID?token=MERCHANT_INVOICE_TOKEN").
+        to_return(:body => get_fixture('invoices_{id}_refunds-GET.json'))
+      stub_request(:post, "#{BitPay::TEST_API_URI}/invoices/TEST_INVOICE_ID/refunds").
+        to_return(:body => get_fixture('invoices_{id}_refunds-POST.json'))
   end
 
   describe "#initialize" do
@@ -109,6 +115,51 @@ describe BitPay::SDK::Client do
     end
   end
 
+  describe '#refund_invoice' do
+    subject { bitpay_client }
+    before { stub_const('ENV', {'BITPAY_PEM' => PEM}) }
+    it { is_expected.to respond_to(:refund_invoice) }
+    
+    it 'should get the token for the invoice' do
+      bitpay_client.refund_invoice(id: 'TEST_INVOICE_ID')
+      expect(WebMock).to have_requested :get, "#{BitPay::TEST_API_URI}/invoices/TEST_INVOICE_ID?token=MERCHANT_TOKEN"
+    end
+    
+    it 'should generate a POST to the invoices/refund endpoint' do
+      bitpay_client.refund_invoice(id: 'TEST_INVOICE_ID')
+      expect(WebMock).to have_requested :post, "#{BitPay::TEST_API_URI}/invoices/TEST_INVOICE_ID/refunds"
+    end
+  end
+  
+  describe '#get_all_refunds_for_invoice' do
+    subject { bitpay_client }
+    before {stub_const('ENV', {'BITPAY_PEM' => PEM})}
+    it { is_expected.to respond_to(:get_all_refunds_for_invoice) }  
+    
+    it 'should get the token for the invoice' do
+      bitpay_client.get_all_refunds_for_invoice(id: 'TEST_INVOICE_ID')
+      expect(WebMock).to have_requested :get, "#{BitPay::TEST_API_URI}/invoices/TEST_INVOICE_ID?token=MERCHANT_TOKEN"
+    end
+    it 'should GET all refunds' do
+      bitpay_client.get_all_refunds_for_invoice(id: 'TEST_INVOICE_ID')
+      expect(WebMock).to have_requested :get, "#{BitPay::TEST_API_URI}/invoices/TEST_INVOICE_ID/refunds?token=MERCHANT_INVOICE_TOKEN"
+    end
+  end
+    
+  describe '#get_refund' do
+    subject { bitpay_client }
+    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(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(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
+
   describe "#verify_tokens" do
     subject { bitpay_client }
     before {stub_const('ENV', {'BITPAY_PEM' => PEM})}

data/spec/fixtures/invoices_{id}_refunds_{refund_id}-GET.json

@@ -1,9 +1,11 @@
 {
   "facade": "merchant/supportRequest",
-  "data": {
-    "id": "TEST_REQUEST_ID",
-    "requestDate": "2015-01-27T00:36:12.360Z",
-    "status": "pending",
-    "token": "REFUND_REQUEST_TOKEN"
-  }
+  "data": [
+    {
+      "id": "TEST_REQUEST_ID",
+      "requestDate": "2015-01-27T00:36:12.360Z",
+      "status": "pending",
+      "token": "REFUND_REQUEST_TOKEN"
+    }
+  ]
 }

data/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitpay-sdk
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.4.0
 platform: ruby
 authors:
 - Bitpay, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-13 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -215,7 +215,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
-- CHANGELOG.md
 - GUIDE.md
 - Gemfile
 - LICENSE.md
@@ -226,9 +225,11 @@ files:
 - config/constants.rb
 - features/creating_invoices.feature
 - features/pairing.feature
+- features/refunds.feature
 - features/retrieving_invoices.feature
 - features/step_definitions/invoice_steps.rb
 - features/step_definitions/keygen_steps.rb
+- features/step_definitions/refund_steps.rb
 - features/step_definitions/step_helpers.rb
 - lib/bitpay/cacert.pem
 - lib/bitpay/client.rb

data/CHANGELOG.md

@@ -1,11 +0,0 @@
-# Change Log
-All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
-
-## [2.3.3] - 2015-03-12
-### Changed
-- Pull refund functionality from 2.3 spec
-- Bump gem version
-
-### Fixed
-- Fix Bug: GitHub issue #40 - error on return from endpoints that do not have a "data" field