action_service 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c8f7b52ecc3f88e50370f17d7cc24fd17e971a8
+  data.tar.gz: 2c3abf99ab662c10bdeca699313e301b78e301d1
+SHA512:
+  metadata.gz: 10d82df111bae4842bf47911c349e03d469f4d9ca0fbaa36eb532cc6005dde160afc61f1a30e4ca1243987ef03d58503b569b80daa1c8038de0c8a171cf4d75b
+  data.tar.gz: a033bd4d4b748c3bb10021d13e3e9a6dc39116d66db5980f705ba453da9ea8201935c876f59af41b9c36c0016b237aec68b032c3b18340e5cc1ee54ada2ad23a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 abdofawzi
+
+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,130 @@
+# ActionService v1.0
+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.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_service'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install action_service
+```
+
+## Setting up
+For start to use the gem execute:
+```bash
+$ rails g service:application_service
+```
+This command will generate application service (is the parent class for all your services), application service is inheriting from the action service base class, and you can overwrite all methods.
+
+## Usage
+You can start to use action service by generating service to execute a specific logic, Example:
+Run next command to generate service for authenticating an admin
+```bash 
+$ rails g service Admin::Authenticate
+```
+this will add a new directory for admin inside `app/services` if not exist, and generate `authenticate_service.rb`
+```bash
+Running via Spring preloader in process 30051
+      create  app/services/admin/authenticate_service.rb
+```
+And when you open `authenticate_service.rb` will be like this
+```ruby
+class Admin::AuthenticateService < ApplicationService
+
+    def initialize()
+        super()
+    end
+
+    def call
+        return self
+    end
+
+end
+```
+
+### ApplicationService class
+All generated services are inhariting from `ApplcaitonService`, `ApplicationService` is inherite 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.
+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.
+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 sef if not @admin
+        add_error "wrong password" and return seld if not @admin.authenticate(@password)
+        @response[:admin] = @admin
+        return self
+    end
+end
+```
+
+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
+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:
+```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
+end
+```
+
+## Contributing
+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).

data/Rakefile

@@ -0,0 +1,41 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActionService'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test
+
+
+
+begin
+  require 'gemika/tasks'
+rescue LoadError
+  puts 'Run `gem install gemika` for additional tasks'
+end

data/lib/action_service.rb

@@ -0,0 +1,49 @@
+require 'action_service/version'
+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
+      @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
+
+    def add_error(error_message)
+      @success = false
+      @errors << error_message
+    end
+
+    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
+    end
+  end
+
+end

data/lib/action_service/version.rb

@@ -0,0 +1,3 @@
+module ActionService
+  VERSION = '1.0.1'
+end

data/lib/generators/application_service/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Generates an application service class, application service class is a class that inherits from action service base class.
+
+Example:
+    `rails generate service:application_service`
+

data/lib/generators/application_service/application_service_generator.rb

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

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

@@ -0,0 +1,2 @@
+class ApplicationService < ActionService::Base
+end

data/lib/generators/service/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Generates a service for logic implementation.
+
+Example:
+    `rails generate service UserLogin`
+

data/lib/generators/service/service_generator.rb

@@ -0,0 +1,21 @@
+module Service
+  class ServiceGenerator < Rails::Generators::NamedBase
+
+    source_root File.expand_path('templates', __dir__)
+
+    def create_service_file
+      template 'service.rb.tt', File.join('app/services', class_path, "#{file_name}_service.rb")
+    end
+
+    private
+
+    def file_name
+      @_file_name ||= remove_possible_suffix(super)
+    end
+
+    def remove_possible_suffix(name)
+      name.sub(/_?service$/i, "")
+    end
+
+  end
+end

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

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

data/lib/tasks/action_service_tasks.rake

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

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: action_service
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Abdo Fawzi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6'
+description: Is where you can add your code to do simple functionality instead of
+  make complex controller or models.
+email:
+- abdofawzi5@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/action_service.rb
+- lib/action_service/version.rb
+- lib/generators/application_service/USAGE
+- lib/generators/application_service/application_service_generator.rb
+- lib/generators/application_service/templates/application_service.rb.tt
+- lib/generators/service/USAGE
+- lib/generators/service/service_generator.rb
+- lib/generators/service/templates/service.rb.tt
+- lib/tasks/action_service_tasks.rake
+homepage: https://github.com/abdofawzi5/action_service
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Is a ruby gem to create and interact easily with services.
+test_files: []