s-3po 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e1d759431fa3c4bc9f3f6a0a7a8b8663ca9a979
+  data.tar.gz: 68df6f31ed06cb70c2020955b2cc1d2cf36de9f5
+SHA512:
+  metadata.gz: 3e4269f0094d557113cab59c653c2e78e1f9bcb7c072a69f37688b5e9161ea7ed44fe57cff92988da2bde318942ab931e5a5be2c90860ac005e370555419896b
+  data.tar.gz: 2e0300dfe5c6a8ffc6ec6e837abe692082542531efdb75c8e3e62becbfb5d1d3edb3fc10a49ca410b31fd71ab7796230bd54fd4e53a9feaffd5e48d73f33c262

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ken J.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,51 @@
+# S-3PO
+
+A protocol droid made by Cybot Galactica for Slack.
+
+This gem parses, generates, and manupilates various Slack events and messages.
+
+## Requirements
+
+- Ruby 2.0.0 <=
+
+## Usage
+
+If you're creating integrations or bots for Slack, this may come useful. Install:
+
+```
+$ gem install subaru
+```
+
+Then use:
+
+```ruby
+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)
+puts "#{event.type} : #{event.subtype}"
+puts event.plain if event.is_simplemessage?
+# => "@U123ABC: hello you!"
+```
+
+Generate a message to send to Slack.
+
+```ruby
+json = S3PO.generate_message do |reply|
+  reply.channel = 'CABC123'
+  reply.plain = "@channel: what's up, ya all?"
+end
+puts json
+# => "<!channel>: what's up, ya all?"
+```
+
+See [YARD Doc](http://www.rubydoc.info/github/kenjij/s-3po) for more info.
+
+## What's Next
+
+- Provide feedback
+- Expect more updates
+- Random anniversary at May 4th

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

@@ -0,0 +1,110 @@
+module S3PO
+
+  # Base event class; a generic event class should only come from Slack.
+  class Event
+
+    attr_reader :object
+
+    def initialize(event = {})
+      fail 'Must be a Hash.' unless event.class == Hash
+      @object = event
+    end
+
+    # @return [Symbol]
+    def type
+      return :response unless object[:ok].nil?
+      return object[:type].to_sym if object[:type]
+      return nil
+    end
+
+    # Is it a message event?
+    # @return [Boolean]
+    def is_message?
+      return !type.nil? && type == :message
+    end
+
+    # @return [Symbol]
+    def subtype
+      return object[:subtype].to_sym if object[:subtype]
+      return nil
+    end
+
+    # Is it a simple message event; a straight forward text message without a subtype?
+    # @return [Boolean]
+    def is_simplemessage?
+      is_message? && subtype.nil?
+    end
+
+    def user
+      object[:user]
+    end
+
+    def channel
+      object[:channel]
+    end
+
+    def channel=(string)
+      fail 'Must be a String.' unless string.class == String
+      fail 'Invalid channel' unless /C[0-9A-Z]+/ =~ string
+      object[:channel] = string
+    end
+
+    def ts
+      object[:ts]
+    end
+
+  end
+
+
+  # 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
+
+    def text=(string)
+      fail 'Must be a String.' unless string.class == String
+      object[:text] = string
+      @plain = nil
+    end
+
+    def plain
+      @plain ||= Parser.plain_from_text(text)
+    end
+
+    def plain=(string)
+      fail 'Must be a String.' unless string.class == String
+      @plain = string
+      object[:text] = Generator.text_from_plain(@plain)
+    end
+
+    def mentions
+      @mentions ||= Parser.mentions_from_text(text)
+    end
+
+    
+    def commands
+      @commands ||= Parser.commands_from_text(text)
+    end
+
+  end
+
+  class Response < Event
+
+    def ok
+      object[:ok]
+    end
+
+    def ok?
+      ok
+    end
+
+  end
+
+end

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

@@ -0,0 +1,36 @@
+require 'json'
+
+
+module S3PO
+
+  class Generator
+
+    def self.generate_message(message, id = nil)
+      @id ||= 0
+      obj = message.object
+      msg = {type: 'message', channel: obj[:channel], text: obj[:text]}
+      msg[:id] = id ? id : @id
+      @id += 1 unless id
+      return JSON.fast_generate(msg)
+    end
+
+    def self.text_from_plain(plain)
+      text = String.new(plain)
+      # escape
+      text.gsub!('&', '&')
+      text.gsub!('<', '&lt;')
+      text.gsub!('>', '&gt;')
+      # add brackets to mentions
+      text.gsub!(/(@[a-z0-9][a-z0-9.\-_]*)/, '<\1>')
+      text.gsub!(/(@U[A-Z0-9]+)/, '<\1>')
+      # add brackets to channels
+      text.gsub!(/(#[a-z0-9\-_]+)/, '<\1>')
+      text.gsub!(/(#C[A-Z0-9]+)/, '<\1>')
+      # convert commands
+      text.gsub!(/<@(everyone|channel|group)>/, '<!\1>')
+      return text
+    end
+
+  end
+
+end

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

@@ -0,0 +1,46 @@
+require 'json'
+
+
+module S3PO
+
+  class Parser
+
+    def self.parse_event(event)
+      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)
+    end
+
+    def self.mentions_from_text(text)
+      mentions = []
+      text.scan(/<@([^>|]*)[^>]*>/) { |m| mentions << m[0]}
+      return mentions
+    end
+
+    def self.plain_from_text(text)
+      # Copy
+      plain = String.new(text)
+      # remove labels within brackets
+      plain.gsub!(/<([^>|]*)[^>]*>/, '<\1>')
+      # process commands
+      plain.gsub!(/<!(everyone|channel|group)>/, '<@\1>')
+      plain.gsub!(/<!(.*?)>/, '<\1>')
+      # remove brackets
+      plain.gsub!(/<(.*?)>/, '\1')
+      # unescape
+      plain.gsub!('&gt;', '>')
+      plain.gsub!('&lt;', '<')
+      plain.gsub!('&amp;', '&')
+      return plain
+    end
+
+    def self.commands_from_text(text)
+      commands = []
+      text.scan(/<!([^>|]*)[^>]*>/) { |m| commands << m[0]}
+      return commands
+    end
+
+  end
+
+end

data/lib/s-3po.rb

@@ -0,0 +1,27 @@
+require 's-3po/events'
+require 's-3po/generator'
+require 's-3po/parser'
+
+
+module S3PO
+
+  # Parse Slack event into an S3PO Event object.
+  # @param event [String] event from Slack in JSON string
+  # @return [Object] an S3PO::Event object
+  def self.parse_event(event)
+    return Parser.parse_event(event)
+  end
+
+  # Generate JSON message to send to Slack.
+  # @param message [Hash] message event object
+  # @param block [&block] provide a block to configure the message
+  # @return [String] JSON ready to send to Slack
+  def self.generate_message(message = {})
+    if block_given?
+      message = Message.new(message)
+      yield message
+    end
+    return Generator.generate_message(message)
+  end
+
+end

data/s-3po.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name          = 's-3po'
+  s.version       = '0.1.0'
+  s.authors       = ['Ken J.']
+  s.email         = ['kenjij@gmail.com']
+  s.description   = %q{Slack message formatter gem}
+  s.summary       = %q{A Slack message "protocol droid®".}
+  s.homepage      = 'https://github.com/kenjij/s-3po'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($/)
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: s-3po
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ken J.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-10 00:00:00.000000000 Z
+dependencies: []
+description: Slack message formatter gem
+email:
+- kenjij@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/s-3po.rb
+- lib/s-3po/events.rb
+- lib/s-3po/generator.rb
+- lib/s-3po/parser.rb
+- s-3po.gemspec
+homepage: https://github.com/kenjij/s-3po
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A Slack message "protocol droid®".
+test_files: []
+has_rdoc: