unione-ruby 0.0.1 → 1.0.0

data/lib/unione/client/webhook.rb

@@ -1,53 +1,34 @@
 module UniOne
   class Client
-
     module Webhook
+      extend UniOne::Validation::ClassMethods
+      include UniOne::Validation::InstanceMethods
 
-      def set_webhook(webhook)
-        post 'webhook/set.json', webhook
-        validate_response({'type' => 'object', 'required' => ['status', 'object'], 'properties' => {
-           'status' => {'type' => 'string'},
-           'object' => webhook_schema
-         }})
+      def set_webhook(params = {})
+        post('webhook/set.json', params)
       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
-         }})
+      def get_webhook(params = {})
+        post('webhook/get.json', params)
       end
 
-      def delete_webhook(url)
-        params = { url: url }
-        post 'webhook/delete.json', params
-        validate_response({'type' => 'object', 'required' => ['status'], 'properties' => {
-           'status' => {'type' => 'string'}
-         }})
+      def list_webhooks(params = {})
+        post('webhook/list.json', params)
       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'}
-         }}
+      def delete_webhook(params = {})
+        post('webhook/delete.json', params)
       end
 
-      def webhook_events_schema
-        {'type' => 'object', 'required' => ['email_status', 'spam_block'], 'properties' => {
-           'email_status' => {'items' => {'type' => 'string'}},
-           'spam_block' => {'items' => {'type' => 'string'}}
-         }}
-      end
+      add_response_validations(
+        :webhook,
+        %w(
+          set_webhook
+          get_webhook
+          list_webhooks
+          delete_webhook
+        )
+      )
     end
   end
 end

data/lib/unione/client.rb

@@ -1,44 +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/webhook'
 require_relative 'client/unsubscribed'
-require_relative 'client/project'
+require_relative 'client/webhook'
 
 module UniOne
-
   class Client
-
     include UniOne::Connection
-    include UniOne::Validation
+    extend  UniOne::Validation::ClassMethods
+    include UniOne::Validation::InstanceMethods
+    include UniOne::Client::Helpers
     include UniOne::Client::Domain
     include UniOne::Client::Email
+    include UniOne::Client::EventDump
+    include UniOne::Client::Project
+    include UniOne::Client::Suppression
+    include UniOne::Client::System
+    include UniOne::Client::Tag
     include UniOne::Client::Template
-    include UniOne::Client::Webhook
     include UniOne::Client::Unsubscribed
-    include UniOne::Client::Project
+    include UniOne::Client::Webhook
+
+    class BaseException < StandardError; end
+    class InvalidCallbackAuth < BaseException; end
 
     API_ENDPOINT =
-      'https://%{data_center}.unione.io/%{lang}/transactional/api/v1/'
+      'https://%{hostname}/%{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
+    #   - +hostname+          -> string, API hostname, for example 'eu1.unione.io'
+    #   - +lang+              -> string, two-letter ISO 639-1 language abbreviation, e.g. 'en'
+    #   - +api_key+           -> string, your UniOne 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 % { data_center: @data_center, lang: @lang }
+        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/unione/connection.rb

@@ -6,45 +6,53 @@ require 'hashie'
 module UniOne
   module Connection
 
-    def get(url, params)
-      params.merge!(default_params)
+    def get(url, 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)
+    def post(url, 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'},
-        request: { timeout: 30 }
+        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 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.rb

@@ -0,0 +1,22 @@
+require 'digest'
+
+module UniOne
+  class Client
+    module Helpers
+      # Helper function for webhooks callback. It is checking auth field
+      # and if it is invalid, raises Unione::Client::InvalidCallbackAuth exception
+      def verify_callback_auth!(params)
+        params = params.transform_keys(&:to_sym)
+        auth = params[:auth]
+        unless auth == Digest::MD5.hexdigest(params.merge(auth: @api_key).to_json)
+          raise InvalidCallbackAuth
+        end
+      end
+
+      def callback_helper(params)
+        verify_callback_auth!(params)
+        yield params.dig('events_by_user', 0, 'events')
+      end
+    end
+  end
+end

data/lib/unione/response/raise_error.rb

@@ -1,14 +1,13 @@
+# UniOne response middleware
+
 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
+    # This class raises an UniOne-flavored exception based on HTTP
+    # status codes returned by the API
     class RaiseError < Faraday::Response::Middleware
-
       private
 
       def on_complete(response)

data/lib/unione/validation.rb

@@ -1,24 +1,44 @@
 require 'json-schema'
+require 'yaml'
 
 module UniOne
   module Validation
+    module ClassMethods
+      def add_response_validations(klass, methods)
+        methods.each do |method|
+          orig = "#{method}_without_hook"
+          alias_method orig, method
 
-    private
+          define_method method do |*args|
+            send(orig, *args)
+            schema = get_response_schema(klass, method)
+            validate_response(schema)
+          end
+        end
+      end
+    end
 
-    def validate_response(schema)
-      begin
+    module InstanceMethods
+      private
+
+      def validate_response(schema)
         JSON::Validator.validate!(schema, @last_response.body)
-      rescue JSON::Schema::ValidationError => e
-        puts @last_response.body
-        raise
+        @last_response
+      end
+
+      def get_response_schema(klass, method)
+        @response_schemas ||= {}
+        @response_schemas[klass] ||= begin
+          directory = File.join(File.dirname(__FILE__), '..', '..', 'config', 'response_schema')
+          filename = "#{klass}.yml"
+          YAML.load_file(File.join(directory, filename))
+        end
+
+        @response_schemas[klass][method]
       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) }
+      def undescore_class_name(class_name)
+        class_name.gsub(/([^\^])([A-Z])/,'\1_\2').downcase
       end
     end
   end

data/lib/unione/version.rb

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

data/lib/unione-ruby.rb

@@ -1,5 +1,2 @@
 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/test/CONFIGFILE.yml

@@ -0,0 +1,71 @@
+- method: send_email
+  params:
+    message:
+      recipients:
+      - email: test@qadns.net
+        substitutions:
+          CustomerId: 12452
+          to_name: John Smith
+        metadata:
+          campaign_id: c77f4f4e-3561-49f7-9f07-c35be01b4f43
+          customer_hash: b253ac7
+      tags:
+      - string1
+      skip_unsubscribe: 0
+      global_language: en
+      template_engine: simple
+      global_substitutions:
+        property1: string
+        property2: string
+      global_metadata:
+        property1: string
+        property2: string
+      body:
+        html: "<b>Hello, {{to_name}}</b>"
+        plaintext: Hello, {{to_name}}
+        amp: <!doctype html><html amp4email><head> <meta charset="utf-8"><script async
+          src="https://cdn.ampproject.org/v0.js"></script> <style amp4email-boilerplate>body{visibility:hidden}</style></head><body>
+          Hello, AMP4EMAIL world.</body></html>
+      subject: string
+      from_email: test@qadns.net
+      from_name: John Smith
+      reply_to: test@qadns.net
+      track_links: 0
+      track_read: 0
+      bypass_global: 0
+      bypass_unavailable: 0
+      bypass_unsubscribed: 0
+      bypass_complained: 0
+      headers:
+        X-MyHeader: some data
+        List-Unsubscribe: "<mailto: unsubscribe@example.com?subject=unsubscribe>, <http://www.example.com/unsubscribe/{{CustomerId}}>"
+      attachments:
+      - type: text/plain
+        name: readme.txt
+        content: SGVsbG8sIHdvcmxkIQ==
+      inline_attachments:
+      - type: image/gif
+        name: IMAGECID1
+        content: R0lGODdhAwADAIABAP+rAP///ywAAAAAAwADAAACBIQRBwUAOw==
+      options:
+        unsubscribe_url: https://example.org/unsubscribe/{{CustomerId}}
+- method: set_webhook
+  params:
+    url: http://example.com
+    status: active
+    event_format: json_post
+    delivery_info: 1
+    single_event: 0
+    max_parallel: 10
+    events:
+      email_status:
+      - sent
+      - delivered
+      - opened
+      - hard_bounced
+      - soft_bounced
+      - spam
+      - clicked
+      - unsubscribed
+      spam_block:
+      - '*'

data/unione-ruby.gemspec

@@ -7,7 +7,7 @@ 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 'net-http-persistent', '~> 4.0'
   spec.add_dependency 'hashie', '~> 4.0'
   spec.add_dependency 'json-schema', '~> 2.0'
   spec.authors = ['UniOne developer']
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.licenses = ['MIT']
   spec.name = 'unione-ruby'
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 2.5'
   spec.summary = 'Official UniOne Gem'
   spec.version = UniOne::VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unione-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - UniOne developer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
+date: 2023-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -102,29 +102,54 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- examples/1_setup.rb
-- examples/2_mail_sending.rb
+- Rakefile
+- config/response_schema/domain.yml
+- config/response_schema/email.yml
+- config/response_schema/event_dump.yml
+- config/response_schema/project.yml
+- config/response_schema/suppression.yml
+- config/response_schema/system.yml
+- config/response_schema/tag.yml
+- config/response_schema/template.yml
+- config/response_schema/unsubscribed.yml
+- config/response_schema/webhook.yml
+- examples/api/custom_api.rb
 - examples/api/domain.rb
-- examples/api/email.rb
+- examples/api/email/attachments.rb
+- examples/api/email/multiple_recipients.rb
+- examples/api/email/send.rb
+- examples/api/email/settings.rb
+- examples/api/email/subscribe.rb
+- examples/api/email/template.rb
+- examples/api/event_dump.rb
 - examples/api/project.rb
+- examples/api/suppression.rb
+- examples/api/system.rb
+- examples/api/tag.rb
 - examples/api/template.rb
 - examples/api/unsubscribed.rb
 - examples/api/webhook.rb
+- examples/helpers.rb
+- examples/send_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/event_dump.rb
 - lib/unione/client/project.rb
+- lib/unione/client/suppression.rb
+- lib/unione/client/system.rb
+- lib/unione/client/tag.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/helpers.rb
 - lib/unione/response/raise_error.rb
 - lib/unione/validation.rb
 - lib/unione/version.rb
+- test/CONFIGFILE.yml
 - unione-ruby.gemspec
 homepage: https://github.com/unione-repo/unione-ruby
 licenses:
@@ -138,7 +163,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

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)

data/examples/api/email.rb

@@ -1,36 +0,0 @@
-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/lib/unione/helpers/mail/mail.rb

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