reolink-http 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0df4961d3dddac35c27d48dc2a9d859d9e863c7bef207458642083fce41334d0
+  data.tar.gz: 56002d3e9acb54e5d6c305f3cf49552f01c173b894dcdd252b5ec73139974e0c
+SHA512:
+  metadata.gz: 8a993b24bf83f29ba5f6e92cf75528276c793a2f07406a95a18b8c500dec593140f4eb76c03e73c082c75e9736a018fa16cb0612d0083fe99000ea1ab81fbf8d
+  data.tar.gz: 1700ad1ce09feb1a8105bc8c3678a547fad5f10a38bb5e11dde13fa7d91ba2ac227600690125368a653dae257b94d4c1170392a98ef916510334943f4953ecdf

data/lib/reolink/http/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Reolink
+  class HTTP
+    VERSION = "0.1.0"
+  end
+end

data/lib/reolink/http.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+
+require_relative "http/version"
+
+module Reolink
+  # Provides an abstraction of the Reolink device API.
+  # See the Reolink API documentation for commands, parameters, and response fields.
+  class HTTP
+    attr_reader :host, :token, :token_expires_at
+
+    def initialize(host, username: nil, password: nil)
+      @host = host
+      @username = username
+      @password = password
+      @token = nil
+      @token_expires_at = Time.new(0)
+    end
+
+    def method_missing(method_name, params = {}, **kwargs)
+      # Assume any missing method is a valid Reolink command. We have no good way to validate this: the API changes and
+      # will be a maintenance burden, and GetAbility does not return all commands. An invalid command will still cause
+      # a proper error response, so this functionality is correct, if not ideal.
+      command(command: method_name.to_s.split("_").map(&:capitalize).join,
+              params:,
+              **kwargs)
+    end
+
+    def respond_to_missing?(*_args)
+      true
+    end
+
+    def command(method: :post, **kwargs)
+      Net::HTTP.start(host, use_ssl: true, verify_mode: OpenSSL::SSL::VERIFY_NONE) do |http|
+        refresh_token(http:) if token_expires_at <= Time.now
+        case method
+        when :post then post(http:, **kwargs)
+        when :get then get(http:, **kwargs)
+        else
+          raise "Unknown method #{method}"
+        end
+      end
+    end
+
+    def refresh_token(http:)
+      login_response = post(http:, command: "Login", params: { "User" => { "Version" => "0",
+                                                                           "userName" => @username,
+                                                                           "password" => @password } })
+                       .first.value["Token"]
+      @token = login_response["name"]
+      @token_expires_at = Time.now + login_response["leaseTime"]
+    end
+
+    private
+
+    def get(http:, command:, params: {})
+      http.get("/api.cgi?#{URI.encode_www_form({ cmd: command, token:, **params })}")
+    end
+
+    # `verbose` is passed as the `action` parameter. Ignored for non-Get* endpoints.
+    #   0 -- get current value only
+    #   1 -- get initial, range, and current value
+    def post(http:, command:, params: {}, verbose: true)
+      params = { command.delete_prefix("Set") => params } if command.start_with?("Set")
+
+      http.post("/api.cgi?cmd=#{command}" + ("&token=#{token}" if token).to_s,
+                JSON.generate([{ cmd: command, action: verbose ? 1 : 0, param: params }]))
+        .then { |http_response| Response.from_json(http_response.body) }
+    end
+
+    # Represents a response from the device.
+    #   cmd -- name of command
+    #   code -- status code. 0 means no errors.
+    #   initial -- initial value of attribute, for Get* requests when `verbose` is true
+    #   range -- range of possible values for attribute, for Get* requests when `verbose` is true
+    #   current -- current value of attribute, for Get* requests
+    #   error -- error code and details. nil if no error.
+    class Response
+      # Parse a JSON string from the device and return *an array* of Response objects.
+      def self.from_json(str)
+        JSON.parse(str)
+            .map do |response|
+              new(**response.transform_keys(&:to_sym))
+            end
+      end
+
+      attr_reader :cmd, :code, :initial, :range, :value, :error
+
+      def initialize(cmd:, code:, initial: nil, range: nil, value: nil, error: nil)
+        @cmd = cmd
+        @code = code
+        @initial = initial&.[](cmd.delete_prefix("Get")) || initial
+        @range = range&.[](cmd.delete_prefix("Get")) || range
+        @value = value&.[](cmd.delete_prefix("Get")) || value
+        @error = error
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: reolink-http
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eddie Lebow
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-10 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- elebow@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/reolink/http.rb
+- lib/reolink/http/version.rb
+homepage: https://codeberg.org/elebow/reolink-http-ruby
+licenses:
+- AGPL-3.0-or-later
+metadata:
+  homepage_uri: https://codeberg.org/elebow/reolink-http-ruby
+  source_code_uri: https://codeberg.org/elebow/reolink-http-ruby
+  changelog_uri: https://codeberg.org/elebow/reolink-http-ruby/src/CHANGELOG.md
+  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.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Interface for Reolink's HTTP device API.
+test_files: []