stellar_base-rails 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd04e0a80166c2240b0758ebaa6eae6cefab1304a57062ea349613e0698339f4
-  data.tar.gz: 45b0f0c8323a6229b421b5baba5fab3d44cbf034396263f4ef56458ff7f9db6c
+  metadata.gz: 74b62f61385eba2ad71a788469192da7d9056875055582a17c38e982688f0bfc
+  data.tar.gz: 37012d044e08a99b22116cfc54b243a27440721ed4a26eee198c022d10d327c8
 SHA512:
-  metadata.gz: 29006920d37951497ce155702bef8c6f0537a69ccf105a7a0ada4beafcc585fb090d06b5dbfbafd012c56e7c9ff32a350bf8667b9015b6fe94800ab882d457f1
-  data.tar.gz: ddb54313dad9a7fa4299f4a062edd5042f234e9673d51872f7b7bad64dc494b86294918ab03b636df0ace59884400dcc3974ca02696d5cd98cd45e2f2f6a85d0
+  metadata.gz: 2868b757d5cea6de7ca3a25e9d4f3131f029954f07a2f995b674c858fb6602b00c041a1877176d1c9f106a8d2e543ef2cbd608129e116caa9b9fd01f3f2703ee
+  data.tar.gz: 54ef4814eb47f06e8d7148b4f6eaf1d68b0ba89d64b38d56b2af169b957e7962a2009cfffaf203c6ad918e6088eb1cd78507b043c4bdf12e5149f60033fbe26e

data/README.md

@@ -20,6 +20,7 @@ rails db:migrate
 ```
 
 ### Configuration
+
 Create an initializer in your rails application:
 
 ```
@@ -115,14 +116,7 @@ gem("stellar-sdk", {
 
 ## Development
 
-```ruby
-cp spec/config.yml{.sample,}
-```
-
-Edit the `spec/config.yml` file.
-
 ```sh
-cd spec/dummy
 rails db:migrate
 rails db:migrate RAILS_ENV=test
 ```

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

@@ -54,6 +54,8 @@ module StellarBase
           options["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
         end

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

@@ -0,0 +1,50 @@
+module StellarBase
+  module FeeRequests
+    module Contracts
+      class Show < ApplicationContract
+
+        property :operation
+        property :type
+        property :asset_code
+        property :amount
+
+        OPERATION_TYPES = %w[deposit withdraw].freeze
+
+        validates(
+          :operation,
+          presence: true,
+          inclusion: {
+            in: OPERATION_TYPES,
+            message:  "%{value} is not a valid operation",
+          },
+        )
+        validates(:asset_code, :amount, presence: true)
+
+        validate :check_valid_asset_code
+
+        def check_valid_asset_code
+          return if operation.blank?
+          asset_codes = if operation == "deposit"
+                          StellarBase.configuration.depositable_assets
+                            &.map do |asset|
+                              asset[:asset_code]
+                            end
+                        else
+                          StellarBase.configuration.withdrawable_assets
+                            &.map do |asset|
+                              asset[:asset_code]
+                            end
+                        end
+
+          return if asset_codes.include? asset_code
+
+          errors.add(
+            :asset_code,
+            "invalid asset_code. Valid asset_codes: #{asset_codes.join(', ')}",
+          )
+        end
+
+      end
+    end
+  end
+end

data/app/concepts/stellar_base/fee_requests/fee_request_policy.rb

@@ -0,0 +1,18 @@
+module StellarBase
+  module FeeRequests
+    class FeeRequestPolicy
+
+      def initialize(_, _)
+      end
+
+      def show?
+        StellarBase.included_module?(:fees) &&
+          (
+            StellarBase.included_module?(:withdraw) ||
+              StellarBase.included_module?(:deposit)
+          )
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+module StellarBase
+  module FeeRequests
+    module Operations
+      class Show < ApplicationOperation
+
+        POLICY_ERROR_MESSAGE = "You are unauthorized to request fee details".freeze
+
+        step self::Policy::Pundit(FeeRequestPolicy, :show?)
+        failure :set_policy_error!
+        step Model(FeeRequest, :new)
+        step Contract::Build(constant: Contracts::Show)
+        step Contract::Validate(key: :fee_request)
+        step Contract::Persist(method: :sync)
+        step :find_asset_details!
+        success :set_fee_response!
+
+        private
+
+        def set_policy_error!(options, params:, **)
+          options["result.policy.message"] = POLICY_ERROR_MESSAGE
+        end
+
+        def find_asset_details!(options, params:, **)
+          details = FindAssetDetails.(
+            operation: params[:fee_request][:operation],
+            asset_code: params[:fee_request][:asset_code],
+          )
+          options[:asset_details] = details.presence || {}
+        end
+
+        def set_fee_response!(options, model:, asset_details:, params:, **)
+          model.fee_response = FeeRequests::CallFeeFrom.(
+            fee_request: model,
+            fee_from: asset_details[:fee_from],
+          )
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -52,8 +52,12 @@ module StellarBase
           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])
+
           options["model"].fee_percent =
             DetermineFee.(withdrawal_asset_details[:fee_percent])
           options["model"].fee_network = fee_network

data/app/controllers/stellar_base/application_controller.rb

@@ -1,5 +1,18 @@
 module StellarBase
   class ApplicationController < ActionController::Base
     protect_from_forgery with: :null_session
+
+    private
+
+    def errors_from(op)
+      unless op["result.policy.default"].success?
+        return { error: op["result.policy.message"] }
+      end
+
+      if op["contract.default"].errors.any?
+        return { error: op["contract.default"].errors }
+      end
+    end
+
   end
 end

data/app/controllers/stellar_base/balances_controller.rb

@@ -21,16 +21,6 @@ module StellarBase
 
     private
 
-    def errors_from(op)
-      unless op["result.policy.default"].success?
-        return { errors: op["result.policy.message"] }
-      end
-
-      if op["contract.default"].errors.any?
-        return { errors: op["contract.default"].errors }
-      end
-    end
-
     def balance_params
       params.permit(:asset_code).to_hash.with_indifferent_access
     end

data/app/controllers/stellar_base/deposit_controller.rb

@@ -12,10 +12,7 @@ module StellarBase
             representer = DepositRequestRepresenter.new(twin)
             render json: representer
           else
-            render(
-              json: { error: op["contract.default"].errors },
-              status: :unprocessable_entity,
-            )
+            render json: errors_from(op), status: :unprocessable_entity
           end
         end
       end

data/app/controllers/stellar_base/fee_requests_controller.rb

@@ -0,0 +1,31 @@
+module StellarBase
+  class FeeRequestsController < ApplicationController
+
+    def show
+      op = FeeRequests::Operations::Show.(fee_request: fee_request_params)
+
+      respond_to do |f|
+        f.json do
+          if op.success?
+            representer = FeeRequestRepresenter.new(op["model"])
+            render json: representer
+          else
+            render json: errors_from(op), status: :unprocessable_entity
+          end
+        end
+      end
+    end
+
+    private
+
+    def fee_request_params
+      params.permit(*%i[
+        asset_code
+        amount
+        type
+        operation
+      ]).to_hash.with_indifferent_access
+    end
+
+  end
+end

data/app/controllers/stellar_base/withdraw_controller.rb

@@ -12,10 +12,7 @@ module StellarBase
             representer = WithdrawalRequestRepresenter.new(twin)
             render json: representer
           else
-            render(
-              json: { error: op["result.policy.message"] || op["contract.default"].errors },
-              status: :unprocessable_entity,
-            )
+            render json: errors_from(op), status: :unprocessable_entity
           end
         end
       end

data/app/models/stellar_base/fee_request.rb

@@ -0,0 +1,13 @@
+module StellarBase
+  class FeeRequest
+
+    include Virtus.model
+
+    attribute :operation, String
+    attribute :amount, BigDecimal
+    attribute :asset_code, BigDecimal
+    attribute :type, String
+    attribute :fee_response, BigDecimal
+
+  end
+end

data/app/representers/stellar_base/fee_request_representer.rb

@@ -0,0 +1,7 @@
+module StellarBase
+  class FeeRequestRepresenter < ApplicationRepresenter
+
+    property :fee_response, as: :fee
+
+  end
+end

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

@@ -0,0 +1,28 @@
+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

data/app/services/stellar_base/find_asset_details.rb

@@ -0,0 +1,19 @@
+module StellarBase
+  class FindAssetDetails
+
+    def self.call(operation:, asset_code:)
+      return nil if operation.blank?
+      return nil if asset_code.blank?
+
+      assets = if operation == "deposit"
+                 StellarBase.configuration.depositable_assets
+               elsif operation == "withdraw"
+                 StellarBase.configuration.withdrawable_assets
+               else
+                 []
+               end
+      assets.find {|asset| asset[:asset_code] == asset_code }
+    end
+
+  end
+end

data/config/routes.rb

@@ -3,5 +3,6 @@ StellarBase::Engine.routes.draw do
   get "/withdraw" => "withdraw#create", as: :withdraw
   get "/deposit" => "deposit#create", as: :deposit
   get "/balance/:asset_code" => "balances#show", as: :balance
+  get "/fee" => "fee_requests#show", as: :fee
 end
 

data/lib/stellar_base/factories/fee_requests.rb

@@ -0,0 +1,11 @@
+FactoryBot.define do
+
+  factory :stellar_base_fee_request, class: "StellarBase::FeeRequest" do
+    asset_code { "BTCT" }
+    amount { 0.001 }
+    operation { "deposit" }
+    type { nil }
+    fee_response { nil }
+  end
+
+end

data/lib/stellar_base/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stellar_base-rails
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Ace Subido
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-07 00:00:00.000000000 Z
+date: 2019-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: disposable
@@ -426,6 +426,9 @@ files:
 - app/concepts/stellar_base/deposit_requests/contracts/create.rb
 - app/concepts/stellar_base/deposit_requests/deposit_request_policy.rb
 - app/concepts/stellar_base/deposit_requests/operations/create.rb
+- app/concepts/stellar_base/fee_requests/contracts/show.rb
+- app/concepts/stellar_base/fee_requests/fee_request_policy.rb
+- app/concepts/stellar_base/fee_requests/operations/show.rb
 - app/concepts/stellar_base/withdrawal_requests/contracts/create.rb
 - app/concepts/stellar_base/withdrawal_requests/operations/create.rb
 - app/concepts/stellar_base/withdrawal_requests/withdrawal_request_policy.rb
@@ -433,6 +436,7 @@ files:
 - app/controllers/stellar_base/balances_controller.rb
 - app/controllers/stellar_base/bridge_callbacks_controller.rb
 - app/controllers/stellar_base/deposit_controller.rb
+- app/controllers/stellar_base/fee_requests_controller.rb
 - app/controllers/stellar_base/home_controller.rb
 - app/controllers/stellar_base/withdraw_controller.rb
 - app/errors/stellar_base/not_found_error.rb
@@ -447,6 +451,7 @@ files:
 - app/models/stellar_base/bridge_callback.rb
 - app/models/stellar_base/deposit.rb
 - app/models/stellar_base/deposit_request.rb
+- app/models/stellar_base/fee_request.rb
 - app/models/stellar_base/stellar_operation.rb
 - app/models/stellar_base/stellar_payment.rb
 - app/models/stellar_base/stellar_toml.rb
@@ -455,6 +460,7 @@ files:
 - app/representers/stellar_base/application_representer.rb
 - app/representers/stellar_base/balance_representer.rb
 - app/representers/stellar_base/deposit_request_representer.rb
+- app/representers/stellar_base/fee_request_representer.rb
 - app/representers/stellar_base/withdrawal_request_representer.rb
 - app/services/stellar_base/account_subscriptions/execute_account_subscription_callback.rb
 - app/services/stellar_base/account_subscriptions/find_or_create_operation.rb
@@ -490,6 +496,8 @@ 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/find_asset_details.rb
 - app/services/stellar_base/gen_memo_for.rb
 - app/services/stellar_base/gen_random_string.rb
 - app/services/stellar_base/init_asset_sending_client.rb
@@ -523,6 +531,7 @@ files:
 - lib/stellar_base/factories/bridge_callbacks.rb
 - lib/stellar_base/factories/deposit_requests.rb
 - lib/stellar_base/factories/deposits.rb
+- lib/stellar_base/factories/fee_requests.rb
 - lib/stellar_base/factories/stellar_operations.rb
 - lib/stellar_base/factories/stellar_transactions.rb
 - lib/stellar_base/factories/withdrawal_requests.rb