mitake_sms 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42774c4aed1ba07e126a7023b8e2baedf85dc25e53bbeafc4739cff39765d0b3
-  data.tar.gz: 978e2c9b36e5cc2a2b79ad6f05b90f360f49c8930f50c5131851eb170a10aaf3
+  metadata.gz: 7b8e4f3f9a2745fa7633cb7df508a09c1c639d1d55935ae9b5b77b5102535f70
+  data.tar.gz: 10e11540186c4f9a52f0f178c516dfe94ae407d752f97779596f650403638462
 SHA512:
-  metadata.gz: '0859b813573741a6ff71f8339c1a56bb4c625a6acdb0f861b1f2407a5981fce7619cd70580301558b0bac4e682350ccbb6ffb9e35b7a8ff30f45f3f6e80c4992'
-  data.tar.gz: 350a37d091491be985e03b736b39ea999e28edf7a90eb5edc378a0119719a343eb3aeb6f4d558a17e1ea9bdb233d886e8aba585f38f1894b62d46f8500c03b30
+  metadata.gz: f49f9b77f286f86c21e0439bd0f78799d788e8abab1ddfe3c6b3f52679cd0e978e25a3344a22d55a262b46767864af0969ae4569e6a3789e4ebcb119149bf45f
+  data.tar.gz: 624ffd3d41a925bc2a6ee287f0e4ca5f00cc9e5ba0f30e3cb6d98c4fd2ec26b260066620884642e92cb22e756c07f78126d7c8006828af01b54705edd67d138c

data/CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.5.0] - 2025-05-25
+### Added
+- Added named parameters (keyword arguments) to `send_sms` method for improved readability and flexibility
+
+### Changed
+- Updated `send_sms` method to use named parameters instead of positional parameters
+- Removed `from` parameter from `send_sms` method
+- Updated tests to use named parameters for `send_sms` method
+
+## [1.4.0] - 2025-05-25
+### Changed
+- Modified all batch SMS parameters to be sent as query string parameters instead of in the POST body
+- Updated `send_batch` and `send_advanced_batch` methods to use query string parameters
+- Modified tests to verify query string parameter handling for batch SMS
+
+## [1.3.1] - 2025-05-25
+### Changed
+- Modified `CharsetURL` parameter to be sent as a query string parameter instead of a form parameter
+- Updated tests to verify query string parameter handling
+
 ## [1.3.0] - 2025-05-25
 ### Changed
 - Removed automatic URL encoding of message content

data/README.md

@@ -1,6 +1,8 @@
 # MitakeSms
 
 [![codecov](https://codecov.io/gh/7a6163/mitake_sms/graph/badge.svg?token=QNRP1N3TOP)](https://codecov.io/gh/7a6163/mitake_sms)
+![Gem Version](https://img.shields.io/gem/v/mitake_sms)
+
 
 A Ruby client for the Mitake SMS API, providing a simple and efficient way to send SMS messages through the Mitake SMS service.
 
@@ -53,7 +55,7 @@ end
 
 ```ruby
 # Send a simple SMS (uses UTF-8 encoding by default)
-response = MitakeSms.send_sms('0912345678', 'Hello, this is a test message!')
+response = MitakeSms.send_sms(to: '0912345678', text: 'Hello, this is a test message!')
 
 if response.success?
   puts "Message sent successfully! Message ID: #{response.message_id}"
@@ -64,9 +66,8 @@ end
 
 # With additional options
 response = MitakeSms.send_sms(
-  '0912345678',
-  'Hello with options!',
-  from: 'YourBrand',
+  to: '0912345678',
+  text: 'Hello with options!',
   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

data/lib/mitake_sms/client.rb

@@ -22,29 +22,41 @@ module MitakeSms
     # Send a single SMS
     # @param to [String] recipient phone number
     # @param text [String] message content
-    # @param options [Hash] additional options
-    # @option options [String] :from sender ID
-    # @option options [String] :response_url callback URL for delivery reports
-    # @option options [String] :client_id client reference ID
-    # @option options [String] :charset character encoding, defaults to 'UTF8'
+    # @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, options = {})
+    def send_sms(to:, text:, response_url: nil, client_id: nil, charset: 'UTF8', **options)
       require 'uri'
-      charset = options.delete(:charset) || 'UTF8'
+      
+      # Create options hash with only non-nil values
+      param_options = {}
+      param_options[:response_url] = response_url if response_url
+      param_options[:client_id] = client_id if client_id
 
       # Replace any newline characters with ASCII code 6 (ACK)
       # This is required by the Mitake API to represent line breaks
       processed_text = text.to_s.gsub("\n", 6.chr)
 
-      params = {
+      # Prepare query parameters - all parameters are now sent as query parameters
+      query_params = {
         username: @config.username,
         password: @config.password,
         dstaddr: to,
         smbody: processed_text,
         CharsetURL: charset
-      }.merge(options.slice(:from, :response_url, :client_id))
-
-      response = @connection.post('SmSend', params)
+      }.merge(param_options).merge(options)
+  
+      # Construct the endpoint URL
+      endpoint = "SmSend"
+  
+      response = @connection.post(endpoint) do |req|
+        req.params = query_params
+        # Empty body since all parameters are in the query string
+        req.body = {}
+      end
+      
       handle_response(response)
     end
 
@@ -137,23 +149,32 @@ module MitakeSms
     # @return [MitakeSms::Response] response object
     def send_batch(batch, charset = 'UTF8', options = {})
       require 'uri'
+      
+      # Prepare the batch message content
+      smbody = batch.map do |msg|
+        to = msg[:to]
+
+        # Replace any newline characters with ASCII code 6 (ACK)
+        # This is required by the Mitake API to represent line breaks
+        processed_text = msg[:text].to_s.gsub("\n", 6.chr)
 
-      params = {
+        "#{to}:#{processed_text}"
+      end.join("\n")
+      
+      # All parameters should be sent as query string parameters
+      query_params = {
         username: @config.username,
         password: @config.password,
-        smbody: batch.map do |msg|
-          to = msg[:to]
-
-          # Replace any newline characters with ASCII code 6 (ACK)
-          # This is required by the Mitake API to represent line breaks
-          processed_text = msg[:text].to_s.gsub("\n", 6.chr)
-
-          "#{to}:#{processed_text}"
-        end.join("\n"),
+        smbody: smbody,
         Encoding_PostIn: charset
       }
-
-      response = @connection.post('SmBulkSend', params)
+      
+      # Use empty body with all parameters in query string
+      response = @connection.post('SmBulkSend') do |req|
+        req.params = query_params
+        req.body = {}
+      end
+      
       handle_response(response)
     end
 
@@ -164,10 +185,10 @@ module MitakeSms
     # @return [MitakeSms::Response] response object
     def send_advanced_batch(batch, charset = 'UTF8', options = {})
       require 'uri'
-
+      
       # Format each message according to the advanced format
       # ClientID $$ dstaddr $$ dlvtime $$ vldtime $$ destname $$ response $$ smbody
-      body = batch.map do |msg|
+      data = batch.map do |msg|
         # ClientID is required and must be unique
         # If not provided, generate a unique ID
         client_id = msg[:client_id]
@@ -180,22 +201,28 @@ module MitakeSms
         vldtime = msg[:vldtime] || ''
         dest_name = msg[:dest_name] || ''
         response_url = msg[:response] || ''
-
+        
         # 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)
-
+        
         [client_id, to, dlvtime, vldtime, dest_name, response_url, processed_text].join('$$')
       end.join("\n")
 
-      params = {
+      # All parameters should be sent as query string parameters
+      query_params = {
         username: @config.username,
         password: @config.password,
-        data: body,
+        data: data,
         Encoding_PostIn: charset
       }
 
-      response = @connection.post('SmPost', params)
+      # Use empty body with all parameters in query string
+      response = @connection.post('SmPost') do |req|
+        req.params = query_params
+        req.body = {}
+      end
+      
       handle_response(response)
     end
 

data/lib/mitake_sms/configuration.rb

@@ -8,48 +8,48 @@ module MitakeSms
 
     setting :username, default: ENV['MITAKE_USERNAME']
     setting :password, default: ENV['MITAKE_PASSWORD']
-    setting :api_url, default: 'https://smsapi.mitake.com.tw/api/mtk/'
+    setting :api_url, default: 'https://smsapi.mitake.com.tw/b2c/mtk/'
     setting :timeout, default: 30
     setting :open_timeout, default: 5
-    
+
     # Provide direct access to configuration values at the class level
     class << self
       def username
         config.username
       end
-      
+
       def username=(value)
         config.username = value
       end
-      
+
       def password
         config.password
       end
-      
+
       def password=(value)
         config.password = value
       end
-      
+
       def api_url
         config.api_url
       end
-      
+
       def api_url=(value)
         config.api_url = value
       end
-      
+
       def timeout
         config.timeout
       end
-      
+
       def timeout=(value)
         config.timeout = value
       end
-      
+
       def open_timeout
         config.open_timeout
       end
-      
+
       def open_timeout=(value)
         config.open_timeout = value
       end

data/lib/mitake_sms/version.rb

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

data/lib/mitake_sms.rb

@@ -38,15 +38,21 @@ module MitakeSms
     # Send a single SMS message
     # @param to [String] recipient phone number
     # @param text [String] message content
-    # @param options [Hash] additional options
-    # @option options [String] :from sender ID
-    # @option options [String] :response_url callback URL for delivery reports
-    # @option options [String] :client_id client reference ID
-    # @option options [String] :charset character encoding, defaults to 'UTF8'
-
+    # @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, options = {})
-      client.send_sms(to, text, options)
+    def send_sms(to:, text:, 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,
+        response_url: response_url,
+        client_id: client_id,
+        charset: charset,
+        **options
+      )
     end
 
     # Send multiple SMS messages in a single request

metadata

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