tsurezure 0.0.34 → 0.0.36

data/lib/utils/error_codes.rb

@@ -1,24 +1,24 @@
-# frozen_string_literal: true
-
-# for storing generic, reusable error codes.
-module ErrorCodes
-  def self.nan_error(item)
-    "invalid parameter: #{item} must be a number."
-  end
-
-  def self.no_method_error(item)
-    "invalid http method: #{item} is not a valid http method."
-  end
-
-  def self.invalid_type_error(item)
-    "invalid type: #{item} is not a valid type."
-  end
-
-  def self.range_error(min, max)
-    "invalid port number: port must be in range [#{min}, #{max}]"
-  end
-
-  def self.invalid_structure_error(keys, method)
-    "invalid object with keys #{keys} supplied to #{method}"
-  end
-end
+# frozen_string_literal: true
+
+# for storing generic, reusable error codes.
+module ErrorCodes
+  def self.nan_error(item)
+    "invalid parameter: #{item} must be a number."
+  end
+
+  def self.no_method_error(item)
+    "invalid http method: #{item} is not a valid http method."
+  end
+
+  def self.invalid_type_error(item)
+    "invalid type: #{item} is not a valid type."
+  end
+
+  def self.range_error(min, max)
+    "invalid port number: port must be in range [#{min}, #{max}]"
+  end
+
+  def self.invalid_structure_error(keys, method)
+    "invalid object with keys #{keys} supplied to #{method}"
+  end
+end

data/lib/utils/errors.rb

@@ -1,65 +1,65 @@
-# frozen_string_literal: true
-
-# simple methods for showing error messages
-module ErrorMessage
-  def self.invalid_key_error(method, key)
-    raise ArgumentError, {
-      message: "invalid key '#{key}' used as parameter to #{method}."
-    }.to_json
-  end
-
-  def self.invalid_http_method_error(key, val, method)
-    raise ArgumentError, {
-      message: "#{key} used to access #{method}. use #{val}.",
-      status: 405,
-      options: {
-        allowed: val
-      }
-    }.to_json
-  end
-
-  def self.missing_arguments_error(method)
-    raise ArgumentError, {
-      status: 500,
-      message: "missing arguments to #{method}"
-    }.to_json
-  end
-
-  def self.missing_parameter_error(method)
-    raise ArgumentError, {
-      status: 400,
-      message: "missing url parameter id to #{method}."
-    }.to_json
-  end
-
-  def self.invalid_structure_error(method, keys)
-    raise ArgumentError, {
-      status: 400,
-      message: "invalid object with keys #{keys} passed to #{method}."
-    }.to_json
-  end
-
-  def self.make_http_error(status, message, options)
-    error = { status: status, options: options }
-    error.delete :options if options.nil?
-
-    case status.to_s.chr.to_i
-    when 4
-      error[:message] = "bad request: #{message}"
-    when 5
-      error[:message] = "server error: #{message}"
-    end
-
-    error.to_json
-  end
-end
-
-# module for multiple custom error classes
-module CustomError
-  # for throwing a server error (like 500)
-  class ServerError < StandardError
-    def initialize(message = 'an internal server error occurred.')
-      super
-    end
-  end
-end
+# frozen_string_literal: true
+
+# simple methods for showing error messages
+module ErrorMessage
+  def self.invalid_key_error(method, key)
+    raise ArgumentError, {
+      message: "invalid key '#{key}' used as parameter to #{method}."
+    }.to_json
+  end
+
+  def self.invalid_http_method_error(key, val, method)
+    raise ArgumentError, {
+      message: "#{key} used to access #{method}. use #{val}.",
+      status: 405,
+      options: {
+        allowed: val
+      }
+    }.to_json
+  end
+
+  def self.missing_arguments_error(method)
+    raise ArgumentError, {
+      status: 500,
+      message: "missing arguments to #{method}"
+    }.to_json
+  end
+
+  def self.missing_parameter_error(method)
+    raise ArgumentError, {
+      status: 400,
+      message: "missing url parameter id to #{method}."
+    }.to_json
+  end
+
+  def self.invalid_structure_error(method, keys)
+    raise ArgumentError, {
+      status: 400,
+      message: "invalid object with keys #{keys} passed to #{method}."
+    }.to_json
+  end
+
+  def self.make_http_error(status, message, options)
+    error = { status: status, options: options }
+    error.delete :options if options.nil?
+
+    case status.to_s.chr.to_i
+    when 4
+      error[:message] = "bad request: #{message}"
+    when 5
+      error[:message] = "server error: #{message}"
+    end
+
+    error.to_json
+  end
+end
+
+# module for multiple custom error classes
+module CustomError
+  # for throwing a server error (like 500)
+  class ServerError < StandardError
+    def initialize(message = 'an internal server error occurred.')
+      super
+    end
+  end
+end

data/lib/utils/http_utils.rb

@@ -1,202 +1,212 @@
-# frozen_string_literal: true
-
-require_relative 'logbook'
-
-# all utilities for dealing with http-related things
-module HTTPUtils
-  include Logbook
-  # class URLUtils - for dealing with urls
-  class URLUtils
-    def self.extract_url_params(url)
-      url_params = {}
-
-      if url.split('?')
-            .length > 1
-        url.split('?')[1].split('&').map do |e|
-          key, value = e.split('=')
-
-          break if value.nil?
-
-          url_params[key] = value
-        end
-      end
-
-      url_params
-    end
-
-    def self.url_path_matches?(url, path)
-      return true if url == path
-
-      split_url = url.split '/'
-      split_path = path.split '/'
-
-      return false if split_url.empty? || split_url.length != split_path.length
-
-      true
-    end
-
-    def self.get_match_indices(url, path)
-      split_url = url.split '/'
-      split_path = path.split '/'
-
-      hash_with_variables = {}
-
-      return unless url_path_matches? url, path
-
-      split_url.each_with_index do |pname, idx|
-        part = pname.sub(':', '')
-        hash_with_variables[part] = split_path[idx] if pname[0] == ':'
-      end
-
-      hash_with_variables
-    end
-
-    def self.matches_url_regex?(url, regex)
-      return unless url_path_matches? url, regex
-
-      matches = url.scan %r{((?<=\/):[^\/]+)}
-      newregexp = url.dup
-
-      return url.match? Regexp.new("^#{regex}$") if matches.empty?
-
-      matches.each do |mat|
-        newregexp.gsub!(Regexp.new(mat[0].to_s), '.+')
-      end
-
-      url.match? Regexp.new(newregexp)
-    end
-  end
-
-  # for dealing with header data.
-  class HeaderUtils
-    def self.get_headers(client)
-      headers = {}
-
-      while (line = client.gets.split(' ', 2))
-        break if line[0] == ''
-
-        headers[line[0].chop] = line[1].strip
-      end
-
-      headers
-    end
-
-    def self.get_req_data(client, headers)
-      data = client.read headers['Content-Length'].to_i
-
-      return if data.empty?
-
-      data
-    end
-  end
-
-  def self.make_proper_request(client, request)
-    headers = HeaderUtils.get_headers(client)
-    data = HeaderUtils.get_req_data(client, headers)
-    method = request.split(' ')[0]
-    url = request.split(' ')[1]
-    proto = request.split(' ')[2]
-
-    { headers: headers, data: data, method: method, url: url, protocol: proto }
-  end
-
-  def self.make_request_object(req)
-    req[:data] = '{}' if req[:data].nil?
-
-    {
-      headers: req[:headers],
-      data: JSON.parse(req[:data]),
-      method: req[:method],
-      url: req[:url],
-      protocol: req[:protocol]
-    }
-  end
-
-  # class ServerResponses - for sending HTTP responses
-  class ServerResponse
-    def initialize(session, length)
-      @session = session
-      @length = length
-    end
-
-    def valid_options?(options)
-      acceptable_keys = %i[location method]
-
-      return true if acceptable_keys.any? { |key| options.key? key }
-
-      false
-    end
-
-    def respond(response,
-                options = {},
-                status = 200,
-                content_type = 'application/json')
-      @content_type = options[:content_type] || content_type
-
-      if respond_to? "r_#{status}"
-        method("r_#{status}").call unless valid_options? options
-        method("r_#{status}").call options if valid_options? options
-      else
-        r_400
-      end
-
-      @session.puts
-      @session.puts response
-      @session.close
-    end
-
-    def r_200
-      @session.puts 'HTTP/1.1 200 OK'
-      @session.puts "Content-Type: #{@content_type}"
-      @session.puts "Content-Length: #{@length}"
-    end
-
-    def r_201
-      @session.puts 'HTTP/1.1 201 Created'
-      @session.puts "Content-Type: #{@content_type}"
-      @session.puts "Content-Length: #{@length}"
-    end
-
-    def r_301(options)
-      @session.puts 'HTTP/1.1 301 Moved Permanently'
-      @session.puts "Content-Type: #{@content_type}"
-      @session.puts "Content-Length: #{@length}"
-      @session.puts "Location: #{options[:location]}"
-    end
-
-    def r_304
-      @session.puts 'HTTP/1.1 304 Not Modified'
-      @session.puts "Content-Type: #{@content_type}"
-      @session.puts "Content-Length: #{@length}"
-    end
-
-    def r_400
-      @session.puts 'HTTP/1.1 400 Bad Request'
-      @session.puts "Content-Type: #{@content_type}"
-      @session.puts "Content-Length: #{@length}"
-    end
-
-    def r_404
-      @session.puts 'HTTP/1.1 404 Not Found'
-      @session.puts "Content-Type: #{@content_type}"
-      @session.puts "Content-Length: #{@length}"
-    end
-
-    def r_405(options)
-      @session.puts 'HTTP/1.1 405 Method Not Allowed'
-      @session.puts "Content-Type: #{@content_type}"
-      @session.puts "Content-Length: #{@length}"
-      @session.puts "Allow: #{options[:method]}"
-    end
-
-    def r_500
-      @session.puts 'HTTP/1.1 500 Internal Server Error'
-      @session.puts "Content-Type: #{@content_type}"
-      @session.puts "Content-Length: #{@length}"
-    end
-  end
-end
-
-__END__
-
-this is the file that made me realize that the content_length header actually directly controls the length of the content in the response. I incorrectly set the content_length once as a mistake, and my responses were coming out short. interesting!
+# frozen_string_literal: true
+
+require_relative 'logbook'
+
+# all utilities for dealing with http-related things
+module HTTPUtils
+  include Logbook
+  # class URLUtils - for dealing with urls
+  class URLUtils
+    def self.extract_url_params(url)
+      url_params = {}
+
+      if url.split('?')
+            .length > 1
+        url.split('?')[1].split('&').map do |e|
+          key, value = e.split('=')
+
+          break if value.nil?
+
+          url_params[key] = value
+        end
+      end
+
+      url_params
+    end
+
+    # TODO: make this less complicated
+    # hello, eris from [current year]! have you been practicing? good luck!
+    def self.url_path_matches?(url, path)
+      return true if url == path
+
+      split_url = url.split '/'
+      split_path = path.split '/'
+      non_var_equality = true
+
+      return false if split_url.length != split_path.length
+
+      split_path.each_with_index do |p, i|
+        next if split_url[i][0] == ':'
+        non_var_equality = false if p != split_url[i]
+      end
+
+      return false unless non_var_equality == true
+      return false if split_url.empty?
+      true
+    end
+
+    def self.get_match_indices(url, path)
+      split_url = url.split '/'
+      split_path = path.split '/'
+
+      hash_with_variables = {}
+
+      return unless url_path_matches? url, path
+
+      split_url.each_with_index do |pname, idx|
+        part = pname.sub(':', '')
+        hash_with_variables[part] = split_path[idx] if pname[0] == ':'
+      end
+
+      hash_with_variables
+    end
+
+    def self.matches_url_regex?(url, regex)
+      return unless url_path_matches? url, regex
+
+      matches = url.scan %r{((?<=/):[^/]+)}
+      newregexp = url.dup
+
+      return url.match? Regexp.new("^#{regex}$") if matches.empty?
+
+      matches.each do |mat|
+        newregexp.gsub!(Regexp.new(mat[0].to_s), '.+')
+      end
+
+      url.match? Regexp.new(newregexp)
+    end
+  end
+
+  # for dealing with header data.
+  class HeaderUtils
+    def self.get_headers(client)
+      headers = {}
+
+      while (line = client.gets.split(' ', 2))
+        break if line[0] == ''
+
+        headers[line[0].chop] = line[1].strip
+      end
+
+      headers
+    end
+
+    def self.get_req_data(client, headers)
+      data = client.read headers['Content-Length'].to_i
+
+      return if data.empty?
+
+      data
+    end
+  end
+
+  def self.make_proper_request(client, request)
+    headers = HeaderUtils.get_headers(client)
+    data = HeaderUtils.get_req_data(client, headers)
+    method = request.split(' ')[0]
+    url = request.split(' ')[1]
+    proto = request.split(' ')[2]
+
+    { headers: headers, data: data, method: method, url: url, protocol: proto }
+  end
+
+  def self.make_request_object(req)
+    req[:data] = '{}' if req[:data].nil?
+
+    {
+      headers: req[:headers],
+      data: JSON.parse(req[:data]),
+      method: req[:method],
+      url: req[:url],
+      protocol: req[:protocol]
+    }
+  end
+
+  # class ServerResponses - for sending HTTP responses
+  class ServerResponse
+    def initialize(session, length)
+      @session = session
+      @length = length
+    end
+
+    def valid_options?(options)
+      acceptable_keys = %i[location method]
+
+      return true if acceptable_keys.any? { |key| options.key? key }
+
+      false
+    end
+
+    def respond(response,
+                options = {},
+                status = 200,
+                content_type = 'application/json')
+      @content_type = options[:content_type] || content_type
+
+      if respond_to? "r#{status}"
+        method("r#{status}").call unless valid_options? options
+        method("r#{status}").call options if valid_options? options
+      else
+        r400
+      end
+
+      @session.puts
+      @session.puts response
+      @session.close
+    end
+
+    def r200
+      @session.puts 'HTTP/1.1 200 OK'
+      @session.puts "Content-Type: #{@content_type}"
+      @session.puts "Content-Length: #{@length}"
+    end
+
+    def r201
+      @session.puts 'HTTP/1.1 201 Created'
+      @session.puts "Content-Type: #{@content_type}"
+      @session.puts "Content-Length: #{@length}"
+    end
+
+    def r301(options)
+      @session.puts 'HTTP/1.1 301 Moved Permanently'
+      @session.puts "Content-Type: #{@content_type}"
+      @session.puts "Content-Length: #{@length}"
+      @session.puts "Location: #{options[:location]}"
+    end
+
+    def r304
+      @session.puts 'HTTP/1.1 304 Not Modified'
+      @session.puts "Content-Type: #{@content_type}"
+      @session.puts "Content-Length: #{@length}"
+    end
+
+    def r400
+      @session.puts 'HTTP/1.1 400 Bad Request'
+      @session.puts "Content-Type: #{@content_type}"
+      @session.puts "Content-Length: #{@length}"
+    end
+
+    def r404
+      @session.puts 'HTTP/1.1 404 Not Found'
+      @session.puts "Content-Type: #{@content_type}"
+      @session.puts "Content-Length: #{@length}"
+    end
+
+    def r405(options)
+      @session.puts 'HTTP/1.1 405 Method Not Allowed'
+      @session.puts "Content-Type: #{@content_type}"
+      @session.puts "Content-Length: #{@length}"
+      @session.puts "Allow: #{options[:method]}"
+    end
+
+    def r500
+      @session.puts 'HTTP/1.1 500 Internal Server Error'
+      @session.puts "Content-Type: #{@content_type}"
+      @session.puts "Content-Length: #{@length}"
+    end
+  end
+end
+
+__END__
+
+this is the file that made me realize that the content_length header actually directly controls the length of the content in the response. I incorrectly set the content_length once as a mistake, and my responses were coming out short. interesting!