ruby_fs 0.1.0

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+.rvmrc
+.yardoc
+doc
+coverage
+spec/reports
+features/reports
+vendor
+*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--colour
+--tty

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+notifications:
+  irc: "irc.freenode.org#adhearsion"

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# develop
+
+# 0.1.0
+  * Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2, :cli => '--format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Ben Langfeld
+
+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,32 @@
+# RubyFS [![Build Status](https://secure.travis-ci.org/adhearsion/ruby_fs.png?branch=master)](http://travis-ci.org/adhearsion/ruby_fs)
+RubyFS is a FreeSWITCH EventSocket client library in Ruby and based on Celluloid actors with the sole purpose of providing a connection to the EventSocket API. RubyFS does not provide any features beyond connection management and protocol parsing. Actions are sent over the wire, and responses come back via callbacks. It's up to you to match these up into something useful. In this regard, RubyFS is very similar to [Blather](https://github.com/sprsquish/blather) for XMPP or [Punchblock](https://github.com/adhearsion/punchblock), the Ruby 3PCC library. In fact, Punchblock uses RubyFS under the covers for its FreeSWITCH implementation.
+
+## Installation
+    gem install ruby_fs
+
+## Usage
+```ruby
+require 'ruby_fs'
+
+client = RubyFS::Stream.new '127.0.0.1', 8021, 'ClueCon', lambda { |e| p e }
+
+client.start
+```
+
+## Links
+* [Source](https://github.com/adhearsion/ruby_fs)
+* [Documentation](http://rdoc.info/github/adhearsion/ruby_fs/master/frames)
+* [Bug Tracker](https://github.com/adhearsion/ruby_fs/issues)
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  * If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2012 Ben Langfeld. MIT licence (see LICENSE for details).

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'ci/reporter/rake/rspec'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = '--color'
+end
+
+task :default => [:spec]
+task :ci => ['ci:setup:rspec', :spec]
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/lib/ruby_fs/command_reply.rb

@@ -0,0 +1,6 @@
+require 'ruby_fs/response'
+
+module RubyFS
+  class CommandReply < Response
+  end
+end

data/lib/ruby_fs/event.rb

@@ -0,0 +1,9 @@
+require 'ruby_fs/response'
+
+module RubyFS
+  class Event < Response
+    def event_name
+      content[:event_name]
+    end
+  end
+end

data/lib/ruby_fs/lexer.rb

@@ -0,0 +1,148 @@
+module RubyFS
+  class Lexer
+    ContentLengthPattern  = /Content-length:\s*(\d+)/i
+    MaxLineLength         = 16 * 1024
+    MaxBinaryLength       = 32 * 1024 * 1024
+
+    def initialize(callback)
+      @callback = callback
+
+      @data_mode  = :lines
+      @delimiter  = "\n"
+      @linebuffer = []
+
+      init_for_request
+    end
+
+    def receive_data(data)
+      return unless data && data.length > 0
+
+      case @data_mode
+      when :lines
+        receive_line_data data
+      when :text
+        receive_text_data data
+      end
+    end
+    alias :<< :receive_data
+
+    private
+
+    def receive_line_data(data)
+      if ix = data.index(@delimiter)
+        @linebuffer << data[0...ix]
+        ln = @linebuffer.join
+        @linebuffer.clear
+        ln.chomp! if @delimiter == "\n"
+        receive_line ln
+        receive_data data[(ix + @delimiter.length)..-1]
+      else
+        @linebuffer << data
+      end
+    end
+
+    def receive_text_data(data)
+      if @textsize
+        needed = @textsize - @textpos
+        will_take = data.length > needed ? needed : data.length
+
+        @textbuffer << data[0...will_take]
+        tail = data[will_take..-1]
+
+        @textpos += will_take
+        if @textpos >= @textsize
+          set_line_mode
+          receive_binary_data @textbuffer.join
+        end
+
+        receive_data tail
+      else
+        receive_binary_data data
+      end
+    end
+
+    def receive_line(line)
+      case @hc_mode
+      when :discard_blanks
+        unless line == ""
+          @hc_mode = :headers
+          receive_line line
+        end
+      when :headers
+        if line == ""
+          raise "unrecognized state" unless @headers.length > 0
+          # @hc_content_length will be nil, not 0, if there was no content-length header.
+          if @content_length.to_i > 0
+            set_binary_mode @content_length
+          else
+            dispatch_request
+          end
+        else
+          @headers << line
+          if ContentLengthPattern =~ line
+            # There are some attacks that rely on sending multiple content-length
+            # headers. This is a crude protection, but needs to become tunable.
+            raise "extraneous content-length header" if @content_length
+            @content_length = $1.to_i
+          end
+        end
+      else
+        raise "internal error, unsupported mode"
+      end
+    end
+
+    def receive_binary_data(text)
+      @content = text
+      dispatch_request
+    end
+
+    def dispatch_request
+      @callback.call headers_2_hash(@headers), @content if @callback.respond_to?(:call)
+      init_for_request
+    end
+
+    def init_for_request
+      @hc_mode = :discard_blanks
+      @headers = []
+      @content_length = nil
+      @content = ""
+    end
+
+    # Called internally but also exposed to user code, for the case in which
+    # processing of binary data creates a need to transition back to line mode.
+    # We support an optional parameter to "throw back" some data, which might
+    # be an unprocessed chunk of the transmitted binary data, or something else
+    # entirely.
+    def set_line_mode(data = "")
+      @data_mode = :lines
+      (@linebuffer ||= []).clear
+      receive_data data.to_s
+    end
+
+    def set_text_mode(size = nil)
+      if size == 0
+        set_line_mode
+      else
+        @data_mode = :text
+        (@textbuffer ||= []).clear
+        @textsize = size # which can be nil, signifying no limit
+        @textpos = 0
+      end
+    end
+
+    def set_binary_mode(size = nil)
+      set_text_mode size
+    end
+
+    def headers_2_hash(headers)
+      {}.tap do |hash|
+        headers.each do |h|
+          if /\A([^\s:]+)\s*:\s*/ =~ h
+            tail = $'.dup
+            hash[$1.downcase.gsub(/-/, "_").intern] = tail
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby_fs/response.rb

@@ -0,0 +1,19 @@
+module RubyFS
+  class Response
+    attr_reader :headers, :content
+
+    extend Forwardable
+    def_delegator :content, :[]
+    def_delegator :content, :has_key?
+
+    def initialize(headers = nil, content = nil)
+      @headers, @content = headers || {}, content || {}
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && [:headers, :content].all? do |att|
+        other.send(att) == self.send(att)
+      end
+    end
+  end
+end

data/lib/ruby_fs/stream.rb

@@ -0,0 +1,105 @@
+require 'json'
+
+require 'ruby_fs/lexer'
+
+module RubyFS
+  class Stream
+    class ConnectionStatus
+      def eql?(other)
+        other.is_a? self.class
+      end
+
+      alias :== :eql?
+    end
+
+    Connected     = Class.new ConnectionStatus
+    Disconnected  = Class.new ConnectionStatus
+
+    include Celluloid::IO
+
+    def initialize(host, port, secret, event_callback, events = true)
+      super()
+      @secret, @event_callback, @events = secret, event_callback, events
+      @command_callbacks = []
+      logger.debug "Starting up..."
+      @lexer = Lexer.new method(:receive_request)
+      @socket = TCPSocket.from_ruby_socket ::TCPSocket.new(host, port)
+      post_init
+    end
+
+    [:started, :stopped, :ready].each do |state|
+      define_method("#{state}?") { @state == state }
+    end
+
+    def run
+      loop { receive_data @socket.readpartial(4096) }
+    rescue EOFError
+      logger.info "Client socket closed!"
+      current_actor.terminate!
+    end
+
+    def post_init
+      @state = :started
+      fire_event Connected.new
+    end
+
+    def send_data(data)
+      logger.debug "[SEND] #{data.to_s}"
+      @socket.write data.to_s
+    end
+
+    def command(command, options = {}, &block)
+      @command_callbacks << (block || lambda { |reply| logger.debug "Reply to a command (#{command}) without a callback: #{reply.inspect}" })
+      string = "#{command}\n"
+      options.each_pair do |key, value|
+        string << "#{key.to_s.gsub '_', '-'}: #{value}\n"
+      end
+      string << "\n"
+      send_data string
+    end
+
+    def receive_data(data)
+      logger.debug "[RECV] #{data}"
+      @lexer << data
+    end
+
+    def finalize
+      logger.debug "Finalizing stream"
+      @socket.close if @socket
+      @state = :stopped
+      fire_event Disconnected.new
+    end
+
+    def fire_event(event)
+      @event_callback.call event
+    end
+
+    def logger
+      Logger
+    end
+
+    def receive_request(headers, content)
+      case headers[:content_type]
+      when 'text/event-json'
+        fire_event Event.new(headers, json_content_2_hash(content))
+      when 'command/reply'
+        @command_callbacks.pop.call CommandReply.new(headers)
+      when 'auth/request'
+        command "auth #{@secret}" do
+          command "event json ALL" if @events
+        end
+      else
+        raise "Unknown request type received (#{headers.inspect})"
+      end
+    end
+
+    def json_content_2_hash(content)
+      json = JSON.parse content
+      {}.tap do |hash|
+        json.each_pair do |k, v|
+          hash[k.downcase.gsub(/-/,"_").intern] = v
+        end
+      end
+    end
+  end
+end

data/lib/ruby_fs/version.rb

@@ -0,0 +1,3 @@
+module RubyFS
+  VERSION = "0.1.0"
+end

data/lib/ruby_fs.rb

@@ -0,0 +1,22 @@
+%w{
+  uuidtools
+  future-resource
+  logger
+  countdownlatch
+  celluloid/io
+}.each { |f| require f }
+
+class Logger
+  alias :trace :debug
+end
+
+module RubyFS
+end
+
+%w{
+  command_reply
+  event
+  response
+  stream
+  version
+}.each { |f| require "ruby_fs/#{f}" }

data/ruby_ami.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby_fs/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ruby_fs"
+  s.version     = RubyFS::VERSION
+  s.authors     = ["Ben Langfeld"]
+  s.email       = ["ben@langfeld.me"]
+  s.homepage    = ""
+  s.summary     = %q{Wrapping FreeSWITCH EventSocket for rubyists}
+  s.description = %q{A Ruby client library for the FreeSWITCH EventSocket API built on Celluloid.}
+
+  s.rubyforge_project = "ruby_fs"
+
+  s.files         = `git ls-files`.split("\n") << 'lib/ruby_fs/lexer.rb'
+  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.add_runtime_dependency %q<uuidtools>, [">= 0"]
+  s.add_runtime_dependency %q<celluloid-io>, ["~> 0.11.0"]
+  s.add_runtime_dependency %q<future-resource>, [">= 0"]
+  s.add_runtime_dependency %q<countdownlatch>, ["~> 1.0"]
+  s.add_runtime_dependency %q<json>
+
+  s.add_development_dependency %q<bundler>, ["~> 1.0"]
+  s.add_development_dependency %q<rspec>, [">= 2.5.0"]
+  s.add_development_dependency %q<ci_reporter>, [">= 1.6.3"]
+  s.add_development_dependency %q<yard>, ["~> 0.6.0"]
+  s.add_development_dependency %q<rake>, [">= 0"]
+  s.add_development_dependency %q<mocha>, [">= 0"]
+  s.add_development_dependency %q<simplecov>, [">= 0"]
+  s.add_development_dependency %q<simplecov-rcov>, [">= 0"]
+  s.add_development_dependency %q<guard-rspec>
+  s.add_development_dependency %q<ruby_gntp>
+end

data/spec/ruby_fs/command_reply_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+module RubyFS
+  describe CommandReply do
+    it { should be_a Response }
+  end
+end

data/spec/ruby_fs/event_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+module RubyFS
+  describe Event do
+    subject { described_class.new nil, :event_name => 'FOO' }
+
+    it { should be_a Response }
+
+    its(:event_name) { should == 'FOO' }
+  end
+end

data/spec/ruby_fs/response_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+module RubyFS
+  describe Response do
+
+    its(:headers) { should == {} }
+    its(:content) { should == {} }
+
+    context "when created with headers" do
+      let(:headers) { {:foo => 'bar'} }
+
+      subject { Event.new headers }
+
+      its(:headers) { should == headers }
+      its(:content) { should == {} }
+    end
+
+    context "when created with content" do
+      let(:content) { {:foo => 'bar'} }
+
+      subject { Event.new nil, content }
+
+      its(:headers) { should == {} }
+      its(:content) { should == content }
+
+      it "makes content values available via #[]" do
+        subject.should_not have_key(:bar)
+        subject[:bar].should == nil
+
+        subject.should have_key(:foo)
+        subject[:foo].should == 'bar'
+      end
+    end
+
+    context "when created with headers and content" do
+      let(:headers) { {:foo => 'bar'} }
+      let(:content) { {:doo => 'dah'} }
+
+      subject { Event.new headers, content }
+
+      its(:headers) { should == headers }
+      its(:content) { should == content }
+    end
+
+    describe "equality" do
+      context "with another kind of object" do
+        it "should not be equal" do
+          Event.new.should_not == :foo
+        end
+      end
+
+      context "with the same headers and the same content" do
+        let :event1 do
+          Event.new({:foo => 'bar'}, :doo => 'bah')
+        end
+
+        let :event2 do
+          Event.new({:foo => 'bar'}, :doo => 'bah')
+        end
+
+        it "should be equal" do
+          event1.should == event2
+        end
+      end
+
+      context "with the same headers and different content" do
+        let :event1 do
+          Event.new({:foo => 'bar'}, :doo => 'bah')
+        end
+
+        let :event2 do
+          Event.new({:foo => 'bar'}, :doo => 'dah')
+        end
+
+        it "should not be equal" do
+          event1.should_not == event2
+        end
+      end
+
+      context "with the different headers and the same content" do
+        let :event1 do
+          Event.new({:foo => 'bar'}, :doo => 'bah')
+        end
+
+        let :event2 do
+          Event.new({:foo => 'baz'}, :doo => 'bah')
+        end
+
+        it "should not be equal" do
+          event1.should_not == event2
+        end
+      end
+
+      context "with different headers and different content" do
+        let :event1 do
+          Event.new({:foo => 'bar'}, :foo => 'baz')
+        end
+
+        let :event2 do
+          Event.new({:foo => 'baz'}, :foo => 'bar')
+        end
+
+        it "should not be equal" do
+          event1.should_not == event2
+        end
+      end
+    end
+  end
+end

data/spec/ruby_fs/stream_spec.rb

@@ -0,0 +1,239 @@
+require 'spec_helper'
+
+module RubyFS
+  describe Stream do
+    let(:server_port) { 50000 - rand(1000) }
+
+    before do
+      def client.message_received(message)
+        @messages ||= Queue.new
+        @messages << message
+      end
+
+      def client.messages
+        @messages
+      end
+    end
+
+    let :client_messages do
+      messages = []
+      messages << client.messages.pop until client.messages.empty?
+      messages
+    end
+
+    let(:secret)  { 'ClueCon' }
+    let(:events)  { false }
+
+    def mocked_server(times = nil, fake_client = nil, &block)
+      mock_target = MockServer.new
+      mock_target.expects(:receive_data).send(*(times ? [:times, times] : [:at_least, 1])).with &block
+      s = ServerMock.new '127.0.0.1', server_port, mock_target
+      @stream = Stream.new '127.0.0.1', server_port, secret, lambda { |m| client.message_received m }, events
+      @stream.run!
+      fake_client.call s if fake_client.respond_to? :call
+      s.join
+      @stream.join
+    end
+
+    def expect_connected_event
+      client.expects(:message_received).with Stream::Connected.new
+    end
+
+    def expect_disconnected_event
+      client.expects(:message_received).with Stream::Disconnected.new
+    end
+
+    before { @sequence = 1 }
+
+    describe "after connection" do
+      it "should be started" do
+        expect_connected_event
+        expect_disconnected_event
+        mocked_server(0) do |val, server|
+          @stream.started?.should be_true
+        end
+      end
+
+      it "can send data" do
+        expect_connected_event
+        expect_disconnected_event
+        mocked_server(1, lambda { |server| @stream.send_data "foo" }) do |val, server|
+          val.should == "foo"
+        end
+      end
+    end
+
+    it 'sends events to the client when the stream is ready' do
+      mocked_server(1, lambda { |server| @stream.send_data 'Foo' }) do |val, server|
+        server.send_data %Q(
+Content-Length: 776
+Content-Type: text/event-json
+
+{
+ "Event-Name": "HEARTBEAT",
+ "Core-UUID": "2ad09a34-c056-11e1-b095-fffeda3ce54f",
+ "FreeSWITCH-Hostname": "blmbp.home",
+ "FreeSWITCH-Switchname": "blmbp.home",
+ "FreeSWITCH-IPv4": "192.168.1.74",
+ "FreeSWITCH-IPv6": "::1",
+ "Event-Date-Local": "2012-06-27 19:43:32",
+ "Event-Date-GMT": "Wed, 27 Jun 2012 18:43:32 GMT",
+ "Event-Date-Timestamp": "1340822612392823",
+ "Event-Calling-File": "switch_core.c",
+ "Event-Calling-Function": "send_heartbeat",
+ "Event-Calling-Line-Number": "68",
+ "Event-Sequence": "3526",
+ "Event-Info": "System Ready",
+ "Up-Time": "0 years, 0 days, 5 hours, 56 minutes, 40 seconds, 807 milliseconds, 21 microseconds",
+ "Session-Count": "0",
+ "Max-Sessions": "1000",
+ "Session-Per-Sec": "30",
+ "Session-Since-Startup": "4",
+ "Idle-CPU": "100.000000"
+}Content-Length: 629
+Content-Type: text/event-json
+
+{
+ "Event-Name": "RE_SCHEDULE",
+ "Core-UUID": "2ad09a34-c056-11e1-b095-fffeda3ce54f",
+ "FreeSWITCH-Hostname": "blmbp.home",
+ "FreeSWITCH-Switchname": "blmbp.home",
+ "FreeSWITCH-IPv4": "192.168.1.74",
+ "FreeSWITCH-IPv6": "::1",
+ "Event-Date-Local": "2012-06-27 19:43:32",
+ "Event-Date-GMT": "Wed, 27 Jun 2012 18:43:32 GMT",
+ "Event-Date-Timestamp": "1340822612392823",
+ "Event-Calling-File": "switch_scheduler.c",
+ "Event-Calling-Function": "switch_scheduler_execute",
+ "Event-Calling-Line-Number": "65",
+ "Event-Sequence": "3527",
+ "Task-ID": "2",
+ "Task-Desc": "heartbeat",
+ "Task-Group": "core",
+ "Task-Runtime": "1340822632"
+})
+      end
+
+      client_messages.should be == [
+        Stream::Connected.new,
+        Event.new({:content_length => '776', :content_type => 'text/event-json'}, {:event_name => "HEARTBEAT", :core_uuid => "2ad09a34-c056-11e1-b095-fffeda3ce54f", :freeswitch_hostname => "blmbp.home", :freeswitch_switchname => "blmbp.home", :freeswitch_ipv4 => "192.168.1.74", :freeswitch_ipv6 => "::1", :event_date_local => "2012-06-27 19:43:32", :event_date_gmt => "Wed, 27 Jun 2012 18:43:32 GMT", :event_date_timestamp => "1340822612392823", :event_calling_file => "switch_core.c", :event_calling_function => "send_heartbeat", :event_calling_line_number => "68", :event_sequence => "3526", :event_info => "System Ready", :up_time => "0 years, 0 days, 5 hours, 56 minutes, 40 seconds, 807 milliseconds, 21 microseconds", :session_count => "0", :max_sessions => "1000", :session_per_sec => "30", :session_since_startup => "4", :idle_cpu => "100.000000"}),
+        Event.new({:content_length => '629', :content_type => 'text/event-json'}, {:event_name => "RE_SCHEDULE", :core_uuid => "2ad09a34-c056-11e1-b095-fffeda3ce54f", :freeswitch_hostname => "blmbp.home", :freeswitch_switchname => "blmbp.home", :freeswitch_ipv4 => "192.168.1.74", :freeswitch_ipv6 => "::1", :event_date_local => "2012-06-27 19:43:32", :event_date_gmt => "Wed, 27 Jun 2012 18:43:32 GMT", :event_date_timestamp => "1340822612392823", :event_calling_file => "switch_scheduler.c", :event_calling_function => "switch_scheduler_execute", :event_calling_line_number => "65", :event_sequence => "3527", :task_id => "2", :task_desc => "heartbeat", :task_group => "core", :task_runtime => "1340822632"}),
+        Stream::Disconnected.new
+      ]
+    end
+
+    it "can send commands with response callbacks" 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|
+        val.should == "foo\n\n"
+        server.send_data %Q(
+Content-Type: command/reply
+Reply-Text: +OK accepted
+
+)
+      end
+    end
+
+    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|
+        val.should == %Q(foo
+one: 1
+foo-bar: doo_dah
+
+)
+      end
+    end
+
+    it 'authenticates when requested' do
+      mocked_server(1, lambda { |server| server.send_data "Content-Type: auth/request\n\n" }) do |val, server|
+        val.should == "auth ClueCon\n\n"
+        server.send_data %Q(
+Content-Type: command/reply
+Reply-Text: +OK accepted
+
+)
+      end
+
+      client_messages.should be == [
+        Stream::Connected.new,
+        Stream::Disconnected.new
+      ]
+    end
+
+    context 'with events turned on' do
+      let(:events) { true }
+
+      it 'sets the event mask after authenticating' do
+        mocked_server(2, lambda { |server| server.send_data "Content-Type: auth/request\n\n" }) do |val, server|
+          case @sequence
+          when 1
+            val.should == "auth ClueCon\n\n"
+            server.send_data %Q(
+Content-Type: command/reply
+Reply-Text: +OK accepted
+
+)
+          when 2
+            val.should == "event json ALL\n\n"
+            server.send_data %Q(
+Content-Type: command/reply
+Reply-Text: +OK accepted
+
+)
+          end
+          @sequence += 1
+        end
+
+        client_messages.should be == [
+          Stream::Connected.new,
+          Stream::Disconnected.new
+        ]
+      end
+    end
+
+    context 'with events turned off' do
+      it 'does not the event mask after authenticating' do
+        mocked_server(1, lambda { |server| server.send_data "Content-Type: auth/request\n\n" }) do |val, server|
+          val.should == "auth ClueCon\n\n"
+          server.send_data %Q(
+Content-Type: command/reply
+Reply-Text: +OK accepted
+
+)
+        end
+
+        client_messages.should be == [
+          Stream::Connected.new,
+          Stream::Disconnected.new
+        ]
+      end
+    end
+
+    it 'puts itself in the stopped state and fires a disconnected event when unbound' do
+      expect_connected_event
+      expect_disconnected_event
+      mocked_server(1, lambda { |server| @stream.send_data 'Foo' }) do |val, server|
+        @stream.stopped?.should be false
+      end
+      @stream.alive?.should be false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'simplecov'
+require 'simplecov-rcov'
+class SimpleCov::Formatter::MergedFormatter
+  def format(result)
+     SimpleCov::Formatter::HTMLFormatter.new.format(result)
+     SimpleCov::Formatter::RcovFormatter.new.format(result)
+  end
+end
+SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+SimpleCov.start do
+  add_filter "/vendor/"
+end
+
+require 'ruby_fs'
+require 'mocha'
+require 'countdownlatch'
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+include RubyFS
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+
+  config.before :each do
+    uuid = UUIDTools::UUID.random_create
+    UUIDTools::UUID.stubs :random_create => uuid
+  end
+end

data/spec/support/mock_server.rb

@@ -0,0 +1,43 @@
+MockServer = Class.new
+
+class ServerMock
+  include Celluloid::IO
+
+  def initialize(host, port, mock_target = MockServer.new)
+    @server = TCPServer.new host, port
+    @mock_target = mock_target
+    @clients = []
+    run!
+  end
+
+  def finalize
+    Logger.debug "ServerMock finalizing"
+    @server.close if @server
+    @clients.each(&:close)
+  end
+
+  def run
+    after(1) { terminate }
+    loop { handle_connection! @server.accept }
+  end
+
+  def handle_connection(socket)
+    @clients << socket
+    _, port, host = socket.peeraddr
+    Logger.debug "MockServer Received connection from #{host}:#{port}"
+    loop { receive_data socket.readpartial(4096) }
+  end
+
+  def receive_data(data)
+    Logger.debug "ServerMock receiving data: #{data}"
+    @mock_target.receive_data data, self
+  end
+
+  def send_data(data)
+    @clients.each { |client| client.write data }
+  end
+end
+
+def client
+  @client ||= mock('Client')
+end

metadata

@@ -0,0 +1,320 @@
+--- !ruby/object:Gem::Specification
+name: ruby_fs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ben Langfeld
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: celluloid-io
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: future-resource
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: countdownlatch
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby_gntp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby client library for the FreeSWITCH EventSocket API built on Celluloid.
+email:
+- ben@langfeld.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby_fs.rb
+- lib/ruby_fs/command_reply.rb
+- lib/ruby_fs/event.rb
+- lib/ruby_fs/lexer.rb
+- lib/ruby_fs/response.rb
+- lib/ruby_fs/stream.rb
+- lib/ruby_fs/version.rb
+- ruby_ami.gemspec
+- spec/ruby_fs/command_reply_spec.rb
+- spec/ruby_fs/event_spec.rb
+- spec/ruby_fs/response_spec.rb
+- spec/ruby_fs/stream_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock_server.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2481817772884138362
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2481817772884138362
+requirements: []
+rubyforge_project: ruby_fs
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Wrapping FreeSWITCH EventSocket for rubyists
+test_files:
+- spec/ruby_fs/command_reply_spec.rb
+- spec/ruby_fs/event_spec.rb
+- spec/ruby_fs/response_spec.rb
+- spec/ruby_fs/stream_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock_server.rb