tshield 0.8.0.0 → 0.9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 21eb1813abe621fbbd5239e1b80aa3f0c3985aac
-  data.tar.gz: 63e502ed3dd6663f90befd4da0a97a91a62b7551
+SHA256:
+  metadata.gz: b2bb0faafe574abb4aae439e22b68758271aecc2db875e7075d43a327ee7bc3e
+  data.tar.gz: 818926f43b10948fa156028b758c5e9750fc3638c3f8f84c6cf102abe145d292
 SHA512:
-  metadata.gz: 7dddf275f556989113f2ab0be6fdc1a3ef431e2e223a5042eb734fcccf016d3a2c5d5bcd5d22e2f1eca70133f7f0aec5351d854eed681dd36e9d3c0f2d971496
-  data.tar.gz: f1795cd4c6da1c31904a45831d887d82b27affae09fca7794d7e2484e5f62b8133b495e098d6acc70f344cead810aa279d55dcb3a711a67cc507005a6bd8bc50
+  metadata.gz: 5fe988d83f69aa0d0053e928fc78c326ee7f08d08a39a6aea3aba4321289efe9e09c91be1f2c5d75e3e61c3202b5651256962c4ad7a66f001e39480e1f6dce92
+  data.tar.gz: 658b408f3fb7cd82d67278ac2c8569bd5b2801671630a72a6ca074089ea62ae28cd5f896c9994ff6ad02ee6dec00f3de2590819bee060587d8726efd511b2b63

data/Gemfile

@@ -1,4 +1,5 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-gemspec
+source 'https://rubygems.org'
 
+gemspec

data/README.md

@@ -1,17 +1,33 @@
 TShield
 =======
 
-## Install
+[![Build Status](https://travis-ci.org/diegorubin/tshield.svg)](https://travis-ci.org/diegorubin/tshield)
+[![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)
+
+## 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
+    
+## Basic Usage
+### Install
 
     gem install tshield
 
-## Using
+### Using
 
 To run server execute this command
 
     tshield
+    
+Default port is **4567**
+    
 
-### Config example
+#### Config example
 
 Before run `tshield` command is necessary to create config file.
 This is an example of `config/tshield.yml`
@@ -33,7 +49,93 @@ domains:
       - /users
 ```
 
-### Custom controllers
+## Config options
+```yaml
+request:
+  timeout: 8
+  verify_ssl: <<value>>
+domains:
+  'http://my-soap-service:80':
+    name: 'my-soap-service'
+    headers:
+      HTTP_AUTHORIZATION: Authorization
+      HTTP_COOKIE: Cookie
+    not_save_headers:
+      - transfer-encoding
+    cache_request: <<value>>
+    filters: 
+      - <<value>>
+    excluded_headers:
+      - <<value>>
+    paths:
+      - /Operation
+
+  'http://localhost:9090':
+    name: 'my-service'
+    headers:
+      HTTP_AUTHORIZATION: Authorization
+      HTTP_COOKIE: Cookie
+      HTTP_DOCUMENTID: DocumentId
+    not_save_headers:
+      - transfer-encoding
+    paths:
+      - /secure
+
+  'http://localhost:9092':
+    name: 'my-other-service'
+    headers:
+      HTTP_AUTHORIZATION: Authorization
+      HTTP_COOKIE: Cookie
+    not_save_headers:
+      - transfer-encoding
+    paths:
+      - /users
+```
+**request**
+* **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
+* **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
+
+You can use TShield sessions to separate multiple scenarios for your mocks
+
+By default TShield save request/response into 
+
+    requests/<<domain_name>>/<<resource_with_param>>/<<http_verb>>/<<index_based.content and json>>
+    
+If you start a session a folder with de **session_name** will be placed between **"requests/"** and **"<<domain_name>>"**
+
+### Start TShield session
+**Start new or existing session**
+
+_POST_ to http://localhost:4567/sessions?name=<<same_name>>
+
+```
+curl -X POST \
+  'http://localhost:4567/sessions?name=my_valid'
+```
+
+### Stop TShield session
+**Stop current session**
+
+_DELETE_ to http://localhost:4567/sessions
+
+```
+curl -X DELETE \
+  http://localhost:4567/sessions
+```
+
+## Custom controllers
 
 All custom controller should be created in `controllers` directory.
 
@@ -57,4 +159,45 @@ module FooController
 end
 ```
 
+## Features
+
+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/client-api-nodejs](examples/client-api-nodejs)
+#### Basic sample for componente/integration test
+**[WIP]**
+
+## Setup for local development
+
+First install dependencies.
+_We recommend use of the RVM to manage project dependencies.__
+
+```
+bundle install
+```
+
+### Run server to development
+
+To start server execute:
+
+`rake server`
+
+### Build
+
+To generate ruby gem execute:
+
+`rake build`
+
+### Test
+
+To run all unit tests:
+
+`rake spec`
+
+To run all component tests:
+
+`rake component__tests`
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -18,8 +20,17 @@ Bundler::GemHelper.install_tasks
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
-desc "Run all specs in spec directory (excluding plugin specs)"
+desc 'Run all specs in spec directory (excluding plugin specs)'
 RSpec::Core::RakeTask.new
 
-task :default => :spec
+task default: :spec
+
+task :component_tests do
+  $LOAD_PATH.unshift File.dirname('./lib/tshield.rb')
+  exec 'component_tests/run'
+end
 
+task :server do
+  $LOAD_PATH.unshift File.dirname('./lib/tshield.rb')
+  exec 'bin/tshield'
+end

data/bin/tshield

@@ -1,18 +1,18 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'tshield'
-
+require 'tshield/options'
 TShield::Options.init
 
-tshield = Thread.new {TShield::Server.run!}
+require 'tshield'
+tshield = Thread.new { TShield::Server.run! }
 
 configuration = TShield::Configuration.load_configuration
 (configuration.tcp_servers || []).each do |tcp_server|
   puts "initializing #{tcp_server['name']}"
   require "./servers/#{tcp_server['file']}"
-  klass = Object.const_get(tcp_server['name']) 
+  klass = Object.const_get(tcp_server['name'])
   Thread.new { klass.new.listen(tcp_server['port']) }
 end
 
 tshield.join
-

data/config/tshield.yml

@@ -0,0 +1,9 @@
+---
+request:
+  timeout: 8
+
+domains:
+  'https://service.com':
+    name: 'service'
+    paths:
+      - /users

data/lib/tshield/after_filter.rb

@@ -1,11 +1,12 @@
-module TShield
+# frozen_string_literal: true
 
+module TShield
   # Example:
   # def filter(response)
   #   response
   # end
   class AfterFilter
-    def filter(response)
+    def filter(_response)
       raise 'should implement method filter and returns response'
     end
   end

data/lib/tshield/before_filter.rb

@@ -1,11 +1,12 @@
-module TShield
+# frozen_string_literal: true
 
+module TShield
   # Example:
   # def filter(method, url, options)
   #   [method, url, options]
   # end
   class BeforeFilter
-    def filter(method, url, options)
+    def filter(_method, _url, _options)
       raise 'should implement method filter and returns method, url, options'
     end
   end

data/lib/tshield/configuration.rb

@@ -1,38 +1,63 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 require 'tshield/after_filter'
 require 'tshield/before_filter'
+require 'tshield/options'
+require 'tshield/logger'
 
 module TShield
+  # Class for read configuration file
   class Configuration
-
-    attr_accessor :request
-    attr_accessor :domains
-    attr_accessor :tcp_servers
-    attr_writer :session_path
+    # Configuration file
+    #
+    # Possible attributes
+    # request:
+    #   timeout: wait time for real service in seconds
+    #   verify_ssl: ignores invalid ssl if false
+    # domains:
+    #   'url':
+    #     name: Name to identify the domain in the generated files
+    #     headers: Object to translate received header in tshield to send to
+    #              original service. Sinatra change keys. Example:
+    #                HTTP_AUTHORIZATION should be mapped to Authorization
+    #                (NEED IMPROVEMENT github-issue #https://github.com/diegorubin/tshield/issues/17)
+    #     not_save_headers: List of headers that should be ignored in generated
+    #                       file
+    #
+    attr_reader :request
+    attr_reader :domains
+    attr_reader :tcp_servers
 
     def initialize(attributes)
-      attributes.each do |key, value|
-        send("#{key}=", value)
-      end
+      attributes.each { |key, value| instance_variable_set("@#{key}", value) }
 
-      if File.exists?('filters')
-        Dir.entries('filters').each do |entry|
-          next if entry =~ /^\.\.?$/
-          puts "loading filter #{entry}"
-          entry.gsub!('.rb', '')
-          require File.join('.', 'filters', entry)
-        end
+      return unless File.exist?('filters')
+
+      Dir.entries('filters').each do |entry|
+        next if entry =~ /^\.\.?$/
+
+        TShield.logger.info("loading filter #{entry}")
+        entry.gsub!('.rb', '')
+
+        require File.join('.', 'filters', entry)
       end
     end
 
     def self.singleton
-      @@configuration ||= load_configuration
+      @singleton ||= load_configuration
+    end
+
+    def self.clear
+      @singleton = nil
     end
 
     def get_domain_for(path)
       domains.each do |url, config|
-        config['paths'].each { |p| return url if path =~ Regexp.new(p) }
+        config['paths'].each do |pattern|
+          return url if path =~ Regexp.new(pattern)
+        end
       end
       nil
     end
@@ -42,27 +67,26 @@ module TShield
     end
 
     def get_name(domain)
-      domains[domain]['name'] || domain.gsub(/.*:\/\//, '')
+      domains[domain]['name'] || domain.gsub(%r{.*://}, '')
     end
 
     def get_before_filters(domain)
       get_filters(domain)
-        .select { |k| k.ancestors.include?(TShield::BeforeFilter) }
+        .select { |klass| klass.ancestors.include?(TShield::BeforeFilter) }
     end
 
     def get_after_filters(domain)
       get_filters(domain)
-        .select { |k| k.ancestors.include?(TShield::AfterFilter) }
+        .select { |klass| klass.ancestors.include?(TShield::AfterFilter) }
     end
 
     def cache_request?(domain)
-      return true unless domains[domain].include?('cache_request')
-      domains[domain]['cache_request']
+      domains[domain]['cache_request'] || true
     end
 
     def get_filters(domain)
       (domains[domain]['filters'] || [])
-        .collect { |f| Class.const_get(f) }
+        .collect { |filter| Class.const_get(filter) }
     end
 
     def get_excluded_headers(domain)
@@ -77,22 +101,19 @@ module TShield
       @session_path || '/sessions'
     end
 
-    def admin_session_path
-      @admin_session_path || '/admin/sessions'
-    end
-
-    def admin_request_path
-      @admin_request_path || '/admin/requests'
+    def self.read_configuration_file(config_path)
+      configs = YAML.safe_load(File.open(config_path).read)
+      Configuration.new(configs)
     end
 
-    private
     def self.load_configuration
-      config_path = File.join('config', 'tshield.yml')
-      file = File.open(config_path)
-      configs = YAML::load(file.read)
-      Configuration.new(configs)
+      configuration_file = TShield::Options.instance.configuration_file
+      read_configuration_file(configuration_file)
+    rescue Errno::ENOENT => e
+      TShield.logger.fatal(
+        "Load configuration file #{configuration_file} failed!\n#{e}"
+      )
+      raise 'Startup aborted'
     end
-
   end
 end
-

data/lib/tshield/controller.rb

@@ -1,29 +1,41 @@
+# frozen_string_literal: false
+
 require 'sinatra'
 
+require 'tshield/logger'
+
 module TShield
+  # TShield Controller
   module Controller
-
     def self.included(base)
       base.extend ClassMethods
     end
 
+    # Implementation of actions
     module ClassMethods
       def action(class_method, options)
-        @@actions = {} unless defined? @@actions
-        @@actions[class_method] = options
+        @actions = {} unless defined? @actions
+        @actions[class_method] = options
       end
 
       def registered(app)
-        @@actions.each do |class_method, options|
-          puts "== registering #{options[:path]} for methods #{options[:methods].join(',')} with action #{class_method}"
-          options[:methods].each do |method|
-            app.send(method, options[:path]) { send(class_method, params, request) }
-          end
+        @actions.each do |class_method, options|
+          load_action(app, class_method, options)
         end
       end
 
-    end
+      def load_action(app, class_method, options)
+        msg = "== registering #{options[:path]}"
+        msg << " for methods #{options[:methods].join(',')}"
+        msg << " with action #{class_method}"
 
+        TShield.logger.info(msg)
+        options[:methods].each do |method|
+          app.send(method, options[:path]) do
+            send(class_method, params, request)
+          end
+        end
+      end
+    end
   end
 end
-

data/lib/tshield/controllers/requests.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'sinatra'
 
@@ -12,40 +12,40 @@ require 'tshield/sessions'
 module TShield
   module Controllers
     module Requests
-      PATHP = /([a-zA-Z0-9\/\._-]+)/
+      PATHP = %r{([a-zA-Z0-9/\._-]+)}.freeze
 
       def self.registered(app)
         app.configure :production, :development do
           app.enable :logging
         end
-        
-        app.get (PATHP) do
+
+        app.get(PATHP) do
           treat(params, request, response)
         end
 
-        app.post (PATHP) do
+        app.post(PATHP) do
           treat(params, request, response)
         end
 
-        app.put (PATHP) do
+        app.put(PATHP) do
           treat(params, request, response)
         end
 
-        app.patch (PATHP) do
+        app.patch(PATHP) do
           treat(params, request, response)
         end
 
-        app.head (PATHP) do
+        app.head(PATHP) do
           treat(params, request, response)
         end
 
-        app.delete (PATHP) do
+        app.delete(PATHP) do
           treat(params, request, response)
         end
       end
 
       module Helpers
-        def treat(params, request, response)
+        def treat(params, request, _response)
           path = params.fetch('captures', [])[0]
 
           debugger if TShield::Options.instance.break?(path: path, moment: :before)
@@ -66,12 +66,11 @@ module TShield
             ip: request.ip
           }
 
-          if ['POST', 'PUT', 'PATCH'].include? method
-            result = request.body.read.encode('UTF-8', {
-              :invalid => :replace,
-              :undef   => :replace,
-              :replace => ''
-            })
+          if %w[POST PUT PATCH].include? method
+            result = request.body.read.encode('UTF-8',
+                                              invalid: :replace,
+                                              undef: :replace,
+                                              replace: '')
             options[:body] = result
           end
 
@@ -80,14 +79,15 @@ module TShield
           api_response = TShield::Request.new(path, options).response
 
           logger.info(
-            "original=#{api_response.original} method=#{method} path=#{path} content-type=#{request_content_type} session=#{current_session_name(request)}")
+            "original=#{api_response.original} method=#{method} path=#{path} content-type=#{request_content_type} session=#{current_session_name(request)}"
+          )
 
           status api_response.status
-          headers api_response.headers.reject { |k,v| configuration.get_excluded_headers(domain(path)).include?(k) }
+          headers api_response.headers.reject { |k, _v| configuration.get_excluded_headers(domain(path)).include?(k) }
           body api_response.body
         end
 
-        def set_content_type(request_content_type)
+        def set_content_type(_request_content_type)
           content_type :json
         end
 
@@ -97,7 +97,7 @@ module TShield
         end
 
         def add_headers(headers, path)
-          configuration.get_headers(domain(path)).each do |source, destiny| 
+          configuration.get_headers(domain(path)).each do |source, destiny|
             headers[destiny] = request.env[source] unless request.env[source].nil?
           end
         end
@@ -113,4 +113,3 @@ module TShield
     end
   end
 end
-

data/lib/tshield/controllers/sessions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sinatra/base'
 
 require 'tshield/configuration'
@@ -7,7 +9,6 @@ module TShield
   module Controllers
     module Sessions
       def self.registered(app)
-
         app.get TShield::Configuration.singleton.session_path do
           TShield::Sessions.current(request.ip).to_json
         end
@@ -19,9 +20,7 @@ module TShield
         app.delete TShield::Configuration.singleton.session_path do
           TShield::Sessions.stop(request.ip).to_json
         end
-
       end
     end
   end
 end
-

data/lib/tshield/counter.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module TShield
+  # Increment counter for sessions requests
   class Counter
-
     def initialize
       @requests = {}
     end
@@ -9,7 +11,7 @@ module TShield
       requests_to_path = @requests.fetch(path, {})
       requests_to_method = requests_to_path.fetch(method, 0)
 
-      requests_to_path[method] = requests_to_method += 1
+      requests_to_path[method] = requests_to_method + 1
       @requests[path] = requests_to_path
     end
 
@@ -18,9 +20,7 @@ module TShield
     end
 
     def to_json(options = {})
-      @requests.to_json
+      @requests.to_json(options)
     end
-
   end
 end
-

data/lib/tshield/logger.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+# Logger instance for application
+module TShield
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+end