comms_sdk 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d62a3711780407daaa0294a755a59775499665b3b07ef3a5af9edcd849f32fdb
-  data.tar.gz: 9dd7deca89b32b00f1a483e0dc5cb0738a3cf5a19406e9a73ea38111d3c7ed41
+  metadata.gz: 2bd645fc9d43ee7901bbee4f47d065cecb985dab95eb167bacec0e9984df888d
+  data.tar.gz: 2ab419f94ce8b2f7966aeb0aa9ab568fefc4078378e9eb5bc8ef6c7119f3e87e
 SHA512:
-  metadata.gz: 4dc71be2eb0b4e17b2a46e530d57a3291ea1cf056549172afefd9b542b961c350ee3cf2528b8507ddd381cb69ebfeef31d1e4c0694b34d701746ae02f3f8d477
-  data.tar.gz: 17cd00fbc6f6e3a3973402d6864c137839a5f975b315ce08852f99898d5431f2da1b89c95303c23457ebeb78427b0b08dd51f4116cf72ef009a49717d80d8fe7
+  metadata.gz: 599836f2e32cf109d8829689fe6b86459012378b0602d436cd69b6f8362e201d4900887b4caf589b20e8d85b6cbeac4ce6362696c1c55e6b976324c3bdb00e24
+  data.tar.gz: f6fb82669a9a5022574e207fec635a293ea948bacd368e0aa2fa7e6831cb0e75a08652e89897bf3fee189b5f33379b1c41e4165ad142fc9260de1fe9a435bbbc

data/.rspec

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

data/.standard.yml

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

data/LICENSE.txt

@@ -1,21 +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.
+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

@@ -1,34 +1,201 @@
-# CommsSdk
+# comms_sdk Ruby SDK
 
-TODO: Delete this and the text below, and describe your gem
+A Ruby implementation of the CommsSDK for sending SMS and managing communications, following the same patterns as the Python and Kotlin reference implementations.
 
-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.
+**Version:** 1.0.1
+
+---
+
+## Features
+
+- Consistent API across all supported languages
+- Authenticate with username and API key
+- Send SMS to one or more recipients
+- Optional sender ID and message priority
+- Check account balance
+- Comprehensive error handling
+
+---
 
 ## 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.
+Add this line to your application's Gemfile:
 
-Install the gem and add to the application's Gemfile by executing:
+```ruby
+gem 'comms_sdk', '~> 1.0.1'
+```
+
+And then execute:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle install
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install it yourself as:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install comms_sdk
 ```
 
+---
+
 ## Usage
 
-TODO: Write usage instructions here
+### Basic Authentication
+
+```ruby
+require 'comms_sdk/v1'
+
+# Authenticate with username and API key
+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
+
+- `with_sender_id(sender_id)`
+  Set sender ID, returns self for chaining.
+- `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.
+- `set_authenticated`
+  Mark SDK as authenticated (internal use).
+
+#### Attributes
+
+- `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
+
+- `MessagePriority::HIGHEST` - Priority "0"
+- `MessagePriority::HIGH` - Priority "1"
+- `MessagePriority::MEDIUM` - Priority "2"
+- `MessagePriority::LOW` - Priority "3"
+- `MessagePriority::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::V1::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.
+
+---
 
-## Development
+## Contributing
 
-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.
+Bug reports and pull requests are welcome on GitHub.
 
-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
 

data/Rakefile

@@ -1,10 +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]
+# 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/build_and_upload.sh

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

data/lib/comms_sdk/v1/README.md

@@ -1,167 +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
-
+# 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

@@ -9,7 +9,7 @@ require_relative 'utils'
 module CommsSdk
   module V1
     class CommsSDK
-      API_URL = "http://176.58.101.43:8080/communications/api/v1/json/"
+      API_URL = "https://comms-test.pahappa.net/api/v1/json/"
 
       attr_reader :api_key, :user_name, :sender_id, :is_authenticated
 
@@ -30,12 +30,12 @@ module CommsSdk
 
       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")
+        const_set(:API_URL, "https://comms-test.pahappa.net/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")
+        const_set(:API_URL, "https://comms-test.pahappa.net/api/v1/json")
       end
 
       def set_authenticated

data/lib/comms_sdk/version.rb

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

data/lib/comms_sdk.rb

@@ -1,13 +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
+# 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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: comms_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Daniel
@@ -21,6 +21,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- build_and_upload.sh
 - lib/comms_sdk.rb
 - lib/comms_sdk/v1/README.md
 - lib/comms_sdk/v1/comms_sdk.rb