slack_messaging 1.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3508ee5d59522e0a8d3c931e165bee408d707240fc4c3a1aadbabd2d5b6799f9
-  data.tar.gz: 67bc57eb2943f0f9f801eac68e25988ee4b06ac20835dd2f46b24b4599d213d5
+  metadata.gz: e6742192033a64bb2935e5af6486ea356d54684f501515f22eb8a24c200fff61
+  data.tar.gz: 0d880c5cd858c778f06c9047e911927a1cb2ab2ee6b53a89b20b9e23a61ad2a9
 SHA512:
-  metadata.gz: 0aa1c61dcb454f5beef05a9ecc13da9e16a258812952013675d2bc5a4b3230d6f80f9b08d47d3de0168a6fb85a180fe1a9d2b78e6b68474c6ae615fdf7639081
-  data.tar.gz: dd9967c7e2347435a1194961f03f7d5329f45cb839a47130cc1bb901cd324234e854a457a274cfccc54c9903cd322157f06dc0b61baa9e283d21daa549c7dc51
+  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,29 +1,31 @@
 PATH
   remote: .
   specs:
-    slack_messaging (1.4.0)
+    slack_messaging (3.0.0)
       activesupport (~> 6.0)
       gli (~> 2.10)
       hashie (~> 4.1)
       highline (~> 2.0)
-      httparty
+      httparty (~> 0.18)
+      json (~> 2.5)
       rack (~> 2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.4)
+    activesupport (6.1.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
-    faker (2.14.0)
+    faker (2.15.1)
       i18n (>= 1.6, < 2)
-    ffi (1.13.1)
+    ffi (1.14.2)
     formatador (0.2.5)
     gli (2.19.2)
     guard (2.16.2)
@@ -45,9 +47,10 @@ GEM
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.8.5)
+    i18n (1.8.8)
       concurrent-ruby (~> 1.0)
-    listen (3.3.1)
+    json (2.5.1)
+    listen (3.4.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
@@ -55,50 +58,70 @@ GEM
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2020.1104)
-    minitest (5.14.2)
+    minitest (5.14.3)
     multi_xml (0.6.0)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    pry (0.13.1)
+    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)
-    rake (13.0.1)
+    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)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
+    rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.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.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.8)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.1)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
-  bundler (~> 2.1)
-  faker
+  bundler (~> 2.2)
+  faker (~> 2.15)
   guard-rspec (~> 4.3)
+  pry (~> 0.13)
   rake (~> 13.0)
   rspec (~> 3.9)
+  rubocop
   slack_messaging!
 
 BUNDLED WITH
-   2.1.4
+   2.2.9

data/Guardfile

@@ -1,4 +1,6 @@
-guard :rspec, cmd: 'bundle exec rspec', all_on_start: true, all_after_pass: 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/c74baada70ad96048dc7/maintainability)](https://codeclimate.com/github/emmasax4/slack_messaging/maintainability) ![Default](https://github.com/emmasax4/slack_messaging/workflows/Default/badge.svg)
+# 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.
 
@@ -26,47 +26,61 @@ gem install slack_messaging
 
 This project requires a config file that should look like this:
 
-```
+```yml
 slack:
-  channel: "#<AWESOME CHANNEL NAME>"
+  channel: <AWESOME CHANNEL NAME>
   username: <AWESOME USER NAME>
-  webhook_url: <WEBHOOK URL>
-  icon_emoji: ":<SOME EMOJI>:"
+  webhook_url: <SLACK 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:
+To generate this file at `~/.slack_messaging.yml`, please run this command:
 
+```bash
+slack-messaging setup
 ```
-$ slack-messaging --config="/PATH/TO/FILE/config.yml" slack
+
+To obtain the webhook URL, go to [this link](https://api.slack.com/messaging/webhooks).
+
+If you'd like to create the config file at a different directory, I recommend using the `setup` command, and then manually moving the file to your desired location:
+
+```bash
+slack-messaging setup
+# Walk through the prompts to create the file
+mv ~/.slack_messaging.yml /PATH/TO/FILE/config.yml
 ```
 
-To obtain the webhook url, go to [this link](https://api.slack.com/incoming-webhooks).
+And then you can pass in that specific file location like this:
 
-Okay, now the project will be ready to rock and roll.
+```bash
+slack-messaging --config="/PATH/TO/FILE/config.yml" send
+```
+
+Once the config file is set up, the project is ready to go!
 
 To print a friendly message to Slack, run:
 
-```
-slack-messaging slack
+```bash
+slack-messaging send
 ```
 
-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/emmasax4/slack_messaging/blob/main/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.
+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:
 
-```
-slack-messaging slack "MESSAGE 1"
+```bash
+slack-messaging send 'MESSAGE 1'
 ```
 
 You can even print multiple messages at once:
 
-```
-slack-messaging slack "MESSAGE 1" "MESSAGE 2" "MESSAGE 3" ... "MESSAGE N"
+```bash
+slack-messaging send 'MESSAGE 1' 'MESSAGE 2' 'MESSAGE 3' ... 'MESSAGE N'
 ```
 
 The output of slack_messaging will look something like this:
 
-<img src="https://github.com/emmasax4/slack_messaging/blob/main/OutputFile.png" width="1000">
+<img src="https://github.com/emmahsax/slack_messaging/blob/main/QuoteExample.png" width="500">
 
 I hope you enjoy printing fun and specialized messages to Slack!
 
@@ -76,11 +90,11 @@ To run the tests, run `bundle exec rspec` from the command line. GitHub Actions
 
 ## Contributing
 
-To submit a feature request, bug ticket, etc, please submit an official [GitHub Issue](https://github.com/emmasax4/slack_messaging/issues/new).
+To submit a feature request, bug ticket, etc, please submit an official [GitHub Issue](https://github.com/emmahsax/slack_messaging/issues/new).
 
-To report any security vulnerabilities, please view this project's [Security Policy](https://github.com/emmasax4/slack_messaging/security/policy).
+To report any security vulnerabilities, please view this project's [Security Policy](https://github.com/emmahsax/slack_messaging/security/policy).
 
-This repository does have a standard [Code of Conduct](https://github.com/emmasax4/slack_messaging/blob/main/.github/code_of_conduct.md).
+When interacting with this repository, please follow [Contributor Covenant's Code of Conduct](https://contributor-covenant.org).
 
 ## Releasing
 
@@ -88,7 +102,7 @@ To make a new release of this 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)
+3. Make a new release [here](https://github.com/emmahsax/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

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,23 +13,31 @@ version SlackMessaging::VERSION
 
 wrap_help_text :verbatim
 
-flag [:config], :desc => 'SlackMessaging 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|
-  c.action do |global_options, options, args|
-    SlackMessaging::Slack.execute(args, options)
+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::Send.execute(args, options)
   end
 end
 
-pre do |global,command,options,args|
-  SlackMessaging::Config.load(global[:config])
-  SlackMessaging::Config.set_config_options(global)
-  true
+desc 'Sets up a Slack Messaging config file at ~/.slack_messaging.yml'
+command 'setup' do |c|
+  c.action do
+    SlackMessaging::Setup.execute
+  end
 end
 
 exit run(ARGV)

data/lib/slack_messaging.rb

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

@@ -0,0 +1,35 @@
+# 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/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,30 +1,12 @@
+# frozen_string_literal: true
+
 module SlackMessaging
   class RandomMessage
-    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",
-    ]
-
-    attr_accessor :text
-
-    def initialize
-      self.text = MESSAGE_ARRAY[rand(MESSAGE_ARRAY.length)]
+    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']
+      "\"#{quote_content}\"\n—#{quote_author}"
     end
   end
 end

data/lib/slack_messaging/send.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SlackMessaging
+  class Send
+    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 |arg_message|
+          print_message(arg_message)
+        end
+      end
+    end
+
+    def self.print_message(message)
+      SlackMessaging::NotifySlack.new(message).perform
+    end
+  end
+end

data/lib/slack_messaging/setup.rb

@@ -0,0 +1,84 @@
+# 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)"
+        )
+        puts
+      else
+        answer = true
+      end
+
+      create_or_update_config_file(ask_config_questions) if answer
+    end
+
+    def self.create_or_update_config_file(answers)
+      contents = generate_config_file(answers)
+      puts "\nCreating or updating your #{default_config} file..."
+      File.open(default_config, 'w') { |file| file.puts contents }
+      puts "\nDone!"
+    end
+
+    def self.generate_config_file(answers)
+      file_contents = ''.dup
+      file_contents << "slack:\n"
+      file_contents << "  channel: #{answers[:channel].tr('#', '').strip}\n"
+      file_contents << "  username: #{answers[:username].strip}\n"
+      file_contents << "  webhook_url: #{answers[:webhook_url].strip}\n"
+      file_contents << "  icon_emoji: '#{answers[:icon_emoji].strip}'"
+      file_contents
+    end
+
+    def self.config_file_exists?
+      File.exist?(default_config)
+    end
+
+    # 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.'
+      )
+
+      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'
+
+      answers[:username] = ask_question(
+        "\nWhat slack username do you wish to post as? (default is \"Let's Get Quoty\")"
+      ) || "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:'
+
+      answers
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def self.ask_question(prompt)
+      answer = highline.ask(prompt)
+      answer.empty? ? nil : answer
+    end
+
+    def self.highline
+      @highline ||= SlackMessaging::HighlineCli.new
+    end
+
+    def self.default_config
+      SlackMessaging::DefaultPaths.config
+    end
+  end
+end

data/lib/slack_messaging/version.rb

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

data/spec/slack_messaging/config_spec.rb

@@ -1,17 +1,21 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'slack_messaging'
 
 describe SlackMessaging::Config do
+  subject { SlackMessaging::Config }
+
   context 'config key methods' do
     it 'should return nil when not set' do
-      expect(SlackMessaging::Config.doesnt_exist).to eql(nil)
-      expect(SlackMessaging::Config.doesnt_exist?).to eql(false)
+      expect(subject.doesnt_exist).to eql(nil)
+      expect(subject.doesnt_exist?).to eql(false)
     end
 
     it 'should return the config value when set' do
       config_value = Faker::Lorem.word
-      SlackMessaging::Config.new_value = config_value
-      expect(SlackMessaging::Config.new_value).to eql(config_value)
+      subject.new_value = config_value
+      expect(subject.new_value).to eql(config_value)
     end
   end
 
@@ -21,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
@@ -35,19 +39,19 @@ describe SlackMessaging::Config do
     before do
       allow(YAML).to receive(:load_file).and_return(config_file)
       allow(File).to receive(:exist?).and_return(true)
-      SlackMessaging::Config.load(Faker::Lorem.word)
+      subject.load(Faker::Lorem.word)
     end
 
     it 'calling a method corresponding to a key in the file should return the value' do
-      expect(SlackMessaging::Config.domain).to eql(domain)
-      expect(SlackMessaging::Config.slack).to be_kind_of(Hash)
-      expect(SlackMessaging::Config.slack[:slack_option]).to eql(true)
+      expect(subject.domain).to eql(domain)
+      expect(subject.slack).to be_kind_of(Hash)
+      expect(subject.slack[:slack_option]).to eql(true)
     end
 
     it 'overwriting values should work' do
-      expect(SlackMessaging::Config.slack).to be_kind_of(Hash)
-      SlackMessaging::Config.slack = sentence
-      expect(SlackMessaging::Config.slack).to eql(sentence)
+      expect(subject.slack).to be_kind_of(Hash)
+      subject.slack = sentence
+      expect(subject.slack).to eql(sentence)
     end
   end
 end

data/spec/slack_messaging/highline_cli_spec.rb

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

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
@@ -26,14 +28,16 @@ describe SlackMessaging::NotifySlack do
     SlackMessaging::Config.load(Faker::Lorem.word)
   end
 
+  subject { SlackMessaging::NotifySlack }
+
   it 'should call HTTParty' do
     expect(HTTParty).to receive(:post)
-    message = SlackMessaging::NotifySlack.new(sentence)
+    message = subject.new(sentence)
     message.perform
   end
 
-    it 'should define certain values' do
-    message = SlackMessaging::NotifySlack.new(sentence)
+  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)

data/spec/slack_messaging/random_message_spec.rb

@@ -1,24 +1,47 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'slack_messaging'
 
 describe SlackMessaging::RandomMessage do
+  let(:quote_object) { double(:quote_object, body: quote_json) }
+
+  let(:quote_json) do
+    "{\"_id\":\"4MRaRRKq4Tcg\",
+      \"tags\":[\"famous-quotes\"],
+      \"content\":\"There are two ways of spreading light: to be the candle or the mirror that reflects it.\",
+      \"author\":\"Edith Wharton\",\"length\":87
+    }"
+  end
+
+  before do
+    allow(HTTParty).to receive(:get).and_return(quote_object)
+  end
+
+  subject { SlackMessaging::RandomMessage }
+
   it 'should get a string message' do
-    message = SlackMessaging::RandomMessage.new
-    expect(message.text).to be_instance_of(String)
+    message = subject.acquire_random_quote
+    expect(message).to be_instance_of(String)
+  end
+
+  it 'should get a message that includes a newline' do
+    message = subject.acquire_random_quote
+    expect(message.include?("\n")).to eq(true)
   end
 
-  it 'should get a message greater than 25 characters' do
-    message = SlackMessaging::RandomMessage.new
-    expect(message.text.length).to be >= 50
+  it 'should get a message that includes a —' do
+    message = subject.acquire_random_quote
+    expect(message.include?('—')).to eq(true)
   end
 
-  it 'should get a message that includes a new line' do
-    message = SlackMessaging::RandomMessage.new
-    expect(message.text.include?("\n")).to eq(true)
+  it 'should use HTTParty to ping an API' do
+    expect(HTTParty).to receive(:get)
+    subject.acquire_random_quote
   end
 
-  it 'should get a message that includes a --' do
-    message = SlackMessaging::RandomMessage.new
-    expect(message.text.include?('--')).to eq(true)
+  it 'should have the JSON parse the response content twice' do
+    expect(JSON).to receive(:parse).at_least(2).times.and_return(JSON.parse(quote_json))
+    subject.acquire_random_quote
   end
 end

data/spec/slack_messaging/setup_spec.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+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(:answers) do
+    {
+      channel: Faker::Lorem.word,
+      username: Faker::Lorem.word,
+      webhook_url: Faker::Internet.url,
+      icon_emoji: ":#{Faker::Lorem.word}:"
+    }
+  end
+
+  before do
+    allow(SlackMessaging::HighlineCli).to receive(:new).and_return(highline_cli)
+    allow(subject).to receive(:puts)
+  end
+
+  after do
+    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)
+      allow(subject).to receive(:ask_config_questions).and_return(true)
+      subject.execute
+    end
+
+    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)
+      expect(subject).to receive(:create_or_update_config_file).and_return(true)
+      expect(subject).to receive(:ask_config_questions).and_return(true)
+      subject.execute
+    end
+
+    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)
+      subject.execute
+    end
+  end
+
+  describe '#self.create_or_update_config_file' do
+    it 'should generate the file based on the answers to the questions' do
+      expect(subject).to receive(:generate_config_file)
+      allow(File).to receive(:open).and_return(nil)
+      subject.send(:create_or_update_config_file, answers)
+    end
+
+    it 'should open the file for writing' do
+      allow(subject).to receive(:generate_config_file)
+      expect(File).to receive(:open).and_return(nil)
+      subject.send(:create_or_update_config_file, answers)
+    end
+  end
+
+  describe '#self.generate_config_file' do
+    it 'returns a string' do
+      expect(subject.send(:generate_config_file, answers)).to be_a(String)
+    end
+  end
+
+  describe '#self.config_file_exists?' do
+    it 'should return true if the file exists' do
+      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(:exist?).and_return(false)
+      expect(subject.send(:config_file_exists?)).to eq(false)
+    end
+  end
+
+  describe '#self.ask_question' do
+    it 'should use highline to ask a question' do
+      expect(highline_cli).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('')
+      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)
+      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
+      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)
+    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.'
+      ).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:'
+        }
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'faker'
+require 'pry'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
@@ -33,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: 1.4.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Emma Sax
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-19 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,16 +70,30 @@ dependencies:
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -100,28 +114,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.15'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -164,9 +192,22 @@ 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:
-- emma.sax4@gmail.com
 executables:
 - slack-messaging
 extensions: []
@@ -176,22 +217,26 @@ files:
 - Gemfile.lock
 - Guardfile
 - LICENSE
-- OutputFile.png
+- QuoteExample.png
 - README.md
 - Rakefile
 - bin/slack-messaging
 - 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/slack.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
 - spec/spec_helper.rb
-homepage: https://github.com/emmasax4/slack_messaging
+homepage: https://github.com/emmahsax/slack_messaging
 licenses:
 - MIT
 metadata: {}
@@ -203,19 +248,21 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Personalized Slack Messages
 test_files:
 - spec/spec_helper.rb
 - spec/slack_messaging/config_spec.rb
-- spec/slack_messaging/random_message_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/slack.rb

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