bitpay-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa770bdf4bff602b5a1d08ae90adaad37cbae6b7
+  data.tar.gz: 9028c2eef4e4f36c0921f1ba7cfbd0931dd3431d
+SHA512:
+  metadata.gz: ccb93210155e6b26b69dfdc025587253c46ddfb163eb5fcbd7b1cc998ccd3e05a16eb29cd36e1ec355ced828cda64ea7f2f73e1a8ddfc8420c00043e81137f0a
+  data.tar.gz: c6d5d4c7f90bc10c095c04f12e2d8172acc800104d8d3319151c98fc9a11fa7eb1a00ade1bc9128553d95e13ff8d2a5a783621f59cc3a587f5a875be508b7643

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+test.rb
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode

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) 2013 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,62 @@
+# 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-client
+    
+In your Gemfile:
+
+    gem 'bitpay-client', :require => 'bitpay'
+
+Or directly:
+
+    require 'bitpay'
+
+## Basic Usage
+
+To create an invoice:
+
+    invoice = client.post 'invoice', {:price => 10.00, :currency => 'USD'}
+
+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` is 
+
+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 'invoice/DGrAEmbsXe9bavBPMJ8kuk'
+
+## API Documentation
+
+API Documentation is available on the [BitPay site](https://bitpay.com/bitcoin-payment-gateway-api).
+
+## RDoc/YARD Documentation
+The code has been fully code documented, and the latest version is always available at the [Rubydoc Site](http://rubydoc.info/gems/bitpay-client).
+
+## Running the Tests
+
+    $ bundle install
+    $ bundle exec rake
+
+In addition to a full test suite, there is Travis integration for MRI 1.9, JRuby and Rubinius.
+
+## 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.
+
+## Authors
+* Kyle Drake

data/Rakefile

@@ -0,0 +1,10 @@
+require "rake/testtask"
+
+desc "Run all tests"
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList['test/*_test.rb','test/bitpay/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/bitpay-client.gemspec

@@ -0,0 +1,23 @@
+require './lib/bitpay/version.rb'
+Gem::Specification.new do |s|
+  s.name = 'bitpay-client'
+  s.version = BitPay::VERSION
+  s.authors = ['Kyle Drake']
+  s.email = ['kyle@bitpay.com']
+  s.homepage = 'https://github.com/bitpay/ruby-client'
+  s.summary = 'Official ruby client 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 = %w[lib]
+  s.rubyforge_project = s.name
+  s.required_rubygems_version = '>= 1.3.4'
+
+  s.add_dependency 'json'
+  s.add_dependency 'rack',    '>= 0'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'yard'
+end

data/lib/bitpay.rb

@@ -0,0 +1,24 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+require 'json'
+require 'uri'
+require 'net/https'
+require 'bitpay/client'
+require 'bitpay/version'
+
+module BitPay
+  # Location of the directory of SSL certificates.
+  DATA_DIR = File.join File.dirname(__FILE__), 'bitpay', 'data'
+
+  # SSL Certificate
+  CERT = File.join DATA_DIR, 'cert.pem'
+
+  # SSL Key
+  KEY = File.join DATA_DIR, 'key.pem'
+
+  # Location of API
+  API_URI = 'https://bitpay.com/api'
+
+  # User agent reported to API
+  USER_AGENT = 'ruby-bitpay-client '+VERSION
+end

data/lib/bitpay/client.rb

@@ -0,0 +1,53 @@
+module BitPay
+  # This class is used to instantiate a BitPay Client object. It is expected to be thread safe.
+  #
+  # @example
+  #  # Create a client with your BitPay API key (obtained from the BitPay API access page at BitPay.com):
+  #  client = BitPay::Client.new 'YOUR_API_KEY'
+  class Client
+    class BitPayError < StandardError; end
+
+    # Creates a BitPay Client object. The second parameter is a hash for overriding defaults.
+    #
+    # @return [Client]
+    # @example
+    #  # Create a client with your BitPay API key (obtained from the BitPay API access page at BitPay.com):
+    #  client = BitPay::Client.new 'YOUR_API_KEY'
+    def initialize(api_key, opts={})
+      @api_key           = api_key
+      @uri               = URI.parse opts[:api_uri] || API_URI
+      @https             = Net::HTTP.new @uri.host, @uri.port
+      @https.use_ssl     = true
+      @https.cert        = OpenSSL::X509::Certificate.new File.read(opts[:cert] || CERT)
+      @https.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    end
+
+    # Makes a GET call to the BitPay API.
+    # @return [Hash]
+    # @see get_invoice
+    # @example
+    #  # Get an invoice:
+    #  existing_invoice = client.get 'invoice/YOUR_INVOICE_ID'
+    def get(path)
+      request = Net::HTTP::Get.new @uri.path+'/'+path
+      request.basic_auth @api_key, ''
+      request['User-Agent'] = USER_AGENT
+      response = @https.request request
+      JSON.parse response.body
+    end
+
+    # Makes a POST call to the BitPay API.
+    # @return [Hash]
+    # @see create_invoice
+    #  # Create an invoice:
+    #  created_invoice = client.post 'invoice', {:price => 1.45, :currency => 'BTC'}
+    def post(path, params={})
+      request = Net::HTTP::Post.new @uri.path+'/'+path
+      request.basic_auth @api_key, ''
+      request['User-Agent'] = USER_AGENT
+      request.body = params
+      response = @https.request request
+      JSON.parse response.body
+    end
+  end
+end

data/lib/bitpay/data/cert.pem

@@ -0,0 +1,15 @@
+-----BEGIN CERTIFICATE-----
+MIICWDCCAcGgAwIBAgIJAP4dy3lMOd97MA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV
+BAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBX
+aWRnaXRzIFB0eSBMdGQwHhcNMTEwODE1MTUxMDU2WhcNMjEwODEyMTUxMDU2WjBF
+MQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50
+ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKB
+gQDZ92nLT7OmfKJPIWzpNDc4gbUmUhBzHKG5aLaXpDZtvyqaMH2lUzGjIxY8taKS
+Q8gvzLnIDuZJ6+99e7OlX9w5In5x1B2tVrwCXZo9ZUIy7a34ULQYxRhI5ZzCKtsC
+O84fakQfNgKfkjlqUBr6ksK7IusftPwc7UHEPWSJfaakCQIDAQABo1AwTjAdBgNV
+HQ4EFgQUfubRYcwiDLT98VoHiVXcGlXXAMAwHwYDVR0jBBgwFoAUfubRYcwiDLT9
+8VoHiVXcGlXXAMAwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUFAAOBgQCruca0
+pys5xJ3l4qts/gBxpAuW3Yx6Jkrr35ertgj108SIN+O5uBCu+/AZfTJArVSdh+Zn
+ML6zF2T5E5ho7T/UHUXUW6hf5uCJVbRusx73pw4Hh1yE0x/+1Rwnf9uDD2gIeL2W
+3u6e+8/ladZJtplIYvCK031MxAwO4s2LMznpTQ==
+-----END CERTIFICATE-----

data/lib/bitpay/version.rb

@@ -0,0 +1,3 @@
+module BitPay
+  VERSION = '0.1.0'
+end

data/test/bitpay/client_test.rb

@@ -0,0 +1,47 @@
+require File.join File.dirname(__FILE__), '..', 'env.rb'
+
+USER_AGENT = 'ruby-bitpay-client '+BitPay::VERSION
+
+def invoice_body
+  {
+    "id"             => "DGrAEmbsXe9bavBPMJ8kuk",
+    "url"            => "https://bitpay.com/invoice?id=DGrAEmbsXe9bavBPMJ8kuk",
+    "status"         => "new",
+    "btcPrice"       => "0.0495",
+    "price"          => 10,
+    "currency"       => "USD",
+    "invoiceTime"    => 1383265343674,
+    "expirationTime" => 1383266243674,
+    "currentTime"    => 1383265957613
+  }
+end
+
+stub_request(:post, "https://KEY:@bitpay.com/api/invoice/create").
+  with(:headers => {'User-Agent'=>USER_AGENT}).
+  to_return(:body => invoice_body.to_json)
+
+stub_request(:get, "https://KEY:@bitpay.com/api/invoice/DGrAEmbsXe9bavBPMJ8kuk").
+  with(:headers => {'User-Agent'=>USER_AGENT}).
+  to_return(:body => invoice_body.to_json)
+
+describe BitPay::Client do
+  before do
+    @client = BitPay::Client.new 'KEY'
+  end
+
+  describe 'post' do
+    it 'creates invoice' do
+      response = @client.post 'invoice/create', {}
+      response.class.must_equal Hash
+      response['id'].must_equal 'DGrAEmbsXe9bavBPMJ8kuk'
+    end
+  end
+
+  describe 'get' do
+    it 'retreives invoice' do
+      response = @client.get 'invoice/DGrAEmbsXe9bavBPMJ8kuk'
+      response.class.must_equal Hash
+      response['id'].must_equal 'DGrAEmbsXe9bavBPMJ8kuk'
+    end
+  end
+end

data/test/env.rb

@@ -0,0 +1,7 @@
+require 'addressable/uri'
+require 'json'
+require 'minitest/autorun'
+require 'webmock'
+require './lib/bitpay.rb'
+
+include WebMock::API

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: bitpay-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kyle Drake
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Powerful, flexible, lightweight, thread-safe interface to the BitPay
+  developers API
+email:
+- kyle@bitpay.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bitpay-client.gemspec
+- lib/bitpay.rb
+- lib/bitpay/client.rb
+- lib/bitpay/data/cert.pem
+- lib/bitpay/version.rb
+- test/bitpay/client_test.rb
+- test/env.rb
+homepage: https://github.com/bitpay/ruby-client
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.4
+requirements: []
+rubyforge_project: bitpay-client
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Official ruby client library for the BitPay API
+test_files: []
+has_rdoc: