slack_messaging 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6742192033a64bb2935e5af6486ea356d54684f501515f22eb8a24c200fff61
-  data.tar.gz: 0d880c5cd858c778f06c9047e911927a1cb2ab2ee6b53a89b20b9e23a61ad2a9
+  metadata.gz: b90f38dcdaf24ec98961f9cf3311570daf0087c1308b63483762d158f04161f7
+  data.tar.gz: 5e8fdef06dd5285ff63d922ca7e1b8e18eef0149104e26a155d8d1bb5916576e
 SHA512:
-  metadata.gz: 8458be91785ae94772e960f5f0705a2a611b36c286f694d0eb0ac4abe86fdd9d6867aa89d45dc9c44d721dbdb7bd9f34365ca5121f1d85ac0fd027d33439dbf4
-  data.tar.gz: 7485f64ff53624785968f06a25e109a8042aa1e7e63412d7c7a40b78da8209f643e06f62130b3c8e7ba8d0677db2445950b2a9fca0ceb5199b03c71d10592bd3
+  metadata.gz: 2461540b052fc9a790da9e2e11da01b496d08260db928c61c7e11dcd67add9a75e15feab6f03f8dcb029807db6f6205a3fa517d358bc629f606732bed3397b7f
+  data.tar.gz: 17dcb6ba4aa5f6c98d29611c3e08bb05080aa009c66de4e97ded5194fb31dd3296d4bae091ec9eedc59f142e8d4d862c1d28809a705a0f5282652c1f4f6b049c

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    slack_messaging (3.0.0)
+    slack_messaging (3.1.0)
       activesupport (~> 6.0)
       gli (~> 2.10)
       hashie (~> 4.1)
-      highline (~> 2.0)
+      highline_wrapper (~> 0.1.0)
       httparty (~> 0.18)
       json (~> 2.5)
       rack (~> 2.2)
@@ -44,6 +44,8 @@ GEM
       rspec (>= 2.99.0, < 4.0)
     hashie (4.1.0)
     highline (2.0.3)
+    highline_wrapper (0.1.0)
+      highline (~> 2.0)
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
@@ -120,7 +122,7 @@ DEPENDENCIES
   pry (~> 0.13)
   rake (~> 13.0)
   rspec (~> 3.9)
-  rubocop
+  rubocop (~> 1.10)
   slack_messaging!
 
 BUNDLED WITH

data/README.md

@@ -86,7 +86,7 @@ I hope you enjoy printing fun and specialized messages to Slack!
 
 ### Tests
 
-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!
+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!
 
 ## Contributing
 

data/lib/slack_messaging.rb

@@ -3,7 +3,7 @@
 require 'yaml'
 require 'hashie'
 require 'httparty'
-require 'highline'
+require 'highline_wrapper'
 require 'json'
 
 files = "#{File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), 'slack_messaging'))}/**/*.rb"

data/lib/slack_messaging/setup.rb

@@ -36,21 +36,17 @@ module SlackMessaging
       File.exist?(default_config)
     end
 
-    # rubocop:disable Metrics/MethodLength:
+    # rubocop:disable Metrics/MethodLength
     def self.ask_config_questions
       answers = {}
 
       answers[:webhook_url] = ask_question(
         "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.'
+        ' here and paste it in the Terminal.',
+        required: true
       )
 
-      unless answers[:webhook_url]
-        puts "\nExiting because Slack webhoook is required..."
-        exit
-      end
-
       answers[:channel] = ask_question(
         "\nWhat slack channel do you wish to post to? (default is \"#general\")"
       ) || 'general'
@@ -68,13 +64,25 @@ module SlackMessaging
     end
     # rubocop:enable Metrics/MethodLength
 
-    def self.ask_question(prompt)
+    # rubocop:disable Metrics/MethodLength
+    def self.ask_question(prompt, required: false)
       answer = highline.ask(prompt)
-      answer.empty? ? nil : answer
+
+      if required
+        if answer.empty?
+          puts "\nThis question is required.\n\n"
+          ask_question(prompt, required: true)
+        else
+          answer
+        end
+      else
+        answer.empty? ? nil : answer
+      end
     end
+    # rubocop:enable Metrics/MethodLength
 
     def self.highline
-      @highline ||= SlackMessaging::HighlineCli.new
+      @highline ||= HighlineWrapper.new
     end
 
     def self.default_config

data/lib/slack_messaging/version.rb

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

data/spec/slack_messaging/notify_slack_spec.rb

@@ -28,20 +28,18 @@ describe SlackMessaging::NotifySlack do
     SlackMessaging::Config.load(Faker::Lorem.word)
   end
 
-  subject { SlackMessaging::NotifySlack }
+  subject { SlackMessaging::NotifySlack.new(sentence) }
 
   it 'should call HTTParty' do
     expect(HTTParty).to receive(:post)
-    message = subject.new(sentence)
-    message.perform
+    subject.perform
   end
 
   it 'should define certain values' do
-    message = subject.new(sentence)
-    expect(message.text).to eq(sentence)
-    expect(message.channel).to eq(channel)
-    expect(message.username).to eq(username)
-    expect(message.webhook_url).to eq(webhook)
-    expect(message.icon_emoji).to eq(emoji)
+    expect(subject.text).to eq(sentence)
+    expect(subject.channel).to eq(channel)
+    expect(subject.username).to eq(username)
+    expect(subject.webhook_url).to eq(webhook)
+    expect(subject.icon_emoji).to eq(emoji)
   end
 end

data/spec/slack_messaging/setup_spec.rb

@@ -4,8 +4,7 @@ require 'spec_helper'
 require 'slack_messaging'
 
 describe SlackMessaging::Setup do
-  let(:response) { double(:response, readline: true, to_s: Faker::Lorem.sentence) }
-  let(:highline_cli) { double(:highline_cli, ask: response, ask_yes_no: true) }
+  let(:highline_wrapper) { double(:highline_wrapper, ask: Faker::Lorem.word, ask_yes_no: true) }
   let(:answers) do
     {
       channel: Faker::Lorem.word,
@@ -16,7 +15,7 @@ describe SlackMessaging::Setup do
   end
 
   before do
-    allow(SlackMessaging::HighlineCli).to receive(:new).and_return(highline_cli)
+    allow(HighlineWrapper).to receive(:new).and_return(highline_wrapper)
     allow(subject).to receive(:puts)
   end
 
@@ -30,7 +29,7 @@ describe SlackMessaging::Setup 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)
+      expect(highline_wrapper).to receive(:ask_yes_no).and_return(true)
       allow(subject).to receive(:create_or_update_config_file).and_return(true)
       allow(subject).to receive(:ask_config_questions).and_return(true)
       subject.execute
@@ -38,7 +37,7 @@ describe SlackMessaging::Setup do
 
     it 'should call to create or update the config file' do
       allow(File).to receive(:exists?).and_return(true)
-      allow(highline_cli).to receive(:ask_yes_no).and_return(true)
+      allow(highline_wrapper).to receive(:ask_yes_no).and_return(true)
       expect(subject).to receive(:create_or_update_config_file).and_return(true)
       expect(subject).to receive(:ask_config_questions).and_return(true)
       subject.execute
@@ -47,7 +46,7 @@ describe SlackMessaging::Setup 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)
+      allow(highline_wrapper).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)
       subject.execute
@@ -88,49 +87,69 @@ describe SlackMessaging::Setup do
 
   describe '#self.ask_question' do
     it 'should use highline to ask a question' do
-      expect(highline_cli).to receive(:ask).and_return('')
+      expect(highline_wrapper).to receive(:ask).and_return('')
       subject.send(:ask_question, Faker::Lorem.sentence)
     end
 
     it 'should return nil if the highline client gets an empty string' do
-      allow(highline_cli).to receive(:ask).and_return('')
+      allow(highline_wrapper).to receive(:ask).and_return('')
       expect(subject.send(:ask_question, Faker::Lorem.sentence)).to be_nil
     end
 
     it 'should return the answer if it is given' do
       answer = Faker::Lorem.sentence
-      allow(highline_cli).to receive(:ask).and_return(answer)
+      allow(highline_wrapper).to receive(:ask).and_return(answer)
       expect(subject.send(:ask_question, Faker::Lorem.sentence)).to be(answer)
     end
   end
 
   describe '#self.ask_config_questions' do
     it 'should call to ask at least four questions' do
-      expect(subject).to receive(:ask_question).at_least(4).times
+      expect(subject).to receive(:ask_question).at_least(4).times.and_return(Faker::Lorem.word)
       subject.send(:ask_config_questions)
     end
 
-    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)
+    it 'should recurse if the slack URL is not given' do
+      allow(highline_wrapper).to receive(:ask).with(
+        "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.'
+      ).and_return('', Faker::Internet.url)
+      allow(highline_wrapper).to receive(:ask).with(
+        "\nWhat slack channel do you wish to post to? (default is \"#general\")"
+      ).and_return('')
+      allow(highline_wrapper).to receive(:ask).with(
+        "\nWhat slack username do you wish to post as? (default is \"Let's Get Quoty\")"
+      ).and_return('')
+      allow(highline_wrapper).to receive(:ask).with(
+        "\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:\")"
+      ).and_return('')
+      expect(subject).to receive(:ask_question).at_least(:twice).and_call_original
+      subject.send(:ask_config_questions)
     end
 
     it 'should return the defaults if nothing is given' do
       slack_url = Faker::Internet.url
+      defaults = {
+        channel: 'general',
+        username: "Let's Get Quoty",
+        webhook_url: slack_url,
+        icon_emoji: ':mailbox_with_mail:'
+      }
       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.'
+        "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.",
+        required: true
       ).and_return(slack_url)
-      allow(subject).to receive(:ask_question).and_return(nil)
-      expect(subject.send(:ask_config_questions)).to eq(
-        {
-          channel: 'general',
-          username: "Let's Get Quoty",
-          webhook_url: slack_url,
-          icon_emoji: ':mailbox_with_mail:'
-        }
-      )
+      allow(subject).to receive(:ask_question).with(
+        "\nWhat slack channel do you wish to post to? (default is \"#general\")"
+      ).and_return(nil)
+      allow(subject).to receive(:ask_question).with(
+        "\nWhat slack username do you wish to post as? (default is \"Let's Get Quoty\")"
+      ).and_return(nil)
+      allow(subject).to receive(:ask_question).with(
+        "\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:\")"
+      ).and_return(nil)
+      expect(subject.send(:ask_config_questions)).to eq(defaults)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_messaging
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Emma Sax
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
-  name: highline
+  name: highline_wrapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -196,16 +196,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.10'
 description: Sending Personalized Slack Messages to a Slack channel of your choice.
 email:
 executables:
@@ -224,14 +224,12 @@ files:
 - lib/slack_messaging.rb
 - lib/slack_messaging/config.rb
 - lib/slack_messaging/default_paths.rb
-- 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/version.rb
 - spec/slack_messaging/config_spec.rb
-- spec/slack_messaging/highline_cli_spec.rb
 - spec/slack_messaging/notify_slack_spec.rb
 - spec/slack_messaging/random_message_spec.rb
 - spec/slack_messaging/setup_spec.rb
@@ -262,7 +260,6 @@ summary: Personalized Slack Messages
 test_files:
 - spec/spec_helper.rb
 - spec/slack_messaging/config_spec.rb
-- spec/slack_messaging/highline_cli_spec.rb
 - spec/slack_messaging/notify_slack_spec.rb
 - spec/slack_messaging/random_message_spec.rb
 - spec/slack_messaging/setup_spec.rb

data/lib/slack_messaging/highline_cli.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module SlackMessaging
-  class HighlineCli
-    def ask(prompt)
-      highline_client.ask(prompt) do |conf|
-        conf.readline = true
-      end.to_s
-    end
-
-    def ask_yes_no(prompt)
-      answer = highline_client.ask(prompt) do |conf|
-        conf.readline = true
-      end.to_s
-
-      answer.empty? ? true : !!(answer =~ /^y/i)
-    end
-
-    def ask_options(prompt, choices)
-      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}"
-
-      index = highline_client.ask(compiled_prompt) do |conf|
-        conf.readline = true
-      end.to_i - 1
-
-      choices[index]
-    end
-
-    private def highline_client
-      @highline_client ||= HighLine.new
-    end
-  end
-end

data/spec/slack_messaging/highline_cli_spec.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'slack_messaging'
-
-describe SlackMessaging::HighlineCli do
-  let(:response) { double(:response, readline: true, to_i: 3) }
-  let(:highline_client) { double(:highline_cli, ask: response) }
-
-  before do
-    allow(HighLine).to receive(:new).and_return(highline_client)
-  end
-
-  describe '#ask' do
-    it 'should ask the highline client ask' do
-      expect(highline_client).to receive(:ask)
-      subject.ask(Faker::Lorem.sentence)
-    end
-
-    it 'should return a string' do
-      expect(subject.ask(Faker::Lorem.sentence)).to be_a(String)
-    end
-  end
-
-  describe '#ask_yes_no' do
-    it 'should ask the highline client ask' do
-      expect(highline_client).to receive(:ask)
-      subject.ask_yes_no(Faker::Lorem.sentence)
-    end
-
-    it 'should return a boolean' do
-      expect(subject.ask_yes_no(Faker::Lorem.sentence)).to be_falsey
-    end
-
-    it 'should return true if we say yes' do
-      allow(response).to receive(:to_s).and_return('y')
-      expect(subject.ask_yes_no(Faker::Lorem.sentence)).to be_truthy
-    end
-  end
-
-  describe '#ask_options' do
-    it 'should ask the highline client ask' do
-      expect(highline_client).to receive(:ask)
-      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, %w[one two three])).to be_a(String)
-    end
-  end
-end