boty 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cc2c0485b34d41c484c6226afcd775177ae9ff4
-  data.tar.gz: 41dc976a9443dc170427775a5db302f67c64a4fd
+  metadata.gz: 6c95fa76730f4a41c13d06ff314d53c0a9ee1f1c
+  data.tar.gz: 22567a320540d0fb327cdf9a0c863a10da787b82
 SHA512:
-  metadata.gz: e36b9176d3ddd5f8cffa05457637d2a98c1897f38f5d485f960b2306b2ab88be1606f6069bfabc9c8540f596a30249b8891c0f79fce80ea430f8b6ad7a00ddd0
-  data.tar.gz: b8f8b998064f4aabab2ca72abb91be20ee513c4f841eec7201d90d1e240106f2ff837af1d9faee3691366589d485cf21e8399daaa205a9cafc69651843ec1c88
+  metadata.gz: a44d246026394e6d097e83d8405d1fdfcd73bed586790dd807fa975da6a330b548b8b85a3840b2d27c0da2b166e673d623b27524db02ee89504c4ec4d7fdfd2a
+  data.tar.gz: e82866d26ad78cc4de3cd4f875d4a52fa59208f745823a0172142a3e8e4cb4e63931c67dd33cd4d340495d349d518c145e1f513f6e86d694d08561a18699696f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boty (0.0.4)
+    boty (0.0.6)
       eventmachine
       faye-websocket
       thor

data/README.md

@@ -1,28 +1,141 @@
 # Boty
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/boty`. To experiment with that code, run `bin/console` for an interactive prompt.
+`Boty` is a utilitary to create bots (at this time, specificaly Slack bots).
 
-TODO: Delete this and the text above, and describe your gem
+A bot is this context is a ordinary ruby application, that knows how to receive
+messages. Boty will give you a nice way to bind your own logic to specific
+messages of your own interest.
 
-## Installation
+## Slack Bot Integration<a id="integration" />
 
-Add this line to your application's Gemfile:
+The first thing to do is to create a Slack Bot integration.
+Go to `http://[your-company-name].slack.com/services` to add a new one.
+In the process an `API Token` will be generated. That will be used in the [next
+step](#installation).
 
-```ruby
-gem 'boty'
+## Installation<a id="installation" />
+
+Now you can install `Boty`:
+
+```sh
+$ gem install boty
+```
+
+This will give you an executable `boty`, which ships with a command `help` so
+you can know all the stuff that it can do. But the main one is to [create your
+new shiny bot](#usage).
+
+## Usage<a id="usage" />
+
+In this section you will learn how to create a custom bot application for your
+needs, how to configure it to allow the bot say stuff in your slack channels and
+finally, will see how to run the bot properly.
+
+### Creating a new bot
+
+To create a new bot, execute:
+
+```sh
+$ boty new jeeba
+```
+
+Where `jeeba` will be the nickname you give your bot in the [Slack
+integration](#integration).
+
+The command will create a new directory after your bot name (`jeeba` in my
+example). Your _bot application_ will live in this directory. Feel free to check
+the directory, it will have some ruby files, some directories... it's just an
+ordinary ruby application.
+
+But first, let's see something about the [configurations](#configuration).
+
+### Configuration<a id="configuration" />
+
+When executing the `boty new` command, you will be prompted for the
+*company name* and the *bot api key*.
+
+The information that you enter will be used only locally, so you can experiment
+and test (we will see more about the automated ones in this *README*) while
+developing your bot. This will be stored in the `.env.local` file on the
+recently created dir.
+
+If you want to understand how this configuration is managed locally, you can
+check de [`Dotenv` gem documentation](https://github.com/bkeepers/dotenv), but
+you don't need to worry about it.
+
+### Running locally<a id="running" />
+
+After create the new _bot application_ and give the *bot api key*, you can just
+enter the new dir and run
+
+```sh
+$ ./bot
 ```
 
-And then execute:
+Done! Your bot will be connected to your company Slack through the nickname that
+you provided in the [integration](#integration) step.
+To see if it's working properly, just go the the slack, in the general channel
+(or any other where the bot was invited) and type:
 
-    $ bundle
+```sh
+@jeeba: ping
+```
+
+It will respond to you: `pong`. IT'S ALIVE.
+
+### Deploy on heroku
+
+But probably what you want is to have your bot running in a server, not in your
+machine, right?
+
+Your bot is created with an example `Procfile` to make it easy to run it on
+[Heroku](http://heroku.com) (to give an example).
+
+Create a new project on Heroku, following their instructions, until they ask you
+to do the "deploy" (the `git push heroku master`).
+
+#### configure the api key
+
+Now you need to add the configurations that are localy stored on `.env.local`.
+The two environment variables on that file are:
+
+    SLACK_COMPANY
+    SLACK_BOT_API_TOKEN
+
+The *Heroku* command line tool offers a way to create environment vars in the
+server, check
+[their documentation](https://devcenter.heroku.com/articles/config-vars).
+Today, when as I'm writing the readme, you can use the following commands to set
+those two environment variables:
 
-Or install it yourself as:
+    $ heroku config:set SLACK_COMPANY=your-company-name
+    $ heroku config:set SLACK_BOT_API_TOKEN=your-bot-integration-api-token
 
-    $ gem install boty
+#### allow process to run
 
-## Usage
+Heroku will not detect a web application in your bot, so you need to tell them
+to run your application as a, well... as a "normal" application.
+Go to your heroku dashboard (https://dashboard.heroku.com/apps), find the
+application that you have created to your bot.
+On the tab _Resources_, find a line with the information:
 
-TODO: Write usage instructions here
+    your-bot-name bundle exec ./bot
+
+
+Turn on this resource. And done, your bot is up and running!
+
+
+## Adding custom scripts
+
+ **todo: document**
+
+For now, check the `script/ping.rb` and follow it's leads.
+
+### Testing your own scripts
+
+ **todo: document**`
+
+For now, check the `spec/script/ping_spec.rb` and follow it's leads.
 
 ## Development
 
@@ -38,4 +151,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/ricard
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/bin/bot

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require "./lib/boty"
+
+session = Boty::Session.new
+session.verbose = true
+session.start do |bot|
+  bot.verbose = true
+  bot.message(/are you there\?/i) do |message|
+    next if message.from? self
+    say "Ohay <@#{message.user}>! I'm here, that's for sure."
+  end
+end

data/lib/boty.rb

@@ -13,9 +13,10 @@ require "faye/websocket"
 
 $:.unshift File.expand_path("../../lib", __FILE__)
 require "boty/version"
+require "boty/slack"
 require "boty/session"
-require "boty/bot"
 require "boty/message"
+require "boty/bot"
 
 module Boty
 end

data/lib/boty/bot.rb

@@ -43,12 +43,10 @@ module Boty
       end
     end
 
-    def say(message)
+    def say(message, api_parameters = {})
       channel = (@_message && @_message.channel) || "general"
-      uri = URI("https://slack.com/api/chat.postMessage?" +
-        "token=#{ENV['SLACK_BOT_API_TOKEN']}&as_user=true&channel=#{channel}&" +
-        "text=#{URI.encode message}")
-      post_response = Net::HTTP.get uri
+      options = { channel: channel }.merge api_parameters
+      post_response = Slack.chat.post_message message, options
       debug nil, post_response
     end
 

data/lib/boty/cli.rb

@@ -3,7 +3,7 @@ require "thor"
 module Boty
   class CLI < Thor
     include Thor::Actions
-    class_option :verbose, type: :boolean
+    class_option :verbose, type: :boolean, default: true
 
     attr_reader :bot_name, :company, :api_key
 
@@ -19,6 +19,7 @@ module Boty
         # for some reason the example .rspec isn't been copied
         create_file ".rspec", "--require=spec_helper"
         run "chmod +x bot"
+        run "bundle install"
       end
     end
 

data/lib/boty/rspec.rb

@@ -4,10 +4,8 @@ module Boty
       def self.included(base)
         base.instance_eval do
           let(:bot) {
-            bot = Boty::Bot.new(
-              {"id" => "1234", "name" => "bot"},
-              Boty::Session.new(ENV["SLACK_COMPANY"] || "acme")
-            )
+            bot = Boty::Bot.new({"id" => "1234", "name" => "bot"},
+                                Boty::Session.new)
 
             class << bot
               attr_accessor :_response
@@ -22,12 +20,17 @@ module Boty
         end
       end
 
+      def event(options)
+        bot.event({ "type" => "message" }.merge options)
+      end
+
       def message_event(text)
-        bot.event "type" => "message", "text" => text
+        event "text" => text
       end
     end
 
     ::RSpec::Matchers.define :have_responded do |expected|
+      # TODO: add proper messages for failures.
       match do |bot|
         response = bot._response
         bot._response = nil

data/lib/boty/session.rb

@@ -3,17 +3,10 @@ require "net/http"
 
 module Boty
   class Session
-    SLACK_RTM_START_URL = "https://%{domain}.slack.com/api/rtm.start?"+
-        "token=%{token}&"+
-        "simple_latest=true&no_unreads=true"
-    private_constant :SLACK_RTM_START_URL
-
     attr_reader :bot
     attr_writer :verbose
 
-    def initialize(slack_domain = ENV["SLACK_COMPANY"], verbose: false)
-      @rtm_start_url = SLACK_RTM_START_URL.sub "%{domain}", slack_domain
-      @rtm_start_url = @rtm_start_url.sub "%{token}", ENV["SLACK_BOT_API_TOKEN"]
+    def initialize(verbose: false)
       @verbose = verbose
     end
 
@@ -43,7 +36,7 @@ module Boty
 
     def login
       debug "logging in against slack right now"
-      @slack_info = JSON.parse Net::HTTP.get(URI @rtm_start_url)
+      @slack_info = Slack.rtm.start
       debug "yep! logged in!"
       @session_url = @slack_info["url"]
     end

data/lib/boty/slack.rb

@@ -0,0 +1,12 @@
+require "boty/slack/url"
+require "boty/slack/chat"
+require "boty/slack/rtm"
+
+module Boty
+  module Slack
+    class << self
+      def chat; @chat ||= Chat.new end
+      def rtm; @rtm ||= RTM.new end
+    end
+  end
+end

data/lib/boty/slack/chat.rb

@@ -0,0 +1,17 @@
+module Boty
+  module Slack
+    class Chat
+      include Slack::URL
+      url "https://slack.com/api/chat.postMessage"
+
+      def post_message(message, parameters = {})
+        defaults = {
+          as_user: true,
+          channel: "general",
+          text: message
+        }
+        URL.get parameterize(defaults.merge parameters)
+      end
+    end
+  end
+end

data/lib/boty/slack/rtm.rb

@@ -0,0 +1,14 @@
+module Boty
+  module Slack
+    class RTM
+      include Slack::URL
+      url "https://#{ENV["SLACK_COMPANY"]}.slack.com/api/"
+
+      def start(parameters = {})
+        defaults = { simple_latest: true, no_unreads: true }
+        url = parameterize defaults.merge(parameters), path: "rtm.start"
+        URL.get url
+      end
+    end
+  end
+end

data/lib/boty/slack/url.rb

@@ -0,0 +1,28 @@
+module Boty
+  module Slack
+    module URL
+      def self.included(base)
+        base.instance_eval do
+          def url(url); @_url = url end
+          def _url; @_url end
+        end
+      end
+
+      def self.get(url)
+        JSON.parse Net::HTTP.get(URI(url)) || "{}"
+      end
+
+      private
+
+      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|
+          parameter = param[0]
+          value = URI.encode param[1].to_s
+          "#{_url}#{parameter}=#{value}&"
+        }.gsub(/&$/, "")
+      end
+    end
+  end
+end

data/lib/boty/version.rb

@@ -1,3 +1,3 @@
 module Boty
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boty
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Ricardo Valeriano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2015-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -168,6 +168,7 @@ files:
 - Procfile
 - README.md
 - Rakefile
+- bin/bot
 - bin/console
 - bin/setup
 - boty.gemspec
@@ -179,6 +180,10 @@ files:
 - lib/boty/message.rb
 - lib/boty/rspec.rb
 - lib/boty/session.rb
+- lib/boty/slack.rb
+- lib/boty/slack/chat.rb
+- lib/boty/slack/rtm.rb
+- lib/boty/slack/url.rb
 - lib/boty/version.rb
 - lib/tasks/.keep
 - log/.keep
@@ -220,4 +225,3 @@ signing_key:
 specification_version: 4
 summary: Boty is a pretty bot specially tailored for Slack.
 test_files: []
-has_rdoc: