kingfisher 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96ea6b666ef0a71463260c13c70d02f4362432bd
+  data.tar.gz: 41af6c0139e78cd221d4147b8bb442d46ef97615
+SHA512:
+  metadata.gz: 8634da7fd4c0176e59d5364e620a9d70fb69386a9de7bc705d625d387aaaebd9484c60ae9819a2f3e674a0eb02e943d07e113106dc8f5d51f18be1ace809c128
+  data.tar.gz: a551fa15a79e8dff367fa70bd4c204b07b3cb9adb33452cea80fee4da602c136f7d16c6f80670711518700b0840391dcdd122d2b0d54342e1db9204d6f8da912

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at halogenandtoast@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Matthew Mongeau
+
+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,15 @@
+# Kingfisher
+
+A web framework
+
+## Installation
+
+```ruby
+gem install kingfisher
+```
+
+## Usage
+
+```
+kingfisher new APP_NAME
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kingfisher"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kingfisher.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kingfisher/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kingfisher"
+  spec.version       = Kingfisher::VERSION
+  spec.authors       = ["Matthew Mongeau"]
+  spec.email         = ["halogenandtoast@gmail.com"]
+
+  spec.summary       = %q{A modular web framework with opinions}
+  spec.description   = %q{A modular web framework with opinions}
+  spec.homepage      = "https://github.com/halogenandtoast/kingfisher"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/kingfisher.rb

@@ -0,0 +1,4 @@
+require "kingfisher/version"
+
+module Kingfisher
+end

data/lib/kingfisher/app.rb

@@ -0,0 +1,41 @@
+module Kingfisher
+  class App
+    def initialize(router, config)
+      @router = router
+      @config = config
+      @builder = Rack::Builder.new
+
+      config.middlewares.each do |middleware|
+        builder.use middleware.klass, *middleware.args, &middleware.block
+      end
+
+      builder.run(router)
+
+      run_initializers
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      request.env["repo"] = repo
+
+      builder.call(env)
+    end
+
+    private
+    attr_reader :builder, :router, :config
+
+    def root
+      config.root
+    end
+
+    def repo
+      @_repo ||= config.repo.new(config.backend)
+    end
+
+    def run_initializers
+      Dir.glob("#{root}/config/initializers/*.rb").each do |file|
+        require file
+      end
+    end
+  end
+end

data/lib/kingfisher/controller.rb

@@ -0,0 +1,63 @@
+module Kingfisher
+  class NullRepo
+    def all(_)
+      []
+    end
+  end
+
+  class Redirect
+    DEFAULTS = {
+      status_code: 302,
+      body: ["You are being redirected"],
+      headers: { "Content-Type" => "plain/text" }
+    }
+    def initialize(to:, **options)
+      @path = to
+      @options = DEFAULTS.merge(options)
+    end
+
+    def status_code
+      options[:status_code]
+    end
+
+    def headers
+      options[:headers].merge("Location" => path)
+    end
+
+    def body
+      options[:body]
+    end
+
+    private
+    attr_reader :path, :options
+  end
+
+  class Controller
+    def initialize(env)
+      @env = env
+    end
+
+    private
+    attr_reader :env
+
+    def request
+      @_request ||= Rack::Request.new(env)
+    end
+
+    def view(view_class, locals: {})
+      view_class.new(request, locals: locals)
+    end
+
+    def repo
+      request.env.fetch("repo") { NullRepo.new }
+    end
+
+    def params
+      request.params
+    end
+
+    def redirect(path)
+      Redirect.new(path)
+    end
+  end
+end

data/lib/kingfisher/csrf.rb

@@ -0,0 +1,41 @@
+module Kingfisher
+  class CSRF
+    def initialize(request)
+      @request = request
+    end
+
+    def token
+      session[:csrf_token] ||= SecureRandom.base64(32)
+    end
+
+    def reset!
+      session.delete(:csrf_token)
+    end
+
+    def safe?
+      return true if request.get? || request.head?
+      return true if request[:csrf_token] == token
+
+      request.env["HTTP_X_CSRF_TOKEN"] == token
+    end
+
+    def unsafe?
+      !safe?
+    end
+
+    def form_input
+      %Q(<input type="hidden" name="csrf_token" value="#{token}">)
+    end
+
+    def meta_tag
+      %Q(<meta name="csrf_token" content="#{token}">)
+    end
+
+    def session
+      request.env["rack.session"]
+    end
+
+    private
+    attr_reader :request
+  end
+end

data/lib/kingfisher/database_backends/postgresql.rb

@@ -0,0 +1,47 @@
+require "sequel"
+
+module Kingfisher
+  module DatabaseBackends
+    class PostgreSQL
+      def initialize(database_url:)
+        @database_url = database_url
+        @db = open_db
+      end
+
+      def all(model)
+        db[table_name(model)].all
+      end
+
+      def create(model, params)
+        id = db[table_name(model)].insert(params)
+        attributes = symbolize_keys(params).merge(id: id)
+        model.new(attributes)
+      end
+
+      def find(model, id)
+        find_by(model, id: id)
+      end
+
+      def find_by(model, attributes)
+        db[table_name(model)][**attributes]
+      end
+
+      private
+      attr_reader :db, :database_url
+
+      def open_db
+        Sequel.connect database_url
+      end
+
+      def table_name(model)
+        model.name.downcase.to_sym
+      end
+
+      def symbolize_keys(hash)
+        hash.each_with_object({}) do |(key, value), new_hash|
+          new_hash[key.to_sym] = value
+        end
+      end
+    end
+  end
+end

data/lib/kingfisher/database_backends/sqlite3.rb

@@ -0,0 +1,47 @@
+require "sequel"
+
+module Kingfisher
+  module DatabaseBackends
+    class SqlLite3
+      def initialize(database_url:)
+        @database_url = database_url
+        @db = open_db
+      end
+
+      def all(model)
+        db[table_name(model)].all
+      end
+
+      def create(model, params)
+        id = db[table_name(model)].insert(params)
+        attributes = symbolize_keys(params).merge(id: id)
+        model.new(attributes)
+      end
+
+      def find(model, id)
+        find_by(model, id: id)
+      end
+
+      def find_by(model, attributes)
+        db[table_name(model)][**attributes]
+      end
+
+      private
+      attr_reader :db, :database_url
+
+      def open_db
+        Sequel.connect database_url
+      end
+
+      def table_name(model)
+        model.name.downcase.to_sym
+      end
+
+      def symbolize_keys(hash)
+        hash.each_with_object({}) do |(key, value), new_hash|
+          new_hash[key.to_sym] = value
+        end
+      end
+    end
+  end
+end

data/lib/kingfisher/middleware.rb

@@ -0,0 +1,27 @@
+module Kingfisher
+  class Middleware
+    attr_reader :klass, :args, :block
+    def initialize(klass, args, block)
+      @klass = klass
+      @args = args
+      @block = block
+    end
+  end
+
+  class MiddlewareStack
+    def initialize
+      @middlewares = []
+    end
+
+    def each
+      middlewares.each { |x| yield x }
+    end
+
+    def use(klass, *args, &block)
+      middlewares.push(Middleware.new(klass, args, block))
+    end
+
+    private
+    attr_reader :middlewares
+  end
+end

data/lib/kingfisher/middlewares/file_logger.rb

@@ -0,0 +1,23 @@
+module Kingfisher
+  module Middlewares
+    class FileLogger
+      def initialize(app, args)
+        @app = app
+        @filename = args[:file]
+      end
+
+      def call(env)
+        app.call(env).tap do |response|
+          log(response.inspect)
+        end
+      end
+
+      private
+      attr_reader :app, :filename
+
+      def log(message)
+        File.open(filename, "a+") { |file| file.puts message }
+      end
+    end
+  end
+end

data/lib/kingfisher/model.rb

@@ -0,0 +1,14 @@
+module Kingfisher
+  class Model
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def [](key)
+      attributes[key]
+    end
+
+    private
+    attr_reader :attributes
+  end
+end

data/lib/kingfisher/repo.rb

@@ -0,0 +1,27 @@
+module Kingfisher
+  class Repo
+    def initialize(backend)
+      @backend = backend
+    end
+
+    def all(model)
+      backend.all(model)
+    end
+
+    def find(model, id)
+      backend.find(model, id)
+    end
+
+    def create(model, params)
+      backend.create(model, params)
+    end
+
+    def find_by(model, attributes)
+      backend.find_by(model, attributes)
+    end
+
+    private
+    attr_reader :backend
+
+  end
+end

data/lib/kingfisher/route_set.rb

@@ -0,0 +1,85 @@
+module Kingfisher
+  class RouteSet
+    def initialize
+      @routes = []
+    end
+
+    def match(request)
+      mroute = @routes.find { |route| route.match?(request) }
+      Operation.either(->(_){ raise NoRouteError, "#{request.request_method} #{request.path}" }, mroute).result
+    end
+
+    def get(url, controller, action)
+      @routes << Route.new(:get, url, controller, action)
+    end
+
+    def post(url, controller, action)
+      @routes << Route.new(:post, url, controller, action)
+    end
+
+    def delete(url, controller, action)
+      @routes << Route.new(:delete, url, controller, action)
+    end
+  end
+
+  class Route
+    def initialize(verb, url, app, action)
+      @verb = verb
+      @url = url
+      @app = app
+      @action = action
+    end
+
+    def match?(request)
+      request.request_method.downcase.to_sym == verb && request.path == url
+    end
+
+    def call(env)
+      response = app.new(env).public_send(action)
+      [response.status_code, response.headers, response.body]
+    end
+
+    private
+    attr_reader :verb, :url, :app, :action
+  end
+
+  module Operation
+    def self.either(failure, maybe)
+      if maybe.nil?
+        Failure.new(failure)
+      else
+        Success.new(maybe)
+      end
+    end
+  end
+
+  class Failure
+    attr_reader :failure
+    def initialize(failure)
+      @failure = failure
+    end
+
+    def result
+      @failure
+    end
+
+    def success?
+      false
+    end
+  end
+
+  class Success
+    attr_reader :success
+    def initialize(success)
+      @success = success
+    end
+
+    def result
+      @success
+    end
+
+    def success?
+      true
+    end
+  end
+end

data/lib/kingfisher/router.rb

@@ -0,0 +1,45 @@
+module Kingfisher
+  NoRouteError = Class.new(StandardError)
+
+  class Router
+    def call(env)
+      request = Rack::Request.new(env)
+
+      if csrf(request).unsafe?
+        forbidden
+      else
+        route(request).call(env)
+      end
+    end
+
+    private
+
+    def route_set
+      @_route_set ||= RouteSet.new
+    end
+
+    def route(request)
+      route_set.match(request)
+    end
+
+    def get(url, controller, action)
+      route_set.get(url, controller, action)
+    end
+
+    def post(url, controller, action)
+      route_set.post(url, controller, action)
+    end
+
+    def delete(url, controller, action)
+      route_set.delete(url, controller, action)
+    end
+
+    def forbidden
+      [403, {"Content-Type" => "text/plain"}, ["Forbidden"]]
+    end
+
+    def csrf(request)
+      @_csrf ||= CSRF.new(request)
+    end
+  end
+end

data/lib/kingfisher/sqlite3_backend.rb

@@ -0,0 +1,40 @@
+require "sequel"
+
+module Kingfisher
+  class SqlLite3Backend
+    def initialize(file)
+      @db = Sequel.connect("sqlite://#{file}")
+    end
+
+    def all(model)
+      db[table_name(model)].to_a
+    end
+
+    def create(model, params)
+      id = db[table_name(model)].insert(params)
+      attributes = symbolize_keys(params).merge(id: id)
+      model.new(attributes)
+    end
+
+    def find(model, id)
+      find_by(model, id: id)
+    end
+
+    def find_by(model, attributes)
+      model.new(db[table_name(model)][**attributes])
+    end
+
+    private
+    attr_reader :db
+
+    def table_name(model)
+      model.name.downcase.to_sym
+    end
+
+    def symbolize_keys(hash)
+      hash.each_with_object({}) do |(key, value), new_hash|
+        new_hash[key.to_sym] = value
+      end
+    end
+  end
+end

data/lib/kingfisher/version.rb

@@ -0,0 +1,3 @@
+module Kingfisher
+  VERSION = "0.0.1"
+end

data/lib/kingfisher/view.rb

@@ -0,0 +1,35 @@
+require "slim"
+
+module Kingfisher
+  class View
+    def initialize(request, locals: {})
+      @request = request
+      @locals = locals
+    end
+
+    def status_code
+      @_status_code ||= 200
+    end
+
+    def headers
+      @_headers ||= { "Content-Type" => "text/html" }
+    end
+
+    def body
+      [render]
+    end
+
+    def render
+      Slim::Template.
+        new("web/templates/#{template}.slim").
+        render(self)
+    end
+
+    private
+    attr_reader :locals, :request
+
+    def template
+      self.class.name.gsub(/View$/, "").gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: kingfisher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Mongeau
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A modular web framework with opinions
+email:
+- halogenandtoast@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kingfisher.gemspec
+- lib/kingfisher.rb
+- lib/kingfisher/app.rb
+- lib/kingfisher/controller.rb
+- lib/kingfisher/csrf.rb
+- lib/kingfisher/database_backends/postgresql.rb
+- lib/kingfisher/database_backends/sqlite3.rb
+- lib/kingfisher/middleware.rb
+- lib/kingfisher/middlewares/file_logger.rb
+- lib/kingfisher/model.rb
+- lib/kingfisher/repo.rb
+- lib/kingfisher/route_set.rb
+- lib/kingfisher/router.rb
+- lib/kingfisher/sqlite3_backend.rb
+- lib/kingfisher/version.rb
+- lib/kingfisher/view.rb
+homepage: https://github.com/halogenandtoast/kingfisher
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A modular web framework with opinions
+test_files: []