qna 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: adb0435bdedde64951c33f9adb0c8e034a4e93ef91eed2066607574e58c285f2
+  data.tar.gz: 2d083475967af5c83aaee36cd5589fa175136043e8fbe92605f1c3e2bd0c3688
+SHA512:
+  metadata.gz: beac1c493217d40e57269e63f0a6cb7735c1a9a64df59b2b6ed3b147e649d4527d546c6a42bb5b3570f960a28f66df27119d8eb75e5ae622c39cc31ae1fcadaa
+  data.tar.gz: cc2b6a4a1b75d1cdde1570ffb7276ab9a69951cf24c0059e503065c5022cc57476150f3d2e99876ff4b93cb3487ac301a8956bd1b2ec20c05bb5a6e151f79ead

data/.github/test.yml

@@ -0,0 +1,27 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby: [2.6, 2.7, 3]
+
+    name: >-
+      ${{matrix.os}}, ${{matrix.ruby}}
+
+    runs-on: ${{matrix.os}}
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+    - name: Install dependencies
+      run: |
+        gem install bundler
+        bundle install
+    - name: Run tests
+      run:  bundle exec rake test

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    qna (0.1)
+      escape_utils (~> 1.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.4)
+    escape_utils (1.2.1)
+    minitest (5.11.3)
+    minitest-reporters (1.4.3)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (12.3.3)
+    ruby-progressbar (1.11.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.11.3)
+  minitest-reporters (~> 1.4.2)
+  qna!
+  rake (~> 12.3.3)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Sharon Rosner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,11 @@
+# QNA
+
+## Cross-library feature rich HTTP request / response API
+
+QNA provides a uniform API for dealing with HTTP requests and responses.
+
+## Features
+
+- Works with different web server APIs, notably Tipi, Digital Fabric, and Rack
+- Transport-agnostic
+- High-performance routing API inspired by Roda

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/clean"
+
+# frozen_string_literal: true
+
+task :default => [:test]
+task :test do
+  exec 'ruby test/run.rb'
+end

data/lib/qna.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module QNA
+end
+
+require_relative 'qna/request.rb'

data/lib/qna/request.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative './request_info'
+require_relative './routing'
+require_relative './response'
+
+module QNA
+  # HTTP request
+  class Request
+    include RequestInfoMethods
+    include RoutingMethods
+    include ResponseMethods
+
+    extend RequestInfoClassMethods
+
+    attr_reader :headers, :adapter
+    attr_accessor :__next__
+    
+    def initialize(headers, adapter)
+      @headers  = headers
+      @adapter  = adapter
+    end
+        
+    def buffer_body_chunk(chunk)
+      @buffered_body_chunks ||= []
+      @buffered_body_chunks << chunk
+    end
+
+    def next_chunk
+      if @buffered_body_chunks
+        chunk = @buffered_body_chunks.shift
+        @buffered_body_chunks = nil if @buffered_body_chunks.empty?
+        return chunk
+      end
+
+      @message_complete ? nil : @adapter.get_body_chunk
+    end
+    
+    def each_chunk
+      if @buffered_body_chunks
+        while (chunk = @buffered_body_chunks.shift)
+          yield chunk
+        end
+        @buffered_body_chunks = nil
+      end
+      while !@message_complete && (chunk = @adapter.get_body_chunk)
+        yield chunk
+      end
+    end
+
+    def complete!(keep_alive = nil)
+      @message_complete = true
+      @keep_alive = keep_alive
+    end
+    
+    def complete?
+      @message_complete
+    end
+    
+    def consume
+      @adapter.consume_request
+    end
+    
+    def keep_alive?
+      @keep_alive
+    end
+    
+    def read
+      buf = @buffered_body_chunks ? @buffered_body_chunks.join : nil
+      while (chunk = @adapter.get_body_chunk)
+        (buf ||= +'') << chunk
+      end
+      @buffered_body_chunks = nil
+      buf
+    end
+    alias_method :body, :read
+    
+    def respond(body, headers = {})
+      @adapter.respond(body, headers)
+      @headers_sent = true
+    end
+    
+    def send_headers(headers = {}, empty_response = false)
+      return if @headers_sent
+      
+      @headers_sent = true
+      @adapter.send_headers(headers, empty_response: empty_response)
+    end
+    
+    def send_chunk(body, done: false)
+      send_headers({}) unless @headers_sent
+      
+      @adapter.send_chunk(body, done: done)
+    end
+    alias_method :<<, :send_chunk
+    
+    def finish
+      send_headers({}) unless @headers_sent
+      
+      @adapter.finish
+    end
+
+    def headers_sent?
+      @headers_sent
+    end
+  end
+end

data/lib/qna/request_info.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'escape_utils'
+
+module QNA
+  module RequestInfoMethods
+    def host
+      @headers['host']
+    end
+
+    def connection
+      @headers['connection']
+    end
+
+    def upgrade_protocol
+      connection == 'upgrade' && @headers['upgrade']&.downcase
+    end
+
+    def protocol
+      @protocol ||= @adapter.protocol
+    end
+    
+    def method
+      @method ||= @headers[':method'].downcase
+    end
+    
+    def scheme
+      @scheme ||= @headers[':scheme']
+    end
+    
+    def uri
+      @uri ||= URI.parse(@headers[':path'] || '')
+    end
+    
+    def path
+      @path ||= uri.path
+    end
+    
+    def query_string
+      @query_string ||= uri.query
+    end
+    
+    def query
+      return @query if @query
+      
+      @query = (q = uri.query) ? split_query_string(q) : {}
+    end
+    
+    def split_query_string(query)
+      query.split('&').each_with_object({}) do |kv, h|
+        k, v = kv.split('=')
+        h[k.to_sym] = URI.decode_www_form_component(v)
+      end
+    end
+
+    def request_id
+      @headers['x-request-id']
+    end
+
+    def forwarded_for
+      @headers['x-forwarded-for']
+    end
+  end
+
+  module RequestInfoClassMethods
+    def parse_form_data(body, headers)
+      case (content_type = headers['content-type'])
+      when /multipart\/form\-data; boundary=([^\s]+)/
+        boundary = "--#{Regexp.last_match(1)}"
+        parse_multipart_form_data(body, boundary)
+      when 'application/x-www-form-urlencoded'
+        parse_urlencoded_form_data(body)
+      else
+        raise "Unsupported form data content type: #{content_type}"
+      end
+    end
+
+    def parse_multipart_form_data(body, boundary)
+      parts = body.split(boundary)
+      parts.each_with_object({}) do |p, h|
+        next if p.empty? || p == "--\r\n"
+
+        # remove post-boundary \r\n
+        p.slice!(0, 2)
+        parse_multipart_form_data_part(p, h)
+      end
+    end
+
+    def parse_multipart_form_data_part(part, hash)
+      body, headers = parse_multipart_form_data_part_headers(part)
+      disposition = headers['content-disposition'] || ''
+
+      name = (disposition =~ /name="([^"]+)"/) ? Regexp.last_match(1) : nil
+      filename = (disposition =~ /filename="([^"]+)"/) ? Regexp.last_match(1) : nil
+
+      if filename
+        hash[name] = { filename: filename, content_type: headers['content-type'], data: body }
+      else
+        hash[name] = body
+      end
+    end
+
+    def parse_multipart_form_data_part_headers(part)
+      headers = {}
+      while true
+        idx = part.index("\r\n")
+        break unless idx
+
+        header = part[0, idx]
+        part.slice!(0, idx + 2)
+        break if header.empty?
+
+        next unless header =~ /^([^\:]+)\:\s?(.+)$/
+        
+        headers[Regexp.last_match(1).downcase] = Regexp.last_match(2)
+      end
+      # remove trailing \r\n
+      part.slice!(part.size - 2, 2)
+      [part, headers]
+    end
+
+    PARAMETER_RE = /^(.+)=(.*)$/.freeze
+    MAX_PARAMETER_NAME_SIZE = 256
+    MAX_PARAMETER_VALUE_SIZE = 2**20 # 1MB
+
+    def parse_urlencoded_form_data(body)
+      body.force_encoding(UTF_8) unless body.encoding == Encoding::UTF_8
+      body.split('&').each_with_object({}) do |i, m|
+        raise 'Invalid parameter format' unless i =~ PARAMETER_RE
+  
+        k = Regexp.last_match(1)
+        raise 'Invalid parameter size' if k.size > MAX_PARAMETER_NAME_SIZE
+  
+        v = Regexp.last_match(2)
+        raise 'Invalid parameter size' if v.size > MAX_PARAMETER_VALUE_SIZE
+  
+        m[EscapeUtils.unescape_uri(k)] = EscapeUtils.unescape_uri(v)
+      end
+    end
+  end
+end

data/lib/qna/response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module QNA
+  module ResponseMethods
+    def redirect(url)
+      respond(nil, ':status' => 302, 'Location' => url)
+    end
+  end
+end

data/lib/qna/routing.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module QNA
+  module RoutingMethods
+    def route(&block)
+      res = catch(:stop) { yield self }
+      return if res == :found
+  
+      respond(nil, ':status' => 404)
+    end
+
+    def route_found(&block)
+      catch(:stop, &block)
+      throw :stop, :found
+    end
+
+    @@regexp_cache = {}
+
+    def routing_path
+      @__routing_path__
+    end
+  
+    def on(route = nil, &block)
+      @__routing_path__ ||= path
+
+      if route
+        regexp = (@@regexp_cache[route] ||= /^\/#{route}(\/.*)?/)
+        return unless @__routing_path__ =~ regexp
+
+        @__routing_path__ = Regexp.last_match(1) || '/'
+      end
+  
+      route_found(&block)
+    end
+
+    def is(route = '/', &block)
+      return unless @__routing_path__ == route
+
+      route_found(&block)
+    end
+
+    def on_root(&block)
+      return unless @__routing_path__ == '/'
+
+      route_found(&block)
+    end
+  
+    def on_get(route = nil, &block)
+      return unless method == 'get'
+  
+      on(route, &block)
+    end
+  
+    def on_post(route = nil, &block)
+      return unless method == 'post'
+  
+      on(route, &block)
+    end
+
+    def on_options(route = nil, &block)
+      return unless method == 'options'
+  
+      on(route, &block)
+    end
+
+    def on_upgrade(protocol, &block)
+      return unless upgrade_protocol == protocol
+
+      route_found(&block)
+    end
+
+    def on_query_param(key)
+      value = query[key]
+      return unless value
+
+      route_found { yield value }
+    end
+
+    def on_accept(accept, &block)
+      if accept.is_a?(Regexp)
+        return unless headers['accept'] =~ accept
+      else
+        return unless headers['accept'] == accept
+      end
+
+      route_found(&block)
+    end
+
+    def stop_routing
+      yield if block_given?
+      throw :stop, :found
+    end
+  end
+end

data/lib/qna/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module QNA
+  VERSION = '0.1'
+end

data/qna.gemspec

@@ -0,0 +1,25 @@
+require_relative './lib/qna/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'qna'
+  s.version     = QNA::VERSION
+  s.licenses    = ['MIT']
+  s.summary     = 'QNA - cross library HTTP request / response API'
+  s.author      = 'Sharon Rosner'
+  s.email       = 'sharon@noteflakes.com'
+  s.files       = `git ls-files`.split
+  s.homepage    = 'http://github.com/digital-fabric/qna'
+  s.metadata    = {
+    "source_code_uri" => "https://github.com/digital-fabric/qna"
+  }
+  s.rdoc_options = ["--title", "QNA", "--main", "README.md"]
+  s.extra_rdoc_files = ["README.md"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = '>= 2.6'
+
+  s.add_runtime_dependency      'escape_utils',       '~>1.2.1'
+
+  s.add_development_dependency  'rake',               '~>12.3.3'
+  s.add_development_dependency  'minitest',           '~>5.11.3'
+  s.add_development_dependency  'minitest-reporters', '~>1.4.2'
+end

data/test/helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'qna'
+
+require 'fileutils'
+
+require_relative './coverage' if ENV['COVERAGE']
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+
+module QNA
+  def self.mock(headers)
+    Request.new(headers, nil)
+  end
+end
+
+Minitest::Reporters.use! [
+  Minitest::Reporters::SpecReporter.new
+]

data/test/run.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Dir.glob("#{__dir__}/test_*.rb").each do |path|
+  require(path)
+end

data/test/test_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+class RequestInfoTest < MiniTest::Test
+  def test_uri
+    r = QNA.mock(':path' => '/test/path')
+    assert_equal '/test/path', r.path
+    assert_equal({}, r.query)
+
+    r = QNA.mock(':path' => '/test/path?a=1&b=2&c=3%2f4')
+    assert_equal '/test/path', r.path
+    assert_equal({ a: '1', b: '2', c: '3/4' }, r.query)
+  end
+
+  def test_host
+    r = QNA.mock(':path' => '/')
+    assert_nil r.host
+
+    r = QNA.mock('host' => 'my.example.com')
+    assert_equal 'my.example.com', r.host
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: qna
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Sharon Rosner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: escape_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+description: 
+email: sharon@noteflakes.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".github/test.yml"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/qna.rb
+- lib/qna/request.rb
+- lib/qna/request_info.rb
+- lib/qna/response.rb
+- lib/qna/routing.rb
+- lib/qna/version.rb
+- qna.gemspec
+- test/helper.rb
+- test/run.rb
+- test/test_request.rb
+homepage: http://github.com/digital-fabric/qna
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/digital-fabric/qna
+post_install_message: 
+rdoc_options:
+- "--title"
+- QNA
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: QNA - cross library HTTP request / response API
+test_files: []