aservice 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79bff4730e2fb2c8fa887a439ea31957acc798528dd751d0b2ef129f424dd004
+  data.tar.gz: 340923d749844cfdb527b4935856b58761544da946af1c478e0635b9d0a372ef
+SHA512:
+  metadata.gz: 58514c9c2ebf6b153c4657a8fb00625fc27ee3570b326acbe773b511a73a731acae4af277995b65cb93723d00dc12ef104c908dd9dcbede078c2fa98a996b457
+  data.tar.gz: e8706e954ba0be5e5dfdca059d6b3996224c43e8a2bf474c58a1854b33d78481b0116f5636adb28132267d4ece6d1b7ee8aae809449eac73cc12c9f3cd40816b

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle/
+/Gemfile.lock
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+/examples/config.ru

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,39 @@
+ 
+AllCops:
+  TargetRubyVersion: 2.5
+  Include:
+    - "lib/**/*.rb"
+    - "spec/**/*.rb"
+  Exclude:
+    - "bin/**/*"
+    - "examples/*"
+    - "spec/support/*"
+    - "Gemfile"
+    - "Rakefile"
+    - "*.gemspec"
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+
+Style/MethodMissingSuper:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - "spec/**/*.rb"
+
+Style/BlockDelimiters:
+  Exclude:
+    - "spec/**/*.rb"
+
+Metrics/MethodLength:
+  Exclude:
+    - "spec/**/*.rb"
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - "spec/**/*.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,7 @@
+Aservice gem allow you to execute your services in background as a sidekiq jod.
+
+Include Aservice into your class and [method_name]_async and [method_name]_after will be available.
+
+[method_name]_async call method in sidekiq background job.
+And [method_name]_after accepts sidekiq job as a first argument and would call method only when job will be successfully completed.
+Check examples folder for example

data/aservice.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name        = 'aservice'
+  s.version     = '0.0.2'
+  s.date        = '2020-07-07'
+  s.summary     = 'Aservice'
+  s.description = 'Gem for running services asynchroniously'
+  s.authors     = ['Aleksandr Korotkikh']
+  s.email       = 'koralvas@gmail.com'
+  s.homepage    =
+    'https://github.com/SanderMander/aservice'
+  s.license       = 'MIT'
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(spec|examples)/})
+  end
+  s.require_paths = ['lib']
+  s.add_development_dependency 'bundler', '~> 2'
+  s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'rake', '>= 12.3.3'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rubocop'
+  s.add_dependency 'anyway_config', '>= 2.0.0'
+  s.add_dependency('sidekiq', ['>= 4.2.1'])
+  s.add_dependency('sidekiq-status', ['>= 1.1.4'])
+end

data/lib/aservice.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'sidekiq'
+require 'sidekiq-status'
+require 'anyway_config'
+require_relative 'aservice/config.rb'
+require_relative 'aservice/worker/worker.rb'
+require_relative 'aservice/worker/aservice_worker.rb'
+require_relative 'aservice/callback.rb'
+require_relative 'sidekiq/middleware/callback_middleware.rb'
+
+# Main mixin which provide Asynchronious service call
+module Aservice
+  def self.included(base)
+    base.class_eval do
+      extend ClassMethods
+    end
+  end
+
+  # Class methods for service.
+  module ClassMethods
+    def call_async(*args)
+      perform(:async, 'call', args)
+    end
+
+    def call_after(jid, *args)
+      args = [] if args.nil?
+      perform(:after, 'call', args.unshift(jid))
+    end
+
+    def respond_to_missing?(method, _)
+      return false if method =~ /_(async|after)$/
+    end
+
+    def method_missing(method, *args)
+      method = method.to_s
+      if method =~ /_async$/
+        method = method.sub(/.*\K_async/, '')
+        perform(:async, method, args)
+      elsif method =~ /_after$/
+        method = method.sub(/.*\K_after/, '')
+        perform(:after, method, args)
+      else
+        raise_no_method_error("No method: #{method} for class: #{AserviceWorker.name}")
+      end
+    end
+
+    private
+
+    def perform(type, method, args)
+      worker = AserviceWorker.set(queue: Aservice::Config.queue)
+      raise_no_method_error("No method: #{method} for class: #{name}") unless respond_to?(method.to_sym)
+      return worker.perform_async(name, method, *args) if type == :async
+
+      jid = args.shift
+      if Sidekiq::Status.complete?(jid)
+        worker.perform_async(name, method, *args)
+      else
+        worker.perform_after(jid, name, method, *args)
+      end
+    end
+
+    def raise_no_method_error(msg)
+      raise NoMethodError, msg
+    end
+  end
+end

data/lib/aservice/callback.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Aservice
+  # Sidekiq job callbacks
+  class Callback
+    class << self
+      def add(jid, class_name, method, args)
+        opt = {
+          'class' => class_name,
+          'method' => method,
+          'args' => args
+        }
+        Sidekiq.redis do |conn|
+          conn.multi do
+            conn.rpush(key(jid), opt.to_json)
+            conn.expire(key(jid), Aservice::Config.callbacks_expiration)
+          end
+        end
+      end
+
+      def success(job)
+        while (opt = pop_next(job['jid']))
+          execute_service(opt['class'], opt['method'], opt['args'])
+        end
+      end
+
+      def failure(job)
+        clear_stack(job['jid'])
+      end
+
+      private
+
+      def execute_service(class_name, method, args)
+        Kernel.const_get(class_name).send(method, *args)
+      end
+
+      def pop_next(jid)
+        opt = Sidekiq.redis do |conn|
+          conn.lpop(key(jid))
+        end
+        return false if opt.nil?
+
+        JSON.parse(opt)
+      end
+
+      def clear_stack(jid)
+        Sidekiq.redis do |conn|
+          conn.del(key(jid))
+        end
+      end
+
+      def key(jid)
+        "#{Aservice::Config.redis_prefix}_#{jid}"
+      end
+    end
+  end
+end

data/lib/aservice/config.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Aservice
+  # anyway config wrapper
+  class Config < Anyway::Config
+    config_name :aservice
+
+    attr_config logger: Logger.new($stdout),
+                severity: Logger::Severity::DEBUG,
+                queue: 'default',
+                status_expiration: 60 * 30,
+                redis_prefix: 'AC',
+                callbacks_expiration: 60 * 30
+    def self.instance
+      @config ||= new
+      yield @config if block_given?
+      @config
+    end
+
+    def self.respond_to_missing?(_name, _)
+      instance.respond_to?(method)
+    end
+
+    def self.method_missing(method)
+      instance.send(method)
+    end
+  end
+end

data/lib/aservice/worker/aservice_worker.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# sidekiq worker which run services in background
+class AserviceWorker
+  include Aservice::Worker
+
+  def perform(class_name, method_name, *args)
+    Kernel.const_get(class_name).__send__(method_name, *args)
+  end
+end

data/lib/aservice/worker/worker.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Aservice
+  # Mixin which define perform_after method
+  module Worker
+    def self.included(base)
+      base.include Sidekiq::Worker
+      base.include Sidekiq::Status::Worker
+      Sidekiq::Worker::Setter.class_eval do
+        def perform_after(jid, class_name, method, *args)
+          Aservice::Callback.add(jid, class_name, method, args)
+        end
+      end
+
+      def expiration
+        Aservice::Config.status_expiration
+      end
+    end
+  end
+end

data/lib/sidekiq/middleware/callback_middleware.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  module Middleware
+    # Middleware which executes callbacks
+    class CallbackMiddleware
+      def call(_worker_class, job, _queue)
+        yield
+        Aservice::Callback.success(job)
+      rescue StandardError => e
+        Aservice::Callback.failure(job)
+        raise e
+      end
+    end
+  end
+end
+
+Sidekiq.configure_client do |config|
+  Sidekiq::Status.configure_client_middleware config
+end
+
+Sidekiq.configure_server do |config|
+  Sidekiq::Status.configure_server_middleware config
+  Sidekiq::Status.configure_client_middleware config
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Middleware::CallbackMiddleware
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: aservice
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Aleksandr Korotkikh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: anyway_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: sidekiq-status
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+description: Gem for running services asynchroniously
+email: koralvas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- aservice.gemspec
+- lib/aservice.rb
+- lib/aservice/callback.rb
+- lib/aservice/config.rb
+- lib/aservice/worker/aservice_worker.rb
+- lib/aservice/worker/worker.rb
+- lib/sidekiq/middleware/callback_middleware.rb
+homepage: https://github.com/SanderMander/aservice
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Aservice
+test_files: []