ruby_fs 0.2.0 → 0.3.0

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # develop
 
+# 0.3.0
+  * Feature/Change: Switch command methods from yielding the result asynchronously to returning it synchronously. Allows for better actor usage (async/futures)
+
 # 0.2.0
   * Feature: Common command helper methods
   * Feature: Trace level logging & easy logging override

data/lib/ruby_fs/stream.rb

@@ -55,16 +55,17 @@ module RubyFS
     # @param [#to_s] command the command to run
     # @param [optional, Hash] options the command's options, where keys have _ substituted for -
     #
-    # @yield [response] Handle the command's response
-    # @yieldparam [RubyFS::Response] response the command's response object
-    def command(command, options = {}, &block)
-      @command_callbacks << (block || lambda { |reply| logger.debug "Reply to a command (#{command}) without a callback: #{reply.inspect}" })
+    # @return [RubyFS::Response] response the command's response object
+    def command(command, options = {}, &callback)
+      uuid = SecureRandom.uuid
+      @command_callbacks << (callback || lambda { |reply| signal uuid, reply })
       string = "#{command}\n"
       options.each_pair do |key, value|
         string << "#{key.to_s.gsub '_', '-'}: #{value}\n" if value
       end
       string << "\n"
       send_data string
+      wait uuid unless callback
     end
 
     #
@@ -72,10 +73,9 @@ module RubyFS
     #
     # @param [#to_s] action the API action to execute
     #
-    # @yield [response] Handle the command's response
-    # @yieldparam [RubyFS::Response] response the command's response object
-    def api(action, &block)
-      command "api #{action}", &block
+    # @return [RubyFS::Response] response the command's response object
+    def api(action)
+      command "api #{action}"
     end
 
     #
@@ -83,10 +83,9 @@ module RubyFS
     #
     # @param [#to_s] action the API action to execute
     #
-    # @yield [response] Handle the command's response
-    # @yieldparam [RubyFS::Response] response the command's response object
-    def bgapi(action, &block)
-      command "bgapi #{action}", &block
+    # @return [RubyFS::Response] response the command's response object
+    def bgapi(action)
+      command "bgapi #{action}"
     end
 
     #
@@ -95,10 +94,9 @@ module RubyFS
     # @param [#to_s] call the call ID to send the message to
     # @param [optional, Hash] options the message options
     #
-    # @yield [response] Handle the message's response
-    # @yieldparam [RubyFS::Response] response the message's response object
-    def sendmsg(call, options = {}, &block)
-      command "SendMsg #{call}", options, &block
+    # @return [RubyFS::Response] response the message's response object
+    def sendmsg(call, options = {})
+      command "SendMsg #{call}", options
     end
 
     #
@@ -108,10 +106,9 @@ module RubyFS
     # @param [#to_s] appname the app to execute
     # @param [optional, String] options the application options
     #
-    # @yield [response] Handle the application's response
-    # @yieldparam [RubyFS::Response] response the application's response object
-    def application(call, appname, options = nil, &block)
-      sendmsg call, :call_command => 'execute', :execute_app_name => appname, :execute_app_arg => options, &block
+    # @return [RubyFS::Response] response the application's response object
+    def application(call, appname, options = nil)
+      sendmsg call, :call_command => 'execute', :execute_app_name => appname, :execute_app_arg => options
     end
 
     #
@@ -162,7 +159,7 @@ module RubyFS
         @command_callbacks.pop.call CommandReply.new(headers)
       when 'auth/request'
         command "auth #{@secret}" do
-          command "event json ALL" if @events
+          command! "event json ALL" if @events
         end
       else
         raise "Unknown request type received (#{headers.inspect})"

data/lib/ruby_fs/version.rb

@@ -1,3 +1,3 @@
 module RubyFS
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/ruby_fs/stream_spec.rb

@@ -132,25 +132,11 @@ Content-Type: text/event-json
       ]
     end
 
-    it "can send commands with response callbacks" do
+    it "can send commands and returns the response" do
       expect_connected_event
       expect_disconnected_event
-      handler = mock
-      handler.expects(:call).once.with CommandReply.new(:content_type => 'command/reply', :reply_text => '+OK accepted')
-      mocked_server(1, lambda { |server| @stream.command('foo') { |reply| handler.call reply } }) do |val, server|
-        val.should == "foo\n\n"
-        server.send_data %Q(
-Content-Type: command/reply
-Reply-Text: +OK accepted
-
-)
-      end
-    end
-
-    it "can send commands without response callbacks" do
-      expect_connected_event
-      expect_disconnected_event
-      mocked_server(1, lambda { |server| @stream.command 'foo' }) do |val, server|
+      reply = CommandReply.new(:content_type => 'command/reply', :reply_text => '+OK accepted')
+      mocked_server(1, lambda { |server| @stream.command('foo').should == reply }) do |val, server|
         val.should == "foo\n\n"
         server.send_data %Q(
 Content-Type: command/reply
@@ -163,7 +149,7 @@ Reply-Text: +OK accepted
     it "can send commands with options" do
       expect_connected_event
       expect_disconnected_event
-      mocked_server(1, lambda { |server| @stream.command 'foo', :one => 1, :foo_bar => :doo_dah }) do |val, server|
+      mocked_server(1, lambda { |server| @stream.command! 'foo', :one => 1, :foo_bar => :doo_dah }) do |val, server|
         val.should == %Q(foo
 one: 1
 foo-bar: doo_dah
@@ -172,12 +158,11 @@ foo-bar: doo_dah
       end
     end
 
-    it "can send API commands with response callbacks" do
+    it "can send API commands and returns the response" do
       expect_connected_event
       expect_disconnected_event
-      handler = mock
-      handler.expects(:call).once.with CommandReply.new(:content_type => 'command/reply', :reply_text => '+OK accepted')
-      mocked_server(1, lambda { |server| @stream.api('foo') { |reply| handler.call reply } }) do |val, server|
+      reply = CommandReply.new(:content_type => 'command/reply', :reply_text => '+OK accepted')
+      mocked_server(1, lambda { |server| @stream.api('foo').should == reply }) do |val, server|
         val.should == "api foo\n\n"
         server.send_data %Q(
 Content-Type: command/reply
@@ -187,12 +172,11 @@ Reply-Text: +OK accepted
       end
     end
 
-    it "can send background API commands with response callbacks" do
+    it "can send background API commands and returns the response" do
       expect_connected_event
       expect_disconnected_event
-      handler = mock
-      handler.expects(:call).once.with CommandReply.new(:content_type => 'command/reply', :reply_text => '+OK Job-UUID: 4e8344be-c1fe-11e1-a7bf-cf9911a69d1e', :job_uuid => '4e8344be-c1fe-11e1-a7bf-cf9911a69d1e')
-      mocked_server(1, lambda { |server| @stream.bgapi('foo') { |reply| handler.call reply } }) do |val, server|
+      reply = CommandReply.new(:content_type => 'command/reply', :reply_text => '+OK Job-UUID: 4e8344be-c1fe-11e1-a7bf-cf9911a69d1e', :job_uuid => '4e8344be-c1fe-11e1-a7bf-cf9911a69d1e')
+      mocked_server(1, lambda { |server| @stream.bgapi('foo').should == reply }) do |val, server|
         val.should == "bgapi foo\n\n"
         server.send_data %Q(
 Content-Type: command/reply
@@ -203,12 +187,11 @@ Job-UUID: 4e8344be-c1fe-11e1-a7bf-cf9911a69d1e
       end
     end
 
-    it "can send messages to calls with options and response callbacks" do
+    it "can send messages to calls with options and returns the response" do
       expect_connected_event
       expect_disconnected_event
-      handler = mock
-      handler.expects(:call).once.with CommandReply.new(:content_type => 'command/reply', :reply_text => '+OK accepted')
-      mocked_server(1, lambda { |server| @stream.sendmsg('aUUID', :call_command => 'execute') { |reply| handler.call reply } }) do |val, server|
+      reply = CommandReply.new(:content_type => 'command/reply', :reply_text => '+OK accepted')
+      mocked_server(1, lambda { |server| @stream.sendmsg('aUUID', :call_command => 'execute').should == reply }) do |val, server|
         val.should == %Q(SendMsg aUUID
 call-command: execute
 
@@ -221,12 +204,11 @@ Reply-Text: +OK accepted
       end
     end
 
-    it "can execute applications on calls without options but with response callbacks" do
+    it "can execute applications on calls without options and returns the response" do
       expect_connected_event
       expect_disconnected_event
-      handler = mock
-      handler.expects(:call).once.with CommandReply.new(:content_type => 'command/reply', :reply_text => '+OK accepted')
-      mocked_server(1, lambda { |server| @stream.application('aUUID', 'answer') { |reply| handler.call reply } }) do |val, server|
+      reply = CommandReply.new(:content_type => 'command/reply', :reply_text => '+OK accepted')
+      mocked_server(1, lambda { |server| @stream.application('aUUID', 'answer').should == reply }) do |val, server|
         val.should == %Q(SendMsg aUUID
 call-command: execute
 execute-app-name: answer
@@ -240,12 +222,11 @@ Reply-Text: +OK accepted
       end
     end
 
-    it "can execute applications on calls with options and response callbacks" do
+    it "can execute applications on calls with options and returns the response" do
       expect_connected_event
       expect_disconnected_event
-      handler = mock
-      handler.expects(:call).once.with CommandReply.new(:content_type => 'command/reply', :reply_text => '+OK accepted')
-      mocked_server(1, lambda { |server| @stream.application('aUUID', 'playback', '/tmp/test.wav') { |reply| handler.call reply } }) do |val, server|
+      reply = CommandReply.new(:content_type => 'command/reply', :reply_text => '+OK accepted')
+      mocked_server(1, lambda { |server| @stream.application('aUUID', 'playback', '/tmp/test.wav').should == reply }) do |val, server|
         val.should == %Q(SendMsg aUUID
 call-command: execute
 execute-app-name: playback

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_fs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-02 00:00:00.000000000 Z
+date: 2012-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
@@ -295,7 +295,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3148609615352772925
+      hash: 1007735488205713228
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -304,7 +304,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3148609615352772925
+      hash: 1007735488205713228
 requirements: []
 rubyforge_project: ruby_fs
 rubygems_version: 1.8.24