soaspec 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f8a71ef7aaaed332941f635ea0c8dae5635b2c7
-  data.tar.gz: ace048d3a5dbd883c0523c6f2a5f654e51b486b6
+  metadata.gz: 8c021efb99c24b3ab3c9e20d17d9a6162dbc2000
+  data.tar.gz: 8a565f97656d00caaa5f3d55f17d76ef3d2e0966
 SHA512:
-  metadata.gz: 13201679a589ce4856d1f9e61df09d25e8ec72242a1f4d2e8e781654e72c961c8a653555a6c3c7c9197e51b7d2643348ea0f5049115b2255b2546890db15a1b8
-  data.tar.gz: 52962a53cb57f808154936718de1aab8a0a30b2488e5cf2bf302e9f6c62caf8b58590c1be4832089221fcd60fd385f0bf9b490cd018a53315b9a1d2f5445d848
+  metadata.gz: 29afe2d8539a57f203330bc5a869648dbfa018c27aba144af9d5343a592c74591c0d07cec5c22439d5286200a01d27ecd4fbee6b646aa8145a434950f8b7ff5b
+  data.tar.gz: eec926fd442193365280f711ed49d705dfa6b29de63cb18714af7101b5d9c1b469d73586d5c775dea9135eb02f077b7224d7a9dbedf5aedade90fb2549bdcc3f

data/ChangeLog

@@ -1,3 +1,7 @@
+Version 0.1.12
+* Enhancements
+  * Add 'refresh_token' attribute to Soaspec::OAuth2 class so that token can be retrieved once and then stored
+
 Version 0.1.11
 * Enhancements
   * OAuth2 class can be initialized with strings as keys

data/lib/soaspec/exchange_handlers/rest_accessors.rb

@@ -13,13 +13,18 @@ module Soaspec
     # Will create access_token method based on passed parameters
     # @param [Hash] params Params client_id: nil, client_secret: nil, token_url: nil, username: nil, password: nil, security_token: nil
     def oauth2(params)
+      # Object to handle oauth2
+      define_method('oauth_obj') do
+        OAuth2.new(params, api_username)
+      end
+
       # Method to send request to get oauth token based on parameters
       define_method('oauth_response') do
-        OAuth2.new(params, api_username).response
+        oauth_obj.response
       end
 
       define_method('access_token') do
-        oauth_response['access_token']
+        oauth_obj.access_token
       end
 
       define_method('instance_url') do

data/lib/soaspec/o_auth2.rb

@@ -3,14 +3,25 @@ require 'erb'
 module Soaspec
   # Handles working with OAuth2
   class OAuth2
+    # How often to refresh access token
+    @refresh_token = :always
+    # List of access tokens. They are mapped according to the OAuth parameters used
+    @access_tokens = {}
     class << self
       # Default token url used across entire suite
       attr_accessor :token_url
+      # @attr [Symbol] refresh_token How often to refresh access token
+      # Values are:
+      #   * :always - (Default) Request token from token url every time it is needed
+      #   * :once - Request token once for the entire execution of the suite
+      attr_accessor :refresh_token
+      # @attr [Hash] access_tokens List of access tokens. They are mapped according to the OAuth parameters used
+      attr_accessor :access_tokens
     end
 
-    # [Hash] OAuth parameters
+    # @attr [Hash] OAuth parameters
     attr_accessor :params
-    # Count of tries to obtain access token
+    # @attr [Integer] Count of tries to obtain access token
     attr_accessor :retry_count
 
     # @param [Hash] params_sent Parameters to make OAuth request
@@ -28,12 +39,22 @@ module Soaspec
       Soaspec::SpecLogger.info request_message
     end
 
+    # @return [String] Existing or new access token, dependent on refresh_token attribute
+    def access_token
+      case Soaspec::OAuth2.refresh_token
+      when :once
+        Soaspec::OAuth2.access_tokens[params] ||= response['access_token']
+      else # Default is :always
+        response['access_token']
+      end
+    end
+
     # @return [Hash] Hash containing access token parameters
     def response
+      Soaspec::SpecLogger.info "using oauth_params: #{params}" if Soaspec.debug_oauth?
       response = RestClient.post(params[:token_url], payload, cache_control: 'no_cache', verify_ssl: false)
     rescue RestClient::Exception => error
       Soaspec::SpecLogger.info(["oauth_error: #{error.message}", "oauth_response: #{error.response}"])
-      Soaspec::SpecLogger.info "oauth_params_used: #{params}" if Soaspec.debug_oauth?
       self.retry_count += 1
       sleep 0.1 # Wait if a bit before retying obtaining access token
       retry if retry_count < 3

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.1.11'.freeze
+  VERSION = '0.1.12'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-24 00:00:00.000000000 Z
+date: 2018-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler