action_message_texter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0b1e9948866086af99648cfa73f11aa1d005511665b2994498ec9d5c4712ae6
+  data.tar.gz: daf2f869aadbaf8c0b88d60993e08bcb7d8054cb614453e15f8f1dad6725096d
+SHA512:
+  metadata.gz: f1578f69ee484d7b6b8744724320b0a7a5a80582056ced7317dd14d4e0c77d97bbade833dfb014f693d4f05728f7edcd3a86735ba20f78150b93a3d461e073b7
+  data.tar.gz: 526a2b6307bab0833b18b9978eae1fff1b571cb779992180ed773396a9ec42a67efb7ad1c406870ee8d590677d91614ae5c6967bbeb75be3a8d2e82b60872147

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Arthur Li
+
+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,39 @@
+# ActionMessageTexter
+
+仿造Rails ActionMailer 打造的簡訊寄送模組，提供與Mailer一致的開發體驗
+
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_message_texter'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install action_message_texter
+```
+
+## Usage
+
+### Texter Generator 
+This generator will generate Texter at `app/texter`
+```bash
+rails g action_message_texter:texter Devise sign_up_succeed
+```
+
+### Texter
+
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'ActionMessageTexter'
+  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', __dir__)
+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/lib/action_message_texter/base.rb

@@ -0,0 +1,127 @@
+module ActionMessageTexter
+  class Base < AbstractController::Base
+    include Rescuable
+    include DeliveryMethods
+
+    include AbstractController::Logger
+    include AbstractController::Translation
+    include AbstractController::Callbacks
+    include AbstractController::Caching
+
+    # configure
+    class_attribute :default_params, default: {
+      to: nil, # who the message is destined for
+      deliver_at: nil # who to say the message send on
+    }
+
+    class << self
+      def default(value)
+        self.default_params = default_params.merge(value).freeze if value
+        default_params
+      end
+
+      # set default params by configuration
+      alias default_options= default
+
+      def texter_name
+        @texter_name ||= anonymous? ? 'anonymous' : name.underscore
+      end
+      attr_writer :texter_name
+
+      def deliver_message(message)
+        # Notification
+        ActiveSupport::Notifications.instrument('deliver.action_message_texter') do |payload|
+          payload[:content] = message.content
+          payload[:to] = message.to
+          payload[:deliver_at] = message.deliver_at || Time.now
+          payload[:texter] = name
+          yield # Let Message do the delivery actions
+        end
+      end
+
+      private
+
+      # connect to MessageDelivery through method_missing
+      def method_missing(method_name, *args)
+        if action_methods.include?(method_name.to_s)
+          ActionMessageTexter::MessageDelivery.new(self, method_name, *args)
+        else
+          super
+        end
+      end
+    end
+
+    attr_internal :message
+
+    def initialize
+      super()
+      @_message_was_called = false
+      @_message = Message.new
+    end
+
+    def process(method_name, *args)
+      payload = {
+        messenger: self.class.name,
+        action: method_name,
+        args: args
+      }
+
+      # Notification
+      ActiveSupport::Notifications.instrument('process.action_message_texter', payload) do
+        super
+        @_message = NullMessage.new unless @_message_was_called
+      end
+    end
+
+    class NullMessage
+    end
+
+    # return Message instance
+    def sms(headers = {})
+      puts headers
+      @_message_was_called = true
+
+      headers = self.class.default_params.merge(headers)
+
+      message.content = render_content(headers)
+
+      message.to = recipient(headers)
+
+      message.deliver_at = headers.delete(:at)
+
+      message.other_options = headers
+
+      # TODO: set provider dynamic
+      wrap_delivery_behavior!(:base)
+
+      message
+    end
+
+    private
+
+    def render_content(headers)
+      content = headers.delete(:content) || default_i18n_context(instance_values.reject do |key, _value|
+                                                                   key.start_with?('_')
+                                                                 end)
+      unless content.present?
+        raise 'Message content cannot be nil, add content to sms method, or add I18n to generated message content'
+      end
+
+      content
+    end
+
+    def recipient(headers)
+      recipient = headers.delete(:to)
+      raise 'Message should has at least one recipient' unless recipient.present?
+
+      recipient
+    end
+
+    def default_i18n_context(interpolations = {})
+      texter_scope = self.class.texter_name.tr('/', '.')
+      I18n.t(action_name, **interpolations.symbolize_keys.merge(scope: [texter_scope]), default: nil)
+    end
+
+    ActiveSupport.run_load_hooks(:action_message_texter, self)
+  end
+end

data/lib/action_message_texter/delivery_job.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'active_job'
+
+module ActionMessageTexter
+  class DeliveryJob < ActiveJob::Base
+    queue_as { ActionMailer::Base.deliver_later_queue_name }
+
+    rescue_from StandardError, with: :handle_exception_with_texter_class
+
+    def perform(_texter, sms_method, delivery_method, *args)
+      texter_class.public_send(sms_method, *args).send(delivery_method)
+    end
+
+    private
+
+    def texter_class
+      if texter = Array(@serialized_arguments).first || Array(arguments).first
+        texter.constantize
+      end
+    end
+
+    def handle_exception_with_texter_class(exception)
+      if klass = texter_class
+        klass.handle_exception exception
+      else
+        raise exception
+      end
+    end
+  end
+end

data/lib/action_message_texter/delivery_methods.rb

@@ -0,0 +1,45 @@
+module ActionMessageTexter
+  module DeliveryMethods
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :raise_delivery_errors, default: true
+      cattr_accessor :deliver_later_queue_name, default: :texters
+
+      class_attribute :delivery_methods, default: {}.freeze
+      class_attribute :delivery_method, default: :base
+
+      add_delivery_method(:base, SMSProvider::Base)
+    end
+
+    module ClassMethods
+      def add_delivery_method(symbol, klass, options = {})
+        class_attribute("#{symbol}_settings".to_sym) unless respond_to?("#{symbol}_settings".to_sym)
+        send("#{symbol}_settings=".to_sym, options)
+        self.delivery_methods = delivery_methods.merge(symbol.to_sym => klass).freeze
+      end
+
+      def wrap_delivery_behavior(message, method = nil, options = {})
+        method ||= delivery_method
+        message.delivery_handler = self
+        case method
+        when NilClass
+          raise 'Delivery method cannot be nil'
+        when Symbol
+          if klass = delivery_methods[method]
+            message.delivery_method(klass, (send("#{method}_settings") || {}).merge(options))
+          else
+            raise "Invalid delivery method #{method.inspect}"
+          end
+        else
+          message.delivery_method(method)
+        end
+        message.raise_delivery_errors = raise_delivery_errors
+      end
+    end
+
+    def wrap_delivery_behavior!(*args) # :nodoc:
+      self.class.wrap_delivery_behavior(message, *args)
+    end
+  end
+end

data/lib/action_message_texter/engine.rb

@@ -0,0 +1,19 @@
+require 'action_message_texter'
+
+module ActionMessageTexter
+  class Engine < ::Rails::Engine
+    isolate_namespace ActionMessageTexter
+    config.eager_load_namespaces << ActionMessageTexter
+
+    initializer 'action_message_texter.logger' do
+      ActiveSupport.on_load(:action_message_texter) { self.logger ||= Rails.logger }
+    end
+
+    config.after_initialize do |app|
+      ActiveSupport.on_load(:action_message_txter) do
+        options = app.config.action_short_message
+        options.each { |k, v| send("#{k}=", v) }
+      end
+    end
+  end
+end

data/lib/action_message_texter/log_subscriber.rb

@@ -0,0 +1,29 @@
+module ActionMessageTexter
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    # delivery log
+    def deliver(event)
+      info do
+        message = event.payload[:content]
+        to = event.payload[:to]
+        deliver_at = event.payload[:deliver_at]
+        texter = event.payload[:texter]
+        "#{texter}: Delivered message [#{message}] to #{to} at #{deliver_at}"
+      end
+    end
+
+    # process message log
+    def process(event)
+      debug do
+        messenger = event.payload[:messenger]
+        action = event.payload[:action]
+        "#{messenger}##{action}: processed short Message in #{event.duration.round(1)}ms"
+      end
+    end
+
+    def logger
+      ActionMessageTexter::Base.logger || Rails.logger
+    end
+  end
+end
+
+ActionMessageTexter::LogSubscriber.attach_to :action_message_texter

data/lib/action_message_texter/message.rb

@@ -0,0 +1,42 @@
+module ActionMessageTexter
+  class Message
+    attr_accessor :content, :to, :deliver_at, :delivery_options, :delivery_handler, :other_options,
+                  :raise_delivery_errors
+
+    attr_writer :delivery_method
+
+    # TODO: create registred interceptor and observer
+
+    def initialize
+      @raise_delivery_errors = true
+    end
+
+    def deliver
+      # inform_interceptors
+      if delivery_handler
+        delivery_handler.deliver_message(self) { do_delivery }
+      else
+        do_delivery
+      end
+      # inform_observers
+      self
+    end
+
+    def delivery_method(method = nil, _settings = {})
+      if method
+        # TODO: get provider from configuration
+        @delivery_method = SMSProvider::Base.new
+      else
+        @delivery_method
+      end
+    end
+
+    private
+
+    def do_delivery
+      delivery_method.deliver!(self)
+    rescue StandardError => e
+      raise e if raise_delivery_errors
+    end
+  end
+end

data/lib/action_message_texter/message_delivery.rb

@@ -0,0 +1,50 @@
+module ActionMessageTexter
+  # 分派工作
+  class MessageDelivery < Delegator
+    def initialize(texter_class, action, *args)
+      @texter_class = texter_class
+      @action = action
+      @args = args
+    end
+
+    def deliver_now
+      processed_messenger.handle_exceptions do
+        message.deliver
+      end
+    end
+
+    def deliver_later(options = {})
+      enqueue_delivery :deliver_now, options
+    end
+
+    def __getobj__
+      @message ||= processed_messenger.message
+    end
+
+    def __setobj__(message)
+      @message = message
+    end
+
+    def message
+      __getobj__
+    end
+
+    # 是否送出
+    def processed?
+      @processed_messenger || @message
+    end
+
+    private
+
+    def processed_messenger
+      @processed_messenger ||= @texter_class.new.tap do |messenger|
+        messenger.process @action, *@args
+      end
+    end
+
+    def enqueue_delivery(delivery_method, options = {})
+      args = @texter_class.name, @action.to_s, delivery_method.to_s, *@args
+      ::ActionMessageTexter::DeliveryJob.set(options).perform_later(*args)
+    end
+  end
+end

data/lib/action_message_texter/rescuable.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ActionMessageTexter
+  module Rescuable
+    extend ActiveSupport::Concern
+    include ActiveSupport::Rescuable
+
+    class_methods do
+      def handle_exception(exception)
+        rescue_with_handler(exception) || raise(exception)
+      end
+    end
+
+    def handle_exceptions
+      yield
+    rescue StandardError => e
+      rescue_with_handler(e) || raise
+    end
+
+    private
+
+    def process(*)
+      handle_exceptions do
+        super
+      end
+    end
+  end
+end

data/lib/action_message_texter/version.rb

@@ -0,0 +1,3 @@
+module ActionMessageTexter
+  VERSION = '0.0.1'
+end

data/lib/action_message_texter.rb

@@ -0,0 +1,20 @@
+require 'action_message_texter/engine'
+require 'action_message_texter/delivery_methods'
+require 'action_message_texter/log_subscriber'
+require 'action_message_texter/message_delivery'
+require 'action_message_texter/message'
+require 'action_message_texter/rescuable'
+require 'action_message_texter/delivery_job'
+require 'sms_provider/base'
+
+module ActionMessageTexter
+  extend ::ActiveSupport::Autoload
+
+  autoload :Base
+  autoload :DeliveryMethods
+  autoload :DeliveryJob
+  autoload :LogSubscriber
+  autoload :MessageDelivery
+  autoload :Recuable
+  autoload :Message
+end

data/lib/generators/action_message_texter/texter_generator.rb

@@ -0,0 +1,34 @@
+module ActionMessageTexter
+  module Generators
+    class TexterGenerator < Rails::Generators::NamedBase
+      require 'yaml'
+      source_root File.expand_path(__dir__)
+
+      argument :actions, type: :array, default: [], banner: 'method method'
+
+      check_class_collision suffix: 'Texter'
+
+      def create_message_file
+        template '../templates/texter.rb', File.join('app/texter', "#{file_name}_texter.rb")
+      end
+
+      def create_locale_yml
+        @yaml = {}
+        default_locale = I18n.default_locale.to_s
+        scope_name = "#{file_name}_texter"
+        @yaml[default_locale] = {}
+        @yaml[default_locale][scope_name] = {}
+        actions.each do |action|
+          @yaml[default_locale][scope_name][action] = "#{action} message"
+        end
+        template '../templates/I18n.yml.rb', File.join('config/locales/texter', "#{file_name}_texter.yml")
+      end
+
+      protected
+
+      def file_name
+        @_file_name ||= super.gsub(/_texter|Texter/i, '')
+      end
+    end
+  end
+end

data/lib/generators/templates/i18n.yml.rb

@@ -0,0 +1 @@
+<%= @yaml.to_yaml %>

data/lib/generators/templates/texter.rb

@@ -0,0 +1,7 @@
+class <%="#{class_name}"%>Texter < ActionMessageTexter::Base
+  <%actions.each do |action| %>
+    def <%=action%>
+      sms(to: "+886987654321")
+    end
+  <%end%>
+end

data/lib/sms_provider/base.rb

@@ -0,0 +1,7 @@
+module SMSProvider
+  class Base
+    def deliver!(message)
+      puts message
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: action_message_texter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Arthur Li
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: SMS/Text Message gem, allow your Rails send short message to phone
+email:
+- z22919456@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/action_message_texter.rb
+- lib/action_message_texter/base.rb
+- lib/action_message_texter/delivery_job.rb
+- lib/action_message_texter/delivery_methods.rb
+- lib/action_message_texter/engine.rb
+- lib/action_message_texter/log_subscriber.rb
+- lib/action_message_texter/message.rb
+- lib/action_message_texter/message_delivery.rb
+- lib/action_message_texter/rescuable.rb
+- lib/action_message_texter/version.rb
+- lib/generators/action_message_texter/texter_generator.rb
+- lib/generators/templates/i18n.yml.rb
+- lib/generators/templates/texter.rb
+- lib/sms_provider/base.rb
+homepage: http://github.com/z22919456/action_message_texter
+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.1.6
+signing_key:
+specification_version: 4
+summary: SMS/Text Message gem, allow your Rails send short message to phone
+test_files: []