Merge pull request #1 from anditto/singlesatoshipayment-fix

Allow single satoshi units for invoice creations

.gitignore

@@ -10,3 +10,4 @@ pkg
 bitpaykey.pem
 constants.txt
 coverage/
+.pem.data

.travis.yml

@@ -1,2 +1,5 @@
+sudo: false
 rvm:
-- 2.1.0
+- 2.1.10
+- 2.2.5
+- 2.3.1

GUIDE.md

@@ -29,8 +29,6 @@ Most calls to the BitPay REST API require that your client is paired with the bi
 
 Your client can be paired via the `pos` (point-of-sale) or `merchant` facade (or both).  The `pos` facade allows for invoices to be created.  The `merchant` facade has broader privileges to view all invoices, bills, and ledger entries, as well as to issue refunds.  Consider the level of access required when you pair your client.
 
-_For development or quick deployment purposes, consider the [BitPay Ruby Command-Line Interface](https://github.com/bitpay/ruby-cli) to simplify the deployment process_
-
 ### A quick note on keys
 
 The BitPay client gem includes the BitPay KeyUtilities gem, which can be used to generate new public private key pairs which it returns in PEM format. However, there are no methods which save the keys anywhere, so it is your responsibility to store the PEM file somewhere secure.
@@ -38,10 +36,11 @@ The BitPay client gem includes the BitPay KeyUtilities gem, which can be used to
 ### BitPay authentication
 
 BitPay authentication depends on four parts:
+
 1. An account on our servers.
-2. A token shared between the client and the server.
-3. A public key, shared between the client and the server.
-4. A private key, held exclusively by the client.
+1. A token shared between the client and the server.
+1. A public key, shared between the client and the server.
+1. A private key, held exclusively by the client.
 
 In order to complete authentication, you have to associate your private key with a token, and associate that token with an account. Once this authentication is complete, as long as you have the private key, you never have to authenticate again. The token you created will always be associated with that private key, so any time you create a new bitpay client object with that key, it is authenticated with BitPay. This is true whether you use the ruby-client, python client, or no client at all, the key is the important thing. 
 
@@ -82,7 +81,7 @@ As described above, using the value from the `pairingCode` element, visit https:
 ### Initialize the client
 
 ```ruby
-client = BitPay::SDK::Client.new(pem: File.read('bitpaykey.pem')
+client = BitPay::SDK::Client.new(pem: File.read('bitpaykey.pem'))
 ```
     
 Optional parameters:
@@ -95,7 +94,7 @@ Optional parameters:
 ### Create a new bitcoin invoice
 
 ```ruby
-invoice = client.create_invoice (price: <price>, currency: <currency>)
+invoice = client.create_invoice(price: <price>, currency: <currency>)
 ```
 
 With invoice creation, `price` and `currency` are the only required fields. If you are sending a customer from your website to make a purchase, setting `redirectURL` will redirect the customer to your website when the invoice is paid.
@@ -185,12 +184,20 @@ client.cancel_refund(id: 'JB49z2MsDH7FunczeyDS8j', request_id: '4evCrXq4EDXk4oqD
 
 ### Make a HTTP request directly against the REST API
 
-For API tasks which lack a dedicated library method, BitPay provides a method that will automatically apply the proper cryptographic parameters to a request.
+For API tasks which lack a dedicated library method, BitPay provides methods that will automatically apply the proper cryptographic parameters to a request.
 
 ```ruby
-client.send_request("GET", "/invoices/JB49z2MsDH7FunczeyDS8j", facade: 'merchant')
+client.send_request("GET", "invoices/JB49z2MsDH7FunczeyDS8j", facade: 'merchant')
+## This request is identical to:
+token = client.get_token("merchant")
+client.get(path: "invoices/JB49z2MsDH7FunczeyDS8j", token: token)
+
+## post requests are also possible
+token = client.get_token("merchant")
+client.post(path: "tokens", token: token, params: {facade: "pos"})  #returns a new token with pairing code
+## equivalent to
+client.send_request("POST", "tokens", facade: 'merchant', params: {facade: 'pos'})
 ```
-    
 Usage:
  * Specify HTTP verb and REST endpoint
  * Specifying a `facade` will fetch and apply the corresponding `token`

README.md

@@ -8,9 +8,9 @@
 
 Powerful, flexible, lightweight interface to the BitPay Bitcoin Payment Gateway API.
 
-The `bitpay-sdk` gem provides all the programattic tools required to implement a ruby client application for the BitPay REST API.  For developers who prefer the ease of command-line pairing during the development or deployment process, BitPay provides a complementary [Ruby CLI gem](https://github.com/bitpay/ruby-cli) which can be used in conjunction with this gem.
+The `bitpay-sdk` gem provides all the programattic tools required to implement a ruby client application for the BitPay REST API.
 
-## [Getting Started »](http://dev.bitpay.com/guides/ruby.html)
+## [Getting Started »](https://github.com/bitpay/ruby-client/blob/master/GUIDE.md)
 
 ## Found a bug?
 Let us know! Send a pull request or a patch. Questions? Ask! We're here to help. We will respond to all filed issues.

Rakefile

@@ -1,12 +1,9 @@
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
-require 'capybara'
-require 'capybara/poltergeist'
 require 'mongo'
 require 'cucumber'
 require 'cucumber/rake/task'
 require_relative 'config/constants.rb'
-require_relative 'config/capybara.rb'
 
 RSpec::Core::RakeTask.new(:spec)
 

bitpay-sdk.gemspec

@@ -17,18 +17,15 @@ Gem::Specification.new do |s|
   s.bindir        = 'bin'
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
 
-  s.add_dependency 'json',      '~>1.8'
-  s.add_dependency 'rack',      '~>1.5'
   s.add_dependency 'bitpay-key-utils', '~>2.0.0'
 
-  s.add_development_dependency 'rake', '10.3.2'
+  s.add_development_dependency 'rack', '~> 2.0'
+  s.add_development_dependency 'rake', '12.0'
   s.add_development_dependency 'webmock', '1.18.0'
   s.add_development_dependency 'pry', '0.10.1'
   s.add_development_dependency 'pry-byebug', '2.0.0'
   s.add_development_dependency 'pry-rescue', '1.4.1'
-  s.add_development_dependency 'capybara', '2.4.3'
-  s.add_development_dependency 'cucumber', '1.3.17'
-  s.add_development_dependency 'poltergeist', '1.5.1'
+  s.add_development_dependency 'cucumber', '~> 1.3.17'
   s.add_development_dependency 'airborne', '0.0.20'
   s.add_development_dependency 'rspec', '3.1.0'
   s.add_development_dependency 'mongo', '1.11.1'

config/capybara.rb

@@ -1,6 +0,0 @@
-Capybara.javascript_driver = :poltergeist
-Capybara.default_driver = :poltergeist
-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

config/constants.rb

@@ -5,19 +5,8 @@
 #    source ./spec/set_constants.sh https://test.bitpay.com testuser@gmail.com mypassword
 #
 
-ROOT_ADDRESS = ENV['RCROOTADDRESS']
-TEST_USER = ENV['RCTESTUSER']
-TEST_PASS = ENV['RCTESTPASSWORD']
-DASHBOARD_URL = "#{ROOT_ADDRESS}/dashboard/merchant/home"
+APIURI = ENV['BITPAYAPI']
 
 # 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 &&
-  TEST_PASS
-then
-  raise "Missing configuration options - see constants.rb"
-end

features/pairing.feature

@@ -5,11 +5,11 @@ 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
+    Then the user receives a require token from bitpay
 
   Scenario: the client initiates pairing
     Given the user performs a client-side pairing
-    Then the user has a merchant token
+    Then the user receives an inactive token from bitpay
 
   Scenario Outline: the client has a bad pairing code
     Given the user fails to pair with a semantically <valid> code <code>
@@ -17,8 +17,3 @@ Feature: pairing with bitpay
   Examples:
       | valid   | code       | error                 | message                       |
       | invalid | "a1b2c3d4" | BitPay::ArgumentError | "pairing code is not legal"   |
-
-  Scenario: the client has a bad port configuration to a closed port
-    When the fails to pair with BitPay because of an incorrect port
-    Then they will receive a BitPay::ConnectionError matching "Connection refused" 
-

features/refunds.feature

@@ -3,6 +3,9 @@ Feature: issuing a refund
   The merchant wants to issue a refund
   So that they can serve their customers
 
+  Background:
+    Given the user is authenticated with BitPay
+
   Scenario: creating a refund
     Given the user creates a refund
     Then they will receive a refund id

features/step_definitions/keygen_steps.rb

@@ -2,42 +2,33 @@
 @error = nil
 
 When(/^the user pairs with BitPay(?: with a valid pairing code|)$/) do
-  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)
+  @client = new_client_from_stored_values
+  claim_code = get_claim_code_from_server @client
   sleep 1 # rate limit compliance
   @token = @client.pair_pos_client(claim_code)
 end
 
-When(/^the fails to pair with BitPay because of an incorrect port$/) do
-  pem = BitPay::KeyUtils.generate_pem
-  address = ROOT_ADDRESS.split(':').slice(0,2).join(':') + ":999"
-  client = BitPay::SDK::Client.new(api_uri: address, pem: pem, insecure: true)
-  begin
-    sleep 1 # rate limit compliance
-    client.pair_pos_client("1ab2c34")
-    raise "pairing unexpectedly worked"
-  rescue => error
-    @error = error
-    true
-  end
-end
-
 Given(/^the user is authenticated with BitPay$/) do
   @client = new_client_from_stored_values
+  raise "client not authenticated" unless client_has_tokens(@client)
 end
 
 Given(/^the user is paired with BitPay$/) do
   raise "Client is not paired" unless @client.verify_tokens
 end
 
+Then(/^the user receives an? ([A-z]+) token from bitpay$/) do |expected|
+  actual = @token[0]["policies"][0]["method"]
+  raise "Token not correct, #{actual} != #{expected}" unless actual == expected
+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
 
 Then(/^the user fails to pair with a semantically (?:in|)valid code "(.*?)"$/) do |code|
   pem = BitPay::KeyUtils.generate_pem
-  client = BitPay::SDK::Client.new(api_uri: ROOT_ADDRESS, pem: pem, insecure: true)
+  client = BitPay::SDK::Client.new(api_uri: APIURI, pem: pem, insecure: true)
   begin
     sleep 1 # rate limit compliance
     client.pair_pos_client(code)
@@ -55,10 +46,8 @@ end
 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({facade: 'merchant'})
-  @token = response.first["token"]
-  approve_token_on_server(response.first["pairingCode"])
+  @client = BitPay::SDK::Client.new(api_uri: APIURI, pem: pem, insecure: true)
+  @token = @client.pair_client({facade: 'merchant'})
 end
 
 Then(/^the user has a merchant token$/) do

features/step_definitions/refund_steps.rb

@@ -1,7 +1,6 @@
 Given(/^the user creates a refund$/) do
   sleep(1)
-  client = new_client_from_stored_values
-  @response = client.refund_invoice(id: REFUND_TRANSACTION, params: {amount: 1, currency: 'USD', bitcoinAddress: REFUND_ADDRESS})
+  @response = @client.refund_invoice(id: REFUND_TRANSACTION, params: {amount: 1, currency: 'USD', bitcoinAddress: REFUND_ADDRESS})
 end
 
 Then(/^they will receive a refund id$/) do
@@ -10,8 +9,7 @@ Then(/^they will receive a refund id$/) do
 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)
+  @response = @client.get_refund(invoice_id: REFUND_TRANSACTION, request_id: @refund_id)
 end
 
 Then(/^they will receive the refund$/) do

features/step_definitions/step_helpers.rb

@@ -1,10 +1,8 @@
-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'
 
 
 module BitPay
@@ -16,77 +14,18 @@ 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
-  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 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
-  sleep 0.50
-  Capybara::find(".token-access-approve-pairing").find(".token-access-approve-pairing-code").find(".btn").trigger("click")
-  sleep 0.50
-  Capybara::find(".token-access-request-manager").find(".token-access-request").find(".api-manager-actions-confirm").find(".ajaxForm").find(".btn").trigger("click")
-end
-
-def log_in
-  Capybara::visit "#{ROOT_ADDRESS}/dashboard/login/"
-  Capybara::fill_in 'email', :with => TEST_USER
-  Capybara::fill_in 'password', :with => TEST_PASS
-  Capybara::click_on('Login')
-  Capybara::find(".ion-gear-a", match: :first)
-end
-
-def new_paired_client
-  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)
-  client.pair_pos_client(claim_code)
-  client
-end
-
 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)
-    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
-    pem = BitPay::KeyUtils.generate_pem
-    client = BitPay::SDK::Client.new(api_uri: ROOT_ADDRESS, pem: pem, insecure: true)
-    sleep 1 # rate limit compliance
-    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))
-  end   
-  client
+  pem = ENV['BITPAYPEM'].gsub("\\n", "\n")
+  BitPay::SDK::Client.new(api_uri: APIURI, pem: pem, insecure: true)
 end
 
-def get_token_from_file
-  token = JSON.parse(File.read(BitPay::TOKEN_FILE_PATH))[0]
-  {token['facade'] => token['token']}
+def get_claim_code_from_server client
+  token = client.get(path: "tokens")["data"].select{|tuple| tuple["merchant"]}.first.values.first
+  client.post(path: "tokens", token: token, params: {facade: "pos"})["data"][0]["pairingCode"]
 end
 
-def logged_in
-  Capybara::has_link?('Dashboard')
+def client_has_tokens client
+  data = client.get(path: "tokens")["data"]
+  data.select{|tuple| tuple["pos"]}.any? && data.select{|tuple| tuple["merchant"]}.any?
 end
+

lib/bitpay/client.rb

@@ -66,7 +66,7 @@ module BitPay
         raise BitPay::ArgumentError, "Illegal Argument: Price must be formatted as a float" unless 
           price.is_a?(Numeric) ||
           /^[[:digit:]]+(\.[[:digit:]]{2})?$/.match(price) ||
-          currency == 'BTC' && /^[[:digit:]]+(\.[[:digit:]]{1,6})?$/.match(price)
+          currency == 'BTC' && /^[[:digit:]]+(\.[[:digit:]]{1,8})?$/.match(price)
         raise BitPay::ArgumentError, "Illegal Argument: Currency is invalid." unless /^[[:upper:]]{3}$/.match(currency)
         params.merge!({price: price, currency: currency})
         token = get_token(facade)
@@ -83,10 +83,15 @@ module BitPay
         invoice["data"]
       end
 
+      def get_invoices(params = {}) 
+        token = get_token('merchant')    
+        invoice = get(path: "invoices", token: token, params: params)
+        invoice["data"]
+      end
+
       ## Gets the public version of the invoice
-      #
       def get_public_invoice(id:)
-        invoice = get(path: "invoices/#{id}", public: true)
+        invoice = get(path: "invoices/#{id}", public_request: true)
         invoice["data"]
       end
       

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, params: params)
       when "POST"
         return post(path: path, token: token, params: params)
       else
@@ -16,12 +16,12 @@ module BitPay
       end
     end
 
-    def get(path:, token: nil, public: false)
-      urlpath = '/' + path
-      token_prefix = if urlpath.include? '?' then '&token=' else '?token=' end
-      urlpath = urlpath + token_prefix + token if token
+    def get(path:, token: nil, public_request: false, params: {})
+      urlpath = '/' + path + '?'
+      urlpath = urlpath + 'token=' + token if token
+      urlpath = urlpath + '&' + params.to_param if params.present?
       request = Net::HTTP::Get.new urlpath
-      unless public
+      unless public_request
         request['X-Signature'] = KeyUtils.sign(@uri.to_s + urlpath, @priv_key) 
         request['X-Identity'] = @pub_key
       end

lib/bitpay/version.rb

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

spec/set_constants.sh

@@ -1,12 +0,0 @@
-#!/bin/bash
-
-export RCROOTADDRESS=$1
-echo $RCROOTADDRESS
-export RCTESTUSER=$2
-echo $RCTESTUSER
-export RCTESTPASSWORD=$3
-echo $RCTESTPASSWORD
-export REFUND_TRANSACTION=$4
-echo $REFUND_TRANSACTION
-export REFUND_ADDRESS=$5
-echo $REFUND_ADDRESS

spec/spec_helper.rb

@@ -1,13 +1,10 @@
 require 'webmock/rspec'
 require 'pry'
-require 'capybara/rspec'
-require 'capybara/poltergeist'
 require 'coveralls'
 Coveralls.wear!
 
 require File.join File.dirname(__FILE__), '..', 'lib', 'bitpay_sdk.rb'
 require_relative '../config/constants.rb'
-require_relative '../config/capybara.rb'
 
 #
 ## Test Variables