inspect_request 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6abde53a7e052c38f001e03a0a5f79e6ed8302ac
-  data.tar.gz: 48b1b558b118fa00432a7d801b3d30556f2e3b86
+  metadata.gz: 6bc1422da3ee98462f05f5029b842c1dbab17ee2
+  data.tar.gz: bb43c9e4091551bbd89a140ca5abd8c209b638b7
 SHA512:
-  metadata.gz: 28fefa4b276bfe6b80f0f7fa5d8b4e9563bc47d6059965c5e0bf65c0588a3242e0c0244781cb7bfd1b30589081163d1416e696acd32831edd2eb3882e4be734a
-  data.tar.gz: 8ddb64164fa1d02bc7ca6859349083178de80603b914010397dfb80e751213522c2605ca7a6036a015c1edc8f6e7ac555b615e05de15a7754149a71e2e01ca4e
+  metadata.gz: a00de31c9c6620a8672c4573b2a343d8645aaf8fd2bc538d65d1a78bddf96744065a587b74770b8d6d3cf4764bcfbc2b62abfcb677eb39891de9ad75e5980272
+  data.tar.gz: 6dc0f17ff6d1c3bae9a623c398e341afcdf800df19cab2350366d7c07b65bf4edaa9dfff75561a4d953800b146c74736c12683b3849fb836eb96907b320eb574

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    inspect_request (0.1.2)
+    inspect_request (0.1.3)
       ritm (~> 1.0.3)
 
 GEM

data/README.md

@@ -4,8 +4,6 @@ This library will provide you with a proxy (Ritm) which make it possible to insp
 It similar to what mockserver provide, but much simpler (less feature as well).
 Under the verification function, you have a copy of the request. And you can inspect it however you want. In the end, you just need to return true/false.
 
-Default port is 7777. You cannot change it yet.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -32,7 +30,7 @@ foo = InspectRequest::Checker.new
 
 # we can configure our proxy details similar to Ritm
 foo.configure do
-    proxy[:bind_port] = 7777 # default port
+    proxy[:bind_port] = 8080 # default port
 end
 
 foo.verify do |req|
@@ -40,7 +38,7 @@ foo.verify do |req|
 end
 
 # make sure to go throuh our proxy
-RestClient.proxy = 'http://127.0.0.1:7777'
+RestClient.proxy = 'http://127.0.0.1:8080'
 # send a test request
 RestClient.get 'http://example.org'
 
@@ -48,6 +46,34 @@ sleep 1
 foo.fulfilled? # true
 ```
 
+## Self-signed Certificate
+Use the following command to generate `insecure_ca.pem` and `insecure_ca.key`
+
+```ruby
+require 'ritm/certs/ca'
+
+ca = Ritm::CA.create common_name: 'Inspect Request'
+
+File.write('insecure_ca.pem', ca.pem)
+File.write('insecure_ca.key', ca.private_key.to_s)
+```
+
+Then we'll need to use it like this:
+```
+INSECURE_CA_PEM = './insecure_ca.pem'.freeze
+INSECURE_CA_KEY = './insecure_ca.key'.freeze
+
+foo = InspectRequest::Checker.new
+foo.configure do
+    ssl_reverse_proxy.ca[:pem] = INSECURE_CA_PEM
+    ssl_reverse_proxy.ca[:key] = INSECURE_CA_KEY
+end
+```
+
+Finally, you can test it using curl:
+```
+curl -k --cacert insecure_ca.pem -x http://localhost:7777 https://httpbin.org/get
+```
 
 ## Development
 
@@ -57,7 +83,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/umbrella.
+
 
 ## License
 

data/lib/inspect_request.rb

@@ -1,40 +1,75 @@
 require 'inspect_request/version'
 require 'ritm'
 
+# You can create multiple Checker instances (verificator). But it will share the same proxy.
 module InspectRequest
-  @started = false
-  @session = nil
-
+  # Checker class
   class Checker
+    @started = false
+    @session = nil
+
+    class << self
+      attr_reader :session
+      attr_reader :started
+    end
+
     def initialize
-      InspectRequest.start
+      @results = []
+      @verifier_block = proc {}
 
-      InspectRequest.session.on_request do |req|
+      self.class.start
+      self.class.session.on_request do |req|
         track_result @verifier_block.call req.clone
       end
+    end
 
-      trap('INT') { InspectRequest.shutdown }
-      trap('TERM') { InspectRequest.shutdown }
-      @results = []
-      @verifier_block = proc {}
+    # Start the proxy. No need to do this unless you've explicitely shut it down
+    def self.start
+      return if @started
+      @session ||= Ritm::Session.new
+      @session.start
+      @started = true
+      trap('INT') { Checker.shutdown }
+      trap('TERM') { Checker.shutdown }
+    end
+
+    # Shutdown proxy
+    def self.shutdown
+      @session.shutdown if @started
+      @started = false
     end
 
-    # block should return true/false given an `req` (webrick request instance)
+    def started?
+      self.class.started
+    end
+
+    # block should return true/false given an +req+ (webrick request instance)
+    # ===== Examples
+    #
+    #    foo.verify do |req|
+    #      req.host == 'example.org'
+    #    end
     def verify(&block)
       @verifier_block = block
     end
 
-    # automatically clear previous results
+    # did our verification ever fulfilled?
     def fulfilled?
       res = @results.any? # any true?
       @results.clear
       res
     end
 
+    # Configure proxy. It will also auto-restart the proxy
+    # ==== Examples
+    #    foo = InspectRequest::Checker.new
+    #    foo.configure do
+    #      proxy[:bind_port] = 7070
+    #    end
     def configure(&block)
-      InspectRequest.session.send(:configure, &block)
-      InspectRequest.session.shutdown
-      InspectRequest.session.start
+      self.class.session.send(:configure, &block)
+      self.class.session.shutdown
+      self.class.session.start
     end
 
     private
@@ -43,29 +78,4 @@ module InspectRequest
       @results.push result
     end
   end
-
-  # Your code goes here...
-  def self.start
-    return if @started
-    @session = Ritm::Session.new
-    @session.configure do
-      proxy[:bind_address] = '0.0.0.0'
-      proxy[:bind_port] = 7777
-    end
-    @session.start
-    @started = true
-  end
-
-  def self.shutdown
-    @session.shutdown if @started
-    @started = false
-  end
-
-  def self.started?
-    @started
-  end
-
-  def self.session
-    @session
-  end
 end

data/lib/inspect_request/version.rb

@@ -1,3 +1,4 @@
 module InspectRequest
-  VERSION = '0.1.2'.freeze
+  # :nodoc:
+  VERSION = '0.1.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspect_request
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Akhmad Fathonih
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2018-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ritm