action_message_texter 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8b8133432b4a5a074595da923cd0a09da09ebd5d4674b33b404f01a4c1dd1f9
-  data.tar.gz: 1f5a879189b1132f5a8a967eb07e5c86107c1e1506994e267a010ddde46add7c
+  metadata.gz: 52d4c99126aee66a02300b6615a12480d51f4c20681cf9c273b9ec020e2e0cf2
+  data.tar.gz: 9f88237c239af14edae7e6175434823e3bded0ff388425ca1b059257ee26c50d
 SHA512:
-  metadata.gz: 908903bdf31ae658a80c09cbdd5f4f52ea21ae74b5c5cae6271cb7bcc9db00444796cfd5c19faefe73eb956dda493b1df3ec66af8a5fac6d9a73e5c112d9b415
-  data.tar.gz: 9ca06bde4d8d764753ef36288b7cda4eaefba3f991065cdc5a90c5b443a30374fb8403f065b7b733f10bdca64f70debacf74c4a6e6a33f43b5b2624574786f0b
+  metadata.gz: a0f88ab4802086adbd69588b76659e0045fcc28ff6a0dfb0a923ffd94bdb2afe984252fc60d097922ba114b247eadb0b0ee8c13021b04250ffa1e6c91071724f
+  data.tar.gz: '09d0a2b7f4942bd4983f109aea575629b70b377c4838db9325829bf9c73f59297730d79ca91b940b3f306b284a7c161af2bf2b66679f01dcfbb5ecab5243da2a'

data/README.md

@@ -1,6 +1,6 @@
 # ActionMessageTexter
 
-仿造Rails ActionMailer 打造的簡訊寄送模組，提供與Mailer一致的開發體驗
+以 Rails ActionMailer 為參考打造的簡訊寄送模組，提供與 ActionMailer 一致的開發體驗
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -19,120 +19,126 @@ Or install it yourself as:
 $ gem install action_message_texter
 ```
 
-## Configuration
-
-1. 載入設定  
-   先到`config/application.rb` 新增 `require action_message_texter/engine`
-
-2. 簡訊寄送方式設定  
+## Usage
 
-    由於簡訊沒有類似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 
+請先執行`generator`
 
 ```bash
 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 以及字典檔
+這將會產生以下文件
 
+```
+root
+├─ app
+│  └─ texters
+│     ├─ application_texter.rb
+│     └─ module_name_texter.rb
+│
+└─ config
+   └─ locales
+      └─ module_name.yml
+```    
+
+使用上大致上跟Mailer差不多
 
 ```ruby
 # app/texter/my_texter.rb
 class MyTexter
-  def action_name
-    text(to: "+8860987654321")
+  def my_ubereats(phone)
+    @order = "林東芳的半筋半肉牛肉麵"
+    @notes = "不要牛肉不要麵"
+    text(to: phone)
   end
 end
 ```
+與Mailer不同的是 簡訊內容不從View Render出來，請使用I18n，或是直接給 `content`
+
 ```yaml
 # config/locales/texter/my_texter.yaml
 zh-TW:
   my_texter:
-    action_name: 
-    action_name2:
+    my_action: 今晚我想來點%{order}，%{note}
 ```
 
 
-## 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
+# app/texter/my_texter.rb
+def my_ubereats(phone)  
+  ...
+  # 也可以直接給文字，不走I18n
+  text(to: phone, content: "今晚我想來點#{order}，#{note}")
 end
 ```
 
-```yaml
-zh-TW:
-  my_texter: 
-    uber_eat_order: "今晚，我想來%{order}"
-# 記得插值不要加 `@` 喔
-```
-
-若不同的`Texter`想使用不同的method 可以直接加入 `delivery_method = :method`
+跟 ActionMailer 一樣，提供 `deliver_now` 跟 `deliver_later` 兩種寄送方式，`deliver_now` 會直接寄出，`deliver_later`會調用Job做寄出。
 
 ```ruby
-class MyTexter
-  delivery_method = :method
-  ....
+# 直接寄出，後續的動作需等待這個動作完成
+MyTexter.my_ubereats("0987654321").deliver_now
+# 調用Job，後續的動作繼續執行
+MyTexter.my_ubereats("0987654321").deliver_latter
+
 ```
 
-## Send Message
+**於是 `0987654321` 就會收到這樣的簡訊**
+> 今晚我想來點林東芳的半筋半肉牛肉麵，不要牛肉不要麵
 
-跟 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
 
-```
+## Configuration
+
+### 設定簡訊傳送方式： 三竹簡訊 API
+
+設定方式基本跟 `ActionMailer` 一模一樣
+
+預設內建三竹簡訊，首先請設定`網域`，`帳號`，`密碼`，如果有需要`Callback`的話，請準備一下`Callback Url`
+
+> 有計劃提供一個介面讓大家可以自己包自己的簡訊Api模組
+> 到時候只需使用 `add_delivery_method`  就可以加入自己的 Api 模組
+
+
+*  Require   
+   麻煩請先到`config/application.rb` 新增 `require action_message_texter/engine`
+
+*  設定三竹API
+    
+    ```ruby
+    # config/application.rb
+    config.action_message_texter.mitake_settings= { 
+      url: "三竹發給你的網域名稱 ex: https://smsapi.mitake.com.tw", 
+      username: "三竹的使用者名稱", 
+      password: "三竹的密碼", 
+      callback_url: "https://foo.bar.com/api/v1/callback" # 這行非必填
+    }  
+    ```
+
+*  設定預設寄送方式  
+   目前只有 `mitake` 一種寄送方式，因此預設就是這個，但若有需要的話
+   
+   在`app/application.rb`裡，可以預設所有簡訊要使用哪一個寄送方式
+   ``` ruby
+    # app/application.rb
+
+    #預設值為 :mitake
+    config.action_message_texter.delivery_method = :mitake
+   ```
+   基本上的設定方式都與ActionMailer相同，如果有不知道如何設定的，可以依照設定Mailer的經驗試試看喔
+
+
+## Message Object
+
+`Message` 物件相當於 `ActionMailer` 中的 `Message` 物件，是簡訊的本體，`Message` 物件包含了這些東西
+ - uuid: 簡訊的ID
+ - to: 收件者
+ - content: 簡訊內容
+ - response: 簡訊 Api 的回覆 (此部分可以參考[三竹簡訊API文件](https://sms.mitake.com.tw/common/header/download.jsp#))
+
 
 ## Callbacks
 
-可以在Tester中加入 `before_action` 與 `after_action`，在這兩個funciton中可以取得`message`物件。
+可以在Tester中加入 `before_action` 與 `after_action`，在這兩個方法中可以取得 `message` 物件。
 ```ruby
 class MyTexter
   before_action :do_before
@@ -158,6 +164,10 @@ class MyTexter
 class TexterObserver
   def self.delivered_message(message)
     # 請實作此方法
+    
+    # 如傳送後儲存傳送結果
+    message_history = MessageHistory.find_by(uuid: message.uuid)
+    message_history.update(response_message: message.response.response_message)
   end
 end
 
@@ -178,6 +188,9 @@ end
 class TexterInspection
   def self.delivering_message(message)
     # 請實作此方法
+
+    # 如測試站時加入測試站專屬訊息
+    message.content = "[test]#{message.content}" unless Rails.env.production
   end
 end
 
@@ -185,17 +198,15 @@ end
 class MyTexter
   self.register_inspection(TexterObserver)
   
-  # 您也可以註冊多組Observer
+  # 您也可以註冊多組攔截器
   self.register_inspection(OtherObserver)
 end
 ```
-## Test
 
-尚未規劃Test的部分
+## Test
 
+小弟初次寫Gem 還不會寫測試 還請各位神人協助交流 感謝
 
-## 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/lib/action_message_texter/base.rb

@@ -1,4 +1,9 @@
+# frozen_string_literal: true
+
 module ActionMessageTexter
+  #
+  # 所有Texter的父類別
+  #
   class Base < AbstractController::Base
     include Rescuable
     include DeliveryMethods
@@ -15,28 +20,51 @@ module ActionMessageTexter
     }
 
     class << self
+      ##
+      # 註冊觀察者Observer
+      #
+      # +Observer+ 需要包含一個Class Method +delivered_message(message)+
+      # 此方法會在訊息傳送後被呼叫 並取得 +message+ instance
+      # @params [Class|Symbel|String] observer
       def register_observer(observer)
         Message.register_observer(observer_class_for(observer))
       end
 
+      ##
+      # 移除已被註冊的 Observer
+      # @params [Class|Symbel|String] observer
       def unregister_observer(observer)
         Message.unregister_observer(observer_class_for(observer))
       end
 
+      ##
+      # 註冊攔截器Interceptor
+      #
+      # +Interceptor+ 需要包含一個Class Method +delivering_message(message)+
+      # 此Interceptor被註冊後 將於簡訊寄出前觸發delivering_message並取得 +message+ instance
+      #  @params [Class|Symbel|String] interceptor
       def register_interceptor(interceptor)
         Message.register_interceptor(observer_class_for(interceptor))
       end
 
+      ##
+      # 移除已被註冊的 Interceptor
+      # @params [Class|Symbel|String] observer
       def unregister_interceptor(interceptor)
         Message.unregister_observer(observer_class_for(interceptor))
       end
 
+      ##
+      # 可在 +Texter+ 中更改設定
+      #
+      # @param [Hash] value
       def default(value)
         self.default_params = default_params.merge(value).freeze if value
         default_params
       end
 
-      # set default params by configuration
+      ##
+      # 提供初始化時的 Configruation 使用
       alias default_options= default
 
       def texter_name
@@ -44,8 +72,9 @@ module ActionMessageTexter
       end
       attr_writer :texter_name
 
+      ##
+      # 寄送訊息 發出Log Notification
       def deliver_message(message)
-        # Notification
         ActiveSupport::Notifications.instrument('deliver.action_message_texter') do |payload|
           payload[:content] = message.content
           payload[:to] = message.to
@@ -57,7 +86,6 @@ module ActionMessageTexter
 
       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)

data/lib/action_message_texter/delivery_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionMessageTexter
   module DeliveryMethods
     extend ActiveSupport::Concern

data/lib/action_message_texter/log_subscriber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionMessageTexter
   class LogSubscriber < ActiveSupport::LogSubscriber
     # delivery log

data/lib/action_message_texter/message.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionMessageTexter
   class Message
     class << self

data/lib/action_message_texter/message_delivery.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionMessageTexter
   # 分派工作
   class MessageDelivery < Delegator

data/lib/action_message_texter/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionMessageTexter
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/lib/generators/action_message_texter/texter_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionMessageTexter
   module Generators
     class TexterGenerator < Rails::Generators::NamedBase

data/lib/sms_provider/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SMSProvider
   class Base
     def initialize(*setting)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_message_texter
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Arthur Li
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-30 00:00:00.000000000 Z
+date: 2022-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mitake_api