ddslbg 0.0.1 → 0.0.2

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.log

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--fail-fast

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'rspec', all_after_pass: false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch('spec/spec_helper.rb')  { 'spec' }
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/ddslbg/(.+)\.rb$})   { |m| "spec/ddslbg/#{m[1]}_spec.rb" }
+  watch('lib/ddslbg.rb')             { 'spec' }
+  watch(%r{^spec/support/(.+)\.rb$}) { 'spec' }
+  watch('spec/spec_helper.rb')       { 'spec' }
+end

data/README.md

@@ -11,21 +11,68 @@ Just a proof of concept.
 gem install ddslbg
 ```
 
+Note that this gem spawns a Java process running a standalone jar, so a working
+JRE is required.
+
 ## Usage
 
+Please see the [main DDSL documentation](https://github.com/mbknor/ddsl) for
+concepts and details.
+
+### Initialize the client
+
 ```ruby
 require 'ddslbg'
-
 $ddsl = Ddslbg::Client.new
+```
+
+### Set a list of zookeepers to use
+
+```ruby
+$ddsl.zookeeper_hosts = ['localhost:2181', 'some.other.server.com:2181']
+```
+
+### List available services
+
+```ruby
+$ddsl.available_services
+```
+
+### Toggle service state
 
+```ruby
 service = {
   id: {environment: 'test', serviceType: 'http', name: 'cmd-tool', version: '0.1'},
   sl: {url: 'http://localhost:4321/hi', quality: 1.0, lastUpdated: 1347398923243, ip: '127.0.0.1'}
 }
 
-$ddsl.up(service)        # Register the service, uses ddsl serviceUp
+$ddsl.up(service)
+$ddsl.down(service)
+```
 
-$ddsl.available_services # List all available services, uses ddsl getAllAvailableServices
+### Get service locations
 
-$ddsl.down(service)      # Explicitly deregister the service, uses ddsl serviceDown
+```ruby
+service_request = {
+  'sid' => {'environment' => 'test', 'serviceType' => 'telnet', 'name' => 'telnetServer', 'version' => '0.1'},
+  'cid' => {'environment' => 'Client env', 'name' => 'client name', 'version' => 'version', 'ip' => 'ip-address'}
+}
+
+$ddsl.best_service_location(service_request)
+$ddsl.service_locations(service_request)
 ```
+
+### Set local fallbacks
+
+```ruby
+fallbacks = {
+  'ServiceId(test,telnet,telnetServer,0.1)' => 'http://example.com/foo',
+  'ServiceId(test,http,BarServer,1.0)'      => 'http://example.com/bar'
+}
+
+$ddsl.fallback_urls = fallbacks
+```
+
+### Cleanly disconnect
+
+Use `$ddsl.disconnect!` to kill off the spawned process.

data/ddslbg.gemspec

@@ -18,4 +18,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_development_dependency 'awesome_print'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'rb-fsevent'
 end

data/lib/ddslbg.rb

@@ -1,5 +1,2 @@
-require 'open3'
-require 'json'
-
 require 'ddslbg/version'
 require 'ddslbg/client'

data/lib/ddslbg/client.rb

@@ -1,3 +1,8 @@
+require 'open3'
+require 'json'
+
+require 'ddslbg/error'
+
 module Ddslbg
   class Client
     BUNDLED_JAR_PATH = File.expand_path(
@@ -9,11 +14,12 @@ module Ddslbg
     def initialize(options={})
       default_opts = {
         java_cmd: 'java -jar',
-        jar_path: BUNDLED_JAR_PATH
+        jar_path: BUNDLED_JAR_PATH,
+        auto_connect: false
       }
       @options = default_opts.merge(options)
 
-      connect!
+      connect! if @options[:auto_connect]
     end
 
     def available_services
@@ -28,29 +34,65 @@ module Ddslbg
       send('serviceDown', service)
     end
 
-    # Send a raw command to DDSL.
-    #
+    def best_service_location(service_request)
+      send('getBestServiceLocation', service_request)
+    end
+
+    def service_locations(service_request)
+      send('getServiceLocations', service_request)
+    end
+
+    def fallback_urls=(fallback_urls)
+      send('setFallbackUrlsMap', fallback_urls, parse: false)
+    end
+
+    def zookeeper_hosts=(hosts=[])
+      send('setZookeeperHosts', hosts, parse: false)
+    end
+
     # `data` can be a Ruby array or hash. It is converted to JSON before it is
     # sent to DDSL.
-    def send(msg, data=nil)
-      cmd = msg
-      cmd += " #{data.to_json}" if data
-      @stdin.puts(cmd)
-      parse(process_line(@stdout.gets))
+    def send(msg, data={}, options={})
+      default_opts = { parse: true }
+      options = default_opts.merge(options)
+      msg += " #{data.to_json}" unless !data || data.empty?
+      res = process_line(do_send(msg))
+      res = parse(res) if options[:parse]
+      res
     end
 
-    private
+    # Sends a raw command to DDSL and returns the response as a unprocessed string.
+    def do_send(cmd)
+      connect! unless connected?
+      @stdin.puts(cmd)
+      @stdout.gets
+    end
 
     def connect!
       cmd = [options[:java_cmd], options[:jar_path]].join(' ')
-      @stdin, @stdout, @stderr = Open3.popen3(cmd)
+      @stdin, @stdout, @wait_thr = Open3.popen2(cmd)
+
+      process_line(@stdout.gets).include?('ddsl-cmdline-tool started')
+    end
+
+    def disconnect!
+      return false unless connected?
+      @stdin.close unless @stdin.closed?
+      @stdout.close unless @stdout.closed?
+      Process.kill(:INT, @wait_thr.pid)
+      true
+    end
 
-      process_line(@stdout.gets)
+    def connected?
+      !!@wait_thr && @wait_thr.alive?
     end
 
+    private
+
     def process_line(line='')
       status, data = line.scan(/^([a-z]+) (.+)/).flatten
-      raise StandardError.new("[ddslbg] #{line}") unless status == 'ok'
+      data.chomp!
+      raise Error.new(data) unless status == 'ok'
       data
     end
 

data/lib/ddslbg/error.rb

@@ -0,0 +1,4 @@
+module Ddslbg
+  class Error < StandardError
+  end
+end

data/lib/ddslbg/version.rb

@@ -1,3 +1,3 @@
 module Ddslbg
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/ddslbg/client_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+require 'ddslbg/client'
+
+module Ddslbg
+  describe Client do
+    subject { Client.new(auto_connect: false) }
+
+    it 'should raise if it receives an error' do
+      response = "error java.net.UnknownHostException: some.other.server.com\n"
+      subject.should_receive(:do_send).and_return(response)
+
+      begin
+        subject.send('any message')
+      rescue Ddslbg::Error => e
+        e.to_s.should == 'java.net.UnknownHostException: some.other.server.com'
+      end
+    end
+
+    describe '#available_services' do
+      specify do
+        subject.should_receive(:do_send).with('getAllAvailableServices').and_return("ok []\n")
+        subject.available_services.should == []
+      end
+    end
+
+    describe '#up' do
+      specify do
+        service = {
+          id: {environment: 'test', serviceType: 'http', name: 'cmd-tool', version: '0.1'},
+          sl: {url: 'http://localhost:4321/hi', quality: 1.0, lastUpdated: 1347398923243, ip: '127.0.0.1'}
+        }
+        subject.should_receive(:do_send).with("serviceUp #{service.to_json}").and_return("ok true\n")
+        subject.up(service).should be_true
+      end
+    end
+
+    describe '#fallback_urls=' do
+      specify do
+        fallbacks = {
+          'ServiceId(test,telnet,telnetServer,0.1)' => 'http://example.com/foo',
+          'ServiceId(test,http,BarServer,1.0)'      => 'http://example.com/bar'
+        }
+
+        response = "ok fallbackUrls-map has been updated: {\"ServiceId(test,telnet,telnetServer,0.1)\":\"http://example.com/foo\",\"ServiceId(test,http,BarServer,1.0)\":\"http://example.com/bar\"}\n"
+
+        subject.should_receive(:do_send)
+          .with("setFallbackUrlsMap #{fallbacks.to_json}")
+          .and_return(response)
+
+        subject.fallback_urls = fallbacks
+      end
+    end
+
+    describe '#zookeeper_hosts=' do
+      specify do
+        hosts = ['localhost:2181', 'some.other.server.com:2181']
+        response = "ok ZookeeperHosts-list has been configured\n"
+
+        subject.should_receive(:do_send)
+          .with("setZookeeperHosts #{hosts.to_json}")
+          .and_return(response)
+
+        subject.zookeeper_hosts = hosts
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+
+require 'bundler/setup'
+require 'awesome_print'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/spec/support/rspec_config.rb

@@ -0,0 +1,7 @@
+RSpec.configure do |config|
+  # Annotate specs with focus: true for focused runs
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+end

metadata

@@ -2,14 +2,14 @@
 name: ddslbg
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Bjørn Arild Mæland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-16 00:00:00.000000000 Z
+date: 2013-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   prerelease: false
@@ -27,6 +27,38 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
     none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
 description: This library spawns a child process which communicates with the DDSL
   command line tool
 email:
@@ -36,14 +68,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - ddslbg.gemspec
 - lib/ddslbg.rb
 - lib/ddslbg/client.rb
+- lib/ddslbg/error.rb
 - lib/ddslbg/version.rb
+- spec/ddslbg/client_spec.rb
+- spec/spec_helper.rb
+- spec/support/rspec_config.rb
 - vendor/bin/ddsl-cmdline-tool_2.10-0.3.5-SNAPSHOT-one-jar.jar
 homepage: https://github.com/bmaland/ddslbg
 licenses: []
@@ -69,4 +107,7 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Ruby client which wraps ddsl-cmdline-tool
-test_files: []
+test_files:
+- spec/ddslbg/client_spec.rb
+- spec/spec_helper.rb
+- spec/support/rspec_config.rb