diaspora_federation 0.0.3 → 0.0.4

data/lib/diaspora_federation/{web_finger → discovery}/xrd_document.rb

@@ -1,5 +1,5 @@
 module DiasporaFederation
-  module WebFinger
+  module Discovery
     # This class implements basic handling of XRD documents as far as it is
     # necessary in the context of the protocols used with Diaspora* federation.
     #
@@ -92,19 +92,18 @@ module DiasporaFederation
       # @raise [InvalidDocument] if the XRD is malformed
       def self.xml_data(xrd_doc)
         doc = parse_xrd_document(xrd_doc)
-        data = {}
 
-        exp_elem = doc.at_xpath("xrd:XRD/xrd:Expires", NS)
-        data[:expires] = DateTime.strptime(exp_elem.content, DATETIME_FORMAT) unless exp_elem.nil?
+        {}.tap do |data|
+          exp_elem = doc.at_xpath("xrd:XRD/xrd:Expires", NS)
+          data[:expires] = DateTime.strptime(exp_elem.content, DATETIME_FORMAT) unless exp_elem.nil?
 
-        subj_elem = doc.at_xpath("xrd:XRD/xrd:Subject", NS)
-        data[:subject] = subj_elem.content unless subj_elem.nil?
+          subj_elem = doc.at_xpath("xrd:XRD/xrd:Subject", NS)
+          data[:subject] = subj_elem.content unless subj_elem.nil?
 
-        parse_aliases_from_xml_doc(doc, data)
-        parse_properties_from_xml_doc(doc, data)
-        parse_links_from_xml_doc(doc, data)
-
-        data
+          parse_aliases_from_xml_doc(doc, data)
+          parse_properties_from_xml_doc(doc, data)
+          parse_links_from_xml_doc(doc, data)
+        end
       end
 
       private

data/lib/diaspora_federation/entities.rb

@@ -0,0 +1,12 @@
+module DiasporaFederation
+  # This namespace contains all the entities used to encapsulate data that is
+  # passed around in the Diaspora* network as part of the federation protocol.
+  #
+  # All entities must be defined in this namespace. otherwise the XML
+  # de-serialization will fail.
+  module Entities
+  end
+end
+
+require "diaspora_federation/entities/profile"
+require "diaspora_federation/entities/person"

data/lib/diaspora_federation/entities/person.rb

@@ -0,0 +1,33 @@
+module DiasporaFederation
+  module Entities
+    # this entity contains the base data of a person
+    #
+    # @see Validators::PersonValidator
+    class Person < Entity
+      # @!attribute [r] guid
+      #   @see HCard#guid
+      #   @return [String] guid
+      property :guid
+
+      # @!attribute [r] diaspora_id
+      #   The diaspora ID of the person
+      #   @return [String] diaspora ID
+      property :diaspora_id, xml_name: :diaspora_handle
+
+      # @!attribute [r] url
+      #   @see WebFinger#seed_url
+      #   @return [String] link to the pod
+      property :url
+
+      # @!attribute [r] profile
+      #   all profile data of the person
+      #   @return [Profile] the profile of the person
+      entity :profile, Entities::Profile
+
+      # @!attribute [r] exported_key
+      #   @see HCard#public_key
+      #   @return [String] public key
+      property :exported_key
+    end
+  end
+end

data/lib/diaspora_federation/entities/profile.rb

@@ -0,0 +1,54 @@
+module DiasporaFederation
+  module Entities
+    # this entity contains all the profile data of a person
+    #
+    # @see Validators::ProfileValidator
+    class Profile < Entity
+      # @!attribute [r] diaspora_id
+      #   The diaspora ID of the person
+      #   @see Person#diaspora_id
+      #   @return [String] diaspora ID
+      property :diaspora_id, xml_name: :diaspora_handle
+
+      # @!attribute [r] first_name
+      #   @deprecated
+      #   @see #full_name
+      #   @see HCard#first_name
+      #   @return [String] first name
+      property :first_name, default: nil
+
+      # @!attribute [r] last_name
+      #   @deprecated
+      #   @see #full_name
+      #   @see HCard#last_name
+      #   @return [String] last name
+      property :last_name, default: nil
+
+      # @!attribute [r] image_url
+      #   @see HCard#photo_large_url
+      #   @return [String] url to the big avatar (300x300)
+      property :image_url, default: nil
+      # @!attribute [r] image_url_medium
+      #   @see HCard#photo_medium_url
+      #   @return [String] url to the medium avatar (100x100)
+      property :image_url_medium, default: nil
+      # @!attribute [r] image_url_small
+      #   @see HCard#photo_small_url
+      #   @return [String] url to the small avatar (50x50)
+      property :image_url_small, default: nil
+
+      property :birthday, default: nil
+      property :gender, default: nil
+      property :bio, default: nil
+      property :location, default: nil
+
+      # @!attribute [r] searchable
+      #   @see HCard#searchable
+      #   @return [Boolean] searchable flag
+      property :searchable, default: true
+
+      property :nsfw, default: false
+      property :tag_string, default: nil
+    end
+  end
+end

data/lib/diaspora_federation/entity.rb

@@ -15,6 +15,7 @@ module DiasporaFederation
   #     property :prop
   #     property :optional, default: false
   #     property :dynamic_default, default: -> { Time.now }
+  #     property :another_prop, xml_name: :another_name
   #     entity :nested, NestedEntity
   #     entity :multiple, [OtherEntity]
   #   end
@@ -37,6 +38,12 @@ module DiasporaFederation
     # Initializes the Entity with the given attribute hash and freezes the created
     # instance it returns.
     #
+    # After creation, the entity is validated against a Validator, if one is defined.
+    # The Validator needs to be in the {DiasporaFederation::Validators} namespace and
+    # named like "<EntityName>Validator". Only valid entities can be created.
+    #
+    # @see DiasporaFederation::Validators
+    #
     # @note Attributes not defined as part of the class definition ({PropertiesDSL#property},
     #       {PropertiesDSL#entity}) get discarded silently.
     #
@@ -50,16 +57,18 @@ module DiasporaFederation
       end
 
       self.class.default_values.merge(data).each do |k, v|
-        instance_variable_set("@#{k}", v) if setable?(k, v)
+        instance_variable_set("@#{k}", nilify(v)) if setable?(k, v)
       end
+
       freeze
+      validate
     end
 
     # Returns a Hash representing this Entity (attributes => values)
     # @return [Hash] entity data (mostly equal to the hash used for initialization).
     def to_h
       self.class.class_prop_names.each_with_object({}) do |prop, hash|
-        hash[prop] = send(prop)
+        hash[prop] = public_send(prop)
       end
     end
 
@@ -76,16 +85,12 @@ module DiasporaFederation
 
     # some of this is from Rails "Inflector.demodulize" and "Inflector.undersore"
     def self.entity_name
-      word = name.dup
-      i = word.rindex("::")
-      word = word[(i + 2)..-1] if i
-
-      word.gsub!("::", "/")
-      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
-      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
-      word.tr!("-", "_")
-      word.downcase!
-      word
+      name.rpartition("::").last.tap do |word|
+        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        word.tr!("-", "_")
+        word.downcase!
+      end
     end
 
     private
@@ -113,34 +118,61 @@ module DiasporaFederation
         val.all? {|v| v.instance_of?(t.first) })
     end
 
+    def nilify(value)
+      return nil if value.respond_to?(:empty?) && value.empty?
+      value
+    end
+
+    def validate
+      validator_name = "#{self.class.name.split('::').last}Validator"
+      return unless Validators.const_defined? validator_name
+
+      validator_class = Validators.const_get validator_name
+      validator = validator_class.new self
+      raise ValidationError, error_message(validator) unless validator.valid?
+    end
+
+    def error_message(validator)
+      errors = validator.errors.map do |prop, rule|
+        "property: #{prop}, value: #{public_send(prop).inspect}, rule: #{rule[:rule]}, with params: #{rule[:params]}"
+      end
+      "Failed validation for properties: #{errors.join(' | ')}"
+    end
+
     # Serialize the Entity into XML elements
     # @return [Nokogiri::XML::Element] root node
     def entity_xml
       doc = Nokogiri::XML::DocumentFragment.new(Nokogiri::XML::Document.new)
-      root_element = Nokogiri::XML::Element.new(self.class.entity_name, doc)
-
-      self.class.class_props.each do |prop_def|
-        name = prop_def[:name]
-        type = prop_def[:type]
-        if type == String
-          root_element << simple_node(doc, name)
-        else
-          # call #to_xml for each item and append to root
-          [*send(name)].compact.each do |item|
-            root_element << item.to_xml
-          end
+      Nokogiri::XML::Element.new(self.class.entity_name, doc).tap do |root_element|
+        self.class.class_props.each do |prop_def|
+          add_property_to_xml(doc, prop_def, root_element)
         end
       end
+    end
 
-      root_element
+    def add_property_to_xml(doc, prop_def, root_element)
+      property = prop_def[:name]
+      type = prop_def[:type]
+      if type == String
+        root_element << simple_node(doc, prop_def[:xml_name], property)
+      else
+        # call #to_xml for each item and append to root
+        [*public_send(property)].compact.each do |item|
+          root_element << item.to_xml
+        end
+      end
     end
 
     # create simple node, fill it with text and append to root
-    def simple_node(doc, name)
-      node = Nokogiri::XML::Element.new(name.to_s, doc)
-      data = send(name).to_s
-      node.content = data unless data.empty?
-      node
+    def simple_node(doc, name, property)
+      Nokogiri::XML::Element.new(name.to_s, doc).tap do |node|
+        data = public_send(property).to_s
+        node.content = data unless data.empty?
+      end
+    end
+
+    # Raised, if entity is not valid
+    class ValidationError < RuntimeError
     end
   end
 end

data/lib/diaspora_federation/fetcher.rb

@@ -0,0 +1,42 @@
+require "faraday"
+require "faraday_middleware/response/follow_redirects"
+require "typhoeus/adapters/faraday"
+
+module DiasporaFederation
+  # A wrapper for {https://github.com/lostisland/faraday Faraday} used for
+  # fetching
+  #
+  # @see Discovery::Discovery
+  class Fetcher
+    # Perform a GET request
+    #
+    # @param [String] uri the URI
+    # @return [Faraday::Response] the response
+    def self.get(uri)
+      connection.get(uri)
+    end
+
+    # gets the Faraday connection
+    #
+    # @return [Faraday::Connection] the response
+    def self.connection
+      create_default_connection unless @connection
+      @connection.dup
+    end
+
+    def self.create_default_connection
+      options = {
+        request: {timeout: 30},
+        ssl:     {ca_file: DiasporaFederation.certificate_authorities}
+      }
+
+      @connection = Faraday::Connection.new(options) do |builder|
+        builder.use FaradayMiddleware::FollowRedirects, limit: 4
+        builder.adapter :typhoeus
+      end
+
+      @connection.headers["User-Agent"] = "DiasporaFederation/#{DiasporaFederation::VERSION}"
+    end
+    private_class_method :create_default_connection
+  end
+end

data/lib/diaspora_federation/logging.rb

@@ -13,10 +13,12 @@ module DiasporaFederation
                     # 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
+                    return ::Rails.logger if defined?(::Rails)
+
                     # fallback logger
                     @logger = Logger.new(STDOUT)
-                    loglevel = defined?(::Rails) ? ::Rails.configuration.log_level.to_s.upcase : "INFO"
-                    @logger.level = Logger.const_get(loglevel)
+                    @logger.level = Logger::INFO
                     @logger
                   end
     end

data/lib/diaspora_federation/properties_dsl.rb

@@ -6,6 +6,7 @@ module DiasporaFederation
   #   property :prop
   #   property :optional, default: false
   #   property :dynamic_default, default: -> { Time.now }
+  #   property :another_prop, xml_name: :another_name
   #   entity :nested, NestedEntity
   #   entity :multiple, [OtherEntity]
   module PropertiesDSL
@@ -19,6 +20,7 @@ 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, opts={})
       define_property name, String, opts
     end
@@ -69,7 +71,14 @@ module DiasporaFederation
     def define_property(name, type, opts={})
       raise InvalidName unless name_valid?(name)
 
-      class_props << {name: name, type: type}
+      xml_name = name
+      if opts.has_key? :xml_name
+        raise ArgumentError, "xml_name is not supported for nested entities" unless type == String
+        xml_name = opts[:xml_name]
+        raise InvalidName, "invalid xml_name" unless name_valid?(xml_name)
+      end
+
+      class_props << {name: name, xml_name: xml_name, type: type}
       default_props[name] = opts[:default] if opts.has_key? :default
 
       instance_eval { attr_reader name }
@@ -79,7 +88,7 @@ module DiasporaFederation
     # @param [String, Symbol] name the name to check
     # @return [Boolean]
     def name_valid?(name)
-      name.instance_of?(Symbol) || name.instance_of?(String)
+      name.instance_of?(Symbol)
     end
 
     # checks if the type extends {Entity}

data/lib/diaspora_federation/validators.rb

@@ -0,0 +1,38 @@
+require "validation"
+require "validation/rule/regular_expression"
+require "validation/rule/not_empty"
+require "validation/rule/uri"
+
+# +valid+ gem namespace
+module Validation
+  # This module contains custom validation rules for various data field types.
+  # That includes types for which there are no provided rules by the +valid+ gem
+  # or types that are very specific to Diaspora* federation and need special handling.
+  # The rules are used inside the {DiasporaFederation::Validators validator classes}
+  # to perform basic sanity-checks on {DiasporaFederation::Entities federation entities}.
+  module Rule
+  end
+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/guid"
+require "diaspora_federation/validators/rules/nilable_uri"
+require "diaspora_federation/validators/rules/not_nil"
+require "diaspora_federation/validators/rules/public_key"
+require "diaspora_federation/validators/rules/tag_count"
+
+module DiasporaFederation
+  # Validators to perform basic sanity-checks on {DiasporaFederation::Entities federation entities}.
+  #
+  # The Validators are mapped with the entities by name. The naming schema
+  # is "<EntityName>Validator".
+  module Validators
+  end
+end
+
+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"

data/lib/diaspora_federation/validators/h_card_validator.rb

@@ -0,0 +1,30 @@
+module DiasporaFederation
+  module Validators
+    # This validates a {Discovery::HCard}
+    #
+    # @todo activate guid and public key validation after all pod have it in
+    #   the hcard.
+    #
+    # @note
+    class HCardValidator < Validation::Validator
+      include Validation
+
+      # rule :guid, :guid
+
+      # the name must not contain a semicolon because of mentions
+      # @{<full_name> ; <diaspora_id>}
+      rule :full_name, regular_expression: {regex: /\A[^;]{,70}\z/}
+      rule :first_name, regular_expression: {regex: /\A[^;]{,32}\z/}
+      rule :last_name, regular_expression: {regex: /\A[^;]{,32}\z/}
+
+      # this urls can be relative
+      rule :photo_large_url, [:not_nil, nilableURI: [:path]]
+      rule :photo_medium_url, [:not_nil, nilableURI: [:path]]
+      rule :photo_small_url, [:not_nil, nilableURI: [:path]]
+
+      # rule :exported_key, :public_key
+
+      rule :searchable, :boolean
+    end
+  end
+end