slack_messaging 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd3e90f703693ae103c78862c1c506cc48dcab4f04065d4aee1b6e60a9cab9da
-  data.tar.gz: 9cf11baa6f0d033e3c944a7a6d30255eb4ed94233a3a54cfa277c59566bdd91b
+  metadata.gz: e6742192033a64bb2935e5af6486ea356d54684f501515f22eb8a24c200fff61
+  data.tar.gz: 0d880c5cd858c778f06c9047e911927a1cb2ab2ee6b53a89b20b9e23a61ad2a9
 SHA512:
-  metadata.gz: cc3b3d202c84093c07a6d0aae39f05dad04aa16a7b28fb66a57b4399e4f1bccdff049909d92fba9a56431a4171422d589a3b616c56b7ee72dad2aca0d48e5560
-  data.tar.gz: cab8ff992b73a96e41f4f8cb996df80b644ec304a58292d728f54ba5b3965695d4421c5f1df6819aad530981be893a1bfe8fb2c51cf2338142440787f3eff390
+  metadata.gz: 8458be91785ae94772e960f5f0705a2a611b36c286f694d0eb0ac4abe86fdd9d6867aa89d45dc9c44d721dbdb7bd9f34365ca5121f1d85ac0fd027d33439dbf4
+  data.tar.gz: 7485f64ff53624785968f06a25e109a8042aa1e7e63412d7c7a40b78da8209f643e06f62130b3c8e7ba8d0677db2445950b2a9fca0ceb5199b03c71d10592bd3

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in slack_messaging.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slack_messaging (2.2.0)
+    slack_messaging (3.0.0)
       activesupport (~> 6.0)
       gli (~> 2.10)
       hashie (~> 4.1)
@@ -19,6 +19,7 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
+    ast (2.4.2)
     coderay (1.1.3)
     concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
@@ -63,14 +64,20 @@ GEM
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
     pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rack (2.2.3)
+    rainbow (3.0.0)
     rake (13.0.3)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -84,10 +91,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    rubocop (1.10.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
     shellany (0.0.1)
     thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
     zeitwerk (2.4.2)
 
 PLATFORMS
@@ -100,6 +120,7 @@ DEPENDENCIES
   pry (~> 0.13)
   rake (~> 13.0)
   rspec (~> 3.9)
+  rubocop
   slack_messaging!
 
 BUNDLED WITH

data/Guardfile

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

data/README.md

@@ -1,4 +1,4 @@
-# Slack Messaging [![Maintainability](https://api.codeclimate.com/v1/badges/9aabbea68d6522f4b308/maintainability)](https://codeclimate.com/github/emmahsax/slack_messaging/maintainability) [![Main](https://github.com/emmahsax/slack_messaging/actions/workflows/main.yml/badge.svg)](https://github.com/emmahsax/slack_messaging/actions/workflows/main.yml)
+# Slack Messaging [![Main](https://github.com/emmahsax/slack_messaging/actions/workflows/main.yml/badge.svg)](https://github.com/emmahsax/slack_messaging/actions/workflows/main.yml)
 
 This is a simple project designed to post messages to a given Slack channel as a bot.
 
@@ -53,7 +53,7 @@ mv ~/.slack_messaging.yml /PATH/TO/FILE/config.yml
 And then you can pass in that specific file location like this:
 
 ```bash
-slack-messaging --config="/PATH/TO/FILE/config.yml" slack
+slack-messaging --config="/PATH/TO/FILE/config.yml" send
 ```
 
 Once the config file is set up, the project is ready to go!
@@ -61,7 +61,7 @@ Once the config file is set up, the project is ready to go!
 To print a friendly message to Slack, run:
 
 ```bash
-slack-messaging slack
+slack-messaging send
 ```
 
 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/).
@@ -69,13 +69,13 @@ Here, no specific message is being given to print to Slack, so slack_messaging w
 However, what if you wanted to print something specific? Well, you can! Just run:
 
 ```bash
-slack-messaging slack 'MESSAGE 1'
+slack-messaging send 'MESSAGE 1'
 ```
 
 You can even print multiple messages at once:
 
 ```bash
-slack-messaging slack 'MESSAGE 1' 'MESSAGE 2' 'MESSAGE 3' ... 'MESSAGE N'
+slack-messaging send 'MESSAGE 1' 'MESSAGE 2' 'MESSAGE 3' ... 'MESSAGE N'
 ```
 
 The output of slack_messaging will look something like this:

data/Rakefile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'

data/bin/slack-messaging

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'gli'
 require_relative '../lib/slack_messaging'
@@ -10,29 +13,29 @@ version SlackMessaging::VERSION
 
 wrap_help_text :verbatim
 
-flag [:config], :desc => 'Slack Messaging config file path', :default_value => SlackMessaging::DefaultPaths.config
+flag [:config], desc: 'Slack Messaging config file path', default_value: SlackMessaging::DefaultPaths.config
 
-program_long_desc """
+program_long_desc "
 DOCUMENTATION
     For documentation and help in setting up your configuration files,
     see Slack Messaging's GitHub repo: https://github.com/emmahsax/slack_messaging
-"""
+"
 
 desc 'Prints a variety of messages to Slack'
-command 'slack' do |c|
-  pre do |global, command, options, args|
+command 'send' do |c|
+  pre do |global, _command, _options, _args|
     SlackMessaging::Config.load(global[:config])
     true
   end
 
-  c.action do |global_options, options, args|
-    SlackMessaging::Slack.execute(args, options)
+  c.action do |_global_options, options, args|
+    SlackMessaging::Send.execute(args, options)
   end
 end
 
 desc 'Sets up a Slack Messaging config file at ~/.slack_messaging.yml'
 command 'setup' do |c|
-  c.action do ||
+  c.action do
     SlackMessaging::Setup.execute
   end
 end

data/lib/slack_messaging.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 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|
+files = "#{File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), 'slack_messaging'))}/**/*.rb"
+
+Dir[files].each do |file|
   require_relative file
 end
 

data/lib/slack_messaging/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackMessaging
   class Config
     def self.config
@@ -9,8 +11,6 @@ module SlackMessaging
       config
     end
 
-    private
-
     def self.config_data
       @config_data ||= Hashie::Mash.new
     end
@@ -21,6 +21,7 @@ module SlackMessaging
 
     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

data/lib/slack_messaging/default_paths.rb

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

data/lib/slack_messaging/highline_cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackMessaging
   class HighlineCli
     def ask(prompt)
@@ -15,7 +17,7 @@ module SlackMessaging
     end
 
     def ask_options(prompt, choices)
-      choices_as_string_options = ''
+      choices_as_string_options = ''.dup
       choices.each { |choice| choices_as_string_options << "#{choices.index(choice) + 1}. #{choice}\n" }
       compiled_prompt = "#{prompt}\n#{choices_as_string_options.strip}"
 

data/lib/slack_messaging/notify_slack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackMessaging
   class NotifySlack
     attr_accessor :text, :channel, :webhook_url, :username, :icon_url, :icon_emoji

data/lib/slack_messaging/random_message.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module SlackMessaging
   class RandomMessage
     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}"
+      "\"#{quote_content}\"\n—#{quote_author}"
     end
   end
 end

data/lib/slack_messaging/{slack.rb → send.rb}

@@ -1,20 +1,20 @@
+# frozen_string_literal: true
+
 module SlackMessaging
-  class Slack
+  class Send
     attr_accessor :options
 
-    def self.execute(args, options = nil)
+    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)
+        args.each do |arg_message|
+          print_message(arg_message)
         end
       end
     end
 
-    private
-
     def self.print_message(message)
       SlackMessaging::NotifySlack.new(message).perform
     end

data/lib/slack_messaging/setup.rb

@@ -1,20 +1,20 @@
+# frozen_string_literal: true
+
 module SlackMessaging
   class Setup
     def self.execute
       if config_file_exists?
-        answer = highline.ask_yes_no("It looks like the #{default_config} file already exists. Do you wish to replace it? (y/n)")
-
-        unless answer
-          puts "\nExiting because you selected to not replace the #{default_config} file..."
-          exit
-        end
+        answer = highline.ask_yes_no(
+          "It looks like the #{default_config} file already exists. Do you wish to replace it? (y/n)"
+        )
+        puts
+      else
+        answer = true
       end
 
-      create_or_update_config_file(ask_config_questions)
+      create_or_update_config_file(ask_config_questions) if answer
     end
 
-    private
-
     def self.create_or_update_config_file(answers)
       contents = generate_config_file(answers)
       puts "\nCreating or updating your #{default_config} file..."
@@ -23,7 +23,7 @@ module SlackMessaging
     end
 
     def self.generate_config_file(answers)
-      file_contents = ''
+      file_contents = ''.dup
       file_contents << "slack:\n"
       file_contents << "  channel: #{answers[:channel].tr('#', '').strip}\n"
       file_contents << "  username: #{answers[:username].strip}\n"
@@ -33,16 +33,17 @@ module SlackMessaging
     end
 
     def self.config_file_exists?
-      File.exists?(default_config)
+      File.exist?(default_config)
     end
 
+    # rubocop:disable Metrics/MethodLength:
     def self.ask_config_questions
       answers = {}
 
       answers[:webhook_url] = ask_question(
-        "\nWhat is your Slack webhook URL? If you don't have one yet, please navigate" \
-        " to https://api.slack.com/messaging/webhooks to create one, and then come back" \
-        " here and paste it in the Terminal."
+        "What is your Slack webhook URL? If you don't have one yet, please navigate" \
+        ' to https://api.slack.com/messaging/webhooks to create one, and then come back' \
+        ' here and paste it in the Terminal.'
       )
 
       unless answers[:webhook_url]
@@ -59,11 +60,13 @@ module SlackMessaging
       ) || "Let's Get Quoty"
 
       answers[:icon_emoji] = ask_question(
-        "\nWhat emoji would you like to post with (include the colons at the beginning and end of the emoji name)? (default is \":mailbox_with_mail:\")"
-      ) || ":mailbox_with_mail:"
+        "\nWhat emoji would you like to post with (include the colons at the beginning and end" \
+        ' of the emoji name)? (default is ":mailbox_with_mail:")'
+      ) || ':mailbox_with_mail:'
 
       answers
     end
+    # rubocop:enable Metrics/MethodLength
 
     def self.ask_question(prompt)
       answer = highline.ask(prompt)

data/lib/slack_messaging/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackMessaging
-  VERSION = '2.2.0'
+  VERSION = '3.0.0'
 end

data/spec/slack_messaging/config_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'slack_messaging'
 
@@ -23,13 +25,13 @@ describe SlackMessaging::Config do
 
     let(:config_file) do
       {
-        'domain': domain,
-        'slack': {
-          'slack_option': true,
-          'username': Faker::Name.name,
-          'icon_url': Faker::Internet.url,
-          'channel': Faker::Lorem.word,
-          'webhook': Faker::Internet.url
+        domain: domain,
+        slack: {
+          slack_option: true,
+          username: Faker::Name.name,
+          icon_url: Faker::Internet.url,
+          channel: Faker::Lorem.word,
+          webhook: Faker::Internet.url
         }
       }
     end

data/spec/slack_messaging/highline_cli_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'slack_messaging'
 
@@ -10,7 +12,7 @@ describe SlackMessaging::HighlineCli do
   end
 
   describe '#ask' do
-    it 'should ask the highline client ask'do
+    it 'should ask the highline client ask' do
       expect(highline_client).to receive(:ask)
       subject.ask(Faker::Lorem.sentence)
     end
@@ -21,7 +23,7 @@ describe SlackMessaging::HighlineCli do
   end
 
   describe '#ask_yes_no' do
-    it 'should ask the highline client ask'do
+    it 'should ask the highline client ask' do
       expect(highline_client).to receive(:ask)
       subject.ask_yes_no(Faker::Lorem.sentence)
     end
@@ -37,13 +39,13 @@ describe SlackMessaging::HighlineCli do
   end
 
   describe '#ask_options' do
-    it 'should ask the highline client ask'do
+    it 'should ask the highline client ask' do
       expect(highline_client).to receive(:ask)
-      subject.ask_options(Faker::Lorem.sentence, ['one', 'two', 'three'])
+      subject.ask_options(Faker::Lorem.sentence, %w[one two three])
     end
 
     it 'should return a string from the options' do
-      expect(subject.ask_options(Faker::Lorem.sentence, ['one', 'two', 'three'])).to be_a(String)
+      expect(subject.ask_options(Faker::Lorem.sentence, %w[one two three])).to be_a(String)
     end
   end
 end

data/spec/slack_messaging/notify_slack_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'slack_messaging'
 
@@ -10,12 +12,12 @@ describe SlackMessaging::NotifySlack do
 
   let(:config_file) do
     {
-      'slack': {
-        'slack_option': true,
-        'username': username,
-        'icon_emoji': emoji,
-        'channel': channel,
-        'webhook_url': webhook
+      slack: {
+        slack_option: true,
+        username: username,
+        icon_emoji: emoji,
+        channel: channel,
+        webhook_url: webhook
       }
     }
   end
@@ -34,7 +36,7 @@ describe SlackMessaging::NotifySlack do
     message.perform
   end
 
-    it 'should define certain values' do
+  it 'should define certain values' do
     message = subject.new(sentence)
     expect(message.text).to eq(sentence)
     expect(message.channel).to eq(channel)

data/spec/slack_messaging/random_message_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'slack_messaging'
 

data/spec/slack_messaging/setup_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'slack_messaging'
 
@@ -19,13 +21,14 @@ describe SlackMessaging::Setup do
   end
 
   after do
-    SlackMessaging::Setup.instance_variable_set("@highline", nil)
+    SlackMessaging::Setup.instance_variable_set('@highline', nil)
   end
 
   subject { SlackMessaging::Setup }
 
   describe '#self.execute' do
     it 'should ask a question if the config file exists' do
+      allow(subject).to receive(:config_file_exists?).and_return(true)
       allow(File).to receive(:exists?).and_return(true)
       expect(highline_cli).to receive(:ask_yes_no).and_return(true)
       allow(subject).to receive(:create_or_update_config_file).and_return(true)
@@ -41,12 +44,13 @@ describe SlackMessaging::Setup do
       subject.execute
     end
 
-    it 'should exit if the user opts not to continue' do
+    it 'should skip if the user opts not to continue' do
+      allow(subject).to receive(:config_file_exists?).and_return(true)
       allow(File).to receive(:exists?).and_return(true)
       allow(highline_cli).to receive(:ask_yes_no).and_return(false)
       expect(subject).not_to receive(:create_or_update_config_file)
       expect(subject).not_to receive(:ask_config_questions)
-      expect{ subject.execute }.to raise_error(SystemExit)
+      subject.execute
     end
   end
 
@@ -72,12 +76,12 @@ describe SlackMessaging::Setup do
 
   describe '#self.config_file_exists?' do
     it 'should return true if the file exists' do
-      allow(File).to receive(:exists?).and_return(true)
+      allow(File).to receive(:exist?).and_return(true)
       expect(subject.send(:config_file_exists?)).to eq(true)
     end
 
     it 'should return false if the file does not exist' do
-      allow(File).to receive(:exists?).and_return(false)
+      allow(File).to receive(:exist?).and_return(false)
       expect(subject.send(:config_file_exists?)).to eq(false)
     end
   end
@@ -108,15 +112,15 @@ describe SlackMessaging::Setup do
 
     it 'should exit if the slack URL is not given' do
       allow(subject).to receive(:ask_question).and_return(nil)
-      expect{ subject.send(:ask_config_questions) }.to raise_error(SystemExit)
+      expect { subject.send(:ask_config_questions) }.to raise_error(SystemExit)
     end
 
     it 'should return the defaults if nothing is given' do
       slack_url = Faker::Internet.url
       allow(subject).to receive(:ask_question).with(
         "\nWhat is your Slack webhook URL? If you don't have one yet, please navigate" \
-        " to https://api.slack.com/messaging/webhooks to create one, and then come back" \
-        " here and paste it in the Terminal."
+        ' to https://api.slack.com/messaging/webhooks to create one, and then come back' \
+        ' here and paste it in the Terminal.'
       ).and_return(slack_url)
       allow(subject).to receive(:ask_question).and_return(nil)
       expect(subject.send(:ask_config_questions)).to eq(
@@ -124,7 +128,7 @@ describe SlackMessaging::Setup do
           channel: 'general',
           username: "Let's Get Quoty",
           webhook_url: slack_url,
-          icon_emoji: ":mailbox_with_mail:"
+          icon_emoji: ':mailbox_with_mail:'
         }
       )
     end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faker'
 require 'pry'
 
@@ -34,7 +36,7 @@ RSpec.configure do |config|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
-  config.filter_run :focus => true
+  config.filter_run focus: true
   config.run_all_when_everything_filtered = true
 
   # rspec-mocks config goes here. You can use an alternate test double

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_messaging
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Emma Sax
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -192,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Sending Personalized Slack Messages to a Slack channel of your choice.
 email:
 executables:
@@ -213,8 +227,8 @@ files:
 - lib/slack_messaging/highline_cli.rb
 - lib/slack_messaging/notify_slack.rb
 - lib/slack_messaging/random_message.rb
+- lib/slack_messaging/send.rb
 - lib/slack_messaging/setup.rb
-- lib/slack_messaging/slack.rb
 - lib/slack_messaging/version.rb
 - spec/slack_messaging/config_spec.rb
 - spec/slack_messaging/highline_cli_spec.rb
@@ -234,7 +248,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="