stellar_base-rails 0.5.6 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b42873b418f519fda036560eef2596c0f75835247bf43d6680f9b3c82b6cb5b9
-  data.tar.gz: 892c7e80de8320d7bc137cacdfb72bd6e31a813d446c67b8e8676ccb4ef6b09e
+  metadata.gz: fdcf37c86d71ffbb7830e3040033107afb8f31522425c8cc94e24d3c67097c8f
+  data.tar.gz: 34b17e584937960171db869cd9d8660647e22d9689c5fd1d05864342a7afc85c
 SHA512:
-  metadata.gz: 7cfeddf2e1766828779c2635afc3fdf13b17f081aab34a797977d1a2798c11f058d6541c891a144de89c7d15faa5a71e9b86e77dcb7dca65abee4cca0d818a05
-  data.tar.gz: 01c19269320076cb8e8636aa4a5a855a51a02e0371695afd014b84e4a0710b14df7c39eed13b664e21219cb572c7737c25d0a92e52db97da74c9d271ee723056
+  metadata.gz: 4e5caa243016431428f00c29a14ed7437afab21e0e3560b366e8e64152596479e0394735e142669a7c6019c983d980cd6b9bec1b5ba09ae3c3a7c745a35ed287
+  data.tar.gz: bc4d072cc0ea013fbcf828b2421111d387e26a3e11413d34db1a614388f325b4a585fda98920af36ee932fc76dac76871fbf177a073711d0b07310c526daa3e8

data/README.md

@@ -36,6 +36,8 @@ StellarBase.configure do |c|
 end
 ```
 
+To use the public network, ensure that you set the `Stellar` network to the [appropriate value](https://github.com/stellar/ruby-stellar-sdk#usage).
+
 #### c.modules
 You can supply what endpoints you want to activate with the gem
 

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

@@ -0,0 +1,41 @@
+module StellarBase
+  module DepositRequests
+    module Contracts
+      class Create < ApplicationContract
+
+        property :asset_code
+        property :account_id
+        property :memo_type
+        property :memo
+        property :email_address
+        property :deposit_type
+
+        validates(
+          :asset_code,
+          :account_id,
+          presence: true,
+        )
+        validate :check_valid_asset_code
+
+        def check_valid_asset_code
+          asset_codes = StellarBase.configuration.depositable_assets.dup
+
+          if asset_codes.nil?
+            errors.add(:asset_code, "no assets configured for deposits")
+            return
+          end
+
+          asset_codes.map! { |asset| asset[:asset_code] }
+
+          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/deposit_requests/deposit_request_policy.rb

@@ -0,0 +1,14 @@
+module StellarBase
+  module DepositRequests
+    class DepositRequestPolicy
+
+      def initialize(_, _)
+      end
+
+      def create?
+        StellarBase.included_module?(:deposit)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+module StellarBase
+  module DepositRequests
+    module Operations
+      class Create < ApplicationOperation
+
+        DEFAULT_ETA = (10 * 60).freeze
+
+        step self::Policy::Pundit(DepositRequestPolicy, :create?)
+        step Model(DepositRequest, :new)
+        step :setup_params!
+        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!
+        step Contract::Persist(method: :save)
+
+        private
+
+        def setup_params!(options, params:, **)
+          params[:deposit_request].merge!({
+            account_id: params[:deposit_request][:account],
+            deposit_type: params[:deposit_request][:type],
+            memo: memo_from(params[:deposit_request]),
+            memo_type: memo_type_from(params[:deposit_request]),
+          })
+        end
+
+        def find_depositable_asset_details!(options, params:, **)
+          details = FindDepositableAsset.(params[:deposit_request][:asset_code])
+          params[:deposit_asset_details] = details.presence || {}
+        end
+
+        def determine_how!(options, params:, **)
+          details = params[:deposit_asset_details]
+          options["model"].deposit_address =
+            ConfiguredClassRunner.(details[:how_from])
+        end
+
+        def determine_max_amount!(options, params:, **)
+          details = params[:deposit_asset_details]
+          options["model"].max_amount =
+            ConfiguredClassRunner.(details[:max_amount_from])
+        end
+
+        def set_defaults!(options, params:, **)
+          details = params[:deposit_asset_details]
+
+          options["model"].asset_type = details[:type]
+          options["model"].issuer = details[:issuer]
+          options["model"].eta = DEFAULT_ETA
+          options["model"].min_amount = 0.0
+
+          # Make Deposits free unless we want it configured
+          options["model"].fee_fixed = details[:fee_fixed] || 0.0
+          options["model"].fee_percent = details[:fee_percent] || 0.0
+        end
+
+        def memo_type_from(params)
+          return "text" if params[:memo_type].blank?
+          params[:memo_type]
+        end
+
+        def memo_from(params)
+          return GenMemoFor.(DepositRequest) if params[:memo].blank?
+          params[:memo]
+        end
+      end
+    end
+  end
+end

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

@@ -42,7 +42,7 @@ module StellarBase
           options["model"].account_id =
             StellarBase.configuration.distribution_account
           options["model"].memo_type = "text"
-          options["model"].memo = GenMemo.()
+          options["model"].memo = GenMemoFor.(WithdrawalRequest)
           options["model"].eta = DEFAULT_ETA
           options["model"].min_amount = 0.0
           options["model"].max_amount =
@@ -54,14 +54,6 @@ module StellarBase
           options["model"].fee_network = fee_network
         end
 
-        def get_balance_from(balance_checker_class)
-          if balance_checker_present?
-            return balance_checker_class.constantize.send(:call)
-          end
-
-          nil
-        end
-
       end
     end
   end

data/app/controllers/stellar_base/deposit_controller.rb

@@ -0,0 +1,24 @@
+module StellarBase
+  class DepositController < ApplicationController
+
+    def create
+      op = DepositRequests::Operations::Create.(deposit_request: params)
+
+      respond_to do |f|
+        f.json do
+          if op.success?
+            twin = DepositRequestTwin.new(op["model"])
+            representer = DepositRequestRepresenter.new(twin)
+            render json: representer
+          else
+            render(
+              json: { error: op["contract.default"].errors },
+              status: :unprocessable_entity,
+            )
+          end
+        end
+      end
+    end
+
+  end
+end

data/app/models/stellar_base/deposit_request.rb

@@ -0,0 +1,4 @@
+module StellarBase
+  class DepositRequest < ApplicationRecord
+  end
+end

data/app/representers/stellar_base/application_representer.rb

@@ -0,0 +1,5 @@
+module StellarBase
+  class ApplicationRepresenter < Representable::Decorator
+    include Representable::JSON
+  end
+end

data/app/representers/stellar_base/deposit_request_representer.rb

@@ -0,0 +1,13 @@
+module StellarBase
+  class DepositRequestRepresenter < ApplicationRepresenter
+
+    property :deposit_address, as: :how
+    property :eta
+    property :min_amount
+    property :max_amount
+    property :fee_fixed
+    property :fee_percent
+    property :extra_info
+
+  end
+end

data/app/representers/stellar_base/withdrawal_request_representer.rb

@@ -0,0 +1,15 @@
+module StellarBase
+  class WithdrawalRequestRepresenter < ApplicationRepresenter
+
+    property :account_id
+    property :memo_type
+    property :memo
+    property :min_amount
+    property :max_amount
+    property :fee_fixed
+    property :fee_percent
+    property :fee_network
+    property :extra_info
+
+  end
+end

data/app/services/stellar_base/configured_class_runner.rb

@@ -0,0 +1,13 @@
+module StellarBase
+  class ConfiguredClassRunner
+
+    DEFAULT = nil
+
+    def self.call(class_name)
+      # TODO: how do we handle errors
+      return class_name.constantize.send(:call) if class_name.present?
+      DEFAULT
+    end
+
+  end
+end

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

@@ -0,0 +1,12 @@
+module StellarBase
+  module DepositRequests
+    class FindDepositableAsset
+
+      def self.call(asset_code)
+        depositable_assets = StellarBase.configuration.depositable_assets
+        depositable_assets.find {|asset| asset[:asset_code] == asset_code }
+      end
+
+    end
+  end
+end

data/app/services/stellar_base/gen_memo_for.rb

@@ -0,0 +1,17 @@
+module StellarBase
+  class GenMemoFor
+
+    LENGTH = 8
+
+    def self.call(klass)
+      loop do
+        memo = GenRandomString.(length: LENGTH)
+        if !klass.exists?(memo: memo)
+          return memo
+          break
+        end
+      end
+    end
+
+  end
+end

data/app/twins/stellar_base/application_twin.rb

@@ -0,0 +1,5 @@
+module StellarBase
+  class ApplicationTwin < Disposable::Twin
+    feature Expose
+  end
+end

data/app/twins/stellar_base/deposit_request_twin.rb

@@ -0,0 +1,13 @@
+module StellarBase
+  class DepositRequestTwin < ApplicationTwin
+
+    property :deposit_address
+    property :eta
+    property :min_amount
+    property :max_amount
+    property :fee_fixed
+    property :fee_percent
+    property :extra_info
+
+  end
+end

data/app/twins/stellar_base/withdrawal_request_twin.rb

@@ -0,0 +1,15 @@
+module StellarBase
+  class WithdrawalRequestTwin < ApplicationTwin
+
+    property :account_id
+    property :memo_type
+    property :memo
+    property :min_amount
+    property :max_amount
+    property :fee_fixed
+    property :fee_percent
+    property :fee_network
+    property :extra_info
+
+  end
+end

data/config/routes.rb

@@ -1,5 +1,6 @@
 StellarBase::Engine.routes.draw do
   resources :bridge_callbacks, only: [:create], defaults: { format: "json" }
   get "/withdraw" => "withdraw#create", as: :withdraw
+  get "/deposit" => "deposit#create", as: :deposit
 end
 

data/db/migrate/20180925045927_create_stellar_base_deposit_requests.rb

@@ -0,0 +1,28 @@
+class CreateStellarBaseDepositRequests < ActiveRecord::Migration[5.2]
+
+  def change
+    create_table :stellar_base_deposit_requests do |t|
+      t.string :asset_type, null: false
+      t.string :asset_code, null: false
+      t.string :memo_type
+      t.string :memo
+      t.string :account_id, null: false
+      t.string :issuer, null: false
+      t.string :email_address
+      t.string :deposit_address, null: false
+      t.string :deposit_type
+      t.integer :eta
+      t.decimal :min_amount, null: false, default: 0.0
+      t.decimal :max_amount
+      t.decimal :fee_fixed, null: false, default: 0.0
+      t.decimal :fee_percent, null: false, default: 0.0
+      t.string :extra_info
+
+      t.timestamps
+      t.index(%i[asset_type asset_code], {
+        name: :index_stellar_base_deposit_requests_on_asset,
+      })
+    end
+  end
+
+end

data/lib/stellar_base.rb

@@ -30,26 +30,44 @@ module StellarBase
     has :withdrawable_assets, classes: [NilClass, Array, String, Pathname]
     has :on_withdraw
 
+    has :depositable_assets, classes: [NilClass, Array, String, Pathname]
+
     has :stellar_toml, classes: Hash, default: {}
   end
 
   after_configuration_change do
     self.convert_config_withdraw!
+    self.convert_config_deposit!
   end
 
+
   def self.included_module?(module_name)
     self.configuration.modules&.include?(module_name)
   end
 
+  def self.convert_config_deposit!
+    depositable_assets = self.configuration.depositable_assets
+    return if depositable_assets.is_a?(Array) || depositable_assets.nil?
+
+    self.configuration.depositable_assets =
+      convert_config!(depositable_assets)
+  end
+
   def self.convert_config_withdraw!
     withdrawable_assets = self.configuration.withdrawable_assets
     return if withdrawable_assets.is_a?(Array) || withdrawable_assets.nil?
 
-    array_of_hashes = try_from_yaml_file_path(withdrawable_assets) ||
-      try_from_json(withdrawable_assets)
-
     self.configuration.withdrawable_assets =
-      array_of_hashes.map(&:with_indifferent_access)
+      convert_config!(withdrawable_assets)
+  end
+
+  private
+
+  def self.convert_config!(asset_config)
+    array_of_hashes = try_from_yaml_file_path(asset_config) ||
+      try_from_json(asset_config)
+
+    array_of_hashes.map(&:with_indifferent_access)
   end
 
   def self.try_from_json(str)

data/lib/stellar_base/factories/deposit_requests.rb

@@ -0,0 +1,17 @@
+FactoryBot.define do
+
+  factory :stellar_base_deposit_request, class: "StellarBase::DepositRequest" do
+    deposit_address { "dep-addr" }
+    issuer { "issuer-addr" }
+    memo_type { "text" }
+    memo { "ABAC" }
+    min_amount { 0 }
+    max_amount { 0 }
+    email_address { "test@test.com" }
+    account_id { "G-STELLAR-ACCT" }
+    deposit_type { "" }
+    fee_fixed { 0 }
+    fee_percent { 0 }
+  end
+
+end

data/lib/stellar_base/version.rb

@@ -1,3 +1,3 @@
 module StellarBase
-  VERSION = "0.5.6".freeze
+  VERSION = "0.6.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stellar_base-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.6.0
 platform: ruby
 authors:
 - Ace Subido
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2018-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: disposable
@@ -294,11 +294,15 @@ files:
 - app/concepts/stellar_base/bridge_callbacks/bridge_callback_policy.rb
 - app/concepts/stellar_base/bridge_callbacks/contracts/create.rb
 - app/concepts/stellar_base/bridge_callbacks/operations/create.rb
+- 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/withdrawal_requests/contracts/create.rb
 - app/concepts/stellar_base/withdrawal_requests/operations/create.rb
 - app/concepts/stellar_base/withdrawal_requests/withdrawal_request_policy.rb
 - app/controllers/stellar_base/application_controller.rb
 - app/controllers/stellar_base/bridge_callbacks_controller.rb
+- app/controllers/stellar_base/deposit_controller.rb
 - app/controllers/stellar_base/home_controller.rb
 - app/controllers/stellar_base/withdraw_controller.rb
 - app/helpers/stellar_base/application_helper.rb
@@ -306,10 +310,12 @@ files:
 - app/mailers/stellar_base/application_mailer.rb
 - app/models/stellar_base/application_record.rb
 - app/models/stellar_base/bridge_callback.rb
+- app/models/stellar_base/deposit_request.rb
 - app/models/stellar_base/stellar_toml.rb
 - app/models/stellar_base/withdrawal_request.rb
-- app/representers/application_representer.rb
-- app/representers/withdrawal_request_representer.rb
+- app/representers/stellar_base/application_representer.rb
+- app/representers/stellar_base/deposit_request_representer.rb
+- app/representers/stellar_base/withdrawal_request_representer.rb
 - app/services/stellar_base/bridge_callbacks/check.rb
 - app/services/stellar_base/bridge_callbacks/compare.rb
 - app/services/stellar_base/bridge_callbacks/get_operation.rb
@@ -322,27 +328,32 @@ files:
 - app/services/stellar_base/bridge_callbacks/mac_payloads/encode_params.rb
 - app/services/stellar_base/bridge_callbacks/process.rb
 - app/services/stellar_base/bridge_callbacks/verify_mac_payload.rb
+- app/services/stellar_base/configured_class_runner.rb
+- app/services/stellar_base/deposit_requests/find_depositable_asset.rb
+- app/services/stellar_base/gen_memo_for.rb
 - app/services/stellar_base/gen_random_string.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
 - app/services/stellar_base/withdrawal_requests/find_withdrawable_asset.rb
 - app/services/stellar_base/withdrawal_requests/find_withdrawal_request.rb
-- app/services/stellar_base/withdrawal_requests/gen_memo.rb
 - app/services/stellar_base/withdrawal_requests/process.rb
-- app/twins/application_twin.rb
-- app/twins/withdrawal_request_twin.rb
+- app/twins/stellar_base/application_twin.rb
+- app/twins/stellar_base/deposit_request_twin.rb
+- app/twins/stellar_base/withdrawal_request_twin.rb
 - app/views/layouts/stellar_base/application.html.erb
 - config/routes.rb
 - config/spring.rb
 - db/migrate/20180816014433_create_stellar_base_bridge_callbacks.rb
 - db/migrate/20180816110314_create_stellar_base_withdrawal_requests.rb
 - db/migrate/20180816135847_unique_stellar_base_bridge_callbacks_operation_id.rb
+- db/migrate/20180925045927_create_stellar_base_deposit_requests.rb
 - lib/stellar_base-rails.rb
 - lib/stellar_base.rb
 - lib/stellar_base/engine.rb
 - lib/stellar_base/factories.rb
 - lib/stellar_base/factories/bridge_callbacks.rb
+- lib/stellar_base/factories/deposit_requests.rb
 - lib/stellar_base/factories/withdrawal_requests.rb
 - lib/stellar_base/horizon_client.rb
 - lib/stellar_base/rails/routes.rb

data/app/representers/application_representer.rb

@@ -1,3 +0,0 @@
-class ApplicationRepresenter < Representable::Decorator
-  include Representable::JSON
-end

data/app/representers/withdrawal_request_representer.rb

@@ -1,13 +0,0 @@
-class WithdrawalRequestRepresenter < ApplicationRepresenter
-
-  property :account_id
-  property :memo_type
-  property :memo
-  property :min_amount
-  property :max_amount
-  property :fee_fixed
-  property :fee_percent
-  property :fee_network
-  property :extra_info
-
-end

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

@@ -1,19 +0,0 @@
-module StellarBase
-  module WithdrawalRequests
-    class GenMemo
-
-      LENGTH = 8
-
-      def self.call
-        loop do
-          memo = GenRandomString.(length: LENGTH)
-          if !WithdrawalRequest.exists?(memo: memo)
-            return memo
-            break
-          end
-        end
-      end
-
-    end
-  end
-end

data/app/twins/application_twin.rb

@@ -1,3 +0,0 @@
-class ApplicationTwin < Disposable::Twin
-  feature Expose
-end

data/app/twins/withdrawal_request_twin.rb

@@ -1,13 +0,0 @@
-class WithdrawalRequestTwin < ApplicationTwin
-
-  property :account_id
-  property :memo_type
-  property :memo
-  property :min_amount
-  property :max_amount
-  property :fee_fixed
-  property :fee_percent
-  property :fee_network
-  property :extra_info
-
-end