slack_msgr 0.0.1 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fd274c89233b9e5903e49f7e4243a859f2e78c74
-  data.tar.gz: 7ba179fb4226cf6fafb36f6735c80b10daf28b3c
+SHA256:
+  metadata.gz: 4e8ddbcbfbd549eb2c4ab898505896bf2d99ad950b1dda24167c4c7b0af2274f
+  data.tar.gz: 2d9f90f36aa0cc306ddf6b968b89cdf2280a41ef72b222ac00356c3fe685562b
 SHA512:
-  metadata.gz: 1998160597b692ff67d57b2c6c794c6f3b807037c0da3186d6a5c6b4b46eb7caf1c70220dd8d08938b537fbae9078a06f305093a5efb99733ec8ce284fdb86ff
-  data.tar.gz: 227e030f4de7db7f7c0ed5134217e6594d1efa5f2b71011dae41010bc2898754cbe76e952426d9b27cf107c5f2566df82707e5796a430fe808927000e4bc9f1b
+  metadata.gz: e8ee2351b8481befbd89f910b0f48855d5dfde409ac4611f7121de5311f2e7021b2553813f280539bdec5c17a208631f0e50c667766e443168ebb4475d72882b
+  data.tar.gz: 83810c251a1b51364de4d0f51ac216e3ceba00ee5f4a47a1a4d33dc35d88facc61826243212d11f9959acf12e099a20f686c1af6354aa6b43c12c9280459b570

data/.rubocop.yml

@@ -58,10 +58,10 @@ AllCops:
     - bin/**
 
 Metrics/LineLength:
-  Description: 'Limit lines to 100 characters.'
-  StyleGuide: '#100-character-limits'
+  Description: 'Limit lines to 120 characters.'
+  StyleGuide: '#120-character-limits'
   Enabled: true
-  Max: 100
+  Max: 120
   # To make it possible to copy or click on URIs in the code, we allow lines
   # containing a URI to be longer than Max.
   AllowHeredoc: true

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slack_msgr (0.0.1)
+    slack_msgr (0.0.7)
       faraday (~> 0.15.4)
 
 GEM
@@ -26,7 +26,7 @@ GEM
       multipart-post (>= 1.2, < 3)
     ice_nine (0.11.2)
     jaro_winkler (1.5.2)
-    json (2.2.0)
+    json (2.3.1)
     kwalify (0.7.2)
     method_source (0.9.2)
     multipart-post (2.1.1)
@@ -38,7 +38,7 @@ GEM
       method_source (~> 0.9.0)
     psych (3.1.0)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
     reek (5.4.0)
       codeclimate-engine-rb (~> 0.4.0)
       kwalify (~> 0.7.0)
@@ -85,7 +85,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   pry
-  rake (~> 10.0)
+  rake (~> 13.0)
   reek (~> 5.4.0)
   rspec (~> 3.0)
   rubocop (~> 0.71.0)

data/README.md

@@ -33,14 +33,30 @@ If you are using this gem with a Rails project, create an initializer file.
 # ./config/initializers/slack_msgr.rb
 
 SlackMsgr.configure do |config|
-  config.verification_token          = '1a2b3c4d5e'
-  config.client_secret               = 'a1b2c3d4e5'
-  config.signing_secret              = 'aa11bb22cc3'
-  config.oauth_access_token          = 'xoxp-1234567-xxxxxxxxx'
-  config.bot_user_oauth_access_token = 'xoxb-1234567-xxxxxxxxx'
+  config.verification_token = '1a2b3c4d5e'
+  config.client_secret      = 'a1b2c3d4e5'
+  config.signing_secret     = 'aa11bb22cc3'
+  config.access_tokens      = {
+    bot: 'xoxp-1234567-xxxxxxxxx',
+    me: 'xoxb-1234567-xxxxxxxxx'
+  }
 end
 ```
 
+_NOTE_: All access tokens are configured as a hash. The name of the keys are arbitrary, and there is no limit to keys that can be configured.
+
+Multiple oauth tokens can be used during a single session. Oauth tokens are declared in the method execution. For example, considering the configuration above, to use the token attached to the key `:me` simply pass the parameter `use_token: :me`.
+
+```ruby
+SlackMsgr.chat(:post_message,
+  use_token: :me,
+  channel: 'announcements',
+  text: 'Hello world'
+)
+```
+
+SlackMsgr will try to use a default token if a method is called without declaring `use_token:`. SlackMsgr takes the first token in the `access_tokens` hash as a default.
+
 If you are using this gem outside of a Rails project, follow the configuration pattern above, but be sure to run this code before using any functionality of the gem.
 
 ## Usage
@@ -59,6 +75,7 @@ SlackMsgr.chat(:post_message, channel: 'announcements', text: 'Hello world')
 # Sends the text 'Hello world' to the announcements channel
 
 SlackMsgr.chat(:post_message, {
+  use_token: :bot,
   channel: "C1H9RESGL",
   text: "Here's a message for you",
   as_user: false,
@@ -69,7 +86,7 @@ SlackMsgr.chat(:post_message, {
     fallback: "This is an attachment's fallback"
   }]
 })
-# Sends a message with an attachment as a user with the username 'testing'
+# Sends a message with an attachment using the oauth token configured for :bot as a user with the username 'testing'
 ```
 
 ## License

data/lib/config/constants.rb

@@ -5,5 +5,5 @@ module SlackMsgr
 
   SLACK_URL = 'https://slack.com'
 
-  VERSION = '0.0.1'
+  VERSION = '0.0.7'
 end

data/lib/config/initializer.rb

@@ -2,6 +2,15 @@
 
 require 'json'
 require 'faraday'
+require 'uri'
 require_relative './constants'
 
-Dir[File.expand_path 'lib/{slack_msgr,utils}/**/*.rb'].each { |f| require f }
+path = __dir__
+
+require "#{path}/../slack_msgr/slack_method"
+require "#{path}/../slack_msgr/authenticate"
+require "#{path}/../slack_msgr/chat"
+require "#{path}/../slack_msgr/configuration"
+require "#{path}/../slack_msgr/conversations"
+require "#{path}/../slack_msgr/users"
+require "#{path}/../utils/error_handling"

data/lib/slack_msgr.rb

@@ -11,10 +11,19 @@ module SlackMsgr
 
     def configure
       yield(configuration)
+      nil
     end
 
     def chat(method, opts = {})
       Chat.call(method, opts)
     end
+
+    def users(*methods, **opts)
+      Users.call(methods, opts)
+    end
+
+    def conversations(method, **opts)
+      Conversations.call(method, opts)
+    end
   end
 end

data/lib/slack_msgr/authenticate.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module SlackMsgr
+  # Handles various authentication patterns offered by Slack
+  class Authenticate
+    class << self
+      def verification_token?(token)
+        token == SlackMsgr.configuration.verification_token
+      end
+
+      def signing_secret?(request)
+        signature = request.headers['X-Slack-Signature']
+        timestamp = request.headers['X-Slack-Request-Timestamp']
+        version   = signature.split('=').first
+        body      = request.body.read
+
+        # The request timestamp is more than five minutes from local time.
+        # It could be a replay attack, so let's ignore it.
+        return false if timestamp_over_five_minutes_old?(timestamp)
+
+        signature == "#{version}=#{compute_hash_sha256(version, timestamp, body)}"
+      end
+
+      private
+
+      def compute_hash_sha256(version, timestamp, body)
+        digest = OpenSSL::Digest::SHA256.new
+        OpenSSL::HMAC.hexdigest(digest, SlackMsgr.configuration.signing_secret, "#{version}:#{timestamp}:#{body}")
+      end
+
+      def timestamp_over_five_minutes_old?(timestamp)
+        (Time.now - Time.at(timestamp.to_i)) > (60 * 5)
+      end
+    end
+  end
+end

data/lib/slack_msgr/chat.rb

@@ -29,12 +29,7 @@ module SlackMsgr
     class << self
       def call(method, opts = {})
         chat = new(method, opts)
-
-        conn.post do |req|
-          req.url "/api/#{chat.method}"
-          req.headers['Content-Type'] = 'application/json; charset=utf-8'
-          req.body = chat.body
-        end
+        send_post_request_to_slack(chat)
       end
     end
 
@@ -54,7 +49,8 @@ module SlackMsgr
     private
 
     def sanitize_body
-      ErrorHandling.raise(:req_args_missing, req_args: REQUIRED_ARGUMENTS, method: method) if req_args_missing? # rubocop:disable LineLength
+      ErrorHandling.raise(:req_args_missing, req_args: REQUIRED_ARGUMENTS, method: method) if req_args_missing?
+
       opts.keys.each_with_object({}) do |key, body|
         body[key] ||= opts[key] if PERMITTED_ARGUMENTS.include?(key)
         body

data/lib/slack_msgr/configuration.rb

@@ -6,29 +6,50 @@ module SlackMsgr
     attr_accessor :verification_token,
                   :client_secret,
                   :signing_secret,
-                  :oauth_access_token,
-                  :bot_user_oauth_access_token
+                  :legacy_token,
+                  :access_tokens,
+                  :set_default_token
 
-    def initialize(
+    def initialize( # rubocop:disable Metrics/ParameterLists
       verification_token: nil,
       client_secret: nil,
       signing_secret: nil,
-      oauth_access_token: nil,
-      bot_user_oauth_access_token: nil
+      legacy_token: nil,
+      access_tokens: {},
+      set_default_token: nil
     )
-      @verification_token          = verification_token
-      @client_secret               = client_secret
-      @signing_secret              = signing_secret
-      @oauth_access_token          = oauth_access_token
-      @bot_user_oauth_access_token = bot_user_oauth_access_token
+      @verification_token = verification_token
+      @client_secret      = client_secret
+      @signing_secret     = signing_secret
+      @legacy_token       = legacy_token
+      @access_tokens      = access_tokens
+      @set_default_token  = set_default_token
     end
 
     def clear!
-      @verification_token          = nil
-      @client_secret               = nil
-      @signing_secret              = nil
-      @oauth_access_token          = nil
-      @bot_user_oauth_access_token = nil
+      @verification_token = nil
+      @client_secret      = nil
+      @signing_secret     = nil
+      @legacy_token       = nil
+      @access_tokens      = {}
+      @set_default_token  = nil
+      @default_token      = nil
+    end
+
+    def default_token
+      @default_token ||= initialize_default_token
+    end
+
+    def initialize_default_token
+      return unless access_tokens&.first
+
+      access_tokens[set_default_token] || access_tokens.first[1]
+    end
+
+    def oauth_access_token(given_token)
+      token = access_tokens[given_token] || default_token
+      ErrorHandling.raise(:configuration_error) unless token
+      token
     end
   end
 end

data/lib/slack_msgr/conversations.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module SlackMsgr
+  # Handles all conversations functionality and methods corresponding with Slack API
+  class Conversations < SlackMethod
+    CONVERSATIONS_METHODS = { open: 'open' }.freeze
+
+    REQUIRED_ARGUMENTS = %i[token users].freeze
+
+    PERMITTED_ARGUMENTS = %i[token channel return_im users].freeze
+
+    class << self
+      def call(method, opts = {})
+        chat = new(method, opts)
+        send_post_request_to_slack(chat)
+      end
+    end
+
+    attr_reader :method,
+                :opts,
+                :body
+
+    def initialize(method, opts)
+      conversations_method = CONVERSATIONS_METHODS[method]
+      ErrorHandling.raise(:unknown_method, method: method) unless conversations_method
+
+      @method = "conversations.#{conversations_method}"
+      @opts   = opts
+      @body   = sanitize_body
+    end
+
+    private
+
+    def sanitize_body
+      ErrorHandling.raise(:req_args_missing, req_args: REQUIRED_ARGUMENTS, method: method) if req_args_missing?
+
+      opts.keys.each_with_object({}) do |key, body|
+        body[key] ||= opts[key] if PERMITTED_ARGUMENTS.include?(key)
+        body
+      end.to_json
+    end
+
+    def req_args_missing?
+      !(REQUIRED_ARGUMENTS - opts.keys).empty?
+    end
+  end
+end

data/lib/slack_msgr/slack_method.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SlackMsgr
+  # Handles all requests with Slack API
+  class SlackMethod
+    class << self
+      private
+
+      def conn
+        @conn ||= Faraday.new(url: SLACK_URL) do |config|
+          config.request  :url_encoded             # form-encode POST params
+          config.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+        end
+      end
+
+      def conceal(token)
+        token.split('Bearer ').last[0..-6].gsub(/[a-zA-Z0-9]/, 'X') + token[-5..-1]
+      end
+
+      def add_metadata_to_response(response)
+        JSON.parse(response.body, symbolize_names: true)
+            .merge!(auth_token: conceal(conn.headers['Authorization']))
+      end
+
+      def send_post_request_to_slack(obj)
+        conn.authorization :Bearer, SlackMsgr.configuration.oauth_access_token(obj.opts[:use_token])
+        response = conn.post do |req|
+          req.url "/api/#{obj.method}"
+          req.headers['Content-Type'] = 'application/json; charset=utf-8'
+          req.body = obj.body
+        end
+        add_metadata_to_response(response)
+      end
+
+      def send_legacy_request_to_slack(obj)
+        conn.authorization :Bearer, SlackMsgr.configuration.legacy_token
+        response = conn.post do |req|
+          req.url "/api/#{obj.method}"
+          req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+          req.body = URI.encode_www_form(obj.body)
+        end
+        JSON.parse(response.body, symbolize_names: true)
+      end
+    end
+  end
+end

data/lib/slack_msgr/users.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module SlackMsgr
+  # Handles all users functionality and methods corresponding with Slack API
+  class Users < SlackMethod
+    USERS_METHODS = {
+      admin: 'admin',
+      invite: 'invite'
+    }.freeze
+
+    REQUIRED_ARGUMENTS = %i[email].freeze
+
+    PERMITTED_ARGUMENTS = %i[
+      token
+      email
+      channels
+      real_name
+      resend
+      restricted
+      ultra_restricted
+      expiration_ts
+    ].freeze
+
+    class << self
+      def call(method, opts = {})
+        users = new(method, opts)
+        send_legacy_request_to_slack(users)
+      end
+    end
+
+    attr_reader :method,
+                :opts,
+                :body
+
+    def initialize(methods, opts)
+      users_method = methods.map do |method|
+        ErrorHandling.raise(:unknown_method, method: method) unless USERS_METHODS[method]
+
+        USERS_METHODS[method]
+      end.join('.')
+
+      @method = "users.#{users_method}"
+      @opts   = opts
+      @body   = sanitize_body
+    end
+
+    private
+
+    def sanitize_body
+      ErrorHandling.raise(:req_args_missing, req_args: REQUIRED_ARGUMENTS, method: method) if req_args_missing?
+
+      opts.merge!(token).keys.each_with_object({}) do |key, body|
+        body[key] ||= opts[key] if PERMITTED_ARGUMENTS.include?(key)
+        body
+      end
+    end
+
+    def req_args_missing?
+      !(REQUIRED_ARGUMENTS - opts.keys).empty?
+    end
+
+    def token
+      { token: SlackMsgr.configuration.legacy_token }
+    end
+  end
+end

data/lib/utils/error_handling.rb

@@ -21,8 +21,8 @@ module SlackMsgr
       def configuration_error(_opts)
         {
           exception: ConfigurationError,
-          message: "Error with configruation: oauth_access_token not found\n" \
-            'Be sure to configure all tokens and secrets'
+          message: "Error with configruation: access_tokens not found\n" \
+            'At least one oauth token must be configured using access_tokens'
         }
       end
 

data/slack_msgr.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday', '~>0.15.4'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.71.0'
   spec.add_development_dependency 'reek', '~> 5.4.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_msgr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.7
 platform: ruby
 authors:
 - Ryan Workman
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-07-03 00:00:00.000000000 Z
+date: 2020-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -134,6 +134,7 @@ files:
 - ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".tool-versions"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -145,9 +146,12 @@ files:
 - lib/config/constants.rb
 - lib/config/initializer.rb
 - lib/slack_msgr.rb
+- lib/slack_msgr/authenticate.rb
 - lib/slack_msgr/chat.rb
 - lib/slack_msgr/configuration.rb
-- lib/slack_msgr/fetcher.rb
+- lib/slack_msgr/conversations.rb
+- lib/slack_msgr/slack_method.rb
+- lib/slack_msgr/users.rb
 - lib/utils/error_handling.rb
 - slack_msgr.gemspec
 homepage: https://github.com/rdavid1099/slack-msgr
@@ -156,7 +160,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/rdavid1099/slack-msgr
   source_code_uri: https://github.com/rdavid1099/slack_msgr
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -171,9 +175,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A Ruby gem to send and receive messages through Slack
 test_files: []

data/lib/slack_msgr/fetcher.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module SlackMsgr
-  # Handles all requests with Slack API
-  class SlackMethod
-    class << self
-      private
-
-      def conn
-        oauth_access_token = SlackMsgr.configuration.oauth_access_token
-        ErrorHandling.raise(:configuration_error) unless oauth_access_token
-
-        faraday = Faraday.new(url: SLACK_URL) do |config|
-          config.request  :url_encoded             # form-encode POST params
-          config.adapter  Faraday.default_adapter  # make requests with Net::HTTP
-        end
-        faraday.authorization :Bearer, oauth_access_token
-        faraday
-      end
-    end
-  end
-end