sinatra-slack 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1001e651845588b445467b51c39c70088b645578db40e9a3ab8912fbca3627bb
+  data.tar.gz: 7bfd5bb48ed346097648304703bb55a8976a99af2018788f2bbd683a64b113d8
+SHA512:
+  metadata.gz: c7cd89a308c80e2d57c021e31a52ca345906b1807480eed6dc88ee1fd82a283899650d6c7920ff02b369155ce59e3364b646c6afb1e2abb99e2b54fe896c35ee
+  data.tar.gz: 95cd9900d8bdc6d890b57319826da7d17b2538d1d12548f922ee2342a5f8127fc94a47d83e9a2e6b451934e15fd6b5698257e8dd917c4523ce88371dbe8f2d80

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+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,68 @@
+# Sinatra::Slack
+
+> Note: WIP
+
+Creating your first Slack Slash Command application has never been to easy. Combining `sinatra` and `sinatra-slack` DSL, you can quickly create a app that processes Slach Commands with ease.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sinatra-slack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-slack
+
+## Example
+
+Go to folder example for more information. Learn how to create a Slack App in https://api.slack.com
+
+## Usage
+
+``` ruby
+require "sinatra/base"
+require "sinatra/slack"
+
+class App < Sinatra::Base
+  register Sinatra::Slack
+
+  configure :production, :development do
+    enable :logging
+    
+    before { logger.info "Received: #{params}" }
+  end
+
+  set :slack_secret, ENV['SLACK_SIGNING_SECRET']
+  commands_endpoint "/slack/commands"
+  actions_endpoint "/slack/actions"
+
+  command "/command *sub_command :spot_name" do |sub_command, spot_name|
+    "Executed *command* command \n[subcommand]: #{sub_command} \n[args]:  #{spot_name}"
+  end
+end
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nunonamorado/sinatra-slack. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sinatra::Slack project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sinatra-slack/blob/master/CODE_OF_CONDUCT.md).

data/lib/sinatra/slack.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'sinatra/async'
+require_relative './slack/instance_helpers'
+
+# Sinatra
+module Sinatra
+  # Sinatra Module for creating Slack apps with ease
+  module Slack
+    def self.registered(app)
+      # We will use async request handling so that it's easier
+      # so offload heavier proccessing to a background thread.
+      # Sinatra::Async uses EventMachine.
+      app.register Sinatra::Async
+
+      # Slack signing secret, used for request verification
+      app.set :slack_secret, nil
+      app.helpers Slack::InstanceHelpers
+    end
+
+    # Defines a new HTTP POST Handler to receive
+    # Slash Command notifications.
+    def commands_endpoint(path, quick_reply: '')
+      set_endpoint(path, quick_reply) do
+        signature = "#{command.command} #{command.text}"
+        command_pattern = self.class.get_pattern(signature)
+        request_params = command_pattern.params(signature).values
+
+        {
+          request_handler: self.class.get_handler(signature),
+          request_params: request_params
+        }
+      end
+    end
+
+    # Defines a new HTTP POST Handler to receive
+    # Actions notifications.
+    def actions_endpoint(path, quick_reply: '')
+      set_endpoint(path, quick_reply) do
+        action_pattern = self.class.get_pattern(action.name)
+        request_params = action_pattern.params(action.name).values || []
+        request_params << action.value
+
+        {
+          request_handler: self.class.get_handler(action.name),
+          request_params: request_params
+        }
+      end
+    end
+
+    def register_handler(signature, &block)
+      pattern = parse_signature(signature)
+      method_name = get_handler_name(pattern)
+      define_method(method_name, &block)
+    end
+    alias action register_handler
+    alias command register_handler
+
+    def get_handler(signature)
+      pattern = get_pattern(signature)
+      return unless pattern
+
+      method_name = get_handler_name(pattern)
+      instance_method method_name
+    end
+
+    def get_pattern(signature)
+      @patterns.find { |p| p.match(signature) }
+    end
+
+    private
+
+    def get_handler_name(pattern)
+      "#{pattern.safe_string}_handler"
+    end
+
+    def parse_signature(signature)
+      @patterns ||= []
+      raise 'Signature already defined' if get_pattern(signature)
+
+      @patterns << Mustermann.new(signature)
+      @patterns.last
+    end
+
+    def set_endpoint(path, quick_reply, &block)
+      raise 'No block given' unless block_given?
+
+      define_method("#{path}_options", &block)
+
+      settings.apost(path) do
+        halt 401, 'Invalid Headers' unless authorized?
+
+        get_options = self.class.instance_method "#{path}_options"
+        options = get_options.bind(self).call
+
+        halt 400 unless options
+
+        options[:quick_reply] = quick_reply
+
+        handle_request(options)
+      rescue StandardError => ex
+        logger.error ex.full_message
+        channel.send(slack_error_notification)
+      end
+    end
+  end
+
+  register Sinatra::Slack
+end

data/lib/sinatra/slack/helpers/action_request.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Sinatra
+  module Slack
+    module Helpers
+      # Representation of a Action request
+      # sent from Slack Servers.
+      class ActionRequest
+        attr_reader :name, :value
+
+        def initialize(name, value)
+          @name = name
+          @value = value
+        end
+
+        def self.parse(params)
+          payload = JSON.parse params['payload']
+
+          return unless payload['type'] == 'interactive_message'
+
+          action = payload['actions'].first
+          value = action['value'] if action.key?('value')
+          value = action['selected_options'].first['value'] if action.key?('selected_options')
+          name = payload['callback_id']
+
+          new(name, value)
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/slack/helpers/channel.rb

@@ -0,0 +1,40 @@
+require "httparty"
+
+module Sinatra
+  module Slack
+    module Helpers
+      class Channel
+        def initialize(opts = {})
+          @id = opts["channel_id"]
+          @name = opts["channel_name"]
+          @url = opts["response_url"]
+        end
+
+        def send(response)
+          options = {
+            headers: {
+              "Content-type": "application/json"
+            },
+            body: response.to_json
+          }
+          HTTParty.post(@url, options)
+        end
+
+        def to_s
+          "Slack Channel: #{@name}"
+        end
+
+        def self.parse(params)
+          payload = params.clone
+          if payload["payload"]
+            payload = JSON.parse(payload["payload"])
+            payload["channel_id"] = payload.dig("channel", "id")
+            payload["channel_name"] = payload.dig("channel", "name")
+          end
+
+          self.new(payload)
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/slack/helpers/command_request.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Sinatra
+  module Slack
+    module Helpers
+      # Representation of a Slash Command request sent
+      # from Slack servers.
+      class CommandRequest
+        attr_reader :token, :command, :text, :response_url, :trigger_id,
+                    :user_id, :user_name, :team_id, :team_name, :channel_id,
+                    :channel_name
+
+        def initialize(params = {})
+          @params = params
+          params.keys.each { |k| instance_variable_set("@#{k}", params[k]) }
+        end
+
+        def to_s
+          @params.to_s
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/slack/helpers/slack_attachment.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Sinatra
+  module Slack
+    module Helpers
+      # Represents a message attachment sent to the Slack Channel.
+      class Attachment
+        attr_accessor :title, :color, :attachment_type,
+                      :text, :fallback, :image_url
+
+        def initialize(callback_id)
+          @callback_id = callback_id
+          @attachment_type = 'default'
+          @color = '#3AA3E3'
+          @actions = []
+
+          @text = ''
+          @fallback = ''
+          @image_url = ''
+          @title = ''
+        end
+
+        def action_button(name, text, value)
+          @actions << {
+            name: name,
+            text: text,
+            type: 'button',
+            value: value
+          }
+        end
+
+        def action_menu(name, text, options)
+          @actions << {
+            name: name,
+            text: text,
+            type: 'select',
+            options: options
+          }
+        end
+
+        def to_json
+          att_obj = {}
+
+          att_obj[:callback_id] = @callback_id
+
+          att_obj[:title] = title unless title.empty?
+          att_obj[:color] = color unless color.empty?
+          att_obj[:attachment_type] = attachment_type unless attachment_type.empty?
+          att_obj[:text] = text unless text.empty?
+          att_obj[:fallback] = fallback unless fallback.empty?
+          att_obj[:image_url] = image_url unless image_url.empty?
+
+          att_obj[:actions] = @actions unless @actions.empty?
+
+          att_obj
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/slack/helpers/slack_response.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative './slack_attachment'
+
+module Sinatra
+  module Slack
+    module Helpers
+      # Represents a message sent to the Slack Channel.
+      class SlackResponse
+        attr_accessor :text, :replace_original, :mrkdwn
+
+        def initialize(callback_id)
+          @callback_id = callback_id
+          @text = nil
+          @attachments = []
+          @replace_original = true
+          @mrkdwn = false
+        end
+
+        def attachment
+          return unless block_given?
+
+          attachment = Helpers::Attachment.new(@callback_id)
+          yield attachment
+          @attachments << attachment
+        end
+
+        def to_json
+          response = {}
+
+          response[:text] = @text if @text
+          response[:mrkdwn] = @mrkdwn
+          response[:replace_original] = @replace_original
+
+          response[:attachments] = @attachments.map(&:to_json) unless @attachments.empty?
+
+          response.to_json
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/slack/instance_helpers.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative './helpers/command_request'
+require_relative './helpers/channel'
+require_relative './helpers/slack_response'
+require_relative './helpers/action_request'
+
+module Sinatra
+  module Slack
+    # Instance level helper methods
+    module InstanceHelpers
+      def command
+        @command ||= Helpers::CommandRequest.new(params)
+      end
+
+      def action
+        @action ||= Helpers::ActionRequest.parse(params)
+      end
+
+      def channel
+        @channel ||= Helpers::Channel.parse(params)
+      end
+
+      def slack_response(callback_id)
+        s_resp = Helpers::SlackResponse.new(callback_id)
+        yield s_resp if block_given?
+        s_resp
+      end
+
+      def slack_error_notification
+        slack_response '' do |r|
+          r.text = 'Ups, something went wrong'
+        end
+      end
+
+      def handle_request(request_handler:, request_params:, quick_reply: '...')
+        EM.defer do
+          deferred_message = request_handler.bind(self).call(*request_params)
+          channel.send(deferred_message)
+        rescue StandardError => ex
+          logger.error ex.full_message
+          channel.send(slack_error_notification)
+        end
+
+        body quick_reply
+      end
+
+      # Checks for Slack defined HTTP headers
+      # and computes the request signature (HMAC). If provided signature
+      # is the same as the computed one, the request is valid.
+      #
+      # Go to this page for the verification process:
+      # https://api.slack.com/docs/verifying-requests-from-slack
+      def authorized?
+        logger.warn 'Missing Slack signing token' unless settings.slack_secret
+        return true unless settings.slack_secret
+
+        valid_headers? &&
+          compute_signature(settings.slack_secret) == slack_signature
+      end
+
+      # Helper methods for Slack request validation
+      def slack_signature
+        @slack_signature ||= env['HTTP_X_SLACK_SIGNATURE']
+      end
+
+      def slack_timestamp
+        @slack_timestamp ||= env['HTTP_X_SLACK_REQUEST_TIMESTAMP']
+      end
+
+      def valid_headers?
+        return false unless slack_signature || slack_timestamp
+
+        # The request timestamp is more than five minutes from local time.
+        # It could be a replay attack, so let's ignore it.
+        (Time.now.to_i - slack_timestamp.to_i).abs <= 60 * 5
+      end
+
+      def compute_signature(secret)
+        # in case someone already read it
+        request.body.rewind
+
+        # From Slack API docs, the "v0" is always fixed for now
+        sig_basestring = "v0:#{slack_timestamp}:#{request.body.read}"
+        "v0=#{hmac_signed(sig_basestring, secret)}"
+      end
+
+      def hmac_signed(to_sign, hmac_key)
+        sha256 = OpenSSL::Digest.new('sha256')
+        OpenSSL::HMAC.hexdigest(sha256, hmac_key, to_sign)
+      end
+    end
+  end
+end

data/lib/sinatra/slack/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sinatra
+  module Slack
+    VERSION = '0.8.0'
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-slack
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Nuno Namorado
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async_sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.4
+- !ruby/object:Gem::Dependency
+  name: mustermann
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+description: 
+email:
+- n.namorado@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/sinatra/slack.rb
+- lib/sinatra/slack/helpers/action_request.rb
+- lib/sinatra/slack/helpers/channel.rb
+- lib/sinatra/slack/helpers/command_request.rb
+- lib/sinatra/slack/helpers/slack_attachment.rb
+- lib/sinatra/slack/helpers/slack_response.rb
+- lib/sinatra/slack/instance_helpers.rb
+- lib/sinatra/slack/version.rb
+homepage: https://github.com/nunonamorado/sinatra-slack
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Create Slack apps with a simple Sinatra specific DSL
+test_files: []