service_caller 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4270b7ad52ef57a18ba599c31496415626a298ab824884c416c1b5ff51af75c2
-  data.tar.gz: 627575a83678d20e7ec951b1ac9c4777acdcf91e2ae620e2b99c59ccef5b46c6
+  metadata.gz: 48401571ef678e9a715d9edca52d93dfc564532732c5e90be288ca908149bbf9
+  data.tar.gz: 82ace8f205fcc2c999ec78e358a45faf35a001dc7529da582379908b985478da
 SHA512:
-  metadata.gz: 1ce323d5562bb0fb08d42121858dfa19c4cf691f5afe27a11c3781ce8475b190ea7b5c4593f71a924908317c2447c2b03b3e6adbcd81471dea41b956970df2ea
-  data.tar.gz: 796dd3b3e3b64fc4e58b76a12778e2436758b62f4305bda9c2896a3278a340d45c12b220f1379933e0dd43d6aebbcb3319cdb6b1c07832af28611c0d6ea7b657
+  metadata.gz: d8fe40ec0f7c44958867ffa7faed7241429cb78328cc13bf6280b61f2cd8616c687a7c90d0cf473bce73eebfb4f9a5b26de3aaeed4df237734036ed15f94d2d9
+  data.tar.gz: c3101c3b72ae80e54817bd4cc6ea5850c1e8a0cfbfe171068912b06b50d91cab67c3768414082db6a1b0159480174fbb2c5dbca872b3cd04d8158eb7148364e4

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.x'
+# 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.x |
+
+## 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_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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_caller
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - JiaRou Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2023-05-18 00:00:00.000000000 Z
 dependencies: []
 description: basic implement of service object
 email: laura34963@kdanmobile.com
@@ -25,7 +25,9 @@ files:
 homepage: https://github.com/kdan-mobile-software-ltd/service_caller
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/kdan-mobile-software-ltd/service_caller
+  changelog_uri: https://github.com/kdan-mobile-software-ltd/service_caller/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
@@ -35,14 +37,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.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Ruby Service Basic Class