bitcoin_payable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f5d9650ea027c2efde7202dd4022609f33cb429
+  data.tar.gz: 63490e5bdfce90487c755d9377656b601b917768
+SHA512:
+  metadata.gz: 1ae414724a5c27d25c9e89e773a6e88e0b69616b678d734ca9402c6fc50500f1dbe62b6cd79c424b1c7e21c3e81451fa9f36646f076a8de2a5e9de84c8889378
+  data.tar.gz: bb5355b2584488fd3be82401c5228fcbeb4e4df3d104adcd6863697642498dc18871831088a7a4f494083c73ad5c48316263bccab5ed679e9da4af0ba33556b5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bitcoin_payable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,158 @@
+PATH
+  remote: .
+  specs:
+    bitcoin_payable (0.0.1)
+      cucumber-rails
+      database_cleaner
+      helloblock
+      money-tree
+      rails (~> 4.0.0)
+      rspec-rails
+      state_machine
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.5)
+      actionpack (= 4.0.5)
+      mail (~> 2.5.4)
+    actionpack (4.0.5)
+      activesupport (= 4.0.5)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.5)
+      activesupport (= 4.0.5)
+      builder (~> 3.1.0)
+    activerecord (4.0.5)
+      activemodel (= 4.0.5)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.5)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.5)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.2)
+    builder (3.1.4)
+    capybara (2.3.0)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    cucumber (1.3.15)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.1)
+    cucumber-rails (1.4.1)
+      capybara (>= 1.1.2, < 3)
+      cucumber (>= 1.3.8, < 2)
+      mime-types (~> 1.16)
+      nokogiri (~> 1.5)
+      rails (>= 3, < 5)
+    database_cleaner (1.3.0)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    ffi (1.9.3)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    hashie (2.0.5)
+    helloblock (0.0.2)
+      faraday_middleware (~> 0.9)
+      json
+      multi_json (~> 1.9)
+      rash (~> 0.4)
+      yajl-ruby (~> 1.2)
+    hike (1.2.3)
+    i18n (0.6.9)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    mini_portile (0.6.0)
+    minitest (4.7.5)
+    money-tree (0.8.7)
+      ffi
+    multi_json (1.10.1)
+    multi_test (0.1.1)
+    multipart-post (2.0.0)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    polyglot (0.3.5)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.5)
+      actionmailer (= 4.0.5)
+      actionpack (= 4.0.5)
+      activerecord (= 4.0.5)
+      activesupport (= 4.0.5)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.5)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.5)
+      actionpack (= 4.0.5)
+      activesupport (= 4.0.5)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.1)
+    rash (0.4.0)
+      hashie (~> 2.0.0)
+    rspec-core (3.0.1)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.1)
+      rspec-support (~> 3.0.0)
+    rspec-rails (3.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.0)
+    sprockets (2.12.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.9)
+    state_machine (1.2.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.39)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+    yajl-ruby (1.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bitcoin_payable!
+  bundler (~> 1.3)
+  rake
+  sqlite3 (~> 1.2)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jonathan Salis
+
+MIT License
+
+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,125 @@
+# BitcoinPayable
+
+A rails gem that enables any model to have bitcoin payments.
+The polymorhpic table bitcoin_payments creates payments with unique addresses based on a BIP32 deterministic seed using https://github.com/wink/money-tree
+and uses the https://helloblock.io API to check for payments.
+
+Payments have 3 states:  `pending`, `partial_payment`, `paid_in_full`
+
+No private keys needed, No bitcoind blockchain indexing on new servers, just address and payments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bitcoin_payable'
+
+And then execute:
+
+    $ bundle
+
+    $ rails g bitcoin_payable:install
+
+    $ bundle exec rake db:migrate
+
+Or install it yourself as:
+
+    $ gem install bitcoin_payable
+
+## Usage
+
+### Configuration
+
+config/initializers/bitcoin_payable.rb
+
+    BitcoinPayable.config.currency = :cad
+    BitcoinPayable.config.master_seed = ENV["MASTER_SEED"]              # Use master_seed OR master_public_key
+    BitcoinPayable.config.master_public_key = ENV["MASTER_PUBLIC_KEY"]
+    BitcoinPayable.config.testnet = true
+
+#### Master Seed
+
+The 32 Hex master seed.
+Reference: https://github.com/wink/money-tree#create-a-master-node-seed
+
+#### Master Public Key
+
+A BIP32 MPK in "Extended Key" format.
+
+### Adding it to your model
+
+    class Product < ActiveRecord::Base
+      has_bitcoin_payments
+    end
+
+### Creating a payment from your application
+
+    def create_payment(amount_in_cents)
+      self.bitcoin_payments.create!(reason: 'sale', price: amount_in_cents)
+    end
+
+### Update payments with the current price of BTC based on your currency
+
+BitcoinPayable also supports local currency conversions and BTC exchange rates.
+
+The `process_prices` rake task connects to api.bitcoinaverage.com to get the 24 hour weighted average of BTC for your specified currency.
+It then updates all payments that havent received an update in the last 30 minutes with the new value owing in BTC.
+This *honors* the price of a payment for 30 minutes at a time.
+
+rake bitcoin_payable:process_prices
+
+### Processing payments
+
+All payments are calculated against the dollar amount of the payment.  So a `bitcoin_payment` for $49.99 will have it's value calculated in BTC.
+It will stay at that price for 30 minutes.  When a payment is made, a transaction is created that stores the BTC in satoshis paid, and the exchange rate is was paid at.
+This is very valuable for accounting later.  (capital gains of all payments received)
+
+If a partial payment is made, the BTC value is recalculated for the remaining *dollar* amount with the latest exchange rate.
+This means that if someone pays 0.01 for a 0.5 payment, that 0.01 is converted into dollars at the time of processing and the
+remaining amount is calculated in dollars and the remaining amount in BTC is issued.  (If BTC bombs, that value could be greater than 0.5 now)
+
+This prevents people from gaming the payments by paying very little BTC in hopes the price will rise.
+Payments are not recalculated based on the current value of BTC, but in dollars.
+
+To run the payment processor:
+
+`rake bitcoin_payable:process_payments`
+
+### Notify your application when a payment is made
+
+Use the `bitcoin_payment_paid` method
+
+    def Product < ActiveRecord::Base
+      has_bitcoin_payments
+
+      def create_payment(amount_in_cents)
+        self.bitcoin_payments.create!(reason: 'sale', price: amount_in_cents)
+      end
+
+      def bitcoin_payment_paid
+        self.ship!
+      end
+    end
+
+### View all the transactions in the payment
+
+    bitcoin_payment = @product.bitcoin_payments.first
+    bitcoin_payment.transactions.each do |transaction|
+      puts transaction.block_hash
+      puts transaction.block_time
+
+      puts transaction.transaction_hash
+
+      puts transaction.estimated_value
+      puts transaction.estimated_time
+
+      puts transaction.btc_conversion
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'bitcoin_payable/tasks'

data/bitcoin_payable.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bitcoin_payable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bitcoin_payable"
+  spec.version       = BitcoinPayable::VERSION
+  spec.authors       = ["Jonathan Salis"]
+  spec.email         = ["jon.salis@bitcoinsultants.ca"]
+  spec.description   = %q{A Bitcoin payment processor}
+  spec.summary       = %q{A Bitcoin payment processor}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'sqlite3', '~> 1.2'
+
+  spec.required_rubygems_version = '>= 1.3.6'
+
+  spec.add_dependency "rails", "~> 4.0.0"
+  spec.add_dependency "cucumber-rails"
+  spec.add_dependency "rspec-rails"
+  spec.add_dependency "database_cleaner"
+  #spec.add_dependency "bitcoin-addrgen"
+  spec.add_dependency "state_machine"
+  spec.add_dependency "helloblock"
+  spec.add_dependency "money-tree"
+end

data/features/bitcoin_payments.feature

@@ -0,0 +1,20 @@
+Feature: BitcoinPayment creation, validation and state
+
+Background:
+  Given a saved widget
+
+Scenario Outline: A saved widget can create a payment
+Given a new bitcoin_payment
+Then the bitcoin_payment field <field> is set to <value>
+  And the bitcoin_payment field amount_due is set to 1
+When the bitcoin_payment is saved
+Then the bitcoin_payment should have an address
+  And the bitcoin_payment should have the state pending
+
+Examples:
+
+| field     | value       |
+| reason    | New Payment |
+
+
+

data/features/default.feature

@@ -0,0 +1,5 @@
+Feature: Testing an empty widget
+
+Scenario: An unsaved widget should respond to bitcoin_payments
+Given an unsaved widget
+Then the widget should have 0 bitcoin_payments

data/features/pricing_processor.feature

@@ -0,0 +1,4 @@
+Feature: Pricing Processor tests
+
+Scenario: The test framework should set up 3 currency conversions
+Given there should be 3 currency_conversions

data/features/step_definitions/bitcoin_payment_steps.rb

@@ -0,0 +1,16 @@
+Given /^the bitcoin_payment field (\S*) is set to (.*)/ do |field, value|
+  @bitcoin_payment.send("#{field}=", value)
+end
+
+Given /^the bitcoin_payment is saved$/ do
+  @bitcoin_payment.save
+  @bitcoin_payment.reload.new_record?.should be_false
+end
+
+Given /^the bitcoin_payment should have an address$/ do
+  @bitcoin_payment.address.should_not be_nil
+end
+
+Given /^the bitcoin_payment should have the state (\S+)$/ do |state|
+  @bitcoin_payment.state.should eq(state)
+end

data/features/step_definitions/currency_conversion_steps.rb

@@ -0,0 +1,4 @@
+Given /^there should be (\d+) currency_conversions?$/ do |n|
+  @currency_conversions.should_not be_nil
+  @currency_conversions.count.should eql(n.to_i)
+end

data/features/step_definitions/model_step.rb

@@ -0,0 +1,11 @@
+Given /^an unsaved widget$/ do
+  @widget = Widget.new
+end
+
+Given /^a saved widget$/ do
+  @widget = Widget.create
+end
+
+Given /^a new bitcoin_payment$/ do
+  @bitcoin_payment = @widget.bitcoin_payments.new
+end

data/features/step_definitions/widget_steps.rb

@@ -0,0 +1,3 @@
+Given /^the widget should have (\d+) bitcoin_payments$/ do |n|
+  @widget.bitcoin_payments.count.should eql(n.to_i)
+end

data/features/support/env.rb

@@ -0,0 +1,33 @@
+ENV["RAILS_ENV"] ||= "test"
+require File.expand_path("../../../spec/dummy/config/environment.rb",  __FILE__)
+
+ENV["RAILS_ROOT"] ||= File.dirname(__FILE__) + "../../../spec/dummy"
+
+require 'cucumber/rails'
+require 'cucumber/rspec/doubles'
+
+# Remove/comment out the lines below if your app doesn't have a database.
+# For some databases (like MongoDB and CouchDB) you may need to use :truncation instead.
+begin
+  DatabaseCleaner.strategy = :transaction
+rescue NameError
+  raise "You need to add database_cleaner to your Gemfile (in the :test group) if you wish to use it."
+end
+
+Before do
+  3.times do
+    BitcoinPayable::CurrencyConversion.create!(
+      currency: rand() * (0.99 - 0.85) + 0.85,
+      btc: (rand(500.0) + 500.0) * 100
+    )
+  end
+  @currency_conversions = BitcoinPayable::CurrencyConversion.all
+
+  # return_values = []
+  # 10.times do
+  #  return_values << rand(500.0) + 500.0
+  # end
+
+  #allow_any_instance_of(BitcoinPayable::PricingProcessor).to receive(:get_btc).and_return { return_values.shift }
+  #allow_any_instance_of(BitcoinPayable::PricingProcessor).to receive(:get_currency).and_return(rand() * (0.99 - 0.85) + 0.85)
+end