unigo-ruby 1.0.1

data/lib/unigo/helpers/template/template.rb

@@ -0,0 +1,32 @@
+module UniGo
+  class Template
+    attr_accessor :name, :editor_type, :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,
+          editor_type: self.editor_type,
+          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/unigo/helpers/webhook/webhook.rb

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

data/lib/unigo/helpers.rb

@@ -0,0 +1,22 @@
+require 'digest'
+
+module UniGo
+  class Client
+    module Helpers
+      # Helper function for webhooks callback. It is checking auth field
+      # and if it is invalid, raises UniGo::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/unigo/response/raise_error.rb

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

data/lib/unigo/validation.rb

@@ -0,0 +1,45 @@
+require 'json-schema'
+require 'yaml'
+
+module UniGo
+  module Validation
+    module ClassMethods
+      def add_response_validations(klass, methods)
+        methods.each do |method|
+          orig = "#{method}_without_hook"
+          alias_method orig, method
+
+          define_method method do |*args|
+            send(orig, *args)
+            schema = get_response_schema(klass, method)
+            validate_response(schema)
+          end
+        end
+      end
+    end
+
+    module InstanceMethods
+      private
+
+      def validate_response(schema)
+        JSON::Validator.validate!(schema, @last_response.body)
+        @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
+
+      def undescore_class_name(class_name)
+        class_name.gsub(/([^\^])([A-Z])/,'\1_\2').downcase
+      end
+    end
+  end
+end

data/lib/unigo/version.rb

@@ -0,0 +1,3 @@
+module UniGo
+  VERSION = '1.0.1'
+end

data/lib/unigo-ruby.rb

@@ -0,0 +1,2 @@
+require_relative 'unigo/client'
+require_relative 'unigo/version'

data/test/CONFIGFILE.yml

@@ -0,0 +1,71 @@
+- method: send_email
+  params:
+    message:
+      recipients:
+      - email: test@example.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@example.net
+      from_name: John Smith
+      reply_to: test@example.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/unigo-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 'unigo/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', '~> 4.0'
+  spec.add_dependency 'hashie', '~> 4.0'
+  spec.add_dependency 'json-schema', '~> 2.0'
+  spec.authors = ['UniGo developer']
+  spec.description = 'Official UniGo Gem to Interact with UniGo Api in native Ruby'
+  spec.email = 'devs@unisender.ru'
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.homepage = 'https://gitflic.ru/project/unisender/unigo-ruby'
+  spec.licenses = ['MIT']
+  spec.name = 'unigo-ruby'
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.5'
+  spec.summary = 'Official UniGo Gem'
+  spec.version = UniGo::VERSION
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: unigo-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- UniGo developer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-11-24 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: '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: 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 UniGo Gem to Interact with UniGo Api in native Ruby
+email: devs@unisender.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- 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/sending_mail.rb
+- examples/setup.rb
+- lib/unigo-ruby.rb
+- lib/unigo/client.rb
+- lib/unigo/client/domain.rb
+- lib/unigo/client/email.rb
+- lib/unigo/client/event_dump.rb
+- lib/unigo/client/project.rb
+- lib/unigo/client/suppression.rb
+- lib/unigo/client/system.rb
+- lib/unigo/client/tag.rb
+- lib/unigo/client/template.rb
+- lib/unigo/client/unsubscribed.rb
+- lib/unigo/client/webhook.rb
+- lib/unigo/connection.rb
+- lib/unigo/helpers.rb
+- lib/unigo/helpers/mail/mail.rb
+- lib/unigo/helpers/template/template.rb
+- lib/unigo/helpers/webhook/webhook.rb
+- lib/unigo/response/raise_error.rb
+- lib/unigo/validation.rb
+- lib/unigo/version.rb
+- test/CONFIGFILE.yml
+- unigo-ruby.gemspec
+homepage: https://gitflic.ru/project/unisender/unigo-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.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Official UniGo Gem
+test_files: []