activecrew 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a45d0ac6c7ba04c2eee3d07464b4a33eb8929527
+  data.tar.gz: d451a7a7ada0b52d1cab74db53f5545f0b48f1bc
+SHA512:
+  metadata.gz: fdea905f162d86ff05391ed80582cbfaa5c092f2a2741847a65f0dc73273d63bfb61f987f614cba8b43d0466374ec0ebbffe09ea56d0939723a29669bcf51af7
+  data.tar.gz: 487f78c9e5cc76199a3f0841ad956f4c38aaa7170cc2a6cda9aed1e0dc6ccbd656e66dcd437afe897ab71201fa3e1b45c7f57c6f4c215ab9c8dedf983ffac01c

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activecommand.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Max Kazarin
+
+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,41 @@
+# ActiveCrew
+
+[![Gem Version](https://badge.fury.io/rb/activecrew.svg)](https://badge.fury.io/rb/activecrew)
+[![Code Climate](https://codeclimate.com/github/maxkazar/activecrew/badges/gpa.svg)](https://codeclimate.com/github/maxkazar/activecrew)
+[![Build Status](https://travis-ci.org/maxkazar/activecrew.svg)](https://travis-ci.org/maxkazar/activecrew)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activecrew'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activecrew
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/maxkazar/activecrew.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activecrew.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_crew/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activecrew'
+  spec.version       = ActiveCrew::VERSION
+  spec.authors       = ['Max Kazarin']
+  spec.email         = ['maxkazargm@gmail.com']
+
+  spec.summary       = %q{Steroid command pattern.}
+  spec.description   = %q{Steroid command pattern.}
+  spec.homepage      = 'https://github.com/maxkazar/activecrew'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'actionpack', '~> 4.0'
+
+  spec.add_dependency 'activesupport', '~> 4.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activecrew"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_crew.rb

@@ -0,0 +1,46 @@
+require 'rubygems'
+
+require 'active_support/all'
+require 'active_crew/version'
+require 'active_crew/configuration'
+require 'active_crew/concerns/authorizable'
+require 'active_crew/concerns/chainable'
+require 'active_crew/concerns/commandable'
+require 'active_crew/concerns/combinable'
+require 'active_crew/concerns/respondable'
+require 'active_crew/concerns/measurable'
+require 'active_crew/concerns/validatable'
+require 'active_crew/base'
+require 'active_crew/backends'
+require 'active_crew/responders'
+
+require 'active_crew/extender' if defined? ActionController
+
+module ActiveCrew
+  class << self
+    # Getter for shared global objects
+    attr_reader :configuration
+
+    # Returns the global [Configuration](ActiveCrew/Configuration) object.
+    #
+    # @example
+    #     ActiveCrew.configuration.responder = :pusher
+    def configuration
+      @configuration ||= ActiveCrew::Configuration.new
+    end
+
+    # Yields the global configuration to a block.
+    # @yield [Configuration] global configuration
+    #
+    # @example
+    #     ActiveCrew.configure do |config|
+    #       config.responder = :fayer
+    #     end
+    def configure
+      yield configuration if block_given?
+
+      Backends.create
+      Responders.create
+    end
+  end
+end

data/lib/active_crew/backends.rb

@@ -0,0 +1,45 @@
+module ActiveCrew
+  module Backends
+    autoload :InlineBackend, 'active_crew/backends/inline_backend'
+    autoload :SidekiqBackend, 'active_crew/backends/sidekiq_backend'
+
+    class << self
+      attr_reader :default
+
+      def create
+        @default = "ActiveCrew::Backends::#{backend.to_s.classify}Backend".constantize
+      rescue NameError
+        raise ArgumentError, "Unsupported backend #{backend} for active command."
+      end
+
+      def enqueue(name, invoker, *args)
+        default.enqueue name, serialize(invoker), *args
+      end
+
+      def dequeue(name, invoker, *args)
+        command = create_command name, deserialize(invoker), *args
+        command.execute if command.can_execute?
+      end
+
+      private
+
+      def backend
+        ActiveCrew.configuration.backend
+      end
+
+      def serialize(invoker)
+        [invoker.class.name, invoker.id.to_s]
+      end
+
+      def deserialize(invoker)
+        invoker[0].constantize.find invoker[1]
+      end
+
+      def create_command(name, invoker, *args)
+        "#{name.classify}Command".constantize.new invoker, *args
+      rescue NameError
+        raise ArgumentError, "Unsupported command #{name} for active command."
+      end
+    end
+  end
+end

data/lib/active_crew/backends/inline_backend.rb

@@ -0,0 +1,19 @@
+module ActiveCrew
+  module Backends
+    class InlineBackend
+      class Queue
+        def size
+          0
+        end
+      end
+
+      def self.enqueue(*args)
+        ActiveCrew::Backends.dequeue *args
+      end
+
+      def self.queue(command_name)
+        Queue.new
+      end
+    end
+  end
+end

data/lib/active_crew/backends/sidekiq_backend.rb

@@ -0,0 +1,27 @@
+module ActiveCrew
+  module Backends
+    class SidekiqBackend
+      include Sidekiq::Worker
+
+      class << self
+        def enqueue(*args)
+          Sidekiq::Client.push 'class' => self,
+                               'queue' => queue_name(args.first),
+                               'args' => args
+        end
+
+        def queue_name(command_name)
+          command_name[/^(.*)\/[^\/]*$/, 1].underscore.gsub(/\//, '_')
+        end
+
+        def queue(command_name)
+          Sidekiq::Queue.new queue_name command_name
+        end
+      end
+
+      def perform(*args)
+        ActiveCrew::Backends.dequeue *args
+      end
+    end
+  end
+end

data/lib/active_crew/base.rb

@@ -0,0 +1,50 @@
+module ActiveCrew
+
+  # Sidekiq Command class. Implements command pattern for Sidekiq.
+  # Helps to deconstruct application into micro services with command interface.
+  #
+  # Command class file structure with two micro services (mailer and users):
+  #
+  #     app
+  #       commands
+  #         mailer
+  #           deliver_command.rb
+  #         users
+  #           create_command.rb
+  #
+  # Command queues will be the following:
+  #
+  #     mailer
+  #     users
+  #
+  class Base
+    prepend Chainable
+    prepend Combinable
+    prepend Validatable
+    prepend Measurable
+    prepend Respondable
+    prepend Authorizable
+
+    include Commandable
+
+    attr_reader :invoker, :options, :context
+
+    def initialize(invoker, context = {})
+      @invoker = invoker
+      # Should only symbolize key for
+      @context = ActiveSupport::HashWithIndifferentAccess.new context
+      @options = @context[:options] || {}
+    end
+
+    def name
+      @name ||= self.class.name.underscore.gsub(/_command/, '')
+    end
+
+    def execute
+      perform
+    end
+
+    def perform
+    end
+  end
+end

data/lib/active_crew/concerns/authorizable.rb

@@ -0,0 +1,17 @@
+module ActiveCrew
+  class AuthorizationError < Exception; end
+
+  module Authorizable
+    extend ActiveSupport::Concern
+
+    def execute
+      raise AuthorizationError unless can_execute?
+
+      super
+    end
+
+    def can_execute?
+      invoker.can? name, options
+    end
+  end
+end

data/lib/active_crew/concerns/chainable.rb

@@ -0,0 +1,35 @@
+module ActiveCrew
+  module Chainable
+    def chain
+      @chain ||= @context[:chain] || []
+    end
+
+    def commands(*args)
+      options = args.extract_options!
+      add_to_chain args
+      execute_chain options
+    end
+
+    def execute
+      super
+      execute_chain
+    end
+
+    private
+
+    def add_to_chain(commands)
+      chain.concat commands
+    end
+
+    def execute_chain(options = nil)
+      return unless chain.present?
+
+      name = chain.shift
+      if name.is_a? Array
+        name.each { |name| command name, options }
+      else
+        command name, options, chain: chain
+      end
+    end
+  end
+end

data/lib/active_crew/concerns/combinable.rb

@@ -0,0 +1,27 @@
+module ActiveCrew
+  # Combinable behavior helps to combine command executions into one command execution
+  module Combinable
+    def execute
+      super
+      execute_combine_commands
+    end
+
+    def combine_command(name, options = {})
+      combine_command_options = combine_commands[name] ||= {}
+      options.each do |key, value|
+        combine_command_value = combine_command_options[key] ||= []
+        combine_command_value << value unless combine_command_value.include? value
+      end
+    end
+
+    def combine_commands
+      @combine_commands ||= {}
+    end
+
+    private
+
+    def execute_combine_commands
+      combine_commands.each { |name, options| command name, options }
+    end
+  end
+end

data/lib/active_crew/concerns/commandable.rb

@@ -0,0 +1,11 @@
+module ActiveCrew
+  module Commandable
+    def command(name, options = {}, context = {})
+      Backends.enqueue name, invoker, @context.merge(options: options).merge(context)
+    end
+
+    def backend
+      Backends.default
+    end
+  end
+end

data/lib/active_crew/concerns/measurable.rb

@@ -0,0 +1,30 @@
+module ActiveCrew
+  class MeasurerError < Exception; end
+
+  module Measurable
+    extend ActiveSupport::Concern
+
+    private
+
+    def execute
+      started_at = Time.current
+
+      super
+
+      measurer.measure self, Time.current - started_at if measurer
+    end
+
+    def has_measurer?
+      measurer.present?
+    end
+
+    def measurer
+      return @measurer if defined? @measurer
+
+      measurer_name = ActiveCrew.configuration.measurer
+      @measurer = measurer_name && measurer_name.to_s.classify.constantize
+    rescue NameError
+      raise MeasurerError, "Unsupported measurer #{measurer_name} for active command."
+    end
+  end
+end

data/lib/active_crew/concerns/respondable.rb

@@ -0,0 +1,21 @@
+module ActiveCrew
+  class CommandError < Exception; end
+
+  module Respondable
+    def respond_with(model)
+      Responders.respond_with name, invoker, context, model
+    end
+
+    def respond_fail(*args)
+      fail CommandError, I18n.t(*args)
+    end
+
+    def execute
+      super
+    rescue Interrupt
+      raise
+    rescue CommandError
+      respond_with $ERROR_INFO
+    end
+  end
+end

data/lib/active_crew/concerns/validatable.rb

@@ -0,0 +1,15 @@
+module ActiveCrew
+  module Validatable
+    extend ActiveSupport::Concern
+
+    def validate!
+
+    end
+
+    def execute
+      validate!
+
+      super
+    end
+  end
+end

data/lib/active_crew/configuration.rb

@@ -0,0 +1,10 @@
+module ActiveCrew
+  class Configuration
+    attr_accessor :responder, :backend, :measurer
+
+    def initialize
+      @responder = :inline
+      @backend = :inline
+    end
+  end
+end

data/lib/active_crew/extender.rb

@@ -0,0 +1,12 @@
+module ActiveCrew
+  module Extender
+    def command(name, options)
+      context = { options: options }
+
+      ActiveCrew::Responders.init context, request
+      ActiveCrew::Backends.enqueue name, current_user, context
+    end
+  end
+end
+
+ActionController::Base.include ActiveCrew::Extender

data/lib/active_crew/responders.rb

@@ -0,0 +1,30 @@
+module ActiveCrew
+  module Responders
+    autoload :InlineResponder, 'active_crew/responders/inline_responder'
+    autoload :FayeResponder, 'active_crew/responders/faye_responder'
+
+    class << self
+      attr_reader :default
+
+      def create
+        @default = "ActiveCrew::Responders::#{responder.to_s.classify}Responder".constantize
+      rescue NameError
+        raise ArgumentError, "Unsupported responder #{responder} for active command."
+      end
+
+      def init(context, request)
+        default.init(context, request) if default.respond_to? :init 
+      end
+
+      def respond_with(name, invoker, context, model)
+        default.respond name, invoker, context, model
+      end
+
+      private
+
+      def responder
+        ActiveCrew.configuration.responder
+      end
+    end
+  end
+end

data/lib/active_crew/responders/faye_responder.rb

@@ -0,0 +1,109 @@
+module ActiveCrew
+  module Responders
+    # FayeResponderError class.
+    class FayeResponderError < Exception; end
+
+    # FayeConnectionError class.
+    class FayeConnectionError < Exception; end
+
+    # ActiveCrew Faye responder.
+    module FayeResponder
+      module_function
+
+      MAX_RETRIES = 5
+
+      def init(context, request)
+        context[:session] = request.headers['x-session-token']
+      end
+
+      # Respond with faye
+      def respond(name, invoker, context, model)
+        request channel: channel(invoker),
+                data: payload(name, invoker, context, model),
+                ext: { publish_key: config[:publish_key] }
+      end
+
+      def request(message)
+        retries = 0
+
+        begin
+          validate RestClient.post url, message.to_json, header
+        rescue FayeResponderError
+          retries += 1
+          raise FayeConnectionError $ERROR_INFO unless retries < MAX_RETRIES
+
+          retry
+        rescue FayeConnectionError
+          Rails.logger.fatal $ERROR_INFO.message
+        end
+      end
+
+      # @return Invoker channel name
+      def channel(invoker)
+        "/#{invoker.class.to_s.underscore}/#{invoker.id}"
+      end
+
+      # @return Faye request payload
+      def payload(name, invoker, context, model)
+        {
+          invoker: serialize_invoker(invoker),
+          session: context[:session],
+          command: name,
+          status: status(model),
+          response: serialize(model)
+        }
+      end
+
+      def serialize_invoker(invoker)
+        serialize invoker, serializer: "#{invoker.class}::InvokerSerializer".constantize
+      end
+
+      # Serialize payload
+      def serialize(model, options = {})
+        return { base: model.message } if model.is_a? CommandError
+
+        if model.is_a?(Array) || model.errors.empty?
+          ActiveModelSerializers::SerializableResource.new(model, options).serializable_hash
+        else
+          ActiveModelSerializers::SerializableResource.new(model.errors, options.merge(root: 'errors')).serializable_hash[:errors]
+        end
+      end
+
+      def status(model)
+        model.is_a?(Array) || !model.is_a?(CommandError) && model.valid? ? :success : :failure
+      end
+
+      # @return Faye request header
+      def header
+        {
+          'Content-Type' => 'application/json',
+          'Pragma' => 'no-cache',
+          'X-Requested-With' => 'XMLHttpRequest'
+        }
+      end
+
+      # Validate faye response
+      def validate(response)
+        fail FayeResponderError, response.code unless response.code == 200
+
+        response = JSON.parse(response)[0].symbolize_keys
+        fail FayeResponderError, response[:error] unless response[:successful]
+      end
+
+      def url
+        "http://#{config[:host]}/faye"
+      end
+
+      def config
+        return @config if defined? @config
+
+        @config = YAML.load(ERB.new(File.new(config_path).read).result)[Rails.env]
+        @config = (@config || {}).symbolize_keys
+      end
+
+      def config_path
+        File.join(Rails.root, 'config', 'faye.yml')
+      end
+    end
+  end
+end

data/lib/active_crew/responders/inline_responder.rb

@@ -0,0 +1,9 @@
+module ActiveCrew
+  module Responders
+    module InlineResponder
+      def self.respond(*, model)
+        model
+      end
+    end
+  end
+end

data/lib/active_crew/version.rb

@@ -0,0 +1,3 @@
+module ActiveCrew
+  VERSION = '0.1.4'
+end

data/lib/activecrew.rb

@@ -0,0 +1 @@
+require 'active_crew'

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: activecrew
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Max Kazarin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Steroid command pattern.
+email:
+- maxkazargm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activecrew.gemspec
+- bin/console
+- bin/setup
+- lib/active_crew.rb
+- lib/active_crew/backends.rb
+- lib/active_crew/backends/inline_backend.rb
+- lib/active_crew/backends/sidekiq_backend.rb
+- lib/active_crew/base.rb
+- lib/active_crew/concerns/authorizable.rb
+- lib/active_crew/concerns/chainable.rb
+- lib/active_crew/concerns/combinable.rb
+- lib/active_crew/concerns/commandable.rb
+- lib/active_crew/concerns/measurable.rb
+- lib/active_crew/concerns/respondable.rb
+- lib/active_crew/concerns/validatable.rb
+- lib/active_crew/configuration.rb
+- lib/active_crew/extender.rb
+- lib/active_crew/responders.rb
+- lib/active_crew/responders/faye_responder.rb
+- lib/active_crew/responders/inline_responder.rb
+- lib/active_crew/version.rb
+- lib/activecrew.rb
+homepage: https://github.com/maxkazar/activecrew
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Steroid command pattern.
+test_files: []