xmpp4r-robot 0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1546d0ef0a762f29b06026368758036e5675b5a8
-  data.tar.gz: 9de0ef3dba793af53cfefbc37260ed778354781e
+  metadata.gz: 62c1f2e10c7d3b9bbff8750f1c122e67e6e20665
+  data.tar.gz: eca785d782872d6076e81d2d872e9a8a5f0059bd
 SHA512:
-  metadata.gz: 31c4b5c1728638a547f2a1b4cd7da0867e062a21c36ebe03c580510e9923374ba4a5cbaa02b72386360ae94de791da82fe233a5446fcb206095ae181ed93fc78
-  data.tar.gz: d78ffd1965952d2cddf91ec99516be7579a3428caa22dfe7bd9a6d52ba22f900ddaba5906740919ba5968fdc915ba78183cb5ae8bf1fd4bf9d0b560a31a41503
+  metadata.gz: e11bfd191df92527c20cd4a1765e53336955af0c9878d121bfe9393e611c6fd56a455b915093f69e915b15cf95c062449249fb5e6c68780f74b6104e4bdb9e28
+  data.tar.gz: 3af9add9f15286f162cb96c5c250e4ff624d2f40f9ab9b106f7ac03a89f79dcdcf007ccb93473688c32b5d590378eb35081a353434c0ae1c28484cb5029bddd9

data/.gitignore

@@ -0,0 +1 @@
+/pkg/

data/CHANGES.md

@@ -0,0 +1,12 @@
+# CHANGES
+
+## xmpp4r-robot 0.2.0 -- 2014-01-23
+
+* Jabber::Robot#start would now act as restart.
+* Jabber::Robot#roster added which would return a list of roster,
+  with the state of :available, :away, :unavailable, and :unknown.
+* Now we never consume any events.
+
+## xmpp4r-robot 0.1 -- 2014-01-22
+
+* Birthday!

data/README.md

@@ -35,9 +35,9 @@ robot = Jabber::Robot.new('someone@gmail.com', 'awesome password',
                           :retry_time => 10,
                           :auto_accept_subscription => true)
 
-robot.notify_presence do |from, reason|
-  # reason could be one of :available, :away, :unavailable
-  puts "#{from} is #{reason}"
+robot.notify_presence do |from, status|
+  # status could be one of :available, :away, :unavailable
+  puts "#{from} is #{status}"
 end
 
 robot.notify_message do |from, body|
@@ -47,10 +47,10 @@ robot.notify_message do |from, body|
   robot.subscribe(from) if body == 'subscribe' # demonstrate how we subscribe
 end
 
-robot.start
+p robot.start.roster
 
 rd, wr = IO.pipe
-Signal.trap('INT'){ wr.puts
+Signal.trap('INT'){ wr.puts }
 rd.gets
 
 robot.stop

data/Rakefile

@@ -8,6 +8,6 @@ end
 
 Gemgem.init(dir) do |s|
   s.name    = 'xmpp4r-robot'
-  s.version = '0.1'
-  %w[xmpp4r].each{ |g| s.add_runtime_dependency(g) }
+  s.version = '0.2.0'
+  s.add_runtime_dependency('xmpp4r', '~> 0.5')
 end

data/lib/xmpp4r/robot.rb

@@ -1,4 +1,6 @@
 
+require 'set'
+
 require 'xmpp4r'
 require 'xmpp4r/roster'
 
@@ -10,36 +12,58 @@ class Jabber::Robot
     @username = username
     @password = password
     @errback  = errback
+    @roster   = {:available   => Set.new,
+                 :away        => Set.new,
+                 :unavailable => Set.new}
 
     @retry_time               = Float(opts[:retry_time] || 0)
     @auto_accept_subscription = opts[:auto_accept_subscription]
   end
 
-  # So that you could reset the client by calling:
-  #     robot.client = nil
-  #     robot.client
-  # This would remove all previously set callbacks.
+  def inspect
+    "#<#{self.class.name} username=#{username.inspect}>"
+  end
+
   def client
     @client ||= Jabber::Client.new(Jabber::JID::new(username))
   end
 
+  def helper
+    @helper ||= Jabber::Roster::Helper.new(client, false)
+  end
+
   def start
+    if @client # restart
+      stop
+      @client = nil
+    end
+    initialize_callbacks
     connect
     login
-    initialize_callbacks
     available
+    self
   end
 
   def stop
     client.close
+    self
   end
 
   def connect
     client.connect
+    self
   end
 
   def login
     client.auth(password)
+    self
+  end
+
+  ##### getters #####
+
+  def roster sync=false
+    sync_roster if sync || @roster[:unknown].nil?
+    @roster
   end
 
   ##### actions #####
@@ -49,33 +73,34 @@ class Jabber::Robot
   end
 
   # e.g. robot.message('someone@example.com', 'Hi!')
-  def message to, body
-    client.send(Jabber::Message::new(to, body).set_type(:chat))
+  def message to_jid, body
+    client.send(Jabber::Message::new(to_jid, body).set_type(:chat))
   end
 
   # e.g. robot.subscribe('someone@example.com')
-  def subscribe to
-    roster.accept_subscription(to)
+  def subscribe to_jid
+    client.send(Jabber::Presence.new.set_type(:subscribe).set_to(to_jid))
   end
 
   ##### callbacks #####
 
-  # e.g. robot.notify_presence{ |from, reason| puts "#{from} is #{reason}" }
+  # e.g. robot.notify_presence{ |from, status| puts "#{from} is #{status}" }
+  # The status could be one of :available, :away, :unavailable
   def notify_presence
     client.add_presence_callback do |presence|
-      # :available, :away, :unavailable
-      show = presence.type ||
-               case presence.show # http://xmpp.org/rfcs/rfc3921.html
-               when nil, :chat
-                 :available
-               when :away, :dnd, :xa
-                 :away
-               else
-                 raise "What's this show? #{presence.show}"
-               end
+      status = presence.type ||
+                 case presence.show # http://xmpp.org/rfcs/rfc3921.html
+                 when nil, :chat
+                   :available
+                 when :away, :dnd, :xa
+                   :away
+                 else
+                   raise "What's this show? #{presence.show}"
+                 end
 
       protect_yield do
-        yield(jid_to_username(presence.from), show)
+        yield(jid_to_username(presence.from), status)
+        false
       end
     end
   end
@@ -84,8 +109,10 @@ class Jabber::Robot
   def notify_message
     client.add_message_callback do |message|
       protect_yield do
-        yield(jid_to_username(message.from), message.body.strip) if
-          message.body
+        if message.body
+          yield(jid_to_username(message.from), message.body.strip)
+        end
+        false
       end
     end
   end
@@ -93,10 +120,6 @@ class Jabber::Robot
   ##### private #####
 
   private
-  def roster
-    @roster ||= Jabber::Roster::Helper.new(client)
-  end
-
   def initialize_callbacks
     client.on_exception do |exp|
       errback.call(exp) if errback
@@ -109,8 +132,23 @@ class Jabber::Robot
       start
     end
 
-    roster.add_subscription_request_callback do |_, presence|
-      subscribe(presence.from) if auto_accept_subscription
+    client.add_presence_callback do |presence|
+      if auto_accept_subscription && presence.type == :subscribe
+        subscribe(presence.from)
+      end
+      false
+    end
+
+    notify_presence do |jid, status|
+      @roster[:unknown].delete(jid) if @roster[:unknown]
+
+      [:available, :away, :unavailable].each do |type|
+        if type == status
+          @roster[type].add(jid)
+        else
+          @roster[type].delete(jid)
+        end
+      end
     end
   end
 
@@ -123,4 +161,19 @@ class Jabber::Robot
   rescue => e
     errback.call(e) if errback
   end
+
+  def sync_roster
+    clear_roster_semaphore
+    helper.get_roster
+    helper.wait_for_roster
+    @roster[:unknown] =
+      Set.new(helper.items.keys.map(&method(:jid_to_username))) -
+      @roster[:available] - @roster[:away] - @roster[:unavailable]
+  end
+
+  # a hack to let us always get the latest roster
+  def clear_roster_semaphore
+    helper.instance_variable_get(:@roster_wait).
+           instance_variable_set(:@tickets, 0)
+  end
 end

data/xmpp4r-robot.gemspec

@@ -1,19 +1,21 @@
 # -*- encoding: utf-8 -*-
-# stub: xmpp4r-robot 0.1 ruby lib
+# stub: xmpp4r-robot 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "xmpp4r-robot"
-  s.version = "0.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2014-01-22"
+  s.date = "2014-01-23"
   s.description = "Simple XMPP client built upon xmpp4r. Intended for building simple robots."
   s.email = ["godfat (XD) godfat.org"]
   s.files = [
+  ".gitignore",
   ".gitmodules",
   ".travis.yml",
+  "CHANGES.md",
   "Gemfile",
   "LICENSE",
   "README.md",
@@ -32,11 +34,11 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<xmpp4r>, [">= 0"])
+      s.add_runtime_dependency(%q<xmpp4r>, ["~> 0.5"])
     else
-      s.add_dependency(%q<xmpp4r>, [">= 0"])
+      s.add_dependency(%q<xmpp4r>, ["~> 0.5"])
     end
   else
-    s.add_dependency(%q<xmpp4r>, [">= 0"])
+    s.add_dependency(%q<xmpp4r>, ["~> 0.5"])
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: xmpp4r-robot
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.2.0
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2014-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xmpp4r
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 description: Simple XMPP client built upon xmpp4r. Intended for building simple robots.
 email:
 - godfat (XD) godfat.org
@@ -31,8 +31,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - ".gitmodules"
 - ".travis.yml"
+- CHANGES.md
 - Gemfile
 - LICENSE
 - README.md