farcall 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28f543ad602b3ae18360d4e445c79c60f9999e89
-  data.tar.gz: 5c560d5137bba206c11a216e3005bb5ec7f2713c
+  metadata.gz: 00f92b591c51a5eed01bd1bf156d902e4865ec4f
+  data.tar.gz: 741af581d714a7e6b435941a9f2e1b1946361ed2
 SHA512:
-  metadata.gz: 9696bda5293c960cb672aeb14a5d47a640d4db7673a59f1a4aa2a2bded5d9fd80cf4f1d302f83a9c404bef236b480ebb8bc52250519f86cf00d80319d17f8273
-  data.tar.gz: 07128d134976c41240dd64612b575f475ef5d6e2884657729cfa1a81f89f50ffaf8aba8debd87589140e449e9a682033bacc89496c80f8fc85aa433a6e8bc8e1
+  metadata.gz: 8da68133b9dbf39cc77e11287b6bc491a0bdbecac048b8bfd94f02e88a521bd9e6360755a89060da73ef40d02efb61c85ff45d4cb4cfe495c232192780abd65e
+  data.tar.gz: 5af5f225af489f8c6aa75cc880d6855a45991f1baf500b4072af75cdd80286f1ce4625c781579b89f64a66244a20cdca257a080e410cf63d0d8c48b8c699ce58

data/Gemfile

@@ -1,4 +1,7 @@
 source 'https://rubygems.org'
 
+# to debug wiyj local boss installation
+# gem "boss-protocol", :path => "~/dev/boss_protocol"
+
 # Specify your gem's dependencies in farcall.gemspec
 gemspec

data/README.md

@@ -2,46 +2,74 @@
 
 ## Important!
 
-The gem creation is under active development, current state is: beta. Only JSON format is supported.
+The gem creation is under active development, current state is: beta. The JSON and 
+(BOSS)[https://github.com/sergeych/boss_protocol] formats are supported out of the box,
+thogh XML and other could be easily implemented.
 
 ## Description
 
 The simple and elegant cross-platform RPC protocol that uses any formatter/transport capable of
-transmitting dictionary-like objects, for example, JSON, XML, BSON, BOSS and many others.
+transmitting dictionary-like objects, for example, JSON, XML, BSON, BOSS and many others. This gem
+supports out of the box JSON and (BOSS)[https://github.com/sergeych/boss_protocol] protocols. 
 
 RPC is made asynchronously, each call can have any return values. While one call is waiting,
 other calls can be executed. The protocol is bidirectional Call parameters could be
 both arrays of arguments and keyword arguments, return value could be any object, e.g. array, 
 dictionary, wahtever.
 
-Exception/errors transmitting is also supported.
+Exception/errors transmitting is also supported. The interface is very simple and rubyish. The 
+protocol is very easy to support, its description will be available in the github wiki soon.
 
-The interface is very simple and rubyish:
+## Installation
+
+Add this line to your application's Gemfile:
 
 ```ruby
-# The sample class that exports all its methods to the remote callers:
-#
-class TestProvider < Farcall::Provider
+    gem 'farcall'
+    # If you want to use binary-effective boss encoding:
+    # gem 'noss-protocol', '>= 1.4.1' 
+```
 
-  attr :foo_calls, :a, :b
+And then execute:
 
-  def foo a, b, optional: 'none'
-    @foo_calls = (@foo_calls || 0) + 1
-    @a, @b     = a, b
-    return "Foo: #{a+b}, #{optional}"
-  end
-end
+    $ bundle
+
+Or install it yourself as:
 
-# create instance and export it to some connected socket:
+    $ gem install farcall
 
-TestProvider.new socket: connected_socket # default format is JSON
+## Usage
+
+```ruby
+
+    # The sample class that exports all its methods to the remote callers:
+    #
+    class TestProvider < Farcall::Provider
+    
+      attr :foo_calls, :a, :b
+    
+      def foo a, b, optional: 'none'
+        @foo_calls = (@foo_calls || 0) + 1
+        @a, @b     = a, b
+        return "Foo: #{a+b}, #{optional}"
+      end
+    end
+    
+    # create instance and export it to some connected socket:
+    TestProvider.new socket: connected_socket # default format is JSON
+    
+    # or using boss, if you need to pass dates and binary data
+    TestProvider.new socket: connected_socket, format: :boss
 ```
 
 Suppose whe have some socket connected to one above, then TestProvider methods are available via
 this connection:
 
 ```ruby
+
     i = Farcall::Interface.new socket: client_socket
+    # or
+    # i = Farcall::Interface.new socket: client_socket, format: :boss
 
     # Plain arguments
     i.foo(10, 20).should == 'Foo: 30, none'
@@ -57,30 +85,23 @@ this connection:
     i.b.should == 6
 ```
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'farcall'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install farcall
+More creation options ofr both provider and interface creation are:
 
-## Usage
+* `endpoint:` at this point please refrain of using it as endpoint interface is going to change a 
+              bit
+* `transport:` subclass the `Farcall::Transport` and provide your own. It overrides `socket:`, 
+               `input:` and `ouput:` parameters.
+* `input:` and `output:` should be presented both or none - override `socket` - provide streams to
+                         build the transport over.
+                         
 
-Try to get autodocs. Sorry for now.
+Get more in (online docs)[http://www.rubydoc.info/gems/farcall]
 
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/farcall/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+3. Do not forget ot add specs and ensure all of them pass
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/farcall.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "boss-protocol", ">= 1.4.1"
 end

data/lib/farcall.rb

@@ -1,7 +1,13 @@
+
 require 'farcall/version'
 require 'farcall/transport'
 require 'farcall/json_transport'
 require 'farcall/endpoint'
+begin
+  require 'boss-protocol'
+  require 'farcall/boss_transport'
+rescue LoadError
+end
 
 module Farcall
   # Your code goes here...

data/lib/farcall/boss_transport.rb

@@ -0,0 +1,52 @@
+module Farcall
+
+  class BossTransport < Farcall::Transport
+    include TransportBase
+
+    # Create json transport, see Farcall::Transpor#create for parameters
+    def initialize **params
+      setup_streams **params
+    end
+
+    def on_data_received= block
+      super
+      if block && !@thread
+        @thread = Thread.start {
+          load_loop
+        }
+      end
+    end
+
+    def send_data hash
+      @output << Boss.dump(hash)
+    end
+
+    def close
+      if !@closing
+        @closing = true
+        close_connection
+        @thread and @thread.join
+        @thread = nil
+      end
+    end
+
+    private
+
+    def load_loop
+      Boss::Parser.new(@input).each { |object|
+        on_data_received and on_data_received.call object
+      }
+    rescue Errno::EPIPE
+      close
+    rescue
+      if !@closing
+        STDERR.puts "Farcall::BossTransport read loop failed: #{$!.class.name}: #$!"
+        STDERR.puts $!.backtrace.join("\n")
+        connection_aborted $!
+      else
+        close
+      end
+    end
+  end
+end
+

data/lib/farcall/json_transport.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'socket'
 
 module Farcall
 
@@ -10,17 +11,22 @@ module Farcall
     end
 
     def read length=1
-      data = ''
-      while data.length < length
-        data << @socket.recv(length - data.length, Socket::MSG_WAITALL)
-      end
-      data
+      # data = ''
+      # while data.length < length
+      #   data << @socket.recv(length - data.length, Socket::MSG_WAITALL)
+      # end
+      # data
+      @socket.read length
     end
 
     def write data
       @socket.write data
     end
 
+    def eof?
+      @socket.eof?
+    end
+
     def << data
       write data
     end
@@ -110,7 +116,6 @@ module Farcall
         close_connection
         @thread and @thread.join
         @thread = nil
-        @in_close = false
       end
     end
 
@@ -118,7 +123,7 @@ module Farcall
 
     def load_loop
       buffer = ''
-      while true
+      while !@input.eof?
         buffer << @input.read(1)
         if buffer[@dlength..-1] == @delimiter
           on_data_received and on_data_received.call(JSON.parse(buffer[0...@dlength]))
@@ -130,6 +135,7 @@ module Farcall
     rescue
       if !@closing
         STDERR.puts "Farcall::JsonTransport read loop failed: #{$!.class.name}: #$!"
+        STDERR.puts $!.backtrace.join("\n")
         connection_aborted $!
       else
         close

data/lib/farcall/transport.rb

@@ -1,4 +1,3 @@
-
 module Farcall
 
   # Generic error in Farcall library
@@ -35,6 +34,12 @@ module Farcall
       case format
         when :json
           Farcall::JsonTransport.new **params
+        when :boss
+          if defined?(Farcall::BossTransport)
+            Farcall::BossTransport.new **params
+          else
+            raise Farcall::Error.new("add gem 'boss-protocol' to use boss transport")
+          end
         else
           raise Farcall::Error, "unknown format: #{format}"
       end

data/lib/farcall/version.rb

@@ -1,3 +1,3 @@
 module Farcall
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/endpoint_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'stringio'
 
 # The sample class that exports all its methods to the remote callers:
 #
@@ -14,6 +13,7 @@ class TestProvider < Farcall::Provider
   end
 end
 
+
 describe 'endpoint' do
   include Farcall
 
@@ -41,12 +41,11 @@ describe 'endpoint' do
     ib.split.should == ['Hello', 'world']
   end
 
-  it 'should connect via shortcut' do
+  def check_protocol format
     s1, s2 = Socket.pair(:UNIX, :STREAM, 0)
 
-    tp = TestProvider.new socket: s1, format: :json
-    i = Farcall::Interface.new socket: s2, format: :json, provider: "Hello world"
-
+    tp = TestProvider.new socket: s1, format: format
+    i  = Farcall::Interface.new socket: s2, format: format, provider: "Hello world"
 
     expect(-> { i.foo() }).to raise_error Farcall::RemoteError
 
@@ -59,4 +58,12 @@ describe 'endpoint' do
     tp.far_interface.split.should == ['Hello', 'world']
   end
 
+  it 'should connect json via shortcut' do
+    check_protocol :json
+  end
+
+  it 'should connect boss via shortcut' do
+    check_protocol :boss
+  end
+
 end

data/spec/rmi_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'rmi' do
+
+  it 'should connect existing objects and'
+
+end

data/spec/transports_spec.rb

@@ -70,5 +70,29 @@ describe 'transports' do
     results.should == [{ 'echo' => { 'foo' => 'bar' } }, { 'echo' => { 'one' => 2 } }]
   end
 
+  it 'should run boss transport' do
+    s1, s2 = Socket.pair(:UNIX, :STREAM, 0)
+
+    j1 = Farcall::BossTransport.new socket: s1
+    j2 = Farcall::BossTransport.new socket: s2
+
+    j2.receive_data { |data|
+      j2.send_data({ echo: data })
+    }
+
+    results = []
+    j1.receive_data { |data|
+      results << data
+    }
+
+    j1.send_data({ foo: "bar" })
+    j1.send_data({ one: 2 })
+    sleep 0.01
+    j1.close
+    j2.close
+
+    results.should == [{ 'echo' => { 'foo' => 'bar' } }, { 'echo' => { 'one' => 2 } }]
+  end
+
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: farcall
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - sergeych
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-27 00:00:00.000000000 Z
+date: 2015-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: boss-protocol
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
 description: |-
   Can work with any transpot capable of conveing dictionaries (json, xml, bson, boss, yaml.
                            Incides some transports.
@@ -69,11 +83,13 @@ files:
 - Rakefile
 - farcall.gemspec
 - lib/farcall.rb
+- lib/farcall/boss_transport.rb
 - lib/farcall/endpoint.rb
 - lib/farcall/json_transport.rb
 - lib/farcall/transport.rb
 - lib/farcall/version.rb
 - spec/endpoint_spec.rb
+- spec/rmi_spec.rb
 - spec/spec_helper.rb
 - spec/transports_spec.rb
 homepage: ''
@@ -102,5 +118,6 @@ specification_version: 4
 summary: Simple, elegant and cross-platofrm RCP and RMI protocol
 test_files:
 - spec/endpoint_spec.rb
+- spec/rmi_spec.rb
 - spec/spec_helper.rb
 - spec/transports_spec.rb