unione-ruby 0.0.2 → 1.0.0

data/examples/api/unsubscribed.rb

@@ -1,16 +1,22 @@
 require 'unione-ruby'
 
-unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
+unione = UniOne::Client.new(
+  hostname: 'eu1.unione.io',
+  lang: 'en',
+  api_key: ENV['UNIONE_API_KEY']
+)
 
-# unsubscribe email
-response = unione.unsubscribe('email@example.com')
+# Unsubscribe email
+response = unione.unsubscribe(
+  address: 'email@example.com'
+)
 
-puts response.status
-puts response.body.to_h
-puts response.headers
+# Check email is unsubscribed
+response = unione.check_unsubscribed(
+  address: 'email@example.com'
+)
 
-# check email is unsubscribed
-response = unione.check_unsubscribed('email@example.com')
-
-# list unsubscribed emails
-response = unione.list_unsubscribed('2019-01-01')
+# List unsubscribed emails
+response = unione.list_unsubscribed(
+  date_from: Date.today # Or String: '2019-01-01'
+)

data/examples/api/webhook.rb

@@ -1,39 +1,42 @@
 require 'unione-ruby'
 require 'json'
 
-unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
+unione = UniOne::Client.new(
+  hostname: 'eu1.unione.io',
+  lang: 'en',
+  api_key: ENV['UNIONE_API_KEY']
+)
 
-# set webhook
-webhook = UniOne::Webhook.new
+# Set webhook
+params = {}
 
-webhook.url      = 'http://example.com'
-webhook.status   = :active
+params[:url] = 'http://example.com'
+params[:status] = :active
 
-webhook.settings = {
-  event_format: :json_post,
-  delivery_info: 1,
-  single_event: 0,
-  max_parallel: 10
-}
+params[:event_format] = :json_post
+params[:delivery_info] = 1
+params[:single_event] = 0
+params[:max_parallel] = 10
 
-webhook.events = {
+params[:events] = {
   email_status: %w(sent delivered opened hard_bounced soft_bounced spam clicked unsubscribed),
   spam_block: ["*"]
 }
 
-puts webhook.to_json
-
-response = unione.set_webhook(webhook.to_json)
-
-puts response.status
-puts response.body.to_h
-puts response.headers
+response = unione.set_webhook(params)
 
-# get webhook
-response = unione.get_webhook('http://example.com')
+# Get webhook
+response = unione.get_webhook(
+  url: 'http://example.com'
+)
 
-# list all webhooks
-response = unione.list_webhooks(50, 0)
+# List all webhooks
+response = unione.list_webhooks(
+  limit: 50,
+  offset: 0
+)
 
-# delete webhook
-response = unione.delete_webhook('http://example.com')
+# Delete webhook
+response = unione.delete_webhook(
+  url: 'http://example.com'
+)

data/examples/helpers.rb

@@ -0,0 +1,29 @@
+require 'unione-ruby'
+
+unione = UniOne::Client.new(
+  hostname: 'eu1.unione.io',
+  lang: 'en',
+  api_key: ENV['UNIONE_API_KEY']
+)
+
+# Verify webhook callback message
+# Will raise Unione::Client::InvalidCallbackAuth error unless `auth' field is correct.
+unione.verify_callback_auth!(params)
+
+# Callback helper usage
+# Will raise Unione::Client::InvalidCallbackAuth error unless `auth' field is correct.
+unione.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 'unione-ruby'
+require 'json'
+
+unione = UniOne::Client.new(
+  hostname: 'eu1.unione.io',
+  lang: 'en',
+  api_key: ENV['UNIONE_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@qadns.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 = unione.send_email(message: message)
+
+puts response.status
+puts response.body.to_h
+puts response.headers

data/examples/setup.rb

@@ -1,27 +1,34 @@
 require 'unione-ruby'
 require 'json'
 
-unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
+unione = UniOne::Client.new(
+  hostname: 'eu1.unione.io',
+  lang: 'en',
+  api_key: ENV['UNIONE_API_KEY']
+)
 
 # Validate domain verification record
-unione.validate_verification_record('example.com')
+unione.validate_verification_record(domain: 'qadns.net')
 
 # Create template
-template = UniOne::Template.new
+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[:name] = 'Template Name'
+template[:subject] = 'Email Subject'
+template[:template_engine] = 'simple'
+template[:headers] = {'X-ReplyTo' => 'reply@example.com'}
 
-template.from                 = { from_email: 'test@example.com', from_name: 'userName' }
-template.body                 = { html: '<b>Hello {{substitutionName}}</b>' }
+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         << { type: 'text/plain', name: 'myfile.txt', content: 'ZXhhbXBsZSBmaWxl' }
-template.inline_attachments  << { type: 'image/png', name: 'IMAGECID', content: 'iVBORw0KGgo' }
+template[:attachments] = []
+template[:attachments] << { type: 'text/plain', name: 'myfile.txt', content: 'ZXhhbXBsZSBmaWxl' }
 
-template.options              = { unsubscribe_url: 'someurl' }
+template[:inline_attachments] = []
+template[:inline_attachments] << { type: 'image/png', name: 'IMAGECID', content: 'iVBORw0KGgo' }
 
-response = unione.set_template(template.to_json)
+response = unione.set_template(template: template)
 template_id = response.body.template.id

data/lib/unione/client/domain.rb

@@ -1,58 +1,34 @@
 module UniOne
   class Client
     module Domain
-      def get_dns_records(domain)
-        params = { domain: domain }
-        post 'domain/get-dns-records.json', params
-        validate_response({
-          'type' => 'object', 'required' => ['status', 'domain', 'verification-record', 'dkim'], 'properties' => {
-            'status' => {'type' => 'string'},
-            'domain' => {'type' => 'string'},
-            'verification-record' => {'type' => 'string'},
-            'dkim' => {'type' => 'string'}}
-        })
+      extend UniOne::Validation::ClassMethods
+      include UniOne::Validation::InstanceMethods
+
+      def get_dns_records(params = {})
+        post('domain/get-dns-records.json', params)
       end
 
-      def validate_verification_record(domain)
-        params = { domain: domain }
-        post 'domain/validate-verification-record.json', params
-        validate_response({
-          'type' => 'object', 'required' => ['status', 'message'], 'properties' => {
-            'status' => {'type' => 'string'},
-            'message' => {'type' => 'string'}}
-        })
+      def validate_verification_record(params = {})
+        post('domain/validate-verification-record.json', params)
       end
 
-      def validate_dkim(domain)
-        params = { domain: domain }
-        post 'domain/validate-dkim.json', params
-        validate_response({
-          'type' => 'object', 'required' => ['status', 'message'], 'properties' => {
-            'status' => {'type' => 'string'},
-            'message' => {'type' => 'string'}}
-        })
+      def validate_dkim(params = {})
+        post('domain/validate-dkim.json', params)
       end
 
-      def list_domains
-        post 'domain/list.json', {}
-        validate_response({
-          'type' => 'object', 'required' => ['status', 'domains'], 'properties' => {
-            'status' => {'type' => 'string'},
-            'domains' =>
-            {'items' =>
-             {'type' => 'object', 'required' => ['domain', 'verification-record', 'dkim'], 'properties' => [
-              'domain' => {'type' => 'string'},
-              'verification-record' =>
-              {'type' => 'object', 'required' => ['value', 'status'], 'properties' => [
-               'value' => {'type' => 'string'},
-               'status' => {'type' => 'string'}]},
-              'dkim' =>
-              {'type' => 'object', 'required' => ['key', 'status'], 'properties' => [
-               'key' => {'type' => 'string'},
-               'status' => {'type' => 'string'}]}
-              ]}}}
-        })
+      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/unione/client/email.rb

@@ -1,24 +1,25 @@
 module UniOne
   class Client
     module Email
-      def send_email(message)
-        post 'email/send.json', message
-        validate_response({
-          'type' => 'object', 'required' => ['status', 'job_id', 'emails'], 'properties' => {
-            'status' => {'type' => 'string'},
-            'job_id' => {'type' => 'string'},
-            'emails' => {'items' => {'type' => 'string'}},
-            'failed_emails' => {'type' => 'object'}}
-        })
+      extend UniOne::Validation::ClassMethods
+      include UniOne::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
-        validate_response({
-          'type' => 'object', 'required' => ['status'], 'properties' => {
-            'status' => {'type' => 'string'}}
-        })
+      def subscribe_email(params = {})
+        post('email/subscribe.json', params)
       end
+
+      add_response_validations(
+        :email,
+        %w(
+          send_email
+          subscribe_email
+        )
+      )
     end
   end
 end

data/lib/unione/client/event_dump.rb

@@ -0,0 +1,37 @@
+module UniOne
+  class Client
+    module EventDump
+      extend UniOne::Validation::ClassMethods
+      include UniOne::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/unione/client/project.rb

@@ -1,76 +1,34 @@
 module UniOne
   class Client
     module Project
-      def create_project(project)
-        params = { project: project }
-        post 'project/create.json', params
-        validate_response({
-          'type' => 'object', 'required' => ['status', 'project_id', 'project_api_key'], 'properties' => {
-            'status' => {'type' => 'string'},
-            'project_id' => {'type' => 'string'},
-            'project_api_key' => {'type' => 'string'}}
-        })
-      end
+      extend UniOne::Validation::ClassMethods
+      include UniOne::Validation::InstanceMethods
 
-      def update_project(project_identity, project)
-        params = get_identity(project_identity).merge(project: project)
-        post 'project/update.json', params
-        validate_response({
-          'type' => 'object', 'required' => ['status'], 'properties' => {
-            'status' => {'type' => 'string'},
-            'project_api_key' => {'type' => 'string'}}
-        })
+      def create_project(params = {})
+        post('project/create.json', params)
       end
 
-      def list_projects(project_identity = nil)
-        params = get_identity(project_identity)
-        post 'project/list.json', params
-        validate_response({
-          'type'       => 'object',
-          'required'   => %w{ status },
-          'properties' => {
-            'status'     => { 'type' => 'string' },
-            'projects'   => { 'items' => project_schema }
-          }
-        })
+      def update_project(params = {})
+        post('project/update.json', params)
       end
 
-      def delete_project(project_identity)
-        params = get_identity(project_identity)
-        post 'project/delete.json', params
-        validate_response({
-          'type'       => 'object',
-          'required'   => %w{ status },
-          'properties' => {
-            'status' => { 'type' => 'string' }
-          }
-        })
+      def list_projects(params = {})
+        post('project/list.json', params)
       end
 
-      private
-
-      def get_identity(project_identity)
-        if project_identity.is_a?(Hash)
-          project_identity
-        elsif project_identity
-          { project_api_key: project_identity }
-        else
-          {}
-        end
+      def delete_project(params = {})
+        post('project/delete.json', params)
       end
 
-      def project_schema
-        {'type'       => 'object',
-         'required'   => %w{ id api_key name reg_time send_enabled custom_unsubscribe_url_enabled },
-         'properties' => {
-           'id'                             => {'type' => 'string'},
-           'api_key'                        => {'type' => 'string'},
-           'name'                           => {'type' => 'string'},
-           'reg_time'                       => {'type' => 'string'},
-           'send_enabled'                   => {'type' => 'boolean'},
-           'custom_unsubscribe_url_enabled' => {'type' => 'boolean'}
-         }}
-      end
+      add_response_validations(
+        :project,
+        %w(
+          create_project
+          update_project
+          list_projects
+          delete_project
+        )
+      )
     end
   end
 end

data/lib/unione/client/suppression.rb

@@ -0,0 +1,38 @@
+module UniOne
+  class Client
+    module Suppression
+      extend UniOne::Validation::ClassMethods
+      include UniOne::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/unione/client/system.rb

@@ -1,24 +1,19 @@
 module UniOne
   class Client
     module System
-      def info
-        post 'system/info.json', {}
-        validate_response({
-          'type' => 'object', 'required' => ['status', 'user_id', 'email'], 'properties' => {
-            'status' => {'type' => 'string'},
-            'user_id' => {'type' => 'integer'},
-            'email' => {'type' => 'string'},
-            'accounting' =>
-            {'type' => 'object', 'required' => ['period_start', 'period_end', 'emails_included', 'emails_sent'], 'properties' => [
-             'period_start' => {'type' => 'string'},
-             'period_end' => {'type' => 'string'},
-             'emails_included' => {'type' => 'integer'},
-             'emails_sent' => {'type' => 'integer'}
-             ]},
-            'project_id' => {'type' => 'string'},
-            'project_name' => {'type' => 'string'}}
-        })
+      extend UniOne::Validation::ClassMethods
+      include UniOne::Validation::InstanceMethods
+
+      def info(params = {})
+        post('system/info.json', params)
       end
+
+      add_response_validations(
+        :system,
+        %w(
+          info
+        )
+      )
     end
   end
 end

data/lib/unione/client/tag.rb

@@ -0,0 +1,24 @@
+module UniOne
+  class Client
+    module Tag
+      extend UniOne::Validation::ClassMethods
+      include UniOne::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