diaspora_federation 0.1.1 → 0.1.2

data/lib/diaspora_federation/entity.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   # +Entity+ is the base class for all other objects used to encapsulate data
-  # for federation messages in the Diaspora* network.
+  # for federation messages in the diaspora* network.
   # Entity fields are specified using a simple {PropertiesDSL DSL} as part of
   # the class definition.
   #
@@ -231,7 +231,7 @@ module DiasporaFederation
       end
     end
 
-    # create simple node, fill it with text and append to root
+    # Create simple node, fill it with text and append to root
     def simple_node(doc, name, value)
       xml_name = self.class.xml_names[name]
       Nokogiri::XML::Element.new(xml_name ? xml_name.to_s : name, doc).tap do |node|
@@ -268,7 +268,7 @@ module DiasporaFederation
       end
     end
 
-    # create simple entry in data hash
+    # Create simple entry in data hash
     #
     # @param [String] name xml tag to parse
     # @param [Nokogiri::XML::Element] root_node XML root_node to parse
@@ -279,24 +279,24 @@ module DiasporaFederation
       node.first.text if node.any?
     end
 
-    # create an entry in the data hash for the nested entity
+    # Create an entry in the data hash for the nested entity
     #
     # @param [Class] type target type to parse
     # @param [Nokogiri::XML::Element] root_node XML node to parse
     # @return [Entity] parsed child entity
     private_class_method def self.parse_entity_from_node(type, root_node)
       node = root_node.xpath(type.entity_name)
-      type.from_xml(node.first) if node.any?
+      type.from_xml(node.first) if node.any? && node.first.children.any?
     end
 
-    # collect all nested children of that type and create an array in the data hash
+    # Collect all nested children of that type and create an array in the data hash
     #
     # @param [Class] type target type to parse
     # @param [Nokogiri::XML::Element] root_node XML node to parse
     # @return [Array<Entity>] array with parsed child entities
     private_class_method def self.parse_array_from_node(type, root_node)
       node = root_node.xpath(type.entity_name)
-      node.map {|child| type.from_xml(child) } unless node.empty?
+      node.select {|child| child.children.any? }.map {|child| type.from_xml(child) } unless node.empty?
     end
 
     # Raised, if entity is not valid

data/lib/diaspora_federation/federation/fetcher.rb

@@ -1,9 +1,9 @@
 module DiasporaFederation
   module Federation
-    # this module is for fetching entities from other pods
+    # This module is for fetching entities from other pods.
     module Fetcher
-      # fetches a public entity from a remote pod
-      # @param [String] author the diaspora ID of the author of the entity
+      # Fetches a public entity from a remote pod
+      # @param [String] author the diaspora* ID of the author of the entity
       # @param [Symbol, String] entity_type snake_case version of the entity class
       # @param [String] guid guid of the entity to fetch
       def self.fetch_public(author, entity_type, guid)

data/lib/diaspora_federation/federation/receiver.rb

@@ -1,10 +1,10 @@
 module DiasporaFederation
   module Federation
-    # this module is for parse and receive entities.
+    # This module parses and receives entities.
     module Receiver
       extend Logging
 
-      # receive a public message
+      # Receive a public message
       # @param [String] data message to receive
       # @param [Boolean] legacy use old slap parser
       def self.receive_public(data, legacy=false)
@@ -21,7 +21,7 @@ module DiasporaFederation
         raise e
       end
 
-      # receive a private message
+      # Receive a private message
       # @param [String] data message to receive
       # @param [OpenSSL::PKey::RSA] recipient_private_key recipient private key to decrypt the message
       # @param [Object] recipient_id the identifier to persist the entity for the correct user,

data/lib/diaspora_federation/federation/receiver/abstract_receiver.rb

@@ -1,11 +1,11 @@
 module DiasporaFederation
   module Federation
     module Receiver
-      # common functionality for receivers
+      # Common functionality for receivers
       class AbstractReceiver
         include Logging
 
-        # create a new receiver
+        # Creates a new receiver
         # @param [MagicEnvelope] magic_envelope the received magic envelope
         # @param [Object] recipient_id the identifier of the recipient of a private message
         def initialize(magic_envelope, recipient_id=nil)
@@ -14,7 +14,7 @@ module DiasporaFederation
           @recipient_id = recipient_id
         end
 
-        # validate and receive the entity
+        # Validates and receives the entity
         def receive
           validate_and_receive
         rescue => e

data/lib/diaspora_federation/federation/receiver/private.rb

@@ -1,7 +1,7 @@
 module DiasporaFederation
   module Federation
     module Receiver
-      # receiver for private entities
+      # Receiver for private entities
       class Private < AbstractReceiver
         private
 

data/lib/diaspora_federation/federation/receiver/public.rb

@@ -1,7 +1,7 @@
 module DiasporaFederation
   module Federation
     module Receiver
-      # receiver for public entities
+      # Receiver for public entities
       class Public < AbstractReceiver
         private
 

data/lib/diaspora_federation/federation/sender/hydra_wrapper.rb

@@ -11,12 +11,13 @@ module DiasporaFederation
         # @return [Hash] hydra opts
         def self.hydra_opts
           @hydra_opts ||= {
-            maxredirs: DiasporaFederation.http_redirect_limit,
-            timeout:   DiasporaFederation.http_timeout,
-            method:    :post,
-            verbose:   DiasporaFederation.http_verbose,
-            cainfo:    DiasporaFederation.certificate_authorities,
-            headers:   {
+            maxredirs:    DiasporaFederation.http_redirect_limit,
+            timeout:      DiasporaFederation.http_timeout,
+            method:       :post,
+            verbose:      DiasporaFederation.http_verbose,
+            cainfo:       DiasporaFederation.certificate_authorities,
+            forbid_reuse: true,
+            headers:      {
               "Expect"            => "",
               "Transfer-Encoding" => "",
               "User-Agent"        => DiasporaFederation.http_user_agent

data/lib/diaspora_federation/http_client.rb

@@ -2,7 +2,7 @@ require "faraday"
 require "faraday_middleware/response/follow_redirects"
 
 module DiasporaFederation
-  # A wrapper for {https://github.com/lostisland/faraday Faraday}.
+  # A wrapper for {https://github.com/lostisland/faraday Faraday}
   #
   # @see Discovery::Discovery
   # @see Federation::Fetcher
@@ -15,7 +15,7 @@ module DiasporaFederation
       connection.get(uri)
     end
 
-    # gets the Faraday connection
+    # Gets the Faraday connection
     #
     # @return [Faraday::Connection] the response
     def self.connection

data/lib/diaspora_federation/logging.rb

@@ -1,9 +1,9 @@
 module DiasporaFederation
-  # logging module for the diaspora federation
+  # Logging module for the diaspora* federation
   #
-  # it uses the logging-gem if available
+  # It uses the logging-gem if available.
   module Logging
-    # add +logger+ also as class method when included
+    # Add +logger+ also as class method when included
     # @param [Class] klass the class into which the module is included
     def self.included(klass)
       klass.extend(self)
@@ -11,15 +11,15 @@ module DiasporaFederation
 
     private
 
-    # get the logger for this class
+    # Get the logger for this class
     #
-    # use the logging-gem if available, else use a default logger
+    # Use the logging-gem if available, else use a default logger.
     def logger
       @logger ||= begin
-                    # use logging-gem if available
+                    # Use logging-gem if available
                     return ::Logging::Logger[self] if defined?(::Logging::Logger)
 
-                    # use rails logger if running in rails and no logging-gem is available
+                    # Use rails logger if running in rails and no logging-gem is available
                     return ::Rails.logger if defined?(::Rails)
 
                     # fallback logger

data/lib/diaspora_federation/properties_dsl.rb

@@ -75,7 +75,7 @@ module DiasporaFederation
       @xml_names ||= {}
     end
 
-    # finds a property by +xml_name+ or +name+
+    # Finds a property by +xml_name+ or +name+
     # @param [String] xml_name name of the property from the received xml
     # @return [Hash] the property data
     def find_property_for_xml_name(xml_name)
@@ -114,14 +114,14 @@ module DiasporaFederation
       define_alias(name, opts[:alias]) if opts.has_key? :alias
     end
 
-    # checks if the name is a +Symbol+ or a +String+
+    # Checks if the name is a +Symbol+ or a +String+
     # @param [String, Symbol] name the name to check
     # @return [Boolean]
     def name_valid?(name)
       name.instance_of?(Symbol)
     end
 
-    # checks if the type extends {Entity}
+    # Checks if the type extends {Entity}
     # @param [Class] type the type to check
     # @return [Boolean]
     def type_valid?(type)

data/lib/diaspora_federation/salmon.rb

@@ -1,5 +1,5 @@
 module DiasporaFederation
-  # This module contains a Diaspora*-specific implementation of parts of the
+  # This module contains a diaspora*-specific implementation of parts of the
   # {http://www.salmon-protocol.org/ Salmon Protocol}.
   module Salmon
     # XML namespace url

data/lib/diaspora_federation/salmon/aes.rb

@@ -1,18 +1,18 @@
 module DiasporaFederation
   module Salmon
-    # class for AES encryption and decryption
+    # Class for AES encryption and decryption
     class AES
       # OpenSSL aes cipher definition
       CIPHER = "AES-256-CBC".freeze
 
-      # generates a random AES key and initialization vector
+      # Generates a random AES key and initialization vector
       # @return [Hash] { key: "...", iv: "..." }
       def self.generate_key_and_iv
         cipher = OpenSSL::Cipher.new(CIPHER)
         {key: cipher.random_key, iv: cipher.random_iv}
       end
 
-      # encrypts the given data with an AES cipher defined by the given key
+      # Encrypts the given data with an AES cipher defined by the given key
       # and iv and returns the resulting ciphertext base64 strict_encoded.
       # @param [String] data plain input
       # @param [String] key AES key
@@ -34,7 +34,7 @@ module DiasporaFederation
         Base64.strict_encode64(ciphertext)
       end
 
-      # decrypts the given ciphertext with an AES cipher defined by the given key
+      # Decrypts the given ciphertext with an AES cipher defined by the given key
       # and iv. +ciphertext+ is expected to be base64 encoded
       # @param [String] ciphertext input data
       # @param [String] key AES key

data/lib/diaspora_federation/salmon/encrypted_slap.rb

@@ -3,14 +3,14 @@ require "json"
 module DiasporaFederation
   module Salmon
     # +EncryptedSlap+ provides class methods for generating and parsing encrypted
-    # Slaps. (In principle the same as  {Slap}, but with encryption.)
+    # Slaps. (In principle the same as {Slap}, but with encryption.)
     #
     # The basic encryption mechanism used here is based on the knowledge that
     # asymmetrical encryption is slow and symmetrical encryption is fast. Keeping in
     # mind that a message we want to de-/encrypt may greatly vary in length,
     # performance considerations must play a part of this scheme.
     #
-    # A Diaspora*-flavored encrypted magic-enveloped XML message looks like the following:
+    # A diaspora*-flavored encrypted magic-enveloped XML message looks like the following:
     #
     #   <?xml version="1.0" encoding="UTF-8"?>
     #   <diaspora xmlns="https://joindiaspora.com/protocol" xmlns:me="http://salmon-protocol.org/ns/magic-env">
@@ -63,7 +63,7 @@ module DiasporaFederation
     # @deprecated
     class EncryptedSlap < Slap
       # the author of the slap
-      # @param [String] value the author diaspora id
+      # @param [String] value the author diaspora* ID
       attr_writer :author_id
 
       # the key and iv if it is an encrypted slap
@@ -100,7 +100,7 @@ module DiasporaFederation
 
       # Creates an encrypted Salmon Slap.
       #
-      # @param [String] author_id Diaspora* handle of the author
+      # @param [String] author_id diaspora* ID of the author
       # @param [OpenSSL::PKey::RSA] privkey sender private key for signing the magic envelope
       # @param [Entity] entity payload
       # @return [EncryptedSlap] encrypted Slap instance
@@ -136,7 +136,7 @@ module DiasporaFederation
 
       private
 
-      # decrypts and reads the data from the encrypted XML header
+      # Decrypts and reads the data from the encrypted XML header
       # @param [String] data base64 encoded, encrypted header data
       # @param [OpenSSL::PKey::RSA] privkey private key for decryption
       # @return [Hash] { iv: "...", aes_key: "...", author_id: "..." }
@@ -151,7 +151,7 @@ module DiasporaFederation
         {iv: iv, aes_key: key, author_id: author_id}
       end
 
-      # decrypts the xml header
+      # Decrypts the xml header
       # @param [String] data base64 encoded, encrypted header data
       # @param [OpenSSL::PKey::RSA] privkey private key for decryption
       # @return [Nokogiri::XML::Element] header xml document
@@ -163,8 +163,8 @@ module DiasporaFederation
         Nokogiri::XML::Document.parse(xml).root
       end
 
-      # encrypt the header xml with an AES cipher and encrypt the cipher params
-      # with the recipients public_key
+      # Encrypt the header xml with an AES cipher and encrypt the cipher params
+      # with the recipients public_key.
       # @param [String] author_id diaspora_handle
       # @param [Hash] envelope_key envelope cipher params
       # @param [OpenSSL::PKey::RSA] pubkey recipient public_key
@@ -182,7 +182,7 @@ module DiasporaFederation
         Base64.strict_encode64(json_header)
       end
 
-      # generate the header xml string, including the author, aes_key and iv
+      # Generate the header xml string, including the author, aes_key and iv
       # @param [String] author_id diaspora_handle of the author
       # @param [Hash] envelope_key { key: "...", iv: "..." } (values in base64)
       # @return [String] header XML string

data/lib/diaspora_federation/salmon/magic_envelope.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Salmon
-    # Represents a Magic Envelope for Diaspora* federation messages.
+    # Represents a Magic Envelope for diaspora* federation messages
     #
     # When generating a Magic Envelope, an instance of this class is created and
     # the contents are specified on initialization. Optionally, the payload can be
@@ -23,26 +23,26 @@ module DiasporaFederation
     class MagicEnvelope
       include Logging
 
-      # encoding used for the payload data
+      # Encoding used for the payload data
       ENCODING = "base64url".freeze
 
-      # algorithm used for signing the payload data
+      # Algorithm used for signing the payload data
       ALGORITHM = "RSA-SHA256".freeze
 
-      # mime type describing the payload data
+      # Mime type describing the payload data
       DATA_TYPE = "application/xml".freeze
 
-      # digest instance used for signing
+      # Digest instance used for signing
       DIGEST = OpenSSL::Digest::SHA256.new
 
       # XML namespace url
       XMLNS = "http://salmon-protocol.org/ns/magic-env".freeze
 
-      # the payload entity of the magic envelope
+      # The payload entity of the magic envelope
       # @return [Entity] payload entity
       attr_reader :payload
 
-      # the sender of the magic envelope
+      # The sender of the magic envelope
       # @return [String] diaspora-ID of the sender
       attr_reader :sender
 
@@ -101,7 +101,7 @@ module DiasporaFederation
       # @see AES#decrypt
       #
       # @param [Nokogiri::XML::Element] magic_env XML root node of a magic envelope
-      # @param [String] sender diaspora-ID of the sender or nil
+      # @param [String] sender diaspora* ID of the sender or nil
       # @param [Hash] cipher_params hash containing the key and iv for
       #   AES-decrypting previously encrypted data. E.g.: { iv: "...", key: "..." }
       #
@@ -132,7 +132,7 @@ module DiasporaFederation
 
       private
 
-      # the payload data as string
+      # The payload data as string
       # @return [String] payload data
       def payload_data
         @payload_data ||= XmlPayload.pack(@payload).to_xml.strip.tap do |data|
@@ -155,7 +155,7 @@ module DiasporaFederation
         }.doc.root
       end
 
-      # create the signature for all fields according to specification
+      # Creates the signature for all fields according to specification
       #
       # @param [OpenSSL::PKey::RSA] privkey private key used for signing
       # @return [String] the signature
@@ -173,7 +173,7 @@ module DiasporaFederation
       end
 
       # @param [Nokogiri::XML::Element] env magic envelope XML
-      # @param [String] sender diaspora-ID of the sender or nil
+      # @param [String] sender diaspora* ID of the sender or nil
       # @return [Boolean]
       private_class_method def self.signature_valid?(env, sender)
         subject = sig_subject([Base64.urlsafe_decode64(env.at_xpath("me:data").content),
@@ -188,18 +188,18 @@ module DiasporaFederation
         sender_key.verify(DIGEST, sig, subject)
       end
 
-      # reads the +key_id+ from the magic envelope
+      # Reads the +key_id+ from the magic envelope.
       # @param [Nokogiri::XML::Element] env magic envelope XML
-      # @return [String] diaspora-ID of the sender
+      # @return [String] diaspora* ID of the sender
       private_class_method def self.sender(env)
         key_id = env.at_xpath("me:sig")["key_id"]
         raise InvalidEnvelope, "no key_id" unless key_id # TODO: move to `envelope_valid?`
         Base64.urlsafe_decode64(key_id)
       end
 
-      # constructs the signature subject.
-      # the given array should consist of the data, data_type (mimetype), encoding
-      # and the algorithm
+      # Constructs the signature subject.
+      # The given array should consist of the data, data_type (mimetype), encoding
+      # and the algorithm.
       # @param [Array<String>] data_arr
       # @return [String] signature subject
       private_class_method def self.sig_subject(data_arr)

data/lib/diaspora_federation/salmon/slap.rb

@@ -3,7 +3,7 @@ module DiasporaFederation
     # +Slap+ provides class methods to create unencrypted Slap XML from payload
     # data and parse incoming XML into a Slap instance.
     #
-    # A Diaspora*-flavored magic-enveloped XML message looks like the following:
+    # A diaspora* flavored magic-enveloped XML message looks like the following:
     #
     #   <?xml version="1.0" encoding="UTF-8"?>
     #   <diaspora xmlns="https://joindiaspora.com/protocol" xmlns:me="http://salmon-protocol.org/ns/magic-env">
@@ -51,7 +51,7 @@ module DiasporaFederation
 
       # Creates an unencrypted Salmon Slap and returns the XML string.
       #
-      # @param [String] author_id Diaspora* handle of the author
+      # @param [String] author_id diaspora* ID of the author
       # @param [OpenSSL::PKey::RSA] privkey sender private_key for signing the magic envelope
       # @param [Entity] entity payload
       # @return [String] Salmon XML string