opn_api 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f4a5b4f37a74d43e959a0dde3c5933284713c2840e640d5398b638cb6092545
-  data.tar.gz: 15f1ce76e1ba52d46363022aeb405f860a838af32276a57155b5efeb1f074757
+  metadata.gz: 4849faffbc79c96ff2c9cd0b00d0b22ddb376fefc1179bef6759d87571becbce
+  data.tar.gz: 6b37d3cdb52fd5d71e4ad1a9daa1e01fd30a308344e49dad1be66016a26b3e9a
 SHA512:
-  metadata.gz: ae8a89720dfb7364ed49c6df05e87fd85cb9eca7bc5ba42f7cce4d9c8269e772ea4a21299a092dda352ad1d27c0fcc4da98b5d02d8222273a11e27e4698cac91
-  data.tar.gz: 9c607e3f96345a7f4544600f070084f63495b812fb5f5e4e57a551fb2b7a28e14b6eff33cc5cd6597edc348a0745f822a55c2bef98e13206b560ed6a4a6cc490
+  metadata.gz: 04a49796e1ab3bf2a1fdbe5eb01ad7d7487c7396e54d5a020480c7113925afb5a3dfbeb1cbe6cfc08d72929684e4d0e6f2e99bb4cdce473f9ab46e36f0de1928
+  data.tar.gz: 8c3cded6629294868dfce670e77fd724f099018b03859efd0540fb70eb09d72ed000802fb77565a2487a50a8939d3440fa51b609052f15bc29b43cdc3a0124d7

data/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## 0.1.0
+## [v1.0.0] - 2026-03-17
+
+### Added
+* Add GitHub Actions CI workflow
+
+### Fixed
+* Fix unit tests
+
+## v0.1.0 - 2026-03-16
 
 Initial release.
+
+[v1.0.0]: https://github.com/markt-de/opn-api/compare/v0.1.0...v1.0.0

data/README.md

@@ -928,7 +928,7 @@ results = OpnApi::ServiceReconfigure[:haproxy].run
 
 ### Config loader
 
-`OpnApi::Config` loads device credentials from YAML files with a hierarchical search path. Supports multiple devices and is compatible with puppet-opn's device file format.
+`OpnApi::Config` loads device credentials from YAML files with a hierarchical search path. Supports multiple devices and is compatible with [puppet-opn's](https://github.com/markt-de/puppet-opn) device file format.
 
 ### ID resolver
 

data/lib/opn_api/client.rb

@@ -13,7 +13,7 @@ module OpnApi
   #
   # @example Direct instantiation
   #   client = OpnApi::Client.new(
-  #     url: 'https://fw.example.com/api',
+  #     url: 'https://opnsense01.example.com/api',
   #     api_key: '+ABC...', api_secret: '+XYZ...',
   #     ssl_verify: false,
   #   )
@@ -21,12 +21,12 @@ module OpnApi
   #
   # @example From Config
   #   config = OpnApi::Config.new
-  #   client = config.client_for('myfw')
+  #   client = config.client_for('opnsense01')
   class Client
     DEFAULT_URL = 'http://localhost:80/api'
     MAX_REDIRECTS = 5
 
-    # @param url [String] Base URL of the OPNsense API (e.g. 'https://fw.example.com/api')
+    # @param url [String] Base URL of the OPNsense API (e.g. 'https://opnsense01.example.com/api')
     # @param api_key [String] OPNsense API key
     # @param api_secret [String] OPNsense API secret
     # @param ssl_verify [Boolean] Whether to verify SSL certificates (default: true)

data/lib/opn_api/config.rb

@@ -23,12 +23,12 @@ module OpnApi
   #
   # @example
   #   config = OpnApi::Config.new
-  #   config.device_names            # => ['myfw', 'backup']
-  #   client = config.client_for('myfw')
+  #   config.device_names            # => ['opnsense01', 'backup']
+  #   client = config.client_for('opnsense01')
   #
   # @example With explicit path (e.g. for puppet-opn integration)
   #   config = OpnApi::Config.new(config_dir: '/etc/puppetlabs/puppet/opn')
-  #   client = config.client_for('myfw')
+  #   client = config.client_for('opnsense01')
   class Config
     SYSTEM_DIR = '/etc/opn-api/devices'
     USER_DIR   = File.join(Dir.home, '.config', 'opn-api', 'devices')

data/lib/opn_api/id_resolver.rb

@@ -17,7 +17,7 @@ module OpnApi
   #     'linkedServers' => { endpoint: 'haproxy/settings/search_servers', multiple: true },
   #     'sslCA' => { endpoint: 'trust/ca/search', id_field: 'refid', name_field: 'descr' },
   #   }
-  #   translated = OpnApi::IdResolver.translate_to_names(client, 'myfw', relation_fields, config)
+  #   translated = OpnApi::IdResolver.translate_to_names(client, 'opnsense01', relation_fields, config)
   module IdResolver
     UUID_RE = %r{\A[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}\z}
 

data/lib/opn_api/service_reconfigure.rb

@@ -16,9 +16,9 @@ module OpnApi
   #     endpoint: 'ipsec/service/reconfigure',
   #     log_prefix: 'opn_ipsec')
   #
-  #   OpnApi::ServiceReconfigure[:ipsec].mark('myfw', client)
+  #   OpnApi::ServiceReconfigure[:ipsec].mark('opnsense01', client)
   #   results = OpnApi::ServiceReconfigure[:ipsec].run
-  #   # => { 'myfw' => :ok }
+  #   # => { 'opnsense01' => :ok }
   class ServiceReconfigure
     # Global registry of named instances.
     @registry = {}

data/lib/opn_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpnApi
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: opn_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - markt-de
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: |
   A standalone Ruby library and command-line tool for communicating with
@@ -51,7 +50,6 @@ licenses:
 - BSD-2-Clause
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -66,8 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Ruby client library and CLI for the OPNsense REST API
 test_files: []