drivel 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in drivel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Joshua M. Keyes
+
+MIT License
+
+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,79 @@
+# Drivel
+
+An alternative DSL utilizing the excellent XMPP library, Blather, for creating interactive XMPP bots.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'drivel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install drivel
+
+## Usage
+
+TBD.
+
+## Example
+
+    #!/usr/bin/env ruby
+
+    require 'drivel'
+
+    configure do
+      # Do basic setup/configuration.
+      set nickname: 'DrivelBot', jid: 'username@chat.example.com/resource', password: 'secretpassword'
+
+      # (Optional) conferences to discover and join.
+      set :conferences, 'main', 'offtopic'
+    end
+
+    helpers do
+      def authorized?(context)
+        context.chat? and message.from == 'owner@example.com'
+      end
+    end
+
+    connected do
+      status :available, 'At your service.'
+    end
+
+    disconnected do
+      status :offline, 'Going away now.' and shutdown
+    end
+
+    subscription do |message|
+      # Handle subscription messages like Blather would.
+    end
+
+    command 'ping' do |message|
+      respond message, 'pong'
+    end
+
+    command 'join :conference' do |message, params|
+      respond message, "I'm afraid I can't do that." and halt unless authorized?(message)
+      join params[:conference]
+    end
+
+    command 'leave :conference' do |message, params|
+      respond message, "I'm afraid I can't do that." and halt unless authorized?(message)
+      leave params[:conference]
+    end
+
+    recognize 'What is love?' do |message|
+      respond message, "Baby don't hurt me no more."
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/drivel.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'drivel/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "drivel"
+  gem.version       = Drivel::VERSION
+
+  gem.authors       = ["Joshua M. Keyes"]
+  gem.email         = ["joshua.michael.keyes@gmail.com"]
+
+  gem.description   = %q{An alternative DSL utilizing the excellent XMPP library, Blather, for creating interactive XMPP bots.}
+  gem.summary       = %q{A DSL for building XMPP bots.}
+  gem.homepage      = "https://github.com/jmkeyes/drivel"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'blather', '= 0.8.1'
+end

data/lib/drivel.rb

@@ -0,0 +1,3 @@
+require 'drivel/version'
+require 'drivel/base'
+require 'drivel/main'

data/lib/drivel/base.rb

@@ -0,0 +1,193 @@
+require 'blather/client/client'
+
+module Drivel
+  module DSL
+    def set(key, *values)
+      if key.is_a?(Hash) and values.empty?
+        key.each { |k, v| set(k, v) }
+      else
+        create_method("#{key}=") { |value| settings[key] = value }
+        create_method("#{key}?") { !!settings[key] }
+        create_method("#{key}")  { settings[key] }
+
+        settings[key] = values.first
+      end
+    end
+
+    def configure
+      yield
+    end
+
+    def helpers(*helpers, &block)
+      self.instance_eval(&block) if block_given?
+      include(*helpers) unless helpers.empty?
+    end
+
+    def before(handler = nil, *guards, &block)
+      filter(:before, handler, *guards, &block)
+    end
+
+    def after(handler = nil, *guards, &block)
+      filter(:after, handler, *guards, &block)
+    end
+
+    def connected(&block)
+      handle(:ready, &block)
+    end
+
+    def disconnected(&block)
+      handle(:disconnected, &block)
+    end
+
+    def subscription(&block)
+      handle(:subscription, &block)
+    end
+
+    def command(pattern, *arguments, &block)
+      raise InvalidArgumentError unless pattern.is_a?(String) or pattern.is_a?(Regexp)
+
+      safe_nickname   = Regexp.escape(settings[:nickname])
+      optional_prefix = /(?:#{safe_nickname}[:,]? |[!$%@])/i
+
+      pattern.gsub!(/((:\w+)|\*)/) do |key|
+        (key == '*' ? "(?<splat>.*?)" : "(?<#{key[1..-1]}>[^\s]+)")
+      end if pattern.is_a?(String)
+
+      recognize(/\A#{optional_prefix}#{pattern}\Z/, &block)
+    end
+
+    def recognize(pattern, *arguments, &block)
+      raise InvalidArgumentError unless pattern.is_a?(String) or pattern.is_a?(Regexp)
+
+      matcher = Regexp.compile(pattern, true)
+
+      handle(:message, :body => matcher) do |message|
+        matches  = message.body.match(matcher)
+        captures = matches.names.map(&:to_sym).zip(matches.captures)
+        yield message, Hash[captures]
+      end
+    end
+
+    def ready?
+      jid? and password? and nickname?
+    end
+
+    def run!
+      client.setup(settings[:jid], settings[:password])
+
+      # Reopen standard input and direct it at /dev/null.
+      $stdin.reopen('/dev/null')
+
+      # Capture interrupt and terminate and force them to shutdown the connection.
+      [:INT, :TERM].each do |signal|
+        trap(signal) { shutdown }
+      end
+
+      # Start.
+      EM.run { client.run }
+    end
+
+    def status(mode, message)
+      mode = nil if mode == :offline
+      client.status = mode, message
+    end
+
+    def shutdown
+      client.close
+    end
+
+    def respond(message = nil, content = nil)
+      response = ::Blather::Stanza::Message.new.tap do |stanza|
+        if message and content
+          stanza.type, stanza.from = message.type, message.to
+
+          case message.type
+          when :groupchat
+            stanza.to   = message.from.stripped
+            stanza.body = message.from.resource + ': ' + content
+          when :chat
+            stanza.to   = message.from
+            stanza.body = content
+          else
+            raise ArgumentError, 'Cannot respond to messages of type ' + message.type.to_s
+          end
+        end
+
+        # Evaluate any given block, passing in this message before delivery.
+        yield stanza if block_given?
+      end
+
+      EM.next_tick { client.write(response) }
+    end
+
+    def join(conference, &block)
+      room    = ::Blather::JID.new(conference)
+      request = ::Blather::Stanza::Presence::MUC.new.tap do |stanza|
+        target = ::Blather::JID.new(room.node, room.domain, settings[:nickname])
+        stanza.to, stanza.type = target, nil
+      end
+      client.write_with_handler(request)
+    end
+
+    def leave(conference, &block)
+      room = ::Blather::JID.new(conference)
+      request = ::Blather::Stanza::Presence::MUC.new.tap do |stanza|
+        target = ::Blather::JID.new(room.node, room.domain, settings[:nickname])
+        stanza.to, stanza.type = target, :unavailable
+      end
+      client.write_with_handler(request, &block)
+    end
+
+    def pass
+      throw :pass
+    end
+
+    def halt
+      throw :halt
+    end
+
+    def discover(type, target, node = nil, &block)
+      stanza = {
+        info:  ::Blather::Stanza::DiscoInfo,
+        items: ::Blather::Stanza::DiscoItems
+      }[type].new
+
+      stanza.node = node
+      stanza.from = client.jid
+      stanza.to   = target
+
+      client.write_with_handler(stanza, &block)
+    end
+
+    def schedule(interval, repeat = true, &block)
+      EM.next_tick do
+        if repeat
+          EM.add_periodic_timer(interval, &block)
+        else
+          EM.add_timer(interval, &block)
+        end
+      end
+    end
+
+    private
+    def settings
+      @settings ||= {}
+    end
+
+    def client
+      @client ||= ::Blather::Client.new
+    end
+
+    def handle(type, *guards, &block)
+      client.register_handler(type, *guards, &block)
+    end
+
+    def filter(type, handler = nil, *guards, &block)
+      client.register_filter(type, handler, *guards, &block)
+    end
+
+    def create_method(name, *arguments, &block)
+      self.class.send(:define_method, name, *arguments, &block)
+    end
+  end
+end

data/lib/drivel/main.rb

@@ -0,0 +1,4 @@
+require 'drivel/base'
+
+Object.send(:include, ::Drivel::DSL)
+at_exit { run! if ready? }

data/lib/drivel/version.rb

@@ -0,0 +1,3 @@
+module Drivel
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: drivel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joshua M. Keyes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: blather
+  requirement: &7989760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *7989760
+description: An alternative DSL utilizing the excellent XMPP library, Blather, for
+  creating interactive XMPP bots.
+email:
+- joshua.michael.keyes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- drivel.gemspec
+- examples/.gitkeep
+- lib/drivel.rb
+- lib/drivel/base.rb
+- lib/drivel/main.rb
+- lib/drivel/version.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jmkeyes/drivel
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A DSL for building XMPP bots.
+test_files:
+- spec/spec_helper.rb
+has_rdoc: