rslp 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d18a5f649a8f64234f0ca36681d7700bc82c6f92d6f92fb7de5a15a3e0c9a75
-  data.tar.gz: 445016807c2bb1f53192df312f86e8da65948e2c5f634f16cb5fd91fcd49df10
+  metadata.gz: 1c95a3256bfee540b035527983b2855d2ed8cfee989c766674259cc5649c928f
+  data.tar.gz: c78b46ee391b1dc210100c998a1e37ef1ab27e1dca89474aef4f48a2c0670612
 SHA512:
-  metadata.gz: c2150dfc89eae6d2a403151bcc6d4e1e683733225702cbd7e51cb2f6fc7d90e1e3b25504b2536d14a03fa629acb1fa4a8a093e6c45d72964feec43eac367fa94
-  data.tar.gz: 5051e0ec6e22438ada2b92729c64465b307201d0baf60a996627cf429efa2fbdb246ce602eeb627a29db60362bbd65944195d7ef46a7ef89880b052770572cbc
+  metadata.gz: cfbdfcea3945c0d0ee3625a0494e012b98ad85704089e254cafa2d9b9e3e85db19d93fb06ded3518e5c3d10073c43c1efcc1537b3ac4679867b3e035d881b0c3
+  data.tar.gz: 9e504c569a23cbfd41701beddf4670cf2441eea128ce9686c6ceb10bc7ebf61554a6641367ddebf490b8cd2c979ff45cb2d76b8f7d2961030f7d67c4e5564f5f

data/CHANGES.md

@@ -1,3 +1,11 @@
+## 0.1.1 - 22-Oct-2022
+* Added many more specs, along with instructions for how to install and
+  run an openslp container via Docker so that you can run the specs.
+* The :url parameter to the register method now raises an error unless
+  it is present. It was always required in practice, but now it's enforced.
+* Many documentation updates, notably that some methods may not actually
+  be implemented yet by the underlying OpenSLP library.
+
 ## 0.1.0 - 19-Oct-2022
 * Updated the constructor, now uses keyword arguments.
 * Constructor now accepts a hostname, or a comma separate lists of hosts.

data/README.md

@@ -24,6 +24,17 @@ None that I'm aware of. Please report bugs on the project page at:
 
 https://github.com/djberg96/rslp
 
+## Running the Specs
+You will need an OpenSLP server running on localhost to run all of the specs.
+The easiest way to do that is to install docker and run:
+
+  `docker run -d -p 427:427/tcp -p 427:427/udp vcrhonek/openslp`
+
+Once you're done just terminate the container.
+
+## Notes
+Also see Novell's SLP implementation.
+
 ## Future Plans
 None at this time.
 

data/lib/rslp.rb

@@ -11,7 +11,7 @@ module OpenSLP
     extend OpenSLP::Functions
 
     # The version of the rslp library.
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.1.1'.freeze
 
     # Internal error raised whenever an openslp function fails.
     class Error < StandardError; end
@@ -31,7 +31,7 @@ module OpenSLP
     #
     # The +async+ argument may be set to true or false and establishes whether
     # the underlying handle is set to handle asynchronous operations or not. By
-    # default this value is false.
+    # default this value is false, and may not be supported by your implementation.
     #
     # The +host+ argument, if present, will associate the Host/IP with the OpenSLP
     # handle. This is the Hostname/IP address of the Service Agent / Directory Agent
@@ -104,6 +104,8 @@ module OpenSLP
     # Returns the url if successful.
     #
     def register(options = {})
+      url = options.fetch(:url){ raise ArgumentError, ":url must be provided" }
+
       options[:lifetime] ||= SLP_LIFETIME_DEFAULT
       options[:attributes] ||= ""
       options[:fresh] ||= true
@@ -121,7 +123,7 @@ module OpenSLP
 
         result = SLPReg(
           @handle,
-          options[:url],
+          url,
           options[:lifetime],
           nil,
           attributes,
@@ -135,7 +137,7 @@ module OpenSLP
         cookie.free unless cookie.null?
       end
 
-      options[:url]
+      url
     end
 
     # Deregisters the advertisement for +url+ in all scopes where the service
@@ -161,6 +163,10 @@ module OpenSLP
     #
     # Returns the list of deleted attributes if successful.
     #
+    # Note that this method may not be supported. In that case, the only way
+    # to alter a service's attributes is to deregister it then register it
+    # again without the undesired attributes.
+    #
     def delete_service_attributes(url, attributes)
       callback = Proc.new{ |hslp, err, cookie| }
 
@@ -206,8 +212,8 @@ module OpenSLP
     # form of an LDAP search filter. The default is an empty string, which
     # will gather all services of the requested type.
     #
-    # The result is an array of hashes, with the URL as the key and its lifetime
-    # as the value.
+    # The result is an array of hashes, with the URL as the key and its
+    # remaining lifetime as the value.
     #
     def find_services(type, scope = '', filter = '')
       arr = []

data/rslp.gemspec

@@ -3,7 +3,7 @@ require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name       = 'rslp'
-  spec.version    = '0.1.0'
+  spec.version    = '0.1.1'
   spec.license    = 'Apache-2.0'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   }
 
   spec.description = <<-EOF
-    The rslp library is an FFI interface for the OpenSLP service
-    location protocol library.
+    The rslp library is an FFI interface for the OpenSLP service location
+    protocol library. See http://www.openslp.org for more information.
   EOF
 end

data/spec/rslp_spec.rb

@@ -1,8 +1,14 @@
-########################################################################
+##############################################################################
 # rslp_spec.rb
 #
-# Test suite for the rslp library.
-########################################################################
+# Test suite for the rslp library. Note that these specs assume that you
+# have an OpenSLP server running on localhost. If not, install Docker and
+# run the following command:
+#
+#   docker run -d -p 427:427/tcp -p 427:427/udp vcrhonek/openslp
+#
+# Once complete, simply stop the docker container and delete the image.
+##############################################################################
 require 'rspec'
 require 'rslp'
 
@@ -14,7 +20,7 @@ RSpec.describe OpenSLP::SLP do
 
   context "version" do
     example "version is set to the expected value" do
-      expect(described_class::VERSION).to eq('0.1.0')
+      expect(described_class::VERSION).to eq('0.1.1')
     end
   end
 
@@ -109,6 +115,144 @@ RSpec.describe OpenSLP::SLP do
         expect(described_class.unescape_reserved("\\2Ctag-example\\2C")).to eq(expected)
       end
     end
+
+    context "set_app_property_file" do
+      example "defines a set_app_property_file method" do
+        expect(described_class).to respond_to(:set_app_property_file)
+      end
+    end
+  end
+
+  describe "instance methods" do
+    let(:service){ "service:ntp" }
+    let(:url){ "#{service}://time.windows.com" }
+    let(:attributes){ {"foo" => "hello", "bar" => "world"} }
+
+    context "close" do
+      example "has a close method that returns the expected value" do
+        expect(@slp).to respond_to(:close)
+        expect(@slp.close).to be_nil
+      end
+
+      example "calling close multiple times has no effect" do
+        expect(@slp.close).to be_nil
+        expect(@slp.close).to be_nil
+      end
+    end
+
+    context "find_scopes" do
+      example "has a find_scopes method" do
+        expect(@slp).to respond_to(:find_scopes)
+      end
+
+      example "the find_scopes method returns the expected value" do
+        expect(@slp.find_scopes).to eq(['DEFAULT'])
+      end
+    end
+
+    context "find_services" do
+      before do
+        sleep 1
+        @slp.register(url: url, attributes: attributes)
+      end
+
+      example "has a find_services method" do
+        expect(@slp).to respond_to(:find_services)
+      end
+
+      example "the find_services method returns the expected types" do
+        results = @slp.find_services(service)
+        expect(results).to be_kind_of(Array)
+        expect(results.first).to be_kind_of(Hash)
+      end
+
+      example "the find_services method returns the expected values" do
+        results = @slp.find_services(service)
+        expect(results.first.keys).to include(url)
+        expect(results.first.values.first).to be_kind_of(Numeric)
+      end
+
+      example "the find_services method with valid scope returns the expected values" do
+        results = @slp.find_services(service, 'DEFAULT')
+        expect(results.first.keys).to include(url)
+        expect(results.first.values.first).to be_kind_of(Numeric)
+      end
+
+=begin
+      # These specs appear to cause a segfault in the OpenSLP daemon.
+      example "the find_services method with invalid scope returns an empty value" do
+        results = @slp.find_services(service, 'bogus')
+        expect(results).to be_empty
+      end
+
+      example "the find_services method with filter on existing attribute returns the expected values" do
+        results = @slp.find_services(service, '', "(foo=hello)")
+        expect(results).to eq(1)
+      end
+=end
+    end
+
+    context "find_service_types" do
+      example "has a find_services method" do
+        expect(@slp).to respond_to(:find_service_types)
+      end
+
+      example "the find_service_types method returns the expected results" do
+        results = @slp.find_service_types
+        expect(results).to be_kind_of(Array)
+        expect(results.first).to eq(service)
+      end
+    end
+
+    context "registration" do
+      example "registers a service successfully if url is provided" do
+        expect(@slp.register(url: url)).to eq(url)
+      end
+
+      example "doesn't matter if service is already registered" do
+        expect(@slp.register(url: url)).to eq(url)
+      end
+
+      example "accepts hash attributes option and registers them as expected" do
+        expect(@slp.register(url: url, attributes: attributes)).to eq(url)
+      end
+
+      example "raises an error if the :url option is not provided" do
+        expect{ @slp.register }.to raise_error(ArgumentError, ":url must be provided")
+      end
+
+      example "registers a service successfully with a lifetime value" do
+        expect(@slp.register(url: url, lifetime: OpenSLP::SLP::SLP_LIFETIME_MAXIMUM)).to eq(url)
+        expect(@slp.find_services(service).first.values.first).to be_within(1).of(OpenSLP::SLP::SLP_LIFETIME_MAXIMUM)
+      end
+    end
+
+    context "deregistration" do
+      example "deregisters a service successfully if it exists" do
+        expect(@slp.deregister(url)).to eq(url)
+        expect(@slp.find_services(url)).to be_empty
+      end
+
+      example "fails to deregister a service successfully if it does not exist" do
+        expect{ @slp.deregister('bogus') }.to raise_error(OpenSLP::SLP::Error)
+      end
+    end
+
+    context "find service attributes" do
+      before do
+        @slp.register(url: url, attributes: attributes)
+      end
+
+      example "successfully finds service attribute when they exist" do
+        expect(@slp.find_service_attributes(url)).to eq(["(foo=hello),(bar=world)"])
+        expect(@slp.find_service_attributes(url, "foo")).to eq(["(foo=hello)"])
+        expect(@slp.find_service_attributes(url, "foo,bar")).to eq(["(foo=hello),(bar=world)"])
+      end
+
+      example "returns an empty array if the service attribute does not exist" do
+        expect(@slp.find_service_attributes(url, "bogus")).to eq([])
+      end
+    end
   end
 
   after do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rslp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2022-10-20 00:00:00.000000000 Z
+date: 2022-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -80,8 +80,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.9'
 description: |2
-      The rslp library is an FFI interface for the OpenSLP service
-      location protocol library.
+      The rslp library is an FFI interface for the OpenSLP service location
+      protocol library. See http://www.openslp.org for more information.
 email: djberg96@gmail.com
 executables: []
 extensions: []