add string representation to entities for better and easier logging

lib/diaspora_federation/discovery/web_finger.rb

@@ -175,6 +175,11 @@ module DiasporaFederation
         )
       end
 
+      # @return [String] string representation of this object
+      def to_s
+        "WebFinger:#{acct_uri}"
+      end
+
       private
 
       # Parses the XML string to a Hash and does some rudimentary checking on

lib/diaspora_federation/entities/account_deletion.rb

@@ -13,6 +13,11 @@ module DiasporaFederation
       #   @see AccountDeletion#author
       #   @return [String] diaspora ID
       property :author, alias: :diaspora_id, xml_name: :diaspora_handle
+
+      # @return [String] string representation of this object
+      def to_s
+        "AccountDeletion:#{author}"
+      end
     end
   end
 end

lib/diaspora_federation/entities/contact.rb

@@ -24,6 +24,11 @@ module DiasporaFederation
       # @!attribute [r] sharing
       #   @return [Boolean] if the author is sharing with the person
       property :sharing, default: true
+
+      # @return [String] string representation of this object
+      def to_s
+        "Contact:#{author}:#{recipient}"
+      end
     end
   end
 end

lib/diaspora_federation/entities/profile.rb

@@ -55,6 +55,11 @@ module DiasporaFederation
 
       property :nsfw, default: false
       property :tag_string, default: nil
+
+      # @return [String] string representation of this object
+      def to_s
+        "Profile:#{author}"
+      end
     end
   end
 end

lib/diaspora_federation/entities/relayable.rb

@@ -93,6 +93,11 @@ module DiasporaFederation
         sender == author || sender == parent.author
       end
 
+      # @return [String] string representation of this object
+      def to_s
+        "#{super}#{":#{parent_type}" if respond_to?(:parent_type)}:#{parent_guid}"
+      end
+
       private
 
       # this happens only on downstream federation

lib/diaspora_federation/entities/relayable_retraction.rb

@@ -72,6 +72,11 @@ module DiasporaFederation
         Retraction.new(author: author, target_guid: target_guid, target_type: target_type, target: target)
       end
 
+      # @return [String] string representation of this object
+      def to_s
+        "RelayableRetraction:#{target_type}:#{target_guid}"
+      end
+
       private
 
       # @param [Nokogiri::XML::Element] root_node xml nodes

lib/diaspora_federation/entities/request.rb

@@ -24,6 +24,11 @@ module DiasporaFederation
         Contact.new(author: author, recipient: recipient)
       end
 
+      # @return [String] string representation of this object
+      def to_s
+        "Request:#{author}:#{recipient}"
+      end
+
       # @param [Nokogiri::XML::Element] root_node xml nodes
       # @return [Retraction] instance
       def self.populate_entity(root_node)

lib/diaspora_federation/entities/reshare.rb

@@ -22,6 +22,11 @@ module DiasporaFederation
       #   has no meaning at the moment
       #   @return [Boolean] public
       property :public, default: true # always true? (we only reshare public posts)
+
+      # @return [String] string representation of this object
+      def to_s
+        "#{super}:#{root_guid}"
+      end
     end
   end
 end

lib/diaspora_federation/entities/retraction.rb

@@ -42,6 +42,11 @@ module DiasporaFederation
         end
       end
 
+      # @return [String] string representation of this object
+      def to_s
+        "Retraction:#{target_type}:#{target_guid}"
+      end
+
       # @param [Nokogiri::XML::Element] root_node xml nodes
       # @return [Retraction] instance
       def self.populate_entity(root_node)

lib/diaspora_federation/entities/signed_retraction.rb

@@ -57,6 +57,11 @@ module DiasporaFederation
         Base64.strict_encode64(privkey.sign(Relayable::DIGEST, [ret.target_guid, ret.target_type].join(";")))
       end
 
+      # @return [String] string representation of this object
+      def to_s
+        "SignedRetraction:#{target_type}:#{target_guid}"
+      end
+
       private
 
       # @param [Nokogiri::XML::Element] root_node xml nodes

lib/diaspora_federation/entity.rb

@@ -131,6 +131,11 @@ module DiasporaFederation
       Entities.const_get(class_name)
     end
 
+    # @return [String] string representation of this object
+    def to_s
+      "#{self.class.name.rpartition('::').last}#{":#{guid}" if respond_to?(:guid)}"
+    end
+
     private
 
     def setable?(name, val)

lib/diaspora_federation/federation/receiver/abstract_receiver.rb

@@ -18,7 +18,7 @@ module DiasporaFederation
         def receive
           validate_and_receive
         rescue => e
-          logger.error "failed to receive #{entity.class}#{":#{entity.guid}" if entity.respond_to?(:guid)}"
+          logger.error "failed to receive #{entity}"
           raise e
         end
 
@@ -29,8 +29,7 @@ module DiasporaFederation
         def validate_and_receive
           validate
           DiasporaFederation.callbacks.trigger(:receive_entity, entity, recipient_id)
-          logger.info "successfully received #{entity.class}#{":#{entity.guid}" if entity.respond_to?(:guid)} " \
+          logger.info "successfully received #{entity} from person #{sender}#{" for #{recipient_id}" if recipient_id}"
-                      "from person #{sender}#{" for #{recipient_id}" if recipient_id}"
         end
 
         def validate

spec/lib/diaspora_federation/discovery/h_card_spec.rb

@@ -107,6 +107,7 @@ module DiasporaFederation
 </html>
 HTML
     }
+    let(:string) { "HCard:#{data[:guid]}" }
 
     it_behaves_like "an Entity subclass"
 

spec/lib/diaspora_federation/discovery/web_finger_spec.rb

@@ -36,6 +36,7 @@ module DiasporaFederation
 </XRD>
 XML
     }
+    let(:string) { "WebFinger:#{data[:acct_uri]}" }
 
     it_behaves_like "an Entity subclass"
 

spec/lib/diaspora_federation/entities/account_deletion_spec.rb

@@ -9,6 +9,7 @@ module DiasporaFederation
 </account_deletion>
 XML
     }
+    let(:string) { "AccountDeletion:#{data[:author]}" }
 
     it_behaves_like "an Entity subclass"
 

spec/lib/diaspora_federation/entities/comment_spec.rb

@@ -19,6 +19,7 @@ module DiasporaFederation
 </comment>
 XML
     }
+    let(:string) { "Comment:#{data[:guid]}:#{parent.guid}" }
 
     it_behaves_like "an Entity subclass", [:parent]
 

spec/lib/diaspora_federation/entities/contact_spec.rb

@@ -12,6 +12,7 @@ module DiasporaFederation
 </contact>
 XML
     }
+    let(:string) { "Contact:#{data[:author]}:#{data[:recipient]}" }
 
     it_behaves_like "an Entity subclass"
 

spec/lib/diaspora_federation/entities/conversation_spec.rb

@@ -31,6 +31,7 @@ module DiasporaFederation
 </conversation>
 XML
     }
+    let(:string) { "Conversation:#{data[:guid]}" }
 
     it_behaves_like "an Entity subclass"
 

spec/lib/diaspora_federation/entities/like_spec.rb

@@ -25,6 +25,7 @@ module DiasporaFederation
 </like>
 XML
     }
+    let(:string) { "Like:#{data[:guid]}:Post:#{parent.guid}" }
 
     it_behaves_like "an Entity subclass", [:parent]
 

spec/lib/diaspora_federation/entities/location_spec.rb

@@ -11,6 +11,7 @@ module DiasporaFederation
 </location>
 XML
     }
+    let(:string) { "Location" }
 
     it_behaves_like "an Entity subclass"
 

spec/lib/diaspora_federation/entities/message_spec.rb

@@ -21,6 +21,7 @@ module DiasporaFederation
 </message>
 XML
     }
+    let(:string) { "Message:#{data[:guid]}:#{parent.guid}" }
 
     it_behaves_like "an Entity subclass", [:parent]
 

spec/lib/diaspora_federation/entities/participation_spec.rb

@@ -24,6 +24,7 @@ module DiasporaFederation
 </participation>
 XML
     }
+    let(:string) { "Participation:#{data[:guid]}:Post:#{parent.guid}" }
 
     it_behaves_like "an Entity subclass", [:parent]
 

spec/lib/diaspora_federation/entities/person_spec.rb

@@ -27,6 +27,7 @@ module DiasporaFederation
 </person>
 XML
     }
+    let(:string) { "Person:#{data[:guid]}" }
 
     it_behaves_like "an Entity subclass"
 

spec/lib/diaspora_federation/entities/photo_spec.rb

@@ -18,6 +18,7 @@ module DiasporaFederation
 </photo>
 XML
     }
+    let(:string) { "Photo:#{data[:guid]}" }
 
     it_behaves_like "an Entity subclass"
 

spec/lib/diaspora_federation/entities/poll_answer_spec.rb

@@ -10,6 +10,7 @@ module DiasporaFederation
 </poll_answer>
 XML
     }
+    let(:string) { "PollAnswer:#{data[:guid]}" }
 
     it_behaves_like "an Entity subclass"
 

spec/lib/diaspora_federation/entities/poll_participation_spec.rb

@@ -23,6 +23,7 @@ module DiasporaFederation
 </poll_participation>
 XML
     }
+    let(:string) { "PollParticipation:#{data[:guid]}:#{parent.guid}" }
 
     it_behaves_like "an Entity subclass", [:parent]
 

spec/lib/diaspora_federation/entities/poll_spec.rb

@@ -11,6 +11,7 @@ module DiasporaFederation
 </poll>
 XML
     }
+    let(:string) { "Poll:#{data[:guid]}" }
 
     it_behaves_like "an Entity subclass"
 

spec/lib/diaspora_federation/entities/profile_spec.rb

@@ -21,6 +21,7 @@ module DiasporaFederation
 </profile>
 XML
     }
+    let(:string) { "Profile:#{data[:author]}" }
 
     it_behaves_like "an Entity subclass"
 

spec/lib/diaspora_federation/entities/related_entity_spec.rb

@@ -1,6 +1,7 @@
 module DiasporaFederation
   describe Entities::RelatedEntity do
     let(:data) { FactoryGirl.attributes_for(:related_entity) }
+    let(:string) { "RelatedEntity" }
 
     it_behaves_like "an Entity subclass"
   end

spec/lib/diaspora_federation/entities/relayable_retraction_spec.rb

@@ -32,6 +32,7 @@ module DiasporaFederation
 </relayable_retraction>
 XML
     }
+    let(:string) { "RelayableRetraction:#{data[:target_type]}:#{data[:target_guid]}" }
 
     it_behaves_like "an Entity subclass", [:target]
 

spec/lib/diaspora_federation/entities/request_spec.rb

@@ -10,6 +10,7 @@ module DiasporaFederation
 </request>
 XML
     }
+    let(:string) { "Request:#{data[:author]}:#{data[:recipient]}" }
 
     it_behaves_like "an Entity subclass"
 

spec/lib/diaspora_federation/entities/reshare_spec.rb

@@ -15,6 +15,7 @@ module DiasporaFederation
 </reshare>
 XML
     }
+    let(:string) { "Reshare:#{data[:guid]}:#{data[:root_guid]}" }
 
     it_behaves_like "an Entity subclass"
 

spec/lib/diaspora_federation/entities/retraction_spec.rb

@@ -20,6 +20,7 @@ module DiasporaFederation
 </retraction>
 XML
     }
+    let(:string) { "Retraction:#{data[:target_type]}:#{data[:target_guid]}" }
 
     it_behaves_like "an Entity subclass", [:target]
 

spec/lib/diaspora_federation/entities/signed_retraction_spec.rb

@@ -22,6 +22,7 @@ module DiasporaFederation
 </signed_retraction>
 XML
     }
+    let(:string) { "SignedRetraction:#{data[:target_type]}:#{data[:target_guid]}" }
 
     it_behaves_like "an Entity subclass", [:target]
 

spec/lib/diaspora_federation/entities/status_message_spec.rb

@@ -53,6 +53,7 @@ module DiasporaFederation
 </status_message>
       XML
     }
+    let(:string) { "StatusMessage:#{data[:guid]}" }
 
     it_behaves_like "an Entity subclass"
 

spec/support/shared_entity_specs.rb

@@ -31,6 +31,12 @@ shared_examples "an Entity subclass" do |ignored_props=[]|
         expect(hash).to eq(data)
       end
     end
+
+    describe "#to_s" do
+      it "should represent the entity as string" do
+        expect(instance.to_s).to eq(string)
+      end
+    end
   end
 end