blather 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 26cf5c0a6d1dba72a71b5c0b48696354f78c421b
-  data.tar.gz: f1bd35632f6b5b809dcf6fa062da13f750eae39b
+SHA256:
+  metadata.gz: aeaa80653766a8a8a6fd2054b2e3265306f9e7182ca5bfbbb9df66f9d7ce6f0f
+  data.tar.gz: 8998041476db54c0fb00efec13ddbee3403fcf35d9099318c352db104a5d8837
 SHA512:
-  metadata.gz: 92884baac11b0f449f6b87b2a52f55534bca13f1638783c5c4c2f50c160af35b30712d47a89395455aeb6fbe6585c87ee0b0ad5b81b84782415605f28c80662d
-  data.tar.gz: eeb47327e6496182a286311a0873c1347679fa09f1ed827c5e71b35843aa6c117a299dc64e93fc1bb340b14c3100f64ad3e9a2c871b03752fb7c66c414371ae4
+  metadata.gz: 69b1624e91b0f2cd1d43c9d5de90eaec038b04191a370113d02547ee6c68ba1b00b981371756184550cf72a9242479c9b7d2ebb8c94c856ea23d654cc5b2f5b3
+  data.tar.gz: b21b1651df0b249d6f8fbc970e86e186b5fce044e90060ebed46fed1d93c9c3e11550c8cc2961b074ca37a0a0a8157820bd18b8e9df37a5b4164221d8d1ac268

data/.travis.yml

@@ -1,16 +1,16 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - jruby
-  - rbx-2.1.1
+  - 2.3.7
+  - 2.4.4
+  - jruby-9.1.17.0
+  - rbx-3.105
   - ruby-head
+jdk:
+  - openjdk8 # for jruby
 matrix:
   allow_failures:
-    - rvm: jruby
     - rvm: ruby-head
-    - rvm: rbx-2.1.1
+    - rvm: rbx-3.105
 before_install:
   - gem install bundler
 notifications:

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # [develop](https://github.com/adhearsion/blather/compare/master...develop)
 
+# [v2.0.0](https://github.com/adhearsion/blather/compare/v1.2.0...v2.0.0) - [2018-06-18](https://rubygems.org/gems/blather/versions/2.0.0)
+  * Bugfix: Require EventMachine >= 1.2.6 to avoid segfault issue
+  * Bugfix: Fix unsafe threaded use of @tmp_handlers in Blather::Client
+  * Feature: Bump RSpec to 3.x and convert specs with Transpec
+  * Feature: Bump Mocha version to 1.x
+  * Feature: Switch from girl_friday to sucker_punch
+  * Feature: Unlock Nokogiri to allow >=1.8.3 now that issues are fixed upstream
+
 # [v1.2.0](https://github.com/adhearsion/blather/compare/v1.1.4...v1.2.0) - [2016-01-07](https://rubygems.org/gems/blather/versions/1.2.0)
   * Bugfix: Properly sort resources with the same priority but different status
   * Bugfix: Lock to Nokogiri <= 1.6.1 because new versions are more broken than old ones

data/blather.gemspec

@@ -34,18 +34,18 @@ Gem::Specification.new do |s|
   s.rdoc_options = %w{--charset=UTF-8}
   s.extra_rdoc_files = %w{LICENSE README.md}
 
-  s.add_dependency "eventmachine", [">= 1.0.0"]
-  s.add_dependency "nokogiri", ["~> 1.5", ">= 1.5.6", "<= 1.6.1"]
+  s.add_dependency "eventmachine", ["~> 1.2", ">= 1.2.6"]
+  s.add_dependency "nokogiri", ["~> 1.8", ">= 1.8.3"]
   s.add_dependency "niceogiri", ["~> 1.0"]
   s.add_dependency "activesupport", [">= 2.3.11"]
-  s.add_dependency "girl_friday"
+  s.add_dependency "sucker_punch", ["~> 2.0"]
 
   s.add_development_dependency "bundler", ["~> 1.0"]
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", ["~> 2.7"]
-  s.add_development_dependency "mocha", ["~> 0.9"]
+  s.add_development_dependency "rspec", ["~> 3.0"]
+  s.add_development_dependency "mocha", ["~> 1.0"]
   s.add_development_dependency "guard-rspec"
-  s.add_development_dependency "yard", ["~> 0.6"]
+  s.add_development_dependency "yard", ["~> 0.9.11"]
   s.add_development_dependency "bluecloth" unless jruby? || rbx?
   s.add_development_dependency "countdownlatch"
   s.add_development_dependency 'rb-fsevent', ['~> 0.9']

data/lib/blather.rb

@@ -8,7 +8,7 @@
   digest/sha1
   logger
   openssl
-  girl_friday
+  sucker_punch
 
   active_support/core_ext/class/attribute
   active_support/core_ext/object/blank

data/lib/blather/client/client.rb

@@ -32,6 +32,21 @@ module Blather
   #     end
   #
   class Client
+    class Job
+      include SuckerPunch::Job
+      class_attribute :client
+
+      def perform(stanza)
+        client.handle_data stanza
+      end
+
+      def self.shutdown
+        SuckerPunch::Queue.all.each do |queue|
+          queue.shutdown if queue.name == to_s
+        end
+      end
+    end
+
     attr_reader :jid,
                 :roster,
                 :caps,
@@ -62,6 +77,7 @@ module Blather
       @status = Stanza::Presence::Status.new
       @handlers = {}
       @tmp_handlers = {}
+      @tmp_handlers_mutex = Mutex.new
       @filters = {:before => [], :after => []}
       @roster = Roster.new self
       @caps = Stanza::Capabilities.new
@@ -124,7 +140,9 @@ module Blather
     # @param [#to_s] id the ID of the stanza that should be handled
     # @yield [Blather::Stanza] stanza the incomming stanza
     def register_tmp_handler(id, &handler)
-      @tmp_handlers[id.to_s] = handler
+      @tmp_handlers_mutex.synchronize do
+        @tmp_handlers[id.to_s] = handler
+      end
     end
 
     # Clear handlers with given guards
@@ -194,7 +212,7 @@ module Blather
     # @private
     def receive_data(stanza)
       if handler_queue
-        handler_queue << stanza
+        handler_queue.perform_async stanza
       else
         handle_data stanza
       end
@@ -229,9 +247,11 @@ module Blather
     # @private
     def handler_queue
       return if queue_size == 0
-      @handler_queue ||= GirlFriday::WorkQueue.new :handle_stanza, :size => queue_size do |stanza|
-        handle_data stanza
-      end
+      return @handler_queue if @handler_queue
+      @handler_queue = Class.new(Job)
+      @handler_queue.client = self
+      @handler_queue.workers queue_size
+      return @handler_queue
     end
 
     protected
@@ -293,7 +313,11 @@ module Blather
     end
 
     def handle_stanza(stanza)
-      if handler = @tmp_handlers.delete(stanza.id)
+      handler = @tmp_handlers_mutex.synchronize do
+        @tmp_handlers.delete(stanza.id)
+      end
+
+      if handler
         handler.call stanza
       else
         stanza.handler_hierarchy.each do |type|

data/lib/blather/version.rb

@@ -1,3 +1,3 @@
 module Blather
-  VERSION = '1.2.0'
+  VERSION = '2.0.0'
 end

data/spec/blather/client/client_spec.rb

@@ -11,42 +11,42 @@ describe Blather::Client do
 
   it 'provides a Blather::JID reader' do
     subject.post_init stream, jid
-    subject.should respond_to :jid
-    subject.jid.should == jid
+    expect(subject).to respond_to :jid
+    expect(subject.jid).to eq(jid)
   end
 
   it 'provides a reader for the roster' do
-    subject.should respond_to :roster
-    subject.roster.should be_kind_of Blather::Roster
+    expect(subject).to respond_to :roster
+    expect(subject.roster).to be_kind_of Blather::Roster
   end
 
   it 'provides a status reader' do
     subject.post_init stream, jid
-    subject.should respond_to :status
+    expect(subject).to respond_to :status
     subject.status = :away
-    subject.status.should == :away
+    expect(subject.status).to eq(:away)
   end
 
   it 'should have a caps handler' do
-    subject.should respond_to :caps
-    subject.caps.should be_kind_of Blather::Stanza::Capabilities
+    expect(subject).to respond_to :caps
+    expect(subject.caps).to be_kind_of Blather::Stanza::Capabilities
   end
 
   describe '#setup' do
     it 'can be setup' do
-      subject.should respond_to :setup
-      subject.setup('me@me.com', 'pass').should == subject
+      expect(subject).to respond_to :setup
+      expect(subject.setup('me@me.com', 'pass')).to eq(subject)
     end
 
     it 'knows if it has been setup' do
-      subject.should respond_to :setup?
-      subject.should_not be_setup
+      expect(subject).to respond_to :setup?
+      expect(subject).not_to be_setup
       subject.setup 'me@me.com', 'pass'
-      subject.should be_setup
+      expect(subject).to be_setup
     end
 
     it 'cannot be run before being setup' do
-      lambda { subject.run }.should raise_error RuntimeError
+      expect { subject.run }.to raise_error RuntimeError
     end
 
     it 'starts up a Component connection when setup without a node' do
@@ -71,7 +71,7 @@ describe Blather::Client do
       subject { Blather::Client.setup(jid, password, nil, nil, nil, nil, :workqueue_count => queue_size) }
 
       it 'sets the queue size on the client' do
-        subject.queue_size.should == queue_size
+        expect(subject.queue_size).to eq(queue_size)
       end
 
       describe 'receiving data' do
@@ -81,7 +81,7 @@ describe Blather::Client do
           let(:queue_size) { 0 }
 
           it "has no handler queue" do
-            subject.handler_queue.should be_nil
+            expect(subject.handler_queue).to be_nil
           end
 
           it 'handles the data immediately' do
@@ -94,7 +94,7 @@ describe Blather::Client do
           let(:queue_size) { 4 }
 
           it 'enqueues the data on the handler queue' do
-            subject.handler_queue.expects(:<<).with(stanza)
+            subject.handler_queue.expects(:perform_async).with(stanza)
             subject.receive_data stanza
           end
         end
@@ -103,21 +103,21 @@ describe Blather::Client do
   end
 
   it 'knows if it is disconnected' do
-    subject.should respond_to :connected?
-    subject.should_not be_connected
+    expect(subject).to respond_to :connected?
+    expect(subject).not_to be_connected
   end
 
   it 'knows if it is connected' do
     stream.expects(:stopped?).returns false
     subject.setup 'me.com', 'secret'
     subject.post_init stream, Blather::JID.new('me.com')
-    subject.should be_connected
+    expect(subject).to be_connected
   end
 
   describe 'if it has been setup but not connected yet' do
     it 'should consider itself disconnected' do
       subject.setup 'me.com', 'secret'
-      subject.should_not be_connected
+      expect(subject).not_to be_connected
     end
   end
 
@@ -158,18 +158,23 @@ describe Blather::Client do
         stream.stubs(:close_connection_after_writing)
         subject.handler_queue.expects(:shutdown)
         subject.close
+        expect(instance_variable_get(:@handler_queue)).to be_nil
       end
 
       it 'forces the work queue to be re-created when referenced' do
         stream.stubs(:close_connection_after_writing)
         subject.close
 
-        fake_queue = stub('GirlFriday::WorkQueue')
-        GirlFriday::WorkQueue.expects(:new)
-        .with(:handle_stanza, :size => subject.queue_size)
+        fake_queue = stub('Blather::Client::Job subclass')
+        Class.expects(:new)
+          .with(Blather::Client::Job)
           .returns(fake_queue)
+        fake_queue.expects(:client=)
+          .with(subject)
+        fake_queue.expects(:workers)
+          .with(subject.queue_size)
 
-        subject.handler_queue.should == fake_queue
+        expect(subject.handler_queue).to eq(fake_queue)
       end
     end
   end
@@ -235,7 +240,7 @@ describe Blather::Client do
     response.expects(:call)
     subject.expects(:write).with do |s|
       subject.receive_data stanza
-      s.should == stanza
+      expect(s).to eq(stanza)
     end
     subject.write_with_handler(stanza) { |_| response.call }
   end
@@ -317,24 +322,24 @@ describe Blather::Client do
 
     it 'updates the state when not sending to a Blather::JID' do
       stream.stubs(:write)
-      subject.status.should_not equal :away
+      expect(subject.status).not_to equal :away
       subject.status = :away, 'message'
-      subject.status.should == :away
+      expect(subject.status).to eq(:away)
     end
 
     it 'does not update the state when sending to a Blather::JID' do
       stream.stubs(:write)
-      subject.status.should_not equal :away
+      expect(subject.status).not_to equal :away
       subject.status = :away, 'message', 'me@me.com'
-      subject.status.should_not equal :away
+      expect(subject.status).not_to equal :away
     end
 
     it 'writes the new status to the stream' do
       Blather::Stanza::Presence::Status.stubs(:next_id).returns 0
       status = [:away, 'message']
       stream.expects(:send).with do |s|
-        s.should be_kind_of Blather::Stanza::Presence::Status
-        s.to_s.should == Blather::Stanza::Presence::Status.new(*status).to_s
+        expect(s).to be_kind_of Blather::Stanza::Presence::Status
+        expect(s.to_s).to eq(Blather::Stanza::Presence::Status.new(*status).to_s)
       end
       subject.status = status
     end
@@ -343,7 +348,7 @@ describe Blather::Client do
   describe 'default handlers' do
     it 're-raises errors' do
       err = Blather::BlatherError.new
-      lambda { subject.receive_data err }.should raise_error Blather::BlatherError
+      expect { subject.receive_data err }.to raise_error Blather::BlatherError
     end
 
     # it 'responds to iq:get with a "service-unavailable" error' do
@@ -370,7 +375,7 @@ describe Blather::Client do
     it 'responds to s2c pings with a pong' do
       ping = Blather::Stanza::Iq::Ping.new :get
       pong = ping.reply
-      subject.expects(:write).with { |n| n.to_s.should == pong.to_s }
+      subject.expects(:write).with { |n| expect(n.to_s).to eq(pong.to_s) }
       subject.receive_data ping
     end
 
@@ -444,7 +449,7 @@ describe Blather::Client do
     end
 
     it 'sends a request for the roster when post_init is called' do
-      stream.expects(:send).with { |stanza| stanza.should be_kind_of Blather::Stanza::Iq::Roster }
+      stream.expects(:send).with { |stanza| expect(stanza).to be_kind_of Blather::Stanza::Iq::Roster }
       subject.post_init stream, Blather::JID.new('n@d/r')
     end
 
@@ -486,7 +491,7 @@ describe Blather::Client do
 
   describe 'filters' do
     it 'raises an error when an invalid filter type is registered' do
-      lambda { subject.register_filter(:invalid) {} }.should raise_error RuntimeError
+      expect { subject.register_filter(:invalid) {} }.to raise_error RuntimeError
     end
 
     it 'can be guarded' do
@@ -510,11 +515,11 @@ describe Blather::Client do
     it 'runs them in order' do
       stanza = Blather::Stanza::Iq.new
       count = 0
-      subject.register_filter(:before) { |_| count.should == 0; count = 1 }
-      subject.register_filter(:before) { |_| count.should == 1; count = 2 }
-      subject.register_handler(:iq) { |_| count.should == 2; count = 3 }
-      subject.register_filter(:after) { |_| count.should == 3; count = 4 }
-      subject.register_filter(:after) { |_| count.should == 4 }
+      subject.register_filter(:before) { |_| expect(count).to eq(0); count = 1 }
+      subject.register_filter(:before) { |_| expect(count).to eq(1); count = 2 }
+      subject.register_handler(:iq) { |_| expect(count).to eq(2); count = 3 }
+      subject.register_filter(:after) { |_| expect(count).to eq(3); count = 4 }
+      subject.register_filter(:after) { |_| expect(count).to eq(4) }
       subject.receive_data stanza
     end
 
@@ -659,9 +664,9 @@ describe Blather::Client do
 
     it 'can be an xpath and will send the result to the handler' do
       response.expects(:call).with do |stanza, xpath|
-        xpath.should be_instance_of Nokogiri::XML::NodeSet
-        xpath.should_not be_empty
-        stanza.should == stanza
+        expect(xpath).to be_instance_of Nokogiri::XML::NodeSet
+        expect(xpath).not_to be_empty
+        expect(stanza).to eq(stanza)
       end
       subject.register_handler(:iq, "/iq[@id='#{stanza.id}']") { |stanza, xpath| response.call stanza, xpath }
       subject.receive_data stanza
@@ -670,16 +675,16 @@ describe Blather::Client do
     it 'can be an xpath with namespaces and will send the result to the handler' do
       stanza = Blather::Stanza.parse('<message><foo xmlns="http://bar.com"></message>')
       response.expects(:call).with do |stanza, xpath|
-        xpath.should be_instance_of Nokogiri::XML::NodeSet
-        xpath.should_not be_empty
-        stanza.should == stanza
+        expect(xpath).to be_instance_of Nokogiri::XML::NodeSet
+        expect(xpath).not_to be_empty
+        expect(stanza).to eq(stanza)
       end
       subject.register_handler(:message, "/message/bar:foo", :bar => 'http://bar.com') { |stanza, xpath| response.call stanza, xpath }
       subject.receive_data stanza
     end
 
     it 'raises an error when a bad guard is tried' do
-      lambda { subject.register_handler(:iq, 0) {} }.should raise_error RuntimeError
+      expect { subject.register_handler(:iq, 0) {} }.to raise_error RuntimeError
     end
   end
 
@@ -687,51 +692,51 @@ describe Blather::Client do
     let(:caps) { subject.caps }
 
     it 'must be of type result' do
-      caps.should respond_to :type
-      caps.type.should == :result
+      expect(caps).to respond_to :type
+      expect(caps.type).to eq(:result)
     end
 
     it 'can have a client node set' do
-      caps.should respond_to :node=
+      expect(caps).to respond_to :node=
       caps.node = "somenode"
     end
 
     it 'provides a client node reader' do
-      caps.should respond_to :node
+      expect(caps).to respond_to :node
       caps.node = "somenode"
-      caps.node.should == "somenode##{caps.ver}"
+      expect(caps.node).to eq("somenode##{caps.ver}")
     end
 
     it 'can have identities set' do
-      caps.should respond_to :identities=
+      expect(caps).to respond_to :identities=
       caps.identities = [{:name => "name", :type => "type", :category => "cat"}]
     end
 
     it 'provides an identities reader' do
-      caps.should respond_to :identities
+      expect(caps).to respond_to :identities
       caps.identities = [{:name => "name", :type => "type", :category => "cat"}]
-      caps.identities.should == [Blather::Stanza::Iq::DiscoInfo::Identity.new({:name => "name", :type => "type", :category => "cat"})]
+      expect(caps.identities).to eq([Blather::Stanza::Iq::DiscoInfo::Identity.new({:name => "name", :type => "type", :category => "cat"})])
     end
 
     it 'can have features set' do
-      caps.should respond_to :features=
-      caps.features.size.should == 0
+      expect(caps).to respond_to :features=
+      expect(caps.features.size).to eq(0)
       caps.features = ["feature1"]
-      caps.features.size.should == 1
+      expect(caps.features.size).to eq(1)
       caps.features += [Blather::Stanza::Iq::DiscoInfo::Feature.new("feature2")]
-      caps.features.size.should == 2
+      expect(caps.features.size).to eq(2)
       caps.features = nil
-      caps.features.size.should == 0
+      expect(caps.features.size).to eq(0)
     end
 
     it 'provides a features reader' do
-      caps.should respond_to :features
+      expect(caps).to respond_to :features
       caps.features = %w{feature1 feature2}
-      caps.features.should == [Blather::Stanza::Iq::DiscoInfo::Feature.new("feature1"), Blather::Stanza::Iq::DiscoInfo::Feature.new("feature2")]
+      expect(caps.features).to eq([Blather::Stanza::Iq::DiscoInfo::Feature.new("feature1"), Blather::Stanza::Iq::DiscoInfo::Feature.new("feature2")])
     end
 
     it 'provides a client ver reader' do
-      caps.should respond_to :ver
+      expect(caps).to respond_to :ver
       caps.node = 'http://code.google.com/p/exodus'
       caps.identities = [Blather::Stanza::Iq::DiscoInfo::Identity.new({:name => 'Exodus 0.9.1', :type => 'pc', :category => 'client'})]
       caps.features = %w{
@@ -740,12 +745,12 @@ describe Blather::Client do
                             http://jabber.org/protocol/disco#items
                             http://jabber.org/protocol/muc
                           }
-      caps.ver.should == 'QgayPKawpkPSDYmwT/WM94uAlu0='
-      caps.node.should == "http://code.google.com/p/exodus#QgayPKawpkPSDYmwT/WM94uAlu0="
+      expect(caps.ver).to eq('QgayPKawpkPSDYmwT/WM94uAlu0=')
+      expect(caps.node).to eq("http://code.google.com/p/exodus#QgayPKawpkPSDYmwT/WM94uAlu0=")
     end
 
     it 'can construct caps presence correctly' do
-      caps.should respond_to :c
+      expect(caps).to respond_to :c
       caps.node = 'http://code.google.com/p/exodus'
       caps.identities = [Blather::Stanza::Iq::DiscoInfo::Identity.new({:name => 'Exodus 0.9.1', :type => 'pc', :category => 'client'})]
       caps.features = %w{
@@ -754,7 +759,7 @@ describe Blather::Client do
                             http://jabber.org/protocol/disco#items
                             http://jabber.org/protocol/muc
                           }
-      Nokogiri::XML(caps.c.to_xml).to_s.should == Nokogiri::XML("<presence><c xmlns=\"http://jabber.org/protocol/caps\" hash=\"sha-1\" node=\"http://code.google.com/p/exodus\" ver=\"QgayPKawpkPSDYmwT/WM94uAlu0=\"/></presence>").to_s
+      expect(Nokogiri::XML(caps.c.to_xml).to_s).to eq(Nokogiri::XML("<presence><c xmlns=\"http://jabber.org/protocol/caps\" hash=\"sha-1\" node=\"http://code.google.com/p/exodus\" ver=\"QgayPKawpkPSDYmwT/WM94uAlu0=\"/></presence>").to_s)
     end
   end
 end