reverb 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 948de7b1ca89f2d1cd47c1c4ac4056e5dc26b2d7
-  data.tar.gz: 8cf997b3e04627b2c46c63bade13622c3cb4208a
+  metadata.gz: d253f03805c6dfea7a968b0c6f98cfd7eff557ce
+  data.tar.gz: 2f988191d4ee9e915a73814aa1288bc0e6df7414
 SHA512:
-  metadata.gz: 0077e6bd52b1ff520b72899e6cc4fe1891b04293f605a0d12b5ce4a3f0fe97de458fa42ad36bf53200a01aabf37127599421478c28bfa4e17edbfcf8ae50020d
-  data.tar.gz: 6c39cb1f270a0e34a2d1a29033b3da2719db115da426f1301c6bbf9c52dfa013fcf4cee5a3f3bf04220f65a71400255b769e4e1aceabfb621416e12eb0157e51
+  metadata.gz: bff291d48bc230bac6ac13109c2a93e16a59a23b94e501001b5b7a3d617a59a43ea6ee3d26db99598735cac60d19fa1eb40c644514c933cc71e7bd6f491fbc10
+  data.tar.gz: 0446afe9a2a9f7fec238bea268080f78762a97be7721ed3c94d17abad3f187f0f7f86232ac61b671d4b4d24974b9a9d95f3ed8dc95461e68cb31feafeff2c5e3

data/README.md

@@ -1,6 +1,8 @@
 Reverb
 ======
 
+[![Build Status](https://semaphoreci.com/api/v1/projects/2ed8a518-6a6c-4ebe-844b-4a1fc310baa4/459078/badge.svg)](https://semaphoreci.com/awesomenesstv/reverb--2)
+
 Reverb provides a generic interface for responding to API requests.
 
 
@@ -43,6 +45,8 @@ The only methods that are considered part of the public API are:
 * `status`
 * `data`
 * `on_success`
+* `scrub`
+* `scrubbed`
 
 `on_success` only gets called if `success?` is true.
 
@@ -61,6 +65,46 @@ Include them after requiring FactoryGirl:
 	require 'reverb/factories'
 
 
+Sensitive Data
+--------------
+
+Responses may be scrubbed to remove sensitive data such as credentials.
+Use `response.scrubbed` to access the 'scrubbed' version of the response.
+
+By default, Reverb will scrub etags.
+
+To turn this off, set `scrub_etags` to false in a configuration block:
+
+```
+Reverb.configure do |config|
+  config.scrub_etags = false
+end
+```
+
+
+To turn off scrubbing entirely, set `scrub` to false a configuration block:
+This will cause no scrubbing to occur, even if `scrub_etags` is set to true.
+
+```
+Reverb.configure do |config|
+  config.scrub = false
+end
+```
+
+
+To scrub custom values, simply call `scrub` with the regex/string
+to scrub and a replacement string.
+
+```
+response = Reverb::Response.new(original_response)
+response.scrub 'sensitive-string', 'YOU_CANT_SEE_ME'
+```
+
+The code above will replace all occurences
+of 'sensitive-string' with 'YOU_CANT_SEE_ME'.
+
+
+
 Deployment
 ----------
 

data/lib/reverb.rb

@@ -1,6 +1,7 @@
 require 'json'
+require 'pp'
+require 'cgi'
 
-module Reverb
-end
-
+require_relative 'reverb/configuration'
+require_relative 'reverb/core'
 require_relative 'reverb/response'

data/lib/reverb/configuration.rb

@@ -0,0 +1,16 @@
+module Reverb
+  class Configuration
+    attr_accessor :scrub, :scrub_etag
+
+    def initialize
+      @scrub      = true
+      @scrub_etag = true
+    end
+
+    class << self
+      def current
+        @config ||= self.new
+      end
+    end
+  end
+end

data/lib/reverb/core.rb

@@ -0,0 +1,9 @@
+module Reverb
+  module Core
+    def configuration(&block)
+      yield Configuration.current
+    end
+  end
+
+  extend Core
+end

data/lib/reverb/response.rb

@@ -5,29 +5,103 @@ module Reverb
     attr_accessor :status, :success, :data
 
     def initialize(response = nil)
-      @status = nil
-      @success = false
-      @body = nil
+      @status    = nil
+      @success   = false
+      @body      = nil
+      @response  = response
+      @scrubbers = {}
 
-      if response
-        @response = response
-
-        @status = @response.status
-        @success = @response.success?
-
-        if success?
-          @body = JSON.parse(response.body)
-          on_success
-        end
-      end
+      process_response if @response
     end
 
     def success?
       @success
     end
 
+    def scrubbed
+      return @scrubbed if defined?(@scrubbed)
+
+      scrub etag, 'ETAG' if Configuration.current.scrub_etag && etag
+
+      scrubbers = @scrubbers
+      @scrubbers = {}
+
+      @scrubbed = PP.pp(self, '')
+
+      scrub_all scrubbers
+
+      @scrubbers = scrubbers
+
+      @scrubbed
+    end
+
+    def scrub(regex, value)
+      return self unless regex
+      @scrubbers[regex] = value
+      self
+    end
+
     private
 
+    def process_response
+      @status = @response.status
+      @success = @response.success?
+
+      if success?
+        @body = JSON.parse(@response.body)
+        on_success
+      end
+    end
+
+    def scrub_all(scrubbers)
+      return unless Configuration.current.scrub
+      scrubbers.each do |regex, value|
+        wipe regex, value
+      end
+    end
+
+    def wipe(regex, value)
+      value ||= 'NIL_SCRUB'
+
+      regexes(regex).each do |match|
+        @scrubbed = @scrubbed.gsub(match, value)
+      end
+    end
+
+    def regexes(regex)
+      return [regex] unless regex.is_a?(String)
+
+      escaped = CGI.escape(regex)
+
+      list = Set.new([regex])
+      list << escaped
+      list << escaped.gsub('+', '%20').gsub('%2F', '/')
+
+      list
+    end
+
+    def etag
+      raw_etag &&
+        @response.env.response_headers['etag'].gsub(/"/, '')
+    end
+
+    def raw_etag
+      response_headers &&
+        @response.env.response_headers.is_a?(Hash) &&
+        @response.env.response_headers['etag'] || nil
+    end
+
+    def response_headers
+      response_env &&
+        @response.env.respond_to?(:response_headers) &&
+        @response.env.response_headers || nil
+    end
+
+    def response_env
+      @response.respond_to?(:env) &&
+        @response.env || nil
+    end
+
     def body
       @body
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reverb
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Travis Herrick
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gems
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: cane
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,8 @@ extra_rdoc_files:
 files:
 - README.md
 - lib/reverb.rb
+- lib/reverb/configuration.rb
+- lib/reverb/core.rb
 - lib/reverb/factories.rb
 - lib/reverb/factories/response.rb
 - lib/reverb/response.rb