straight 0.2.3 → 1.0.0

data/lib/straight/exchange_rate_adapter.rb

@@ -5,8 +5,8 @@ module Straight
 
       include Singleton
 
-      class FetchingFailed       < Exception; end
-      class CurrencyNotSupported < Exception; end
+      class FetchingFailed       < StraightError; end
+      class CurrencyNotSupported < StraightError; end
 
       def initialize(rates_expire_in: 1800)
         @rates_expire_in = rates_expire_in # in seconds

data/lib/straight/exchange_rate_adapters/average_rate_adapter.rb

@@ -15,7 +15,7 @@ module Straight
         @adapters.each do |adapter|
           begin
             adapter.fetch_rates!
-          rescue Exception => e
+          rescue => e
             failed_fetches += 1
             raise e if failed_fetches == @adapters.size
           end

data/lib/straight/exchange_rate_adapters/okcoin_adapter.rb

@@ -15,4 +15,4 @@ module Straight
     end
 
   end
-end
+end

data/lib/straight/faraday_monkeypatch.rb

@@ -0,0 +1,22 @@
+Faraday::SSLOptions = Faraday::Options.new(*(Faraday::SSLOptions.members | [:verify_callback])) do
+
+  def verify?
+    verify != false
+  end
+
+  def disable?
+    !verify?
+  end
+end
+
+Faraday::ConnectionOptions.options(ssl: Faraday::SSLOptions)
+
+Faraday::Adapter::NetHttp.class_exec do
+
+  alias_method :orig_configure_ssl, :configure_ssl
+
+  def configure_ssl(http, ssl)
+    http.verify_callback = ssl[:verify_callback] if ssl[:verify_callback]
+    orig_configure_ssl(http, ssl)
+  end
+end

data/lib/straight/gateway.rb

@@ -18,7 +18,8 @@ module Straight
   module GatewayModule
 
     # Raised when adapter's list (either Exchange or Blockchain adapters) is empty
-    class NoAdaptersAvailable < Exception;end
+    class NoAdaptersAvailable < StraightError;end
+    class OrderAmountInvalid  < StraightError;end
 
     # Only add getters and setters for those properties in the extended class
     # that don't already have them. This is very useful with ActiveRecord for example
@@ -27,6 +28,7 @@ module Straight
       base.class_eval do
         [
           :pubkey,
+          :test_pubkey,
           :confirmations_required,
           :status_check_schedule,
           :blockchain_adapters,
@@ -34,7 +36,11 @@ module Straight
           :order_callbacks,
           :order_class,
           :default_currency,
-          :name
+          :name,
+          :address_provider,
+          :address_provider_type,
+          :address_derivation_scheme,
+          :test_mode
         ].each do |field|
           attr_reader field unless base.method_defined?(field)
           attr_writer field unless base.method_defined?("#{field}=")
@@ -64,52 +70,67 @@ module Straight
 
     module Includable
 
-      # Creates a new order for the address derived from the pubkey and the keychain_id argument provided.
-      # See explanation of this keychain_id argument is in the description for the #address_for_keychain_id method.
-      def order_for_keychain_id(amount:, keychain_id:, currency: nil, btc_denomination: :satoshi)
+      def blockchain_adapters
+        return test_blockchain_adapters if test_mode
+        @blockchain_adapters
+      end
 
-        amount = amount_from_exchange_rate(
-          amount,
-          currency:         currency,
-          btc_denomination: btc_denomination
+      def test_blockchain_adapters
+        @blockchain_adapters.map{ |el| el.class.testnet_adapter rescue next }.compact
+      end
+
+      # Creates a new order for the address derived from the pubkey and the keychain_id argument provided.
+      # See explanation of this keychain_id argument is in the description for the AddressProvider::Base#new_address method.
+      def new_order(args)
+
+        # Args: amount:, keychain_id: nil, currency: nil, btc_denomination: :satoshi
+        # 
+        # The reason these arguments are supplied as a hash and not as named arguments
+        # is because we don't know in advance which arguments are required for a particular
+        # AddressAdapter. So we accpet all, check manually for required ones like :amount,
+        # set default values where needed and then hand them all to address_adapter.
+        if args[:amount].nil? || !args[:amount].kind_of?(Numeric) || args[:amount] <= 0
+          raise OrderAmountInvalid, "amount cannot be nil and should be more than 0" 
+        end
+        # Setting default values
+        args[:currency]         ||= default_currency
+        args[:btc_denomination] ||= :satoshi
+
+        amount = args[:amount_from_exchange_rate] = amount_from_exchange_rate(
+          args[:amount],
+          currency:         args[:currency],
+          btc_denomination: args[:btc_denomination]
         )
 
+        if address_provider.takes_fees?
+          address, amount = address_provider.new_address_and_amount(**args)
+        else
+          address = address_provider.new_address(**args)
+        end
+
         order             = Kernel.const_get(order_class).new
-        order.amount      = amount
         order.gateway     = self
-        order.address     = address_for_keychain_id(keychain_id)
-        order.keychain_id = keychain_id
+        order.keychain_id = args[:keychain_id]
+        order.address     = address
+        order.amount      = amount
         order
       end
 
-      # Returns a Base58-encoded Bitcoin address to which the payment transaction
-      # is expected to arrive. id is an an integer > 0 (hopefully not too large and hopefully
-      # 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)
-        # First check the depth. If the depth is 4 use '/i' notation (Mycelium iOS wallet)
-        # TODO deal with other depths later. Currently only supports 0 and 4
-        if keychain.depth > 0
-          keychain.node_for_path(id.to_s).to_address
-        else # Otherwise, use 'm/0/n' - both Electrum and Mycelium on Android
-          keychain.node_for_path("m/0/#{id.to_s}").to_address
-        end
-      end
-      
       def fetch_transaction(tid, address: nil)
-        try_adapters(@blockchain_adapters, type: "blockchain") { |b| b.fetch_transaction(tid, address: address) }
+        try_adapters(blockchain_adapters, type: "blockchain") { |b| b.fetch_transaction(tid, address: address) }
       end
       
       def fetch_transactions_for(address)
-        try_adapters(@blockchain_adapters, type: "blockchain") { |b| b.fetch_transactions_for(address) }
+        try_adapters(blockchain_adapters, type: "blockchain", raise_exceptions: [Blockchain::Adapter::BitcoinAddressInvalid]) { |b| b.fetch_transactions_for(address) }
       end
       
       def fetch_balance_for(address)
-        try_adapters(@blockchain_adapters, type: "blockchain") { |b| b.fetch_balance_for(address) }
+        try_adapters(blockchain_adapters, type: "blockchain") { |b| b.fetch_balance_for(address) }
       end
 
       def keychain
-        @keychain ||= MoneyTree::Node.from_bip32(pubkey)
+        key = self.test_mode ? self.test_pubkey : self.pubkey
+        @keychain ||= BTC::Keychain.new(xpub: key)
       end
 
       # This is a callback method called from each order
@@ -145,11 +166,23 @@ module Straight
         end
       end
 
+      def test_pubkey_missing?
+        address_provider_type == :Bip32 && test_mode && test_pubkey.to_s.empty?
+      end
+
+      def pubkey_missing?
+        address_provider_type == :Bip32 && !test_mode && pubkey.to_s.empty?
+      end
+
+      def address_provider_type
+        @address_provider ? @address_provider.class.name.split('::')[-1].to_sym  : :Bip32
+      end
+
       private
-        
+
         # Calls the block with each adapter until one of them does not fail.
         # Fails with the last exception.
-        def try_adapters(adapters, type: nil, &block)
+        def try_adapters(adapters, type: nil, raise_exceptions: [], &block)
 
           # TODO: specify which adapters are unavailable (blockchain or exchange rate)
           raise NoAdaptersAvailable, "the list of #{type} adapters is empty or nil" if adapters.nil? || adapters.empty?
@@ -160,7 +193,8 @@ module Straight
               result = yield(adapter)
               last_exception = nil
               return result
-            rescue Exception => e
+            rescue => e
+              raise e if raise_exceptions.include?(e)
               last_exception = e
               # If an Exception is raised, it passes on
               # to the next adapter and attempts to call a method on it.
@@ -182,7 +216,8 @@ module Straight
       @default_currency = 'BTC'
       @blockchain_adapters = [
         Blockchain::BlockchainInfoAdapter.mainnet_adapter,
-        Blockchain::MyceliumAdapter.mainnet_adapter
+        Blockchain::MyceliumAdapter.mainnet_adapter,
+        Blockchain::InsightAdapter.mainnet_adapter(main_url: "https://insight.mycelium.com/api")
       ]
       @exchange_rate_adapters = [
         ExchangeRate::BitpayAdapter.instance, 
@@ -194,6 +229,8 @@ module Straight
         ExchangeRate::OkcoinAdapter.instance
       ]
       @status_check_schedule = DEFAULT_STATUS_CHECK_SCHEDULE
+      @address_provider = AddressProvider::Bip32.new(self)
+      @test_mode = false
     end
 
     def order_class

data/lib/straight/order.rb

@@ -22,7 +22,7 @@ module Straight
     # where we don't want to override AR getters and setters that set attribtues.
     def self.included(base)
       base.class_eval do
-        [:amount, :address, :gateway, :keychain_id, :status, :tid].each do |field|
+        [:amount, :amount_paid, :address, :gateway, :keychain_id, :status, :tid, :title, :callback_url, :test_mode].each do |field|
           attr_reader field unless base.method_defined?(field)
           attr_writer field unless base.method_defined?("#{field}=")
         end
@@ -41,12 +41,13 @@ module Straight
       paid:         2, # transaction received with enough confirmations and the correct amount
       underpaid:    3, # amount that was received in a transaction was not enough
       overpaid:     4, # amount that was received in a transaction was too large
-      expired:      5  # too much time passed since creating an order
+      expired:      5, # too much time passed since creating an order
+      canceled:     6, # user decides to economize
     }
 
     attr_reader :old_status
 
-    class IncorrectAmount < Exception; end
+    class IncorrectAmount < StraightError; end
 
     # If you are defining methods in this module, it means you most likely want to
     # call super() somehwere inside those methods. An example would be the #status=
@@ -65,7 +66,7 @@ module Straight
       def status(as_sym: false, reload: false)
 
         if defined?(super)
-          begin 
+          begin
             @status = super
           # if no method with arguments found in the class
           # we're prepending to, then let's use a standard getter
@@ -78,43 +79,25 @@ module Straight
         # 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.
-        # Therefore, even if you remove the following line, status won't actually
-        # be allowed to change.
-        return @status if @status && @status > 1 
-
-        if reload || !@status
-          t = transaction(reload: reload)
-          self.status = if t.nil?
-            STATUSES[:new]
-          else
-            if t[:confirmations] >= gateway.confirmations_required
-              if t[:total_amount] == amount
-                STATUSES[:paid]
-              elsif t[:total_amount] < amount
-                STATUSES[:underpaid]
-              else
-                STATUSES[:overpaid]
-              end
-            else
-              STATUSES[:unconfirmed]
-            end
-          end
+        if (reload || @status.nil?) && !status_locked?
+          self.status = get_transaction_status(reload: reload)
         end
-        as_sym ? STATUSES.invert[@status] : @status 
+
+        as_sym ? STATUSES.invert[@status] : @status
       end
 
       def status=(new_status)
         # Prohibit status update if the order was paid in some way,
         # so statuses above 1 are in fact immutable.
-        return false if @status && @status > 1
+        return false if status_locked?
 
         self.tid = transaction[:tid] if transaction
-        
+
         # Pay special attention to the order of these statements. If you place
         # the assignment @status = new_status below the callback call,
         # you may get a "Stack level too deep" error if the callback checks
         # for the status and it's nil (therefore, force reload and the cycle continues).
-        # 
+        #
         # 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)
@@ -124,6 +107,34 @@ module Straight
         super if defined?(super)
       end
 
+      def set_amount_paid(transaction)
+        self.amount_paid = transaction[:total_amount]
+      end
+
+      def get_transaction_status(reload: false)
+        t = transaction(reload: reload)
+        
+        return STATUSES[:new] if t.nil?
+        return STATUSES[:unconfirmed] if status_unconfirmed?(t[:confirmations])
+
+        set_amount_paid(t)
+        if t[:total_amount] == amount
+          STATUSES[:paid]
+        elsif t[:total_amount] < amount
+          STATUSES[:underpaid]
+        else
+          STATUSES[:overpaid]
+        end
+      end
+
+      def status_unconfirmed?(confirmations)
+        confirmations < gateway.confirmations_required
+      end
+
+      def status_locked?
+        @status && @status > 1
+      end
+
       def status_changed?
         @status_changed
       end
@@ -170,7 +181,7 @@ module Straight
       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, duration: 600, time_passed: 0)
@@ -200,8 +211,8 @@ 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)
+      def amount_in_btc(field: amount, as: :number)
+        a = Satoshi.new(field, from_unit: :satoshi, to_unit: :btc)
         as == :string ? a.to_unit(as: :string) : a.to_unit
       end
 

data/straight.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: straight 0.2.3 ruby lib
+# stub: straight 1.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "straight"
-  s.version = "0.2.3"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Roman Snitko"]
-  s.date = "2015-05-30"
+  s.date = "2015-07-31"
   s.description = "An engine for the Straight payment gateway software. Requires no state to be saved (that is, no storage or DB). Its responsibilities only include processing data coming from an actual gateway."
   s.email = "roman.snitko@gmail.com"
   s.extra_rdoc_files = [
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -28,9 +29,12 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/straight.rb",
+    "lib/straight/address_providers/base.rb",
+    "lib/straight/address_providers/bip32.rb",
     "lib/straight/blockchain_adapter.rb",
     "lib/straight/blockchain_adapters/biteasy_adapter.rb",
     "lib/straight/blockchain_adapters/blockchain_info_adapter.rb",
+    "lib/straight/blockchain_adapters/insight_adapter.rb",
     "lib/straight/blockchain_adapters/mycelium_adapter.rb",
     "lib/straight/exchange_rate_adapter.rb",
     "lib/straight/exchange_rate_adapters/average_rate_adapter.rb",
@@ -41,23 +45,9 @@ Gem::Specification.new do |s|
     "lib/straight/exchange_rate_adapters/kraken_adapter.rb",
     "lib/straight/exchange_rate_adapters/localbitcoins_adapter.rb",
     "lib/straight/exchange_rate_adapters/okcoin_adapter.rb",
+    "lib/straight/faraday_monkeypatch.rb",
     "lib/straight/gateway.rb",
     "lib/straight/order.rb",
-    "spec/lib/blockchain_adapters/biteasy_adapter_spec.rb",
-    "spec/lib/blockchain_adapters/blockchain_info_adapter_spec.rb",
-    "spec/lib/blockchain_adapters/mycelium_adapter_spec.rb",
-    "spec/lib/exchange_rate_adapter_spec.rb",
-    "spec/lib/exchange_rate_adapters/average_rate_adapter_spec.rb",
-    "spec/lib/exchange_rate_adapters/bitpay_adapter_spec.rb",
-    "spec/lib/exchange_rate_adapters/bitstamp_adapter_spec.rb",
-    "spec/lib/exchange_rate_adapters/btce_adapter_spec.rb",
-    "spec/lib/exchange_rate_adapters/coinbase_adapter_spec.rb",
-    "spec/lib/exchange_rate_adapters/kraken_adapter_spec.rb",
-    "spec/lib/exchange_rate_adapters/localbitcoins_adapter_spec.rb",
-    "spec/lib/exchange_rate_adapters/okcoin_adapter_spec.rb",
-    "spec/lib/gateway_spec.rb",
-    "spec/lib/order_spec.rb",
-    "spec/spec_helper.rb",
     "straight.gemspec"
   ]
   s.homepage = "http://github.com/snitko/straight"
@@ -69,24 +59,27 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<money-tree>, ["= 0.9.0"])
-      s.add_runtime_dependency(%q<satoshi-unit>, [">= 0"])
-      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<btcruby>, ["~> 1.0"])
+      s.add_runtime_dependency(%q<satoshi-unit>, ["~> 0.1"])
+      s.add_runtime_dependency(%q<httparty>, ["~> 0.13.5"])
+      s.add_runtime_dependency(%q<faraday>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
       s.add_development_dependency(%q<github_api>, ["= 0.11.3"])
     else
-      s.add_dependency(%q<money-tree>, ["= 0.9.0"])
-      s.add_dependency(%q<satoshi-unit>, [">= 0"])
-      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<btcruby>, ["~> 1.0"])
+      s.add_dependency(%q<satoshi-unit>, ["~> 0.1"])
+      s.add_dependency(%q<httparty>, ["~> 0.13.5"])
+      s.add_dependency(%q<faraday>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
       s.add_dependency(%q<github_api>, ["= 0.11.3"])
     end
   else
-    s.add_dependency(%q<money-tree>, ["= 0.9.0"])
-    s.add_dependency(%q<satoshi-unit>, [">= 0"])
-    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<btcruby>, ["~> 1.0"])
+    s.add_dependency(%q<satoshi-unit>, ["~> 0.1"])
+    s.add_dependency(%q<httparty>, ["~> 0.13.5"])
+    s.add_dependency(%q<faraday>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
     s.add_dependency(%q<github_api>, ["= 0.11.3"])