hscode 0.1.0

data/lib/hscode/input_parser.rb

@@ -0,0 +1,86 @@
+require 'hscode/pretty_print'
+
+module Hscode
+  class InputParser
+    attr_reader :options
+
+    def initialize
+      @options = OpenStruct.new
+    end
+
+    def parse(args)
+      option_parser.parse!(args)
+      options
+    rescue OptionParser::InvalidOption,
+           OptionParser::InvalidArgument,
+           OptionParser::MissingArgument => e
+      puts e, "See 'hscode --help'."
+      exit 1
+    end
+
+    private
+
+    def option_parser
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: hscode [options]'
+        opts.separator ''
+        opts.separator 'Specific options:'
+
+        run_verbosely(opts)
+        show_status_code(opts)
+        list_status_codes(opts)
+
+        opts.separator ''
+
+        display_help_message(opts)
+        display_version_number(opts)
+      end
+    end
+
+    def show_status_code(opts)
+      opts.on('-c', '--code CODE', Integer,
+              'Show HTTP status code documentation') do |code|
+        options.status_code = code
+      end
+    end
+
+    def run_verbosely(opts)
+      opts.on('-v', '--verbose',
+              'Show full HTTP status code documentation') do |v|
+        options.verbose = v
+      end
+    end
+
+    def list_status_codes(opts)
+      opts.on('-l', '--list', 'List all HTTP status codes') do
+        print_all_codes
+      end
+    end
+
+    def display_help_message(opts)
+      opts.on_tail('-h', '--help', 'Show this help message') do
+        puts opts, 'Examples:
+          hscode -c 200
+          hscode -c 200 -v
+          hscode -l
+        '
+        exit
+      end
+    end
+
+    def display_version_number(opts)
+      opts.on_tail('--version', 'Show version') do
+        puts Hscode::VERSION
+        exit
+      end
+    end
+
+    def print_all_codes
+      HTTP_STATUS_CODES.map do |code, info_hash|
+        colour_code = code.to_s[0]
+        PrettyPrint.print("#{code} - #{info_hash[:title]}", colour_code)
+      end
+      exit
+    end
+  end
+end

data/lib/hscode/pretty_print.rb

@@ -0,0 +1,22 @@
+module Hscode
+  class PrettyPrint
+    COLORS = {
+      '0' => 255,
+      '1' => 6,
+      '2' => 2,
+      '3' => 3,
+      '4' => 9,
+      '5' => 1
+    }.freeze
+
+    def self.print(text, colour_code)
+      puts make_pretty(text, COLORS[colour_code])
+    end
+
+    private_class_method
+
+    def self.make_pretty(text, color_code)
+      "\x1b[38;5;#{color_code}m#{text}\n"
+    end
+  end
+end

data/lib/hscode/version.rb

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

data/lib/hscode.rb

@@ -0,0 +1,37 @@
+require 'hscode/version'
+require 'hscode/input_parser'
+require 'hscode/http_status_codes'
+require 'optparse'
+require 'ostruct'
+
+module Hscode
+  class CliController
+    def self.call(args)
+      options = Hscode::InputParser.new.parse(args)
+      print_code(options)
+    end
+
+    private_class_method
+
+    def self.print_code(options)
+      status_code = HTTP_STATUS_CODES[options.status_code.to_i]
+
+      unless status_code
+        puts "#{options.status_code} is not a valid code. See 'hscode --help'."
+        exit
+      end
+
+      PrettyPrint.print(
+        "#{options.status_code} - #{status_code[:title]}",
+        options.status_code.to_s[0]
+      )
+      print_description(status_code) if options.verbose
+    end
+
+    def self.print_description(status_code)
+      status_code[:description].each do |desc|
+        PrettyPrint.print("\n#{desc}", '0')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: hscode
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Herbert Kagumba
+- Austin Kabiru
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !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: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rubycritic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: Quickly look up any status code without leaving your terminal.
+email:
+- makabby@gmail.com
+executables:
+- hscode
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/hscode
+- bin/setup
+- config/bootstrap.rb
+- hscode.gemspec
+- lib/hscode.rb
+- lib/hscode/http_status_codes.rb
+- lib/hscode/input_parser.rb
+- lib/hscode/pretty_print.rb
+- lib/hscode/version.rb
+homepage: https://github.com/akabiru/hscode
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A HTTP status code lookup command line tool.
+test_files: []