test_server 0.2.4 → 0.3.1

data/lib/test_server.rb

@@ -1,25 +1,22 @@
+#require 'sass'
+#require 'haml'
+#require 'rack/contrib/locale'
+#require 'rack/contrib/nested_params'
+#require 'rack/contrib/post_body_content_type_parser'
+#require 'sprockets-helpers'
+#require 'uglifier'
+#require 'rack/protection'
+#require 'rack/cors'
+#require 'rails'
+
 require 'psych'
-require 'sass'
-require 'haml'
 require 'i18n'
 require 'i18n/backend/fallbacks'
-require 'rack/contrib/locale'
-require 'rack/contrib/nested_params'
-require 'rack/contrib/post_body_content_type_parser'
-require 'sprockets-helpers'
-require 'sinatra'
-require 'sinatra/param'
-require 'sinatra/json'
-require 'sinatra/streaming'
 require 'json'
-require 'uglifier'
-require 'rack/protection'
-require 'rack/cors'
-require 'thor'
 require 'base64'
+require 'thor'
 require 'zlib'
 require 'digest/sha1'
-require 'padrino'
 
 require 'active_support/core_ext/kernel/reporting'
 require 'active_support/core_ext/object/blank'
@@ -35,6 +32,7 @@ require 'addressable/uri'
 require 'securerandom'
 require 'erb'
 
+require 'test_server/permitted_params'
 
 require 'test_server/access_logger'
 require 'test_server/null_access_logger'

data/lib/test_server/error_handler.rb

@@ -11,19 +11,19 @@ module TestServer
 
     private
 
-    attr_reader :details_i18n, :summary_i18n, :exit_code
+    attr_reader :details_i18n, :summary_i18n
 
     public
 
-    attr_reader :exception
-    attr_accessor :original_message
-    attr_accessor :backtrace
+    attr_reader :exception, :status_code, :exit_code
+    attr_accessor :original_message, :backtrace
 
     def initialize(options = {})
       @exception    = options.fetch(:exception)
       @details_i18n = options.fetch(:details)
       @summary_i18n = options.fetch(:summary)
-      @exit_code    = options.fetch(:exit_code)
+      @exit_code    = options.fetch(:exit_code, 1)
+      @status_code  = options.fetch(:status_code, :internal_server_error)
     rescue KeyError => e
       raise ArgumentError, e.message
     end
@@ -93,17 +93,21 @@ module TestServer
       Kernel.exit exit_code
     end
 
-    def to_json
+    def to_hash
       ErrorHandler.mutex.synchronize do
         @details ||= I18n.t(details_i18n)
         @summary ||= I18n.t(summary_i18n)
       end
 
-      JSON.dump(
-          error_summary: summary,
-          error_details: details,
-          result: :failure,
-      )
+      {
+        error_summary: summary,
+        error_details: details,
+        result: :failure,
+      }
+    end
+
+    def to_json
+      JSON.dump(to_hash)
     end
   end
 end

data/lib/test_server/error_messages.rb

@@ -1,11 +1,14 @@
 # encoding: utf-8
 module TestServer
   module ErrorMessages
+    # See http://futureshock-ed.com/2011/03/04/http-status-code-symbols-for-rails/
+    # for list of symbols for status codes
     ErrorHandler.create(
       exception: StandardError,
       summary: 'errors.default.summary',
       details: 'errors.default.details',
       exit_code: 99,
+      status_code: :internal_server_error,
     )
 
     ErrorHandler.create(
@@ -13,6 +16,7 @@ module TestServer
       details: 'errors.internal_error.details',
       summary: 'errors.internal_error.summary',
       exit_code: 1,
+      status_code: :internal_server_error,
     )
     
     ErrorHandler.create(
@@ -20,6 +24,7 @@ module TestServer
       details: 'errors.unreadable_config_file.details',
       summary: 'errors.unreadable_config_file.summary',
       exit_code: 2,
+      status_code: :internal_server_error,
     )
 
     ErrorHandler.create(
@@ -27,20 +32,22 @@ module TestServer
       details: 'errors.user_error.details',
       summary: 'errors.user_error.summary',
       exit_code: 3,
+      status_code: :internal_server_error,
     )
 
-    ErrorHandler.create(
-      exception: Sinatra::Param::InvalidParameterError,
-      details: 'errors.invalid_parameter.details',
-      summary: 'errors.invalid_parameter.summary',
-      exit_code: 4,
-    )
+    #ErrorHandler.create(
+    #  exception: Sinatra::Param::InvalidParameterError,
+    #  details: 'errors.invalid_parameter.details',
+    #  summary: 'errors.invalid_parameter.summary',
+    #  exit_code: 4,
+    #)
 
     ErrorHandler.create(
       exception: Exceptions::PidFileDoesNotExist,
       details: 'errors.invalid_proxy_pac.details',
       summary: 'errors.invalid_proxy_pac.summary',
       exit_code: 5,
+      status_code: :internal_server_error,
     )
 
     ErrorHandler.create(
@@ -48,6 +55,7 @@ module TestServer
       details: 'errors.invalid_url.details',
       summary: 'errors.invalid_url.summary',
       exit_code: 6,
+      status_code: :internal_server_error,
     )
     
     ErrorHandler.create(
@@ -55,6 +63,7 @@ module TestServer
       details: 'errors.invalid_listen_statement.details',
       summary: 'errors.invalid_listen_statement.summary',
       exit_code: 8,
+      status_code: :internal_server_error,
     )
 
     ErrorHandler.create(
@@ -62,6 +71,7 @@ module TestServer
       details: 'errors.invalid_access_log_path.details',
       summary: 'errors.invalid_access_log_path.summary',
       exit_code: 9,
+      status_code: :internal_server_error,
     )
   end
 end

data/lib/test_server/exceptions.rb

@@ -35,5 +35,11 @@ module TestServer
 
     # raised if variable cannot be looked up
     class VariableUnknown < InternalError; end
+
+    # raised if developer misses to define controller in parameter list
+    class ControllerNotDefinedInParameterList < InternalError; end
+
+    # raised if developer misses to define action for controller in parameter list
+    class ActionNotDefinedInParameterList < InternalError; end
   end
 end

data/lib/test_server/locales/en.yml

@@ -56,10 +56,63 @@ en:
       link: Home
     test:
       link: Tests
-    javascript:
+    string:
+      title: String Tests
+      link: String
+      index:
+        title: Overview for streaming tests
+        link: Overview
+      sleep:
+        title: Sleeps for a "count" amount of time and sends back string
+        link: Sleep and Send
+      random:
+        title: Sends random data back
+        link: Random Data
+      plain:
+        title: Sends plain static string back
+        link: Plain Data
+      eicar:
+        title: Sends eicar test string back
+        link: Eicar Test File
+    streaming:
+      title: Streaming Tests
+      link: Streaming
+      index:
+        title: Overview for streaming tests
+        link: Overview
+      random:
+        title: Sends random data back
+        link: Random Data
+      plain:
+        title: Sends plain static string back
+        link: Plain Data
+      eicar:
+        title: Sends eicar test string back
+        link: Eicar Test File
+
+    dashboard:
+      title: Dashboard
+      link: Dashboard
+      show:
+        title: Dashboard
+        link: Dashboard
+    static:
+      link: Static
+      title: Static content
+      index:
+        title: Overview for static files
+        link: Overview
+      plain:
+        title: Plain static content
+    generator:
+      title: Generators
+      link: Generators
+      index:
+        title: Overview for Generators
+        link: Overview
       xhr:
+        title: Send requests via Javascript
         link: XHR
-        title: 'Javascript Tests'
         fields: &fields
           url: URL
           count: Count

data/lib/test_server/permitted_params.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+module TestServer
+  class PermittedParams
+    private
+
+    attr_reader :database
+
+    public
+
+    attr_reader :params
+
+    def initialize(params)
+      @params = params
+
+      @database = {
+        dashboard: {
+          show: [],
+        },
+        static: {
+          index: [],
+        },
+        streaming: {
+          plain:  [:encodable, :streamable, :cachable, :countable],
+          random: [:encodable, :streamable, :cachable, :countable],
+          eicar:  [:encodable, :streamable, :cachable],
+          index: [],
+        },
+        string: {
+          plain:  [:encodable, :streamable, :cachable, :countable],
+          random: [:encodable, :streamable, :cachable, :countable],
+          sleep:  [:encodable, :streamable, :cachable, :countable],
+          eicar:  [:encodable, :streamable, :cachable],
+          index: [],
+        },
+        generator: {
+          xhr: [:generatable, :repeatable],
+          index: [],
+        },
+      }
+    end
+
+    def params_for_controller(name, action, defaults)
+      name   = name.to_sym
+      action = action.to_sym
+
+      raise Exceptions::ControllerNotDefinedInParameterList unless database.key? name
+      raise Exceptions::ActionNotDefinedInParameterList     unless database[name].key? action
+
+      generate_params(defaults, params_for(database[name][action]))
+    end
+
+    def known_params_for_controller(name, action)
+      name   = name.to_sym
+      action = action.to_sym
+
+      raise Exceptions::ControllerNotDefinedInParameterList, JSON.dump(controller: name) unless database.key? name
+      raise Exceptions::ActionNotDefinedInParameterList, JSON.dump(action: action)       unless database[name].key? action
+      
+      params_for(database[name][action]).to_a.sort
+    end
+
+    private
+
+    def params_for(*roles)
+      roles    = roles.flatten
+      attributes = Set.new
+
+      attributes = attributes + countable_params   if roles.include? :countable
+      attributes = attributes + encodable_params   if roles.include? :encodable
+      attributes = attributes + cachable_params    if roles.include? :cachable
+      attributes = attributes + repeatable_params  if roles.include? :repeatable
+      attributes = attributes + generatable_params if roles.include? :generatable
+
+      attributes
+    end
+
+    def generate_params(defaults, attributes)
+      params = self.params.permit(*attributes)
+      params.modify_values { |v| v.to_bool }
+      params.reverse_merge defaults if defaults
+    end
+
+    def generatable_params
+      [:count, :timeout, :url]
+    end
+
+    def repeatable_params
+      [:repeat]
+    end
+
+    def streamable_params
+      [:wait]
+    end
+
+    def encodable_params
+      [:base64, :base64_strict, :gzip]
+    end
+
+    def countable_params
+      [:count]
+    end
+
+    def cachable_params
+      [:expires]
+    end
+  end
+end

data/lib/test_server/version.rb

@@ -1,4 +1,4 @@
 #main TestServer
 module TestServer
-  VERSION = '0.2.4'
+  VERSION = '0.3.1'
 end

data/lib/test_server/web_helper.rb

@@ -1,30 +1,14 @@
 # encoding: utf-8
 module TestServer
   module WebHelper
-    def base_url
-      mutex = Mutex.new
-
-      mutex.synchronize do
-        @base_url ||= "#{request.env['rack.url_scheme']}://#{request.env['HTTP_HOST']}"
-      end
-    end
-
-    def h(text)
-      Rack::Utils.escape_html(text)
-    end
-
-    def t(*args)
-      I18n.t(*args)
-    end
-
     def generate_string(count, string = "Plain Data\n")
-      string * count
+      string * count.to_i
     end
   
     def generate_random_string(count)
       o = [('a'..'z'), ('A'..'Z'), (1..9), %w{° ^ ! " § $ % & / ( ) = ? * + ~ ` ´ ' # > < | @ ł € ¶ ŧ ← ↓ → ŋ đ ð ſ ð đ ŋ ħ “ „ ¢ « | » « ¢ „ “ ” µ · … – ĸ ¹ ² ³ ¼ ½ ¬ \{ [ ] \}}].map { |i| i.to_a }.flatten
 
-      (0...count).map { o[rand(o.length)] }.join
+      (0...count.to_i).map { o[rand(o.length)] }.join
     end
 
     def generate_eicar
@@ -36,29 +20,21 @@ module TestServer
         '+', 'H', '*' ]
     end
 
-    def configure_caching(params)
-      options = []
-
+    def configure_caching
       if params.key? 'expires'
-        options << :must_revalidate
-        options << :no_cache
-        options << { max_age: params[:expires] }
+        expires_in params[:expires].to_i, public: true, must_revalidate: true
       else
-        options << :must_revalidate              if params.key? 'must_revalidate'
-        options << :no_cache                     if params.key? 'no_cache'
-        options << { max_age: params[:max_age] } if params.key? 'max_age'
+        expires_now
       end
-
-      cache_control(*options)
     end
 
-    def encode(&block)
+    def encode(params, &block)
       encoders = []
       encoders << Encoders::Base64.new
       encoders << Encoders::Base64Strict.new
       encoders << Encoders::Gzip.new
 
-      encoders_to_run = params.keys.map(&:to_sym) & encoders.collect { |e| e.name }
+      encoders_to_run = params.symbolize_keys.keep_if {|_,v| v.to_bool == true }.keys & encoders.collect { |e| e.name }
 
       if encoders_to_run.blank?
         real_encoders = [Encoders::Null.new]