diaspora_federation 0.2.7 → 1.0.0

data/lib/diaspora_federation/parsers/json_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Parsers
     # This is a parser of JSON serialized object. JSON object format is defined by
@@ -15,27 +17,29 @@ module DiasporaFederation
       private
 
       def parse_entity_data(entity_data)
-        hash = entity_data.map {|key, value|
-          property = entity_type.find_property_for_xml_name(key)
+        hash = entity_data.to_h {|key, value|
+          property = entity_type.class_props.keys.find {|name| name.to_s == key }
           if property
             type = entity_type.class_props[property]
             [property, parse_element_from_value(type, entity_data[key])]
           else
             [key, value]
           end
-        }.to_h
+        }
 
         [hash]
       end
 
       def parse_element_from_value(type, value)
         return if value.nil?
+
         if %i[integer boolean timestamp].include?(type) && !value.is_a?(String)
           value
         elsif type.instance_of?(Symbol)
           parse_string(type, value)
         elsif type.instance_of?(Array)
           raise DeserializationError, "Expected array for #{type}" unless value.respond_to?(:map)
+
           value.map {|element|
             type.first.from_json(element)
           }
@@ -45,10 +49,9 @@ module DiasporaFederation
       end
 
       def from_json_sanity_validation(json_hash)
-        missing = %w[entity_type entity_data].map {|prop|
-          prop if json_hash[prop].nil?
-        }.compact.join(", ")
+        missing = %w[entity_type entity_data].select {|prop| json_hash[prop].nil? }.join(", ")
         raise DeserializationError, "Required properties are missing in JSON object: #{missing}" unless missing.empty?
+
         assert_parsability_of(json_hash["entity_type"])
       end
 

data/lib/diaspora_federation/parsers/relayable_json_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Parsers
     # This is a parser of JSON serialized object, that is normally used for parsing data of relayables.
@@ -18,6 +20,7 @@ module DiasporaFederation
       def from_json_sanity_validation(json_hash)
         super
         return unless json_hash["property_order"].nil?
+
         raise DeserializationError, "Required property is missing in JSON object: property_order"
       end
     end

data/lib/diaspora_federation/parsers/relayable_xml_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Parsers
     # This is a parser of XML serialized object that is normally used for parsing data of relayables.

data/lib/diaspora_federation/parsers/xml_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Parsers
     # This is a parser of XML serialized object.
@@ -12,23 +14,33 @@ module DiasporaFederation
       def parse(root_node)
         from_xml_sanity_validation(root_node)
 
-        hash = root_node.element_children.uniq(&:name).map {|child|
-          xml_name = child.name
-          property = entity_type.find_property_for_xml_name(xml_name)
+        hash = root_node.element_children.uniq(&:name).to_h {|child|
+          property, type = find_property_for(child.name)
           if property
-            type = class_properties[property]
-            value = parse_element_from_node(xml_name, type, root_node)
+            value = parse_element_from_node(child.name, type, root_node)
             [property, value]
           else
-            [xml_name, child.text]
+            [child.name, child.text]
           end
-        }.to_h
+        }
 
         [hash]
       end
 
       private
 
+      def find_property_for(xml_name)
+        class_properties.find {|name, type|
+          if type.instance_of?(Symbol)
+            name.to_s == xml_name
+          elsif type.instance_of?(Array)
+            type.first.entity_name == xml_name
+          elsif type.ancestors.include?(Entity)
+            type.entity_name == xml_name
+          end
+        }
+      end
+
       # @param [String] name property name to parse
       # @param [Class, Symbol] type target type to parse
       # @param [Nokogiri::XML::Element] root_node XML node to parse
@@ -51,7 +63,6 @@ module DiasporaFederation
       # @return [String] data
       def parse_string_from_node(name, type, root_node)
         node = root_node.xpath(name.to_s)
-        node = root_node.xpath(xml_names[name].to_s) if node.empty?
         parse_string(type, node.first.text) if node.any?
       end
 
@@ -77,6 +88,7 @@ module DiasporaFederation
 
       def from_xml_sanity_validation(root_node)
         raise ArgumentError, "only Nokogiri::XML::Element allowed" unless root_node.instance_of?(Nokogiri::XML::Element)
+
         assert_parsability_of(root_node.name)
       end
     end

data/lib/diaspora_federation/parsers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   # This namespace contains parsers which are used to deserialize federation entities
   # objects from supported formats (XML, JSON) to objects of DiasporaFederation::Entity

data/lib/diaspora_federation/properties_dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   # Provides a simple DSL for specifying {Entity} properties during class
   # definition.
@@ -6,7 +8,6 @@ module DiasporaFederation
   #   property :prop
   #   property :optional, default: false
   #   property :dynamic_default, default: -> { Time.now }
-  #   property :another_prop, xml_name: :another_name
   #   property :original_prop, alias: :alias_prop
   #   entity :nested, NestedEntity
   #   entity :multiple, [OtherEntity]
@@ -22,7 +23,6 @@ module DiasporaFederation
     # @param [Hash] opts further options
     # @option opts [Object, #call] :default a default value, making the
     #   property optional
-    # @option opts [Symbol] :xml_name another name used for xml generation
     def property(name, type, opts={})
       raise InvalidType unless property_type_valid?(type)
 
@@ -57,67 +57,34 @@ module DiasporaFederation
     # resolved on each call
     # @return [Hash] default values
     def default_values
-      optional_props.map {|name| [name, nil] }.to_h.merge(default_props).map {|name, prop|
-        [name, prop.respond_to?(:call) ? prop.call : prop]
-      }.to_h
+      optional_props.to_h {|name| [name, nil] }.merge(default_props).transform_values {|prop|
+        prop.respond_to?(:call) ? prop.call : prop
+      }
     end
 
     # @param [Hash] data entity data
     # @return [Hash] hash with resolved aliases
     def resolv_aliases(data)
-      data.map {|name, value|
+      data.to_h {|name, value|
         if class_prop_aliases.has_key? name
           prop_name = class_prop_aliases[name]
           raise InvalidData, "only use '#{name}' OR '#{prop_name}'" if data.has_key? prop_name
+
           [prop_name, value]
         else
           [name, value]
         end
-      }.to_h
-    end
-
-    # @return [Symbol] alias for the xml-generation/parsing
-    # @deprecated
-    def xml_names
-      @xml_names ||= {}
-    end
-
-    # 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)
-      class_props.keys.find {|name| name.to_s == xml_name || xml_names[name].to_s == xml_name }
+      }
     end
 
     private
 
-    # @deprecated
-    def determine_xml_name(name, type, opts={})
-      if !type.instance_of?(Symbol) && opts.has_key?(:xml_name)
-        raise ArgumentError, "xml_name is not supported for nested entities"
-      end
-
-      if type.instance_of?(Symbol)
-        if opts.has_key? :xml_name
-          raise InvalidName, "invalid xml_name" unless name_valid?(opts[:xml_name])
-          opts[:xml_name]
-        else
-          name
-        end
-      elsif type.instance_of?(Array)
-        type.first.entity_name.to_sym
-      elsif type.ancestors.include?(Entity)
-        type.entity_name.to_sym
-      end
-    end
-
     def define_property(name, type, opts={})
       raise InvalidName unless name_valid?(name)
 
       class_props[name] = type
       optional_props << name if opts[:optional]
       default_props[name] = opts[:default] if opts.has_key? :default
-      xml_names[name] = determine_xml_name(name, type, opts)
 
       instance_eval { attr_reader name }
 

data/lib/diaspora_federation/salmon/aes.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Salmon
     # Class for AES encryption and decryption
     class AES
       # OpenSSL aes cipher definition
-      CIPHER = "AES-256-CBC".freeze
+      CIPHER = "AES-256-CBC"
 
       # Generates a random AES key and initialization vector
       # @return [Hash] { key: "...", iv: "..." }
@@ -19,7 +21,7 @@ module DiasporaFederation
       # @param [String] iv AES initialization vector
       # @return [String] base64 encoded ciphertext
       # @raise [ArgumentError] if any of the arguments is missing or not the correct type
-      def self.encrypt(data, key, iv) # rubocop:disable Naming/UncommunicativeMethodParamName
+      def self.encrypt(data, key, iv) # rubocop:disable Naming/MethodParameterName
         raise ArgumentError unless data.instance_of?(String) &&
                                    key.instance_of?(String) &&
                                    iv.instance_of?(String)
@@ -41,7 +43,7 @@ module DiasporaFederation
       # @param [String] iv AES initialization vector
       # @return [String] decrypted plain message
       # @raise [ArgumentError] if any of the arguments is missing or not the correct type
-      def self.decrypt(ciphertext, key, iv) # rubocop:disable Naming/UncommunicativeMethodParamName
+      def self.decrypt(ciphertext, key, iv) # rubocop:disable Naming/MethodParameterName
         raise ArgumentError unless ciphertext.instance_of?(String) &&
                                    key.instance_of?(String) &&
                                    iv.instance_of?(String)

data/lib/diaspora_federation/salmon/encrypted_magic_envelope.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Salmon
     # This is a simple crypt-wrapper for {MagicEnvelope}.
@@ -36,7 +38,7 @@ module DiasporaFederation
         key = AES.generate_key_and_iv
         encrypted_env = AES.encrypt(magic_env.to_xml, key[:key], key[:iv])
 
-        encoded_key = key.map {|k, v| [k, Base64.strict_encode64(v)] }.to_h
+        encoded_key = key.transform_values {|v| Base64.strict_encode64(v) }
         encrypted_key = Base64.strict_encode64(pubkey.public_encrypt(JSON.generate(encoded_key)))
 
         JSON.generate(aes_key: encrypted_key, encrypted_magic_envelope: encrypted_env)
@@ -51,7 +53,7 @@ module DiasporaFederation
         encrypted_json = JSON.parse(encrypted_env)
 
         encoded_key = JSON.parse(privkey.private_decrypt(Base64.decode64(encrypted_json["aes_key"])))
-        key = encoded_key.map {|k, v| [k, Base64.decode64(v)] }.to_h
+        key = encoded_key.transform_values {|v| Base64.decode64(v) }
 
         xml = AES.decrypt(encrypted_json["encrypted_magic_envelope"], key["key"], key["iv"])
         Nokogiri::XML(xml).root

data/lib/diaspora_federation/salmon/exceptions.rb

@@ -1,25 +1,7 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Salmon
-    # Raised, if the element containing the Magic Envelope is missing from the XML
-    # @deprecated
-    class MissingMagicEnvelope < RuntimeError
-    end
-
-    # Raised, if the element containing the author is empty.
-    # @deprecated
-    class MissingAuthor < RuntimeError
-    end
-
-    # Raised, if the element containing the header is missing from the XML
-    # @deprecated
-    class MissingHeader < RuntimeError
-    end
-
-    # Raised, if the decrypted header has an unexpected XML structure
-    # @deprecated
-    class InvalidHeader < RuntimeError
-    end
-
     # Raised, if failed to fetch the public key of the sender of the received message
     class SenderKeyNotFound < RuntimeError
     end

data/lib/diaspora_federation/salmon/magic_envelope.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Salmon
     # Represents a Magic Envelope for diaspora* federation messages
@@ -24,19 +26,19 @@ module DiasporaFederation
       include Logging
 
       # Encoding used for the payload data
-      ENCODING = "base64url".freeze
+      ENCODING = "base64url"
 
       # Algorithm used for signing the payload data
-      ALGORITHM = "RSA-SHA256".freeze
+      ALGORITHM = "RSA-SHA256"
 
       # Mime type describing the payload data
-      DATA_TYPE = "application/xml".freeze
+      DATA_TYPE = "application/xml"
 
       # Digest instance used for signing
-      DIGEST = OpenSSL::Digest::SHA256.new
+      DIGEST = OpenSSL::Digest.new("SHA256")
 
       # XML namespace url
-      XMLNS = "http://salmon-protocol.org/ns/magic-env".freeze
+      XMLNS = "http://salmon-protocol.org/ns/magic-env"
 
       # The payload entity of the magic envelope
       # @return [Entity] payload entity
@@ -112,7 +114,8 @@ module DiasporaFederation
 
         logger.debug "unenvelop message from #{sender}:\n#{data}"
 
-        new(XmlPayload.unpack(Nokogiri::XML(data).root), sender)
+        xml = Nokogiri::XML(data).root
+        new(Entity.entity_class(xml.name).from_xml(xml), sender)
       end
 
       private
@@ -134,10 +137,8 @@ module DiasporaFederation
       # @yield [xml] Invokes the block with the
       #   {http://www.rubydoc.info/gems/nokogiri/Nokogiri/XML/Builder Nokogiri::XML::Builder}
       # @return [Nokogiri::XML::Element] XML root node
-      def build_xml
-        Nokogiri::XML::Builder.new(encoding: "UTF-8") {|xml|
-          yield xml
-        }.doc
+      def build_xml(&block)
+        Nokogiri::XML::Builder.new(encoding: "UTF-8", &block).doc
       end
 
       # Creates the signature for all fields according to specification
@@ -153,6 +154,7 @@ module DiasporaFederation
       # @raise [InvalidEnvelope] if the envelope XML structure is malformed
       private_class_method def self.validate_envelope(env)
         raise InvalidEnvelope unless env.instance_of?(Nokogiri::XML::Element) && env.name == "env"
+
         validate_element(env, "me:data")
         validate_element(env, "me:sig")
       end
@@ -188,6 +190,7 @@ module DiasporaFederation
       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
 

data/lib/diaspora_federation/salmon.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   # This module contains a diaspora*-specific implementation of parts of the
   # {http://www.salmon-protocol.org/ Salmon Protocol}.
   module Salmon
     # XML namespace url
-    XMLNS = "https://joindiaspora.com/protocol".freeze
+    XMLNS = "https://joindiaspora.com/protocol"
   end
 end
 
@@ -11,8 +13,5 @@ require "base64"
 
 require "diaspora_federation/salmon/aes"
 require "diaspora_federation/salmon/exceptions"
-require "diaspora_federation/salmon/xml_payload"
 require "diaspora_federation/salmon/magic_envelope"
 require "diaspora_federation/salmon/encrypted_magic_envelope"
-require "diaspora_federation/salmon/slap"
-require "diaspora_federation/salmon/encrypted_slap"

data/lib/diaspora_federation/validators/account_deletion_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::AccountDeletion}.

data/lib/diaspora_federation/validators/account_migration_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::AccountMigration}.

data/lib/diaspora_federation/validators/comment_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::Comment}.

data/lib/diaspora_federation/validators/contact_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::Contact}.

data/lib/diaspora_federation/validators/conversation_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::Conversation}.

data/lib/diaspora_federation/validators/embed_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::Embed}.

data/lib/diaspora_federation/validators/event_participation_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::EventParticipation}.

data/lib/diaspora_federation/validators/event_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::Event}.

data/lib/diaspora_federation/validators/h_card_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Discovery::HCard}.

data/lib/diaspora_federation/validators/like_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::Like}.

data/lib/diaspora_federation/validators/location_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::Location}.

data/lib/diaspora_federation/validators/message_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::Message}.

data/lib/diaspora_federation/validators/optional_aware_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # Abstract validator which only validates optional fields when they are not nil.
@@ -14,6 +16,7 @@ module DiasporaFederation
 
       def optional_props
         return [] unless @obj.class.respond_to?(:optional_props)
+
         @obj.class.optional_props
       end
     end

data/lib/diaspora_federation/validators/participation_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::Participation}.

data/lib/diaspora_federation/validators/person_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::Person}.

data/lib/diaspora_federation/validators/photo_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::Photo}.

data/lib/diaspora_federation/validators/poll_answer_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::PollAnswer}.

data/lib/diaspora_federation/validators/poll_participation_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::PollParticipation}.

data/lib/diaspora_federation/validators/poll_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::Poll}.

data/lib/diaspora_federation/validators/profile_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::Profile}.

data/lib/diaspora_federation/validators/related_entity_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::RelatedEntity}.

data/lib/diaspora_federation/validators/relayable_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This is included to validatros which validate entities which include {Entities::Relayable}.

data/lib/diaspora_federation/validators/reshare_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::Reshare}.

data/lib/diaspora_federation/validators/retraction_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DiasporaFederation
   module Validators
     # This validates a {Entities::Retraction}.

data/lib/diaspora_federation/validators/rules/birthday.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "date"
 
 module Validation
@@ -20,7 +22,7 @@ module Validation
         return true if value.nil? || (value.is_a?(String) && value.empty?)
         return true if value.is_a? Date
 
-        if value =~ /[0-9]{4}\-[0-9]{2}\-[0-9]{2}/
+        if value.is_a?(String) && value.match?(/[0-9]{4}-[0-9]{2}-[0-9]{2}/)
           date_field = value.split("-").map(&:to_i)
           return Date.valid_civil?(date_field[0], date_field[1], date_field[2])
         end

data/lib/diaspora_federation/validators/rules/boolean.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Validation
   module Rule
     # Boolean validation rule
@@ -17,14 +19,13 @@ module Validation
       def valid_value?(value)
         return false if value.nil?
 
-        if value.is_a?(String)
+        case value
+        when String
           true if value =~ /\A(true|false|t|f|yes|no|y|n|1|0)\z/i
-        elsif value.is_a?(Integer)
+        when Integer
           true if [1, 0].include?(value)
-        elsif [true, false].include?(value)
-          true
         else
-          false
+          [true, false].include?(value)
         end
       end
 

data/lib/diaspora_federation/validators/rules/diaspora_id.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Validation
   module Rule
     # diaspora* ID validation rule
@@ -22,7 +24,7 @@ module Validation
       end
 
       # The Regex for validating a full diaspora* ID
-      DIASPORA_ID = /\A#{DIASPORA_ID_REGEX}\z/u
+      DIASPORA_ID = /\A#{DIASPORA_ID_REGEX}\z/u.freeze
 
       # The error key for this rule
       # @return [Symbol] error key

data/lib/diaspora_federation/validators/rules/diaspora_id_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Validation
   module Rule
     # Rule for validating the number of diaspora* IDs in a string.
@@ -31,6 +33,7 @@ module Validation
         ids = value.split(";")
         return false if params.include?(:maximum) && ids.count > params[:maximum]
         return false if params.include?(:minimum) && ids.count < params[:minimum]
+
         ids.each do |id|
           return false if DiasporaId::DIASPORA_ID.match(id).nil?
         end