README.md in cadenero-0.0.2.b4 vs README.md in cadenero-0.0.2.b5

- old
+ new

@@ -14,11 +14,12 @@ * Allows you to have multiple roles (or models/scopes) signed in at the same time ## Information ### Why Cadenero? -**"Cadenero"** is the spanish word for ["Bouncer (doorman)"](http://en.wikipedia.org/wiki/Bouncer_(doorman\)). The main function of **Cadenero** is to be a resource for authenticating consumers of the services that the API provides. As the real bouncers, **Cadenero** aims to provide security, check authorized access, to refuse entry for intoxication, aggressive behavior or non-compliance with statutory or establishment rules. +**"Cadenero"** is the spanish word for ["Bouncer (doorman)"](http://en.wikipedia.org/wiki/Bouncer_(doorman\)). The main function of **Cadenero** is to be a resource for authenticating consumers of the services that the API provides. As the real bouncers, **Cadenero** aims to provide security, check authorized access, to refuse entry for intoxication, aggressive behavior or non-compliance with statutory or establishment rules. +You can use [Warden](https://github.com/hassox/warden) or [Devise](https://github.com/plataformatec/devise) directly but for API apps the rewritting and monkey patching can be messy. ### Installing **Cadenero** Rails 3.2.13 is the master version used now by **Cadenero**, if you want to use Rails 4 goodness please use the branch "rails4" @@ -28,11 +29,11 @@ $ rails _3.2.13_ new your_app --skip-test-unit ``` In the `Gemfile` add the following lines: ```ruby - gem 'cadenero', '~> 0.0.2.b4' + gem 'cadenero', '~> 0.0.2.b5' gem 'pg' ``` In the `config/database.yml` replace the `sqlite3` adapter for `postgresql` as follow: @@ -109,22 +110,22 @@ ``` You can check them running: ``` - rake routes + $ rake routes ``` ### Documentation You can review the YARD docs in: http://rubydoc.info/github/AgilTec/cadenero/frames ### The Cadenero Task List - [x] Specs for the code 100% Coverage using BDD with [Rspec](https://github.com/rspec/rspec) and [Capybara](https://github.com/jnicklas/capybara) - [x] Documentation for all the code - [ ] Examples of use and demo ### Versions -**Cadenero** use [Semantic Versioning 2.0.0](http://semver.org/) the current version is: 0.0.2-alpha meaning MAJOR.MINOR.PATCH format +**Cadenero** use [Semantic Versioning 2.0.0](http://semver.org/) the current version is: 0.0.2-b5 meaning MAJOR.MINOR.PATCH format ### Bug reports If you discover a problem with **Cadenero**, we would like to know about it. However, we ask that you please review these guidelines before submitting a bug report: @@ -137,9 +138,23 @@ We hope that you will consider contributing to **Cadenero**. Please read this short overview for some information about how to get started: https://github.com/AgilTec/cadenero/Contributing You will usually want to write tests for your changes using BDD tools as RSpec, Rack::Test and Capybara. To run the test suite, go into **Cadenero**'s top-level directory and run "bundle install" and "rspec". For the tests to pass, you will need to have a Postgresql server running on your system. + +#### Running the Specs +**Cadenero** use [RSpec](https://github.com/rspec/rspec) and [Capybara](https://github.com/jnicklas/capybara). If you want to extend **Cadenero** please fork and clone the repo. To run the specs you only need to do: +``` + $ RAILS_ENV=test bundle exec rake db:create + $ RAILS_ENV=test bundle exec rake db:migrate + $ bundle exec rspec spec +``` + +You can `binstub` the command bins to avoid writing `bundle exec`. You only need to write: +``` + $ bundle binstubs rspec-core + $ bundle binstubs rake +``` ### Warden **Cadenero** is based on Warden, which is a general Rack authentication framework created by Daniel Neighman. We encourage you to read more about Warden here: https://github.com/hassox/warden \ No newline at end of file