slackened 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0533a76d3e20e531fb744a74faa507a0fdedc6879f3c33e94834f13f90f107a
+  data.tar.gz: 76aa533b1f39ca68127328c846d2550887f9001d4a26877b2e8ec8a302202cea
+SHA512:
+  metadata.gz: 0ad787bfc7030af7acc25c992ed8d00e6ef8a9f1481cbc5a924184340646013f885c3f98a02d34eb9132e275398a3c09aaaf5aee0b9dd066f6140f882677f8f2
+  data.tar.gz: 8b7aa0d123e9a9337306c13efe766bd17bcdd267ded343dc1c08a86a2fa2d3317d52fdc810218d6eb3d8bfc038961f70d8843a481c520aa7e5a1f4ea81ab6da8

data/lib/slackened/authentication/request.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Slackened
+	# Determine whether the incoming request is fraudulent
+	module Authentication
+		class Request
+			attr_reader :signature, :timestamp, :body
+
+			def initialize(timestamp:, signature:, body:)
+				@timestamp = timestamp.to_i
+				@signature = signature
+				@body = body
+			end
+
+			# The signature depends on the timestamp to protect against replay attacks. While you're extracting the timestamp,
+			# check to make sure that the request occurred recently. In this example, we verify that the timestamp does not
+			# differ from local time by more than five minutes.
+			# https://api.slack.com/authentication/verifying-requests-from-slack
+			def stale?
+				# is it less than 5 minutes old?
+				five_minutes_ago = Time.now - 60 * 5
+
+				Time.at(@timestamp) > five_minutes_ago
+			end
+
+			# Slack creates a unique string for your app and shares it with you.
+			# Verify requests from Slack with confidence by verifying signatures using your signing secret.
+			# https://api.slack.com/authentication/verifying-requests-from-slack
+			def valid?
+				return false if stale?
+
+				sig_basestring = "v0:#{@timestamp}:#{@body}"
+
+				secret = Slackened.configuration.signing_secret
+
+				digest = OpenSSL::HMAC.hexdigest('SHA256', secret, sig_basestring)
+
+				@signature == "v0=#{digest}"
+			end
+		end
+	end
+end

data/lib/slackened/authentication.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Slackened
+	# proof of concept
+	module Authentication
+		extend Forwardable
+
+		# alphabetical
+		def_delegators self, :validate_request
+
+		# alphabetical
+		class << self
+			def validate_request(**kwargs)
+				Request.new(**kwargs).valid?
+			end
+		end
+	end
+end
+

data/lib/slackened/block_kit/blocks/actions.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Slackened
+	module BlockKit
+		# proof of concept
+		module Blocks
+			class Actions < Slackened::BlockKit::Blocks::Base
+				MAX_LENGTH = 25
+
+				def initialize(*elements)
+					raise MinimumElementsError if elements.length.zero?
+					raise MaximumElementsError, "#{elements.count} can't be greater than #{MAX_LENGTH}" if elements.length > MAX_LENGTH
+
+					set({
+						type: :actions,
+						elements:
+					})
+
+					self
+				end
+			end
+		end
+	end
+end

data/lib/slackened/block_kit/blocks/base.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Slackened
+	module BlockKit
+		# proof of concept
+		module Blocks
+			class MinimumCharactersError < StandardError; end
+			class MaximumCharactersError < StandardError; end
+
+			class MinimumFieldsError < StandardError; end
+			class MaximumFieldsError < StandardError; end
+
+			class MinimumElementsError < StandardError; end
+			class MaximumElementsError < StandardError; end
+
+			class MustBeString < StandardError; end
+
+			class Base
+				attr_accessor :block
+
+				def set(block)
+					@block = block
+				end
+
+				# recursion?
+				def to_h
+					@block.to_h do |key, value|
+						case value
+						when Array
+							[key, value.map(&:to_h)]
+						when Base
+							[key, value.to_h]
+						else
+							[key, value]
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/slackened/block_kit/blocks/button.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Slackened
+	module BlockKit
+		# proof of concept
+		module Blocks
+			class Button < Slackened::BlockKit::Blocks::Base
+				MAX_LENGTH = 75
+
+				def initialize(plain_text:, action_id:, value:) # rubocop:disable Metrics/MethodLength
+					raise MinimumCharactersError if plain_text.length.zero?
+					raise MaximumCharactersError, "#{plain_text} can't be greater than #{MAX_LENGTH}" if plain_text.length > MAX_LENGTH
+
+					set({
+						action_id:,
+						text: {
+							type: :plain_text,
+							text: plain_text
+						},
+						type: :button,
+						value:
+					})
+
+					self
+				end
+			end
+		end
+	end
+end

data/lib/slackened/block_kit/blocks/context.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Slackened
+	module BlockKit
+		# proof of concept
+		module Blocks
+			class Context < Slackened::BlockKit::Blocks::Base
+				MAX_LENGTH = 10
+
+				def initialize(*elements)
+					raise TooManyElementsError, "#{elements.count} can't be greater than #{MAX_LENGTH}" if elements.length > MAX_LENGTH
+
+					# TODO: need to allow for image
+					# https://api.slack.com/reference/block-kit/blocks#context
+					set({
+						type: :context,
+						elements: elements.map do |element|
+							raise MustBeString, "#{element} must be a string" unless element.is_a? String
+
+							Text.new(element)
+						end
+					})
+
+					self
+				end
+			end
+		end
+	end
+end

data/lib/slackened/block_kit/blocks/divider.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Slackened
+	module BlockKit
+		# proof of concept
+		module Blocks
+			class Divider < Slackened::BlockKit::Blocks::Base
+				def initialize
+					set({ type: :divider })
+
+					self
+				end
+
+				def to_h
+					@block.to_h
+				end
+			end
+		end
+	end
+end

data/lib/slackened/block_kit/blocks/header.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Slackened
+	module BlockKit
+		# proof of concept
+		module Blocks
+			class Header < Slackened::BlockKit::Blocks::Base
+				MAX_LENGTH = 150
+
+				def initialize(plain_text)
+					raise TooManyCharactersError, "#{plain_text} can't be greater than #{MAX_LENGTH}" if plain_text.length > MAX_LENGTH
+					raise MustBeString unless plain_text.is_a? String
+
+					set({
+						type: :header,
+						text: {
+							type: :plain_text, # cannot be :mrkdwn
+							text: plain_text
+						}
+					})
+
+					self
+				end
+			end
+		end
+	end
+end

data/lib/slackened/block_kit/blocks/section.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Slackened
+	module BlockKit
+		# proof of concept
+		module Blocks
+			class Section < Slackened::BlockKit::Blocks::Base
+				MAX_LENGTH = 10
+
+				def initialize(*fields) # rubocop:disable Metrics/MethodLength
+					raise TooManyFieldsError, "#{fields.count} can't be greater than #{MAX_LENGTH}" if fields.length > MAX_LENGTH
+					raise MustBeString unless fields.all? { |f| f.is_a? String }
+
+					if fields.one?
+						set({
+							type: :section,
+							text: Text.new(fields.first)
+						})
+
+						return self
+					end
+
+					set({
+						type: :section,
+						fields: fields.map { |f| Text.new(f) }
+					})
+
+					self
+				end
+			end
+		end
+	end
+end

data/lib/slackened/block_kit/blocks/text.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Slackened
+	module BlockKit
+		# proof of concept
+		module Blocks
+			class Text < Slackened::BlockKit::Blocks::Base
+				MAX_LENGTH = 3000
+
+				def initialize(markdown)
+					raise TooManyCharactersError, "#{markdown.length} can't be greater than #{MAX_LENGTH}" if markdown.length > MAX_LENGTH
+
+					set({
+						type: :mrkdwn,
+						text: markdown
+					})
+
+					self
+				end
+			end
+		end
+	end
+end

data/lib/slackened/block_kit/blocks.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Slackened
+	module BlockKit
+		# proof of concept
+		module Blocks
+			extend Forwardable
+
+			# alphabetical
+			def_delegators self, :actions, :button, :context, :divider, :header, :section, :text
+
+			# alphabetical
+			class << self
+				def actions(*elements)
+					Actions.new(*elements)
+				end
+
+				def button(**kwargs)
+					Button.new(**kwargs)
+				end
+
+				def context(*elements)
+					Context.new(*elements)
+				end
+
+				def divider
+					Divider.new
+				end
+
+				def header(*args)
+					Header.new(*args)
+				end
+
+				def section(*args)
+					Section.new(*args)
+				end
+
+				def text(*args)
+					Text.new(*args)
+				end
+			end
+		end
+	end
+end

data/lib/slackened/block_kit/builder.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Slackened
+	module BlockKit
+		# where the blocks are stored
+		class Builder
+			attr_accessor :blocks
+
+			def initialize
+				@blocks = []
+			end
+
+			def row(row)
+				blocks.push(row)
+			end
+		end
+	end
+end

data/lib/slackened/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Slackened
+	# Settings
+	class Configuration
+		# alphabetize
+		attr_accessor :signing_secret, :webhook_url
+
+		def initialize
+			# alphabetize
+			@signing_secret = ''
+			@webhook_url = 'https://slack.com'
+		end
+	end
+end

data/lib/slackened/http.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'json'
+require 'net/http'
+require 'uri'
+
+module Slackened
+	# Post the message
+	class HTTP
+		extend Forwardable
+
+		def_delegators self, :post
+
+		HEADERS = {
+			'Content-Type' => 'application/json'
+		}.freeze
+
+		class << self
+			def post(blocks: [], headers: {}, url: Slackened.configuration.webhook_url)
+
+				body = JSON.dump({ blocks: })
+
+				uri = URI(url)
+
+				Net::HTTP.post(uri, body, HEADERS.merge(headers))
+			end
+		end
+	end
+end

data/lib/slackened/logger.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Slackened
+	# proof of concept
+	module Logger
+		def log
+			@log ||= ::Logger.new($stdout)
+		end
+
+		def debug!
+			@log.level = ::Logger::DEBUG
+		end
+
+		def info!
+			@log.level = ::Logger::INFO
+		end
+
+		def warn!
+			@log.level = ::Logger::WARN
+		end
+	end
+end

data/lib/slackened/surface/message.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Slackened
+	module Surface
+		# Proof of concept
+		# https://api.slack.com/surfaces/messages
+		class Message
+			extend Forwardable
+			extend Slackened::BlockKit::Blocks
+
+			# alphabetical
+			def_delegators self, :build, :builder, :layout, :post
+
+			# alphabetical
+			class << self
+				def builder
+					@builder ||= Slackened::BlockKit::Builder.new
+				end
+
+				def build
+					yield builder
+				end
+
+				def post(url: Slackened.configuration.webhook_url, **kwargs)
+					layout(**kwargs)
+
+					Slackened::HTTP.post(
+						blocks: payload,
+						url:
+					)
+				end
+
+				def layout
+					raise NotImplementedError, 'You must define `self.layout` and build a layout'
+				end
+
+				private
+
+				def payload
+					builder.blocks.map(&:to_h)
+				end
+			end
+		end
+	end
+end

data/lib/slackened.rb

@@ -0,0 +1,32 @@
+# typed: false
+# frozen_string_literal: true
+
+# Slack Incoming Webhook
+module Slackened
+	require_relative 'slackened/authentication/request'
+	require_relative 'slackened/block_kit/blocks'
+	require_relative 'slackened/block_kit/blocks/actions'
+	require_relative 'slackened/block_kit/blocks/button'
+	require_relative 'slackened/block_kit/blocks/context'
+	require_relative 'slackened/block_kit/blocks/divider'
+	require_relative 'slackened/block_kit/blocks/header'
+	require_relative 'slackened/block_kit/blocks/section'
+	require_relative 'slackened/block_kit/blocks/text'
+	require_relative 'slackened/block_kit/builder'
+	require_relative 'slackened/configuration'
+	require_relative 'slackened/http'
+	require_relative 'slackened/logger'
+	require_relative 'slackened/surface/message'
+
+	extend Slackened::Logger
+
+	class << self
+		def configuration
+			@configuration ||= Configuration.new
+		end
+
+		def configure
+			yield configuration
+		end
+	end
+end

data.tar.gz.sig

@@ -0,0 +1,2 @@
+U
+ƛiLK�ۛ��՚�X*5#���;Z�j֨LY6��&BC��
���f<0��TŃ*1(��)�`\ޥ�4��kA����ŕ����Ѻ�1�p^�z���u�yo4&K&�����'�9�-��i���7����"��\�HRO

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: slackened
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Matyus
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEZDCCAsygAwIBAgIBATANBgkqhkiG9w0BAQsFADA8MRAwDgYDVQQDDAdtaWNo
+  YWVsMRQwEgYKCZImiZPyLGQBGRYEbWF0eTESMBAGCgmSJomT8ixkARkWAnVzMB4X
+  DTI0MDcwMTEyMDIxMFoXDTI1MDcwMTEyMDIxMFowPDEQMA4GA1UEAwwHbWljaGFl
+  bDEUMBIGCgmSJomT8ixkARkWBG1hdHkxEjAQBgoJkiaJk/IsZAEZFgJ1czCCAaIw
+  DQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALdWoH+SLiruQkWj49ozmet32XEo
+  qsdDgz/3wYbVYWsobKGlvkwQf8k1bdjrpS4Ns9FA7sEJ9dM88GpPp1QViDayeNoO
+  ox08b92evCTdfsDC2WJy30pYhDu9kANJPCXNGMyhzNbHFGS9Q1+W9UbE0N4UfGpB
+  I4Zmz6NPMWBZ6oLCdjFfoKrJ0R9VgTOOjvaNzWQj81PFKzBFVy9HD8oBxZ105rlS
+  RhPKR2aeA+NB/7Q9RTETPtaS9vyA6a9L/eF5BO4C/cQOGaRp45D4eSSmYhqg0deL
+  NOFCA7dzxTIYBnwMK4DX2hiXi83cK9DrohA4Z2f4HybjRI8ys0zq59ESJRsWWoCq
+  lRZOZ/gZxnMGcjK5ICXfDUpLMfBIyso2XXtxfgARM9ypR11uZLu+Uk5tf6VuO74T
+  m6136/TfZbIStirgkpIIAQtdqVGNzgRqE9Xm48QREuNgEdjbUYabn0XxOvw/VY1h
+  h3Y+v1V2S7ERDEO0fSSXa0gHlJmv/y1R7HgDtQIDAQABo3EwbzAJBgNVHRMEAjAA
+  MAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUEnqPdYWlVwXtf4JqTDCK71bHelowGgYD
+  VR0RBBMwEYEPbWljaGFlbEBtYXR5LnVzMBoGA1UdEgQTMBGBD21pY2hhZWxAbWF0
+  eS51czANBgkqhkiG9w0BAQsFAAOCAYEAcBByxEg8NTpu4U29HBKjqajKS9CAOg2z
+  KYEoRleKd/NYapQWKkdzD1Ly8pG9F421c15uQx0gdrwoTwTod/YmL0k5DyHukkfX
+  j5v7EUl7N0XCzZICAUJ7K/bjasMN2Q3W0dS2bBkeNAloZP1WoHA2CcBTiA6Wbwx7
+  WMiR8+addSAmXYc08fy4mKJDOiqCpNCu9GGh6Ij8S6N8SH+1lCIdkJIAKUIYISZ6
+  Dnt3NCUYdw/rfbehWPwlSG98sA8MEreNTtJWWqyjpqP2VfqA1fmLyPqhUhGrpfeb
+  9xpLFh4jRCWtdCy8cuvr/5CAvihnS03TI4BZ3W2QuDXwRPeetKwpokXG123JU6LF
+  7mYaOEX3bj5HG426MuKj8lyHMa4ooe7Cm48eMDyL9oNMI7M9L+0+5xtuYPDEKIlJ
+  kSxIyBhjGtfFTmutQUKLBZmOzNf1g4sxY0BylDvd+Ce270mbViFvmpwkpiKpPqQQ
+  2UTSf+Edp6/W5RDQoUAObJKcsvzDv5tp
+  -----END CERTIFICATE-----
+date: 2024-07-01 00:00:00.000000000 Z
+dependencies: []
+description: A lightweight interface interacting with the Slack APIs
+email: michael@maty.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/slackened.rb
+- lib/slackened/authentication.rb
+- lib/slackened/authentication/request.rb
+- lib/slackened/block_kit/blocks.rb
+- lib/slackened/block_kit/blocks/actions.rb
+- lib/slackened/block_kit/blocks/base.rb
+- lib/slackened/block_kit/blocks/button.rb
+- lib/slackened/block_kit/blocks/context.rb
+- lib/slackened/block_kit/blocks/divider.rb
+- lib/slackened/block_kit/blocks/header.rb
+- lib/slackened/block_kit/blocks/section.rb
+- lib/slackened/block_kit/blocks/text.rb
+- lib/slackened/block_kit/builder.rb
+- lib/slackened/configuration.rb
+- lib/slackened/http.rb
+- lib/slackened/logger.rb
+- lib/slackened/surface/message.rb
+homepage: https://rubygems.org/gems/slackened
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_requirea: 'true'
+  source_code_uri: https://github.com/matyus/slackened
+post_install_message: 'Slack stands for: Searchable Log of All Communication and Knowledge'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- '"Activate incoming webhooks" feature via https://api.slack.com/messaging/webhooks'
+- Create a valid webhook endpoint URL provided by Slack
+- Store the entire URL in an ENV variable outside your application
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Interact with Slack
+test_files: []