diaspora_federation 0.0.12 → 0.0.13

data/lib/diaspora_federation/salmon/slap.rb

@@ -21,49 +21,20 @@ module DiasporaFederation
     #   slap_xml = Slap.generate_xml(author_id, author_privkey, entity)
     #
     # @example Parsing a Salmon Slap
-    #   slap = Slap.from_xml(slap_xml)
-    #   author_pubkey = however_you_retrieve_the_authors_public_key(slap.author_id)
+    #   entity = Slap.from_xml(slap_xml).payload
     #
-    #   entity = slap.entity(author_pubkey)
+    # @deprecated
     class Slap
-      # the author of the slap
-      # @overload author_id
-      #   @return [String] the author diaspora id
-      # @overload author_id=
-      #   @param [String] the author diaspora id
-      attr_accessor :author_id
-
-      # the key and iv if it is an encrypted slap
-      # @param [Hash] value hash containing the key and iv
-      attr_writer :cipher_params
-
       # Namespaces
-      NS = {d: Salmon::XMLNS, me: MagicEnvelope::XMLNS}
-
-      # Returns new instance of the Entity that is contained within the XML of
-      # this Slap.
-      #
-      # The first time this is called, a public key has to be specified to verify
-      # the Magic Envelope signature. On repeated calls, the key may be omitted.
-      #
-      # @see MagicEnvelope.unenvelop
-      #
-      # @param [OpenSSL::PKey::RSA] pubkey public key for validating the signature
-      # @return [Entity] entity instance from the XML
-      # @raise [ArgumentError] if the public key is of the wrong type
-      def entity(pubkey=nil)
-        return @entity unless @entity.nil?
-
-        raise ArgumentError unless pubkey.instance_of?(OpenSSL::PKey::RSA)
-        @entity = MagicEnvelope.unenvelop(@magic_envelope, pubkey, @cipher_params)
-        @entity
-      end
+      NS = {d: Salmon::XMLNS, me: MagicEnvelope::XMLNS}.freeze
 
       # Parses an unencrypted Salmon XML string and returns a new instance of
-      # {Slap} populated with the XML data.
+      # {MagicEnvelope} with the XML data.
       #
       # @param [String] slap_xml Salmon XML
-      # @return [Slap] new Slap instance
+      #
+      # @return [MagicEnvelope] magic envelope instance with payload and sender
+      #
       # @raise [ArgumentError] if the argument is not a String
       # @raise [MissingAuthor] if the +author_id+ element is missing from the XML
       # @raise [MissingMagicEnvelope] if the +me:env+ element is missing from the XML
@@ -71,25 +42,23 @@ module DiasporaFederation
         raise ArgumentError unless slap_xml.instance_of?(String)
         doc = Nokogiri::XML::Document.parse(slap_xml)
 
-        Slap.new.tap do |slap|
-          author_elem = doc.at_xpath("d:diaspora/d:header/d:author_id", Slap::NS)
-          raise MissingAuthor if author_elem.nil? || author_elem.content.empty?
-          slap.author_id = author_elem.content
+        author_elem = doc.at_xpath("d:diaspora/d:header/d:author_id", Slap::NS)
+        raise MissingAuthor if author_elem.nil? || author_elem.content.empty?
+        sender = author_elem.content
 
-          slap.add_magic_env_from_doc(doc)
-        end
+        MagicEnvelope.unenvelop(magic_env_from_doc(doc), sender)
       end
 
       # Creates an unencrypted Salmon Slap and returns the XML string.
       #
       # @param [String] author_id Diaspora* handle of the author
-      # @param [OpenSSL::PKey::RSA] pkey sender private_key for signing the magic envelope
+      # @param [OpenSSL::PKey::RSA] privkey sender private_key for signing the magic envelope
       # @param [Entity] entity payload
       # @return [String] Salmon XML string
       # @raise [ArgumentError] if any of the arguments is not the correct type
-      def self.generate_xml(author_id, pkey, entity)
+      def self.generate_xml(author_id, privkey, entity)
         raise ArgumentError unless author_id.instance_of?(String) &&
-                                   pkey.instance_of?(OpenSSL::PKey::RSA) &&
+                                   privkey.instance_of?(OpenSSL::PKey::RSA) &&
                                    entity.is_a?(Entity)
 
         build_xml do |xml|
@@ -97,7 +66,7 @@ module DiasporaFederation
             xml.author_id(author_id)
           }
 
-          MagicEnvelope.new(pkey, entity).envelop(xml)
+          xml.parent << MagicEnvelope.new(entity, author_id).envelop(privkey)
         end
       end
 
@@ -107,22 +76,22 @@ module DiasporaFederation
       #   {http://www.rubydoc.info/gems/nokogiri/Nokogiri/XML/Builder Nokogiri::XML::Builder}
       # @return [String] Slap XML
       def self.build_xml
-        builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+        Nokogiri::XML::Builder.new(encoding: "UTF-8") {|xml|
           xml.diaspora("xmlns" => Salmon::XMLNS, "xmlns:me" => MagicEnvelope::XMLNS) {
             yield xml
           }
-        end
-        builder.to_xml
+        }.to_xml
       end
 
       # Parses the magic envelop from the document.
       #
       # @param [Nokogiri::XML::Document] doc Salmon XML Document
-      def add_magic_env_from_doc(doc)
-        @magic_envelope = doc.at_xpath("d:diaspora/me:env", Slap::NS).tap do |env|
+      def self.magic_env_from_doc(doc)
+        doc.at_xpath("d:diaspora/me:env", Slap::NS).tap do |env|
           raise MissingMagicEnvelope if env.nil?
         end
       end
+      private_class_method :magic_env_from_doc
     end
   end
 end

data/lib/diaspora_federation/salmon/xml_payload.rb

@@ -11,6 +11,7 @@ module DiasporaFederation
     #   </XML>
     #
     # (The +post+ element is there for historic reasons...)
+    # @deprecated
     module XmlPayload
       # Encapsulates an Entity inside the wrapping xml structure
       # and returns the XML Object.
@@ -39,122 +40,22 @@ module DiasporaFederation
       # @return [Entity] re-constructed Entity instance
       # @raise [ArgumentError] if the argument is not an
       #   {http://www.rubydoc.info/gems/nokogiri/Nokogiri/XML/Element Nokogiri::XML::Element}
-      # @raise [InvalidStructure] if the XML doesn't look like the wrapper XML
       # @raise [UnknownEntity] if the class for the entity contained inside the
       #   XML can't be found
       def self.unpack(xml)
         raise ArgumentError, "only Nokogiri::XML::Element allowed" unless xml.instance_of?(Nokogiri::XML::Element)
-        raise Salmon::InvalidStructure unless wrap_valid?(xml)
 
-        data = xml.at_xpath("post/*[1]")
-        klass_name = entity_class_name(data.name)
-        raise Salmon::UnknownEntity, "'#{klass_name}' not found" unless Entities.const_defined?(klass_name)
+        data = xml_wrapped?(xml) ? xml.at_xpath("post/*[1]") : xml
 
-        klass = Entities.const_get(klass_name)
-        populate_entity(klass, data)
+        Entity.entity_class(data.name).from_xml(data)
       end
 
-      private
-
       # @param [Nokogiri::XML::Element] element
-      def self.wrap_valid?(element)
+      def self.xml_wrapped?(element)
         (element.name == "XML" && !element.at_xpath("post").nil? &&
          !element.at_xpath("post").children.empty?)
       end
-      private_class_method :wrap_valid?
-
-      # Transform the given String from the lowercase underscored version to a
-      # camelized variant, used later for getting the Class constant.
-      #
-      # @param [String] term "snake_case" class name
-      # @return [String] "CamelCase" class name
-      def self.entity_class_name(term)
-        term.to_s.tap do |string|
-          raise Salmon::InvalidEntityName, "'#{string}' is invalid" unless string =~ /^[a-z]*(_[a-z]*)*$/
-          string.sub!(/^[a-z]/, &:upcase)
-          string.gsub!(/_([a-z])/) { Regexp.last_match[1].upcase }
-        end
-      end
-      private_class_method :entity_class_name
-
-      # Construct a new instance of the given Entity and populate the properties
-      # with the attributes found in the XML.
-      # Works recursively on nested Entities and Arrays thereof.
-      #
-      # @param [Class] klass entity class
-      # @param [Nokogiri::XML::Element] root_node xml nodes
-      # @return [Entity] instance
-      def self.populate_entity(klass, root_node)
-        # Use all known properties to build the Entity. All other elements are respected
-        # and attached to resulted hash as string. It is intended to build a hash
-        # invariable of an Entity definition, in order to support receiving objects
-        # from the future versions of Diaspora, where new elements may have been added.
-        data = Hash[root_node.element_children.map { |child|
-          xml_name = child.name
-          property = klass.class_props.find {|prop| prop[:xml_name].to_s == xml_name }
-          if property
-            parse_element_from_node(property[:name], property[:type], xml_name, root_node)
-          else
-            [xml_name, child.text]
-          end
-        }]
-
-        if klass.included_modules.include?(Entities::Relayable)
-          Entities::Relayable.verify_signatures(data, klass)
-        end
-
-        klass.new(data)
-      end
-      private_class_method :populate_entity
-
-      # @param [Symbol] name property name
-      # @param [Class] type target type to parse
-      # @param [String] xml_name xml tag to parse
-      # @param [Nokogiri::XML::Element] node XML node to parse
-      # @return [Array<Symbol, Object>] parsed data
-      def self.parse_element_from_node(name, type, xml_name, node)
-        if type == String
-          [name, parse_string_from_node(xml_name, node)]
-        elsif type.instance_of?(Array)
-          [name, parse_array_from_node(type, node)]
-        elsif type.ancestors.include?(Entity)
-          [name, parse_entity_from_node(type, node)]
-        end
-      end
-      private_class_method :parse_element_from_node
-
-      # create simple entry in data hash
-      #
-      # @param [String] name xml tag to parse
-      # @param [Nokogiri::XML::Element] root_node XML root_node to parse
-      # @return [String] data
-      def self.parse_string_from_node(name, root_node)
-        node = root_node.xpath(name.to_s)
-        node.first.text if node.any?
-      end
-      private_class_method :parse_string_from_node
-
-      # 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
-      def self.parse_entity_from_node(type, root_node)
-        node = root_node.xpath(type.entity_name)
-        populate_entity(type, node.first) if node.any?
-      end
-      private_class_method :parse_entity_from_node
-
-      # collect all nested children of that type and create an array in the data hash
-      #
-      # @param [Array<Class>] type target type to parse
-      # @param [Nokogiri::XML::Element] root_node XML node to parse
-      # @return [Array<Entity>] array with parsed child entities
-      def self.parse_array_from_node(type, root_node)
-        node = root_node.xpath(type.first.entity_name)
-        node.map {|child| populate_entity(type.first, child) }
-      end
-      private_class_method :parse_array_from_node
+      private_class_method :xml_wrapped?
     end
   end
 end

data/lib/diaspora_federation/validators.rb

@@ -19,11 +19,11 @@ end
 require "diaspora_federation/validators/rules/birthday"
 require "diaspora_federation/validators/rules/boolean"
 require "diaspora_federation/validators/rules/diaspora_id"
+require "diaspora_federation/validators/rules/diaspora_id_count"
 require "diaspora_federation/validators/rules/guid"
 require "diaspora_federation/validators/rules/not_nil"
 require "diaspora_federation/validators/rules/public_key"
 require "diaspora_federation/validators/rules/tag_count"
-require "diaspora_federation/validators/rules/diaspora_id_count"
 
 module DiasporaFederation
   # Validators to perform basic sanity-checks on {DiasporaFederation::Entities federation entities}.
@@ -34,25 +34,31 @@ module DiasporaFederation
   end
 end
 
+# abstract types
 require "diaspora_federation/validators/relayable_validator"
+
+# types
+require "diaspora_federation/validators/account_deletion_validator"
+require "diaspora_federation/validators/comment_validator"
+require "diaspora_federation/validators/contact_validator"
+require "diaspora_federation/validators/conversation_validator"
 require "diaspora_federation/validators/h_card_validator"
-require "diaspora_federation/validators/person_validator"
-require "diaspora_federation/validators/profile_validator"
-require "diaspora_federation/validators/web_finger_validator"
-require "diaspora_federation/validators/request_validator"
-require "diaspora_federation/validators/photo_validator"
-require "diaspora_federation/validators/location_validator"
-require "diaspora_federation/validators/status_message_validator"
-require "diaspora_federation/validators/participation_validator"
 require "diaspora_federation/validators/like_validator"
-require "diaspora_federation/validators/comment_validator"
-require "diaspora_federation/validators/account_deletion_validator"
+require "diaspora_federation/validators/location_validator"
 require "diaspora_federation/validators/message_validator"
-require "diaspora_federation/validators/conversation_validator"
-require "diaspora_federation/validators/relayable_retraction_validator"
+require "diaspora_federation/validators/participation_validator"
+require "diaspora_federation/validators/person_validator"
+require "diaspora_federation/validators/photo_validator"
+require "diaspora_federation/validators/poll_answer_validator"
+require "diaspora_federation/validators/poll_participation_validator"
+require "diaspora_federation/validators/poll_validator"
+require "diaspora_federation/validators/profile_validator"
 require "diaspora_federation/validators/reshare_validator"
 require "diaspora_federation/validators/retraction_validator"
+require "diaspora_federation/validators/status_message_validator"
+require "diaspora_federation/validators/web_finger_validator"
+
+# deprecated
+require "diaspora_federation/validators/relayable_retraction_validator"
+require "diaspora_federation/validators/request_validator"
 require "diaspora_federation/validators/signed_retraction_validator"
-require "diaspora_federation/validators/poll_answer_validator"
-require "diaspora_federation/validators/poll_validator"
-require "diaspora_federation/validators/poll_participation_validator"

data/lib/diaspora_federation/validators/account_deletion_validator.rb

@@ -4,7 +4,7 @@ module DiasporaFederation
     class AccountDeletionValidator < Validation::Validator
       include Validation
 
-      rule :diaspora_id, %i(not_empty diaspora_id)
+      rule :author, %i(not_empty diaspora_id)
     end
   end
 end

data/lib/diaspora_federation/validators/comment_validator.rb

@@ -4,14 +4,10 @@ module DiasporaFederation
     class CommentValidator < Validation::Validator
       include Validation
 
-      rule :guid, :guid
-
       include RelayableValidator
 
       rule :text, [:not_empty,
                    length: {maximum: 65_535}]
-
-      rule :diaspora_id, %i(not_empty diaspora_id)
     end
   end
 end

data/lib/diaspora_federation/validators/contact_validator.rb

@@ -0,0 +1,13 @@
+module DiasporaFederation
+  module Validators
+    # This validates a {Entities::Contact}
+    class ContactValidator < Validation::Validator
+      include Validation
+
+      rule :author, %i(not_empty diaspora_id)
+      rule :recipient, %i(not_empty diaspora_id)
+      rule :following, :boolean
+      rule :sharing, :boolean
+    end
+  end
+end

data/lib/diaspora_federation/validators/conversation_validator.rb

@@ -6,9 +6,9 @@ module DiasporaFederation
 
       rule :guid, :guid
 
-      rule :diaspora_id, %i(not_empty diaspora_id)
+      rule :author, %i(not_empty diaspora_id)
 
-      rule :participant_ids, diaspora_id_count: {maximum: 20}
+      rule :participants, diaspora_id_count: {maximum: 20}
     end
   end
 end

data/lib/diaspora_federation/validators/like_validator.rb

@@ -4,11 +4,9 @@ module DiasporaFederation
     class LikeValidator < Validation::Validator
       include Validation
 
-      rule :guid, :guid
-
       include RelayableValidator
 
-      rule :diaspora_id, %i(not_empty diaspora_id)
+      rule :parent_type, [:not_empty, regular_expression: {regex: /\A(Post|Comment)\z/}]
     end
   end
 end

data/lib/diaspora_federation/validators/message_validator.rb

@@ -4,12 +4,8 @@ module DiasporaFederation
     class MessageValidator < Validation::Validator
       include Validation
 
-      rule :guid, :guid
-
       include RelayableValidator
 
-      rule :diaspora_id, %i(not_empty diaspora_id)
-
       rule :conversation_guid, :guid
     end
   end

data/lib/diaspora_federation/validators/participation_validator.rb

@@ -4,13 +4,9 @@ module DiasporaFederation
     class ParticipationValidator < Validation::Validator
       include Validation
 
-      rule :guid, :guid
-
-      rule :target_type, :not_empty
-
       include RelayableValidator
 
-      rule :diaspora_id, %i(not_empty diaspora_id)
+      rule :parent_type, [:not_empty, regular_expression: {regex: /\APost\z/}]
     end
   end
 end

data/lib/diaspora_federation/validators/person_validator.rb

@@ -6,7 +6,7 @@ module DiasporaFederation
 
       rule :guid, :guid
 
-      rule :diaspora_id, %i(not_empty diaspora_id)
+      rule :author, %i(not_empty diaspora_id)
 
       rule :url, %i(not_nil URI)
 

data/lib/diaspora_federation/validators/photo_validator.rb

@@ -6,7 +6,7 @@ module DiasporaFederation
 
       rule :guid, :guid
 
-      rule :diaspora_id, %i(not_empty diaspora_id)
+      rule :author, %i(not_empty diaspora_id)
 
       rule :public, :boolean
 
@@ -14,7 +14,7 @@ module DiasporaFederation
 
       rule :remote_photo_name, :not_empty
 
-      rule :status_message_guid, :guid
+      rule :status_message_guid, guid: {nilable: true}
 
       rule :height, :numeric
 

data/lib/diaspora_federation/validators/poll_participation_validator.rb

@@ -4,12 +4,8 @@ module DiasporaFederation
     class PollParticipationValidator < Validation::Validator
       include Validation
 
-      rule :guid, :guid
-
       include RelayableValidator
 
-      rule :diaspora_id, %i(not_empty diaspora_id)
-
       rule :poll_answer_guid, :guid
     end
   end