snf_core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dde0007bbb3dc4a82efd54f10f989550985fcf19580458cc1c384b557625a725
+  data.tar.gz: ad334000389fe9007b7fe3b54224a370a6fd31d04b4269fc076ef6ac05bc1214
+SHA512:
+  metadata.gz: 2b0b39082ad4e83efdd9d491eba81b6dd6ff4dc02ee4b17986f0bd907db2d19a205bc0695a4bb4188cae60ffba5a22f5fb829886b7012175360178dc48583280
+  data.tar.gz: 2f9a33b8b8719327427b0b3dcf6b825a4ec51a9974a74b8e5fa4fe47866477cabec442c225bf5031cbd1ba872f0b33d22856d652676bc7309d4a1c80dea0d9c7

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 @@
+# SnfCore
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "snf_core"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install snf_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/common.rb

@@ -0,0 +1,140 @@
+module SnfCore
+  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

data/app/controllers/concerns/pagination.rb

@@ -0,0 +1,33 @@
+module ScfCore
+  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

data/app/controllers/snf_core/application_controller.rb

@@ -0,0 +1,4 @@
+module SnfCore
+  class ApplicationController < ActionController::API
+  end
+end

data/app/jobs/snf_core/application_job.rb

@@ -0,0 +1,4 @@
+module SnfCore
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/snf_core/application_mailer.rb

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

data/app/models/snf_core/application_record.rb

@@ -0,0 +1,5 @@
+module SnfCore
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/snf_core/person.rb

@@ -0,0 +1,5 @@
+module SnfCore
+  class Person < ApplicationRecord
+    validates :name, presence: true
+  end
+end

data/config/routes.rb

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

data/db/migrate/20250226035137_create_snf_core_people.rb

@@ -0,0 +1,9 @@
+class CreateSnfCorePeople < ActiveRecord::Migration[8.0]
+  def change
+    create_table :snf_core_people do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/lib/snf_core/engine.rb

@@ -0,0 +1,22 @@
+module SnfCore
+  class Engine < ::Rails::Engine
+    isolate_namespace SnfCore
+    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 'snf_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|
+      unless app.root.to_s.match(root.to_s + File::SEPARATOR)
+        app.config.paths['db/migrate'].concat(config.paths['db/migrate'].expanded)
+      end
+    end
+  end
+end

data/lib/snf_core/version.rb

@@ -0,0 +1,3 @@
+module SnfCore
+  VERSION = "0.1.0"
+end

data/lib/snf_core.rb

@@ -0,0 +1,6 @@
+require "snf_core/version"
+require "snf_core/engine"
+
+module SnfCore
+  # Your code goes here...
+end

data/lib/tasks/snf_core_tasks.rake

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

metadata

@@ -0,0 +1,323 @@
+--- !ruby/object:Gem::Specification
+name: snf_core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Asrat
+bindir: bin
+cert_chain: []
+date: 2025-02-26 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ancestry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: image_processing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.2
+- !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: '8.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.1
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: letter_opener
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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/common.rb
+- app/controllers/concerns/pagination.rb
+- app/controllers/snf_core/application_controller.rb
+- app/jobs/snf_core/application_job.rb
+- app/mailers/snf_core/application_mailer.rb
+- app/models/snf_core/application_record.rb
+- app/models/snf_core/person.rb
+- config/routes.rb
+- db/migrate/20250226035137_create_snf_core_people.rb
+- lib/snf_core.rb
+- lib/snf_core/engine.rb
+- lib/snf_core/version.rb
+- lib/tasks/snf_core_tasks.rake
+homepage: https://www.mks.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.mks.com
+  source_code_uri: https://github.com/BITS-DEVSEC
+  changelog_uri: https://github.com/BITS-DEVSEC
+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: []