mitake_sms 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c363dc8dd6553a342f2e38afb125c68e77f9312dcb804ca067b12d828ea33a23
-  data.tar.gz: 2232bcf3e90cbcd41b3933d1e56df41934a88fba3fe03c6c8dc41ddebc7e0a15
+  metadata.gz: 39775d8249e44177aa4d89da4716abc178ccd834e6c653549389a419f305d08c
+  data.tar.gz: c47d00857751465b785cfe5da97b858b7c78722a8f65fd81d6e965de06541730
 SHA512:
-  metadata.gz: 86ff828f6173002ae80d1a3db3da9f26cf711136026bf7492102e09f63ecb58aa6478d6b0afb22dae8455ae8ff697a3c65f282b2e8a5affc18c1d4c6cd3ca38a
-  data.tar.gz: 539afb9e3ea2adb46591fe17d36e0850d1d0aa8769636efaadb414d980ca57049234ac19f98d99f0e94ec925018845272c9d4adcf1219df26071601c99ae5b03
+  metadata.gz: 04bea4cc56b8294f4e5ecc6667a6378ed49bc13221c4766e6b3102421ad598b118d0793bdf7cf900340013fcfe83484f6b64b75d55c1f2e508330c7aef26c49c
+  data.tar.gz: df170765544707a1b51ee0240811f4b379211f146725504d5b496c41792be713f13cf86ed4565689d51f2d09510f1b0a6df72a43512753bdc901fdb632402a38

data/CHANGELOG.md

@@ -7,6 +7,15 @@ 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

data/README.md

@@ -141,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
@@ -153,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
   },
   {
@@ -178,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

@@ -155,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.6.0"
+  VERSION = "2.0.0"
 end

data/lib/mitake_sms.rb

@@ -100,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.6.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Zac