seven_api 0.5.0

data/lib/seven_api/client.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'seven_api/resources/analytics'
+require 'seven_api/resources/balance'
+require 'seven_api/resources/contacts'
+require 'seven_api/resources/hooks'
+require 'seven_api/resources/journal'
+require 'seven_api/resources/lookup'
+require 'seven_api/resources/pricing'
+require 'seven_api/resources/sms'
+require 'seven_api/resources/status'
+require 'seven_api/resources/subaccounts'
+require 'seven_api/resources/validate_for_voice'
+require 'seven_api/resources/voice'
+require 'seven_api/util'
+
+module SevenApi
+  class Client
+    # @param resource [SevenApi::Resource]
+    def initialize(resource)
+      SevenApi::Util::get_namespace_classes(SevenApi::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/seven_api/contacts.rb

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

data/lib/seven_api/endpoint.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# This module exposes the endpoints covered by this client.
+module SevenApi::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/seven_api/hooks.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# This module holds all utilities related to the /hooks endpoint.
+module SevenApi::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 SevenApi::Hooks::Validator::is_action?(action)
+
+      if SevenApi::Hooks::Action::SUBSCRIBE == action
+        raise 'Parameter validation failed' unless SevenApi::Hooks::Validator::subscribe(params)
+      elsif SevenApi::Hooks::Action::UNSUBSCRIBE == action
+        raise 'ID must be a positive integer' unless SevenApi::Hooks::Validator::unsubscribe(params)
+      end
+    end
+
+    def self.subscribe(params)
+      { :request_method => SevenApi::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)
+      SevenApi::Util::is_positive_integer?(params[:id])
+    end
+
+    def self.is_action?(str)
+      SevenApi::Util::in_module_constants?(str, SevenApi::Hooks::Action)
+    end
+
+    def self.event_type?(str)
+      SevenApi::Util::in_module_constants?(str, SevenApi::Hooks::EventType)
+    end
+
+    def self.request_method?(str)
+      SevenApi::Util::in_module_constants?(str, SevenApi::Hooks::RequestMethod)
+    end
+
+    def self.target_url?(str)
+      SevenApi::Util::is_valid_url?(str)
+    end
+  end
+end

data/lib/seven_api/journal.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# This module holds all utilities related to the /journal endpoint.
+module SevenApi::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 SevenApi::Journal::Validator::is_type?(type)
+      raise "Wrong date_from #{date_from}" unless SevenApi::Journal::Validator::is_date?(date_from)
+      raise "Wrong date_to #{date_to}" unless SevenApi::Journal::Validator::is_date?(date_to)
+    end
+
+    def self.subscribe(params)
+      { :request_method => SevenApi::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)
+      SevenApi::Util::in_module_constants?(str, SevenApi::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/seven_api/lookup.rb

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

data/lib/seven_api/resource.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'cgi'
+require 'json'
+require 'faraday'
+require 'seven_api/endpoint'
+
+# This module exposes a HTTP client for communication with the API.
+module SevenApi
+  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.seven.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, SevenApi::Util::to_numbered_bool(val))
+      end
+
+      payload.each do |key, val|
+        payload.store(key, SevenApi::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['SEVEN_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/seven_api/resources/analytics.rb

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

data/lib/seven_api/resources/balance.rb

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

data/lib/seven_api/resources/contacts.rb

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

data/lib/seven_api/resources/hooks.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /hooks.
+# read more: https://www.seven.io/en/docs/gateway/http-api/webhooks/
+module SevenApi::Resources
+  class Hooks < SevenApi::Resource
+    @endpoint = SevenApi::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 => SevenApi::Hooks::Action::READ }))
+    end
+
+    # Register a new webhook
+    # @param params [Hash]
+    # @return [Hash]
+    def subscribe(params)
+      SevenApi::Hooks::Validator::subscribe(params)
+
+      request(params.merge({ :action => SevenApi::Hooks::Action::SUBSCRIBE }))
+    end
+
+    # Delete a webhook
+    # @param params [Hash]
+    # @return [Hash]
+    def unsubscribe(params)
+      SevenApi::Hooks::Validator::unsubscribe(params)
+
+      request(params.merge({ :action => SevenApi::Hooks::Action::UNSUBSCRIBE }))
+    end
+  end
+end

data/lib/seven_api/resources/journal.rb

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

data/lib/seven_api/resources/lookup.rb

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

data/lib/seven_api/resources/pricing.rb

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

data/lib/seven_api/resources/sms.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /sms.
+module SevenApi::Resources
+  class Sms < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::SMS
+    @http_methods = {
+      :retrieve => :post,
+    }
+
+    # Send SMS
+    # read more: https://www.seven.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/seven_api/resources/status.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /status.
+module SevenApi::Resources
+  class Status < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::STATUS
+    @http_methods = {
+      :retrieve => :get,
+    }
+
+    # Retrieve delivery report for a SMS
+    # read more: https://www.seven.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/seven_api/resources/subaccounts.rb

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

data/lib/seven_api/resources/validate_for_voice.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /validate_for_voice.
+module SevenApi::Resources
+  class ValidateForVoice < SevenApi::Resource
+    @endpoint = SevenApi::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.seven.io/en/docs/gateway/http-api/caller-ids/
+    # @param params [Hash]
+    # @return [Hash]
+    def retrieve(params)
+      request(params)
+    end
+  end
+end

data/lib/seven_api/resources/voice.rb

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

data/lib/seven_api/sms.rb

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