termii_ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71c1cf1dc8fcfaaf33a33624d3fd0e0c891ff19fda4e462d3c649de79ee82898
-  data.tar.gz: 060b6b77bd2ae007cc21abe66977bc56e5ad667424f7de5bf3eb6f394d7a67dd
+  metadata.gz: 845e38ac1d73b88056bd65863f81b0d46d252d773decdf6326711014db0bac10
+  data.tar.gz: fe3813e56c0eead5056e5546d10ba9fa67977551003950fc48e93f216540a488
 SHA512:
-  metadata.gz: 8dd27e9102e0c0cccf49d040a82272cf9d2e3cff4a8ba3d573e0d89d9f1a842b36934729c98c957fa0cea1dc09203fe0624aabffcdbd237c2a438c92fa43b4c2
-  data.tar.gz: 70b70e594906908edaf7d42e1cdb675bd7b31a40c513134a765044890dc61dec21e57e1cf6416d2904626f1efd552225f29b600396fbbe260015f21e7657cefc
+  metadata.gz: 8b8f959a635d3f0e35a19a91b38b14e30464dcc1419af766d8c4c89dbf79156d58ba0599a769d580c497255fbbc5e6683fed69281e809375bae198bec3f1b53d
+  data.tar.gz: 6b21733a176c75782c23541f78ea5ba6d066e4ad200ed616f80b27ff91c1e3d030f3d57b411d1832930a43a953d119d1c81943f6a06c2be100aa8d2425249cef

data/.rubocop.yml

@@ -25,4 +25,7 @@ Layout/LineLength:
   Enabled: false
 
 Lint/MissingSuper:
+  Enabled: false
+
+Metrics/BlockLength:
   Enabled: false

data/Gemfile

@@ -10,6 +10,9 @@ gem "rspec", "~> 3.0"
 
 gem "faraday", "~> 2.7", ">= 2.7.4"
 gem "faraday-retry"
+group :test do
+  gem "webmock", "~> 3.18", ">= 3.18.1"
+end
 
 # gem "pry", "~> 0.13.1"
 gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -1,12 +1,16 @@
 PATH
   remote: .
   specs:
-    termii_ruby (0.1.0)
+    termii_ruby (0.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.5.0)
     faraday (2.7.4)
       faraday-net_http (>= 2.0, < 3.1)
@@ -14,10 +18,12 @@ GEM
     faraday-net_http (3.0.2)
     faraday-retry (2.1.0)
       faraday (~> 2.0)
+    hashdiff (1.0.1)
     json (2.6.3)
     parallel (1.23.0)
     parser (3.2.2.1)
       ast (~> 2.4.1)
+    public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.0)
@@ -50,6 +56,10 @@ GEM
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     unicode-display_width (2.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   x86_64-linux
@@ -61,6 +71,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   rubocop (~> 1.21)
   termii_ruby!
+  webmock (~> 3.18, >= 3.18.1)
 
 BUNDLED WITH
    2.3.5

data/README.md

@@ -9,7 +9,7 @@ TODO: Delete this and the text above, and describe your gem
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'termii_ruby'
+gem 'termii_ruby', '~> 0.1.0'
 ```
 
 And then execute:
@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+
 
 ## Development
 
@@ -32,7 +32,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/termii_ruby. 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/[USERNAME]/termii_ruby/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/collinsugwu/termii_ruby. 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/collinsugwu/termii_ruby/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +40,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the TermiiRuby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/termii_ruby/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the TermiiRuby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/collinsugwu/termii_ruby/blob/master/CODE_OF_CONDUCT.md).

data/lib/termii_ruby/abstract_client.rb

@@ -1,12 +1,26 @@
 # frozen_string_literal: true
 
-
 module TermiiRuby
+  #
+  # @author Collins
+  # A class to enforce the request methods
+  # @abstract
+  #
   class AbstractClient
+    #
+    # Ensure the subclass implements the make_get_request method
+    #
+    # @return [Object] NotImplementedError
+    #
     def make_get_request
       raise NotImplementedError, "Subclasses must implement the make_get_request method"
     end
 
+    #
+    # Ensure the subclass implements the make_post_request method
+    #
+    # @return [Object] NotImplementedError
+    #
     def make_post_request
       raise NotImplementedError, "Subclasses must implement the make_post_request method"
     end

data/lib/termii_ruby/client.rb

@@ -6,6 +6,10 @@ require "faraday/retry"
 require_relative "abstract_client"
 
 module TermiiRuby
+  #
+  # @author Collins Ugwu
+  # Client class to make request to Termii endpoints
+  #
   class Client < TermiiRuby::AbstractClient
     def initialize(api_key)
       @api_key = api_key
@@ -24,10 +28,7 @@ module TermiiRuby
         end
       end
 
-      {
-        status: response.status,
-        data: response.body
-      }
+      request_response(response)
     end
 
     def make_post_request(endpoint, args = {})
@@ -38,14 +39,18 @@ module TermiiRuby
         req.body = args.to_json
       end
 
+      request_response(response)
+    end
+
+    private
+
+    def request_response(response)
       {
         status: response.status,
         data: response.body
       }
     end
 
-    private
-
     def request_url(endpoint)
       "#{base_url}/#{endpoint}"
     end

data/lib/termii_ruby/insight.rb

@@ -5,6 +5,10 @@ require_relative "termii"
 require_relative "client"
 
 module TermiiRuby
+  #
+  # @author Collins Ugwu
+  # Retrieve real-time delivery report of messages sent to customers as well as the status of their contacts
+  #
   class Insight < TermiiRuby::Termii
     QUERY = "phone_number"
 
@@ -15,10 +19,23 @@ module TermiiRuby
 
     def verify; end
 
+    #
+    # The Balance API returns your total balance and balance information from your wallet, such as currency.
+    #
+    # @return [JSON] JSON object
+    #
     def balance
       @client.make_get_request(GET_BALANCE)
     end
 
+    #
+    # The search API allows businesses verify phone numbers and automatically detect their status as well as current network
+    #
+    # @param [String] phone_number Represents the phone number to be verified. Phone number must be in the international format (Example: 23490126727)
+    # @param [Hash] query Hash of the query params
+    #
+    # @return [JSON] JSON object
+    #
     def search(phone_number, query = {})
       if query.empty?
         query = {
@@ -29,6 +46,14 @@ module TermiiRuby
       @client.make_get_request(SEARCH, query)
     end
 
+    #
+    # The status API allows businesses to detect if a number is fake or has ported to a new network.
+    #
+    # @param [<Type>] phone_number Represents the phone number to be verified. Phone number must be in the international format (Example: 2348753243651)
+    # @param [Hash] query Hash of the query params
+    #
+    # @return [JSON] JSON object
+    #
     def status(phone_number, query = {})
       if query.empty?
         query = {
@@ -39,6 +64,11 @@ module TermiiRuby
       @client.make_get_request(STATUS, query)
     end
 
+    #
+    # This Inbox API returns reports for messages sent across the sms, voice & whatsapp channels. Reports can either display all messages on termii or a single message.
+    #
+    # @return [JSON] JSON object
+    #
     def history
       @client.make_get_request(HISTORY)
     end

data/lib/termii_ruby/sender.rb

@@ -5,12 +5,25 @@ require_relative "termii"
 require_relative "client"
 
 module TermiiRuby
+  #
+  # @author Collins Ugwu
+  # Sender Class for creating and fetching the sender ID
+  #
   class Sender < TermiiRuby::Termii
     def initialize(api_key)
       super()
       @client = TermiiRuby::Client.new(api_key)
     end
 
+    #
+    # Create a Sender ID
+    #
+    # @param [String] sender_id Represents the ID of the sender which can be alphanumeric or numeric
+    # @param [String] usecase A sample of the type of message sent.
+    # @param [String] company Represents the name of the company with the sender ID.
+    #
+    # @return [JSON] JSON object
+    #
     def create_sender(sender_id, usecase, company)
       data = {
         sender_id: sender_id,
@@ -20,6 +33,11 @@ module TermiiRuby
       @client.make_post_request(CREATE_SENDER, data)
     end
 
+    #
+    # A Sender ID is the name or number that identifies the sender of an SMS message.
+    #
+    # @return [JSON] JSON object
+    #
     def fetch_senders
       @client.make_get_request(FETCH_SENDER)
     end

data/lib/termii_ruby/termii.rb

@@ -1,13 +1,38 @@
 # frozen_string_literal: true
 
-# Base Class
-
 require_relative "mixins/endpoints"
 
 module TermiiRuby
+  #
+  # @author Collins Ugwu
+  # Base Termii Class
+  #
   class Termii
     include TermiiRuby::Mixins::Endpoints
-    attr_accessor :message_text, :pin_type, :channel, :pin_attempts, :pin_length, :pin_time_to_live, :pin_placeholder
+
+    # @return [Stiring] Enum: "NUMERIC" "ALPHANUMERIC" Type of message that will be generated and sent as part of the OTP message. You can set message type to numeric or alphanumeric
+    attr_accessor :message_type
+
+    # @return [String] "NUMERIC"
+    attr_accessor :pin_type
+
+    # @return [String] This is the route through which the message is sent. It is either dnd, WhatsApp, or generic or email
+    attr_accessor :channel
+
+    # @return [Integer] Example: 3 Represents the number of times the PIN can be attempted before expiration. It has a minimum of one attempt
+    attr_accessor :pin_attempts
+
+    # @return [Integer] The length of the PIN code.It has a minimum of 4 and maximum of 8.
+    attr_accessor :pin_length
+
+    # @return [Interger] Represents how long the PIN is valid before expiration. The time is in minutes. The minimum time value is 0 and the maximum time value is 60
+    attr_accessor :pin_time_to_live
+
+    # @return [String] Example: "< 1234 >" PIN placeholder. Right before sending the message, PIN code placeholder will be replaced with generate PIN code.
+    attr_accessor :pin_placeholder
+
+    # @return [String] Represents short alphabetic codes developed to represent countries
+    attr_accessor :country_code
 
     def initialize
       @message_type = "NUMERIC"
@@ -20,10 +45,22 @@ module TermiiRuby
       @country_code = "NG"
     end
 
+    #
+    # Subclasses must implement the verify method
+    #
+    # @return [Object] NotImplementedError
+    #
     def verify
       raise NotImplementedError, "Subclasses must implement the verify method"
     end
 
+    #
+    # <Description>
+    #
+    # @param [<Type>] attrs <description>
+    #
+    # @return [<Type>] <description>
+    #
     def update_attributes(attrs)
       attrs.each do |key, value|
         self[key.to_s] = value

data/lib/termii_ruby/token.rb

@@ -5,12 +5,25 @@ require_relative "termii"
 require_relative "client"
 
 module TermiiRuby
+  #
+  # @author Collins Ugwu
+  # Token allows businesses generate, send and verify one-time-passwords.
+  #
   class Token < TermiiRuby::Termii
     def initialize(api_key)
       super()
       @client = TermiiRuby::Client.new(api_key)
     end
 
+    #
+    # The send token API allows businesses trigger one-time-passwords (OTP) across any available messaging channel on Termii. One-time-passwords created are generated randomly and there's an option to set an expiry time.
+    #
+    # @param [string] to Represents the email address if the channel is set to email (Example: testshola@termii.com). It represents the destination phone number if other channels are selected. Phone number must be in the international format (Example: 23490126727)
+    # @param [string] from Represents the configuration ID if the channel is set to email (Example: 0a53c416-uocj-95af-ab3c306aellc). It can be found on your Termii dashboard. If other channels are selected, it represents a sender ID which can be alphanumeric or numeric. Alphanumeric sender ID length should be between 3 and 11 characters (Example:CompanyName)
+    # @param [string] message_text Text of a message that would be sent to the destination phone number
+    #
+    # @return [JSON] JSON object
+    #
     def send_otp_token(to, from, message_text)
       data = {
         to: to,
@@ -27,6 +40,13 @@ module TermiiRuby
       @client.make_post_request(SEND_OTP_TOKEN, data)
     end
 
+    #
+    # The voice token API enables you to generate and trigger one-time passwords (OTP) through the voice channel to a phone number. OTPs are generated and sent to the phone number and can only be verified using our Verify Token API .
+    #
+    # @param [string] phone_number The destination phone number. Phone number must be in the international format (Example: 23490126727)
+    #
+    # @return [JSON] JSON object
+    #
     def send_voice_token(phone_number)
       data = {
         phone_number: phone_number,
@@ -37,6 +57,14 @@ module TermiiRuby
       @client.make_post_request(SEND_VOICE_TOKEN, data)
     end
 
+    #
+    # The voice call API enables you to send messages from your application through our voice channel to a phone number. Only one-time-passwords (OTP) are allowed for now and these OTPs can not be verified using our Verify Token API.
+    #
+    # @param [String] phone_number The destination phone number. Phone number must be in the international format (Example: 23490126727)
+    # @param [Numeric] code Example: 3344, The code you want your users to receive. It has to be numeric and length must be between 4 and 8 digits.
+    #
+    # @return [JSON] JSON object
+    #
     def send_voice_call(phone_number, code)
       data = {
         phone_number: phone_number,
@@ -46,6 +74,13 @@ module TermiiRuby
       @client.make_post_request(SEND_VOICE_CALL, data)
     end
 
+    #
+    # This API returns OTP codes in JSON format which can be used within any web or mobile app.
+    #
+    # @param [String] phone_number Represents the destination phone number.Phone number must be in the international format (Example: 23490126727)
+    #
+    # @return [JSON] JSON object
+    #
     def send_in_app_token(phone_number)
       data = {
         phone_number: phone_number,
@@ -57,10 +92,18 @@ module TermiiRuby
       @client.make_post_request(SEND_IN_APP_TOKEN, data)
     end
 
-    def verify(pin_id, pin)
+    #
+    # Verify token API, checks tokens sent to customers and returns a response confirming the status of the token. A token can either be confirmed as verified or expired based on the timer set for the token.
+    #
+    # @param [string] pin_id ID of the PIN sent (Example: "c8dcd048-5e7f-4347-8c89-4470c3af0b")
+    # @param [string] token The PIN code (Example: "195558")
+    #
+    # @return [JSON] JSON object
+    #
+    def verify(pin_id, token)
       data = {
         pin_id: pin_id,
-        pin: pin
+        pin: token
       }
       @client.make_post_request(VERIFY_TOKEN, data)
     end

data/lib/termii_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TermiiRuby
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/termii_ruby.rb

@@ -5,6 +5,9 @@ require_relative "termii_ruby/sender"
 require_relative "termii_ruby/token"
 require_relative "termii_ruby/insight"
 
+#
+# <Description>
+#
 module TermiiRuby
   class Error < StandardError; end
   # Your code goes here...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: termii_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Collins Ugwu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-27 00:00:00.000000000 Z
+date: 2023-06-05 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby gem for integrating Termii messaging API
 email: