rabbit_feed 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4628837f151f999235f99e08ec94cfb7d3de228c
-  data.tar.gz: 5d6b69d02e1026fc83ab2cce50125d5700dc8689
+  metadata.gz: a254021c58185a15c29214a7361fca851d51ae4e
+  data.tar.gz: 63bddce1a50ec017cf59c61d21d77b5b36910242
 SHA512:
-  metadata.gz: 96611f7a62e4d4c0a64f6fc3fb578676889f906ec90830a68c6e304d40ece011b9625e2956469b2923896d7090515c166199efbce70bce1e8e3cbeb1df70225a
-  data.tar.gz: 9f4b31d15ba80d3c9c00abb564cec0b12a95b44be668f138ade602eaf8e63b8bafd1356db2e2875d77713fbb77c46c090576d0c8d5fedcf2e0b7b81babf5e609
+  metadata.gz: b68e75c49e38da3619904f7144509705d659d97627e3f9b57b4e106023e8ed635c60aaab19dd1496e78321379288c4bae9681ae1be68dacf3842ee72e9c72fe7
+  data.tar.gz: 58a49087c1cdda30bff123501fb5c8bb3a12f3bf68b9df3f316feb12bb8d67b1fd508a5a147b08e1d5fc26761c6edc4883974ed0f4911fb9b1a1150d431eb996

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rabbit_feed (2.1.1)
+    rabbit_feed (2.1.2)
       activemodel (>= 3.2.0, < 5.0.0)
       activesupport (>= 3.2.0, < 5.0.0)
       avro (>= 1.5.4, < 1.8.0)

data/README.md

@@ -16,7 +16,7 @@ A gem providing asynchronous event publish and subscribe capabilities with Rabbi
 
 Add this line to your application's Gemfile:
 
-    gem 'rabbit_feed', git: 'git@github.com:simplybusiness/rabbit_feed.git'
+    gem 'rabbit_feed'
 
 ### Configuration
 
@@ -289,22 +289,22 @@ Here is an example DSL:
 ```ruby
 EventRouting do
   accept_from('beavers') do
-    event('user_created_beaver') do |event|
+    event('user_creates_beaver') do |event|
       puts event.payload
     end
-    event('user_updated_beaver') do |event|
+    event('user_updates_beaver') do |event|
       puts event.payload
     end
   end
 end
 ```
 
-This will subscribe to specified events originating from the `beavers` application. We have specified that we would like to subcribe to `user_created_beaver` and `user_updated_beaver` events. If either event type is received, we have specified that its payload will be printed to the screen.
+This will subscribe to specified events originating from the `beavers` application. We have specified that we would like to subcribe to `user_creates_beaver` and `user_updates_beaver` events. If either event type is received, we have specified that its payload will be printed to the screen.
 
 When the consumer is started, it will create its queue named using this pattern: `[environment].[consumer application name]`. It will bind the queue to the `amq.topic` exchange on the routing keys as defined in the event routing. In this example, it will bind on:
 
-    environment.beavers.user_created_beaver
-    environment.beavers.user_updated_beaver
+    environment.beavers.user_creates_beaver
+    environment.beavers.user_updates_beaver
 
 _Note: The consumer queues will automatically expire (delete) after 7 days without any consumer connections. This is to prevent unused queues from hanging around once their associated consumer has been terminated._
 

data/lib/rabbit_feed/event.rb

@@ -4,15 +4,16 @@ module RabbitFeed
 
     SCHEMA_VERSION = '2.0.0'
 
-    attr_reader :schema, :payload, :metadata
+    attr_reader :schema, :payload, :metadata, :sensitive_fields
     validates :metadata, presence: true
     validates :payload, length: { minimum: 0, allow_nil: false, message: 'can\'t be nil' }
     validate  :required_metadata
 
-    def initialize metadata, payload={}, schema=nil
+    def initialize metadata, payload={}, schema=nil, sensitive_fields=[]
       @schema   = schema
       @payload  = payload.with_indifferent_access if payload
       @metadata = metadata.with_indifferent_access if metadata
+      @sensitive_fields = Array(sensitive_fields).map(&:to_s).flatten
       validate!
     end
 
@@ -22,6 +23,8 @@ module RabbitFeed
       writer << { 'metadata' => metadata, 'payload' => payload }
       writer.close
       buffer.string
+    rescue Avro::IO::AvroTypeError
+      raise Avro::IO::AvroTypeError.new(schema, sensitive_proof_payload)
     end
 
     def application
@@ -70,6 +73,12 @@ module RabbitFeed
 
     private
 
+    def sensitive_proof_payload
+      sensitive_fields.each_with_object(payload.dup) do |field, clean_payload|
+        clean_payload[field] = "[REMOVED]" if clean_payload.key?(field)
+      end
+    end
+
     def validate!
       raise Error.new "Invalid event: #{errors.messages}" if invalid?
     end

data/lib/rabbit_feed/event_definitions.rb

@@ -28,7 +28,7 @@ module RabbitFeed
     class Event
       include ActiveModel::Validations
 
-      attr_reader :name, :definition, :version, :fields
+      attr_reader :name, :definition, :version, :fields, :sensitive_fields
       validates_presence_of :name, :definition, :version
       validate :schema_parseable
       validates :version, format: { with: /\A\d+\.\d+\.\d+\z/, message: 'must be in *.*.* format' }
@@ -37,6 +37,7 @@ module RabbitFeed
         @name    = name
         @version = version
         @fields  = []
+        @sensitive_fields = []
       end
 
       def payload_contains &block
@@ -44,6 +45,7 @@ module RabbitFeed
       end
 
       def field name, options
+        sensitive_fields << name.to_s if options.delete(:sensitive)
         fields << (Field.new name, options[:type], options[:definition])
       end
 

data/lib/rabbit_feed/producer.rb

@@ -9,7 +9,7 @@ module RabbitFeed
       event_definition = event_definitions[name] or raise (Error.new "definition for event: #{name} not found")
       timestamp        = Time.now.utc
       metadata         = (metadata event_definition.version, name, timestamp)
-      event            = Event.new metadata, payload, event_definition.schema
+      event            = Event.new metadata, payload, event_definition.schema, event_definition.sensitive_fields
       ProducerConnection.publish event.serialize, (options name, timestamp)
       event
     end

data/lib/rabbit_feed/version.rb

@@ -1,3 +1,3 @@
 module RabbitFeed
-  VERSION = '2.1.1'
+  VERSION = '2.1.2'
 end

data/spec/lib/rabbit_feed/event_definitions_spec.rb

@@ -10,8 +10,8 @@ module RabbitFeed
           end
           payload_contains do
             field('customer_id', type: 'string', definition: 'The definition of the customer id')
-            field('policy_id', type: 'string', definition: 'The definition of the policy id')
-            field('price', type: 'string', definition: 'The definition of the price')
+            field('policy_id', type: 'string', definition: 'The definition of the policy id', sensitive: true)
+            field('price', type: 'string', definition: 'The definition of the price', sensitive: true)
           end
         end
       end
@@ -21,6 +21,7 @@ module RabbitFeed
     it { should_not be_nil }
     it { should be_valid }
     its(:name) { should eq 'customer_purchases_policy' }
+    its(:sensitive_fields) { should match_array(['price', 'policy_id']) }
 
     describe EventDefinitions::Event do
       let(:name)       { 'event_name' }

data/spec/lib/rabbit_feed/event_spec.rb

@@ -67,6 +67,65 @@ module RabbitFeed
       end
     end
 
+    describe '#serialize' do
+      let(:schema) do
+        Avro::Schema.parse(
+          {
+            name:   'example-1.0',
+            type:   'record',
+            fields: [
+              {
+                name: 'payload',
+                type: {
+                  name: 'event_payload',
+                  type: 'record',
+                  fields: [
+                    { name: 'event_integer', type: 'int' },
+                    { name: 'event_string',  type: 'string' },
+                  ],
+                },
+              },
+              {
+                name: 'metadata',
+                type: {
+                  name: 'event_metadata',
+                  type: 'record',
+                  fields: [{ name: 'name', type: 'string' }],
+                },
+              },
+            ],
+          }.to_json
+        )
+      end
+
+      context 'with invalid payload' do
+        let(:payload)  { {
+          'event_string'  => 'HIGHLY SENSITIVE',
+          'event_integer' => 'incorrect',
+        } }
+
+        it 'raises an Exception' do
+          expect {
+            subject.serialize
+          }.to raise_error(Avro::IO::AvroTypeError)
+        end
+
+        it 'can remove values from exception' do
+          event = described_class.new(metadata, payload, schema, ['event_string'])
+          exception_msg = nil
+          begin
+            event.serialize
+          rescue Avro::IO::AvroTypeError => e
+            exception_msg = e.message
+          end
+          expect(exception_msg).to_not be_nil
+          expect(exception_msg).to_not include("HIGHLY SENSITIVE")
+          expect(exception_msg).to include('"event_string"=>"[REMOVED]"')
+          expect(exception_msg).to include('"event_integer"=>"incorrect"')
+        end
+      end
+    end
+
     describe '.deserialize' do
       subject { described_class.deserialize serialized_event }
 

data/spec/lib/rabbit_feed/producer_spec.rb

@@ -12,7 +12,7 @@ module RabbitFeed
               'The definition of the event'
             end
             payload_contains do
-              field('field', type: 'string', definition: 'The definition of the field')
+              field('field', type: 'string', definition: 'The definition of the field', sensitive: true)
             end
           end
         end
@@ -39,6 +39,10 @@ module RabbitFeed
         expect(subject).to be_a Event
       end
 
+      it 'sets the sensitive fields for the event' do
+        expect(subject.sensitive_fields).to match_array(['field'])
+      end
+
       it 'sets the event metadata' do
         Timecop.freeze(Time.local(1990)) do
           expect(subject.metadata).to match({

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rabbit_feed
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -312,7 +312,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Enables your Ruby applications to perform centralized event logging with