stellar_base-rails 3.1.0 → 4.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74b62f61385eba2ad71a788469192da7d9056875055582a17c38e982688f0bfc
-  data.tar.gz: 37012d044e08a99b22116cfc54b243a27440721ed4a26eee198c022d10d327c8
+  metadata.gz: 1bdb1de1dfc55634223730e54bb842bfafd076cc22eac56dbc11357eaeabbb6d
+  data.tar.gz: 0275c78f1e5ab0d14a0a20145c4cd9b0b26895b53d37d6ef9e3bfdc73b9a4f1a
 SHA512:
-  metadata.gz: 2868b757d5cea6de7ca3a25e9d4f3131f029954f07a2f995b674c858fb6602b00c041a1877176d1c9f106a8d2e543ef2cbd608129e116caa9b9fd01f3f2703ee
-  data.tar.gz: 54ef4814eb47f06e8d7148b4f6eaf1d68b0ba89d64b38d56b2af169b957e7962a2009cfffaf203c6ad918e6088eb1cd78507b043c4bdf12e5149f60033fbe26e
+  metadata.gz: 5900cbcd9b5c4069feb88c0cc829a8bfddef0b0f71addf8491b6c2b2fe18edbf238ed5cf40e883d915e813440b59f0951d06daa41dc9430a42fc3321a8258e0c
+  data.tar.gz: 55c79dadfa9626290bf42a081d6d95537295e147b82176cabca5df41c630fcc2950653df886b60a0335272de9d4d014e04c5862eefd234a09a33fbbe63806dfb

data/README.md

@@ -102,6 +102,8 @@ gem 'stellar_base-rails'
 And then execute:
 ```bash
 $ bundle
+$ rails stellar_base:install:migrations
+$ rails db:migrate
 ```
 
 If you're using `StellarBase.on_deposit_trigger` you'll need to install:

data/app/concepts/stellar_base/deposit_requests/contracts/create.rb

@@ -9,6 +9,7 @@ module StellarBase
         property :memo
         property :email_address
         property :deposit_type
+        property :extra_info
 
         validates(
           :asset_code,

data/app/concepts/stellar_base/deposit_requests/operations/create.rb

@@ -3,15 +3,14 @@ module StellarBase
     module Operations
       class Create < ApplicationOperation
 
-        DEFAULT_ETA = (10 * 60).freeze
-
         step self::Policy::Pundit(DepositRequestPolicy, :create?)
         step Model(DepositRequest, :new)
+        step :find_depositable_asset_details!
         step :setup_params!
+        step :set_extra_info!
         step Contract::Build(constant: Contracts::Create)
         step Contract::Validate(key: :deposit_request)
         step Contract::Persist(method: :sync)
-        step :find_depositable_asset_details!
         step :determine_how!
         step :determine_max_amount!
         success :set_defaults!
@@ -30,34 +29,35 @@ module StellarBase
 
         def find_depositable_asset_details!(options, params:, **)
           details = FindDepositableAsset.(params[:deposit_request][:asset_code])
-          params[:deposit_asset_details] = details.presence || {}
+          options[:asset_details] = details.presence || {}
         end
 
-        def determine_how!(options, params:, **)
-          details = params[:deposit_asset_details]
-          options["model"].deposit_address =
-            DetermineHow.(details[:how_from], params[:deposit_request])
+        def determine_how!(options, params:, asset_details:, model:, **)
+          model.deposit_address =
+            DetermineHow.(asset_details[:how_from], params[:deposit_request])
         end
 
-        def determine_max_amount!(options, params:, **)
-          details = params[:deposit_asset_details]
-          options["model"].max_amount =
-            ConfiguredClassRunner.(details[:max_amount_from]) || 0
+        def set_extra_info!(ctx, params:, asset_details:, **)
+          params[:deposit_request][:extra_info] =
+            DetermineExtraInfo.(asset_details).to_json
         end
 
-        def set_defaults!(options, params:, **)
-          details = params[:deposit_asset_details]
+        def determine_max_amount!(options, params:, asset_details:, model:, **)
+          model.max_amount =
+            ConfiguredClassRunner.(asset_details[:max_amount_from]) || 0
+        end
 
-          options["model"].asset_type = details[:type]
-          options["model"].issuer = details[:issuer]
-          options["model"].eta = DEFAULT_ETA
-          options["model"].min_amount = 0.0
+        def set_defaults!(options, params:, model:, asset_details:, **)
+          model.asset_type = asset_details[:type]
+          model.issuer = asset_details[:issuer]
+          model.eta =
+            DetermineEta.(asset_details[:eta_from], params[:deposit_request])
+          model.min_amount = 0.0
 
           # Make Deposits free unless we want it configured
-          #
-          # TODO: this should come from `CallFeeFrom.(details[:fee_from)`
-          options["model"].fee_fixed = details[:fee_fixed] || 0.0
-          options["model"].fee_percent = details[:fee_percent] || 0.0
+          # TODO: this should come from `CallDepositFeeFrom.(params, asset_details)`
+          model.fee_fixed = asset_details[:fee_fixed] || 0.0
+          model.fee_percent = asset_details[:fee_percent] || 0.0
         end
 
         def memo_type_from(params)

data/app/concepts/stellar_base/fee_requests/operations/show.rb

@@ -29,9 +29,9 @@ module StellarBase
         end
 
         def set_fee_response!(options, model:, asset_details:, params:, **)
-          model.fee_response = FeeRequests::CallFeeFrom.(
+          model.fee_response = FeeRequests::CallWithdrawFeeFixedQuoteFrom.(
             fee_request: model,
-            fee_from: asset_details[:fee_from],
+            fee_fixed_quote_from: asset_details[:fee_fixed_quote_from],
           )
         end
 

data/app/concepts/stellar_base/withdrawal_requests/contracts/create.rb

@@ -7,16 +7,17 @@ module StellarBase
         property :asset_code
         property :dest
         property :dest_extra
-        property :fee_network
+        property :fee_fixed
 
         validates(
           :asset_type,
           :asset_code,
           :dest,
-          :fee_network,
+          :fee_fixed,
           presence: true,
         )
         validate :check_valid_asset_code
+        validates(:fee_fixed, numericality: {greater_than_or_equal_to: 0})
 
         def check_valid_asset_code
           asset_codes = StellarBase.configuration.withdrawable_assets

data/app/concepts/stellar_base/withdrawal_requests/operations/create.rb

@@ -10,10 +10,11 @@ module StellarBase
         failure :set_policy_error!
         step Model(WithdrawalRequest, :new)
         step :setup_params!
+        step :find_withdrawal_asset_details!
+        step :set_fee_fixed!
         step Contract::Build(constant: Contracts::Create)
         step Contract::Validate(key: :withdrawal_request)
         step Contract::Persist(method: :sync)
-        step :find_withdrawal_asset_details!
         success :set_defaults!
         step Contract::Persist(method: :save)
 
@@ -29,38 +30,26 @@ module StellarBase
           })
         end
 
-        def find_withdrawal_asset_details!(options, params:, **)
-          details = FindWithdrawableAsset
-            .(params[:withdrawal_request][:asset_code])
-          params[:withdrawal_asset_details] = details.presence || {}
+        def find_withdrawal_asset_details!(ctx, params:, **)
+          asset_code = params[:withdrawal_request][:asset_code]
+          details = FindWithdrawableAsset.(asset_code)
+          ctx["asset_details"] = details.presence || {}
         end
 
-        def set_defaults!(options, params:, **)
-          withdrawal_asset_details = params[:withdrawal_asset_details]
-
-          fee_network = DetermineFee.network(
-            withdrawal_asset_details[:network],
-            params[:withdrawal_request][:fee_network],
-          )
-
-          options["model"].issuer = withdrawal_asset_details[:issuer]
-          options["model"].account_id =
-            StellarBase.configuration.distribution_account
-          options["model"].memo_type = "text"
-          options["model"].memo = GenMemoFor.(WithdrawalRequest)
-          options["model"].eta = DEFAULT_ETA
-          options["model"].min_amount = 0.0
-          options["model"].max_amount =
-            DetermineMaxAmount.(withdrawal_asset_details[:max_amount_from])
-
-          # TODO: This should come from `CallFeeFrom.(details[:fee_from])`
-          # or dest_extra
-          options["model"].fee_fixed =
-            DetermineFee.(withdrawal_asset_details[:fee_fixed])
+        def set_fee_fixed!(ctx, params:, asset_details:, **)
+          params[:withdrawal_request][:fee_fixed] =
+            CallFeeFixedFrom.(params[:withdrawal_request], asset_details)
+        end
 
-          options["model"].fee_percent =
-            DetermineFee.(withdrawal_asset_details[:fee_percent])
-          options["model"].fee_network = fee_network
+        def set_defaults!(options, params:, asset_details:, model:, **)
+          model.issuer = asset_details[:issuer]
+          model.account_id = StellarBase.configuration.distribution_account
+          model.memo_type = "text"
+          model.memo = GenMemoFor.(WithdrawalRequest)
+          model.eta = DEFAULT_ETA
+          model.min_amount = 0.0
+          model.max_amount = DetermineMaxAmount.(asset_details[:max_amount_from])
+          model.fee_percent = DetermineFee.(asset_details[:fee_percent])
         end
 
       end

data/app/controllers/stellar_base/withdraw_controller.rb

@@ -25,7 +25,6 @@ module StellarBase
         :asset_code,
         :dest,
         :dest_extra,
-        :fee_network,
         :type,
       ).to_hash.with_indifferent_access
     end

data/app/representers/stellar_base/deposit_request_representer.rb

@@ -7,7 +7,13 @@ module StellarBase
     property :max_amount
     property :fee_fixed
     property :fee_percent
-    property :extra_info
+    property :extra_info, exec_context: :decorator
+
+    def extra_info
+      ::JSON.parse(represented.extra_info)
+    rescue
+      {}
+    end
 
   end
 end

data/app/representers/stellar_base/withdrawal_request_representer.rb

@@ -8,7 +8,6 @@ module StellarBase
     property :max_amount
     property :fee_fixed
     property :fee_percent
-    property :fee_network
     property :extra_info
 
   end

data/app/services/stellar_base/bridge_callbacks/process.rb

@@ -9,8 +9,7 @@ module StellarBase
 
       def self.callback_class
         on_bridge_callback = StellarBase.configuration.on_bridge_callback
-        return on_bridge_callback if on_bridge_callback.respond_to?(:call)
-        on_bridge_callback.constantize
+        GetCallbackFrom.(on_bridge_callback)
       rescue NameError
         error_message = [
           "StellarBase.on_bridge_callback isn't configured or the",

data/app/services/stellar_base/configured_class_runner.rb

@@ -5,7 +5,10 @@ module StellarBase
 
     def self.call(class_name)
       # TODO: how do we handle errors
-      return class_name.constantize.send(:call) if class_name.present?
+      if class_name.present?
+        callback = GetCallbackFrom.(class_name)
+        return callback.send(:call)
+      end
       DEFAULT
     end
 

data/app/services/stellar_base/deposit_requests/determine_eta.rb

@@ -0,0 +1,22 @@
+module StellarBase
+  module DepositRequests
+    class DetermineEta
+
+      DEFAULT = nil
+
+      def self.call(class_name, params)
+        # TODO: how do we handle errors
+        if class_name.present?
+          callback = GetCallbackFrom.(class_name)
+          unless callback.method(:call).arity.zero?
+            return callback.send(:call, params)
+          end
+
+          return callback.send(:call)
+        end
+        DEFAULT
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/deposit_requests/determine_how.rb

@@ -7,11 +7,12 @@ module StellarBase
       def self.call(class_name, params)
         # TODO: how do we handle errors
         if class_name.present?
-          unless class_name.constantize.method(:call).arity.zero?
-            return class_name.constantize.send(:call, params)
+          callback = GetCallbackFrom.(class_name)
+          unless callback.method(:call).arity.zero?
+            return callback.send(:call, params)
           end
 
-          return class_name.constantize.send(:call)
+          return callback.send(:call)
         end
         DEFAULT
       end

data/app/services/stellar_base/determine_extra_info.rb

@@ -0,0 +1,14 @@
+module StellarBase
+  class DetermineExtraInfo
+
+    def self.call(asset_details)
+      info_from =
+        GetCallbackFrom.(asset_details[:extra_info_from])
+
+      if info_from
+        return info_from.(asset_details)
+      end
+    end
+
+  end
+end

data/app/services/stellar_base/fee_requests/call_withdraw_fee_fixed_quote_from.rb

@@ -0,0 +1,42 @@
+module StellarBase
+  module FeeRequests
+    class CallWithdrawFeeFixedQuoteFrom
+
+      FEE_FIXED_QUOTE_FROM_ERROR = "`fee_fixed_quote_from` must be a string of an object " \
+        "that responds to `.call` or the object itself".freeze
+
+      def self.call(fee_request:, fee_fixed_quote_from:)
+        asset_details = asset_details_from(fee_request)
+
+        if fee = asset_details[:fee_fixed]
+          return fee
+        end
+
+        return 0.0 if fee_fixed_quote_from.nil?
+
+        callback = callback_from(fee_fixed_quote_from)
+        callback.(fee_request)
+      end
+
+      def self.callback_from(fee_fixed_quote_from)
+        fee_fixed_quote_from = GetCallbackFrom.(fee_fixed_quote_from)
+
+        if !fee_fixed_quote_from.respond_to?(:call)
+          fail ArgumentError, FEE_FIXED_QUOTE_FROM_ERROR
+        end
+
+        fee_fixed_quote_from
+      end
+
+      private
+
+      def self.asset_details_from(fee_request)
+        FindAssetDetails.(
+          operation: "withdraw",
+          asset_code: fee_request.asset_code,
+        )
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/get_callback_from.rb

@@ -0,0 +1,13 @@
+module StellarBase
+  class GetCallbackFrom
+
+    def self.call(callback)
+      if callback.respond_to?(:constantize)
+        callback = callback.constantize
+      end
+
+      callback
+    end
+
+  end
+end

data/app/services/stellar_base/withdrawal_requests/call_fee_fixed_from.rb

@@ -0,0 +1,29 @@
+module StellarBase
+  module WithdrawalRequests
+    class CallFeeFixedFrom
+
+      CALLBACK_CONFIG_NAME = :fee_fixed_from
+      INVALID_FEE_MESSAGE =
+        "`fee_fixed_from` must return a value >= 0".freeze
+
+      def self.call(params, asset_details)
+        if fee_fixed = asset_details[:fee_fixed]
+          return fee_fixed
+        end
+
+        callback = GetCallbackFrom.(asset_details[CALLBACK_CONFIG_NAME])
+
+        return 0.0 if callback.nil?
+
+        fee_fixed = callback.(params, asset_details)
+
+        if fee_fixed.nil?
+          fail ArgumentError, INVALID_FEE_MESSAGE
+        end
+
+        fee_fixed
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/withdrawal_requests/call_on_withdraw.rb

@@ -15,9 +15,7 @@ module StellarBase
       end
 
       def self.callback_from(on_withdraw)
-        if on_withdraw.respond_to?(:constantize)
-          on_withdraw = on_withdraw.constantize
-        end
+        on_withdraw = GetCallbackFrom.(on_withdraw)
 
         if !on_withdraw.respond_to?(:call)
           fail ArgumentError, ON_WITHDRAW_ERROR

data/app/services/stellar_base/withdrawal_requests/determine_max_amount.rb

@@ -5,8 +5,8 @@ module StellarBase
       DEFAULT = nil
 
       def self.call(class_name)
-        return class_name.constantize.send(:call) if class_name.present?
-        DEFAULT
+        return DEFAULT if class_name.blank?
+        GetCallbackFrom.(class_name).()
       end
 
     end

data/app/twins/stellar_base/withdrawal_request_twin.rb

@@ -8,7 +8,6 @@ module StellarBase
     property :max_amount
     property :fee_fixed
     property :fee_percent
-    property :fee_network
     property :extra_info
 
   end

data/db/migrate/20190808014913_remove_fee_network.rb

@@ -0,0 +1,8 @@
+class RemoveFeeNetwork < ActiveRecord::Migration[5.2]
+  def change
+    remove_column(:stellar_base_withdrawal_requests, :fee_network, :decimal, {
+      default: "0.0",
+      null: false,
+    })
+  end
+end

data/lib/stellar_base/version.rb

@@ -1,3 +1,3 @@
 module StellarBase
-  VERSION = "3.1.0".freeze
+  VERSION = "4.2.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stellar_base-rails
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.2.2
 platform: ruby
 authors:
 - Ace Subido
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-07 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: disposable
@@ -112,30 +112,30 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: representable
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: toml-rb
   requirement: !ruby/object:Gem::Requirement
@@ -199,6 +199,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -206,6 +209,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: trailblazer-rails
   requirement: !ruby/object:Gem::Requirement
@@ -484,6 +490,7 @@ files:
 - app/services/stellar_base/bridge_callbacks/verify_mac_payload.rb
 - app/services/stellar_base/configured_class_runner.rb
 - app/services/stellar_base/deposit_requests/create_deposit.rb
+- app/services/stellar_base/deposit_requests/determine_eta.rb
 - app/services/stellar_base/deposit_requests/determine_how.rb
 - app/services/stellar_base/deposit_requests/find_config.rb
 - app/services/stellar_base/deposit_requests/find_deposit_request.rb
@@ -496,13 +503,16 @@ files:
 - app/services/stellar_base/deposit_requests/send_asset.rb
 - app/services/stellar_base/deposit_requests/trigger.rb
 - app/services/stellar_base/deposit_requests/update_deposit.rb
-- app/services/stellar_base/fee_requests/call_fee_from.rb
+- app/services/stellar_base/determine_extra_info.rb
+- app/services/stellar_base/fee_requests/call_withdraw_fee_fixed_quote_from.rb
 - app/services/stellar_base/find_asset_details.rb
 - app/services/stellar_base/gen_memo_for.rb
 - app/services/stellar_base/gen_random_string.rb
+- app/services/stellar_base/get_callback_from.rb
 - app/services/stellar_base/init_asset_sending_client.rb
 - app/services/stellar_base/init_stellar_client.rb
 - app/services/stellar_base/subscribe_account.rb
+- app/services/stellar_base/withdrawal_requests/call_fee_fixed_from.rb
 - app/services/stellar_base/withdrawal_requests/call_on_withdraw.rb
 - app/services/stellar_base/withdrawal_requests/determine_fee.rb
 - app/services/stellar_base/withdrawal_requests/determine_max_amount.rb
@@ -523,6 +533,7 @@ files:
 - db/migrate/20181003072138_create_stellar_base_account_subscriptions.rb
 - db/migrate/20181210043919_add_unique_index_to_deposits.rb
 - db/migrate/20181217090323_create_stellar_transactions_and_operations.rb
+- db/migrate/20190808014913_remove_fee_network.rb
 - lib/stellar_base-rails.rb
 - lib/stellar_base.rb
 - lib/stellar_base/engine.rb
@@ -558,7 +569,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Mountable Stellar API Endpoints for Rails

data/app/services/stellar_base/fee_requests/call_fee_from.rb

@@ -1,28 +0,0 @@
-module StellarBase
-  module FeeRequests
-    class CallFeeFrom
-
-      FEE_FROM_ERROR = "`fee_from` must be a string of an object " \
-        "that responds to `.call` or the object itself".freeze
-
-      def self.call(fee_request:, fee_from:)
-        return 0 if fee_from.nil?
-        callback = callback_from(fee_from)
-        callback.(fee_request)
-      end
-
-      def self.callback_from(fee_from)
-        if fee_from.respond_to?(:constantize)
-          fee_from = fee_from.constantize
-        end
-
-        if !fee_from.respond_to?(:call)
-          fail ArgumentError, FEE_FROM_ERROR
-        end
-
-        fee_from
-      end
-
-    end
-  end
-end