shogun 6.2.1 → 6.2.2

data/scaffold/new/project/Envfile

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby -wKU
+
+variable :APPLICATION_LOG_LEVEL, :string
+variable :APPLICATION_SESSION_SECRET, :string
+variable :CLIENT_HOST, :string
+variable :SERVER_HOST, :string
+variable :PUMA_THREADS_MAX, :integer
+variable :PUMA_THREADS_MIN, :integer
+variable :PUMA_WORKERS, :integer
+variable :PUMA_WORKER_TIMEOUT, :integer
+variable :RACK_ENV, :string
+variable :PORT,:integer
+variable :DATABASE_POOL, :integer
+variable :DATABASE_REAP_FREQUENCY, :integer
+variable :DATABASE_TIMEZONE, :string
+variable :DATABASE_TIMEOUT, :integer
+variable :DATABASE_URL, :string

data/scaffold/new/project/Gemfile

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby -wKU
+
+source "https://rubygems.org"
+
+ruby "2.1.5"
+
+gem "shogun", "~> 6.0.0"
+gem "oj", "~> 2.11.1"
+gem "jwt", "~> 1.2.0"
+gem "puma", "~> 2.10.2"
+gem "pg", "~> 0.17.1"
+gem "bcrypt", "~> 3.1.9"
+gem "moneta", "~> 0.8.0"
+gem "pry", "~> 0.10.1"
+gem "rspec", "~> 3.1.0"
+gem "guard", "~> 2.10.2"
+gem "envied", "~> 0.8.1"
+gem "dotenv", "~> 1.0.2"

data/scaffold/new/project/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 {{author}}
+
+MIT License
+
+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/scaffold/new/project/Procfile

@@ -0,0 +1 @@
+web: bundle exec puma --config config/puma.rb --port $PORT

data/scaffold/new/project/README.md

@@ -0,0 +1,32 @@
+{{namespace}}
+========
+
+  - [![Quality](http://img.shields.io/codeclimate/github/{{author}}/{{namespace}}.svg?style=flat-square)](https://codeclimate.com/github/{{author}}/{{namespace}})
+  - [![Coverage](http://img.shields.io/codeclimate/coverage/github/{{author}}/{{namespace}}.svg?style=flat-square)](https://codeclimate.com/github/{{author}}/{{namespace}})
+  - [![Build](http://img.shields.io/travis-ci/{{author}}/{{namespace}}.svg?style=flat-square)](https://travis-ci.org/{{author}}/{{namespace}})
+  - [![Dependencies](http://img.shields.io/gemnasium/{{author}}/{{namespace}}.svg?style=flat-square)](https://gemnasium.com/{{author}}/{{namespace}})
+  - [![Tags](http://img.shields.io/github/tag/{{author}}/{{namespace}}.svg?style=flat-square)](http://github.com/{{author}}/{{namespace}}/tags)
+  - [![Releases](http://img.shields.io/github/release/{{author}}/{{namespace}}.svg?style=flat-square)](http://github.com/{{author}}/{{namespace}}/releases)
+  - [![Issues](http://img.shields.io/github/issues/{{author}}/{{namespace}}.svg?style=flat-square)](http://github.com/{{author}}/{{namespace}}/issues)
+  - [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](http://opensource.org/licenses/MIT)
+  - [![Version](http://img.shields.io/badge/version-1.0.0-blue.svg?style=flat-square)](http://github.com/{{author}}/{{namespace}})
+
+
+A sample HTTP HATEOS JSON API project.
+
+
+middleware
+==========
+
+All of the middleware used:
+
+  - rack-protection, for protecting against common attack vectors
+  - rack-authentication_bearer, for parsing the bearer token
+  - rack-accept_setter, for storing an accept string
+  - rack-content_length_setter, for determining and storing the content-length
+  - rack-chuncker, for handling (automatically) body chunking
+  - rack-log, for storing a global logger
+  - rack-runtime, for storing the runtime
+  - rack-dispatch, for handling routing
+  - rack-body_serializer, for serializing the body of responses
+  - rack-body_deserializer, for deserializing inputs in requests

data/scaffold/new/project/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+
+require "rspec/core/rake_task"
+
+desc "Run all the tests in spec"
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Default: run tests"
+task default: :spec

data/scaffold/new/project/config.ru

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby -wKU
+# encoding: utf-8
+
+require File.expand_path(File.join("..", "lib", "{{namespace}}"), __FILE__)
+require File.expand_path(File.join("..", "lib", "{{namespace}}", "server"), __FILE__)
+
+Shogun::Database.new(logger: {{namespace_module}}.logger)
+{{namespace_module}}::Server.new(rack: self, logger: {{namespace_module}}.logger)

data/scaffold/new/project/config/puma.rb

@@ -0,0 +1,167 @@
+#!/usr/bin/env puma
+
+require "envied"
+require "dotenv"
+
+Dotenv.load
+ENVied.require
+
+# The directory to operate out of.
+#
+# The default is the current directory.
+#
+# directory '/u/apps/lolcat'
+
+# Use an object or block as the rack application. This allows the
+# config file to be the application itself.
+#
+# app do |env|
+#   puts env
+#
+#   body = 'Hello, World!'
+#
+#   [200, { 'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s }, [body]]
+# end
+
+# Load “path” as a rackup file.
+#
+# The default is “config.ru”.
+#
+# rackup '/u/apps/lolcat/config.ru'
+
+# Set the environment in which the rack's app will run. The value must be a string.
+#
+# The default is “development”.
+#
+environment(ENV["RACK_ENV"])
+
+# Daemonize the server into the background. Highly suggest that
+# this be combined with “pidfile” and “stdout_redirect”.
+#
+# The default is “false”.
+#
+# daemonize
+# daemonize false
+
+# Store the pid of the server in the file at “path”.
+#
+# pidfile '/u/apps/lolcat/tmp/pids/puma.pid'
+
+# Use “path” as the file to store the server info state. This is
+# used by “pumactl” to query and control the server.
+#
+# state_path '/u/apps/lolcat/tmp/pids/puma.state'
+
+# Redirect STDOUT and STDERR to files specified. The 3rd parameter
+# (“append”) specifies whether the output is appended, the default is
+# “false”.
+#
+# stdout_redirect '/u/apps/lolcat/log/stdout', '/u/apps/lolcat/log/stderr'
+# stdout_redirect '/u/apps/lolcat/log/stdout', '/u/apps/lolcat/log/stderr', true
+
+# Disable request logging.
+#
+# The default is “false”.
+#
+quiet
+
+# Configure “min” to be the minimum number of threads to use to answer
+# requests and “max” the maximum.
+#
+# The default is “0, 16”.
+#
+threads(Integer(ENV["PUMA_THREADS_MIN"]), Integer(ENV["PUMA_THREADS_MAX"]))
+
+# Bind the server to “url”. “tcp://”, “unix://” and “ssl://” are the only
+# accepted protocols.
+#
+# The default is “tcp://0.0.0.0:9292”.
+#
+# bind 'tcp://0.0.0.0:9292'
+# bind 'unix:///var/run/puma.sock'
+# bind 'unix:///var/run/puma.sock?umask=0777'
+# bind 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert'
+
+# Instead of “bind 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert'” you
+# can also use the “ssl_bind” option.
+#
+# ssl_bind '127.0.0.1', '9292', { key: path_to_key, cert: path_to_cert }
+
+# Code to run before doing a restart. This code should
+# close log files, database connections, etc.
+#
+# This can be called multiple times to add code each time.
+#
+on_restart do
+  require "./lib/{{namespace}}"
+  Shogun::Database.connection.disconnect! and {{namespace_module}}.logger.debug { "Closed database connection." }
+  {{namespace_module}}.logger.close
+end
+
+# Command to use to restart puma. This should be just how to
+# load puma itself (ie. 'ruby -Ilib bin/puma'), not the arguments
+# to puma, as those are the same as the original process.
+#
+# restart_command '/u/app/lolcat/bin/restart_puma'
+
+# === Cluster mode ===
+
+# How many worker processes to run.
+#
+# The default is “0”.
+#
+workers(Integer(ENV["PUMA_WORKERS"] || 0))
+
+# Code to run when a worker boots to setup the process before booting
+# the app.
+#
+# This can be called multiple times to add hooks.
+#
+on_worker_boot do
+  require "./lib/{{namespace}}"
+  Shogun::Database.new(logger: {{namespace_module}}.logger)
+end
+
+# Code to run when a worker boots to setup the process after booting
+# the app.
+#
+# This can be called multiple times to add hooks.
+#
+# after_worker_boot do
+#
+# end
+
+# Allow workers to reload bundler context when master process is issued
+# a USR1 signal. This allows proper reloading of gems while the master
+# is preserved across a phased-restart. (incompatible with preload_app)
+# (off by default)
+
+# prune_bundler
+
+# Preload the application before starting the workers; this conflicts with
+# phased restart feature. (off by default)
+
+# preload_app!
+
+# Additional text to display in process listing
+#
+tag(ENV["APPLICATION_NAME"])
+
+# Change the default timeout of workers
+#
+worker_timeout(Integer(ENV["PUMA_WORKER_TIMEOUT"] || 60))
+
+# === Puma control rack application ===
+
+# Start the puma control rack application on “url”. This application can
+# be communicated with to control the main server. Additionally, you can
+# provide an authentication token, so all requests to the control server
+# will need to include that token as a query parameter. This allows for
+# simple authentication.
+#
+# Check out https://github.com/puma/puma/blob/master/lib/puma/app/status.rb
+# to see what the app has available.
+#
+# activate_control_app 'unix:///var/run/pumactl.sock'
+# activate_control_app 'unix:///var/run/pumactl.sock', { auth_token: '12345' }
+# activate_control_app 'unix:///var/run/pumactl.sock', { no_token: true }

data/scaffold/new/project/gitignore

@@ -0,0 +1,39 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore all bundler caching
+/vendor/cache
+/vendor/ruby
+
+# Ignore the default SQLite database.
+/db/*.sqlite3*
+/db/*.sql
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+
+# Ignore environment file
+/.ruby-env
+/.env
+
+# Ignore application configuration
+/config/application.yml
+
+# Ignoring the compiled assets
+/public/assets
+/public/uploads
+
+# Ignore documentation directory
+/doc
+
+# Ignoring provisioning files
+/cookbooks
+/.vagrant
+/*.paw

data/scaffold/new/project/lib/namespace.rb

@@ -0,0 +1,29 @@
+require "logger"
+require "scrawl"
+require "bcrypt"
+require "pg"
+require "active_record"
+require "moneta"
+require "adamantium"
+require "memoizable"
+require "shogun"
+require "envied"
+require "dotenv"
+
+Dotenv.load
+ENVied.require
+
+module {{namespace_module}}
+  require_relative "{{namespace}}/errors"
+  require_relative "{{namespace}}/accounts"
+  require_relative "{{namespace}}/sessions"
+
+  def self.logger(io: STDOUT, level: ::Logger.const_get(ENV["APPLICATION_LOG_LEVEL"]))
+    @logger ||= ::Logger.new(STDOUT).tap do |log|
+      log.level = level
+      log.formatter = ->(level, stamp, name, message) do
+        Scrawl.new(level: level, time: stamp.to_datetime.rfc3339, name: name, message: message.strip).inspect + "\n"
+      end
+    end
+  end
+end

data/scaffold/new/project/lib/namespace/accounts.rb

@@ -0,0 +1,15 @@
+module {{namespace_module}}
+  module Accounts
+    NAMESPACE = "accounts"
+
+    require_relative "accounts/create"
+    require_relative "accounts/destroy"
+    require_relative "accounts/endpoint"
+    require_relative "accounts/list"
+    require_relative "accounts/model"
+    require_relative "accounts/null"
+    require_relative "accounts/presenter"
+    require_relative "accounts/show"
+    require_relative "accounts/update"
+  end
+end

data/scaffold/new/project/lib/namespace/accounts/create.rb

@@ -0,0 +1,10 @@
+module {{namespace_module}}
+  module Accounts
+    module Create
+      require_relative "create/control"
+      require_relative "create/denormalizer"
+      require_relative "create/normalizer"
+      require_relative "create/validator"
+    end
+  end
+end

data/scaffold/new/project/lib/namespace/accounts/create/control.rb

@@ -0,0 +1,27 @@
+module {{namespace_module}}
+  module Accounts
+    module Create
+      class Control
+        include Shogun::Control
+        include Accounts
+
+        def initialize(payload:)
+          @normalizer = Normalizer.new(raw: payload.to_hash)
+          @validator = Validator.new(data: @normalizer)
+
+          if @validator.valid?
+            @model = Model.create(@normalizer.to_hash)
+
+            @presenter = Presenter.new(resource: @model)
+            @denormalizer = Denormalizer.new(object: @presenter)
+            @status = OK
+          else
+            @presenters = Shogun::Presenters.new(resources: @validator.invalids, cast: Errors::Presenter)
+            @denormalizer = Errors::Denormalizer.new(object: @presenters)
+            @status = UNPROCESSABLE_ENTITY
+          end
+        end
+      end
+    end
+  end
+end

data/scaffold/new/project/lib/namespace/accounts/create/denormalizer.rb

@@ -0,0 +1,35 @@
+module {{namespace_module}}
+  module Accounts
+    module Create
+      class Denormalizer
+        include Shogun::Denormalizer
+        include Accounts
+
+        MAPPING = {
+          "id" => "id",
+          "signature" => "signature",
+          "username" => "username",
+          "email" => "email",
+          "name" => "name",
+          "created_at" => "created_at",
+          "destroyed_at" => "destroyed_at",
+          "updated_at" => "updated_at",
+          "href" => "href"
+        }
+
+        def initialize(object:)
+          @object = object
+          @meta = object.meta
+          @links = object.links
+          @linked = object.linked
+        end
+
+        private def document
+          mapping.inject({}) do |hash, (field, name)|
+            hash.merge(field => @object.public_send(name))
+          end
+        end
+      end
+    end
+  end
+end