Merge branch 'release/1.0.0'

bbriatte · bbriatte · commit 040c3e46ed00 · 2017-06-03T18:41:12.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -19,8 +19,7 @@ xcuserdata/
 
 ## Other
 *.moved-aside
-*.xccheckout
-*.xcscmblueprint
+*.xcuserstate
 
 ## Obj-C/Swift specific
 *.hmap
@@ -35,9 +34,10 @@ playground.xcworkspace
 # Swift Package Manager
 #
 # Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
-# Packages/
-# Package.pins
+Packages/
 .build/
+*.xcodeproj
+Package.pins
 
 # CocoaPods
 #
@@ -59,7 +59,7 @@ Carthage/Build
 # It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
 # screenshots whenever they are needed.
 # For more information about the recommended setup visit:
-# https://docs.fastlane.tools/best-practices/source-control/#source-control
+# https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Gitignore.md
 
 fastlane/report.xml
 fastlane/Preview.html
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,46 @@
+# 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 [contact@digipolitan.com](mailto:contact@digipolitan.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/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,94 @@
+# Contributing to perfect-blink-swift
+
+First off, thanks for taking the time to contribute! :tada::+1:
+
+The following is a set of guidelines for contributing to Digipolitan and its packages, which are hosted in the [Digipolitan Organization](https://github.com/digipolitan) on GitHub.
+These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+#### Table Of Contents
+
+[What should I know before I get started?](#what-should-i-know-before-i-get-started)
+  * [Code of Conduct](#code-of-conduct)
+
+[How Can I Contribute?](#how-can-i-contribute)
+  * [Reporting Bugs](#reporting-bugs)
+
+## What should I know before I get started?
+
+### Code of Conduct
+
+This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code.
+Please report unacceptable behavior to [contact@digipolitan.com](mailto:contact@digipolitan.com).
+
+### Reporting Bugs
+
+This section guides you through submitting a bug report for Digipolitan. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:.
+
+Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). If you'd like, you can use [this template](#template-for-submitting-bug-reports) to structure the information.
+
+#### Before Submitting A Bug Report
+
+* **Perform a [search](https://github.com/issues?q=+is%3Aissue+user%3Adigipolitan)** to see if the problem has already been reported. If it has, add a comment to the existing issue instead of opening a new one.
+
+#### How Do I Submit A (Good) Bug Report?
+
+Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). After you've determined
+
+Explain the problem and include additional details to help maintainers reproduce the problem:
+
+* **Use a clear and descriptive title** for the issue to identify the problem.
+* **Describe the exact steps which reproduce the problem** in as many details as possible.
+* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
+* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
+* **Explain which behavior you expected to see instead and why.**
+* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem.
+* **If you're reporting that perfect-blink-swift crashed**, include a crash report with a stack trace from the operating system. On iOS, the crash report is available in Xcode, on macOS, the crash report will be available in `Console.app` under "Diagnostic and usage information" > "User diagnostic reports". Include the crash report in the issue in a [code block](https://help.github.com/articles/markdown-basics/#multiple-lines), a [file attachment](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/), or put it in a [gist](https://gist.github.com/) and provide link to that gist.
+* **If the problem is related to performance**, include a CPU profile capture and a screenshot with your report.
+* **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
+
+Provide more context by answering these questions:
+
+* **Did the problem start happening recently** (e.g. after updating to a new version of perfect-blink-swift) or was this always a problem?
+* If the problem started happening recently, **can you reproduce the problem in an older version of perfect-blink-swift ?** What's the most recent version in which the problem doesn't happen? You can download older versions of perfect-blink-swift from [the releases page](https://github.com/digipolitan/perfect-blink-swift/releases).
+* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
+
+Include details about your configuration and environment:
+
+* **Which version of perfect-blink-swift are you using?
+* **What's the name and version of the macOS or iOS you're using**?
+
+#### Template For Submitting Bug Reports
+
+    [Short description of problem here]
+
+    **Reproduction Steps:**
+
+    1. [First Step]
+    2. [Second Step]
+    3. [Other Steps...]
+
+    **Expected behavior:**
+
+    [Describe expected behavior here]
+
+    **Observed behavior:**
+
+    [Describe observed behavior here]
+
+    **Screenshots and GIFs**
+
+    ![Screenshots and GIFs which follow reproduction steps to demonstrate the problem](url)
+
+    **perfect-blink-swift version:** [Enter perfect-blink-swift version here]
+    **OS and version:** [Enter macOS / iOS / linux name and version here]
+
+    **Installed packages:**
+
+    [List of installed packages here]
+
+    **Additional information:**
+
+    * Problem started happening recently, didn't happen in an older version of perfect-blink-swift: [Yes/No]
+    * Problem can be reliably reproduced, doesn't happen randomly: [Yes/No]
+    * Problem happens with all files and projects, not only some files or projects: [Yes/No]
diff --git a/Package.swift b/Package.swift
@@ -0,0 +1,10 @@
+// swift-tools-version:3.1
+
+import PackageDescription
+
+let package = Package(
+    name: "PerfectBlink",
+    dependencies: [
+        .Package(url: "https://github.com/Digipolitan/perfect-middleware-swift.git", majorVersion: 1)
+    ]
+)
diff --git a/README.md b/README.md
@@ -1 +1,100 @@
-# perfect-blink-swift
+PerfectBlink
+=================================
+
+[![Twitter](https://img.shields.io/badge/twitter-@Digipolitan-blue.svg?style=flat)](http://twitter.com/Digipolitan)
+
+Perfect Blink middleware swift is a request parser
+
+Parse incoming request body, query, url parameters before the route handler, data available under the context.blink.
+
+## Installation
+
+### Swift Package Manager
+
+To install PerfectBlink with SPM, add the following lines to your `Package.swift`.
+
+```swift
+import PackageDescription
+
+let package = Package(
+    name: "XXX",
+    dependencies: [
+        .Package(url: "https://github.com/Digipolitan/perfect-blink-swift.git", majorVersion: 1)
+    ]
+)
+```
+
+## The Basics
+
+Create a RouterMiddleware and register the blink middleware before all routes handlers
+
+```swift
+let server = HTTPServer()
+
+let router = RouterMiddleware()
+
+router.use(event: .beforeAll, middleware: Blink.shared)
+
+router.post(path: "/").bind { (context) in
+  guard let body = context.blink.body as? [String: Any],
+        let name = body["name"] as? String else {
+        context.next()
+        return
+    }
+    context.response.setBody(string: name).completed()
+    context.next()
+}
+
+server.use(router: router)
+
+server.serverPort = 8887
+
+do {
+    try server.start()
+    print("Server listening on port \(server.serverPort)")
+} catch PerfectError.networkError(let err, let msg) {
+    print("Network error thrown: \(err) \(msg)")
+}
+```
+
+It's possible to register a specific type to parse for only one route as follow :
+```swift
+router.post(path: "/")
+  .bind(Blink.shared.json())
+  .bind { (context) in
+    guard let body = context.blink.body as? [String: Any] {
+      context.next()
+      return
+    }
+    print(body)
+    context.next()
+}
+```
+
+You can parse query parameters and url parameters for only one route as follow :
+```swift
+router.get(path: "/")
+  .bind(Blink.shared.query())
+  .bind(Blink.shared.params())
+  .bind { (context) in
+    guard let query = context.blink.query,
+      let name = query["name"] {
+      context.next()
+      return
+    }
+    context.response.setBody(string: name).completed()
+    context.next()
+}
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more details!
+
+This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code. Please report
+unacceptable behavior to [contact@digipolitan.com](mailto:contact@digipolitan.com).
+
+## License
+
+PerfectBlink is licensed under the [BSD 3-Clause license](LICENSE).
diff --git a/Sources/Blink.swift b/Sources/Blink.swift
