slack_msgr 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67ff0e3f7b3a1f928d175cb1fa15d74bf612c6b1
-  data.tar.gz: 3d07152341f8ea05c91b3df0e7827e7714a726c0
+  metadata.gz: a2a6986eb6b25c10e5c937d6f72f7716489ce77e
+  data.tar.gz: 4882906275e2a2781e11c6b07067351ed6b2cc66
 SHA512:
-  metadata.gz: 546f9af207d3c971fe87aa5c5586f01059d1d97a3afcc005ed32beede73db388c0ff04861ce3ae769c306f7149a36eea414a56e886a2016af2e2e0c38b225b8d
-  data.tar.gz: c781083423b3282ffb92d8bf8cf7f61648d2ed2da18c1e4cc943b9fea35dec4c69e3bd0233b5e8ef1e32c610af82fdbd7f20286fefcb5300c1d9ff71902f18cf
+  metadata.gz: 326e481ccb93330fb19b0d0fbe261dd83212b50ea84b2e0b0612e6cc3a91a98de8e7f48dd6269dbc2b3da61d68d8893416b192fb421f7909d9cc57764d8c0d14
+  data.tar.gz: 6c0ef937c0b433390fb2291c067d689e24469333a47d969a9baa01f92a3378d22ea206192aae92699fdf7c842421d9c38a7a35364fc946d6a4961db5d6651199

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slack_msgr (0.0.2)
+    slack_msgr (0.0.4)
       faraday (~> 0.15.4)
 
 GEM

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.2'
+  VERSION = '0.0.4'
 end

data/lib/config/initializer.rb

@@ -6,7 +6,7 @@ require_relative './constants'
 
 path = __dir__
 
-require "#{path}/../slack_msgr/fetcher"
+require "#{path}/../slack_msgr/slack_method"
 require "#{path}/../slack_msgr/chat"
 require "#{path}/../slack_msgr/configuration"
 require "#{path}/../utils/error_handling"

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
 

data/lib/slack_msgr/configuration.rb

@@ -6,29 +6,46 @@ module SlackMsgr
     attr_accessor :verification_token,
                   :client_secret,
                   :signing_secret,
-                  :oauth_access_token,
-                  :bot_user_oauth_access_token
+                  :access_tokens,
+                  :set_default_token
 
     def initialize(
       verification_token: nil,
       client_secret: nil,
       signing_secret: nil,
-      oauth_access_token: nil,
-      bot_user_oauth_access_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
+      @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
+      @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/slack_method.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module SlackMsgr
+  # Handles all requests with Slack API
+  class SlackMethod
+    class << self
+      private
+
+      attr_reader :conn
+
+      def establish_connection(given_token = nil)
+        @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
+        conn.authorization :Bearer, SlackMsgr.configuration.oauth_access_token(given_token)
+      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)
+        establish_connection(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
+    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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_msgr
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Ryan Workman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-03 00:00:00.000000000 Z
+date: 2019-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -147,7 +147,7 @@ files:
 - lib/slack_msgr.rb
 - lib/slack_msgr/chat.rb
 - lib/slack_msgr/configuration.rb
-- lib/slack_msgr/fetcher.rb
+- lib/slack_msgr/slack_method.rb
 - lib/utils/error_handling.rb
 - slack_msgr.gemspec
 homepage: https://github.com/rdavid1099/slack-msgr

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