tshield 0.11.19.0 → 0.11.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7be1450b970496e9bc17514f42fcda00e98cf8e0b5e269b54b809f38e752653
-  data.tar.gz: fd139f9746a3cd6470aec409b809f0d62b6af0915ca0db910a64a7470ad6f44b
+  metadata.gz: 1880df41008713100967696d1bf1695b1e830851877f0ed5340f1f3f75cabd5e
+  data.tar.gz: 2a540ed72557ad9f9ba32073a5e98ed9b22812c1d0b96feaec00eeed35494386
 SHA512:
-  metadata.gz: c9727017f7c245277e64ab4bb4eca0a82f08eaf8ceb0c4b4424693f42dc2267eb0420ea15b557adadba4a69eb3116e7fca60717686a641b8602e77a4d99f183e
-  data.tar.gz: c4d633f5d08a2801de7e30e56a2a947b64d3e91db13ca803689a2f05d15053812eeb82585f7058e6a0a2ee9a72170b9d0f5f44557c751f7ce77800073aa23f2e
+  metadata.gz: 7187004fa9e86545dcf81ebf70ea3059e04a0a8dcfe0143be3714ead2df3b9fc7d3e981641514f38192d69e57f826c85b14c46965f5d8171e3813e1bd9188574
+  data.tar.gz: d1e5e07ff88b722a944d78e22f1d3089214fb1ae9bed74c7bd42943700fc63bc096fc7916368513c83e660cb7936044dffd52e0f5c5b927d2618364a1411074e

data/README.md

@@ -250,6 +250,16 @@ _DELETE_ to http://localhost:4567/sessions
 curl -X DELETE \
   http://localhost:4567/sessions
 ```
+### Append secondary TShield session
+**Append session. Secondary sessions will used only for read content in VCR mode, writes will be do in the main session. Append only works if exists a current session setted.**
+
+_POST_ to http://localhost:4567/sessions?name=<<same_name>>
+
+```
+curl -X POST \
+  'http://localhost:4567/sessions/append?name=my_valid'
+```
+
 ## [Experimental] Config options for gRPC
 
 ```yaml

data/config/tshield.yml

@@ -14,5 +14,6 @@ domains:
     skip_query_params:
       - b
     paths:
+      - /fake
       - /users
       - /resources

data/lib/tshield/controllers/helpers/session_helpers.rb

@@ -10,6 +10,11 @@ module TShield
           session[:name] if session
         end
 
+        def self.secondary_sessions(request)
+          session = TShield::Sessions.current(request.ip)
+          session[:secondary_sessions] if session
+        end
+
         def self.current_session_call(request, callid, method)
           session = TShield::Sessions.current(request.ip)
           session ? session[:counter].current(callid, method) : 0

data/lib/tshield/controllers/requests.rb

@@ -43,6 +43,7 @@ module TShield
           request_content_type = request.content_type
 
           session_name = TShield::Controllers::Helpers::SessionHelpers.current_session_name(request)
+          secondary_sessions = TShield::Controllers::Helpers::SessionHelpers.secondary_sessions(request)
           session_call = TShield::Controllers::Helpers::SessionHelpers
                          .current_session_call(request, callid, method)
 
@@ -51,6 +52,7 @@ module TShield
             headers: Helpers.build_headers(request),
             raw_query: request.env['QUERY_STRING'],
             session: session_name,
+            secondary_sessions: secondary_sessions,
             call: session_call,
             ip: request.ip
           }
@@ -67,7 +69,7 @@ module TShield
           unless api_response
             add_headers(options, path)
 
-            api_response ||= TShield::RequestVCR.new(path, options.clone).response
+            api_response ||= TShield::RequestVCR.new(path, options.clone).vcr_response
             api_response.headers.reject! do |key, _v|
               configuration.get_excluded_headers(domain(path)).include?(key)
             end

data/lib/tshield/controllers/sessions.rb

@@ -23,6 +23,9 @@ module TShield
       end
 
       def self.register_post(app, session_path)
+        app.post "#{session_path}/append" do
+          TShield::Sessions.append(request.ip, params[:name]).to_json
+        end
         app.post session_path do
           TShield::Sessions.start(request.ip, params[:name]).to_json
         end

data/lib/tshield/errors.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class AppendSessionWithoutMainSessionError < RuntimeError
+end

data/lib/tshield/matching/filters.rb

@@ -8,6 +8,14 @@ module TShield
         result = filter_stubs(stubs[@options[:session]] || {})
         return result if result
 
+        find_in_secondary_sessions(stubs, @options[:secondary_sessions] || [])
+      end
+
+      def find_in_secondary_sessions(stubs, sessions)
+        sessions.each do |session|
+          result = filter_stubs(stubs[session] || {})
+          return result if result
+        end
         filter_stubs(stubs[DEFAULT_SESSION] || {}) unless @options[:session] == DEFAULT_SESSION
       end
 

data/lib/tshield/request.rb

@@ -13,8 +13,8 @@ module TShield
 
     protected
 
-    def session_destiny(request_path)
-      session = @options[:session]
+    def session_destiny(request_path, current_session = nil)
+      session = current_session || @options[:session]
       return request_path unless session
 
       request_path = File.join(request_path, session)
@@ -22,19 +22,19 @@ module TShield
       request_path
     end
 
-    def content_destiny
-      "#{destiny}.content"
+    def content_destiny(current_session = nil)
+      "#{destiny(current_session)}.content"
     end
 
-    def headers_destiny
-      "#{destiny}.json"
+    def headers_destiny(current_session = nil)
+      "#{destiny(current_session)}.json"
     end
 
-    def destiny
+    def destiny(current_session = nil)
       request_path = File.join('requests')
       Dir.mkdir(request_path) unless File.exist?(request_path)
 
-      request_path = session_destiny(request_path)
+      request_path = session_destiny(request_path, current_session)
 
       name_path = File.join(request_path, name)
       Dir.mkdir(name_path) unless File.exist?(name_path)

data/lib/tshield/request_vcr.rb

@@ -2,11 +2,11 @@
 
 require 'httparty'
 require 'json'
-require 'byebug'
 
 require 'digest/sha1'
 
 require 'tshield/configuration'
+require 'tshield/logger'
 require 'tshield/options'
 require 'tshield/request'
 require 'tshield/response'
@@ -14,6 +14,8 @@ require 'tshield/response'
 module TShield
   # Module to write and read saved responses
   class RequestVCR < TShield::Request
+    attr_reader :vcr_response
+
     def initialize(path, options = {})
       super()
       @path = path
@@ -35,27 +37,31 @@ module TShield
         _method, @url, @options = filter.new.filter(method, @url, @options)
       end
 
-      if exists
-        response.original = false
-        resp = response
+      in_session = find_in_sessions
+      if in_session
+        # TODO: create concept of global session in vcr
+        in_session = nil if in_session == 'global'
+        @vcr_response = response(in_session)
+        @vcr_response.original = false
       else
+        TShield.logger.info("calling original service for request with options #{@options}")
         raw = HTTParty.send(method.to_s, @url, @options)
 
         original_response = save(raw)
         original_response.original = true
-        resp = original_response
+        @vcr_response = original_response
       end
 
       configuration.get_after_filters(domain).each do |filter|
-        resp = filter.new.filter(resp)
+        @vcr_response = filter.new.filter(@vcr_response)
       end
-      resp
     end
 
-    def response
-      @response ||= TShield::Response.new(saved_content['body'],
-                                          saved_content['headers'] || [],
-                                          saved_content['status'] || 200)
+    def response(session)
+      response_content = saved_content(session)
+      TShield::Response.new(response_content['body'],
+                            response_content['headers'] || [],
+                            response_content['status'] || 200)
     end
 
     private
@@ -89,20 +95,27 @@ module TShield
       TShield::Response.new(raw_response.body, headers, raw_response.code)
     end
 
-    def saved_content
-      return @saved_content if @saved_content
-
-      @saved_content = JSON.parse(File.open(headers_destiny).read)
-      @saved_content['body'] = File.open(content_destiny).read unless @saved_content['body']
-      @saved_content
+    def saved_content(session)
+      content = JSON.parse(File.open(headers_destiny(session)).read)
+      content['body'] = File.open(content_destiny(session)).read unless content['body']
+      content
     end
 
-    def file_exists
-      File.exist?(content_destiny)
+    def file_exists(session)
+      File.exist?(content_destiny(session))
     end
 
-    def exists
-      file_exists && configuration.cache_request?(domain)
+    def find_in_sessions
+      in_session = nil
+
+      ([@options[:session]] + (@options[:secondary_sessions] || [])).each do |session|
+        if file_exists(session) && configuration.cache_request?(domain)
+          in_session = (session || 'global')
+          break
+        end
+        TShield.logger.info("saved response not found in #{session}")
+      end
+      in_session
     end
 
     def key

data/lib/tshield/sessions.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+require 'tshield/logger'
 require 'tshield/counter'
+require 'tshield/errors'
 
 module TShield
   # Manage sessions
@@ -9,7 +11,11 @@ module TShield
   module Sessions
     def self.start(ip, name)
       TShield.logger.info("starting session #{name} for ip #{normalize_ip(ip)}")
-      sessions[normalize_ip(ip)] = { name: name, counter: TShield::Counter.new }
+      sessions[normalize_ip(ip)] = {
+        name: name,
+        counter: TShield::Counter.new,
+        secondary_sessions: []
+      }
     end
 
     def self.stop(ip)
@@ -22,6 +28,16 @@ module TShield
       sessions[normalize_ip(ip)]
     end
 
+    def self.append(ip, name)
+      TShield.logger.info("appeding session #{name} for ip #{normalize_ip(ip)}")
+
+      current_session = sessions[normalize_ip(ip)]
+      raise AppendSessionWithoutMainSessionError, "not found main session for #{ip}" unless current_session
+
+      current_session[:secondary_sessions] << name
+      current_session
+    end
+
     def self.sessions
       @sessions ||= {}
     end

data/lib/tshield/version.rb

@@ -5,7 +5,7 @@ module TShield
   class Version
     MAJOR = 0
     MINOR = 11
-    PATCH = 19
+    PATCH = 20
     PRE = 0
 
     class << self

data/spec/tshield/fixtures/matching/example.json

@@ -99,5 +99,17 @@
         "body": "body content in session"
       }
     }]
+  },
+  {
+    "session": "second-session",
+    "stubs": [{
+      "method": "GET",
+      "path": "/matching/second-example",
+      "response": {
+        "status": 200,
+        "headers": {},
+        "body": "body content in second-session"
+      }
+    }]
   }
 ]

data/spec/tshield/request_matching_spec.rb

@@ -235,6 +235,18 @@ describe TShield::RequestMatching do
           expect(@response.headers).to eql({})
           expect(@response.status).to eql(201)
         end
+        context 'with secondary session' do
+          it 'should return response object from session settings' do
+            @request_matching = TShield::RequestMatching.new('/matching/second-example',
+                                                             method: 'GET',
+                                                             session: 'a-session',
+                                                             secondary_sessions: ['second-session'])
+            @response = @request_matching.match_request
+            expect(@response.body).to eql('body content in second-session')
+            expect(@response.headers).to eql({})
+            expect(@response.status).to eql(200)
+          end
+        end
       end
     end
   end

data/spec/tshield/sessions_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'tshield/sessions'
+require 'spec_helper'
+
+describe TShield::Sessions do
+  context 'on append session' do
+    it 'should raise error if not has a main session' do
+      expect { TShield::Sessions.append 'ip', 'secondary-session' }
+        .to raise_error(AppendSessionWithoutMainSessionError)
+    end
+    it 'should append if has main session' do
+      TShield::Sessions.start 'ip', 'main-session'
+      result = TShield::Sessions.append 'ip', 'secondary-session'
+      expect(result[:secondary_sessions]).to include('secondary-session')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tshield
 version: !ruby/object:Gem::Version
-  version: 0.11.19.0
+  version: 0.11.20.0
 platform: ruby
 authors:
 - Diego Rubin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -426,6 +426,7 @@ files:
 - lib/tshield/controllers/requests.rb
 - lib/tshield/controllers/sessions.rb
 - lib/tshield/counter.rb
+- lib/tshield/errors.rb
 - lib/tshield/extensions/string_extensions.rb
 - lib/tshield/grpc.rb
 - lib/tshield/grpc/vcr.rb
@@ -452,6 +453,7 @@ files:
 - spec/tshield/options_spec.rb
 - spec/tshield/request_matching_spec.rb
 - spec/tshield/request_vcr_spec.rb
+- spec/tshield/sessions_spec.rb
 - tshield.gemspec
 homepage: https://github.com/diegorubin/tshield
 licenses:
@@ -481,6 +483,7 @@ test_files:
 - spec/tshield/request_matching_spec.rb
 - spec/tshield/grpc_spec.rb
 - spec/tshield/configuration_spec.rb
+- spec/tshield/sessions_spec.rb
 - spec/tshield/request_vcr_spec.rb
 - spec/tshield/controllers/requests_spec.rb
 - spec/tshield/options_spec.rb