tshield 0.13.2.0 → 0.13.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87b26d114e278df9af5848487fbe41a5783b69e9
-  data.tar.gz: 36fd3d713a4c30d82631d7141c83154c90659281
+  metadata.gz: ff8ebc5fc00636cb1f4a14e64c431db07fc5b018
+  data.tar.gz: 2a3931e85a3869b2f39b19512352117bf664c750
 SHA512:
-  metadata.gz: 5bd5f43cc13647026b199ad55ab149b842d6bbedae8dcfccb9a345dcc99abb72c132641ede6cd80bff36bd7e5e9123deb8dde882c4573b2d441a8c9c3e430df9
-  data.tar.gz: 956d0f30dcf1c57ba98e3488deb0d8d80367c8c5ffa6c5b6c383eed282bf17f679463df5403e93ba17033ca1dcb8bfc69afe3deeff778a44b9431b47089c7f47
+  metadata.gz: 2d6affb50388b0f3e39b13806c5079c19f708a9d62f6bff8b89f70c21ec02ff19b33e9f635b6aee9398525bea000bfbd6efa1aed3f3de1f5b5279c6a0c2761d7
+  data.tar.gz: 7c3646904d2f38a5f4d608b9f76e3355c26e311eb2ac2518d09eb5e4a139bdddc506a41ce0078b395dddf551c775e7b654a00a15e8de9734ac97033772de90d3

data/README.md

@@ -192,6 +192,7 @@ domains:
     headers:
       HTTP_AUTHORIZATION: Authorization
       HTTP_COOKIE: Cookie
+    send_header_content_type: true  
     not_save_headers:
       - transfer-encoding
     cache_request: <<value>>
@@ -235,6 +236,7 @@ domains:
 *   Define Base URI of service
 *   **name**: Name to identify the domain in the generated files
 *   **headers**: github-issue #17
+*   **send_header_content_type**: Boolean domain config to send header 'Content-Type' when requesting this domain  
 *   **not_save_headers**: List of headers that should be ignored in generated file
 *   **skip_query_params**: List of query params that should be ignored in generated file
 *   **cache_request**: <<some_description>>

data/lib/tshield/configuration.rb

@@ -100,6 +100,11 @@ module TShield
       domains[domain]['not_save_headers'] || []
     end
 
+    def send_header_content_type(domain)
+      return domains[domain]['send_header_content_type'] != false if domains[domain]
+      true
+    end
+
     def read_session_path
       session_path || '/sessions'
     end

data/lib/tshield/controllers/requests.rb

@@ -57,6 +57,8 @@ module TShield
             ip: request.ip
           }
 
+          treat_headers_by_domain(options, path)
+
           if %w[POST PUT PATCH].include? method
             result = request.body.read.encode('UTF-8',
                                               invalid: :replace,
@@ -74,7 +76,7 @@ module TShield
               configuration.get_excluded_headers(domain(path)).include?(key)
             end
           end
-          
+
           logger.info(
             "original=#{api_response.original} method=#{method} path=#{path} "\
             "content-type=#{request_content_type} "\
@@ -94,6 +96,11 @@ module TShield
           end
         end
 
+        def treat_headers_by_domain(options, path)
+          @send_header_content_type = configuration.send_header_content_type(domain(path))
+          options[:headers].delete('Content-Type') unless @send_header_content_type
+        end
+
         def configuration
           @configuration ||= TShield::Configuration.singleton
         end

data/lib/tshield/version.rb

@@ -5,7 +5,7 @@ module TShield
   class Version
     MAJOR = 0
     MINOR = 13
-    PATCH = 2
+    PATCH = 3
     PRE = 0
 
     class << self

data/spec/tshield/configuration_spec.rb

@@ -108,14 +108,42 @@ describe TShield::Configuration do
 
   context 'on config exists without grpc entry' do
     before :each do
-      options_instance = double
-      allow(options_instance).to receive(:configuration_file)
-        .and_return('spec/tshield/fixtures/config/tshield-without-grpc.yml')
-      allow(TShield::Options).to receive(:instance).and_return(options_instance)
-      @configuration = TShield::Configuration.singleton
+      @configuration = generate_configuration_from_file('spec/tshield/fixtures/config/tshield-without-grpc.yml')
+      TShield::Configuration.clear
     end
     it 'should set default value for port' do
       expect(@configuration.grpc).to eql('port' => 5678, 'proto_dir' => 'proto', 'services' => {})
     end
   end
+
+  context 'on config property request.domains.domain.send_header_content_type does not exists' do
+    before :each do
+      @configuration = generate_configuration_from_file('spec/tshield/fixtures/config/tshield-without-grpc.yml')
+      TShield::Configuration.clear
+    end
+    it 'should return send_header_content_type as true when property is not set' do
+      expect(@configuration.send_header_content_type('example.org')).to be true
+    end
+  end
+
+  context 'on config property request.domains.domain.send_header_content_type does exists' do
+    before :each do
+      TShield::Configuration.clear
+    end
+    it 'should return send_header_content_type as true when property is true' do
+      @configuration = generate_configuration_from_file('spec/tshield/fixtures/config/tshield-with-send-content-type-header.yml')
+      expect(@configuration.send_header_content_type('example.org')).to be true
+    end
+    it 'should return send_header_content_type as false when property is false' do
+      @configuration = generate_configuration_from_file('spec/tshield/fixtures/config/tshield-with-send-content-type-header_as_false.yml')
+      expect(@configuration.send_header_content_type('example.org')).to be false
+    end
+  end
+end
+
+def generate_configuration_from_file(file)
+  options_instance = double
+  allow(options_instance).to receive(:configuration_file).and_return(file)
+  allow(TShield::Options).to receive(:instance).and_return(options_instance)
+  TShield::Configuration.singleton
 end

data/spec/tshield/controllers/requests_spec.rb

@@ -58,3 +58,95 @@ describe TShield::Controllers::Requests do
     end
   end
 end
+
+describe TShield::Controllers::Requests do
+  before :each do
+    @configuration = double
+    allow(TShield::Configuration)
+      .to receive(:singleton).and_return(@configuration)
+    allow(@configuration).to receive(:get_before_filters).and_return([])
+    allow(@configuration).to receive(:not_save_headers).and_return([])
+    allow(@configuration).to receive(:get_after_filters).and_return([])
+    allow(@configuration).to receive(:get_headers).and_return([])
+    allow(@configuration).to receive(:request).and_return('timeout' => 10)
+    allow(@configuration).to receive(:get_name).and_return('example.org')
+    allow(@configuration).to receive(:get_domain_for).and_return('example.org')
+    allow(@configuration).to receive(:get_delay).and_return(0)
+
+
+    allow(TShield::Options).to receive_message_chain(:instance, :break?)
+    @mock_logger = double
+    @controller = MockController.new(@mock_logger)
+  end
+  context 'when send_header_content_type is false for a single domain' do
+    it 'should remove application/json header when making a request' do
+      params = { 'captures' => ['/'] }
+      request = double
+      matcher = double
+      matched_response = double
+
+      allow(@configuration).to receive(:send_header_content_type).and_return(false)
+      allow(request).to receive(:request_method).and_return('GET')
+      allow(request).to receive(:content_type).and_return('application/json')
+      allow(request).to receive(:ip).and_return('0.0.0.0')
+      allow(request).to receive(:env).and_return('QUERY_STRING' => 'a=b')
+      allow(TShield::RequestMatching).to receive(:new).and_return(matcher)
+      allow(matcher).to receive(:match_request).and_return(nil)
+      allow(TShield::RequestVCR).to receive(:new).and_return(matcher)
+      allow(matcher).to receive(:vcr_response).and_return(matched_response)
+      allow(matched_response).to receive(:original).and_return(false)
+      allow(matched_response).to receive(:status).and_return(200)
+      allow(matched_response).to receive(:headers).and_return({})
+      allow(matched_response).to receive(:body).and_return('')
+      allow(@mock_logger).to receive(:info)
+
+      expect(TShield::RequestVCR).to receive(:new).with("/",{
+        call: 0,
+        headers: {},
+        ip: "0.0.0.0",
+        method: "GET",
+        raw_query: "a=b",
+        secondary_sessions: nil,
+        session: nil
+      })
+      @controller.treat(params, request, nil)
+    end
+  end
+
+  context 'when send_header_content_type is true for a single domain' do
+    it 'should NOT remove application/json header when making a request' do
+      params = { 'captures' => ['/'] }
+      request = double
+      matcher = double
+      matched_response = double
+
+      allow(@configuration).to receive(:send_header_content_type).and_return(true)
+      allow(request).to receive(:request_method).and_return('GET')
+      allow(request).to receive(:content_type).and_return('application/json')
+      allow(request).to receive(:ip).and_return('0.0.0.0')
+      allow(request).to receive(:env).and_return('QUERY_STRING' => 'a=b')
+      allow(TShield::RequestMatching).to receive(:new).and_return(matcher)
+      allow(matcher).to receive(:match_request).and_return(nil)
+      allow(TShield::RequestVCR).to receive(:new).and_return(matcher)
+      allow(matcher).to receive(:vcr_response).and_return(matched_response)
+      allow(matched_response).to receive(:original).and_return(false)
+      allow(matched_response).to receive(:status).and_return(200)
+      allow(matched_response).to receive(:headers).and_return({})
+      allow(matched_response).to receive(:body).and_return('')
+      allow(@mock_logger).to receive(:info)
+
+      expect(TShield::RequestVCR).to receive(:new).with("/",{
+        call: 0,
+        headers: {'Content-Type' => 'application/json'},
+        ip: "0.0.0.0",
+        method: "GET",
+        raw_query: "a=b",
+        secondary_sessions: nil,
+        session: nil
+      })
+
+
+      @controller.treat(params, request, nil)
+    end
+  end
+end

data/spec/tshield/fixtures/config/tshield-with-send-content-type-header.yml

@@ -0,0 +1,18 @@
+---
+request:
+  timeout: 0
+domains:
+  'example.org':
+    name: 'example.org'
+    send_header_content_type: true
+    filters:
+      - 'ExampleFilter'
+    paths:
+      - '/api/one'
+      - '/api/two'
+    skip_query_params:
+      - 'a'
+  'example.com':
+    name: 'example.com'
+    paths:
+      - '/api/three'

data/spec/tshield/fixtures/config/tshield-with-send-content-type-header_as_false.yml

@@ -0,0 +1,18 @@
+---
+request:
+  timeout: 0
+domains:
+  'example.org':
+    name: 'example.org'
+    send_header_content_type: false
+    filters:
+      - 'ExampleFilter'
+    paths:
+      - '/api/one'
+      - '/api/two'
+    skip_query_params:
+      - 'a'
+  'example.com':
+    name: 'example.com'
+    paths:
+      - '/api/three'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tshield
 version: !ruby/object:Gem::Version
-  version: 0.13.2.0
+  version: 0.13.3.0
 platform: ruby
 authors:
 - Diego Rubin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -430,6 +430,8 @@ files:
 - spec/tshield/after_filter_spec.rb
 - spec/tshield/configuration_spec.rb
 - spec/tshield/controllers/requests_spec.rb
+- spec/tshield/fixtures/config/tshield-with-send-content-type-header.yml
+- spec/tshield/fixtures/config/tshield-with-send-content-type-header_as_false.yml
 - spec/tshield/fixtures/config/tshield-without-grpc.yml
 - spec/tshield/fixtures/config/tshield.yml
 - spec/tshield/fixtures/filters/example_filter.rb
@@ -467,16 +469,18 @@ specification_version: 4
 summary: Proxy for mocks API responses
 test_files:
 - spec/spec_helper.rb
+- spec/tshield/sessions_spec.rb
+- spec/tshield/configuration_spec.rb
+- spec/tshield/controllers/requests_spec.rb
 - spec/tshield/fixtures/matching/example.json
-- spec/tshield/fixtures/config/tshield-without-grpc.yml
+- spec/tshield/fixtures/proto/test_services_pb.rb
+- spec/tshield/fixtures/config/tshield-with-send-content-type-header.yml
+- spec/tshield/fixtures/config/tshield-with-send-content-type-header_as_false.yml
 - spec/tshield/fixtures/config/tshield.yml
+- spec/tshield/fixtures/config/tshield-without-grpc.yml
 - spec/tshield/fixtures/filters/example_filter.rb
-- spec/tshield/fixtures/proto/test_services_pb.rb
-- spec/tshield/options_spec.rb
-- spec/tshield/configuration_spec.rb
-- spec/tshield/sessions_spec.rb
-- spec/tshield/request_matching_spec.rb
-- spec/tshield/controllers/requests_spec.rb
 - spec/tshield/grpc_spec.rb
-- spec/tshield/request_vcr_spec.rb
 - spec/tshield/after_filter_spec.rb
+- spec/tshield/request_vcr_spec.rb
+- spec/tshield/request_matching_spec.rb
+- spec/tshield/options_spec.rb