unigo-sender-simple 0.0.13

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: add8396e00e8814105cc33b799d844af62761459753fe8e530aa5fb9a49564f7
+  data.tar.gz: 2ce5d2ac34cf856dae85e3fedea0e8505d8e5a2f38d05e34bc7b12c68f8155bc
+SHA512:
+  metadata.gz: 2aca13358f40cefc43fa0bf637d584b46dc15373817ddc7d61aff096e725a059bc24b65ca7e87046350262617c9be53fa1cf77670f45ec76a693cc89e7281793
+  data.tar.gz: 137ad9994a9ce8b2b96b7bc1b6bf5e2dbe66f0a6effe216b91ec9a8eed81853e453b81acc9e915509c9ece249801fe605184ce74243c1172d076505680150810

data/.gitignore

@@ -0,0 +1,51 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+#Ignore SimpleCov
+/coverage/*
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore uploaded files in development
+/storage/*
+!/storage/.keep
+
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+
+
+/.idea/*
+/public/uploads/*
+
+start.sh
+/.vscode/launch.json
+/client/.eslintcache
+.vscode/launch.json
+config/secrets.yml
+rspec_results.html

data/.rubocop.yml

@@ -0,0 +1,12 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 3.1
+  Exclude:
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in unigo-sender-simple.gemspec
+gemspec
+gem "dotenv", "~> 2.8"
+gem "nokogiri", "~> 1.13"
+gem "pry"
+gem "rake", "~> 13.0"
+
+gem "vcr", "~> 6.0"
+
+gem "rubocop", "~> 1.54.1"
+gem "rubocop-shopify"
+gem "rubocop-performance", "~> 1.18"
+gem "rubocop-rake", "~> 0.6.0"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 UniGo
+
+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,59 @@
+Based on official UniGo Gem https://gitflic.ru/project/unisender/unigo-ruby but using gem faraday", "~> 2.0" to prevent conflicts 
+
+For the moment only send_email is supported from the base library
+
+```ruby
+  gem 'unigo-sender-simple'
+```
+```ruby
+  bundle install
+```
+configuration example
+```ruby
+    Unigo::Sender.configure do |config|
+      config.host = "go1.unisender.ru"
+      config.api_key = Rails.application.secrets.api_key
+    end
+
+```
+ 
+usage
+```ruby
+ message = {}
+
+      message[:subject] = @subject
+      message[:body] = { "html": "<h3>#{@title}</h3><div><p>#{@main_text}<br></p></div><div><p>#{@footer}</p></div>", "plaintext": @main_text } unless @template
+
+      message[:from_email] = "from@test.ru"
+      message[:from_name] = @from_name 
+
+      if @bypass
+        message[:bypass_unsubscribed] = 1
+        message[:bypass_global] = 1
+        message[:bypass_unavailable] = 1
+        message[:skip_unsubscribe] = 1
+      end
+      message[:recipients] = []
+
+      message[:template_engine] = "simple"
+      message[:template_id] = @template if @template
+
+      message[:recipients] << {
+        email: "test@test.com",
+        substitutions: {
+          "title" => @title || "",
+          "main_text" => @main_text || "",
+          "link" => @link || "",
+          "link_name" => @link_name || "",
+          "secondary_text" => @secondary_text || "",
+          "footer" => @footer || "",
+        },
+      }
+
+      begin
+        client = Unigo::Sender::Client.new
+        client.send_email(message: message)
+      rescue Faraday::Error => err
+        raise err.response[:body] # raise Exception, { message: "Send error to #{@email} with subject #{@subject}" }
+      end
+```

data/lib/unigo/sender/client/email.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Unigo
+  module Sender
+    class Client
+      module Email
+        extend Unigo::Sender::Validation::ClassMethods
+        include Unigo::Sender::Validation::InstanceMethods
+        def send_email(params = {})
+          params[:message][:options][:send_at] =
+            handle_time_param(params.dig(:message, :options, :send_at)) if params.dig(
+              :message, :options, :send_at
+            )
+          post("email/send.json", params)
+        end
+
+        add_response_validations(
+          :email,
+          [
+            "send_email",
+          ],
+        )
+      end
+    end
+  end
+end

data/lib/unigo/sender/client.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Unigo
+  module Sender
+    class Client
+      include Unigo::Sender::Connection
+      include Unigo::Sender::Client::Email
+
+      class BaseException < StandardError; end
+      class InvalidCallbackAuth < BaseException; end
+
+      class << self
+        def run(*args, &block)
+          new(*args).run(&block)
+        end
+      end
+
+      API_ENDPOINT =
+        "https://%{hostname}/%{lang}/transactional/api/v1/"
+
+      # * *Args* :
+      #   - +host+          -> string, API hostname, for example 'go1.unisender.ru'
+      #   - +api_key_in_params+ -> boolean, pass API key in parameters, otherwise pass in headers (default)
+      def initialize(params = {})
+        @hostname = params[:host] || Unigo::Sender.configuration.host
+      end
+
+      def run
+        yield self
+      end
+
+      private
+
+      def api_endpoint
+        @api_endpoint ||=
+          format(API_ENDPOINT, hostname: @hostname, lang: Unigo::Sender.configuration.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
+end

data/lib/unigo/sender/config/response_schema/email.yml

@@ -0,0 +1,23 @@
+send_email:
+  type: object
+  required:
+    - status
+    - job_id
+    - emails
+  properties:
+    status:
+      type: string
+    job_id:
+      type: string
+    emails:
+      items:
+        type: string
+    failed_emails:
+      type: object
+subscribe_email:
+  type: object
+  required:
+    - status
+  properties:
+    status:
+      type: string

data/lib/unigo/sender/configuration.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Unigo
+  module Sender
+    class Configuration
+      attr_accessor :adapter,
+        :connection_open_timeout,
+        :connection_timeout,
+        :enable_logging,
+        :lang,
+        :api_key,
+        :host,
+        :api_key_in_params
+
+      def initialize
+        @adapter = Faraday.default_adapter
+        @connection_open_timeout = 20
+        @connection_timeout = 20
+        @enable_logging = false
+        @lang = "ru"
+        @host = "go1.unisender.ru"
+        @api_key_in_params = false
+      end
+    end
+  end
+end

data/lib/unigo/sender/connection.rb

@@ -0,0 +1,57 @@
+require "json"
+require "faraday"
+require "faraday/mashify"
+module Unigo
+  module Sender
+    module Connection
+      def get(url, params = {})
+        prepare_params!(params)
+
+        # Assume HTTP library receives params as Hash
+        request(:get, url, params)
+      end
+
+      def post(url, params = {})
+        prepare_params!(params)
+
+        # Assume HTTP library receives payload body as String
+        request(:post, url, JSON.dump(params))
+      end
+
+      private
+
+      def request(method, path, data)
+        @last_response = connection.send(method, path, data)
+      end
+
+      def connection
+        headers = { "Content-Type" => "application/json" }
+        prepare_headers!(headers)
+
+        @connection ||= Faraday.new(
+          url: api_endpoint,
+          headers: headers,
+        ) do |conn|
+          conn.response(:mashify, content_type: /\bjson$/)
+          conn.response(:json, content_type: /\bjson$/)
+          conn.response(:raise_error)
+          conn.adapter(Unigo::Sender.configuration.adapter)
+          conn.options.timeout = Unigo::Sender.configuration.connection_timeout
+          conn.options.open_timeout = Unigo::Sender.configuration.connection_open_timeout
+
+          if Unigo::Sender.configuration.enable_logging
+            conn.response(:logger, nil, { headers: true, bodies: true, errors: true })
+          end
+        end
+      end
+
+      def prepare_params!(params)
+        params.merge!({ api_key: Unigo::Sender.configuration.api_key }) if Unigo::Sender.configuration.api_key_in_params
+      end
+
+      def prepare_headers!(headers)
+        headers.merge!("X-API-KEY" => Unigo::Sender.configuration.api_key) unless Unigo::Sender.configuration.api_key_in_params
+      end
+    end
+  end
+end

data/lib/unigo/sender/mail.rb

@@ -0,0 +1,44 @@
+module Unigo
+  module Sender
+  class Mail
+    attr_accessor :template, :body, :track, :from, :subject, :global_metadata, :headers, :options,
+                  :global_substitutions, :recipients, :attachments, :inline_attachments,
+                  :reply_to, :skip_unsubscribe, :force_send
+
+    def initialize
+      @template = {}
+      @from = {}
+      @track = {}
+      @global_substitutions = {}
+      @recipients = []
+      @attachments = []
+      @inline_attachments = []
+    end
+
+    # backward compatibility
+    alias_method :"metadata=", :"global_metadata="
+
+    def as_json
+      {
+        message: {
+          global_substitutions: self.global_substitutions,
+          body: self.body,
+          subject: self.subject,
+          reply_to: self.reply_to,
+          recipients: self.recipients,
+          global_metadata: self.global_metadata,
+          headers: self.headers,
+          attachments: self.attachments,
+          inline_attachments: self.inline_attachments,
+          options: self.options,
+          skip_unsubscribe: self.skip_unsubscribe,
+          force_send: self.force_send
+        }.merge(self.template)
+         .merge(self.from)
+         .merge(self.track)
+         .delete_if { |_, value| value.to_s.strip == '' || value == [] || value == {}}
+      }
+    end
+    end
+  end
+end

data/lib/unigo/sender/validation.rb

@@ -0,0 +1,47 @@
+require 'json-schema'
+require 'yaml'
+
+module Unigo
+  module Sender
+  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
+end

data/lib/unigo/sender/version.rb

@@ -0,0 +1,5 @@
+module Unigo
+  module Sender
+    VERSION = "0.0.13"
+  end
+end

data/lib/unigo/sender.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "json"
+require "json-schema"
+require "faraday"
+require "zeitwerk"
+
+module Unigo
+  module Sender
+    class << self
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= Unigo::Sender::Configuration.new
+      end
+
+      def configure
+        yield(configuration)
+      end
+    end
+  end
+end
+
+loader = Zeitwerk::Loader.new
+loader.inflector = Zeitwerk::GemInflector.new(__FILE__)
+loader.push_dir("#{__dir__}/sender", namespace: Unigo::Sender)
+loader.setup

data/unigo-sender-simple.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+require_relative "lib/unigo/sender/version"
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.authors = ["Alexander Tarasov"]
+  spec.description = "Based on official UniGo Gem https://gitflic.ru/project/unisender/unigo-ruby"
+  spec.metadata = { "github_repo" => "ssh://github.com/tarassov/unigo-sender-simple" }
+  spec.homepage = "https://github.com/tarassov/unigo-sender-simple"
+  spec.email = "tarassov.al@gmail.com"
+  spec.files = %x(git ls-files -z).split("\x0")
+  spec.licenses = ["MIT"]
+  spec.name = "unigo-sender-simple"
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.7"
+  spec.summary = "Simple UniGo sender Gem"
+  spec.version = Unigo::Sender::VERSION
+
+  spec.add_dependency("faraday", "~> 2.0")
+  spec.add_dependency("faraday-mashify", "~> 0.1")
+  spec.add_dependency("json", "~> 2.0")
+  spec.add_dependency("json-schema", "~> 2.0")
+  spec.add_dependency("zeitwerk", "~> 2.6")
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: unigo-sender-simple
+version: !ruby/object:Gem::Version
+  version: 0.0.13
+platform: ruby
+authors:
+- Alexander Tarasov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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-mashify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Based on official UniGo Gem https://gitflic.ru/project/unisender/unigo-ruby
+email: tarassov.al@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- lib/unigo/sender.rb
+- lib/unigo/sender/client.rb
+- lib/unigo/sender/client/email.rb
+- lib/unigo/sender/config/response_schema/email.yml
+- lib/unigo/sender/configuration.rb
+- lib/unigo/sender/connection.rb
+- lib/unigo/sender/mail.rb
+- lib/unigo/sender/validation.rb
+- lib/unigo/sender/version.rb
+- unigo-sender-simple.gemspec
+homepage: https://github.com/tarassov/unigo-sender-simple
+licenses:
+- MIT
+metadata:
+  github_repo: ssh://github.com/tarassov/unigo-sender-simple
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key: 
+specification_version: 4
+summary: Simple UniGo sender Gem
+test_files: []