tramway-mailout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15bec9d36e4eda7dd77e9a3d7aa8866ef9774d89cf86166b5d33971344c0161e
+  data.tar.gz: 79b27fe49ab81bf845a88a10aa0617c660fecc9b70d8c53ff8949fc0e59dd90e
+SHA512:
+  metadata.gz: 45122b076125a1224e82226fc3ae6669b38617904456562cda6819c0211a27e3856c871fb18d388f8bccd61cfd84caa7d46970daf404e45c4ce21cf2aa6083e4
+  data.tar.gz: 49cb42cc4a99f2e028cf2afd653ca3077f0f8eacb8d5ff57e1392d63c4bf5b7e84ac2a29f0f4efa0a80aec7f80c7af080b696a7321ef5823a002034992c2eeb1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Pavel Kalashnikov
+
+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 @@
+# Tramway::Mailout
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tramway-mailout'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install tramway-mailout
+```
+
+## 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,36 @@
+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    = 'Tramway::Mailout'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+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

data/app/assets/config/tramway_mailout_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/tramway/mailout .js
+//= link_directory ../stylesheets/tramway/mailout .css

data/app/assets/javascripts/tramway/mailout/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/tramway/mailout/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/channels/tramway/mailout/application_cable/channel.rb

@@ -0,0 +1,2 @@
+class Tramway::Mailout::ApplicationCable::Channel < ActionCable::Channel::Base
+end

data/app/channels/tramway/mailout/application_cable/connection.rb

@@ -0,0 +1,2 @@
+class Tramway::Mailout::ApplicationCable::Connection < ActionCable::Connection::Base
+end

data/app/controllers/tramway/mailout/application_controller.rb

@@ -0,0 +1,7 @@
+module Tramway
+  module Mailout
+    class ApplicationController < ActionController::Base
+      protect_from_forgery with: :exception
+    end
+  end
+end

data/app/forms/tramway/mailout/session_form.rb

@@ -0,0 +1,3 @@
+class Tramway::Mailout::SessionForm < ::Tramway::Core::ApplicationForm
+  properties :campaign_id, :campaign_type, :mailing_state, :mailing_state_event
+end

data/app/helpers/tramway/mailout/application_helper.rb

@@ -0,0 +1,6 @@
+module Tramway
+  module Mailout
+    module ApplicationHelper
+    end
+  end
+end

data/app/jobs/tramway/mailout/application_job.rb

@@ -0,0 +1,6 @@
+module Tramway
+  module Mailout
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/jobs/tramway/mailout/mailing_job.rb

@@ -0,0 +1,12 @@
+class Tramway::Mailout::MailingJob < ActiveJob::Base
+  queue_as :default
+
+  def perform(contacts, template, mailer, &block)
+    contacts.each_slice(100) do |combination|
+      combination.each do |contact|
+        mailer.constantize.delay.send :just_message, contact.email, template.title, template.body
+        yield if block_given?
+      end
+    end
+  end
+end

data/app/mailers/tramway/mailout/application_mailer.rb

@@ -0,0 +1,10 @@
+module Tramway
+  module Mailout
+    class ApplicationMailer < ActionMailer::Base
+      def just_message(email, title, body)
+        @body = body
+        mail from: sender_name, to: email, subject: title
+      end
+    end
+  end
+end

data/app/models/tramway/mailout/session.rb

@@ -0,0 +1,42 @@
+require 'tramway/mailout/job_proxy'
+
+module Tramway::Mailout
+  class Session < ::Tramway::Core::ApplicationRecord
+    belongs_to :campaign, polymorphic: true
+
+    state_machine :mailing_state, initial: :ready, namespace: :mailing do
+      state :during
+      state :completed
+      state :aborted
+
+      event :start do
+        transition ready: :during
+      end
+
+      event :repeat do
+        transition completed: :ready
+      end
+
+      event :abort do
+        transition during: :aborted
+      end
+
+      event :continue do
+        transition aborted: :during
+      end
+
+      after_transition ready: :during do
+      end
+
+      after_transition aborted: :during do |session|
+        ::Tramway::Mailout::JobProxy.perform_job ::Tramway::Mailout::MailingJob,
+          :later,
+          session.campaign.contacts,
+          session.campaign.strategy.touches.first.mail_template,
+          ::Tramway::Mailout::ApplicationMailer
+      end
+    end
+
+    scope :during, -> { active.where mailing_state: :during }
+  end
+end

data/config/locales/state_machines.yml

@@ -0,0 +1,15 @@
+ru:
+  activerecord:
+    state_machines:
+      tramway/mailout/session:
+        mailing_state:
+          states:
+            ready: Готово к рассылке
+            during: В процессе рассылки
+            completed: Рассылка окончена
+            aborted: Рассылка прервана
+          events:
+            start: Начать рассылку
+            repeat: Повторить рассылку
+            abort: Прервать рассылку
+            continue: Продолжить рассылку

data/config/routes.rb

@@ -0,0 +1,2 @@
+Tramway::Mailout::Engine.routes.draw do
+end

data/lib/tasks/tramway/mailout_tasks.rake

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

data/lib/tramway/mailout/engine.rb

@@ -0,0 +1,10 @@
+require 'sidekiq'
+
+module Tramway
+  module Mailout
+    class Engine < ::Rails::Engine
+      isolate_namespace Tramway::Mailout
+      ::Sidekiq::Extensions.enable_delay!
+    end
+  end
+end

data/lib/tramway/mailout/generates/install_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+require 'tramway/core/generators/install_generator'
+
+module Tramway::Mailout::Generators
+  class InstallGenerator < ::Tramway::Core::Generators::InstallGenerator
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+
+    def run_other_generators
+      generate 'tramway:core:install'
+    end
+
+    def self.next_migration_number(path)
+      next_migration_number = current_migration_number(path) + 1
+      ActiveRecord::Migration.next_migration_number next_migration_number
+    end
+
+    def copy_migrations
+      migration_template 'create_tramway_mailout_sessions.rb', 'db/migrate/create_tramway_mailout_sessions.rb'
+    end
+  end
+end

data/lib/tramway/mailout/generates/templates/create_tramway_mailout_sessions.rb

@@ -0,0 +1,12 @@
+class CreateTramwayMailoutSessions < ActiveRecord::Migration[5.1]
+  def change
+    create_table :tramway_mailout_sessions do |t|
+      t.integer :campaign_id
+      t.text :state
+      t.text :mailing_state, default: :ready
+      t.text :campaign_type
+
+      t.timestamps
+    end
+  end
+end

data/lib/tramway/mailout/job_proxy.rb

@@ -0,0 +1,19 @@
+module Tramway::Mailout::JobProxy
+  class << self
+    def perform_job(job_class, mode, *args)
+      job_class.send "perform_#{mode}", *args.map { |a| convert a }
+    end
+
+    private
+
+    def convert(object)
+      if object.class.to_s.include? 'ActiveRecord_Associations_CollectionProxy'
+        object.to_a
+      elsif object.class == Class
+        object.to_s
+      else
+        object
+      end
+    end
+  end
+end

data/lib/tramway/mailout/version.rb

@@ -0,0 +1,5 @@
+module Tramway
+  module Mailout
+    VERSION = '0.1.0'
+  end
+end

data/lib/tramway/mailout.rb

@@ -0,0 +1,9 @@
+require "tramway/mailout/engine"
+require 'tramway/mailout/generates/install_generator'
+require 'tramway/mailout/job_proxy'
+
+module Tramway
+  module Mailout
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: tramway-mailout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavel Kalashnikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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'
+description: Rails Engine for your mailouts
+email:
+- kalashnikovisme@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/tramway_mailout_manifest.js
+- app/assets/javascripts/tramway/mailout/application.js
+- app/assets/stylesheets/tramway/mailout/application.css
+- app/channels/tramway/mailout/application_cable/channel.rb
+- app/channels/tramway/mailout/application_cable/connection.rb
+- app/controllers/tramway/mailout/application_controller.rb
+- app/forms/tramway/mailout/session_form.rb
+- app/helpers/tramway/mailout/application_helper.rb
+- app/jobs/tramway/mailout/application_job.rb
+- app/jobs/tramway/mailout/mailing_job.rb
+- app/mailers/tramway/mailout/application_mailer.rb
+- app/models/tramway/mailout/session.rb
+- config/locales/state_machines.yml
+- config/routes.rb
+- lib/tasks/tramway/mailout_tasks.rake
+- lib/tramway/mailout.rb
+- lib/tramway/mailout/engine.rb
+- lib/tramway/mailout/generates/install_generator.rb
+- lib/tramway/mailout/generates/templates/create_tramway_mailout_sessions.rb
+- lib/tramway/mailout/job_proxy.rb
+- lib/tramway/mailout/version.rb
+homepage: https://github.com/kalashnikovisme/tramway-mailout
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Rails Engine for your mailouts
+test_files: []