unigo-ruby 1.0.1

data/examples/api/webhook.rb

@@ -0,0 +1,42 @@
+require 'unigo-ruby'
+require 'json'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+# Set webhook
+params = {}
+
+params[:url] = 'http://example.com'
+params[:status] = :active
+
+params[:event_format] = :json_post
+params[:delivery_info] = 1
+params[:single_event] = 0
+params[:max_parallel] = 10
+
+params[:events] = {
+  email_status: %w(sent delivered opened hard_bounced soft_bounced spam clicked unsubscribed),
+  spam_block: ["*"]
+}
+
+response = unigo.set_webhook(params)
+
+# Get webhook
+response = unigo.get_webhook(
+  url: 'http://example.com'
+)
+
+# List all webhooks
+response = unigo.list_webhooks(
+  limit: 50,
+  offset: 0
+)
+
+# Delete webhook
+response = unigo.delete_webhook(
+  url: 'http://example.com'
+)

data/examples/helpers.rb

@@ -0,0 +1,29 @@
+require 'unigo-ruby'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+# Verify webhook callback message
+# Will raise UniGo::Client::InvalidCallbackAuth error unless `auth' field is correct.
+unigo.verify_callback_auth!(params)
+
+# Callback helper usage
+# Will raise UniGo::Client::InvalidCallbackAuth error unless `auth' field is correct.
+unigo.callback_helper(params) do |events|
+  # [
+  #   {
+  #     'event_name' => 'transactional_email_status',
+  #     'event_data' =>
+  #      {
+  #        'email' => 'recipient.email@example.com',
+  #        'status' => 'sent',
+  #        'event_time' => '2015-11-30 15:09:42',
+  #       ...
+  #      }
+  #   },
+  #   ...
+  # ]
+end

data/examples/send_mail.rb

@@ -0,0 +1,44 @@
+require 'unigo-ruby'
+require 'json'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY'],
+  enable_logging: true
+)
+
+message = {}
+
+message[:template_engine] = 'simple'
+message[:template_id] = 'template_id'
+
+# In case template_id is not specified, subject and body are mandatory
+message[:subject] = 'test letter'
+message[:body] = {"html": "tests", "plaintext": "plaintext"}
+
+message[:from_email] = 'test@example.net'
+message[:from_name] = 'userName'
+
+message[:recipients] = []
+message[:recipients] << {
+  email: 'test1@example.com',
+  substitutions: { 'substitutionName' => 'substitutionVal', to_name: 'Name Surname' },
+  metadata: { key1: 'val' },
+}
+
+message[:global_metadata] = { key1: 'val' }
+message[:headers] = { 'X-ReplyTo' => 'reply@example.com' }
+message[:options] = { unsubscribe_url: 'someurl' }
+
+message[:attachments] = []
+message[:attachments] << { type: 'text/plain', name: 'myfile.txt', content: 'ZXhhbXBsZSBmaWxl' }
+
+message[:inline_attachments] = []
+message[:inline_attachments] << { type: 'image/png', name: 'IMAGECID', content: 'iVBORw0KGgo' }
+
+response = unigo.send_email(message: message)
+
+puts response.status
+puts response.body.to_h
+puts response.headers

data/examples/sending_mail.rb

@@ -0,0 +1,32 @@
+require 'unigo-ruby'
+require 'json'
+
+unigo = UniGo::Client.new(data_center: 'eu1', lang: 'ru', api_key: ENV['UNIGO_API_KEY'])
+
+mail = UniGo::Mail.new
+
+template_id    = "bc0372d4-69f2-11eb-9d14-366b3a36c9e1"
+mail.template  = { template_engine: 'simple', template_id: template_id }
+
+mail.from      = { from_email: 'test@example.net', from_name: 'userName' }
+
+substitutions  = { 'substitutionName' => 'substitutionVal', to_name: 'Name Surname 1' }
+recipient      = { email: 'test1@example.com', substitutions: substitutions, metadata: { key1: 'val1' } }
+mail.recipients << recipient
+
+substitutions  = { 'substitutionName' => 'substitutionVal', to_name: 'Name Surname 2' }
+recipient      = { email: 'test2@example.com', substitutions: substitutions, metadata: { key1: 'val1' } }
+mail.recipients << recipient
+
+mail.global_metadata  = { key1: 'val1' }
+mail.headers   = { 'X-ReplyTo' => 'reply@example.com' }
+mail.options   = { unsubscribe_url: 'someurl' }
+
+mail.attachments        << { type: 'text/plain', name: 'myfile.txt', content: 'ZXhhbXBsZSBmaWxl' }
+mail.inline_attachments << { type: 'image/png', name: 'IMAGECID', content: 'iVBORw0KGgo' }
+
+response = unigo.send_email(mail.to_json)
+
+puts response.status
+puts response.body.to_h
+puts response.headers

data/examples/setup.rb

@@ -0,0 +1,34 @@
+require 'unigo-ruby'
+require 'json'
+
+unigo = UniGo::Client.new(
+  hostname: 'go1.unisender.ru',
+  lang: 'ru',
+  api_key: ENV['UNIGO_API_KEY']
+)
+
+# Validate domain verification record
+unigo.validate_verification_record(domain: 'example.net')
+
+# Create template
+template = {}
+
+template[:name] = 'Template Name'
+template[:subject] = 'Email Subject'
+template[:template_engine] = 'simple'
+template[:headers] = {'X-ReplyTo' => 'reply@example.com'}
+
+template[:global_substitutions] = { 'someVar' => 'someVal' }
+template[:from_email] = 'test@example.com'
+template[:from_name] = 'userName'
+template[:body] = { html: '<b>Hello {{substitutionName}}</b>' }
+template[:options] = { unsubscribe_url: 'someurl' }
+
+template[:attachments] = []
+template[:attachments] << { type: 'text/plain', name: 'myfile.txt', content: 'ZXhhbXBsZSBmaWxl' }
+
+template[:inline_attachments] = []
+template[:inline_attachments] << { type: 'image/png', name: 'IMAGECID', content: 'iVBORw0KGgo' }
+
+response = unigo.set_template(template: template)
+template_id = response.body.template.id

data/lib/unigo/client/domain.rb

@@ -0,0 +1,34 @@
+module UniGo
+  class Client
+    module Domain
+      extend UniGo::Validation::ClassMethods
+      include UniGo::Validation::InstanceMethods
+
+      def get_dns_records(params = {})
+        post('domain/get-dns-records.json', params)
+      end
+
+      def validate_verification_record(params = {})
+        post('domain/validate-verification-record.json', params)
+      end
+
+      def validate_dkim(params = {})
+        post('domain/validate-dkim.json', params)
+      end
+
+      def list_domains(params = {})
+        post('domain/list.json', params)
+      end
+
+      add_response_validations(
+        :domain,
+        %w(
+          get_dns_records
+          validate_verification_record
+          validate_dkim
+          list_domains
+        )
+      )
+    end
+  end
+end

data/lib/unigo/client/email.rb

@@ -0,0 +1,25 @@
+module UniGo
+  class Client
+    module Email
+      extend UniGo::Validation::ClassMethods
+      include UniGo::Validation::InstanceMethods
+
+      def send_email(params = {})
+        params[:message][:options][:send_at] = handle_time_param(params.dig(:message, :options, :send_at)) if params.dig(:message, :options, :send_at)
+        post('email/send.json', params)
+      end
+
+      def subscribe_email(params = {})
+        post('email/subscribe.json', params)
+      end
+
+      add_response_validations(
+        :email,
+        %w(
+          send_email
+          subscribe_email
+        )
+      )
+    end
+  end
+end

data/lib/unigo/client/event_dump.rb

@@ -0,0 +1,37 @@
+module UniGo
+  class Client
+    module EventDump
+      extend UniGo::Validation::ClassMethods
+      include UniGo::Validation::InstanceMethods
+
+      def create_event_dump(params = {})
+        params[:start_time] = handle_time_param(params[:start_time]) if params[:start_time]
+        params[:end_time] = handle_time_param(params[:end_time]) if params[:end_time]
+
+        post('event-dump/create.json', params)
+      end
+
+      def get_event_dump(params = {})
+        post('event-dump/get.json', params)
+      end
+
+      def list_event_dumps(params = {})
+        post('event-dump/list.json', params)
+      end
+
+      def delete_event_dump(params = {})
+        post('event-dump/delete.json', params)
+      end
+
+      add_response_validations(
+        :event_dump,
+        %w(
+          create_event_dump
+          get_event_dump
+          list_event_dumps
+          delete_event_dump
+        )
+      )
+    end
+  end
+end

data/lib/unigo/client/project.rb

@@ -0,0 +1,34 @@
+module UniGo
+  class Client
+    module Project
+      extend UniGo::Validation::ClassMethods
+      include UniGo::Validation::InstanceMethods
+
+      def create_project(params = {})
+        post('project/create.json', params)
+      end
+
+      def update_project(params = {})
+        post('project/update.json', params)
+      end
+
+      def list_projects(params = {})
+        post('project/list.json', params)
+      end
+
+      def delete_project(params = {})
+        post('project/delete.json', params)
+      end
+
+      add_response_validations(
+        :project,
+        %w(
+          create_project
+          update_project
+          list_projects
+          delete_project
+        )
+      )
+    end
+  end
+end

data/lib/unigo/client/suppression.rb

@@ -0,0 +1,38 @@
+module UniGo
+  class Client
+    module Suppression
+      extend UniGo::Validation::ClassMethods
+      include UniGo::Validation::InstanceMethods
+
+      def set_suppression(params = {})
+        params[:created] = handle_time_param(params[:created]) if params[:created]
+
+        post('suppression/set.json', params)
+      end
+
+      def get_suppression(params = {})
+        post('suppression/get.json', params)
+      end
+
+      def list_suppressions(params = {})
+        params[:start_time] = handle_time_param(params[:start_time]) if params[:start_time]
+
+        post('suppression/list.json', params)
+      end
+
+      def delete_suppression(params = {})
+        post('suppression/delete.json', params)
+      end
+
+      add_response_validations(
+        :suppression,
+        %w(
+          set_suppression
+          get_suppression
+          list_suppressions
+          delete_suppression
+        )
+      )
+    end
+  end
+end

data/lib/unigo/client/system.rb

@@ -0,0 +1,19 @@
+module UniGo
+  class Client
+    module System
+      extend UniGo::Validation::ClassMethods
+      include UniGo::Validation::InstanceMethods
+
+      def info(params = {})
+        post('system/info.json', params)
+      end
+
+      add_response_validations(
+        :system,
+        %w(
+          info
+        )
+      )
+    end
+  end
+end

data/lib/unigo/client/tag.rb

@@ -0,0 +1,24 @@
+module UniGo
+  class Client
+    module Tag
+      extend UniGo::Validation::ClassMethods
+      include UniGo::Validation::InstanceMethods
+
+      def list_tags(params = {})
+        post('tag/list.json', params)
+      end
+
+      def delete_tag(params = {})
+        post('tag/delete.json', params)
+      end
+
+      add_response_validations(
+        :tag,
+        %w(
+          list_tags
+          delete_tag
+        )
+      )
+    end
+  end
+end

data/lib/unigo/client/template.rb

@@ -0,0 +1,34 @@
+module UniGo
+  class Client
+    module Template
+      extend UniGo::Validation::ClassMethods
+      include UniGo::Validation::InstanceMethods
+
+      def set_template(params = {})
+        post('template/set.json', params)
+      end
+
+      def get_template(params = {})
+        post('template/get.json', params)
+      end
+
+      def list_templates(params = {})
+        post('template/list.json', params)
+      end
+
+      def delete_template(params = {})
+        post('template/delete.json', params)
+      end
+
+      add_response_validations(
+        :template,
+        %w(
+          set_template
+          get_template
+          list_templates
+          delete_template
+        )
+      )
+    end
+  end
+end

data/lib/unigo/client/unsubscribed.rb

@@ -0,0 +1,31 @@
+module UniGo
+  class Client
+    module Unsubscribed
+      extend UniGo::Validation::ClassMethods
+      include UniGo::Validation::InstanceMethods
+
+      def unsubscribe(params = {})
+        post('unsubscribed/set.json', params)
+      end
+
+      def check_unsubscribed(params = {})
+        post('unsubscribed/check.json', params)
+      end
+
+      def list_unsubscribed(params = {})
+        params[:date_from] = handle_date_param(params[:date_from]) if params[:date_from]
+
+        post('unsubscribed/list.json', params)
+      end
+
+      add_response_validations(
+        :unsubscribed,
+        %w(
+          unsubscribe
+          check_unsubscribed
+          list_unsubscribed
+        )
+      )
+    end
+  end
+end

data/lib/unigo/client/webhook.rb

@@ -0,0 +1,34 @@
+module UniGo
+  class Client
+    module Webhook
+      extend UniGo::Validation::ClassMethods
+      include UniGo::Validation::InstanceMethods
+
+      def set_webhook(params = {})
+        post('webhook/set.json', params)
+      end
+
+      def get_webhook(params = {})
+        post('webhook/get.json', params)
+      end
+
+      def list_webhooks(params = {})
+        post('webhook/list.json', params)
+      end
+
+      def delete_webhook(params = {})
+        post('webhook/delete.json', params)
+      end
+
+      add_response_validations(
+        :webhook,
+        %w(
+          set_webhook
+          get_webhook
+          list_webhooks
+          delete_webhook
+        )
+      )
+    end
+  end
+end

data/lib/unigo/client.rb

@@ -0,0 +1,69 @@
+require_relative 'connection'
+require_relative 'validation'
+require_relative 'helpers'
+require_relative 'client/domain'
+require_relative 'client/email'
+require_relative 'client/event_dump'
+require_relative 'client/project'
+require_relative 'client/suppression'
+require_relative 'client/system'
+require_relative 'client/tag'
+require_relative 'client/template'
+require_relative 'client/unsubscribed'
+require_relative 'client/webhook'
+
+module UniGo
+  class Client
+    include UniGo::Connection
+    extend  UniGo::Validation::ClassMethods
+    include UniGo::Validation::InstanceMethods
+    include UniGo::Client::Helpers
+    include UniGo::Client::Domain
+    include UniGo::Client::Email
+    include UniGo::Client::EventDump
+    include UniGo::Client::Project
+    include UniGo::Client::Suppression
+    include UniGo::Client::System
+    include UniGo::Client::Tag
+    include UniGo::Client::Template
+    include UniGo::Client::Unsubscribed
+    include UniGo::Client::Webhook
+
+    class BaseException < StandardError; end
+    class InvalidCallbackAuth < BaseException; end
+
+    API_ENDPOINT =
+      'https://%{hostname}/%{lang}/transactional/api/v1/'
+
+    # * *Args* :
+    #   - +hostname+          -> string, API hostname, for example 'go1.unisender.ru'
+    #   - +lang+              -> string, two-letter ISO 639-1 language abbreviation, e.g. 'ru'
+    #   - +api_key+           -> string, your Unisender Go API key
+    #   - +timeout+           -> integer, timeout in seconds, 5 by default
+    #   - +api_key_in_params+ -> boolean, pass API key in parameters, otherwise pass in headers (default)
+    #   - +enable_logging+    -> boolean, enable logging
+    def initialize(params = {})
+      @hostname          = params[:hostname]
+      @lang              = params[:lang]
+      @api_key           = params[:api_key]
+      @timeout           = params[:timeout] || 5
+      @api_key_in_params = params[:api_key_in_params]
+      @enable_logging    = params[:enable_logging] || ENV['ENABLE_LOGGING']
+    end
+
+    private
+
+    def api_endpoint
+      @api_endpoint ||=
+        API_ENDPOINT % { hostname: @hostname, lang: @lang }
+    end
+
+    def handle_time_param(param)
+      param.respond_to?(:strftime) ? param.strftime('%Y-%m-%d %H:%M:%S') : param
+    end
+
+    def handle_date_param(param)
+      param.respond_to?(:strftime) ? param.strftime('%Y-%m-%d') : param
+    end
+  end
+end

data/lib/unigo/connection.rb

@@ -0,0 +1,62 @@
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+require 'hashie'
+
+module UniGo
+  module Connection
+
+    def get(url, params = {})
+      prepare_params!(params)
+
+      # Assume HTTP library receives params as Hash
+      request(:get, url, params)
+    end
+
+    def post(url, params = {})
+      prepare_params!(params)
+
+      # Assume HTTP library receives payload body as String
+      request(:post, url, JSON.dump(params))
+    end
+
+    private
+
+    def request(method, path, data)
+      path = add_version(path)
+      @last_response = conn.send(method, path, data)
+    end
+
+    def conn
+      headers = {'Content-Type' => 'application/json'}
+      prepare_headers!(headers)
+
+      @conn ||= Faraday.new(
+        url: api_endpoint,
+        headers: headers,
+        request: { timeout: @timeout }
+      ) do |conn|
+        conn.response :mashify, content_type: /\bjson$/
+        conn.response :json, content_type: /\bjson$/
+        conn.response :raise_error
+        conn.adapter :net_http_persistent
+
+        if @enable_logging
+          conn.response(:logger, nil, { headers: true, bodies: true, errors: true })
+        end
+      end
+    end
+
+    def prepare_params!(params)
+      params.merge!({api_key: @api_key}) if @api_key_in_params
+    end
+
+    def prepare_headers!(headers)
+      headers.merge!('X-API-KEY' => @api_key) unless @api_key_in_params
+    end
+
+    def add_version(path)
+      "#{path}?platform=unigo_ruby_#{UniGo::VERSION}"
+    end
+  end
+end

data/lib/unigo/helpers/mail/mail.rb

@@ -0,0 +1,42 @@
+module UniGo
+  class Mail
+    attr_accessor :template, :body, :track, :from, :subject, :global_metadata, :headers, :options,
+                  :global_substitutions, :recipients, :attachments, :inline_attachments,
+                  :reply_to, :skip_unsubscribe, :force_send
+
+    def initialize
+      @template = {}
+      @from = {}
+      @track = {}
+      @global_substitutions = {}
+      @recipients = []
+      @attachments = []
+      @inline_attachments = []
+    end
+
+    # backward compatibility
+    alias_method :"metadata=", :"global_metadata="
+
+    def to_json(*)
+      {
+        message: {
+          global_substitutions: self.global_substitutions,
+          body: self.body,
+          subject: self.subject,
+          reply_to: self.reply_to,
+          recipients: self.recipients,
+          global_metadata: self.global_metadata,
+          headers: self.headers,
+          attachments: self.attachments,
+          inline_attachments: self.inline_attachments,
+          options: self.options,
+          skip_unsubscribe: self.skip_unsubscribe,
+          force_send: self.force_send
+        }.merge(self.template)
+         .merge(self.from)
+         .merge(self.track)
+         .delete_if { |_, value| value.to_s.strip == '' || value == [] || value == {}}
+      }
+    end
+  end
+end