slack_messaging 1.3.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21d4c79502e68eea2cf007a81f3a1e49a1f2b3fc670a68515f91d2671470c7b6
-  data.tar.gz: 013f88ec707d9bea10b2186962bd4b82e0106cb8754185f0fedb9448b8e3dfb4
+  metadata.gz: bd3e90f703693ae103c78862c1c506cc48dcab4f04065d4aee1b6e60a9cab9da
+  data.tar.gz: 9cf11baa6f0d033e3c944a7a6d30255eb4ed94233a3a54cfa277c59566bdd91b
 SHA512:
-  metadata.gz: d4cc5277991115cb449882eb7f069b6eb135c2c0d944692fbab654c2938c84441ab6bd3b0c9c47f748402d5b8390d34fe2a65ee433b165b3c10df1f230b4d672
-  data.tar.gz: bb984c22a6a030630daec5848b91fcc73dd5a08090a2711878895741f8cc3317dbc37182a918b00e33b0790a69024f4a251cbfd13aabf214a7ae39f1d24a9c70
+  metadata.gz: cc3b3d202c84093c07a6d0aae39f05dad04aa16a7b28fb66a57b4399e4f1bccdff049909d92fba9a56431a4171422d589a3b616c56b7ee72dad2aca0d48e5560
+  data.tar.gz: cab8ff992b73a96e41f4f8cb996df80b644ec304a58292d728f54ba5b3965695d4421c5f1df6819aad530981be893a1bfe8fb2c51cf2338142440787f3eff390

data/Gemfile.lock

@@ -1,27 +1,30 @@
 PATH
   remote: .
   specs:
-    slack_messaging (1.3.1)
+    slack_messaging (2.2.0)
       activesupport (~> 6.0)
       gli (~> 2.10)
       hashie (~> 4.1)
       highline (~> 2.0)
+      httparty (~> 0.18)
+      json (~> 2.5)
       rack (~> 2.2)
-      slack-notifier (~> 1.5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.3)
+    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)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
-    ffi (1.13.1)
+    faker (2.15.1)
+      i18n (>= 1.6, < 2)
+    ffi (1.14.2)
     formatador (0.2.5)
     gli (2.19.2)
     guard (2.16.2)
@@ -40,56 +43,64 @@ GEM
       rspec (>= 2.99.0, < 4.0)
     hashie (4.1.0)
     highline (2.0.3)
-    i18n (1.8.5)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.8)
       concurrent-ruby (~> 1.0)
-    listen (3.2.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)
     method_source (1.0.0)
-    minitest (5.14.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    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)
+    pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rack (2.2.3)
-    rake (13.0.1)
+    rake (13.0.3)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.3)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    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.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     shellany (0.0.1)
-    slack-notifier (1.5.1)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
-  bundler (~> 2.1)
+  bundler (~> 2.2)
+  faker (~> 2.15)
   guard-rspec (~> 4.3)
+  pry (~> 0.13)
   rake (~> 13.0)
   rspec (~> 3.9)
   slack_messaging!
 
 BUNDLED WITH
-   2.1.4
+   2.2.9

data/Guardfile

@@ -1,5 +1,5 @@
-guard :rspec, cmd: 'bundle exec rspec', all_on_start: true, all_after_pass: true  do
+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" }
+  watch('spec/spec_helper.rb')  { 'spec' }
 end

data/LICENSE

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

data/README.md

@@ -1,4 +1,4 @@
-# Slack Messaging [![Maintainability](https://api.codeclimate.com/v1/badges/c74baada70ad96048dc7/maintainability)](https://codeclimate.com/github/emmasax4/slack_messaging/maintainability) ![Develop](https://github.com/emmasax4/slack_messaging/workflows/Develop/badge.svg)
+# 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)
 
 This is a simple project designed to post messages to a given Slack channel as a bot.
 
@@ -12,57 +12,75 @@ gem 'slack_messaging'
 
 And then execute:
 
-    $ bundle
+```bash
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install slack_messaging
+```bash
+gem install slack_messaging
+```
 
 ### Usage
 
 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" slack
+```
+
+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
 ```
 
-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 slack 'MESSAGE 1'
 ```
 
 You can even print multiple messages at once:
 
-```
-slack-messaging slack "MESSAGE 1" "MESSAGE 2" "MESSAGE 3" ... "MESSAGE N"
+```bash
+slack-messaging slack 'MESSAGE 1' 'MESSAGE 2' 'MESSAGE 3' ... 'MESSAGE N'
 ```
 
 The output of slack_messaging will look something like this:
 
-<img src="https://github.com/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!
 
@@ -72,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
 
@@ -84,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 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/bin/slack-messaging

@@ -10,23 +10,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 """
 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|
+    SlackMessaging::Config.load(global[:config])
+    true
+  end
+
   c.action do |global_options, options, args|
-    SlackMessaging::Slack.execute(args, options) # args are optional string to print
+    SlackMessaging::Slack.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,4 +1,10 @@
-Dir[File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), 'slack_messaging')) + "/**/*.rb"].each do |file|
+require 'yaml'
+require 'hashie'
+require 'httparty'
+require 'highline'
+require 'json'
+
+Dir[File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), 'slack_messaging')) + '/**/*.rb'].each do |file|
   require_relative file
 end
 

data/lib/slack_messaging/config.rb

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

data/lib/slack_messaging/default_paths.rb

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

data/lib/slack_messaging/highline_cli.rb

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

data/lib/slack_messaging/random_message.rb

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

data/lib/slack_messaging/setup.rb

@@ -0,0 +1,81 @@
+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
+      end
+
+      create_or_update_config_file(ask_config_questions)
+    end
+
+    private
+
+    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 = ''
+      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.exists?(default_config)
+    end
+
+    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."
+      )
+
+      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
+
+    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/slack.rb

@@ -1,15 +1,11 @@
-require 'highline'
-
 module SlackMessaging
   class Slack
-    class << self
-      attr_accessor :options
-    end
+    attr_accessor :options
 
-    def self.execute(args, options=nil)
+    def self.execute(args, options = nil)
       if args.empty?
-        message = SlackMessaging::RandomMessage.new # generate a new random message
-        print_message(message.get_text)
+        message = SlackMessaging::RandomMessage.acquire_random_quote
+        print_message(message)
       else
         args.each do |message|
           print_message(message)
@@ -17,9 +13,10 @@ module SlackMessaging
       end
     end
 
+    private
+
     def self.print_message(message)
-      slack_job = SlackMessaging::NotifySlack.new(message)
-      slack_job.perform
+      SlackMessaging::NotifySlack.new(message).perform
     end
   end
 end

data/lib/slack_messaging/version.rb

@@ -1,3 +1,3 @@
 module SlackMessaging
-  VERSION = "1.3.1"
+  VERSION = '2.2.0'
 end

data/spec/slack_messaging/config_spec.rb

@@ -1,44 +1,55 @@
 require 'spec_helper'
 require 'slack_messaging'
 
-module SlackMessaging
-  describe Config do
-
-    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)
-      end
-      it "should return the config value when set" do
-        SlackMessaging::Config.new_value = "testing"
-        expect(SlackMessaging::Config.new_value).to eql("testing")
-      end
+describe SlackMessaging::Config do
+  subject { SlackMessaging::Config }
+
+  context 'config key methods' do
+    it 'should return nil when not set' do
+      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
+      subject.new_value = config_value
+      expect(subject.new_value).to eql(config_value)
+    end
+  end
+
+  context 'after loading a config file' do
+    let(:domain) { Faker::Internet.domain_name }
+    let(:sentence) { Faker::Lorem.sentence }
+
+    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
+        }
+      }
+    end
+
+    before do
+      allow(YAML).to receive(:load_file).and_return(config_file)
+      allow(File).to receive(:exist?).and_return(true)
+      subject.load(Faker::Lorem.word)
+    end
+
+    it 'calling a method corresponding to a key in the file should return the value' do
+      expect(subject.domain).to eql(domain)
+      expect(subject.slack).to be_kind_of(Hash)
+      expect(subject.slack[:slack_option]).to eql(true)
     end
 
-    context "after loading a config file" do
-      before do
-        config_file = {"domain" => "example_domain",
-                       "slack" => {"slack_option" => true,
-                                   "username" => "Rspec Tester",
-                                   "icon_url" => "http://fake.url",
-                                   "channel" => "#test-channel",
-                                   "webhook" => "https://slack.web.hook"}}
-        allow(YAML).to receive(:load_file).and_return(config_file)
-        allow(File).to receive(:exist?).and_return(true)
-        SlackMessaging::Config.load("dummy/path")
-      end
-
-      it "calling a method corresponding to a key in the file should return the value" do
-        expect(SlackMessaging::Config.domain).to eql("example_domain")
-        expect(SlackMessaging::Config.slack).to be_kind_of(Hash)
-        expect(SlackMessaging::Config.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 = "this is a string now"
-        expect(SlackMessaging::Config.slack).to eql("this is a string now")
-      end
+    it 'overwriting values should work' do
+      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,49 @@
+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, ['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)
+    end
+  end
+end

data/spec/slack_messaging/notify_slack_spec.rb

@@ -1,34 +1,45 @@
 require 'spec_helper'
 require 'slack_messaging'
 
-module SlackMessaging
-  describe NotifySlack do
-    before :each do
-      config_file = {"slack" => {"channel" => "#random-test-channel",
-                                 "username" => "Random User",
-                                 "webhook_url" => "https://hooks.slack.com/services/totallyrandom/fakewebhookurl",
-                                 "icon_emoji" => ":wine_glass:"}
-                    }
-      allow(YAML).to receive(:load_file).and_return(config_file)
-      allow(File).to receive(:exist?).and_return(true)
-      SlackMessaging::Config.load("dummy/path")
-    end
+describe SlackMessaging::NotifySlack do
+  let(:sentence) { Faker::Lorem.sentence }
+  let(:channel) { Faker::Lorem.word }
+  let(:username) { Faker::Name.name }
+  let(:webhook) { Faker::Internet.url }
+  let(:emoji) { Faker::Internet.url }
 
-    it 'should ping Slack Notifier' do
-      notifier = double('notifier', ping: true)
-      allow(::Slack::Notifier).to receive(:new).and_return(notifier)
-      expect(notifier).to receive(:ping).and_return(true)
-      message = NotifySlack.new("Test message")
-      message.perform
-    end
+  let(:config_file) do
+    {
+      'slack': {
+        'slack_option': true,
+        'username': username,
+        'icon_emoji': emoji,
+        'channel': channel,
+        'webhook_url': webhook
+      }
+    }
+  end
+
+  before :each 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)
+  end
+
+  subject { SlackMessaging::NotifySlack }
+
+  it 'should call HTTParty' do
+    expect(HTTParty).to receive(:post)
+    message = subject.new(sentence)
+    message.perform
+  end
 
-     it 'should define certain values' do
-      message = NotifySlack.new("Test message")
-      expect(message.text).to eq("Test message")
-      expect(message.channel).to eq("#random-test-channel")
-      expect(message.username).to eq("Random User")
-      expect(message.webhook_url).to eq("https://hooks.slack.com/services/totallyrandom/fakewebhookurl")
-      expect(message.icon_emoji).to eq(":wine_glass:")
-    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)
   end
 end

data/spec/slack_messaging/random_message_spec.rb

@@ -1,27 +1,45 @@
 require 'spec_helper'
 require 'slack_messaging'
 
-module SlackMessaging
-  describe RandomMessage do
-
-    it "should get a string message" do
-      message = RandomMessage.new
-      expect(message.get_text).to be_instance_of(String)
-    end
-
-    it "should get a message greater than 25 characters" do
-      message = RandomMessage.new
-      expect(message.get_text.length).to be >= 50
-    end
-
-    it "should get a message that includes a new line" do
-      message = RandomMessage.new
-      expect(message.get_text.include?("\n")).to eq(true)
-    end
-
-    it "should get a message that includes a '--'" do
-      message = RandomMessage.new
-      expect(message.get_text.include?("--")).to eq(true)
-    end
+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 = 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 that includes a —' do
+    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)
+    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))
+    subject.acquire_random_quote
   end
 end

data/spec/slack_messaging/setup_spec.rb

@@ -0,0 +1,132 @@
+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(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 exit if the user opts not to continue' do
+      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)
+    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(:exists?).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)
+      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,3 +1,6 @@
+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`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_messaging
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Emma Sax
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-02 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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
@@ -81,33 +109,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: slack-notifier
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.1
-  type: :runtime
+        version: '2.2'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.15'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,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
@@ -152,7 +194,6 @@ dependencies:
         version: '3.9'
 description: Sending Personalized Slack Messages to a Slack channel of your choice.
 email:
-- emma.sax4@gmail.com
 executables:
 - slack-messaging
 extensions: []
@@ -162,22 +203,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/output.rb
 - lib/slack_messaging/random_message.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
 - 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: {}
@@ -196,12 +241,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+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/output.rb

@@ -1,13 +0,0 @@
-require 'highline'
-
-module SlackMessaging
-  module Output
-    def self.terminal
-      @terminal ||= HighLine.new
-    end
-
-    def self.ask(*args, &block)
-      terminal.ask(*args, &block)
-    end
-  end
-end