opnsense_api 0.1.0 → 0.2.0

data/lib/opnsense_api/core/proxy/service.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     class Proxy

data/lib/opnsense_api/core/proxy/settings.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     class Proxy

data/lib/opnsense_api/core/proxy/template.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     class Proxy

data/lib/opnsense_api/core/proxy.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     # @see https://docs.opnsense.org/development/api/core/proxy.html

data/lib/opnsense_api/core/routes/gateway.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     class Routes

data/lib/opnsense_api/core/routes/routes.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     class Routes

data/lib/opnsense_api/core/routes.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     # @see https://docs.opnsense.org/development/api/core/routes.html

data/lib/opnsense_api/core/syslog/service.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     class Syslog

data/lib/opnsense_api/core/syslog/settings.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     class Syslog

data/lib/opnsense_api/core/syslog.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     # @see https://docs.opnsense.org/development/api/core/syslog.html

data/lib/opnsense_api/core/traffic_shaping/service.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     class TrafficShaping

data/lib/opnsense_api/core/traffic_shaping/settings.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     class TrafficShaping

data/lib/opnsense_api/core/traffic_shaping.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     # @see https://docs.opnsense.org/development/api/core/trafficshaper.html

data/lib/opnsense_api/core/unbound/diagnostics.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     class Unbound

data/lib/opnsense_api/core/unbound/service.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     class Unbound

data/lib/opnsense_api/core/unbound/settings.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     class Unbound

data/lib/opnsense_api/core/unbound.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   module Core
     # @see https://docs.opnsense.org/development/api/core/unbound.html

data/lib/opnsense_api/core.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   # @see https://docs.opnsense.org/development/api.html#core-api
   module Core

data/lib/opnsense_api/error.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
   class Error < StandardError; end
 end

data/lib/opnsense_api/version.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 module OPNsenseAPI
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/opnsense_api.rb

@@ -1,5 +1,20 @@
 # frozen_string_literal: true
 
+# Copyright (C) 2022  Zach Bensley
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 require_relative 'opnsense_api/error'
 require_relative 'opnsense_api/version'
 

data/sig/lib/opnsense_api/client.rbs

@@ -7,7 +7,7 @@ module OPNsenseAPI
     attr_reader api_secret: String
     attr_reader options: Hash[Symbol, untyped]
 
-    def initialize: (URI | String host, String api_key, String api_secret, **Hash[Symbol, untyped] options) -> void
+    def initialize: (host: URI | String, api_key: String , api_secret: String, **Hash[Symbol, untyped] options) -> void
 
     def captive_portal: () -> Core::CaptivePortal
 

data/sig/lib/opnsense_api/core/core/firmware.rbs

@@ -31,6 +31,20 @@ module OPNsenseAPI
         def upgrade_status: (?Hash[untyped, untyped] params) -> untyped
 
         def changelog: (version: String) -> untyped
+
+        def install: (String pkg_name, ?Hash[untyped, untyped] body) -> untyped
+
+        def reinstall: (String pkg_name, ?Hash[untyped, untyped] body) -> untyped
+
+        def remove: (String pkg_name, ?Hash[untyped, untyped] body) -> untyped
+
+        def lock: (String pkg_name, ?Hash[untyped, untyped] body) -> untyped
+
+        def unlock: (String pkg_name, ?Hash[untyped, untyped] body) -> untyped
+
+        def details: (String pkg_name, ?Hash[untyped, untyped] body) -> untyped
+
+        def license: (String pkg_name, ?Hash[untyped, untyped] body) -> untyped
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opnsense_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Zach Bensley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-13 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -235,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Library for using the OPNsense API