ruddy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5472f2049ff6bfd144aeea055ab4e7bf2f28c2a
+  data.tar.gz: b631945110c72dbddb97b16f53a96b4aace394a9
+SHA512:
+  metadata.gz: a48d3d9eb7bb0a5baa0c263675f629af983d940ad2322e6bf34035ad112ebecf1bf96d3901c73358d45494aa6f0eb359fb5a3656b54968b648282972b4a6cc86
+  data.tar.gz: 2cdb71ff621c0cdb7849428ce1d786569764d6542a62e42957df51e881f1f65b977f1a2cb4ea9f9a566654c1133654d03bc1ee7a4b5ed9179704f3631527d271

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Haines
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,19 @@
+# Ruddy
+
+Basic Win32 DDE client in Ruby.
+
+## Installation
+
+    $ gem install ruddy
+
+## Usage
+
+Connect to a DDE server using the `Ruddy::Connection.open` method, and call `execute` on the yielded connection:
+
+```ruby
+require "ruddy"
+
+Ruddy::Connection.open("SERVICE", "topic") do |connection|
+  connection.execute("command")
+end
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/dde.rb

@@ -0,0 +1,76 @@
+require "ffi"
+require "dde/constants"
+
+module DDE
+  extend FFI::Library
+  ffi_lib "user32"
+  ffi_convention :stdcall
+
+# HDDEDATA CALLBACK DdeCallback(
+#   _In_  UINT uType,
+#   _In_  UINT uFmt,
+#   _In_  HCONV hconv,
+#   _In_  HSZ hsz1,
+#   _In_  HSZ hsz2,
+#   _In_  HDDEDATA hdata,
+#   _In_  ULONG_PTR dwData1,
+#   _In_  ULONG_PTR dwData2
+# );
+  callback :dde_callback, [:uint, :uint, :pointer, :pointer, :pointer, :pointer, :pointer, :pointer], :pointer
+
+# UINT WINAPI DdeInitialize(
+#   _Inout_     LPDWORD pidInst,
+#   _In_        PFNCALLBACK pfnCallback,
+#   _In_        DWORD afCmd,
+#   _Reserved_  DWORD ulRes
+# );
+  attach_function :start, :DdeInitializeA, [:pointer, :dde_callback, :uint, :uint], :uint
+
+# BOOL WINAPI DdeUninitialize(
+#   _In_  DWORD idInst
+# );
+  attach_function :stop, :DdeUninitialize, [:uint], :bool
+
+# HSZ WINAPI DdeCreateStringHandle(
+#   _In_  DWORD idInst,
+#   _In_  LPTSTR psz,
+#   _In_  int iCodePage
+# );
+  attach_function :create_string_handle, :DdeCreateStringHandleA, [:uint, :pointer, :int], :pointer
+
+# HCONV WINAPI DdeConnect(
+#   _In_      DWORD idInst,
+#   _In_      HSZ hszService,
+#   _In_      HSZ hszTopic,
+#   _In_opt_  PCONVCONTEXT pCC
+# );
+  attach_function :connect, :DdeConnect, [:uint, :pointer, :pointer, :pointer], :pointer
+
+# HDDEDATA WINAPI DdeClientTransaction(
+#   _In_opt_   LPBYTE pData,
+#   _In_       DWORD cbData,
+#   _In_       HCONV hConv,
+#   _In_opt_   HSZ hszItem,
+#   _In_       UINT wFmt,
+#   _In_       UINT wType,
+#   _In_       DWORD dwTimeout,
+#   _Out_opt_  LPDWORD pdwResult
+# );
+  attach_function :client_transaction, :DdeClientTransaction, [:pointer, :uint, :pointer, :pointer, :uint, :uint, :uint, :pointer], :pointer
+
+# UINT WINAPI DdeGetLastError(
+#   _In_  DWORD idInst
+# );
+  attach_function :last_error, :DdeGetLastError, [:uint], :uint
+
+# BOOL WINAPI DdeFreeDataHandle(
+#   _In_  HDDEDATA hData
+# );
+  attach_function :free_data_handle, :DdeFreeDataHandle, [:pointer], :bool
+
+# BOOL WINAPI DdeFreeStringHandle(
+#   _In_  DWORD idInst,
+#   _In_  HSZ hsz
+# );
+  attach_function :free_string_handle, :DdeFreeStringHandle, [:uint, :pointer], :bool
+end

data/lib/dde/constants.rb

@@ -0,0 +1,7 @@
+module DDE
+  DMLERR_NO_ERROR = 0
+  CP_WINANSI = 1004
+  XTYP_EXECUTE = 0x4050
+  APPCLASS_STANDARD = 0x00000000
+  APPCMD_CLIENTONLY = 0x00000010
+end

data/lib/ruddy.rb

@@ -0,0 +1,3 @@
+require "ruddy/version"
+require "dde"
+require "ruddy/connection"

data/lib/ruddy/connection.rb

@@ -0,0 +1,83 @@
+module Ruddy
+  class Connection
+
+    attr_reader :service, :topic
+    attr_accessor :timeout
+
+    def initialize(service, topic, options = {})
+      @service = service
+      @topic   = topic
+      @timeout = options.fetch(:timeout, 3000)
+
+      start
+      connect
+    end
+
+    def close
+      @closed = true
+      DDE.stop(instance)
+    end
+
+    def closed?
+      @closed
+    end
+
+    def execute(command)
+      raise IOError.new("closed connection") if closed?
+
+      buffer = FFI::MemoryPointer.from_string(command)
+      result = FFI::MemoryPointer.new(:uint)
+
+      data = DDE.client_transaction(buffer, buffer.size, conversation, nil, 0, DDE::XTYP_EXECUTE, timeout, result)
+      raise SystemCallError.new("command execution failed", DDE.last_error(instance)) if data.null?
+      DDE.free_data_handle(data)
+
+      return result.read_uint
+    end
+
+    def self.open(*args)
+      connection = new(*args)
+      return connection unless block_given?
+
+      begin
+        yield connection
+      ensure
+        connection.close
+      end
+    end
+
+    private
+
+    attr_reader :instance, :conversation
+
+    CALLBACK = ->(*){}
+
+    def start
+      instance = FFI::MemoryPointer.new(:uint)
+      error = DDE.start(instance, CALLBACK, DDE::APPCLASS_STANDARD | DDE::APPCMD_CLIENTONLY, 0)
+      raise SystemCallError.new("DDE management library initialization failed", error) if error != DDE::DMLERR_NO_ERROR
+      @instance = instance.read_uint
+    end
+
+    def connect
+      service_handle = create_string_handle(service)
+      topic_handle = create_string_handle(topic)
+
+      @conversation = DDE.connect(instance, service_handle, topic_handle, nil)
+
+      free_string_handle service_handle
+      free_string_handle topic_handle
+
+      raise SystemCallError.new(%{could not connect to DDE service "#{service}"}) if conversation.null?
+    end
+
+    def create_string_handle(string)
+      DDE.create_string_handle(instance, string, DDE::CP_WINANSI)
+    end
+
+    def free_string_handle(handle)
+      DDE.free_string_handle(instance, handle)
+    end
+
+  end
+end

data/lib/ruddy/version.rb

@@ -0,0 +1,3 @@
+module Ruddy
+  VERSION = "0.1.0"
+end

data/ruddy.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruddy/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "ruddy"
+  gem.version       = Ruddy::VERSION
+  gem.authors       = ["Andrew Haines"]
+  gem.email         = ["andrew@haines.org.nz"]
+  gem.summary       = %q{Basic Win32 DDE client in Ruby}
+  gem.homepage      = "https://github.com/haines/ruddy"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "ffi", "~> 1.7.0"
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 2.13"
+end

data/spec/ruddy/connection_spec.rb

@@ -0,0 +1,206 @@
+require "ruddy/connection"
+require "ffi"
+
+require "support/fake_dde"
+require "support/string_pointer_matcher"
+
+module Ruddy
+  describe Connection do
+    describe ".new" do
+      it "sets the service" do
+        connection = Connection.new("MY_SERVICE", "my_topic")
+
+        expect(connection.service).to eq "MY_SERVICE"
+      end
+
+      it "sets the topic" do
+        connection = Connection.new("MY_SERVICE", "my_topic")
+
+        expect(connection.topic).to eq "my_topic"
+      end
+
+      describe "timeout option" do
+        it "sets the timeout" do
+          connection = Connection.new("MY_SERVICE", "my_topic", timeout: 1000)
+
+          expect(connection.timeout).to eq 1000
+        end
+
+        it "defaults to 3 sec" do
+          connection = Connection.new("MY_SERVICE", "my_topic")
+
+          expect(connection.timeout).to eq 3000
+        end
+      end
+
+      it "connects to the service" do
+        stub_instance 42
+
+        service_handle = stub("service_handle")
+        DDE.stub(:create_string_handle).with(42, "MY_SERVICE", DDE::CP_WINANSI).and_return(service_handle)
+
+        topic_handle = stub("topic_handle")
+        DDE.stub(:create_string_handle).with(42, "my_topic", DDE::CP_WINANSI).and_return(topic_handle)
+
+        DDE.should_receive(:connect).with(42, service_handle, topic_handle, nil).and_return(valid_pointer)
+        Connection.new("MY_SERVICE", "my_topic")
+      end
+
+      context "when initializing the DDE management library fails" do
+        it "raises an error" do
+          DDE.stub start: 0x4006
+          expect{Connection.new("MY_SERVICE", "my_topic")}.to raise_error SystemCallError, /DDE management library initialization failed/
+        end
+
+        it "sets the error code" do
+          DDE.stub start: 0x4006
+          begin
+            Connection.new("MY_SERVICE", "my_topic")
+          rescue SystemCallError => error
+            expect(error.errno).to eq 0x4006
+          end
+        end
+      end
+
+      context "when the connection fails" do
+        it "raises an error" do
+          DDE.stub connect: null_pointer
+          expect{Connection.new("MY_SERVICE", "my_topic")}.to raise_error SystemCallError, /could not connect to DDE service "MY_SERVICE"/
+        end
+      end
+    end
+
+    describe "#close" do
+      it "uninitializes the DDE management library" do
+        stub_instance 42
+        connection = Connection.new("MY_SERVICE", "my_topic")
+
+        DDE.should_receive(:stop).with(42)
+        connection.close
+      end
+    end
+
+    describe "#closed?" do
+      it "is false initially" do
+        connection = Connection.new("MY_SERVICE", "my_topic")
+
+        expect(connection).not_to be_closed
+      end
+
+      it "is true after closing" do
+        connection = Connection.new("MY_SERVICE", "my_topic")
+        connection.close
+
+        expect(connection).to be_closed
+      end
+    end
+
+    describe "#execute" do
+      it "executes the given command" do
+        conversation = valid_pointer
+        DDE.stub connect: conversation
+        connection = Connection.new("MY_SERVICE", "my_topic", timeout: 12345)
+        command = "[Foo(bar)]"
+
+        DDE.should_receive(:client_transaction).with(string_pointer(command), command.length + 1, conversation, nil, 0, DDE::XTYP_EXECUTE, 12345, kind_of(FFI::MemoryPointer)).and_return(valid_pointer)
+        connection.execute(command)
+      end
+
+      it "returns the result" do
+        connection = Connection.new("MY_SERVICE", "my_topic")
+        DDE.stub :client_transaction do |*, result|
+          result.write_uint 43
+        end
+
+        expect(connection.execute("[Foo(bar)]")).to eq 43
+      end
+
+      it "frees the returned data structure" do
+        connection = Connection.new("MY_SERVICE", "my_topic")
+        data = valid_pointer
+        DDE.stub client_transaction: data
+
+        DDE.should_receive(:free_data_handle).with(data)
+        connection.execute("[Foo(bar)]")
+      end
+
+      context "when the execution fails" do
+        it "raises an error" do
+          connection = Connection.new("MY_SERVICE", "my_topic")
+          DDE.stub client_transaction: null_pointer
+
+          expect{connection.execute("[Foo(bar)]")}.to raise_error SystemCallError, /command execution failed/
+        end
+
+        it "sets the error code" do
+          stub_instance 42
+          connection = Connection.new("MY_SERVICE", "my_topic")
+          DDE.stub(:last_error).with(42).and_return(0x4000)
+          DDE.stub client_transaction: null_pointer
+
+          begin
+            connection.execute("[Foo(bar)]")
+          rescue SystemCallError => error
+            expect(error.errno).to eq 0x4000
+          end
+        end
+      end
+
+      context "when the connection is closed" do
+        it "raises an error" do
+          connection = Connection.new("MY_SERVICE", "my_topic")
+          connection.close
+
+          expect{connection.execute("[Foo(bar)]")}.to raise_error IOError, /closed connection/
+        end
+      end
+    end
+
+    describe ".open" do
+      context "with a block" do
+        it "yields a connection" do
+          yielded = false
+          Connection.open("MY_SERVICE", "my_topic") do |connection|
+            yielded = connection
+          end
+
+          expect(yielded).to be_a Connection
+        end
+
+        it "closes the connection afterwards" do
+          yielded = false
+          Connection.open("MY_SERVICE", "my_topic") do |connection|
+            expect(connection).not_to be_closed
+            yielded = connection
+          end
+
+          expect(yielded).to be_closed
+        end
+      end
+
+      context "without a block" do
+        it "returns an open connection" do
+          connection = Connection.open("MY_SERVICE", "my_topic")
+
+          expect(connection).to be_a Connection
+          expect(connection).not_to be_closed
+        end
+      end
+    end
+
+    def stub_instance(instance)
+      DDE.stub :start do |pointer, *|
+        pointer.write_uint instance
+        DDE::DMLERR_NO_ERROR
+      end
+    end
+
+    def valid_pointer
+      FFI::MemoryPointer.new(:uint)
+    end
+
+    def null_pointer
+      stub(null?: true)
+    end
+  end
+end

data/spec/support/fake_dde.rb

@@ -0,0 +1,22 @@
+require "dde/constants"
+
+module DDE
+  module_function
+
+  def start(*)
+    DDE::DMLERR_NO_ERROR
+  end
+
+  def connect(*)
+    FFI::MemoryPointer.new(:uint)
+  end
+
+  def stop(*) end
+
+  def create_string_handle(*) end
+  def free_string_handle(*) end
+
+  def free_data_handle(*) end
+
+  def last_error(*) end
+end

data/spec/support/string_pointer_matcher.rb

@@ -0,0 +1,17 @@
+class StringPointerMatcher
+  def initialize(string)
+    @string = string
+  end
+
+  def ==(actual)
+    @string == actual.read_string
+  end
+
+  def description
+    "pointer to #{@string.inspect}"
+  end
+end
+
+def string_pointer(string)
+  StringPointerMatcher.new(string)
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: ruddy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Haines
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: 
+email:
+- andrew@haines.org.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/dde.rb
+- lib/dde/constants.rb
+- lib/ruddy.rb
+- lib/ruddy/connection.rb
+- lib/ruddy/version.rb
+- ruddy.gemspec
+- spec/ruddy/connection_spec.rb
+- spec/support/fake_dde.rb
+- spec/support/string_pointer_matcher.rb
+homepage: https://github.com/haines/ruddy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Basic Win32 DDE client in Ruby
+test_files:
+- spec/ruddy/connection_spec.rb
+- spec/support/fake_dde.rb
+- spec/support/string_pointer_matcher.rb