unione-ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8462ee8f317ff0d316298a45e0f6f948897776346bcbe7f70997190a681e02a
-  data.tar.gz: 51f9b320c81f7bd65559b10eda50bdaf20a0bd1148c2d7017590a1d344319118
+  metadata.gz: e22befdd1f1c883aea070dc4fc563186de323067b32d3d5d9f992185b6f2daed
+  data.tar.gz: 95d1729d578640a7853b44498198a4253a587270344ba3b1893452e28489c4b8
 SHA512:
-  metadata.gz: 46993c14f31096f8f22eefb96f050c26436088335ef44572d981fd599f25187b333d69b7c19790e0fe04f3efee05b164f226181d5633f0c06c30737a25e62bd4
-  data.tar.gz: 33b4d179be489d1edb42b0a24f5866a672d640ae90e30dd8db1376a63ecb695624c5034b48f52b30584153c1298cf7fd780be610204ae7e02e43715d3e37e82f
+  metadata.gz: 2679550487b3d69e2bb922309a9581d3f6905f534a5d3a809e957ee7797fed443124c9454a1449e3983538daa88a94860c91153d630da1aef34ba7970586c647
+  data.tar.gz: 363db7dd049ddd4921de5ef64354b741b9353db1423cc2bace4a0ea99c460b6656531aeef371846cda6aaf17abe7c88b82115da2f54ab3d8483802858cb64f66

data/README.md

@@ -3,12 +3,16 @@ UniOne (unione.io) integration gem for Ruby
 
 [Examples of usage](https://github.com/unione-repo/unione-ruby/tree/master/examples)
 
+## Install
+
+    gem install unione-ruby
+
 ## Working with API responses
 This library using [faraday](https://github.com/lostisland/faraday) gem for making HTTP queries along with [mashify middleware](https://github.com/hashie/hashie#mash) for post-processing response body. So, you can use extended syntax for accessing response fields.
 
 Example of work with responses:
 
-```ruby
+~~~ruby
 require 'unione-ruby'
 unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
 response = unione.get_dns_records("example.com")
@@ -18,6 +22,12 @@ puts response.headers
 # Access fields as hash or as methods
 puts response.body['status']
 puts response.body.status
+~~~
+
+By default authentication produced through X-API-KEY header. For passing API key in params use:
+
+```
+unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'], api_key_in_params: true)
 ```
 
 ## Handling API errors
@@ -25,7 +35,7 @@ Library using [`raise-error' middleware](https://lostisland.github.io/faraday/mi
 
 Example of work with errors:
 
-```ruby
+~~~ruby
 require 'unione-ruby'
 begin
   unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
@@ -39,4 +49,4 @@ rescue Faraday::Error => e
   puts e.response[:body]
   puts e.response[:headers]
 end
-```
+~~~

data/Rakefile

@@ -0,0 +1,3 @@
+task :console do
+  exec "irb -r unione-ruby -I ./lib"
+end

data/examples/api/domain.rb

@@ -9,10 +9,10 @@ puts response.body.to_h
 puts response.headers
 
 # Validate domain verification record before use
-response = unione.validate_verification_record("example.com")
+response = unione.validate_verification_record('example.com')
 
 # Validate DKIM signature before sending
-response = unione.validate_dkim("example.com")
+response = unione.validate_dkim('example.com')
 
 # Get a list of your domains and their verification/DKIM statuses
 response = unione.list_domains

data/examples/api/email.rb

@@ -1,36 +1,51 @@
 require 'unione-ruby'
 require 'json'
 
-# Send email
+unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
+
+# sending mail
 mail = UniOne::Mail.new
-mail.body = {html: "<b>Hello {{substitutionName}}</b>"}
-mail.from = {from_email: 'test@example.com', from_name: 'userName'}
-mail.subject = 'Email Subject'
-mail.template = {"template_engine" => "simple", "template_id" => "template_id"}
 
-substitutions = {"substitutionName" => "substitutionVal", "to_name" => "Name Surname 1"}
-recipient1 = {email: 'test1@example.com', substitutions: substitutions, metadata: {"key1" => "val1"}}
+mail.subject  = 'Email Subject'
+mail.from     = { from_email: 'test@qadns.net', from_name: 'userName' }
+
+# Using body
+mail.body     = { html: '<b>Hello {{substitutionName}}</b>' }
+
+# Using template
+# mail.template = { template_engine: 'simple', template_id: 'template_id' }
+
+substitutions = { 'substitutionName' => 'substitutionVal', to_name: 'Name Surname 1' }
+recipient1    = { email: 'test1@example.com', substitutions: substitutions, metadata: { key1: 'val1' } }
 mail.recipients << recipient1
 
-substitutions = {"substitutionName" => "substitutionVal", "to_name" => "Name Surname 2"}
-recipient2 = {email: 'test2@example.com', substitutions: substitutions, metadata: {"key1" => "val1"}}
+substitutions = { 'substitutionName' => 'substitutionVal', to_name: 'Name Surname 2' }
+recipient2    = { email: 'test2@example.com', substitutions: substitutions, metadata: { key1: 'val1' } }
 mail.recipients << recipient2
 
-mail.metadata = {"key1" => "val1"}
-mail.headers = {"X-ReplyTo" => "reply@example.com"}
-mail.attachments << {"type" => "text/plain", "name" => "myfile.txt", "content" => "ZXhhbXBsZSBmaWxl"}
-mail.inline_attachments << {"type" => "image/png", "name" => "IMAGECID", "content" => "iVBORw0KGgo"}
-mail.options = {"unsubscribe_url" => "someurl"}
+mail.global_metadata = { key1: 'val1' }
+mail.headers = { 'X-ReplyTo' => 'reply@qadns.net' }
+mail.track   = { track_links: 1, track_read: 1 }
+mail.options = { unsubscribe_url: 'someurl' }
+
+# Should have rights to use this option
+# mail.skip_unsubscribe = 1
+mail.force_send       = 0
+
+mail.attachments        << { type: 'text/plain', name: 'myfile.txt', content: 'ZXhhbXBsZSBmaWxl' }
+mail.inline_attachments << { type: 'image/png', name: 'IMAGECID', content: 'iVBORw0KGgo' }
 
 puts mail.to_json
 
-unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
 response = unione.send_email(mail.to_json)
+
 puts response.status
 puts response.body
 puts response.headers
 
-# Subscribe email
-unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
-response = unione.subscribe_email(email_address_from: "emailFrom",
-  email_address_to: "blackhole@example.com", name_from: "Example Sender")
+# subscribe email
+response = unione.subscribe_email(
+  from_email: 'from@qadns.net',
+  from_name: 'Example Sender',
+  to_email: 'blackhole@example.com'
+)

data/examples/api/project.rb

@@ -1,20 +1,37 @@
 require 'unione-ruby'
 
-# Create project
 unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
-response = unione.create_project(
-  {"name" => "Projectname 2", "send_enabled" => true, "custom_unsubscribe_url_enabled" => true})
+
+# create project
+response = unione.create_project({
+  name: 'Project Name',
+  send_enabled: true,
+  # custom_unsubscribe_url_enabled: true, # Should have rights to use
+})
+
 puts response.status
 puts response.body.to_h
 puts response.headers
 
-# Update project
-response = unione.update_project("5qugsquc85i1e87xfb4spgxh8bnmi1pjfrtx1w1c",
-  {"name" => "Projectname 2", "send_enabled" => true, "custom_unsubscribe_url_enabled" => true})
+project_id = response.body.project_id
 
-# Delete project
-response = unione.delete_project("5qegsquc85i1e87xfb4spgxh8bnmi1pjfrtx1w1c")
+# update project
+response = unione.update_project(
+  {
+    project_id: project_id
+  },
+  {
+    name: 'New Project Name',
+    send_enabled: true,
+    # custom_unsubscribe_url_enabled: true, # Should have rights to use
+  }
+)
 
-# List projects
+# list all projects
 response = unione.list_projects
-response = unione.list_projects("5qegsquc85i1e87xfb4spgxh8bnmi1pjfrtx1w1c")
+
+# list project by id
+response = unione.list_projects({ project_id: project_id })
+
+# delete project
+response = unione.delete_project({ project_id: project_id })

data/examples/api/system.rb

@@ -0,0 +1,10 @@
+require 'unione-ruby'
+
+unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
+
+# get user or project information
+response = unione.info
+
+puts response.status
+puts response.body.to_h
+puts response.headers

data/examples/api/template.rb

@@ -1,36 +1,42 @@
 require 'unione-ruby'
 require 'json'
 
-# Set template
+unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
+
+# set template
 template = UniOne::Template.new
-template.name = 'Template Name'
-template.subject = 'Email Subject'
+
+template.name            = 'Template Name'
+template.editor_type     = 'html'
+template.subject         = 'Email Subject'
 template.template_engine = 'simple'
-template.global_substitutions = {"someVar" => "someVal"}
 
-template.from = {from_email: 'test@example.com', from_name: 'userName'}
-template.headers = {"X-ReplyTo" => "reply@example.com"}
-template.body = {html: "<b>Hello {{substitutionName}}</b>"}
+template.global_substitutions = { 'someVar' => 'someVal' }
+
+template.from    = { from_email: 'test@example.com', from_name: 'userName' }
+template.headers = { 'X-ReplyTo' => 'reply@example.com' }
+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.options = {"unsubscribe_url" => "someurl"}
+template.attachments        << { type: 'text/plain', name: 'myfile.txt', content: 'ZXhhbXBsZSBmaWxl' }
+template.inline_attachments << { type: 'image/png', name: 'IMAGECID', content: 'iVBORw0KGgo' }
 
 puts template.to_json
 
-unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
 response = unione.set_template(template.to_json)
+
 puts response.status
 puts response.body.to_h
-puts response.body.template.id   # Get Id of created template for later referencing
 puts response.headers
 
-# Get template
-unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
-response = unione.get_template("cef89054-40a8-4b9b-a379-22030d525c49")
+# get id of created template
+template_id = response.body.template.id
+
+# get template
+response = unione.get_template(template_id)
 
-# List templates
+# list all templates
 response = unione.list_templates(50, 0)
 
-# Delete template
-response = unione.delete_template("cef89054-40a8-4b9b-a379-22030d525c49")
+# delete template
+response = unione.delete_template(template_id)

data/examples/api/unsubscribed.rb

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

data/examples/api/webhook.rb

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

data/examples/sending_mail.rb

@@ -0,0 +1,32 @@
+require 'unione-ruby'
+require 'json'
+
+unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
+
+mail = UniOne::Mail.new
+
+template_id    = "bc0372d4-69f2-11eb-9d14-366b3a36c9e1"
+mail.template  = { template_engine: 'simple', template_id: template_id }
+
+mail.from      = { from_email: 'test@qadns.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 = unione.send_email(mail.to_json)
+
+puts response.status
+puts response.body.to_h
+puts response.headers

data/examples/setup.rb

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

data/lib/unione/client.rb

@@ -2,10 +2,11 @@ require_relative 'connection'
 require_relative 'validation'
 require_relative 'client/domain'
 require_relative 'client/email'
+require_relative 'client/project'
+require_relative 'client/system'
 require_relative 'client/template'
-require_relative 'client/webhook'
 require_relative 'client/unsubscribed'
-require_relative 'client/project'
+require_relative 'client/webhook'
 
 module UniOne
 
@@ -15,10 +16,11 @@ module UniOne
     include UniOne::Validation
     include UniOne::Client::Domain
     include UniOne::Client::Email
+    include UniOne::Client::Project
+    include UniOne::Client::System
     include UniOne::Client::Template
-    include UniOne::Client::Webhook
     include UniOne::Client::Unsubscribed
-    include UniOne::Client::Project
+    include UniOne::Client::Webhook
 
     API_ENDPOINT =
       'https://%{data_center}.unione.io/%{lang}/transactional/api/v1/'
@@ -27,11 +29,12 @@ module UniOne
     #   - +data_center+ -> data center: ['eu1', 'us1']
     #   - +lang+ -> Two-letter ISO 639-1 language abbreviation, e.g. 'en'
     #   - +api_key+ -> your UniOne API key
-    #
-    def initialize(data_center:, lang:, api_key:)
-      @data_center = data_center
-      @lang = lang
-      @api_key = api_key
+    #   - +api_key_in_params+ -> boolean, pass API key inside form, otherwise pass in headers (default in headers)
+    def initialize(params = {})
+      @data_center       = params[:data_center]
+      @lang              = params[:lang]
+      @api_key           = params[:api_key]
+      @api_key_in_params = !!params[:api_key_in_params]
     end
 
     private

data/lib/unione/client/domain.rb

@@ -1,8 +1,6 @@
 module UniOne
   class Client
-
     module Domain
-
       def get_dns_records(domain)
         params = { domain: domain }
         post 'domain/get-dns-records.json', params
@@ -55,7 +53,6 @@ module UniOne
               ]}}}
         })
       end
-
     end
   end
 end

data/lib/unione/client/email.rb

@@ -1,8 +1,6 @@
 module UniOne
   class Client
-
     module Email
-
       def send_email(message)
         post 'email/send.json', message
         validate_response({
@@ -14,19 +12,13 @@ module UniOne
         })
       end
 
-      def subscribe_email(email_address_from:, email_address_to:, name_from:)
-        params = {
-          email_address_from: email_address_from,
-          email_address_to: email_address_to,
-          name_from: name_from
-        }
+      def subscribe_email(params)
         post 'email/subscribe.json', params
         validate_response({
           'type' => 'object', 'required' => ['status'], 'properties' => {
             'status' => {'type' => 'string'}}
         })
       end
-
     end
   end
 end

data/lib/unione/client/project.rb

@@ -1,55 +1,73 @@
 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_api_key'], 'properties' => {
+          'type' => 'object', 'required' => ['status', 'project_id', 'project_api_key'], 'properties' => {
             'status' => {'type' => 'string'},
+            'project_id' => {'type' => 'string'},
             'project_api_key' => {'type' => 'string'}}
         })
       end
 
-      def update_project(project_api_key, project)
-        params = { project_api_key: project_api_key, project: project }
+      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', 'project_api_key'], 'properties' => {
+          'type' => 'object', 'required' => ['status'], 'properties' => {
             'status' => {'type' => 'string'},
             'project_api_key' => {'type' => 'string'}}
         })
       end
 
-      def delete_project(project_api_key)
-        params = { project_api_key: project_api_key }
-        post 'project/delete.json', params
+      def list_projects(project_identity = nil)
+        params = get_identity(project_identity)
+        post 'project/list.json', params
         validate_response({
-          'type' => 'object', 'required' => ['status'], 'properties' => {
-            'status' => {'type' => 'string'}}
+          'type'       => 'object',
+          'required'   => %w{ status },
+          'properties' => {
+            'status'     => { 'type' => 'string' },
+            'projects'   => { 'items' => project_schema }
+          }
         })
       end
 
-      def list_projects(project_api_key = nil)
-        params = { project_api_key: project_api_key }
-        post 'project/list.json', params
+      def delete_project(project_identity)
+        params = get_identity(project_identity)
+        post 'project/delete.json', params
         validate_response({
-          'type' => 'object', 'required' => ['status'], 'properties' => {
-            'status' => {'type' => 'string'},
-            'projects' => {'items' => project_schema}}
+          'type'       => 'object',
+          'required'   => %w{ status },
+          'properties' => {
+            'status' => { 'type' => 'string' }
+          }
         })
       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
+      end
+
       def project_schema
-        {'type' => 'object', 'required' => ['api_key', 'name', 'reg_time', 'send_enabled', 'custom_unsubscribe_url_enabled'], 'properties' => {
-           'api_key' => {'type' => 'string'},
-           'name' => {'type' => 'string'},
-           'reg_time' => {'type' => 'string'},
-           'send_enabled' => {'type' => 'boolean'},
+        {'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

data/lib/unione/client/system.rb

@@ -0,0 +1,24 @@
+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'}}
+        })
+      end
+    end
+  end
+end

data/lib/unione/client/template.rb

@@ -45,10 +45,11 @@ module UniOne
       private
 
       def template_schema
-        {'type' => 'object', 'required' => ['id', 'name', 'subject', 'from_name', 'body', 'headers', 'attachments',
-                                            'inline_attachments', 'options', 'created', 'user_id'], 'properties' => {
+        {'type' => 'object', 'required' => ['id', 'name', 'editor_type', 'subject', 'from_name', 'body', 'headers', 'attachments',
+                                            'inline_attachments', 'created', 'user_id'], 'properties' => {
            'id' => {'type' => 'string'},
            'name' => {'type' => 'string'},
+           'editor_type' => {'type' => 'string'},
            'subject' => {'type' => 'string'},
            'from_name' => {'type' => 'string'},
            'body' => template_body_schema,

data/lib/unione/client/webhook.rb

@@ -21,6 +21,31 @@ module UniOne
          }})
       end
 
+      def list_webhooks(limit, offset)
+        params = { limit: limit, offset: offset }
+        post 'webhook/list.json', params
+        validate_response({
+          'type' => 'object', 'required' => ['status', 'objects'], 'properties' => {
+            'status' => {'type' => 'string'},
+            'objects' =>
+            {'items' =>
+             {'type' => 'object', 'required' => ['id', 'url', 'status', 'updated_at', 'events', 'event_format', 'delivery_info', 'single_event', 'max_parallel'], 'properties' => [
+              'id' => {'type' => 'integer'},
+              'url' => {'type' => 'string'},
+              'status' => {'type' => 'string'},
+              'updated_at' => {'type' => 'string'},
+              'events' =>
+              {'type' => 'object', 'required' => ['email_status', 'spam_block'], 'properties' => [
+               'email_status' => {'items' => {'type' => 'string'}},
+               'spam_block' => {'items' => {'type' => 'string'}}]},
+              'event_format' => {'type' => 'string'},
+              'delivery_info' => {'type' => 'integer'},
+              'single_event' => {'type' => 'integer'},
+              'max_parallel' => {'type' => 'integer'}
+              ]}}}
+        })
+      end
+
       def delete_webhook(url)
         params = { url: url }
         post 'webhook/delete.json', params
@@ -32,13 +57,15 @@ module UniOne
       private
 
       def webhook_schema
-        {'type' => 'object', 'required' => ['url', 'events', 'event_format', 'delivery_info', 'single_event', 'max_parallel'], 'properties' => {
+        {'type' => 'object', 'required' => ['url', 'status', 'events', 'event_format', 'delivery_info', 'single_event', 'max_parallel'], 'properties' => {
+           'id' => {'type' => 'integer'},
            'url' => {'type' => 'string'},
-           'events' => webhook_events_schema,
+           'status' => {'type' => 'string'},
            'event_format' => {'type' => 'string'},
            'delivery_info' => {'type' => 'integer'},
            'single_event' => {'type' => 'integer'},
-           'max_parallel' => {'type' => 'integer'}
+           'max_parallel' => {'type' => 'integer'},
+           'events' => webhook_events_schema,
          }}
       end
 

data/lib/unione/connection.rb

@@ -7,33 +7,33 @@ module UniOne
   module Connection
 
     def get(url, params)
-      params.merge!(default_params)
+      prepare_params!(params)
+
       # Assume HTTP library receives params as Hash
-      request :get, url, params
+      request(:get, url, params)
     end
 
     def post(url, params)
-      params.merge!(default_params)
+      prepare_params!(params)
+
       # Assume HTTP library receives payload body as String
-      request :post, url, JSON.dump(params)
+      request(:post, url, JSON.dump(params))
     end
 
     private
 
     def request(method, path, data)
       path = add_version(path)
-      begin
-        @last_response = conn.send(method, path, data)
-      rescue Faraday::Error => e
-        puts e.response[:body]
-        raise
-      end
+      @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: {'Content-Type' => 'application/json'},
+        headers: headers,
         request: { timeout: 30 }
       ) do |conn|
         conn.response :mashify, content_type: /\bjson$/
@@ -43,8 +43,12 @@ module UniOne
       end
     end
 
-    def default_params
-      { api_key: @api_key }
+    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)

data/lib/unione/helpers/mail/mail.rb

@@ -1,8 +1,8 @@
 module UniOne
   class Mail
-    attr_accessor :template, :body, :track, :from, :subject, :metadata, :headers, :options,
+    attr_accessor :template, :body, :track, :from, :subject, :global_metadata, :headers, :options,
                   :global_substitutions, :recipients, :attachments, :inline_attachments,
-                  :reply_to
+                  :reply_to, :skip_unsubscribe, :force_send
 
     def initialize
       @template = {}
@@ -14,6 +14,9 @@ module UniOne
       @inline_attachments = []
     end
 
+    # backward compatibility
+    alias_method :"metadata=", :"global_metadata="
+
     def to_json(*)
       {
         message: {
@@ -22,11 +25,13 @@ module UniOne
           subject: self.subject,
           reply_to: self.reply_to,
           recipients: self.recipients,
-          metadata: self.metadata,
+          global_metadata: self.global_metadata,
           headers: self.headers,
           attachments: self.attachments,
           inline_attachments: self.inline_attachments,
-          options: self.options
+          options: self.options,
+          skip_unsubscribe: self.skip_unsubscribe,
+          force_send: self.force_send
         }.merge(self.template)
          .merge(self.from)
          .merge(self.track)

data/lib/unione/helpers/template/template.rb

@@ -1,6 +1,6 @@
 module UniOne
   class Template
-    attr_accessor :name, :subject, :template_engine, :global_substitutions, :from,
+    attr_accessor :name, :editor_type, :subject, :template_engine, :global_substitutions, :from,
                   :headers, :body, :attachments, :inline_attachments, :options
 
     def initialize
@@ -15,6 +15,7 @@ module UniOne
         template: {
           id: '',
           name: self.name,
+          editor_type: self.editor_type,
           subject: self.subject,
           template_engine: self.template_engine,
           global_substitutions: self.global_substitutions,

data/lib/unione/helpers/webhook/webhook.rb

@@ -1,6 +1,6 @@
 module UniOne
   class Webhook
-    attr_accessor :url, :settings, :events
+    attr_accessor :url, :status, :settings, :events
 
     def initialize
       @settings = {}
@@ -9,6 +9,7 @@ module UniOne
     def to_json(*)
       {
         url: self.url,
+        status: self.status,
         events: self.events
       }.merge(self.settings)
         .delete_if { |_, value| value.to_s.strip == '' || value == [] || value == {}}

data/lib/unione/validation.rb

@@ -6,12 +6,7 @@ module UniOne
     private
 
     def validate_response(schema)
-      begin
-        JSON::Validator.validate!(schema, @last_response.body)
-      rescue JSON::Schema::ValidationError => e
-        puts @last_response.body
-        raise
-      end
+      JSON::Validator.validate!(schema, @last_response.body)
       @last_response
     end
 

data/lib/unione/version.rb

@@ -1,3 +1,3 @@
 module UniOne
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unione-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - UniOne developer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -102,19 +102,22 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- examples/1_setup.rb
-- examples/2_mail_sending.rb
+- Rakefile
 - examples/api/domain.rb
 - examples/api/email.rb
 - examples/api/project.rb
+- examples/api/system.rb
 - examples/api/template.rb
 - examples/api/unsubscribed.rb
 - examples/api/webhook.rb
+- examples/sending_mail.rb
+- examples/setup.rb
 - lib/unione-ruby.rb
 - lib/unione/client.rb
 - lib/unione/client/domain.rb
 - lib/unione/client/email.rb
 - lib/unione/client/project.rb
+- lib/unione/client/system.rb
 - lib/unione/client/template.rb
 - lib/unione/client/unsubscribed.rb
 - lib/unione/client/webhook.rb

data/examples/1_setup.rb

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

data/examples/2_mail_sending.rb

@@ -1,23 +0,0 @@
-require 'unione-ruby'
-require 'json'
-
-unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
-
-mail = UniOne::Mail.new
-mail.template = {"template_engine" => "simple", "template_id" => template_id}
-
-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.metadata = {"key1" => "val1"}
-mail.headers = {"X-ReplyTo" => "reply@example.com"}
-mail.attachments << {"type" => "text/plain", "name" => "myfile.txt", "content" => "ZXhhbXBsZSBmaWxl"}
-mail.inline_attachments << {"type" => "image/png", "name" => "IMAGECID", "content" => "iVBORw0KGgo"}
-mail.options = {"unsubscribe_url" => "someurl"}
-
-unione.send_email(mail.to_json)