mastodon_healthchecker 0.1.0.pre → 0.1.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf3b0f82d8322a8b5ab8ee6ffa15f2ae69b3f74a
-  data.tar.gz: 295ec16abde24bdf984a80d3b63374a2a33c5669
+  metadata.gz: 7ac4c1e11218f383ffeb7d4e4f93c2f47a103b1a
+  data.tar.gz: 3a07a3424670db0aa6c02d15f6269b8dc151ad4f
 SHA512:
-  metadata.gz: 19f358c52a57860b6b9875f6db23b6942bd71f65a86e8cc617170cbb1d5e1017112e05e838bda288b030b7ea70667bc615d243532f265cdaa2c35dce5efb6777
-  data.tar.gz: 12a936ee80f32546e1d4f9f73babc768fbf4ca9fc43d6e995333384cf918a848ced71f73f5c7560b7deb68307cbfe6d38a67f59e3ec525db2305762225a4f945
+  metadata.gz: '0638501d22b1a3e2a89c263cef80b0e87eb80ff2d39ecc622b994e18a7a48e855ac5786684ac7b2b9bb7c0e2b6b40784e7ecab3cbfb157f99ca9b0041c5a5848'
+  data.tar.gz: 8ea93661741d70a4db76207740ad131b0cc65298ace25fcffcd5d689a1e08bde2c1ed27f3fac5a6ad8fcb84c67758d35fbefda66d2fa57a2572e0bd62b74c5f2

data/lib/mastodon_healthchecker.rb

@@ -1,20 +1,19 @@
+require 'mastodon_healthchecker/dns_records'
+require 'mastodon_healthchecker/instance_info'
 require 'mastodon_healthchecker/version'
 
 module MastodonHealthchecker
-  autoload :AvailabilityInspector,
-           'mastodon_healthchecker/inspectors/availability'
-  autoload :RecordExistenceInspector,
-           'mastodon_healthchecker/inspectors/record_existence'
+  Result = Struct.new('Result', :exists_record, :up, :info)
 
-  DefaultInspectionItems = {
-    exists_record: RecordExistenceInspector,
-    up: AvailabilityInspector
-  }.freeze
+  def self.perform(host)
+    records = DNSRecords.new(host)
+    info_v4 = InstanceInfo.fetch(host, records.v4_addresses) if records.v4_addresses.any?
+    info_v6 = InstanceInfo.fetch(host, records.v6_addresses) if records.v6_addresses.any?
 
-  def self.perform(host, inspection_items: DefaultInspectionItems)
-    inspection_items.inject({}) do |result, (key, item)|
-      result[key] = item.call(host)
-      result
-    end
+    Result.new(
+      { v4: records.v4_addresses.any?, v6: records.v6_addresses.any? },
+      { v4: !info_v4.nil?, v6: !info_v6.nil? },
+      info_v4 || info_v6 || nil
+    )
   end
 end

data/lib/mastodon_healthchecker/dns_records.rb

@@ -0,0 +1,23 @@
+require 'resolv'
+
+module MastodonHealthchecker
+  class DNSRecords
+    def initialize(host)
+      @v4_addresses = []
+      @v6_addresses = []
+      Resolv::DNS.new.each_address(host) do |addr|
+        case addr
+        when Resolv::IPv4
+          v4_addresses << addr
+        when Resolv::IPv6
+          v6_addresses << addr
+        else
+          raise "Resolver returns an address which is neither IPv4 nor IPv6."
+        end
+      end
+    end
+
+    attr_reader :v4_addresses, :v6_addresses
+  end
+end
+

data/lib/mastodon_healthchecker/hash_hosts.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+##
+# Copyright (C) 2017 nullkal.
+#
+# This program is a derived work from Resolv::Hosts of Ruby 2.4
+# (https://github.com/ruby/ruby/).
+#
+# ----
+#
+# Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+#
+
+require 'resolv'
+
+module MastodonHealthchecker
+  class HashHosts
+    def initialize(hosts)
+      @name2addr = hosts
+
+      @addr2name = {}
+      hosts.each do |name, addrs|
+        addrs.each do |addr|
+          @addr2name[addr] ||= []
+          @addr2name[addr] << name
+        end
+      end
+    end
+
+    ##
+    # Gets the IP address of +name+ from the hosts file.
+
+    def getaddress(name)
+      each_address(name) {|address| return address}
+      raise ResolvError.new("#{@filename} has no name: #{name}")
+    end
+
+    ##
+    # Gets all IP addresses for +name+ from the hosts file.
+
+    def getaddresses(name)
+      ret = []
+      each_address(name) {|address| ret << address}
+      return ret
+    end
+
+    ##
+    # Iterates over all IP addresses for +name+ retrieved from the hosts file.
+
+    def each_address(name, &proc)
+      if @name2addr.include?(name)
+        @name2addr[name].each(&proc)
+      end
+    end
+
+    ##
+    # Gets the hostname of +address+ from the hosts file.
+
+    def getname(address)
+      each_name(address) {|name| return name}
+      raise ResolvError.new("#{@filename} has no address: #{address}")
+    end
+
+    ##
+    # Gets all hostnames for +address+ from the hosts file.
+
+    def getnames(address)
+      ret = []
+      each_name(address) {|name| ret << name}
+      return ret
+    end
+
+    ##
+    # Iterates over all hostnames for +address+ retrieved from the hosts file.
+
+    def each_name(address, &proc)
+      @addr2name[address]&.each(&proc)
+    end
+  end
+end

data/lib/mastodon_healthchecker/instance_info.rb

@@ -0,0 +1,90 @@
+require 'json'
+require 'mastodon_healthchecker/hash_hosts'
+require 'nokogiri'
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday/encoding'
+require 'resolv'
+require 'resolv-replace'
+
+module MastodonHealthchecker
+  class InstanceInfo
+
+    class << self
+      def fetch(host, addresses)
+        default_resolver = Resolv::DefaultResolver
+
+        hash_hosts = HashHosts.new({ "#{host}" => addresses })
+        Resolv::DefaultResolver.replace_resolvers([hash_hosts, Resolv::DNS.new])
+
+        result = nil
+        begin
+          info = InstanceInfo.new
+          info.parse_about(get(host, '/about'))
+          info.parse_about_more(get(host, '/about/more'))
+          info.parse_instance(get(host, '/api/v1/instance'))
+          result = info
+        rescue Faraday::ClientError
+        rescue Nokogiri::SyntaxError
+        rescue JSON::ParseError
+        end
+
+        Resolv::DefaultResolver.replace_resolvers(default_resolver)
+        result
+      end
+
+      private
+
+      def get(host, path)
+        conn = Faraday.new("http://#{host}") do |faraday|
+          faraday.use FaradayMiddleware::FollowRedirects
+          faraday.response :encoding
+          faraday.response :raise_error
+          faraday.adapter :net_http
+        end
+        conn.get(path)
+      end
+    end
+
+    def initialize
+      @version = nil
+
+      @users = nil
+      @statuses = nil
+      @connections = nil
+
+      @description = nil
+      @extended_description = nil
+      @email = nil
+      @opened = nil
+    end
+
+    def parse_about(response)
+      doc = Nokogiri::HTML.parse(response.body)
+      @opened = doc.xpath("//*[@class='closed-registrations-message']").empty?
+    end
+
+    def parse_about_more(response)
+      doc = Nokogiri::HTML.parse(response.body)
+
+      info = doc.xpath("//*[@class='main']/*[@class='information-board']/*[@class='section']/strong")
+      if 3 <= info.length
+        @users = info[0].text.tr(',', '').to_i
+        @statuses = info[1].text.tr(',', '').to_i
+        @connections = info[2].text.tr(',', '').to_i
+      end
+
+      @extended_description = doc.xpath("//*[@class='main']/*[@class='panel'][2]").inner_html
+    end
+
+    def parse_instance(response)
+      instance = JSON.parse(response.body)
+      @version = instance['version']
+      @description = instance['description']
+      @email = instance['email']
+    end
+
+    attr_reader :version, :users, :statuses, :connections,
+                :description, :extended_description, :email, :opened
+  end
+end

data/lib/mastodon_healthchecker/version.rb

@@ -1,3 +1,3 @@
 module MastodonHealthchecker
-  VERSION = '0.1.0.pre'.freeze
+  VERSION = '0.1.0.pre.2'.freeze
 end

data/mastodon_healthchecker.gemspec

@@ -29,4 +29,9 @@ and other statuses of a mastodon instance.
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.49.1'
+
+  spec.add_runtime_dependency 'faraday', '~> 0.9.2'
+  spec.add_runtime_dependency 'faraday-encoding', '~> 0.0.4'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.10.0'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6', '>= 1.6.7.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mastodon_healthchecker
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.0.pre.2
 platform: ruby
 authors:
 - nullkal
@@ -66,6 +66,68 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: faraday-encoding
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7.2
 description: |
   mastodon_healthchecker provides a function which checks the connectability,
   and other statuses of a mastodon instance.
@@ -87,9 +149,9 @@ files:
 - bin/console
 - bin/setup
 - lib/mastodon_healthchecker.rb
-- lib/mastodon_healthchecker/inspectors/availability.rb
-- lib/mastodon_healthchecker/inspectors/record_existence.rb
-- lib/mastodon_healthchecker/results/network_inspection.rb
+- lib/mastodon_healthchecker/dns_records.rb
+- lib/mastodon_healthchecker/hash_hosts.rb
+- lib/mastodon_healthchecker/instance_info.rb
 - lib/mastodon_healthchecker/version.rb
 - mastodon_healthchecker.gemspec
 homepage: https://github.com/nullkal/mastodon_healthchecker

data/lib/mastodon_healthchecker/inspectors/availability.rb

@@ -1,19 +0,0 @@
-require 'mastodon_healthchecker/results/network_inspection.rb'
-
-module MastodonHealthchecker
-  module AvailabilityInspector
-    def self.call(host)
-      NetworkInspectionResult.new(v4: inspect_v4, v6: inspect_v6)
-    end
-
-    private
-
-    def self.inspect_v4
-      # TODO: Implement here
-    end
-
-    def self.inspect_v6
-      # TODO: Implement here
-    end
-  end
-end

data/lib/mastodon_healthchecker/inspectors/record_existence.rb

@@ -1,26 +0,0 @@
-module MastodonHealthchecker
-  module RecordExistenceInspector
-    class Result
-      def initialize(v4: false, v6: false)
-        @v4 = v4
-        @v6 = v6
-      end
-
-      attr_accessor :v4, :v6
-    end
-
-    def self.call(host)
-      Result.new(v4: inspect_v4, v6: inspect_v6)
-    end
-
-    private
-
-    def self.inspect_v4
-      # TODO: Implement here
-    end
-
-    def self.inspect_v6
-      # TODO: Implement here
-    end
-  end
-end

data/lib/mastodon_healthchecker/results/network_inspection.rb

@@ -1,15 +0,0 @@
-module MastodonHealthchecker
-  class NetworkInspectionResult
-    def initialize(v4: false, v6: false)
-      @v4 = v4
-      @v6 = v6
-    end
-
-    def to_s
-      "v4: #{v4}, v6: #{v6}"
-    end
-
-    attr_accessor :v4, :v6
-  end
-end
-