collecta-rb 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeff Smick
+
+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,44 @@
+Collecta.rb
+===========
+
+A ruby library based on Blather for working with the Collecta XMPP api.
+
+Install
+-------
+Gem is hosted on [Gemcutter](http://gemcutter.org/)
+
+    sudo gem install collecta-rb
+
+Example
+-------
+
+    require 'rubygems'
+    require 'collecta-rb'
+    require 'pp'
+
+    client = Collecta::Client.setup '[api-key]'
+
+    client.subscribe('earthquake') do |result|
+      pp({
+        :query => result.query,
+        :title => result.title,
+        :category => result.category,
+        :abstract => result.abstract,
+      })
+    end
+
+    client.notifications('earthquake') do |notification|
+      pp notification
+    end
+
+    client.archive('earthquake') do |result|
+      pp result
+    end
+
+    EM.run { client.connect }
+
+
+Copyright
+---------
+
+Copyright (c) 2009 Jeff Smick. See LICENSE for details.

data/examples/collecta.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'collecta-rb'
+require 'pp'
+
+client = Collecta::Client.setup 'f67a267c6d5c86ed36ae676e70698bdd'
+
+client.subscribe('earthquake') do |result|
+  pp({
+    :query => result.query,
+    :title => result.title,
+    :category => result.category,
+    :abstract => result.abstract,
+  })
+end
+
+client.notifications('earthquake') do |notification|
+  pp notification
+end
+
+client.archive('earthquake') do |result|
+  pp result
+end
+
+EM.run { client.connect }

data/lib/collecta-rb.rb

@@ -0,0 +1,84 @@
+%w[
+  blather
+  blather/client/client
+
+  collecta/pubsub
+  collecta/archive
+  collecta/result
+  collecta/subscribe
+].each { |r| require r }
+
+module Collecta
+  COLLECTA_JID = 'search.collecta.com'.freeze
+  HOST = 'guest.collecta.com'.freeze
+  NODE = 'search'.freeze
+
+  class Client < Blather::Client
+    attr_accessor :api_key # :nodoc:
+
+    # Setup the connection with an API key
+    def self.setup(apikey)
+      new_client = super "@#{HOST}", nil
+      new_client.api_key = apikey
+      new_client
+    end
+
+    def initialize # :nodoc:
+      super
+      @deferred = []
+    end
+
+    # Subscribe to a query
+    def subscribe(search, &block)
+      return if defer(:subscribe, search, &block)
+      self.write Subscribe.new self.api_key, search
+      self.register_handler(:pubsub_event, "//ns:headers/ns:header[@name='x-collecta#query' and .='#{search}']", :ns => 'http://jabber.org/protocol/shim') do |evt, _|
+        block.call Result.new.inherit(evt)
+      end
+    end
+
+    # Subscribe to query notifications
+    def notifications(search, &block)
+      return if defer(:notifications, search, &block)
+      self.write Subscribe.new self.api_key, nil, search
+      self.register_handler(:pubsub_event, "//ns:item[@id='#{search}']", :ns => 'http://jabber.org/protocol/pubsub#event') do |evt, item|
+        block.call item.first.find('//ns:count', :ns => 'http://api.collecta.com/ns/search-0#notify').first.content.to_i
+      end
+    end
+
+    # Retrieve the last set of entries for <tt>search</tt>
+    def archive(search, &block)
+      return if defer(:archive, search, &block)
+      self.write_with_handler Archive.new(self.api_key, search), &block
+    end
+
+    # Collecta doesn't seem to like stanzas with whitespace so clear it out
+    def write(stanza) # :nodoc:
+      super stanza.to_xml(:indent => 0).gsub(/\n|\r/,'')
+    end
+
+    # Allow users to setup callbacks before the connection is setup
+    def defer(*args, &block) # :nodoc:
+      if @stream
+        false
+      else
+        @deferred << [args, block]
+        true
+      end
+    end
+
+    # Run all deferred commands after the connection is established
+    def post_init(stream, jid = nil) # :nodoc:
+      super
+      until @deferred.empty?
+        args = @deferred.pop
+        self.__send__ *(args[0]), &args[1]
+      end
+    end
+
+    def client_post_init # :nodoc:
+      # overwrite the default actions to take after a client is setup
+    end
+  end
+
+end

data/lib/collecta/archive.rb

@@ -0,0 +1,12 @@
+module Collecta
+  class Archive < Blather::Stanza::PubSub::Items
+    include Collecta::Pubsub
+    def self.new(apikey, search)
+      new_node = super :get, COLLECTA_JID
+      new_node.node = NODE
+      new_node.apikey = apikey
+      new_node.query = search
+      new_node
+    end
+  end
+end

data/lib/collecta/pubsub.rb

@@ -0,0 +1,54 @@
+module Collecta
+  module Pubsub
+    DATA_NS = 'jabber:x:data'.freeze
+
+    def apikey
+      self.options.content_from '//ns:field[@var="x-collecta#apikey"]/ns:value', :ns => DATA_NS
+    end
+
+    def apikey=(key)
+      self.add_field 'x-collecta#apikey', key
+    end
+
+    def query
+      self.options.find('//ns:field[@var="x-collecta#query"]/ns:value', :ns => DATA_NS).map { |n| n.content }
+    end
+
+    def query=(values)
+      self.add_field 'x-collecta#query', values
+    end
+
+    def notify
+      self.options.find('//ns:field[@var="x-collecta#notify"]/ns:value', :ns => DATA_NS).map { |n| n.content }
+    end
+
+    def notify=(values)
+      self.add_field 'x-collecta#notify', values
+    end
+
+  protected
+    def options
+      x = self.pubsub.find_first('//pubsub_ns:options/ns:x', :pubsub_ns => self.registered_ns, :ns => DATA_NS)
+      unless x
+        self.pubsub << (o = Blather::XMPPNode.new('options', self.document))
+        o << (x = Blather::XMPPNode.new('x', self.document))
+        x.namespace = 'jabber:x:data'
+        x[:type] = 'submit'
+
+        field = self.add_field('FORM_TYPE', 'http://jabber.org/protocol/pubsub#subscribe_options')
+        field[:type] = 'hidden'
+      end
+      x
+    end
+
+    def add_field(var, values)
+      self.options << (field = Blather::XMPPNode.new('field', self.document))
+      field[:var] = var
+      [values].flatten.each do |value|
+        field << (val = Blather::XMPPNode.new('value', self.document))
+        val.content = value
+      end
+      field
+    end
+  end
+end

data/lib/collecta/result.rb

@@ -0,0 +1,23 @@
+module Collecta
+  class Result < Blather::Stanza::PubSub::Event
+    def query
+      content_from('//ns:headers/ns:header[@name="x-collecta#query"]', :ns => 'http://jabber.org/protocol/shim').strip
+    end
+
+    def title
+      self.entry.content_from '//ns:title', :ns => 'http://www.w3.org/2005/Atom'
+    end
+
+    def category
+      self.entry.content_from '//ns:category', :ns => 'http://api.collecta.com/ns/search-0#results'
+    end
+
+    def abstract
+      self.entry.find('//ns:abstract', :ns => 'http://api.collecta.com/ns/search-0#results').first.inner_html.strip
+    end
+
+    def entry
+      Blather::XMPPNode.new('event').inherit self.items.first.find_first('//ns:entry', :ns => 'http://www.w3.org/2005/Atom')
+    end
+  end
+end

data/lib/collecta/subscribe.rb

@@ -0,0 +1,12 @@
+module Collecta
+  class Subscribe < Blather::Stanza::PubSub::Subscribe
+    include Collecta::Pubsub
+    def self.new(apikey, query = nil, notify = nil)
+      new_node = super :set, COLLECTA_JID, NODE
+      new_node.apikey = apikey
+      new_node.query = query
+      new_node.notify = notify if notify
+      new_node
+    end
+  end
+end

data/spec/collecta/archive_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Collecta::Archive do
+  it 'can be created with an apikey and a search term' do
+    archive = Collecta::Archive.new 'apikey-value', 'search-term'
+    archive.must_be_kind_of Blather::Stanza::PubSub::Items
+    archive.must_have_apikey 'apikey-value'
+    archive.must_have_query 'search-term'
+  end
+end

data/spec/collecta/result_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Collecta::Result do
+  before do
+    @result = Collecta::Result.new.inherit(Blather::XMPPNode.import(Nokogiri::XML.parse(<<-XML).root))
+    <message from='search.collecta.com'
+             to='tofu@collecta.com/search'>
+      <event xmlns='http://jabber.org/protocol/pubsub#event'>
+        <items node='search'>
+          <item id='1cb57d9c-1c46-11dd-838c-001143d5d5db'>
+            <entry xmlns="http://www.w3.org/2005/Atom">
+              <source>
+                <title>metajack</title>
+                <icon>http://identi.ca/avatar/4685-96-20090213165024.jpeg</icon>
+                <author>
+                  <name>metajack</name>
+                </author>
+                <link href="http://identi.ca/metajack"/>
+                <link href="http://identi.ca/metajack" type="application/atom+xml" rel="self"/>
+                <link href="http://creativecommons.org/licenses/by/3.0/" rel="license"/>
+              </source>
+              <link href="http://identi.ca/metajack"/>
+              <title>metajack</title>
+              <published>2009-04-25T04:03:38+00:00</published>
+              <id>http://identi.ca/notice/3694388</id>
+              <updated>1970-01-01T00:00:00+00:00</updated>
+              <category xmlns="http://api.collecta.com/ns/search-0#results">update</category>
+              <abstract xmlns="http://api.collecta.com/ns/search-0#results">
+                <p>metajack Great. My first day back in SF and there's an earthquake.</p>
+              </abstract>
+              <link rel='collecta-abstract-image' href='http://identi.ca/avatar/4685-96-20090213165024.jpeg'/>
+            </entry>
+          </item>
+        </items>
+      </event>
+      <headers xmlns='http://jabber.org/protocol/shim'>
+        <header name='x-collecta#query'>
+          earthquake
+        </header>
+      </headers>
+    </message>
+    XML
+  end
+
+  it 'has a query' do
+    @result.query.must_equal 'earthquake'
+  end
+
+  it 'has a title' do
+    @result.title.must_equal 'metajack'
+  end
+
+  it 'has a category' do
+    @result.category.must_equal 'update'
+  end
+
+  it 'has an abstract' do
+    @result.abstract.must_equal "<p>metajack Great. My first day back in SF and there's an earthquake.</p>"
+  end
+end

data/spec/collecta/subscribe_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Collecta::Subscribe do
+  it 'can be created with an apikey, a search term and a notify term' do
+    subscription = Collecta::Subscribe.new 'apikey-value', 'search-term', 'notify-term'
+    subscription.must_be_kind_of Blather::Stanza::PubSub::Subscribe
+    subscription.must_have_apikey 'apikey-value'
+    subscription.must_have_query 'search-term'
+    subscription.must_have_notify 'notify-term'
+  end
+end

data/spec/collecta_spec.rb

@@ -0,0 +1,3 @@
+require 'spec_helper'
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'minitest/spec'
+
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), '..'))
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), *%w[.. lib]))
+require 'collecta-rb'
+
+MiniTest::Unit.autorun
+
+module MiniTest
+  require 'pathname' if MINI_DIR =~ %r{^./}
+
+  module Assertions
+    def assert_has_apikey(key, node, msg = nil)
+      msg = message(msg) { "Expected #{mu_pp(node)} to have API key #{mu_pp(key)}" }
+      assert(node.apikey == key, msg)
+    end
+
+    def assert_has_query(query, node, msg = nil)
+      msg = message(msg) { "Expected #{mu_pp(node)} to have query #{mu_pp(query)}" }
+      assert(node.query.include?(query), msg)
+    end
+
+    def assert_has_notify(notify, node, msg = nil)
+      msg = message(msg) { "Expected #{mu_pp(node)} to have query #{mu_pp(notify)}" }
+      assert(node.notify.include?(notify), msg)
+    end
+  end
+end
+
+class Object
+  def must_have_apikey *args
+    return MiniTest::Spec.current.assert_has_apikey(args.first, self)
+  end
+
+  def must_have_query *args
+    return MiniTest::Spec.current.assert_has_query(args.first, self)
+  end
+
+  def must_have_notify *args
+    return MiniTest::Spec.current.assert_has_notify(args.first, self)
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: collecta-rb
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeff Smick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-02 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: blather
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A ruby library based on Blather for working with the Collecta XMPP api.
+email: sprsquish@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- examples/collecta.rb
+- lib/collecta-rb.rb
+- lib/collecta/archive.rb
+- lib/collecta/pubsub.rb
+- lib/collecta/result.rb
+- lib/collecta/subscribe.rb
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: http://github.com/sprsquish/collecta-rb
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A ruby library based on Blather for working with the Collecta XMPP api.
+test_files: 
+- spec/collecta/archive_spec.rb
+- spec/collecta/result_spec.rb
+- spec/collecta/subscribe_spec.rb
+- spec/collecta_spec.rb
+- spec/spec_helper.rb