blather 0.8.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb830ccd52af623286db7ca3279a65d4af8f697f
-  data.tar.gz: c80062c82de98d711c6fc2c52c9bcbf2d4e9402b
+  metadata.gz: 821cfa57a4b4d947dfe64d18c05c0bd31b8e33bc
+  data.tar.gz: 5f4ed8978cbda2d5c422b5334c87bb02c918896b
 SHA512:
-  metadata.gz: 00b97546e6b9b9d5d483b9bf1f40ce130bbb31ea92ca01e73dd7e5e7387d0f7224b822ca4cdb8f226131b771eb9c71bdddadef08528d1d5ce08824eb4ecd649e
-  data.tar.gz: 33add22b374eec2ae766b5de6e9775c656656737d18b47479498eeab6b8f40c8b0feb3da0a5d8e886c5a32f7baceda17df23e8c9daea087028b288dd027e4f4d
+  metadata.gz: 69222c73bc14ba562a45e56681e7cfa868a1ed4c6a492ddbee36a8bcaca6abbf3f571e126eab05c5a589143d4151c6ea16bced0d97a0f3c7e86ccdb28d2afce7
+  data.tar.gz: 92c7c2ba080d2da3143c0fa796c783e5697d3b39079a423aa42295b7eb68b858214c547f7e05d6344967e5effb4925c3e786a24860c05a542703b29e22c21086

data/.travis.yml

@@ -1,14 +1,15 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
-  - jruby-19mode
-  - rbx-19mode
+  - 2.1.0
+  - jruby
+  - rbx-2.1.1
   - ruby-head
 matrix:
   allow_failures:
-    - rvm: jruby-19mode
+    - rvm: jruby
     - rvm: ruby-head
+    - rvm: rbx-2.1.1
 notifications:
   irc: "irc.freenode.org#adhearsion"

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # [develop](https://github.com/adhearsion/blather/compare/master...develop)
 
+# [v1.0.0](https://github.com/adhearsion/blather/compare/v0.8.8...v1.0.0) - [2014-02-10](https://rubygems.org/gems/blather/versions/1.0.0)
+  * Stable API promise
+  * Bugfix: Fix the DSL module-extended API that was broken by 8327184acc57c20daeaebb975729ff70207eab67
+
 # [v0.8.8](https://github.com/adhearsion/blather/compare/v0.8.7...v0.8.8) - [2013-09-30](https://rubygems.org/gems/blather/versions/0.8.8)
   * Bugfix: Warn about local file transfers being disabled by default
   * Bugfix: Ensure that file transfers are accepted instantly. See https://groups.google.com/forum/#!topic/xmpp-blather/LMl6pR9qHfA

data/README.md

@@ -26,7 +26,6 @@ XMPP DSL (and more) for Ruby written on [EventMachine](http://rubyeventmachine.c
 Blather comes with a DSL that makes writing XMPP bots quick and easy. See the examples directory for more advanced examples.
 
 ```ruby
-require 'rubygems'
 require 'blather/client'
 
 setup 'echo@jabber.local', 'echo'
@@ -42,6 +41,49 @@ message :chat?, :body do |m|
 end
 ```
 
+The above example is for a standalone script, and [can be run as a command line program](https://github.com/adhearsion/blather#on-the-command-line). If you wish to integrate Blather into an existing application, you will need to avoid `blather/client` and instead do something like this:
+
+```ruby
+require 'blather/client/dsl'
+
+module App
+  extend Blather::DSL
+
+  def self.run
+    EM.run { client.run }
+  end
+
+  setup 'echo@jabber.local', 'echo'
+
+  # Auto approve subscription requests
+  subscription :request? do |s|
+    write_to_stream s.approve!
+  end
+
+  # Echo back what was said
+  message :chat?, :body do |m|
+    write_to_stream m.reply
+  end
+end
+
+trap(:INT) { EM.stop }
+trap(:TERM) { EM.stop }
+
+App.run
+```
+
+If you need to ensure that Blather does not block the rest of your application, run the reactor in a new thread:
+
+```ruby
+Thread.new { App.run }
+```
+
+You can additionally send messages like so:
+
+```ruby
+App.say 'foo@bar.com', 'Hello there!'
+```
+
 ## Handlers
 
 Handlers let Blather know how you'd like each type of stanza to be well.. handled. Each type of stanza has an associated handler which is part of a handler hierarchy. In the example above we're handling message and subscription stanzas.

data/blather.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.homepage    = "http://adhearsion.com/blather"
   s.summary     = %q{Simpler XMPP built for speed}
   s.description = %q{An XMPP DSL for Ruby written on top of EventMachine and Nokogiri}
+  s.license     = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/blather/client/dsl.rb

@@ -94,6 +94,18 @@ module Blather
       super
     end
 
+    def self.extended(o)
+      # Generate a method for every stanza handler that exists.
+      Blather::Stanza.handler_list.each do |handler_name|
+        module_eval <<-METHOD, __FILE__, __LINE__
+          def #{handler_name}(*args, &callback)
+            handle :#{handler_name}, *args, &callback
+          end
+        METHOD
+      end
+      super
+    end
+
     # The actual client connection
     #
     # @return [Blather::Client]

data/lib/blather/version.rb

@@ -1,3 +1,3 @@
 module Blather
-  VERSION = '0.8.8'
+  VERSION = '1.0.0'
 end

data/spec/blather/client/dsl_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 require 'blather/client/dsl'
 
-include Blather::DSL
-
 describe Blather::DSL do
   before do
     @client = Blather::Client.new
@@ -266,6 +264,22 @@ describe Blather::DSL do
     @dsl.pubsub.host.should == jid.domain
   end
 
+  context "extending a module" do
+    let(:test_module) do
+      Module.new do
+        extend Blather::DSL
+      end
+    end
+
+    Blather::Stanza.handler_list.each do |handler_method|
+      it "provides a helper method for #{handler_method}" do
+        guards = [:chat?, {:body => 'exit'}]
+        @client.expects(:register_handler).with handler_method, *guards
+        test_module.__send__(handler_method, *guards)
+      end
+    end
+  end
+
   context "included in a class which defines methods which collide with handler names" do
     class CollisionTarget
       include Blather::DSL

data/spec/spec_helper.rb

@@ -14,3 +14,7 @@ end
 def parse_stanza(xml)
   Nokogiri::XML.parse xml
 end
+
+def jruby?
+  RUBY_PLATFORM =~ /java/
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blather
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Jeff Smick
@@ -9,208 +9,208 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2014-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.6
 - !ruby/object:Gem::Dependency
   name: niceogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.11
 - !ruby/object:Gem::Dependency
   name: girl_friday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
   name: bluecloth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: countdownlatch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 description: An XMPP DSL for Ruby written on top of EventMachine and Nokogiri
@@ -221,9 +221,9 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -370,26 +370,27 @@ files:
 - yard/templates/default/class/setup.rb
 - yard/templates/default/class/text/handlers.erb
 homepage: http://adhearsion.com/blather
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 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.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Simpler XMPP built for speed