bitpay-sdk 2.2.0 → 2.3.0

data/features/step_definitions/step_helpers.rb

@@ -1,17 +1,12 @@
 require 'capybara/poltergeist'
 require 'pry'
+require 'fileutils' 
 
 require File.join File.dirname(__FILE__), '..', '..', 'lib', 'bitpay_sdk.rb'
 require_relative '../../config/constants.rb'
 require_relative '../../config/capybara.rb'
 
-#
-## Test Variables
-#
-#PEM = "-----BEGIN EC PRIVATE KEY-----\nMHQCAQEEICg7E4NN53YkaWuAwpoqjfAofjzKI7Jq1f532dX+0O6QoAcGBSuBBAAK\noUQDQgAEjZcNa6Kdz6GQwXcUD9iJ+t1tJZCx7hpqBuJV2/IrQBfue8jh8H7Q/4vX\nfAArmNMaGotTpjdnymWlMfszzXJhlw==\n-----END EC PRIVATE KEY-----\n"
-#
-#PUB_KEY = '038d970d6ba29dcfa190c177140fd889fadd6d2590b1ee1a6a06e255dbf22b4017'
-#CLIENT_ID = "TeyN4LPrXiG5t2yuSamKqP3ynVk3F52iHrX"
+
 module BitPay
   # Location for API Credentials
   BITPAY_CREDENTIALS_DIR = File.join(Dir.home, ".bitpay")
@@ -21,26 +16,25 @@ module BitPay
   TOKEN_FILE_PATH = File.join(BITPAY_CREDENTIALS_DIR, TOKEN_FILE)
 end
 
+# Lots of sleeps in here to deal with finicky transitions and PhantomJS
 def get_claim_code_from_server
   Capybara::visit ROOT_ADDRESS
-  if logged_in
-    Capybara::visit "#{ROOT_ADDRESS}/home"
-  else
-    log_in
-  end
-  Capybara::click_link "My Account"
-  Capybara::click_link "API Tokens", match: :first
-  Capybara::find(".token-access-new-button").find(".btn").find(".icon-plus").click
-  sleep 0.25
-  Capybara::find_button("Add Token", match: :first).click
+  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::find(".token-access-new-button").find(".btn").find(".icon-plus", match: :first).trigger("click")
+  sleep 0.50
+  Capybara::find(".token-access-new-button-wrapper").find_by_id("token-new-form", visible: true).find(".btn").trigger("click")
   Capybara::find(".token-claimcode", match: :first).text
 end
 
 def log_in
-  Capybara::click_link('Login')
+  Capybara::visit "#{ROOT_ADDRESS}/dashboard/login/"
   Capybara::fill_in 'email', :with => TEST_USER
   Capybara::fill_in 'password', :with => TEST_PASS
-  Capybara::click_button('loginButton')
+  Capybara::click_on('Login')
+  Capybara::find(".ion-gear-a", match: :first)
 end
 
 def new_paired_client
@@ -55,16 +49,20 @@ def new_client_from_stored_values
   if File.file?(BitPay::PRIVATE_KEY_PATH) && File.file?(BitPay::TOKEN_FILE_PATH)
     token = get_token_from_file
     pem = File.read(BitPay::PRIVATE_KEY_PATH)
-    BitPay::SDK::Client.new(pem: pem, tokens: token, insecure: true, api_uri: ROOT_ADDRESS )
+    client = BitPay::SDK::Client.new(pem: pem, tokens: token, insecure: true, api_uri: ROOT_ADDRESS )
+    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)
+    FileUtils.mkdir_p(BitPay::BITPAY_CREDENTIALS_DIR)
     File.write(BitPay::PRIVATE_KEY_PATH, pem)
     File.write(BitPay::TOKEN_FILE_PATH, JSON.generate(token))
-    client
   end   
+  client
 end
 
 def get_token_from_file

data/lib/bitpay/client.rb

@@ -14,39 +14,52 @@ module BitPay
   module SDK
     class Client
       
-
       # @return [Client]
       # @example
       #  # Create a client with a pem file created by the bitpay client:
-      #  client = BitPay::Client.new
+      #  client = BitPay::SDK::Client.new
       def initialize(opts={})
-        @pem               = opts[:pem] || ENV['BITPAY_PEM'] || KeyUtils.generate_pem 
-        @key               = KeyUtils.create_key @pem
-        @priv_key          = KeyUtils.get_private_key @key
-        @pub_key           = KeyUtils.get_public_key @key
-        @client_id         = KeyUtils.generate_sin_from_pem @pem
-        @uri               = URI.parse opts[:api_uri] || API_URI
-        @user_agent        = opts[:user_agent] || USER_AGENT
-        @https             = Net::HTTP.new @uri.host, @uri.port
-        @https.use_ssl     = true
-        @https.ca_file     = CA_FILE
-        @tokens            = opts[:tokens] || {}
+        @pem                = opts[:pem] || ENV['BITPAY_PEM'] || KeyUtils.generate_pem 
+        @key                = KeyUtils.create_key @pem
+        @priv_key           = KeyUtils.get_private_key @key
+        @pub_key            = KeyUtils.get_public_key @key
+        @client_id          = KeyUtils.generate_sin_from_pem @pem
+        @uri                = URI.parse opts[:api_uri] || API_URI
+        @user_agent         = opts[:user_agent] || USER_AGENT
+        @https              = Net::HTTP.new @uri.host, @uri.port
+        @https.use_ssl      = true
+        @https.open_timeout = 10
+        @https.read_timeout = 10
+
+        @https.ca_file      = CA_FILE
+        @tokens             = opts[:tokens] || {}
 
         # Option to disable certificate validation in extraordinary circumstance.  NOT recommended for production use
         @https.verify_mode = opts[:insecure] == true ? OpenSSL::SSL::VERIFY_NONE : OpenSSL::SSL::VERIFY_PEER
         
         # Option to enable http request debugging
         @https.set_debug_output($stdout) if opts[:debug] == true
+      end
 
+      ## Pair client with BitPay service
+      # => Pass empty hash {} to retreive client-initiated pairing code
+      # => Pass {pairingCode: 'WfD01d2'} to claim a server-initiated pairing code
+      #
+      def pair_client(params={})
+        pairing_request(params)
       end
 
+      ## Compatibility method for pos pairing
+      #
       def pair_pos_client(claimCode)
         raise BitPay::ArgumentError, "pairing code is not legal" unless verify_claim_code(claimCode)
-        response = set_pos_token(claimCode)
-        get_token 'pos'
-        response
+        pair_client({pairingCode: claimCode})
       end
 
+      ## Create bitcoin invoice
+      #
+      #   Defaults to pos facade, also works with merchant facade
+      # 
       def create_invoice(price:, currency:, facade: 'pos', params:{})
         raise BitPay::ArgumentError, "Illegal Argument: Price must be formatted as a float" unless ( price.is_a?(Numeric) || /^[[:digit:]]+(\.[[:digit:]]{2})?$/.match(price) )
         raise BitPay::ArgumentError, "Illegal Argument: Currency is invalid." unless /^[[:upper:]]{3}$/.match(currency)
@@ -55,29 +68,92 @@ module BitPay
         response["data"]
       end
 
+      ## Gets the privileged merchant-version of the invoice
+      #   Requires merchant facade token
+      #
+      def get_invoice(id:)
+        response = send_request("GET", "invoices/#{id}", facade: 'merchant')
+        response["data"]        
+      end
+      
+      ## Gets the public version of the invoice
+      #
       def get_public_invoice(id:)
         request = Net::HTTP::Get.new("/invoices/#{id}")
         response = process_request(request)
         response["data"]
       end
       
-      def set_token
+      
+      ## 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)
+        response = send_request("POST", "invoices/#{id}/refunds", facade: nil, token: invoice["token"], params: params)
+        response["data"]
+      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)
+        response = send_request("GET", urlpath, facade: nil, token: invoice["token"])
+        response["data"]
       end
 
-      def verify_token
-        server_tokens = load_tokens
-        @tokens.each{|key, value| return false if server_tokens[key] != value}
+      ## Get Refund
+      #   Requires merchant facade token
+      #
+      #  @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)
+        response = send_request("GET", urlpath, facade: nil, token: invoice["token"])
+        response["data"]
+      end
+
+      ## Checks that the passed tokens are valid by
+      #  comparing them to those that are authorized by the server
+      #
+      #  Uses local @tokens variable if no tokens are passed
+      #  in order to validate the connector is properly paired
+      #
+      def verify_tokens(tokens: @tokens)
+        server_tokens = refresh_tokens
+        tokens.each{|key, value| return false if server_tokens[key] != value}
         return true
       end
+      
       ## Generates REST request to api endpoint
-
+      # =>  Defaults to merchant facade unless token or facade is explicitly provided
+      #
       def send_request(verb, path, facade: 'merchant', params: {}, token: nil)
         token ||= get_token(facade)
 
         # Verb-specific logic
         case verb.upcase
           when "GET"
-            urlpath = '/' + path + '?nonce=' + KeyUtils.nonce + '&token=' + token
+            urlpath = '/' + path + '?token=' + token
             request = Net::HTTP::Get.new urlpath
             request['X-Signature'] = KeyUtils.sign(@uri.to_s + urlpath, @priv_key)
 
@@ -88,7 +164,6 @@ module BitPay
             urlpath = '/' + path
             request = Net::HTTP::Post.new urlpath
             params[:token] = token
-            params[:nonce] = KeyUtils.nonce
             params[:guid]  = SecureRandom.uuid
             params[:id] = @client_id
             request.body = params.to_json
@@ -133,19 +208,17 @@ module BitPay
           
       end
 
-      ## Requests token by appending nonce and signing URL
-      #  Returns a hash of available tokens
+      ## Fetches the tokens hash from the server and
+      #  updates @tokens
       #
-      def load_tokens
-
-        urlpath = '/tokens?nonce=' + KeyUtils.nonce
+      def refresh_tokens
+        urlpath = '/tokens'
 
         request = Net::HTTP::Get.new(urlpath)
-        request['x-identity'] = @pub_key
-        request['x-signature'] = KeyUtils.sign(@uri.to_s + urlpath, @priv_key)
+        request['X-Identity'] = @pub_key
+        request['X-Signature'] = KeyUtils.sign(@uri.to_s + urlpath, @priv_key)
 
         response = process_request(request)
-
         token_array = response["data"] || {}
 
         tokens = {}
@@ -158,9 +231,13 @@ module BitPay
 
       end
 
-      ## Retrieves specified token from hash, otherwise tries to refresh @tokens and retry
-      def set_pos_token(claim_code)
-        params = {pairingCode: claim_code}
+      ## Makes a request to /tokens for pairing
+      #     Adds passed params as post parameters
+      #     If empty params, retrieves server-generated pairing code
+      #     If pairingCode key/value is passed, will pair client ID to this account
+      #   Returns response hash
+      #
+      def pairing_request(params)
         urlpath = '/tokens'
         request = Net::HTTP::Post.new urlpath
         params[:guid] = SecureRandom.uuid
@@ -170,7 +247,7 @@ module BitPay
       end
 
       def get_token(facade)
-        token = @tokens[facade] || load_tokens[facade] || raise(BitPayError, "Not authorized for facade: #{facade}")
+        token = @tokens[facade] || refresh_tokens[facade] || raise(BitPayError, "Not authorized for facade: #{facade}")
       end
 
       def verify_claim_code(claim_code)

data/lib/bitpay/version.rb

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

data/spec/client_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 def tokens
     {"data" => 
-      [{"merchant" => "MERCHANTTOKEN"},
-      {"pos" =>"POSTOKEN"},
+      [{"merchant" => "MERCHANT_TOKEN"},
+      {"pos" =>"POS_TOKEN"},
       {"merchant/invoice" => "9kv7gGqZLoQ2fxbKEgfgndLoxwjp5na6VtGSH3sN7buX"}
       ]
     }
@@ -14,8 +14,17 @@ describe BitPay::SDK::Client do
   let(:claim_code) { "a12bc3d" }
 
   before do
-      allow(BitPay::KeyUtils).to receive(:nonce).and_return('1')
-      stub_request(:get, /#{BitPay::TEST_API_URI}\/tokens.*/).to_return(:status => 200, :body => tokens.to_json, :headers => {})
+      # Stub JSON responses from fixtures
+      stub_request(:get, /#{BitPay::TEST_API_URI}\/tokens.*/)
+        .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
@@ -36,7 +45,7 @@ describe BitPay::SDK::Client do
       it 'should generate a get request' do
         stub_request(:get, /#{BitPay::TEST_API_URI}\/whatever.*/).to_return(:body => '{"awesome": "json"}')
         bitpay_client.send_request("GET", "whatever", facade: "merchant")
-        expect(WebMock).to have_requested(:get, "#{BitPay::TEST_API_URI}/whatever?nonce=1&token=MERCHANTTOKEN") 
+        expect(WebMock).to have_requested(:get, "#{BitPay::TEST_API_URI}/whatever?token=MERCHANT_TOKEN") 
       end
     end
 
@@ -68,7 +77,7 @@ describe BitPay::SDK::Client do
     it 'short circuits on invalid pairing codes' do
       100.times do
         claim_code = an_illegal_claim_code
-        expect{bitpay_client.pair_pos_client(claim_code)}.to raise_error BitPay::ArgumentError, "pairing code is not legal"
+        expect { bitpay_client.pair_pos_client(claim_code) }.to raise_error BitPay::ArgumentError, "pairing code is not legal"
       end
     end
   end
@@ -106,19 +115,55 @@ describe BitPay::SDK::Client do
     end
   end
 
-  describe '#set_token' do
+  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(:set_token) }
-    it 'sets a token in the client' do
-
+    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(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')
+      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_token" do
+  describe "#verify_tokens" do
     subject { bitpay_client }
     before {stub_const('ENV', {'BITPAY_PEM' => PEM})}
-    it { is_expected.to respond_to(:verify_token) }
+    it { is_expected.to respond_to(:verify_tokens) }
   end
 end
 

data/spec/fixtures/invoices-POST.json

@@ -0,0 +1,29 @@
+{
+  "facade": "pos/invoice",
+  "data": {
+    "url": "https://test.bitpay.com/invoice?id=2RSyNDvsiTrA31rPwnnEcd",
+    "status": "new",
+    "btcPrice": "0.037523",
+    "btcDue": "0.037523",
+    "price": 10,
+    "currency": "USD",
+    "exRates": {
+      "USD": 266.5
+    },
+    "invoiceTime": 1422319964413,
+    "expirationTime": 1422320864413,
+    "currentTime": 1422319964431,
+    "guid": "34d7be05-eb65-4f72-a2ce-79bf23e93f17",
+    "id": "2RSyNDvsiTrA31rPwnnEcd",
+    "btcPaid": "0.000000",
+    "rate": 266.5,
+    "exceptionStatus": false,
+    "paymentUrls": {
+      "BIP21": "bitcoin:mhPM48eieakd6AgCuHMwAtpFXE5yQ3N7om?amount=0.037523",
+      "BIP72": "bitcoin:mhPM48eieakd6AgCuHMwAtpFXE5yQ3N7om?amount=0.037523&r=https://test.bitpay.com/i/2RSyNDvsiTrA31rPwnnEcd",
+      "BIP72b": "bitcoin:?r=https://test.bitpay.com/i/2RSyNDvsiTrA31rPwnnEcd",
+      "BIP73": "https://test.bitpay.com/i/2RSyNDvsiTrA31rPwnnEcd"
+    },
+    "token": "2RPipMRUXAvt5wAfthCzF7Tj4SppBWPHGQ7hCeWYeWDm7RtwUtDds1XUNt11VTf5C6UfCAACBhsKwjW6SAocLsd7"
+  }
+}