action_message_texter 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd00de826d0db8e13aaf8b49e914d530c89582e4f0ec99a4b9353f465f0e5e9d
-  data.tar.gz: 6f0a2f3321cfed58a7d3106670b7f253aaaf0f26774b3a43c2382003e0f401ac
+  metadata.gz: bfa1e0bae8d03c42e775fa78af9bb21309f02c073ecadae12f62330285dc7343
+  data.tar.gz: bf5a2e62fc9341a13737bd46529c97b498ed8b6e8c1e1ed41df1bb4db91f9def
 SHA512:
-  metadata.gz: 475cb10cc05e0910b526d56dca462015bbbcac58e0fe92a34f6bf94b208bbf417ba6111680d22fb98947918420669ba6fca46e203d3a5e4ac56be86192a820d1
-  data.tar.gz: 752ad19afd9068de50573f49909104c2ada1999baed798805d60393ad55e272dd4790af266a2e8e47244ee0d7c37611796f08e7aff1f2e820e9ba7d33b2c06fb
+  metadata.gz: da388aacea57f21c6d0b27cf3e601351a369d871473dd7c2c63d1a443e1271881f16030ff2960ee169dc192252f2676b9495ecba17d48a26682d755ac18699ce
+  data.tar.gz: 0d3fb35b1e9bd665eee577779bfe04500ebc3cfb91f99665a6e9e8c77cb5cf9749efa9dbb45c5de97cba6ffab107f564b1f1dc5068c60d33cc80a36b87e6feb1

data/README.md

@@ -2,8 +2,6 @@
 
 仿造Rails ActionMailer 打造的簡訊寄送模組，提供與Mailer一致的開發體驗
 
-
-
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -21,15 +19,179 @@ Or install it yourself as:
 $ gem install action_message_texter
 ```
 
-## Usage
+## Configuration
+
+1. 載入設定  
+   先到`config/application.rb` 新增 `require action_message_texter/engine`
+
+2. 簡訊寄送方式設定  
+
+    由於簡訊沒有類似SMTP的標準寄送方式，全依照簡訊提供商的API，目前我有包一個基於**三竹簡訊**的API，未來有計畫開放大家自行建立自己的寄送方式
+    
+    ```ruby
+    # config/application.rb
+    config.action_message_texter.mitake_settings= :mitake, MitakeApi::SMSProvider, url: "三竹發給你的網域名稱", username: "三竹的使用者名稱", password: "三竹的密碼"
+    ```
+
+3. 設定預設寄送方式  
+   在`app/application.rb`裡，可以預設所有簡訊要使用哪一個寄送方式
+   ``` ruby
+    # app/application.rb
+
+    #預設值為 :mitake
+    config.action_message_texter.delivery_method = :mitake
+   ```
+   若要依照不同環境使用不同的簡訊寄送方式 請在不同環境的設定檔(如`config/environments/development.rb`)內覆蓋這個設定，也可以在Texter中使用`delivery_method = :method`直接指定
+
+### 完整設定如下
+```ruby
+# config/applications.rb
+
+# 引用ActionMessageTexter
+require 'action_message_texter/engine'
+....
+
+class Application < Rails::Application
+  ...
+  # 加入三竹科技登入方式
+  config.action_message_texter.mitake_settings(:url: ENV['URL'], username: ENV['USERNAME'], password: ENV['password'])
+  # 設定預設的寄送方式
+  config.action_message_texter.delivery_method = :mitake
+  ...
+end
+```
+
+## Generator 
 
-### Texter Generator 
-This generator will generate Texter at `app/texter`
 ```bash
-rails g action_message_texter:texter Devise sign_up_succeed
+rails g action_message_texter:texter ModuleName action_name action_name ....
+```
+這會產生3個檔案，分別是 `app/texter/application_texter.rb` (若不存在)、`app/texter/{{name}}_texter.rb`、`config/locales/texter/{{name}}_texter.yaml`
+若有給定`function_name` 會自動生成對應的 function 以及字典檔
+
+
+```ruby
+# app/texter/my_texter.rb
+class MyTexter
+  def action_name
+    sms(to: "+8860987654321")
+  end
+end
+```
+```yaml
+# config/locales/texter/my_texter.yaml
+zh-TW:
+  my_texter:
+    action_name: 
+    action_name2:
+```
+
+
+## Texter
+
+與Mailer雷同，但因為簡訊是比較單純的文字，因此render view了，簡訊生成的部分將使用`I18n`，同時會自動帶入參數
+
+#### Example
+假設要送出簡訊，並帶入訂單
+```ruby
+class MyTexter
+  def uber_eat_order(phone_number, order)
+    # 記得設成全域變數 我會幫你自動插到I18n內，就像平常使用view 時會插入 `<%=@order>` 一樣
+    @order = order
+    sms(to: phone_number)
+  end
+end
+```
+
+```yaml
+zh-TW:
+  my_texter: 
+    uber_eat_order: "今晚，我想來%{order}"
+# 記得插值不要加 `@` 喔
+```
+
+若不同的`Texter`想使用不同的method 可以直接加入 `delivery_method = :method`
+
+```ruby
+class MyTexter
+  delivery_method = :method
+  ....
+```
+
+## Send Message
+
+跟 Mailer 一樣，提供 `deliver_now` 跟 `deliver_later` 兩種寄送方式，`deliver_now` 會直接寄出，`deliver_later`會調用Job做寄出。
+
+```ruby
+# 直接寄出，後續的動作需等待這個動作完成
+MyTexter.uber_eat_order("0987654321", "林東芳牛肉麵").deliver_now
+# 調用Job，後續的動作繼續執行
+MyTexter.uber_eat_order("0987654321", "林東芳牛肉麵").deliver_latter
+
+```
+
+## Callbacks
+
+可以在Tester中加入 `before_action` 與 `after_action`，在這兩個funciton中可以取得`message`物件。
+```ruby
+class MyTexter
+  before_action :do_before
+  after_action :do_after
+
+  def do_before
+    ...do_something
+  end
+
+  def do_after
+    ...do_something
+  end
+  ....
+```
+
+
+## Observer
+
+若需要再寄送後，查看寄送是否完成？儲存寄送方式結果...等
+可以註冊一個 `Observer` 或多個 `Observer`
+
+```ruby
+class TexterObserver
+  def self.delivered_message(message)
+    # 請實作此方法
+  end
+end
+
+
+class MyTexter
+  self.register_observer(TexterObserver)
+  
+  # 您也可以註冊多組Observer
+  self.register_observer(OtherObserver)
+end
+```
+
+## Inspection
+
+如了`Observer` 您也可以註冊攔截器 `Inspection`
+
+```ruby
+class TexterInspection
+  def self.delivering_message(message)
+    # 請實作此方法
+  end
+end
+
+
+class MyTexter
+  self.register_inspection(TexterObserver)
+  
+  # 您也可以註冊多組Observer
+  self.register_inspection(OtherObserver)
+end
 ```
+## Test
 
-### Texter
+尚未規劃Test的部分
 
 
 ## Contributing

data/lib/action_message_texter/base.rb

@@ -19,6 +19,18 @@ module ActionMessageTexter
         Message.register_observer(observer_class_for(observer))
       end
 
+      def unregister_observer(observer)
+        Message.unregister_observer(observer_class_for(observer))
+      end
+
+      def register_interceptor(interceptor)
+        Message.register_interceptor(observer_class_for(interceptor))
+      end
+
+      def unregister_interceptor(interceptor)
+        Message.unregister_observer(observer_class_for(interceptor))
+      end
+
       def default(value)
         self.default_params = default_params.merge(value).freeze if value
         default_params

data/lib/action_message_texter/delivery_methods.rb

@@ -10,6 +10,7 @@ module ActionMessageTexter
       class_attribute :delivery_method, default: :base
 
       add_delivery_method(:base, SMSProvider::Base)
+      add_delivery_method(:mitake, MitakeApi::SMSProvider, {})
     end
 
     module ClassMethods

data/lib/action_message_texter/message.rb

@@ -10,6 +10,16 @@ module ActionMessageTexter
       def unregister_observer(observer)
         @@delivery_notification_observers.delete(observer)
       end
+
+      def register_interceptor(interceptor)
+        unless @@delivery_notification_interceptors.include?(interceptor)
+          @@delivery_notification_interceptors << interceptor
+        end
+      end
+
+      def unregister_interceptor(interceptor)
+        @@delivery_notification_interceptors.delete(interceptor)
+      end
     end
     attr_accessor :content, :to, :deliver_at, :delivery_options, :delivery_handler, :other_options,
                   :raise_delivery_errors, :response
@@ -26,7 +36,7 @@ module ActionMessageTexter
     end
 
     def deliver
-      # inform_interceptors
+      inform_interceptors
       if delivery_handler
         delivery_handler.deliver_message(self) { do_delivery }
       else
@@ -54,6 +64,12 @@ module ActionMessageTexter
       end
     end
 
+    def inform_interceptors
+      @@delivery_notification_observers.each do |observer|
+        observer.delivering_message(self)
+      end
+    end
+
     def do_delivery
       delivery_method.deliver!(self)
     rescue StandardError => e

data/lib/action_message_texter/version.rb

@@ -1,3 +1,3 @@
 module ActionMessageTexter
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/generators/action_message_texter/texter_generator.rb

@@ -8,7 +8,13 @@ module ActionMessageTexter
 
       check_class_collision suffix: 'Texter'
 
-      def create_message_file
+      def create_application_texter
+        unless File.exist?('app/texter/application_texter.rb')
+          template '../templetes/application_texter.rb', File.join('app/texter', 'application_texter.rb')
+        end
+      end
+
+      def create_texter
         template '../templates/texter.rb', File.join('app/texter', "#{file_name}_texter.rb")
       end
 

data/lib/generators/templates/application_texter.rb

@@ -0,0 +1,2 @@
+class ApplicationTexter < ActionMessageTexter::Base
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_message_texter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Arthur Li
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-27 00:00:00.000000000 Z
+date: 2022-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,6 +45,7 @@ files:
 - lib/action_message_texter/rescuable.rb
 - lib/action_message_texter/version.rb
 - lib/generators/action_message_texter/texter_generator.rb
+- lib/generators/templates/application_texter.rb
 - lib/generators/templates/i18n.yml.rb
 - lib/generators/templates/texter.rb
 - lib/sms_provider/base.rb