slack_msgr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd274c89233b9e5903e49f7e4243a859f2e78c74
+  data.tar.gz: 7ba179fb4226cf6fafb36f6735c80b10daf28b3c
+SHA512:
+  metadata.gz: 1998160597b692ff67d57b2c6c794c6f3b807037c0da3186d6a5c6b4b46eb7caf1c70220dd8d08938b537fbae9078a06f305093a5efb99733ec8ce284fdb86ff
+  data.tar.gz: 227e030f4de7db7f7c0ed5134217e6594d1efa5f2b71011dae41010bc2898754cbe76e952426d9b27cf107c5f2566df82707e5796a430fe808927000e4bc9f1b

data/.codeclimate.yml

@@ -0,0 +1,8 @@
+---
+version: "2"
+plugins:
+  rubocop:
+    enabled: true
+    channel: rubocop-0-71
+  reek:
+    enabled: true

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.reek.yml

@@ -0,0 +1,132 @@
+---
+detectors:
+  Attribute:
+    enabled: true
+    exclude:
+    - Configuration
+  BooleanParameter:
+    enabled: true
+    exclude: []
+  ClassVariable:
+    enabled: true
+    exclude: []
+  ControlParameter:
+    enabled: true
+    exclude: []
+  DataClump:
+    enabled: true
+    exclude: []
+    max_copies: 2
+    min_clump_size: 2
+  DuplicateMethodCall:
+    enabled: true
+    exclude: []
+    max_calls: 1
+    allow_calls: []
+  FeatureEnvy:
+    enabled: true
+    exclude: []
+  InstanceVariableAssumption:
+    enabled: true
+    exclude: []
+  IrresponsibleModule:
+    enabled: true
+    exclude: []
+  LongParameterList:
+    enabled: true
+    exclude: []
+    max_params: 3
+    overrides:
+      initialize:
+        max_params: 5
+  LongYieldList:
+    enabled: true
+    exclude: []
+    max_params: 3
+  ManualDispatch:
+    enabled: true
+    exclude: []
+  MissingSafeMethod:
+    enabled: false
+    exclude:
+    - 'Configuration#clear!'
+  ModuleInitialize:
+    enabled: true
+    exclude: []
+  NestedIterators:
+    enabled: true
+    exclude: []
+    max_allowed_nesting: 1
+    ignore_iterators:
+    - tap
+  NilCheck:
+    enabled: true
+    exclude: []
+  RepeatedConditional:
+    enabled: true
+    exclude: []
+    max_ifs: 2
+  SubclassedFromCoreClass:
+    enabled: true
+    exclude: []
+  TooManyConstants:
+    enabled: true
+    exclude: []
+    max_constants: 5
+  TooManyInstanceVariables:
+    enabled: false
+    exclude: []
+    max_instance_variables: 4
+  TooManyMethods:
+    enabled: true
+    exclude: []
+    max_methods: 15
+  TooManyStatements:
+    enabled: true
+    exclude:
+    - initialize
+    - SlackMsgrHelpers
+    max_statements: 5
+  UncommunicativeMethodName:
+    enabled: true
+    exclude: []
+    reject:
+    - "/^[a-z]$/"
+    - "/[0-9]$/"
+    - "/[A-Z]/"
+    accept: []
+  UncommunicativeModuleName:
+    enabled: true
+    exclude: []
+    reject:
+    - "/^.$/"
+    - "/[0-9]$/"
+    accept: []
+  UncommunicativeParameterName:
+    enabled: true
+    exclude: []
+    reject:
+    - "/^.$/"
+    - "/[0-9]$/"
+    - "/[A-Z]/"
+    - "/^_/"
+    accept: []
+  UncommunicativeVariableName:
+    enabled: true
+    exclude: []
+    reject:
+    - "/^.$/"
+    - "/[0-9]$/"
+    - "/[A-Z]/"
+    accept:
+    - "/^_$/"
+  UnusedParameters:
+    enabled: true
+    exclude: []
+  UnusedPrivateMethod:
+    enabled: false
+    exclude: []
+  UtilityFunction:
+    enabled: true
+    exclude: []
+    public_methods_only: false

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,141 @@
+AllCops:
+  # Include common Ruby source files.
+  Include:
+    - '**/*.rb'
+    - '**/*.arb'
+    - '**/*.axlsx'
+    - '**/*.builder'
+    - '**/*.fcgi'
+    - '**/*.gemfile'
+    - '**/*.god'
+    - '**/*.jb'
+    - '**/*.jbuilder'
+    - '**/*.mspec'
+    - '**/*.opal'
+    - '**/*.pluginspec'
+    - '**/*.podspec'
+    - '**/*.rabl'
+    - '**/*.rake'
+    - '**/*.rbuild'
+    - '**/*.rbw'
+    - '**/*.rbx'
+    - '**/*.ru'
+    - '**/*.ruby'
+    - '**/*.spec'
+    - '**/*.thor'
+    - '**/*.watchr'
+    - '**/.irbrc'
+    - '**/.pryrc'
+    - '**/buildfile'
+    - '**/Appraisals'
+    - '**/Berksfile'
+    - '**/Brewfile'
+    - '**/Buildfile'
+    - '**/Capfile'
+    - '**/Cheffile'
+    - '**/Dangerfile'
+    - '**/Deliverfile'
+    - '**/Fastfile'
+    - '**/*Fastfile'
+    - '**/Guardfile'
+    - '**/Jarfile'
+    - '**/Mavenfile'
+    - '**/Podfile'
+    - '**/Puppetfile'
+    - '**/Rakefile'
+    - '**/Snapfile'
+    - '**/Thorfile'
+    - '**/Vagabondfile'
+    - '**/Vagrantfile'
+  Exclude:
+    - 'node_modules/**/*'
+    - 'vendor/**/*'
+    - '.git/**/*'
+    - 'Gemfile'
+    - 'slack_msgr.gemspec'
+    - 'spec/**/*'
+    - Rakefile
+    - bin/**
+
+Metrics/LineLength:
+  Description: 'Limit lines to 100 characters.'
+  StyleGuide: '#100-character-limits'
+  Enabled: true
+  Max: 100
+  # 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
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+  # The IgnoreCopDirectives option causes the LineLength rule to ignore cop
+  # directives like '# rubocop: enable ...' when calculating a line's length.
+  IgnoreCopDirectives: false
+  # The IgnoredPatterns option is a list of !ruby/regexp and/or string
+  # elements. Strings will be converted to Regexp objects. A line that matches
+  # any regular expression listed in this option will be ignored by LineLength.
+  IgnoredPatterns: []
+
+Naming/FileName:
+  Description: 'Use snake_case for source file names.'
+  StyleGuide: '#snake-case-files'
+  Enabled: true
+  # Camel case file names listed in `AllCops:Include` and all file names listed
+  # in `AllCops:Exclude` are excluded by default. Add extra excludes here.
+  Exclude: [slack_msgr.gemspec]
+  # When `true`, requires that each source file should define a class or module
+  # with a name which matches the file name (converted to ... case).
+  # It further expects it to be nested inside modules which match the names
+  # of subdirectories in its path.
+  ExpectMatchingDefinition: false
+  # If non-`nil`, expect all source file names to match the following regex.
+  # Only the file name itself is matched, not the entire file path.
+  # Use anchors as necessary if you want to match the entire name rather than
+  # just a part of it.
+  Regex: ~
+  # With `IgnoreExecutableScripts` set to `true`, this cop does not
+  # report offending filenames for executable scripts (i.e. source
+  # files with a shebang in the first line).
+  IgnoreExecutableScripts: true
+  AllowedAcronyms:
+    - CLI
+    - DSL
+    - ACL
+    - API
+    - ASCII
+    - CPU
+    - CSS
+    - DNS
+    - EOF
+    - GUID
+    - HTML
+    - HTTP
+    - HTTPS
+    - ID
+    - IP
+    - JSON
+    - LHS
+    - QPS
+    - RAM
+    - RHS
+    - RPC
+    - SLA
+    - SMTP
+    - SQL
+    - SSH
+    - TCP
+    - TLS
+    - TTL
+    - UDP
+    - UI
+    - UID
+    - UUID
+    - URI
+    - URL
+    - UTF8
+    - VM
+    - XML
+    - XMPP
+    - XSRF
+    - XSS

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 rdavid1099@gmail.com. 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/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in slack_msgr.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    slack_msgr (0.0.1)
+      faraday (~> 0.15.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    equalizer (0.0.11)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.2)
+    json (2.2.0)
+    kwalify (0.7.2)
+    method_source (0.9.2)
+    multipart-post (2.1.1)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    reek (5.4.0)
+      codeclimate-engine-rb (~> 0.4.0)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.7, != 2.5.1.1)
+      psych (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    unicode-display_width (1.6.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  pry
+  rake (~> 10.0)
+  reek (~> 5.4.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.71.0)
+  simplecov
+  slack_msgr!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ryan Workman
+
+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,77 @@
+# SlackMsgr
+
+[![Build Status](https://semaphoreci.com/api/v1/rworkman1099/slack-msgr/branches/master/badge.svg)](https://semaphoreci.com/rworkman1099/slack-msgr)
+[![Maintainability](https://api.codeclimate.com/v1/badges/b0b292347eea43d4c414/maintainability)](https://codeclimate.com/github/rdavid1099/slack-msgr/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/b0b292347eea43d4c414/test_coverage)](https://codeclimate.com/github/rdavid1099/slack-msgr/test_coverage)
+
+Under construction 🚧 Release is still in very early development. Limited, basic functionality is available.
+
+## Requirements
+* Ruby >= 2.3
+
+SlackMsgr depends on these other gems for usage at runtime:
+* [Faraday](https://github.com/lostisland/faraday) handles requests to and from [SlackAPI](https://api.slack.com/)
+
+## Installation
+Add the following line to a Gemfile:
+
+    gem 'slack_msgr'
+
+and run `bundle install` from your shell.
+
+If you use Rubygems, run this command manually from your shell to install the latest poke-api-v2 version:
+
+    gem install slack_msgr
+
+## Configuration
+This gem must be configured with credentials provided by Slack. _NOTE: These tokens are secret and given uniquely to you to access your workspace. It is strongly advised to store these in an environment variable and not directly in your configuration file._
+
+### Using Rails
+If you are using this gem with a Rails project, create an initializer file.
+
+```ruby
+# ./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'
+end
+```
+
+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
+_SlackMsgr is still in the early stages of development and has limited functionality. Please refer to the [issues](https://github.com/rdavid1099/slack-msgr/issues) for future development and if you would like to help out._
+
+SlackMsgr follows SlackAPI's patterns for methods and functionality. Posting a message in Slack using its API, for example, requires making a `POST` request to `https://slack.com/api/chat.postMessage`. You can execute this identical functionality in SlackMsgr by calling `SlackMsgr.chat(:post_message)`. A `POST` request to `https://slack.com/api/channels.info` would simply be `SlackMsgr.channels(:info)`. Please refer to the list of available functions below for a complete summary of what is built out in this early stage of development.
+
+### SlackMsgr#chat
+All options passed to a chat function follow the patterns and arguments described by the [SlackAPI Documentation](https://api.slack.com/methods). SlackMsgr uses the `bot_user_oauth_access_token` passed in the configuration to send out the messages. At this moment, only one `bot_user_oauth_access_token` can be configured at a time and there is no way to send a message as one user and then send a consecutive message as a different user. This functionality will be built out in the future.
+
+Available functions:
+- `:post_message`: [chat.postMessage SlackAPI Docs](https://api.slack.com/methods/chat.postMessage)
+
+```ruby
+SlackMsgr.chat(:post_message, channel: 'announcements', text: 'Hello world')
+# Sends the text 'Hello world' to the announcements channel
+
+SlackMsgr.chat(:post_message, {
+  channel: "C1H9RESGL",
+  text: "Here's a message for you",
+  as_user: false,
+  username: "testing",
+  attachments: [{
+    text: "This is an attachment",
+    id: 1,
+    fallback: "This is an attachment's fallback"
+  }]
+})
+# Sends a message with an attachment as a user with the username 'testing'
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slack_msgr"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/config/constants.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SlackMsgr
+  GITHUB_REPO = 'https://github.com/rdavid1099/slack-msgr'
+
+  SLACK_URL = 'https://slack.com'
+
+  VERSION = '0.0.1'
+end

data/lib/config/initializer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'faraday'
+require_relative './constants'
+
+Dir[File.expand_path 'lib/{slack_msgr,utils}/**/*.rb'].each { |f| require f }

data/lib/slack_msgr/chat.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module SlackMsgr
+  # Handles all chat functionality and methods corresponding with Slack API
+  class Chat < SlackMethod
+    CHAT_METHODS = { post_message: 'postMessage' }.freeze
+
+    REQUIRED_ARGUMENTS = %i[channel text].freeze
+
+    PERMITTED_ARGUMENTS = %i[
+      token
+      channel
+      text
+      as_user
+      attachments
+      blocks
+      icon_emoji
+      icon_url
+      link_names
+      mrkdwn
+      parse
+      reply_broadcast
+      thread_ts
+      unfurl_links
+      unfurl_media
+      username
+    ].freeze
+
+    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
+      end
+    end
+
+    attr_reader :method,
+                :opts,
+                :body
+
+    def initialize(method, opts)
+      chat_method = CHAT_METHODS[method]
+      ErrorHandling.raise(:unknown_method, method: method) unless chat_method
+
+      @method = "chat.#{chat_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? # rubocop:disable LineLength
+      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/configuration.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SlackMsgr
+  # Configuration class handling config variables set on launch
+  class Configuration
+    attr_accessor :verification_token,
+                  :client_secret,
+                  :signing_secret,
+                  :oauth_access_token,
+                  :bot_user_oauth_access_token
+
+    def initialize(
+      verification_token: nil,
+      client_secret: nil,
+      signing_secret: nil,
+      oauth_access_token: nil,
+      bot_user_oauth_access_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
+    end
+
+    def clear!
+      @verification_token          = nil
+      @client_secret               = nil
+      @signing_secret              = nil
+      @oauth_access_token          = nil
+      @bot_user_oauth_access_token = nil
+    end
+  end
+end

data/lib/slack_msgr/fetcher.rb

@@ -0,0 +1,22 @@
+# 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

data/lib/slack_msgr.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative './config/initializer'
+
+# Main module housing all classes, modules and methods for SlackMsgr
+module SlackMsgr
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def chat(method, opts = {})
+      Chat.call(method, opts)
+    end
+  end
+end

data/lib/utils/error_handling.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module SlackMsgr
+  # Handles all chat functionality and methods corresponding with Slack API
+  module ErrorHandling
+    class << self
+      def raise(error_type, opts = {})
+        err = send(error_type, opts)
+
+        Kernel.raise err[:exception], err[:message]
+      end
+
+      def unknown_method(opts)
+        {
+          exception: NoMethodError,
+          message: "Method not found: #{opts[:method] || 'unknown_method'} does not exist\n" \
+            "If you would like this method added, please add an issue at #{GITHUB_REPO}"
+        }
+      end
+
+      def configuration_error(_opts)
+        {
+          exception: ConfigurationError,
+          message: "Error with configruation: oauth_access_token not found\n" \
+            'Be sure to configure all tokens and secrets'
+        }
+      end
+
+      def req_args_missing(opts)
+        {
+          exception: ArgumentError,
+          message: "Required arguments missing: Method #{opts[:method]} requires arguments:\n" \
+            "[ #{opts[:req_args].join(', ')} ] Refer to https://api.slack.com/methods/"
+        }
+      end
+    end
+  end
+end
+
+# Define custom error class for more descriptive exceptions
+class ConfigurationError < StandardError
+end

data/slack_msgr.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require './lib/config/constants'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'slack_msgr'
+  spec.version       = SlackMsgr::VERSION
+  spec.authors       = ['Ryan Workman']
+  spec.email         = ['rdavid1099@gmail.com']
+
+  spec.summary       = %q{A Ruby gem to send and receive messages through Slack}
+  spec.description   = %q{A Ruby gem to send and receive messages through Slack}
+  spec.homepage      = 'https://github.com/rdavid1099/slack-msgr'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/rdavid1099/slack_msgr'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  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 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.71.0'
+  spec.add_development_dependency 'reek', '~> 5.4.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: slack_msgr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Workman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.71.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.71.0
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby gem to send and receive messages through Slack
+email:
+- rdavid1099@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/config/constants.rb
+- lib/config/initializer.rb
+- lib/slack_msgr.rb
+- lib/slack_msgr/chat.rb
+- lib/slack_msgr/configuration.rb
+- lib/slack_msgr/fetcher.rb
+- lib/utils/error_handling.rb
+- slack_msgr.gemspec
+homepage: https://github.com/rdavid1099/slack-msgr
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rdavid1099/slack-msgr
+  source_code_uri: https://github.com/rdavid1099/slack_msgr
+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.6.14
+signing_key: 
+specification_version: 4
+summary: A Ruby gem to send and receive messages through Slack
+test_files: []