soaspec 0.0.68 → 0.0.69

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 598e32d75616543432d61150ecdd1105a255b172
-  data.tar.gz: eeeeb60b9f49ec979dada1b46caf83ba77523455
+  metadata.gz: 14727008606cfec7f58866ea5528db6e761927dd
+  data.tar.gz: 9da88c13d311e5d2f1e920fbe6c5ce219362f871
 SHA512:
-  metadata.gz: cc58120c84d46e6bcf688c35c19508e5bf0130bd83c33e80fe146720c4c33cf20f599b0126fcfc05a5e233911407a5dad75e2eec2dbb63409e874dec7f27d4ac
-  data.tar.gz: c58d409768534149f900b6b9314181ac548f5b1699540e496901ff26c4007ea607897535b9d0dc6928e4a0888f608cce5e83adf8a9a000e78baafc9f819feb3f
+  metadata.gz: ce39bb65f5aa62ab0df66a454eaa690e85253a3974c2d9739140fbe1a67c5f8e96a473772623c8943356a0b8e9eb5a0576ae4e59edea95450140b9616bdb1458
+  data.tar.gz: aeab0b613c8217aa71f3a02ac459d3b3187ced396e7f6f9a03994c863edafb4a7fc7f563363c5c62a4d8065b898a1f2959e3bb34e567d4f568c15257a48bfe78

data/ChangeLog

@@ -1,3 +1,10 @@
+Version 0.0.69
+* Enhancements
+  * Calculate base_url ERB at time of handler's first request (Rather than when initialised).
+    - Important for where base url uses ERB and so does oauth whose user may change
+  * Demonstrate using oauth via spec
+  * Demonstrate using basic auth via spec
+
 Version 0.0.68
 * Enhancements
   * Use ERB to calculate base_url for dynamic bases

data/Rakefile

@@ -21,6 +21,6 @@ desc 'Start virtual web service'
 task :start_test_server do
   mkdir_p 'logs'
   ENV['test_server_pid'] = Process.spawn('ruby', 'exe/soaspec-virtual-server', err: %w[logs/test_server.log w]).to_s
-  sleep 1 # Wait a little for virtual server to start up
+  sleep 2 # Wait a little for virtual server to start up
   puts 'Running test server at pid ' + ENV['test_server_pid']
 end

data/exe/soaspec-virtual-server

@@ -5,6 +5,7 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 require 'soaspec'
 require 'sinatra'
+require 'sinatra/basic_auth'
 require 'nokogiri'
 require 'erb'
 require 'json'
@@ -27,12 +28,27 @@ get '/BLZService' do
   [200, { 'Content-Type' => 'text/xml' }, Soaspec::TestServer::GetBank.test_wsdl]
 end
 
-get '/as/token.oauth2' do
+# Simulate retrieving an ouath token. Passed to '/invoices'
+post '/as/token.oauth2' do
+  [200, Soaspec::TestServer::Invoices.oauth_headers, JSON.generate(Soaspec::TestServer::Invoices.oauth_body) ] #Soaspec::TestServer::Invoices.oauth_headers, ]# JSON.generate(Soaspec::TestServer::Invoices.oauth_body)]
+end
+
+get '/invoice/:id' do |id|
+  JSON.generate(customer_id: id, oauth: request.env['HTTP_AUTHORIZATION'])
+end
+
+authorize do |username, password|
+  username == 'admin' && password == 'secret'
+end
 
+protect do
+  get '/basic_secrets' do
+    'Secret data'
+  end
 end
 
 # Used for testing storage of data
-post '/test/name' do
+post '/test/puppy' do
   request_hash = JSON.parse(request.body.string)
   id = Soaspec::TestServer::PuppyService.new_id
   Soaspec::TestServer::PuppyService.data[id][:Name] = request_hash['Name']
@@ -42,12 +58,12 @@ post '/test/name' do
 end
 
 # Used for testing retrieving storage of data
-get '/test/name/:id' do |id|
+get '/test/puppy/:id' do |id|
   result = Soaspec::TestServer::PuppyService.data[id.to_i]
   JSON.generate result
 end
 
-patch '/test/name/:id' do |id|
+patch '/test/puppy/:id' do |id|
   request_hash = JSON.parse(request.body.string)
   Soaspec::TestServer::PuppyService.data[id.to_i][:Name] = request_hash['Name']
   response_hash = { result: { Status: 'updated', With: request_hash['Name'] } }

data/lib/soaspec.rb

@@ -25,6 +25,7 @@ require 'soaspec/not_found_errors'
 require 'soaspec/test_server/get_bank'
 require 'soaspec/test_server/test_attribute'
 require 'soaspec/test_server/puppy_service'
+require 'soaspec/test_server/invoices'
 
 # Gem for handling SOAP and REST api tests
 module Soaspec

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -50,12 +50,15 @@ module Soaspec
           Soaspec::SpecLogger.add_to 'request_params: ' + payload.to_s
           response = RestClient.post(token_url, payload, cache_control: 'no_cache', verify_ssl: false)
         rescue RestClient::Exception => e
+          Soaspec::SpecLogger.add_to("oauth_error: #{e.message}")
+          Soaspec::SpecLogger.add_to("oauth_error: #{e.response}")
           retry_count += 1
           retry if retry_count < 3
           raise e
         end
         Soaspec::SpecLogger.add_to("response_headers: #{response.headers}")
         Soaspec::SpecLogger.add_to("response_body: #{response.body}")
+        Soaspec::SpecLogger.add_to("response: #{response}")
         JSON.parse(response)
       end
 
@@ -138,11 +141,7 @@ module Soaspec
       end
       super
       set_remove_key(options, :default_hash)
-      merged_options = rest_resource_options
-      merged_options[:headers] ||= {}
-      merged_options[:headers].merge! parse_headers
-      merged_options.merge!(options)
-      @resource = RestClient::Resource.new(ERB.new(base_url_value).result(binding), merged_options)
+      @init_options = options
     end
 
     # Convert snakecase to PascalCase
@@ -168,18 +167,30 @@ module Soaspec
       end
     end
 
+    # Initialize value of merged options
+    def init_merge_options
+      options = rest_resource_options
+      options[:headers] ||= {}
+      options[:headers].merge! parse_headers
+      options.merge(@init_options)
+    end
+
     # Used in together with Exchange request that passes such override parameters
     # @param [Hash] override_parameters Params to characterize REST request
     # @param_value [params] Extra parameters (E.g. headers)
     # @param_value [suburl] URL appended to base_url of class
-    # @param_value [method] REST method (get, post, etc)
+    # @param_value [method] REST method (:get, :post, etc)
     def make_request(override_parameters)
+      @merged_options ||= init_merge_options
       test_values = override_parameters
       test_values[:params] ||= {}
       test_values[:method] ||= :post
       test_values[:suburl] = test_values[:suburl].to_s if test_values[:suburl]
       test_values[:params][:params] = test_values[:q] if test_values[:q] # Use q for query parameters. Nested :params is ugly and long
 
+      # In order for ERB to be calculated at correct time, the first time request is made, the resource should be created
+      @resource ||= RestClient::Resource.new(ERB.new(base_url_value).result(binding), @merged_options)
+
       @resource_used = test_values[:suburl] ? @resource[test_values[:suburl]] : @resource
 
       begin

data/lib/soaspec/test_server/invoices.rb

@@ -0,0 +1,23 @@
+module Soaspec
+  module TestServer
+    # Used to simulate requests requiring oauth authentication
+    class Invoices
+      class << self
+        def oauth_headers
+          {
+            'Content-Type' => 'application/json;charset=UTF-8'
+          }
+        end
+
+        def oauth_body
+          {
+            access_token: 'TEST_TOKENiIsImtpZCI6IlRFU1QifQ.AAAABBBBRfaWQiOiJhYWQ5MjY3SIMULATE_LARGE_TOKEN3MmM5OGQ5NGE2YTU5YSIsImV4cCI6MTUyNzU3MTY4Mywic2NvcGUiOltdfQ.3OmCdW7fLZMUST_BE_ABLE_TO_HANDLEgAGaJB0lFYyhaw',
+            token_type: 'Bearer',
+            expires_in: '86399'
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/soaspec/test_server/puppy_service.rb

@@ -1,5 +1,6 @@
 module Soaspec
   module TestServer
+    # Simulates ordering a new puppy. Used for testing REST storing, retrieving and updating data
     class PuppyService
       @data = {}
       @current_id = 1

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.0.68'.freeze
+  VERSION = '0.0.69'.freeze
 end

data/soaspec.gemspec

@@ -38,6 +38,7 @@ the same configuration "
   spec.add_dependency 'rspec-its', '>= 1.2.0'
   spec.add_dependency 'savon', '>= 2' # SOAP
   spec.add_dependency 'sinatra'
+  spec.add_dependency 'sinatra-basic-auth'
   spec.add_dependency 'xml-simple', '>= 1.1.5'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.0.68
+  version: 0.0.69
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-28 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -234,6 +234,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-basic-auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: xml-simple
   requirement: !ruby/object:Gem::Requirement
@@ -292,6 +306,7 @@ files:
 - lib/soaspec/spec_logger.rb
 - lib/soaspec/test_server/bank.wsdl
 - lib/soaspec/test_server/get_bank.rb
+- lib/soaspec/test_server/invoices.rb
 - lib/soaspec/test_server/note.xml
 - lib/soaspec/test_server/puppy_service.rb
 - lib/soaspec/test_server/test_attribute.rb