rslp 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef8e7db15adf1f9e15979f07caecad8051e01084a4aeb215351adfcc97eb7335
-  data.tar.gz: 208805a618c7b3b278513fd7bb8fa7945e3b3b61ef4f8696eeb565eb1008c04f
+  metadata.gz: 6d18a5f649a8f64234f0ca36681d7700bc82c6f92d6f92fb7de5a15a3e0c9a75
+  data.tar.gz: 445016807c2bb1f53192df312f86e8da65948e2c5f634f16cb5fd91fcd49df10
 SHA512:
-  metadata.gz: dd5c483bb96f5866adcf971a86551f441a3ed2046fc1a7b245ccfbda979cbccd5bee7525deafdf98a5244c8c7f3c20012b0c1a99f1aa339ee756d1749f91675d
-  data.tar.gz: 1c4293e328733ecc6dbbfcf92574ac8c671fe7f31eb1458643c03b8975125ce57ef967543fcb53a92677e8c0001103644b47036e1fb47d98faef53d76eeb5897
+  metadata.gz: c2150dfc89eae6d2a403151bcc6d4e1e683733225702cbd7e51cb2f6fc7d90e1e3b25504b2536d14a03fa629acb1fa4a8a093e6c45d72964feec43eac367fa94
+  data.tar.gz: 5051e0ec6e22438ada2b92729c64465b307201d0baf60a996627cf429efa2fbdb246ce602eeb627a29db60362bbd65944195d7ef46a7ef89880b052770572cbc

data/CHANGES.md

@@ -1,2 +1,18 @@
+## 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.
+* Added some nicer method aliases to the SLPSrvURL struct.
+* Refactored the underlying C function wrappers to return an SLPError enum
+  to more closely align with the API.
+* Any internal function failures now raise an OpenSLP::SLP::Error instead
+  of a SystemCallError. The error message has also been improved.
+
 ## 0.0.1 - 2-Jul-2021
 * Initial release

data/Gemfile

@@ -1,3 +1,2 @@
-source 'https://rubygems.org' do
-  gemspec
-end
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -4,14 +4,18 @@ A Ruby wrapper for OpenSLP using FFI.
 ## Installation
 `gem install rslp`
 
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/rslp/main/certs/djberg96_pub.pem)`
+
 ## Synopsis
 ```ruby
 require 'rslp'
 
+# See docs for more methods
 OpenSLP::SLP.new do |slp|
-  # See docs for more methods
-  p slp.find_services
+  p slp.find_services('myservice:myorg')
   p slp.find_scopes
+  p slp.find_service_types
 end
 ```
 
@@ -25,18 +29,19 @@ None at this time.
 
 ## Maintenance
 Please contact me about taking over maintenance of this library if you are
-interested. I'm not actually using it myself, and have no real plans to update
-it.
+interested. I'm not actually using it myself, so maintenance and releases
+will be sporadic at best.
 
 Why then? I originally wrote most of this when I thought we might need it
 for a project at work. That never materialized, but I hated to let it go to
-waste, so I've published what I completed.
+waste, so I've published what I completed and may occasionally tinker with
+it from time to time.
 
 ## License
 Apache-2.0
 
 ## Copyright
-(C) 2003-2021 Daniel J. Berger, All Rights Reserved
+(C) 2003-2022 Daniel J. Berger, All Rights Reserved
 
 ## Warranty
 This package is provided "as is" and without any express or

data/lib/rslp.rb

@@ -11,7 +11,10 @@ module OpenSLP
     extend OpenSLP::Functions
 
     # The version of the rslp library.
-    VERSION = '0.0.1'.freeze
+    VERSION = '0.1.0'.freeze
+
+    # Internal error raised whenever an openslp function fails.
+    class Error < StandardError; end
 
     # The language tag for requests.
     attr_reader :lang
@@ -27,34 +30,51 @@ module OpenSLP
     # machine's locale.
     #
     # The +async+ argument may be set to true or false and establishes whether
-    # the underlying handle is set to handl asynchronous operations or not. By
+    # 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)
 
-      if SLPOpen(lang, async, ptr) != SLP_OK
-        raise SystemCallError.new('SLPOpen', FFI.errno)
-      end
+      result = SLPOpen(lang, async, ptr)
+      raise Error, "SLPOpen(): #{result}" if result != :SLP_OK
 
       @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
@@ -88,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(',')
@@ -96,20 +116,24 @@ module OpenSLP
         attributes = ""
       end
 
-      cookie = FFI::MemoryPointer.new(:void)
-
-      result = SLPReg(
-        @handle,
-        options[:url],
-        options[:lifetime],
-        nil,
-        attributes,
-        options[:fresh],
-        options[:callback],
-        cookie
-      )
-
-      raise SystemCallError.new('SLPReg', result) if result != SLP_OK
+      begin
+        cookie = FFI::MemoryPointer.new(:void)
+
+        result = SLPReg(
+          @handle,
+          options[:url],
+          options[:lifetime],
+          nil,
+          attributes,
+          options[:fresh],
+          options[:callback],
+          cookie
+        )
+
+        raise Error, "SLPReg(): #{result}" if result != :SLP_OK
+      ensure
+        cookie.free unless cookie.null?
+      end
 
       options[:url]
     end
@@ -118,13 +142,17 @@ module OpenSLP
     # is registered and all language locales.
     #
     def deregister(url)
-      callback = Proc.new{ |hslp, err, cookie| }
-      cookie = FFI::MemoryPointer.new(:void)
+      callback = Proc.new{ |_hslp, err, _cookie| }
 
-      result = SLPDereg(@handle, url, callback, cookie)
-      raise SystemCallError.new('SLPDereg', result) if result != SLP_OK
+      begin
+        cookie = FFI::MemoryPointer.new(:void)
+        result = SLPDereg(@handle, url, callback, cookie)
+        raise Error, "SLPDereg(): #{result}" if result != :SLP_OK
+      ensure
+        cookie.free unless cookie.null?
+      end
 
-      true
+      url
     end
 
     # Deletes specified attributes from a registered service. The attributes
@@ -135,10 +163,14 @@ module OpenSLP
     #
     def delete_service_attributes(url, attributes)
       callback = Proc.new{ |hslp, err, cookie| }
-      cookie = FFI::MemoryPointer.new(:void)
 
-      result = SLPDelAttrs(@handle, url, attributes, callback, cookie)
-      raise SystemCallError.new('SLPDelAttrs', result) if result != SLP_OK
+      begin
+        cookie = FFI::MemoryPointer.new(:void)
+        result = SLPDelAttrs(@handle, url, attributes, callback, cookie)
+        raise Error, "SLPDelAttrs(): #{result}" if result != :SLP_OK
+      ensure
+        cookie.free unless cookie.null?
+      end
 
       attributes
     end
@@ -150,16 +182,13 @@ module OpenSLP
       begin
         pptr = FFI::MemoryPointer.new(:pointer, 128)
 
-        rv = SLPFindScopes(@handle, pptr)
-
-        if rv != SLP_OK
-          raise SystemCallError.new('SLPFindScopes', rv)
-        end
+        result = SLPFindScopes(@handle, pptr)
+        raise Error, "SLPFindScopes(): #{result}" if result != :SLP_OK
 
         arr = pptr.read_array_of_string
       ensure
         SLPFree(pptr.read_pointer)
-        pptr.free
+        pptr.free unless pptr.null?
       end
 
       arr
@@ -177,24 +206,27 @@ 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
         end
       }
 
-      cookie = FFI::MemoryPointer.new(:void)
-
-      rv = SLPFindSrvs(@handle, type, scope, filter, callback, cookie)
-
-      if rv != SLP_OK
-        raise SystemCallError.new('SLPFindSrvs', rv)
+      begin
+        cookie = FFI::MemoryPointer.new(:void)
+        result = SLPFindSrvs(@handle, type, scope, filter, callback, cookie)
+        raise Error, "SLPFindSrvs(): #{result}" if result != :SLP_OK
+      ensure
+        cookie.free unless cookie.null?
       end
 
       arr
@@ -214,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
@@ -223,12 +255,12 @@ module OpenSLP
         end
       }
 
-      cookie = FFI::MemoryPointer.new(:void)
-
-      rv = SLPFindSrvTypes(@handle, auth, scope, callback, cookie)
-
-      if rv != SLP_OK
-        raise SystemCallError.new('SLPFindSrvs', rv)
+      begin
+        cookie = FFI::MemoryPointer.new(:void)
+        result = SLPFindSrvTypes(@handle, auth, scope, callback, cookie)
+        raise Error, "SLPFindSrvTypes(): #{result}" if result != :SLP_OK
+      ensure
+        cookie.free unless cookie.null?
       end
 
       arr
@@ -242,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
@@ -251,12 +283,12 @@ module OpenSLP
         end
       }
 
-      cookie = FFI::MemoryPointer.new(:void)
-
-      rv = SLPFindAttrs(@handle, url, scope, attrs, callback, cookie)
-
-      if rv != SLP_OK
-        raise SystemCallError.new('SLPFindSrvs', rv)
+      begin
+        cookie = FFI::MemoryPointer.new(:void)
+        result = SLPFindAttrs(@handle, url, scope, attrs, callback, cookie)
+        raise Error, "SLPFindAttrs(): #{result}" if result != :SLP_OK
+      ensure
+        cookie.free unless cookie.null?
       end
 
       arr
@@ -292,14 +324,13 @@ module OpenSLP
       begin
         pptr = FFI::MemoryPointer.new(SLPSrvURL)
 
-        if SLPParseSrvURL(url, pptr) != SLP_OK
-          raise SystemCallError.new('SLPParseSrvURL', FFI.errno)
-        end
+        result = SLPParseSrvURL(url, pptr)
+        raise Error, "SLPParseSrvURL(): #{result}" if result != :SLP_OK
 
         ptr = pptr.read_pointer
         struct = SLPSrvURL.new(ptr)
       ensure
-        SLPFree(ptr)
+        pptr.free unless pptr.null?
       end
 
       struct
@@ -312,9 +343,8 @@ module OpenSLP
       begin
         pptr = FFI::MemoryPointer.new(:pointer)
 
-        if SLPEscape(string, pptr, istag) != SLP_OK
-          raise SystemCallError.new('SLPEscape', FFI.errno)
-        end
+        result = SLPEscape(string, pptr, istag)
+        raise Error, "SLPEscape(): #{result}" if result != :SLP_OK
 
         str = pptr.read_pointer.read_string
       ensure
@@ -331,9 +361,8 @@ module OpenSLP
       begin
         pptr = FFI::MemoryPointer.new(:pointer)
 
-        if SLPUnescape(string, pptr, istag) != SLP_OK
-          raise SystemCallError.new('SLPEscape', FFI.errno)
-        end
+        result = SLPUnescape(string, pptr, istag)
+        raise Error, "SLPUnescape(): #{result}" if result != :SLP_OK
 
         str = pptr.read_pointer.read_string
       ensure
@@ -342,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

@@ -19,6 +19,29 @@ module OpenSLP
       end
     end
 
+    SLPError = enum(
+      :SLP_LAST_CALL, 1,
+      :SLP_OK, 0,
+      :SLP_LANGUAGE_NOT_SUPPORTED, -1,
+      :SLP_PARSE_ERROR, -2,
+      :SLP_INVALID_REGISTRATION, -3,
+      :SLP_SCOPE_NOT_SUPPORTED, -4,
+      :SLP_AUTHENTICATION_ABSENT, -6,
+      :SLP_AUTHENTICATION_FAILED, -7,
+      :SLP_INVALID_UPDATE, -13,
+      :SLP_REFRESH_REJECTED, -15,
+      :SLP_NOT_IMPLEMENTED, -17,
+      :SLP_BUFFER_OVERFLOW, -18,
+      :SLP_NETWORK_TIMED_OUT, -19,
+      :SLP_NETWORK_INIT_FAILED, -20,
+      :SLP_MEMORY_ALLOC_FAILED, -21,
+      :SLP_PARAMETER_BAD, -22,
+      :SLP_NETWORK_ERROR, -23,
+      :SLP_INTERNAL_SYSTEM_ERROR, -24,
+      :SLP_HANDLE_IN_USE, -25,
+      :SLP_TYPE_ERROR, -26
+    )
+
     typedef :ulong, :handle
 
     callback :SLPSrvURLCallback, [:handle, :string, :ushort, :int, :pointer], :bool
@@ -26,29 +49,35 @@ 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], :int
-    attach_function :SLPDelAttrs, [:handle, :string, :string, :SLPRegReportCallback, :pointer], :int
-    attach_function :SLPDereg, [:handle, :string, :SLPRegReportCallback, :pointer], :int
+    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], :int
+      [:handle, :string, :string, :string, :SLPAttrCallback, :pointer], SLPError
 
-    attach_function :SLPFindScopes, [:handle, :pointer], :int
+    attach_function :SLPFindScopes, [:handle, :pointer], SLPError
 
     attach_function :SLPFindSrvs,
-      [:handle, :string, :string, :string, :SLPSrvURLCallback, :pointer], :int
+      [:handle, :string, :string, :string, :SLPSrvURLCallback, :pointer], SLPError
 
     attach_function :SLPFindSrvTypes,
-      [:handle, :string, :string, :SLPSrvTypeCallback, :pointer], :int
+      [:handle, :string, :string, :SLPSrvTypeCallback, :pointer], SLPError
 
     attach_function :SLPFree, [:pointer], :void
     attach_function :SLPGetProperty, [:string], :string
     attach_function :SLPGetRefreshInterval, [], :uint
-    attach_function :SLPOpen, [:string, :bool, :pointer], :handle
-    attach_function :SLPParseSrvURL, [:string, :pointer], :int
-    attach_function :SLPReg, [:handle, :string, :ushort, :string, :string, :bool, :SLPRegReportCallback, :pointer], :int
+    attach_function :SLPOpen, [:string, :bool, :pointer], SLPError
+    attach_function :SLPParseSrvURL, [:string, :pointer], SLPError
+
+    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], :int
+    attach_function :SLPUnescape, [:string, :pointer, :bool], SLPError
   end
 end

data/lib/slp/structs.rb

@@ -1,8 +1,10 @@
-require 'ffi'
+require_relative 'functions'
 
 module OpenSLP
   module Structs
-    class SLPSrvURL < FFI::Struct
+    class SLPSrvURL < FFI::ManagedStruct
+      extend OpenSLP::Functions
+
       layout(
         :s_pcSrvType, :string,
         :s_pcHost, :string,
@@ -10,6 +12,30 @@ module OpenSLP
         :s_pcNetFamily, :string,
         :s_pcSrvPart, :string
       )
+
+      def self.release(pointer)
+        SLPFree(pointer) unless pointer.null?
+      end
+
+      def service_type
+        self[:s_pcSrvType]
+      end
+
+      def host
+        self[:s_pcHost]
+      end
+
+      def port
+        self[:s_iPort]
+      end
+
+      def net_family
+        self[:s_pcNetFamily]
+      end
+
+      def url_remainder
+        self[:s_pcSrvPart]
+      end
     end
   end
 end

data/rslp.gemspec

@@ -3,7 +3,7 @@ require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name       = 'rslp'
-  spec.version    = '0.0.1'
+  spec.version    = '0.1.0'
   spec.license    = 'Apache-2.0'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
@@ -21,12 +21,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('rspec', "~> 3.9")
 
   spec.metadata = {
-    'homepage_uri'      => 'https://github.com/djberg96/rslp',
-    'bug_tracker_uri'   => 'https://github.com/djberg96/rslp/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/rslp/blob/main/CHANGES.md',
-    'documentation_uri' => 'https://github.com/djberg96/rslp/wiki',
-    'source_code_uri'   => 'https://github.com/djberg96/rslp',
-    'wiki_uri'          => 'https://github.com/djberg96/rslp/wiki'
+    'homepage_uri'          => 'https://github.com/djberg96/rslp',
+    'bug_tracker_uri'       => 'https://github.com/djberg96/rslp/issues',
+    'changelog_uri'         => 'https://github.com/djberg96/rslp/blob/main/CHANGES.md',
+    'documentation_uri'     => 'https://github.com/djberg96/rslp/wiki',
+    'source_code_uri'       => 'https://github.com/djberg96/rslp',
+    'wiki_uri'              => 'https://github.com/djberg96/rslp/wiki',
+    'rubygems_mfa_required' => 'true'
   }
 
   spec.description = <<-EOF

data/spec/rslp_spec.rb

@@ -6,25 +6,25 @@
 require 'rspec'
 require 'rslp'
 
-describe OpenSLP::SLP do
+RSpec.describe OpenSLP::SLP do
   before do
     @lang = 'en-us'
-    @slp = OpenSLP::SLP.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(OpenSLP::SLP::VERSION).to eq('0.0.1')
+      expect(described_class::VERSION).to eq('0.1.0')
     end
   end
 
   context "constructor" do
     example "defaults to an empty string if no lang is provided" do
-      expect(OpenSLP::SLP.new.lang).to eq('')
+      expect(described_class.new.lang).to eq('')
     end
 
     example "defaults to a false async value if no value is provided" do
-      expect(OpenSLP::SLP.new.async).to be false
+      expect(described_class.new.async).to be false
     end
 
     example "sets attributes to expected values" do
@@ -33,38 +33,81 @@ describe OpenSLP::SLP do
     end
   end
 
-  context "singleton methods" do
-    example "defines a refresh_interval method" do
-      expect(OpenSLP::SLP).to respond_to(:refresh_interval)
-    end
+  describe "singleton methods" do
+    context "refresh_interval" do
+      example "defines a refresh_interval method" do
+        expect(described_class).to respond_to(:refresh_interval)
+      end
 
-    example "returns the expected value for refresh_interval" do
-      expect(OpenSLP::SLP.refresh_interval).to eq(0)
+      example "returns the expected value for refresh_interval" do
+        expect(described_class.refresh_interval).to eq(0)
+      end
     end
 
     example "defines a get_property method" do
-      expect(OpenSLP::SLP).to respond_to(:get_property)
+      expect(described_class).to respond_to(:get_property)
     end
 
     example "defines a set_property method" do
-      expect(OpenSLP::SLP).to respond_to(:set_property)
+      expect(described_class).to respond_to(:set_property)
     end
 
-    example "defines a parse_service_url method" do
-      expect(OpenSLP::SLP).to respond_to(:parse_service_url)
-    end
+    context "parse_service_url" do
+      let(:valid_url) { "service:test.openslp://192.168.100.1:3003,en,65535" }
+
+      before do
+        @struct = described_class.parse_service_url(valid_url)
+      end
+
+      example "defines a parse_service_url method" do
+        expect(described_class).to respond_to(:parse_service_url)
+      end
+
+      example "does not raise an error if the url is valid" do
+        expect{ described_class.parse_service_url(valid_url) }.not_to raise_error
+      end
+
+      example "returns a struct with the expected service type" do
+        expect(@struct.service_type).to eq("service:test.openslp")
+      end
 
-    example "defines a escape_reserved method" do
-      expect(OpenSLP::SLP).to respond_to(:escape_reserved)
+      example "returns a struct with the expected host" do
+        expect(@struct.host).to eq("192.168.100.1")
+      end
+
+      example "returns a struct with the expected port" do
+        expect(@struct.port).to eq(3003)
+      end
+
+      example "returns a struct with the expected net family" do
+        expect(@struct.net_family).to eq("")
+      end
+
+      example "returns a struct with the expected url remainder" do
+        expect(@struct.url_remainder).to eq("")
+      end
     end
 
-    example "returns the expected value for the escape_reserved method" do
-      expected = "\\2Ctag-example\\2C"
-      expect(OpenSLP::SLP.escape_reserved(",tag-example,")).to eq(expected)
+    context "escape_reserved" do
+      example "defines a escape_reserved method" do
+        expect(described_class).to respond_to(:escape_reserved)
+      end
+
+      example "returns the expected value for the escape_reserved method" do
+        expected = "\\2Ctag-example\\2C"
+        expect(described_class.escape_reserved(",tag-example,")).to eq(expected)
+      end
     end
 
-    example "defines a unescape_reserved method" do
-      expect(OpenSLP::SLP).to respond_to(:unescape_reserved)
+    context "unescape_reserved" do
+      example "defines a unescape_reserved method" do
+        expect(described_class).to respond_to(:unescape_reserved)
+      end
+
+      example "returns the expected value for the unescape_reserved method" do
+        expected = ",tag-example,"
+        expect(described_class.unescape_reserved("\\2Ctag-example\\2C")).to eq(expected)
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rslp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  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: 2021-07-02 00:00:00.000000000 Z
+date: 2022-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -115,6 +115,7 @@ metadata:
   documentation_uri: https://github.com/djberg96/rslp/wiki
   source_code_uri: https://github.com/djberg96/rslp
   wiki_uri: https://github.com/djberg96/rslp/wiki
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -130,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Interface for the OpenSLP library