service_core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a394edd3cba542ec79b3749978672b3b2bdd1c64288f8b3180ca1420dfe22df3
+  data.tar.gz: 1e058a4a0a9d562939e617e70e8aaeb7889c73941e2be9236e04139c44424b1f
+SHA512:
+  metadata.gz: f80ef1c0e7ae359d7c006b63a5476a4970432ab30efbe7e4b107f20f475fd9db0149ebf7166e50d438139ff297cfa7dd57bb8403108e9848d5f9ad7fcfa66e6c
+  data.tar.gz: bcd65b6b67539f4817cb7133456c9e174c61f9e1d702b2e8c88a0a10bc366ddda3fee96f6feb03d66fbf4604578c10b3c452136c2b92365e6cb873d829a859e4

data/.byebug_history

@@ -0,0 +1,71 @@
+c
+@logger
+c
+defined?(Rails) && Rails.logger ? Rails.logger : ActiveSupport::Logger.new($stdout)
+c
+defined?(Rails) && Rails.logger ? Rails.logger : ActiveSupport::Logger.new($stdout)
+defined?(Rails)
+c
+defined?(Rails)
+c
+ServiceCore.logger
+c
+@logger
+c
+@logger
+c
+self.active
+self.status
+c
+self.active
+name
+c
+name
+n
+self.class.fields_defined
+@fields
+c
+n
+default
+self
+type
+n
+default
+n
+args
+opts
+c
+args
+opts
+c
+service
+c
+service
+c
+service
+c
+self.name
+n
+attributes
+c
+service
+c
+service.fields
+service
+c
+service.name
+c
+send(name)
+@fields
+name
+c
+@fields
+n
+c
+service
+c
+service.name
+service
+c
+service.fields
+service

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-17
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at sehgalmayank001@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 mayank sehgal
+
+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,205 @@
+# ServiceCore
+
+ServiceCore provides a standardized way to define and use service objects in your Ruby and Rails applications. It includes support for defining fields, validations, responses, and logging.
+
+## Installation
+Install the gem and add to the application's Gemfile by executing:
+
+```sh
+bundle add service_core
+```
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```sh
+gem install service_core
+```
+## Usage
+
+### Defining a Service
+
+To define a new service, include the `ServiceCore` module in your service class and define your fields and the perform method.
+```ruby
+# app/services/my_service.rb
+
+class MyService
+  include ServiceCore
+
+  field :first_name, :string
+  field :last_name, :string
+  field :active, :boolean, default: true
+
+  def perform
+    success_response(message: "Hello, World", data: name)
+  end
+
+  def name
+    "#{first_name} #{last_name}"
+  end
+end
+```
+
+### Using a Service
+Instantiate and call the service to execute it. The call method will validate the input, perform the operation, and return the output.
+```ruby
+service = MyService.new(first_name: "John", last_name: "Doe")
+result = service.call
+puts result
+# Output:
+# {
+#   status: "success",
+#   message: "Hello, World",
+#.  data: "John Doe"
+# }
+
+puts service.output
+# Output:
+# {
+#   status: "success",
+#   message: "Hello, World",
+#.  data: "John Doe"
+# }
+```
+
+### Validations
+You can define validation on the service and  those will be invoked before service logic is invoked
+```ruby
+class MyService
+  include ServiceCore
+
+  field :name, :string
+  validates :name, presence: true
+
+  def perform
+    success_response(message: "Hello, World", data: name)
+  end
+end
+
+service = MyService.new(name: "")
+result = service.call
+puts result
+# Output:
+#{
+#   status: "error",
+#   message: "validation failure",
+#   errors: { name: ["can't be blank"] }
+# }
+```
+
+### Step Validation
+You can perform validation at each step of service logic. This is helpful when result of previous step decides next logic.
+```ruby
+class MyService
+  include ServiceCore
+  
+  field :first_name, :string
+  field :last_name, :string
+  field :user
+
+  validates :first_name, presence: true
+  validates :user, presence: true
+
+  def perform
+    if last_name.blank?
+      add_error_and_validate(:last_name, "can't be nil")
+      return error_response(message: "validation failure", errors: errors)
+    end
+    
+   success_response(data: { user: { id: 1 } })
+  end
+end
+
+MyService.call(first_name: 'abc')
+# output:
+# {
+#   status: "error",
+#   message: "validation failure",
+#   errors: { last_name: ["can't be nil"] }
+# }
+```
+
+### Logging Errors
+You can log errors using the `log_error` method.
+```ruby
+class MyService
+  include ServiceCore
+
+  field :name, :string
+
+  def perform
+    begin
+      raise StandardError, "Something went wrong"
+    rescue StandardError => e
+      log_error(e)
+      error_response(message: "Failed", errors: { base: [e.message] })
+    end
+  end
+end
+
+service = MyService.new(name: "World")
+result = service.call
+puts result
+# Output:
+# {
+#   status: "error",
+#   message: "Failed",
+#   errors: { base: ["Something went wrong"] }
+# }
+
+```
+
+### Configuring the Logger
+You can configure the logger for the ServiceCore module.
+```ruby
+ServiceCore.configure do |config|
+  config.logger = Logger.new(STDOUT)
+end
+```
+
+### Custom Response
+use `formatted_response` method to return any other status other than `success` or `error`
+```ruby
+
+class MyService
+  include ServiceCore
+
+  field :first_name, :string
+  field :last_name, :string
+  field :active, :boolean, default: true
+
+  def perform
+    formatted_response(status: 'processed', message: "Hello, World", data: name)
+  end
+
+  def name
+    "#{first_name} #{last_name}"
+  end
+end
+
+service = MyService.new(first_name: "John", last_name: "Doe")
+result = service.call
+puts result
+# Output:
+# {
+#   status: "processed",
+#   message: "Hello, World",
+#.  data: "John Doe"
+# }
+```
+
+`formatted_response` accepts following arguments:
+- status
+- message
+- data
+- errors
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sehgalmayank001/service-core. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sehgalmayank001/service-core/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ServiceCore project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sehgalmayank001/service-core/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+desc "Tag and push the current version"
+task :release do
+  version = `ruby -r ./lib/service_core/version -e "puts ServiceCore::VERSION"`.strip
+  sh "git add ."
+  sh "git commit -m 'Prepare for version #{version} release'"
+  sh "git tag v#{version}"
+  sh "git push origin main --tags"
+end

data/lib/service_core/base.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "active_model"
+require_relative "response"
+
+module ServiceCore
+  module Base
+    extend ActiveSupport::Concern
+
+    included do
+      include ActiveModel::Model
+      include ActiveModel::Attributes
+      include ActiveModel::Validations
+      include ServiceCore::Response
+
+      # NOTE: output attribute will hold output of the service
+      attr_reader :output
+
+      # NOTE: fields attribute will hold the fields defined and their values
+      attr_reader :fields
+
+      class << self
+        # Wrapper method to define attribuutes and attr_accessor methods on object
+        def fields_defined
+          @fields_defined ||= {}
+        end
+
+        def field(name, *args, **opts)
+          # field :active, :boolean, default: true
+          # field :active, type: :boolean, default: true
+          # Both explicit and implicit definitions are handled
+          type = args[0] || opts[:type]
+          default = args[1] || opts[:default]
+
+          # NOTE: -
+          # ActiveModel::Attributes support only basic data types
+          # for ActiveRecord objects we use attr_accessor through ActiveModel::Model
+          # define attr_accessor to make instance variables also available for attributes
+
+          # define attribute if type is available to type cast
+          if type
+            attribute(name, type, default: default)
+          else
+            attr_accessor(name)
+          end
+
+          # save fields defind as an hash, makes it easier to check
+          fields_defined[name] = default
+        end
+
+        def call(attributes = {})
+          new(attributes).call
+        end
+      end
+
+      def initialize(attributes = {})
+        super
+        @local_errors = {}
+        @fields = {}
+        # NOTE: this helps identify values passed from values updated
+        self.class.fields_defined.each_key do |name|
+          @fields[name] = send(name)
+        end
+
+        # default value of output
+        @output = { status: "initialized" }
+      end
+
+      def call
+        # check if valid arguments are present?
+        return error_response(message: "validation failure", errors: errors) unless valid?
+
+        # perform the operation
+        perform
+
+        # return output
+        output
+      end
+
+      private
+
+      # output writer is protected to be used inside class and sub-classes only
+      attr_writer :output
+
+      def perform
+        raise StandardError, "perform method not implemented"
+      end
+    end
+  end
+end

data/lib/service_core/logger.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module ServiceCore
+  module Logger
+    extend ActiveSupport::Concern
+
+    protected
+
+    def log_error(exception)
+      ServiceCore.logger.error("#{self.class.name}: #{exception.message}")
+    end
+  end
+end

data/lib/service_core/response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+# require "active_model/errors"
+
+module ServiceCore
+  module Response
+    extend ActiveSupport::Concern
+
+    protected
+
+    def success_response(message: nil, data: nil)
+      formatted_response(status: "success", message: message, data: data)
+    end
+
+    def error_response(message:, errors: nil)
+      formatted_response(status: "error", message: message, errors: errors)
+    end
+
+    # set output response
+    def formatted_response(status:, message: nil, data: nil, errors: nil)
+      @output[:status] = status
+      @output[:message] = message if message.present?
+      @output[:data] = data if data.present?
+      @output[:errors] = error_messages(errors) if errors.present?
+      @output
+    end
+
+    def error_messages(errors)
+      errors.is_a?(ActiveModel::Errors) ? errors.messages : errors
+    end
+  end
+end

data/lib/service_core/step_validation.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module ServiceCore
+  module StepValidation
+    extend ActiveSupport::Concern
+
+    included do
+      # NOTE: #
+      # added this to support partial validation
+      # valid? method empties all errors, so needed a way to hold errors from within method invocation
+      validate :local_errors_validation
+
+      def local_errors_validation
+        _local_errors_validation(@local_errors)
+      end
+
+      def _local_errors_validation(errors_hsh)
+        errors_hsh.each do |attribute, messages|
+          next unless messages
+
+          messages.each do |message|
+            errors.add(attribute, *message.is_a?(Array) ? message : [message])
+          end
+        end
+        {}
+      end
+
+      def add_error(attribute, message, options = {})
+        value = options.present? ? [message, options] : message
+        @local_errors[attribute] = if @local_errors[attribute].present?
+                                     Array(@local_errors[attribute]) << value
+                                   else
+                                     [value]
+                                   end
+      end
+
+      # method to add partial errors and validate
+      def add_error_and_validate(attribute, message, _options = {})
+        add_error(attribute, message, {})
+        valid?
+      end
+    end
+  end
+end

data/lib/service_core/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ServiceCore
+  VERSION = "0.1.0"
+end

data/lib/service_core.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "service_core/version"
+require_relative "service_core/base"
+require_relative "service_core/step_validation"
+require_relative "service_core/logger"
+require "active_model"
+require "active_support/concern"
+require "active_support/logger"
+
+module ServiceCore
+  extend ActiveSupport::Concern
+
+  included do
+    include ServiceCore::Base
+    include ServiceCore::StepValidation
+    include ServiceCore::Logger
+  end
+
+  class Error < StandardError; end
+
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= defined?(Rails) && Rails.logger ? Rails.logger : ActiveSupport::Logger.new($stdout)
+    end
+
+    def configure
+      yield self
+    end
+  end
+end

data/sig/service_core.rbs

@@ -0,0 +1,4 @@
+module ServiceCore
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: service_core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mayank sehgal
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: A service pattern implementation for Rails applications.
+email:
+- sehgalmayank001@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/service_core.rb
+- lib/service_core/base.rb
+- lib/service_core/logger.rb
+- lib/service_core/response.rb
+- lib/service_core/step_validation.rb
+- lib/service_core/version.rb
+- sig/service_core.rbs
+homepage: https://github.com/sehgalmayank001/service-core
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: A Rails service pattern implementation
+test_files: []