pihole-api 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 969171190d388a3b5fe68032344c4ab88022b2a2a2deceb03209ddbe8b83dd01
-  data.tar.gz: 9dcbe97d905946646c02bf56da36a8eac6bd76adaae033c70aed81cc990e84b8
+  metadata.gz: 72274b476c945fb672d06332375555bc2aec2defb464238619f263e1aa3de808
+  data.tar.gz: 4b033a3662517060589a5203cd03c75ad28b7a662f72932339fe4582ef3abe81
 SHA512:
-  metadata.gz: f1a541c23de20a1f29cb897c785fd5b43e48837b327e31a5592156e224702e8ab4cefc0d2c7d31ad2e34b6545f5a133ea858dd2371064450f7844695a7ad321e
-  data.tar.gz: 61705316cec6e332e505f4117f061c0daaf64d170c86cd22e777047e2a45a5353af951bfe3638a20f3127f9b22ed4c4b29985557fca254a10cdd242449682ef5
+  metadata.gz: bc1f224963cc84e0ac8f2574fd83667aec056e224b1d8d884d943460f5cc740adbf24059f8ddb6fbdbf74e3f5512f006c64687281a5ea21e13152a9f806d03ec
+  data.tar.gz: 76a8fe962a747f5ec7e138f7e394441f0ecbf32a93ca1aa4946058f3ea5f5b9041d156f24f5ff4bd64767c077fc3fc9559a018a85483fae30cdc131ff8ea81c4

data/.ruby-version

@@ -1 +1 @@
-3.3.0
+3.3.4

data/Gemfile.lock

@@ -1,112 +1,148 @@
 PATH
   remote: .
   specs:
-    pihole-api (0.0.4)
+    pihole-api (0.0.6)
       active_attr (~> 0.16.0)
-      httparty (~> 0.21.0)
-      nokogiri (~> 1.16.0)
+      httparty (~> 0.22.0)
+      nokogiri (~> 1.16.7)
 
 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)
-      public_suffix (>= 2.0.2, < 6.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.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.1)
+    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)
-    minitest (5.21.2)
+      nokogiri (>= 1.12.0)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    minitest (5.25.1)
     minitest-focus (1.4.0)
       minitest (>= 4, < 6)
-    minitest-reporters (1.6.1)
+    minitest-reporters (1.7.1)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    mocha (2.1.0)
+    mocha (2.4.5)
       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.7-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-arm-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.7-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 (6.0.1)
+    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)
-    rake (13.1.0)
-    rexml (3.2.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    rake (13.2.1)
+    rexml (3.3.5)
+      strscan
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    timecop (0.9.8)
-    tzinfo (2.0.5)
+    strscan (3.1.0)
+    timecop (0.9.10)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    webmock (3.19.1)
+    webmock (3.23.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       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)
+  minitest (~> 5.25.1)
   minitest-focus (~> 1.4.0)
-  minitest-reporters (~> 1.6.1)
-  mocha (~> 2.1.0)
+  minitest-reporters (~> 1.7.1)
+  mocha (~> 2.4.5)
   pihole-api!
   pry (~> 0.14.2)
-  rake (~> 13.1.0)
-  timecop (~> 0.9.8)
-  webmock (~> 3.19.1)
+  rake (~> 13.2.1)
+  timecop (~> 0.9.10)
+  webmock (~> 3.23.1)
 
 BUNDLED WITH
-   2.5.5
+   2.5.17

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/authorised_form_endpoints.rb

@@ -0,0 +1,67 @@
+module PiholeApi
+  module AuthorisedFormEndpoints
+    include ::PiholeApi::Constants
+
+    # These endpoints need to be authorised
+    # They are non API backed endpoints the require separate auth
+    # https://discourse.pi-hole.net/t/pi-hole-api/1863
+
+    def auth_form_token
+      # Login
+      login_response = HTTParty.post(
+        "#{base_path}/#{LOGIN_PATH}",
+        body: { pw: password }
+      )
+
+      @cookie = login_response.headers["set-cookie"].split(TOKEN_SEPERATOR).first
+
+      # Index
+      index_response = HTTParty.get(
+        "#{base_path}/#{INDEX_PATH}",
+        headers: { "Cookie": @cookie }
+      )
+
+      # Get form token
+      @form_token = TOKEN_REGEX.match(index_response.body)[1]
+    end
+
+    # This does not use the API
+    def 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)
+
+      auth_form_token unless @form_token
+
+      # authorise_and_send(http_method:, command:, payload: {}, params: {}, custom_path: nil)
+      # Content-Type: application/octet-stream
+      # zip_file ; filename=""
+      custom_path = "#{base_path}/#{TELEPORTER_PATH}"
+      payload = {
+        "token": @form_token,
+        "whitelist": whitelist,
+        "regex_whitelist": regex_whitelist,
+        "blacklist": blacklist,
+        "regexlist": regexlist,
+        "adlist": adlist,
+        "client": client,
+        "group": group,
+        "auditlog": auditlog,
+        "staticdhcpleases": staticdhcpleases,
+        "localdnsrecords": localdnsrecords,
+        "localcnamerecords": localcnamerecords,
+        "flushtables": flushtables
+      }
+
+      HTTParty.post(custom_path, body: payload, headers: { "Cookie": @cookie })
+    end
+  end
+end

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.6'
 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,17 +22,18 @@ 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.7"
+  # spec.add_dependency "oj", "~> 3.16.3"
 
   # Development dependancies
-  spec.add_development_dependency "rake", "~> 13.1.0"
-  spec.add_development_dependency "minitest", "~> 5.21.2"
+  spec.add_development_dependency "rake", "~> 13.2.1"
+  spec.add_development_dependency "minitest", "~> 5.25.1"
   spec.add_development_dependency "minitest-focus", "~> 1.4.0"
-  spec.add_development_dependency "minitest-reporters", "~> 1.6.1"
-  spec.add_development_dependency "timecop", "~> 0.9.8"
-  spec.add_development_dependency "mocha", "~> 2.1.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.7.1"
+  spec.add_development_dependency "timecop", "~> 0.9.10"
+  spec.add_development_dependency "mocha", "~> 2.4.5"
   spec.add_development_dependency "pry", "~> 0.14.2"
-  spec.add_development_dependency "webmock", "~> 3.19.1"
+  spec.add_development_dependency "webmock", "~> 3.23.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pihole-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - trex22
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-23 00:00:00.000000000 Z
+date: 2024-08-18 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,42 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.16.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.16.7
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.1.0
+        version: 13.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.1.0
+        version: 13.2.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.21.2
+        version: 5.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.21.2
+        version: 5.25.1
 - !ruby/object:Gem::Dependency
   name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
@@ -100,42 +100,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.7.1
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.8
+        version: 0.9.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.8
+        version: 0.9.10
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.4.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.4.5
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.19.1
+        version: 3.23.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.19.1
+        version: 3.23.1
 description: A client for using the PiholeApi API in Ruby. Built form their api documentation.
   https://discourse.pi-hole.net/t/using-the-api/976/6. This is an unofficial project.
 email:
@@ -186,6 +186,7 @@ files:
 - bin/setup
 - lib/pihole-api.rb
 - lib/pihole-api/authorised_endpoints.rb
+- lib/pihole-api/authorised_form_endpoints.rb
 - lib/pihole-api/client.rb
 - lib/pihole-api/constants.rb
 - lib/pihole-api/unauthorised_endpoints.rb
@@ -210,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A client for using the PiholeApi API in Ruby.