mastodon_healthchecker 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf3b0f82d8322a8b5ab8ee6ffa15f2ae69b3f74a
+  data.tar.gz: 295ec16abde24bdf984a80d3b63374a2a33c5669
+SHA512:
+  metadata.gz: 19f358c52a57860b6b9875f6db23b6942bd71f65a86e8cc617170cbb1d5e1017112e05e838bda288b030b7ea70667bc615d243532f265cdaa2c35dce5efb6777
+  data.tar.gz: 12a936ee80f32546e1d4f9f73babc768fbf4ca9fc43d6e995333384cf918a848ced71f73f5c7560b7deb68307cbfe6d38a67f59e3ec525db2305762225a4f945

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1 @@
+

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

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 behavior 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 behavior by participants include:
+
+* The use of sexualized 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
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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 behaviors 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 behavior may be
+reported by contacting the project team at TODO: Write your email address. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mastodon_healthchecker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,60 @@
+# Mastodon Health-checker
+
+mastodon_healthchecker provides a function which checks the connectability,
+and other statuses of a mastodon instance.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mastodon_healthchecker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mastodon_healthchecker
+
+## Usage
+
+```ruby
+gem 'mastodon_healthchecker'
+
+stat = MastodonHealthchecker.perform('mstdn.jp')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/nullkal/mastodon_healthchecker. 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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MastodonHealthchecker project’s codebases, issu
+urackers, chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/[USERNAME]/mastodon_healthchecker/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mastodon_healthchecker'
+
+# 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
+
+require 'irb'
+IRB.start(__FILE__)

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

@@ -0,0 +1,20 @@
+require 'mastodon_healthchecker/version'
+
+module MastodonHealthchecker
+  autoload :AvailabilityInspector,
+           'mastodon_healthchecker/inspectors/availability'
+  autoload :RecordExistenceInspector,
+           'mastodon_healthchecker/inspectors/record_existence'
+
+  DefaultInspectionItems = {
+    exists_record: RecordExistenceInspector,
+    up: AvailabilityInspector
+  }.freeze
+
+  def self.perform(host, inspection_items: DefaultInspectionItems)
+    inspection_items.inject({}) do |result, (key, item)|
+      result[key] = item.call(host)
+      result
+    end
+  end
+end

data/lib/mastodon_healthchecker/inspectors/availability.rb

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,26 @@
+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

@@ -0,0 +1,15 @@
+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
+

data/lib/mastodon_healthchecker/version.rb

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

data/mastodon_healthchecker.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mastodon_healthchecker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mastodon_healthchecker'
+  spec.version       = MastodonHealthchecker::VERSION
+  spec.authors       = ['nullkal']
+  spec.email         = ['nullkal@nil.nu']
+
+  spec.summary       = 'Perform the health check of a mastodon instance'
+  spec.description   = <<-DESCRIPTION
+mastodon_healthchecker provides a function which checks the connectability,
+and other statuses of a mastodon instance.
+  DESCRIPTION
+  spec.homepage      = 'https://github.com/nullkal/mastodon_healthchecker'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49.1'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: mastodon_healthchecker
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- nullkal
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+description: |
+  mastodon_healthchecker provides a function which checks the connectability,
+  and other statuses of a mastodon instance.
+email:
+- nullkal@nil.nu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- 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/version.rb
+- mastodon_healthchecker.gemspec
+homepage: https://github.com/nullkal/mastodon_healthchecker
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Perform the health check of a mastodon instance
+test_files: []