slack_messaging 2.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6ace0c951c1c91d3e1e55ecfaf4c07979b7bbea225d89e55e73c63a1c51e5a4
-  data.tar.gz: 18d9438426df6aa452ba1946c773b63befe71e5e28d2f0e4dc761a14c41952f4
+  metadata.gz: 12ec2e4beafc03f085a3a1752070bce7e030cd02e1e57378229400f39a2284ee
+  data.tar.gz: f6c4e26dcb8799058f144e24aee9ddf1d4f2f05c0b91deba9f19d5cd1d414303
 SHA512:
-  metadata.gz: c754f66c000c328697834a8d139587632849b94e4809e924847088a3c7a7b78f6ff3291e252235fdb28aa7d048e2ca8104c3b48764919fe4c65d0fe4c57832b6
-  data.tar.gz: 24c2befeb5629d2e7b6a40a3ca761c3dcc00a91cff80a415c2f32a311b9b9705800ee766a0b4c2e621ff011b3763997061eae1f977951803e96bd0dd78895785
+  metadata.gz: c3dff63c5569a13e0a713b2e34ca6ef7f22a7ce858523bee5a8483b59b8c17d7053302e3a0f25a670b2ff3ce794f8bd1aef25500e2766594e51b2f35d12ad8ea
+  data.tar.gz: 41dc15d6314e4ae1721b2e26163b1e4d6f006f9c7ae6ed93d5ff394b29e98f6399e16f604515eefa54663cb6328356fd31843d6da5228bdf92173889b0380c98

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

@@ -0,0 +1,129 @@
+PATH
+  remote: .
+  specs:
+    slack_messaging (3.1.0)
+      activesupport (~> 6.0)
+      gli (~> 2.10)
+      hashie (~> 4.1)
+      highline_wrapper (~> 1.0)
+      httparty (~> 0.18)
+      json (~> 2.5)
+      rack (~> 2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.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.8)
+    diff-lcs (1.4.4)
+    faker (2.16.0)
+      i18n (>= 1.6, < 2)
+    ffi (1.14.2)
+    formatador (0.2.5)
+    gli (2.20.0)
+    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)
+    highline_wrapper (1.0.0)
+      highline (~> 2.0)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    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)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    minitest (5.14.4)
+    multi_xml (0.6.0)
+    nenv (0.3.0)
+    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)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.11.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
+  x86_64-darwin-20
+
+DEPENDENCIES
+  bundler (~> 2.2)
+  faker (~> 2.15)
+  guard-rspec (~> 4.3)
+  pry (~> 0.13)
+  rake (~> 13.0)
+  rspec (~> 3.9)
+  rubocop (~> 1.10)
+  slack_messaging!
+
+BUNDLED WITH
+   2.2.4

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/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,59 +26,73 @@ gem install slack_messaging
 
 This project requires a config file that should look like this:
 
-```
+```yml
 slack:
   channel: <AWESOME CHANNEL NAME>
   username: <AWESOME USER NAME>
   webhook_url: <SLACK WEBHOOK URL>
-  icon_emoji: ":<SOME EMOJI>:"
+  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. The random quotes are selected using the [Quotable API](http://api.quotable.io/).
+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/QuoteExample.png" width="500">
+<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!
 
 ### 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
 
-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).
 
 When interacting with this repository, please follow [Contributor Covenant's Code of Conduct](https://contributor-covenant.org).
 
@@ -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,32 @@ 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
+"
+
+pre do |global, _command, _options, _args|
+  SlackMessaging::Config.load(global[:config])
+  true
+end
 
 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|
+  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'
+skips_pre
+command 'setup' do |c|
+  c.action do
+    SlackMessaging::Setup.execute
+  end
 end
 
 exit run(ARGV)

data/lib/slack_messaging.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'hashie'
 require 'httparty'
-require 'highline'
+require 'highline_wrapper'
 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,27 +1,30 @@
+# frozen_string_literal: true
+
 module SlackMessaging
   class Config
-    def self.config
-      config_data.to_hash
-    end
+    class << self
+      def method_missing(method, args = false)
+        config_data.send(method, args)
+      end
 
-    def self.load(path)
-      load_config(path)
-      config
-    end
+      def load(path)
+        load_config(path)
+        config
+      end
 
-    private
+      private def config
+        config_data.to_hash
+      end
 
-    def self.config_data
-      @config_data ||= Hashie::Mash.new
-    end
+      private def config_data
+        @config_data ||= Hashie::Mash.new
+      end
 
-    def self.method_missing(method, args = false)
-      config_data.send(method, args)
-    end
+      private def load_config(file)
+        raise StandardError, "Missing configuration file: #{file}" unless File.exist?(file)
 
-    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) }
+        YAML.load_file(file).each { |key, value| config_data.assign_property(key, value) }
+      end
     end
   end
 end

data/lib/slack_messaging/default_paths.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module SlackMessaging
   class DefaultPaths
-    def self.config
-      File.join(self.home, '.slack_messaging.yml')
-    end
-
-    private
+    class << self
+      def config
+        File.join(home, '.slack_messaging.yml')
+      end
 
-    def self.home
-      ENV['HOME'] ? ENV['HOME'] : '.'
+      private def home
+        ENV['HOME'] || '.'
+      end
     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,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/send.rb

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

data/lib/slack_messaging/setup.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module SlackMessaging
+  class Setup
+    class << self
+      # rubocop:disable Style/ConditionalAssignment
+      def 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)",
+            { required: true }
+          )
+        else
+          answer = true
+        end
+
+        create_or_update_config_file(ask_config_questions) if answer
+      end
+      # rubocop:enable Style/ConditionalAssignment
+
+      private def create_or_update_config_file(answers)
+        contents = generate_config_file(answers)
+        puts "Creating or updating your #{default_config} file..."
+        File.open(default_config, 'w') { |file| file.puts contents }
+        puts "\nDone!"
+      end
+
+      private def 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
+
+      private def config_file_exists?
+        File.exist?(default_config)
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      private def 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.',
+          required: true
+        )
+
+        answers[:channel] = ask_question(
+          'What slack channel do you wish to post to? (default is "#general")'
+        ) || 'general'
+
+        answers[:username] = ask_question(
+          "What slack username do you wish to post as? (default is \"Let's Get Quoty\")"
+        ) || "Let's Get Quoty"
+
+        answers[:icon_emoji] = ask_question(
+          'What 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
+
+      private def ask_question(prompt, required: false)
+        answer = highline.ask(prompt, { required: required })
+        answer.empty? ? nil : answer
+      end
+
+      private def highline
+        @highline ||= HighlineWrapper.new
+      end
+
+      private def default_config
+        SlackMessaging::DefaultPaths.config
+      end
+    end
+  end
+end

data/lib/slack_messaging/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackMessaging
-  VERSION = '2.1.0'
+  VERSION = '3.1.1'
 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/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,18 +28,18 @@ describe SlackMessaging::NotifySlack do
     SlackMessaging::Config.load(Faker::Lorem.word)
   end
 
+  subject { SlackMessaging::NotifySlack.new(sentence) }
+
   it 'should call HTTParty' do
     expect(HTTParty).to receive(:post)
-    message = SlackMessaging::NotifySlack.new(sentence)
-    message.perform
+    subject.perform
   end
 
-    it 'should define certain values' do
-    message = SlackMessaging::NotifySlack.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)
+  it 'should define certain values' do
+    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/random_message_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'slack_messaging'
 
@@ -16,28 +18,30 @@ describe SlackMessaging::RandomMessage do
     allow(HTTParty).to receive(:get).and_return(quote_object)
   end
 
+  subject { SlackMessaging::RandomMessage }
+
   it 'should get a string message' do
-    message = SlackMessaging::RandomMessage.acquire_random_quote
+    message = subject.acquire_random_quote
     expect(message).to be_instance_of(String)
   end
 
   it 'should get a message that includes a newline' do
-    message = SlackMessaging::RandomMessage.acquire_random_quote
+    message = subject.acquire_random_quote
     expect(message.include?("\n")).to eq(true)
   end
 
   it 'should get a message that includes a —' do
-    message = SlackMessaging::RandomMessage.acquire_random_quote
+    message = subject.acquire_random_quote
     expect(message.include?('—')).to eq(true)
   end
 
   it 'should use HTTParty to ping an API' do
     expect(HTTParty).to receive(:get)
-    SlackMessaging::RandomMessage.acquire_random_quote
+    subject.acquire_random_quote
   end
 
   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))
-    SlackMessaging::RandomMessage.acquire_random_quote
+    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(:highline_wrapper) { double(:highline_wrapper, ask: Faker::Lorem.word, 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(HighlineWrapper).to receive(:new).and_return(highline_wrapper)
+    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_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
+    end
+
+    it 'should call to create or update the config file' do
+      allow(File).to receive(:exists?).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
+    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_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
+    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_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_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_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.and_return(Faker::Lorem.word)
+      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(
+        "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).with(
+        'What slack channel do you wish to post to? (default is "#general")'
+      ).and_return(nil)
+      allow(subject).to receive(:ask_question).with(
+        "What slack username do you wish to post as? (default is \"Let's Get Quoty\")"
+      ).and_return(nil)
+      allow(subject).to receive(:ask_question).with(
+        'What 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

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.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Emma Sax
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2021-03-04 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: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -192,15 +192,29 @@ 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: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
 description: Sending Personalized Slack Messages to a Slack channel of your choice.
 email:
-- emma.sax4@gmail.com
 executables:
 - slack-messaging
 extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - LICENSE
 - QuoteExample.png
@@ -212,13 +226,15 @@ files:
 - lib/slack_messaging/default_paths.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/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: {}
@@ -230,7 +246,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:
   - - ">="
@@ -246,3 +262,4 @@ test_files:
 - spec/slack_messaging/config_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,22 +0,0 @@
-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