keenetic 0.1.0

data/lib/keenetic.rb

@@ -0,0 +1,99 @@
+require_relative 'keenetic/version'
+require_relative 'keenetic/errors'
+require_relative 'keenetic/configuration'
+require_relative 'keenetic/client'
+require_relative 'keenetic/resources/base'
+require_relative 'keenetic/resources/devices'
+require_relative 'keenetic/resources/system'
+require_relative 'keenetic/resources/network'
+require_relative 'keenetic/resources/wifi'
+require_relative 'keenetic/resources/internet'
+require_relative 'keenetic/resources/ports'
+require_relative 'keenetic/resources/policies'
+require_relative 'keenetic/resources/dhcp'
+require_relative 'keenetic/resources/routing'
+require_relative 'keenetic/resources/logs'
+
+# Keenetic Router API Client
+#
+# A Ruby client for interacting with Keenetic router's REST API.
+# Supports authentication, device management, system monitoring, and network interfaces.
+#
+# == Configuration
+#
+#   Keenetic.configure do |config|
+#     config.host = '192.168.1.1'
+#     config.login = 'admin'
+#     config.password = 'your_password'
+#     config.timeout = 30          # optional, default: 30
+#     config.logger = Logger.new($stdout)  # optional
+#   end
+#
+# == Usage
+#
+#   client = Keenetic.client
+#
+#   # Devices
+#   client.devices.all                    # List all devices
+#   client.devices.active                 # Only connected devices
+#   client.devices.find(mac: 'AA:BB:...')  # Find by MAC
+#   client.devices.update(mac: 'AA:BB:...', name: 'My Phone')
+#
+#   # System
+#   client.system.resources   # CPU, memory, uptime
+#   client.system.info        # Model, firmware version
+#
+#   # Network
+#   client.network.interfaces  # All network interfaces
+#
+#   # WiFi
+#   client.wifi.access_points  # WiFi networks
+#   client.wifi.clients        # Connected WiFi clients
+#
+#   # Internet
+#   client.internet.status     # Internet connection status
+#   client.internet.speed      # Current WAN speed stats
+#
+#   # Ports
+#   client.ports.all           # Physical port statuses
+#
+# == Error Handling
+#
+#   begin
+#     client.devices.all
+#   rescue Keenetic::AuthenticationError => e
+#     # Invalid credentials
+#   rescue Keenetic::ConnectionError => e
+#     # Router unreachable
+#   rescue Keenetic::TimeoutError => e
+#     # Request timed out
+#   rescue Keenetic::NotFoundError => e
+#     # Resource not found
+#   rescue Keenetic::ApiError => e
+#     # Other API errors (e.status_code, e.response_body)
+#   end
+#
+module Keenetic
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration) if block_given?
+      configuration
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+
+    # Convenience method to create a new client with current configuration
+    def client
+      Client.new(configuration)
+    end
+  end
+end
+

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: keenetic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: A Ruby client for interacting with Keenetic router REST API. Supports
+  authentication, device management, system monitoring, and network interfaces.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/keenetic.rb
+- lib/keenetic/client.rb
+- lib/keenetic/configuration.rb
+- lib/keenetic/errors.rb
+- lib/keenetic/resources/base.rb
+- lib/keenetic/resources/devices.rb
+- lib/keenetic/resources/dhcp.rb
+- lib/keenetic/resources/internet.rb
+- lib/keenetic/resources/logs.rb
+- lib/keenetic/resources/network.rb
+- lib/keenetic/resources/policies.rb
+- lib/keenetic/resources/ports.rb
+- lib/keenetic/resources/routing.rb
+- lib/keenetic/resources/system.rb
+- lib/keenetic/resources/wifi.rb
+- lib/keenetic/version.rb
+homepage: https://github.com/example/keenetic
+licenses:
+- MIT
+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.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Ruby client for Keenetic router API
+test_files: []