rao-service 0.0.2.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a453d7bad543b288e31572b87c313a28e19597e
+  data.tar.gz: baadcaee6910fb4c866914000ba63209e3ceda75
+SHA512:
+  metadata.gz: 2440d8288cd48ea63f42595931cd665234995e6d4a5e39a396bb211964e4560cabc6cf3d8022dee9cdbec55414b130de0a231c31c8f46a1026e3534a346a5870
+  data.tar.gz: 52aaf54967964788d15586ffd39e06deb7f22ba3da001f7d2c7bbe3439a3b9ab51af201c95d138748d2e13f060b3b33f21981d517915265dcdabdd87b47c70f3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Roberto Vasquez Angel
+
+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,28 @@
+# Rails Add-Ons Service
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rao-service'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rao-service
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,25 @@
+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    = 'Rails Add-Ons Service'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'

data/app/mailers/rao/service/application_mailer.rb

@@ -0,0 +1,6 @@
+module Rao
+  module Service
+    class ApplicationMailer < ActionMailer::Base
+    end
+  end
+end

data/app/mailers/rao/service/notification_mailer.rb

@@ -0,0 +1,16 @@
+module Rao
+  module Service
+    class NotificationMailer < ApplicationMailer
+      def result_email
+        @result      = params[:result]
+        @sender      = params[:sender]
+        @recipient   = params[:recipient]
+        @environment = params[:environment]
+
+        subject = "[#{@environment}][#{@result.service.class.name}] #{@result.ok? ? 'SUCCEEDED' : 'FAILED'}"
+
+        mail(from: @sender, to: @recipient, subject: subject)
+      end
+    end
+  end
+end

data/app/views/rao/service/notification_mailer/result_email.text.erb

@@ -0,0 +1,5 @@
+Execution of <%= @result.service.class.name %> <%= @result.ok? ? 'succeeded' : 'failed' %> in <%= @environment %>:
+
+<% @result.messages.each do |message| %>
+  <%= message %>
+<% end %>

data/lib/generators/rao/service/install_generator.rb

@@ -0,0 +1,15 @@
+module Rao
+  module Service
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        desc 'Generates the initializer'
+
+        source_root File.expand_path('../templates', __FILE__)
+
+        def generate_initializer
+          template 'initializer.rb', 'config/initializers/rao-service.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/rao/service/templates/initializer.rb

@@ -0,0 +1,19 @@
+Rao::Service.configure do |config|
+  # Set the default recipient for service result emails.
+  #
+  # Default: config.default_notification_sender = 'john.doe@domain.local'
+  #
+  config.default_notification_sender = 'john.doe@domain.local'
+
+  # Set the default recipient for service result emails.
+  #
+  # Default: config.default_notification_recipient = 'john.doe@domain.local'
+  #
+  config.default_notification_recipient = 'john.doe@domain.local'
+
+  # Set the environment that will be shown in notifications.
+  #
+  # Default: config.default_notification_recipient = ->(result) { ::Rails.env }
+  #
+  config.notification_environment = ->(result) { ::Rails.env }
+end

data/lib/rao/service/base.rb

@@ -0,0 +1,157 @@
+require 'active_support/concern'
+require "rao/service/result/base"
+require "rao/service/messages"
+require 'active_model'
+
+module Rao
+  module Service
+    class Base
+      include ActiveModel::Model
+      extend ActiveModel::Naming
+
+      def self.attr_accessor(*args)
+        super
+        add_attribute_names(*args)
+      end
+
+      def self.add_attribute_names(*args)
+        args.each do |attr_name|
+          attribute_names << attr_name
+        end
+      end
+
+      def self.attribute_names
+        (@attr_names ||= [])
+      end
+
+      def self.call(*args)
+        new(*args).perform
+      end
+
+      def initialize(attributes = {}, options = {}, &block)
+        @options    = options
+        @block      = block
+        @attributes = {}
+        set_attributes(attributes)
+        initialize_result
+        initialize_errors
+        initialize_messages
+        after_initialize
+      end
+
+      private
+
+      module Attributes
+        def set_attributes(attributes)
+          attributes.each do |key, value|
+            send("#{key}=", value)
+          end
+        end
+      end
+
+      include Attributes
+
+      module Callbacks
+        def after_initialize; end
+        def before_perform; end
+        def after_perform; end
+        def before_validation; end
+        def after_validation; end
+        def after_perform; end
+
+        def perform
+          before_validation
+          return perform_result unless valid?
+          after_validation
+          before_perform
+          say "Performing" do
+            _perform
+          end
+          after_perform
+          perform_result
+        end
+      end
+
+      module Resultable
+        private
+
+        def initialize_result
+          @result = result_class.new(self)
+        end
+
+        def perform_result
+          copy_messages_to_result
+          copy_errors_to_result
+          @result
+        end
+
+        def result_class
+          "#{self.class.name}::Result".constantize
+        end
+      end
+
+      module Errors
+        private
+
+        def initialize_errors
+          @errors = ActiveModel::Errors.new(self)
+        end
+
+        def copy_errors_to_result
+          @result.instance_variable_set(:@errors, @errors)
+        end
+
+        def copy_errors_from_to(obj, key_prefix)
+          obj.errors.each do |key, message|
+            @errors.add(key_prefix, message)
+          end
+        end
+
+        def add_error_and_say(attribute, message)
+          @errors.add(attribute, message)
+          say(message)
+        end
+      end
+
+      module Autosave
+        extend ActiveSupport::Concern
+
+        if respond_to?(:class_methods)
+          class_methods do
+            def call!(*args)
+              new(*args).autosave!.perform
+            end
+          end
+        else
+          module ClassMethods
+            def call!(*args)
+              new(*args).autosave!.perform
+            end
+          end
+        end
+
+        def autosave?
+          !!@options[:autosave]
+        end
+
+        def autosave!
+          @options[:autosave] = true
+          self
+        end
+      end
+
+      module Internationalization
+        def t(key, options)
+          I18n.t("activemodel.#{self.class.name.underscore}#{key}", options)
+        end
+      end
+
+      include Errors
+      include Resultable
+      include Callbacks
+      include Rao::Service::Messages
+      include Autosave
+      include Internationalization
+    end
+  end
+end

data/lib/rao/service/configuration.rb

@@ -0,0 +1,16 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/module/attribute_accessors'
+
+module Rao
+  module Service
+    module Configuration
+      def configure
+        yield self
+      end
+
+      mattr_accessor(:default_notification_sender)    { 'john.doe@domain.local' }
+      mattr_accessor(:default_notification_recipient) { 'john.doe@domain.local' }
+      mattr_accessor(:notification_environment)       { Object.const_defined?('::Rails') ? ::Rails.env : nil }
+    end
+  end
+end

data/lib/rao/service/engine.rb

@@ -0,0 +1,7 @@
+module Rao
+  module Service
+    class Engine < ::Rails::Engine
+      isolate_namespace Rao::Service
+    end
+  end
+end

data/lib/rao/service/message/base.rb

@@ -0,0 +1,18 @@
+module Rao
+  module Service::Message
+    class Base
+      def initialize(content, options = {})
+        @indent_level = options.fetch(:indent_level) { 1 }
+        @content = content
+      end
+
+      def level
+        @indent_level
+      end
+
+      def to_s
+        @content
+      end
+    end
+  end
+end

data/lib/rao/service/messages.rb

@@ -0,0 +1,52 @@
+require "rao/service/message/base"
+
+module Rao
+  module Service
+      module Messages
+      private
+
+      def initialize_messages
+        @messages = []
+      end
+
+      def say(what, &block)
+        @indent ||= 0
+        if block_given?
+          @indent += 1
+          output(_message("#{output_prefix}#{("  " * @indent)}#{what}...", level: @indent))
+          block_result = yield
+          say_done
+          @indent -= 1
+          block_result
+        else
+          output(_message("#{output_prefix}#{("  " * @indent)}#{what}", level: @indent))
+        end
+      end
+
+      def say_done
+        say "  => Done"
+      end
+
+      def output_prefix
+        "[#{self.class.name}] "
+      end
+
+      def output(what)
+        @messages << what
+        puts what unless silenced?
+      end
+
+      def silenced?
+        !!@options[:silence]
+      end
+
+      def copy_messages_to_result
+        @result.instance_variable_set(:@messages, @messages)
+      end
+
+      def _message(content, options = {})
+        Rao::Service::Message::Base.new(content, level: options[:level])
+      end
+    end
+  end
+end

data/lib/rao/service/result/base.rb

@@ -0,0 +1,60 @@
+require 'rao/service'
+require 'active_model/naming'
+require 'active_model/translation'
+
+module Rao
+  module Service::Result
+    class Base
+      extend ActiveModel::Translation
+      
+      attr_reader :messages, :errors, :service
+
+      def initialize(service)
+        @service = service
+      end
+
+      def model_name
+        @service.model_name
+      end
+
+      module Succeedable
+        def success?
+          !failed?
+        end
+
+        def failed?
+          @errors.any?
+        end
+
+        def ok?
+          success?
+        end
+      end
+
+      include Succeedable
+
+      module Mailable
+        def notify_now(recipient = nil)
+          recipient ||= default_notification_recipient
+          sender    ||= default_notification_sender
+          ::Rao::Service::NotificationMailer.with(result: self, environment: notification_environment, sender: sender, recipient: recipient).result_email.deliver_now
+        end
+
+        def default_notification_sender
+          ::Rao::Service::Configuration.default_notification_sender
+        end
+
+        def default_notification_recipient
+          ::Rao::Service::Configuration.default_notification_recipient
+        end
+
+        def notification_environment
+          ::Rao::Service::Configuration.notification_environment.call(self)
+        end
+          
+      end
+
+      include Mailable if Rao::Service.rails_present?
+    end
+  end
+end

data/lib/rao/service/version.rb

@@ -0,0 +1,7 @@
+require 'rao/version'
+
+module Rao
+  module Service
+    VERSION = ::Rao::VERSION
+  end
+end

data/lib/rao/service.rb

@@ -0,0 +1,18 @@
+require "rao/service/configuration"
+require "rao/service/version"
+
+module Rao
+  module Service
+    extend Configuration
+    
+    class_eval do
+      def self.rails_present?
+        # Gem.loaded_specs["rails"].present?
+        Object.const_defined?('::Rails')
+      end
+    end
+  end
+end
+
+require "rao/service/engine" if Object.const_defined?('::Rails')
+require "rao/service/base"

data/lib/rao-service.rb

@@ -0,0 +1,2 @@
+require "rao"
+require "rao/service"

data/lib/tasks/rao-service_tasks.rake

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

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: rao-service
+version: !ruby/object:Gem::Version
+  version: 0.0.2.pre
+platform: ruby
+authors:
+- Roberto Vasquez Angel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rao
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- roberto@vasquez-angel.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/mailers/rao/service/application_mailer.rb
+- app/mailers/rao/service/notification_mailer.rb
+- app/views/rao/service/notification_mailer/result_email.text.erb
+- lib/generators/rao/service/install_generator.rb
+- lib/generators/rao/service/templates/initializer.rb
+- lib/rao-service.rb
+- lib/rao/service.rb
+- lib/rao/service/base.rb
+- lib/rao/service/configuration.rb
+- lib/rao/service/engine.rb
+- lib/rao/service/message/base.rb
+- lib/rao/service/messages.rb
+- lib/rao/service/result/base.rb
+- lib/rao/service/version.rb
+- lib/tasks/rao-service_tasks.rake
+homepage: https://github.com/rao
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Services for Ruby on Rails.
+test_files: []