Permalink
Browse files

Updated deployment info to be 0.2.6

  • Loading branch information...
1 parent c12d6df commit 9cd0584aaa41bd47256bc3db7518bd0045e74068 @pelle committed Sep 9, 2008
Showing with 76 additions and 4 deletions.
  1. +73 −0 README.rdoc
  2. +0 −1 README.txt
  3. +1 −1 lib/oauth/version.rb
  4. +1 −1 oauth.gemspec
  5. +1 −1 tasks/deployment.rake
View
@@ -0,0 +1,73 @@
+= Ruby OAuth GEM
+
+== What
+
+This is a RubyGem for implementing both OAuth clients and servers in Ruby applications.
+
+See the OAuth specs http://oauth.net/core/1.0/
+
+== Installing
+
+ sudo gem install oauth
+
+You can also install it from the oauth rubyforge project http://rubyforge.org/projects/oauth/.
+
+The source code is now hosted on the OAuth GitHub Project http://github.com/pelle/oauth/tree/master
+
+== The basics
+
+This is a ruby library which is intended to be used in creating Ruby Consumer and Service Provider applications. It is NOT a Rails plugin, but could easily be used for the foundation for such a Rails plugin.
+
+As a matter of fact it has been pulled out from an OAuth Rails Plugin http://code.google.com/p/oauth-plugin/ which now requires this GEM.
+
+== Demonstration of usage
+
+Create a new consumer instance by passing it a configuration hash:
+
+ @consumer=OAuth::Consumer.new( "key","secret", {
+ :site=>"https://agree2"
+ })
+
+Start the process by requesting a token
+
+ @request_token=@consumer.get_request_token
+ session[:request_token]=@request_token
+ redirect_to @request_token.authorize_url
+
+When user returns create an access_token
+
+ @access_token=@request_token.get_access_token
+ @photos=@access_token.get('/photos.xml')
+
+For more detailed instructions I have written this OAuth Client Tutorial http://stakeventures.com/articles/2008/02/23/developing-oauth-clients-in-ruby and "How to turn your rails site into an OAuth Provider ":http://stakeventures.com/articles/2007/11/26/how-to-turn-your-rails-site-into-an-oauth-provider .
+
+Finally be sure to check out the OAuth RDoc Manual http://oauth.rubyforge.org/rdoc/ .
+
+== Documentation Wiki
+
+There is some documentation on the Google Code project for the "OAuth Rails Plugin":http://code.google.com/p/oauth-plugin/ :
+
+* RequestToken http://code.google.com/p/oauth-plugin/wiki/RequestToken
+* AccessToken http://code.google.com/p/oauth-plugin/wiki/AccessToken
+
+== Forum
+
+http://groups.google.com/group/oauth-ruby
+
+
+== How to submit patches
+
+Read the "8 steps for fixing other people's code" http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/.
+
+The source code is now hosted on the OAuth GitHub Project http://github.com/pelle/oauth/tree/master
+
+To submit a patch, please fork the oauth project and create a patch with tests. Once you're happy with it send a pull request and post a message to the google group.
+
+== License
+
+This code is free to use under the terms of the MIT license.
+
+== Contact
+
+Comments are welcome. Send an email to "Pelle Braendgaard" pelleb@gmail.com email via the OAuth Ruby mailing list http://groups.google.com/group/oauth-ruby
+
View
@@ -1 +0,0 @@
-README
View
@@ -2,7 +2,7 @@ module Oauth #:nodoc:
module VERSION #:nodoc:
MAJOR = 0
MINOR = 2
- TINY = 5
+ TINY = 6
STRING = [MAJOR, MINOR, TINY].join('.')
end
View
@@ -1,6 +1,6 @@
Gem::Specification.new do |s|
s.name = "oauth"
- s.version = "0.2.5"
+ s.version = "0.2.6"
s.specification_version = 2 if s.respond_to? :specification_version=
View
@@ -31,4 +31,4 @@ namespace :manifest do
task :refresh do
`rake check_manifest | patch -p0 > Manifest.txt`
end
-end
+end

0 comments on commit 9cd0584

Please sign in to comment.