pechkin 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6a85ac81ee32154705d92319c32e7706eb4af5d7a741bebcc4fee1ce64004b3
-  data.tar.gz: 4f36119f5bca18893aed4cdfa69ee4e1426291f2ac585b8b970d12ee604a62b4
+  metadata.gz: 3447abc49727b844f0c86895242a10aa1c3cee00e1fbdff5deb915ba790ebe98
+  data.tar.gz: 3352b4e61c0a9885d8e0b14b497e41947952b996bd522e238ac519100965ff2d
 SHA512:
-  metadata.gz: 85742668000030821d0bc05ac5531144d2a34ff890c788ff568c309e4dc9020b808a64ffdb9f84b3346247af8de14bad70f3a6a915d1df3cc5aaf6e682f5628d
-  data.tar.gz: e5a3ab2a6fb85241223d589aed03603bf2e1295825200cfc2f4eb8adac89eb9780d40f578e84ab1657ff45e521738c83f15ca9ef7df867964a2e30cac547cc77
+  metadata.gz: 81fbdfd449664ed2715035649db5f3c9f31740ca9ade3295d5eab19415e6cc3ea9eae0652e99810c0ff3317b8815032a10e4e257246802efee3d31e247d4dbe9
+  data.tar.gz: 84ce0aa1dfb906e2bae2221e85fe77bdc48ec160ad6bf494c6ba1fcf64bb6a7c274a479a22825954cf66dad8470546cec9283a120434f85be0b7a17182eb4a22

data/lib/pechkin.rb

@@ -3,10 +3,12 @@ require 'rack'
 require 'logger'
 require 'prometheus/middleware/collector'
 require 'prometheus/middleware/exporter'
+require 'powerpack/string'
 require 'htauth'
 require 'base64'
 
 require_relative 'pechkin/cli'
+require_relative 'pechkin/command'
 require_relative 'pechkin/exceptions'
 require_relative 'pechkin/handler'
 require_relative 'pechkin/message_template'
@@ -24,76 +26,12 @@ module Pechkin # :nodoc:
   class << self
     def run
       options = CLI.parse(ARGV)
-      Main.new(options).run
+      cmd = Command::Dispatcher.new(options).dispatch
+      cmd.execute
     rescue StandardError => e
       warn 'Error: ' + e.message
       warn "\t" + e.backtrace.reverse.join("\n\t") if options.debug?
       exit 2
     end
   end
-
-  class Main # :nodoc:
-    attr_reader :options, :configuration, :handler
-
-    def initialize(options)
-      @options = options
-    end
-
-    def run
-      if options.add_auth
-        add_auth
-        exit 0
-      end
-
-      @configuration = Configuration.load_from_directory(options.config_file)
-      @handler = Handler.new(@configuration.channels)
-      configuration.list if options.list?
-      return if options.check?
-
-      if options.send_data
-        send_data
-      else
-        run_server
-      end
-    end
-
-    def run_server
-      Rack::Server.start(app: AppBuilder.new.build(handler, options),
-                         Port: options.port,
-                         pid: options.pid_file,
-                         Host: options.bind_address)
-    end
-
-    def send_data
-      ch, msg = parse_endpoint(options.send_data)
-
-      raise "#{ch}/#{msg} not found" unless handler.message?(ch, msg)
-
-      data = read_data(options.data)
-
-      handler.preview = options.preview
-      handler.handle(ch, msg, JSON.parse(data))
-    end
-
-    def read_data(data)
-      return data unless data.start_with?('@')
-
-      file = data[1..-1]
-      raise "File not found #{file}" unless File.exist?(file)
-
-      IO.read(file)
-    end
-
-    def parse_endpoint(endpoint)
-      endpoint.match(%r{^([^/]+)/(.+)}) do |m|
-        [m[1], m[2]]
-      end
-    end
-
-    def add_auth
-      user, password = options.add_auth.split(':')
-      Pechkin::Auth::Manager.new(options.htpasswd).add(user, password)
-      puts IO.read(options.htpasswd)
-    end
-  end
 end

data/lib/pechkin/auth.rb

@@ -1,5 +1,7 @@
 module Pechkin
   module Auth
+    class AuthError < StandardError; end
+
     # Utility class for altering htpasswd files
     class Manager
       attr_reader :htpasswd
@@ -25,32 +27,41 @@ module Pechkin
       end
 
       def call(env)
-        if authorized?(env)
-          @app.call(env)
-        else
-          body = { status: 'error', reason: 'unathorized' }.to_json
-          ['401', { 'Content-Type' => 'application/json' }, [body]]
-        end
+        authorize(env)
+        @app.call(env)
+      rescue AuthError => e
+        body = { status: 'error', reason: e.message }.to_json
+        ['401', { 'Content-Type' => 'application/json' }, [body]]
       rescue StandardError => e
-        puts e.backtrace.reverse.join('\n\t')
         body = { status: 'error', reason: e.message }.to_json
         ['503', { 'Content-Type' => 'application/json' }, [body]]
       end
 
       private
 
-      def authorized?(env)
-        return true unless htpasswd
+      def authorize(env)
+        return unless htpasswd
 
-        auth = env['HTTP_AUTHORIZATION'] || ''
-        auth.match(/^Basic (.+)$/) do |m|
-          check_auth(*Base64.decode64(m[1]).split(':'))
-        end
+        auth = env['HTTP_AUTHORIZATION']
+        raise AuthError, 'Auth header is missing' unless auth
+
+        match = auth.match(/^Basic (.*)$/)
+        raise AuthError, 'Auth is not basic' unless match
+
+        user, password = *Base64.decode64(match[1]).split(':')
+        check_auth(user, password)
       end
 
       def check_auth(user, password)
+        raise AuthError, 'User is missing' unless user
+
+        raise AuthError, 'Password is missing' unless password
+
         e = htpasswd.fetch(user)
-        e && e.authenticated?(password)
+
+        raise AuthError, "User '#{user}' not found" unless e
+
+        raise AuthError, "Can't authenticate" unless e.authenticated?(password)
       end
     end
   end

data/lib/pechkin/cli.rb

@@ -38,13 +38,8 @@ module Pechkin
       values = OpenStruct.new
       parser = parser_create(values)
 
-      if args.empty?
-        puts parser.help
-        exit 2
-      else
-        parser.parse(args)
-        new.post_init(values)
-      end
+      parser.parse(args)
+      new.post_init(values)
     end
 
     def parser_create(values)
@@ -96,9 +91,9 @@ module Pechkin
 
     separator 'Run options'
 
-    opt :config_file, default: Dir.pwd,
-                      names: ['-c', '--config-dir FILE'],
-                      desc: 'Path to configuration file'
+    opt :config_dir, default: Dir.pwd,
+                     names: ['-c', '--config-dir FILE'],
+                     desc: 'Path to configuration file'
 
     opt :port, names: ['--port PORT'], default: 9292, type: Integer
     opt :bind_address, names: ['--address ADDRESS'], default: '127.0.0.1',
@@ -148,7 +143,7 @@ module Pechkin
                  desc: 'Print debug information and stack trace on errors'
 
     def post_init(values)
-      default_htpasswd = File.join(values.config_file, PECHKIN_HTPASSWD_FILE)
+      default_htpasswd = File.join(values.config_dir, PECHKIN_HTPASSWD_FILE)
       values.htpasswd ||= default_htpasswd
 
       values

data/lib/pechkin/command.rb

@@ -0,0 +1,38 @@
+require_relative 'command/base'
+
+require_relative 'command/add_auth'
+require_relative 'command/list'
+require_relative 'command/check'
+require_relative 'command/run_server'
+require_relative 'command/send_data'
+
+module Pechkin
+  # Contains general command processing.
+  module Command
+    # Dispatch command. Commands are placed in fixed order to allow matching
+    # rules be executed in right way. For example at first we check for
+    # --add-auth and than for --check. At the moment only RunServer should be
+    # last element of this sequence.
+    class Dispatcher
+      COMMANDS = [
+        AddAuth,
+        Check,
+        List,
+        SendData,
+        RunServer
+      ].freeze
+
+      attr_reader :options
+
+      # @param cli_options [OpenStruct] command line options object
+      def initialize(cli_options)
+        @options = cli_options
+      end
+
+      # Dispatch command according to provided options
+      def dispatch
+        COMMANDS.map { |c| c.new(options) }.find(&:matches?)
+      end
+    end
+  end
+end

data/lib/pechkin/command/add_auth.rb

@@ -0,0 +1,17 @@
+module Pechkin
+  module Command
+    # Read user:password combination and write it to htpasswd file. If file
+    # already contains user then record will be replaced
+    class AddAuth < Base
+      def matches?
+        options.add_auth
+      end
+
+      def execute
+        user, password = options.add_auth.split(':')
+        Pechkin::Auth::Manager.new(options.htpasswd).add(user, password)
+        puts IO.read(options.htpasswd)
+      end
+    end
+  end
+end

data/lib/pechkin/command/base.rb

@@ -0,0 +1,40 @@
+module Pechkin
+  module Command
+    # Basic class for all commands
+    class Base
+      attr_reader :options
+
+      # Initializes command state
+      # @param options [OpenStruct] set of options which allows to configure
+      #   command behaviour
+      # @opt stdout [IO] IO object which represents STDOUT
+      # @opt stderr [IO] IO object which represents STDERR
+      def initialize(options, stdout: STDOUT, stderr: STDERR)
+        @options = options
+        @stdout = stdout
+        @stderr = stderr
+      end
+
+      def configuration
+        config_dir = options.config_dir
+        @configuration ||= Configuration.load_from_directory(config_dir)
+      end
+
+      def handler
+        @handler ||= Handler.new(configuration.channels)
+      end
+
+      def matches?
+        raise 'Unimplemented'
+      end
+
+      def puts(*args)
+        @stdout.puts(*args)
+      end
+
+      def warn(*args)
+        @stderr.puts(*args)
+      end
+    end
+  end
+end

data/lib/pechkin/command/check.rb

@@ -0,0 +1,14 @@
+module Pechkin
+  module Command
+    # Check configuration consistency and exit.
+    class Check < Base
+      def matches?
+        options.check?
+      end
+
+      def execute
+        configuration # load configuration from disk and do nothing more
+      end
+    end
+  end
+end

data/lib/pechkin/command/list.rb

@@ -0,0 +1,42 @@
+module Pechkin
+  module Command
+    BOT_ENTRY_FORMAT = '  %-25s   %-10s   %-60s '.freeze
+    CHAT_ENTRY_FORMAT = '  %-40s   %-40s   %-30s '.freeze
+
+    # List channels configuration
+    class List < Base
+      def matches?
+        options.list?
+      end
+
+      def execute
+        cfg = configuration
+
+        puts "Working dir: #{cfg.working_dir}"
+        print_bots(cfg.bots)
+        print_channels(cfg.channels)
+      end
+
+      private
+
+      def print_bots(bots)
+        puts "\nBots:"
+        puts format(BOT_ENTRY_FORMAT, 'NAME', 'CONNECTOR', 'TOKEN')
+        bots.each do |name, bot|
+          puts format(BOT_ENTRY_FORMAT, name, bot.connector, bot.token)
+        end
+      end
+
+      def print_channels(channels)
+        puts "\nChannels:"
+        puts format(CHAT_ENTRY_FORMAT, 'CHANNEL', 'MESSAGE', 'BOT')
+        channels.each do |channel_name, channel|
+          channel.messages.each do |message_name, _message|
+            puts format(CHAT_ENTRY_FORMAT,
+                        channel_name, message_name, channel.connector.name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pechkin/command/run_server.rb

@@ -0,0 +1,17 @@
+module Pechkin
+  module Command
+    # Start pechkin HTTP server
+    class RunServer < Base
+      def matches?
+        true # Always match
+      end
+
+      def execute
+        Rack::Server.start(app: AppBuilder.new.build(handler, options),
+                           Host: options.bind_adress,
+                           Port: options.port,
+                           pid: options.pid_file)
+      end
+    end
+  end
+end

data/lib/pechkin/command/send_data.rb

@@ -0,0 +1,46 @@
+module Pechkin
+  module Command
+    # Send data to channel and exit. Uses --preview flag to render message and
+    # flush it to STDOUT before sending
+    class SendData < Base
+      def matches?
+        options.send_data
+      end
+
+      def execute
+        ch, msg = parse_endpoint(options.send_data)
+
+        raise "#{ch}/#{msg} not found" unless handler.message?(ch, msg)
+
+        data = read_data(options.data)
+
+        if options.preview
+          puts handler.preview(ch, msg, data)
+        else
+          handler.handle(ch, msg, data).each do |e|
+            puts "* #{e.inspect}"
+          end
+        end
+      end
+
+      private
+
+      def read_data(data)
+        d = if data.start_with?('@')
+              file = data[1..-1]
+              raise "File not found #{file}" unless File.exist?(file)
+              IO.read(file)
+            else
+              data
+            end
+        JSON.parse(d)
+      end
+
+      def parse_endpoint(endpoint)
+        endpoint.match(%r{^([^/]+)/(.+)$}) do |m|
+          [m[1], m[2]]
+        end
+      end
+    end
+  end
+end

data/lib/pechkin/configuration.rb

@@ -79,24 +79,5 @@ module Pechkin
       @views = views
       @channels = channels
     end
-
-    def list
-      puts "Working dir: #{working_dir}\nBots:"
-
-      bots.each do |name, bot|
-        puts "  #{name}(#{bot.connector}): #{bot.token}"
-      end
-
-      puts "\nChannels:"
-      channels.each do |channel_name, channel|
-        puts "  - name #{channel_name}"
-        puts "    bot: #{channel.connector.name}"
-        puts '    messages: '
-        channel.messages.each do |message_name, _message|
-          puts "     - /#{channel_name}/#{message_name}"
-        end
-        puts
-      end
-    end
   end
 end

data/lib/pechkin/connector.rb

@@ -10,8 +10,8 @@ module Pechkin
     def send_message(chat, message, message_desc); end
 
     def preview(chats, message, _message_desc)
-      puts "Connector: #{self.class.name}; Chats: #{chats.join(', ')}\n"
-      puts "Message:\n#{message}"
+      "Connector: #{self.class.name}; Chats: #{chats.join(', ')}\n" \
+      "Message:\n#{message}"
     end
 
     def post_data(url, data, headers: {})

data/lib/pechkin/handler.rb

@@ -3,7 +3,6 @@ module Pechkin
   # services. Can skip some requests acording to filters.
   class Handler
     attr_reader :channels
-    attr_writer :preview
 
     def initialize(channels)
       @channels = channels
@@ -13,6 +12,7 @@ module Pechkin
     # message id, and data object. By channel id we determine where to send
     # data, by message id we determine how to transform this data to real
     # message.
+    #
     # @param channel_id [String] channel name from configuration. This name is
     #  obtained from directory structure we have in configuration directory.
     # @param msg_id [String] message name from configuration. This name is
@@ -33,19 +33,38 @@ module Pechkin
 
       chats = channel_config.chat_ids
       connector = channel_config.connector
-      if preview?
-        connector.preview(chats, text, message_config)
-      else
-        chats.map { |chat| connector.send_message(chat, text, message_config) }
-      end
+
+      chats.map { |chat| connector.send_message(chat, text, message_config) }
     end
 
-    def message?(channel_id, msg_id)
-      channels.key?(channel_id) && channels[channel_id].messages.key?(msg_id)
+    # Executes message handling and renders template using connector logic
+    #
+    # @param channel_id [String] channel name from configuration. This name is
+    #  obtained from directory structure we have in configuration directory.
+    # @param msg_id [String] message name from configuration. This name is
+    #  references yml file with message description
+    # @param data [Object] data object to render via template. This is usualy
+    #  deserialized json.
+    # @see Configuration
+    def preview(channel_id, msg_id, data)
+      channel_config = fetch_channel(channel_id)
+      # Find message and try substitute values to message parameters.
+      message_config = substitute(data, fetch_message(channel_config, msg_id))
+
+      data = (message_config['variables'] || {}).merge(data)
+      template = message_config['template']
+
+      text = ''
+      text = template.render(data) unless template.nil?
+
+      chats = channel_config.chat_ids
+      connector = channel_config.connector
+
+      connector.preview(chats, text, message_config)
     end
 
-    def preview?
-      @preview
+    def message?(channel_id, msg_id)
+      channels.key?(channel_id) && channels[channel_id].messages.key?(msg_id)
     end
 
     private

data/lib/pechkin/version.rb

@@ -1,7 +1,7 @@
 module Pechkin
   # Keeps actual version
   module Version
-    VERSION = [1, 2, 0].freeze
+    VERSION = [1, 2, 1].freeze
     class << self
       def version_string
         VERSION.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pechkin
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Ilya Arkhanhelsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-17 00:00:00.000000000 Z
+date: 2020-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -38,6 +38,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: powerpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: prometheus-client
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +93,13 @@ files:
 - lib/pechkin/auth.rb
 - lib/pechkin/channel.rb
 - lib/pechkin/cli.rb
+- lib/pechkin/command.rb
+- lib/pechkin/command/add_auth.rb
+- lib/pechkin/command/base.rb
+- lib/pechkin/command/check.rb
+- lib/pechkin/command/list.rb
+- lib/pechkin/command/run_server.rb
+- lib/pechkin/command/send_data.rb
 - lib/pechkin/configuration.rb
 - lib/pechkin/configuration/configuration_loader.rb
 - lib/pechkin/configuration/configuration_loader_bots.rb