cf-uaa-lib 1.3.2 → 1.3.3

data/.yardopts

@@ -0,0 +1,5 @@
+--main README.md
+--no-private
+--title "Cloud Foundry UAA Client API"
+lib/**/*.rb - LICENSE.TXT NOTICE.TXT
+

data/Rakefile

@@ -13,7 +13,6 @@
 require "rspec/core/rake_task"
 require "bundler/gem_tasks" # only available in bundler >= 1.0.15
 require "ci/reporter/rake/rspec"
-require "yard"
 
 ENV['CI_REPORTS'] = File.expand_path("spec_reports")
 COV_REPORTS = File.expand_path("coverage")
@@ -22,12 +21,6 @@ task :default => [:test]
 task :tests => [:test]
 task :spec => [:test]
 
-YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb', '-', 'LICENSE.TXT', 'NOTICE.TXT']
-  t.options = ['--main', 'README.md', '--no-private',
-              '--title', 'Cloud Foundry UAA Client API']
-end
-
 RSpec::Core::RakeTask.new("test") do |t|
   t.rspec_opts = ["--format", "documentation", "--colour"]
   t.pattern = "spec/**/*_spec.rb"

data/cf-uaa-lib.gemspec

@@ -36,8 +36,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "bundler"
   s.add_development_dependency "rake"
-  s.add_development_dependency "yard"
-  s.add_development_dependency "redcarpet"
   s.add_development_dependency "rspec"
   s.add_development_dependency "simplecov"
   s.add_development_dependency "simplecov-rcov"

data/lib/uaa/http.rb

@@ -71,19 +71,22 @@ module Http
         Base64.strict_encode64(str): [str].pack("m").gsub(/\n/, ''))
   end
 
+  JSON_UTF8 = "application/json;charset=utf-8"
+  FORM_UTF8 = "application/x-www-form-urlencoded;charset=utf-8"
+
   private
 
   def json_get(target, path = nil, style = nil, headers = {})
     raise ArgumentError unless style.nil? || style.is_a?(Symbol)
-    json_parse_reply(style, *http_get(target, path, headers.merge("accept" => "application/json")))
+    json_parse_reply(style, *http_get(target, path, headers.merge("accept" => JSON_UTF8)))
   end
 
   def json_post(target, path, body, headers = {})
-    http_post(target, path, Util.json(body), headers.merge("content-type" => "application/json"))
+    http_post(target, path, Util.json(body), headers.merge("content-type" => JSON_UTF8))
   end
 
   def json_put(target, path, body, headers = {})
-    http_put(target, path, Util.json(body), headers.merge("content-type" => "application/json"))
+    http_put(target, path, Util.json(body), headers.merge("content-type" => JSON_UTF8))
   end
 
   def json_parse_reply(style, status, body, headers)

data/lib/uaa/misc.rb

@@ -98,9 +98,8 @@ class Misc
   # @return [Hash]
   def self.password_strength(target, password)
     json_parse_reply(@key_style, *request(target, :post, '/password/score',
-        Util.encode_form(:password => password),
-        "content-type" => "application/x-www-form-urlencoded",
-        "accept" => "application/json"))
+        Util.encode_form(:password => password), "content-type" => Http::FORM_UTF8,
+        "accept" => Http::JSON_UTF8))
   end
 
 end

data/lib/uaa/scim.rb

@@ -209,9 +209,8 @@ class Scim
     end
   end
 
-  # Gets id/name pairs for given names.
+  # Gets id/name pairs for given names. For naming attribute of each object type see {Scim}
   # @param type (see #add)
-  # @param [Array<String>] names. For naming attribute of each object type see {Scim}
   # @return [Array] array of name/id hashes for each object found
   def ids(type, *names)
     na = type_info(type, :name_attr)

data/lib/uaa/token_coder.rb

@@ -46,8 +46,7 @@ class TokenCoder
 
   # Constructs a signed JWT.
   # @param token_body Contents of the token in any object that can be converted to JSON.
-  # @param skey (see #initialize)
-  # @param pkey  (see #initialize)
+  # @param options (see #initialize)
   # @return [String] a signed JWT token string in the form "xxxx.xxxxx.xxxx".
   def self.encode(token_body, options = {}, obsolete1 = nil, obsolete2 = nil)
     unless options.is_a?(Hash) && obsolete1.nil? && obsolete2.nil?
@@ -78,9 +77,7 @@ class TokenCoder
   # The JWT header indicates what signature algorithm was used and the
   # corresponding key is used to verify the signature (if +verify+ is true).
   # @param [String] token A JWT token as returned by {TokenCoder.encode}
-  # @param skey (see #initialize)
-  # @param pkey  (see #initialize)
-  # @param [Boolean] verify
+  # @param options (see #initialize)
   # @return [Hash] the token contents
   def self.decode(token, options = {}, obsolete1 = nil, obsolete2 = nil)
     unless options.is_a?(Hash) && obsolete1.nil? && obsolete2.nil?
@@ -112,17 +109,26 @@ class TokenCoder
 
   # Creates a new token en/decoder for a service that is associated with
   # the the audience_ids, the symmetrical token validation key, and the
-  # public and/or private keys. Parameters:
-  # @param [Array<String>, String] audience_ids An array or space separated
-  #   strings of values which indicate the token is intended for this service
-  #   instance. It will be compared with tokens as they are decoded to ensure
-  #   that the token was intended for this audience.
-  # @param [String] skey is used to sign and validate tokens using symmetrical
-  #   key algoruthms
-  # @param [String, File, OpenSSL::PKey::PKey] pkey may be a String, File in
-  #   PEM or DER formats. May include public and/or private key data. The
-  #   private key is used to sign tokens and the public key is used to
-  #   validate tokens.
+  # public and/or private keys.
+  # @param [Hash] options Supported options:
+  #   * :audience_ids [Array<String>, String] -- An array or space separated
+  #     string of values which indicate the token is intended for this service
+  #     instance. It will be compared with tokens as they are decoded to ensure
+  #     that the token was intended for this audience.
+  #   * :skey [String] -- used to sign and validate tokens using symmetrical
+  #     key algoruthms
+  #   * :pkey [String, File, OpenSSL::PKey::PKey] -- may be a String or File in
+  #     PEM or DER formats. May include public and/or private key data. The
+  #     private key is used to sign tokens and the public key is used to
+  #     validate tokens.
+  #   * :algorithm [String] -- Sets default used for encoding. May be HS256,
+  #     HS384, HS512, RS256, RS384, RS512, or none.
+  #   * :verify [String] -- Verifies signatures when decoding tokens. Defaults
+  #     to +true+.
+  # @note the TokenCoder instance must be configured with the appropriate
+  #   key material to support particular algorithm families and operations
+  #   -- i.e. :pkey must include a private key in order to sign tokens with
+  #   the RS algorithms.
   def initialize(options = {}, obsolete1 = nil, obsolete2 = nil)
     unless options.is_a?(Hash) && obsolete1.nil? && obsolete2.nil?
       # deprecated: def initialize(audience_ids, skey, pkey = nil)
@@ -135,10 +141,8 @@ class TokenCoder
 
   # Encode a JWT token. Takes a hash of values to use as the token body.
   # Returns a signed token in JWT format (header, body, signature).
-  # Algorithm may be HS256, HS384, HS512, RS256, RS384, RS512, or none --
-  # assuming the TokenCoder instance is configured with the appropriate
-  # key -- i.e. pkey must include a private key for the RS algorithms.
   # @param token_body (see TokenCoder.encode)
+  # @param [String] algorithm -- overrides default. See {#initialize} for possible values.
   # @return (see TokenCoder.encode)
   def encode(token_body = {}, algorithm = nil)
     token_body[:aud] = @options[:audience_ids] if @options[:audience_ids] && !token_body[:aud] && !token_body['aud']

data/lib/uaa/token_issuer.rb

@@ -72,8 +72,7 @@ class TokenIssuer
     if scope = Util.arglist(params.delete(:scope))
       params[:scope] = Util.strlist(scope)
     end
-    headers = {'content-type' => 'application/x-www-form-urlencoded',
-        'accept' => 'application/json',
+    headers = {'content-type' => FORM_UTF8, 'accept' => JSON_UTF8,
         'authorization' => Http.basic_auth(@client_id, @client_secret) }
     reply = json_parse_reply(@key_style, *request(@token_target, :post,
         '/oauth/token', Util.encode_form(params), headers))
@@ -134,7 +133,7 @@ class TokenIssuer
     uri = authorize_path_args("token", redir_uri, scope, state = random_state)
 
     # the accept header is only here so the uaa will issue error replies in json to aid debugging
-    headers = {'content-type' => 'application/x-www-form-urlencoded', 'accept' => 'application/json' }
+    headers = {'content-type' => FORM_UTF8, 'accept' => JSON_UTF8 }
     body = Util.encode_form(credentials.merge(:source => 'credentials'))
     status, body, headers = request(@target, :post, uri, body, headers)
     raise BadResponse, "status #{status}" unless status == 302
@@ -184,8 +183,7 @@ class TokenIssuer
   # @param [String] redirect_uri (see #authcode_uri)
   # @return (see #authcode_uri)
   def autologin_uri(redirect_uri, credentials, scope = nil)
-    headers = {'content-type' => 'application/x-www-form-urlencoded',
-        'accept' => 'application/json',
+    headers = {'content-type' => FORM_UTF8, 'accept' => JSON_UTF8,
         'authorization' => Http.basic_auth(@client_id, @client_secret) }
     body = Util.encode_form(credentials)
     reply = json_parse_reply(nil, *request(@target, :post, "/autologin", body, headers))

data/lib/uaa/version.rb

@@ -14,6 +14,6 @@
 # Cloud Foundry namespace
 module CF
   module UAA
-    VERSION = "1.3.2"
+    VERSION = "1.3.3"
   end
 end

data/spec/misc_spec.rb

@@ -29,7 +29,7 @@ describe Misc do
       url.should == "https://uaa.cloudfoundry.com/login"
       method.should == :get
       headers["content-type"].should be_nil
-      headers["accept"].should =~ /application\/json/
+      headers["accept"].gsub(/\s/, '').should =~ /application\/json;charset=utf-8/i
       [200, '{"commit_id":"12345","prompts":["one","two"]}', {"content-type" => "application/json"}]
     end
     result = Misc.server("https://uaa.cloudfoundry.com")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cf-uaa-lib
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -63,38 +63,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +159,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .yardopts
 - Gemfile
 - LICENSE.TXT
 - NOTICE.TXT
@@ -226,7 +195,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1911536519495271904
+      hash: 1871594390469590559
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -235,12 +204,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1911536519495271904
+      hash: 1871594390469590559
 requirements: []
 rubyforge_project: cf-uaa-lib
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Client library for CloudFoundry UAA
 test_files: []
-has_rdoc: