comms_sdk 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bd645fc9d43ee7901bbee4f47d065cecb985dab95eb167bacec0e9984df888d
-  data.tar.gz: 2ab419f94ce8b2f7966aeb0aa9ab568fefc4078378e9eb5bc8ef6c7119f3e87e
+  metadata.gz: f9ea74e1fd85fce61fa38b1b7fa2d488176f187596c91cd594026f553b866f52
+  data.tar.gz: 919d0b66b1f395aa8eade387e3e2330439fe542f2649aacb204278f067ecba73
 SHA512:
-  metadata.gz: 599836f2e32cf109d8829689fe6b86459012378b0602d436cd69b6f8362e201d4900887b4caf589b20e8d85b6cbeac4ce6362696c1c55e6b976324c3bdb00e24
-  data.tar.gz: f6fb82669a9a5022574e207fec635a293ea948bacd368e0aa2fa7e6831cb0e75a08652e89897bf3fee189b5f33379b1c41e4165ad142fc9260de1fe9a435bbbc
+  metadata.gz: 10c5b114e2c6f02c5d8dd0f38c7a8843987471d64aa51f56369c4dbc1faf01760b548bfeee7400aaa154bc97566f4349bea1c05f8bddae5cf78204725cf7f8fc
+  data.tar.gz: e4ed0bbfab88defd40e25a6590034165efca6470b4379712efbc33fcb89295fdec5debfcaf5de60bfdf916422db256e340269a23e7c53f814b727a6494aeafec

data/README.md

@@ -2,7 +2,7 @@
 
 A Ruby implementation of the CommsSDK for sending SMS and managing communications, following the same patterns as the Python and Kotlin reference implementations.
 
-**Version:** 1.0.1
+**Version:** 1.1.0
 
 ---
 
@@ -22,7 +22,7 @@ A Ruby implementation of the CommsSDK for sending SMS and managing communication
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'comms_sdk', '~> 1.0.1'
+gem 'comms_sdk', '~> 1.1.0'
 ```
 
 And then execute:
@@ -87,7 +87,6 @@ puts "Balance: #{balance}"
 response = sdk.query_balance
 puts "Status: #{response.status}"
 puts "Balance: #{response.balance}"
-puts "Currency: #{response.currency}"
 ```
 
 ### Configuration
@@ -122,10 +121,10 @@ sdk.with_sender_id("MyCustomSender")
 
 - `with_sender_id(sender_id)`
   Set sender ID, returns self for chaining.
-- `send_sms(numbers, message, sender_id: nil, priority: MessagePriority::HIGHEST)`
+- `send_sms(numbers, message, sender_id: nil, priority: MessagePriority::HIGH)`
   Send SMS, returns boolean.
-- `query_send_sms(numbers, message, sender_id, priority)`
-  Send SMS, returns full ApiResponse.
+- `query_send_sms(numbers, message, sender_id: nil, priority: MessagePriority::HIGH)`
+  Same as `send_sms`, but returns the full ApiResponse.
 - `get_balance`
   Get account balance as float.
 - `query_balance`
@@ -158,8 +157,7 @@ sdk.with_sender_id("MyCustomSender")
 
 - `status` - Response status ("OK" or "Failed")
 - `message` - Response message
-- `cost` - Message cost
-- `currency` - Currency code
+- `cost` - Message cost (not always a whole number)
 - `msg_follow_up_unique_code` - Unique tracking code
 - `balance` - Account balance
 

data/build_and_upload.sh

@@ -1,3 +1,4 @@
 #!/bin/bash
+rm -f ./*.gem
 gem build comms_sdk.gemspec
 GEM_HOST_API_KEY=rubygems_b64bca26f978b82cea4200d4e5d04d06444401f6cc340f27 gem push ./comms_sdk-*.gem

data/lib/comms_sdk/v1/README.md

@@ -78,7 +78,6 @@ puts "Balance: #{balance}"
 response = sdk.query_balance
 puts "Status: #{response.status}"
 puts "Balance: #{response.balance}"
-puts "Currency: #{response.currency}"
 ```
 
 ### Configuration
@@ -131,8 +130,7 @@ sdk.with_sender_id("MyCustomSender")
 #### ApiResponse
 - `status` - Response status ("OK" or "Failed")
 - `message` - Response message
-- `cost` - Message cost
-- `currency` - Currency code
+- `cost` - Message cost (not always a whole number)
 - `msg_follow_up_unique_code` - Unique tracking code
 - `balance` - Account balance
 

data/lib/comms_sdk/v1/comms_sdk.rb

@@ -9,7 +9,7 @@ require_relative 'utils'
 module CommsSdk
   module V1
     class CommsSDK
-      API_URL = "https://comms-test.pahappa.net/api/v1/json/"
+      API_URL = "https://comms.egosms.co/api/v1/json/"
 
       attr_reader :api_key, :user_name, :sender_id, :is_authenticated
 
@@ -35,7 +35,7 @@ module CommsSdk
 
       def self.use_live_server
         remove_const(:API_URL) if const_defined?(:API_URL)
-        const_set(:API_URL, "https://comms-test.pahappa.net/api/v1/json")
+        const_set(:API_URL, "https://comms.egosms.co/api/v1/json")
       end
 
       def set_authenticated
@@ -47,10 +47,8 @@ module CommsSdk
         self
       end
 
-      def send_sms(numbers, message, sender_id: nil, priority: MessagePriority::HIGHEST)
-        numbers = [numbers] if numbers.is_a?(String)
-        
-        api_response = query_send_sms(numbers, message, sender_id || @sender_id, priority)
+      def send_sms(numbers, message, sender_id: nil, priority: MessagePriority::HIGH)
+        api_response = query_send_sms(numbers, message, sender_id: sender_id, priority: priority)
         
         if api_response.nil?
           puts "Failed to get a response from the server."
@@ -70,9 +68,12 @@ module CommsSdk
         end
       end
 
-      def query_send_sms(numbers, message, sender_id, priority)
+      def query_send_sms(numbers, message, sender_id: nil, priority: MessagePriority::HIGH)
         return nil if sdk_not_authenticated?
-        
+
+        numbers = [numbers] if numbers.is_a?(String)
+        sender_id ||= @sender_id
+
         raise ArgumentError, "Numbers list cannot be empty" if numbers.nil? || numbers.empty?
         raise ArgumentError, "Message cannot be empty" if message.nil? || message.empty?
         raise ArgumentError, "Message cannot be a single character" if message.length == 1
@@ -96,7 +97,8 @@ module CommsSdk
         api_request = ApiRequest.new(
           method: "SendSms",
           userdata: UserData.new(@user_name, @api_key),
-          msgdata: message_models
+          msgdata: message_models,
+          wallet_type: WalletType::LOCAL
         )
         
         begin
@@ -113,14 +115,17 @@ module CommsSdk
         end
       end
 
-      def query_balance
+      def query_balance(wallet_type: nil)
         return nil if sdk_not_authenticated?
-        
+
+        wallet_type ||= WalletType::LOCAL
+
         api_request = ApiRequest.new(
           method: "Balance",
-          userdata: UserData.new(@user_name, @api_key)
+          userdata: UserData.new(@user_name, @api_key),
+          wallet_type: wallet_type
         )
-        
+
         begin
           response = make_http_request(api_request)
           ApiResponse.from_hash(JSON.parse(response.body))
@@ -129,8 +134,8 @@ module CommsSdk
         end
       end
 
-      def get_balance
-        response = query_balance
+      def get_balance(wallet_type: nil)
+        response = query_balance(wallet_type: wallet_type)
         return nil if response.nil? || response.balance.nil?
         
         begin

data/lib/comms_sdk/v1/models.rb

@@ -51,6 +51,28 @@ module CommsSdk
       LOWEST = new("4")
     end
 
+    class WalletType
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def self.from_value(text)
+        case text
+        when "Local"
+          LOCAL
+        when "International"
+          INTERNATIONAL
+        else
+          raise ArgumentError, "Unknown wallet type value: #{text}"
+        end
+      end
+
+      LOCAL = new("Local")
+      INTERNATIONAL = new("International")
+    end
+
     class UserData
       attr_reader :username, :apikey
 
@@ -96,12 +118,13 @@ module CommsSdk
     end
 
     class ApiRequest
-      attr_reader :method, :userdata, :msgdata
+      attr_reader :method, :userdata, :msgdata, :wallet_type
 
-      def initialize(method:, userdata:, msgdata: nil)
+      def initialize(method:, userdata:, msgdata: nil, wallet_type: nil)
         @method = method
         @userdata = userdata
         @msgdata = msgdata
+        @wallet_type = wallet_type
       end
 
       def to_hash
@@ -110,6 +133,7 @@ module CommsSdk
           "userdata" => @userdata.to_hash
         }
         hash["msgdata"] = @msgdata.map(&:to_hash) if @msgdata
+        hash["walletType"] = @wallet_type.value if @wallet_type
         hash
       end
 
@@ -119,13 +143,12 @@ module CommsSdk
     end
 
     class ApiResponse
-      attr_reader :status, :message, :cost, :currency, :msg_follow_up_unique_code, :balance
+      attr_reader :status, :message, :cost, :msg_follow_up_unique_code, :balance
 
-      def initialize(status:, message: nil, cost: nil, currency: nil, msg_follow_up_unique_code: nil, balance: nil)
+      def initialize(status:, message: nil, cost: nil, msg_follow_up_unique_code: nil, balance: nil)
         @status = status
         @message = message
         @cost = cost
-        @currency = currency
         @msg_follow_up_unique_code = msg_follow_up_unique_code
         @balance = balance
       end
@@ -135,7 +158,6 @@ module CommsSdk
           status: hash["Status"],
           message: hash["Message"],
           cost: hash["Cost"],
-          currency: hash["Currency"],
           msg_follow_up_unique_code: hash["MsgFollowUpUniqueCode"],
           balance: hash["Balance"]
         )
@@ -146,7 +168,6 @@ module CommsSdk
           "Status" => @status,
           "Message" => @message,
           "Cost" => @cost,
-          "Currency" => @currency,
           "MsgFollowUpUniqueCode" => @msg_follow_up_unique_code,
           "Balance" => @balance
         }.compact

data/lib/comms_sdk/v1/utils.rb

@@ -63,7 +63,8 @@ module CommsSdk
         def self.valid_credential?(sdk)
           api_request = ApiRequest.new(
             method: "Balance",
-            userdata: UserData.new(sdk.user_name, sdk.api_key)
+            userdata: UserData.new(sdk.user_name, sdk.api_key),
+            wallet_type: WalletType::LOCAL
           )
 
           begin

data/lib/comms_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CommsSdk
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: comms_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniel