service_caller 1.0.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a82a014594816863e1bfcc5595241ad98f46088584d3491b014b1a64c70a42c2
-  data.tar.gz: 4c436447096e5d4eda6be6e3dc445cf9857686d57eab9a471a9c352de58db1c3
+  metadata.gz: baf3a2b14016c3d6c5d8edaaeb685b471fe044f341b499c881ce80d255fd9793
+  data.tar.gz: 7b0eb03312f9b820097f4f3cd2104aa8ec9c9bd203163f037fd2b1b97ba7d9bc
 SHA512:
-  metadata.gz: 6bfda486178406cbb5d2a3f69a9c918d1b3726f5dec1ee635fccf3e1d4229bf24a2998f210a824edfe499999cd8c30454cbbe73dc731c215894bac7fca7c9d37
-  data.tar.gz: 14808d05d2f90a70502d4c0f2978fc5e626a04942c23ee2f8a55caaea9ab33e2aafea7a607096f0bb7dcbb98868bc27dd4747a76e99e8897c177ce4e41ffb37b
+  metadata.gz: f96a41886c346c180dde240521dcdbfbbfe297a71f448e608120aeb51881adb1c45cda1ce03b6fd595b0a212b887c70a330d36c2eda60d7109cba0aca5db0482
+  data.tar.gz: 28aa75a07f70bf226d454366d8b76f20350c9c5fa28956b68d27c28566deb109fb8de8fd9129dfb65d79358924ed6df73ad9bf4ab5778f8afc79a025d2cfa1f6

data/README.md

@@ -1,34 +1,81 @@
 # Service Caller
 
-### How to Use
-* install gem
+## Installation
+1. Add `service_caller` in your app's `Gemfile`.
+
+``` ruby
+# ruby version 2.7+ or later
+gem 'service_caller', '~> 1.2.0'
+# ruby version 2.6+ or eariler
+gem 'service_caller', '~> 1.1.0'
 ```
-gem install service_caller-0.1.0.gem
+
+2. Then, in your project directory, install the gem manually from your shell, run:
+
+``` bash
+# Download and install
+$ bundle install
 ```
 
-* require gem
-```ruby
-require 'service_caller'
+## Upgrading
+
+If your project is already using an older version of service_caller, upgrade to the latest version with:
+
+``` bash
+$ bundle update service_caller
 ```
 
+## Support of Ruby and Rails Version
+
+|  Ruby Version  | Rails Verision | Service Caller Version |
+| - | - | - |
+| 2.6 or eariler | 5.x | 1.1.0 | 
+| 2.7, 3.0 later | 6.x | 1.2.0 |
+
+## Usage
+
 * define service & inherit from `ServiceCaller`
+  * **For ruby 2.6 or earlier** (ruby 2.7 may show deprecated warning message)
 ```ruby
 class [Custom Service] < ServiceCaller
   def initialize(*args)
     ...
+    @a = a
+    @b = b
   end
 
   def call
     ...
+    @result = "Your service result which you want to return"
   end
 end
 ```
+  * **For ruby 2.7 or ruby 3.0**
+``` ruby
+class [Custom Service] < ServiceCaller
+  def initialize(*args, **hsh)
+    ...
+    @a = a
+    @b = b
+  end
 
-* call the service
+  def call
+    ...
+    @result = "Your service result which you want to return"
+  end
+end
+``` 
+
+* call the service (**For ruby 2.6 or earlier**)
 ```ruby
   service = [Custom Service].call(*args)
 ```
 
+* call the service (**For ruby 2.7 or ruby 3.0**)
+```ruby
+  service = [Custom Service].call(*args, **hsh)
+```
+
 * check if success
 ```ruby
   service.success?
@@ -43,4 +90,42 @@ end
 * get error if failed
 ```ruby
   service.error
+```
+
+### Example
+
+``` ruby
+class CalBmi < ServiceCaller
+  def initialize(member_name, height: 1.55, weight: 52)
+    @member_name = member_name
+    @height = height
+    @weight = weight
+  end
+
+  def call
+    bmi = calculate_bmi
+    raise ServiceError.new(:member_name_not_found, error_msg: 'not enter the name') if @member_name.blank?
+    @result = "#{@member_name}'s BMI is #{bmi}"
+  end
+
+  private
+
+  def calculate_bmi
+    (@weight / @height**2).round(2)
+  end
+end
+
+
+# Call the BMI Service
+
+body_insight = {height: 1.80, weight: 73}
+bmi = CalBmi.call('william', **body_insight)
+
+bmi.success? # it will show the caller is success or failed
+bmi.result   # it will show you => william's BMI is 22.53
+
+bmi = CalBmi.call('', **body_insight)
+bmi.error    # if failed, the service will raise the custom error => #<ServiceError: member_name_not_found>
+bmi.error.key # :member_name_not_found
+bmi.error.error_obj #  {:error_msg=>"not enter the name"}
 ```

data/lib/service_error.rb

@@ -4,7 +4,7 @@ class ServiceError < StandardError
 
   class << self
     def generate_from_exception(exception, append_info={})
-      error_obj = {error_msg: "#{exception.class.name}: #{exception.message}"}
+      error_obj = {error_message: "#{exception.class.name}: #{exception.message}"}
       error_obj.merge!(append_info)
       service_err = new(:internal_error, error_obj)
       service_err.set_backtrace(exception.backtrace)
@@ -14,7 +14,8 @@ class ServiceError < StandardError
 
   def initialize(key, error_obj={})
     @key = key
+    error_message = error_obj.delete(:error_message) || key
     @error_obj = error_obj
-    super(error_obj[:error_msg] || key)
+    super(error_message)
   end
 end

data/lib/service_extend/callable.rb

@@ -3,8 +3,8 @@ module ServiceExtend
     attr_reader :error, :result
 
     module ClassMethods
-      def call(*args)
-        service = new(*args)
+      def call(*args, **hsh)
+        service = new(*args, **hsh)
         service.call
         service
       end

data/lib/service_extend/handler.rb

@@ -2,13 +2,13 @@ module ServiceExtend
   module Handler
 
     def call
-      if defined?(::Rails::Engine)
+      if defined?(::Rails::Engine) && defined?(::ActiveRecord)
         begin
           super
         rescue ServiceError => e
           @error = e
         rescue ActiveRecord::RecordNotFound => e
-          @error = ServiceError.new(:record_not_found, error_msg: e.message)
+          @error = ServiceError.new(:record_not_found, error_message: e.message)
           @error.set_backtrace(e.backtrace)
         rescue Exception => e
           @error = ServiceError.generate_from_exception(e)
@@ -25,4 +25,4 @@ module ServiceExtend
     end
 
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_caller
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.2.0
 platform: ruby
 authors:
 - JiaRou Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-29 00:00:00.000000000 Z
+date: 2021-10-05 00:00:00.000000000 Z
 dependencies: []
 description: basic implement of service object
 email: laura34963@kdanmobile.com
@@ -35,14 +35,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.1
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Ruby Service Basic Class