sms77 0.4.0 → 0.5.0

data/lib/sms77/client.rb

@@ -1,29 +1,30 @@
-# frozen_string_literal: true
-
-require 'sms77/resources/analytics'
-require 'sms77/resources/balance'
-require 'sms77/resources/contacts'
-require 'sms77/resources/hooks'
-require 'sms77/resources/journal'
-require 'sms77/resources/lookup'
-require 'sms77/resources/pricing'
-require 'sms77/resources/sms'
-require 'sms77/resources/status'
-require 'sms77/resources/validate_for_voice'
-require 'sms77/resources/voice'
-require 'sms77/util'
-
-module Sms77
-  class Client
-    # @param resource [Sms77::Resource]
-    def initialize(resource)
-      Sms77::Util::get_namespace_classes(Sms77::Resources).each do |cls|
-        name = cls.name.split('::').last
-
-        instance_variable_set("@#{name}", cls.new(resource))
-
-        singleton_class.instance_eval("attr_reader :#{name}")
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'sms77/resources/analytics'
+require 'sms77/resources/balance'
+require 'sms77/resources/contacts'
+require 'sms77/resources/hooks'
+require 'sms77/resources/journal'
+require 'sms77/resources/lookup'
+require 'sms77/resources/pricing'
+require 'sms77/resources/sms'
+require 'sms77/resources/status'
+require 'sms77/resources/subaccounts'
+require 'sms77/resources/validate_for_voice'
+require 'sms77/resources/voice'
+require 'sms77/util'
+
+module Sms77
+  class Client
+    # @param resource [Sms77::Resource]
+    def initialize(resource)
+      Sms77::Util::get_namespace_classes(Sms77::Resources).each do |cls|
+        name = cls.name.split('::').last
+
+        instance_variable_set("@#{name}", cls.new(resource))
+
+        singleton_class.instance_eval("attr_reader :#{name}")
+      end
+    end
+  end
+end

data/lib/sms77/contacts.rb

@@ -1,9 +1,10 @@
-# frozen_string_literal: true
-
-module Sms77::Contacts
-  module Action
-    DEL = 'del'
-    READ = 'read'
-    WRITE = 'write'
-  end
-end
+# frozen_string_literal: true
+
+# This module holds all utilities related to the /contacts endpoint.
+module Sms77::Contacts
+  module Action
+    DEL = 'del'
+    READ = 'read'
+    WRITE = 'write'
+  end
+end

data/lib/sms77/endpoint.rb

@@ -1,15 +1,17 @@
-# frozen_string_literal: true
-
-module Sms77::Endpoint
-  ANALYTICS = 'analytics'
-  BALANCE = 'balance'
-  CONTACTS = 'contacts'
-  HOOKS = 'hooks'
-  JOURNAL = 'journal'
-  LOOKUP = 'lookup'
-  PRICING = 'pricing'
-  SMS = 'sms'
-  STATUS = 'status'
-  VALIDATE_FOR_VOICE = 'validate_for_voice'
-  VOICE = 'voice'
-end
+# frozen_string_literal: true
+
+# This module exposes the endpoints covered by this client.
+module Sms77::Endpoint
+  ANALYTICS = 'analytics'
+  BALANCE = 'balance'
+  CONTACTS = 'contacts'
+  HOOKS = 'hooks'
+  JOURNAL = 'journal'
+  LOOKUP = 'lookup'
+  PRICING = 'pricing'
+  SMS = 'sms'
+  STATUS = 'status'
+  SUBACCOUNTS = 'subaccounts'
+  VALIDATE_FOR_VOICE = 'validate_for_voice'
+  VOICE = 'voice'
+end

data/lib/sms77/hooks.rb

@@ -1,64 +1,67 @@
-# frozen_string_literal: true
-
-module Sms77::Hooks
-  module Action
-    READ = 'read'
-    SUBSCRIBE = 'subscribe'
-    UNSUBSCRIBE = 'unsubscribe'
-  end
-
-  module EventType
-    ALL = 'all'
-    NEW_INBOUND_SMS = 'sms_mo'
-    SMS_STATUS_UPDATE = 'dlr'
-    VOICE_STATUS_UPDATE = 'voice_status'
-  end
-
-  module RequestMethod
-    GET = 'GET'
-    JSON = 'JSON'
-    POST = 'POST'
-  end
-
-  module Validator
-    def self.validate(params)
-      action = params[:action]
-
-      raise "Unknown action #{action}" unless Sms77::Hooks::Validator::is_action?(action)
-
-      if Sms77::Hooks::Action::SUBSCRIBE == action
-        raise 'Parameter validation failed' unless Sms77::Hooks::Validator::subscribe(params)
-      elsif Sms77::Hooks::Action::UNSUBSCRIBE == action
-        raise 'ID must be a positive integer' unless Sms77::Hooks::Validator::unsubscribe(params)
-      end
-    end
-
-    def self.subscribe(params)
-      { :request_method => Sms77::Hooks::RequestMethod::POST }.merge!(params)
-
-      self.event_type?(params[:event_type]) &&
-        self.request_method?(params[:request_method]) &&
-        self.target_url?(params[:target_url])
-    end
-
-    def self.unsubscribe(params)
-      Sms77::Util::is_positive_integer?(params[:id])
-    end
-
-    def self.is_action?(str)
-      Sms77::Util::in_module_constants?(str, Sms77::Hooks::Action)
-    end
-
-    def self.event_type?(str)
-      Sms77::Util::in_module_constants?(str, Sms77::Hooks::EventType)
-    end
-
-    def self.request_method?(str)
-      Sms77::Util::in_module_constants?(str, Sms77::Hooks::RequestMethod)
-    end
-
-    def self.target_url?(str)
-      Sms77::Util::is_valid_url?(str)
-    end
-  end
-end
+# frozen_string_literal: true
+
+# This module holds all utilities related to the /hooks endpoint.
+module Sms77::Hooks
+  module Action
+    READ = 'read'
+    SUBSCRIBE = 'subscribe'
+    UNSUBSCRIBE = 'unsubscribe'
+  end
+
+  module EventType
+    ALL = 'all'
+    NEW_INBOUND_SMS = 'sms_mo'
+    SMS_STATUS_UPDATE = 'dlr'
+    TRACKING = 'tracking'
+    VOICE_CALL = 'voice_call'
+    VOICE_STATUS_UPDATE = 'voice_status'
+  end
+
+  module RequestMethod
+    GET = 'GET'
+    JSON = 'JSON'
+    POST = 'POST'
+  end
+
+  module Validator
+    def self.validate(params)
+      action = params[:action]
+
+      raise "Unknown action #{action}" unless Sms77::Hooks::Validator::is_action?(action)
+
+      if Sms77::Hooks::Action::SUBSCRIBE == action
+        raise 'Parameter validation failed' unless Sms77::Hooks::Validator::subscribe(params)
+      elsif Sms77::Hooks::Action::UNSUBSCRIBE == action
+        raise 'ID must be a positive integer' unless Sms77::Hooks::Validator::unsubscribe(params)
+      end
+    end
+
+    def self.subscribe(params)
+      { :request_method => Sms77::Hooks::RequestMethod::POST }.merge!(params)
+
+      self.event_type?(params[:event_type]) &&
+        self.request_method?(params[:request_method]) &&
+        self.target_url?(params[:target_url])
+    end
+
+    def self.unsubscribe(params)
+      Sms77::Util::is_positive_integer?(params[:id])
+    end
+
+    def self.is_action?(str)
+      Sms77::Util::in_module_constants?(str, Sms77::Hooks::Action)
+    end
+
+    def self.event_type?(str)
+      Sms77::Util::in_module_constants?(str, Sms77::Hooks::EventType)
+    end
+
+    def self.request_method?(str)
+      Sms77::Util::in_module_constants?(str, Sms77::Hooks::RequestMethod)
+    end
+
+    def self.target_url?(str)
+      Sms77::Util::is_valid_url?(str)
+    end
+  end
+end

data/lib/sms77/journal.rb

@@ -1,38 +1,39 @@
-# frozen_string_literal: true
-
-module Sms77::Journal
-  module Type
-    INBOUND = 'inbound'
-    OUTBOUND = 'outbound'
-    REPLIES = 'replies'
-    VOICE = 'voice'
-  end
-
-  module Validator
-    def self.validate(params)
-      type = params[:type]
-      date_from = params[:date_from]
-      date_to = params[:date_to]
-
-      raise "Unknown type #{type}" unless Sms77::Journal::Validator::is_type?(type)
-      raise "Wrong date_from #{date_from}" unless Sms77::Journal::Validator::is_date?(date_from)
-      raise "Wrong date_to #{date_to}" unless Sms77::Journal::Validator::is_date?(date_to)
-    end
-
-    def self.subscribe(params)
-      { :request_method => Sms77::Hooks::RequestMethod::POST }.merge!(params)
-
-      self.event_type?(params[:event_type]) &&
-        self.request_method?(params[:request_method]) &&
-        self.target_url?(params[:target_url])
-    end
-
-    def self.is_type?(str)
-      Sms77::Util::in_module_constants?(str, Sms77::Journal::Type)
-    end
-
-    def self.is_date?(date)
-      date.is_a?(NilClass) || date.match(/[\d]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][\d]|3[0-1])/)
-    end
-  end
-end
+# frozen_string_literal: true
+
+# This module holds all utilities related to the /journal endpoint.
+module Sms77::Journal
+  module Type
+    INBOUND = 'inbound'
+    OUTBOUND = 'outbound'
+    REPLIES = 'replies'
+    VOICE = 'voice'
+  end
+
+  module Validator
+    def self.validate(params)
+      type = params[:type]
+      date_from = params[:date_from]
+      date_to = params[:date_to]
+
+      raise "Unknown type #{type}" unless Sms77::Journal::Validator::is_type?(type)
+      raise "Wrong date_from #{date_from}" unless Sms77::Journal::Validator::is_date?(date_from)
+      raise "Wrong date_to #{date_to}" unless Sms77::Journal::Validator::is_date?(date_to)
+    end
+
+    def self.subscribe(params)
+      { :request_method => Sms77::Hooks::RequestMethod::POST }.merge!(params)
+
+      self.event_type?(params[:event_type]) &&
+        self.request_method?(params[:request_method]) &&
+        self.target_url?(params[:target_url])
+    end
+
+    def self.is_type?(str)
+      Sms77::Util::in_module_constants?(str, Sms77::Journal::Type)
+    end
+
+    def self.is_date?(date)
+      date.is_a?(NilClass) || date.match(/[\d]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][\d]|3[0-1])/)
+    end
+  end
+end

data/lib/sms77/lookup.rb

@@ -1,10 +1,11 @@
-# frozen_string_literal: true
-
-module Sms77::Lookup
-  module Type
-    CNAM = 'cnam'
-    FORMAT = 'format'
-    HLR = 'hlr'
-    MNP = 'mnp'
-  end
-end
+# frozen_string_literal: true
+
+# This module holds all utilities related to the /lookup endpoint.
+module Sms77::Lookup
+  module Type
+    CNAM = 'cnam'
+    FORMAT = 'format'
+    HLR = 'hlr'
+    MNP = 'mnp'
+  end
+end

data/lib/sms77/resource.rb

@@ -1,93 +1,94 @@
-# frozen_string_literal: true
-
-require 'cgi'
-require 'json'
-require 'faraday'
-require 'sms77/endpoint'
-
-module Sms77
-  class Resource
-    attr_reader :api_key, :endpoint, :sent_with, :http_methods, :request_methods, :builder, :conn
-
-    BASE_PATH = '/api/'
-
-    def initialize(api_key, sent_with = 'ruby')
-      raise 'missing api_key in config' if api_key.to_s.empty?
-      raise 'missing sent_with in config' if sent_with.to_s.empty?
-
-      @api_key = api_key
-      @sent_with = sent_with
-      @endpoint = self.class.get_endpoint
-      @http_methods = self.class.get_http_methods
-      @conn = Faraday.new("https://gateway.sms77.io#{BASE_PATH}")
-    end
-
-    protected
-
-    def request(payload = {}, query = {})
-      path = @endpoint
-      http_method = @http_methods[caller_locations.first.label.to_sym]
-
-      if :get == http_method
-        query = payload
-
-        payload = {}
-      end
-
-      query.each do |key, val|
-        query.store(key, Sms77::Util::to_numbered_bool(val))
-      end
-
-      payload.each do |key, val|
-        payload.store(key, Sms77::Util::to_numbered_bool(val))
-      end
-
-      unless query.empty?
-        path = "#{path}?#{URI.encode_www_form(query)}"
-      end
-
-      headers = Hash[
-        Faraday::Request::Authorization::KEY, "Bearer #{@api_key}",
-        'sentWith', @sent_with
-      ]
-
-      res = @conn.run_request(http_method, path, payload, headers)
-
-      puts JSON.pretty_generate(res.to_hash.merge({
-                                                    :method => http_method,
-                                                    :path => path,
-                                                    :payload => payload,
-                                                    :req_headers => headers,
-                                                    :query => query,
-                                                  }).compact) if ENV['SMS77_DEBUG']
-
-      raise "Error requesting (#{self.class.name}) with code #{res.status}" unless 200 == res.status
-
-      raise 'Unexpected response' unless res.is_a?(Faraday::Response)
-
-      body = res.body
-
-      if body.is_a?(String)
-        begin
-          body = JSON.parse(body, :symbolize_names => true)
-        rescue StandardError
-          # Ignored
-        end
-      end
-
-      body.map! { |hash| hash.transform_keys(&:to_sym) } if body.is_a?(Array)
-
-      body
-    end
-
-    class << self
-      def get_http_methods
-        @http_methods
-      end
-
-      def get_endpoint
-        @endpoint
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'cgi'
+require 'json'
+require 'faraday'
+require 'sms77/endpoint'
+
+# This module exposes a HTTP client for communication with the API.
+module Sms77
+  class Resource
+    attr_reader :api_key, :endpoint, :sent_with, :http_methods, :request_methods, :builder, :conn
+
+    BASE_PATH = '/api/'
+
+    def initialize(api_key, sent_with = 'ruby')
+      raise 'missing api_key in config' if api_key.to_s.empty?
+      raise 'missing sent_with in config' if sent_with.to_s.empty?
+
+      @api_key = api_key
+      @sent_with = sent_with
+      @endpoint = self.class.get_endpoint
+      @http_methods = self.class.get_http_methods
+      @conn = Faraday.new("https://gateway.sms77.io#{BASE_PATH}")
+    end
+
+    protected
+
+    def request(payload = {}, query = {})
+      path = @endpoint
+      http_method = @http_methods[caller_locations.first.label.to_sym]
+
+      if :get == http_method
+        query = payload
+
+        payload = {}
+      end
+
+      query.each do |key, val|
+        query.store(key, Sms77::Util::to_numbered_bool(val))
+      end
+
+      payload.each do |key, val|
+        payload.store(key, Sms77::Util::to_numbered_bool(val))
+      end
+
+      unless query.empty?
+        path = "#{path}?#{URI.encode_www_form(query)}"
+      end
+
+      headers = Hash[
+        Faraday::Request::Authorization::KEY, "Bearer #{@api_key}",
+        'sentWith', @sent_with
+      ]
+
+      res = @conn.run_request(http_method, path, payload, headers)
+
+      puts JSON.pretty_generate(res.to_hash.merge({
+                                                    :method => http_method,
+                                                    :path => path,
+                                                    :payload => payload,
+                                                    :req_headers => headers,
+                                                    :query => query,
+                                                  }).compact) if ENV['SMS77_DEBUG']
+
+      raise "Error requesting (#{self.class.name}) with code #{res.status}" unless 200 == res.status
+
+      raise 'Unexpected response' unless res.is_a?(Faraday::Response)
+
+      body = res.body
+
+      if body.is_a?(String)
+        begin
+          body = JSON.parse(body, :symbolize_names => true)
+        rescue StandardError
+          # Ignored
+        end
+      end
+
+      body.map! { |hash| hash.transform_keys(&:to_sym) } if body.is_a?(Array)
+
+      body
+    end
+
+    class << self
+      def get_http_methods
+        @http_methods
+      end
+
+      def get_endpoint
+        @endpoint
+      end
+    end
+  end
+end

data/lib/sms77/resources/analytics.rb

@@ -1,16 +1,21 @@
-# frozen_string_literal: true
-
-require 'sms77/resource'
-
-module Sms77::Resources
-  class Analytics < Sms77::Resource
-    @endpoint = Sms77::Endpoint::ANALYTICS
-    @http_methods = {
-      :retrieve => :get,
-    }
-
-    def retrieve(params = {})
-      request(params)
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'sms77/resource'
+
+# This module exposes the methods for communicating with the API endpoint /analytics.
+module Sms77::Resources
+  class Analytics < Sms77::Resource
+    @endpoint = Sms77::Endpoint::ANALYTICS
+    @http_methods = {
+      :retrieve => :get,
+    }
+
+    # Retrieve analytics for associated API key
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/analytics/
+    # @param params [Hash]
+    # @return [Array]
+    def retrieve(params = {})
+      request(params)
+    end
+  end
+end

data/lib/sms77/resources/balance.rb

@@ -1,16 +1,20 @@
-# frozen_string_literal: true
-
-require 'sms77/resource'
-
-module Sms77::Resources
-  class Balance < Sms77::Resource
-    @endpoint = Sms77::Endpoint::BALANCE
-    @http_methods = {
-      :retrieve => :get,
-    }
-
-    def retrieve
-      request
-    end
-  end
+# frozen_string_literal: true
+
+require 'sms77/resource'
+
+# This module exposes the methods for communicating with the API endpoint /balance.
+module Sms77::Resources
+  class Balance < Sms77::Resource
+    @endpoint = Sms77::Endpoint::BALANCE
+    @http_methods = {
+      :retrieve => :get,
+    }
+
+    # Retrieve account balance for associated API key
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/credit-balance/
+    # @return [Float]
+    def retrieve
+      request
+    end
+  end
 end