File: README.rdoc

package info (click to toggle)
ruby-rack-oauth2 1.9.2-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, sid
  • size: 624 kB
  • sloc: ruby: 4,482; makefile: 4
file content (77 lines) | stat: -rw-r--r-- 2,118 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
= rack-oauth2

OAuth 2.0 Server & Client Library.
Both Bearer and MAC token type are supported.

{<img src="https://secure.travis-ci.org/nov/rack-oauth2.png" />}[http://travis-ci.org/nov/rack-oauth2]

The OAuth 2.0 Authorization Framework (RFC 6749)
http://www.rfc-editor.org/rfc/rfc6749.txt

The OAuth 2.0 Authorization Framework: Bearer Token Usage (RFC 6750)
http://tools.ietf.org/html/draft-ietf-oauth-v2-bearer-06

HTTP Authentication: MAC Access Authentication (draft 01)
http://tools.ietf.org/html/draft-ietf-oauth-v2-http-mac-01

== Installation

  gem install rack-oauth2

== Resources

* View Source on GitHub (https://github.com/nov/rack-oauth2)
* Docs on GitHub (https://github.com/nov/rack-oauth2/wiki)
* Report Issues on GitHub (https://github.com/nov/rack-oauth2/issues)

== Sample Server Application (Rails3)

=== Bearer

Running on Heroku
https://rack-oauth2-sample.heroku.com

Source on GitHub
https://github.com/nov/rack-oauth2-sample

=== MAC

Running on Heroku
https://rack-oauth2-sample-mac.heroku.com

Source on GitHub
https://github.com/nov/rack-oauth2-sample-mac

== Sample Client

=== Common between Bearer and MAC

Authorization Request (request_type: 'code' and 'token')
https://gist.github.com/862393

Token Request (grant_type: 'client_credentials', 'password', 'authorization_code' and 'refresh_token')
https://gist.github.com/883541

=== Bearer

Resource Request (request both for resource owner resource and for client resource)
https://gist.github.com/883575

=== MAC

Resource Request (request both for resource owner resource and for client resource)
https://gist.github.com/933885

== Note on Patches/Pull Requests

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
  future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.

== Copyright

Copyright (c) 2010 nov matake. See LICENSE for details.