cf-uaac 3.1.6 → 3.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60ae15860d77b0b2f0c132a4c356b244346b438c
-  data.tar.gz: 97cb870f7936e8cc67c4bfa4284e7e7281f1870a
+  metadata.gz: c7d94b0c99e65a95ea8973d615886e3c34f53726
+  data.tar.gz: fb96fbcfe4e8e5a65f2ff631b87289b82561b802
 SHA512:
-  metadata.gz: c52ff8e0adb7e9df5270f557626c6b5e4d996a842bc9736242b836e3a1ebcafe70386053277cabc1df2781e7e09a7c65c03661e2cce8a23ef00bb581e858e27b
-  data.tar.gz: 60340d5967d8dab9babdc1d5ba34f2ab300a4e83b2871717d46f32ce3fc2e7a60ecd53e90067a40c723ab27e3e68c7d7035e5ec5ad087463b56b5d46bf28361c
+  metadata.gz: 97d98de132132cbbb5e227e232cce7959edbf3917e776983ec8007e2221ad825fc74c50001c3e7570c00be253fbfdd2960be5cb489412f95cd7a1c57d163961a
+  data.tar.gz: 01dd3c1946a31587b5d149d7b4d2b80b6ecad0d19194cc176373d407b9fe43d9663dda7036ddc48c9e80ec4e6d4781e99f3091085259add4ea5d7272663c34d5

data/README.md

@@ -3,41 +3,68 @@
 [![Build Status](https://travis-ci.org/cloudfoundry/cf-uaac.svg?branch=master)](https://travis-ci.org/cloudfoundry/cf-uaac)
 [![Gem Version](https://badge.fury.io/rb/cf-uaac.png)](https://rubygems.org/gems/cf-uaac)
 
-## Build the gem
+## Installation
 
-    $ bundle install
-    $ gem build cf-uaac.gemspec
+From Rubygems:
 
-## Install it
+`gem install cf-uaac`
 
-    $ gem install cf-uaac*.gem
+Or to build and install the gem:
 
-or from rubygems
+```
+bundle install
+gem build cf-uaac.gemspec
+gem install cf-uaac*.gem
+```
 
-    $ gem install cf-uaac
 
-## Run it
+## Concepts
 
-    $ uaac help
-    $ uaac target uaa.cloudfoundry.com
-    $ uaac token get <your-cf-username>
-    $ uaac token decode
+The user uses a client (like a webapp, or uaac) to do things. The client and the user have different secrets; both the user's and client's secret are passwords.
+
+
+## Connecting and logging in
+
+* `uaac help` opens up the help menu and shows a full list of commands.
+* `uaac target` tells UAAC which UAA you're targeting. e.g. `uaa.example.io`.
+* `uaac target <target-number>` lets you choose a registered target.
+* `uaac targets` lists all registered targets.
+* `uaac token client get (-s <your-client-secret>)` authenticates and gets your token so it can be used by UAAC. The `-s` or `--secret` flag is for inputting your secret, otherwise it will be asked for by UAAC.
+
+Now that UAAC has your token, you're able to run commands and hit the endpoints that your client has the proper scopes for. A list of scopes can be found in [UAA's API documentation.](https://github.com/cloudfoundry/uaa/blob/master/docs/UAA-APIs.rst#scopes-authorized-by-the-uaa)
 
 To use the APIs, see: https://github.com/cloudfoundry/cf-uaa-lib
 
+
+## Creating clients
+
+Authenticate as `admin`, or a user with the right permissions: `clients.admin` or `clients.write`.
+
+`uaac client add -i` brings up the interactive interface. If entering multiple values, separate them with commas.
+
+Scopes and authorities are different in the context of a client.
+
+* Scopes is a list of permitted scopes for this client to obtain on behalf of a user.
+* Authorities is a list of granted authorities for the client, such as `uaa.admin` or `scim.invite`.
+
+`uaac contexts` will list the scopes for a client, which correspond to the users' authorities.
+
+
 ## 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 rake test
+```
+export UAA_CLIENT_ID="admin"
+export UAA_CLIENT_SECRET="adminsecret"
+export UAA_CLIENT_TARGET="http://localhost:8080/uaa"
+bundle exec rake test
+```

data/lib/cli/client_reg.rb

@@ -68,7 +68,7 @@ class ClientCli < CommonCli
       *CLIENT_SCHEMA.keys, :clone, :secret, :interact do |id|
     pp scim_request { |cr|
       opts[:client_id] = clientid(id)
-      opts[:name] = clientname()
+      opts[:name] = clientname() || opts[:client_id]
       opts[:secret] = verified_pwd("New client secret", opts[:secret])
       defaults = opts[:clone] ? Util.hash_keys!(cr.get(:client, opts[:clone]), :sym) : {}
       defaults.delete(:client_id)

data/lib/cli/common.rb

@@ -33,7 +33,7 @@ class CommonCli < Topic
   def userpwd(pwd = opts[:password]); pwd || ask_pwd("Password") end
   def clientid(id = opts[:client]); id || ask("Client ID") end
   def clientsecret(secret = opts[:secret]); secret || ask_pwd("Client secret") end
-  def clientname(name = opts[:name]); name || ask("Client name") end
+  def clientname(name = opts[:name]); name end
 
   def verified_pwd(prompt, pwd = nil)
     while pwd.nil?

data/lib/cli/version.rb

@@ -14,6 +14,6 @@
 # Cloud Foundry namespace
 module CF
   module UAA
-    CLI_VERSION = "3.1.6"
+    CLI_VERSION = "3.1.7"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cf-uaac
 version: !ruby/object:Gem::Version
-  version: 3.1.6
+  version: 3.1.7
 platform: ruby
 authors:
 - Dave Syer
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-12 00:00:00.000000000 Z
+date: 2016-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -276,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: cf-uaac
-rubygems_version: 2.2.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Command line interface for CloudFoundry UAA