iruby 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 993862535344a6f784ec1d905f239764b9c80d07
-  data.tar.gz: bc6916ae5072c89afa89d3bca5f6575458232aa4
+  metadata.gz: 3315e60fa2fabec2327df00d481249757ce9c199
+  data.tar.gz: 33f5306f10e6f51f64483e63b96cc3055f75e118
 SHA512:
-  metadata.gz: f7c6302c618a2a6cba11836c79e3e9a3aa7d4a6da7fde6c3f334e584c40dfa63454bfa32996c92e3db9035c87300a6c1e0326bde56732a4710062a6bd922fcd9
-  data.tar.gz: c953ad387205dfb3addc05154bc78ea806756a90408d7732b71fef731b8099c521a8b5878963eed57a4d0085b5ef6c1b6f24d08e65c39423202ebc2167fc2a81
+  metadata.gz: d314e35b4f4331892cb7bee54c6ca5aab5a3d86f058c8b34472672831da21d37e88093babeabb8d0daaadd1dc2ac5508310c3c3b5767c98b7ccee7d5d7335510
+  data.tar.gz: f3543ff4d8c01cddc5c9091ffd4d78d95c3a74b5baba7efd4dc0c122487048de55f84b117d077bdde4bc3e9a90ad4db484087df0ab246b1bddd359d4ffa10b42

data/README.md

@@ -7,7 +7,9 @@ This is a Ruby kernel for IPython/Jupyter and is part of [SciRuby](http://scirub
 ![Screenshot](https://cloud.githubusercontent.com/assets/50754/7956845/3fa46df8-09e3-11e5-8641-f5b8669061b5.png)
 
 ### Quick start
+The installation instructions are divided according to environments mainly because of ZeroMQ.
 
+#### Ubuntu/Debian
 At first install IPython/Jupyter. I recommend an installation using virtualenv.
 
     apt-get install python3-dev virtualenv libzmq3-dev
@@ -17,13 +19,83 @@ At first install IPython/Jupyter. I recommend an installation using virtualenv.
 
 After that, install the Ruby gem.
 
+    gem install rbczmq
     gem install iruby
 
 Now you can run iruby with:
 
-    iruby
     iruby notebook
 
+#### Windows
+At first install IPython/Jupyter. I recommend an installation using [Enthought Canopy](https://www.enthought.com/).
+
+After that install libzmq.dll (v3.2.x, x86) from [the website of ZeroMQ](http://zeromq.org/area:download).
+
+Rename `libzmq-v100-mt-3_x_x.dll` to `libzmq.dll`.
+
+Add the path to /bin to the PATH system variable.
+
+Run two commands below:
+
+    gem install ffi-rzmq
+    gem install iruby
+
+Now you can run iruby with:
+
+    iruby notebook
+
+#### Mac
+I recommend an installation using [Anaconda](https://store.continuum.io/cshop/anaconda/).
+I have not checked the installation to MacOS X, but four lines below were necessary in v0.1.x.
+
+    conda remove zeromq (If you installed anaconda)
+    brew install zeromq
+    gem install ffi-rzmq
+    gem install iruby
+
+Send us pull-request if you Mac users successed in installing IRuby in another way.
+
+#### FreeBSD
+
+At first install IPython/Jupyter. 
+There is a pyzmq ports (ports/net/py-pyzmq) which depends on libzmq4, however, it doesn't works with ipython.
+Therefore we use libzmq3 like the following:
+
+1. make your ports tree up-to-date.
+2. replace LIBDEPENDS line in ports/net/py-pyzmq/Makefile
+
+    ```shell
+    LIB_DEPENDS=    libzmq.so:${PORTSDIR}/net/libzmq4
+    ```
+    with
+    ```shell
+    LIB_DEPENDS=    libzmq.so:${PORTSDIR}/net/libzmq3
+    ```
+3. install related packages
+
+    ```shell
+    $ sudo pkg install libzmq3 py27-qt4-gui py27-pexpect-3.3 py27-qt4-svg py27-pygments py27-Jinja2 py27-tornado py27-jsonschema
+    ```
+4. make install using ports
+
+    ```shell
+    $ cd /usr/ports/net/py-pyzmq
+    $ sudo make install
+    $ cd /usr/ports/devel/ipython
+    $ sudo make install
+    ```
+Then, install iruby and related ports and gems.
+    ```shell
+    $ sudo pkg install rubygem-mimemagic
+    $ sudo gem install ffi-rzmq  # install ffi, ffi-rzmq-core and ffi-rzmq
+    $ git clone https://github.com/SciRuby/iruby.git
+    $ cd iruby
+    $ gem build iruby.gemspec
+    $ sudo gem install iruby-0.2.7.gem
+    ```
+
+### After the installation
+
 Take a look at the [example notebook](http://nbviewer.ipython.org/urls/raw.github.com/SciRuby/sciruby-notebooks/master/getting_started.ipynb)
 and the [collection of notebooks](https://github.com/SciRuby/sciruby-notebooks/) which includes a Dockerfile to create a containerized installation of iruby
 and other scientific gems. You can find the prebuild image at [dockerhub](https://registry.hub.docker.com/u/minad/sciruby-notebooks/).
@@ -32,9 +104,10 @@ and other scientific gems. You can find the prebuild image at [dockerhub](https:
 ### Required dependencies
 
 * IPython/Jupyter >= 3.0.0
-* libzmq >= 3.2
 * Ruby >= 2.1.0
 
+If you install IRuby with ffi-rzmq instead of rbczmq, libzmq >= 3.2 is added to the list above.
+
 ### Authors
 
 See the [CONTRIBUTORS](CONTRIBUTORS) file.

data/iruby.gemspec

@@ -28,7 +28,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'minitest', '~> 5.6'
 
   s.add_runtime_dependency 'bond', '~> 0.5'
-  s.add_runtime_dependency 'rbczmq', '~> 1.7'
   s.add_runtime_dependency 'multi_json', '~> 1.11'
   s.add_runtime_dependency 'mimemagic', '~> 0.3'
 end

data/lib/iruby.rb

@@ -1,4 +1,3 @@
-require 'rbczmq'
 require 'mimemagic'
 require 'multi_json'
 require 'securerandom'
@@ -8,9 +7,19 @@ require 'set'
 require 'iruby/version'
 require 'iruby/kernel'
 require 'iruby/backend'
-require 'iruby/session'
 require 'iruby/ostream'
 require 'iruby/formatter'
 require 'iruby/utils'
 require 'iruby/display'
 require 'iruby/comm'
+require 'iruby/session/mixin'
+
+begin
+  require 'iruby/session/rbczmq'
+rescue LoadError
+  begin
+    require 'iruby/session/ffi_rzmq'
+  rescue LoadError
+    STDERR.puts "You should install rbczmq or ffi_rzmq before running iruby notebook. See README."
+  end
+end

data/lib/iruby/command.rb

@@ -115,8 +115,15 @@ Add `gem 'iruby'` to your Gemfile to fix it.} unless Bundler.definition.dependen
 
     def register_kernel
       FileUtils.mkpath(@kernel_dir)
-      File.write(@kernel_file, MultiJson.dump(argv: [ @iruby_path, 'kernel', '{connection_file}' ],
+      unless RUBY_PLATFORM =~ /mswin(?!ce)|mingw|cygwin/
+        File.write(@kernel_file, MultiJson.dump(argv: [ @iruby_path, 'kernel', '{connection_file}' ],
                                               display_name: "Ruby #{RUBY_VERSION}", language: 'ruby'))
+      else
+        ruby_path, iruby_path = [RbConfig.ruby, @iruby_path].map{|path| path.gsub('/', '\\\\')}
+        File.write(@kernel_file, MultiJson.dump(argv: [ ruby_path, iruby_path, 'kernel', '{connection_file}' ],
+                                                display_name: "Ruby #{RUBY_VERSION}", language: 'ruby'))
+      end
+
       FileUtils.copy(Dir[File.join(__dir__, 'assets', '*')], @kernel_dir) rescue nil
     end
 

data/lib/iruby/kernel.rb

@@ -63,7 +63,7 @@ module IRuby
                       name: 'ruby',
                       version: RUBY_VERSION,
                       mimetype: 'application/x-ruby',
-                      file_extension: 'rb'
+                      file_extension: '.rb'
                     })
     end
 

data/lib/iruby/session/ffi_rzmq.rb

@@ -0,0 +1,74 @@
+require 'ffi-rzmq'
+
+module IRuby
+  class Session
+    include SessionSerialize
+
+    def initialize(config)
+      c = ZMQ::Context.new
+
+      connection = "#{config['transport']}://#{config['ip']}:%d"
+      reply_socket = c.socket(ZMQ::XREP)
+      reply_socket.bind(connection % config['shell_port'])
+
+      pub_socket = c.socket(ZMQ::PUB)
+      pub_socket.bind(connection % config['iopub_port'])
+
+      Thread.new do
+        begin
+          hb_socket = c.socket(ZMQ::REP)
+          hb_socket.bind(connection % config['hb_port'])
+          ZMQ::Device.new(hb_socket, hb_socket)
+        rescue Exception => e
+          IRuby.logger.fatal "Kernel heartbeat died: #{e.message}\n#{e.backtrace.join("\n")}"
+        end
+      end
+
+      @sockets = { publish: pub_socket, reply: reply_socket }
+      @session = SecureRandom.uuid
+      unless config['key'].to_s.empty? || config['signature_scheme'].to_s.empty?
+        raise 'Unknown signature scheme' unless config['signature_scheme'] =~ /\Ahmac-(.*)\Z/
+        @hmac = OpenSSL::HMAC.new(config['key'], OpenSSL::Digest.new($1))
+      end
+    end
+
+    # Build and send a message
+    def send(socket, type, content)
+      idents =
+        if socket == :reply && @last_recvd_msg
+          @last_recvd_msg[:idents]
+        else
+          type == :stream ? "stream.#{content[:name]}" : type
+        end
+      header = {
+        msg_type: type,
+        msg_id:   SecureRandom.uuid,
+        username: 'kernel',
+        session:  @session,
+        version:  '5.0'
+      }
+      socket = @sockets[socket]
+      list = serialize(idents, header, content)
+      list.each_with_index do |part, i|
+        socket.send_string(part, i == list.size - 1 ? 0 : ZMQ::SNDMORE)
+      end
+    end
+
+    # Receive a message and decode it
+    def recv(socket)
+      socket = @sockets[socket]
+      msg = []
+      while msg.empty? || socket.more_parts?
+        begin
+          frame = ''
+          rc = socket.recv_string(frame, 1)
+          ZMQ::Util.error_check('zmq_msg_send', rc)
+          msg << frame
+        rescue
+        end
+      end
+
+      @last_recvd_msg = unserialize(msg)
+    end
+  end
+end

data/lib/iruby/session/mixin.rb

@@ -0,0 +1,47 @@
+module IRuby
+  module SessionSerialize
+    DELIM = '<IDS|MSG>'
+
+    private
+
+    def serialize(idents, header, content)
+      msg = [MultiJson.dump(header),
+             MultiJson.dump(@last_recvd_msg ? @last_recvd_msg[:header] : {}),
+             '{}',
+             MultiJson.dump(content || {})]
+      frames = ([*idents].compact.map(&:to_s) << DELIM << sign(msg)) + msg
+      IRuby.logger.debug "Sent #{frames.inspect}"
+      frames
+    end
+
+    def unserialize(msg)
+      raise 'no message received' unless msg
+      frames = msg.to_a.map(&:to_s)
+      IRuby.logger.debug "Received #{frames.inspect}"
+
+      i = frames.index(DELIM)
+      idents, msg_list = frames[0..i-1], frames[i+1..-1]
+
+      minlen = 5
+      raise 'malformed message, must have at least #{minlen} elements' unless msg_list.length >= minlen
+      s, header, parent_header, metadata, content, buffers = *msg_list
+      raise 'Invalid signature' unless s == sign(msg_list[1..-1])
+      {
+        idents:        idents,
+        header:        MultiJson.load(header),
+        parent_header: MultiJson.load(parent_header),
+        metadata:      MultiJson.load(metadata),
+        content:       MultiJson.load(content),
+        buffers:       buffers
+      }
+    end
+
+    # Sign using HMAC
+    def sign(list)
+      return '' unless @hmac
+      @hmac.reset
+      list.each {|m| @hmac.update(m) }
+      @hmac.hexdigest
+    end
+  end
+end

data/lib/iruby/{session.rb → session/rbczmq.rb}

@@ -1,6 +1,8 @@
+require 'rbczmq'
+
 module IRuby
   class Session
-    DELIM = '<IDS|MSG>'
+    include SessionSerialize
 
     def initialize(config)
       c = ZMQ::Context.new
@@ -45,54 +47,12 @@ module IRuby
         session:  @session,
         version:  '5.0'
       }
-      @sockets[socket].send_message(serialize(idents, header, content))
+      @sockets[socket].send_message(ZMQ::Message(*serialize(idents, header, content)))
     end
 
     # Receive a message and decode it
     def recv(socket)
       @last_recvd_msg = unserialize(@sockets[socket].recv_message)
     end
-
-    private
-
-    def serialize(idents, header, content)
-      msg = [MultiJson.dump(header),
-             MultiJson.dump(@last_recvd_msg ? @last_recvd_msg[:header] : {}),
-             '{}',
-             MultiJson.dump(content || {})]
-      frames = ([*idents].compact.map(&:to_s) << DELIM << sign(msg)) + msg
-      IRuby.logger.debug "Sent #{frames.inspect}"
-      ZMQ::Message(*frames)
-    end
-
-    def unserialize(msg)
-      raise 'no message received' unless msg
-      frames = msg.to_a.map(&:to_s)
-      IRuby.logger.debug "Received #{frames.inspect}"
-
-      i = frames.index(DELIM)
-      idents, msg_list = frames[0..i-1], frames[i+1..-1]
-
-      minlen = 5
-      raise 'malformed message, must have at least #{minlen} elements' unless msg_list.length >= minlen
-      s, header, parent_header, metadata, content, buffers = *msg_list
-      raise 'Invalid signature' unless s == sign(msg_list[1..-1])
-      {
-        idents:        idents,
-        header:        MultiJson.load(header),
-        parent_header: MultiJson.load(parent_header),
-        metadata:      MultiJson.load(metadata),
-        content:       MultiJson.load(content),
-        buffers:       buffers
-      }
-    end
-
-    # Sign using HMAC
-    def sign(list)
-      return '' unless @hmac
-      @hmac.reset
-      list.each {|m| @hmac.update(m) }
-      @hmac.hexdigest
-    end
   end
 end

data/lib/iruby/version.rb

@@ -1,3 +1,3 @@
 module IRuby
-  VERSION = '0.2.7'
+  VERSION = '0.2.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iruby
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Daniel Mendler
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
+date: 2015-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -53,20 +53,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: rbczmq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -127,7 +113,9 @@ files:
 - lib/iruby/kernel.rb
 - lib/iruby/logger.rb
 - lib/iruby/ostream.rb
-- lib/iruby/session.rb
+- lib/iruby/session/ffi_rzmq.rb
+- lib/iruby/session/mixin.rb
+- lib/iruby/session/rbczmq.rb
 - lib/iruby/utils.rb
 - lib/iruby/version.rb
 - logo/logo-32x32.png
@@ -172,4 +160,3 @@ test_files:
 - test/integration_test.rb
 - test/iruby/multi_logger_test.rb
 - test/test_helper.rb
-has_rdoc: