tshield 0.8.0.0 → 0.9.0.0

data/lib/tshield/options.rb

@@ -1,21 +1,25 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
+require 'tshield/logger'
 require 'tshield/version'
 
 module TShield
+  # Options for command line
   class Options
-
     attr_reader :debug
 
     def self.init
-      @@instance = TShield::Options.new
+      @instance = TShield::Options.new
     end
 
     def self.instance
-      @@instance
+      @instance || TShield::Options.new
     end
 
     def initialize
+      @options = {}
       parse
     end
 
@@ -23,42 +27,72 @@ module TShield
       check_breakpoint(args)
     end
 
+    def configuration_file
+      @options.fetch(:configuration_file, 'config/tshield.yml')
+    end
+
     private
+
     def check_breakpoint(args)
-      check_breakpoint_moment(args) 
+      check_breakpoint_moment(args)
     end
 
     def check_breakpoint_moment(args)
       @options["#{args[:moment]}_pattern".to_sym] =~ args[:path]
     end
 
+    def register_before_pattern(opts)
+      opts.on('-b', '--break-before-request [PATTERN]',
+              'Breakpoint before request') do |pattern|
+        @options[:before_pattern] = Regexp.new(pattern)
+      end
+    end
+
+    def register_after_pattern(opts)
+      opts.on('-a', '--break-after-request [PATTERN]',
+              'Breakpoint after request') do |pattern|
+        @options[:after_pattern] = Regexp.new(pattern)
+      end
+    end
+
+    def register_configuration(opts)
+      opts.on('-c', '--configuration [FILE]',
+              'Configuration File') do |file|
+        @options[:configuration_file] = file
+      end
+    end
+
+    def register_patterns(opts)
+      register_before_pattern(opts)
+      register_after_pattern(opts)
+    end
+
+    def register_version(opts)
+      opts.on('-v', '--version', 'Show version') do
+        TShield.logger.info(TShield::Version.to_s)
+        exit
+      end
+    end
+
+    def register_help(opts)
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
+      end
+    end
+
     def parse
-      @options = {}
       OptionParser.new do |opts|
-        opts.banner = "Usage: tshield [options]"
-      
-        opts.on('-b', '--break-before-request [PATTERN]', 
-          'Breakpoint before request') do |pattern|
-          @options[:before_pattern] = Regexp.new(pattern)
-        end
-
-        opts.on('-a', '--break-after-request [PATTERN]', 
-          'Breakpoint after request') do |pattern|
-          @options[:after_pattern] = Regexp.new(pattern)
-        end
-
-        opts.on("-v", "--version", "Show version") do
-          puts TShield::Version
-          exit
-        end
-
-        opts.on_tail("-h", "--help", "Show this message") do
-          puts opts
-          exit
-        end
+        opts.banner = 'Usage: tshield [options]'
+        register(opts)
       end.parse!
     end
 
+    def register(opts)
+      register_configuration(opts)
+      register_patterns(opts)
+      register_version(opts)
+      register_help(opts)
+    end
   end
 end
-

data/lib/tshield/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'httparty'
 require 'json'
 require 'byebug'
@@ -10,29 +12,27 @@ require 'tshield/response'
 require 'tshield/sessions'
 
 module TShield
-
   class Request
-
     attr_reader :response
 
     def initialize(path, options = {})
       @path = path
-      @options = options 
+      @options = options
       @configuration = TShield::Configuration.singleton
-      @options[:timeout] =  @configuration.request['timeout']
-      @options[:verify] =  @configuration.request['verify_ssl']
+      @options[:timeout] = @configuration.request['timeout']
+      @options[:verify] = @configuration.request['verify_ssl']
       request
     end
 
     def request
-      if not (@options[:raw_query].nil? or @options[:raw_query].empty?)
+      unless @options[:raw_query].nil? || @options[:raw_query].empty?
         @path = "#{@path}?#{@options[:raw_query]}"
       end
 
       @url = "#{domain}#{@path}"
 
       if exists
-        @response = get_current_response  
+        @response = get_current_response
         @response.original = false
       else
         @method = method
@@ -40,7 +40,7 @@ module TShield
           @method, @url, @options = filter.new.filter(@method, @url, @options)
         end
 
-        raw = HTTParty.send("#{@method}", @url, @options)
+        raw = HTTParty.send(@method.to_s, @url, @options)
 
         @configuration.get_after_filters(domain).each do |filter|
           raw = filter.new.filter(raw)
@@ -56,6 +56,7 @@ module TShield
     end
 
     private
+
     def domain
       @domain ||= @configuration.get_domain_for(@path)
     end
@@ -70,14 +71,12 @@ module TShield
 
     def save(raw_response)
       headers = {}
-      raw_response.headers.each do |k,v| 
-        if !@configuration.not_save_headers(domain).include? k
-          headers[k] = v
-        end
+      raw_response.headers.each do |k, v|
+        headers[k] = v unless @configuration.not_save_headers(domain).include? k
       end
 
       content = {
-        body: raw_response.body, 
+        body: raw_response.body,
         status: raw_response.code,
         headers: headers
       }
@@ -102,7 +101,7 @@ module TShield
     def file_exists
       session = current_session
       @content_idx = session ? session[:counter].current(@path, method) : 0
-      File.exists?(destiny)
+      File.exist?(destiny)
     end
 
     def exists
@@ -110,7 +109,7 @@ module TShield
     end
 
     def get_current_response
-      TShield::Response.new(content['body'], content['headers'] || [], content['status'] || 200) 
+      TShield::Response.new(content['body'], content['headers'] || [], content['status'] || 200)
     end
 
     def key
@@ -119,22 +118,23 @@ module TShield
 
     def destiny(iscontent = false)
       request_path = File.join('requests')
-      Dir.mkdir(request_path) unless File.exists?(request_path)
+      Dir.mkdir(request_path) unless File.exist?(request_path)
 
-      if session = current_session
+      session = current_session
+      if session
         request_path = File.join(request_path, session[:name])
-        Dir.mkdir(request_path) unless File.exists?(request_path)
+        Dir.mkdir(request_path) unless File.exist?(request_path)
       end
 
       name_path = File.join(request_path, name)
-      Dir.mkdir(name_path) unless File.exists?(name_path)
+      Dir.mkdir(name_path) unless File.exist?(name_path)
 
       path_path = File.join(name_path, safe_dir(@path))
-      Dir.mkdir(path_path) unless File.exists?(path_path)
+      Dir.mkdir(path_path) unless File.exist?(path_path)
 
       method_path = File.join(path_path, method)
-      Dir.mkdir(method_path) unless File.exists?(method_path)
-      
+      Dir.mkdir(method_path) unless File.exist?(method_path)
+
       destiny_name = iscontent ? "#{@content_idx}.content" : "#{@content_idx}.json"
       File.join(method_path, destiny_name)
     end
@@ -156,14 +156,11 @@ module TShield
     def safe_dir(url)
       if url.size > 225
         path = url.gsub(/(\?.*)/, '')
-        params = Digest::SHA1.hexdigest $1
-        "#{path.gsub(/\//, '-').gsub(/^-/, '')}?#{params}"
+        params = Digest::SHA1.hexdigest Regexp.last_match(1)
+        "#{path.gsub(%r{/}, '-').gsub(/^-/, '')}?#{params}"
       else
-        url.gsub(/\//, '-').gsub(/^-/, '')
+        url.gsub(%r{/}, '-').gsub(/^-/, '')
       end
     end
-
   end
-
 end
-

data/lib/tshield/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TShield
   class Response
     attr_accessor :body, :headers, :status, :original

data/lib/tshield/server.rb

@@ -1,22 +1,35 @@
+# frozen_string_literal: false
+
 require 'sinatra'
 require 'haml'
 
 require 'tshield/controllers/requests'
 require 'tshield/controllers/sessions'
 
-require 'tshield/controllers/admin/requests'
-require 'tshield/controllers/admin/sessions'
-
 module TShield
+  # Base of TShield Server
   class Server < Sinatra::Base
-
     include TShield::Controllers::Requests::Helpers
-    include TShield::Controllers::Admin::Sessions::Helpers
-    include TShield::Controllers::Admin::Requests::Helpers
 
-    if File.exists?('controllers')
+    set :protection, except: [:json_csrf]
+    set :public_dir, File.join(File.dirname(__FILE__), 'assets')
+    set :views, File.join(File.dirname(__FILE__), 'views')
+    set :bind, '0.0.0.0'
+
+    def self.register_resources
+      load_controllers
+      register TShield::Controllers::Sessions
+      register TShield::Controllers::Requests
+    end
+
+    def self.load_controllers
+      return unless File.exist?('controllers')
+
       Dir.entries('controllers').each do |entry|
+        require 'byebug'
+        debugger
         next if entry =~ /^\.\.?$/
+
         entry.gsub!('.rb', '')
         require File.join('.', 'controllers', entry)
         controller_name = entry.split('_').collect(&:capitalize).join
@@ -25,17 +38,9 @@ module TShield
       end
     end
 
-    set :protection, :except => [:json_csrf]
-    set :public_dir, File.join(File.dirname(__FILE__), 'assets')
-    set :views, File.join(File.dirname(__FILE__), 'views')
-    set :bind, '0.0.0.0'
-
-    register TShield::Controllers::Admin::Sessions
-    register TShield::Controllers::Admin::Requests
-
-    register TShield::Controllers::Sessions
-    register TShield::Controllers::Requests
-
+    def self.run!
+      register_resources
+      super.run!
+    end
   end
 end
-

data/lib/tshield/sessions.rb

@@ -1,10 +1,15 @@
+# frozen_string_literal: true
+
 require 'byebug'
 require 'tshield/counter'
 
 module TShield
+  # Manage sessions
+  #
+  # Start and stop session for ip
   module Sessions
     def self.start(ip, name)
-      sessions[normalize_ip(ip)] = {name: name, counter: TShield::Counter.new}
+      sessions[normalize_ip(ip)] = { name: name, counter: TShield::Counter.new }
     end
 
     def self.stop(ip)
@@ -15,7 +20,6 @@ module TShield
       sessions[normalize_ip(ip)]
     end
 
-    protected 
     def self.sessions
       @sessions ||= {}
     end
@@ -23,7 +27,5 @@ module TShield
     def self.normalize_ip(ip)
       ip == '::1' ? '127.0.0.1' : ip
     end
-
   end
 end
-

data/lib/tshield/simple_tcp_server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'socket'
 
 module TShield
@@ -6,7 +8,7 @@ module TShield
       @running = true
     end
 
-    def on_connect(client)
+    def on_connect(_client)
       raise 'should implement method on_connect'
     end
 
@@ -24,4 +26,3 @@ module TShield
     end
   end
 end
-

data/lib/tshield/version.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module TShield
+  # Control version of gem
   class Version
     MAJOR = 0
-    MINOR = 8
+    MINOR = 9
     PATCH = 0
     PRE = 0
 
@@ -12,4 +15,3 @@ module TShield
     end
   end
 end
-

data/lib/tshield.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
+require 'tshield/options'
 require 'tshield/simple_tcp_server'
 require 'tshield/server'
-require 'tshield/options'
 
 module TShield
 end
-

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 require 'bundler/setup'
 Bundler.setup
 
@@ -5,14 +7,12 @@ require 'simplecov'
 SimpleCov.start
 
 require 'httparty'
-require 'tshield'
-
 require 'webmock/rspec'
 
 RSpec.configure do |config|
-
-  config.before(:each) do 
+  config.before(:each) do
+    allow(File).to receive(:join).and_return(
+      'spec/tshield/fixtures/config/tshield.yml'
+    )
   end
-
 end
-

data/spec/tshield/after_filter_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'tshield/after_filter'
+require 'spec_helper'
+
+describe TShield::AfterFilter do
+end

data/spec/tshield/configuration_spec.rb

@@ -1,32 +1,69 @@
+# frozen_string_literal: false
+
+require 'tshield/configuration'
 require 'spec_helper'
 
 describe TShield::Configuration do
-  before :each do 
-    allow(File).to(
-      receive(:join).and_return('spec/tshield/fixtures/config/tshield.yml'))
-    @configuration = TShield::Configuration.singleton
-  end
-
-  describe 'load configurations from yaml' do
-    it 'recover domains' do
-      expect(@configuration.domains['example.org']['paths']).to(
-        include('/api/one', '/api/two'))
+  context 'on config exist' do
+    before :each do
+      options_instance = double
+      allow(options_instance).to receive(:configuration_file)
+        .and_return('spec/tshield/fixtures/config/tshield.yml')
+      allow(TShield::Options).to receive(:instance).and_return(options_instance)
+      allow(File).to receive(:join).and_return(
+        './spec/tshield/fixtures/filters/example_filter.rb'
+      )
+      allow(File).to receive(:exist?) do
+        true
+      end
+      allow(Dir).to receive(:entries) do
+        ['.', '..', 'example_filter.rb']
+      end
+      @configuration = TShield::Configuration.singleton
     end
-  end
 
-  describe 'get_domain_for' do
-    it 'return domain for example.org' do
-      expect(@configuration.get_domain_for('/api/two')).to eq('example.org')
-    end
+    context 'load configurations from yaml' do
+      it 'recover domains' do
+        expect(@configuration.domains['example.org']['paths']).to(
+          include('/api/one', '/api/two')
+        )
+      end
 
-    it 'return domain for example.com' do
-      expect(@configuration.get_domain_for('/api/three')).to eq('example.com')
+      context 'on load filters' do
+        it 'recover filters for a domain' do
+          expect(@configuration.get_filters('example.org')).to eq([ExampleFilter])
+        end
+        it 'return empty array if domain not have filters' do
+          expect(@configuration.get_filters('example.com')).to eq([])
+        end
+      end
     end
 
-    it 'return nil if domain not found' do
-      expect(@configuration.get_domain_for('/api/four')).to be_nil
+    describe 'get_domain_for' do
+      it 'return domain for example.org' do
+        expect(@configuration.get_domain_for('/api/two')).to eq('example.org')
+      end
+
+      it 'return domain for example.com' do
+        expect(@configuration.get_domain_for('/api/three')).to eq('example.com')
+      end
+
+      it 'return nil if domain not found' do
+        expect(@configuration.get_domain_for('/api/four')).to be_nil
+      end
     end
   end
+  context 'on config not exist' do
+    before :each do
+      options_instance = double
+      allow(options_instance).to receive(:configuration_file)
+        .and_return('not_found/config/tshield.yml')
+      allow(TShield::Options).to receive(:instance).and_return(options_instance)
+      TShield::Configuration.clear
+    end
 
+    it 'exit with error status' do
+      expect { TShield::Configuration.singleton }.to raise_error RuntimeError
+    end
+  end
 end
-

data/spec/tshield/fixtures/config/tshield.yml

@@ -1,9 +1,15 @@
+---
+request:
+  timeout: 0
 domains:
   'example.org':
+    name: 'example.org'
+    filters:
+      - 'ExampleFilter'
     paths:
       - '/api/one'
       - '/api/two'
   'example.com':
+    name: 'example.com'
     paths:
       - '/api/three'
-  

data/spec/tshield/fixtures/filters/example_filter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'tshield/after_filter'
+
+class ExampleFilter < TShield::AfterFilter
+  def filter(response)
+    response
+  end
+end

data/spec/tshield/request_spec.rb

@@ -1,11 +1,52 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
+require 'tshield/request'
+
 describe TShield::Request 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(:get_after_filters).and_return([])
+    allow(configuration).to receive(:request).and_return('timeout' => 10)
+    allow(configuration).to receive(:get_domain_for).and_return('example.org')
+    allow(TShield::Options).to receive_message_chain(:instance, :break?)
+  end
 
   describe 'when save response' do
-    it '' do
+    it 'should write response body, request status and headers' do
+      allow_any_instance_of(TShield::Request).to receive(:exists)
+        .and_return(false)
+      allow_any_instance_of(TShield::Request).to receive(:destiny)
+      allow(HTTParty).to receive(:send).and_return(RawResponse.new)
+
+      write_spy = double
+      allow(File).to receive(:open).and_return(write_spy)
+
+      expect(write_spy).to receive(:write).ordered.with('this is the body')
+      expect(write_spy).to receive(:write)
+        .ordered
+        .with("{\n  \"status\": 200,\n  \"headers\": {\n  }\n}")
+      allow(write_spy).to receive(:close)
+
+      TShield::Request.new '/', method: 'GET'
     end
   end
 
-end
+  class RawResponse
+    def headers
+      []
+    end
+
+    def body
+      'this is the body'
+    end
 
+    def code
+      200
+    end
+  end
+end