dashamail_transactional 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92b17a0fa9a6bb122fbfd652a10260398a3483a436c3fa67a2d88a976d189d40
+  data.tar.gz: 6744d496614686e699adc0b53ce666facffce67884aebe5a209e0d8d6e6d9755
+SHA512:
+  metadata.gz: 50eacf3ad356b15416978f99c2b31954afc6f5da5668aaf6fe71251d5db95e4dcc6019767e2c03357da9a274cb13d8f5907fa967252a4cd89b3aab6be5ab07eb
+  data.tar.gz: b4cc77e44821c1c970be7b72ce3a0e87c0fddd0484d1fcc4c23c78958340a4107c82ae2f079e37853b097591bcb8fee48492c75be9d2c6526f41540134bb845b

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dashamail.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'minitest', '~> 5.0'
+
+gem 'rubocop', '~> 1.21'

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    dashamail (0.1.0)
+      mime-types (>= 3.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.6.1)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2023.0218.1)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rubocop (1.39.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  dashamail!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 creadone
+
+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,79 @@
+# DashaMail
+
+Гем для работы с транзакционным API российского сервиса https://dashamail.ru, с его методами и параметрами можно ознакомиться на [официальном ресурсе](https://dashamail.ru/transactional/).
+
+## Установка
+
+Укажите в проекте загрузку гема из гитхаба:
+
+```sh
+gem 'dashamail', git: 'https://github.com/creadone/dashamail'
+```
+Затем установите с помощью Bundler
+
+```sh
+bundle install
+```
+
+## Использование
+
+Сконфигурируйте гем в своем проекте:
+```ruby
+DashaMail.configure do |config|
+  config.api_key    = 'ваш API-ключ'
+  config.domain     = 'my-domain.ru'
+  config.from_email = 'marketing@my-domain.ru'
+  config.from_name  = 'Отдел маркетинга'
+  # config.http_debug = true
+end
+```
+
+Отправить письмо:
+```ruby
+mailer         = DashaMail::Mailer.new
+mailer.to      = 'marketing@customer.ru'
+mailer.subject = 'Какой-то заголовок'
+mailer.message = '<p>Какой-то текст</p><img src="cid:123">'
+
+mailer.add_attachment './attachment.png'
+mailer.add_inline     './inline_attachment.png', 123
+
+response = mailer.send
+
+if response.success?
+  pp response.body
+# {"msg"=>
+#   {"err_code"=>0,
+#    "text"=>"OK",
+#    "type"=>"message"},
+#  "data"=>
+#  {"transaction_id"=>"5a802b10ba82eccfd164f3c8be0fb678"}}
+
+  pp response.transaction_id #=> 5a802b10ba82eccfd164f3c8be0fb678
+end
+```
+
+Проверить статус отправки письма:
+
+```ruby
+mailer = DashaMail::Mailer.new
+response = mailer.check('5a802b10ba82eccfd164f3c8be0fb678')
+
+pp response.data
+# {"data"=>
+#   {"date"=>"2023-02-22 19:14:42",
+#    "datesent"=>"2023-02-22 19:14:42",
+#    "to"=>"marketing@customer.ru",
+#    "status"=>5,
+#    "statusname"=>"Sent",
+#    "statuschangedate"=>"2023-02-22 19:14:42"},
+#  "success"=>true}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/creadone/dashamail.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/dashamail/composer.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module DashaMail
+  class Composer
+    def initialize
+      @config = DashaMail.config
+      @container = {
+        to: nil,
+        from_name: @config.from_name,
+        from_email: @config.from_email,
+        ignore_delivery_policy: @config.ignore_delivery_policy,
+        no_track_clicks: @config.no_track_clicks,
+        no_track_opens: @config.no_track_opens
+      }
+    end
+
+    def to=(to)
+      @container[:to] = to
+    end
+
+    def cc=(cc)
+      @container[:cc] = cc
+    end
+
+    def bcc=(bcc)
+      @container[:bcc] = bcc
+    end
+
+    def from_email=(from_email)
+      @container[:from_email] = from_email
+    end
+
+    def from_name=(from_name)
+      @container[:from_name] = from_name
+    end
+
+    def subject=(subject)
+      @container[:subject] = subject
+    end
+
+    def message=(message)
+      @container[:message] = message
+    end
+
+    def plain_text=(plain_text)
+      @container[:plain_text] = plain_text
+    end
+
+    def message_id=(message_id)
+      @container[:message_id] = message_id
+    end
+
+    def delivery_time=(delivery_time)
+      @container[:delivery_time] = delivery_time
+    end
+
+    def replace=(replace)
+      @container[:replace] = replace
+    end
+
+    def domain=(domain)
+      @container[:domain] = domain
+    end
+
+    def headers=(headers)
+      @container[:headers] = headers
+    end
+
+    def template_data=(template_data)
+      @container[:template_data] = template_data
+    end
+
+    def add_attachment(file_path)
+      @container[:attachments] = [] unless @container.key?(:attachments)
+      @container[:attachments].push Utils.build_attachment(file_path)
+    end
+
+    def add_inline(file_path, cid)
+      @container[:inline] = [] unless @container.key?(:inline)
+      @container[:inline].push Utils.build_inline(file_path, cid)
+    end
+
+    def no_track_opens=(no_track_opens)
+      @container[:no_track_opens] = no_track_opens
+    end
+
+    def no_track_clicks=(no_track_clicks)
+      @container[:no_track_clicks] = no_track_clicks
+    end
+
+    def ignore_delivery_policy=(ignore_delivery_policy)
+      @container[:ignore_delivery_policy] = ignore_delivery_policy
+    end
+
+    def call
+      @container
+    end
+  end
+end

data/lib/dashamail/configuration.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module DashaMail
+  module Configuration
+    def self.api_key
+      @api_key
+    end
+
+    def self.api_key=(api_key)
+      @api_key = api_key
+    end
+
+    def self.domain
+      @domain
+    end
+
+    def self.domain=(domain)
+      @domain = domain
+    end
+
+    def self.from_email
+      @from_email
+    end
+
+    def self.from_email=(from_email)
+      @from_email = from_email
+    end
+
+    def self.from_name
+      @from_name
+    end
+
+    def self.from_name=(from_name)
+      @from_name = from_name
+    end
+
+    def self.no_track_opens
+      @no_track_opens
+    end
+
+    def self.no_track_opens=(no_track_opens)
+      @no_track_opens = no_track_opens
+    end
+
+    def self.no_track_clicks
+      @no_track_clicks
+    end
+
+    def self.no_track_clicks=(no_track_clicks)
+      @no_track_clicks = no_track_clicks
+    end
+
+    def self.ignore_delivery_policy
+      @ignore_delivery_policy
+    end
+
+    def self.ignore_delivery_policy=(ignore_delivery_policy)
+      @ignore_delivery_policy = ignore_delivery_policy
+    end
+
+    def self.end_point
+      @end_point
+    end
+
+    def self.end_point=(end_point)
+      @end_point = end_point
+    end
+
+    def self.response_format
+      @response_format
+    end
+
+    def self.response_format=(response_format)
+      @response_format = response_format
+    end
+
+    def self.logger
+      @logger
+    end
+
+    def self.logger=(logger)
+      @logger = logger
+    end
+
+    def self.http_debug
+      @http_debug
+    end
+
+    def self.http_debug=(http_debug)
+      @http_debug = http_debug
+    end
+
+    DEFAULT = {
+      end_point: 'https://api.dashamail.ru',
+      no_track_opens: true,
+      no_track_clicks: true,
+      response_format: 'JSON',
+      ignore_delivery_policy: false
+    }.freeze
+
+    DEFAULT.each do |param, default_value|
+      send("#{param}=", default_value)
+    end
+  end
+end

data/lib/dashamail/http.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'json'
+require 'net/http'
+
+module DashaMail
+  class HTTP
+    VERBS = {
+      get: Net::HTTP::Get,
+      post: Net::HTTP::Post
+    }.freeze
+
+    def initialize(options = {})
+      @config = DashaMail.config
+      @credentials = {
+        end_point: @config.end_point,
+        api_key: @config.api_key
+      }.merge!(options)
+    end
+
+    def base_headers(options = {})
+      @headers = {
+        'User-Agent' => "DashaMail(Ruby)/#{DashaMail::VERSION}",
+        'Content-Type' => 'application/json'
+      }.merge!(options)
+    end
+
+    def get(path, options = {})
+      execute(path, :get, options)
+    end
+
+    def post(path, options = {})
+      execute(path, :post, options)
+    end
+
+    private
+
+    def execute(path, method, options = {})
+      uri_params = add_param(@credentials[:end_point], 'method', path)
+      uri = URI(uri_params)
+
+      req = VERBS[method].new(uri)
+
+      options.merge!(api_key: @credentials[:api_key])
+      options.transform_keys!(&:to_s)
+
+      headers = base_headers
+      headers.each { |k, v| req[k] = v }
+      req.body = (options || {}).to_json
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = (uri.scheme == 'https')
+      http.set_debug_output($stdout) if @config.http_debug
+
+      http.request(req)
+    end
+
+    def add_param(url, param_name, param_value)
+      uri = URI(url)
+      params = URI.decode_www_form(uri.query || '') << [param_name, param_value]
+      uri.query = URI.encode_www_form(params)
+      uri.to_s
+    end
+  end
+end

data/lib/dashamail/mailer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DashaMail
+  class Mailer
+    def initialize
+      @composer = Composer.new
+    end
+
+    def send
+      message = @composer.call
+      Request.new.send(message)
+    end
+
+    def check(transaction_id)
+      Request.new.check(transaction_id)
+    end
+
+    def method_missing(method, *args)
+      @composer.send(method, *args)
+    end
+  end
+end

data/lib/dashamail/request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DashaMail
+  class Request
+    def initialize
+      @http = DashaMail::HTTP.new
+    end
+
+    def send(message)
+      answer = @http.post('transactional.send', message)
+      Response.new(answer)
+    end
+
+    def check(transaction_id)
+      answer = @http.get('transactional.check', { transaction_id: transaction_id })
+      Response.new(answer)
+    end
+  end
+end

data/lib/dashamail/response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module DashaMail
+  class Response
+    def initialize(answer)
+      @answer = answer
+      @body   = JSON.parse(@answer.body)['response']
+    end
+
+    def success?
+      @body.dig('msg', 'err_code').to_i.zero?
+    end
+
+    def http_code
+      @answer.code
+    end
+
+    def text
+      @body.dig('msg', 'text')
+    end
+
+    def transaction_id
+      @body.dig('data', 'transaction_id')
+    end
+
+    def data
+      @body['data']
+    end
+
+    attr_reader :body
+
+    def raw
+      @answer
+    end
+  end
+end

data/lib/dashamail/utils.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'mime-types'
+
+module DashaMail
+  class Utils
+    def self.build_attachment(file_path)
+      raise StandardError, 'File not exist' unless File.exist?(file_path)
+
+      file_name = File.basename(file_path)
+      file_body = File.open(file_path, 'rb') do |io|
+        Base64.strict_encode64(io.read)
+      end
+      { name: file_name, filebody: file_body }
+    end
+
+    def self.build_inline(file_path, cid)
+      raise StandardError, 'File not exist' unless File.exist?(file_path)
+
+      file_name = File.basename(file_path)
+      mime_type = MIME::Types.type_for(file_path)[0].to_s
+      file_body = File.open(file_path, 'rb') do |io|
+        Base64.strict_encode64(io.read)
+      end
+      {
+        mime_type: mime_type,
+        filename: file_name,
+        body: file_body,
+        cid: cid
+      }
+    end
+  end
+end

data/lib/dashamail/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DashaMail
+  VERSION = '0.1.0'
+end

data/lib/dashamail.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'dashamail/version'
+require 'dashamail/configuration'
+require 'dashamail/utils'
+require 'dashamail/http'
+require 'dashamail/composer'
+require 'dashamail/mailer'
+require 'dashamail/response'
+require 'dashamail/request'
+
+module DashaMail
+  def self.configure
+    yield DashaMail::Configuration
+  end
+
+  def self.config
+    DashaMail::Configuration
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: dashamail_transactional
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Fedorov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description: Ruby client DashaMail for transactional API
+email:
+- creadone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/dashamail.rb
+- lib/dashamail/composer.rb
+- lib/dashamail/configuration.rb
+- lib/dashamail/http.rb
+- lib/dashamail/mailer.rb
+- lib/dashamail/request.rb
+- lib/dashamail/response.rb
+- lib/dashamail/utils.rb
+- lib/dashamail/version.rb
+homepage:
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/creadone/dashamail
+  source_code_uri: https://github.com/creadone/dashamail
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: Ruby client DashaMail for transactional API
+test_files: []