Update yard doc. (+1 squashed commit)

Squashed commits:
[2b827f5] Options pass through to oauth2 client.

Author: marlinpierce

lib/jira/oauth2_client.rb

@@ -5,7 +5,7 @@ module JIRA
   #
   # == OAuth 2.0 Overview
   #
-  # OAuth 2.0 sepearates the roles of Resource Server and Authentication Server.
+  # OAuth 2.0 separates the roles of Resource Server and Authentication Server.
   #
   # The Resource Server will be Jira.
   # The Authentication Server can be Jira or some other OAuth 2.0 Authentication server.
@@ -94,12 +94,16 @@ module JIRA
   #   @return [String] The CLIENT ID registered with the Authentication Server
   # @!attribute [r] client_secret
   #   @return [String] The CLIENT SECRET registered with the Authentication Server
-  # @!attribute [r] cstf_state
+  # @!attribute [r] csrf_state
   #   @return [String] An unpredictable value which a CSRF forger would not be able to provide
   # @!attribute [r] oauth2_client
   #   @return [OAuth2::Client] The oauth2 gem client object used.
-  # @!attribute [r] options
+  # @!attribute [r] oauth2_client_options
   #   @return [Hash] The oauth2 gem options for the client object.
+  # @!attribute [r] prior_grant_type
+  #   @return [String] The grant type used to create the current Access Token.
+  # @!attribute [r] access_token
+  #   @return [OAuth2::AccessToken] An object for the Access Token.
   #
   class Oauth2Client < RequestClient
 
@@ -117,26 +121,36 @@ class Oauth2Client < RequestClient
     }.freeze
 
     attr_reader :prior_grant_type, :access_token
-    # attr_reader :options
     attr_reader :oauth2_client_options, :client_id, :client_secret, :csrf_state
+    # attr_reader :options
 
-    # @param [Hash] options
-    # @option options [String] :client_id The registered client id
-    # @option options [String] :client_secret The registered client secret
-    # @option options [String] :site The hostname of the Authentication Server
-    # @option options [String] :authorize_url The Authorization Request URI (default '/rest/oauth2/latest/authorize')
-    # @option options [String] :token_url The Jira Resource Server Access Request URI (default '/rest/oauth2/latest/token')
-    # @option options [String] :auth_scheme Way of passing parameters for authentication (default 'request_body')
+    # @param [Hash] options Options as passed from JIRA::Client constructor.
+    # @option options [String] :site The hostname of the Jira in the role as Resource Server
+    # @option options [String] :auth_site The hostname of the Authentication Server
+    # @option options [String] :client_id The OAuth 2.0 client id as registered with the Authentication Server
+    # @option options [String] :client_secret The OAuth 2.0 client secret as registered with the Authentication Server
+    # @option options [String] :auth_scheme Way of passing parameters for authentication (defaults to 'request_body')
+    # @option options [String] :authorize_url The Authorization Request URI (defaults to '/rest/oauth2/latest/authorize')
+    # @option options [String] :token_url The Jira Resource Server Access Request URI (defaults to '/rest/oauth2/latest/token')
     # @option options [String] :redirect_uri Callback for result of Authentication Request
+    # @option options [Integer] :max_redirects Number of redirects allowed
+    # @option options [Hash] :default_headers Additional headers for requests
+    # @option options [Boolean] :use_ssl true if using HTTPS, false for HTTP
+    # @option options [Integer] :ssl_verify_mode OpenSSL::SSL::VERIFY_PEER or OpenSSL::SSL::VERIFY_NONE
+    # @option options [String] :cert_path Full path to certificate verifying server identity.
+    # @option options [String] :ssl_client_cert Path to client public key certificate.
+    # @option options [String] :ssl_client_key Path to client private key.
+    # @option options [Symbol] :ssl_version Version of TLS or SSL, (e.g. :TLSv1_2)
     # @option options [String] :proxy_uri Proxy URI
     # @option options [String] :proxy_user Proxy user
     # @option options [String] :proxy_password Proxy Password
-    def initialize(options = {})
+    def initialize(options)
       # @options = init_oauth2_options(options)
       init_oauth2_options(options)
       if options.has_key?(:access_token_options)
         @access_token = access_token_from_options(options[:access_token_options])
       end
+      nil
     end
 
     # @private

spec/jira/oauth2_client_spec.rb

@@ -93,38 +93,6 @@ def query_params_to_h(uri)
           expect(request_client.oauth2_client.site).to eq(site)
           expect(request_client.oauth2_client.id).to eq(client_id)
           expect(request_client.oauth2_client.secret).to eq(client_secret)
-          #         authorize_url: 'oauth/authorize',
-          # redirect_uri: ?
-          # authorize_url: ?
-          #         token_url: 'oauth/token',
-          #         token_method: :post,
-          #         auth_scheme: :basic_auth,
-          #         connection_opts: {},   # <-- Faraday
-          #         connection_build: block,
-          #         max_redirects: 5,
-          #         raise_errors: true,
-          #         logger: ::Logger.new($stdout),
-          #         access_token_class: AccessToken,
-          # Faraday:
-          #     # @option options [Hash] :params Hash of unencoded URI query params.
-          #     # @option options [Hash] :headers Hash of unencoded HTTP headers.
-          #     # @option options [Hash] :request Hash of request options.
-          #     # @option options [Hash] :ssl Hash of SSL options.
-          #     # @option options [Hash] :proxy Hash of Proxy options.
-          # expect(request_client.oauth2_client_options[:auth_scheme]).to eq(JIRA::Oauth2Client::DEFAULT_AUTHORIZE_OPTIONS[:auth_scheme])
-          # expect(request_client.oauth2_client_options[:authorize_url]).to eq(JIRA::Oauth2Client::DEFAULT_AUTHORIZE_OPTIONS[:authorize_url])
-          # expect(request_client.options[:token_url]).to eq(JIRA::Oauth2Client::DEFAULT_OPTIONS[:token_url])
-          #       use_ssl:          config.tls,
-          #       ssl_verify_mode:  ('verify-none' == config.verify_mode ? OpenSSL::SSL::VERIFY_NONE : OpenSSL::SSL::VERIFY_PEER),
-          #       cert_path:        config.ca_cert_file,
-          #       read_timeout:     config.read_timeout,
-          #
-          #:verify => OpenSSL::SSL::VERIFY_NONE
-          # version: :TLSv1_2
-          #     :client_cert  => ...,
-          #     :client_key   => ...,
-          #     :ca_file      => ...,
-          #     :ca_path      => ...,
         end
       end
 
@@ -192,7 +160,18 @@ def query_params_to_h(uri)
       end
 
       context 'passing options to oauth2 client' do
-        it 'passes oauth2 client options to creating oauth2 client'
+        let(:oauth2_client) { instance_double(OAuth2::Client) }
+        subject(:request_client) do
+          JIRA::Oauth2Client.new(full_options)
+        end
+
+        it 'passes oauth2 client options to creating oauth2 client' do
+          expect(OAuth2::Client).to receive(:new).with(client_id, client_secret, request_client.oauth2_client_options).and_return(oauth2_client)
+
+          oauth2_client_result = request_client.oauth2_client
+
+          expect(oauth2_client_result).to eq(oauth2_client)
+        end
       end
     end
   end