Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Docfile changes

  • Loading branch information...
commit ae64c5a888bb55c11a03710fcfc4ae58c0facb72 1 parent d53ddda
@dennisreimann dennisreimann authored
View
215 CHANGELOG
@@ -1,215 +0,0 @@
-Mon Jan 23 12:48:00 PST 2006 brian@janrain.com
- * fixed bug in expiresIn. added expired? method
-
- M ./lib/openid/filestore.rb -1 +1
- M ./lib/openid/stores.rb +4
-
-Mon Jan 23 12:46:37 PST 2006 brian@janrain.com
- * removed deps section from INSTALL file. deps are now included in lib because they are so small and to lower to bar of installing the library.
-
- M ./INSTALL -9
-
-Tue Jan 17 14:45:57 PST 2006 brian@janrain.com
- * added better handling of non-URL input
-
- M ./lib/openid/consumer.rb -1 +5
-
-Sat Jan 14 19:39:57 PST 2006 brian@janrain.com
- * added html and hmac deps into lib since they are so small
-
- A ./lib/hmac-md5.rb
- A ./lib/hmac-rmd160.rb
- A ./lib/hmac-sha1.rb
- A ./lib/hmac-sha2.rb
- A ./lib/hmac.rb
- A ./lib/html/
- A ./lib/html/htmltokenizer.rb
-
-Mon Jan 16 15:04:05 PST 2006 Josh Hoyt <josh@janrain.com>
- * Add script that will prepare the repository for release
-
- A ./admin/fixperms
- A ./admin/prepare-release
-
-Mon Jan 16 14:35:27 PST 2006 Josh Hoyt <josh@janrain.com>
- * Add custom boring file
-
- A ./admin/darcs-ignore
-
-Mon Jan 16 14:07:13 PST 2006 Josh Hoyt <josh@janrain.com>
- * Put the build-docs script into the admin directory
-
- ./build-docs -> ./admin/build-docs
- A ./admin/
-
-Mon Jan 16 14:05:47 PST 2006 Josh Hoyt <josh@janrain.com>
- * Add script to build documentation
-
- A ./build-docs
-
-Wed Jan 4 16:06:41 PST 2006 brian@janrain.com
- tagged ruby-openid-0.9.2
-
-
-Wed Jan 4 16:02:32 PST 2006 brian@janrain.com
- * added openid_login_generator rails generator to examples
-
- A ./examples/openid_login_generator/
- A ./examples/openid_login_generator/USAGE
- A ./examples/openid_login_generator/openid_login_generator.rb
- A ./examples/openid_login_generator/templates/
- A ./examples/openid_login_generator/templates/README
- A ./examples/openid_login_generator/templates/controller.rb
- A ./examples/openid_login_generator/templates/helper.rb
- A ./examples/openid_login_generator/templates/login_system.rb
- A ./examples/openid_login_generator/templates/user.rb
- A ./examples/openid_login_generator/templates/view_login.rhtml
- A ./examples/openid_login_generator/templates/view_logout.rhtml
- A ./examples/openid_login_generator/templates/view_signup.rhtml
- A ./examples/openid_login_generator/templates/view_welcome.rhtml
-
-Wed Jan 4 16:01:12 PST 2006 brian@janrain.com
- * updated examples README to include openid_login_generator
-
- M ./examples/README +11
-
-Wed Jan 4 14:58:24 PST 2006 brian@janrain.com
- * added link to ruby library from consumer.rb example
-
- M ./examples/consumer.rb -1 +1
-
-Wed Jan 4 10:56:45 PST 2006 brian@janrain.com
- * ensure Content-type header is present for POSTs
-
- M ./lib/openid/fetchers.rb -1 +2
-
-Fri Dec 30 17:05:25 PST 2005 brian@janrain.com
- tagged ruby-openid-0.9.1
-
-
-Fri Dec 30 17:03:54 PST 2005 brian@janrain.com
- * added Ruby on Rails example consumer
-
- M ./examples/README -1 +14
- A ./examples/openid_rails.tar.gz
-
-Thu Dec 29 16:00:20 PST 2005 brian@janrain.com
- tagged ruby-openid-0.9.0
-
-
-Thu Dec 29 15:43:07 PST 2005 brian@janrain.com
- * removed docs directory. generated rdoc html will be added manually to tarballs, and not be kept in repository
-
- R ./docs/
- R ./docs/README
-
-Thu Dec 29 15:21:21 PST 2005 brian@janrain.com
- * added more docs for stores
-
- M ./TODO -2 +4
- M ./lib/openid/filestore.rb -16 +3
- M ./lib/openid/stores.rb -9 +1
-
-Thu Dec 29 14:58:52 PST 2005 brian@janrain.com
- * Huge documentation patch
-
- M ./INSTALL -12 +22
- M ./README -1 +1
- M ./lib/openid/consumer.rb -24 +370
- M ./lib/openid/fetchers.rb -2 +1
- M ./lib/openid/filestore.rb -6 +4
- M ./lib/openid/stores.rb -2 +1
-
-Thu Dec 29 10:59:54 PST 2005 brian@janrain.com
- * added more info and rdoc formatting to README
-
- M ./README -10 +26
-
-Thu Dec 29 09:45:51 PST 2005 brian@janrain.com
- * fixed bad comment
-
- M ./examples/consumer.rb -1 +1
-
-Wed Dec 28 17:59:48 PST 2005 brian@janrain.com
- * added platform agnositc temp dir discovery
-
- M ./examples/consumer.rb -1 +5
-
-Wed Dec 28 17:13:21 PST 2005 brian@janrain.com
- * moved getOpenIDParamerters to util
-
- M ./lib/openid/consumer.rb -10 +2
- M ./lib/openid/util.rb +8
-
-Wed Dec 28 15:47:51 PST 2005 brian@janrain.com
- * code cleanup
-
- M ./lib/openid/consumer.rb -5
-
-Wed Dec 28 15:29:31 PST 2005 brian@janrain.com
- * added linkparse to test suite script
-
- M ./test/runtests -1 +1
-
-Wed Dec 28 15:29:07 PST 2005 brian@janrain.com
- * added link parsing tests, lots of em
-
- A ./test/linkparse.rb
-
-Wed Dec 28 15:28:07 PST 2005 brian@janrain.com
- * link parsing more robust: handle non-html data, and make sure link tag is in head
-
- M ./lib/openid/parse.rb -5 +13
-
-Tue Dec 27 16:11:09 PST 2005 brian@janrain.com
- * added more tests for openid/util
-
- M ./test/dh.rb -2 +1
- M ./test/runtests +1
- A ./test/util.rb
-
-Tue Dec 27 16:10:28 PST 2005 brian@janrain.com
- * change util methods to use all use /dev/urandom if available
-
- M ./lib/openid/util.rb -15 +35
-
-Tue Dec 27 16:09:53 PST 2005 brian@janrain.com
- * changed tmp pathname to something more useful
-
- M ./examples/consumer.rb -1 +1
-
-Fri Dec 16 09:04:59 PST 2005 Josh Hoyt <josh@janrain.com>
- * Removed (now obsolete) interface.rb
-
- This has been subsumed by consumer.rb
-
- R ./lib/openid/interface.rb
-
-Thu Dec 15 18:25:04 PST 2005 brian@janrain.com
- * initial checkin
-
- A ./COPYING
- A ./INSTALL
- A ./README
- A ./TODO
- A ./docs/
- A ./docs/README
- A ./examples/
- A ./examples/README
- A ./examples/consumer.rb
- A ./lib/
- A ./lib/openid/
- A ./lib/openid/consumer.rb
- A ./lib/openid/dh.rb
- A ./lib/openid/fetchers.rb
- A ./lib/openid/filestore.rb
- A ./lib/openid/interface.rb
- A ./lib/openid/parse.rb
- A ./lib/openid/stores.rb
- A ./lib/openid/util.rb
- A ./setup.rb
- A ./test/
- A ./test/assoc.rb
- A ./test/dh.rb
- A ./test/runtests
- A ./test/teststore.rb
View
13 CHANGELOG.md
@@ -0,0 +1,13 @@
+# Changelog
+
+## 2.2.0
+
+* Bundler compatibility and bundler gem tasks - 72d551945f9577bf5d0e516c673c648791b0e795
+* register_namespace_alias for AX message - aeaf050d21aeb681a220758f1cc61b9086f73152
+* Fixed JRuby (1.9 mode) incompatibilty - 40baed6cf7326025058a131c2b76047345618539
+* Added UI extension support - a276a63d68639e985c1f327cf817489ccc5f9a17
+* Add attr_reader for setup_url on SetupNeededResponse - 75a7e98005542ede6db3fc7f1fc551e0a2ca044a
+* Encode form inputs - c9e9b5b52f8a23df3159c2387b6330d5df40f35b
+* Fixed cleanup AR associations whose expiry is past, not upcoming - 2265179a6d5c8b51ccc741180db46b618dd3caf9
+* Fixed issue with Memcache store and Dalli - ef84bf73da9c99c67b0632252bf0349e2360cbc7
+* Improvements to ActiveRecordStore's gc rake task - 847e19bf60a6b8163c1e0d2e96dbd805c64e2880
View
36 CHANGES-2.0.0
@@ -0,0 +1,36 @@
+
+* API Changes
+ * PAPE (Provider Authentication Policy Extension) module
+ * Updated extension for specification draft 2
+ * PAPE::Request::from_success_response returns nil if PAPE
+ response arguments were not signed
+ * Added functions to generate request/response HTML forms with
+ auto-submission javascript
+ * Consumer (relying party) API:
+ Auth_OpenID_AuthRequest::htmlMarkup
+ * Server API: Auth_OpenID_OpenIDResponse::toHTML
+ * Removed Rails login generator
+ * SReg::Response::from_success_response returns nil when no signed
+ arguments were found
+
+* New Features
+ * Fetchers now only read/request first megabyte of response
+
+* Bug fixes
+ * NOT NULL constraints to tables created by ActiveRecordStore
+ * check_authentication requests: copy entire response, not just
+ signed fields. Fixes missing namespace in check_authentication
+ requests
+ * OpenID 1 association requests no longer explicitly set
+ no-encryption session type
+ * Improved HTML parsing
+ * AssociationRequest::answer: include session_type in
+ no-encryption assoc responses
+ * normalize return_to URL before performing return_to verification
+ * OpenID::Consumer::IdResHandler.verify_discovery_results_openid1:
+ fall back to OpenID 1.0 type if 1.1 endpoint cannot be found
+ * StandardFetcher now includes a timeout setting
+ * Handle blank content types in
+ OpenID::Yadis::DiscoveryResult.where_is_yadis?
+ * Properly convert timestamps to ints before storing in DB, and vise
+ versa
View
47 INSTALL
@@ -1,47 +0,0 @@
-= Ruby OpenID Library Installation
-
-== Rubygems Installation
-
-Rubygems is a tool for installing ruby libraries and their
-dependancies. If you have rubygems installed, simply:
-
- gem install ruby-openid
-
-== Manual Installation
-
-Unpack the archive and run setup.rb to install:
-
- ruby setup.rb
-
-setup.rb installs the library into your system ruby. If don't want to
-add openid to you system ruby, you may instead add the *lib* directory of
-the extracted tarball to your RUBYLIB environment variable:
-
- $ export RUBYLIB=${RUBYLIB}:/path/to/ruby-openid/lib
-
-
-== Testing the Installation
-
-Make sure everything installed ok:
- $> irb
- irb$> require "openid"
- => true
-
-Or, if you installed via rubygems:
-
- $> irb
- irb$> require "rubygems"
- => true
- irb$> require_gem "ruby-openid"
- => true
-
-== Run the test suite
-
-Go into the test directory and execute the *runtests.rb* script.
-
-== Next steps
-
-* Run consumer.rb in the examples directory.
-* Get started writing your own consumer using OpenID::Consumer
-* Write your own server with OpenID::Server
-* Use the OpenIDLoginGenerator! Read example/README for more info.
View
47 INSTALL.md
@@ -0,0 +1,47 @@
+# Ruby OpenID Library Installation
+
+## Rubygems Installation
+
+Rubygems is a tool for installing ruby libraries and their
+dependancies. If you have rubygems installed, simply:
+
+ gem install ruby-openid
+
+## Manual Installation
+
+Unpack the archive and run setup.rb to install:
+
+ ruby setup.rb
+
+setup.rb installs the library into your system ruby. If don't want to
+add openid to you system ruby, you may instead add the `lib` directory of
+the extracted tarball to your RUBYLIB environment variable:
+
+ $ export RUBYLIB=${RUBYLIB}:/path/to/ruby-openid/lib
+
+## Testing the Installation
+
+Make sure everything installed ok:
+
+ $> irb
+ irb$> require "openid"
+ => true
+
+Or, if you installed via rubygems:
+
+ $> irb
+ irb$> require "rubygems"
+ => true
+ irb$> require_gem "ruby-openid"
+ => true
+
+## Run the test suite
+
+Go into the test directory and execute the `runtests.rb` script.
+
+## Next steps
+
+* Run `consumer.rb` in the examples directory.
+* Get started writing your own consumer using OpenID::Consumer
+* Write your own server with `OpenID::Server`
+* Use the `OpenIDLoginGenerator`! Read `example/README` for more info.
View
109 UPGRADE → UPGRADE.md
@@ -1,125 +1,124 @@
-= Upgrading from the OpenID 1.x series library
+# Upgrading from the OpenID 1.x series library
-== Consumer Upgrade
+## Consumer Upgrade
-The flow is largely the same, however there are a number of significant
-changes. The consumer example is helpful to look at:
-examples/rails_openid/app/controllers/consumer_controller.rb
+The flow is largely the same, however there are a number of significant
+changes. The consumer example is helpful to look at:
+`examples/rails_openid/app/controllers/consumer_controller.rb`
-
-=== Stores
+### Stores
You will need to require the file for the store that you are using.
For the filesystem store, this is 'openid/stores/filesystem'
-They are also now in modules. The filesystem store is
- OpenID::Store::Filesystem
+They are also now in modules. The filesystem store is
+ `OpenID::Store::Filesystem`
The format has changed, and you should remove your old store directory.
-The ActiveRecord store ( examples/active_record_openid_store ) still needs
+The ActiveRecord store (`examples/active_record_openid_store`) still needs
to be put in a plugin directory for your rails app. There's a migration
-that needs to be run; examine the README in that directory.
+that needs to be run; examine the `README` in that directory.
Also, note that the stores now can be garbage collected with the method
- store.cleanup
-
+ `store.cleanup`
-=== Starting the OpenID transaction
+### Starting the OpenID transaction
The OpenIDRequest object no longer has status codes. Instead,
consumer.begin raises an OpenID::OpenIDError if there is a problem
initiating the transaction, so you'll want something along the lines of:
- begin
- openid_request = consumer.begin(params[:openid_identifier])
- rescue OpenID::OpenIDError => e
- # display error e
- return
- end
- #success case
+ begin
+ openid_request = consumer.begin(params[:openid_identifier])
+ rescue OpenID::OpenIDError => e
+ # display error e
+ return
+ end
+ #success case
Data regarding the OpenID server once lived in
- openid_request.service
+ `openid_request.service`
The corresponding object in the 2.0 lib can be retrieved with
- openid_request.endpoint
+ `openid_request.endpoint`
Getting the unverified identifier: Where you once had
- openid_request.identity_url
+ `openid_request.identity_url`
you will now want
- openid_request.endpoint.claimed_id
+ `openid_request.endpoint.claimed_id`
which might be different from what you get at the end of the transaction,
since it is now possible for users to enter their server's url directly.
Arguments on the return_to URL are now verified, so if you want to add
additional arguments to the return_to url, use
- openid_request.return_to_args['param'] = value
+ `openid_request.return_to_args['param'] = value`
Generating the redirect is the same as before, but add any extensions
first.
If you need to set up an SSL certificate authority list for the fetcher,
-use the 'ca_file' attr_accessor on the OpenID::StandardFetcher. This has
-changed from 'ca_path' in the 1.x.x series library. That is, set
-OpenID.fetcher.ca_file = '/path/to/ca.list'
+use the 'ca_file' attr_accessor on the `OpenID::StandardFetcher`. This has
+changed from 'ca_path' in the 1.x.x series library. That is, set
+`OpenID.fetcher.ca_file = '/path/to/ca.list'`
before calling consumer.begin.
-=== Requesting Simple Registration Data
+### Requesting Simple Registration Data
You'll need to require the code for the extension
- require 'openid/extensions/sreg'
+
+ require 'openid/extensions/sreg'
The new code for adding an SReg request now looks like:
- sreg_request = OpenID::SReg::Request.new
- sreg_request.request_fields(['email', 'dob'], true) # required
- sreg_request.request_fields(['nickname', 'fullname'], false) # optional
- sreg_request.policy_url = policy_url
- openid_request.add_extension(sreg_request)
+ sreg_request = OpenID::SReg::Request.new
+ sreg_request.request_fields(['email', 'dob'], true) # required
+ sreg_request.request_fields(['nickname', 'fullname'], false) # optional
+ sreg_request.policy_url = policy_url
+ openid_request.add_extension(sreg_request)
The code for adding other extensions is similar. Code for the Attribute
Exchange (AX) and Provider Authentication Policy Extension (PAPE) are
included with the library, and additional extensions can be implemented
-subclassing OpenID::Extension.
+subclassing `OpenID::Extension`.
-
-=== Completing the transaction
+### Completing the transaction
The return_to and its arguments are verified, so you need to pass in
the base URL and the arguments. With Rails, the params method mashes
together parameters from GET, POST, and the path, so you'll need to pull
off the path "parameters" with something like
- return_to = url_for(:only_path => false,
- :controller => 'openid',
- :action => 'complete')
- parameters = params.reject{|k,v| request.path_parameters[k] }
- openid_response = consumer.complete(parameters, return_to)
+ return_to = url_for(:only_path => false,
+ :controller => 'openid',
+ :action => 'complete')
+ parameters = params.reject{|k,v| request.path_parameters[k] }
+ openid_response = consumer.complete(parameters, return_to)
The response still uses the status codes, but they are now namespaced
-slightly differently, for example OpenID::Consumer::SUCCESS
+slightly differently, for example `OpenID::Consumer::SUCCESS`
In the case of failure, the error message is now found in
- openid_response.message
+ `openid_response.message`
The identifier to display to the user can be found in
- openid_response.endpoint.display_identifier
+ `openid_response.endpoint.display_identifier`
The Simple Registration response can be read from the OpenID response
with
- sreg_response = OpenID::SReg::Response.from_success_response(openid_response)
- nickname = sreg_response['nickname']
- # etc.
+ sreg_response = OpenID::SReg::Response.from_success_response(openid_response)
+ nickname = sreg_response['nickname']
+ # etc.
-== Server Upgrade
+## Server Upgrade
The server code is mostly the same as before, with the exception of
-extensions. Also, you must pass in the endpoint URL to the server
+extensions. Also, you must pass in the endpoint URL to the server
constructor:
- @server = OpenID::Server.new(store, server_url)
-I recommend looking at
-examples/rails_openid/app/controllers/server_controller.rb
+ @server = OpenID::Server.new(store, server_url)
+
+I recommend looking at
+`examples/rails_openid/app/controllers/server_controller.rb`
for an example of the new way of doing extensions.
--
Please sign in to comment.
Something went wrong with that request. Please try again.