unione-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c8462ee8f317ff0d316298a45e0f6f948897776346bcbe7f70997190a681e02a
+  data.tar.gz: 51f9b320c81f7bd65559b10eda50bdaf20a0bd1148c2d7017590a1d344319118
+SHA512:
+  metadata.gz: 46993c14f31096f8f22eefb96f050c26436088335ef44572d981fd599f25187b333d69b7c19790e0fe04f3efee05b164f226181d5633f0c06c30737a25e62bd4
+  data.tar.gz: 33b4d179be489d1edb42b0a24f5866a672d640ae90e30dd8db1376a63ecb695624c5034b48f52b30584153c1298cf7fd780be610204ae7e02e43715d3e37e82f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 UniOne
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# unione-ruby
+UniOne (unione.io) integration gem for Ruby
+
+[Examples of usage](https://github.com/unione-repo/unione-ruby/tree/master/examples)
+
+## 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
+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")
+puts response.status
+puts response.body.to_h
+puts response.headers
+# Access fields as hash or as methods
+puts response.body['status']
+puts response.body.status
+```
+
+## Handling API errors
+Library using [`raise-error' middleware](https://lostisland.github.io/faraday/middleware/raise-error) for handling error responses.
+
+Example of work with errors:
+
+```ruby
+require 'unione-ruby'
+begin
+  unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
+  response = unione.get_dns_records("example.com")
+  puts response.status
+  puts response.body.to_h
+  puts response.headers
+rescue Faraday::Error => e
+  # Note that exception response has internal format which is a little bit different and body field is not post-processed
+  puts e.response[:status]
+  puts e.response[:body]
+  puts e.response[:headers]
+end
+```

data/examples/1_setup.rb

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,23 @@
+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)

data/examples/api/domain.rb

@@ -0,0 +1,18 @@
+require 'unione-ruby'
+
+unione = UniOne::Client.new(data_center: 'eu1', lang: 'en', api_key: ENV['UNIONE_API_KEY'])
+
+# Generate/get DNS records for domain verification and DKIM signing
+response = unione.get_dns_records("example.com")
+puts response.status
+puts response.body.to_h
+puts response.headers
+
+# Validate domain verification record before use
+response = unione.validate_verification_record("example.com")
+
+# Validate DKIM signature before sending
+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

@@ -0,0 +1,36 @@
+require 'unione-ruby'
+require 'json'
+
+# Send email
+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.recipients << recipient1
+
+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"}
+
+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")

data/examples/api/project.rb

@@ -0,0 +1,20 @@
+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})
+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})
+
+# Delete project
+response = unione.delete_project("5qegsquc85i1e87xfb4spgxh8bnmi1pjfrtx1w1c")
+
+# List projects
+response = unione.list_projects
+response = unione.list_projects("5qegsquc85i1e87xfb4spgxh8bnmi1pjfrtx1w1c")

data/examples/api/template.rb

@@ -0,0 +1,36 @@
+require 'unione-ruby'
+require 'json'
+
+# Set 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"}
+
+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")
+
+# List templates
+response = unione.list_templates(50, 0)
+
+# Delete template
+response = unione.delete_template("cef89054-40a8-4b9b-a379-22030d525c49")

data/examples/api/unsubscribed.rb

@@ -0,0 +1,14 @@
+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")
+puts response.status
+puts response.body.to_h
+puts response.headers
+
+# Check unsubscribed
+response = unione.check_unsubscribed("email@example.com")
+
+# List unsubscribed
+response = unione.list_unsubscribed("2019-01-01")

data/examples/api/webhook.rb

@@ -0,0 +1,32 @@
+require 'unione-ruby'
+require 'json'
+
+# 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: ["*"]}
+
+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")
+
+# Delete webhook
+response = unione.delete_webhook("http://example.com")

data/lib/unione-ruby.rb

@@ -0,0 +1,5 @@
+require_relative 'unione/client'
+require_relative 'unione/version'
+require_relative 'unione/helpers/mail/mail'
+require_relative 'unione/helpers/template/template'
+require_relative 'unione/helpers/webhook/webhook'

data/lib/unione/client.rb

@@ -0,0 +1,44 @@
+require_relative 'connection'
+require_relative 'validation'
+require_relative 'client/domain'
+require_relative 'client/email'
+require_relative 'client/template'
+require_relative 'client/webhook'
+require_relative 'client/unsubscribed'
+require_relative 'client/project'
+
+module UniOne
+
+  class Client
+
+    include UniOne::Connection
+    include UniOne::Validation
+    include UniOne::Client::Domain
+    include UniOne::Client::Email
+    include UniOne::Client::Template
+    include UniOne::Client::Webhook
+    include UniOne::Client::Unsubscribed
+    include UniOne::Client::Project
+
+    API_ENDPOINT =
+      'https://%{data_center}.unione.io/%{lang}/transactional/api/v1/'
+
+    # * *Args* :
+    #   - +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
+    end
+
+    private
+
+    def api_endpoint
+      @api_endpoint ||=
+        API_ENDPOINT % { data_center: @data_center, lang: @lang }
+    end
+  end
+end

data/lib/unione/client/domain.rb

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

data/lib/unione/client/email.rb

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

@@ -0,0 +1,58 @@
+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' => {
+            'status' => {'type' => 'string'},
+            'project_api_key' => {'type' => 'string'}}
+        })
+      end
+
+      def update_project(project_api_key, project)
+        params = { project_api_key: project_api_key, project: project }
+        post 'project/update.json', params
+        validate_response({
+          'type' => 'object', 'required' => ['status', 'project_api_key'], '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
+        validate_response({
+          'type' => 'object', 'required' => ['status'], 'properties' => {
+            'status' => {'type' => 'string'}}
+        })
+      end
+
+      def list_projects(project_api_key = nil)
+        params = { project_api_key: project_api_key }
+        post 'project/list.json', params
+        validate_response({
+          'type' => 'object', 'required' => ['status'], 'properties' => {
+            'status' => {'type' => 'string'},
+            'projects' => {'items' => project_schema}}
+        })
+      end
+
+      private
+
+      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'},
+           'custom_unsubscribe_url_enabled' => {'type' => 'boolean'}
+         }}
+      end
+    end
+  end
+end

data/lib/unione/client/template.rb

@@ -0,0 +1,80 @@
+module UniOne
+  class Client
+
+    module Template
+
+      def set_template(template)
+        post 'template/set.json', template
+        validate_response({
+          'type' => 'object', 'required' => ['status', 'template'], 'properties' => {
+           'status' => {'type' => 'string'},
+           'template' => template_schema}
+        })
+      end
+
+      def get_template(id)
+        params = { id: id }
+        post 'template/get.json', params
+        validate_response({
+          'type' => 'object', 'required' => ['status', 'template'], 'properties' => {
+           'status' => {'type' => 'string'},
+           'template' => template_schema}
+        })
+      end
+
+      def list_templates(limit, offset)
+        params = { limit: limit, offset: offset }
+        post 'template/list.json', params
+        list_template_schema = remove_fields_from_schema(template_schema, ['from_name', 'headers'])
+        validate_response({
+          'type' => 'object', 'required' => ['status', 'templates'], 'properties' => {
+            'status' => {'type' => 'string'},
+            'templates' => {'items' => list_template_schema}}
+        })
+      end
+
+      def delete_template(id)
+        params = { id: id }
+        post 'template/delete.json', params
+        validate_response({
+          'type' => 'object', 'required' => ['status'], 'properties' => {
+            'status' => {'type' => 'string'}}
+        })
+      end
+
+      private
+
+      def template_schema
+        {'type' => 'object', 'required' => ['id', 'name', 'subject', 'from_name', 'body', 'headers', 'attachments',
+                                            'inline_attachments', 'options', 'created', 'user_id'], 'properties' => {
+           'id' => {'type' => 'string'},
+           'name' => {'type' => 'string'},
+           'subject' => {'type' => 'string'},
+           'from_name' => {'type' => 'string'},
+           'body' => template_body_schema,
+           'headers' => {'type' => 'object'},
+           'attachments' => {'items' => {'type' => 'object'}},
+           'inline_attachments' => {'items' => {'type' => 'object'}},
+           'options' => template_options_schema,
+           'created' => {'type' => 'string'},
+           'user_id' => {'type' => 'integer'},
+         }}
+      end
+
+      def template_body_schema
+        {'type' => 'object', 'required' => ['html', 'plaintext', 'amp'], 'properties' => {
+           'html' => {'type' => 'string, null'},
+           'plaintext' => {'type' => 'string, null'},
+           'amp' => {'type' => 'string, null'}
+         }}
+      end
+
+      def template_options_schema
+        {'type' => 'object', 'required' => ['unsubscribe_url'], 'properties' => {
+           'unsubscribe_url' => {'type' => 'string'}
+         }}
+      end
+
+    end
+  end
+end

data/lib/unione/client/unsubscribed.rb

@@ -0,0 +1,44 @@
+module UniOne
+  class Client
+
+    module Unsubscribed
+
+      def unsubscribe(address)
+        params = { address: address }
+        post 'unsubscribed/set.json', params
+        validate_response({
+          'type' => 'object', 'required' => ['status', 'address', 'message'], 'properties' => {
+            'status' => {'type' => 'string'},
+            'address' => {'type' => 'string'},
+            'message' => {'type' => 'string'}}
+        })
+      end
+
+      def check_unsubscribed(address)
+        params = { address: address }
+        post 'unsubscribed/check.json', params
+        validate_response({
+          'type' => 'object', 'required' => ['status', 'address', 'is_unsubscribed'], 'properties' => {
+            'status' => {'type' => 'string'},
+            'address' => {'type' => 'string'},
+            'is_unsubscribed' => {'type' => 'boolean'}}
+        })
+      end
+
+      def list_unsubscribed(date_from)
+        params = { date_from: date_from }
+        post 'unsubscribed/list.json', params
+        validate_response({
+          'type' => 'object', 'required' => ['status', 'unsubscribed'], 'properties' => {
+            'status' => {'type' => 'string'},
+            'unsubscribed' => {
+              'items' => {'type' => 'object'}, 'required' => ['address', 'unsubscribed_on'], 'properties' => {
+                'address' => {'type' => 'string'},
+                'unsubscribed_on' => {'type' => 'string'}
+              }}}
+        })
+      end
+
+    end
+  end
+end

data/lib/unione/client/webhook.rb

@@ -0,0 +1,53 @@
+module UniOne
+  class Client
+
+    module Webhook
+
+      def set_webhook(webhook)
+        post 'webhook/set.json', webhook
+        validate_response({'type' => 'object', 'required' => ['status', 'object'], 'properties' => {
+           'status' => {'type' => 'string'},
+           'object' => webhook_schema
+         }})
+      end
+
+      def get_webhook(url)
+        params = { url: url }
+        post 'webhook/get.json', params
+        get_webhook_schema = remove_fields_from_schema(webhook_schema, ['delivery_info', 'single_event'])
+        validate_response({'type' => 'object', 'required' => ['status', 'object'], 'properties' => {
+           'status' => {'type' => 'string'},
+           'object' => get_webhook_schema
+         }})
+      end
+
+      def delete_webhook(url)
+        params = { url: url }
+        post 'webhook/delete.json', params
+        validate_response({'type' => 'object', 'required' => ['status'], 'properties' => {
+           'status' => {'type' => 'string'}
+         }})
+      end
+
+      private
+
+      def webhook_schema
+        {'type' => 'object', 'required' => ['url', 'events', 'event_format', 'delivery_info', 'single_event', 'max_parallel'], 'properties' => {
+           'url' => {'type' => 'string'},
+           'events' => webhook_events_schema,
+           'event_format' => {'type' => 'string'},
+           'delivery_info' => {'type' => 'integer'},
+           'single_event' => {'type' => 'integer'},
+           'max_parallel' => {'type' => 'integer'}
+         }}
+      end
+
+      def webhook_events_schema
+        {'type' => 'object', 'required' => ['email_status', 'spam_block'], 'properties' => {
+           'email_status' => {'items' => {'type' => 'string'}},
+           'spam_block' => {'items' => {'type' => 'string'}}
+         }}
+      end
+    end
+  end
+end

data/lib/unione/connection.rb

@@ -0,0 +1,54 @@
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+require 'hashie'
+
+module UniOne
+  module Connection
+
+    def get(url, params)
+      params.merge!(default_params)
+      # Assume HTTP library receives params as Hash
+      request :get, url, params
+    end
+
+    def post(url, params)
+      params.merge!(default_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)
+      begin
+        @last_response = conn.send(method, path, data)
+      rescue Faraday::Error => e
+        puts e.response[:body]
+        raise
+      end
+    end
+
+    def conn
+      @conn ||= Faraday.new(
+        url: api_endpoint,
+        headers: {'Content-Type' => 'application/json'},
+        request: { timeout: 30 }
+      ) do |conn|
+        conn.response :mashify, content_type: /\bjson$/
+        conn.response :json, content_type: /\bjson$/
+        conn.response :raise_error
+        conn.adapter :net_http_persistent
+      end
+    end
+
+    def default_params
+      { api_key: @api_key }
+    end
+
+    def add_version(path)
+      "#{path}?platform=unione_ruby_#{UniOne::VERSION}"
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module UniOne
+  class Mail
+    attr_accessor :template, :body, :track, :from, :subject, :metadata, :headers, :options,
+                  :global_substitutions, :recipients, :attachments, :inline_attachments,
+                  :reply_to
+
+    def initialize
+      @template = {}
+      @from = {}
+      @track = {}
+      @global_substitutions = {}
+      @recipients = []
+      @attachments = []
+      @inline_attachments = []
+    end
+
+    def to_json(*)
+      {
+        message: {
+          global_substitutions: self.global_substitutions,
+          body: self.body,
+          subject: self.subject,
+          reply_to: self.reply_to,
+          recipients: self.recipients,
+          metadata: self.metadata,
+          headers: self.headers,
+          attachments: self.attachments,
+          inline_attachments: self.inline_attachments,
+          options: self.options
+        }.merge(self.template)
+         .merge(self.from)
+         .merge(self.track)
+         .delete_if { |_, value| value.to_s.strip == '' || value == [] || value == {}}
+      }
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module UniOne
+  class Template
+    attr_accessor :name, :subject, :template_engine, :global_substitutions, :from,
+                  :headers, :body, :attachments, :inline_attachments, :options
+
+    def initialize
+      @global_substitutions = {}
+      @from = {}
+      @attachments = []
+      @inline_attachments = []
+    end
+
+    def to_json(*)
+      {
+        template: {
+          id: '',
+          name: self.name,
+          subject: self.subject,
+          template_engine: self.template_engine,
+          global_substitutions: self.global_substitutions,
+          headers: self.headers,
+          body: self.body,
+          attachments: self.attachments,
+          inline_attachments: self.inline_attachments,
+          options: self.options
+        }.merge(self.from)
+          .delete_if { |_, value| value.to_s.strip == '' || value == [] || value == {}}
+      }
+    end
+  end
+end

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

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

data/lib/unione/response/raise_error.rb

@@ -0,0 +1,21 @@
+require 'faraday'
+require 'unione/error'
+
+module UniOne
+  # UniOne response middleware
+  module Response
+
+    # This class raises an UniOne-flavored exception based
+    # HTTP status codes returned by the API
+    class RaiseError < Faraday::Response::Middleware
+
+      private
+
+      def on_complete(response)
+        if error = UniOne::Error.from_response(response)
+          raise error
+        end
+      end
+    end
+  end
+end

data/lib/unione/validation.rb

@@ -0,0 +1,25 @@
+require 'json-schema'
+
+module UniOne
+  module Validation
+
+    private
+
+    def validate_response(schema)
+      begin
+        JSON::Validator.validate!(schema, @last_response.body)
+      rescue JSON::Schema::ValidationError => e
+        puts @last_response.body
+        raise
+      end
+      @last_response
+    end
+
+    def remove_fields_from_schema(schema, fields)
+      schema.dup.tap do |s|
+        s['required'] = s['required'].reject { |f| fields.include?(f) }
+        s['properties'] = s['properties'].reject { |f| fields.include?(f) }
+      end
+    end
+  end
+end

data/lib/unione/version.rb

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

data/unione-ruby.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unione/version'
+
+Gem::Specification.new do |spec|
+  spec.add_dependency 'json', '~> 2.0'
+  spec.add_dependency 'faraday', '~> 1.0'
+  spec.add_dependency 'faraday_middleware', '~> 1.0'
+  spec.add_dependency 'net-http-persistent', '~> 3.0'
+  spec.add_dependency 'hashie', '~> 4.0'
+  spec.add_dependency 'json-schema', '~> 2.0'
+  spec.authors = ['UniOne developer']
+  spec.description = 'Official UniOne Gem to Interact with UniOne Api in native Ruby'
+  spec.email = 'devlib@unione.io'
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.homepage = 'https://github.com/unione-repo/unione-ruby'
+  spec.licenses = ['MIT']
+  spec.name = 'unione-ruby'
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.4'
+  spec.summary = 'Official UniOne Gem'
+  spec.version = UniOne::VERSION
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: unione-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- UniOne developer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Official UniOne Gem to Interact with UniOne Api in native Ruby
+email: devlib@unione.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- examples/1_setup.rb
+- examples/2_mail_sending.rb
+- examples/api/domain.rb
+- examples/api/email.rb
+- examples/api/project.rb
+- examples/api/template.rb
+- examples/api/unsubscribed.rb
+- examples/api/webhook.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/template.rb
+- lib/unione/client/unsubscribed.rb
+- lib/unione/client/webhook.rb
+- lib/unione/connection.rb
+- lib/unione/helpers/mail/mail.rb
+- lib/unione/helpers/template/template.rb
+- lib/unione/helpers/webhook/webhook.rb
+- lib/unione/response/raise_error.rb
+- lib/unione/validation.rb
+- lib/unione/version.rb
+- unione-ruby.gemspec
+homepage: https://github.com/unione-repo/unione-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Official UniOne Gem
+test_files: []