rslp 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f495c04e7aa0fa38ebead86d3100b360d13de94d02ee3fc2f54bc41eb5b087c
-  data.tar.gz: 88a33d40ab0aa9e71048c73c765a250c60d559eda2619f483c1800bec48d4ba7
+  metadata.gz: 6d18a5f649a8f64234f0ca36681d7700bc82c6f92d6f92fb7de5a15a3e0c9a75
+  data.tar.gz: 445016807c2bb1f53192df312f86e8da65948e2c5f634f16cb5fd91fcd49df10
 SHA512:
-  metadata.gz: bf1356f4e184640cf4b8f13198dca65469cf653228b1a9679dfce3da82ab0de9f236f81d85e01d3b11d3fd27e8dd472345a09aebf9111df207dc233c27acecb4
-  data.tar.gz: f67b5df2e8b5c6849b9fe826bee87b594bd4dcc351da1c640b0f3a637c106875e6160097f4e3a783abdfa9896df18b4813294dba6e94a81c914daebeb3d36f24
+  metadata.gz: c2150dfc89eae6d2a403151bcc6d4e1e683733225702cbd7e51cb2f6fc7d90e1e3b25504b2536d14a03fa629acb1fa4a8a093e6c45d72964feec43eac367fa94
+  data.tar.gz: 5051e0ec6e22438ada2b92729c64465b307201d0baf60a996627cf429efa2fbdb246ce602eeb627a29db60362bbd65944195d7ef46a7ef89880b052770572cbc

data/CHANGES.md

@@ -1,3 +1,10 @@
+## 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.
+* Added the set_app_property_file singleton method.
+* Changed the deregister method to return the url.
+* Minor refactoring of callback procs.
+
 ## 0.0.2 - 12-Oct-2022
 * Fixed the parse_service_url singleton method. The underlying SLPSrvURL
   struct is now a managed struct.

data/lib/rslp.rb

@@ -11,7 +11,7 @@ module OpenSLP
     extend OpenSLP::Functions
 
     # The version of the rslp library.
-    VERSION = '0.0.2'.freeze
+    VERSION = '0.1.0'.freeze
 
     # Internal error raised whenever an openslp function fails.
     class Error < StandardError; end
@@ -33,22 +33,30 @@ module OpenSLP
     # the underlying handle is set to handle asynchronous operations or not. By
     # default this value is false.
     #
+    # 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
+    # from # which service is requested. For multicast, use a comma separated list of
+    # Hostnames/IP addresses.
+    #
     # If a block is given, then the object itself is yielded to the block, and
     # it is automatically closed at the end of the block.
     #
     # Examples:
     #
-    #   OpenSLP::SLP.new('en-us') do |slp|
+    #   # Block form
+    #   OpenSLP::SLP.new(lang: 'en-us', async: false, host: 'localhost') do |slp|
     #     # ... do stuff
     #   end
     #
-    #   slp = OpenSLP::SLP.new('en-us')
+    #   # Non-block form
+    #   slp = OpenSLP::SLP.new(lang: 'en-us')
     #   # Do stuff
     #   slp.close
     #
-    def initialize(lang = '', async = false)
+    def initialize(lang: '', async: false, host: nil)
       @lang = lang
       @async = async
+      @host = host
 
       ptr = FFI::MemoryPointer.new(:ulong)
 
@@ -57,6 +65,16 @@ module OpenSLP
 
       @handle = ptr.read_ulong
 
+      if @host
+        if @host.split(',').size > 1
+          result = SLPAssociateIFList(@handle, @host)
+          raise Error, "SLPAssociateIFList(): #{result}" if result != :SLP_OK
+        else
+          result = SLPAssociateIP(@handle, @host)
+          raise Error, "SLPAssociateIP(): #{result}" if result != :SLP_OK
+        end
+      end
+
       if block_given?
         begin
           yield self
@@ -90,7 +108,7 @@ module OpenSLP
       options[:attributes] ||= ""
       options[:fresh] ||= true
 
-      options[:callback] ||= Proc.new{ |hslp, err, cookie| }
+      options[:callback] ||= Proc.new{ |_hslp, err, _cookie| }
 
       if options[:attributes] && options[:attributes] != ""
         attributes = options[:attributes].map{ |k,v| "(#{k}=#{v})" }.join(',')
@@ -124,7 +142,7 @@ module OpenSLP
     # is registered and all language locales.
     #
     def deregister(url)
-      callback = Proc.new{ |hslp, err, cookie| }
+      callback = Proc.new{ |_hslp, err, _cookie| }
 
       begin
         cookie = FFI::MemoryPointer.new(:void)
@@ -134,7 +152,7 @@ module OpenSLP
         cookie.free unless cookie.null?
       end
 
-      true
+      url
     end
 
     # Deletes specified attributes from a registered service. The attributes
@@ -188,12 +206,15 @@ 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.
+    #
     def find_services(type, scope = '', filter = '')
       arr = []
 
-      callback = Proc.new{ |hslp, url, life, err, cook|
+      callback = Proc.new{ |_hslp, url, lifetime, err, _cookie|
         if err == SLP_OK
-          arr << {url => life}
+          arr << {url => lifetime}
           true
         else
           false
@@ -225,7 +246,7 @@ module OpenSLP
     def find_service_types(auth = '*', scope = '')
       arr = []
 
-      callback = Proc.new{ |hslp, types, err, cookie|
+      callback = Proc.new{ |_hslp, types, err, _cookie|
         if err == SLP_OK
           arr << types
           true
@@ -237,7 +258,7 @@ module OpenSLP
       begin
         cookie = FFI::MemoryPointer.new(:void)
         result = SLPFindSrvTypes(@handle, auth, scope, callback, cookie)
-        raise Error, "SLPFindSrvs(): #{result}" if result != :SLP_OK
+        raise Error, "SLPFindSrvTypes(): #{result}" if result != :SLP_OK
       ensure
         cookie.free unless cookie.null?
       end
@@ -253,7 +274,7 @@ module OpenSLP
     def find_service_attributes(url, attrs = '', scope = '')
       arr = []
 
-      callback = Proc.new{ |hslp, attrlist, err, cookie|
+      callback = Proc.new{ |_hslp, attrlist, err, _cookie|
         if err == SLP_OK
           arr << attrlist
           true
@@ -350,5 +371,17 @@ module OpenSLP
 
       str
     end
+
+    # Set the application-specific configuration file full path name.
+    #
+    # The contents of this property file will override the contents of the
+    # default or global UA configuration file (usually /etc/slp.conf or
+    # C:\windows\slp.conf).
+    #
+    def self.set_app_property_file(path)
+      result = SLPSetAppPropertyFile(string)
+      raise Error, "SLPSetAppPropertyFile(): #{result}" if result != :SLP_OK
+      path
+    end
   end
 end

data/lib/slp/functions.rb

@@ -49,10 +49,12 @@ module OpenSLP
     callback :SLPAttrCallback, [:handle, :string, :int, :pointer], :bool
     callback :SLPRegReportCallback, [:handle, :int, :pointer], :void
 
+    attach_function :SLPAssociateIFList, [:handle, :string], SLPError
+    attach_function :SLPAssociateIP, [:handle, :string], SLPError
     attach_function :SLPClose, [:handle], :void
-    attach_function :SLPEscape, [:string, :pointer, :bool], SLPError
     attach_function :SLPDelAttrs, [:handle, :string, :string, :SLPRegReportCallback, :pointer], SLPError
     attach_function :SLPDereg, [:handle, :string, :SLPRegReportCallback, :pointer], SLPError
+    attach_function :SLPEscape, [:string, :pointer, :bool], SLPError
 
     attach_function :SLPFindAttrs,
       [:handle, :string, :string, :string, :SLPAttrCallback, :pointer], SLPError
@@ -74,6 +76,7 @@ module OpenSLP
     attach_function :SLPReg,
       [:handle, :string, :ushort, :string, :string, :bool, :SLPRegReportCallback, :pointer], SLPError
 
+    attach_function :SLPSetAppPropertyFile, [:string], SLPError
     attach_function :SLPSetProperty, [:string, :string], :void
     attach_function :SLPUnescape, [:string, :pointer, :bool], SLPError
   end

data/rslp.gemspec

@@ -3,7 +3,7 @@ require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name       = 'rslp'
-  spec.version    = '0.0.2'
+  spec.version    = '0.1.0'
   spec.license    = 'Apache-2.0'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'

data/spec/rslp_spec.rb

@@ -9,12 +9,12 @@ require 'rslp'
 RSpec.describe OpenSLP::SLP do
   before do
     @lang = 'en-us'
-    @slp = described_class.new(@lang, false)
+    @slp = described_class.new(lang: @lang, async: false, host: 'localhost')
   end
 
   context "version" do
     example "version is set to the expected value" do
-      expect(described_class::VERSION).to eq('0.0.2')
+      expect(described_class::VERSION).to eq('0.1.0')
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rslp
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2022-10-13 00:00:00.000000000 Z
+date: 2022-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.16
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Interface for the OpenSLP library