pihole-api 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 969171190d388a3b5fe68032344c4ab88022b2a2a2deceb03209ddbe8b83dd01
-  data.tar.gz: 9dcbe97d905946646c02bf56da36a8eac6bd76adaae033c70aed81cc990e84b8
+  metadata.gz: '0819b5dbc059b9bded89781059e55824fc94d102e4e2b4aec8d54ecec1d1d5fb'
+  data.tar.gz: 3f44a5bc69c7037aa2078b2c662ed216f2a153e0af42853f2ac19872046f0b90
 SHA512:
-  metadata.gz: f1a541c23de20a1f29cb897c785fd5b43e48837b327e31a5592156e224702e8ab4cefc0d2c7d31ad2e34b6545f5a133ea858dd2371064450f7844695a7ad321e
-  data.tar.gz: 61705316cec6e332e505f4117f061c0daaf64d170c86cd22e777047e2a45a5353af951bfe3638a20f3127f9b22ed4c4b29985557fca254a10cdd242449682ef5
+  metadata.gz: 479bdb784791d1fb764b05f710f146d34ec21d5887246eab3e3cc04b20fbab43547550859442d1cd0ff37a0b77fd2049fd17adbe48b8140ee312aa5e5c2d5658
+  data.tar.gz: 4048e62ab0cff87b404da183fa13e82d9d7c798a5b297e6e3436b485190bdfc8368d4a7d9224e0c6a9c7905bc65b7608f5bbaa7640590d03ded9f81f1d4926c9

data/Gemfile.lock

@@ -1,59 +1,74 @@
 PATH
   remote: .
   specs:
-    pihole-api (0.0.4)
+    pihole-api (0.0.5)
       active_attr (~> 0.16.0)
-      httparty (~> 0.21.0)
-      nokogiri (~> 1.16.0)
+      httparty (~> 0.22.0)
+      nokogiri (~> 1.16.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.0.4.2)
-      actionview (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
-      rack (~> 2.0, >= 2.2.0)
+    actionpack (7.1.3.3)
+      actionview (= 7.1.3.3)
+      activesupport (= 7.1.3.3)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (7.0.4.2)
-      activesupport (= 7.0.4.2)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.3.3)
+      activesupport (= 7.1.3.3)
       builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
     active_attr (0.16.0)
       actionpack (>= 3.0.2, < 7.2)
       activemodel (>= 3.0.2, < 7.2)
       activesupport (>= 3.0.2, < 7.2)
-    activemodel (7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activesupport (7.0.4.2)
+    activemodel (7.1.3.3)
+      activesupport (= 7.1.3.3)
+    activesupport (7.1.3.3)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-    addressable (2.8.5)
+    addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     ansi (1.5.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
     builder (3.2.4)
     coderay (1.1.3)
-    concurrent-ruby (1.2.0)
-    crack (0.4.5)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crack (1.0.0)
+      bigdecimal
       rexml
     crass (1.0.6)
+    csv (3.3.0)
+    drb (2.2.1)
     erubi (1.12.0)
-    hashdiff (1.0.1)
-    httparty (0.21.0)
+    hashdiff (1.1.0)
+    httparty (0.22.0)
+      csv
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    i18n (1.12.0)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    loofah (2.19.1)
+    loofah (2.22.0)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (1.0.0)
-    mini_mime (1.1.2)
+      nokogiri (>= 1.12.0)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
     minitest (5.21.2)
     minitest-focus (1.4.0)
       minitest (>= 4, < 6)
@@ -64,28 +79,46 @@ GEM
       ruby-progressbar
     mocha (2.1.0)
       ruby2_keywords (>= 0.0.5)
-    multi_xml (0.6.0)
-    nokogiri (1.16.0-arm64-darwin)
+    multi_xml (0.7.1)
+      bigdecimal (~> 3.1)
+    mutex_m (0.2.0)
+    nokogiri (1.16.5-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.5-arm-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.5-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.5-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.5-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.5-x86_64-linux)
       racc (~> 1.4)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (5.0.3)
-    racc (1.6.2)
-    rack (2.2.6.2)
-    rack-test (2.0.2)
+    public_suffix (5.0.5)
+    racc (1.8.0)
+    rack (3.0.11)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
       rack (>= 1.3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.5.0)
-      loofah (~> 2.19, >= 2.19.1)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
     rake (13.1.0)
-    rexml (3.2.6)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
+    strscan (3.1.0)
     timecop (0.9.8)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     webmock (3.19.1)
       addressable (>= 2.8.0)
@@ -93,9 +126,12 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
-  arm64-darwin-20
-  arm64-darwin-22
-  arm64-darwin-23
+  aarch64-linux
+  arm-linux
+  arm64-darwin
+  x86-linux
+  x86_64-darwin
+  x86_64-linux
 
 DEPENDENCIES
   minitest (~> 5.21.2)
@@ -109,4 +145,4 @@ DEPENDENCIES
   webmock (~> 3.19.1)
 
 BUNDLED WITH
-   2.5.5
+   2.5.9

data/README.md

@@ -45,13 +45,16 @@ Or install it yourself as:
   client.type
 ```
 
-Double hash web password to get the api_token. A helper method exists on the client to do this:
+Double hash web password to get the api_token.
+A helper method exists on the client to do this:
 ```ruby
 require 'pihole-api'
 api_token = PiholeApi::Client.hash_password(password)
 end
 ```
 
+However the client now generates the API token automatically from the given password
+
 ### Endpoints
 #### Authorised
 - `summary_raw`
@@ -66,6 +69,9 @@ end
 - `recent_blocked`
 - `enable`
 - `disable`
+#### Authorised Non API
+- auth_form_token
+- `teleport(whitelist: true, regex_whitelist: true, blacklist: true, regexlist: true, adlist: true, client: true, group: true, auditlog: true, staticdhcpleases: true, localdnsrecords: true, localcnamerecords: true, flushtables: true)`
 
 #### Unauthorised
 - `type`

data/lib/pihole-api/client.rb

@@ -5,11 +5,14 @@ module PiholeApi
     # Endpoints
     include ::PiholeApi::UnauthorisedEndpoints
     include ::PiholeApi::AuthorisedEndpoints
+    include ::PiholeApi::AuthorisedFormEndpoints
 
-    attr_reader :api_token, :base_path, :port
+    attr_reader :password, :api_token, :form_token, :cookie, :base_path, :port
+
+    def initialize(base_path:, password:, port: 80)
+      @password = password
+      @api_token = PiholeApi::Client.hash_password(password)
 
-    def initialize(base_path:, api_token:, port: 80)
-      @api_token = api_token
       @base_path = base_path
       @port = port
     end
@@ -25,6 +28,7 @@ module PiholeApi
 
     def self.hash_password(password)
       require 'digest'
+
       hash1 = Digest::SHA256.hexdigest(password)
       Digest::SHA256.hexdigest(hash1) # Use as hash password for client
     end

data/lib/pihole-api/constants.rb

@@ -1,5 +1,11 @@
 module PiholeApi
   module Constants
     API_PATH = 'admin/api.php'
+    LOGIN_PATH = 'admin/login.php'
+    INDEX_PATH = 'admin'
+    TELEPORTER_PATH = 'admin/scripts/pi-hole/php/teleporter.php'
+
+    TOKEN_REGEX = /div\s+id="token"\s+hidden>([^<]+)<\/div>/
+    TOKEN_SEPERATOR = ";"
   end
 end

data/lib/pihole-api/version.rb

@@ -1,3 +1,3 @@
 module PiholeApi
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/lib/pihole-api.rb

@@ -1,5 +1,6 @@
 require 'httparty'
 require 'nokogiri'
+# require 'oj'
 
 require 'pihole-api/version'
 require 'pihole-api/constants'
@@ -7,6 +8,7 @@ require 'pihole-api/constants'
 # Endpoints
 require 'pihole-api/unauthorised_endpoints'
 require 'pihole-api/authorised_endpoints'
+require 'pihole-api/authorised_form_endpoints'
 
 require 'pihole-api/client'
 

data/pihole-api.gemspec

@@ -22,9 +22,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency "httparty", "~> 0.21.0"
+  spec.add_dependency "httparty", "~> 0.22.0"
   spec.add_dependency "active_attr", "~> 0.16.0"
-  spec.add_dependency "nokogiri", "~> 1.16.0"
+  spec.add_dependency "nokogiri", "~> 1.16.5"
+  # spec.add_dependency "oj", "~> 3.16.3"
 
   # Development dependancies
   spec.add_development_dependency "rake", "~> 13.1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pihole-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - trex22
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-23 00:00:00.000000000 Z
+date: 2024-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: active_attr
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.16.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.16.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -210,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: A client for using the PiholeApi API in Ruby.