standup_md 1.0.1 → 2.0.1

data/lib/standup_md/post/adapter.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module StandupMD
+  module Post
+    ##
+    # Base class for chat posting adapters.
+    class Adapter
+      ##
+      # Adapter-specific non-secret options.
+      #
+      # @return [Hash]
+      attr_reader :options
+
+      ##
+      # Creates an adapter.
+      #
+      # @param options [Hash]
+      def initialize(options = {})
+        @options = symbolize_keys(options)
+      end
+
+      ##
+      # Sends a message.
+      #
+      # @param message [StandupMD::Post::Message]
+      #
+      # @return [StandupMD::Post::Result]
+      def post(message)
+        raise NotImplementedError, "#{self.class} must implement #post"
+      end
+
+      private
+
+      def symbolize_keys(hash)
+        hash.each_with_object({}) do |(key, value), result|
+          result[key.to_sym] = value
+        end
+      end
+    end
+  end
+end

data/lib/standup_md/post/adapters/slack.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "uri"
+require "standup_md/post/adapter"
+require "standup_md/post/result"
+
+module StandupMD
+  module Post
+    ##
+    # Namespace for built-in posting adapters.
+    module Adapters
+      ##
+      # Posts standup entries to Slack using the chat.postMessage Web API.
+      class Slack < StandupMD::Post::Adapter
+        ##
+        # Slack chat.postMessage endpoint.
+        #
+        # @return [String]
+        DEFAULT_ENDPOINT = "https://slack.com/api/chat.postMessage"
+
+        ##
+        # Environment variable used for the Slack token by default.
+        #
+        # @return [String]
+        DEFAULT_TOKEN_ENV = "STANDUP_MD_SLACK_TOKEN"
+
+        ##
+        # Sends a message to Slack.
+        #
+        # @param message [StandupMD::Post::Message]
+        #
+        # @return [StandupMD::Post::Result]
+        def post(message)
+          channel = message.channel || options[:channel]
+          token = ENV[token_env]
+          return failure(message, channel, "No Slack channel configured") if blank?(channel)
+          return failure(message, channel, "Missing Slack token in $#{token_env}") if blank?(token)
+
+          response = perform_request(channel, message.text, token)
+          parsed = parse_response(response.body)
+          return success(message, channel, response, parsed) if response.is_a?(Net::HTTPSuccess) && parsed["ok"]
+
+          failure(message, channel, error_message(response, parsed), parsed)
+        rescue => e
+          failure(message, channel, e.message)
+        end
+
+        private
+
+        def endpoint
+          options[:endpoint] || DEFAULT_ENDPOINT
+        end
+
+        def token_env
+          options[:token_env] || DEFAULT_TOKEN_ENV
+        end
+
+        def perform_request(channel, text, token)
+          uri = URI(endpoint)
+          request = Net::HTTP::Post.new(uri)
+          request["Authorization"] = "Bearer #{token}"
+          request["Content-Type"] = "application/json; charset=utf-8"
+          request["Accept"] = "application/json"
+          request.body = JSON.generate(channel: channel, text: text)
+
+          return options[:http].call(request, uri) if options[:http]
+
+          Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
+            http.request(request)
+          end
+        end
+
+        def parse_response(body)
+          JSON.parse(body.to_s)
+        rescue JSON::ParserError
+          {}
+        end
+
+        def success(message, channel, http_response, parsed)
+          StandupMD::Post::Result.success(
+            adapter: message.adapter,
+            channel: channel,
+            response: parsed.merge("code" => http_response.code)
+          )
+        end
+
+        def failure(message, channel, error, response = {})
+          StandupMD::Post::Result.failure(
+            adapter: message.adapter,
+            channel: channel,
+            error: error,
+            response: response
+          )
+        end
+
+        def error_message(http_response, parsed)
+          parsed["error"] || "Slack returned HTTP #{http_response.code}"
+        end
+
+        def blank?(value)
+          value.nil? || value.to_s.empty?
+        end
+      end
+    end
+  end
+end

data/lib/standup_md/post/message.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module StandupMD
+  module Post
+    ##
+    # A platform-neutral message to send through a posting adapter.
+    class Message
+      ##
+      # The standup entry being posted.
+      #
+      # @return [StandupMD::Entry]
+      attr_reader :entry
+
+      ##
+      # The rendered message body.
+      #
+      # @return [String]
+      attr_reader :text
+
+      ##
+      # The destination channel, room, or conversation identifier.
+      #
+      # @return [String, nil]
+      attr_reader :channel
+
+      ##
+      # The adapter name requested by the caller.
+      #
+      # @return [Symbol]
+      attr_reader :adapter
+
+      ##
+      # Builds a message for a posting adapter.
+      #
+      # @param entry [StandupMD::Entry]
+      # @param text [String]
+      # @param channel [String, nil]
+      # @param adapter [String, Symbol]
+      def initialize(entry:, text:, channel:, adapter:)
+        @entry = entry
+        @text = text.to_s
+        @channel = channel
+        @adapter = adapter.to_sym
+      end
+    end
+  end
+end

data/lib/standup_md/post/result.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module StandupMD
+  module Post
+    ##
+    # Result returned by posting adapters.
+    class Result
+      ##
+      # The adapter that handled the post.
+      #
+      # @return [Symbol]
+      attr_reader :adapter
+
+      ##
+      # The destination channel, room, or conversation identifier.
+      #
+      # @return [String, nil]
+      attr_reader :channel
+
+      ##
+      # Adapter-specific response metadata.
+      #
+      # @return [Hash]
+      attr_reader :response
+
+      ##
+      # Human-readable error message for failed posts.
+      #
+      # @return [String, nil]
+      attr_reader :error
+
+      ##
+      # Builds a posting result.
+      #
+      # @param success [Boolean]
+      # @param adapter [String, Symbol]
+      # @param channel [String, nil]
+      # @param response [Hash]
+      # @param error [String, nil]
+      def initialize(success:, adapter:, channel:, response: {}, error: nil)
+        @success = success
+        @adapter = adapter.to_sym
+        @channel = channel
+        @response = response
+        @error = error
+      end
+
+      ##
+      # Builds a successful result.
+      #
+      # @return [StandupMD::Post::Result]
+      def self.success(adapter:, channel:, response: {})
+        new(success: true, adapter: adapter, channel: channel, response: response)
+      end
+
+      ##
+      # Builds a failed result.
+      #
+      # @return [StandupMD::Post::Result]
+      def self.failure(adapter:, channel:, error:, response: {})
+        new(
+          success: false,
+          adapter: adapter,
+          channel: channel,
+          response: response,
+          error: error
+        )
+      end
+
+      ##
+      # Was the post successful?
+      #
+      # @return [Boolean]
+      def success?
+        @success
+      end
+
+      ##
+      # Did the post fail?
+      #
+      # @return [Boolean]
+      def failure?
+        !success?
+      end
+    end
+  end
+end

data/lib/standup_md/post.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "standup_md/post/message"
+require "standup_md/post/result"
+require "standup_md/post/adapter"
+require "standup_md/post/adapters/slack"
+require "standup_md/parsers/markdown"
+
+module StandupMD
+  ##
+  # Namespace for posting standup entries to chat clients.
+  module Post
+    ##
+    # Base error for posting failures.
+    class Error < StandardError; end
+
+    ##
+    # Raised when a configured adapter cannot be found.
+    class UnknownAdapter < Error; end
+
+    module_function
+
+    ##
+    # Renders and posts a standup entry through a configured chat adapter.
+    #
+    # @param entry [StandupMD::Entry]
+    # @param adapter [String, Symbol, nil]
+    # @param channel [String, nil]
+    # @param text [String, nil]
+    # @param renderer [Object, nil]
+    # @param config [StandupMD::Config]
+    #
+    # @return [StandupMD::Post::Result]
+    def post(entry, adapter: nil, channel: nil, text: nil, renderer: nil, config: StandupMD.config)
+      adapter_name = (adapter || config.post.default_adapter).to_sym
+      message = Message.new(
+        entry: entry,
+        text: text || render_post_text(entry, renderer, config),
+        channel: channel,
+        adapter: adapter_name
+      )
+      config.post.build_adapter(adapter_name).post(message)
+    end
+
+    ##
+    # Default renderer used when posting an entry.
+    #
+    # @param config [StandupMD::Config]
+    #
+    # @return [StandupMD::Parsers::Markdown]
+    def default_renderer(config = StandupMD.config)
+      StandupMD::Parsers::Markdown.new(config.file)
+    end
+
+    ##
+    # Renders text for a posted entry.
+    #
+    # @param entry [StandupMD::Entry]
+    # @param renderer [Object, nil]
+    # @param config [StandupMD::Config]
+    #
+    # @return [String]
+    def render_post_text(entry, renderer, config)
+      text = (renderer || default_renderer(config)).render_entry(entry)
+      apply_post_title(text, entry, config)
+    end
+
+    ##
+    # Applies the configured post title format to the first entry header.
+    #
+    # @param text [String]
+    # @param entry [StandupMD::Entry]
+    # @param config [StandupMD::Config]
+    #
+    # @return [String]
+    def apply_post_title(text, entry, config)
+      return text unless config.post.title
+
+      title = config.post.title % entry.date.strftime(config.file.header_date_format)
+      header = "#" * config.file.header_depth
+      text.sub(/\A#{Regexp.escape(header)}\s+.*$/, "#{header} #{title}")
+    end
+  end
+end

data/lib/standup_md/section.rb

@@ -48,22 +48,11 @@ module StandupMD
     end
 
     ##
-    # The configured section heading.
+    # The semantic section type.
     #
     # @return [String]
     def to_s
-      StandupMD.config.file.public_send("#{type}_header")
-    end
-
-    ##
-    # The section rendered as markdown lines.
-    #
-    # @return [Array<String>]
-    def to_markdown
-      [
-        "#" * StandupMD.config.file.sub_header_depth + " " + to_s,
-        *tasks.map(&:to_markdown)
-      ]
+      type.to_s
     end
 
     private

data/lib/standup_md/task.rb

@@ -39,15 +39,6 @@ module StandupMD
       text
     end
 
-    ##
-    # The task rendered as a markdown list item.
-    #
-    # @return [String]
-    def to_markdown
-      indent = " " * StandupMD.config.file.indent_width * indent_level
-      "#{indent}#{StandupMD.config.file.bullet_character} #{text}"
-    end
-
     ##
     # Compares task contents.
     def ==(other)

data/lib/standup_md/version.rb

@@ -9,7 +9,7 @@ module StandupMD
     # Major version.
     #
     # @return [Integer]
-    MAJOR = 1
+    MAJOR = 2
 
     ##
     # Minor version.

data/lib/standup_md.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require "standup_md/version"
+require "standup_md/post"
 require "standup_md/config"
 require "standup_md/task"
-require "standup_md/title"
 require "standup_md/section"
 require "standup_md/entry"
 require "standup_md/entry_list"
@@ -21,7 +21,7 @@ module StandupMD
   ##
   # Method for accessing the configuration.
   #
-  # @return [StanupMD::Config]
+  # @return [StandupMD::Config]
   def config
     @config || reset_config
   end

data/standup_md.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |spec|
   spec.summary = %(The cure for all your standup woes)
   spec.description = %(Generate and edit standups in markdown format)
   spec.homepage = "https://evanthegrayt.github.io/standup_md/"
+  spec.required_ruby_version = ">= 3.2"
 
   unless spec.respond_to?(:metadata)
     raise "RubyGems 2.0 or newer is required to protect against " \

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: standup_md
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Evan Gray
@@ -105,6 +105,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- SLACK_SETUP_GUIDE.md
 - _config.yml
 - bin/standup
 - completion/zsh/_standup
@@ -114,15 +115,19 @@ files:
 - lib/standup_md/config.rb
 - lib/standup_md/config/cli.rb
 - lib/standup_md/config/entry.rb
-- lib/standup_md/config/entry_list.rb
 - lib/standup_md/config/file.rb
+- lib/standup_md/config/post.rb
 - lib/standup_md/entry.rb
 - lib/standup_md/entry_list.rb
 - lib/standup_md/file.rb
 - lib/standup_md/parsers/markdown.rb
+- lib/standup_md/post.rb
+- lib/standup_md/post/adapter.rb
+- lib/standup_md/post/adapters/slack.rb
+- lib/standup_md/post/message.rb
+- lib/standup_md/post/result.rb
 - lib/standup_md/section.rb
 - lib/standup_md/task.rb
-- lib/standup_md/title.rb
 - lib/standup_md/version.rb
 - standup_md.gemspec
 homepage: https://evanthegrayt.github.io/standup_md/
@@ -140,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/standup_md/config/entry_list.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module StandupMD
-  class Config
-    ##
-    # The configuration class for StandupMD::EntryList
-    class EntryList
-      ##
-      # The default options.
-      #
-      # @return [Hash]
-      DEFAULTS = {}.freeze
-
-      ##
-      # Initializes the config with default values.
-      def initalize
-        reset
-      end
-
-      ##
-      # Sets all config values back to their defaults.
-      #
-      # @return [Hash]
-      def reset
-        DEFAULTS.each { |k, v| instance_variable_set("@#{k}", v) }
-      end
-    end
-  end
-end

data/lib/standup_md/title.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require "date"
-
-module StandupMD
-  ##
-  # The title for a standup entry.
-  class Title
-    ##
-    # The entry date.
-    #
-    # @return [Date]
-    attr_reader :date
-
-    ##
-    # Constructs an instance of +StandupMD::Title+.
-    #
-    # @param [Date] date
-    def initialize(date)
-      raise ArgumentError, "Must be a Date object" unless date.is_a?(Date)
-
-      @date = date
-    end
-
-    ##
-    # The configured title text.
-    #
-    # @return [String]
-    def to_s
-      date.strftime(StandupMD.config.file.header_date_format)
-    end
-
-    ##
-    # The title rendered as markdown.
-    #
-    # @return [String]
-    def to_markdown
-      "#" * StandupMD.config.file.header_depth + " " + to_s
-    end
-  end
-end