bitpay-sdk 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8fa092d5243a1f4759ce3735f53b892ffd70741
+  data.tar.gz: 2befc033218ad775ecada44facf7836498e86371
+SHA512:
+  metadata.gz: 93fd95f0d1533ef5cf48eed9e964a03b2320409b6ee6fc3fbb66a75012f94a23c8568742bab6e2086994d1eae99635acac70c0b94254bbb2c7a8fb5448b29f9c
+  data.tar.gz: 5196595d3e0d36c58c1a3481d2a4924b848583e417e9418954c3f66921255fa0369cc37d3143afaf9d0a3b1fce138fdf551990a48182289cb153b9e7733da19f

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+test.rb
+Gemfile.lock
+pkg
+.c9
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec
+
+platform :jruby do
+  gem 'jruby-openssl'
+end

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (C) 2014 BitPay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# BitPay Library for Ruby [![](https://secure.travis-ci.org/bitpay/ruby-client.png)](http://travis-ci.org/bitpay/ruby-client)
+Powerful, flexible, lightweight interface to the BitPay Bitcoin Payment Gateway API.
+
+## Installation
+
+    gem install bitpay
+    
+In your Gemfile:
+
+    gem 'bitpay', :require => 'bitpay'
+
+Or directly:
+
+    require 'bitpay'
+
+## Configuration
+
+The bitpay client creates a cryptographically secure connection to your server by pairing an API code with keys generated by the library. The client can be initialized with pre-existing keys passed in as a pem file, or paired if initialized with a pem file and a tokens hash. Examples can be found in the cucumber step helpers.
+
+## Basic Usage
+
+### Pairing with Bitpay.com
+
+To pair with bitpay.com you need to have an approved merchant account.  
+1. Login to your account  
+2. Navigate to bitpay.com/api-tokens (Dashboard > My Account > API Tokens)  
+3. Create a new token and copy the pairing code.  
+
+    client = BitPay::Client.new
+    client.pair_pos_client(<pairing_code>)
+    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.
+
+Response will be a hash with information on your newly created invoice. Send your customer to the `url` to complete payment:
+
+    {
+      "id"             => "DGrAEmbsXe9bavBPMJ8kuk", 
+      "url"            => "https://bitpay.com/invoice?id=DGrAEmbsXe9bavBPMJ8kuk",
+      "status"         => "new",
+      "btcPrice"       => "0.0495",
+      "price"          => 10,
+      "currency"       => "USD",
+      "invoiceTime"    => 1383265343674,
+      "expirationTime" => 1383266243674,
+      "currentTime"    => 1383265957613
+    }
+
+There are many options available when creating invoices, which are listed in the [BitPay API documentation](https://bitpay.com/bitcoin-payment-gateway-api).
+
+To get updated information on this invoice, make a get call with the id returned:
+
+    invoice = client.get_public_invoice(id: 'DGrAEmbsXe9bavBPMJ8kuk')
+
+## Testnet Usage
+
+During development and testing, take advantage of the [Bitcoin TestNet](https://en.bitcoin.it/wiki/Testnet) by passing a custom `api_uri` option on initialization:
+
+    BitPay::Client.new(api_uri: "https://test.bitpay.com/api")
+
+## API Documentation
+
+API Documentation is available on the [BitPay site](https://bitpay.com/api).
+
+## Running the Tests
+
+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:
+    
+    $ source ./spec/set_constants.sh https://test.bitpay.com <yourusername> <yourpassword>
+    $ bundle install
+    $ bundle exec rake
+
+Tests are likely to run up against rate limiters on test.bitpay.com if used too frequently. Rake tasks which interact directly with BitPay will not run for the general public.
+
+## 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.
+
+## Contributors
+[Click here](https://github.com/bitpay/ruby-client/graphs/contributors) to see a list of the contributors to this library.

data/Rakefile

@@ -0,0 +1,73 @@
+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)
+
+task :default => :spec
+
+Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "features --format pretty"
+end
+
+desc "Bitpay Tasks"
+namespace :bitpay do
+
+  desc "Clear all claim codes from the test server."
+  task :clear_claim_codes do
+    puts "clearing claim codes"
+    client = Mongo::MongoClient.new
+    db     = client['bitpay-dev']
+    coll   = db['tokenaccesses']
+    coll.remove()
+    puts "claim codes cleared"
+  end
+
+  desc "Clear rate limiters from local mongo host"
+  task :clear_rate_limiters do
+    puts "clearing rate limiters"
+    client = Mongo::MongoClient.new
+    db     = client['bitpay-dev']
+    coll   = db['ratelimiters']
+    coll.remove()
+    puts "rate limiters cleared"
+  end
+
+  desc "Clear local pem and token file"
+  task :clear_local_files do
+    puts "clearing local files"
+    HOME_DIR = File.join(Dir.home, '.bitpay')
+    KEY_FILE = File.join(HOME_DIR, 'bitpay.pem')
+    TOKEN_FILE = File.join(HOME_DIR, 'tokens.json')
+    File.delete(KEY_FILE) if File.file?(KEY_FILE)
+    File.delete(TOKEN_FILE) if File.file?(TOKEN_FILE)
+    puts "local files cleared"
+  end
+
+  desc "Clear tokens, rate limiters, and local files."
+  task :clear do
+    ["bitpay:clear_local_files", "bitpay:clear_rate_limiters", "bitpay:clear_claim_codes"].each{|task| Rake::Task[task].reenable}
+    ["bitpay:clear_local_files", "bitpay:clear_rate_limiters", "bitpay:clear_claim_codes"].each{|task| Rake::Task[task].invoke}
+  end
+
+  desc "Run specs and clear claim codes and rate_limiters."
+  task :spec_clear => ['spec', 'clear_claim_codes', 'clear_rate_limiters']
+
+  desc "Run specs, clear data, run cukes, clear data"
+  task :tests_clear do
+    Rake::Task["bitpay:clear"].invoke
+    Rake::Task["spec"].invoke
+    Rake::Task["bitpay:clear"].reenable
+    Rake::Task["bitpay:clear"].invoke
+    Rake::Task["features"].invoke
+    Rake::Task["bitpay:clear"].reenable
+    Rake::Task["bitpay:clear"].invoke
+  end
+
+end

data/bitpay-sdk.gemspec

@@ -0,0 +1,35 @@
+require './lib/bitpay/version.rb'
+Gem::Specification.new do |s|
+  s.name = 'bitpay-sdk'
+  s.version = BitPay::VERSION
+  s.licenses = ['MIT']
+  s.authors = 'Bitpay, Inc.'
+  s.email = 'info@bitpay.com'
+  s.homepage = 'https://github.com/bitpay/ruby-client'
+  s.summary = 'Official Ruby library for the BitPay API'
+  s.description = 'Powerful, flexible, lightweight, thread-safe interface to the BitPay developers API'
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.rubyforge_project = s.name
+  s.required_rubygems_version = '>= 1.3.4'
+  s.required_ruby_version = '~> 2.1'
+  s.bindir        = 'bin'
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.add_dependency 'json',      '~> 1.8.1'
+  s.add_dependency 'rack',      '~> 1.5.2'
+  s.add_dependency 'ecdsa',     '~> 1.2.0'
+
+  s.add_development_dependency 'rake', '~> 10.3.2'
+  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 'airborne', '~> 0.0.20'
+  s.add_development_dependency 'rspec', '~> 3.1.0'
+  s.add_development_dependency 'mongo', '~> 1.11.1'
+end

data/config/capybara.rb

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

data/config/constants.rb

@@ -0,0 +1,3 @@
+ROOT_ADDRESS = ENV['RCROOTADDRESS']
+TEST_USER = ENV['RCTESTUSER']
+TEST_PASS = ENV['RCTESTPASSWORD']

data/features/creating_invoices.feature

@@ -0,0 +1,26 @@
+Feature: creating an invoice
+  The user won't get any money 
+  If they can't
+  Create Invoices
+
+  Background:
+    Given the user is authenticated with BitPay
+
+  Scenario Outline: The request is correct
+    When the user creates an invoice for <price> <currency>
+    Then they should recieve an invoice in response for <price> <currency>
+  Examples:
+    | price    | currency |
+    | "500.23" | "USD"    |
+    | "300.21" | "EUR"    |
+
+  Scenario Outline: The invoice contains illegal characters
+    When the user creates an invoice for <price> <currency>
+    Then they will receive a BitPay::ArgumentError matching <message>
+  Examples:
+    | price    | currency  | message                              |
+    | "50,023" | "USD"     | "Price must be formatted as a float" |
+    | "300.21" | "EaUR"    | "Currency is invalid."               |
+    | ""       | "USD"     | "Price must be formatted as a float" |
+    | "Ten"    | "USD"     | "Price must be formatted as a float" |
+    | "100"    | ""        | "Currency is invalid."               |

data/features/pairing.feature

@@ -0,0 +1,21 @@
+Feature: pairing with bitpay
+  In order to access bitpay
+  It is required that the library
+  Is able to pair successfully
+
+  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 Outline: the client has a bad pairing code
+    Given the user fails to pair with a semantically <valid> code <code>
+    Then they will receive a <error> matching <message>
+  Examples:
+      | valid   | code       | error                 | message                       |
+      | valid   | "a1b2c3d"  | BitPay::BitPayError   | "500: Unable to create token" |
+      | 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" 
+

data/features/retrieving_invoices.feature

@@ -0,0 +1,7 @@
+Feature: retrieving an invoice
+  The user may want to retrieve invoices
+  So that they can view them
+
+  Scenario: The request is correct
+    Given that a user knows an invoice id
+    Then they can retrieve that invoice

data/features/step_definitions/invoice_steps.rb

@@ -0,0 +1,26 @@
+When(/^the user (?:tries to |)creates? an invoice (?:for|without) "(.*?)" (?:or |and |)"(.*?)"$/) do |price, currency|
+  begin
+    @response = @client.create_invoice(price: price, currency: currency)
+  rescue => error
+    @error = error
+  end
+end
+
+Then(/^they should recieve an invoice in response for "(.*?)" "(.*?)"$/) do |price, currency|
+  raise "#{@response['price']} != #{price} or #{@response['currency']} != #{currency}" unless (price == @response['price'].to_s && currency == @response['currency'])
+end
+
+Given(/^there is an invalid token$/) do
+    pending # express the regexp above with the code you wish you had
+end
+
+Given(/^that a user knows an invoice id$/) do
+  client = new_paired_client
+  @id = (client.create_invoice(price: 100, currency: "USD" ))['id']
+end
+
+Then(/^they can retrieve that invoice$/) do
+  invoice = BitPay::Client.new(api_uri: ROOT_ADDRESS, insecure: true).get_public_invoice(id: @id)
+  raise "That's the wrong invoice" unless invoice['id'] == @id
+end
+

data/features/step_definitions/keygen_steps.rb

@@ -0,0 +1,51 @@
+@token = nil
+@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::Client.new(api_uri: ROOT_ADDRESS, pem: pem, insecure: true)
+  @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::Client.new(api_uri: address, pem: pem, insecure: true)
+  begin
+    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
+end
+
+Given(/^the user is paired with BitPay$/) do
+  raise "Client is not paired" unless @client.verify_token
+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::Client.new(api_uri: ROOT_ADDRESS, pem: pem, insecure: true)
+  begin
+    client.pair_pos_client(code)
+    raise "pairing unexpectedly worked"
+  rescue => error
+    @error = error
+    true
+  end
+end
+
+Then(/^they will receive an? (.*?) matching "(.*?)"$/) do |error_class, error_message|
+  raise "Error: #{@error.class}, message: #{@error.message}" unless Object.const_get(error_class) == @error.class && @error.message.include?(error_message)
+end
+

data/features/step_definitions/step_helpers.rb

@@ -0,0 +1,79 @@
+require 'capybara/poltergeist'
+require 'pry'
+
+require File.join File.dirname(__FILE__), '..', '..', 'lib', 'bitpay', 'client.rb'
+require File.join File.dirname(__FILE__), '..', '..', 'lib', 'bitpay', 'key_utils.rb'
+require File.join File.dirname(__FILE__), '..', '..', 'lib', 'bitpay.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")
+  PRIVATE_KEY_FILE = 'bitpay.pem'
+  PRIVATE_KEY_PATH = File.join(BITPAY_CREDENTIALS_DIR, PRIVATE_KEY_FILE)
+  TOKEN_FILE = 'tokens.json'
+  TOKEN_FILE_PATH = File.join(BITPAY_CREDENTIALS_DIR, TOKEN_FILE)
+end
+
+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
+  Capybara::find(".token-claimcode", match: :first).text
+end
+
+def log_in
+  Capybara::click_link('Login')
+  Capybara::fill_in 'email', :with => TEST_USER
+  Capybara::fill_in 'password', :with => TEST_PASS
+  Capybara::click_button('loginButton')
+end
+
+def new_paired_client
+  claim_code = get_claim_code_from_server
+  pem = BitPay::KeyUtils.generate_pem
+  client = BitPay::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)
+    BitPay::Client.new(pem: pem, tokens: token, insecure: true, api_uri: ROOT_ADDRESS )
+  else
+    claim_code = get_claim_code_from_server
+    pem = BitPay::KeyUtils.generate_pem
+    client = BitPay::Client.new(api_uri: ROOT_ADDRESS, pem: pem, insecure: true)
+    token = client.pair_pos_client(claim_code)
+    File.write(BitPay::PRIVATE_KEY_PATH, pem)
+    File.write(BitPay::TOKEN_FILE_PATH, JSON.generate(token))
+    client
+  end   
+end
+
+def get_token_from_file
+  token = JSON.parse(File.read(BitPay::TOKEN_FILE_PATH))['data'][0]
+  {token['facade'] => token['token']}
+end
+
+def logged_in
+  Capybara::has_link?('Dashboard')
+end