raki 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 525786fbd7d2b61ce8eaf8f2f5f6ea070de9801521a353b71c62ffbcf0d3b2c6
+  data.tar.gz: ce2226ef9894b6fff04ac74923ce26168f6674802a2ea83cedf93d8d6c6717e5
+SHA512:
+  metadata.gz: 6905b821786588bc1215bf498e75b7421284d2862f35e4282ec994557c5029fd124a805909bcafe465a9335b28507832d28242dc3fa33c66d170fe51d568c96b
+  data.tar.gz: 51b1595622b43efb6c7a220cc65032c39391ae361a9f76d454da5bd9de1ddd760180fbc804e1004366c8f74535bfb4ed8d99f505caf72848dde0608dc997b8b2

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+desc 'Run all the tests'
+task default: :test
+
+Rake::TestTask.new("test:regular") do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+  t.verbose = true
+end
+
+desc "Run all the fast + platform agnostic tests"
+task test: %w[test:regular]
+
+desc "Run all the tests we run on CI"
+task ci: :test

data/lib/raki.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Raki
+  autoload :Block,   'raki/block'
+  autoload :Builder, 'raki/builder'
+  autoload :Cache,   'raki/cache'
+  autoload :Idem,    'raki/idem'
+  autoload :Lint,    'raki/lint'
+  autoload :Merge,   'raki/merge'
+  autoload :MiddlewareBase, 'raki/middleware_base'
+  autoload :Nil,     'raki/nil'
+  autoload :Params,  'raki/params'
+  autoload :Require, 'raki/require'
+  autoload :Slice,   'raki/slice'
+end

data/lib/raki/block.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Middleware to execute a Block.
+module Raki
+  class Block < Raki::MiddlewareBase
+    def call(env)
+      my_env = env
+      @block.call(my_env)
+      @app.call(my_env)
+    end
+  end
+end

data/lib/raki/builder.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# see also
+# cat ~/test/rack/lib/rack/builder.rb
+
+# inspired by Rack::Builder
+module Raki
+  class Builder
+    def initialize(default_app = nil, &block)
+      @added = []
+      @runs = [default_app].compact
+      instance_eval(&block) if block_given?
+    end
+
+    # Create a new Raki::Builder instance and return the Raki application
+    # generated from it.
+    def self.app(default_app = nil, &block)
+      new(default_app, &block).to_app
+    end
+
+    def add(middleware, *args, &block)
+      raise 'No add allowed after a run' if @runs.size.positive?
+
+      @added <<
+        if middleware.instance_of?(Class)
+          proc { |app| middleware.new(app, *args, &block) }
+        else
+          proc { |_app| middleware }
+        end
+    end
+    ruby2_keywords(:add) if respond_to?(:ruby2_keywords, true)
+
+    def run(app)
+      @runs << app
+    end
+
+    def to_app
+      app = fake_parallel(@runs)
+      @added.reverse.inject(app) { |a, e| e[a] }
+    end
+
+   private
+    def fake_parallel(runs)
+      return runs.first if runs.size < 2
+
+      app = lambda do |env|
+        status, hsh, body = [200, {}, []]
+        runs.shuffle.each { |run|
+          s, h, b = run.call(env)
+          status = s unless s == 200
+          hsh.merge! h
+          body << b unless b.empty?
+        }
+
+        [status, hsh, body.flatten]
+      end
+    end
+  end
+end

data/lib/raki/cache.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'crimp'
+
+# not yet finished
+# requires a Rails environment! (see Rails below)
+# middleware for caching.
+
+module Raki
+  class Cache < Raki::MiddlewareBase
+    def call(env)
+      @block&.call(env)
+      kache(Crimp.signature(env)) {
+        @app.call(env)
+      }
+    end
+
+   private
+    def kache(key)
+      # raise 'Missing Rails environment' unless defined?(Rails.cache)
+      return yield unless defined?(Rails.cache)
+
+      Rails.cache.fetch(key, expires_in: 1.hour) {
+        yield
+      }
+    end
+  end
+end

data/lib/raki/idem.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Middleware just passing over or returning the params.
+module Raki
+  class Idem < Raki::MiddlewareBase
+    def call(env)
+      return env unless @app
+
+      @block&.call(env)
+      @app.call(env)
+    end
+  end
+end

data/lib/raki/lint.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Raki::AssertRequest validates your requests according to Raki spec.
+
+# see also:
+# cat ~/test/rack/lib/rack/lint.rb
+# cat ~/test/rack/SPEC.rdoc
+module Raki
+  class LintError < RuntimeError; end
+
+  class Lint < Raki::MiddlewareBase
+    def call(env)
+      assert('No env given') { env }
+      assert('Block complained') { @block.call(env) } if @block
+
+      @block&.call(env)
+      response = @app.call(env)
+
+      assert('Expected array') { response.class == Array }
+      assert('Expected array of 3 items') { response.size == 3 }
+      assert('First item must be an Integer') { response[0].class == Integer }
+      assert('Second item must be a Hash') { response[1].class == Hash }
+      assert('Third item must be an Array') { response[2].class == Array }
+
+      response
+    end
+
+   private
+    def assert(message)
+      return if yield
+
+      raise LintError, message
+    end
+  end
+end

data/lib/raki/merge.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Middleware Merge.
+module Raki
+  class Merge < Raki::MiddlewareBase
+    def call(env)
+      my_env = env.merge(*@args)
+      @block&.call(my_env)
+      @app.call(my_env)
+    end
+  end
+end

data/lib/raki/middleware_base.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Middleware just passing over or returning the params.
+module Raki
+  class MiddlewareBase
+    def initialize(app = nil, *args, &block)
+      @app = app
+      @args = args
+      @block = block
+    end
+
+    def call(_env)
+      raise '#call must be overwritten by a middleware raki'
+    end
+  end
+end

data/lib/raki/nil.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Returns a Raki zero.
+module Raki
+  class Nil < Raki::MiddlewareBase
+    def call(_env)
+      @block&.call(env)
+      @app&.call(env)
+
+      [200, {}, []]
+    end
+  end
+end

data/lib/raki/require.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Middleware Require.
+module Raki
+  class RequireError < RuntimeError; end
+
+  class Require < Raki::MiddlewareBase
+    def call(env)
+      expected = @args.flatten.sort
+      bool = env.keys.sort == expected
+      raise(RequireError, "Expected <#{expected.join}>") unless bool
+
+      @block&.call(env)
+      @app.call(env)
+    end
+  end
+end

data/lib/raki/slice.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Middleware Slice.
+module Raki
+  class Slice < Raki::MiddlewareBase
+    def call(env)
+      my_env = env.slice(*@args.flatten)
+      @block&.call(my_env)
+      @app.call(my_env)
+    end
+  end
+end

data/lib/raki/version.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Raki is freely distributable under the terms of an MIT-style license.
+# See MIT-LICENSE or https://opensource.org/licenses/MIT.
+
+# The Raki main module, serving as a namespace for all core Raki
+# modules and classes.
+#
+# All modules meant for use in your application are <tt>autoload</tt>ed here,
+# so it should be enough just to <tt>require 'rack'</tt> in your code.
+
+module Raki
+  VERSION = '0.0.2'
+end

data/raki.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/raki/version'
+
+Gem::Specification.new do |s|
+  s.name = "raki"
+  s.version = Raki::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.summary = "A modular hash interface."
+  s.license = "MIT"
+
+  s.description = <<~EOF
+    Raki provides a minimal, modular and adaptable interface for developing
+    web applications in Ruby. By wrapping HTTP requests and responses in
+    the simplest way possible, it unifies and distills the API for web
+    servers, web frameworks, and software in between (the so-called
+    middleware) into a single method call.
+  EOF
+
+  s.files = Dir['{bin/*,contrib/*,example/*,lib/**/*}'] +
+    %w(raki.gemspec Rakefile)
+
+  s.bindir = 'bin'
+  s.require_path = 'lib'
+
+  s.author = 'Dittmar Krall'
+  s.email = 'dittmar.krall@matique.de'
+
+  s.homepage = 'https://matique.com'
+
+  s.required_ruby_version = '>= 2.6.0'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'bundler'
+
+  s.add_development_dependency 'minitest', "~> 5.0"
+  s.add_development_dependency 'minitest-sprint'
+  s.add_development_dependency 'minitest-global_expectations'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: raki
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Dittmar Krall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-sprint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-global_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Raki provides a minimal, modular and adaptable interface for developing
+  web applications in Ruby. By wrapping HTTP requests and responses in
+  the simplest way possible, it unifies and distills the API for web
+  servers, web frameworks, and software in between (the so-called
+  middleware) into a single method call.
+email: dittmar.krall@matique.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/raki.rb
+- lib/raki/block.rb
+- lib/raki/builder.rb
+- lib/raki/cache.rb
+- lib/raki/idem.rb
+- lib/raki/lint.rb
+- lib/raki/merge.rb
+- lib/raki/middleware_base.rb
+- lib/raki/nil.rb
+- lib/raki/require.rb
+- lib/raki/slice.rb
+- lib/raki/version.rb
+- raki.gemspec
+homepage: https://matique.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: A modular hash interface.
+test_files: []