mitake_sms 1.5.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69819e16435ee76e99640024557815e7ad6a9854c4bcdcea982b0fcd330c85e3
-  data.tar.gz: fdb94f92929b03ca298d86ea6babaa38910bf266c6bfb8870f281ababa773068
+  metadata.gz: 39775d8249e44177aa4d89da4716abc178ccd834e6c653549389a419f305d08c
+  data.tar.gz: c47d00857751465b785cfe5da97b858b7c78722a8f65fd81d6e965de06541730
 SHA512:
-  metadata.gz: c6ecaef16af836d259dbcdc16e0a34d02fd3a1a5705803827bcef72c70ebc0639502a1eff273182205f1e141200cd307e01550903aec4a52ef9979eed767e452
-  data.tar.gz: 93f2a41050e17e6c4f2abcede74f4a3877252e20533a89d7612c39ee39bdf381408da0a214218f31f4b581e466f268085e28f3824ba4008896cc280a1d869ef2
+  metadata.gz: 04bea4cc56b8294f4e5ecc6667a6378ed49bc13221c4766e6b3102421ad598b118d0793bdf7cf900340013fcfe83484f6b64b75d55c1f2e508330c7aef26c49c
+  data.tar.gz: df170765544707a1b51ee0240811f4b379211f146725504d5b496c41792be713f13cf86ed4565689d51f2d09510f1b0a6df72a43512753bdc901fdb632402a38

data/CHANGELOG.md

@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.0] - 2025-05-26
+### Changed
+- Modified `send_batch` method to use the advanced format with $$ separators
+- Updated batch SMS request to place data in the request body with 'text/plain' content type
+- Updated tests to verify the new batch SMS request format
+
+### Removed
+- Removed `advanced_batch_send_with_limit` method to simplify the API surface
+
+## [1.6.0] - 2025-05-25
+### Added
+- Added `destname` parameter to `send_sms` method for recipient name or system integration key value
+- Added tests for the new `destname` parameter
+
 ## [1.5.3] - 2025-05-25
 ### Changed
 - Updated the default API URL to `https://smsapi.mitake.com.tw/api/mtk/`

data/README.md

@@ -68,6 +68,7 @@ end
 response = MitakeSms.send_sms(
   to: '0912345678',
   text: 'Hello with options!',
+  destname: 'John Doe',  # Recipient name or integration key value
   response_url: 'https://your-callback-url.com/delivery-reports',
   client_id: 'your-client-reference-id',
   charset: 'BIG5'  # Override the default UTF-8 encoding if needed
@@ -140,9 +141,9 @@ responses.each_with_index do |batch_response, index|
 end
 ```
 
-### Sending Advanced Format Batch SMS
+### Sending Batch SMS with Advanced Format
 
-The advanced format allows more control over each message in the batch, including scheduled delivery, validity period, recipient name, and more:
+The batch_send method now uses the advanced format by default, which provides more control over each message in the batch, including scheduled delivery, validity period, recipient name, and more:
 
 ```ruby
 # Create messages with advanced options
@@ -152,8 +153,8 @@ messages = [
     to: '0912345678',                    # Required recipient phone number
     dlvtime: '20250526120000',           # Optional delivery time (YYYYMMDDhhmmss)
     vldtime: '20250527120000',           # Optional validity period (YYYYMMDDhhmmss)
-    dest_name: '大寶',                   # Optional recipient name
-    response: 'https://callback.url',    # Optional callback URL
+    destname: '大寶',                    # Optional recipient name
+    response_url: 'https://callback.url', # Optional callback URL
     text: '這是一則測試簡訊'             # Required message content
   },
   {
@@ -177,8 +178,8 @@ messages = [
 # - Long messages will be automatically split into multiple SMS messages if your account doesn't
 #   have long message permissions
 
-# Send using advanced format (automatically handles 500 message limit)
-response = MitakeSms.advanced_batch_send(messages)
+# Send using batch_send (automatically handles the advanced format)
+response = MitakeSms.batch_send(messages)
 
 # Process response similar to regular batch sending
 if response.is_a?(MitakeSms::Response) && response.success?

data/lib/mitake_sms/client.rb

@@ -22,16 +22,18 @@ module MitakeSms
     # Send a single SMS
     # @param to [String] recipient phone number
     # @param text [String] message content
+    # @param destname [String] recipient name or key value for system integration (optional)
     # @param response_url [String] callback URL for delivery reports (optional)
     # @param client_id [String] client reference ID (optional)
     # @param charset [String] character encoding, defaults to 'UTF8' (optional)
     # @param options [Hash] additional options (optional)
     # @return [MitakeSms::Response] response object
-    def send_sms(to:, text:, response_url: nil, client_id: nil, charset: 'UTF8', **options)
+    def send_sms(to:, text:, destname: nil, response_url: nil, client_id: nil, charset: 'UTF8', **options)
       require 'uri'
 
       # Create options hash with only non-nil values
       param_options = {}
+      param_options[:destname] = destname if destname
       param_options[:response_url] = response_url if response_url
       param_options[:client_id] = client_id if client_id
 
@@ -153,29 +155,42 @@ module MitakeSms
     def send_batch(batch, charset = 'UTF8', options = {})
       require 'uri'
 
-      # Prepare the batch message content
-      smbody = batch.map do |msg|
+      # Format each message according to the advanced format
+      # ClientID $$ dstaddr $$ dlvtime $$ vldtime $$ destname $$ response $$ smbody
+      data = batch.map do |msg|
+        # ClientID is required and must be unique
+        # If not provided, generate a unique ID
+        client_id = msg[:client_id]
+        if client_id.nil? || client_id.empty?
+          client_id = generate_unique_client_id
+        end
+
         to = msg[:to]
+        dlvtime = msg[:dlvtime] || ''
+        vldtime = msg[:vldtime] || ''
+        dest_name = msg[:destname] || ''
+        response_url = msg[:response_url] || ''
 
-        # Replace any newline characters with ASCII code 6 (ACK)
-        # This is required by the Mitake API to represent line breaks
+        # Replace any newline characters in the message text with ASCII code 6 (ACK)
+        # This is required by the Mitake API to represent line breaks within message content
         processed_text = msg[:text].to_s.gsub("\n", 6.chr)
 
-        "#{to}:#{processed_text}"
+        # Format according to API documentation: ClientID $$ dstaddr $$ dlvtime $$ vldtime $$ destname $$ response $$ smbody
+        [client_id, to, dlvtime, vldtime, dest_name, response_url, processed_text].join('$$')
       end.join("\n")
 
-      # All parameters should be sent as query string parameters
+      # Parameters for the request
       query_params = {
         username: @config.username,
         password: @config.password,
-        smbody: smbody,
         Encoding_PostIn: charset
       }
 
-      # Use empty body with all parameters in query string
+      # According to the API documentation, the data should be in the request body
       response = @connection.post('SmBulkSend') do |req|
         req.params = query_params
-        req.body = {}
+        req.body = data
+        req.headers['Content-Type'] = 'text/plain'
       end
 
       handle_response(response)

data/lib/mitake_sms/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MitakeSms
-  VERSION = "1.5.3"
+  VERSION = "2.0.0"
 end

data/lib/mitake_sms.rb

@@ -38,16 +38,18 @@ module MitakeSms
     # Send a single SMS message
     # @param to [String] recipient phone number
     # @param text [String] message content
+    # @param destname [String] recipient name or key value for system integration (optional)
     # @param response_url [String] callback URL for delivery reports (optional)
     # @param client_id [String] client reference ID (optional)
     # @param charset [String] character encoding, defaults to 'UTF8' (optional)
     # @param options [Hash] additional options (optional)
     # @return [MitakeSms::Response] response object
-    def send_sms(to:, text:, response_url: nil, client_id: nil, charset: 'UTF8', **options)
+    def send_sms(to:, text:, destname: nil, response_url: nil, client_id: nil, charset: 'UTF8', **options)
       # Forward all parameters to the client method using named parameters
       client.send_sms(
         to: to,
         text: text,
+        destname: destname,
         response_url: response_url,
         client_id: client_id,
         charset: charset,
@@ -98,15 +100,6 @@ module MitakeSms
       client.advanced_batch_send(messages, options)
     end
     
-    # Send multiple SMS messages in a single request with a limit per request using advanced format
-    # @param messages [Array<Hash>] array of message hashes with advanced options
-    # @param limit [Integer] maximum number of messages per request (default: 500)
-    # @param options [Hash] additional options
-    # @option options [String] :charset character encoding, defaults to 'UTF8'
 
-    # @return [MitakeSms::Response, Array<MitakeSms::Response>] response object or array of response objects if batch was split
-    def advanced_batch_send_with_limit(messages, limit = 500, options = {})
-      client.advanced_batch_send_with_limit(messages, limit, options)
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mitake_sms
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Zac