http_codes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c9a94a9b12b36c9d6b1dc4d74de65eacffc5e63
+  data.tar.gz: 45019a28a0f498200df9e3cbd20af7973916e85f
+SHA512:
+  metadata.gz: 9a2ab41bfec7aa34e408f08a13e8a890029fbfdf54c6ea65a1c448442a9252d4febff3427705476dc6970f4299558e21bc1e06d98bb1944decd06a1d60fe74a4
+  data.tar.gz: 817c2dedcf46016d18fd75df8cdc60675479c75dab806b82aa87728b94f1135a4a17f71718f4940962d19cd98578a776d114da39a9ee6eb5a6682a412e5cda81

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 2.1.0
+  - 1.9.3
+  - jruby-head
+  - jruby-19mode
+matrix:
+  allow_failures:
+    - jruby-head
+    - jruby-19mode
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'minitest'
+gem 'webmock'
+gem 'vcr'
+
+group :setup do
+  gem 'rake'
+end

data/README.md

@@ -0,0 +1,36 @@
+# Http_Codes [![Build Status](https://travis-ci.org/csrordzhn/httpcodes.svg?branch=master)](https://travis-ci.org/csrordzhn/httpcodes)
+## Description
+The idea behind this project is to have HTTP codes as a searchable list in your code or usable in pry
+instead of going to Wikipedia and search for codes. In the end, its all about saving you some clicks.
+
+The source for the codes is [Internet Assigned Numbers Authority.](http://www.iana.org/assignments/http-status-codes/http-status-codes-1.csv)
+
+## Usage
+Install at the command line,
+```sh
+$ gem install http_codes
+```
+include in your project gemfile,
+```ruby
+gem 'http_codes'
+```
+or require in directly in pry
+```ruby
+require 'http_codes'
+```
+Once installed, you can run from the command line.
+```sh
+$ http_codes desc/code val
+```
+Search by description 'BAD' will return a list of the codes that contain the value 'BAD':
+```sh
+$ http_codes desc BAD
+400 - BAD REQUEST
+502 - BAD GATEWAY
+```
+Search by code number 100 will return the description that matches that code:
+```sh
+$ http_codes code 100
+100 - CONTINUE
+```
+For usage inside a Ruby project, refer to the file ```usage_example.rb```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+task :default => [:spec]
+
+desc 'Run specs'
+Rake::TestTask.new(name=:spec) do |t|
+  t.pattern = 'spec/*_spec.rb'
+end

data/bin/http_codes

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# Local
+# require '../lib/http_codes/http_codes_fetcher.rb'
+# Production
+require 'http_codes'
+
+begin
+  fail ArgumentError, "Usage: http_codes [desc/code] [val]\n" if ARGV.count != 2
+
+  mode = ARGV[0]
+  val = ARGV[1]
+  code_list = HttpCodesFetcher::Httpcodes.new
+
+  if mode == 'desc'
+    code_list.find_by_desc(val).map do |c|
+      puts c
+    end
+  elsif mode == 'code'
+    puts code_list.find_by_code(val.to_i)
+  end
+
+rescue => e
+  puts "Something went wrong: #{e}"
+end

data/http_codes.gemspec

@@ -0,0 +1,21 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'http_codes/version'
+
+Gem::Specification.new do |s|
+  s.name = 'http_codes'
+  s.version = HttpCodesFetcher::VERSION
+  s.date = HttpCodesFetcher::DATE
+  s.executables << 'http_codes'
+  s.summary = 'Get http codes'
+  s.description = 'Provides a easy and fast way to find http codes by number or description.'
+  s.authors = ['Cesar Ordonez']
+  s.email = ['c_man182@yahoo.com']
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files spec/*`.split("\n")
+  s.homepage = 'https://github.com/csrordzhn/httpcodes'
+  s.license = 'MIT'
+
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'webmock'
+end

data/lib/http_codes.rb

@@ -0,0 +1,2 @@
+require 'http_codes/http_codes_fetcher.rb'
+require 'http_codes/version.rb'

data/lib/http_codes/http_codes_fetcher.rb

@@ -0,0 +1,43 @@
+require 'csv'
+require 'open-uri'
+
+# Creates a hash of http codes from iana.org for developer reference inside pry
+module HttpCodesFetcher
+  class Httpcodes
+    def initialize
+      @list = code_list
+    end
+
+    def code_list
+      url = 'http://www.iana.org/assignments/http-status-codes/http-status-codes-1.csv'
+      codes = {}
+      CSV.new(open(url), headers: :first_row).each do |line|
+        codes[line['Description'].upcase] = line['Value'].to_i
+      end
+      codes
+    end
+
+    def find_by_code(code)
+      desc = @list.key(code)
+      fail 'Code not found' unless @list.key?(desc)
+      @list[desc].to_s + ' - ' + desc
+    rescue => e
+      e.message
+    end
+
+    def find_by_desc(desc)
+      search_val = Regexp.new desc.upcase
+      matches = @list.keys.grep search_val
+      fail 'Description not found' unless matches.size > 0
+      matches.map do |k|
+        @list[k].to_s + ' - ' + k.to_s
+      end
+    rescue => e
+      e.message
+    end
+
+    def size
+      @list.size
+    end
+  end
+end

data/lib/http_codes/version.rb

@@ -0,0 +1,6 @@
+# Versioning
+
+module HttpCodesFetcher
+  VERSION = '0.1.0'
+  DATE = '2015-11-05'
+end

data/spec/fixtures/vcr_cassettes/http_csv.yml

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://www.iana.org/assignments/http-status-codes/http-status-codes-1.csv
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Last-Modified:
+      - Thu, 05 Nov 2015 01:13:26 GMT
+      Vary:
+      - Accept-Encoding
+      Content-Type:
+      - text/csv; charset=UTF-8; header=present
+      Cache-Control:
+      - public, max-age=3600
+      Content-Length:
+      - '1031'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Thu, 05 Nov 2015 15:35:11 GMT
+      Connection:
+      - keep-alive
+      Server:
+      - Apache
+      X-Cache-Hits:
+      - '0'
+    body:
+      encoding: ASCII-8BIT
+      string: "Value,Description,Reference\r\n100,Continue,\"[RFC7231, Section 6.2.1]\"\r\n101,Switching
+        Protocols,\"[RFC7231, Section 6.2.2]\"\r\n102,Processing,[RFC2518]\r\n103-199,Unassigned,\r\n200,OK,\"[RFC7231,
+        Section 6.3.1]\"\r\n201,Created,\"[RFC7231, Section 6.3.2]\"\r\n202,Accepted,\"[RFC7231,
+        Section 6.3.3]\"\r\n203,Non-Authoritative Information,\"[RFC7231, Section
+        6.3.4]\"\r\n204,No Content,\"[RFC7231, Section 6.3.5]\"\r\n205,Reset Content,\"[RFC7231,
+        Section 6.3.6]\"\r\n206,Partial Content,\"[RFC7233, Section 4.1]\"\r\n207,Multi-Status,[RFC4918]\r\n208,Already
+        Reported,[RFC5842]\r\n209-225,Unassigned,\r\n226,IM Used,[RFC3229]\r\n227-299,Unassigned,\r\n300,Multiple
+        Choices,\"[RFC7231, Section 6.4.1]\"\r\n301,Moved Permanently,\"[RFC7231,
+        Section 6.4.2]\"\r\n302,Found,\"[RFC7231, Section 6.4.3]\"\r\n303,See Other,\"[RFC7231,
+        Section 6.4.4]\"\r\n304,Not Modified,\"[RFC7232, Section 4.1]\"\r\n305,Use
+        Proxy,\"[RFC7231, Section 6.4.5]\"\r\n306,(Unused),\"[RFC7231, Section 6.4.6]\"\r\n307,Temporary
+        Redirect,\"[RFC7231, Section 6.4.7]\"\r\n308,Permanent Redirect,[RFC7538]\r\n309-399,Unassigned,\r\n400,Bad
+        Request,\"[RFC7231, Section 6.5.1]\"\r\n401,Unauthorized,\"[RFC7235, Section
+        3.1]\"\r\n402,Payment Required,\"[RFC7231, Section 6.5.2]\"\r\n403,Forbidden,\"[RFC7231,
+        Section 6.5.3]\"\r\n404,Not Found,\"[RFC7231, Section 6.5.4]\"\r\n405,Method
+        Not Allowed,\"[RFC7231, Section 6.5.5]\"\r\n406,Not Acceptable,\"[RFC7231,
+        Section 6.5.6]\"\r\n407,Proxy Authentication Required,\"[RFC7235, Section
+        3.2]\"\r\n408,Request Timeout,\"[RFC7231, Section 6.5.7]\"\r\n409,Conflict,\"[RFC7231,
+        Section 6.5.8]\"\r\n410,Gone,\"[RFC7231, Section 6.5.9]\"\r\n411,Length Required,\"[RFC7231,
+        Section 6.5.10]\"\r\n412,Precondition Failed,\"[RFC7232, Section 4.2]\"\r\n413,Payload
+        Too Large,\"[RFC7231, Section 6.5.11]\"\r\n414,URI Too Long,\"[RFC7231, Section
+        6.5.12]\"\r\n415,Unsupported Media Type,\"[RFC7231, Section 6.5.13][RFC7694,
+        Section 3]\"\r\n416,Range Not Satisfiable,\"[RFC7233, Section 4.4]\"\r\n417,Expectation
+        Failed,\"[RFC7231, Section 6.5.14]\"\r\n418-420,Unassigned,\r\n421,Misdirected
+        Request,\"[RFC7540, Section 9.1.2]\"\r\n422,Unprocessable Entity,[RFC4918]\r\n423,Locked,[RFC4918]\r\n424,Failed
+        Dependency,[RFC4918]\r\n425,Unassigned,\r\n426,Upgrade Required,\"[RFC7231,
+        Section 6.5.15]\"\r\n427,Unassigned,\r\n428,Precondition Required,[RFC6585]\r\n429,Too
+        Many Requests,[RFC6585]\r\n430,Unassigned,\r\n431,Request Header Fields Too
+        Large,[RFC6585]\r\n432-499,Unassigned,\r\n500,Internal Server Error,\"[RFC7231,
+        Section 6.6.1]\"\r\n501,Not Implemented,\"[RFC7231, Section 6.6.2]\"\r\n502,Bad
+        Gateway,\"[RFC7231, Section 6.6.3]\"\r\n503,Service Unavailable,\"[RFC7231,
+        Section 6.6.4]\"\r\n504,Gateway Timeout,\"[RFC7231, Section 6.6.5]\"\r\n505,HTTP
+        Version Not Supported,\"[RFC7231, Section 6.6.6]\"\r\n506,Variant Also Negotiates,[RFC2295]\r\n507,Insufficient
+        Storage,[RFC4918]\r\n508,Loop Detected,[RFC5842]\r\n509,Unassigned,\r\n510,Not
+        Extended,[RFC2774]\r\n511,Network Authentication Required,[RFC6585]\r\n512-599,Unassigned,\r\n"
+    http_version: 
+  recorded_at: Thu, 05 Nov 2015 15:35:11 GMT
+recorded_with: VCR 3.0.0

data/spec/http_codes_spec.rb

@@ -0,0 +1,44 @@
+require 'minitest/autorun'
+require './lib/http_codes'
+require 'vcr'
+require 'webmock/minitest'
+
+def random_str(n)
+  srand(n)
+  (0..n).map { ('a'..'z').to_a[rand(26)]}.join
+end
+random_code = Random.rand(1000...9999)
+
+VCR.configure do |config|
+  config.cassette_library_dir = './spec/fixtures/vcr_cassettes'
+  config.hook_into :webmock
+end
+
+VCR.use_cassette('http_csv') do
+  httpcodes_list = HttpCodesFetcher::Httpcodes.new
+
+describe 'httpcodes' do
+
+  it 'should load the code list' do
+    httpcodes_list.size.must_be :>=, 1
+  end
+  it 'should return a string with code and desc' do
+    code_desc = httpcodes_list.find_by_code(100)
+    code_desc.wont_be_empty
+  end
+  it 'should return err when code not found' do
+    code_desc = httpcodes_list.find_by_code(random_code)
+    code_desc.must_match "Code not found"
+  end
+  it 'should return an string array with code and description' do
+    code_list = httpcodes_list.find_by_desc('Continue')
+    code_list.must_be_instance_of Array
+    code_list.wont_be_empty
+  end
+  it 'should return err when code not found' do
+    code_list = httpcodes_list.find_by_desc(random_str(15))
+    code_list.must_match "Description not found"
+  end
+
+end
+end

data/usage_example.rb

@@ -0,0 +1,10 @@
+
+require 'http_codes'
+# create a new httpcodes
+http_codes = HttpCodesFetcher::Httpcodes.new
+
+#puts http_codes.size
+puts http_codes.find_by_code(100)
+# => string '100 - CONTINUE'
+puts http_codes.find_by_desc('BAD')
+# => array ['400 - BAD REQUEST','502 - BAD GATEWAY']

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: http_codes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cesar Ordonez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a easy and fast way to find http codes by number or description.
+email:
+- c_man182@yahoo.com
+executables:
+- http_codes
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/http_codes
+- http_codes.gemspec
+- lib/http_codes.rb
+- lib/http_codes/http_codes_fetcher.rb
+- lib/http_codes/version.rb
+- spec/fixtures/vcr_cassettes/http_csv.yml
+- spec/http_codes_spec.rb
+- usage_example.rb
+homepage: https://github.com/csrordzhn/httpcodes
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Get http codes
+test_files:
+- spec/fixtures/vcr_cassettes/http_csv.yml
+- spec/http_codes_spec.rb