soaspec 0.2.15 → 0.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec45b1e98edf6a23e7067fcd802bae1478eb8c60
-  data.tar.gz: b84b9bcfbb604e1289575e71aec19b5d7ee29b86
+  metadata.gz: 8891885f86ed542e4af5f296faa308b68561c3db
+  data.tar.gz: 320f15c1d25758222199077605fd2438b3dc8210
 SHA512:
-  metadata.gz: 8d9024d5b130efee645a4cdb1bfa08dea28d069b0f457f2d89f8a6634219b284f927eff09ffb9ff6964995637af40748a21952262377d9e3fc0c5ee8ae99820d
-  data.tar.gz: d890a5f985ede66673e32e8a086fbe4920ee5addd5f519ecb5b137c97e0baa8a287481f3a69858bb31936ec27d759f9d460310110a7b04effc2fef496b59241f
+  metadata.gz: 548d8865e81795e26b96d1c6e2bb1db109f74beba399df4714a7e6a3d7b167f9e0b43f2fa74218ac285bbe384ac992a4f2b4797d3b66b71ab985b02d64a98ddb
+  data.tar.gz: 8a89c6cb47d43e6fb24dec5cc407d5c0628ff00d570d638aaa08ddcfaedc31666f1f33dfa42b1955f8e6fc4a0b6e0e7b257f986985d92c52c9b0e103637b375d

data/ChangeLog

@@ -1,3 +1,7 @@
+Version 0.2.16
+* Enhancement
+  * Move debug oauth into OAuth2 class
+
 Version 0.2.14
 * Bug Fix
   * Remove default log file being created before it is changed to a custom location

data/demo/extract.html

@@ -10,30 +10,24 @@
 <div ng-app="codeDemo" ng-controller="extract">
     <p>
         <b>Sample response</b>
-        <p>
-            {"root":
-                {"parent1":
-                    {"child1":5,"child2":"parent1 word"},
-                "parent2":
-                    {"uniq":"val","child2":"word2"}}
-            }
+        <p> {{ sampleData }}
         </p>
     </p>
     <p>Method:
         <select ng-model="index">
-            <option value="0" selected="selected">Unique element from body</option>
-            <option value="1">Element from body via JSONPath</option>
-            <option value="2">List of values matching JSONPath</option>
+            <option ng-repeat="option in myData" value="{{$index}}">{{option.desc}}
+            </option>
         </select>
     </p>
-    <p ng-bind="myData[index].method"></p>
-    <p ng-bind="myData[index].result"></p>
+    <p>Code: {{ myData[index].method }}</p>
+    <p>Result: {{ myData[index].result }} </p>
 </div>
 <script>
     var app = angular.module('codeDemo', []);
     app.controller('extract', function($scope, $http) {
         $http.get("extract.json").then(function(response) {
-            $scope.myData = response.data;
+            $scope.myData = response.data.methods;
+            $scope.sampleData = response.data.sampleData;
         });
     });
 </script>

data/demo/extract.json

@@ -1,14 +1,36 @@
-[
-  {
-    "method": "@exchange['uniq']",
-    "result": "'val'"
-  },
-  {
-    "method": "@exchange['$..parent1.child2']",
-    "result": "'parent1 word'"
-  },
-  {
-    "method": "@exchange.values_at_path('$..child2')",
-    "result": "['parent1 word', 'word2']"
-  }
-]
+{
+  "sampleData":
+    {"root":
+    {"parent1":
+    {"child1":5,"child2":"parent1 word"},
+      "parent2":
+      {"uniq":"val","child2":"word2"}}
+    },
+  "methods": [
+    {
+      "desc": "Get response object",
+      "method": "@exchange.response",
+      "result": "RestClient::Response or Savon::Response"
+    },
+    {
+      "desc": "Unique element from body",
+      "method": "@exchange['uniq']",
+      "result": "'val'"
+    },
+    {
+      "desc": "Element from body via JSONPath",
+      "method": "@exchange['$..parent1.child2']",
+      "result": "'parent1 word'"
+    },
+    {
+      "desc": "List of values matching JSONPath",
+      "method": "@exchange.values_at_path('$..child2')",
+      "result": "['parent1 word', 'word2']"
+    },
+    {
+      "desc": "Convert response into hash",
+      "method": "@exchange.to_hash",
+      "result": "{:root=>{:parent1=>{:child1=>5, :child2=>\"word\"}, :parent2=>{:uniq=>\"val\", :child2=>\"word2\"}}}"
+    }
+  ]
+}

data/lib/soaspec.rb

@@ -40,13 +40,14 @@ module Soaspec
   @auto_oauth = true
 
   class << self
-    # Specify whether to see params sent to and retrieved from oauth. This will put password in log file, only recommended for debugging
-    attr_writer :debug_oauth
     # Folder used to store templates for API calls
+    # @return [String]
     attr_reader :template_folder
     # Stores last exchange
+    # @return [Exchange]
     attr_accessor :last_exchange
     # Automatically add Authorization header to RestHandler where oauth2 credentials are specified
+    # @return [Boolean] Whether to add authorization header
     attr_accessor :auto_oauth
 
     # Folder used to store templates for API calls
@@ -55,23 +56,17 @@ module Soaspec
       @template_folder = folder.include?('\\') ? folder.split('\\') : folder.split('/')
     end
 
-    # Folder used to store credentials
-    # Used in auth2_file command
-    # @param [String] folder
-    attr_writer :credentials_folder
-
     # Credentials folder used to store secret data (not in source control) E.g passwords
-    attr_reader :credentials_folder
-
-    # Used so that exchange class knows what context it's in
-    # @param [ExchangeHandler] handler A class inheriting from Soaspec::ExchangeHandler. Exchange class uses this
-    attr_writer :api_handler
+    # Used in oauth2_file command
+    # @return [String] folder in which credentials are stored
+    attr_accessor :credentials_folder
 
-    # Exchange Handler class currently being used
-    attr_reader :api_handler
+    # Used so that exchange class knows what context it's in.
+    # @return [ExchangeHandler] handler A class inheriting from Soaspec::ExchangeHandler. Exchange class uses this
+    attr_accessor :api_handler
 
-    # Set whether to transform strings to keys in request automatically
-    # @param [Boolean] use_keys
+    # Set whether to transform strings to keys in request automatically.
+    # @return [Boolean]
     attr_writer :always_use_keys
 
     # @return [Boolean] Whether to transform strings to keys in request automatically
@@ -81,10 +76,20 @@ module Soaspec
 
     # @return [Boolean] Whether to see params sent to & received from oauth URL
     def debug_oauth?
-      @debug_oauth || false
+      puts 'Soaspec.debug_oauth? now deprecated. Please use Soaspec::OAuth2.debug_oauth? instead'
+      Soaspec::OAuth2.debug_oauth?
+    end
+
+    # Specify whether to see params sent to and retrieved from oauth.
+    # This will put password in log file, only recommended for debugging
+    # @param [String] set Whether to debug oauth
+    def debug_oauth=(set)
+      puts 'Soaspec.debug_oauth= now deprecated. Please use Soaspec::OAuth2.debug_oauth= instead'
+      Soaspec::OAuth2.debug_oauth = set
     end
 
     # Whether to log all API traffic
+    # @param [Boolean] set
     def log_api_traffic=(set)
       puts 'Soaspec.log_api_traffic= now deprecated. Please use Soaspec::SpecLogger.log_api_traffic= instead'
       Soaspec::SpecLogger.log_api_traffic = set

data/lib/soaspec/exchange/exchange_extractor.rb

@@ -3,7 +3,7 @@ module Soaspec
   # in an exchange from the ExchangeHandler that it's tied to
   module ExchangeExtractor
     # Request of API call. Either intended request or actual request
-    # @response [Object] Object representing request of API
+    # @return [Object] Object representing request of API
     def request
       exchange_handler.request(@response)
     end

data/lib/soaspec/exchange_handlers/rest_exchanger_factory.rb

@@ -3,14 +3,14 @@ module Soaspec
   module RestExchangeFactory
     # Make REST Exchange with 'post' method within this Handler context
     # @param [Hash, String] params Exchange parameters. If String is used it will be for the request payload
-    # @option override_parameters [String] :name Name to appear in traffic logs
-    # @option override_parameters [Hash] :params Extra parameters (E.g. headers)
-    # @option override_parameters [String] :suburl URL appended to base_url of class
-    # @option override_parameters [Hash] :q Query for REST
+    # @option params [String] :name Name to appear in traffic logs
+    # @option params [Hash] :params Extra parameters (E.g. headers)
+    # @option params [String] :suburl URL appended to base_url of class
+    # @option params [Hash] :q Query for REST
     # Following are for the body of the request
-    # @option override_parameters [Hash] :body Hash to be converted to JSON in request body
-    # @option override_parameters [String] :payload String to be passed directly in request body
-    # @option override_parameters [String] :template_name Path to file to be read via ERB and passed in request body
+    # @option params [Hash] :body Hash to be converted to JSON in request body
+    # @option params [String] :payload String to be passed directly in request body
+    # @option params [String] :template_name Path to file to be read via ERB and passed in request body
     # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
     def post(params = {})
       perform_exchange_with(:post, params)
@@ -18,14 +18,14 @@ module Soaspec
 
     # Make REST Exchange with 'patch' method within this Handler context
     # @param [Hash, String] params Exchange parameters. If String is used it will be for the request payload
-    # @option override_parameters [String] :name Name to appear in traffic logs
-    # @option override_parameters [Hash] :params Extra parameters (E.g. headers)
-    # @option override_parameters [String] suburl URL appended to base_url of class
-    # @option override_parameters [Hash] :q Query for REST
+    # @option params [String] :name Name to appear in traffic logs
+    # @option params [Hash] :params Extra parameters (E.g. headers)
+    # @option params [String] suburl URL appended to base_url of class
+    # @option params [Hash] :q Query for REST
     # Following are for the body of the request
-    # @option override_parameters [Hash] :body Hash to be converted to JSON in request body
-    # @option override_parameters [String] :payload String to be passed directly in request body
-    # @option override_parameters [String] :template_name Path to file to be read via ERB and passed in request body
+    # @option params [Hash] :body Hash to be converted to JSON in request body
+    # @option params [String] :payload String to be passed directly in request body
+    # @option params [String] :template_name Path to file to be read via ERB and passed in request body
     # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
     def patch(params)
       perform_exchange_with(:patch, params)
@@ -33,14 +33,14 @@ module Soaspec
 
     # Make REST Exchange with 'put' method within this Handler context
     # @param [Hash, String] params Exchange parameters. If String is used it will be for the request payload
-    # @option override_parameters [String] :name Name to appear in traffic logs
-    # @option override_parameters [Hash] :params Extra parameters (E.g. headers)
-    # @option override_parameters [String] :suburl URL appended to base_url of class
-    # @option override_parameters [Hash] :q Query for REST
+    # @option params [String] :name Name to appear in traffic logs
+    # @option params [Hash] :params Extra parameters (E.g. headers)
+    # @option params [String] :suburl URL appended to base_url of class
+    # @option params [Hash] :q Query for REST
     # Following are for the body of the request
-    # @option override_parameters [Hash] :body Hash to be converted to JSON in request body
-    # @option override_parameters [String] :payload String to be passed directly in request body
-    # @option override_parameters [String] :template_name Path to file to be read via ERB and passed in request body
+    # @option params [Hash] :body Hash to be converted to JSON in request body
+    # @option params [String] :payload String to be passed directly in request body
+    # @option params [String] :template_name Path to file to be read via ERB and passed in request body
     # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
     def put(params = {})
       perform_exchange_with(:put, params)
@@ -49,10 +49,10 @@ module Soaspec
     # Make REST Exchange with 'get' method within this Handler context.
     # If merely a string is passed it will be used as the URL appended to base_url (same as suburl). Otherwise a Hash is expected
     # @param [Hash, String] params Exchange parameters. If String is used it will be for suburl
-    # @option override_parameters [String] :name Name to appear in traffic logs
-    # @option override_parameters [String] :suburl URL appended to base_url of class
-    # @option override_parameters [Hash] :params Extra parameters (E.g. headers)
-    # @option override_parameters [Hash] :q Query for REST
+    # @option params [String] :name Name to appear in traffic logs
+    # @option params [String] :suburl URL appended to base_url of class
+    # @option params [Hash] :params Extra parameters (E.g. headers)
+    # @option params [Hash] :q Query for REST
     # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
     def get(params = {})
       perform_exchange_with(:get, params)
@@ -61,10 +61,10 @@ module Soaspec
     # Make REST Exchange with 'delete' method within this Handler context.
     # If merely a string is passed it will be used as the URL appended to base_url (same as suburl). Otherwise a Hash is expected
     # @param [Hash, String] params Exchange parameters. If String is used it will be for suburl
-    # @option override_parameters [String] :name Name to appear in traffic logs
-    # @option override_parameters [String] :suburl URL appended to base_url of class
-    # @option override_parameters [Hash] :q Query for REST
-    # @option override_parameters [Hash] :params Extra parameters (E.g. headers)
+    # @option params [String] :name Name to appear in traffic logs
+    # @option params [String] :suburl URL appended to base_url of class
+    # @option params [Hash] :q Query for REST
+    # @option params [Hash] :params Extra parameters (E.g. headers)
     # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
     def delete(params = {})
       perform_exchange_with(:delete, params)

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -219,7 +219,7 @@ module Soaspec
       end
     end
 
-    # @response [RestClient::Request] Request of API call. Either intended request or actual request
+    # @return [RestClient::Request] Request of API call. Either intended request or actual request
     def request(response)
       return 'Request not yet sent' if response.nil?
 

data/lib/soaspec/exchange_handlers/rest_parameters.rb

@@ -11,12 +11,12 @@ module Soaspec
 
     # Will create access_token method based on passed parameters
     # @param [Hash] params OAuth 2 parameters
-    # @param_value [token_url] URL to retrieve OAuth token from. @Note this can be set globally instead of here
-    # @param_value [client_id] Client ID
-    # @param_value [client_secret] Client Secret
-    # @param_value [username] Username used in password grant
-    # @param_value [password] Password used in password grant
-    # @param_value [security_token] Security Token used in password grant
+    # @option params [token_url] URL to retrieve OAuth token from. @Note this can be set globally instead of here
+    # @option params [client_id] Client ID
+    # @option params [client_secret] Client Secret
+    # @option params [username] Username used in password grant
+    # @option params [password] Password used in password grant
+    # @option params [security_token] Security Token used in password grant
     def oauth2(params)
       # @!method oauth_obj Object to handle oauth2
       define_method('oauth_obj') { OAuth2.new(params, api_username) }

data/lib/soaspec/o_auth2.rb

@@ -21,6 +21,13 @@ module Soaspec
       attr_accessor :access_tokens
       # List of URLs to that define the instance of an application
       attr_accessor :instance_urls
+      # Specify whether to see params sent to and retrieved from oauth. This will put password in log file, only recommended for debugging
+      attr_writer :debug_oauth
+
+      # @return [Boolean] Whether to see params sent to & received from oauth URL
+      def debug_oauth?
+        @debug_oauth || false
+      end
     end
 
     # @attr [Hash] OAuth parameters
@@ -29,12 +36,12 @@ module Soaspec
     attr_accessor :retry_count
 
     # @param [Hash] params_sent Parameters to make OAuth request
-    # @param_value [token_url] URL to retrieve OAuth token from. @Note this can be set globally instead of here
-    # @param_value [client_id] Client ID
-    # @param_value [client_secret] Client Secret
-    # @param_value [username] Username used in password grant
-    # @param_value [password] Password used in password grant
-    # @param_value [security_token] Security Token used in password grant
+    # @option params_sent [token_url] URL to retrieve OAuth token from. @Note this can be set globally instead of here
+    # @option params_sent [client_id] Client ID
+    # @option params_sent [client_secret] Client Secret
+    # @option params_sent [username] Username used in password grant
+    # @option params_sent [password] Password used in password grant
+    # @option params_sent [security_token] Security Token used in password grant
     # @param [String] api_username Username to use which can be set by Soaspec::ExchangeHandler
     def initialize(params_sent, api_username = nil)
       self.retry_count = 0 # No initial tries at getting access token
@@ -50,6 +57,12 @@ module Soaspec
       params[:password] = ERB.new(params[:password]).result(binding) if params[:password]
     end
 
+    # Retrieve whether to debug oauth parameters based on global settings
+    # @return [Boolean] Whether to see params sent to & received from oauth URL
+    def debug_oauth?
+      self.class.debug_oauth?
+    end
+
     # Retrieve instance_url according to access token response.
     # Some applications have a different instance
     # It's assumed this will be constant for a set of oauth parameters
@@ -71,7 +84,7 @@ module Soaspec
 
     # @return [Hash] Hash containing access token parameters
     def response
-      Soaspec::SpecLogger.info "using oauth_params: #{params}" if Soaspec.debug_oauth?
+      Soaspec::SpecLogger.info "using oauth_params: #{params}" if 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}"])
@@ -80,13 +93,13 @@ module Soaspec
       retry if retry_count < 3
       raise error
     else
-      Soaspec::SpecLogger.info(["response_headers: #{response.headers}", "response_body: #{response.body}"]) if Soaspec.debug_oauth?
+      Soaspec::SpecLogger.info(["response_headers: #{response.headers}", "response_body: #{response.body}"]) if debug_oauth?
       JSON.parse(response)
     end
 
     # @return [String] String to represent OAuth for logging logs
     def request_message
-      if Soaspec.debug_oauth?
+      if debug_oauth?
         "request_params: #{payload}"
       else
         params[:username] ? "User '#{params[:username]}'" : 'client_credentials'

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.2.15'.freeze
+  VERSION = '0.2.16'.freeze
 end

data/lib/soaspec/wsdl_generator.rb

@@ -20,7 +20,7 @@ module Soaspec
       end
     end
 
-    # @param [Nokogiri::XML::NodeSet]
+    # @param [Nokogiri::XML::NodeSet] type WSDL element type
     # @return [Boolean] Whether WSDL type is an enumeration
     def enumeration?(type)
       return false unless type.first
@@ -49,7 +49,7 @@ module Soaspec
       end
     end
 
-    # @param [Nokogiri::XML::Element]
+    # @param [Nokogiri::XML::Element] element Element to check
     # @return [Boolean] True if Nokogiri element is a complex type, that is, has a complexType element underneath itself
     def complex_type?(element)
       element.children.any? { |child| child.name == 'complexType' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.2.15
+  version: 0.2.16
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-17 00:00:00.000000000 Z
+date: 2019-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler