boty 0.1.0 → 0.1.1

data/lib/boty/eventable.rb

@@ -6,7 +6,8 @@ module Boty
     end
 
     def event(data)
-      return unless type = event_type(data)
+      type = event_type data
+      return unless type
 
       events[type].each do |action|
         action.call data
@@ -30,9 +31,9 @@ module Boty
 
     def event_type(data)
       type = data["type"].to_sym
-      logger.debug { "event[#{type}] arrived: #{data}" }
+      logger.debug do "event[#{type}] arrived: #{data}" end
       unless events[type]
-        logger.debug "no action binded to #{type}"
+        logger.debug do "no action binded to #{type}" end
         return
       end
       type

data/lib/boty/http.rb

@@ -13,17 +13,16 @@ module Boty
 
     def connection(verb, url, params)
       uri = URI url
-      Faraday.new(url: "#{uri.scheme}://#{uri.host}") { |builder|
+      faraday = Faraday.new(url: "#{uri.scheme}://#{uri.host}") { |builder|
         builder.adapter(*Faraday.default_adapter)
-      }.public_send(verb) { |req|
-        req.url uri.path, params
       }
+      faraday.public_send(verb) { |req| req.url uri.path, params }
     end
 
     def handle_response
       # TODO: use a response parser accordingly to the
       body = response.body
-      if /application\/json/.match response.headers["Content-Type"]
+      if %r{application/json}.match response.headers["Content-Type"]
         JSON.parse body
       else
         body

data/lib/boty/locale.rb

@@ -1,24 +1,23 @@
 module Boty
   class Locale
-    def self.reload(locale = nil)
-      _locale = new
-      I18n.load_path = _locale.locales_paths.uniq
+    def self.reload(language = nil)
+      locale = new
+      I18n.load_path = locale.locales_paths.uniq
       I18n.available_locales = I18n::Backend::Simple.new.available_locales
-      _locale.set_locale locale if locale
+      locale.locale = language if language
     end
 
     def locales_paths
-      default_locales_path = File.expand_path("../../../locale/**/*.yml", __FILE__)
-      (Dir["locale/**/*.yml"] + Dir[default_locales_path]).
-        map { |file| File.expand_path file }
+      locale_yaml_files_path = "../../../locale/**/*.yml"
+      default_locales_path = File.expand_path(locale_yaml_files_path, __FILE__)
+      (Dir["locale/**/*.yml"] + Dir[default_locales_path])
+        .map { |file| File.expand_path file }
     end
 
-    def set_locale(locale)
-      begin
-        I18n.locale = locale
-      rescue I18n::InvalidLocale
-        I18n.locale = :en
-      end
+    def locale=(language)
+      I18n.locale = language
+    rescue I18n::InvalidLocale
+      I18n.locale = :en
     end
   end
 end

data/lib/boty/logger.rb

@@ -17,6 +17,16 @@ module Boty
       Logger.adapter
     end
 
+    def log_error(error, message)
+      logger.error do
+        "#{message}\n#{error.message}"
+      end
+
+      logger.debug do
+        error.backtrace.reduce("") { |a, e| a << "#{e}\n" }
+      end
+    end
+
     class Multi < ::Logger
       def initialize(adapters)
         @adapters = adapters
@@ -38,7 +48,7 @@ module Boty
     class Memory < ::Logger
       attr_reader :logs
 
-      def initialize(*args)
+      def initialize(*)
         @logs = []
       end
 
@@ -52,8 +62,9 @@ module Boty
     end
 
     class Null < ::Logger
-      def initialize(*args); end
-      def add(*args, &block); end
+      def initialize(*); end
+
+      def add(*, &block); end
     end
   end
 end

data/lib/boty/rspec.rb

@@ -8,23 +8,22 @@ module Boty
           include SlackSupport::Users
 
           before do
-            @_bot = Boty::Bot.new(
-              {"id" => "1234", "name" => "bot"}
-            )
-
-            class << Boty::Slack.chat
-              attr_accessor :messages
-
-              def post_message(message, options)
-                @messages ||= []
-                @messages << { message: message, options: options }
-              end
-            end
+            @_bot = Boty::Bot.new("id" => "1234", "name" => "bot")
+            mock_post_message
           end
 
-          let(:bot) {
-            Boty::DSL.new @_bot
-          }
+          let(:bot) { Boty::DSL.new @_bot }
+        end
+      end
+
+      def mock_post_message
+        class << Boty::Slack.chat
+          attr_accessor :messages
+
+          def post_message(message, options)
+            @messages ||= []
+            @messages << { message: message, options: options }
+          end
         end
       end
 
@@ -39,7 +38,7 @@ module Boty
 
     ::RSpec::Matchers.define :have_responded do |expected|
       # TODO: add proper messages for failures.
-      match do |dsl|
+      match do
         last_message = Slack.chat.messages.last
         expected == last_message[:message]
       end

data/lib/boty/session.rb

@@ -22,38 +22,37 @@ module Boty
         begin
           on_message event, @bot
         rescue StandardError => e
-          logger.error "Message #{event} could not be processed. #{e.message}"
-          logger.debug e.backtrace.reduce("") { |msg, line| msg << "#{line}\n" }
+          log_error e, "Message #{event} could not be processed."
         end
       end
     end
 
     def login
-      logger.debug { "Logging in against slack right now" }
+      logger.debug do "Logging in against slack right now" end
       @slack_info = Slack.rtm.start
-      logger.debug { "yep! logged in!" }
+      logger.debug do "yep! logged in!" end
       @session_url = @slack_info["url"]
     end
 
     def initialize_bot(&block)
       Bot.new(@slack_info["self"]).tap { |bot|
         DSL.new(bot).instance_eval(&block) if block_given?
-        logger.debug { "Bot is configured and ready to go!" }
+        logger.debug do "Bot is configured and ready to go!" end
       }
     end
 
     def on_message(event, bot)
-      logger.debug { "Message arrived. Creating bot event" }
+      logger.debug do "Message arrived. Creating bot event" end
       bot.event JSON.parse(event.data)
     end
 
     def on_close
       logger.debug { "bye bye" }
-      #todo try to reconnect (stablish_connection) unless is an em interrupt
+      # TODO: try to reconnect (stablish_connection) unless is an em interrupt
     end
 
     def stablish_connection
-      logger.debug { "Starting to listen on #{@session_url}" }
+      logger.debug do "Starting to listen on #{@session_url}" end
       ws = Faye::WebSocket::Client.new @session_url
       ws.on :close do on_close end
       on_connect ws

data/lib/boty/slack.rb

@@ -10,9 +10,17 @@ require "boty/slack/message"
 module Boty
   module Slack
     class << self
-      def chat; @chat ||= Chat.new end
-      def rtm; @rtm ||= RTM.new end
-      def users; @users ||= Users.new end
+      def chat
+        @chat ||= Chat.new
+      end
+
+      def rtm
+        @rtm ||= RTM.new
+      end
+
+      def users
+        @users ||= Users.new
+      end
     end
 
     def User(user_id)

data/lib/boty/slack/channel.rb

@@ -4,7 +4,8 @@ module Boty
       attr_accessor :id
 
       def initialize(id:, info:)
-        @id, @info = id, info
+        @id   = id
+        @info = info
       end
     end
   end

data/lib/boty/slack/chat.rb

@@ -4,7 +4,11 @@ module Boty
       include Slack::URL
       url "https://slack.com/api/chat.postMessage"
 
-      def im; @im ||= IM.new end
+      attr_reader :im
+
+      def initialize
+        @im = IM.new
+      end
 
       def post_message(message, parameters = {})
         defaults = {

data/lib/boty/slack/rtm.rb

@@ -2,7 +2,7 @@ module Boty
   module Slack
     class RTM
       include Slack::URL
-      url "https://#{ENV["SLACK_COMPANY"]}.slack.com/api/"
+      url "https://#{ENV['SLACK_COMPANY']}.slack.com/api/"
 
       def start(parameters = {})
         defaults = { simple_latest: true, no_unreads: true }

data/lib/boty/slack/url.rb

@@ -2,9 +2,14 @@ module Boty
   module Slack
     module URL
       def self.included(base)
+        class << base
+          attr_reader :_url
+        end
+
         base.instance_eval do
-          def url(url); @_url = url end
-          def _url; @_url end
+          def url(url)
+            @_url = url
+          end
         end
       end
 
@@ -16,11 +21,11 @@ module Boty
 
       def parameterize(user_parameters, path: nil)
         url = path ? self.class._url + path : self.class._url
-        parameters = {token: ENV["SLACK_BOT_API_TOKEN"]}.merge user_parameters
-        parameters.reduce(url + "?") { |_url, param|
+        parameters = { token: ENV["SLACK_BOT_API_TOKEN"] }.merge user_parameters
+        parameters.reduce(url + "?") { |final_url, param|
           parameter = param[0]
           value = URI.encode param[1].to_s
-          "#{_url}#{parameter}=#{value}&"
+          "#{final_url}#{parameter}=#{value}&"
         }.gsub(/&$/, "")
       end
     end

data/lib/boty/slack/user.rb

@@ -4,7 +4,8 @@ module Boty
       attr_accessor :id, :name
 
       def initialize(info)
-        @id, @name = info["id"], info["name"]
+        @id   = info["id"]
+        @name = info["name"]
       end
     end
   end

data/lib/boty/slack/users.rb

@@ -21,7 +21,7 @@ module Boty
       end
 
       def by_name(name)
-        list.select { |user| user.name == name }.first
+        list.find { |user| user.name == name }
       end
     end
   end

data/lib/boty/version.rb

@@ -1,3 +1,3 @@
 module Boty
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/script/knows.rb

@@ -6,25 +6,26 @@ end
 class KnownFormmater
   def initialize(actions)
     @actions = actions
-    @max_size = @actions.keys.map(&:length).max
+    @descriptions = @actions.map(&:desc)
+    @max_size = @descriptions.map(&:command).map(&:length).max
   end
 
   def format
-    @actions.inject("```\n") { |_message, command|
-      _message << format_command(command) + "\n"
+    @descriptions.inject("```\n") { |message, description|
+      message << format_description(description) + "\n"
     } + "```"
   end
 
   private
 
-  def name(command_name)
-    pad = @max_size - command_name.length
-    (" " * pad) + command_name
+  def name(trigger)
+    pad = @max_size - trigger.length
+    (" " * pad) + trigger
   end
 
-  def format_command(command)
-    message = name command.first
-    message << ": #{command.last}" if command.last
+  def format_description(description)
+    message = name description.command
+    message << ": #{description.description}" if description.description
     message
   end
 end

data/script/pug.rb

@@ -1,12 +1,16 @@
 desc "pug me", I18n.t("scripts.pug_me")
 command(/pug me/i) do
   response = http.get "http://pugme.herokuapp.com/random"
-  say "<#{response["pug"]}>"
+  say "<#{response['pug']}>"
 end
 
 desc "pug bomb X", I18n.t("scripts.pug_bomb")
 command(/pug bomb( \d+)?/i) do |count|
   count = (count || "5").strip
+  if count.to_i > 5
+    count = "5"
+    say "wow! so many pugs! sendind 5 instead."
+  end
   response = http.get "http://pugme.herokuapp.com/bomb", count: count
   response["pugs"].each do |pug| say "<#{pug}>" end
 end

data/spec/boty/bot_spec.rb

@@ -1,11 +1,14 @@
 module Boty
   RSpec.describe Bot do
+    include Boty
     subject(:bot) { described_class.new bot_info }
 
-    let(:bot_info) {{
-      "id" => "666",
-      "name" => "jabber"
-    }}
+    let(:bot_info) do
+      {
+        "id" => "666",
+        "name" => "jabber"
+      }
+    end
 
     describe "#on" do
       it "binds an event `'type'` to a block" do
@@ -22,18 +25,20 @@ module Boty
     end
 
     describe "#off" do
-      let(:data) {{
-        "type" => "bbq",
-        "text" => "omg. wtf."
-      }}
+      let(:data) do
+        {
+          "type" => "bbq",
+          "text" => "omg. wtf."
+        }
+      end
 
       it "unbounds an event by type AND block, just if the block is the same" do
         @permanent_executed = false
-        permanent_block = ->(_){ @permanent_executed = true }
+        permanent_block = ->(_) do @permanent_executed = true end
         bot.on :bbq, &permanent_block
 
         @ephemeral_executed = false
-        ephemeral_block = ->(_){ @ephemeral_executed = true }
+        ephemeral_block = ->(_) do @ephemeral_executed = true end
         bot.on :bbq, &ephemeral_block
         bot.off :bbq, &ephemeral_block
 
@@ -45,9 +50,9 @@ module Boty
 
       it "unbounds all events by type" do
         @first_block = @second_block = @third_block = false
-        bot.on(:bbq) { |_| @first_block = true }
-        bot.on(:bbq) { |_| @second_block = true }
-        bot.on(:bbq) { |_| @third_block = true }
+        bot.on(:bbq) do |_| @first_block = true end
+        bot.on(:bbq) do |_| @second_block = true end
+        bot.on(:bbq) do |_| @third_block = true end
         bot.off(:bbq)
 
         bot.event data
@@ -59,21 +64,23 @@ module Boty
     end
 
     describe "#match", :users do
-      let(:data) {{
-        "type" => "message",
-        "text" => "bbq omg lol"
-      }}
+      let(:data) do
+        {
+          "type" => "message",
+          "text" => "bbq omg lol"
+        }
+      end
 
       it "binds a regex to events of `type => message`" do
-        _message = nil
+        message = nil
         bot.match(/omg/i) do
-          _message = message
+          message = self.message
         end
         bot.event data
 
-        expect(_message).to be_a Boty::Slack::Message
-        expect(_message.text).to eq "bbq omg lol"
-        expect(_message.match[0]).to eq "omg"
+        expect(message).to be_a Boty::Slack::Message
+        expect(message.text).to eq "bbq omg lol"
+        expect(message.match[0]).to eq "omg"
       end
 
       it "binds various actions to events of type message" do
@@ -82,23 +89,22 @@ module Boty
         bot.match(/omg/i) do iterations << "second" end
         bot.event data
 
-        expect(iterations).to eq ["first", "second"]
+        expect(iterations).to eq %w(first second)
       end
 
       it "passes the matched strings as parameters to block action" do
-        _lol, _bbq = nil
+        rspec = self
         bot.match(/(bbq) omg (lol)/i) do |bbq, lol|
-          _lol, _bbq = lol, bbq
+          rspec.expect(bbq).to rspec.eq "bbq"
+          rspec.expect(lol).to rspec.eq "lol"
         end
-        bot.event data
 
-        expect(_lol).to eq "lol"
-        expect(_bbq).to eq "bbq"
+        bot.event data
       end
 
       it "evals the block in the context of the bot" do
         dsl = nil
-        bot.match(/omg/) { dsl = self }
+        bot.match(/omg/) do dsl = self end
         bot.event data
 
         expect(dsl.bot).to eq bot
@@ -106,10 +112,12 @@ module Boty
     end
 
     describe "#respond", :users do
-      let(:data) {{
-        "type" => "message",
-        "text" => "hey <@jabber>, omg me"
-      }}
+      let(:data) do
+        {
+          "type" => "message",
+          "text" => "hey <@jabber>, omg me"
+        }
+      end
 
       it "binds actions for messages only when there is a mention (@bot)" do
         expect { |b|
@@ -146,7 +154,7 @@ module Boty
 
       it "evals the block in the context of the bot" do
         dsl = nil
-        bot.respond(/omg me/) { dsl = self }
+        bot.respond(/omg me/) do dsl = self end
         bot.event data
 
         expect(dsl.bot).to eq bot
@@ -159,10 +167,12 @@ module Boty
       end
 
       describe "#no_match" do
-        let(:data) {{
-          "type" => "message",
-          "text" => "bbq omg lol"
-        }}
+        let(:data) do
+          {
+            "type" => "message",
+            "text" => "bbq omg lol"
+          }
+        end
 
         it "removes a message based on the regex AND the block" do
           permanent_executed = false
@@ -182,8 +192,8 @@ module Boty
 
         it "removes all binds for a specific regex" do
           first = second = false
-          bot.match(/omg/i) { first = true }
-          bot.match(/omg/i) { second = true }
+          bot.match(/omg/i) do first = true end
+          bot.match(/omg/i) do second = true end
           bot.no_match(/omg/i)
 
           bot.event data
@@ -194,10 +204,12 @@ module Boty
       end
 
       describe "#no_respond" do
-        let(:data) {{
-          "type" => "message",
-          "text" => "hey <@#{bot.name}>, omg me"
-        }}
+        let(:data) do
+          {
+            "type" => "message",
+            "text" => "hey <@#{bot.name}>, omg me"
+          }
+        end
 
         it "removes a message based on the regex AND the block" do
           permanent_executed = false
@@ -217,8 +229,8 @@ module Boty
 
         it "removes all binds for a specific regex" do
           first = second = false
-          bot.respond(/omg/i) { first = true }
-          bot.respond(/omg/i) { second = true }
+          bot.respond(/omg/i) do first = true end
+          bot.respond(/omg/i) do second = true end
           bot.no_respond(/omg/i)
 
           dsl.bot.event data
@@ -231,22 +243,22 @@ module Boty
 
     describe "#say" do
       it "sends a string using the slack api to general (default) channel" do
-        expect(Slack.chat).to receive(:post_message).
-          with "something", channel: "#general"
+        expect(Slack.chat).to receive(:post_message)
+          .with "something", channel: "#general"
 
         bot.say "something"
       end
 
       it "sends a message to the channel specified by parameter" do
-        expect(Slack.chat).to receive(:post_message).
-          with "omg pugs!", channel: "#omg"
+        expect(Slack.chat).to receive(:post_message)
+          .with "omg pugs!", channel: "#omg"
 
         bot.say "omg pugs!", channel: "#omg"
       end
 
       it "accepts extra parameters and send them to the slack api" do
-        expect(Slack.chat).to receive(:post_message).
-          with "omg pugs!", channel: "#omg", omg: "lol"
+        expect(Slack.chat).to receive(:post_message)
+          .with "omg pugs!", channel: "#omg", omg: "lol"
 
         bot.say "omg pugs!", channel: "#omg", omg: "lol"
       end
@@ -262,9 +274,9 @@ module Boty
 
     describe "#im" do
       before do
-        allow(Slack.users).to receive(:by_name).
-          with("julian").
-          and_return(Boty::Slack::User.new "id" => "U123", "name" => "julian")
+        user = Boty::Slack::User.new "id" => "U123", "name" => "julian"
+        allow(Slack.users).to receive(:by_name).with("julian")
+          .and_return user
       end
 
       it "sends a message in the back channel (particular, im...)" do
@@ -287,9 +299,8 @@ module Boty
       end
 
       it "logs when fails on discover the destiny", :logger do
-        allow(Slack.users).to receive(:by_name).
-          with("omg_doesnt_exists").
-          and_return nil
+        allow(Slack.users).to receive(:by_name)
+          .with("omg_doesnt_exists").and_return nil
         bot.im "lol", destiny: "omg_doesnt_exists"
 
         expect(logger.logs.last).to eq "User not found, refusing to send im."
@@ -304,46 +315,52 @@ module Boty
     end
 
     describe "#desc" do
+      let(:know_how) {
+        bot.know_how.map { |action|
+          { action.desc.command => action.desc.description }
+        }
+      }
+
       it "describes the next command to be created" do
         bot.desc "omg", "lol all the way down"
-        bot.respond(/omg/) {}
+        bot.respond(/omg/)
 
-        expect(bot.know_how).to include({
+        expect(know_how).to include(
           "omg" => "lol all the way down"
-        })
+        )
       end
 
       it "describes the next match do be created" do
         bot.desc "ula", "babula"
-        bot.match(/ula/) {}
+        bot.match(/ula/)
 
-        expect(bot.know_how).to include({
+        expect(know_how).to include(
           "ula" => "babula"
-        })
+        )
       end
 
       it "stores the description for a regex when no command usage is given" do
         bot.desc "just a description"
-        bot.match(/just desc/i) {}
-        expect(bot.know_how).to include({
+        bot.match(/just desc/i)
+        expect(know_how).to include(
           "/just desc/i" => "just a description"
-        })
+        )
       end
 
       it "presents the commands without description as regexes" do
-        bot.match(/without desc/i) {}
+        bot.match(/without desc/i)
 
-        expect(bot.know_how).to include({
+        expect(know_how).to include(
           "/without desc/i" => nil
-        })
+        )
       end
 
       it "knows when a regex is case insensitive" do
         bot.match(/without desc insensitive/)
 
-        expect(bot.know_how).to include({
+        expect(know_how).to include(
           "/without desc insensitive/" => nil
-        })
+        )
       end
     end
   end