botaku 0.1.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46204c6e35d975dfd68a53d97bc3db03d7b1b18b
-  data.tar.gz: 796dfa27ea76aabe22fa19a865e9d20857d6a47f
+  metadata.gz: 5d9563871eee94af6e33be3d70c71c56b6a43664
+  data.tar.gz: fb92967dbdb6b9d8c796c78646529689c93c535a
 SHA512:
-  metadata.gz: 610542f17841c5970325ce667121e4a1fda7c6511319c49d3d3b1482cd871a183f55df7372ac94b04aa3c47b69c2fc655f7c1124ff4a7f4018a2ccdd2c111d6d
-  data.tar.gz: 9c4c3d3a783cfa7091eb62644cb587bd9d28ee5a96ba2ad68ae52f2350190a105983b6731d64079321597e6ffb2b512d14e96920bb661d7dd14d36e423fd55eb
+  metadata.gz: b3324d211fc6b4880394ad754e0e1d19f09f375aad63d386f6a358e90cac920dacac3f41bc5bc232a994864034872ca36144ac947da37ed20e0689b713d6d479
+  data.tar.gz: a9a737fb10adc36e254e168436b8903fa45fcb8f7b1bc6e80de5a5e72cdc0ffdc383c684166011ccb5e36c7510d9ee72c9c8c5eb2c7c785542bdb20b72f695dd

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 # CHANGELOG.md
 
 
+## botaku 0.9.0  released 2017-07-19
+
+- Read token as file if necessary
+- Implement Botaku::Client, based on HTTPClient and Faye-Websocket
+
+
 ## botaku 0.1.0  released 2017-07-16
 
 - Initial empty release

data/README.md

@@ -1,6 +1,61 @@
 
 # botaku
 
+A Slack bot abstraction, built on top of [faye-websocket](https://github.com/faye/faye-websocket-ruby) and [httpclient](https://github.com/nahi/httpclient).
+
+
+## use
+
+Botaku provides `Botaku::Client` and `Botaku::Bot`.
+
+## Botaku::Client
+
+```ruby
+require 'botaku'
+
+#c = Botaku::Client.new(token: 'xxxx-111111111111-aaaaaaaaaaaaaaaaaaaaaaaa')
+  # or
+c = Botaku::Client.new(token: '.slack_api_token')
+
+c.on('hello') do
+  p [ :hello ]
+  c.say('born to be alive...', '#test')
+end
+c.on('message') do |data|
+  p [ :message, data ]
+  c.say('pong', channel: data['channel']) if data['text'].match(/\A\s*ping\b/)
+end
+```
+
+## Botaku::Bot
+
+```ruby
+require 'botaku'
+
+class ZeroBot < Botaku::Bot
+
+  def on_hello
+
+    p [ :on_hello, _self['id'] ]
+
+    say(
+      "I am #{name} (#{self.class}) from #{`uname -a`}...",
+      '#test')
+  end
+
+  def on_message(data)
+
+    typing(data['channel'])
+    say("@#{user_name(data)} said: #{data['text'].inspect}", data['channel'])
+  end
+end
+
+#ZeroBot.new(token: 'xxxx-111111111111-aaaaaaaaaaaaaaaaaaaaaaaa')
+  # or
+ZeroBot.new(token: 'test/.slack_api_token').run
+```
+
+
 ## license
 
 MIT, see [LICENSE.txt](LICENSE.txt).

data/botaku.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.summary = 'a Slack bot abstraction'
 
   s.description = %{
-A Slack bot abstraction, built on top of the slack-ruby-client gem.
+A Slack bot abstraction, built on top of faye-websocket and httpclient.
   }.strip
 
   #s.files = `git ls-files`.split("\n")
@@ -28,7 +28,8 @@ A Slack bot abstraction, built on top of the slack-ruby-client gem.
     "#{s.name}.gemspec",
   ]
 
-  s.add_runtime_dependency 'slack-ruby-client', '~> 0.8'
+  s.add_runtime_dependency 'faye-websocket', '~> 0.10'
+  s.add_runtime_dependency 'httpclient', '~> 2.8'
 
   #s.add_development_dependency 'rspec', '>= 2.13.0'
 

data/lib/botaku.rb

@@ -1,6 +1,9 @@
 
 module Botaku
 
-  VERSION = '0.1.0'
+  VERSION = '0.9.0'
 end
 
+require 'botaku/client'
+require 'botaku/bot'
+

data/lib/botaku/bot.rb

@@ -0,0 +1,98 @@
+
+module Botaku
+
+  class Bot
+
+    attr_reader :client, :opts
+
+    def initialize(opts)
+
+      fail ArgumentError.new('missing :token') unless opts[:token]
+
+      @opts = opts
+    end
+
+    def _self
+
+      @client._self
+    end
+
+    def name
+
+      @client.objects[_self['id']]['name']
+    end
+
+    def say(*as)
+
+      @client.say(*(as + [ @channel ]))
+    end
+
+    def typing(channel=@channel)
+
+      @client.typing(channel: channel)
+    end
+
+    def run
+
+      @client = Botaku::Client.new(@opts.dup)
+
+      @client.on('hello') { invoke(:hello) }
+      @client.on(:close) { |d| invoke(:close, d) }
+
+      @client.on('message') do |d|
+        (invoke_command(d) || invoke(:message, d)) if d['user'] != _self['id']
+      end
+
+      @client.run
+    end
+    alias join run
+
+    private
+
+    def determine_conf_name
+
+      self.class.name.split(':').last.downcase[0..-4]
+    end
+
+    def invoke_command(data)
+
+      public_methods.sort.grep(/\Aon_command_[a-z]+\z/)
+        .each do |meth|
+          m = match_command(data, meth.to_s[11..-1])
+          next unless m
+          data['match'] = m
+          self.send(meth, data)
+          return true
+        end
+
+      false
+    end
+
+    def invoke(type, data=nil)
+
+      public_methods.sort.grep(/\Aon_#{type}/)
+        .each do |meth|
+          args = method(meth).arity == 1 ? [ data ] : []
+          r = self.send(meth, *args)
+          return true if r == true
+        end
+
+      false
+    end
+
+    def match_command(data, command)
+
+      m = data['text'].match(/\A\s*#{command}(?:\s+(.+))?\z/i)
+      m ? (m[1] || '').split : nil
+    end
+
+    %w[
+      obj obj_id obj_name
+      user user_id user_name
+      channel channel_id channel_name
+    ].each do |m|
+      define_method(m) { |o| @client.send(m, o) }
+    end
+  end
+end
+

data/lib/botaku/client.rb

@@ -0,0 +1,210 @@
+
+require 'json'
+require 'httpclient'
+require 'faye/websocket'
+require 'eventmachine'
+
+
+module Botaku
+
+  class Client
+
+    def initialize(opts)
+
+      fail ArgumentError.new('missing :token') unless opts[:token]
+
+      @opts = opts
+
+      @base_uri = 'https://slack.com/api'
+      @modules = {}
+      @http_client = HTTPClient.new
+      @ws_client = nil
+      @rtm = nil
+      @handlers = {}
+
+      @http_client.debug_dev = $stderr if ENV['BOTAKU_DEBUG_HTTP']
+
+      if @opts[:token].match(/[\\\/.]/) || @opts[:token].count('-') != 2
+        @opts[:token_path] = @opts[:token]
+        @opts[:token] = File.read(@opts[:token]).strip
+      end
+    end
+
+    def _self
+
+      @rtm['self']
+    end
+
+    %w[ api chat rtm ].each do |mod|
+
+      define_method mod do
+        @modules[mod] ||= WebApiModule.new(self, mod)
+      end
+    end
+
+    def on(type, &block)
+
+      (@handlers[type] ||= []) << block
+    end
+
+    def run
+
+      EM.run do
+        @rtm = rtm.start
+        @ws_client = Faye::WebSocket::Client.new(@rtm['url'])
+        [ :open, :error, :close ].each do |event_type|
+          @ws_client.on(event_type) { |event| dispatch(event_type, event) }
+        end
+        @ws_client.on(:message) { |event| dispatch_message(event) }
+      end
+    end
+    alias join run
+
+    # say('hello')
+    # say('hello', '#test_channel')
+    # say('hello', channel: 'C12345ABC')
+    # say('hello', channel: '#test_channel')
+    #
+    def say(*as)
+
+      args = rework_args(as)
+      args[:as_user] = true unless args.has_key?(:as_user)
+
+      args[:text] = args[:text]
+        .gsub(/&/, '&amp;').gsub(/</, '&lt;').gsub(/>/, '&gt;')
+
+      args[:mrkdwn] = true
+
+      #chat.postMessage(args)
+
+      args[:type] = 'message'
+      args[:id] = next_id
+
+      do_send(args)
+    end
+
+    def channels; @rtm['channels']; end
+    def groups; @rtm['groups']; end
+    def users; @rtm['users']; end
+
+    def objects
+
+      @objects ||=
+        (channels + groups + users).inject({}) { |h, o| h[o['id']] = o; h }
+    end
+
+    def obj(o, cat=nil)
+
+      if o.is_a?(Hash)
+        cat = cat ? cat.to_s : nil
+        o = o[cat]
+      end
+
+      case o
+      when /\AU[0-9A-Z]+\z/
+        users.find { |u| u['id'] == o }
+      when /\A@[^\s]+\z/
+        users.find { |u| u['name'] == o[1..-1] }
+      when /\A[CG][0-9A-Z]+\z/
+        (channels + groups).find { |c| c['id'] == o }
+      when /\A#[^\s]+\z/
+        (channels + groups).find { |c| c['name'] == o[1..-1] }
+      else
+        objects[o] ||
+        objects.values.find { |x| x['name'] == o }
+      end
+    end
+
+    def obj_id(o, cat=nil); h = obj(o, cat); h ? h['id'] : nil; end
+    def obj_name(o, cat=nil); h = obj(o, cat); h ? h['name'] : nil; end
+
+    def user(o); obj(o, :user); end
+    def user_id(o); obj_id(o, :user); end
+    def user_name(o); obj_name(o, :user); end
+    def channel(o); obj(o, :channel); end
+    def channel_id(o); obj_id(o, :channel); end
+    def channel_name(o); obj_name(o, :channel); end
+
+    def typing(args)
+
+      do_send(type: 'typing', id: next_id, channel: channel_id(args[:channel]))
+    end
+
+    private
+
+    def get(mod, meth, args)
+
+      uri = args
+        .inject(
+          "#{@base_uri}/#{mod}.#{meth}?token=#{@opts[:token]}"
+        ) { |u, (k, v)|
+          u + "#{uri}&#{k}=#{escape(v)}"
+        }
+
+      @http_client.get(uri)
+    end
+
+    def do_send(args)
+
+      @ws_client.send(JSON.dump(args) + "\n")
+        # the \n seems to help flushing the buffer
+    end
+
+    def next_id
+
+      @id = (@id ||= -1) + 1
+    end
+
+    class WebApiModule
+      def initialize(client, name)
+        @client = client
+        @name = name
+      end
+      def method_missing(meth, *args)
+        args = [ {} ] if args.empty?
+        return super if args.size != 1 || ! args[0].is_a?(Hash)
+        r = @client.send(:get, @name, meth, args.first)
+        JSON.parse(r.body)
+      end
+      undef :test
+    end
+
+    def escape(arg_value)
+
+      v = arg_value.is_a?(String) ? arg_value : arg_value.inspect
+
+      URI.escape(v)
+    end
+
+    def dispatch(event_type, event)
+
+      (@handlers[event_type] || []).each do |block|
+        block.arity == 1 ? block.call(event) : block.call
+      end
+    end
+
+    def dispatch_message(event)
+
+      data = JSON.parse(event.data)
+
+      (@handlers[data['type']] || []).each do |block|
+        block.arity == 1 ? block.call(data) : block.call
+      end
+    end
+
+    def rework_args(as)
+
+      as.inject({}) do |h, a|
+        if h[:channel] == nil && h[:channel] = channel_id(a)
+          # cid just got assigned
+        elsif h[:text] == nil && a.is_a?(String)
+          h[:text] = a
+        elsif a.is_a?(Hash)
+          h.merge!(a)
+        end
+        h
+      end
+    end
+  end
+end
+

metadata

@@ -1,30 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: botaku
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.9.0
 platform: ruby
 authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-16 00:00:00.000000000 Z
+date: 2017-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: slack-ruby-client
+  name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
-description: A Slack bot abstraction, built on top of the slack-ruby-client gem.
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description: A Slack bot abstraction, built on top of faye-websocket and httpclient.
 email:
 - jmettraux@gmail.com
 executables: []
@@ -37,6 +51,8 @@ files:
 - README.md
 - botaku.gemspec
 - lib/botaku.rb
+- lib/botaku/bot.rb
+- lib/botaku/client.rb
 homepage: http://github.com/jmettraux/botaku
 licenses:
 - MIT