tshield 0.11.5.0 → 0.11.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7581fed92c9b0af76120edc8d9a4b9eff62e1f37c8eafa6a33a5712e918382d6
-  data.tar.gz: '018a8ca426a9af1bc6e374461e6f4748673cecf24358b332fd6c30a5ec433028'
+  metadata.gz: c640cd371996f18c70873cdb29f9ebddd56feec72a2a28f97ab12e8c2dea7c79
+  data.tar.gz: db3eafdb27d4b6c6aa7b5f3ccd8480f045f8629beaf61ac431e6d038d8bf3dd2
 SHA512:
-  metadata.gz: 8afb34fe21d6e9d8813c46c42e2c8d64908d9f72badd51bd11e1c92ea4b37b23e159cc03f2ad85932cceda146446db351f32b3167f5a52200df5af8df7cbaf59
-  data.tar.gz: 5bf25b51e864b9f4b89a05158e5532582f86f21ceca0e24e2dafce2c2eb37235867686ecd8514ee6cecc061f4dd3247d83113f11f24eca25b89e9027103a1519
+  metadata.gz: '08a7fa0ab19a76dfbd9f1c262836c5c6e67b2c5ea85db39271162ccce204291e08a27962327f2e95c5921f696c3cfb6cdc541d69eaa8f441af994d63c7246053'
+  data.tar.gz: b8c45e92156a2f1fcbd2016338eaa9aa424edecff1b6248bb11c0cabc747f58ff82012d6fd048dc548825b6b46c208b8ed0bbb2b96a27036c6ce9bdf4accf413

data/README.md

@@ -2,6 +2,7 @@ TShield
 =======
 
 [![Build Status](https://travis-ci.org/diegorubin/tshield.svg)](https://travis-ci.org/diegorubin/tshield)
+[![Coverage Status](https://coveralls.io/repos/github/diegorubin/tshield/badge.svg?branch=master)](https://coveralls.io/github/diegorubin/tshield?branch=master)
 [![SourceLevel](https://app.sourcelevel.io/github/diegorubin/tshield.svg)](https://app.sourcelevel.io/github/diegorubin/tshield)
 [![Join the chat at https://gitter.im/diegorubin/tshield](https://badges.gitter.im/diegorubin/tshield.svg)](https://gitter.im/diegorubin/tshield?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Gem Version](https://badge.fury.io/rb/tshield.svg)](https://badge.fury.io/rb/tshield)
@@ -15,6 +16,17 @@ TShield is an open source proxy for mocks API responses.
 * 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)
+    
 ## Basic Usage
 ### Install
 
@@ -26,7 +38,7 @@ To run server execute this command
 
     tshield
     
-Default port is **4567**
+Default port is `4567`
 
 #### Command Line Options
 
@@ -65,7 +77,7 @@ at least the following attributes:
 
 * __method__: a http method.
 * __path__: url path.
-* __response__: object with response data.
+* __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)
 
 Response must be contain the following attributes:
 
@@ -201,6 +213,7 @@ domains:
 * **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>>
@@ -265,9 +278,12 @@ end
 Description of some tshield features can be found in the features directory.
 This features files are used as base for the component tests.
 
-## Samples
-#### Basic sample for a client app requesting a server API
+## Examples
+#### Basic example for a client app requesting an API
 [examples/client-api-nodejs](examples/client-api-nodejs)
 
+#### Basic example for component/acceptance test
+**[WIP]**
+
 ## Contributing
-[Hacking or Contributing to Tshield](CONTRIBUTING.md)
+[Hacking or Contributing to TShield](CONTRIBUTING.md)

data/lib/tshield/configuration.rb

@@ -31,6 +31,7 @@ module TShield
     attr_reader :request
     attr_reader :domains
     attr_reader :tcp_servers
+    attr_reader :session_path
 
     def initialize(attributes)
       attributes.each { |key, value| instance_variable_set("@#{key}", value) }
@@ -57,9 +58,8 @@ module TShield
 
     def get_domain_for(path)
       domains.each do |url, config|
-        config['paths'].each do |pattern|
-          return url if path =~ Regexp.new(pattern)
-        end
+        result = self.class.get_url_for_domain_by_path(path, config)
+        return url if result
       end
       nil
     end
@@ -99,8 +99,12 @@ module TShield
       domains[domain]['not_save_headers'] || []
     end
 
-    def session_path
-      @session_path || '/sessions'
+    def read_session_path
+      session_path || '/sessions'
+    end
+
+    def self.get_url_for_domain_by_path(path, config)
+      config['paths'].select { |pattern| path =~ Regexp.new(pattern) }[0]
     end
 
     def self.read_configuration_file(config_path)

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

@@ -7,7 +7,17 @@ module TShield
       module SessionHelpers
         def self.current_session_name(request)
           session = TShield::Sessions.current(request.ip)
-          session ? session[:name] : 'no-session'
+          session[:name] if session
+        end
+
+        def self.current_session_call(request, path, method)
+          session = TShield::Sessions.current(request.ip)
+          session ? session[:counter].current(path, method) : 0
+        end
+
+        def self.update_session_call(request, path, method)
+          session = TShield::Sessions.current(request.ip)
+          session[:counter].add(path, method) if session
         end
       end
     end

data/lib/tshield/controllers/requests.rb

@@ -59,12 +59,15 @@ module TShield
           method = request.request_method
           request_content_type = request.content_type
           session_name = TShield::Controllers::Helpers::SessionHelpers.current_session_name(request)
+          session_call = TShield::Controllers::Helpers::SessionHelpers
+                         .current_session_call(request, path, method)
 
           options = {
             method: method,
             headers: Helpers.build_headers(request),
             raw_query: request.env['QUERY_STRING'],
             session: session_name,
+            call: session_call,
             ip: request.ip
           }
 
@@ -75,12 +78,12 @@ module TShield
                                               replace: '')
             options[:body] = result
           end
-          api_response = TShield::RequestMatching.new(path, options).match_request
+          api_response = TShield::RequestMatching.new(path, options.clone).match_request
 
           unless api_response
             add_headers(headers, path)
 
-            api_response ||= TShield::RequestVCR.new(path, options).response
+            api_response ||= TShield::RequestVCR.new(path, options.clone).response
             api_response.headers.reject! do |key, _v|
               configuration.get_excluded_headers(domain(path)).include?(key)
             end
@@ -89,8 +92,9 @@ module TShield
           logger.info(
             "original=#{api_response.original} method=#{method} path=#{path} "\
             "content-type=#{request_content_type} "\
-            "session=#{session_name}"
+            "session=#{session_name} call=#{session_call}"
           )
+          TShield::Controllers::Helpers::SessionHelpers.update_session_call(request, path, method)
 
           status api_response.status
           headers api_response.headers

data/lib/tshield/controllers/sessions.rb

@@ -10,7 +10,7 @@ module TShield
     # Actions to handle sessions
     module Sessions
       def self.registered(app)
-        session_path = TShield::Configuration.singleton.session_path
+        session_path = TShield::Configuration.singleton.read_session_path
         register_get(app, session_path)
         register_post(app, session_path)
         register_delete(app, session_path)

data/lib/tshield/request.rb

@@ -6,7 +6,6 @@ module TShield
   # Base of request mock methods
   class Request
     attr_reader :configuration
-    attr_writer :content_idx
 
     def initialize
       @configuration = TShield::Configuration.singleton
@@ -14,15 +13,11 @@ module TShield
 
     protected
 
-    def current_session
-      TShield::Sessions.current(@options[:ip])
-    end
-
     def session_destiny(request_path)
-      session = current_session
+      session = @options[:session]
       return request_path unless session
 
-      request_path = File.join(request_path, session[:name])
+      request_path = File.join(request_path, session)
       Dir.mkdir(request_path) unless File.exist?(request_path)
       request_path
     end
@@ -52,7 +47,7 @@ module TShield
       method_path = File.join(path_path, method)
       Dir.mkdir(method_path) unless File.exist?(method_path)
 
-      File.join(method_path, @content_idx.to_s)
+      File.join(method_path, @options[:call].to_s)
     end
 
     def clear_path(path)
@@ -67,9 +62,5 @@ module TShield
 
       [url_path, cleared_params].join('?')
     end
-
-    def method
-      @options[:method].downcase
-    end
   end
 end

data/lib/tshield/request_matching.rb

@@ -27,11 +27,19 @@ module TShield
       @matched = find_stub(self.class.stubs)
       return unless matched
 
+      @matched = current_response
+
       TShield::Response.new(self.class.read_body(matched['body']),
                             matched['headers'],
                             matched['status'])
     end
 
+    def current_response
+      return matched[@options[:call]] if matched.is_a? Array
+
+      matched
+    end
+
     class << self
       attr_reader :stubs
 

data/lib/tshield/request_vcr.rb

@@ -14,8 +14,6 @@ require 'tshield/response'
 module TShield
   # Module to write and read saved responses
   class RequestVCR < TShield::Request
-    attr_reader :response
-
     def initialize(path, options = {})
       super()
       @path = path
@@ -28,33 +26,35 @@ module TShield
     end
 
     def request
-      unless @options[:raw_query].nil? || @options[:raw_query].empty?
-        @path = "#{@path}?#{@options[:raw_query]}"
-      end
+      raw_query = @options[:raw_query]
+      @path = "#{@path}?#{raw_query}" unless !raw_query || raw_query.empty?
 
       @url = "#{domain}#{@path}"
 
       if exists
-        @response = current_response
-        @response.original = false
+        response.original = false
+        response
       else
-        @method = method
         configuration.get_before_filters(domain).each do |filter|
-          @method, @url, @options = filter.new.filter(@method, @url, @options)
+          _method, @url, @options = filter.new.filter(method, @url, @options)
         end
 
-        raw = HTTParty.send(@method.to_s, @url, @options)
+        raw = HTTParty.send(method.to_s, @url, @options)
 
         configuration.get_after_filters(domain).each do |filter|
           raw = filter.new.filter(raw)
         end
 
-        @response = save(raw)
-
-        @response.original = true
+        original_response = save(raw)
+        original_response.original = true
+        original_response
       end
-      current_session[:counter].add(@path, method) if current_session
-      @response
+    end
+
+    def response
+      @response ||= TShield::Response.new(saved_content['body'],
+                                          saved_content['headers'] || [],
+                                          saved_content['status'] || 200)
     end
 
     private
@@ -67,6 +67,10 @@ module TShield
       @name ||= configuration.get_name(domain)
     end
 
+    def method
+      @method ||= @options[:method].downcase
+    end
+
     def save(raw_response)
       headers = {}
       raw_response.headers.each do |k, v|
@@ -93,8 +97,6 @@ module TShield
     end
 
     def file_exists
-      session = current_session
-      @content_idx = session ? session[:counter].current(@path, method) : 0
       File.exist?(content_destiny)
     end
 
@@ -102,12 +104,6 @@ module TShield
       file_exists && configuration.cache_request?(domain)
     end
 
-    def current_response
-      TShield::Response.new(saved_content['body'],
-                            saved_content['headers'] || [],
-                            saved_content['status'] || 200)
-    end
-
     def key
       @key ||= Digest::SHA1.hexdigest "#{@url}|#{method}"
     end

data/lib/tshield/version.rb

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

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: false
 
+require 'coveralls'
+Coveralls.wear!
+
 require 'bundler/setup'
 Bundler.setup
 

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

@@ -53,6 +53,23 @@
       "body": "post content"
     }
   },
+  {
+    "method": "GET",
+    "path": "/matching/twice",
+    "response": [{
+      "status": 200,
+      "headers": {
+        "try": 1
+      },
+      "body": "first call"
+    }, {
+      "status": 201,
+      "headers": {
+        "try": 2
+      },
+      "body": "second call"
+    }]
+  },
   {
     "session": "a-session",
     "stubs": [{

data/spec/tshield/request_matching_spec.rb

@@ -128,6 +128,31 @@ describe TShield::RequestMatching do
           expect(@response.status).to eql(200)
         end
       end
+      context 'on match have multiples responses' do
+        before :each do
+          @responses = []
+          2.times.each do |time|
+            @responses << TShield::RequestMatching
+                          .new('/matching/twice',
+                               method: 'GET',
+                               call: time).match_request
+          end
+        end
+
+        it 'should return response object in first call' do
+          response = @responses[0]
+          expect(response.body).to eql('first call')
+          expect(response.headers).to eql('try' => 1)
+          expect(response.status).to eql(200)
+        end
+
+        it 'should return response object in second call' do
+          response = @responses[1]
+          expect(response.body).to eql('second call')
+          expect(response.headers).to eql('try' => 2)
+          expect(response.status).to eql(201)
+        end
+      end
       context 'on not match' do
         before :each do
           @request_matching = TShield::RequestMatching.new('/')

data/spec/tshield/request_vcr_spec.rb

@@ -80,7 +80,8 @@ describe TShield::RequestVCR do
 
         TShield::RequestVCR.new '/',
                                 raw_query: 'allowed=true&skipped=1',
-                                method: 'GET'
+                                method: 'GET',
+                                call: 0
       end
     end
   end

data/tshield.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
   s.add_dependency('httparty', '~> 0.14', '>= 0.14.0')
   s.add_dependency('json', '~> 2.0', '>= 2.0')
   s.add_dependency('sinatra', '~> 1.4', '>= 1.4.0')
+  s.add_development_dependency('coveralls')
   s.add_development_dependency('cucumber', '~> 3.1', '>= 3.1.2')
   s.add_development_dependency('guard', '~> 2.15', '>= 2.15.0')
   s.add_development_dependency('guard-rspec', '~> 4.7', '>= 4.7.3')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tshield
 version: !ruby/object:Gem::Version
-  version: 0.11.5.0
+  version: 0.11.6.0
 platform: ruby
 authors:
 - Diego Rubin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-06 00:00:00.000000000 Z
+date: 2019-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -111,6 +111,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement