s-3po 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afee73b5c45855b4388b24e856b14949d2610e9f
-  data.tar.gz: a89e09d0b8a7f4ff3b1317a2f2acc9277cb88d6e
+  metadata.gz: 89544fe67ba616e85dd1e1082c660f2fd58c67e0
+  data.tar.gz: b24bdffaaaa62a6e9fdf3d36311afcfe6546bc2c
 SHA512:
-  metadata.gz: 99868e8215ad11ec5b15fd5ada25b777d94efec8a55ed5831370b9cb19b0fec5e30ca5aeb066a02a536fc1df50f4af8905922a50f0838319e9fee4d6d88ffc4e
-  data.tar.gz: 90a62b8f876e46ec1fb52a71bf7617d57b193a07de524233ded804f5205ec4184ee6a10494d4e2b01060f3cf5babbfa8f0c068abd279878c102bfae13162fa07
+  metadata.gz: eda02a76d6de6c43feb16692efe305c70078fb97dafb1dca8b008ab7d4f4a71aaecd45fc709ea7676eeb6e83356bd8f1470d5aa0232cf695cb087ed25b884dba
+  data.tar.gz: f1110abfaf267702766c3ffb24011938e5a14b62bea80cf8f551fc297699a4b50c8965e4d3862442720cb1a9cb03e527f5e6e3e343cd757926d4000ac1e053c5

data/README.md

@@ -1,8 +1,8 @@
 # S-3PO
 
-[![Gem Version](https://badge.fury.io/rb/s-3po.svg)](http://badge.fury.io/rb/s-3po) [![security](https://hakiri.io/github/kenjij/s-3po/master.svg)](https://hakiri.io/github/kenjij/s-3po/master) [![Code Climate](https://codeclimate.com/github/kenjij/s-3po/badges/gpa.svg)](https://codeclimate.com/github/kenjij/s-3po)
+[![Gem Version](https://badge.fury.io/rb/s-3po.svg)](http://badge.fury.io/rb/s-3po) [![security](https://hakiri.io/github/kenjij/s-3po/master.svg)](https://hakiri.io/github/kenjij/s-3po/master) [![Code Climate](https://codeclimate.com/github/kenjij/s-3po/badges/gpa.svg)](https://codeclimate.com/github/kenjij/s-3po) [![Dependency Status](https://gemnasium.com/kenjij/s-3po.svg)](https://gemnasium.com/kenjij/s-3po)
 
-A protocol droid made by Cybot Galactica for Slack.
+A protocol droid made by [Cybot Galactica](http://starwars.wikia.com/wiki/Cybot_Galactica) for [Slack](https://slack.com).
 
 This gem parses, generates, and manupilates various Slack events and messages.
 
@@ -27,7 +27,7 @@ require 's-3po'
 Your bot would connect to Slack via [RTM API](https://api.slack.com/rtm). Then process events like this.
 
 ```ruby
-event = S3PO.parse_event(data_from_slack)
+event = S3PO.parse_event(data_from_slack, {botid: bot_id})
 puts "#{event.type} : #{event.subtype}"
 puts event.plain if event.is_simplemessage?
 # => "@U123ABC: hello you!"

data/lib/s-3po/events.rb

@@ -4,10 +4,12 @@ module S3PO
   class Event
 
     attr_reader :object
+    attr_reader :options
 
-    def initialize(event = {})
+    def initialize(event = {}, opts = {})
       fail 'Must be a Hash.' unless event.class == Hash
       @object = event
+      @options = opts
     end
 
     # @return [Symbol]
@@ -39,6 +41,12 @@ module S3PO
       object[:user]
     end
 
+    # Is is an IM, direct channel?
+    # @return [Boolean]
+    def is_im?
+      !object[:channel].nil? && channel.start_with?('D')
+    end
+
     def channel
       object[:channel]
     end
@@ -59,11 +67,6 @@ module S3PO
   # Message Event class comes from Slack, or you would create one to send a message.
   class Message < Event
 
-    def initialize(event = {})
-      event[:type] = :message
-      super(event)
-    end
-
     def text
       object[:text]
     end
@@ -88,9 +91,24 @@ module S3PO
       @mentions ||= Parser.mentions_from_text(text)
     end
 
-    
-    def commands
-      @commands ||= Parser.commands_from_text(text)
+    # Is the message directed to me and/or prefixed with bot username?
+    # @return [Boolean]
+    def is_instruction?
+      return false unless plain
+      withprefix = /^@#{options[:botid]}[!:;,.-]*\s+\S/
+      withoutprefix = /^[^@]/
+      return true if (withprefix =~ plain) == 0
+      if is_im?
+        return true if (withoutprefix =~ plain) == 0
+      end
+      return false
+    end
+
+    # Break up the message text into an Arrary per word when prefixed with bot username; e.g., "@bot echo hello"
+    # @return [Array] excluding the prefixed bot username
+    def instruction
+      return nil unless is_instruction?
+      @instruction ||= Parser.instruction_from_plain(plain, options[:botid])
     end
 
   end

data/lib/s-3po/parser.rb

@@ -5,11 +5,11 @@ module S3PO
 
   class Parser
 
-    def self.parse_event(event)
+    def self.parse_event(event, opts = {})
       obj = JSON.parse(event, {symbolize_names: true})
-      return Response.new(obj) if obj[:type].nil?
-      return Message.new(obj) if obj[:type] == 'message'
-      return Event.new(obj)
+      return Response.new(obj, opts) if obj[:type].nil?
+      return Message.new(obj, opts) if obj[:type] == 'message'
+      return Event.new(obj, opts)
     end
 
     def self.mentions_from_text(text)
@@ -19,7 +19,7 @@ module S3PO
     end
 
     def self.plain_from_text(text)
-      # Copy
+      # copy
       plain = String.new(text)
       # remove labels within brackets
       plain.gsub!(/<([^>|]*)[^>]*>/, '<\1>')
@@ -35,10 +35,13 @@ module S3PO
       return plain
     end
 
-    def self.commands_from_text(text)
-      commands = []
-      text.scan(/<!([^>|]*)[^>]*>/) { |m| commands << m[0]}
-      return commands
+    def self.instruction_from_plain(plain, botid)
+      a = plain.split()
+      if a[0] && a[0].start_with?("@#{botid}")
+        prefix = a.shift
+      end
+      return nil if a.empty?
+      return a
     end
 
   end

data/lib/s-3po.rb

@@ -7,9 +7,10 @@ module S3PO
 
   # Parse Slack event into an S3PO Event object.
   # @param event [String] event from Slack in JSON string
+  # @param opts [Hash] options
   # @return [Object] an S3PO::Event object
-  def self.parse_event(event)
-    return Parser.parse_event(event)
+  def self.parse_event(event, opts = {})
+    return Parser.parse_event(event, opts)
   end
 
   # Generate JSON message to send to Slack.

data/s-3po.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 's-3po'
-  s.version       = '0.1.1'
+  s.version       = '0.2.0'
   s.authors       = ['Ken J.']
   s.email         = ['kenjij@gmail.com']
   s.description   = %q{Slack message formatter gem}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s-3po
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ken J.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2015-04-15 00:00:00.000000000 Z
 dependencies: []
 description: Slack message formatter gem
 email: