opn_api 0.1.0

data/lib/opn_api.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'opn_api/version'
+require_relative 'opn_api/errors'
+require_relative 'opn_api/logger'
+require_relative 'opn_api/client'
+require_relative 'opn_api/config'
+require_relative 'opn_api/normalize'
+require_relative 'opn_api/id_resolver'
+require_relative 'opn_api/service_reconfigure'
+require_relative 'opn_api/resource'
+require_relative 'opn_api/resource_registry'
+
+# Ruby client library for the OPNsense REST API.
+#
+# Provides HTTP client, UUID resolution, service reconfigure orchestration,
+# and OPNsense selection-hash normalization. Usable as a library or via
+# the opn-api CLI.
+module OpnApi
+  class << self
+    # Returns the module-level logger instance.
+    # @return [OpnApi::Logger]
+    def logger
+      @logger ||= OpnApi::Logger.new
+    end
+
+    # Sets a custom logger (e.g. for Puppet integration).
+    # Any object responding to #debug, #info, #notice, #warning, #error.
+    # @param logger [#debug, #info, #notice, #warning, #error]
+    attr_writer :logger
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: opn_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- markt-de
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-16 00:00:00.000000000 Z
+dependencies: []
+description: |
+  A standalone Ruby library and command-line tool for communicating with
+  OPNsense firewalls via their REST API. Features include UUID resolution
+  for ModelRelationField references, service reconfigure orchestration,
+  and OPNsense selection-hash normalization.
+email:
+- github-oss-noreply@markt.de
+executables:
+- opn-api
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/opn-api
+- lib/opn_api.rb
+- lib/opn_api/cli/commands/api.rb
+- lib/opn_api/cli/commands/backup.rb
+- lib/opn_api/cli/commands/base.rb
+- lib/opn_api/cli/commands/device.rb
+- lib/opn_api/cli/commands/plugin.rb
+- lib/opn_api/cli/commands/reconfigure.rb
+- lib/opn_api/cli/commands/resource.rb
+- lib/opn_api/cli/formatter.rb
+- lib/opn_api/cli/main.rb
+- lib/opn_api/client.rb
+- lib/opn_api/config.rb
+- lib/opn_api/errors.rb
+- lib/opn_api/id_resolver.rb
+- lib/opn_api/logger.rb
+- lib/opn_api/normalize.rb
+- lib/opn_api/resource.rb
+- lib/opn_api/resource_registry.rb
+- lib/opn_api/service_reconfigure.rb
+- lib/opn_api/version.rb
+homepage: https://github.com/markt-de/opn-api
+licenses:
+- BSD-2-Clause
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Ruby client library and CLI for the OPNsense REST API
+test_files: []