sms77 0.4.0 → 0.5.0

data/lib/sms77/resources/contacts.rb

@@ -1,26 +1,39 @@
-# frozen_string_literal: true
-
-require 'sms77/resource'
-
-module Sms77::Resources
-  class Contacts < Sms77::Resource
-    @endpoint = Sms77::Endpoint::CONTACTS
-    @http_methods = {
-      :delete => :post,
-      :read => :get,
-      :write => :post,
-    }
-
-    def read(params = {})
-      request(params.merge({ :action => Sms77::Contacts::Action::READ }))
-    end
-
-    def delete(params)
-      request({}, params.merge({ :action => Sms77::Contacts::Action::DEL }))
-    end
-
-    def write(params)
-      request({}, params.merge({ :action => Sms77::Contacts::Action::WRITE }))
-    end
-  end
+# frozen_string_literal: true
+
+require 'sms77/resource'
+
+# This module exposes the methods for communicating with the API endpoint /contacts.
+module Sms77::Resources
+  class Contacts < Sms77::Resource
+    @endpoint = Sms77::Endpoint::CONTACTS
+    @http_methods = {
+      :delete => :post,
+      :read => :get,
+      :write => :post,
+    }
+
+    # Retrieve contacts associated with the API key
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/contacts/#read-contacts
+    # @param params [Hash]
+    # @return [String, Hash]
+    def read(params = {})
+      request(params.merge({ :action => Sms77::Contacts::Action::READ }))
+    end
+
+    # Delete an account with given ID
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/contacts/#delete-contacts
+    # @param params [Hash]
+    # @return [String, Hash]
+    def delete(params)
+      request({}, params.merge({ :action => Sms77::Contacts::Action::DEL }))
+    end
+
+    # Create or update a contact
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/contacts/#create-and-edit-contacts
+    # @param params [Hash]
+    # @return [String, Hash]
+    def write(params)
+      request({}, params.merge({ :action => Sms77::Contacts::Action::WRITE }))
+    end
+  end
 end

data/lib/sms77/resources/hooks.rb

@@ -1,30 +1,41 @@
-# frozen_string_literal: true
-
-require 'sms77/resource'
-
-module Sms77::Resources
-  class Hooks < Sms77::Resource
-    @endpoint = Sms77::Endpoint::HOOKS
-    @http_methods = {
-      :read => :get,
-      :subscribe => :post,
-      :unsubscribe => :post,
-    }
-
-    def read(params = {})
-      request(params.merge({ :action => Sms77::Hooks::Action::READ }))
-    end
-
-    def subscribe(params)
-      Sms77::Hooks::Validator::subscribe(params)
-
-      request(params.merge({ :action => Sms77::Hooks::Action::SUBSCRIBE }))
-    end
-
-    def unsubscribe(params)
-      Sms77::Hooks::Validator::unsubscribe(params)
-
-      request(params.merge({ :action => Sms77::Hooks::Action::UNSUBSCRIBE }))
-    end
-  end
+# frozen_string_literal: true
+
+require 'sms77/resource'
+
+# This module exposes the methods for communicating with the API endpoint /hooks.
+# read more: https://www.sms77.io/en/docs/gateway/http-api/webhooks/
+module Sms77::Resources
+  class Hooks < Sms77::Resource
+    @endpoint = Sms77::Endpoint::HOOKS
+    @http_methods = {
+      :read => :get,
+      :subscribe => :post,
+      :unsubscribe => :post,
+    }
+
+    # Retrieve all webhooks
+    # @param params [Hash]
+    # @return [Hash]
+    def read(params = {})
+      request(params.merge({ :action => Sms77::Hooks::Action::READ }))
+    end
+
+    # Register a new webhook
+    # @param params [Hash]
+    # @return [Hash]
+    def subscribe(params)
+      Sms77::Hooks::Validator::subscribe(params)
+
+      request(params.merge({ :action => Sms77::Hooks::Action::SUBSCRIBE }))
+    end
+
+    # Delete a webhook
+    # @param params [Hash]
+    # @return [Hash]
+    def unsubscribe(params)
+      Sms77::Hooks::Validator::unsubscribe(params)
+
+      request(params.merge({ :action => Sms77::Hooks::Action::UNSUBSCRIBE }))
+    end
+  end
 end

data/lib/sms77/resources/journal.rb

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

data/lib/sms77/resources/lookup.rb

@@ -1,30 +1,48 @@
-# frozen_string_literal: true
-
-require 'sms77/resource'
-module Sms77::Resources
-  class Lookup < Sms77::Resource
-    @endpoint = Sms77::Endpoint::LOOKUP
-    @http_methods = {
-      :cnam => :post,
-      :format => :post,
-      :hlr => :post,
-      :mnp => :post,
-    }
-
-    def cnam(params)
-      request(params.merge({ :type => Sms77::Lookup::Type::CNAM }))
-    end
-
-    def format(params)
-      request(params.merge({ :type => Sms77::Lookup::Type::FORMAT }))
-    end
-
-    def hlr(params)
-      request(params.merge({ :type => Sms77::Lookup::Type::HLR }))
-    end
-
-    def mnp(params)
-      request(params.merge({ :type => Sms77::Lookup::Type::MNP }))
-    end
-  end
+# frozen_string_literal: true
+
+require 'sms77/resource'
+
+# This module exposes the methods for communicating with the API endpoint /lookup.
+module Sms77::Resources
+  class Lookup < Sms77::Resource
+    @endpoint = Sms77::Endpoint::LOOKUP
+    @http_methods = {
+      :cnam => :post,
+      :format => :post,
+      :hlr => :post,
+      :mnp => :post,
+    }
+
+    # Perform a caller name lookup
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/cnam-lookup/
+    # @param params [Hash]
+    # @return [Hash,Array]
+    def cnam(params)
+      request(params.merge({ :type => Sms77::Lookup::Type::CNAM }))
+    end
+
+    # Retrieve phone number formats
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/nummernformat-lookup/
+    # @param params [Hash]
+    # @return [String,Hash]
+    def format(params)
+      request(params.merge({ :type => Sms77::Lookup::Type::FORMAT }))
+    end
+
+    # Perform a home location register lookup
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/hlr-lookup/
+    # @param params [Hash]
+    # @return [Hash,Array]
+    def hlr(params)
+      request(params.merge({ :type => Sms77::Lookup::Type::HLR }))
+    end
+
+    # Perform a mobile number portability lookup
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/mnp-lookup/
+    # @param params [Hash]
+    # @return [Hash,Array]
+    def mnp(params)
+      request(params.merge({ :type => Sms77::Lookup::Type::MNP }))
+    end
+  end
 end

data/lib/sms77/resources/pricing.rb

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

data/lib/sms77/resources/sms.rb

@@ -1,16 +1,21 @@
-# frozen_string_literal: true
-
-require 'sms77/resource'
-
-module Sms77::Resources
-  class Sms < Sms77::Resource
-    @endpoint = Sms77::Endpoint::SMS
-    @http_methods = {
-      :retrieve => :post,
-    }
-
-    def retrieve(params)
-      request(params)
-    end
-  end
+# frozen_string_literal: true
+
+require 'sms77/resource'
+
+# This module exposes the methods for communicating with the API endpoint /sms.
+module Sms77::Resources
+  class Sms < Sms77::Resource
+    @endpoint = Sms77::Endpoint::SMS
+    @http_methods = {
+      :retrieve => :post,
+    }
+
+    # Send SMS
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/sms-dispatch/
+    # @param params [Hash]
+    # @return [Integer,String,Hash]
+    def retrieve(params)
+      request(params)
+    end
+  end
 end

data/lib/sms77/resources/status.rb

@@ -1,16 +1,21 @@
-# frozen_string_literal: true
-
-require 'sms77/resource'
-
-module Sms77::Resources
-  class Status < Sms77::Resource
-    @endpoint = Sms77::Endpoint::STATUS
-    @http_methods = {
-      :retrieve => :get,
-    }
-
-    def retrieve(params)
-      request(params)
-    end
-  end
+# frozen_string_literal: true
+
+require 'sms77/resource'
+
+# This module exposes the methods for communicating with the API endpoint /status.
+module Sms77::Resources
+  class Status < Sms77::Resource
+    @endpoint = Sms77::Endpoint::STATUS
+    @http_methods = {
+      :retrieve => :get,
+    }
+
+    # Retrieve delivery report for a SMS
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/status-reports/#query-delivery-reports
+    # @param params [Hash]
+    # @return [String]
+    def retrieve(params)
+      request(params)
+    end
+  end
 end

data/lib/sms77/resources/subaccounts.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'sms77/resource'
+require 'sms77/subaccounts'
+
+# This module exposes the methods for communicating with the API endpoint /subaccounts.
+module Sms77::Resources
+  class Subaccounts < Sms77::Resource
+    @endpoint = Sms77::Endpoint::SUBACCOUNTS
+    @http_methods = {
+      :create => :post,
+      :delete => :post,
+      :read => :get,
+      :transfer_credits => :post,
+      :update => :post,
+    }
+
+    # Create a subaccount
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/subaccounts/#create-subaccount
+    # @param params [Hash]
+    # @return [Hash]
+    def create(params)
+      Sms77::Subaccounts::Validator::create(params)
+
+      request(params.merge({ :action => Sms77::Subaccounts::Action::CREATE }))
+    end
+
+    # Delete a subaccount
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/subaccounts/#delete-subaccount
+    # @param params [Hash]
+    # @return [Hash]
+    def delete(params)
+      Sms77::Subaccounts::Validator::delete(params)
+
+      request(params.merge({ :action => Sms77::Subaccounts::Action::DELETE }))
+    end
+
+    # Retrieve all subaccounts
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/subaccounts/#read-subaccounts
+    # @param params [Hash]
+    # @return [Hash]
+    def read(params = {})
+      request({}, params.merge({ :action => Sms77::Subaccounts::Action::READ }))
+    end
+
+    # Transfer credits to a subaccount
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/subaccounts/#transfer-credit
+    # @param params [Hash]
+    # @return [Hash]
+    def transfer_credits(params)
+      Sms77::Subaccounts::Validator::transfer_credits(params)
+
+      request(params.merge({ :action => Sms77::Subaccounts::Action::TRANSFER_CREDITS }))
+    end
+
+    # Update automatic charging of a subaccount
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/subaccounts/#update-automatic-charging-of-the-subaccount
+    # @param params [Hash]
+    # @return [Hash]
+    def update(params)
+      Sms77::Subaccounts::Validator::update(params)
+
+      request(params.merge({ :action => Sms77::Subaccounts::Action::UPDATE }))
+    end
+  end
+end

data/lib/sms77/resources/validate_for_voice.rb

@@ -1,16 +1,21 @@
-# frozen_string_literal: true
-
-require 'sms77/resource'
-
-module Sms77::Resources
-  class ValidateForVoice < Sms77::Resource
-    @endpoint = Sms77::Endpoint::VALIDATE_FOR_VOICE
-    @http_methods = {
-      :retrieve => :post,
-    }
-
-    def retrieve(params)
-      request(params)
-    end
-  end
+# frozen_string_literal: true
+
+require 'sms77/resource'
+
+# This module exposes the methods for communicating with the API endpoint /validate_for_voice.
+module Sms77::Resources
+  class ValidateForVoice < Sms77::Resource
+    @endpoint = Sms77::Endpoint::VALIDATE_FOR_VOICE
+    @http_methods = {
+      :retrieve => :post,
+    }
+
+    # Validate a phone number for using it as caller ID via our voice API
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/caller-ids/
+    # @param params [Hash]
+    # @return [Hash]
+    def retrieve(params)
+      request(params)
+    end
+  end
 end

data/lib/sms77/resources/voice.rb

@@ -1,16 +1,21 @@
-# frozen_string_literal: true
-
-require 'sms77/resource'
-
-module Sms77::Resources
-  class Voice < Sms77::Resource
-    @endpoint = Sms77::Endpoint::VOICE
-    @http_methods = {
-      :send => :post,
-    }
-
-    def send(params)
-      request(params)
-    end
-  end
+# frozen_string_literal: true
+
+require 'sms77/resource'
+
+# This module exposes the methods for communicating with the API endpoint /voice.
+module Sms77::Resources
+  class Voice < Sms77::Resource
+    @endpoint = Sms77::Endpoint::VOICE
+    @http_methods = {
+      :send => :post,
+    }
+
+    # Convert text to speech, call number and read voice message out loud.
+    # read more: https://www.sms77.io/en/docs/gateway/http-api/voice/
+    # @param params [Hash]
+    # @return [String,Hash]
+    def send(params)
+      request(params)
+    end
+  end
 end

data/lib/sms77/sms.rb

@@ -1,8 +1,9 @@
-# frozen_string_literal: true
-
-module Sms77::Sms
-  module Type
-    DIRECT = 'direct'
-    ECONOMY = 'economy'
-  end
-end
+# frozen_string_literal: true
+
+# This module holds all utilities related to the /sms endpoint.
+module Sms77::Sms
+  module Type
+    DIRECT = 'direct'
+    ECONOMY = 'economy'
+  end
+end

data/lib/sms77/subaccounts.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# This module holds all utilities related to the /subaccounts endpoint.
+module Sms77::Subaccounts
+  module Action
+    CREATE = 'create'
+    DELETE = 'delete'
+    READ = 'read'
+    TRANSFER_CREDITS = 'transfer_credits'
+    UPDATE = 'update'
+  end
+
+  module Validator
+    def self.is_action?(str)
+      Sms77::Util::in_module_constants?(str, Sms77::Subaccounts::Action)
+    end
+
+    def self.validate(params)
+      action = params[:action]
+
+      case action
+      when Sms77::Subaccounts::Action::CREATE
+        raise 'Parameter validation failed' unless Sms77::Subaccounts::Validator::create(params)
+      when Sms77::Subaccounts::Action::DELETE
+        raise 'Parameter validation failed' unless Sms77::Subaccounts::Validator::delete(params)
+      when Sms77::Subaccounts::Action::TRANSFER_CREDITS
+        raise 'Parameter validation failed' unless Sms77::Subaccounts::Validator::transfer_credits(params)
+      when Sms77::Subaccounts::Action::UPDATE
+        raise 'Parameter validation failed' unless Sms77::Subaccounts::Validator::update(params)
+      else
+        raise "Unknown action #{action}" unless Sms77::Subaccounts::Validator::is_action?(action)
+      end
+    end
+
+    def self.create(params)
+      Sms77::Util::lengthy_string?(params[:email]) &&
+        Sms77::Util::lengthy_string?(params[:name])
+    end
+
+    def self.delete(params)
+      Sms77::Util::is_positive_integer?(params[:id])
+    end
+
+    def self.transfer_credits(params)
+      Sms77::Util::is_positive_integer?(params[:amount]) &&
+        Sms77::Util::is_positive_integer?(params[:id])
+    end
+
+    def self.update(params)
+      Sms77::Util::is_positive_integer?(params[:amount]) &&
+        Sms77::Util::is_positive_integer?(params[:id]) &&
+        Sms77::Util::is_positive_integer?(params[:threshold])
+    end
+  end
+end