jellyfish-contrib 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee54aa1e1b2f82250a6fbbdeec3eee5d2eabc39f
+  data.tar.gz: 5acd039ea055932e8c9babe3c45cddcc725a80d8
+SHA512:
+  metadata.gz: 62baff08974067187a55e872bc39b53f96d2f6a70f1062a2ba5794e8da303c8684b0651b69fbaff2f10331ac3a118c49b9a622641f18e3934c43060f793a2cf6
+  data.tar.gz: 0941ac3d87ebd041b55b2e58831ad64812df51c420916c1750dde760d50935994c230f303d31fec68655a85d8356cfb3195ae7ac12dd9992756a9fa9a10d1331

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "task"]
+	path = task
+	url = git://github.com/godfat/gemgem.git

data/.travis.yml

@@ -0,0 +1,11 @@
+
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx-2
+  - jruby
+
+install: 'bundle install --retry=3'
+script: 'ruby -r bundler/setup -S rake test'

data/CHANGES.md

@@ -0,0 +1,5 @@
+# CHANGES
+
+## jellyfish-contrib 1.1.0 -- 2015-09-25
+
+* Birthday! Extracted from jellyfish.

data/Gemfile

@@ -0,0 +1,16 @@
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rack'
+gem 'pork'
+gem 'muack'
+
+gem 'simplecov', :require => false if ENV['COV']
+gem 'coveralls', :require => false if ENV['CI']
+
+platform :rbx do
+  gem 'rubysl-singleton' # used in rake
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,210 @@
+# jellyfish-contrib [![Build Status](https://secure.travis-ci.org/godfat/jellyfish-contrib.png?branch=master)](http://travis-ci.org/godfat/jellyfish-contrib) [![Coverage Status](https://coveralls.io/repos/godfat/jellyfish-contrib/badge.png)](https://coveralls.io/r/godfat/jellyfish-contrib) [![Join the chat at https://gitter.im/godfat/jellyfish-contrib](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/godfat/jellyfish-contrib)
+
+by Lin Jen-Shin ([godfat](http://godfat.org))
+
+![logo](https://github.com/godfat/jellyfish/raw/master/jellyfish.png)
+
+## LINKS:
+
+* [github](https://github.com/godfat/jellyfish-contrib)
+* [rubygems](https://rubygems.org/gems/jellyfish-contrib)
+* [rdoc](http://rdoc.info/github/godfat/jellyfish-contrib)
+
+## DESCRIPTION:
+
+Extra [Jellyfish](https://github.com/godfat/jellyfish) extensions.
+
+## FEATURES:
+
+* Jellyfish::MultiActions
+* Jellyfish::Sinatra
+* Jellyfish::Swagger
+
+## REQUIREMENTS:
+
+* Tested with MRI (official CRuby), Rubinius and JRuby.
+
+## INSTALLATION:
+
+    gem install jellyfish-contrib
+
+## SYNOPSIS:
+
+You could also take a look at [config.ru](config.ru) as an example, which
+also uses [Swagger](https://helloreverb.com/developers/swagger) to generate
+API documentation.
+
+### Using multiple extensions with custom controller
+
+This is effectively the same as using Jellyfish::Sinatra extension.
+Note that the controller should be assigned lastly in order to include
+modules remembered in controller_include.
+
+``` ruby
+require 'jellyfish-contrib'
+class Tank
+  include Jellyfish
+  class MyController < Jellyfish::Controller
+    include Jellyfish::MultiActions
+  end
+  controller_include NormalizedParams, NormalizedPath
+  controller MyController
+
+  get do # wildcard before filter
+    @state = 'jumps'
+  end
+  get %r{^/(?<id>\d+)$} do
+    "Jelly ##{params[:id]} #{@state}.\n"
+  end
+end
+use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
+run Tank.new
+```
+
+<!---
+GET /123
+[200,
+ {'Content-Length' => '18', 'Content-Type' => 'text/plain'},
+ ["Jelly #123 jumps.\n"]]
+-->
+
+### Extension: MultiActions (Filters)
+
+``` ruby
+require 'jellyfish-contrib'
+class Tank
+  include Jellyfish
+  controller_include Jellyfish::MultiActions
+
+  get do # wildcard before filter
+    @state = 'jumps'
+  end
+  get do
+    "Jelly #{@state}.\n"
+  end
+end
+use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
+run Tank.new
+```
+
+<!---
+GET /123
+[200,
+ {'Content-Length' => '13', 'Content-Type' => 'text/plain'},
+ ["Jelly jumps.\n"]]
+-->
+
+### Halt in before action
+
+``` ruby
+require 'jellyfish-contrib'
+class Tank
+  include Jellyfish
+  controller_include Jellyfish::MultiActions
+
+  get do # wildcard before filter
+    body "Done!\n"
+    halt
+  end
+  get '/' do
+    "Never reach.\n"
+  end
+end
+
+use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
+run Tank.new
+```
+
+<!---
+GET /status
+[200,
+ {'Content-Length' => '6', 'Content-Type' => 'text/plain'},
+ ["Done!\n"]]
+-->
+
+### Extension: Sinatra flavoured controller
+
+It's an extension collection contains:
+
+* MultiActions
+* NormalizedParams
+* NormalizedPath
+
+``` ruby
+require 'jellyfish-contrib'
+class Tank
+  include Jellyfish
+  controller_include Jellyfish::Sinatra
+
+  get do # wildcard before filter
+    @state = 'jumps'
+  end
+  get %r{^/(?<id>\d+)$} do
+    "Jelly ##{params[:id]} #{@state}.\n"
+  end
+end
+use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
+run Tank.new
+```
+
+<!---
+GET /123
+[200,
+ {'Content-Length' => '18', 'Content-Type' => 'text/plain'},
+ ["Jelly #123 jumps.\n"]]
+-->
+
+### Extension: Swagger API documentation
+
+For a complete example, checkout [config.ru](config.ru).
+
+``` ruby
+require 'jellyfish-contrib'
+class Tank
+  include Jellyfish
+  get %r{^/(?<id>\d+)$}, :notes => 'This is an API note' do |match|
+    "Jelly ##{match[:id]}\n"
+  end
+end
+use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
+map '/swagger' do
+  run Jellyfish::Swagger.new('', Tank)
+end
+run Tank.new
+```
+
+<!---
+GET /swagger
+[200,
+ {'Content-Type'   => 'application/json; charset=utf-8',
+  'Content-Length' => '81'},
+ ['{"swaggerVersion":"1.2","info":{},"apiVersion":"0.1.0","apis":[{"path":"/{id}"}]}']]
+-->
+
+## CONTRIBUTORS:
+
+* Fumin (@fumin)
+* Lin Jen-Shin (@godfat)
+
+## LICENSE:
+
+Apache License 2.0
+
+Copyright (c) 2012-2015, Lin Jen-Shin (godfat)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+<http://www.apache.org/licenses/LICENSE-2.0>
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.