straight 0.1.0 → 0.2.0

data/lib/straight/exchange_rate_adapter.rb

@@ -3,7 +3,8 @@ module Straight
 
     class Adapter
 
-      class CurrencyNotFound     < Exception; end
+      include Singleton
+
       class FetchingFailed       < Exception; end
       class CurrencyNotSupported < Exception; end
 
@@ -39,6 +40,24 @@ module Straight
         nil # this should be changed in descendant classes
       end
 
+      # This method will get value we are interested in from hash and
+      # prevent failing with 'undefined method [] for Nil' if at some point hash doesn't have such key value pair
+      def get_rate_value_from_hash(rates_hash, *keys)
+        keys.inject(rates_hash) do |intermediate, key|
+          if intermediate.respond_to?(:[])
+            intermediate[key]
+          else
+            raise CurrencyNotSupported 
+          end
+        end
+      end
+
+      # We dont want to have false positive rate, because nil.to_f is 0.0
+      # This method checks that rate value is not nil
+      def rate_to_f(rate)
+        rate ? rate.to_f : raise(CurrencyNotSupported)
+      end
+
     end
 
   end

data/lib/straight/exchange_rate_adapters/average_rate_adapter.rb

@@ -0,0 +1,54 @@
+module Straight
+  module ExchangeRate
+
+    class AverageRateAdapter < Adapter
+
+      # Takes exchange rate adapters instances or classes as arguments
+      def self.instance(*adapters)
+        instance = super()
+        instance.instance_variable_set(:@adapters, adapters.map { |adapter| adapter.respond_to?(:instance) ? adapter.instance : adapter })
+        instance
+      end
+
+      def fetch_rates!
+        failed_fetches = 0
+        @adapters.each do |adapter|
+          begin
+            adapter.fetch_rates!
+          rescue Exception => e
+            failed_fetches += 1
+            raise e if failed_fetches == @adapters.size
+          end
+        end
+      end
+
+      def rate_for(currency_code)
+        rates = []
+        @adapters.each do |adapter| 
+          begin
+            rates << adapter.rate_for(currency_code)
+          rescue CurrencyNotSupported
+            rates << nil
+          end
+        end
+
+        unless rates.select(&:nil?).size == @adapters.size 
+          rates.compact!
+          rates.inject {|sum, rate| sum + rate} / rates.size
+        else
+          raise CurrencyNotSupported
+        end
+      end
+
+      def get_rate_value_from_hash(rates_hash, *keys)
+        raise "This method is not supposed to be used in #{self.class}."
+      end
+
+      def rate_to_f(rate)
+        raise "This method is not supposed to be used in #{self.class}."
+      end
+
+    end
+
+  end
+end

data/lib/straight/exchange_rate_adapters/bitpay_adapter.rb

@@ -7,8 +7,11 @@ module Straight
 
       def rate_for(currency_code)
         super
-        @rates.each do |r|
-          return r['rate'].to_f if r['code'] == currency_code
+        @rates.each do |rt|
+          if rt['code'] == currency_code
+            rate = get_rate_value_from_hash(rt, 'rate')
+            return rate_to_f(rate)
+          end
         end
         raise CurrencyNotSupported 
       end

data/lib/straight/exchange_rate_adapters/bitstamp_adapter.rb

@@ -8,7 +8,8 @@ module Straight
       def rate_for(currency_code)
         super
         raise CurrencyNotSupported if currency_code != 'USD'
-        @rates['last'].to_f
+        rate = get_rate_value_from_hash(@rates, "last")
+        rate_to_f(rate)
       end
 
     end

data/lib/straight/exchange_rate_adapters/btce_adapter.rb

@@ -0,0 +1,18 @@
+module Straight
+  module ExchangeRate
+
+    class BtceAdapter < Adapter
+      
+      FETCH_URL = 'https://btc-e.com/api/2/btc_usd/ticker'
+
+      def rate_for(currency_code)
+        super
+        raise CurrencyNotSupported if !FETCH_URL.include?("btc_#{currency_code.downcase}")
+        rate = get_rate_value_from_hash(@rates, 'ticker', 'last')
+        rate_to_f(rate)
+      end
+
+    end
+
+  end
+end

data/lib/straight/exchange_rate_adapters/coinbase_adapter.rb

@@ -7,10 +7,8 @@ module Straight
 
       def rate_for(currency_code)
         super
-        if rate = @rates["btc_to_#{currency_code.downcase}"]
-          return rate.to_f
-        end
-        raise CurrencyNotSupported 
+        rate = get_rate_value_from_hash(@rates, "btc_to_#{currency_code.downcase}")
+        rate_to_f(rate)
       end
 
     end

data/lib/straight/exchange_rate_adapters/kraken_adapter.rb

@@ -0,0 +1,18 @@
+module Straight
+  module ExchangeRate
+
+    class KrakenAdapter < Adapter
+      
+      FETCH_URL = 'https://api.kraken.com/0/public/Ticker?pair=xbtusd'
+
+      def rate_for(currency_code)
+        super
+        rate = get_rate_value_from_hash(@rates, 'result', 'XXBTZ' + currency_code.upcase, 'c')
+        rate = rate.kind_of?(Array) ? rate.first : raise(CurrencyNotSupported)
+        rate_to_f(rate)
+      end
+
+    end
+
+  end
+end

data/lib/straight/exchange_rate_adapters/localbitcoins_adapter.rb

@@ -0,0 +1,17 @@
+module Straight
+  module ExchangeRate
+
+    class LocalbitcoinsAdapter < Adapter
+      
+      FETCH_URL = 'https://localbitcoins.com/bitcoinaverage/ticker-all-currencies/'
+
+      def rate_for(currency_code)
+        super
+        rate = get_rate_value_from_hash(@rates, currency_code.upcase, 'rates', 'last')
+        rate_to_f(rate)
+      end
+
+    end
+
+  end
+end

data/lib/straight/exchange_rate_adapters/okcoin_adapter.rb

@@ -0,0 +1,18 @@
+module Straight
+  module ExchangeRate
+
+    class OkcoinAdapter < Adapter
+      
+      FETCH_URL = 'https://www.okcoin.com/api/ticker.do?ok=1'
+
+      def rate_for(currency_code)
+        super
+        raise CurrencyNotSupported if currency_code != 'USD'
+        rate = get_rate_value_from_hash(@rates, 'ticker', 'last')
+        rate_to_f(rate)
+      end
+
+    end
+
+  end
+end

data/lib/straight/gateway.rb

@@ -43,9 +43,8 @@ module Straight
 
     # Determines the algorithm for consequitive checks of the order status.
     DEFAULT_STATUS_CHECK_SCHEDULE = -> (period, iteration_index) do
-      return false if period > 640
       iteration_index += 1
-      if iteration_index > 5
+      if iteration_index >= 20
         period          *= 2
         iteration_index  = 0
       end
@@ -56,7 +55,7 @@ module Straight
     # call super() somehwere inside those methods.
     #
     # In short, the idea is to let the class we're being prepended to do its magic
-    # after out methods are finished.
+    # after our methods are finished.
     module Prependable
     end
 
@@ -85,7 +84,8 @@ module Straight
       # the one a user of this class is going to properly increment) that is used to generate a
       # an BIP32 bitcoin address deterministically.
       def address_for_keychain_id(id)
-        keychain.node_for_path(id.to_s).to_address
+        # The 'm/0/n' notation is used by both Electrum and Mycelium
+        keychain.node_for_path("m/0/#{id.to_s}").to_address
       end
       
       def fetch_transaction(tid, address: nil)
@@ -101,7 +101,7 @@ module Straight
       end
 
       def keychain
-        @keychain ||= MoneyTree::Node.from_serialized_address(@pubkey)
+        @keychain ||= MoneyTree::Node.from_serialized_address(pubkey)
       end
 
       # This is a callback method called from each order
@@ -130,6 +130,13 @@ module Straight
         end
       end
 
+      def current_exchange_rate(currency=self.default_currency)
+        currency = currency.to_s.upcase
+        try_adapters(@exchange_rate_adapters) do |a|
+          a.rate_for(currency)
+        end
+      end
+
       private
         
         # Calls the block with each adapter until one of them does not fail.
@@ -163,12 +170,16 @@ module Straight
       @default_currency = 'BTC'
       @blockchain_adapters = [
         Blockchain::BlockchainInfoAdapter.mainnet_adapter,
-        Blockchain::HelloblockIoAdapter.mainnet_adapter
+        Blockchain::MyceliumAdapter.mainnet_adapter
       ]
       @exchange_rate_adapters = [
-        ExchangeRate::BitpayAdapter.new,
-        ExchangeRate::CoinbaseAdapter.new,
-        ExchangeRate::BitstampAdapter.new
+        ExchangeRate::BitpayAdapter.instance, 
+        ExchangeRate::CoinbaseAdapter.instance,
+        ExchangeRate::BitstampAdapter.instance,
+        ExchangeRate::BtceAdapter.instance,
+        ExchangeRate::KrakenAdapter.instance,
+        ExchangeRate::LocalbitcoinsAdapter.instance,
+        ExchangeRate::OkcoinAdapter.instance
       ]
       @status_check_schedule = DEFAULT_STATUS_CHECK_SCHEDULE
     end

data/lib/straight/order.rb

@@ -44,6 +44,8 @@ module Straight
       expired:      5  # too much time passed since creating an order
     }
 
+    attr_reader :old_status
+
     class IncorrectAmount < Exception; end
 
     # If you are defining methods in this module, it means you most likely want to
@@ -61,7 +63,18 @@ module Straight
       # If as_sym is set to true, then each status is returned as Symbol, otherwise
       # an equivalent Integer from STATUSES is returned.
       def status(as_sym: false, reload: false)
-        @status = super() if defined?(super)
+
+        if defined?(super)
+          begin 
+            @status = super
+          # if no method with arguments found in the class
+          # we're prepending to, then let's use a standard getter
+          # with no argument.
+          rescue ArgumentError
+            @status = super()
+          end
+        end
+
         # Prohibit status update if the order was paid in some way.
         # This is just a caching workaround so we don't query
         # the blockchain needlessly. The actual safety switch is in the setter.
@@ -105,11 +118,16 @@ module Straight
         # The order in which these statements currently are prevents that error, because
         # by the time a callback checks the status it's already set.
         @status_changed = (@status != new_status)
+        @old_status     = @status
         @status         = new_status
-        gateway.order_status_changed(self) if @status_changed
+        gateway.order_status_changed(self) if status_changed?
         super if defined?(super)
       end
 
+      def status_changed?
+        @status_changed
+      end
+
     end
 
     module Includable
@@ -144,22 +162,32 @@ module Straight
       #     order.start_periodic_status_check
       #   end
       #
-      def start_periodic_status_check
-        check_status_on_schedule
+      # `duration` argument (value is in seconds) allows you to
+      # control in what time an order expires. In other words, we
+      # keep checking for new transactions until the time passes.
+      # Then we stop and set Order's status to STATUS[:expired]. See
+      # #check_status_on_schedule for the implementation details.
+      def start_periodic_status_check(duration: 600)
+        check_status_on_schedule(duration: duration)
       end
       
       # Recursion here! Keeps calling itself according to the schedule until
       # either the status changes or the schedule tells it to stop.
-      def check_status_on_schedule(period: 10, iteration_index: 0)
+      def check_status_on_schedule(period: 10, iteration_index: 0, duration: 600, time_passed: 0)
         self.status(reload: true)
-        schedule = gateway.status_check_schedule.call(period, iteration_index)
-        if schedule && self.status < 2 # Stop checking if status is >= 2
-          sleep period
-          check_status_on_schedule(
-            period:          schedule[:period],
-            iteration_index: schedule[:iteration_index]
-          )
-        else
+        time_passed += period
+        if duration >= time_passed # Stop checking if status is >= 2
+          if self.status < 2
+            schedule = gateway.status_check_schedule.call(period, iteration_index)
+            sleep period
+            check_status_on_schedule(
+              period:          schedule[:period],
+              iteration_index: schedule[:iteration_index],
+              duration:        duration,
+              time_passed:     time_passed
+            )
+          end
+        elsif self.status < 2
           self.status = STATUSES[:expired]
         end
       end
@@ -172,6 +200,11 @@ module Straight
         { status: status, amount: amount, address: address, tid: tid }
       end
 
+      def amount_in_btc(as: :number)
+        a = Satoshi.new(amount, from_unit: :satoshi, to_unit: :btc)
+        as == :string ? a.to_unit(as: :string) : a.to_unit
+      end
+
     end
 
   end

data/spec/lib/blockchain_adapters/{helloblock_io_spec.rb → biteasy_adapter_spec.rb}

@@ -1,14 +1,8 @@
 require 'spec_helper'
 
-RSpec.describe Straight::Blockchain::HelloblockIoAdapter do
+RSpec.describe Straight::Blockchain::BiteasyAdapter do
 
-  subject(:adapter) { Straight::Blockchain::HelloblockIoAdapter.mainnet_adapter }
-
-  it "fetches all transactions for the current address" do
-    address = "3B1QZ8FpAaHBgkSB5gFt76ag5AW9VeP8xp"
-    expect(adapter).to receive(:straighten_transaction).with(anything, address: address).at_least(:once)
-    expect(adapter.fetch_transactions_for(address)).not_to be_empty
-  end
+  subject(:adapter) { Straight::Blockchain::BiteasyAdapter.mainnet_adapter }
 
   it "fetches the balance for a given address" do
     address = "3B1QZ8FpAaHBgkSB5gFt76ag5AW9VeP8xp"
@@ -20,24 +14,35 @@ RSpec.describe Straight::Blockchain::HelloblockIoAdapter do
     expect(adapter.fetch_transaction(tid)[:total_amount]).to eq(832947)
   end
 
-  it "gets a transaction id among other data" do
-    tid = 'ae0d040f48d75fdc46d9035236a1782164857d6f0cca1f864640281115898560'
-    expect(adapter.fetch_transaction(tid)[:tid]).to eq(tid)
+  it "calculates total_amount of a transaction for the given address only" do
+    t = { 'data' => {'outputs' => [{ 'value' => 1, 'to_address' => 'address1'}, { 'value' => 2, 'to_address' => 'address2'}] } }
+    expect(adapter.send(:straighten_transaction, t, address: 'address1')[:total_amount]).to eq(1)
+  end
+
+  it "fetches all transactions for the current address" do
+    address = "3B1QZ8FpAaHBgkSB5gFt76ag5AW9VeP8xp"
+    expect(adapter).to receive(:straighten_transaction).with(anything, address: address).at_least(:once)
+    expect(adapter.fetch_transactions_for(address)).not_to be_empty
   end
 
-  it "returns the number of confirmations for a transaction" do
+  it "calculates the number of confirmations for each transaction" do
     tid = 'ae0d040f48d75fdc46d9035236a1782164857d6f0cca1f864640281115898560'
     expect(adapter.fetch_transaction(tid)[:confirmations]).to be > 0
   end
 
-  it "raises an exception when something goes wrong with fetching datd" do
-    allow_any_instance_of(URI).to receive(:read).and_raise(OpenURI::HTTPError)
-    expect( -> { adapter.http_request("http://blockchain.info/a-timed-out-request") }).to raise_error(Straight::Blockchain::Adapter::RequestError)
+  it "gets a transaction id among other data" do
+    tid = 'ae0d040f48d75fdc46d9035236a1782164857d6f0cca1f864640281115898560'
+    expect(adapter.fetch_transaction(tid)[:tid]).to eq(tid)
+  end
+
+  it "raises an exception when something goes wrong with fetching data" do
+    expect( -> { adapter.send(:api_request, "/a-404-request") }).to raise_error(Straight::Blockchain::Adapter::RequestError)
   end
 
-  it "calculates total_amount of a transaction for the given address only" do
-    t = { 'outputs' => [{ 'value' => 1, 'address' => 'address1'}, { 'value' => 1, 'address' => 'address2'}] }
-    expect(adapter.send(:straighten_transaction, t, address: 'address1')[:total_amount]).to eq(1)
+  it "uses the same Singleton instance" do
+    a = Straight::Blockchain::BiteasyAdapter.mainnet_adapter
+    b = Straight::Blockchain::BiteasyAdapter.mainnet_adapter
+    expect(a).to eq(b)
   end
 
 end

data/spec/lib/blockchain_adapters/{blockchain_info_spec.rb → blockchain_info_adapter_spec.rb}

@@ -31,7 +31,7 @@ RSpec.describe Straight::Blockchain::BlockchainInfoAdapter do
   end
 
   it "caches blockchain.info latestblock requests" do
-    expect(adapter).to receive(:http_request).once.and_return('{ "height": 1 }')
+    expect(adapter).to receive(:api_request).once.and_return('{ "height": 1 }')
     adapter.send(:calculate_confirmations, { "block_height" => 1 }, force_latest_block_reload: true)
     adapter.send(:calculate_confirmations, { "block_height" => 1 })
     adapter.send(:calculate_confirmations, { "block_height" => 1 })
@@ -40,8 +40,7 @@ RSpec.describe Straight::Blockchain::BlockchainInfoAdapter do
   end
   
   it "raises an exception when something goes wrong with fetching datd" do
-    allow_any_instance_of(URI).to receive(:read).and_raise(OpenURI::HTTPError)
-    expect( -> { adapter.http_request("http://blockchain.info/a-timed-out-request") }).to raise_error(Straight::Blockchain::Adapter::RequestError)
+    expect( -> { adapter.send(:api_request, "/a-404-request") }).to raise_error(Straight::Blockchain::Adapter::RequestError)
   end
 
   it "calculates total_amount of a transaction for the given address only" do
@@ -49,4 +48,10 @@ RSpec.describe Straight::Blockchain::BlockchainInfoAdapter do
     expect(adapter.send(:straighten_transaction, t, address: 'address1')[:total_amount]).to eq(1)
   end
 
+  it "uses the same Singleton instance" do
+    a = Straight::Blockchain::BlockchainInfoAdapter.mainnet_adapter
+    b = Straight::Blockchain::BlockchainInfoAdapter.mainnet_adapter
+    expect(a).to eq(b)
+  end
+
 end