silent_bob 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f354e5012fca522e0cd4020aec9d2dd0a5bddb32543d25456f855d80e22795b2
+  data.tar.gz: 262b628c2a3e53b24e5cb9173db28757c150ac42faeb199e00420df1fa87ad41
+SHA512:
+  metadata.gz: 60242b3925ede51a4e951d7e62b3710edeb19c2cc2a5c8f3466eca2b5b7e7d5c6b470ed8a29b47fcc431287bcdbfb668388b92a117a8e5b3ea384789f7886ed7
+  data.tar.gz: 635cc7f574329818d06277d80e737e9954b8699beceac82287afa13b914bc8be001a95e45a86989b6005df1d5cf30b17f14e0a5ad9db84b510a0d138939f01f4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.gitlab-ci.yml

@@ -0,0 +1,15 @@
+stages:
+  - deploy
+
+publish_gem:
+  stage: deploy
+  image: ruby:2.6.4
+  script:
+    - 'mkdir ~/.gem'
+    - 'echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials'
+    - 'chmod 0600 ~/.gem/credentials'
+    - 'gem build silent_bob'
+    - 'gem push "silent_bob-$(git describe --tags).gem"'
+  allow_failure: true
+  only:
+    - tags

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,82 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - 'bin/**/*'     # Auto-generated
+
+Metrics/ParameterLists:
+  Max: 7
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 15
+
+Layout/LineLength:
+  Max: 100
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/AutoResourceCleanup:
+  Enabled: true
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/OptionHash:
+  Enabled: true
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Bundler/OrderedGems:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 8
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 3
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10
+
+Rails/FilePath:
+  EnforcedStyle: arguments
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in silent_bob.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    silent_bob (0.1.7)
+      http (~> 4.3)
+      mail (~> 2.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    factory_bot (5.2.0)
+      activesupport (>= 4.2.0)
+    ffi (1.13.1-x64-mingw32)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.2)
+      ffi-compiler
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.0.2)
+    minitest (5.14.2)
+    public_suffix (4.0.6)
+    rake (10.5.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7-x64-mingw32)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  factory_bot (~> 5.1)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  silent_bob!
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,59 @@
+# SilentBob
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/silent_bob`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'silent_bob'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install silent_bob
+
+## Usage
+
+1: Initialize default config
+```ruby
+config = SilentBob::Configuration.new(url: 'http://127.0.0.1:4000', user_name: 'test',
+                                      password: 'cheburek')
+SilentBob::ConfigurationKeeper.default_config = config
+```
+2: Send email or sms (needed params listed at `initialize` method)
+```ruby
+SilentBob::SmsSender.new(to: '78881214455', body: 'sms-text').call
+```
+
+## You can always use a custom config when needed.
+
+```ruby
+# in this case sms won't be sent instead message will be sent to Slack
+config = SilentBob::Configuration.new(url: 'http://127.0.0.1:4000', user_name: 'test',
+                                      password: 'cheburek', slack_replacement: true)
+SilentBob::SmsSender.new(to: '78881214455', body: 'sms-text', configuration: config).call
+```
+
+## ActionMailer delivery
+
+To connect `SilentBob` to `ActionMailer`
+
+```ruby
+ActionMailer::Base.add_delivery_method :revo_jay, SilentBob::Delivery
+```
+
+In this case `SilentBob::ConfigurationKeeper.default_config` **must be initialized**
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "silent_bob"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/silent_bob.rb

@@ -0,0 +1,22 @@
+require 'silent_bob/version'
+require 'openssl'
+require 'http'
+require 'singleton'
+require 'base64'
+require 'silent_bob/configuration'
+require 'silent_bob/configuration_keeper'
+require 'silent_bob/delivery'
+require 'silent_bob/client'
+require 'silent_bob/email_sender'
+require 'silent_bob/sms_sender'
+require 'silent_bob/health_check'
+
+module SilentBob
+  class Error < StandardError; end
+
+  class ConfigurationNotFound < StandardError; end
+
+  class WrongPhoneNumber < StandardError; end
+
+  Result = Struct.new(:success?, :response, keyword_init: true)
+end

data/lib/silent_bob/client.rb

@@ -0,0 +1,30 @@
+module SilentBob
+  class Client
+    attr_reader :configuration, :params
+
+    # Takes configuration and message params(hash)
+    # * <tt>configuration:</tt> `SilentBob::Configuration` object
+    # * <tt>params:</tt> Params represented by `Hash` that would be passed as json params
+    def initialize(configuration:, params:)
+      @configuration = configuration.to_h
+      @params = params
+    end
+
+    def call
+      response = make_request
+
+      Result.new(success?: response.status.success?, response: response.body.to_s)
+    end
+
+    private
+
+    def make_request
+      HTTP.basic_auth(configuration[:basic_auth])
+          .post(messages_url, json: params, ssl_context: configuration[:ssl_context])
+    end
+
+    def messages_url
+      "#{configuration[:url]}/messages"
+    end
+  end
+end

data/lib/silent_bob/configuration.rb

@@ -0,0 +1,37 @@
+module SilentBob
+  class Configuration
+    CONFIG_OPTIONS = %i[url user_name password slack_replacement ssl_context].freeze
+
+    attr_accessor(*CONFIG_OPTIONS)
+
+    # Takes configuration params to work with SilentBob app
+    # * <tt>url:</tt> Base SilentBob url
+    # * <tt>user_name:</tt> User name for basic auth
+    # * <tt>password:</tt> Password for basic auth
+    # * <tt>slack_replacement:</tt> Flag that tells SmsSender to send message by slack or sms
+    # * <tt>ssl_context:</tt> `OpenSSL::SSL::SSLContext` object
+    def initialize(url:, user_name:, password:, slack_replacement: false, ssl_context: nil)
+      @url = url
+      @user_name = user_name
+      @password = password
+      @slack_replacement = slack_replacement
+      @ssl_context = ssl_context || ssl_no_context
+    end
+
+    def to_h
+      {
+        url: url, slack: slack_replacement,
+        basic_auth: { user: user_name, pass: password },
+        ssl_context: ssl_context
+      }
+    end
+
+    private
+
+    def ssl_no_context
+      ctx = OpenSSL::SSL::SSLContext.new
+      ctx.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      ctx
+    end
+  end
+end

data/lib/silent_bob/configuration_keeper.rb

@@ -0,0 +1,13 @@
+module SilentBob
+  class ConfigurationKeeper
+    class << self
+      def default_config=(configuration)
+        @@default_config = configuration
+      end
+
+      def default_config
+        @@default_config
+      end
+    end
+  end
+end

data/lib/silent_bob/delivery.rb

@@ -0,0 +1,43 @@
+module SilentBob
+  class Delivery
+    def initialize(_) end
+
+    def deliver!(mail)
+      raise ConfigurationNotFound unless ConfigurationKeeper.default_config
+
+      @mail = mail
+      Mail::CheckDeliveryParams.check(mail)
+
+      EmailSender.new(email_params).call
+    end
+
+    private
+
+    attr_reader :mail
+
+    def email_params
+      {
+        to: mail.to.first,
+        subject: mail.subject,
+        from: mail.from.first,
+        body: decoded_mail_body,
+        attachments: convert_attachments,
+        configuration: ConfigurationKeeper.default_config
+      }
+    end
+
+    def decoded_mail_body
+      return mail.html_part.decoded if mail.multipart?
+
+      (mail.mime_type =~ %r{^text/html$}i) && mail.body.decoded
+    rescue StandardError
+      nil
+    end
+
+    def convert_attachments
+      mail.attachments&.map do |attachment|
+        { name: attachment.filename, body: attachment.body }
+      end
+    end
+  end
+end

data/lib/silent_bob/email_sender.rb

@@ -0,0 +1,51 @@
+module SilentBob
+  class EmailSender
+    MESSAGE_TYPE = 'email'.freeze
+
+    attr_reader :configuration, :subject, :to, :body, :attachments, :from
+
+    # Pass initialization params
+    # * <tt>configuration:</tt> `SilentBob::Configuration` object
+    # * <tt>to:</tt> Recipients email address
+    # * <tt>body:</tt> Email body in html format
+    # * <tt>subject:</tt> Email subject
+    # * <tt>attachments:</tt> Email attachments
+    # * <tt>from:</tt> Author's email address
+    def initialize(subject:, to:, body:, attachments: [], from: nil,
+                   configuration: ConfigurationKeeper.default_config)
+      @configuration = configuration
+      @subject = subject
+      @to = to
+      @body = body
+      @attachments = attachments
+      @from = from
+    end
+
+    def call
+      raise ConfigurationNotFound unless configuration
+
+      Client.new(configuration: configuration, params: email_params).call
+    end
+
+    private
+
+    def email_params
+      {
+        message_type: MESSAGE_TYPE,
+        message: {
+          subject: subject,
+          to: to,
+          body: body,
+          attachments: handle_attachments(attachments),
+          from: from
+        }.compact
+      }
+    end
+
+    def handle_attachments(attachments)
+      attachments&.map do |attachment|
+        { name: attachment[:name], body: Base64.encode64(attachment[:body]) }
+      end
+    end
+  end
+end

data/lib/silent_bob/health_check.rb

@@ -0,0 +1,29 @@
+module SilentBob
+  class HealthCheck
+    attr_reader :configuration
+
+    # Takes configuration
+    # * <tt>configuration:</tt> `SilentBob::Configuration` object
+    def initialize(configuration: ConfigurationKeeper.default_config)
+      @configuration = configuration
+    end
+
+    def call
+      raise ConfigurationNotFound unless configuration
+
+      config = configuration.to_h
+
+      response = HTTP
+                 .basic_auth(config[:basic_auth])
+                 .get(health_check_url(config), ssl_context: config[:ssl_context])
+
+      Result.new(success?: response.status.success?, response: response.body.to_s)
+    end
+
+    private
+
+    def health_check_url(config)
+      "#{config[:url]}/health_check"
+    end
+  end
+end

data/lib/silent_bob/sms_sender.rb

@@ -0,0 +1,47 @@
+module SilentBob
+  class SmsSender
+    SMS_MESSAGE_TYPE = 'sms'.freeze
+    SLACK_MESSAGE_TYPE = 'slack'.freeze
+
+    attr_reader :configuration, :to, :body
+
+    # Pass initialization params
+    # * <tt>configuration:</tt> `SilentBob::Configuration` object
+    # * <tt>to:</tt> Mobile phone number (11 digits)
+    # * <tt>body:</tt> Sms message text
+    # === Examples
+    #    SilentBob::SmsSender.new(configuration: config, to: '79991231212', body: 'text')
+    def initialize(to:, body:, configuration: ConfigurationKeeper.default_config)
+      @configuration = configuration
+      @to = to
+      @body = body
+    end
+
+    def call
+      raise ConfigurationNotFound unless configuration
+      raise WrongPhoneNumber if wrong_phone?
+
+      Client.new(configuration: configuration, params: sms_params).call
+    end
+
+    private
+
+    def sms_params
+      {
+        message_type: message_type,
+        message: {
+          to: to,
+          body: body
+        }
+      }
+    end
+
+    def message_type
+      configuration.to_h[:slack] ? SLACK_MESSAGE_TYPE : SMS_MESSAGE_TYPE
+    end
+
+    def wrong_phone?
+      to.length != 11
+    end
+  end
+end

data/lib/silent_bob/version.rb

@@ -0,0 +1,3 @@
+module SilentBob
+  VERSION = '0.1.7'.freeze
+end

data/silent_bob.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'silent_bob/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'silent_bob'
+  spec.version       = SilentBob::VERSION
+  spec.authors       = ['Andrey Lobanov']
+  spec.email         = ['soundtechproject@gmail.com']
+
+  spec.summary       = 'Gem that provides ability to send messages through SilentBob service'
+  spec.description   = ''
+  spec.homepage      = 'https://mokka.ru'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'http', '~> 4.3'
+  spec.add_runtime_dependency 'mail', '~> 2.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'factory_bot', '~> 5.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: silent_bob
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Andrey Lobanov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email:
+- soundtechproject@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/silent_bob.rb
+- lib/silent_bob/client.rb
+- lib/silent_bob/configuration.rb
+- lib/silent_bob/configuration_keeper.rb
+- lib/silent_bob/delivery.rb
+- lib/silent_bob/email_sender.rb
+- lib/silent_bob/health_check.rb
+- lib/silent_bob/sms_sender.rb
+- lib/silent_bob/version.rb
+- silent_bob.gemspec
+homepage: https://mokka.ru
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Gem that provides ability to send messages through SilentBob service
+test_files: []