pihole-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0caf0f5f8ec1a96e09e1078ae0ab54e7c7bc6d4f1726250eb17627e146d162e
+  data.tar.gz: a979aca92108d4149e964bc203b16eb185a3a3b1afa7e4df2eb01037836f60d1
+SHA512:
+  metadata.gz: 4368a1a0310ba474d4cf8d6b44ba42ef6456d46c17f4c944dabb7a93ff3c66d1882235d946954cf8bf91ba5d96ddf931e1053aa68ac40facb0b8a41f33429e16
+  data.tar.gz: 2e12802fcf1837cd8f19a190311d5f55b3fd0a96dc62bbec965c21020673ed2a0cb2d27ea83e9a8d56eb8f4df97a7e8246ae4fcffd6787b964d7f14a6276dc8d

data/.gitignore

@@ -0,0 +1,58 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+.DS_Store

data/.ruby-version

@@ -0,0 +1 @@
+3.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behaviour that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behaviour by participants include:
+
+* The use of sexualised language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behaviour and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behaviour.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviours that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be
+reported by contacting the project team at contact@jasonchalom.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| 'https://github.com/TRex22/pihole-api' }
+
+# Specify your gem's dependencies in pihole-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    pihole-api (0.0.1)
+      active_attr (~> 0.15.4)
+      httparty (~> 0.21.0)
+      nokogiri (~> 1.14.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.4.1)
+      actionview (= 7.0.4.1)
+      activesupport (= 7.0.4.1)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.4.1)
+      activesupport (= 7.0.4.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    active_attr (0.15.4)
+      actionpack (>= 3.0.2, < 7.1)
+      activemodel (>= 3.0.2, < 7.1)
+      activesupport (>= 3.0.2, < 7.1)
+    activemodel (7.0.4.1)
+      activesupport (= 7.0.4.1)
+    activesupport (7.0.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ansi (1.5.0)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    crass (1.0.6)
+    erubi (1.12.0)
+    hashdiff (1.0.1)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.19.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.17.0)
+    minitest-focus (1.3.1)
+      minitest (>= 4, < 6)
+    minitest-reporters (1.5.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (2.0.2)
+      ruby2_keywords (>= 0.0.5)
+    multi_xml (0.6.0)
+    nokogiri (1.14.0-arm64-darwin)
+      racc (~> 1.4)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.1)
+    racc (1.6.2)
+    rack (2.2.6.2)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    rake (13.0.6)
+    rexml (3.2.5)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    timecop (0.9.6)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  minitest (~> 5.17.0)
+  minitest-focus (~> 1.3.1)
+  minitest-reporters (~> 1.5.0)
+  mocha (~> 2.0.2)
+  pihole-api!
+  pry (~> 0.14.2)
+  rake (~> 13.0.6)
+  timecop (~> 0.9.6)
+  webmock (~> 3.18.1)
+
+BUNDLED WITH
+   2.3.16

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jason Chalom
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 trex22
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# PiholeApiClient
+A client for the PiholeApi API.
+
+See:
+- https://discourse.pi-hole.net/t/pi-hole-api/1863
+- https://www.reddit.com/r/pihole/comments/br5tla/how_to_get_info_from_the_new_restful_api/
+- https://pi-hole.net/blog/2022/11/17/upcoming-changes-authentication-for-more-api-endpoints-required/
+- https://pi-hole.net/blog/2022/12/21/pi-hole-ftl-v5-20-and-web-v5-18-released/
+- https://github.com/pi-hole/AdminLTE/issues/2470
+- https://github.com/pi-hole/AdminLTE/issues/2326
+- https://discourse.pi-hole.net/t/using-the-api/976/6
+
+This is an unofficial project and still a work in progress (WIP) ... more to come soon.
+
+## TODO
+- Login and Auth token generation: `admin/scripts/pi-hole/php/api_token.php`
+- Undocumented endpointsw
+- Undocumented filters for getAllQueries
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pihole-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pihole-api
+
+## Usage
+
+```ruby
+  require 'pihole-api'
+  client = PiholeApi::Client.new(base_path: 'http://localhost:80/', api_token: '', port: 80)
+
+  # Some example calls
+  client.type
+
+```
+
+### Endpoints
+#### Authorised
+- `summary_raw`
+- `summary(params: {})`
+- `over_time_data_10_mins`
+- `top_items(number_of_items=10)`
+- `get_query_sources(number_of_items=10)`
+- `top_clients(number_of_items=10)`
+- `get_forward_destinations`
+- `get_query_types`
+`get_all_queries(params: {}, from_time: nil, until_time: nil, latest_number_of_items: nil)`
+- `recent_blocked`
+- `enable`
+- `disable`
+
+#### Unauthorised
+- `type`
+- `version`
+
+### Constants
+  Constants
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Tests
+To run tests execute:
+
+    $ rake test
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/trex22/pihole-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the pihole-api: project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/trex22/pihole-api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pihole-api'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start

data/bin/make

@@ -0,0 +1,3 @@
+#!/bin/bash
+gem build pihole-api.gemspec
+gem push pihole-api

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pihole-api/authorised_endpoints.rb

@@ -0,0 +1,82 @@
+module PiholeApi
+  module AuthorisedEndpoints
+    # These endpoints need to be authorised
+    # https://discourse.pi-hole.net/t/pi-hole-api/1863
+
+    def summary_raw
+      command = "summaryRaw&auth=#{password}"
+      authorise_and_send(http_method: :get, command: command)
+    end
+
+    def summary(params: {})
+      command = 'summary'
+      authorise_and_send(http_method: :get, command: command, params: params)
+    end
+
+    def over_time_data_10_mins
+      command = 'overTimeData10mins'
+      authorise_and_send(http_method: :get, command: command)
+    end
+
+    def top_items(number_of_items=10)
+      command = "topItems=#{number_of_items}"
+      authorise_and_send(http_method: :get, command: command)
+    end
+
+    def get_query_sources(number_of_items=10)
+      command = "getQuerySources=#{number_of_items}"
+      authorise_and_send(http_method: :get, command: command)
+    end
+
+    def top_clients(number_of_items=10)
+      command = "topClients=#{number_of_items}"
+      authorise_and_send(http_method: :get, command: command)
+    end
+
+    def get_forward_destinations
+      command = 'getForwardDestinations'
+      authorise_and_send(http_method: :get, command: command)
+    end
+
+    def get_query_types
+      command = 'getQueryTypes'
+      authorise_and_send(http_method: :get, command: command)
+    end
+
+    def get_all_queries(params: {}, from_time: nil, until_time: nil, latest_number_of_items: nil)
+      # API version 3:
+      # First column: Timestamp of query
+      # Second column: Type of query (IPv4 or IPv6)
+      # Third column: Requested domain name
+      # Fourth column: Requesting client
+      # Fifth column: Answer type (1 = blocked by gravity.list, 2 = forwarded to upstream server, 3 = answered by local cache, 4 = blocked by wildcard blocking)
+
+      if latest_number_of_items
+        command = "getAllQueries=#{latest_number_of_items}"
+      else
+        command = 'getAllQueries'
+      end
+
+      if from_time
+        command = "#{command}&from=#{from_time.to_i}&until=#{until_time.to_i}"
+      end
+
+      authorise_and_send(http_method: :get, command: command, params: params)
+    end
+
+    def recent_blocked
+      command = 'recentBlocked'
+      authorise_and_send(http_method: :get, command: command)
+    end
+
+    def enable
+      command = 'enable'
+      authorise_and_send(http_method: :get, command: command)
+    end
+
+    def disable
+      command = 'disable'
+      authorise_and_send(http_method: :get, command: command)
+    end
+  end
+end

data/lib/pihole-api/client.rb

@@ -0,0 +1,118 @@
+module PiholeApi
+  class Client
+    include ::PiholeApi::Constants
+
+    # Endpoints
+    include ::PiholeApi::UnauthorisedEndpoints
+    include ::PiholeApi::AuthorisedEndpoints
+
+    attr_reader :api_token, :base_path, :port
+
+    def initialize(base_path:, api_token:, port: 80)
+      @api_token = api_token
+      @base_path = base_path
+      @port = port
+    end
+
+    def self.compatible_api_version
+      'v3'
+    end
+
+    # This is the version of the API docs this client was built off-of
+    def self.api_version
+      'v2 2023-01-21'
+    end
+
+    private
+
+    def authorise_and_send(http_method:, command:, payload: {}, params: {})
+      start_time = micro_second_time_now
+
+      if params.nil? || params.empty?
+        params = {}
+      end
+
+      response = HTTParty.send(
+        http_method.to_sym,
+        construct_base_path(command, params),
+        body: payload,
+        headers: {
+          'Access-Token': @access_token,
+          'Content-Type': 'application/json',
+          "Accept": 'application/json',
+          "X-Pi-hole-Authenticate": api_token
+        },
+        port: port,
+        format: :json
+      )
+
+      end_time = micro_second_time_now
+      construct_response_object(response, command, start_time, end_time)
+    end
+
+    def construct_response_object(response, path, start_time, end_time)
+      {
+        'body' => parse_body(response, path),
+        'headers' => response.headers,
+        'metadata' => construct_metadata(response, start_time, end_time)
+      }
+    end
+
+    def construct_metadata(response, start_time, end_time)
+      total_time = end_time - start_time
+
+      {
+        'start_time' => start_time,
+        'end_time' => end_time,
+        'total_time' => total_time
+      }
+    end
+
+    def body_is_present?(response)
+      !body_is_missing?(response)
+    end
+
+    def body_is_missing?(response)
+      response.body.nil? || response.body.empty?
+    end
+
+    def parse_body(response, path)
+      return [] if response.body == "[]"
+      parse_json(response) # Purposely not using HTTParty
+    end
+
+    def parse_json(response)
+      begin
+        JSON.parse(response.body)
+      rescue => _e
+        response.body
+      end
+    end
+
+    def micro_second_time_now
+      (Time.now.to_f * 1_000_000).to_i
+    end
+
+    def construct_base_path(command, params)
+      constructed_path = "#{base_path}/#{API_PATH}?#{command}&auth=#{api_token}"
+
+      if params == {}
+        constructed_path
+      else
+        "#{constructed_path}&#{process_params(params)}"
+      end
+    end
+
+    def process_params(params)
+      params.keys.map { |key| "#{key}=#{params[key]}" }.join('&')
+    end
+
+    def process_cursor(cursor, params: {})
+      unless cursor.nil? || cursor.empty?
+        params['cursor'] = cursor
+      end
+
+      params
+    end
+  end
+end

data/lib/pihole-api/constants.rb

@@ -0,0 +1,5 @@
+module PiholeApi
+  module Constants
+    API_PATH = 'admin/api.php'
+  end
+end

data/lib/pihole-api/unauthorised_endpoints.rb

@@ -0,0 +1,16 @@
+module PiholeApi
+  module UnauthorisedEndpoints
+    # These endpoints dont need to be authorised
+    # https://discourse.pi-hole.net/t/pi-hole-api/1863
+
+    def type
+      command = 'type'
+      authorise_and_send(http_method: :get, command: command)
+    end
+
+    def version
+      command = 'version'
+      authorise_and_send(http_method: :get, command: command)
+    end
+  end
+end

data/lib/pihole-api/version.rb

@@ -0,0 +1,3 @@
+module PiholeApi
+  VERSION = '0.0.1'
+end

data/lib/pihole-api.rb

@@ -0,0 +1,15 @@
+require 'httparty'
+require 'nokogiri'
+
+require 'pihole-api/version'
+require 'pihole-api/constants'
+
+# Endpoints
+require 'pihole-api/unauthorised_endpoints'
+require 'pihole-api/authorised_endpoints'
+
+require 'pihole-api/client'
+
+module PiholeApi
+  class Error < StandardError; end
+end

data/pihole-api.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pihole-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pihole-api'
+  spec.version       = PiholeApi::VERSION
+  spec.authors       = ['trex22']
+  spec.email         = ['contact@jasonchalom.com']
+
+  spec.summary       = 'A client for using the PiholeApi API in Ruby.'
+  spec.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.'
+  spec.homepage      = 'https://github.com/TRex22/pihole-api'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  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 "active_attr", "~> 0.15.4"
+  spec.add_dependency "nokogiri", "~> 1.14.0"
+
+  # Development dependancies
+  spec.add_development_dependency "rake", "~> 13.0.6"
+  spec.add_development_dependency "minitest", "~> 5.17.0"
+  spec.add_development_dependency "minitest-focus", "~> 1.3.1"
+  spec.add_development_dependency "minitest-reporters", "~> 1.5.0"
+  spec.add_development_dependency "timecop", "~> 0.9.6"
+  spec.add_development_dependency "mocha", "~> 2.0.2"
+  spec.add_development_dependency "pry", "~> 0.14.2"
+  spec.add_development_dependency "webmock", "~> 3.18.1"
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: pihole-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- trex22
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.17.0
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.18.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.18.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:
+- contact@jasonchalom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/make
+- bin/setup
+- lib/pihole-api.rb
+- lib/pihole-api/authorised_endpoints.rb
+- lib/pihole-api/client.rb
+- lib/pihole-api/constants.rb
+- lib/pihole-api/unauthorised_endpoints.rb
+- lib/pihole-api/version.rb
+- pihole-api.gemspec
+homepage: https://github.com/TRex22/pihole-api
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.4
+signing_key:
+specification_version: 4
+summary: A client for using the PiholeApi API in Ruby.
+test_files: []