rao-service 0.0.48.pre → 0.0.50.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ae2d70f4e63752d4ac5a78e588a07d7929b3ef45b696d650ad8f3d3cdae0777
-  data.tar.gz: 28d0a194eac75ddbb0011b0552b325a51b33ce7ccf67b77e44e9b63a6a4342ca
+  metadata.gz: 294f3a65680c8418c165d267126dbfdb339563eeac0f10aacf532f3f2eb62bcc
+  data.tar.gz: d78dfc7c61bdef1fcfcff9786aca13e8d667d00da890b16253f1d588bbb67bc8
 SHA512:
-  metadata.gz: 7ded1050beb995cf9de1403dac421c36ca0e2f362c8c06838edc0eff1d7980d1bbfa7e440f50cbcc7a23101cabca7442654429eb04ca535ed6848d19035748fa
-  data.tar.gz: 3ec72a8fc91a7317713af254177f9e9da394ee26301697f9992eb2b234e976a08213636da9c9ecfa37e049fa088ebb0331bdea9cd51ca450e2bdd813b4516f1a
+  metadata.gz: 1d614bc3dc2b93cfc2fc5b8521a78fe2b56aedfcf18d3a5326a5392a3c89f9bc218218337916fc235df1326b2d90944d7ae9c59238968bf3cec2ee462bb002fc
+  data.tar.gz: 3442dc89d8f1f844bd2d37ee9216c1960382e17e36da888ab7f0cdb735b48877f62416559bc032c5f710b23a2123921b83302285e3a8ec244c4dda866e5b246b

data/README.md

@@ -1,8 +1,52 @@
 # Rails Add-Ons Service
-Short description and motivation.
+
+Rails is missing a service layer. For simple applications the default MVC impementation may be enought, but once you begin adding serious business lovgic you either end up with fat controllers, models, callback hell or all of them.
+
+Rao::Service solves this problem by providing you a service object that is easy to use. It can be simultaneously used for UIs and APIs by using Rao::ServiceController and Rao::Api::Service Controller as its frontend.
+
 
 ## Usage
-How to use my plugin.
+
+Here is a basic example that queries the nasa api:
+```
+# nethttp.rb
+require 'uri'
+require 'net/http'
+
+class NasaService < Rao::Service::Base
+  class Result < Rao::Service::Result::Base
+    attr_accessor :response
+
+    def parsed_response
+      @parsed_response ||= JSON.parse(response)
+    end
+  end
+
+  private
+
+  def _perform
+    response = Net::HTTP.get_response(uri)
+
+    if response.is_a?(Net::HTTPSuccess)
+      @result.response = response.body
+    else
+      add_error_and_say(:base, "API request failed.")
+    end
+  end
+
+  def uri
+    @uri ||= URI('https://api.nasa.gov/planetary/apod?api_key=DEMO_KEY')
+  end
+end
+
+result = PlanetService.call
+
+if result.ok?
+  result.parsed_response
+else
+  result.errors.full_messages.to_sentence
+end
+```
 
 ## Installation
 Add this line to your application's Gemfile:

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

@@ -16,4 +16,10 @@ Rao::Service.configure do |config|
   # Default: config.default_notification_recipient = ->(result) { ::Rails.env }
   #
   config.notification_environment = ->(result) { ::Rails.env }
+
+  # Sets the base class for service jobs.
+  #
+  # default: config.job_base_class_name = 'ActiveJob::Base'
+  #
+  config.job_base_class_name = 'ActiveJob::Base'
 end

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

@@ -25,6 +25,10 @@ module Rao
         @options[:autosave] = true
         self
       end
+
+      def autosave=(value)
+        @options[:autosave] = ActiveModel::Type::Boolean.new.cast(value)
+      end
     end
   end
 end

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

@@ -9,6 +9,9 @@ module Rao
       def before_validation; end
       def after_validation; end
       def after_perform; end
+      def around_perform
+        yield
+      end
 
       def perform(options = {})
         options.reverse_merge!(validate: true)
@@ -19,8 +22,10 @@ module Rao
           after_validation
         end
         before_perform
-        say "Performing" do
-          _perform
+        around_perform do
+          say "Performing" do
+            _perform
+          end
         end
         after_perform
         save if autosave? && respond_to?(:save, true)

data/lib/rao/service/base.rb

@@ -37,6 +37,11 @@ module Rao
         add_attribute_names(*args)
       end
 
+      def self.attr_reader(*args)
+        super
+        add_attribute_names(*args)
+      end
+
       def self.add_attribute_names(*args)
         args.each do |attr_name|
           attribute_names << attr_name

data/lib/rao/service/configuration.rb

@@ -11,6 +11,7 @@ module Rao
       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 }
+      mattr_accessor(:job_base_class_name)            { 'ActiveJob::Base' }
     end
   end
 end

data/{app/jobs → lib}/rao/service/job.rb

@@ -1,6 +1,6 @@
 module Rao
   module Service
-    class Job < ApplicationJob
+    class Job < Rao::Service::Configuration.job_base_class_name.constantize
       def perform(service_class_name, attributes = {}, options = {})
         service_class_name.constantize.call(attributes, options)
       end

data/{app/mailers → lib}/rao/service/notification_mailer.rb

@@ -1,3 +1,5 @@
+require "rao/service/application_mailer"
+
 module Rao
   module Service
     class NotificationMailer < ApplicationMailer

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

@@ -0,0 +1,35 @@
+module Rao
+  module Service
+    module Result
+      module Base::AttributeNamesConcern
+        extend ActiveSupport::Concern
+
+        included do
+        end
+
+        class_methods do
+          def attr_accessor(*args)
+            super
+            add_attribute_names(*args)
+          end
+
+          def attr_reader(*args)
+            super
+            add_attribute_names(*args)
+          end
+
+          def add_attribute_names(*args)
+            args.each do |attr_name|
+              attribute_names << attr_name
+            end
+          end
+
+          def attribute_names
+            (@attr_names ||= [])
+          end
+        end
+      end
+    end
+  end
+end
+

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

@@ -12,6 +12,9 @@ module Rao
         include MailableConcern
       end
 
+      require 'rao/service/result/base/attribute_names_concern'
+      include AttributeNamesConcern
+
       require 'rao/service/result/base/succeedable_concern'
       include SucceedableConcern
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rao-service
 version: !ruby/object:Gem::Version
-  version: 0.0.48.pre
+  version: 0.0.50.pre
 platform: ruby
 authors:
 - Roberto Vasquez Angel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2023-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -188,14 +188,12 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/jobs/rao/service/job.rb
-- 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/application_mailer.rb
 - lib/rao/service/base.rb
 - lib/rao/service/base/active_job_concern.rb
 - lib/rao/service/base/autosave_concern.rb
@@ -206,8 +204,11 @@ files:
 - lib/rao/service/base/result_concern.rb
 - lib/rao/service/configuration.rb
 - lib/rao/service/engine.rb
+- lib/rao/service/job.rb
 - lib/rao/service/message/base.rb
+- lib/rao/service/notification_mailer.rb
 - lib/rao/service/result/base.rb
+- lib/rao/service/result/base/attribute_names_concern.rb
 - lib/rao/service/result/base/mailable_concern.rb
 - lib/rao/service/result/base/succeedable_concern.rb
 - lib/rao/service/version.rb
@@ -231,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.24
+rubygems_version: 3.4.20
 signing_key: 
 specification_version: 4
 summary: Services for Ruby on Rails.