RubyGems - qeweney - Versions diffs - 0.2 → 0.3 - Mend

Files changed (11) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 468a536796430b202206a5b2e6fe1e05cdc2b9ff248735ceab4fa7ca458b812e
-  data.tar.gz: 379a9bdb10b73d2a5fbce967ec10149fd0c36ce58819fe27da847a3e1194ae27
+  metadata.gz: 63226f0b1696e99fb7c6cb322420ddf08fa6b9a0abd3652a5867c9186e0dd5b2
+  data.tar.gz: abb173aa33639169d3341e553bcbc91a8595727fae03844daebc0cb82e51b881
 SHA512:
-  metadata.gz: 17e66c2fbcf0b60c7cf8023ff7c0cda04e3ec3c527da5019838bf66ed454e10c4fada6b45e6ad56de479812a2e215e692fd566dc3167457e92ed8e88fc54de39
-  data.tar.gz: d46cabcc28e1da7ba15f4603eff436a47198e1c8008e97a3d4c6fb6e7166fddb08f7bea13c537e521784b06c898c9f97d8c9af15677f31516f37a649740ce693
+  metadata.gz: 9d43894a867eaf901cb4cdecf0d907f9257ffcdf369dc89ad1528738f006c854d07bf9850e54fe2fef6e316576593fa8d829f13bc82b5a8ba700a2726daa861b
+  data.tar.gz: d5f6d8eb6b520200b0864defcf5ef16f53965de0bac7304ca0bdf685faadf3f7528b8fecf0ba9377a3338bffbd993b851eb9e76af22fdd5dd966d4348a5ee28b

data/CHANGELOG.md CHANGED Viewed

@@ -1,3 +1,9 @@
+## 0.3 2021-02-12
+- Implement `Request#serve_io`, `Request#serve_file`, `Request#redirect`
+- Add basic MIME types
+- Add HTTP status codes
 ## 0.2 2021-02-11
 - Gem renamed to Qeweney

data/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    qeweney (0.2)
+    qeweney (0.3)
       escape_utils (~> 1.2.1)
 GEM

data/README.md CHANGED Viewed

@@ -1,8 +1,8 @@
-# QNA
+# Qeweney
 ## Cross-library feature rich HTTP request / response API
-QNA provides a uniform API for dealing with HTTP requests and responses.
+Qeweney provides a uniform API for dealing with HTTP requests and responses.
 ## Features

data/TODO.md ADDED Viewed

@@ -0,0 +1,34 @@
+## Serve files / arbitrary content
+- `#serve_file(path, opts)`
+  - See here: https://golang.org/pkg/net/http/#ServeFile
+  - support for `Range` header
+  - support for caching (specified in opts)
+  - support for serving from routing path:
+    ```ruby
+      req.route do
+        req.on 'assets' do
+          req.serve_file(req.routing_path, base_path: STATIC_PATH)
+        end
+      end
+      # or convenience method
+      req.route do
+        req.on_static_route 'assets', base_path: STATIC_PATH
+      end
+    ```
+- `#serve_content(io, opts)`
+  - See here: https://golang.org/pkg/net/http/#ServeContent
+  - support for `Range` header
+  - support for caching (specified in opts)
+  - usage:
+    ```ruby
+      req.route do
+        req.on 'mypdf' do
+          File.open('my.pdf', 'r') { |f| req.serve_content(io) }
+        end
+      end
+    ```

data/lib/qeweney.rb CHANGED Viewed

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
-module Qeweney
+module Qeweney
 end
 require_relative 'qeweney/request.rb'
+require_relative 'qeweney/status.rb'

data/lib/qeweney/mime_types.rb ADDED Viewed

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+module Qeweney
+  # File extension to MIME type mapping
+  module MimeTypes
+    TYPES = {
+      'html'  => 'text/html',
+      'css'   => 'text/css',
+      'js'    => 'application/javascript',
+      'txt'   => 'text/plain'
+      'gif'   => 'image/gif',
+      'jpg'   => 'image/jpeg',
+      'jpeg'  => 'image/jpeg',
+      'png'   => 'image/png',
+      'ico'   => 'image/x-icon',
+      'pdf'   => 'application/pdf',
+      'json'  => 'application/json',
+    }.freeze
+    def [](ref)
+      case ref
+      when Symbol
+        TYPES[ref.to_s]
+      when /\.?([^\.]+)$/
+        TYPES[Regexp.last_match(1)]
+      else
+        raise "Invalid argument #{ref.inspect}"
+      end
+    end
+  end
+end

data/lib/qeweney/response.rb CHANGED Viewed

@@ -1,9 +1,31 @@
 # frozen_string_literal: true
+require_relative 'status'
 module Qeweney
   module ResponseMethods
-    def redirect(url)
-      respond(nil, ':status' => 302, 'Location' => url)
+    def redirect(url, status = Status::FOUND)
+      respond(nil, ':status' => status, 'Location' => url)
+    end
+    def serve_file(path, opts)
+      File.open(file_full_path(path, opts), 'r') do |f|
+        serve_io(f, opts)
+      end
+    rescue Errno::ENOENT
+      respond(nil, ':status' => Status::NOT_FOUND)
+    end
+    def file_full_path(path, opts)
+      if (base_path = opts[:base_path])
+        File.join(opts[:base_path], path)
+      else
+        path
+      end
+    end
+    def serve_io(io, opts)
+      respond(io.read)
     end
   end
 end

data/lib/qeweney/status.rb ADDED Viewed

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+module Qeweney
+  # HTTP status codes
+  module Status
+    # translated from https://golang.org/pkg/net/http/#pkg-constants
+    # https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
+    CONTINUE                        = 100 # RFC 7231, 6.2.1
+    SWITCHING_PROTOCOLS             = 101 # RFC 7231, 6.2.2
+    PROCESSING                      = 102 # RFC 2518, 10.1
+    EARLY_HINTS                     = 103 # RFC 8297
+    OK                              = 200 # RFC 7231, 6.3.1
+    CREATED                         = 201 # RFC 7231, 6.3.2
+    ACCEPTED                        = 202 # RFC 7231, 6.3.3
+    NON_AUTHORITATIVE_INFO          = 203 # RFC 7231, 6.3.4
+    NO_CONTENT                      = 204 # RFC 7231, 6.3.5
+    RESET_CONTENT                   = 205 # RFC 7231, 6.3.6
+    PARTIAL_CONTENT                 = 206 # RFC 7233, 4.1
+    MULTI_STATUS                    = 207 # RFC 4918, 11.1
+    ALREADY_REPORTED                = 208 # RFC 5842, 7.1
+    IM_USED                         = 226 # RFC 3229, 10.4.1
+    MULTIPLE_CHOICES                = 300 # RFC 7231, 6.4.1
+    MOVED_PERMANENTLY               = 301 # RFC 7231, 6.4.2
+    FOUND                           = 302 # RFC 7231, 6.4.3
+    SEE_OTHER                       = 303 # RFC 7231, 6.4.4
+    NOT_MODIFIED                    = 304 # RFC 7232, 4.1
+    USE_PROXY                       = 305 # RFC 7231, 6.4.5
+    TEMPORARY_REDIRECT              = 307 # RFC 7231, 6.4.7
+    PERMANENT_REDIRECT              = 308 # RFC 7538, 3
+    BAD_REQUEST                     = 400 # RFC 7231, 6.5.1
+    UNAUTHORIZED                    = 401 # RFC 7235, 3.1
+    PAYMENT_REQUIRED                = 402 # RFC 7231, 6.5.2
+    FORBIDDEN                       = 403 # RFC 7231, 6.5.3
+    NOT_FOUND                       = 404 # RFC 7231, 6.5.4
+    METHOD_NOT_ALLOWED              = 405 # RFC 7231, 6.5.5
+    NOT_ACCEPTABLE                  = 406 # RFC 7231, 6.5.6
+    PROXY_AUTH_REQUIRED             = 407 # RFC 7235, 3.2
+    REQUEST_TIMEOUT                 = 408 # RFC 7231, 6.5.7
+    CONFLICT                        = 409 # RFC 7231, 6.5.8
+    GONE                            = 410 # RFC 7231, 6.5.9
+    LENGTH_REQUIRED                 = 411 # RFC 7231, 6.5.10
+    PRECONDITION_FAILED             = 412 # RFC 7232, 4.2
+    REQUEST_ENTITY_TOO_LARGE        = 413 # RFC 7231, 6.5.11
+    REQUEST_URI_TOO_LONG            = 414 # RFC 7231, 6.5.12
+    UNSUPPORTED_MEDIA_TYPE          = 415 # RFC 7231, 6.5.13
+    REQUESTED_RANGE_NOT_SATISFIABLE = 416 # RFC 7233, 4.4
+    EXPECTATION_FAILED              = 417 # RFC 7231, 6.5.14
+    TEAPOT                          = 418 # RFC 7168, 2.3.3
+    MISDIRECTED_REQUEST             = 421 # RFC 7540, 9.1.2
+    UNPROCESSABLE_ENTITY            = 422 # RFC 4918, 11.2
+    LOCKED                          = 423 # RFC 4918, 11.3
+    FAILED_DEPENDENCY               = 424 # RFC 4918, 11.4
+    TOO_EARLY                       = 425 # RFC 8470, 5.2.
+    UPGRADE_REQUIRED                = 426 # RFC 7231, 6.5.15
+    PRECONDITION_REQUIRED           = 428 # RFC 6585, 3
+    TOO_MANY_REQUESTS               = 429 # RFC 6585, 4
+    REQUEST_HEADER_FIELDS_TOO_LARGE = 431 # RFC 6585, 5
+    UNAVAILABLE_FOR_LEGAL_REASONS   = 451 # RFC 7725, 3
+    INTERNAL_SERVER_ERROR           = 500 # RFC 7231, 6.6.1
+    NOT_IMPLEMENTED                 = 501 # RFC 7231, 6.6.2
+    BAD_GATEWAY                     = 502 # RFC 7231, 6.6.3
+    SERVICE_UNAVAILABLE             = 503 # RFC 7231, 6.6.4
+    GATEWAY_TIMEOUT                 = 504 # RFC 7231, 6.6.5
+    HTTP_VERSION_NOT_SUPPORTED      = 505 # RFC 7231, 6.6.6
+    VARIANT_ALSO_NEGOTIATES         = 506 # RFC 2295, 8.1
+    INSUFFICIENT_STORAGE            = 507 # RFC 4918, 11.5
+    LOOP_DETECTED                   = 508 # RFC 5842, 7.2
+    NOT_EXTENDED                    = 510 # RFC 2774, 7
+    NETWORK_AUTHENTICATION_REQUIRED = 511 # RFC 6585, 6
+  end
+end

data/lib/qeweney/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Qeweney
-  VERSION = '0.2'
+  VERSION = '0.3'
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qeweney
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2021-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -81,11 +81,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- TODO.md
 - lib/qeweney.rb
+- lib/qeweney/mime_types.rb
 - lib/qeweney/request.rb
 - lib/qeweney/request_info.rb
 - lib/qeweney/response.rb
 - lib/qeweney/routing.rb
+- lib/qeweney/status.rb
 - lib/qeweney/version.rb
 - qeweney.gemspec
 - test/helper.rb

qeweney 0.2 → 0.3