semaphore-sms-ruby 2.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 818fc7db1d70da7136fa8bb4403d90c3a01ead401e87a8c542d295661d8bd9fc
+  data.tar.gz: da60d0de2ede2bff17c3965b9ac59de2080e8d66dd05120dde64215a3c447150
+SHA512:
+  metadata.gz: aa511710399ca2936cd0e90ee78cd1e27e7d7dead6735f6c52ed34151d406bc5cbaa133c9fe57f9affa470a8f8d27f9492f510679b675c7280ddb2480fd261ac
+  data.tar.gz: fafab793c7f84f7cde78129b0e565a065447eab503e145b5a75d4c4d99d29944b6491cf07a8d848d72ca8d846004cbf91b133ab9cf32f82fb61bd556f63a250e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Prince Karlo
+
+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,115 @@
+# Semaphore
+
+This gem provides a simple and intuitive Ruby API wrapper for interacting with the Semaphore API. With this gem, you can easily send messages, manage accounts, and perform other operations using the Semaphore API.
+
+> **Note:** This gem has been renamed from `ruby-semaphore` to `semaphore-sms-ruby`, and the client namespace is now `SemaphoreSMS` (previously `Semaphore`). Update your Gemfile and code accordingly if you were using the previous names.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "semaphore-sms-ruby"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install semaphore-sms-ruby
+```
+
+## Usage
+
+- Get your API key from https://semaphore.co/account
+
+### Quickstart
+
+For a quick test you can pass your token directly to a new client:
+
+```rb
+client = SemaphoreSMS::Client.new(api_key: '[API KEY]', sender_name: '[SENDER NAME]')
+
+# Sending a message
+client.messages.send(
+  message: '[YOUR MESSAGE]',
+  number: '[NUMBER]'
+)
+
+# Sending a bulk message
+client.messages.bulk_send(
+  message: '[YOUR MESSAGE]',
+  numbers: ['NUMBER', 'NUMBER', 'NUMBER', 'NUMBER']
+)
+
+# Sending a priority message
+client.priority.send(
+  message: '[YOUR MESSAGE]',
+  number: '[NUMBER]'
+)
+
+# Sending an OTP
+client.otp.send(
+  message: 'Thanks for registering. Your OTP Code is {otp}.',
+  number: '[NUMBER]',
+  code: 1234
+)
+
+# Retrieving a message
+client.messages.retrieve(123)
+
+# Listing messages
+client.messages.list(limit: 100, page: 1)
+
+# Account
+client.account.retrieve
+client.account.transactions(limit: 100, page: 1)
+client.account.sender_names
+client.account.users
+```
+
+### Using Config
+
+To enhance your setup, you can configure the gem with your API keys in a more secure manner, such as in a `semaphore_sms.rb` initializer file. This approach prevents hardcoding secrets directly into your codebase. Instead, consider using a gem like [dotenv](https://github.com/motdotla/dotenv) to safely pass the keys into your environments.
+
+```rb
+# config/initializers/semaphore_sms.rb
+
+SemaphoreSMS.configure do |config|
+  config.api_key = ENV.fetch("SEMAPHORE_API_KEY")
+  config.sender_name = ENV.fetch("SEMAPHORE_SENDERNAME")
+end
+```
+
+After configuring the API key, you can simply create a new client:
+
+```rb
+client = SemaphoreSMS::Client.new
+
+client.messages.send(
+  message: '[YOUR MESSAGE]',
+  number: '[NUMBER]'
+)
+```
+
+## Development
+
+```bash
+bundle install
+bundle exec rake        # specs + rubocop
+bundle exec rake spec
+bundle exec rake rubocop
+```
+
+## Contributing
+
+Contributions are welcome! Please follow the guidelines outlined in the [CONTRIBUTING.md](https://github.com/frinsdev/ruby-semaphore-sms/blob/main/CONTRIBUTING.md) file.
+
+## 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,9 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/ruby/semaphore.rb

@@ -0,0 +1,2 @@
+require_relative '../semaphore_sms'
+require_relative '../semaphore_sms/compatibility'

data/lib/semaphore_sms/client.rb

@@ -0,0 +1,37 @@
+module SemaphoreSMS
+  class Client
+    include SemaphoreSMS::HTTP
+
+    CONFIG_KEYS = %i[
+      api_version
+      api_key
+      sender_name
+      uri_base
+      request_timeout
+    ].freeze
+
+    attr_reader(*CONFIG_KEYS)
+
+    def initialize(config = {})
+      CONFIG_KEYS.each do |key|
+        instance_variable_set("@#{key}", config[key] || SemaphoreSMS.configuration.send(key))
+      end
+    end
+
+    def messages
+      @messages ||= Resources::Messages.new(self)
+    end
+
+    def priority
+      @priority ||= Resources::Priority.new(self)
+    end
+
+    def otp
+      @otp ||= Resources::Otp.new(self)
+    end
+
+    def account
+      @account ||= Resources::Account.new(self)
+    end
+  end
+end

data/lib/semaphore_sms/compatibility.rb

@@ -0,0 +1,9 @@
+module Ruby
+  module Semaphore
+    VERSION = ::SemaphoreSMS::VERSION
+
+    Error = ::SemaphoreSMS::Error
+    ConfigurationError = ::SemaphoreSMS::ConfigurationError
+    Configuration = ::SemaphoreSMS::Configuration
+  end
+end

data/lib/semaphore_sms/http.rb

@@ -0,0 +1,36 @@
+module SemaphoreSMS
+  module HTTP
+    def post_request(path:, parameters: {})
+      conn.post(uri(path:)) do |req|
+        configure_request_params(req, parameters)
+      end&.body
+    end
+
+    def get_request(path:, parameters: {})
+      conn.get(uri(path:)) do |req|
+        configure_request_params(req, parameters)
+      end&.body
+    end
+
+    private
+
+    def configure_request_params(req, parameters)
+      req_parameters = parameters.dup
+      req_parameters[:apikey] = @api_key
+      req_parameters[:sender_name] = @sender_name
+      req.params = req_parameters
+    end
+
+    def conn
+      Faraday.new do |f|
+        f.options[:timeout] = @request_timeout
+        f.response :raise_error
+        f.response :json
+      end
+    end
+
+    def uri(path:)
+      URI("#{@uri_base}#{@api_version}#{path}")
+    end
+  end
+end

data/lib/semaphore_sms/railtie.rb

@@ -0,0 +1,6 @@
+module Ruby
+  module Semaphore
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/semaphore_sms/resources/account.rb

@@ -0,0 +1,40 @@
+module SemaphoreSMS
+  module Resources
+    class Account
+      def initialize(client)
+        @client = client
+      end
+
+      def retrieve
+        @client.get_request(path: '/account')
+      end
+
+      def transactions(limit: nil, page: nil)
+        @client.get_request(
+          path: '/account/transactions',
+          parameters: compact_params(limit:, page:)
+        )
+      end
+
+      def sender_names(limit: nil, page: nil)
+        @client.get_request(
+          path: '/account/sendernames',
+          parameters: compact_params(limit:, page:)
+        )
+      end
+
+      def users(limit: nil, page: nil)
+        @client.get_request(
+          path: '/account/users',
+          parameters: compact_params(limit:, page:)
+        )
+      end
+
+      private
+
+      def compact_params(**parameters)
+        parameters.compact
+      end
+    end
+  end
+end

data/lib/semaphore_sms/resources/messages.rb

@@ -0,0 +1,51 @@
+module SemaphoreSMS
+  module Resources
+    class Messages
+      def initialize(client)
+        @client = client
+      end
+
+      def send(message:, number:, **parameters)
+        @client.post_request(
+          path: '/messages',
+          parameters: compact_params(message:, number:, **parameters)
+        )
+      end
+
+      def bulk_send(message:, numbers:, **parameters)
+        @client.post_request(
+          path: '/messages',
+          parameters: compact_params(
+            message:,
+            number: Array(numbers).join(','),
+            **parameters
+          )
+        )
+      end
+
+      def retrieve(id)
+        @client.get_request(path: "/messages/#{id}")
+      end
+
+      def list(limit: nil, page: nil, start_date: nil, end_date: nil, network: nil, status: nil)
+        @client.get_request(
+          path: '/messages',
+          parameters: compact_params(
+            limit:,
+            page:,
+            startDate: start_date,
+            endDate: end_date,
+            network:,
+            status:
+          )
+        )
+      end
+
+      private
+
+      def compact_params(**parameters)
+        parameters.compact
+      end
+    end
+  end
+end

data/lib/semaphore_sms/resources/otp.rb

@@ -0,0 +1,22 @@
+module SemaphoreSMS
+  module Resources
+    class Otp
+      def initialize(client)
+        @client = client
+      end
+
+      def send(message:, number:, code: nil, **parameters)
+        @client.post_request(
+          path: '/otp',
+          parameters: compact_params(message:, number:, code:, **parameters)
+        )
+      end
+
+      private
+
+      def compact_params(**parameters)
+        parameters.compact
+      end
+    end
+  end
+end

data/lib/semaphore_sms/resources/priority.rb

@@ -0,0 +1,22 @@
+module SemaphoreSMS
+  module Resources
+    class Priority
+      def initialize(client)
+        @client = client
+      end
+
+      def send(message:, number:, **parameters)
+        @client.post_request(
+          path: '/priority',
+          parameters: compact_params(message:, number:, **parameters)
+        )
+      end
+
+      private
+
+      def compact_params(**parameters)
+        parameters.compact
+      end
+    end
+  end
+end

data/lib/semaphore_sms/version.rb

@@ -0,0 +1,3 @@
+module SemaphoreSMS
+  VERSION = '2.1.2'.freeze
+end

data/lib/semaphore_sms.rb

@@ -0,0 +1,57 @@
+require 'faraday'
+
+require_relative 'semaphore_sms/http'
+require_relative 'semaphore_sms/resources/messages'
+require_relative 'semaphore_sms/resources/priority'
+require_relative 'semaphore_sms/resources/otp'
+require_relative 'semaphore_sms/resources/account'
+require_relative 'semaphore_sms/client'
+require_relative 'semaphore_sms/version'
+
+module SemaphoreSMS
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+
+  class Configuration
+    attr_writer :api_key, :sender_name
+    attr_accessor :api_version, :uri_base, :request_timeout
+
+    DEFAULT_API_VERSION = 'v4'.freeze
+    DEFAULT_URI_BASE = 'https://api.semaphore.co/api/'.freeze
+    DEFAULT_REQUEST_TIMEOUT = 120
+
+    def initialize
+      @api_key = nil
+      @api_version = DEFAULT_API_VERSION
+      @sender_name = nil
+      @uri_base = DEFAULT_URI_BASE
+      @request_timeout = DEFAULT_REQUEST_TIMEOUT
+    end
+
+    def api_key
+      return @api_key if @api_key
+
+      error_text = 'Semaphore access token missing! See https://semaphore.co/docs'
+      raise ConfigurationError, error_text
+    end
+
+    def sender_name
+      return @sender_name if @sender_name
+
+      error_text = 'Semaphore sender name missing! See https://semaphore.co/docs'
+      raise ConfigurationError, error_text
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= SemaphoreSMS::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: semaphore-sms-ruby
+version: !ruby/object:Gem::Version
+  version: 2.1.2
+platform: ruby
+authors:
+- Frins (Prince Karlo)
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+description: This gem provides a simple and intuitive Ruby API wrapper for interacting
+  with the Semaphore API.
+email:
+- frins.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/ruby/semaphore.rb
+- lib/semaphore_sms.rb
+- lib/semaphore_sms/client.rb
+- lib/semaphore_sms/compatibility.rb
+- lib/semaphore_sms/http.rb
+- lib/semaphore_sms/railtie.rb
+- lib/semaphore_sms/resources/account.rb
+- lib/semaphore_sms/resources/messages.rb
+- lib/semaphore_sms/resources/otp.rb
+- lib/semaphore_sms/resources/priority.rb
+- lib/semaphore_sms/version.rb
+homepage: https://bootyard.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://bootyard.com
+  source_code_uri: https://github.com/frinsdev/ruby-semaphore-sms
+  changelog_uri: https://github.com/frinsdev/ruby-semaphore-sms/releases
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Ruby API Wrapper for https://semaphore.co/
+test_files: []