farcall 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00f92b591c51a5eed01bd1bf156d902e4865ec4f
-  data.tar.gz: 741af581d714a7e6b435941a9f2e1b1946361ed2
+  metadata.gz: 0590f2273cea0df6aa322c05cc5b5b4b75be5da0
+  data.tar.gz: be36bff0dfe37581e19af74308361b9958cdc4a2
 SHA512:
-  metadata.gz: 8da68133b9dbf39cc77e11287b6bc491a0bdbecac048b8bfd94f02e88a521bd9e6360755a89060da73ef40d02efb61c85ff45d4cb4cfe495c232192780abd65e
-  data.tar.gz: 5af5f225af489f8c6aa75cc880d6855a45991f1baf500b4072af75cdd80286f1ce4625c781579b89f64a66244a20cdca257a080e410cf63d0d8c48b8c699ce58
+  metadata.gz: 4d400f0595d4b54caeff4f8c09eacc5282b5fdf23b5eb57b4c5f5a5620ad82d2e95d7520212b655a0f29a9fc4fd0e79161c2f236fe51f3b28536327c3277e634
+  data.tar.gz: 680ead9d24db0a9fc2b6b09c2c40c661030ad1917f91ddff132d6c85de92625ea269e02ec44616be135decdac714067e8e77050374a08720917bf53a52bb4a52

data/README.md

@@ -1,16 +1,11 @@
 # Farcall
 
-## Important!
-
-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. This gem
-supports out of the box JSON and (BOSS)[https://github.com/sergeych/boss_protocol] protocols. 
+transmitting dictionary-like objects, for example, JSON, 
+[BOSS](https://github.com/sergeych/boss_protocol), XML, BSON 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
@@ -18,7 +13,9 @@ both arrays of arguments and keyword arguments, return value could be any object
 dictionary, wahtever.
 
 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.
+protocol is very easy to implement if there is no implementation, see 
+[Farcall protocol specification](https://github.com/sergeych/farcall/wiki). Java library for
+Android and desktop is coming soon.
 
 ## Installation
 
@@ -94,8 +91,41 @@ More creation options ofr both provider and interface creation are:
 * `input:` and `output:` should be presented both or none - override `socket` - provide streams to
                          build the transport over.
                          
+## guessing JSON or BOSS
+
+Each one has its pros and contras. 
+
+JSON is widely accepted, and there is a JSON support in literally any platform. It is to some extent
+human readable (well, without line breaks - almost not ;). Still, it has no support for data 
+date/time types so you should convert them somehow, its support for UTF8 is a myth (almost everywhere 
+almost all UTF8 characters are escaped so the text gets many times bigger when transfering). The
+binary data has to be converted to some text form too, like base64. All this compensate its goods. 
+The same, except for UTF8, is right for XML.
+
+[BOSS](https://github.com/sergeych/boss_protocol) is not widely used, and known to me implementations
+exist only for Ruby, Java, Python and I've heard of ObjectiveC implementation. But it is very space-
+effective, can effectively transfer binary data, date/time objects and unlimited length integer out
+of the box. If caches string so when passing large object trees with same keys it provides very
+effective data. It is even more comact that Python's pickle, Ruby's marshalled objects and Java 
+serialized data. Ideal to fast command transfering when reaction time matters, or network speed is
+low.
+
+So, I would recommend:
+
+- of you transfer small data portions limited to JSON data types, use JSON
+
+- if you transfer UTF8 texts with national characters, use BOSS
+ 
+- if you transfer audio, video, images, large arrays and hashes - use BOSS
+ 
+- if you need BOSS but can't find it on your platform, use both and contact me :)
+
+## Documentation
+
+* [Farcall protocol](https://github.com/sergeych/farcall/wiki)
+
 
-Get more in (online docs)[http://www.rubydoc.info/gems/farcall]
+* Gem [online docs](http://www.rubydoc.info/gems/farcall)
 
 ## Contributing
 

data/farcall.gemspec

@@ -8,9 +8,12 @@ Gem::Specification.new do |spec|
   spec.version       = Farcall::VERSION
   spec.authors       = ["sergeych"]
   spec.email         = ["real.sergeych@gmail.com"]
-  spec.summary       = %q{Simple, elegant and cross-platofrm RCP and RMI protocol}
-  spec.description   = %q{Can work with any transpot capable of conveing dictionaries (json, xml, bson, boss, yaml.
-                         Incides some transports.}
+  spec.summary       = %q{Simple, elegant and cross-platofrm RPC protocol}
+  spec.description   = <<-End
+    Simple and effective cross-platform RPC protocol. Can work with any transport capable to
+    pass structures (dictionaries, hashes, whatever you name it). Out of the box provides
+    JSON and BOSS formats over streams and sockets.
+    End
   spec.homepage      = ""
   spec.license       = "MIT"
 

data/lib/farcall/boss_transport.rb

@@ -1,5 +1,8 @@
 module Farcall
 
+  # Boss transport is more spece-effective than json, supports more data types, and does not need
+  # delimiters to separate packets in the stream. Creation parameters are the same as of
+  # Farcall::Transport
   class BossTransport < Farcall::Transport
     include TransportBase
 

data/lib/farcall/transport.rb

@@ -45,8 +45,6 @@ module Farcall
       end
     end
 
-    attr :closed
-
     # Tansport must call this process on each incoming hash
     # passing it as the only parameter, e.g. self.on_data_received(hash)
     attr_accessor :on_data_received, :on_abort, :on_close
@@ -68,12 +66,18 @@ module Farcall
       @on_close and @on_close.call
     end
 
+    def closed?
+      @closed
+    end
+
     protected
 
+    # Call it when your connection is closed
     def connection_closed
       close
     end
 
+    # Call it when the connection is aborted due to an exception
     def connection_aborted exceptoin
       STDERR.puts "Farcall: connection aborted: #{$!.class.name}: #{$!}"
       @on_abort and @on_abort.call $!

data/lib/farcall/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: farcall
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - sergeych
@@ -66,9 +66,10 @@ dependencies:
     - - ">="
       - !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.
+description: |2
+      Simple and effective cross-platform RPC protocol. Can work with any transport capable to
+      pass structures (dictionaries, hashes, whatever you name it). Out of the box provides
+      JSON and BOSS formats over streams and sockets.
 email:
 - real.sergeych@gmail.com
 executables: []
@@ -115,7 +116,7 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Simple, elegant and cross-platofrm RCP and RMI protocol
+summary: Simple, elegant and cross-platofrm RPC protocol
 test_files:
 - spec/endpoint_spec.rb
 - spec/rmi_spec.rb