mark cf-uaa-client gem as deprecated.

Change-Id: I03a93930cd817f45344616272abcad78bd12822f

gem/README.md

@@ -1,57 +1,62 @@
 CloudFoundry UAA Gem
 ====================
 
+*NOTE: This gem is deprecated. Please use cf-uaa-lib and cf-uaac gems instead. 
+They are available from rubygems.org or 
+https://github.com/cloudfoundry/cf-uaa-lib and 
+https://github.com/cloudfoundry/cf-uaac*
+
 Client gem for interacting with the CloudFoundry UAA server.
 
 Set up a local ruby environment (so sudo not required):
 
-  $ rvm use 1.9.2
+    $ rvm use 1.9.2
 
 or
 
-  $ rbenv global 1.9.2-p180
+    $ rbenv global 1.9.2-p180
 
 see: https://rvm.io/ or http://rbenv.org/
 
 Build the gem
 
-  $ bundle install
-  $ gem build cf-uaa-client.gemspec
+    $ bundle install
+    $ gem build cf-uaa-client.gemspec
 
 Install it
 
-  $ gem install cf-uaa-client*.gem
+    $ gem install cf-uaa-client*.gem
 
 Run it
 
-  $ uaac help
-  $ uaac target uaa.cloudfoundry.com
-  $ uaac token get <your-cf-username>
-  $ uaac token decode
+    $ uaac help
+    $ uaac target uaa.cloudfoundry.com
+    $ uaac token get <your-cf-username>
+    $ uaac token decode
 
 Use the gem:
 
-  #!/usr/bin/env ruby
-  require 'uaa'
-  token_issuer = CF::UAA::TokenIssuer.new("https://uaa.cloudfoundry.com", "vmc")
-  puts token_issuer.prompts.inspect
-  token = token_issuer.implicit_grant_with_creds(username: "<your_username>", password: "<your_password>")
-  token_info = TokenCoder.decode(token.info[:access_token], nil, nil, false) #token signature not verified
-  puts token_info[:user_name]
+    #!/usr/bin/env ruby
+    require 'uaa'
+    token_issuer = CF::UAA::TokenIssuer.new("https://uaa.cloudfoundry.com", "vmc")
+    puts token_issuer.prompts.inspect
+    token = token_issuer.implicit_grant_with_creds(username: "<your_username>", password: "<your_password>")
+    token_info = TokenCoder.decode(token.info[:access_token], nil, nil, false) #token signature not verified
+    puts token_info[:user_name]
 
 ## Tests
 
 Run the tests with rake:
 
-  $ bundle exec rake test
+    $ bundle exec rake test
 
 Run the tests and see a fancy coverage report:
 
-  $ bundle exec rake cov
+    $ bundle exec rake cov
 
 Run integration tests (on a server running on localhost:8080/uaa):
 
-  $ export UAA_CLIENT_ID="admin"
-  $ export UAA_CLIENT_SECRET="adminsecret"
-  $ export UAA_CLIENT_TARGET="http://localhost:8080/uaa"
-  $ bundle exec rspec spec/integration_spec.rb
+    $ export UAA_CLIENT_ID="admin"
+    $ export UAA_CLIENT_SECRET="adminsecret"
+    $ export UAA_CLIENT_TARGET="http://localhost:8080/uaa"
+    $ bundle exec rspec spec/integration_spec.rb

gem/cf-uaa-client.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Dave Syer", "Dale Olds", "Joel D'sa", "Vidya Valmikinathan", "Luke Taylor"]
   s.email       = ["dsyer@vmware.com", "olds@vmware.com", "jdsa@vmware.com", "vidya@vmware.com", "ltaylor@vmware.com"]
   s.homepage    = "https://github.com/cloudfoundry/uaa/tree/master/gem"
-  s.summary     = %q{Client and resource library for CloudFoundry UAA}
-  s.description = %q{Client library and command line tools for interacting with the CloudFoundry User Account and Authorization (UAA) server.  The UAA is an OAuth2 Authorization Server so it can be used by webapps and command line apps to obtain access tokens to act on behalf of users.  The tokens can then be used to access protected resources in a Resource Server.  This library can be used by clients (as a convenient wrapper for mainstream oauth gems) or by resource servers.}
+  s.summary     = %q{Deprecated client and resource library for CloudFoundry UAA. Please use cf-uaa-lib and cf-uaac instead.}
+  s.description = %q{Deprecated client library and command line tools for interacting with the CloudFoundry User Account and Authorization (UAA) server.  The UAA is an OAuth2 Authorization Server so it can be used by webapps and command line apps to obtain access tokens to act on behalf of users.  The tokens can then be used to access protected resources in a Resource Server.  This library can be used by clients (as a convenient wrapper for mainstream oauth gems) or by resource servers.}
 
   s.rubyforge_project = "cf-uaa-client"
 

gem/lib/uaa/version.rb

@@ -13,6 +13,7 @@
 
 module CF
   module UAA
+    warn "The cf-uaa-client gem is deprecated. Please use cf-uaa-lib and cf-uaac instead"
     VERSION = "1.3.0"
   end
 end