isitup 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1d2783abd53f3192afd3fad7c919ba6c5335cb9ee6a34eaebbbb6d1a49027f8
-  data.tar.gz: f82782421075d5ef0d01c3a9220914d213edd26303479ce8c14c55ae9a72e36d
+  metadata.gz: 3591027c9e48d3f3206b893f3b749d9921496cfaccf1a1f5c00523d0806b4917
+  data.tar.gz: b95216e8367b36c668e8829e19a3f8545cc5419e22c10b038888b5c0013caf4d
 SHA512:
-  metadata.gz: 46850421f535d0a16c1dfe2bc7e8434935d50e42123ed0b8b5b82709fae155f8d3661f02970663c127977f71ba722b5c979a8da9d550e210a84629069db5bb77
-  data.tar.gz: b5819d263c93c793223ee6a2b01c963118c615c7384ae908495255483161a0ac1602ebcbd64289e52125d5e8e99ba4f7456f6f7d4e8bc5ce6069efd34f0f6183
+  metadata.gz: 0aabbbd5011ae54339d3d84534828a356d397faa43e033fa4fe13d8a153a591a30506747f6496037bc20b9c3dec0baa0467203ea96df671cdb987109e14d3412
+  data.tar.gz: cb1b603b3582abaf45121d4ae2f51bba53b66a86c7e505f8da8b042ba367050f84d7db1a16717cddfae6999a32ed4adb470fb71525b38a76876493c9a77f1de5

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,33 @@
+Layout/IndentationWidth:
+  Width: 4
+
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 40
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/MethodLength: 
+  Max: 60
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Style/GlobalVars:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/RedundantBegin:
+  Enabled: false
+
+Style/WordArray:
+  EnforcedStyle: brackets
+

data/.travis.yml

@@ -0,0 +1,66 @@
+matrix:
+  include:
+  - language: ruby
+    name: "Bundler (rvm 2.4.4 & bundler 1.17.3)"
+    rvm: 2.4.4
+    before_install:
+      - gem install bundler -v 1.17.3
+  - language: ruby
+    name: "Bundler (rvm 2.4.4 & bundler 2.0.1)"
+    rvm: 2.4.4
+    before_install:
+      - gem install bundler -v 2.0.1
+  - language: ruby
+    name: "Bundler (rvm 2.5.3 & bundler 2.0.1)"
+    rvm: 2.5.3
+    before_install:
+      - gem install bundler -v 2.0.1
+  - language: ruby
+    name: "Bundler (rvm 2.6.1 & bundler 2.0.1)"
+    rvm: 2.6.1
+    before_install:
+      - gem install bundler -v 2.0.1
+  - language: ruby
+    name: "Rubocop (rvm 2.4.4)"
+    env: SKIP_INTERPRETER=true
+    rvm: 2.4.4
+    before_install:
+      - git clone https://github.com/TravisToolbox/rubocop-travis.git
+    install:
+      - ./rubocop-travis/install.sh
+    script:
+      - ./rubocop-travis/scan.sh
+  - language: ruby
+    name: "Rubocop (rvm 2.5.3)"
+    env: SKIP_INTERPRETER=true
+    rvm: 2.5.3
+    before_install:
+      - git clone https://github.com/TravisToolbox/rubocop-travis.git
+    install:
+      - ./rubocop-travis/install.sh
+    script:
+      - ./rubocop-travis/scan.sh
+  - language: ruby
+    name: "Rubocop (rvm 2.6.1)"
+    env: SKIP_INTERPRETER=true
+    rvm: 2.6.1
+    before_install:
+      - git clone https://github.com/TravisToolbox/rubocop-travis.git
+    install:
+      - ./rubocop-travis/install.sh
+    script:
+      - ./rubocop-travis/scan.sh
+  - language: ruby
+    name: "Link Checker (rvm 2.6.1)"
+    rvm: 2.6.1
+    before_install:
+      - mkdir travis
+      - git clone https://github.com/TravisToolbox/awesomebot-travis.git travis/awesomebot
+    install:
+      - ./travis/awesomebot/install.sh
+    script:
+      - ./travis/awesomebot/scan.sh
+notifications:
+  email: false
+  slack:
+    secure: T4f9HMHNwKjgyweCGboxO1YW1d23HV/tEumHAlsvgFAWcnbe3z/BdUWUxXg9ztYNQUdaTkbx9PuGH4RyYRPkSsrt1S8OLg7wT7Xjetsu41iqQb1VT0Jw9MH1SOBpFNzmW8GHrkwz9dTvsDISIossJ1WcyMLnnrA91MPRuUm0UUdvjUaGb03h9rFnoUZ0c00KzEXGB3xgHuvYKOPpErQDi7MWxBjx6PoRDARQe+MGjC/r6z+7TwVhyU+3bqz53adU1bPUfFrHlU8wBzFstzzn7yWI5pbOXXPfy92c5Wj9uwdvx62fi9mOE5bQ54Py/qkKaa+BtGznRGRU/j2ql5JxbyJOq8WaXEn93hj5gfORU/+lIWsKqFkdJcNpExhDCvZFVlLhMs3qEuccy0siujTc8XAIAaNsB77rW/4ZdFz3R402LHajGPGLcFGyQNAQNqPQiTeVS2BQqb7GWKGLHH5JnNSJIF+GheMXVCWiBDpZV/pg6foRNk4nfXYdL7ds8q9zYwqC0M0vZ1fx0uhQWrbMNFsYj1YdI7D3J9RTTrS1iM5ROkKmXGYXlgUNcEO1W/zRhGNV2dbnCE6p3tSHzQ7QFANJKtZT0pL+gZJ5KRhFF6n5GNCwgZALf4QSYCQG9vjiffIF4qhsSPjboQYv8aydqXXye1qXm2O28FiRplnDJYA=

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 1.0.0 (June 28, 2019)
+
+* Initial Release ([@TGWolf][])
+
+[@TGWolf]: https://github.com/TGWolf

data/CODEOWNERS

@@ -0,0 +1,7 @@
+# The codeowners file:
+#
+# For more information please read: https://help.github.com/articles/about-codeowners/
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+*       @AntiPhotonltd/reviewers

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 tim.gurney@timgurney.net. 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/#{repo_name}" }
+
+# Specify your gem's dependencies in isitup.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tim Gurney aka Wolf
+
+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,55 @@
+[![Build Status](https://img.shields.io/travis/AntiPhotonltd/isitup/master.svg)](https://travis-ci.org/AntiPhotonltd/isitup)
+[![Software License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
+[![Release](https://img.shields.io/github/release/AntiPhotonltd/isitup.svg)](https://github.com/AntiPhotonltd/isitup/releases/latest)
+[![Gem Version](https://badge.fury.io/rb/isitup.svg)](https://badge.fury.io/rb/isitup)
+[![Github commits (since latest release)](https://img.shields.io/github/commits-since/AntiPhotonltd/isitup/latest.svg)](https://github.com/AntiPhotonltd/isitup/commits)
+[![GitHub repo size in bytes](https://img.shields.io/github/repo-size/AntiPhotonltd/isitup.svg)](https://github.com/AntiPhotonltd/isitup)
+[![GitHub contributors](https://img.shields.io/github/contributors/AntiPhotonltd/isitup.svg)](https://github.com/AntiPhotonltd/isitup)
+
+# isitup?
+
+This is a simple little gem for checking is a site is up or not.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'isitup'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install isitup
+
+## Usage
+
+```ruby
+Isitup.check("www.antiphoton.com")
+```
+
+## 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).
+
+## Testing
+
+For local testing make sure that you run `bundle exec rspec spec` and then `rake install` to install the gem locally.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/AntiPhotonltd/isitup. 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 SSLInfo project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/AntiPhotonltd/isitup/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 "isitup"
+
+# 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/exe/isitup

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'isitup'
+
+# -------------------------------------------------------------------------------- #
+# Process Arguments                                                                #
+# -------------------------------------------------------------------------------- #
+# This function will process the input from the command line and work out what it  #
+# is that the user wants to see.                                                   #
+#                                                                                  #
+# This is the main processing function where all the processing logic is handled.  #
+# -------------------------------------------------------------------------------- #
+
+def process_arguments
+    options = {}
+    # Enforce the presence of
+    mandatory = %I[domain]
+
+    optparse = OptionParser.new do |opts|
+        opts.banner = "Usage: #{$PROGRAM_NAME}"
+
+        opts.on('-h', '--help', 'Display this screen') do
+            puts opts
+            exit(1)
+        end
+        opts.on('-c', '--use-color', 'Use colour when outputting the results') do |_digits|
+            options[:color] = true
+        end
+        opts.on('-d', '--domain string', 'The domain name to check') do |domain|
+            options[:domain] = domain
+        end
+    end
+
+    begin
+        optparse.parse!
+        options[:message] = ARGF.read unless STDIN.tty? # override message parameter if data is piped in
+        missing = mandatory.select { |param| options[param].nil? }
+        raise OptionParser::MissingArgument.new(missing.join(', ')) unless missing.empty?
+    rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+        puts e.to_s
+        puts optparse
+        exit
+    end
+
+    puts Isitup.check(options[:domain], options)
+end
+
+# -------------------------------------------------------------------------------- #
+# Main()                                                                           #
+# -------------------------------------------------------------------------------- #
+# The main function where all of the heavy lifting and script config is done.      #
+# -------------------------------------------------------------------------------- #
+
+def main
+    process_arguments
+end
+
+main
+
+# -------------------------------------------------------------------------------- #
+# End of Script                                                                    #
+# -------------------------------------------------------------------------------- #
+# This is the end - nothing more to see here.                                      #
+# -------------------------------------------------------------------------------- #

data/isitup.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "isitup/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "isitup"
+  spec.version       = Isitup::VERSION
+  spec.authors       = ['Tim Gurney aka Wolf']
+  spec.email         = ['wolf@tgwolf.com']
+
+  spec.summary       = %q{A simple gem to check if a site is up or not.}
+  spec.description   = %q{A simple gem to check if a site is up or not.}
+  spec.homepage      = "https://github.com/AntiPhotonltd/isitup"
+  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.required_ruby_version = '>= 2.3.0'
+
+  spec.add_development_dependency "bundler", ">= 1.17", "< 3.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_development_dependency "colorize", "~> 0.8.1"
+  spec.add_development_dependency "rest-client", "~> 2.0.2"
+
+  spec.add_runtime_dependency "colorize", "~> 0.8.1"
+  spec.add_runtime_dependency "rest-client", "~> 2.0.2"
+end

data/lib/isitup.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'isitup/version'
+
+require 'colorize'
+require 'json'
+require 'ostruct'
+require 'rest-client'
+
+#
+# Docs to follow
+#
+module Isitup
+    def self.check(domain, options = {})
+        data = query_api(domain)
+        process_data(data, options)
+    end
+
+    def self.query_api(domain)
+        url = "http://isitup.org/#{domain}.json"
+        response = RestClient.get(url)
+        data = JSON.parse(response)
+
+        OpenStruct.new(
+            domain: data['domain'],
+            status: data['status_code'],
+            time: data['response_time']
+        )
+    rescue RestClient::Exception => e
+        e.response
+        nil
+    end
+
+    def self.process_data(data, options)
+        case data.status
+        when 1
+            if options[:color]
+                "The domain: #{data.domain} is up! Response time: #{data.time}".green
+            else
+                "The domain: #{data.domain} is up! Response time: #{data.time}"
+            end
+        when 2
+            if options[:color]
+                "The domain: #{data.domain} is down".red
+            else
+                "The domain: #{data.domain} is down"
+            end
+        else
+            if options[:color]
+                "#{data.domain} is not a valid domain!".blue
+            else
+                "#{data.domain} is not a valid domain!"
+            end
+        end
+    end
+end

data/lib/isitup/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Isitup
+    VERSION = '1.0.0'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: isitup
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tim Gurney aka Wolf
@@ -117,10 +117,28 @@ dependencies:
 description: A simple gem to check if a site is up or not.
 email:
 - wolf@tgwolf.com
-executables: []
+executables:
+- isitup
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODEOWNERS
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/isitup
+- isitup.gemspec
+- lib/isitup.rb
+- lib/isitup/version.rb
 homepage: https://github.com/AntiPhotonltd/isitup
 licenses:
 - MIT
@@ -133,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="