mitake_sms 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc6252ee1a0e46b2d3b81d7ac1522a97414d9f923836887e3347909b7136d1a7
-  data.tar.gz: 7feece9cd7334075d6c6c23d5235c272245f656301d6bd3318db87753d5ac70d
+  metadata.gz: 7b8e4f3f9a2745fa7633cb7df508a09c1c639d1d55935ae9b5b77b5102535f70
+  data.tar.gz: 10e11540186c4f9a52f0f178c516dfe94ae407d752f97779596f650403638462
 SHA512:
-  metadata.gz: 118431e6c6b70bd7bcbb964b0d8953914def6b4b542e5101f89a4e3c19eddf2e07f930455975f4e9756462b3899f3e3df2d3b252d5abca87c28ad38b6f6a6b55
-  data.tar.gz: c252b2d7da8b4bf21a63081790582dd3f8e0bf4a956b7d6a4cf9c0f12f1f64ed1164c34186223a1c3206e3d56f797712ee187ebf2cf2e4a6972ec30cc586912f
+  metadata.gz: f49f9b77f286f86c21e0439bd0f78799d788e8abab1ddfe3c6b3f52679cd0e978e25a3344a22d55a262b46767864af0969ae4569e6a3789e4ebcb119149bf45f
+  data.tar.gz: 624ffd3d41a925bc2a6ee287f0e4ca5f00cc9e5ba0f30e3cb6d98c4fd2ec26b260066620884642e92cb22e756c07f78126d7c8006828af01b54705edd67d138c

data/CHANGELOG.md

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

data/README.md

@@ -55,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}"
@@ -66,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,15 +22,18 @@ 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
@@ -43,7 +46,7 @@ module MitakeSms
         dstaddr: to,
         smbody: processed_text,
         CharsetURL: charset
-      }.merge(options.slice(:from, :response_url, :client_id))
+      }.merge(param_options).merge(options)
   
       # Construct the endpoint URL
       endpoint = "SmSend"

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.4.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.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Zac