infobip-sms 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43a0c6d82556bd74bf2d34a02dfce371443b054447c857ecabf43981f6e305b3
+  data.tar.gz: e6e3ff5485ab4d6ff21581a8021d073c47f43677a5635c9a981b8f22dcd17823
+SHA512:
+  metadata.gz: d83a05701ae12ce6a48418f6519cdec432532db359960c4548645bf51bdf3df4e4906fa74802d1de5593d230b7eecd0025ae03c0db3f6f70c1c274bf69362f26
+  data.tar.gz: 6caf838bcdd9de1b37dcac566e62a1e245e32fc35bbdf50396d32e51fbd0f6492e609dc310b634111f28549650fb30aef5cda8b049843864a8acd38382b4f8ca

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.4.2
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [0.1.0] - 2025-04-04
+
+- Initial release
+- sms/sms bulk via infobip functionalities added 
+- single sms message send 
+- bulk sms send 
+- sms single or bulk status check 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Michal Andros
+
+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,157 @@
+# Infobip::Sms
+
+Library to interact with INFOBIP SMS provider 
+
+To experiment with the code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+  $ bundle add infobip-sms
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+  $ gem install infobip-sms
+```
+
+## Usage
+    
+    When bundled, set up a initializer to provide URL and the Identifier
+
+    Simply create a protool_api_client.rb file in the initializers directory, and set it up like this:
+
+```ruby
+  ::Infobip::Sms::Request.configure do |c|
+    c.identifier           = 'Application name to identify in headers by'
+    c.base_url             = 'Infobip api base url configured'
+    c.api_key              = 'Infobip Api Key'
+    c.sms_identifier       = 'Message sender name'
+    c.sms_endpoint         = '/send_endpoint'
+    c.sms_reports_endpoint = '/report_endpoint'
+  end
+```
+
+Examples use for Infobip::Sms CLIENT
+
+```ruby
+  ::Infobip::Sms::Connection.new.send_single_sms(phone_number_with_prefix: +48600500400, content: "Some Message", custom_identifier: nil || "SMS_SENDER_NAME")
+```
+
+response:
+```ruby
+  {
+    "messages": [
+      {
+        "to": "41793026727",
+        "status": {
+          "groupId": 1,
+          "groupName": "PENDING",
+          "id": 26,
+          "name": "PENDING_ACCEPTED",
+          "description": "Message sent to next instance"
+        },
+        "messageId": "33644496xxxx05285365"
+      }
+    ]
+  }
+```
+
+```ruby
+  Infobip::Sms::Connection.new.get_reports(query: {bulkId: '44368913xxxxx434966'})
+```
+
+response: 
+```ruby
+  {
+    results: [
+      { bulk_id: "443689xxxxxx35434966",
+        message_id: "44368913715xx4967",
+        to: "4860xxx",
+        from: "TEST",
+        sent_at: "2025-04-03T14:05:37.157+0000",
+        done_at: "2025-04-03T14:05:37.615+0000",
+        sms_count: 1,
+        mcc_mnc: "null",
+        price: { price_per_message: 0.0558194, currency: "PLN" },
+        status: { group_id: 3, group_name: "DELIVERED", id: 5, name: "DELIVERED_TO_HANDSET", description: "Message delivered to handset" },
+        error: { group_id: 0, group_name: "OK", id: 0, name: "NO_ERROR", description: "No Error", permanent: false }
+      },
+      {
+        bulk_id: "443689xxxxxx434966",
+        message_id: "443689xx35434968",
+        to: "4866xxx",
+        from: "TEST",
+        sent_at: "2025-04-03T14:05:37.157+0000",
+        done_at: "2025-04-03T14:05:38.793+0000",
+        sms_count: 1,
+        mcc_mnc: "null",
+        price: { price_per_message: 0.0558194, currency: "PLN" },
+        status: { group_id: 3, group_name: "DELIVERED", id: 5, name: "DELIVERED_TO_HANDSET", description: "Message delivered to handset" },
+        error: { group_id: 0, group_name: "OK", id: 0, name: "NO_ERROR", description: "No Error", permanent: false }
+      }
+    ]
+}
+```
+
+```ruby
+  ::Infobip::Sms::Connection.new.send_bulk_sms(query: { bulkId: '123', messageId: '123' })
+```
+
+response: 
+```ruby 
+{
+    "results": [
+        {
+            "bulkId": "33649386xxx572262",
+            "messageId": "336xx86024303572263",
+            "to": "41793026727",
+            "from": "InfoSMS",
+            "sentAt": "2021-11-09T21:37:40.258+0000",
+            "doneAt": "2021-11-09T21:37:42.910+0000",
+            "smsCount": 1,
+            "mccMnc": "null",
+            "price": {
+                "pricePerMessage": 0,
+                "currency": "EUR"
+            },
+            "status": {
+                "groupId": 3,
+                "groupName": "DELIVERED",
+                "id": 5,
+                "name": "DELIVERED_TO_HANDSET",
+                "description": "Message delivered to handset"
+            },
+            "error": {
+                "groupId": 0,
+                "groupName": "OK",
+                "id": 0,
+                "name": "NO_ERROR",
+                "description": "No Error",
+                "permanent": false
+            }
+        }
+    ]
+}
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mandros1985/infobip-sms. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mandros1985/infobip-sms/blob/name/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Infobip::Sms project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/infobip-sms/blob/name/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/lib/infobip/sms/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Infobip
+  module Sms
+    class Configuration
+      attr_accessor :identifier, :base_url, :api_key, :sms_identifier, :sms_endpoint, :sms_reports_endpoint
+  
+      def initialize
+        @identifier           = nil
+        @base_url             = nil
+        @sms_identifier       = nil
+        @api_key              = nil
+        @sms_endpoint         = nil
+        @sms_reports_endpoint = nil
+      end
+    end
+  end
+end

data/lib/infobip/sms/connection.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Infobip
+  module Sms
+    class Connection
+      def call(path:, method: :post, body: nil, query: nil)
+        ::Infobip::Sms::Request.new(method: method, body: body, query: query).make_request(path: path)
+      end
+  
+      # Send sms message - single sms
+      # @param phone_number_with_prefix [String]
+      # @param content [String]
+      # @param custom_identifier [String]
+      def send_single_sms(phone_number_with_prefix:, content:, custom_identifier: nil)
+        body = {
+          "messages": [
+            {
+              "from": custom_identifier || ::Infobip::Sms::Request.configuration.sms_identifier,
+              "destinations": [
+                {
+                  "to": phone_number_with_prefix
+                }
+              ],
+              "text": content
+            }
+          ]
+        }
+        call(path: ::Infobip::Sms::Request.configuration.sms_endpoint || "/sms/2/text/advanced", method: :post, body: body)
+      end
+      
+      # Send sms message - bulk sms
+      # @param phone_numbers_with_prefix [Array]
+      # @param content [String]
+      # @param custom_identifier [String]
+      def send_bulk_sms(phone_numbers_with_prefix:, content:, custom_identifier: nil)
+        body = { "messages": [] }
+        phone_numbers_with_prefix.each do |phone_number|
+          body[:"messages"] << {
+            "from": custom_identifier || ::Infobip::Sms::Request.configuration.sms_identifier,
+            "destinations": [
+              {
+                "to": phone_number
+              }
+            ],
+            "text": content
+          }
+        end
+        
+        call(path: ::Infobip::Sms::Request.configuration.sms_endpoint || "/sms/2/text/advanced", method: :post, body: body)
+      end
+      
+      # Check report for bulk or for message_id
+      # @param query [Ruby Hash]
+      # {bulkId: '123', messageId: '123'}
+      # /sms/1/reports?bulkId={{recentBulkId}}&messageId={{recentMessageId}}&limit=453367
+      # LOGS CAN ONLY BE QUERIED ONCE ! after that results are empty
+      def get_reports(query:)
+        call(path: ::Infobip::Sms::Request.configuration.sms_reports_endpoint || "/sms/1/reports", method: :get, query: query)
+      end
+    end
+  end
+end

data/lib/infobip/sms/request.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Infobip
+  module Sms
+    class Request
+      attr_accessor :response, :request
+  
+      class << self
+        attr_accessor :configuration
+      end
+  
+      def self.configure
+        self.configuration ||= ::Infobip::Sms::Configuration.new
+        yield(configuration)
+      end
+  
+      def initialize(base_url: nil, method: nil, payload: nil,
+                     open_timeout: nil, read_timeout: nil, keep_alive_timeout: nil,
+                     verify_mode: nil, body: nil, query: nil)
+        raise "No configuration credentials provided !" if ::Infobip::Sms::Request.configuration.blank?
+  
+        @base_url           = ::Infobip::Sms::Request.configuration.base_url
+        @method             = method.present? ? method.to_s.downcase.intern : :get
+        @payload            = payload
+        @body               = body
+        @query              = query
+        @open_timeout       = open_timeout || 2.minutes
+        @read_timeout       = read_timeout || 2.minutes
+        @keep_alive_timeout = keep_alive_timeout || 20.seconds
+        @verify_mode        = verify_mode || OpenSSL::SSL::VERIFY_NONE
+      end
+  
+      def make_request(path:)
+        retry_count ||= 0
+        @path = "/#{path}" if path[0] != "/" && path.size >= 1
+  
+        uri_obj = uri(host: base_url, path: path)
+  
+        resp = Net::HTTP.start(uri_obj.host, uri_obj.port, use_ssl: uri_obj.scheme == "https",
+                                                           open_timeout: open_timeout, read_timeout: read_timeout,
+                                                           keep_alive_timeout: keep_alive_timeout, verify_mode: verify_mode) do |http|
+          @request = build_request_method(uri: uri_obj)
+          http.request(request)
+        end
+        case resp
+        when Net::HTTPSuccess
+          parse(body: resp.body)
+        else
+          resp.value
+        end
+      rescue Net::HTTPServerException => e
+        raise(e) unless (retry_count += 1) <= 3
+  
+        retry
+      end
+  
+      def build_request_method(uri:)
+        r = case method
+            when :get
+              Net::HTTP::Get.new uri
+            when :post
+              Net::HTTP::Post.new uri
+            when :patch
+              Net::HTTP::Patch.new uri
+            when :put
+              Net::HTTP::Put.new uri
+            else
+              raise "Unexpected method: #{method}"
+            end
+        r["OpenStack-Identity"] = ::Infobip::Sms::Request.configuration.identifier
+        r["Authorization"] = "App #{::Infobip::Sms::Request.configuration.api_key}"
+        if body.present?
+          r["Content-Type"] = "application/json"
+          r.body = body.try(:to_json)
+        end
+        r.set_form_data(payload) if payload.present?
+        # r.basic_auth user, password
+        # binding.pry
+        r
+      end
+  
+      def parse(body:)
+        body = JSON.parse(body)
+        symbolize(body)
+      rescue JSON::ParserError
+        body
+      end
+  
+      def symbolize(body)
+        if body.is_a?(Array)
+          body.map do |array|
+            symbolize(array)
+          end
+        else
+          body.deep_transform_keys(&:underscore).deep_symbolize_keys
+        end
+      end
+  
+      def uri(host:, path:)
+        uri = URI.parse(host + path)
+        uri.query = URI.encode_www_form(query) if query.present?
+        uri
+      end
+  
+      private
+  
+      attr_reader :base_url, :method, :payload, :open_timeout,
+                  :read_timeout, :keep_alive_timeout, :verify_mode,
+                  :path, :body, :query
+    end
+  end
+end

data/lib/infobip/sms/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Infobip
+  module Sms
+    VERSION = "0.1.1"
+  end
+end

data/lib/infobip/sms.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'sms/version'
+require "openssl"
+require "json"
+require "net/http"
+# require 'pry'
+require "active_support/all"
+require "infobip/sms/request"
+require "infobip/sms/configuration"
+require "infobip/sms/connection"
+
+
+
+module Infobip
+  module Sms
+    class Error < StandardError; end
+  end
+end

data/sig/infobip/sms.rbs

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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: infobip-sms
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Michal Andros
+bindir: exe
+cert_chain: []
+date: 2025-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.74'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.74'
+description: single and bulk sms send and status check capabilities
+email:
+- michalandros@amcode.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/infobip/sms.rb
+- lib/infobip/sms/configuration.rb
+- lib/infobip/sms/connection.rb
+- lib/infobip/sms/request.rb
+- lib/infobip/sms/version.rb
+- sig/infobip/sms.rbs
+homepage: https://github.com/mandros1985/infobip-sms
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mandros1985/infobip-sms
+  source_code_uri: https://github.com/mandros1985/infobip-sms
+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.6
+specification_version: 4
+summary: Specs for main functionalities
+test_files: []