tshield 0.11.7.0 → 0.11.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd161c62a3f2ed18d05c36ba7bacfff84a96f92fa7460d9702611af7ac60f33a
-  data.tar.gz: 046ff96f18c8504bce45c7cac21457b75fe46c6f836031279ec481e1e6a4a44c
+  metadata.gz: d2f5af220b6e8aed08b79c006af7975d48416a651c24345b30d20ac7db67e5ca
+  data.tar.gz: a1cc446bac420e431ec099b027c624e33bb5bcd8291605bdd6876d5aaa04b0b7
 SHA512:
-  metadata.gz: ce930e5ee1b0a6964c1e6a4255236fb4925fbc87779729aefdc594016a2d71d69afd2ad5b7ada1083314fb2eab8aefb9ce121181f44b2b2a0e957edf10a277bb
-  data.tar.gz: 585dc9bf34107431b2d93cfc46fe92ef2584f4614d0de9c82a41659f855e374a88cc441b4eedfabffa79aa1b4f17151594f98f4ef0daaa3f095a7ce688eef7de
+  metadata.gz: c4bcbfd8ce65cac9dfb6db41879f9237b6aa26b865b5fb9fee27423ea2352a81d5bf713812b2699d5656df933f2bfe96546ad5cd767b0177cf41226dfc7e2539
+  data.tar.gz: 18b671f8d124aa3237051ed9e516054ddb466510a192107c9016cdba8e11111d770e1603e788daa13218ec8f02dac13d73b14e6a4da7c19463805b0c9431758c

data/README.md

@@ -10,22 +10,22 @@ TShield
 ## API mocks for development and testing
 TShield is an open source proxy for mocks API responses.
 
-* REST
-* SOAP
-* Session manager to separate multiple scenarios (success, error, sucess variation, ...)
-* Lightweight
-* MIT license
+*   REST
+*   SOAP
+*   Session manager to separate multiple scenarios (success, error, sucess variation, ...)
+*   Lightweight
+*   MIT license
     
-#### Table of Contents:
-
-* [Basic Usage](#basic-usage)
-* [Config options for Pattern Matching](#config-options-for-pattern-matching)
-* [Config options for VCR](#config-options-for-vcr)
-* [Manage Sessions](#manage-sessions)
-* [Custom controllers](#custom-controllers)
-* [Features](#features)
-* [Examples](#examples)
-* [Contributing](#contributing)
+## Table of Contents
+
+*   [Basic Usage](#basic-usage)
+*   [Config options for Pattern Matching](#config-options-for-pattern-matching)
+*   [Config options for VCR](#config-options-for-vcr)
+*   [Manage Sessions](#manage-sessions)
+*   [Custom controllers](#custom-controllers)
+*   [Features](#features)
+*   [Examples](#examples)
+*   [Contributing](#contributing)
     
 ## Basic Usage
 ### Install
@@ -42,8 +42,8 @@ Default port is `4567`
 
 #### Command Line Options
 
-* __-port__: Overwrite default port (4567)
-* __-help__: Show all command line options
+*   **-port**: Overwrite default port (4567)
+*   **-help**: Show all command line options
 
 #### Config example
 
@@ -75,37 +75,38 @@ All files should be in `matching` directory.
 Each file should be a valid JSON array of objects and each object must contain
 at least the following attributes:
 
-* __method__: a http method.
-* __path__: url path.
-* __response__: object with response data. Into session can be used an array of objects to return different responses like vcr mode. See example: [multiples_response.json](https://github.com/diegorubin/tshield/blob/master/component_tests/matching/examples/multiple_response.json)
+*   **method**: a http method.
+*   **path**: url path. This attribute accept regex, see example in [regex.json](https://github.com/diegorubin/tshield/blob/master/component_tests/matching/examples/regex.json)
+*   **response**: object with response data. Into session can be used an array of objects to return different responses like vcr mode. See example: [multiples_response.json](https://github.com/diegorubin/tshield/blob/master/component_tests/matching/examples/multiple_response.json). External file can be used as body content, see example in [file.json](https://github.com/diegorubin/tshield/blob/master/component_tests/matching/examples/file.json).
 
 Response must be contain the following attributes:
 
-* __headers__: key value object with expected headers to match. In the evaluation process
-  this stub will be returned if all headers are in request. 
-* __status__: integer used http status respose.
-* __body__: content to be returned.
+*   **headers**: key value object with expected headers to match. In the evaluation process
+this stub will be returned if all headers are in request. 
+*   **status**: integer used http status respose.
+*   **body**: content to be returned.
 
 Optional request attributes:
 
-* __headers__: key value object with expected headers to match. In the evaluation process
-  this stub will be returned if all headers are in request. 
-* __query__: works like headers but use query params.
+*   **headers**: key value object with expected headers to match. In the evaluation process
+this stub will be returned if all headers are in request. 
+*   **query**: works like headers but use query params.
 
-__Important__: If VCR config conflicts with Matching config Matching will be
+**Important**: If VCR config conflicts with Matching config Matching will be
 used. Matching config have priority.
 
 ### Session Configuration
 
 To register stub into a session create an object with following attributes:
 
-* __session__: name of session.
-* __stubs__: an array with objects described above.
+*   **session**: name of session.
+*   **stubs**: an array with objects described above.
 
 ### Example of matching configuration
 
 ```json
-[{
+[
+  {
     "method": "GET",
     "path": "/matching/example",
     "query": {
@@ -205,19 +206,19 @@ domains:
       - /users
 ```
 **request**
-* **timeout**: wait time for real service in seconds
-* **verify_ssl**: ignores invalid ssl if false
+*   **timeout**: wait time for real service in seconds
+*   **verify_ssl**: ignores invalid ssl if false
 
 **domain**
-* Define Base URI of service
-* **name**: Name to identify the domain in the generated files
-* **headers**: github-issue #17
-* **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>>
-* **filters**: Implementation of before or after filters used in domain requests
-* **excluded_headers**: <<some_description>>
-* **paths**: Paths list of all services that will be called. Used to filter what domain will "receive the request"
+*   Define Base URI of service
+*   **name**: Name to identify the domain in the generated files
+*   **headers**: github-issue #17
+*   **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>>
+*   **filters**: Implementation of before or after filters used in domain requests
+*   **excluded_headers**: <<some_description>>
+*   **paths**: Paths list of all services that will be called. Used to filter what domain will "receive the request"
 
 ## Manage Sessions
 
@@ -282,8 +283,8 @@ This features files are used as base for the component tests.
 #### Basic example for a client app requesting an API
 [examples/client-api-nodejs](examples/client-api-nodejs)
 
-#### Basic example for component/acceptance test
-**[WIP]**
+#### Basic example for component/acceptance test using tshield sessions
+[examples/component-test](examples/component-test)
 
 ## Contributing
 [Hacking or Contributing to TShield](CONTRIBUTING.md)

data/lib/tshield.rb

@@ -5,5 +5,6 @@ require 'tshield/options'
 require 'tshield/simple_tcp_server'
 require 'tshield/server'
 
+# TShield: API mocks for development and testing
 module TShield
 end

data/lib/tshield/matching/filters.rb

@@ -23,8 +23,14 @@ module TShield
         stubs.select { |stub| Filters.include_query(stub['query'], @options[:raw_query] || '') }
       end
 
+      def filter_by_path(stubs)
+        stubs.each do |key, value|
+          return value if @path =~ /^#{key}$/
+        end
+      end
+
       def filter_stubs(stubs)
-        result = filter_by_query(filter_by_headers(filter_by_method(stubs[@path] || [])))
+        result = filter_by_query(filter_by_headers(filter_by_method(filter_by_path(stubs))))
         result[0]['response'] unless result.empty?
       end
 

data/lib/tshield/request_matching.rb

@@ -87,9 +87,14 @@ module TShield
 
       def read_body(content)
         return content.to_json if content.is_a? Hash
+        return read_file_content(content) if content =~ %r{^FILE://}
 
         content
       end
+
+      def read_file_content(content)
+        File.open(File.join('matching', content.gsub('FILE://', '')), 'r').read
+      end
     end
   end
 end

data/lib/tshield/version.rb

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

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

@@ -53,6 +53,24 @@
       "body": "post content"
     }
   },
+  {
+    "method": "GET",
+    "path": "/matching/file.txt",
+    "response": {
+      "status": 200,
+      "headers": {},
+      "body": "FILE://body.json"
+    }
+  },
+  {
+    "method": "GET",
+    "path": "/matching/regex/\\d+",
+    "response": {
+      "status": 200,
+      "headers": {},
+      "body": "stub with regex"
+    }
+  },
   {
     "method": "GET",
     "path": "/matching/twice",

data/spec/tshield/request_matching_spec.rb

@@ -160,6 +160,43 @@ describe TShield::RequestMatching do
           expect(response.status).to eql(200)
         end
       end
+      context 'on match have file reference' do
+        before :each do
+          request_matching = TShield::RequestMatching
+                             .new('/matching/file.txt',
+                                  method: 'GET')
+
+          file_content_double = double
+          allow(File).to receive(:join).with('matching', 'body.json')
+                                       .and_return('matching/body.json')
+          allow(File).to receive(:open).with('matching/body.json', 'r')
+                                       .and_return(file_content_double)
+
+          allow(file_content_double).to receive(:read).and_return("line1\nline2")
+
+          @response = request_matching.match_request
+        end
+
+        it 'should return content of file' do
+          expect(@response.body).to eql("line1\nline2")
+          expect(@response.headers).to eql({})
+          expect(@response.status).to eql(200)
+        end
+      end
+      context 'on match with regex' do
+        before :each do
+          @response = request_matching = TShield::RequestMatching
+                                         .new('/matching/regex/1234',
+                                              method: 'GET').match_request
+        end
+
+        it 'should return content of file' do
+          expect(@response.body).to eql('stub with regex')
+          expect(@response.headers).to eql({})
+          expect(@response.status).to eql(200)
+        end
+      end
+
       context 'on not match' do
         before :each do
           @request_matching = TShield::RequestMatching.new('/')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tshield
 version: !ruby/object:Gem::Version
-  version: 0.11.7.0
+  version: 0.11.8.0
 platform: ruby
 authors:
 - Diego Rubin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-08 00:00:00.000000000 Z
+date: 2019-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug