vendor/gems/rots-0.2.1/README

   1 = Ruby OpenID Test Server (ROTS), a dummy OpenID server that makes consumer tests dead easy.
   2
   3 ROTS is a minimal implementation of an OpenID server, developed on top of the Rack middleware, this
   4 server provides an easy to use interface to make testing OpenID consumers really easy.
   5
   6 == No more mocks
   7
   8 Have you always wanted to test the authentication of an OpenID consumer implementation, but find your self
   9 in a point where is to hard to mock? A lot of people have been there.
  10
  11 With ROTS, you only need to specify an identity url provided by the dummy server, passing with it a flag
  12 saying that you want the authentication to be successful. It handles SREG extensions as well.
  13
  14 == How does it works
  15
  16 When you install the ROTS gem, a binary called rots is provided for starting the server (for more
  17 info about what options you have when executing this file, check the -h option).
  18
  19 By default, rots will have a test user called "John Doe", with an OpenID identity "john.doe".
  20 If you want to use your own test user name, you can specify a config file to rots. The
  21 default configuration file looks like this:
  22
  23 # Default configuration file
  24 identity: john.doe
  25 sreg:
  26   nickname: jdoe
  27   fullname: John Doe
  28   email: jhon@doe.com
  29   dob: 1985-09-21
  30   gender: M
  31
  32 You can specify a new config file using the option --config.
  33
  34 == Getting Started
  35
  36 The best way to get started, is running the rots server, and then starting to execute your OpenID consumer tests/specs. You just have to specify the identity url of your test user, if you want the OpenID response be successful just add the openid.success=true flag to the user identity url. If you don't specify the flag it
  37 will return a cancel response instead.
  38
  39 Example:
  40
  41 it "should authenticate with OpenID" do
  42   post("/consumer_openid_login", 'identity_url' => 'http://localhost:1132/john.doe?openid.success=true')
  43 end
  44
  45 == Copyright
  46
  47 Copyright (C) 2009 Roman Gonzalez <romanandreg@gmail.com>
  48
  49 Permission is hereby granted, free of charge, to any person obtaining a copy
  50 of this software and associated documentation files (the "Software"), to
  51 deal in the Software without restriction, including without limitation the
  52 rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  53 sell copies of the Software, and to permit persons to whom the Software is
  54 furnished to do so, subject to the following conditions:
  55
  56 The above copyright notice and this permission notice shall be included in
  57 all copies or substantial portions of the Software.
  58
  59 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  60 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  61 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  62 THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  63 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  64 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.