pihole 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76c6991edc63b968bcdb8d757ed362d4606fce41005b3182c154e3cff8dca619
+  data.tar.gz: a6ffcc4fb6b86954940a1c30c7606a79241a4ffc7038386bd925741307f7145e
+SHA512:
+  metadata.gz: d3c68305df91d72791f7b0b056a2fd290d269396670549a070a6a61f19ec79d56e3cd626e456fc81a4bd24392431151a4755f62cd731f56423336f60ad40d55b
+  data.tar.gz: 7104b23c43ad83d61abe4a836e7621806d4fbe1b820ac1f665f5ca360a73ade6b39589d4ca67ea523ac10af9d7f1702b0081d3eff675055761892c152835d879

data/bin/pihole

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require_relative '../lib/pi_hole'
+
+class PiHoleCommand < Thor
+  class_option :location, {
+    type: :string,
+    banner: 'http://pihole-domain-or-ip-address',
+    desc: <<~HERE
+      The protocol and domain of the target Pi-Hole server. Can also be defined in the environment variable \
+      PIHOLE_LOCATION.
+    HERE
+  }
+  class_option :api_key, {
+    type: :string,
+    banner: 'api-key',
+    desc: <<~HERE.strip
+      The key used to authenticate with the server. It is strongly recommended to define the environment variable \
+      PIHOLE_API_KEY to prevent leaking this information to your command history.
+    HERE
+  }
+
+  desc 'status', 'Prints the status of the target Pi-Hole server'
+  def status
+    response = endpoint.execute PiHole::StatusCommand.new
+    puts response.body
+  end
+
+  desc 'disable', 'Temporarily disable Pi-Hole filtering'
+  method_option :duration, {
+    type: :string,
+    banner: '30',
+    desc: 'The length of time to disable filtering in seconds',
+    required: true
+  }
+  def disable
+    command = DisableCommand.new duration: options[:duration]
+    response = endpoint.execute command
+    puts response.body
+  end
+
+  private
+
+  def location
+    @location ||= [
+      options[:location],
+      ENV['PIHOLE_LOCATION'],
+    ].compact.first
+  end
+
+  def api_key
+    @api_key ||= [
+      options[:api_key],
+      ENV['PIHOLE_API_KEY'],
+    ].compact.first
+  end
+
+  def endpoint
+    @endpoint ||= PiHole::Endpoint.new location: location, api_key: api_key
+  end
+end
+
+PiHoleCommand.start

data/lib/pi_hole.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative './pi_hole/endpoint'
+require_relative './pi_hole/disable_command'
+require_relative './pi_hole/status_command'
+
+module PiHole
+  VERSION = '0.1.0'
+end

data/lib/pi_hole/disable_command.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module PiHole
+  # Temporarily disable PiHole blocking
+  class DisableCommand
+    attr_accessor :duration
+
+    # @param [Integer] duration Number of seconds to disable PiHole blocking
+    def initialize(duration: 30)
+      @duration = duration
+    end
+
+    # @return String
+    def query_string
+      "disable=#{@duration}"
+    end
+  end
+end

data/lib/pi_hole/endpoint.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+module PiHole
+  # The main entrypoint for this SDK. Describes the location and interaction with the PiHole API
+  class Endpoint
+    # @param [String] location The protocol and domain (or IP address) via which PiHole is served
+    # @param [String] api_key The API key to access the PiHole API
+    def initialize(location:, api_key:)
+      @location = location
+      @api_key = api_key
+    end
+
+    # @param [#query_string] command
+    def execute(command)
+      uri = URI "#{location}/admin/api.php?#{command.query_string}&#{auth_query_string}"
+      Net::HTTP.get_response uri
+    end
+
+    private
+
+    attr_reader :location, :api_key
+
+    def auth_query_string
+      "auth=#{api_key}"
+    end
+  end
+end

data/lib/pi_hole/status_command.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module PiHole
+  class StatusCommand
+    def query_string
+      'status=true'
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: pihole
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Yockey
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+executables:
+- pihole
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/pihole
+- lib/pi_hole.rb
+- lib/pi_hole/disable_command.rb
+- lib/pi_hole/endpoint.rb
+- lib/pi_hole/status_command.rb
+homepage: https://github.com/yock/pihole-ruby
+licenses:
+- Unlicense
+metadata:
+  course_code_uri: https://github.com/yock/pihole-ruby
+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.2.3
+signing_key:
+specification_version: 4
+summary: A Ruby SDK and command-line tool for interacting with the Pi-Hole HTTP API
+test_files: []