Skip to content

Commit 39bcf5d

Browse files
simensensimensen
committed
Merge pull request stackphp#7 from simensen/specs
Framework for handling specs and proposals.
2 parents 60eafdf + dc2105d commit 39bcf5d

File tree

8 files changed

+302
-48
lines changed

8 files changed

+302
-48
lines changed

‎source/_views/default.html‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,30 @@
1515
<![endif]-->
1616
</head>
1717
<body>
18+
19+
<div class="jumbotron masthead {% if page.is_homepage %}huge{% endif %}">
20+
<h1><a href="{{ site.url }}/">Stack</a></h1>
21+
<p class="tagline">Composing <a href="https://github.com/symfony/symfony/blob/master/src/Symfony/Component/HttpKernel/HttpKernelInterface.php">HttpKernelInterface</a> middlewares since 2013!</p>
22+
<p>
23+
<ul class="nav nav-pills" style="display: inline-block;">
24+
<li>
25+
<a href="https://github.com/stackphp"><i class="icon-github"></i> stackphp</a>
26+
</li>
27+
<li>
28+
<a href="https://twitter.com/stackphp"><i class="icon-twitter"></i> @stackphp</a>
29+
</li>
30+
<li>
31+
<a href="irc://irc.freenode.net/%23stackphp"><i class="icon-comment"></i> #stackphp</a>
32+
</li>
33+
</ul>
34+
</p>
35+
</div>
36+
1837
<div class="mainContent container">
1938
<div class="row-fluid">
39+
40+
<hr>
41+
2042
{% block content_wrapper %}{% block content %}{% endblock %}{% endblock %}
2143
</div>
2244
</div>

‎source/_views/spec.html‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{% extends "default.html" %}
2+
{% block content_wrapper %}
3+
<div class="spec-meta">
4+
<h2>{{ page.title }} <span class="label">{{ page.status }}</span></h2>
5+
</div>
6+
<section class="spec-body">
7+
8+
{% block content %}
9+
<p>This proposal has no content.</p>
10+
{% endblock %}
11+
</section>
12+
{% endblock %}

‎source/css/style.css‎

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
.anchor {
2+
font-size: .75em;
3+
text-decoration: none;
4+
visibility: hidden;
5+
}
6+
7+
h2:hover .anchor {
8+
visibility: visible;
9+
text-decoration: none;
10+
}
11+
12+
h3 a, h3 a:hover {
13+
color: inherit;
14+
text-decoration: none;
15+
}
16+
17+
h2 .label,
18+
h3 .label { vertical-align: middle; }
19+
120
.jumbotron {
221
text-align: center;
322
margin: 2em 0;
@@ -12,14 +31,20 @@
1231
}
1332

1433
.jumbotron h1 {
34+
display: inline-block;
35+
font-size: 4em;
36+
line-height: 1em;
37+
}
38+
39+
.jumbotron h1 a {
1540
display: inline-block;
1641
background-image: url(stack-logo.png);
1742
background-position: left;
1843
background-repeat: no-repeat;
1944
background-size: contain;
20-
font-size: 5em;
21-
line-height: 1em;
2245
text-indent: 1em;
46+
color: inherit;
47+
text-decoration: none;
2348
}
2449

2550
.jumbotron p.tagline {
@@ -107,7 +132,7 @@ ol.conventions .no {
107132
}
108133

109134
@media (max-width: 767px) {
110-
.jumbotron a.btn {
135+
.jumbotron .nav a.btn {
111136
font-size: 12px;
112137
padding: 5px 9px;
113138
}
@@ -121,18 +146,23 @@ ol.conventions .no {
121146
margin-top: -0.2em;
122147
}
123148

149+
.conventions-and-protocols div.row-fluid h3,
124150
.middlewares div.row-fluid h3 {
125151
margin-top: 20px;
126152
}
127153
}
128154

129155
@media (min-width: 768px) {
130-
.jumbotron {
156+
.jumbotron.huge {
131157
font-size: 2em;
132158
margin-bottom: 2em;
133159
}
134160

135-
.jumbotron a.btn {
161+
.jumbotron .nav {
162+
margin-bottom: 0;
163+
}
164+
165+
.jumbotron .nav a.btn {
136166
margin-top: 1em;
137167
}
138168

@@ -145,6 +175,7 @@ ol.conventions .no {
145175
margin-top: 10px;
146176
}
147177

178+
.conventions-and-protocols div.row-fluid:not(:nth-of-type(1)),
148179
.middlewares div.row-fluid:not(:nth-of-type(1)) {
149180
margin-top: 2em;
150181
}

‎source/index.html‎

Lines changed: 63 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,9 @@
11
---
22
layout: default
3+
is_homepage: true
34
---
45
{% block full_title %}{{ site.title }} &mdash; {{ site.subtitle }}{% endblock %}
56
{% block content %}
6-
<div class="jumbotron masthead">
7-
<h1>Stack</h1>
8-
<p class="tagline">Composing <a href="https://github.com/symfony/symfony/blob/master/src/Symfony/Component/HttpKernel/HttpKernelInterface.php">HttpKernelInterface</a> middlewares since 2013!</p>
9-
<p>
10-
<ul class="nav nav-pills" style="display: inline-block;">
11-
<li>
12-
<a href="https://github.com/stackphp"><i class="icon-github"></i> stackphp</a>
13-
</li>
14-
<li>
15-
<a href="https://twitter.com/stackphp"><i class="icon-twitter"></i> @stackphp</a>
16-
</li>
17-
<li>
18-
<a href="irc://irc.freenode.net/%23stackphp"><i class="icon-comment"></i> #stackphp</a>
19-
</li>
20-
</ul>
21-
</p>
22-
</div>
23-
24-
<hr>
25-
267
<div class="about text">
278
<h2>A common layer</h2>
289
<p>
@@ -168,32 +149,71 @@ <h3>Backstage</h3>
168149
</div>
169150
</div>
170151

171-
<!--
172152
<hr>
173153

174-
<div class="examples">
175-
<h2>How do I use it?</h2>
176-
<pre><code class="php">use Symfony\Component\HttpFoundation\Request;
177-
use Symfony\Component\HttpKernel\HttpCache\Store;
178-
179-
// This can be **any** HttpKernelInterface based application
180-
$app = new Silex\Application();
181-
$app->get('/', function () {
182-
return 'Hello World!';
183-
});
184-
185-
// Extend the behaviour of the application with some middlewares
186-
$stack = (new Stack\Builder())
187-
->push('Stack\Session')
188-
->push('Symfony\Component\HttpKernel\HttpCache\HttpCache', new Store(__DIR__.'/cache'));
189-
$app = $stack->resolve($app);
190-
191-
// Front controller is business as usual
192-
$request = Request::createFromGlobals();
193-
$response = $app->handle($request)->send();
194-
$app->terminate($request, $response);</code></pre>
154+
<div class="conventions-and-protocols">
155+
<h2>
156+
<a name="conventions-and-protocols"></a>
157+
Conventions and Protocols
158+
<a class="anchor" href="#conventions-and-protocols">
159+
<i class="icon icon-link"></i>
160+
</a>
161+
</h2>
162+
<p>
163+
In order to further the goal of interoperability between disparate
164+
<code>HttpKernelInterface</code> implementations, Stack tries to
165+
avoid imposing interfaces and instead relies on conventions and
166+
protocols for the purpose of integration. The following is a list of
167+
community driven proposals for Stack conventions and protocols.
168+
</p>
169+
170+
<div class="row-fluid">
171+
<div class="span6">
172+
<h3><a href="{{ site.url }}/specs/0/">0 Proposals</a> <span class="label">Draft</span></h3>
173+
<p>
174+
Specification for how community driven Stack proposals will be
175+
written and managed.
176+
</p>
177+
<div class="btn-group">
178+
<a class="btn" href="{{ site.url }}/specs/0/"><i class="icon icon-book"></i> Proposal</a>
179+
</div>
180+
</div>
181+
<div class="span6">
182+
<h3><a href="{{ site.url }}/specs/1/">1 Core</a> <span class="label">Draft</span></h3>
183+
<p>
184+
Specification for writing and interacting with Stack middlewares
185+
and applications.
186+
</p>
187+
<div class="btn-group">
188+
<a class="btn" href="{{ site.url }}/specs/1/"><i class="icon icon-book"></i> Proposal</a>
189+
</div>
190+
</div>
191+
</div>
192+
<div class="row-fluid">
193+
<div class="span6">
194+
<h3><a href="{{ site.url }}/specs/2/">2 Authentication</a> <span class="label">Draft</span></h3>
195+
<p>
196+
Specification for authentication middlewares to follow in order
197+
for applications and authorization middlewares to be able to
198+
interact with each other.
199+
</p>
200+
<div class="btn-group">
201+
<a class="btn" href="{{ site.url }}/specs/2/"><i class="icon icon-book"></i> Proposal</a>
202+
</div>
203+
</div>
204+
<div class="span6">
205+
<h3><a href="{{ site.url }}/specs/3/">3 Authorization</a> <span class="label">Draft</span></h3>
206+
<p>
207+
Specification for authorization middlewares to follow in order
208+
for applications and authentication middlewares to be able to
209+
interact with each other.
210+
</p>
211+
<div class="btn-group">
212+
<a class="btn" href="{{ site.url }}/specs/3/"><i class="icon icon-book"></i> Proposal</a>
213+
</div>
214+
</div>
215+
</div>
195216
</div>
196-
-->
197217

198218
<footer class="authors container">
199219
<p class="lead">Brought to you by</p>

‎source/specs/0.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
layout: spec
3+
title: 0 Proposals
4+
status: draft
5+
---
6+
7+
Specification for how community driven Stack proposals will be written and
8+
managed.
9+
10+
* Name: {{ page.title }}
11+
* Editor: Beau Simensen <[beau@dflydev.com](mailto:beau@dflydev.com)>
12+
13+
14+
### Language
15+
16+
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
17+
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
18+
interpreted as described in [RFC 2119](http://www.ietf.org/rfc/rfc2119.txt).
19+
20+
21+
### Goals
22+
23+
* To define a workflow for community driven Stack proposals.
24+

‎source/specs/1.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
layout: spec
3+
title: 1 Core
4+
status: draft
5+
---
6+
7+
Specification for writing and interacting with Stack middlewares and
8+
applications.
9+
10+
* Name: {{ page.title }}
11+
* Editor: Beau Simensen <[beau@dflydev.com](mailto:beau@dflydev.com)>
12+
13+
14+
### Language
15+
16+
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
17+
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
18+
interpreted as described in [RFC 2119](http://www.ietf.org/rfc/rfc2119.txt).
19+
20+
21+
### Goals
22+
23+
* Specify requirements for a Stack middleware
24+

‎source/specs/2.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
layout: spec
3+
title: 2 Authentication
4+
status: draft
5+
---
6+
7+
This document proposes conventions for authentication middlewares to follow in
8+
order for applications and authorization middlewares to be able to interact
9+
with each other.
10+
11+
* Name: {{ page.title }}
12+
* Editor: Beau Simensen <[beau@dflydev.com](mailto:beau@dflydev.com)>
13+
14+
15+
### Language
16+
17+
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
18+
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
19+
interpreted as described in [RFC 2119](http://www.ietf.org/rfc/rfc2119.txt).
20+
21+
22+
### Goals
23+
24+
* To allow authentication middlewares to communicate when a request has been
25+
authenticated.
26+
* To allow other middlewares or applications to communicate whether or not
27+
the authentication was accepted (for example, authorization failed or is
28+
required).
29+
* To allow for some coexistence between multiple Stack authentiation
30+
middlewares for the same request.
31+
32+
33+
### Stack Authentication Middlewares
34+
35+
#### Authentication
36+
37+
A Stack authentication middleware is free to use whatever means necessary to
38+
authenticate a request. The end result of a successfully authenticated request
39+
is that the `stack.authentication.token` attribute is set on the request.
40+
41+
If a request has authentication credentials that are invalid for any reason a
42+
Stack authentication middleware MAY immediately challenge or return another
43+
reaponse (for example, a 400 error response).
44+
45+
If a request already has the `stack.authentication.token` attribute set a Stack
46+
authentication middleware MUST NOT attempt to further authenticate the request.
47+
However, the Stack authentication middleware MAY act further upon inspecting
48+
the response.
49+
50+
51+
#### Integration with Stack Authorization
52+
53+
Stack authentication middlewares SHOULD inspect the response from the wrapped
54+
app to see if it has a status code of `401` and a `WWW-Authenticate: Stack`
55+
header. In this case, the Stack authentication middleware can use its own best
56+
judgement to determine whether or not it should issue a challenge.
57+
58+
Modifying or replacing the response is allowed but a Stack authentication
59+
middleware MUST NOT challenge unless the response is in this state. If a Stack
60+
authentication middleware does not change the `WWW-Authenticate` value other
61+
Stack authentication middlewares will be given an opportunity to challenge.
62+
63+
64+
### Implementations
65+
66+
* [dflydev/stack-hawk](https://github.com/dflydev/dflydev-stack-hawk)

0 commit comments

Comments
 (0)