praxis 0.0.1 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd160ab45c7815baca654d58ad095492971e9373
-  data.tar.gz: 210bf61e77a42f29c5e7b4cf9681520b6a39a577
+  metadata.gz: ea496999177f99af52478aa098d74e4eb07756bf
+  data.tar.gz: acbe97318d3f8951ea9e340ef7fe6b243162450a
 SHA512:
-  metadata.gz: 0c3774a2ba5ed2e6e0661cd8f259d6562f667e42f13bc57baa67d60d26c126b06991dfb5e1e9cfdba225fad5488c3a5fc2dfe6e3255bbe1f6012a639568a0f3e
-  data.tar.gz: 312e512b9286cd6ef19cd149877229843547eb84ebc6aeb1331eb31d9cd49bd9c48ae7c1b20a994c6a164c470e5526d185889b85c15915400fa0874ebe6576ad
+  metadata.gz: a2a86df947317e255b79e44867424a18466031aef0978a457acc21292c2f7d33360dee2812b982467a3a964ad7e5de64e005f5cf501f8df8faa17bf1aae95893
+  data.tar.gz: 866fc777e303b9aef3b1cafa85b791ef1612daf7b345296fe8296735f135ed7529fc6542104fefdd3318f06bc9805c0079c14ab9911a3aefbdbd7b96a12ee48f

data/.gitignore

@@ -0,0 +1,11 @@
+coverage
+*.swp
+Gemfile.lock
+_site/
+.sass-cache/
+
+.data/
+.tmp/
+node_modules/
+*.css.map
+

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format=Fuubar
+--backtrace

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.simplecov

@@ -0,0 +1,7 @@
+SimpleCov.profiles.define 'praxis' do
+  add_filter '/config/'
+  add_filter '/spec/'
+
+  add_group 'lib', 'lib'
+  add_group 'app', 'app'
+end

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "2.1.2"
+script: bundle exec rspec spec

data/CONTRIBUTING.md

@@ -0,0 +1,183 @@
+# Contributing to Praxis
+
+Want to work on Praxis? Here are instructions to get you started. Please let us
+know if anything feels wrong or incomplete.
+
+## Reporting Issues
+
+When reporting [issues](https://github.com/rightscale/praxis/issues) on GitHub,
+remember to include your Ruby version.
+
+Please also include the steps required to reproduce the problem if possible and
+applicable. This information will help us review and fix your issue faster.
+
+## Contribution guidelines
+
+### Project Goals
+
+Before submitting any contributions, please read the below description of what
+the problems Praxis aims to solve. Contributions that are not aligned with
+Praxis' goals will not be accepted.
+
+Praxis is a web framework for developing usable, consistent and
+self-documenting HTTP APIs for
+[SOA](http://en.wikipedia.org/wiki/Service-oriented_architecture) systems.
+
+Praxis is not a Rails plugin or extension. If you want to use Praxis with
+Rails, please create a separate gem or equivalent. We will not enhance Praxis
+with Rails-specific functionality.
+
+Praxis is also not designed for service any kind of UI, although UIs can
+certainly be powered by Praxis apps.
+
+### Pull requests are always welcome
+
+We are always thrilled to receive pull requests, and do our best to process
+them as fast as possible. Not sure if that typo is worth a pull request? Do it!
+We will appreciate it.
+
+If your pull request is not accepted on the first try, don't be discouraged! If
+there's a problem with the implementation, hopefully you received feedback on
+what to improve.
+
+We're trying very hard to keep Praxis lean and focused. We don't want it to do
+everything for everybody. This means that we might decide against incorporating
+a new feature. However, there might be a way to implement that feature *on top
+of* Praxis.
+
+### Discuss your design on the mailing list
+
+We recommend discussing your plans on the
+[praxis-development](http://groups.google.com/d/forum/praxis-development)
+mailing list before starting to code - especially for more ambitious
+contributions. This gives other contributors a chance to point you in the right
+direction, provide feedback on your design, and maybe point out if someone else
+is working on the same thing.
+
+### Create issues...
+
+Any significant improvement should be documented as [a GitHub
+issue](https://github.com/rightscale/praxis/issues) before anybody starts
+working on it.
+
+### ...but check for existing issues first!
+
+Please take a moment to check that an issue doesn't already exist
+documenting your bug report or improvement proposal. If it does, it
+never hurts to add a quick "+1" or "I have this problem too". This will
+help prioritize the most common problems and requests.
+
+### Conventions
+
+Fork the repository and make changes on your fork in a feature branch:
+
+- If it's a bug fix branch, name it XXXX-something where XXXX is the number of
+  the issue.
+- If it's a feature branch, create an enhancement issue to announce your
+  intentions, and name it XXXX-something where XXXX is the number of the issue.
+
+Submit unit tests for your changes. Take a look at existing tests for
+inspiration. Run the full test suite on your branch before submitting a pull
+request.
+
+Update the documentation when creating or modifying features. Test your
+documentation changes for clarity, concision, and correctness.
+
+Pull requests descriptions should be as clear as possible and include a
+reference to all the issues that they address.
+
+Pull requests must not contain commits from other users or branches.
+
+Commit messages must start with a capitalized and short summary (max. 50 chars)
+written in the imperative, followed by an optional, more detailed explanatory
+text which is separated from the summary by an empty line.
+
+Code review comments may be added to your pull request. Discuss, then make the
+suggested modifications and push additional commits to your feature branch. Be
+sure to post a comment after pushing. The new commits will show up in the pull
+request automatically, but the reviewers will not be notified unless you
+comment.
+
+Before the pull request is merged, make sure that you squash your commits into
+logical units of work using `git rebase -i` and `git push -f`. After every
+commit the test suite should be passing. Include documentation changes in the
+same commit so that a revert would remove all traces of the feature or fix.
+
+Commits that fix or close an issue should include a reference like `Closes
+#XXXX` or `Fixes #XXXX`, which will automatically close the issue when merged.
+
+Please do not add yourself to the `AUTHORS` file unless you are on the Praxis
+github team.
+
+### Sign your work
+
+The sign-off is a simple line at the end of the explanation for the
+patch, which certifies that you wrote it or otherwise have the right to
+pass it on as an open-source patch.  The rules are pretty simple: if you
+can certify the below (from
+[developercertificate.org](http://developercertificate.org/)):
+
+```
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+660 York Street, Suite 102,
+San Francisco, CA 94110 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+```
+
+Then you just add a line to every git commit message:
+
+Signed-off-by: Joe Smith <joe.smith@email.com> Using your real name
+(sorry, no pseudonyms or anonymous contributions.)
+
+If you set your user.name and user.email git configs, you can sign your
+commit automatically with git commit -s.
+
+#### Small patch exception
+
+There are several exceptions to the signing requirement. Currently these are:
+
+* Your patch fixes spelling or grammar errors.
+* Your patch is a single line change to documentation.
+* Your patch fixes Markdown formatting or syntax errors in the documentation.
+
+### How can I become a maintainer?
+
+* Step 1: Learn the component inside out
+* Step 2: Make yourself useful by contributing code, bug fixes, support etc.
+* Step 3: Volunteer on the [praxis-development mailing list](http://groups.google.com/d/forum/praxis-development)
+
+Don't forget: being a maintainer is a time investment. Make sure you will have
+time to make yourself available.  You don't have to be a maintainer to make a
+difference on the project!
+

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,8 @@
+guard 'rspec', cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+  watch('spec/functional_spec.rb')  { "spec/" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/functional_spec.rb" }
+  watch(%r{^app/(.+)\.rb$})     { "spec/" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 RightScale
+
+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/MAINTAINERS

@@ -0,0 +1,2 @@
+Josep Blanquer <blanquer@gmail.com> (@blanquer)
+Dane Jensen <dane.jensen@gmail.com>

data/MAINTAINERS.md

@@ -0,0 +1,86 @@
+# The Praxis Maintainer manual
+
+## Introduction
+
+Dear maintainer. Thank you for investing the time and energy to help
+make Praxis as useful as possible. Maintaining a project is difficult,
+sometimes unrewarding work. Sure, you will get to contribute cool
+features to the project. But most of your time will be spent reviewing,
+cleaning up, documenting, answering questions, and justifying design
+decisions - while everyone has all the fun! But remember - the quality
+of the maintainers' work is what distinguishes the good projects from
+the great. So please be proud of your work, even the unglamourous parts,
+and encourage a culture of appreciation and respect for *every* aspect
+of improving the project - not just the hot new features.
+
+This document is a manual for maintainers old and new. It explains what
+is expected of maintainers, how they should work, and what tools are
+available to them.
+
+This is a living document - if you see something out of date or missing,
+speak up!
+
+## What is a maintainer's responsibility?
+
+It is every maintainer's responsibility to:
+
+1. Expose a clear road map for improving their component.
+2. Deliver prompt feedback and decisions on pull requests.
+3. Be available to anyone with questions, bug reports, criticism etc.
+  on their component. This includes GitHub requests and the mailing
+  list.
+4. Make sure their component respects the philosophy, design and
+  road map of the project.
+
+## How are decisions made?
+
+Short answer: with pull requests to the Praxis repository.
+
+Praxis is an open-source project with an open design philosophy. This
+means that the repository is the source of truth for EVERY aspect of the
+project, including its philosophy, design, road map, and APIs. *If it's
+part of the project, it's in the repo. If it's in the repo, it's part of
+the project.*
+
+As a result, all decisions can be expressed as changes to the
+repository. An implementation change is a change to the source code. An
+API change is a change to the API specification. A philosophy change is
+a change to the philosophy manifesto, and so on.
+
+All decisions affecting Praxis, big and small, follow the same 3 steps:
+
+* Step 1: Open a pull request. Anyone can do this.
+
+* Step 2: Discuss the pull request. Anyone can do this.
+
+* Step 3: Accept or refuse a pull request. The relevant maintainers do
+this (see below "Who decides what?")
+
+
+## Who decides what?
+
+All decisions are pull requests, and the relevant maintainers make
+decisions by accepting or refusing pull requests.
+
+Praxis follows the timeless, highly efficient and totally unfair system
+known as [Benevolent dictator for
+life](http://en.wikipedia.org/wiki/Benevolent_Dictator_for_Life), with
+Josep Blanquer (@blanquer), in the role of BDFL. This means that all
+decisions are made, by default, by Josep. Since Josep making every
+decision would be highly un-scalable, in practice decisions are spread
+across multiple maintainers.
+
+The list of maintainers is kept in the MAINTAINERS file
+
+### I'm a maintainer. Should I make pull requests too?
+
+Yes. Nobody should ever push to master directly. All changes should be
+made through a pull request.
+
+### Who assigns maintainers?
+
+Josep has final approval for all pull requests to `MAINTAINERS` files.
+
+### How is this process changed?
+
+Just like everything else: by making a pull request :)

data/README.md

@@ -1,4 +1,70 @@
-Praxis API Framework
-=======================
+# Praxis [![TravisCI][travis-img-url]][travis-ci-url] 
 
-coming soon, near you...
+[travis-img-url]: https://travis-ci.org/rightscale/praxis.svg?branch=master
+[travis-ci-url]:https://travis-ci.org/rightscale/praxis
+
+Praxis is a framework that takes a different approach to creating APIs, an approach that treats both designers and implementors as first class citizens and hold both their hands throughout the API building process. With Praxis you create an API by iterating through the design, review and implementation phases.
+
+Building APIs with Praxis will result in faster developer times, and result in very precise documentation that is apt for both human (web browsable) or machine consumption (JSON spec files). A very important feature of Praxis is that while the design and implementation phases are done independently, the resulting system will still ensure that they are always consistent and enforced at all times. This enforcement will automatically hold true throughout any number of iterations of the design-review-implementation phases. You can, once
+and for all, stop worrying about re-generating server code and keeping it in sync with any change to your code and or docs that you make.
+
+## Quickstart
+```bash
+# Install the praxis gem
+gem install praxis
+
+# Generate a praxis application named my-app in ./my-app
+praxis generate my-app
+
+# Run it!
+cd my-app
+bundle
+rackup
+```
+
+## Philosophy
+Praxis is a practical implementation of a few guiding principles. In part:
+
+### REST APIs should be consistent
+REST APIs should follow consistent design in patterns and action semantics.
+This includes software patterns for creating applications like code
+organization; application patterns like logging, middleware, query filtering,
+and application bootstrapping; and API routing structures and REST verb
+semantics for exposed resources.
+
+### Apps should focus on real business logic
+Applications should be able to focus on application logic, avoiding most of the
+boilerplate code required to build API services.
+
+### API design should be separate from implementation
+Applications should maintain separation of concerns between API design and
+implementation. An API designer should be able to fully construct an API
+skeleton without writing a single line of application code.
+
+### APIs must have great documentation
+It should be possible to generate consistent and detailed documentation. This
+should be done by inspecting real code, to avoid relying on humans to do a good
+job keeping the docs and the code in sync everytime they make code changes.
+
+## Mailing List
+Join our Google Groups for discussion, support and announcements.
+* http://groups.google.com/d/forum/praxis-support (support for people using
+  Praxis)
+* http://groups.google.com/d/forum/praxis-announce (announcements)
+* http://groups.google.com/d/forum/praxis-development (discussion about the
+  development of Praxis itself)
+
+## Contributions
+Contributions to make Praxis better are welcome. Please refer to
+[CONTRIBUTING](https://github.com/rightscale/praxis/blob/master/CONTRIBUTING.md)
+for further details on what contributions are accepted and how to go about
+contributing.
+
+## Requirements
+Praxis requires Ruby 2.1.0 or greater.
+
+## License
+
+This software is released under the [MIT License](http://www.opensource.org/licenses/MIT). Please see  [LICENSE](LICENSE) for further details.
+
+Copyright (c) 2014 RightScale

data/Rakefile

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path('lib',__dir__)
+
+require 'praxis'
+require 'praxis/tasks'
+
+
+require 'rake/notes/rake_task'
+
+require 'rspec/core/rake_task'
+
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/bin/praxis

@@ -0,0 +1,10 @@
+#! /usr/bin/env ruby
+
+require 'bundler'
+
+path_to_praxis    = Bundler.rubygems.find_name('praxis').first.full_gem_path
+path_to_generator = '%s/tasks/praxis_app_generator.thor' % path_to_praxis
+
+load path_to_generator
+
+PraxisAppGenerator.start(ARGV)

data/lib/api_browser/.bowerrc

@@ -0,0 +1,3 @@
+{
+    "directory": "app/bower_components"
+}

data/lib/api_browser/.editorconfig

@@ -0,0 +1,21 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false