ruby-semaphore 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7751eab577eb3dfadaa8b2b937c7f7ea25384176989193fe7d740d878033665d
+  data.tar.gz: da1579637995fc2be78bdee3d4185b65f66e3fb3efba235429217ae7d0413071
+SHA512:
+  metadata.gz: 9cbe7a81ac7474df3f174c2b4b9c64cb28c84913366d44a2d82a11c91d83b3c8c08dfb80cb90ad98440243e6675a383f160e765836d759637126323be31c4d78
+  data.tar.gz: b48c5c7453b6d660734b05db8a324713e1542a2e32e0f1c85abc1be623ca824ecbfb40575d44012b3009459b83cb6279fca9e7cae613bfdee1472f1fa764fb6f

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,89 @@
+# 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.
+
+## 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
+semaphore = Semaphore::Client.new(api_key: '[API KEY]', sender_name: '[SENDER NAME]')
+
+# Sending a message
+semaphore.messages(
+  parameters: {
+    message: '[YOUR MESSAGE]',
+    number: '[NUMBER]'
+  }
+)
+
+# Sending a Bulk Message
+semaphore.messages(
+  parameters: {
+    message: '[YOUR MESSAGE]',
+    number: '[NUMBER], [NUMBER], [NUMBER], [NUMBER]' # Comma separated
+  }
+)
+
+# Sending an OTP
+semaphore.otp(
+  parameters: {
+    message: 'Thanks for registering. Your OTP Code is {otp}.',
+    number: '[NUMBER]',
+    code: 1234
+  }
+)
+```
+
+### Using Config
+
+To enhance your setup, you can configure the gem with your API keys in a more secure manner, such as in an semaphore.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.rb
+
+Semaphore.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
+Semaphore::Client.new.messages(
+  parameters: {
+    message: '[YOUR MESSAGE]',
+    number: '[NUMBER]'
+  }
+)
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ruby-semaphore"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install ruby-semaphore
+```
+
+## Contributing
+
+Contributions are welcome! Please follow the guidelines outlined in the 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,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/ruby/semaphore.rb

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

data/lib/semaphore/client.rb

@@ -0,0 +1,53 @@
+module Semaphore
+  class Client
+    include Semaphore::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] || Semaphore.configuration.send(key))
+      end
+    end
+
+    def messages(parameters: {})
+      post_request(path: '/messages', parameters:)
+    end
+
+    def priority(parameters: {})
+      post_request(path: '/priority', parameters:)
+    end
+
+    def otp(parameters: {})
+      post_request(path: '/otp', parameters:)
+    end
+
+    def get_message(id, parameters: {})
+      get_request(path: "/messages/#{id}", parameters:)
+    end
+
+    def account(parameters: {})
+      get_request(path: '/account', parameters:)
+    end
+
+    def account_transactions(parameters: {})
+      get_request(path: '/account/transactions', parameters:)
+    end
+
+    def account_sendernames(parameters: {})
+      get_request(path: '/account/sendernames', parameters:)
+    end
+
+    def account_users(parameters: {})
+      get_request(path: '/account/users', parameters:)
+    end
+  end
+end

data/lib/semaphore/compatibility.rb

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

data/lib/semaphore/http.rb

@@ -0,0 +1,36 @@
+module Semaphore
+  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
+      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/railtie.rb

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

data/lib/semaphore/version.rb

@@ -0,0 +1,3 @@
+module Semaphore
+  VERSION = '1.0.0'.freeze
+end

data/lib/semaphore.rb

@@ -0,0 +1,53 @@
+require 'faraday'
+
+require_relative 'semaphore/http'
+require_relative 'semaphore/client'
+require_relative "semaphore/version"
+
+module Semaphore
+  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 ||= Semaphore::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: ruby-semaphore
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Prince Karlo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.12
+description: This gem provides a simple and intuitive Ruby API wrapper for interacting
+  with the Semaphore API.
+email:
+- 77134068+princekarlo-bootyard@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/ruby/semaphore.rb
+- lib/semaphore.rb
+- lib/semaphore/client.rb
+- lib/semaphore/compatibility.rb
+- lib/semaphore/http.rb
+- lib/semaphore/railtie.rb
+- lib/semaphore/version.rb
+homepage: https://bootyard.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://bootyard.com
+  source_code_uri: https://github.com/princekarlo-bootyard/ruby-semaphore
+  changelog_uri: https://github.com/princekarlo-bootyard/ruby-semaphore/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.15
+signing_key:
+specification_version: 4
+summary: Ruby API Wrapper for https://semaphore.co/
+test_files: []