slack_messaging 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca6013870004fd4decf9af498cf20bc295923da1e8bb8d3889bf99a5cab01238
-  data.tar.gz: 91ec19a2846a14b64f795869287e7efadb1698b75e1e0106beed8980e5e8ddb6
+  metadata.gz: db2a04a6f53bd5e7d0d1017fe6fd5f6c715cc89d108be3dad1eb3a433f944be0
+  data.tar.gz: 5487fbcfcf279a48911d773c928826b8f7b2e021710d457c0fa256fa1660562e
 SHA512:
-  metadata.gz: 1e9629551ca1a2c7217821c65d5959ae309e1600693053880e795d5def9832bcc993a1e9261e2c55c784819983c1d86efd7a00c48e81d8962bb58e1cdcff1d43
-  data.tar.gz: eb23b41374af3df2f755413b48eb6a6cbf619370503e0a764332d7acf0a3dd3939185eca7acfe53273b970fcb2f54c009317a50e5826cdd4fa2c10eaee71b39e
+  metadata.gz: 76485ac006bb26c047e57e06283ced474b36c5924229dbd58b83a3ea8e2e30e92e8ca916fb7fd24b538ad235a54f427f29e03e4f1dcff382b57eb69d7b71e578
+  data.tar.gz: fe229444fe0b9a050d29a6b8c2fc653f287b85d49f965efc76cc81b5f7f3eb677fd79376a0fff012460febc1cd61d4896e9b6f0cf2098557b7a34130de155c42

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    slack_messaging (2.0.0.pre.test)
+      activesupport (~> 6.0)
+      gli (~> 2.10)
+      hashie (~> 4.1)
+      highline (~> 2.0)
+      httparty
+      json
+      rack (~> 2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    faker (2.14.0)
+      i18n (>= 1.6, < 2)
+    ffi (1.13.1)
+    formatador (0.2.5)
+    gli (2.19.2)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashie (4.1.0)
+    highline (2.0.3)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    json (2.3.1)
+    listen (3.3.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    minitest (5.14.2)
+    multi_xml (0.6.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
+    rake (13.0.1)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    shellany (0.0.1)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  faker
+  guard-rspec (~> 4.3)
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.9)
+  slack_messaging!
+
+BUNDLED WITH
+   2.1.4

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'bundle exec rspec', all_on_start: true, all_after_pass: true  do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

data/{LICENSE.txt → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Elliot Hursh
+Copyright (c) 2014 Emma Sax
 
 MIT License
 

data/README.md

@@ -1,4 +1,4 @@
-# Slack Messaging [![Maintainability](https://api.codeclimate.com/v1/badges/3ba7d6cc8633165b845a/maintainability)](https://codeclimate.com/github/emma-sax4/slack_messaging/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/3ba7d6cc8633165b845a/test_coverage)](https://codeclimate.com/github/emma-sax4/slack_messaging/test_coverage) [![Build Status](https://travis-ci.org/emma-sax4/slack_messaging.svg?branch=master)](https://travis-ci.org/emma-sax4/slack_messaging)
+# Slack Messaging [![Maintainability](https://api.codeclimate.com/v1/badges/c74baada70ad96048dc7/maintainability)](https://codeclimate.com/github/emmasax4/slack_messaging/maintainability) ![Default](https://github.com/emmasax4/slack_messaging/workflows/Default/badge.svg)
 
 This is a simple project designed to post messages to a given Slack channel as a bot.
 
@@ -12,11 +12,15 @@ gem 'slack_messaging'
 
 And then execute:
 
-    $ bundle
+```bash
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install slack_messaging
+```bash
+gem install slack_messaging
+```
 
 ### Usage
 
@@ -24,15 +28,17 @@ This project requires a config file that should look like this:
 
 ```
 slack:
-  channel: "#[AWESOME CHANNEL NAME]"
-  username: [AWESOME USER NAME]
-  webhook_url: [WEBHOOK URL]
-  icon_emoji: ":[SOME EMOJI]:"
+  channel: "#<AWESOME CHANNEL NAME>"
+  username: <AWESOME USER NAME>
+  webhook_url: <WEBHOOK URL>
+  icon_emoji: ":<SOME EMOJI>:"
 ```
 
 The default is for the file to be named `~/.slack_messaging.yml`, but a different path can be passed in like this:
 
-    $ slack-messaging --config="/PATH/TO/FILE/config.yml" slack
+```
+$ slack-messaging --config="/PATH/TO/FILE/config.yml" slack
+```
 
 To obtain the webhook url, go to [this link](https://api.slack.com/incoming-webhooks).
 
@@ -44,7 +50,7 @@ To print a friendly message to Slack, run:
 slack-messaging slack
 ```
 
-from the main directory. Here, no specific message is being given to print to Slack, so slack_messaging will choose a random quote, which are all defined in [`lib/slack_messaging/random_message.rb`](https://github.com/emma-sax4/slack_messaging/blob/master/lib/slack_messaging/random_message.rb). Feel free to change the messages or add more to cater what you'd like slack_messaging to say.
+from the main directory. Here, no specific message is being given to print to Slack, so slack_messaging will choose a random quote. The random quotes are selected using the [Quotable API](http://api.quotable.io/).
 
 However, what if you wanted to print something specific? Well, you can! Just run:
 
@@ -60,25 +66,31 @@ slack-messaging slack "MESSAGE 1" "MESSAGE 2" "MESSAGE 3" ... "MESSAGE N"
 
 The output of slack_messaging will look something like this:
 
-<img src="https://github.com/emma-sax4/slack_messaging/blob/master/OutputFile.png" width="1000">
+<img src="https://github.com/emmasax4/slack_messaging/blob/main/OutputFile.png" width="1000">
 
 I hope you enjoy printing fun and specialized messages to Slack!
 
 ### Tests
 
-To run the tests, run `rspec` from the command line. Travis CI will also run the tests upon every commit to make sure they're up to date and that everything is working correctly. There are currently only tests for the `notify_slack` and `random_message` classes. Feel free to help us add more!
+To run the tests, run `bundle exec rspec` from the command line. GitHub Actions will also run the tests upon every commit to make sure they're up to date and that everything is working correctly. Locally, you can also run `bundle exec guard` to automatically run tests as you develop! There are currently only tests for the `notify_slack` and `random_message` classes. Feel free to help us add more!
+
+## Contributing
 
-### RubyGems
-To make a new version and push to RubyGems:
+To submit a feature request, bug ticket, etc, please submit an official [GitHub Issue](https://github.com/emmasax4/slack_messaging/issues/new).
 
-1. Update the CHANGELOG.markdown with the new version and changes made
+To report any security vulnerabilities, please view this project's [Security Policy](https://github.com/emmasax4/slack_messaging/security/policy).
 
-3. Run `git add -A && git commit -m "Updating Changelog for [version number]"`
+This repository does have a standard [Code of Conduct](https://github.com/emmasax4/slack_messaging/blob/main/.github/code_of_conduct.md).
 
-2. Update `lib/slack_messaging/version.rb` with the new version number
+## Releasing
 
-4. Run `git add -A && git commit -m "Version Bump" && git push`
+To make a new release of this gem:
 
-5. Run `gem build slack_messaging.gemspec && gem push *.gem`
+1. Merge the pull request via the big green button
+2. Run `git tag vX.X.X` and `git push --tag`
+3. Make a new release [here](https://github.com/emmasax4/slack_messaging/releases/new)
+4. Run `gem build *.gemspec`
+5. Run `gem push *.gem` to push the new gem to RubyGems
+6. Run `rm *.gem` to clean up your local repository
 
-6. Run `rm *.gem`
+To set up your local machine to push to RubyGems via the API, see the [RubyGems documentation](https://guides.rubygems.org/publishing/#publishing-to-rubygemsorg).

data/Rakefile

@@ -1,2 +1 @@
-require "bundler/gem_tasks"
-
+require 'bundler/gem_tasks'

data/bin/slack-messaging

@@ -16,7 +16,12 @@ program_long_desc """
 DOCUMENTATION
 """
 
-commands_from File.expand_path(File.dirname(__FILE__) + '/../lib/slack_messaging/commands')
+desc 'Prints a variety of messages to Slack'
+command 'slack' do |c|
+  c.action do |global_options, options, args|
+    SlackMessaging::Slack.execute(args, options)
+  end
+end
 
 pre do |global,command,options,args|
   SlackMessaging::Config.load(global[:config])

data/lib/slack_messaging.rb

@@ -1,9 +1,11 @@
-require_relative 'slack_messaging/version'
-require_relative 'slack_messaging/output'
-require_relative 'slack_messaging/config'
-require_relative 'slack_messaging/notify_slack'
-require_relative 'slack_messaging/random_message'
-
-module SlackMessaging
+require 'yaml'
+require 'hashie'
+require 'httparty'
+require 'highline'
+require 'json'
 
+Dir[File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), 'slack_messaging')) + '/**/*.rb'].each do |file|
+  require_relative file
 end
+
+module SlackMessaging; end

data/lib/slack_messaging/config.rb

@@ -1,48 +1,27 @@
-require 'yaml'
-require 'hashie'
-
 module SlackMessaging
-
-  class DefaultPaths
-    class << self
-      def config
-        File.join(self.home,'.slack_messaging.yml')
-      end
-
-      def home
-        ENV['HOME'] ? ENV['HOME'] : "."
-      end
-    end
-  end
-
   class Config
-    class << self
-
-      def config
-        config_data.to_hash
-      end
+    def self.config
+      config_data.to_hash
+    end
 
-      def load(path)
-        load_config(path)
-        config
-      end
+    def self.load(path)
+      load_config(path)
+      config
+    end
 
-      def config_data
-        @config_data ||= Hashie::Mash.new
-      end
-      private :config_data
+    private
 
-      def method_missing(method, args=false)
-        config_data.send(method, args)
-      end
-      private :method_missing
+    def self.config_data
+      @config_data ||= Hashie::Mash.new
+    end
 
-      def load_config(file)
-        raise MissingConfig, "Missing configuration file: #{file}" unless File.exist?(file)
-        YAML.load_file(file).each{ |key,value| config_data.assign_property(key, value) }
-      end
-      private :load_config
+    def self.method_missing(method, args = false)
+      config_data.send(method, args)
+    end
 
+    def self.load_config(file)
+      raise MissingConfig, "Missing configuration file: #{file}" unless File.exist?(file)
+      YAML.load_file(file).each { |key, value| config_data.assign_property(key, value) }
     end
   end
 end

data/lib/slack_messaging/default_paths.rb

@@ -0,0 +1,13 @@
+module SlackMessaging
+  class DefaultPaths
+    def self.config
+      File.join(self.home, '.slack_messaging.yml')
+    end
+
+    private
+
+    def self.home
+      ENV['HOME'] ? ENV['HOME'] : '.'
+    end
+  end
+end

data/lib/slack_messaging/notify_slack.rb

@@ -1,5 +1,3 @@
-require 'slack-notifier'
-
 module SlackMessaging
   class NotifySlack
     attr_accessor :text, :channel, :webhook_url, :username, :icon_url, :icon_emoji
@@ -8,18 +6,19 @@ module SlackMessaging
       self.text = text
       self.channel = SlackMessaging::Config.slack[:channel]
       self.webhook_url = SlackMessaging::Config.slack[:webhook_url]
-      self.username = SlackMessaging::Config.slack[:username] || "MessageMe"
-      self.icon_emoji = SlackMessaging::Config.slack[:icon_emoji] || ":mailbox_with_mail"
+      self.username = SlackMessaging::Config.slack[:username] || 'MessageMe'
+      self.icon_emoji = SlackMessaging::Config.slack[:icon_emoji] || ':mailbox_with_mail'
     end
 
     def perform
-      options = {webhook_url: webhook_url,
-                 channel: channel,
-                 username: username,
-                 icon_emoji: icon_emoji,
-                 http_options: {open_timeout: 10}
-                }
-      Slack::Notifier.new(webhook_url, options).ping(text)
+      options = {
+        channel: channel,
+        username: username,
+        icon_emoji: icon_emoji,
+        text: text
+      }
+
+      HTTParty.post(webhook_url, body: options.to_json)
     end
   end
 end

data/lib/slack_messaging/random_message.rb

@@ -1,34 +1,10 @@
 module SlackMessaging
   class RandomMessage
-    attr_accessor :text
-
-    MESSAGE_ARRAY = [
-        "A true friend is someone who thinks that you are a good egg even though he knows that you are slightly cracked.\n--Bernard Meltzer",
-        "If you can't make it good, at least make it look good.\n--Bill Gates",
-        "I'm convinced of this: Good done anywhere is good done everywhere.\n--Maya Angelou",
-        "The real trouble with reality is that there's no background music.\n--Anonymous",
-        "Whatever you are, be a good one.\n--Abraham Lincoln",
-        "Good, better, best. Never let it rest. 'Til your good is better and your better is best.\n--St. Jerome",
-        "Despite everything, I believe that people are really good at heart.\n--Anne Frank",
-        "Life is 10% what happens to you and 90% how you react to it.\n--Charles R. Swindoll",
-        "The way to get started is to quit talking and begin doing.\n--Walt Disney",
-        "A creative man is motivated by the desire to achieve, not by the desire to beat others.\n--Ayn Rand",
-        "Problems are not stop signs, they are guidelines.\n--Robert H. Schuller",
-        "Correction does much, but encouragement does more.\n--Johann Wolfgang von Goethe",
-        "Positive anything is better than negative nothing.\n--Elbert Hubbard",
-        "To succeed, you need to find something to hold on to, something to motivate you, something to inspire you.\n--Joyce Meyer",
-        "If you're not making mistakes, then you're not doing anything. I'm positive that a doer makes mistakes.\n--John Wooden",
-        "The best way to deal with other people is to just let them be other people.\n--Anonymous",
-        "Talk to yourself like you would to someone you love.\n--Brenee Brown",
-        "Don't let small minds convince you that your dreams are too big.\n--Anonymous",
-      ]
-
-    def initialize
-      self.text = MESSAGE_ARRAY[rand(MESSAGE_ARRAY.length)]
-    end
-
-    def get_text
-      return self.text
+    def self.acquire_random_quote
+      random_quote = HTTParty.get('http://api.quotable.io/random', headers: { 'Content-Type': 'application/json' }).body
+      quote_content = JSON.parse(random_quote)['content']
+      quote_author = JSON.parse(random_quote)['author']
+      return "\"#{quote_content}\"" + "\n" + "—#{quote_author}"
     end
   end
 end

data/lib/slack_messaging/slack.rb

@@ -0,0 +1,22 @@
+module SlackMessaging
+  class Slack
+    attr_accessor :options
+
+    def self.execute(args, options = nil)
+      if args.empty?
+        message = SlackMessaging::RandomMessage.acquire_random_quote
+        print_message(message)
+      else
+        args.each do |message|
+          print_message(message)
+        end
+      end
+    end
+
+    private
+
+    def self.print_message(message)
+      SlackMessaging::NotifySlack.new(message).perform
+    end
+  end
+end