http_help 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82311d2856d7a90f24e6646474c44f8ca8c6e766
+  data.tar.gz: 550b3329dd574829b0b2efe47e084d83d1cde4e9
+SHA512:
+  metadata.gz: ad5cc67693e4307828bfa7a5c5f66f92de36bec795b74ece276f11ff49f11ba2ceb36aaaa41c032e5fd880d8e2d42c283f6b9e47590e0e92d0de02a287751f72
+  data.tar.gz: 9c4232ccd7ffb46969141ea57f87d37bc0f163ac36c465fc33e5501249c1e1ac3ab938cf91bb7ecab3d681937886386b28fd5e6c3dce097f7116a8a11fcef6eb

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in http_help.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Błażej Pankowiak
+
+MIT License
+
+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,23 @@
+# HttpHelp
+
+Find HTTP status codes from the command line.
+
+## Installation
+
+```ruby
+gem install http_help
+```
+
+## Usage
+
+```http [number]``` finds the description of a given code
+```http [description]``` finds the number of a given description
+```http all``` lists all status codes
+
+## Contributing
+
+1. Fork it ( https://github.com/blase/http_help/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/bin/http

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'http_help'
+
+begin
+  puts HttpHelp.find ARGV.join(" ")
+rescue HttpHelp::StatusCodeNotFoundException, HttpHelp::StatusNotFoundException => e
+  puts e.message
+  puts "You can list all statuses by running: http all"
+end

data/http_help.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'http_help/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "http_help"
+  spec.version       = HttpHelp::VERSION
+  spec.authors       = ["Błażej Pankowiak"]
+  spec.email         = ["blasecodes@gmail.com"]
+  spec.summary       = %q{Find HTTP status codes from the command line}
+  spec.homepage      = "http://github.com/blase/http_help"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/http_help.rb

@@ -0,0 +1,52 @@
+require "http_help/version"
+require 'yaml'
+require 'string'
+
+module HttpHelp
+  class StatusCodeNotFoundException < Exception; end
+  class StatusNotFoundException < Exception; end
+
+  def self.find status
+    if status == "all"
+      list_all_statuses
+    elsif status.to_i > 0
+      find_by_code status.to_i
+    else
+      find_by_description status
+    end
+  end
+
+  private
+
+  def self.find_by_code status_code
+    status_codes.each do |category|
+      category.each do |code|
+        return code[status_code] unless code[status_code].nil?
+      end
+    end
+
+    raise StatusCodeNotFoundException, "Status code not found."
+  end
+
+  def self.find_by_description status_description
+    status_codes.keys.each do |category|
+      status_codes[category].each_pair do |code, description|
+        return "#{code}: #{description}" if description.downcase.levenshtein(status_description.downcase) < 3
+      end
+    end
+
+    raise StatusNotFoundException, "Status not found."
+  end
+
+  def self.list_all_statuses
+    File.open(File.join(__dir__, 'status_codes.yml')) do |file|
+      while line = file.gets
+        puts line
+      end
+    end
+  end
+
+  def self.status_codes
+    YAML::load_file(File.join(__dir__, 'status_codes.yml'))
+  end
+end

data/lib/http_help/version.rb

@@ -0,0 +1,3 @@
+module HttpHelp
+  VERSION = "0.0.1"
+end

data/lib/status_codes.yml

@@ -0,0 +1,46 @@
+informational:
+  100: Continue
+  101: Switching Protocols
+successful:
+  200: OK
+  201: Created
+  202: Accepted
+  203: Non-Authoritative Information
+  204: No Content
+  205: Reset Content
+  206: Partial Content
+redirection:
+  300: Multiple Choices
+  301: Moved Permanently
+  302: Found
+  303: See Other
+  304: Not Modified
+  305: Use Proxy
+  306: (Unused)
+  307: Temporary Redirect
+client error:
+  400: Bad Request
+  401: Unauthorized
+  402: Payment Required
+  403: Forbidden
+  404: Not Found
+  405: Method Not Allowed
+  406: Not Acceptable
+  407: Proxy Authentication Required
+  408: Request Timeout
+  409: Conflict
+  410: Gone
+  411: Length Required
+  412: Precondition Failed
+  413: Request Entity Too Large
+  414: Request-URI Too Long
+  415: Unsupported Media Type
+  416: Requested Range Not Satisfiable
+  417: Expectation Failed
+server error:
+  500: Internal Server Error
+  501: Not Implemented
+  502: Bad Gateway
+  503: Service Unavailable
+  504: Gateway Timeout
+  505: HTTP Version Not Supported

data/lib/string.rb

@@ -0,0 +1,25 @@
+class String
+  # Stolen from:
+  # http://en.wikibooks.org/wiki/Algorithm_Implementation/Strings/Levenshtein_distance#Ruby
+  def levenshtein(string)
+    matrix = [(0..self.length).to_a]
+    (1..string.length).each do |j|
+      matrix << [j] + [0] * (self.length)
+    end
+
+    (1..string.length).each do |i|
+      (1..self.length).each do |j|
+        if self[j-1] == string[i-1]
+          matrix[i][j] = matrix[i-1][j-1]
+        else
+          matrix[i][j] = [
+            matrix[i-1][j],
+            matrix[i][j-1],
+            matrix[i-1][j-1],
+          ].min + 1
+        end
+      end
+    end
+    return matrix.last.last
+  end
+end

data/test/test_http_help.rb

@@ -0,0 +1,32 @@
+require 'http_help'
+require 'test/unit'
+
+class TestHttpHelp < Test::Unit::TestCase
+  def test_that_it_can_find_response_description
+    assert_equal "Not Found", HttpHelp.find(404)
+  end
+
+  def test_that_it_can_find_response_code
+    assert_equal "404: Not Found", HttpHelp.find("Not Found")
+  end
+
+  def test_that_it_can_find_response_code_given_different_letter_case
+    assert_equal "404: Not Found", HttpHelp.find("nOT fOUND")
+  end
+
+  def test_that_it_can_find_response_code_given_similar_description
+    assert_equal "404: Not Found", HttpHelp.find("got fund")
+  end
+
+  def test_that_it_raises_an_exception_when_code_is_not_found
+    assert_raise_with_message HttpHelp::StatusCodeNotFoundException, "Status code not found." do
+      HttpHelp.find("999")
+    end
+  end
+
+  def test_that_it_raises_an_exception_when_status_is_not_found
+    assert_raise_with_message HttpHelp::StatusNotFoundException, "Status not found." do
+      HttpHelp.find("Some weird status")
+    end
+  end
+end

data/test/test_string.rb

@@ -0,0 +1,8 @@
+require 'string'
+require 'test/unit'
+
+class TestString < Test::Unit::TestCase
+  def test_that_it_calculates_levenshtein_distance_correctly
+    assert_equal 3, "kitten".levenshtein("sitting")
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: http_help
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Błażej Pankowiak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: 
+email:
+- blasecodes@gmail.com
+executables:
+- http
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/http
+- http_help.gemspec
+- lib/http_help.rb
+- lib/http_help/version.rb
+- lib/status_codes.yml
+- lib/string.rb
+- test/test_http_help.rb
+- test/test_string.rb
+homepage: http://github.com/blase/http_help
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Find HTTP status codes from the command line
+test_files:
+- test/test_http_help.rb
+- test/test_string.rb