blather 0.4.15 → 0.4.16

data/.autotest

@@ -0,0 +1,13 @@
+Autotest.add_hook :initialize do |at|
+  ignore = %w[.git examples ext pkg .DS_Store CHANGELOG LICENSE VERSION.yml README.rdoc .autotest Rakefile blather.gemspec]
+
+  ignore.each { |exception| at.add_exception(exception) }
+
+  at.clear_mappings
+
+  at.add_mapping(%r%^spec/.*_spec.rb$%) { |filename, _| filename }
+  at.add_mapping(%r%^lib/(.*)\.rb$%) { |_, m| ["spec/#{m[1]}_spec.rb"] }
+  at.add_mapping(%r%^spec/(spec_helper|shared/.*)\.rb$%) { 
+    at.files_matching %r%^spec/.*_spec\.rb$%
+  }
+end

data/.gitignore

@@ -0,0 +1,18 @@
+pkg
+Manifest
+doc
+coverage
+*.bundle
+Gemfile.lock
+mkmf.log
+*.o
+Makefile
+rdoc
+*.gem
+*.log
+*.pid
+notes
+.yardoc
+*.rbc
+lib/.DS_Store
+vendor

data/CHANGELOG

@@ -0,0 +1,150 @@
+v0.4.16
+	Feature(benlangfeld): switch from jeweler to bundler
+	Feature(benlangfeld): add cap support (XEP-0115)
+	Bugfix(sprsquish): Better equality checking
+	Bugfix(sprsquish): Fix #to_proc
+	Bugfix(mironov): Skip private IPs by default
+
+v0.4.15
+  Feature(mironov): Implement XEP-0054: vcard-temp
+  Feature(benlangfeld): Basic support for PubSub subscription notifications as PubSub events
+  Feature(mironov): Ability to clear handlers
+  Feature(mironov): Implement incoming file transfers (XEP-0096, XEP-0065, XEP-0047)
+  Bugfix(mironov): Fix for importing messages with chat states
+  Bugfix(mironov): Added Symbol#to_proc method to work on ruby 1.8.6
+  Bugfix(mironov): Fix roster items .status method to return highest priority presence
+  Bugfix(mironov): Remove old unavailable presences while adding new one
+  Bugfix(mironov): Use Nokogiri::XML::ParseOptions::NOENT to prevent double-encoding of entities
+  Bugfix(benlangfeld): Disco Info Identities should have an xml:lang attribute
+  Bugfix(mironov): Fix lookup path for ruby 1.9
+  Bugfix(mironov): stanza_error.to_node must set type of the error
+  Bugfix(mironov): Allow message to have iq child
+  Bugfix(mironov): Find xhtml body in messages sent from iChat 5.0.3
+
+v0.4.14
+  Tests: get specs fully passing on rubinius
+  Feature(mironov): Implement XEP-0085 Chat State Notifications
+  Bugfix(mironov): send stanzas unformatted
+  Bugfix(mironov): Message#xhtml uses inner_html so tags aren't escaped
+  Bugfix(mironov): Message#xhtml= now works with multiple root nodes
+
+v0.4.13
+  Bugfix: Place form child of command inside command element
+
+v0.4.12
+  API Change: Switch order of var and type arguments to X::Field.new since var is always required but type is not
+  API Change: PubSub payloads can be strings or nodes and can be set nil. PubSub#payload will always return a string
+  Feature: Add forms to Message stanzas
+
+v0.4.11
+  Bugfix: command nodes where generating the wrong xml
+  Bugfix: x nodes where generating the wrong xml
+  Feature: ability to set identities and features on disco info nodes
+  Feature: ability to set items on disco item nodes
+
+v0.4.10
+  no change
+
+v0.4.9
+  Feature: XEP-0004 x:data (benlangfeld)
+  Feature: XEP-0050 Ad-Hoc commands (benlangfeld)
+  Minor bugfixes for the specs
+
+v0.4.8
+  Feature: add xhtml getter/setter to Message stanza
+  Bugfix: heirarchy -> hierarchy spelling mistake
+  Hella documentation
+
+v0.4.7
+  Update to work with Nokogiri 1.4.0
+
+v0.4.6
+  Bugfix: prioritize authentication mechanisms
+
+v0.4.5
+  Bugfix: Change DSL#write to DSL#write_to_stream. Previous way was messing with YAML
+
+v0.4.4
+  Add "disconnected" handler type to handle connection termination
+  Bugfix: Fix error with pubsub using the wrong client connection
+
+v0.4.3
+  Bugfix: status stanza with a blank state will be considered :available (GH-23)
+  Bugfix: ensure regexp guards try to match against a string (GH-24)
+  Stream creation is now evented. The stream object will be sent to #post_init
+  Parser debugging disabled by default
+  Update parser to work with Nokogiri 1.3.2
+  Bugfix: discover helper now calls the correct method on client
+  Bugfix: ensure XMPPNode#inherit properly sets namespaces on inherited nodes
+  Bugfix: xpath guards with namespaces work properly (GH-25)
+
+v0.4.2
+  Fix -D option to actually put Blather in debug mode
+  Stanzas over a client connection will either have the full JID or no JID
+  Regexp guards can be anything that implements #last_match (Regexp or Oniguruma)
+  Add "halt" and "pass" to allow handlers to either halt the handler chain or pass to the next handler
+  Fix default status handler so it doesn't eat the stanza
+  Add before and after filters. Filters, like handlers, can have guards.
+
+v0.4.1
+  Bugfix in roster: trying to call the wrong method on client
+
+v0.4.0
+  Switch from LibXML-Ruby to Nokogiri
+  Update test suite to run on Ruby 1.9
+  Add "<<" style writer to the DSL to provide for chaining outbound writes
+  SRV lookup support
+  Add XPath type of handler guard
+  PubSub support
+
+v0.3.4
+  Remove unneeded functions from the push parser.
+  Create a ParseWarning error that doesn't kill the stream.
+  When a parse error comes in the reply should let the other side know it screwed up before dying.
+  Add the LibXML::XML::Error node to the ParseError/ParseWarning objects.
+
+v0.3.3
+  Fix the load error related to not pushing Blather's dir into the load path
+
+v0.3.2
+  Switch the push parser from chunking to streaming.
+  Don't push Blather's dir into the load paths
+
+v0.3.1
+  Small changes to the DSL due to handler collisions:
+    "status" -> "set_status"
+    "roster" -> "my_roster"
+  Small changes to the Blather::Client API to keep it feeling more like EM's API:
+    #stream_started -> #post_init
+    #call -> #receive_data
+    #stop -> #close
+    #stopped -> #unbind
+  Refactored some of the code internal to Blather::Client
+  Added command line option handler to default use method (see README)
+  require libxml-ruby >=1.1.2 (1.1.3 has an inconsistent malloc err on OS X 10.5)
+  complete specs
+  add single process ping-pong example
+
+v0.3.0
+  Remove autotest discover.rb (created all sorts of conflicts)
+  Added Hash with Array guard
+  Added a hirrarchy printer to examples directory
+  Moved Disco to be in the Stanza namespace (staves off deeply namespaced classes)
+  Namespaced the DSL methods to Blather::DSL. These can be included in any object you like now. "require 'blather/client'" will still include them directly in Kernel to keep the simple one-file dsl
+  Stopped doing one class per error type. This created a giant hierarchy tree that was just unnecessary. The error name is now #name. Errors can be matched with a combination of handler and guard.
+  Fixed XML namespaces. Previous versions weren't actually adding the node to the namespace making xpath queries inconsistent at best.
+  Added support for anonymous authentication by providing a blank node on the jid ("@[host]")
+
+v0.2.3
+  Go back to using the master branch for gems (stupid mistake)
+
+v0.2.2
+  Switch to Jeweler.
+  Move from custom libxml to just a custom push parser
+  Add guards to handlers
+
+v0.2.1 Upgrade to libxml 0.9.7
+
+v0.2 Overhaul the DSL to look more like Sinatra
+
+v0.1 Initial release (birth!)

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'rake'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'spec'
+  test.pattern = 'spec/**/*_spec.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'spec'
+  test.pattern = 'spec/**/*_spec.rb'
+  test.rcov_opts += ['--exclude \/Library\/Ruby,spec\/', '--xrefs']
+  test.verbose = true
+end
+
+require 'yard'
+YARD::Tags::Library.define_tag 'Blather handler', :handler, :with_name
+YARD::Templates::Engine.register_template_path 'yard/templates'
+
+YARD::Rake::YardocTask.new do |t|
+  t.options = ['--no-private', '-m', 'markdown', '-o', './doc/public/yard']
+end
+
+desc 'Generate documentation'
+task :doc => :yard
+task :default => :test

data/TODO.md

@@ -0,0 +1,2 @@
+ * Cleanup implementation of X stanzas
+ * Cleanup implementation of PubSub Subscribe Events

data/blather.gemspec

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "blather/version"
+
+Gem::Specification.new do |s|
+  s.name        = "blather"
+  s.version     = Blather::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jeff Smick"]
+  s.email       = %q{sprsquish@gmail.com}
+  s.date        = %q{2010-09-02}
+  s.homepage    = "http://github.com/sprsquish/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.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.rdoc_options = %w{--charset=UTF-8}
+  s.extra_rdoc_files = %w{LICENSE README.md}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<eventmachine>, ["~> 0.12.6"])
+      s.add_runtime_dependency(%q<nokogiri>, ["~> 1.4.0"])
+
+      s.add_development_dependency(%q<minitest>, ["~> 1.7.1"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.9.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<rcov>, ["~> 0.9.9"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.1"])
+      s.add_development_dependency(%q<bluecloth>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<rake>)
+    else
+      s.add_dependency(%q<eventmachine>, [">= 0.12.6"])
+      s.add_dependency(%q<nokogiri>, [">= 1.4.0"])
+      s.add_dependency(%q<minitest>, [">= 1.7.1"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, [">= 0.12.6"])
+    s.add_dependency(%q<nokogiri>, [">= 1.4.0"])
+    s.add_dependency(%q<minitest>, [">= 1.7.1"])
+  end
+end

data/lib/blather.rb

@@ -3,12 +3,14 @@
   rubygems
   eventmachine
   nokogiri
+  ipaddr
   digest/md5
   digest/sha1
   logger
 
   blather/core_ext/active_support
   blather/core_ext/eventmachine
+  blather/core_ext/ipaddr
   blather/core_ext/nokogiri
 
   blather/errors
@@ -37,6 +39,7 @@
   blather/stanza/disco/disco_items
   blather/stanza/message
   blather/stanza/presence
+  blather/stanza/presence/c
   blather/stanza/presence/status
   blather/stanza/presence/subscription
 

data/lib/blather/client/client.rb

@@ -33,7 +33,8 @@ module Blather
   #
   class Client
     attr_reader :jid,
-                :roster
+                :roster,
+                :caps
 
     # Create a new client and set it up
     #
@@ -56,6 +57,7 @@ module Blather
       @tmp_handlers = {}
       @filters = {:before => [], :after => []}
       @roster = Roster.new self
+      @caps = Caps.new
 
       setup_initial_handlers
     end
@@ -313,6 +315,142 @@ module Blather
         end
       end
     end
+
+    class Caps < Blather::Stanza::DiscoInfo
+      def self.new
+        super :result
+      end
+
+      def ver
+        generate_ver identities, features
+      end
+
+      def node=(node)
+        @bare_node = node
+        super "#{node}##{ver}"
+      end
+
+      def identities=(identities)
+        super identities
+        regenerate_full_node
+      end
+
+      def features=(features)
+        super features
+        regenerate_full_node
+      end
+
+      def c
+        Blather::Stanza::Presence::C.new @bare_node, ver
+      end
+
+      private
+
+      def regenerate_full_node
+        self.node = @bare_node
+      end
+
+      def generate_ver_str(identities, features, forms = [])
+        # 1.  Initialize an empty string S.
+        s = ''
+
+        # 2. Sort the service discovery identities by category and
+        # then by type (if it exists) and then by xml:lang (if it
+        # exists), formatted as CATEGORY '/' [TYPE] '/' [LANG] '/'
+        # [NAME]. Note that each slash is included even if the TYPE,
+        # LANG, or NAME is not included.
+        identities.sort! do |identity1, identity2|
+          cmp_result = nil
+          [:category, :type, :xml_lang, :name].each do |field|
+            value1 = identity1.send(field)
+            value2 = identity2.send(field)
+
+            if value1 != value2
+              cmp_result = value1 <=> value2
+              break
+            end
+          end
+          cmp_result
+        end
+
+        # 3. For each identity, append the 'category/type/lang/name' to
+        # S, followed by the '<' character.
+        s += identities.collect do |identity|
+          [:category, :type, :xml_lang, :name].collect do |field|
+            identity.send(field).to_s
+          end.join('/') + '<'
+        end.join
+
+        # 4. Sort the supported service discovery features.
+        features.sort! { |feature1, feature2| feature1.var <=> feature2.var }
+
+        # 5. For each feature, append the feature to S, followed by the
+        # '<' character.
+        s += features.collect { |feature| feature.var.to_s + '<' }.join
+
+        # 6. If the service discovery information response includes
+        # XEP-0128 data forms, sort the forms by the FORM_TYPE (i.e., by
+        # the XML character data of the <value/> element).
+        forms.sort! do |form1, form2|
+          fform_type1 = form1.field 'FORM_TYPE'
+          fform_type2 = form2.field 'FORM_TYPE'
+          form_type1 = fform_type1 ? fform_type1.values.to_s : nil
+          form_type2 = fform_type2 ? fform_type2.values.to_s : nil
+          form_type1 <=> form_type2
+        end
+
+        # 7. For each extended service discovery information form:
+        forms.each do |form|
+          # 7.1. Append the XML character data of the FORM_TYPE field's
+          # <value/> element, followed by the '<' character.
+          fform_type = form.field 'FORM_TYPE'
+          form_type = fform_type ? fform_type.values.to_s : nil
+          s += "#{form_type}<"
+
+          # 7.2. Sort the fields by the value of the "var" attribute
+          fields = form.fields.sort { |field1, field2| field1.var <=> field2.var }
+
+          # 7.3. For each field:
+          fields.each do |field|
+            # 7.3.1. Append the value of the "var" attribute, followed by
+            # the '<' character.
+            s += "#{field.var}<"
+
+            # 7.3.2. Sort values by the XML character data of the <value/> element
+            # values = field.values.sort { |value1, value2| value1 <=> value2 }
+
+            # 7.3.3. For each <value/> element, append the XML character
+            # data, followed by the '<' character.
+            # s += values.collect { |value| "#{value}<" }.join
+            s += "#{field.value}<"
+          end
+        end
+        s
+      end
+
+      def generate_ver(identities, features, forms = [], hash = 'sha-1')
+        s = generate_ver_str identities, features, forms
+
+        # 9. Compute the verification string by hashing S using the
+        # algorithm specified in the 'hash' attribute (e.g., SHA-1 as
+        # defined in RFC 3174). The hashed data MUST be generated
+        # with binary output and encoded using Base64 as specified in
+        # Section 4 of RFC 4648 (note: the Base64 output MUST NOT
+        # include whitespace and MUST set padding bits to zero).
+
+        # See http://www.iana.org/assignments/hash-function-text-names
+        hash_klass = case hash
+                       when 'md2' then nil
+                       when 'md5' then Digest::MD5
+                       when 'sha-1' then Digest::SHA1
+                       when 'sha-224' then nil
+                       when 'sha-256' then Digest::SHA256
+                       when 'sha-384' then Digest::SHA384
+                       when 'sha-512' then Digest::SHA512
+                     end
+        hash_klass ? [hash_klass::digest(s)].pack('m').strip : nil
+      end
+    end # Caps
   end  # Client
 
 end  # Blather