scf_core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5725126a380791370fbb3a1c3f31b8f90ad4763f2024e7fcee1a36b464a9a630
+  data.tar.gz: 4edc490e9c2d2de7717218b0d7a5da95b32401319a9973eb1f9ecdf3ba0c3c4d
+SHA512:
+  metadata.gz: 2ab7c166bb5eb54d39718c8d4604b15b865d208a33d499f30b70f5c3a12824264a3034e478e03292a39430bdade3dc0edefabe2eea963a43d4ac782519870047
+  data.tar.gz: 28c3eaa830828349700bd0d701e8aa56d47873169b7cdf68eb3f6c5ec59a887cc8858cce031c2276a8a32b6de4313e7180e8550dcca2ca07f566d49b960227fb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Asrat
+
+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.md

@@ -0,0 +1,28 @@
+# Scf::Core
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "scf_core"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install scf_core
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/concerns/scf/core/common.rb

@@ -0,0 +1,142 @@
+module Scf
+  module Core
+    module Common
+      extend ActiveSupport::Concern
+      include Pagination
+
+      included do
+        before_action :set_clazz
+        before_action :set_object, only: %i[show update]
+      end
+
+      def index
+        data = nil
+        options = {}
+        if block_given?
+          incoming = yield
+          if incoming.instance_of?(Array)
+            data, options = incoming
+          elsif incoming.instance_of?(Hash)
+            options = incoming
+          else
+            data = incoming
+          end
+        else
+          data = @clazz.all
+        end
+        total = data.count
+        data = data.then(&paginate) if params[:page]
+        result = {
+          success: true,
+          data: serialize(data, options)
+        }
+        if params[:page]
+          result[:page] = params[:page]
+          result[:total] = total
+        end
+
+        render json: result
+      end
+
+      def show
+        data = nil
+        options = {}
+        if block_given?
+          incoming = yield
+          if incoming.instance_of?(Array)
+            data, options = incoming
+          elsif incoming.instance_of?(Hash)
+            data = @obj
+            options = incoming
+          else
+            data = incoming
+          end
+        else
+          data = @obj
+        end
+        result = {
+          success: true,
+          data: serialize(data, options)
+        }
+        render json: result
+      end
+
+      def create
+        obj = nil
+        options = {}
+        if block_given?
+          incoming = yield
+          if incoming.instance_of?(Array)
+            obj, options = incoming
+          elsif incoming.instance_of?(Hash)
+            obj = @clazz.new(model_params)
+            options = incoming
+          else
+            obj = incoming
+          end
+        else
+          obj = @clazz.new(model_params)
+        end
+
+        if obj.save
+          result = {
+            success: true,
+            data: serialize(obj, options)
+          }
+          render json: result, status: :created
+        else
+          render json: {success: false, error: obj.errors.full_messages[0]}, status: 422
+        end
+      rescue StandardError => e
+        render json: {success: false, error: e.message}
+      end
+
+      def update
+        obj = nil
+        options = {}
+        if block_given?
+          incoming = yield
+          if incoming.instance_of?(Array)
+            obj, options = incoming
+          elsif incoming.instance_of?(Hash)
+            obj = set_object
+            options = incoming
+          else
+            obj = incoming
+          end
+        else
+          obj = set_object
+        end
+
+        if obj.update(model_params)
+          result = {
+            success: true,
+            data: serialize(obj, options)
+          }
+          render json: result
+        else
+          render json: {success: false, error: obj.errors.full_messages[0]}, status: 422
+        end
+      rescue StandardError => e
+        render json: {success: false, error: e.message}
+      end
+
+      private
+
+      def serialize(data, options = {})
+        ActiveModelSerializers::SerializableResource.new(data, options)
+      end
+
+      def set_clazz
+        @clazz = "Scf::Core::#{controller_name.classify}".constantize
+      end
+
+      def set_object
+        @obj = @clazz.find(params[:id])
+      end
+
+      # This class should be overridden by respective child controllers
+      def model_params; end
+    end
+  end
+end

data/app/controllers/concerns/scf/core/pagination.rb

@@ -0,0 +1,35 @@
+module Scf
+  module Core
+    module Pagination
+      extend ActiveSupport::Concern
+
+      def default_per_page
+        25
+      end
+
+      def page_no
+        params[:page]&.to_i || 1
+      end
+
+      def per_page
+        params[:per_page]&.to_i || default_per_page
+      end
+
+      def paginate_offset
+        (page_no - 1) * per_page
+      end
+
+      def order_by
+        params.fetch(:order_by, :id)
+      end
+
+      def order_direction
+        params.fetch(:order_direction, :asc)
+      end
+
+      def paginate
+        ->(it) { it.limit(per_page).offset(paginate_offset).order("#{order_by}": order_direction) }
+      end
+    end
+  end
+end

data/app/controllers/scf/core/application_controller.rb

@@ -0,0 +1,6 @@
+module Scf
+  module Core
+    class ApplicationController < ActionController::API
+    end
+  end
+end

data/app/jobs/scf/core/application_job.rb

@@ -0,0 +1,6 @@
+module Scf
+  module Core
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/scf/core/application_mailer.rb

@@ -0,0 +1,8 @@
+module Scf
+  module Core
+    class ApplicationMailer < ActionMailer::Base
+      default from: "from@example.com"
+      layout "mailer"
+    end
+  end
+end

data/app/models/scf/core/application_record.rb

@@ -0,0 +1,7 @@
+module Scf
+  module Core
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/config/initializers/sentry.rb

@@ -0,0 +1,21 @@
+Sentry.init do |config|
+  config.dsn = 'https://67ed384c7ed38457afd8773c2cb39231@o4508856449105920.ingest.de.sentry.io/4508856451006544'
+  config.breadcrumbs_logger = [:active_support_logger, :http_logger]
+
+  # Add data like request headers and IP for users,
+  # see https://docs.sentry.io/platforms/ruby/data-management/data-collected/ for more info
+  config.send_default_pii = true
+
+  # Set traces_sample_rate to 1.0 to capture 100%
+  # of transactions for tracing.
+  # We recommend adjusting this value in production.
+  config.traces_sample_rate = 1.0
+  # or
+  config.traces_sampler = lambda do |context|
+    true
+  end
+  # Set profiles_sample_rate to profile 100%
+  # of sampled transactions.
+  # We recommend adjusting this value in production.
+  config.profiles_sample_rate = 1.0
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Scf::Core::Engine.routes.draw do
+end

data/config/storage.yml

@@ -0,0 +1,7 @@
+local:
+  service: S3
+  endpoint: http://127.0.0.1:9000
+  access_key_id: minioadmin
+  secret_access_key: minioadmin
+  bucket: scf-core-bucket
+  force_path_style: true

data/lib/scf/core/engine.rb

@@ -0,0 +1,22 @@
+module Scf
+  module Core
+    class Engine < ::Rails::Engine
+      isolate_namespace Scf::Core
+      config.generators.api_only = true
+
+      config.generators do |g|
+        g.test_framework :rspec, routing_specs: false
+        g.fixture_replacement :factory_bot
+        g.factory_bot dir: "spec/factories"
+      end
+
+      initializer "scf_core.factories", after: "factory_bot.set_factory_paths" do
+        FactoryBot.definition_file_paths << File.expand_path("../../../spec/factories", __dir__) if defined?(FactoryBot)
+      end
+
+      initializer :append_migrations do |app|
+        app.config.paths["db/migrate"].concat(config.paths["db/migrate"].expanded) unless app.root.to_s.match(root.to_s + File::SEPARATOR)
+      end
+    end
+  end
+end

data/lib/scf/core/version.rb

@@ -0,0 +1,5 @@
+module Scf
+  module Core
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/scf/core.rb

@@ -0,0 +1,8 @@
+require "scf/core/version"
+require "scf/core/engine"
+
+module Scf
+  module Core
+    # Your code goes here...
+  end
+end

data/lib/tasks/scf/core_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :scf_core do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,311 @@
+--- !ruby/object:Gem::Specification
+name: scf_core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Asrat
+bindir: bin
+cert_chain: []
+date: 2025-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: ancestry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: image_processing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: noticed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: letter_opener
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: An engine which contains core models for Supply Chain Financing.
+email:
+- asratextras77@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/concerns/scf/core/common.rb
+- app/controllers/concerns/scf/core/pagination.rb
+- app/controllers/scf/core/application_controller.rb
+- app/jobs/scf/core/application_job.rb
+- app/mailers/scf/core/application_mailer.rb
+- app/models/scf/core/application_record.rb
+- config/initializers/sentry.rb
+- config/routes.rb
+- config/storage.yml
+- lib/scf/core.rb
+- lib/scf/core/engine.rb
+- lib/scf/core/version.rb
+- lib/tasks/scf/core_tasks.rake
+homepage: https://www.mks.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.mks.com
+  source_code_uri: https://github.com
+  changelog_uri: https://github.com/
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: An Engine for Supply Chain Financing
+test_files: []