response_code 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee5e9a44623d499f56154fe4e29fb9d7cd694dc5c468f6236bc599c2cec981f8
-  data.tar.gz: a6c9d2dd370dee1b9f90fada6752181faa0b605789879abc23ae046b7434a801
+  metadata.gz: e11cb7c1bee1dee1e2b7c291422bcb11dbc6224e7d5a3f71839ce78885c0ee86
+  data.tar.gz: c85eecdf80cbfc6c9f5a8ccf8f9c1a16e8bd4ed560ac05a790789888353a6487
 SHA512:
-  metadata.gz: b3baf5f6d77a84ebb270234a353959f0320193b4a58c9d4010271a1eee95501a86cb4178b32be41d52bd6e450e100faf169a37ea78ed6e251770a05795723b46
-  data.tar.gz: f7d563400eb11fb1e3e66998d3706bdbe8f709fe53c52d553a8fa6705d02917cd45c5bc7d8bf3a48beac0c67da57def5de006f6a38ac4e81a3f3239ae1d97c01
+  metadata.gz: 47a97ea8beb5f06ff53189e479a0c2bbfe92f5a770b312315eba744005bf3c9f065e6b1bb40815393240e9b7d049bfacac33eb8892076b73d0379a6a3e4afa1e
+  data.tar.gz: 9857019a6488047faf7bfe08e38c49245010d0e9dc53b82948364447445b0f37e2dd38091d4c823fab1ac34c676ca8254e929ca6e70b2dc73dd885370bf0e62a

data/README.md

@@ -1,2 +1,59 @@
-# response_code
-Response Code in readable way.
+# ResponseCode
+
+[![Build Status](https://travis-ci.org/torokmark/response_code.svg?branch=master)](https://travis-ci.org/torokmark/response_code)
+[![Gem Version](https://badge.fury.io/rb/response_code.svg)](https://badge.fury.io/rb/response_code)
+
+Who knows which response code represents the partial content? Or what code belongs to the error that says the request uri too long? Do you know the status code of the teapot?
+
+ResponseCode is a tiny tool intended to give a handy way of handling response status codes with text instead of numbers.
+
+### Install
+
+```ruby
+gem install response_code
+```
+
+or
+
+```ruby
+gem 'response_code'
+```
+
+### Usage
+
+```ruby
+require 'response_code'
+
+puts ResponseCode.ok
+# => 200
+```
+
+Using sinatra
+
+```ruby
+#!/usr/bin/env ruby 
+
+require 'sinatra'
+require 'response_code'
+
+get('/') {
+  status ResponseCode.im_a_teapot
+  'I\'m a teapot!' 
+}
+```
+
+Executing `curl -i localhost:4567`
+
+```
+HTTP/1.1 418  
+Content-Type: text/html;charset=utf-8
+Content-Length: 13
+X-Xss-Protection: 1; mode=block
+X-Content-Type-Options: nosniff
+X-Frame-Options: SAMEORIGIN
+Server: WEBrick/1.4.2 (Ruby/2.5.0/2017-12-25)
+Date: Thu, 03 May 2018 18:24:12 GMT
+Connection: Keep-Alive
+
+I'm a teapot!
+```

data/bin/response_code

@@ -1,5 +1,9 @@
 #!/usr/bin/env ruby
 
 require 'response_code'
+require 'response_code/aborted'
 
 puts "Response code of OK is: #{ ResponseCode.ok  }"
+
+puts "#{ ResponseCode::Aborted.lookup(103) }"
+puts "#{ ResponseCode::Aborted.checkpoint }"

data/features/response_code.feature

@@ -0,0 +1,112 @@
+Feature: ResponseCode
+  In order to use readable response codes
+  As a developer
+  I want to use ResponseCode for that
+  
+  Scenario Outline: Codes
+    When I call a method with <name>
+    Then it should give me <code>
+
+    When I call lookup with <code>
+    Then it should return me <name>
+    
+    Examples:
+      | name            | code |
+      | continue| 100|
+			| switching_protocols| 101|
+      | processing| 102|
+      | ok| 200|
+      | created| 201|
+      | accepted| 202|
+      | non_authoritive_information| 203|
+      | no_content| 204|
+      | reset_content| 205|
+      | partial_content| 206|
+      | multi_status| 207|
+      | already_reported| 208|
+      | im_used| 226|
+      | multiple_choices| 300|
+      | moved_permanentaly| 301|
+      | found| 302|
+      | see_other| 303|
+      | not_modified| 304|
+      | use_proxy| 305|
+      | temporary_redirect| 307|
+      | permanent_redirect| 308|
+      | bad_request| 400|
+      | unauthorized| 401|
+      | payment_required| 402|
+      | forbidden| 403|
+      | not_found| 404|
+      | method_not_allowed| 405|
+      | not_acceptable| 406|
+      | proxy_authentication_required| 407|
+      | request_timeout| 408|
+      | conflict| 409|
+      | gone| 410|
+      | length_required| 411|
+      | precondition_failed| 412|
+      | payload_too_large|  413|
+      | request_uri_too_long| 414|
+      | unsupported_media_type| 415|
+      | requested_range_not_satisfiable| 416|
+      | expectation_failed| 417|
+      | im_a_teapot| 418|
+      | misdirected_request| 421|
+      | unprocessable_entity| 422|
+      | locked| 423|
+      | failed_dependency| 424|
+      | upgrade_required| 426|
+      | precondition_required| 428|
+      | internal_server_error| 500|
+      | not_implemented| 501|
+      | bad_gateway| 502|
+      | service_unavailable| 503|
+      | gateway_timeout| 504|
+      | http_version_not_supported| 505|
+      | variant_also_negotiates| 506|
+      | insufficiant_storage| 507|
+      | loop_detected| 508|
+      | not_extended| 510|
+      | network_authentication_required| 511|
+      | network_connect_timeout_error| 599|
+
+  Scenario Outline: Unofficial response codes 
+    When I call a method in <module> with <name>
+    Then it should give me <code> from <module>
+
+    When I call <module> lookup with <code>
+    Then it should return me <name> from <module>
+    
+    Examples:
+      | module           | name                                 | code |
+      | Aborted          | checkpoint                           | 103  |
+      | SpringFramework  | method_failure                       | 420  |
+      | Twitter          | enhance_your_calm                    | 420  |
+      | Microsoft        | blocked_by_windows_parental_controls | 450  |
+      | Esri             | invalid_token                        | 498  |
+      | Esri             | token_required                       | 499  |
+      | ApacheWebServer  | bandwith_limit_exceeded              | 509  |
+      | Pantheon         | site_is_frozen                       | 530  |
+      | Signal           | network_read_timeout_error           | 598  |
+      | IIS              | login_time_out                       | 440  |
+      | IIS              | retry_with                           | 449  |
+      | IIS              | redirect                             | 451  |
+      | Nginx            | no_response                          | 444  |
+      | Nginx            | request_header_too_large             | 494  |
+      | Nginx            | ssl_certificate_error                | 495  |
+      | Nginx            | ssl_certificate_required             | 496  |
+      | Nginx            | http_request_sent_to_https_port      | 497  |
+      | Nginx            | client_closed_request                | 499  |
+      | Cloudflare       | unknown_error                        | 520  |
+      | Cloudflare       | web_server_is_down                   | 521  |
+      | Cloudflare       | connection_timed_out                 | 522  |
+      | Cloudflare       | origin_is_unreachable                | 523  |
+      | Cloudflare       | a_timeout_occurred                   | 524  |
+      | Cloudflare       | ssl_handshake_failed                 | 525  |
+      | Cloudflare       | invalid_ssl_certificate              | 526  |
+      | Cloudflare       | railgun_error                        | 527  |
+      | Cloudflare       | origin_dns_error                     | 530  |
+
+
+	

data/features/step_definitions/response_code_steps.rb

@@ -0,0 +1,17 @@
+require 'response_code'
+
+When(/^I call a method with (\w+)$/) do |name|
+  @result = ResponseCode.send(name.to_sym)
+end
+
+Then(/^it should give me (\d+)$/) do |expected|
+  expect(@result).to eq expected.to_i
+end
+
+When(/^I call lookup with (\d+)$/) do |code|
+  @name = ResponseCode.lookup(code)
+end
+
+Then(/^it should return me (\w+)$/) do |expected|
+  expect(@name.to_s).to eq expected
+end

data/features/step_definitions/unofficial_response_codes_steps.rb

@@ -0,0 +1,28 @@
+require 'response_code/aborted'
+require 'response_code/spring_framework'
+require 'response_code/twitter'
+require 'response_code/microsoft'
+require 'response_code/esri'
+require 'response_code/apache_web_server'
+require 'response_code/pantheon'
+require 'response_code/signal'
+require 'response_code/iis'
+require 'response_code/nginx'
+require 'response_code/cloudflare'
+
+When(/^I call a method in (\w+) with (\w+)$/) do |module_name, name|
+  @result = Object.const_get("ResponseCode::#{ module_name }").send(name.to_sym)
+end
+
+Then(/^it should give me (\d+) from (\w+)$/) do |expected, module_name |
+  expect(@result).to eq expected.to_i
+end
+
+When(/^I call (\w+) lookup with (\d+)$/) do |module_name, code|
+  @name = Object.const_get("ResponseCode::#{ module_name }").lookup(code)
+end
+
+Then(/^it should return me (\w+) from (\w+)$/) do |expected, module_name|
+  expect(@name.to_s).to eq expected
+end
+

data/lib/response_code.rb

@@ -1,5 +1,6 @@
 require 'response_code/version'
 require 'response_code/codes'
+require 'response_code/aborted'
 
 module ResponseCode 
 
@@ -10,5 +11,13 @@ module ResponseCode
       raise 'Not a valid status!'
     end
   end
+
+  def self.lookup(code)
+    if ResponseCode::CODES.value?(code.to_i)
+      ResponseCode::CODES.key(code.to_i)
+    else
+      raise 'Not a valid code!'
+    end
+  end
 end
 

data/lib/response_code/aborted.rb

@@ -0,0 +1,12 @@
+require 'response_code/base_imp'
+
+module ResponseCode
+  module Aborted
+    extend ResponseCode::BaseImp
+
+    @CODES = {
+      checkpoint: 103
+    }
+
+  end
+end

data/lib/response_code/apache_web_server.rb

@@ -0,0 +1,11 @@
+require 'response_code/base_imp'
+
+module ResponseCode
+  module ApacheWebServer 
+    extend ResponseCode::BaseImp
+
+    @CODES = {
+      bandwith_limit_exceeded: 509
+    }
+  end
+end

data/lib/response_code/base_imp.rb

@@ -0,0 +1,21 @@
+module ResponseCode
+  module BaseImp
+    extend self
+
+    def method_missing(m, *args, &block)
+      if @CODES.include?(m.to_sym)
+        @CODES[m.to_sym]
+      else
+        raise 'Not a valid status!'
+      end
+    end
+
+    def lookup(code)
+      if @CODES.value?(code.to_i)
+        @CODES.key(code.to_i)
+      else
+        raise 'Not a valid code!'
+      end
+    end
+  end
+end

data/lib/response_code/cloudflare.rb

@@ -0,0 +1,19 @@
+require 'response_code/base_imp'
+
+module ResponseCode
+  module Cloudflare 
+    extend ResponseCode::BaseImp
+
+    @CODES = {
+      unknown_error: 520,
+      web_server_is_down: 521,
+      connection_timed_out: 522,
+      origin_is_unreachable: 523,
+      a_timeout_occurred: 524,
+      ssl_handshake_failed: 525,
+      invalid_ssl_certificate: 526,
+      railgun_error: 527,
+      origin_dns_error: 530
+    }
+  end
+end

data/lib/response_code/esri.rb

@@ -0,0 +1,12 @@
+require 'response_code/base_imp'
+
+module ResponseCode
+  module Esri 
+    extend ResponseCode::BaseImp
+
+    @CODES = {
+      invalid_token: 498,
+      token_required: 499
+    }
+  end
+end

data/lib/response_code/iis.rb

@@ -0,0 +1,13 @@
+require 'response_code/base_imp'
+
+module ResponseCode
+  module IIS 
+    extend ResponseCode::BaseImp
+
+    @CODES = {
+      login_time_out: 440,
+      retry_with: 449,
+      redirect: 451
+    }
+  end
+end

data/lib/response_code/microsoft.rb

@@ -0,0 +1,11 @@
+require 'response_code/base_imp'
+
+module ResponseCode
+  module Microsoft 
+    extend ResponseCode::BaseImp
+
+    @CODES = {
+      blocked_by_windows_parental_controls: 450
+    }
+  end
+end

data/lib/response_code/nginx.rb

@@ -0,0 +1,16 @@
+require 'response_code/base_imp'
+
+module ResponseCode
+  module Nginx 
+    extend ResponseCode::BaseImp
+
+    @CODES = {
+      no_response: 444,
+      request_header_too_large: 494,
+      ssl_certificate_error: 495,
+      ssl_certificate_required: 496,
+      http_request_sent_to_https_port: 497,
+      client_closed_request: 499
+    }
+  end
+end

data/lib/response_code/pantheon.rb

@@ -0,0 +1,11 @@
+require 'response_code/base_imp'
+
+module ResponseCode
+  module Pantheon 
+    extend ResponseCode::BaseImp
+
+    @CODES = {
+      site_is_frozen: 530
+    }
+  end
+end

data/lib/response_code/signal.rb

@@ -0,0 +1,11 @@
+require 'response_code/base_imp'
+
+module ResponseCode
+  module Signal 
+    extend ResponseCode::BaseImp
+
+    @CODES = {
+      network_read_timeout_error: 598
+    }
+  end
+end

data/lib/response_code/spring_framework.rb

@@ -0,0 +1,11 @@
+require 'response_code/base_imp'
+
+module ResponseCode
+  module SpringFramework
+    extend ResponseCode::BaseImp
+
+    @CODES = {
+      method_failure: 420
+    }
+  end
+end

data/lib/response_code/twitter.rb

@@ -0,0 +1,11 @@
+require 'response_code/base_imp'
+
+module ResponseCode
+  module Twitter 
+    extend ResponseCode::BaseImp
+
+    @CODES = {
+      enhance_your_calm: 420
+    }
+  end
+end

data/lib/response_code/version.rb

@@ -1,3 +1,3 @@
 module ResponseCode 
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: response_code
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Mark Torok
@@ -21,8 +21,23 @@ files:
 - LICENSE
 - README.md
 - bin/response_code
+- features/response_code.feature
+- features/step_definitions/response_code_steps.rb
+- features/step_definitions/unofficial_response_codes_steps.rb
 - lib/response_code.rb
+- lib/response_code/aborted.rb
+- lib/response_code/apache_web_server.rb
+- lib/response_code/base_imp.rb
+- lib/response_code/cloudflare.rb
 - lib/response_code/codes.rb
+- lib/response_code/esri.rb
+- lib/response_code/iis.rb
+- lib/response_code/microsoft.rb
+- lib/response_code/nginx.rb
+- lib/response_code/pantheon.rb
+- lib/response_code/signal.rb
+- lib/response_code/spring_framework.rb
+- lib/response_code/twitter.rb
 - lib/response_code/version.rb
 homepage: http://github.com/torokmark/response_code
 licenses:
@@ -36,16 +51,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Readable way of response codes.
-test_files: []
+test_files:
+- features/step_definitions/response_code_steps.rb
+- features/step_definitions/unofficial_response_codes_steps.rb
+- features/response_code.feature