boty 0.0.17 → 0.0.17.1

data/spec/boty/slack/users_spec.rb

@@ -0,0 +1,44 @@
+module Boty
+  module Slack
+    RSpec.describe Users do
+      subject(:users) { described_class.new }
+
+      let(:action) { :info }
+
+      let(:url) {
+        "https://slack.com/api/users.#{action}?"+
+        "token=#{ENV['SLACK_BOT_API_TOKEN']}"
+      }
+
+      before do
+        allow(Slack::URL).to receive(:get).with(url + "&user=U023BECGF").
+          and_return(
+            {
+              "ok" => true,
+              "user" => {
+                  "id" => "U023BECGF",
+                  "name" => "julian"
+              }
+            }
+        )
+      end
+
+      describe "#info" do
+        it "calls Slack::URL get with token and user" do
+          expect(Slack::URL).to receive(:get).with(url + "&user=U023BECGF")
+
+          users.info "U023BECGF"
+        end
+
+        it "returns a channel object with the im channel information" do
+          expect(Slack::URL).to receive(:get).with(url + "&user=U023BECGF")
+
+          user = users.info("U023BECGF")
+
+          expect(user.id).to eq "U023BECGF"
+          expect(user.name).to eq "julian"
+        end
+      end
+    end
+  end
+end

data/spec/happy_path_spec.rb

@@ -0,0 +1,88 @@
+require "spec_helper"
+
+module Boty
+  RSpec.describe "happy pathy with integration", :project, :session do
+    def start_session(only_knows: nil)
+      executable_bot = File.read "bot"
+      @session = instance_eval executable_bot, "bot", 1
+
+      if only_knows
+        extra_to_remove = bot.know_how.keys - only_knows
+        extra_to_remove.each do |command_desc|
+          bot.no command_desc
+        end
+      end
+    end
+
+    def message(message)
+      faye.message(message, {user: current_user_id})
+    end
+
+    let(:bot_name) { "boty" }
+
+    # I know =(, hard to understand, check the spec/support/slack_support
+    # TODO: enhance this =)
+    let(:current_user) { user_name }
+    let(:current_user_id) { user_id }
+
+    before do
+      @dir = Dir.pwd
+      dry_run
+      capture(:stdout) do
+        create_bot bot_name, company: "omg", api_key: "lol"
+      end
+    end
+
+    after do
+      Dir.chdir @dir
+      Boty.locale = :en
+    end
+
+    it "creates the bot directory" do
+      expect(Dir.exists? bot_name).to eq true
+    end
+
+    context "on the bot directory" do
+      before do
+        Dir.chdir bot_name
+      end
+
+      it "connects to the server and hear it's name" do
+        expect(Faye::WebSocket::Client).to receive(:new).with(rtm_ws_url)
+        start_session
+
+        expect(bot).to receive(:say).
+          with "Ohay <@#{current_user}>! I'm here, that's for sure."
+        message "hey boty!"
+      end
+
+      describe "knows" do
+        before do
+          start_session only_knows: ['knows']
+        end
+
+        it "responds in particular with the known commands and handlers" do
+          # check that a im arrived to the current user with knows result
+          message = "```\nknows: List all the commands known by this bot.\n```"
+          expect{ message "<@boty>: knows" }.
+            to send_im(current_user_id, message)
+        end
+      end
+
+      it "overrides default locale with the project specific one" do
+        File.open("locale/xpto.yml", "w") do |file|
+          file.write(%{xpto:
+  scripts:
+    knows: "Wow! Such commands!"})
+        end
+        start_session only_knows: ['knows']
+        ::Boty.locale = :xpto
+
+        message = "```\nknows: List all the commands known by this bot.\n```"
+
+        expect{ message "<@boty>: knows" }.
+          to send_im(current_user_id, message)
+      end
+    end
+  end
+end

data/spec/script/i18n_spec.rb

@@ -0,0 +1,22 @@
+RSpec.describe "I18n on default scripts", :session do
+  after do
+    Boty.locale = :en
+  end
+
+  it "describes scripts in :en locale (default)" do
+    session = Boty::Session.new
+    session.start do |bot|
+      expect(bot.know_how["knows"]).
+        to eq "List all the commands known by this bot."
+    end
+  end
+
+  it "describes scripts in :pt-br local when forced" do
+    Boty.locale = :"pt-br"
+    session = Boty::Session.new
+    session.start do |bot|
+      expect(bot.know_how["knows"]).
+        to eq "Lista os comandos conhecidos por esse bot."
+    end
+  end
+end

data/spec/script/knows_spec.rb

@@ -0,0 +1,18 @@
+RSpec.describe "script/knows", :session do
+  before do
+    start_session
+
+    extra_to_remove = bot.know_how.keys - ['knows', 'pug me']
+    extra_to_remove.each do |command_desc|
+      bot.no command_desc
+    end
+  end
+
+  it "formats the output indenting by the command name size" do
+    expect(bot).to receive(:im).
+      with %{```\n knows: List all the commands known by this bot.
+pug me: Send some nice pug in the channel.
+```}
+    faye.message "<@jeeba>: knows"
+  end
+end

data/spec/script/pug_spec.rb

@@ -0,0 +1,53 @@
+require "faraday"
+
+RSpec.describe "script/pug", :session do
+  before do
+    start_session
+  end
+
+  describe "pug me", :faraday do
+    before do
+      requests.get("/random") { |env|
+        [200,
+         { "Content-Type" => "application/json;charset=utf-8" },
+         {pug: "some_pug"}.to_json]
+      }
+    end
+
+    it "displays a pug" do
+      expect(bot).to receive(:say).with "<some_pug>"
+
+      faye.message "<@jeeba>:pug me"
+    end
+  end
+
+  describe "pug bomb x", :faraday do
+    it "displays x pugs" do
+      requests.get("/bomb") { |env|
+        expect(env.params).to eq "count" => "3"
+        [200,
+         { "Content-Type" => "application/json;charset=utf-8" },
+         { pugs: ["1", "2", "3"] }.to_json]
+      }
+      (1..3).each do |num|
+        expect(bot).to receive(:say).with("<#{num}>")
+      end
+
+      faye.message "<@jeeba>: pug bomb 3"
+    end
+
+    it "defaults to 5 pugs when no count is given" do
+      requests.get("/bomb") { |env|
+        expect(env.params).to eq "count" => "5"
+        [200,
+         { "Content-Type" => "application/json;charset=utf-8" },
+         { pugs: ["1", "2", "3", "4", "5"] }.to_json]
+      }
+      (1..5).each do |num|
+        expect(bot).to receive(:say).with("<#{num}>")
+      end
+
+      faye.message "<@jeeba>: pug bomb"
+    end
+  end
+end

data/spec/script/remember_spec.rb

@@ -0,0 +1,43 @@
+RSpec.describe "script/brain", :session do
+  before do
+    allow(::Boty::Slack.users).to receive(:info).with("U9876").and_return(
+      ::Boty::Slack::User.new({
+        "id" => "U9876",
+        "name" => "valeriano"
+      })
+    )
+
+    allow(::Boty::Slack.users).to receive(:info).with("U7777").and_return(
+      ::Boty::Slack::User.new({
+        "id" => "U7777",
+        "name" => "julian"
+      })
+    )
+
+    start_session
+  end
+
+  it "stores something about the user issuing the command" do
+    expect(bot).to receive(:im).
+      with "No worries, your secrets aren't safe with me... oh wait..."
+
+    faye.message "<@#{bot.name}>: remember I'm at the dentist until 12pm",
+      user: "U9876"
+
+    expect(bot.brain[:user]["valeriano"].first).to eq "I'm at the dentist until 12pm"
+  end
+
+  it "recovers information from the brain" do
+    allow(bot).to receive(:im)
+    faye.message "<@#{bot.name}>: remember I'm at the dentist until 12pm",
+      user: "U9876"
+
+    expect(bot).to receive(:im).
+      with("julian, I'm searching my user database for valeriano:\n")
+    expect(bot).to receive(:im).
+      with("```\n - I'm at the dentist until 12pm\n```")
+
+    faye.message "<@#{bot.name}>: about user valeriano",
+      user: "U7777"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$:.unshift File.expand_path("..", __FILE__)
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+begin
+  require "byebug"
+  require "rubinius/debugger"
+rescue LoadError
+end
+require "boty"
+
+Dir['./spec/support/**/*.rb'].each { |f| require f }
+
+RSpec.configure do |config|
+  config.include EMSupport, em: true
+  config.include FayeSupport, faye: true
+  config.include FakeFSSupport, fakefs: true
+  config.include SessionSupport, session: true
+  config.include ThorSupport, thor: true
+  config.include TemplateProjectSupport, project: true
+  config.include FaradaySupport, faraday: true
+
+  config.include SlackSupport::Users, users: true
+
+  Boty::Logger.adapter = Boty::Logger::Null.new
+end

data/spec/support/em_support.rb

@@ -0,0 +1,13 @@
+module EMSupport
+  def self.included(base)
+    base.instance_eval do
+      before do
+        allow(EM).to receive(:run).and_yield
+      end
+
+      around do |example|
+        example.run
+      end
+    end
+  end
+end

data/spec/support/fakefs_support.rb

@@ -0,0 +1,13 @@
+module FakeFSSupport
+  def self.included(base)
+    require "fakefs/safe"
+
+    base.instance_eval do
+      around do |example|
+        FakeFS do
+          example.run
+        end
+      end
+    end
+  end
+end

data/spec/support/faraday_support.rb

@@ -0,0 +1,15 @@
+module FaradaySupport
+  def self.included(base)
+    base.instance_eval do
+
+      let(:requests) { Faraday::Adapter::Test::Stubs.new }
+
+      around do |example|
+        adapter = Faraday.default_adapter
+        Faraday.default_adapter = [:test, requests]
+        example.run
+        Faraday.default_adapter = adapter
+      end
+    end
+  end
+end

data/spec/support/faye_support.rb

@@ -0,0 +1,34 @@
+module FayeSupport
+  class FakeFaye
+    def on(type, &block)
+      @events ||= {}
+      @events[type] ||= []
+      @events[type] << block
+    end
+
+    def send_event(type, data)
+      Array(Hash(@events)[type]).each do |block| block.call(data) end
+    end
+
+    def message(message, extra_args = {})
+      send_event(:message, OpenStruct.new(data: {
+        "type" => "message",
+        "text" => message }.merge(extra_args).to_json)
+      )
+    end
+  end
+
+  def self.included(base)
+    base.instance_eval do
+      let(:faye) { FakeFaye.new }
+
+      before do
+        allow(Faye::WebSocket::Client).to receive(:new).and_return faye
+      end
+
+      around do |example|
+        example.run
+      end
+    end
+  end
+end

data/spec/support/file_system_matchers.rb

@@ -0,0 +1,19 @@
+RSpec::Matchers.define :create_directory do |dir_name|
+  match do |block|
+    return false if Dir.exists? dir_name # change this to use a proper message
+    block.call
+    Dir.exists? dir_name
+  end
+
+  supports_block_expectations
+end
+
+RSpec::Matchers.define :create_file do |file_name|
+  match do |block|
+    return false if File.exists? file_name # change this to use a proper message
+    block.call
+    File.exists? file_name
+  end
+
+  supports_block_expectations
+end

data/spec/support/session_support.rb

@@ -0,0 +1,31 @@
+module SessionSupport
+  def self.included(base)
+    def start_session(only_knows:nil)
+      @session = Boty::Session.new
+      @session.start do |_| end
+    end
+
+    base.instance_eval do
+      include EMSupport
+      include FayeSupport
+      include SlackSupport::Users
+
+      let(:bot) { ::Boty::ScriptDSL.new @session.bot }
+      let(:dsl) { bot }
+      let(:bot_name) { "jeeba" }
+      let(:bot_id) { "U1234" }
+      let(:rtm_ws_url) { "ws://example.org/slack/sse/url" }
+
+      before do
+        allow(Boty::Slack.rtm).to receive(:start).
+          and_return JSON.parse '{
+            "url": "'+ rtm_ws_url + '",
+            "self": {
+              "id": "'+ bot_id + '",
+              "name": "'+ bot_name + '"
+            }
+          }'
+      end
+    end
+  end
+end

data/spec/support/slack_support.rb

@@ -0,0 +1,28 @@
+module SlackSupport
+  module Users
+    def self.included(base)
+      base.instance_eval do
+        let(:user_name) { "julian" }
+        let(:user_id) { "U023BECGF" }
+
+        before do
+          allow(::Boty::Slack.users).to receive(:info).and_return(
+            ::Boty::Slack::User.new({
+              "id" => user_id,
+              "name" => user_name
+            })
+          )
+        end
+      end
+    end
+  end
+
+  RSpec::Matchers.define :send_im do |user_id, message|
+    supports_block_expectations
+
+    match do |block|
+      expect(::Boty::Slack.chat).to receive(:post_im).with(user_id, message)
+      block.call
+    end
+  end
+end