comms_sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d62a3711780407daaa0294a755a59775499665b3b07ef3a5af9edcd849f32fdb
+  data.tar.gz: 9dd7deca89b32b00f1a483e0dc5cb0738a3cf5a19406e9a73ea38111d3c7ed41
+SHA512:
+  metadata.gz: 4dc71be2eb0b4e17b2a46e530d57a3291ea1cf056549172afefd9b542b961c350ee3cf2528b8507ddd381cb69ebfeef31d1e4c0694b34d701746ae02f3f8d477
+  data.tar.gz: 17cd00fbc6f6e3a3973402d6864c137839a5f975b315ce08852f99898d5431f2da1b89c95303c23457ebeb78427b0b08dd51f4116cf72ef009a49717d80d8fe7

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# CommsSdk
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/comms_sdk`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/comms_sdk/v1/README.md

@@ -0,0 +1,167 @@
+# CommsSdk Ruby Implementation
+
+A Ruby implementation of the Communications SDK that follows the same patterns as the Python implementation and matches the Kotlin reference implementation.
+
+## Features
+
+- **Consistent API**: Matches the standardized interface across all language implementations
+- **Authentication**: Uses `userName` and `apiKey` authentication pattern
+- **Dual Methods**: Provides both simple boolean return methods and full response query methods
+- **Error Handling**: Comprehensive error handling with proper Ruby exceptions
+- **Validation**: Phone number validation and credential validation
+- **Logging**: Proper error logging to stderr
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'comms_sdk'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install comms_sdk
+
+## Usage
+
+### Basic Authentication
+
+```ruby
+require 'comms_sdk'
+
+# Authenticate with username and API key
+sdk = CommsSdk.authenticate("your_username", "your_api_key")
+
+# Or use the V1 module directly
+sdk = CommsSdk::V1::CommsSDK.authenticate("your_username", "your_api_key")
+```
+
+### Sending SMS
+
+```ruby
+# Send SMS to a single number
+success = sdk.send_sms("256712345678", "Hello from Ruby!")
+
+# Send SMS to multiple numbers
+success = sdk.send_sms(["256712345678", "256787654321"], "Hello to all!")
+
+# Send SMS with custom sender ID and priority
+success = sdk.send_sms(
+  "256712345678", 
+  "Hello!", 
+  sender_id: "MyApp",
+  priority: CommsSdk::V1::MessagePriority::HIGH
+)
+
+# Get full API response
+response = sdk.query_send_sms(
+  ["256712345678"], 
+  "Hello!", 
+  "MyApp", 
+  CommsSdk::V1::MessagePriority::HIGHEST
+)
+```
+
+### Checking Balance
+
+```ruby
+# Get balance as a float
+balance = sdk.get_balance
+puts "Balance: #{balance}"
+
+# Get full balance response
+response = sdk.query_balance
+puts "Status: #{response.status}"
+puts "Balance: #{response.balance}"
+puts "Currency: #{response.currency}"
+```
+
+### Configuration
+
+```ruby
+# Use sandbox environment
+CommsSdk::V1::CommsSDK.use_sandbox
+
+# Use live server (default)
+CommsSdk::V1::CommsSDK.use_live_server
+
+# Set custom sender ID
+sdk.with_sender_id("MyCustomSender")
+```
+
+## API Reference
+
+### CommsSdk::V1::CommsSDK
+
+#### Class Methods
+
+- `authenticate(user_name, api_key)` - Authenticate and return SDK instance
+- `use_sandbox` - Switch to sandbox environment
+- `use_live_server` - Switch to live environment
+
+#### Instance Methods
+
+- `send_sms(numbers, message, sender_id: nil, priority: MessagePriority::HIGHEST)` - Send SMS, returns boolean
+- `query_send_sms(numbers, message, sender_id, priority)` - Send SMS, returns full ApiResponse
+- `get_balance()` - Get account balance as float
+- `query_balance()` - Get full balance response as ApiResponse
+- `with_sender_id(sender_id)` - Set sender ID, returns self for chaining
+
+#### Properties
+
+- `api_key` - The API key used for authentication
+- `user_name` - The username used for authentication  
+- `sender_id` - Current sender ID
+- `is_authenticated` - Authentication status
+
+### Models
+
+#### MessagePriority
+- `HIGHEST` - Priority "0"
+- `HIGH` - Priority "1" 
+- `MEDIUM` - Priority "2"
+- `LOW` - Priority "3"
+- `LOWEST` - Priority "4"
+
+#### ApiResponse
+- `status` - Response status ("OK" or "Failed")
+- `message` - Response message
+- `cost` - Message cost
+- `currency` - Currency code
+- `msg_follow_up_unique_code` - Unique tracking code
+- `balance` - Account balance
+
+## Error Handling
+
+The SDK raises appropriate Ruby exceptions:
+
+```ruby
+begin
+  sdk = CommsSdk.authenticate("", "")  # Empty credentials
+rescue ArgumentError => e
+  puts "Authentication error: #{e.message}"
+end
+
+begin
+  sdk.send_sms([], "")  # Empty numbers and message
+rescue ArgumentError => e
+  puts "Validation error: #{e.message}"
+end
+```
+
+## Thread Safety
+
+The SDK is thread-safe for read operations. For write operations or shared state modifications, use appropriate synchronization mechanisms.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/comms_sdk/v1/comms_sdk.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'uri'
+require_relative 'models'
+require_relative 'utils'
+
+module CommsSdk
+  module V1
+    class CommsSDK
+      API_URL = "http://176.58.101.43:8080/communications/api/v1/json/"
+
+      attr_reader :api_key, :user_name, :sender_id, :is_authenticated
+
+      def initialize
+        @api_key = nil
+        @user_name = nil
+        @sender_id = "EgoSMS"
+        @is_authenticated = false
+      end
+
+      def self.authenticate(user_name, api_key)
+        sdk = new
+        sdk.instance_variable_set(:@user_name, user_name)
+        sdk.instance_variable_set(:@api_key, api_key)
+        Utils::Validator.validate_credentials(sdk)
+        sdk
+      end
+
+      def self.use_sandbox
+        remove_const(:API_URL) if const_defined?(:API_URL)
+        const_set(:API_URL, "http://176.58.101.43:8080/communications/api/v1/json")
+      end
+
+      def self.use_live_server
+        remove_const(:API_URL) if const_defined?(:API_URL)
+        const_set(:API_URL, "http://176.58.101.43:8080/communications/api/v1/json")
+      end
+
+      def set_authenticated
+        @is_authenticated = true
+      end
+
+      def with_sender_id(sender_id)
+        @sender_id = sender_id
+        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)
+        
+        if api_response.nil?
+          puts "Failed to get a response from the server."
+          return false
+        end
+        
+        case api_response.status
+        when ApiResponseCode::OK
+          puts "SMS sent successfully."
+          puts "MessageFollowUpUniqueCode: #{api_response.msg_follow_up_unique_code}" if api_response.msg_follow_up_unique_code
+          true
+        when ApiResponseCode::FAILED
+          puts "Failed: #{api_response.message}"
+          false
+        else
+          raise "Unexpected response status: #{api_response.status}"
+        end
+      end
+
+      def query_send_sms(numbers, message, sender_id, priority)
+        return nil if sdk_not_authenticated?
+        
+        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
+        
+        sender_id = @sender_id if sender_id.nil? || sender_id.strip.empty?
+        
+        if sender_id.length > 11
+          puts "Warning: Sender ID length exceeds 11 characters. Some networks may truncate or reject messages."
+        end
+        
+        numbers = Utils::NumberValidator.validate_numbers(numbers)
+        if numbers.empty?
+          $stderr.puts "No valid phone numbers provided. Please check inputs."
+          return nil
+        end
+        
+        message_models = numbers.map do |num|
+          MessageModel.new(number: num, message: message, senderid: sender_id, priority: priority.value)
+        end
+        
+        api_request = ApiRequest.new(
+          method: "SendSms",
+          userdata: UserData.new(@user_name, @api_key),
+          msgdata: message_models
+        )
+        
+        begin
+          response = make_http_request(api_request)
+          ApiResponse.from_hash(JSON.parse(response.body))
+        rescue => e
+          $stderr.puts "Failed to send SMS: #{e.message}"
+          begin
+            $stderr.puts "Request: #{api_request.to_hash}"
+          rescue
+            # Ignore serialization errors
+          end
+          nil
+        end
+      end
+
+      def query_balance
+        return nil if sdk_not_authenticated?
+        
+        api_request = ApiRequest.new(
+          method: "Balance",
+          userdata: UserData.new(@user_name, @api_key)
+        )
+        
+        begin
+          response = make_http_request(api_request)
+          ApiResponse.from_hash(JSON.parse(response.body))
+        rescue => e
+          raise "Failed to get balance: #{e.message}"
+        end
+      end
+
+      def get_balance
+        response = query_balance
+        return nil if response.nil? || response.balance.nil?
+        
+        begin
+          Float(response.balance)
+        rescue ArgumentError
+          nil
+        end
+      end
+
+      def to_s
+        "SDK(#{@user_name} => #{@api_key})"
+      end
+
+      private
+
+      def sdk_not_authenticated?
+        unless @is_authenticated
+          $stderr.puts "SDK is not authenticated. Please authenticate before performing actions."
+          $stderr.puts "Attempting to re-authenticate with provided credentials..."
+          return !Utils::Validator.validate_credentials(self)
+        end
+        false
+      end
+
+      def make_http_request(api_request)
+        uri = URI(API_URL)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == 'https'
+        
+        request = Net::HTTP::Post.new(uri)
+        request['Content-Type'] = 'application/json'
+        request.body = api_request.to_json
+        
+        http.request(request)
+      end
+    end
+  end
+end

data/lib/comms_sdk/v1/models.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module CommsSdk
+  module V1
+    class ApiResponseCode
+      OK = "OK"
+      FAILED = "Failed"
+
+      def self.from_json(json_string)
+        case json_string.downcase
+        when "ok"
+          OK
+        when "failed"
+          FAILED
+        else
+          raise ArgumentError, "Unknown value: #{json_string}"
+        end
+      end
+    end
+
+    class MessagePriority
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def self.from_value(text)
+        case text
+        when "0"
+          HIGHEST
+        when "1"
+          HIGH
+        when "2"
+          MEDIUM
+        when "3"
+          LOW
+        when "4"
+          LOWEST
+        else
+          raise ArgumentError, "Unknown priority value: #{text}"
+        end
+      end
+
+      HIGHEST = new("0")
+      HIGH = new("1")
+      MEDIUM = new("2")
+      LOW = new("3")
+      LOWEST = new("4")
+    end
+
+    class UserData
+      attr_reader :username, :apikey
+
+      def initialize(username, apikey)
+        @username = username
+        @apikey = apikey
+      end
+
+      def to_hash
+        {
+          "username" => @username,
+          "password" => @apikey  # Maps to "password" in JSON
+        }
+      end
+
+      def to_json(*args)
+        to_hash.to_json(*args)
+      end
+    end
+
+    class MessageModel
+      attr_reader :number, :message, :senderid, :priority
+
+      def initialize(number:, message:, senderid:, priority:)
+        @number = number
+        @message = message
+        @senderid = senderid
+        @priority = priority
+      end
+
+      def to_hash
+        {
+          "number" => @number,
+          "message" => @message,
+          "senderid" => @senderid,
+          "priority" => @priority
+        }
+      end
+
+      def to_json(*args)
+        to_hash.to_json(*args)
+      end
+    end
+
+    class ApiRequest
+      attr_reader :method, :userdata, :msgdata
+
+      def initialize(method:, userdata:, msgdata: nil)
+        @method = method
+        @userdata = userdata
+        @msgdata = msgdata
+      end
+
+      def to_hash
+        hash = {
+          "method" => @method,
+          "userdata" => @userdata.to_hash
+        }
+        hash["msgdata"] = @msgdata.map(&:to_hash) if @msgdata
+        hash
+      end
+
+      def to_json(*args)
+        to_hash.to_json(*args)
+      end
+    end
+
+    class ApiResponse
+      attr_reader :status, :message, :cost, :currency, :msg_follow_up_unique_code, :balance
+
+      def initialize(status:, message: nil, cost: nil, currency: 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
+
+      def self.from_hash(hash)
+        new(
+          status: hash["Status"],
+          message: hash["Message"],
+          cost: hash["Cost"],
+          currency: hash["Currency"],
+          msg_follow_up_unique_code: hash["MsgFollowUpUniqueCode"],
+          balance: hash["Balance"]
+        )
+      end
+
+      def to_hash
+        {
+          "Status" => @status,
+          "Message" => @message,
+          "Cost" => @cost,
+          "Currency" => @currency,
+          "MsgFollowUpUniqueCode" => @msg_follow_up_unique_code,
+          "Balance" => @balance
+        }.compact
+      end
+
+      def to_json(*args)
+        to_hash.to_json(*args)
+      end
+    end
+  end
+end

data/lib/comms_sdk/v1/utils.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'uri'
+require 'set'
+
+module CommsSdk
+  module V1
+    module Utils
+      class NumberValidator
+        REGEX = /^\+?(0|\d{3})\d{9}$/
+
+        def self.validate_numbers(numbers)
+          return [] if numbers.nil? || numbers.empty?
+
+          cleansed = Set.new
+          numbers.each do |number|
+            next if number.nil? || number.strip.empty?
+
+            cleaned_number = number.strip.gsub(/[-\s]/, '')
+            if cleaned_number.match?(REGEX)
+              if cleaned_number.start_with?('0')
+                cleaned_number = '256' + cleaned_number[1..]
+              elsif cleaned_number.start_with?('+')
+                cleaned_number = cleaned_number[1..]
+              end
+              cleansed.add(cleaned_number)
+            else
+              puts "Number (#{number}) is not valid!"
+            end
+          end
+
+          cleansed.to_a
+        end
+      end
+
+      class Validator
+        def self.validate_credentials(sdk)
+          if sdk.api_key.nil? || sdk.api_key.empty? || sdk.user_name.nil? || sdk.user_name.empty?
+            raise ArgumentError, "Either API Key or Username must be provided"
+          end
+
+          unless valid_credential?(sdk)
+            puts <<~ASCII
+                                                                    _                    
+                /\\     _|_ |_   _  ._ _|_ o  _  _. _|_ o  _  ._    |_ _. o |  _   _| | | 
+               /--\\ |_| |_ | | (/_ | | |_ | (_ (_|  |_ | (_) | |   | (_| | | (/_ (_| o o 
+                                                                                         
+            ASCII
+            puts
+            raise "Credentials validation failed"
+          end
+
+          puts "Credentials validated successfully."
+          puts "Validated using basic auth"
+          sdk.set_authenticated
+          true
+        end
+
+        private
+
+        def self.valid_credential?(sdk)
+          api_request = ApiRequest.new(
+            method: "Balance",
+            userdata: UserData.new(sdk.user_name, sdk.api_key)
+          )
+
+          begin
+            uri = URI(CommsSdk::V1::CommsSDK::API_URL)
+            http = Net::HTTP.new(uri.host, uri.port)
+            http.use_ssl = uri.scheme == 'https'
+            
+            request = Net::HTTP::Post.new(uri)
+            request['Content-Type'] = 'application/json'
+            request.body = api_request.to_json
+            
+            response = http.request(request)
+            api_response = ApiResponse.from_hash(JSON.parse(response.body))
+
+            if api_response.status == ApiResponseCode::OK
+              puts "Credentials validated successfully."
+              true
+            else
+              puts "Error validating credentials: #{api_response.message}"
+              false
+            end
+          rescue => e
+            puts "Error validating credentials: #{e.message}"
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/comms_sdk/version.rb

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

data/lib/comms_sdk.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "comms_sdk/version"
+require_relative "comms_sdk/v1/comms_sdk"
+
+module CommsSdk
+  class Error < StandardError; end
+  
+  # Convenience method to access the V1 SDK
+  def self.authenticate(user_name, api_key)
+    V1::CommsSDK.authenticate(user_name, api_key)
+  end
+end

data/sig/comms_sdk.rbs

@@ -0,0 +1,4 @@
+module CommsSdk
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: comms_sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Pahappa Comms platform SDK.
+email:
+- daniel@ug.pahappa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/comms_sdk.rb
+- lib/comms_sdk/v1/README.md
+- lib/comms_sdk/v1/comms_sdk.rb
+- lib/comms_sdk/v1/models.rb
+- lib/comms_sdk/v1/utils.rb
+- lib/comms_sdk/version.rb
+- sig/comms_sdk.rbs
+homepage: https://www.pahappa.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.pahappa.com
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Pahappa Comms platform SDK.
+test_files: []