rslp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ef8e7db15adf1f9e15979f07caecad8051e01084a4aeb215351adfcc97eb7335
+  data.tar.gz: 208805a618c7b3b278513fd7bb8fa7945e3b3b61ef4f8696eeb565eb1008c04f
+SHA512:
+  metadata.gz: dd5c483bb96f5866adcf971a86551f441a3ed2046fc1a7b245ccfbda979cbccd5bee7525deafdf98a5244c8c7f3c20012b0c1a99f1aa339ee756d1749f91675d
+  data.tar.gz: 1c4293e328733ecc6dbbfcf92574ac8c671fe7f31eb1458643c03b8975125ce57ef967543fcb53a92677e8c0001103644b47036e1fb47d98faef53d76eeb5897

data.tar.gz.sig

@@ -0,0 +1,2 @@
+��@�!�]�P��G��n�ыYE�D��g�T����5�ׯ(���߆P�(MN��8Ѩ:�S(��)1�!I?
+HXs�����=?��c���h�+狓|���2Q�u7�c���:��f�M���k������Б�s4nh�r$C:��|�K������$��u

data/CHANGES.md

@@ -0,0 +1,2 @@
+## 0.0.1 - 2-Jul-2021
+* Initial release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/MANIFEST.md

@@ -0,0 +1,14 @@
+CHANGES.md
+Gemfile
+LICENSE
+MANIFEST.md
+README.md
+rslp.gemspec
+Rakefile
+certs/djberg96_pub.pem
+lib/rslp.rb
+lib/slp/constants.rb
+lib/slp/functions.rb
+lib/slp/helper.rb
+lib/slp/structs.rb
+spec/rslp_spec.rb

data/README.md

@@ -0,0 +1,47 @@
+## Description
+A Ruby wrapper for OpenSLP using FFI.
+
+## Installation
+`gem install rslp`
+
+## Synopsis
+```ruby
+require 'rslp'
+
+OpenSLP::SLP.new do |slp|
+  # See docs for more methods
+  p slp.find_services
+  p slp.find_scopes
+end
+```
+
+## Known Bugs
+None that I'm aware of. Please report bugs on the project page at:
+
+https://github.com/djberg96/rslp
+
+## Future Plans
+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.
+
+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.
+
+## License
+Apache-2.0
+
+## Copyright
+(C) 2003-2021 Daniel J. Berger, All Rights Reserved
+
+## Warranty
+This package is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantability and fitness for a particular purpose.
+
+## Author
+Daniel J. Berger

data/Rakefile

@@ -0,0 +1,25 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rake/clean'
+
+CLEAN.include('**/*.gem', '**/*.rbc', '**/*.rbx', '**/*.lock')
+
+namespace 'gem' do
+  desc "Create the sys-cpu gem"
+  task :create => [:clean] do
+    require 'rubygems/package'
+    spec = Gem::Specification.load('rslp.gemspec')
+    spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
+    Gem::Package.build(spec)
+  end
+
+  desc "Install the sys-cpu gem"
+  task :install => [:create] do
+    file = Dir["*.gem"].first
+    sh "gem install -l #{file}"
+  end
+end
+
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/certs/djberg96_pub.pem

@@ -0,0 +1,26 @@
+-----BEGIN CERTIFICATE-----
+MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
+cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
+MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
+ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+/3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
+-----END CERTIFICATE-----

data/lib/rslp.rb

@@ -0,0 +1,346 @@
+require_relative 'slp/functions'
+require_relative 'slp/constants'
+require_relative 'slp/structs'
+require_relative 'slp/helper'
+
+module OpenSLP
+  class SLP
+    include OpenSLP::Functions
+    include OpenSLP::Constants
+    include OpenSLP::Structs
+    extend OpenSLP::Functions
+
+    # The version of the rslp library.
+    VERSION = '0.0.1'.freeze
+
+    # The language tag for requests.
+    attr_reader :lang
+
+    # Returns whether or not the SLP instance is asynchronous.
+    attr_reader :async
+
+    # Creates and returns an OpenSLP::SLP object. This establishes a handle
+    # that is used for the life of the object.
+    #
+    # The +lang+ argument may be an RFC 1766 language tag, e.g. 'en-us', that
+    # sets the natural language local for requests. By default it uses your
+    # 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
+    # default this value is false.
+    #
+    # 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|
+    #     # ... do stuff
+    #   end
+    #
+    #   slp = OpenSLP::SLP.new('en-us')
+    #   # Do stuff
+    #   slp.close
+    #
+    def initialize(lang = '', async = false)
+      @lang = lang
+      @async = async
+
+      ptr = FFI::MemoryPointer.new(:ulong)
+
+      if SLPOpen(lang, async, ptr) != SLP_OK
+        raise SystemCallError.new('SLPOpen', FFI.errno)
+      end
+
+      @handle = ptr.read_ulong
+
+      if block_given?
+        begin
+          yield self
+        ensure
+          close
+        end
+      end
+    end
+
+    # Close the OpenSLP::SLP object. The block form of the constructor will
+    # automatically call this for you.
+    #
+    def close
+      SLPClose(@handle)
+    end
+
+    # Register a :url for the given :lifetime. You may also specify a hash
+    # of :attributes, specify whether or not this is a :fresh service.
+    #
+    # The lifetime defaults to SLP_LIFETIME_DEFAULT.
+    #
+    # The attributes defaults to an empty string. Note that the has you provide
+    # automatically converts the attributes into the appropriate format.
+    #
+    # By default it will be considered a fresh service.
+    #
+    # Returns the url if successful.
+    #
+    def register(options = {})
+      options[:lifetime] ||= SLP_LIFETIME_DEFAULT
+      options[:attributes] ||= ""
+      options[:fresh] ||= true
+
+      options[:callback] ||= Proc.new{ |hslp, err, cookie| }
+
+      if options[:attributes] && options[:attributes] != ""
+        attributes = options[:attributes].map{ |k,v| "(#{k}=#{v})" }.join(',')
+      else
+        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
+
+      options[:url]
+    end
+
+    # Deregisters the advertisement for +url+ in all scopes where the service
+    # is registered and all language locales.
+    #
+    def deregister(url)
+      callback = Proc.new{ |hslp, err, cookie| }
+      cookie = FFI::MemoryPointer.new(:void)
+
+      result = SLPDereg(@handle, url, callback, cookie)
+      raise SystemCallError.new('SLPDereg', result) if result != SLP_OK
+
+      true
+    end
+
+    # Deletes specified attributes from a registered service. The attributes
+    # argument should be a comma separated list (in string form) of attribute
+    # ids.
+    #
+    # Returns the list of deleted attributes if successful.
+    #
+    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
+
+      attributes
+    end
+
+    # Returns a list of scopes. The most desirable values are always first in
+    # the list. There is always at least one value ("DEFAULT") in the list.
+    #
+    def find_scopes
+      begin
+        pptr = FFI::MemoryPointer.new(:pointer, 128)
+
+        rv = SLPFindScopes(@handle, pptr)
+
+        if rv != SLP_OK
+          raise SystemCallError.new('SLPFindScopes', rv)
+        end
+
+        arr = pptr.read_array_of_string
+      ensure
+        SLPFree(pptr.read_pointer)
+        pptr.free
+      end
+
+      arr
+    end
+
+    # Issue a query for services.
+    #
+    # The +type+ argument is the service type string, including the authority
+    # string, for the request. It may not be nil or empty.
+    #
+    # The +scope+ argument is a comma separated list of scope names. May be an
+    # empty string if you wish to use scopes this machine is configured for.
+    #
+    # A query formulated of attribute pattern matching expressions in the
+    # form of an LDAP search filter. The default is an empty string, which
+    # will gather all services of the requested type.
+    #
+    def find_services(type, scope = '', filter = '')
+      arr = []
+
+      callback = Proc.new{ |hslp, url, life, err, cook|
+        if err == SLP_OK
+          arr << {url => life}
+          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)
+      end
+
+      arr
+    end
+
+    # The find_service_types method issues an SLP service type request for
+    # service types indicated by the scope parameter, limited by the naming
+    # authority +auth+.
+    #
+    # The default naming authority is '*', i.e. all naming authorities. A
+    # blank string will result in the default naming authority of IANA.
+    #
+    # A blank +scope+ parameter will use scopes this machine is configured for.
+    #
+    # Returns an array of service type names.
+    #
+    def find_service_types(auth = '*', scope = '')
+      arr = []
+
+      callback = Proc.new{ |hslp, types, err, cookie|
+        if err == SLP_OK
+          arr << types
+          true
+        else
+          false
+        end
+      }
+
+      cookie = FFI::MemoryPointer.new(:void)
+
+      rv = SLPFindSrvTypes(@handle, auth, scope, callback, cookie)
+
+      if rv != SLP_OK
+        raise SystemCallError.new('SLPFindSrvs', rv)
+      end
+
+      arr
+    end
+
+    # Return a list of service attributes matching the +attrs+ for the
+    # indicated service +url+ using the given +scope+.
+    #
+    # A blank +scope+ parameter will use scopes this machine is configured for.
+    #
+    def find_service_attributes(url, attrs = '', scope = '')
+      arr = []
+
+      callback = Proc.new{ |hslp, attrlist, err, cookie|
+        if err == SLP_OK
+          arr << attrlist
+          true
+        else
+          false
+        end
+      }
+
+      cookie = FFI::MemoryPointer.new(:void)
+
+      rv = SLPFindAttrs(@handle, url, scope, attrs, callback, cookie)
+
+      if rv != SLP_OK
+        raise SystemCallError.new('SLPFindSrvs', rv)
+      end
+
+      arr
+    end
+
+    # Singleton methods
+
+    # Returns the minimum refresh interval that will be accepted by all SLP
+    # agents on the network. If no agents advertise a minimum refresh interval
+    # then zero is returned, though that is not a valid lifetime parameter to
+    # other methods.
+    #
+    def self.refresh_interval
+      SLPGetRefreshInterval()
+    end
+
+    # Returns the value of the SLP property +name+.
+    #
+    def self.get_property(name)
+      SLPGetProperty(name)
+    end
+
+    # Sets the value of the SLP property +prop+ to +name+.
+    #
+    def self.set_property(prop, name)
+      SLPSetProperty(prop, name)
+      name
+    end
+
+    # Parses a Service URL string and returns SLPSrvURL struct.
+    #
+    def self.parse_service_url(url)
+      begin
+        pptr = FFI::MemoryPointer.new(SLPSrvURL)
+
+        if SLPParseSrvURL(url, pptr) != SLP_OK
+          raise SystemCallError.new('SLPParseSrvURL', FFI.errno)
+        end
+
+        ptr = pptr.read_pointer
+        struct = SLPSrvURL.new(ptr)
+      ensure
+        SLPFree(ptr)
+      end
+
+      struct
+    end
+
+    # Process the +string+ to escape any SLP reserved characters. If the
+    # +istag_ parameter is true then it will look for bad tag characters.
+    #
+    def self.escape_reserved(string, istag = true)
+      begin
+        pptr = FFI::MemoryPointer.new(:pointer)
+
+        if SLPEscape(string, pptr, istag) != SLP_OK
+          raise SystemCallError.new('SLPEscape', FFI.errno)
+        end
+
+        str = pptr.read_pointer.read_string
+      ensure
+        SLPFree(pptr.read_pointer)
+      end
+
+      str
+    end
+
+    # Process the +string+ to unescape any SLP reserved characters. If the
+    # +istag_ parameter is true then it will look for bad tag characters.
+    #
+    def self.unescape_reserved(string, istag = true)
+      begin
+        pptr = FFI::MemoryPointer.new(:pointer)
+
+        if SLPUnescape(string, pptr, istag) != SLP_OK
+          raise SystemCallError.new('SLPEscape', FFI.errno)
+        end
+
+        str = pptr.read_pointer.read_string
+      ensure
+        SLPFree(pptr.read_pointer)
+      end
+
+      str
+    end
+  end
+end

data/lib/slp/constants.rb

@@ -0,0 +1,13 @@
+module OpenSLP
+  module Constants
+    SLP_OK = 0
+
+    SLP_LIFETIME_DEFAULT = 10800
+    SLP_LIFETIME_MAXIMUM = 65535
+
+    SLP_FALSE = 0
+    SLP_TRUE  = 1
+
+    SLP_LAST_CALL = 1
+  end
+end

data/lib/slp/functions.rb

@@ -0,0 +1,54 @@
+require 'ffi'
+
+module OpenSLP
+  module Functions
+    extend FFI::Library
+
+    # Look for either slp or libslip
+    begin
+      ffi_lib :libslp
+    rescue LoadError
+      begin
+        ffi_lib :slp
+      rescue LoadError
+        if File::ALT_SEPARATOR
+          ffi_lib "C:/Program Files (x86)/OpenSLP/slp"
+        else
+          raise
+        end
+      end
+    end
+
+    typedef :ulong, :handle
+
+    callback :SLPSrvURLCallback, [:handle, :string, :ushort, :int, :pointer], :bool
+    callback :SLPSrvTypeCallback, [:handle, :string, :int, :pointer], :bool
+    callback :SLPAttrCallback, [:handle, :string, :int, :pointer], :bool
+    callback :SLPRegReportCallback, [:handle, :int, :pointer], :void
+
+    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 :SLPFindAttrs,
+      [:handle, :string, :string, :string, :SLPAttrCallback, :pointer], :int
+
+    attach_function :SLPFindScopes, [:handle, :pointer], :int
+
+    attach_function :SLPFindSrvs,
+      [:handle, :string, :string, :string, :SLPSrvURLCallback, :pointer], :int
+
+    attach_function :SLPFindSrvTypes,
+      [:handle, :string, :string, :SLPSrvTypeCallback, :pointer], :int
+
+    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 :SLPSetProperty, [:string, :string], :void
+    attach_function :SLPUnescape, [:string, :pointer, :bool], :int
+  end
+end

data/lib/slp/helper.rb

@@ -0,0 +1,16 @@
+require 'ffi'
+
+class FFI::Pointer
+  def read_array_of_string
+    elements = []
+
+    loc = self
+
+    until ((element = loc.read_pointer).null?)
+     elements << element.read_string
+     loc += FFI::Type::POINTER.size
+    end
+
+    elements
+  end
+end

data/lib/slp/structs.rb

@@ -0,0 +1,15 @@
+require 'ffi'
+
+module OpenSLP
+  module Structs
+    class SLPSrvURL < FFI::Struct
+      layout(
+        :s_pcSrvType, :string,
+        :s_pcHost, :string,
+        :s_iPort, :int,
+        :s_pcNetFamily, :string,
+        :s_pcSrvPart, :string
+      )
+    end
+  end
+end

data/rslp.gemspec

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'rbconfig'
+
+Gem::Specification.new do |spec|
+  spec.name       = 'rslp'
+  spec.version    = '0.0.1'
+  spec.license    = 'Apache-2.0'
+  spec.author     = 'Daniel J. Berger'
+  spec.email      = 'djberg96@gmail.com'
+  spec.homepage   = 'https://github.com/djberg96/rslp'
+  spec.summary    = 'Interface for the OpenSLP library'
+  spec.test_files = Dir['spec/*.rb']
+  spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
+  spec.cert_chain = ['certs/djberg96_pub.pem']
+
+  spec.extra_rdoc_files  = ['README.md', 'CHANGES.md', 'MANIFEST.md', 'LICENSE']
+
+  spec.add_dependency('ffi', "~> 1.1")
+
+  spec.add_development_dependency('rake')
+  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'
+  }
+
+  spec.description = <<-EOF
+    The rslp library is an FFI interface for the OpenSLP service
+    location protocol library.
+  EOF
+end

data/spec/rslp_spec.rb

@@ -0,0 +1,76 @@
+########################################################################
+# rslp_spec.rb
+#
+# Test suite for the rslp library.
+########################################################################
+require 'rspec'
+require 'rslp'
+
+describe OpenSLP::SLP do
+  before do
+    @lang = 'en-us'
+    @slp = OpenSLP::SLP.new(@lang, false)
+  end
+
+  context "version" do
+    example "version is set to the expected value" do
+      expect(OpenSLP::SLP::VERSION).to eq('0.0.1')
+    end
+  end
+
+  context "constructor" do
+    example "defaults to an empty string if no lang is provided" do
+      expect(OpenSLP::SLP.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
+    end
+
+    example "sets attributes to expected values" do
+      expect(@slp.lang).to eq(@lang)
+      expect(@slp.async).to be false
+    end
+  end
+
+  context "singleton methods" do
+    example "defines a refresh_interval method" do
+      expect(OpenSLP::SLP).to respond_to(:refresh_interval)
+    end
+
+    example "returns the expected value for refresh_interval" do
+      expect(OpenSLP::SLP.refresh_interval).to eq(0)
+    end
+
+    example "defines a get_property method" do
+      expect(OpenSLP::SLP).to respond_to(:get_property)
+    end
+
+    example "defines a set_property method" do
+      expect(OpenSLP::SLP).to respond_to(:set_property)
+    end
+
+    example "defines a parse_service_url method" do
+      expect(OpenSLP::SLP).to respond_to(:parse_service_url)
+    end
+
+    example "defines a escape_reserved method" do
+      expect(OpenSLP::SLP).to respond_to(:escape_reserved)
+    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)
+    end
+
+    example "defines a unescape_reserved method" do
+      expect(OpenSLP::SLP).to respond_to(:unescape_reserved)
+    end
+  end
+
+  after do
+    @slp.close if @slp
+    @slp = nil
+    @lang = nil
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: rslp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel J. Berger
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
+  cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
+  ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+  A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+  u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+  75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+  6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+  iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+  ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+  74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+  058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+  HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+  AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+  YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+  /3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+  h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+  6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+  ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+  1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+  DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+  ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+  WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
+  -----END CERTIFICATE-----
+date: 2021-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: |2
+      The rslp library is an FFI interface for the OpenSLP service
+      location protocol library.
+email: djberg96@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGES.md
+- MANIFEST.md
+- LICENSE
+files:
+- CHANGES.md
+- Gemfile
+- LICENSE
+- MANIFEST.md
+- README.md
+- Rakefile
+- certs/djberg96_pub.pem
+- lib/rslp.rb
+- lib/slp/constants.rb
+- lib/slp/functions.rb
+- lib/slp/helper.rb
+- lib/slp/structs.rb
+- rslp.gemspec
+- spec/rslp_spec.rb
+homepage: https://github.com/djberg96/rslp
+licenses:
+- Apache-2.0
+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
+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: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Interface for the OpenSLP library
+test_files:
+- spec/rslp_spec.rb

metadata.gz.sig

@@ -0,0 +1,2 @@
+"��y��b�i�	o�[Zb�S��D�Y�@P,k���̘�����K
+�V��A��/�ɢ�`L��^�4kw`m<D�6��2�R�h<ѩ���	��0���j��c2�k��ҹ�0u�S�0�ۃ<��c�44�)��cK�]k�f��dt]�C}.;Cs����YYX����x���c��?C�