drctrl 0.1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c57e89d0b5d7c9822a9413407e881054f9419ba2
+  data.tar.gz: 57495ebe3caa40066010ea7886100867ca1e9eb7
+SHA512:
+  metadata.gz: 510ec94063e41c05cfeae3d9a5c9a59298caa4c4e1ca9fa7eb64bf7a028870a72f619746bc3a9058857d5c74071c89358f8846219385c2050e45e927a2d7833d
+  data.tar.gz: c0a553383dfc42001bde3d261f0073b6a5a70eb9e6fc06482b34ee9a7a21b7d458fd2f0aa8ff2069adac4de55b1dfbe0811786ebc6704625dae0657a1f5c600a

data/LICENSE

@@ -0,0 +1,166 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+

data/README.md

@@ -0,0 +1,51 @@
+# drctrl
+
+A local control for DRb service.
+
+[![Gem Version](https://badge.fury.io/rb/drctrl.svg)](http://badge.fury.io/rb/drctrl)
+[![GitHub license](https://img.shields.io/badge/license-LGPLv3-orange.svg?style=flat)](https://raw.githubusercontent.com/shikhalev/drctrl/master/LICENSE)
+[![Code Climate](https://codeclimate.com/github/shikhalev/drctrl/badges/gpa.svg)](https://codeclimate.com/github/shikhalev/drctrl)
+
+This gem provides a local dRuby service for control purposes and a command line
+tool for it.
+
+## Usage
+
+### At server side
+
+```Ruby
+require 'drctrl'
+
+DRCtrl.start_service do
+  # some finalize code
+end
+
+. . . . .
+
+
+DRCtrl.wait
+
+```
+
+This code creates object with methods `stop` and `restart`. And it starts
+a dRuby service at unix-socket `/tmp/<appname>-<pid>`.
+
+Use `DRCtrl.wait` instead `DRb.thread.join` for correct stopping.
+
+### At client side
+
+Use a command line tool `drctrl` or your own code with
+`require 'drctrl/client'`.
+
+`drctrl` find appropriate dRuby server and send to it command and arguments.
+
+```
+drctrl [<options>] <command> [<args>]
+    -U, --uri=URI
+    -P, --path=PATH
+    -N, --name=NAME
+    -I, --pid=PID
+```
+
+There is required to set one of options: `--uri` (any dRuby URI), `--path`
+(a path to unix-socket), or `--name` (name of controlled app).

data/bin/drctrl

@@ -0,0 +1,71 @@
+#!/usr/bin/ruby
+# encoding: utf-8
+
+require 'optparse'
+require 'current_spec'
+require_relative '../lib/drctrl/client'
+
+verbose = false
+
+options = {
+  uri: nil,
+  path: nil,
+  name: nil,
+  pid: nil
+}
+
+opts = OptionParser.new do |o|
+
+  o.banner = 'drctrl [<options>] <command> [<args>]'
+
+  o.on '-h', '-?', '--help', 'Show this help and exit.' do
+    puts opts.help
+    exit
+  end
+
+  o.on '-V', '--version', 'Show version info and exit' do
+    puts(Gem.current_spec_version || DRCtrl::VERSION.join('.'))
+    exit
+  end
+
+  o.on '-v', '--[no-]verbose', 'Verbose mode.' do |value|
+    verbose = value
+  end
+
+  o.separator ''
+
+  o.on '-U', '--uri', '=URI', String do |value|
+    options[:uri] = value
+  end
+
+  o.on '-P', '--path', '=PATH', String do |value|
+    options[:path] = value
+  end
+
+  o.on '-N', '--name', '=NAME', String do |value|
+    options[:name] = value
+  end
+
+  o.on '-I', '--pid', '=PID', Integer do |value|
+    options[:pid] = value
+  end
+
+end
+
+command, *args = opts.parse ARGV
+
+obj = DRCtrl.connect options
+
+if Array === obj
+  obj.each do |o|
+    if verbose
+      puts "Send #{command.intern.inspect} to #{o.__drburi.inspect}..."
+    end
+    o.send command.intern, *args
+  end
+else
+  if verbose
+    puts "Send #{command.intern.inspect} to #{obj.__drburi.inspect}..."
+  end
+  obj.send command.intern, *args
+end

data/lib/drctrl.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+
+require 'drb'
+
+require_relative 'drctrl/version'
+
+# Namespace module. Contains server-side methods if you use
+#   require 'drctrl'
+# and client-side methods if you use
+#   require 'drctrl/client'
+module DRCtrl
+
+  # Controller service front object class.
+  class Server
+
+    # @yield Block without parameters which will be runned before stop
+    #   the service.
+    def initialize &block
+      @block = block
+    end
+
+    # Stop the service.
+    # @return [void]
+    def stop
+      if @block
+        Thread.exclusive do
+          block.call
+        end
+      end
+      DRb.primary_server = DRCtrl.server
+      DRb.stop_service
+    end
+
+    # Restart the service.
+    # @return [Integer] Process ID for new process.
+    def restart
+      stop
+      sleep 0
+      spawn 'ruby', File.expand_path($0), *($*)
+    end
+
+  end
+
+  class << self
+
+    # @!group Server-side Module Attributes
+
+    # DRCtrl server.
+    # @return [DRb::DRbServer]
+
+    attr_reader :server
+
+    # @!endgroup
+
+    # @!group Server-side Module Methods
+
+    # Start control service with provided or default URI. Create
+    # a {DRCtrl::Server} instance and start it as a front object of dRuby service.
+    # @param uri [String] Optional. Custom URI for this control service.
+    #    If not set the automated '+drbunix:+' socket will be used.
+    # @param opts [Hash] Options for +DRb::start_service+.
+    # @yield Block without parameters which will be runned before stop
+    #   the service.
+    # @return [DRb::DRbServer]
+
+    def start_service uri: nil, **opts, &block
+      if uri.nil?
+        uri = "drbunix:/tmp/#{File.basename($0, '.rb')}-#{Process.pid}"
+      end
+      oldprim = DRb.primary_server
+      @server = DRb.start_service uri, Server.new(&block), opts
+      DRb.primary_server = oldprim if oldprim
+      @server
+    end
+
+    # Wait when control service will be stopped.
+    # @return [void]
+
+    def wait
+      @server.thread.join if @server
+    end
+
+    alias :join :wait
+
+    # @!endgroup
+
+  end
+
+end

data/lib/drctrl/client.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+require 'drb'
+
+require_relative 'version'
+
+module DRCtrl
+
+  class << self
+
+    # @!group Client-side Module Methods
+
+    # Find socket path for name and process ID.
+    # @param [String] name Application name.
+    # @param [Integer] pid Process ID.
+    # @return [String, Array<String>, nil]
+
+    def detect name, pid = nil
+      if pid
+        result = "/tmp/#{name}-#{pid}"
+        if File.socket? result
+          return result
+        else
+          return nil
+        end
+      else
+        files = Dir["/tmp/#{name}*"]
+        result = files.select { |f| File.socket? f }
+        if result.length == 0
+          return nil
+        elsif result.length == 1
+          return result[0]
+        else
+          return result
+        end
+      end
+    end
+
+    # Connect to dRuby socket(-s).
+    # @param uri [String] Socket's URI.
+    # @param path [String] Path to unix-socket.
+    # @param name [String] Application name.
+    # @param pid [Integer] Process ID.
+    # @return [DRb::DRbObject, Array<DRbObject>, nil]
+    # @raise [RuntimeError] If socket not found.
+    # @raise [ArgumentError] If no required arguments setted.
+
+    def connect uri: nil, path: nil, name: nil, pid: nil
+      if uri
+        DRbObject.new nil, uri
+      elsif path
+        DRbObject.new nil, "drbunix:#{path}"
+      elsif name
+        socket = detect name, pid
+        case socket
+        when String
+          DRbObject.new nil, "drbunix:#{socket}"
+        when Array
+          socket.map { |s| DRbObject.new nil, "drbunix:#{s}" }
+        else
+          raise RuntimeError, "Socket for { name: #{name.inspect}," +
+              " pid: #{pid.inspect} } not found!", caller
+        end
+      else
+        raise ArgumentError,
+            "One of this arguments: uri, path or name must be setted!", caller
+      end
+    end
+
+    # @!endgroup
+
+  end
+
+end
+
+

data/lib/drctrl/version.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+module DRCtrl
+
+  # Version of drctrl gem without build number.
+  VERSION = [0, 1, 1]
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: drctrl
+version: !ruby/object:Gem::Version
+  version: 0.1.1.1
+platform: ruby
+authors:
+- Ivan Shikhalev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: current_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: set_version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: A local control for DRb service.
+email: shikhalev@gmail.com
+executables:
+- drctrl
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/drctrl
+- lib/drctrl.rb
+- lib/drctrl/client.rb
+- lib/drctrl/version.rb
+homepage: https://github.com/shikhalev/drctrl
+licenses:
+- GNU LGPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A local control for DRb service
+test_files: []
+has_rdoc: