straight 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b001bb2871da76e4b657fc5d3e8812ee1e829f3
-  data.tar.gz: ff86dddd47ec116ee7f2f8de5c799aaedd872473
+  metadata.gz: 1ce549f0d3b951b8ce6e5d6e35ba868497b977e7
+  data.tar.gz: 5c44763aa3b9d35441e0d1bdd4824dac85238320
 SHA512:
-  metadata.gz: b5fc18e1b66e8c2548dc0d515374437f467ccb8821ae45228e562ad0676568ff3ee7fd30468e50302b7cd9d294b881766f83ce45349bae78337e986bbc83c8c2
-  data.tar.gz: b15b7209e215e81bfa18bb260ec358368640122d83718591b3b1a09cb409f056b52badae4a2506582f8477caeea174798978f25d473422254e8fdfce3b88f13e
+  metadata.gz: e4632fafae05cd13ab8443a6817806bca0e67fa0f7eddc03027944287e6c57c8437bd914f18589db3b9e39a91ac2a9e796d68015485132ff2e68774fe70f4f86
+  data.tar.gz: 0724e768858d85d0b3f9290d6570f75944167554b9b5ed5177cbb97c1ae76f5569b68730e5a77cba88db1b499413e486381b0dfe35681f5c8aab8051cbc0982d

data/Gemfile

@@ -5,6 +5,7 @@ gem 'money-tree'
 
 # Used in exchange rate adapters
 gem 'satoshi-unit'
+gem 'httparty'
 
 group :development do
   gem "bundler", "~> 1.0"

data/Gemfile.lock

@@ -20,6 +20,9 @@ GEM
       oauth2
     hashie (3.3.1)
     highline (1.6.21)
+    httparty (0.13.3)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
     jeweler (2.0.1)
       builder
       bundler (>= 1.0)
@@ -61,7 +64,7 @@ GEM
     rspec-mocks (3.1.0)
       rspec-support (~> 3.1.0)
     rspec-support (3.1.0)
-    satoshi-unit (0.1.6)
+    satoshi-unit (0.1.7)
     thread_safe (0.3.4)
 
 PLATFORMS
@@ -70,6 +73,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0)
   github_api (= 0.11.3)
+  httparty
   jeweler (~> 2.0.1)
   money-tree
   rspec

data/README.md

@@ -1,12 +1,13 @@
 Straight
 ========
 > Receive bitcoin payments directly into your wallet
+
 > Website: http://straight.romansnitko.com
 
-Straight is a built-in stateless gateway to receive bitcoin payments for 
-your online store. Drop in this library, set your public key and start receiving payments.
-Your BIP32-compatible wallet will see payments automatically without any need for integration
-with your database.
+Straight is a built-in stateless gateway library written in Ruby.
+It allows you to receive bitcoin payments for your online store. Drop in this library,
+set your public key and start receiving payments. Your BIP32-compatible wallet will
+see payments automatically without any need for integration with your database.
 
 Straight cares about security and privacy. No private keys are stored on the server,
 each order uses unique payment address. Straight notifies your application when payment is 
@@ -16,7 +17,7 @@ IMPORTANT: this is a gem, not a server. It has no state and is intended to use w
 an application, such as Ruby On Rails. Most likely, you want
 [straight-server](https://github.com/snitko/straight-server), it is a server,
 which holds the state of all orders for you and has a RESTful API you can use
-with any application written in in language or platform.
+with any application written in any language or platform.
 
 Bitcoin donations are appreciated: 1D3PknG4Lw1gFuJ9SYenA7pboF9gtXtdcD 
 
@@ -61,6 +62,7 @@ Usage
     gateway.name                   = 'my gateway'
 
     # Set the callback for orders' status changes
+    # (see lib/straight/order.rb for status attribute values and their meanings)
     #
     gateway.order_callbacks = [
       lambda { |order| puts "Order status changed to #{order.status}" }
@@ -101,8 +103,8 @@ When this module is included, it doesn't actually *include* all the methods, som
 It is important specifically for getters and setters and as a general rule only getters and setters are prepended.
 
 If you don't want to bother yourself with modules, please use `Straight::Order` class and simply create new instances of it.
-However, if you are contributing to the library, all new functionality should go to either Straight::OrderModule::Includable or
-Straight::OrderModule::Prependable (most likely the former).
+However, if you are contributing to the library, all new functionality should go to either `Straight::OrderModule::Includable` or
+`Straight::OrderModule::Prependable` (most likely the former).
 
 
 Important Considerations
@@ -115,14 +117,22 @@ all orders should be indexed sequentially, not randomly.
 Why can't we just derive new addresses from order UUID, or assign them to orders? The reason is that your
 wallet will have to integrate with your very own database and it may be enormously cumbersome to implement
 in a generic way. Alternative would be to create a wallet within Straight and make it generate and keep the
-private keys, but this would be highly insecure. Keys stored on popular hosting solutions would quickly invite 
-all sorts of attacks to get money from them.
+private keys, but this would be highly insecure. Keys stored on popular hosting solutions would quickly
+invite all sorts of attacks to get money from them.
+
+
+A note about Mycelium blockchain adapter
+----------------------------------------
+If you wish to use Mycelium blockchain adapter you MUST install bitcoind on your server (you may run it in offline mode, no need to download the whole blockchain!) and have a `bitcoin-cli` in your PATH. This
+requirement is due to the need to parse raw bitcoin transaction received from Mycelium WAPI.
+By default, Mycelium is included as a second (fallback) adapter and will only be used in case
+BlockchainInfo one fails. It will not raise an exception until it actually tries to parse the trasaction
+and finds there is no `bitcoin-cli` in PATH.
 
 Requirements
 ------------
 Ruby 2.1 or later.
 
-
 Credits
 -------
 Authors:

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/straight.rb

@@ -4,15 +4,24 @@ require 'json'
 require 'uri'
 require 'open-uri'
 require 'yaml'
+require 'singleton'
+require 'httparty'
 
 require_relative 'straight/blockchain_adapter'
 require_relative 'straight/blockchain_adapters/blockchain_info_adapter'
-require_relative 'straight/blockchain_adapters/helloblock_io_adapter'
+require_relative 'straight/blockchain_adapters/biteasy_adapter'
+require_relative 'straight/blockchain_adapters/mycelium_adapter'
 
 require_relative 'straight/exchange_rate_adapter'
 require_relative 'straight/exchange_rate_adapters/bitpay_adapter'
 require_relative 'straight/exchange_rate_adapters/coinbase_adapter'
 require_relative 'straight/exchange_rate_adapters/bitstamp_adapter'
+require_relative 'straight/exchange_rate_adapters/localbitcoins_adapter'
+require_relative 'straight/exchange_rate_adapters/okcoin_adapter'
+require_relative 'straight/exchange_rate_adapters/btce_adapter'
+require_relative 'straight/exchange_rate_adapters/kraken_adapter'
+require_relative 'straight/exchange_rate_adapters/average_rate_adapter'
+
 
 require_relative 'straight/order'
 require_relative 'straight/gateway'

data/lib/straight/blockchain_adapter.rb

@@ -5,24 +5,13 @@ module Straight
     # all blockchain adapters as well as supplying some useful methods.
     class Adapter
 
+      include Singleton
+
       # Raised when blockchain data cannot be retrived for any reason.
       # We're not really intereste in the precise reason, although it is
       # stored in the message.
       class RequestError < Exception; end
 
-      # This method is a wrapper for creating an HTTP request
-      # to various services that ancestors of this class may use
-      # to retrieve blockchain data. Why do we need a wrapper?
-      # Because it respects timeouts.
-      def http_request(url)
-        uri = URI.parse(url)
-        begin
-          http = uri.read(read_timeout: 4)
-        rescue OpenURI::HTTPError => e
-          raise RequestError, YAML::dump(e)
-        end
-      end
-
       def fetch_transaction(tid)
         raise "Please implement #fetch_transaction in #{self.to_s}"
       end

data/lib/straight/blockchain_adapters/biteasy_adapter.rb

@@ -0,0 +1,74 @@
+module Straight
+  module Blockchain
+
+    class BiteasyAdapter < Adapter
+
+      def self.mainnet_adapter
+        instance = self.instance
+        instance._initialize("https://api.biteasy.com/blockchain/v1")
+        instance
+      end
+      
+      def self.testnet_adapter
+        raise "Not Supported Yet"
+      end
+      
+      def _initialize(base_url)
+        @base_url = base_url
+      end
+
+      # Returns the current balance of the address
+      def fetch_balance_for(address)
+        JSON.parse(api_request("/addresses/#{address}"))['data']['balance']
+      end
+
+      # Returns transaction info for the tid
+      def fetch_transaction(tid, address: nil)
+        straighten_transaction JSON.parse(api_request("/transactions/#{tid}"), address: address)
+      end
+
+      # Returns all transactions for the address
+      def fetch_transactions_for(address)
+        transactions = JSON.parse(api_request("/transactions?address=#{address}"))['data']['transactions']
+        transactions.map { |t| straighten_transaction(t, address: address) }
+      end
+
+      private
+
+        def api_request(url)
+          begin
+            response = HTTParty.get("#{@base_url}/#{url}", timeout: 4, verify: false)
+            unless response.code == 200
+              raise RequestError, "Cannot access remote API, response code was #{response.code}"
+            end
+            response.body
+          rescue HTTParty::Error => e
+            raise RequestError, YAML::dump(e)
+          rescue JSON::ParserError => e
+            raise RequestError, YAML::dump(e)
+          end
+        end
+
+        # Converts transaction info received from the source into the
+        # unified format expected by users of BlockchainAdapter instances.
+        def straighten_transaction(transaction, address: nil)
+          outs         = []
+          total_amount = 0
+          transaction['data']['outputs'].each do |out|
+            total_amount += out['value'] if address.nil? || address == out['to_address']
+            outs << { amount: out['value'], receiving_address: out['to_address'] } 
+          end
+
+          {
+            tid:           transaction['data']['hash'],
+            total_amount:  total_amount,
+            confirmations: transaction['data']['confirmations'],
+            outs:          outs
+          }
+        end
+
+    end
+
+  end
+
+end

data/lib/straight/blockchain_adapters/blockchain_info_adapter.rb

@@ -4,36 +4,67 @@ module Straight
     class BlockchainInfoAdapter < Adapter
 
       def self.mainnet_adapter
-        self.new("http://blockchain.info")
+        instance = self.instance
+        instance._initialize("https://blockchain.info")
+        instance
       end
       
       def self.testnet_adapter
         raise "Not Supported Yet"
       end
       
-      def initialize(base_url)
+      def _initialize(base_url)
         @latest_block = { cache_timestamp: nil, block: nil }
         @base_url = base_url
       end
 
       # Returns transaction info for the tid
       def fetch_transaction(tid, address: nil)
-        straighten_transaction JSON.parse(http_request("#{@base_url}/rawtx/#{tid}"), address: address)
+        straighten_transaction JSON.parse(api_request("/rawtx/#{tid}"), address: address)
       end
 
       # Returns all transactions for the address
       def fetch_transactions_for(address)
-        transactions = JSON.parse(http_request("#{@base_url}/rawaddr/#{address}"))['txs']
+        transactions = JSON.parse(api_request("/rawaddr/#{address}"))['txs']
         transactions.map { |t| straighten_transaction(t, address: address) }
       end
 
       # Returns the current balance of the address
       def fetch_balance_for(address)
-        JSON.parse(http_request("#{@base_url}/rawaddr/#{address}"))['final_balance']
+        JSON.parse(api_request("/rawaddr/#{address}"))['final_balance']
+      end
+
+      def latest_block(force_reload: false)
+        # If we checked Blockchain.info latest block data
+        # more than a minute ago, check again. Otherwise, use cached version.
+        if @latest_block[:cache_timestamp].nil?              ||
+           @latest_block[:cache_timestamp] < (Time.now - 60) ||
+           force_reload
+          @latest_block = {
+            cache_timestamp: Time.now,
+            block: JSON.parse(api_request("/latestblock"))
+          }
+        else
+          @latest_block
+        end
       end
 
       private
 
+        def api_request(url)
+          begin
+            response = HTTParty.get("#{@base_url}/#{url}", timeout: 4, verify: false)
+            unless response.code == 200
+              raise RequestError, "Cannot access remote API, response code was #{response.code}"
+            end
+            response.body
+          rescue HTTParty::Error => e
+            raise RequestError, YAML::dump(e)
+          rescue JSON::ParserError => e
+            raise RequestError, YAML::dump(e)
+          end
+        end
+
         # Converts transaction info received from the source into the
         # unified format expected by users of BlockchainAdapter instances.
         def straighten_transaction(transaction, address: nil)
@@ -59,19 +90,8 @@ module Straight
         # a certain address without making any new requests to the Blockchain API.
         def calculate_confirmations(transaction, force_latest_block_reload: false)
 
-          # If we checked Blockchain.info latest block data
-          # more than a minute ago, check again. Otherwise, use cached version.
-          if @latest_block[:cache_timestamp].nil?              ||
-             @latest_block[:cache_timestamp] < (Time.now - 60) ||
-             force_latest_block_reload
-            @latest_block = {
-              cache_timestamp: Time.now,
-              block: JSON.parse(http_request("#{@base_url}/latestblock"))
-            }
-          end
-
           if transaction["block_height"]
-            @latest_block[:block]["height"] - transaction["block_height"] + 1
+            latest_block(force_reload: force_latest_block_reload)[:block]["height"] - transaction["block_height"] + 1
           else
             0
           end

data/lib/straight/blockchain_adapters/mycelium_adapter.rb

@@ -0,0 +1,144 @@
+module Straight
+  module Blockchain
+
+    class MyceliumAdapter < Adapter
+
+      class NoBitcoindInstalled < Exception
+        def message
+          "You need to install bitcoind on your server and have a `bitcoin-cli` executable in PATH.\n" +
+          "Note that you don't have to download the blockchain and you can run bitcoind in offline mode."
+        end
+      end
+
+      require 'base64'
+
+      def self.mainnet_adapter
+        instance = self.instance
+        instance._initialize("https://mws2.mycelium.com/wapi/wapi")
+        instance
+      end
+      
+      def self.testnet_adapter
+        instance = self.instance
+        instance._initialize("https://node3.mycelium.com/wapitestnet/wapi")
+        instance
+      end
+      
+      def _initialize(base_url)
+        @latest_block = { cache_timestamp: nil, block: nil }
+        @base_url = base_url
+      end
+
+      # Returns transaction info for the tid
+      def fetch_transaction(tid, address: nil)
+        transaction = api_request('getTransactions', { txIds: [tid] })['transactions'].first
+        straighten_transaction transaction, address: address
+      end
+
+      # Supposed to returns all transactions for the address, but
+      # currently actually returns the first one, since we only need one.
+      def fetch_transactions_for(address)
+        tid = api_request('queryTransactionInventory', { addresses: [address], limit: 1 })["txIds"].first
+        tid ? [fetch_transaction(tid, address: address)] : []
+      end
+
+      # Returns the current balance of the address
+      def fetch_balance_for(address)
+        unspent = 0
+        api_request('queryUnspentOutputs', { addresses: [address]})['unspent'].each do |out|
+          unspent += out['value']
+        end
+        unspent
+      end
+
+      # Here we are using Blockchain.info API at this point because I'm not sure how
+      # to get latest block from Mycelium WAPI
+      def latest_block(force_reload: false)
+        # If we checked Blockchain.info latest block data
+        # more than a minute ago, check again. Otherwise, use cached version.
+        if @latest_block[:cache_timestamp].nil?              ||
+           @latest_block[:cache_timestamp] < (Time.now - 60) ||
+           force_reload
+          @latest_block = {
+            cache_timestamp: Time.now,
+            block: JSON.parse(HTTParty.get("https://blockchain.info/latestblock", timeout: 4, verify: false).body)
+          }
+        else
+          @latest_block
+        end
+      end
+
+      private
+
+        def api_request(method, params={})
+          begin
+            body = JSON.parse(HTTParty.post(
+              "#{@base_url}/#{method}",
+              body: params.merge({version: 1}).to_json,
+              headers: { 'Content-Type' => 'application/json' },
+              timeout: 15,
+              verify: false
+            ).body)["r"]
+          rescue HTTParty::Error => e
+            raise RequestError, YAML::dump(e)
+          rescue JSON::ParserError => e
+            raise RequestError, YAML::dump(e)
+          end
+        end
+
+        # Converts transaction info received from the source into the
+        # unified format expected by users of BlockchainAdapter instances.
+        def straighten_transaction(transaction, address: nil)
+
+          # Get the block number this transaction was included into
+          block_height = transaction['height']
+          tid          = transaction['txid']
+
+          # Converting from Base64 to hex
+          transaction = transaction['binary'].unpack("m0").first.unpack("H*").first
+
+          # Decoding with bitcoin-cli
+          begin
+            transaction = JSON.parse(`bitcoin-cli decoderawtransaction #{transaction}`)
+          rescue Errno::ENOENT => e
+            if e.message == 'No such file or directory - bitcoin-cli'
+              raise NoBitcoindInstalled
+            else
+              raise e
+            end
+          end
+
+          outs         = []
+          total_amount = 0
+          transaction['vout'].each do |out|
+            out['value'] = out['value']*10**8
+            total_amount += out['value'] if address.nil? || address == out['address']
+            outs << { amount: out['value'], receiving_address: out['address'] }
+          end
+
+          {
+            tid:           tid,
+            total_amount:  total_amount,
+            confirmations: calculate_confirmations(block_height),
+            outs:          outs
+          }
+        end
+
+        # When we call #calculate_confirmations, it doesn't always make a new
+        # request to the blockchain API. Instead, it checks if cached_id matches the one in
+        # the hash. It's useful when we want to calculate confirmations for all transactions for
+        # a certain address without making any new requests to the Blockchain API.
+        def calculate_confirmations(block_height, force_latest_block_reload: false)
+
+          if block_height && block_height != -1
+            latest_block(force_reload: force_latest_block_reload)[:block]["height"] - block_height + 1
+          else
+            0
+          end
+
+        end
+
+    end
+
+  end
+end