mtk_framework 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53dbafb559cda6d5820bad1dc478c4015b456cd2085d778b219f98fcfca1e8a6
+  data.tar.gz: 835b14b669e2207f57f1614432ec08e363e2a2efe0bf54d374c7022ee77856db
+SHA512:
+  metadata.gz: 3926141e7018495743f9257022a623894c31063b86c43067d530664dde0850e449c41ad797147803dc9c55fb28baa9515431ccc4907db0e7a8e6d8cc29a689a0
+  data.tar.gz: a88efc2fdc5ac1016fa42f20bfe270b5392d84b2b506e31bd7ea9be2ce0a987e26b8b224d77595abd4ddcdbcf8361496853c0624d2c5bf598157fee9dd7a238b

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+env:
+  ImageOS: ubuntu18
+
+name: Tests
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Install development tools
+      run: |
+        sudo apt-get update -y
+        sudo apt-get install -y build-essential libsodium-dev
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7 # Not needed with a .ruby-version file
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rspec spec/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'active_interaction', '~> 4.0'
+gem 'grape', '~> 1.3.0'
+gem 'rails', '~> 6.0.0'
+gem 'rspec-rails', '~> 3.8.2'
+gem 'tezos_client', '~> 1.3.5'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'bundler', '~> 2.2.14'
+  gem 'juwelier', '~> 2.1.0'
+  gem 'pry'
+  gem 'rdoc', '~> 3.12'
+  gem "faker", git: "https://github.com/moneytrackio/faker.git", branch: "feat/add-blockchain-tezos-keys"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2021 Moneytrack
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,18 @@
+= mtk_framework
+
+Description goes here.
+
+== Contributing to mtk_framework
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2021 Moneytrack. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+require 'rake'
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = 'mtk_framework'
+  gem.homepage = 'http://github.com/moneytrackio/mtk_framework'
+  gem.license = 'MIT'
+  gem.summary = 'Moneytrack\'s gems extensions and monkey patches.'
+  gem.email = 'dev@moneytrack.io'
+  gem.authors = ['othmane el kesri']
+
+  # dependencies defined in Gemfile
+end
+
+Juwelier::RubygemsDotOrgTasks.new
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc 'Code coverage detail'
+task :simplecov do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['test'].execute
+end
+
+task default: :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mtk_framework #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/mtk_framework.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# External libs
+require 'active_interaction'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'grape'
+require 'rails'
+require 'tezos_client'
+
+# Gem extensions
+GEM_EXTENSIONS_PATH = 'mtk_framework/gem_extensions/active_interaction'
+
+require_relative "#{GEM_EXTENSIONS_PATH}/filters/abstract_tz_filter.rb"
+require_relative "#{GEM_EXTENSIONS_PATH}/filters/hash_filter.rb"
+require_relative "#{GEM_EXTENSIONS_PATH}/filters/tz_account_filter.rb"
+require_relative "#{GEM_EXTENSIONS_PATH}/filters/tz_contract_address_filter.rb"
+require_relative "#{GEM_EXTENSIONS_PATH}/filters/tz_operation_filter.rb"
+require_relative "#{GEM_EXTENSIONS_PATH}/filters/tz_public_key_filter.rb"
+require_relative "#{GEM_EXTENSIONS_PATH}/filters/tz_secret_key_filter.rb"
+require_relative "#{GEM_EXTENSIONS_PATH}/filters/tz_signature_filter.rb"
+require_relative "#{GEM_EXTENSIONS_PATH}/base.rb"
+
+# Core extensions
+CORE_EXTENSIONS_PATH = 'mtk_framework/core_extensions'
+
+require_relative "#{CORE_EXTENSIONS_PATH}/array/except.rb"
+require_relative "#{CORE_EXTENSIONS_PATH}/class/virtual_method.rb"
+require_relative "#{CORE_EXTENSIONS_PATH}/hash/rename_keys.rb"
+
+# ActiveInteractionParams
+require_relative 'mtk_framework/active_interaction_params.rb'
+
+# ActiveInteractionConcerns
+ACTIVE_INTERACTION_CONCERNS_PATH = 'mtk_framework/active_interaction_concerns'
+
+require_relative "#{ACTIVE_INTERACTION_CONCERNS_PATH}/i18nable.rb"
+require_relative "#{ACTIVE_INTERACTION_CONCERNS_PATH}/rescuable.rb"
+require_relative "#{ACTIVE_INTERACTION_CONCERNS_PATH}/interruptable.rb"
+require_relative "#{ACTIVE_INTERACTION_CONCERNS_PATH}/loggable.rb"
+require_relative "#{ACTIVE_INTERACTION_CONCERNS_PATH}/updatable_object.rb"
+
+I18n.load_path.unshift(
+  *Dir.glob(
+    File.expand_path(
+      File.join(%w[mtk_framework locale *.yml]), File.dirname(__FILE__)
+    )
+  )
+)
+
+require_relative 'mtk_framework/railtie.rb' if defined?(Rails::Railtie)

data/lib/mtk_framework/active_interaction_concerns/i18nable.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MtkFramework
+  module ActiveInteractionConcerns
+    module I18nable
+      extend ActiveSupport::Concern
+
+      def i18n_scope
+        "#{self.class.i18n_scope}.#{self.class.name.underscore}"
+      end
+
+      def t(*args, **h_args)
+        h_args.reverse_merge!(scope: i18n_scope)
+        I18n.t(*args, **h_args)
+      end
+    end
+  end
+end

data/lib/mtk_framework/active_interaction_concerns/interruptable.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MtkFramework
+  module ActiveInteractionConcerns
+    module Interruptable
+      extend ActiveSupport::Concern
+      include ::MtkFramework::ActiveInteractionConcerns::Rescuable
+
+      included do
+        class ApplicationInterrupt < StandardError; end
+
+        rescue_from ApplicationInterrupt do
+          raise unless errors.any?
+        end
+      end
+
+      def interrupt_execute!(*args)
+        if args.any?
+          if args[0].is_a? ActiveModel::Errors
+            errors.merge!(args[0])
+          else
+            errors.add(*args)
+          end
+        end
+
+        raise 'interrupt_execute! called without error' if errors.empty?
+
+        raise ApplicationInterrupt
+      end
+    end
+  end
+end

data/lib/mtk_framework/active_interaction_concerns/loggable.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'rails/backtrace_cleaner'
+require 'active_support/parameter_filter'
+
+module MtkFramework
+  module ActiveInteractionConcerns
+    module Loggable
+      extend ActiveSupport::Concern
+
+      included do
+        set_callback :type_check,
+                     :after,
+                     :log_errors,
+                     if: -> { errors.any? }
+
+        set_callback :execute,
+                     :after,
+                     :log_errors,
+                     if: -> { errors.any? }
+
+        set_callback :validate,
+                     :after,
+                     :log_errors,
+                     if: -> { errors.any? }
+      end
+
+      class_methods do
+        def new(*args)
+          Rails.logger.info "Interaction #{name} #{filtered_interaction_params(args)} called from #{interaction_caller}"
+          super
+        end
+
+        def filtered_interaction_params(params)
+          @param_filter ||= ActiveSupport::ParameterFilter.new(Rails.application.config.filter_parameters)
+          params.map do |arg|
+            @param_filter.filter(arg)
+          end
+        end
+
+        def filter_backtrace(backtrace)
+          backtrace_cleaner.clean(backtrace)
+        end
+
+        def interaction_caller
+          filter_backtrace(Thread.current.backtrace)[0]
+        end
+
+        private
+
+        def backtrace_cleaner
+          @backtrace_cleaner ||= BacktraceCleaner.new
+        end
+      end
+
+      def log_errors
+        error_msg = errors.full_messages.to_sentence
+        Rails.logger.info(
+          "Interaction #{self.class.name} failed: '#{error_msg}' called from: #{interaction_caller}"
+        )
+      end
+
+      delegate :filter_backtrace, :interaction_caller, to: :class
+
+      class BacktraceCleaner < Rails::BacktraceCleaner
+        APP_DIRS_PATTERN = %r{^/?(app|config|lib|test|spec|\(\w*\))}.freeze
+        CURRENT_FILE = __FILE__
+
+        def initialize
+          super
+          remove_silencers!
+          add_silencer { |line| !APP_DIRS_PATTERN.match?(line) }
+          add_silencer { |line| line.include? current_file }
+        end
+
+        private
+
+        def current_file
+          CURRENT_FILE.gsub(@root, '')
+        end
+      end
+    end
+  end
+end

data/lib/mtk_framework/active_interaction_concerns/rescuable.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module MtkFramework
+  module ActiveInteractionConcerns
+    module Rescuable
+      extend ActiveSupport::Concern
+      include ActiveSupport::Rescuable
+
+      included do
+        set_callback :execute,
+                     :around,
+                     :handle_rescue
+      end
+
+      def handle_rescue(*args)
+        yield(*args)
+      rescue StandardError => e
+        raise unless rescue_with_handler(e)
+
+        if errors.any?
+          @_interaction_valid = false
+          errors.backtrace = e.backtrace
+        end
+      end
+    end
+  end
+end

data/lib/mtk_framework/active_interaction_concerns/updatable_object.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MtkFramework
+  module ActiveInteractionConcerns
+    module UpdatableObject
+      extend ActiveSupport::Concern
+
+      def update_object_from_filters(object, **options)
+        filters = self.class.filters.except(*options[:except])
+
+        filters.each_key do |filter_name|
+          if !send(filter_name).nil? && object.respond_to?("#{filter_name}=")
+            object.send("#{filter_name}=", send(filter_name))
+          end
+        end
+      end
+
+      class_methods do
+        def from_object(object)
+          params = filters.keys.reduce({}) do |acc, filter|
+            if object.respond_to? filter
+              acc.merge!(filter => object.send(filter))
+            else
+              acc
+            end
+          end
+          new(object.class.name.downcase => object, **params)
+        end
+      end
+    end
+  end
+end

data/lib/mtk_framework/active_interaction_mocks/interaction_group_mocks_helper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'interaction_mocks_helper.rb'
+
+module MtkFramework
+  module ActiveInteractionMocks
+    module InteractionGroupMocksHelper
+      include InteractionMocksHelper
+
+      # /!\ mandatory is set to false by default because it mocks inside a before block
+      def group_mock_interaction(klass,
+                                 methods: nil,
+                                 failing: false,
+                                 mandatory: false,
+                                 expected_params: nil,
+                                 return_proc: nil, # a proc that will be executed in the before block scope
+                                 call_original: false,
+                                 &exec_block)
+        before do
+          mock_interaction(klass,
+                           methods: methods,
+                           failing: failing,
+                           mandatory: mandatory,
+                           expected_params: expected_params,
+                           return_proc: return_proc,
+                           call_original: call_original,
+                           &exec_block)
+        end
+      end
+    end
+  end
+end