action_service 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e557d577a7c6be44d862d4929a2df8ee053d2834aa705374df3d740c5b64aa0
-  data.tar.gz: 56acbc897cc072d3740bebe22b79ae5cd86b47f1ee4075a61d167cb70e966214
+  metadata.gz: b1380fb36f26ce37de08cac1a1234a2ba69526a93e8481975bc342f89ffef03d
+  data.tar.gz: 0b060a1922cf2994daa803e881180b2c7c6a55a03100c5c28599a98b16784e51
 SHA512:
-  metadata.gz: cfe05a34ab7c13a4efa95d8f56135ef4bcd319d0bfb31580eb240e7f7bb3963b131da0eb8f13b639685f0f90f49e5919e5a42442ed1c48327d41f6d7f31db75f
-  data.tar.gz: 956dddc06eee6edcaf6d4ea23be309b6110d894ee52958e70db6b1889ec5af0177f18f2454349e568e22863dbf6b26d78f8404d1f2367f7fb0a942ca7b088cd4
+  metadata.gz: 961f51fd421624c0d486c7da5f4a73e65c38fc6b99daaf9abf8f5dfb52f15e51ac15ec70e5e95e61f4ac2fcfabe19fa7c409fcae71eb9a5bfa2ad19b09eb3a8d
+  data.tar.gz: e1f3e3399f218967483bc612edbe059cbe87d22979cb290f3fa6304d9f9677fe4e4da584c2380725892c006d54d15c9fa39c8246e6d99420b5dd2fc4db5e3932

data/README.md

@@ -1,8 +1,8 @@
-# ActionService v1.0
+# ActionService v2.x
 Welcome to Action Service gem, is a ruby gem to create and interact easily with services.
 
 ## Why services
-Is where you can add your code to perform simple functionality instead of making complex controllers or models.
+This is where you can add your code to perform a simple function instead of making complex controllers or models.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -22,7 +22,7 @@ $ gem install action_service
 ```
 
 ## Setting up
-For start to use the gem execute:
+To start to use the gem execute:
 ```bash
 $ rails g service:application_service
 ```
@@ -42,84 +42,79 @@ Running via Spring preloader in process 30051
 And when you open `authenticate_service.rb` will be like this
 ```ruby
 class Admin::AuthenticateService < ApplicationService
+  def initialize()
+    super()
+  end
 
-    def initialize()
-        super()
-    end
-
-    def call
-        return self
-    end
-
+  def call
+    self
+  end
 end
 ```
 
 ### ApplicationService class
-All generated services are inhariting from `ApplcaitonService`, `ApplicationService` is inherite from `ActoinService::Base, So all service will contain:  
+All generated services are inheriting from `ApplcaitonService`, `ApplicationService` is inherited from `ActoinService::Base, So all service will contain:  
 #### Three instance variables 
-1. `@success` is a boolean with `true` as default value , and if you add any error this flag will be changed to `false`. 
-2. `@errors` is a array contain a list if errors.
+1. `@success` is a boolean with `true` as the default value, and if you add any error this flag will be changed to `false`. 
+2. `@errors` is an array containing a list of errors.
 3. `@response` is a hash to add service response (values, objects, etc.).
 #### Six instance methods
-1. `success?` to get boolean if service excuted successfully ot not (based on adding errors).
-2. `errors` to get list of errors.
-3. `response` to get response hash.
+1. `success?` to get boolean if service is executed successfully or not (based on adding errors).
+2. `errors` to get a list of errors.
+3. `response` to get the response hash.
 4. `add_error(error_message)` to add error (will change `@success` to `false`), Example `add_error("wrong admin id")`.
 5. `add_errors(*error_messages)` to add errors as parameters or array (will change `@success` to `false`), Example `add_errors("email is required","phone number is aready exist")` OR `add_errors(["email is required","phone number is aready exist"])`.
-6. `add_errors_array(error_messages_array)` to add array of errors (will change `@success` to `false`), Example `add_errors_array(["email is required","phone number is aready exist"])`.
 
 Now, let's implement `Admin::AuthenticateService`
 ```ruby
 class Admin::AuthenticateService < ApplicationService
-
-    def initialize(email, password)
-        super()
-        @admin = Admin.find_by(email: email)
-        @password = password
-    end
-
-    def call
-        add_error "wrong admin email" and return self if not @admin
-        add_error "wrong password" and return self if not @admin.authenticate(@password)
-        @response[:admin] = @admin
-        return self
-    end
+  def initialize(email, password)
+    super()
+    @admin = Admin.find_by(email: email)
+    @password = password
+  end
+
+  def call
+    add_error "wrong admin email" and return self if not @admin
+    add_error "wrong password" and return self if not @admin.authenticate(@password)
+    @response[:admin] = @admin
+    self
+  end
 end
 ```
 
-This service is now ready to be used, For example we will call the service inside a controller
+This service is now ready to be used, For example, we will call the service inside a controller
 ```ruby
 result =  Admin::AuthenticateService.new(params[:email], params[:password]).call
 if result.success?
-    # {success: true, response: {admin object}, errors: []}
-    render json: { success: result.success?, response: result.response, errors: result.errors }
-else:
-    # {success: false, response: {}, errors: ["wrong email" OR "wrong password"]}
-    render json: { success: result.success?, response: result.response, errors: result.errors }, status: :unauthorized
+  # {success: true, response: {admin object}, errors: []}
+  render json: { success: result.success?, response: result.response, errors: result.errors }
+else
+  # {success: false, response: {}, errors: ["wrong email" OR "wrong password"]}
+  render json: { success: result.success?, response: result.response, errors: result.errors }, status: :unauthorized
 end
 ```
 
-#### Services layer will help you to write clean code, by small models, controller and DRY code (don't repeat yourself), you can use service inside another service and stop excuting the first service if the second one fails, Example:
+#### Services layer will help you to write clean code, by small models, controller and DRY code (don't repeat yourself), you can use service inside another service and stop executing the first service if the second one fails, Example:
 ```ruby
 class Cache::List::AddHashService < ApplicationService
-
-    def initialize(list_key, hash_key, hash_data, expiry_datetime=nil)
-        super()
-        @list_key = list_key
-        @hash_key = hash_key
-        @hash = hash_data
-        @expiry_datetime = expiry_datetime
-    end
-
-    def call
-        result = Cache::Hash::SetService.new(hash_key, hash_data, @expiry_datetime).call
-        # if Cache::Hash::SetService fails will stop excuting and return the errors
-        add_errors result.errors and return self if not result.success? 
-        result = Cache::List::AddService.new(list_key, hash_key, @expiry_datetime).call
-        # if Cache::List::AddService fails will stop excuting and return the errors
-        add_errors result.errors and return self if not result.success?
-        self
-    end
+  def initialize(list_key, hash_key, hash_data, expiry_datetime=nil)
+    super()
+    @list_key = list_key
+    @hash_key = hash_key
+    @hash = hash_data
+    @expiry_datetime = expiry_datetime
+  end
+
+  def call
+    result = Cache::Hash::SetService.new(hash_key, hash_data, @expiry_datetime).call
+    # if Cache::Hash::SetService fails will stop excuting and return the errors
+    add_errors result.errors and return self if not result.success? 
+    result = Cache::List::AddService.new(list_key, hash_key, @expiry_datetime).call
+    # if Cache::List::AddService fails will stop excuting and return the errors
+    add_errors result.errors and return self if not result.success?
+    self
+  end
 end
 ```
 
@@ -127,4 +122,4 @@ end
 Bug reports and pull requests are welcome on GitHub at [https://github.com/abdofawzi5/action_service](https://github.com/abdofawzi5/action_service). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open-source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/action_service.rb

@@ -4,24 +4,16 @@ require 'generators/service/service_generator'
 require 'generators/application_service/application_service_generator'
 
 module ActionService
-  
-  
   # ActionService::Base is the parent class for all services that will be generated.
   class Base
-   def initialize
+    attr_accessor :errors, :response
+
+    def initialize
       @errors = []     # contain errors
       @response = {}   # contain the service response data
       @success = true  # flag service execution without any error
     end
 
-    def errors 
-      @errors
-    end
-
-    def response
-      @response
-    end
-
     def success?
       @success
     end
@@ -33,18 +25,8 @@ module ActionService
 
     def add_errors(*error_messages)
       @success = false
-      if error_messages[0].kind_of?(Array)
-        # called using array
-        add_errors_array(error_messages[0])
-      else
-        @errors += error_messages
-      end
-    end
-
-    def add_errors_array(error_messages_array)
-      @success = false
-      @errors += error_messages_array
+      error_messages = error_messages[0] if error_messages[0].is_a?
+      @errors += error_messages
     end
   end
-
 end

data/lib/action_service/version.rb

@@ -1,3 +1,3 @@
 module ActionService
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 end

data/lib/generators/application_service/application_service_generator.rb

@@ -1,18 +1,15 @@
 module Service
   class ApplicationServiceGenerator < Rails::Generators::Base
-
-    source_root File.expand_path("templates", __dir__)
+    source_root File.expand_path('templates', __dir__)
 
     def create_application_service
-      template "application_service.rb", application_service_file_name
+      template 'application_service.rb', application_service_file_name
     end
 
     private
 
     def application_service_file_name
-      @application_record_file_name ||= "app/services/application_service.rb"
+      @application_service_file_name ||= 'app/services/application_service.rb'
     end
-    
-
   end
-end
+end

data/lib/generators/service/service_generator.rb

@@ -1,6 +1,5 @@
 module Service
   class ServiceGenerator < Rails::Generators::NamedBase
-
     source_root File.expand_path('templates', __dir__)
 
     def create_service_file
@@ -10,12 +9,11 @@ module Service
     private
 
     def file_name
-      @_file_name ||= remove_possible_suffix(super)
+      @file_name ||= remove_possible_suffix(super)
     end
 
     def remove_possible_suffix(name)
-      name.sub(/_?service$/i, "")
+      name.sub(/_?service$/i, '')
     end
-
   end
 end

data/lib/generators/service/templates/service.rb.tt

@@ -1,13 +1,11 @@
 <% module_namespacing do -%>
 class <%= class_name %>Service < ApplicationService
+  def initialize()
+    super()
+  end
 
-	def initialize()
-		super()
-	end
-
-	def call
-		return self
-	end
-
+  def call
+    self
+  end
 end
 <% end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_service
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Abdo Fawzi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-21 00:00:00.000000000 Z
+date: 2020-11-02 00:00:00.000000000 Z
 dependencies: []
 description: Is where you can add your code to do simple functionality instead of
   make complex controller or models.
@@ -34,7 +34,7 @@ homepage: https://github.com/abdofawzi5/action_service
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -49,9 +49,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Is a ruby gem to create and interact easily with services.
 test_files: []