diaspora_federation 0.2.3 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 42c68f5013a4c3f538bdf2d0c304d79b42e09ab5
-  data.tar.gz: a3a21dd08bac81bc602fbee8e9ce7f4f726d7413
+SHA256:
+  metadata.gz: 98803be0a780d1fdc7112c28c278550b279ab693e01ecfc268e3a7f43ce77a17
+  data.tar.gz: fd0b31783ca8f058ab3f9d9bd1154e3d229f7cbe663000b2dab5f23305f20ae5
 SHA512:
-  metadata.gz: d4858c3925cd46cd2adf8097066340445129c7630f6a41c8560edac13cc233c825d7b8ae593f3bc917848003f722f4035dca0bf6716c87edb56f99035ffd4b20
-  data.tar.gz: 8bca5a011c3bb00cc128ef5cea489fe1e575bcdb6a3a74cede7fa5336f7c86f6b102ed0e3980b2a370eeba42e14d6c0b7d99b29a40ee7673477645420d9c1bc8
+  metadata.gz: 57ec25012b75ba2895900923d1b48d9ae066542f2be88a6521d2ac862b24e64a402b75a84c657f89cc75fbc18d80631dbe4b5da29087adf3d27e2526967318fe
+  data.tar.gz: 44ef6a752b43a751dc006fa9d0bf7ea62d5ee3fa579549bf9c27598a67811dddc62c775061175f9c26309365ad0a43b5fe2dcc57a5bec23f1211ffc0f6dd6d05

data/Changelog.md

@@ -1,19 +1,61 @@
+# 0.2.7
+
+## Features
+
+* Add `remote_photo_path` to `AccountMigration` entity [#119](https://github.com/diaspora/diaspora_federation/pull/119)
+
+## Bug fixes
+
+* Only parse each nested element name once from the XML [#118](https://github.com/diaspora/diaspora_federation/pull/118)
+
+# 0.2.6
+
+## Bug fixes
+
+* Make `width` and `height` optional for photos in the JSON schema [#110](https://github.com/diaspora/diaspora_federation/pull/110)
+
+# 0.2.5
+
+## Features
+
+* Add `full_name` to `Profile` entity [#100](https://github.com/diaspora/diaspora_federation/pull/100)
+* Add `Embed` entity [#101](https://github.com/diaspora/diaspora_federation/pull/101)
+
+## Refactor
+
+* Include `web+` prefix in `diaspora://` URL parsing [#108](https://github.com/diaspora/diaspora_federation/pull/108)
+
+## Bug fixes
+
+* Various bug fixes in the `federation_entities.json` [#102](https://github.com/diaspora/diaspora_federation/pull/102) [#104](https://github.com/diaspora/diaspora_federation/pull/104) [#107](https://github.com/diaspora/diaspora_federation/pull/107)
+* Allow fetching of entities with dot in the GUID [#106](https://github.com/diaspora/diaspora_federation/pull/106)
+
+# 0.2.4
+
+## Features
+
+* Make some entities editable and add `edited_at` property [#94](https://github.com/diaspora/diaspora_federation/pull/94)
+
+## Bug fixes
+
+* Fix validation of optional properties (for example for WebFinger) [#97](https://github.com/diaspora/diaspora_federation/pull/97)
+
 # 0.2.3
 
 ## Features
 
-Add `blocking` flag to `Contact` entity [#80](https://github.com/diaspora/diaspora_federation/pull/80)
-Introduce alternative form for `AccountMigration` entity signature [#89](https://github.com/diaspora/diaspora_federation/pull/89)
+* Add `blocking` flag to `Contact` entity [#80](https://github.com/diaspora/diaspora_federation/pull/80)
+* Introduce alternative form for `AccountMigration` entity signature [#89](https://github.com/diaspora/diaspora_federation/pull/89)
 
 ## Refactor
 
-Extract signing of `AccountMigration` to a different module [#89](https://github.com/diaspora/diaspora_federation/pull/89)
-Remove participants limit for conversations [#91](https://github.com/diaspora/diaspora_federation/pull/91)
+* Extract signing of `AccountMigration` to a different module [#89](https://github.com/diaspora/diaspora_federation/pull/89)
+* Remove participants limit for conversations [#91](https://github.com/diaspora/diaspora_federation/pull/91)
 
 ## Bug fixes
 
-Fix when booleans in relayables are false [#90](https://github.com/diaspora/diaspora_federation/pull/90)
-Fix relayable signatures for messages with invalid XML characters [#95](https://github.com/diaspora/diaspora_federation/pull/95)
+* Fix when booleans in relayables are false [#90](https://github.com/diaspora/diaspora_federation/pull/90)
+* Fix relayable signatures for messages with invalid XML characters [#95](https://github.com/diaspora/diaspora_federation/pull/95)
 
 # 0.2.2
 

data/README.md

@@ -6,7 +6,6 @@
 
 [![Code Climate](https://codeclimate.com/github/diaspora/diaspora_federation/badges/gpa.svg)](https://codeclimate.com/github/diaspora/diaspora_federation)
 [![Test Coverage](https://codeclimate.com/github/diaspora/diaspora_federation/badges/coverage.svg)](https://codeclimate.com/github/diaspora/diaspora_federation/coverage)
-[![Dependency Status](https://gemnasium.com/diaspora/diaspora_federation.svg)](https://gemnasium.com/diaspora/diaspora_federation)
 [![Inline docs](https://inch-ci.org/github/diaspora/diaspora_federation.svg?branch=master)](https://inch-ci.org/github/diaspora/diaspora_federation)
 [![Gem Version](https://badge.fury.io/rb/diaspora_federation.svg)](https://badge.fury.io/rb/diaspora_federation)
 
@@ -38,25 +37,31 @@ Configure the engine in ```config/initializers/diaspora_federation.rb```:
 ```ruby
 DiasporaFederation.configure do |config|
   # the pod url
-  config.server_uri = AppConfig.pod_uri
+  config.server_uri = URI("http://localhost:3000")
+
+  # ... other settings
 
   config.define_callbacks do
     on :fetch_person_for_webfinger do |diaspora_id|
       person = Person.find_local_by_diaspora_id(diaspora_id)
       if person
         DiasporaFederation::Discovery::WebFinger.new(
-          # ...
+          # ... copy person attributes to WebFinger object
         )
       end
     end
 
     on :fetch_person_for_hcard do |guid|
-      # ...
+      # ... fetch hcard information
     end
+
+    # ... other callbacks
   end
 end
 ```
 
+The available config settings can be found [here](https://www.rubydoc.info/gems/diaspora_federation/DiasporaFederation#class_attr_details) and the callbacks are listed [here](https://www.rubydoc.info/gems/diaspora_federation/DiasporaFederation#define_callbacks-class_method) in the gem documentation.
+
 ## Contributing
 
 See [our contribution guide](/CONTRIBUTING.md) for more information on how to contribute to the diaspora\* federation library.

data/lib/diaspora_federation/discovery/h_card.rb

@@ -48,7 +48,7 @@ module DiasporaFederation
       # @!attribute [r] nickname
       #   The first part of the diaspora* ID
       #   @return [String] nickname
-      property :nickname, :string, default: nil
+      property :nickname, :string, optional: true
 
       # @!attribute [r] full_name
       #   @return [String] display name of the user
@@ -60,7 +60,7 @@ module DiasporaFederation
       #     installations).
       #
       #   @return [String] link to the pod
-      property :url, :string, default: nil
+      property :url, :string, optional: true
 
       # @!attribute [r] public_key
       #   When a user is created on the pod, the pod MUST generate a pgp keypair

data/lib/diaspora_federation/discovery/host_meta.rb

@@ -1,4 +1,3 @@
-
 module DiasporaFederation
   module Discovery
     # Generates and parses Host Meta documents.

data/lib/diaspora_federation/discovery/web_finger.rb

@@ -44,7 +44,7 @@ module DiasporaFederation
 
       # @!attribute [r] profile_url
       #   @return [String] link to the users profile
-      property :profile_url, :string, default: nil
+      property :profile_url, :string, optional: true
 
       # @!attribute [r] atom_url
       #   This atom feed is an Activity Stream of the user's public posts. diaspora*
@@ -55,18 +55,18 @@ module DiasporaFederation
       #   Note that this feed MAY also be made available through the PubSubHubbub
       #   mechanism by supplying a <link rel="hub"> in the atom feed itself.
       #   @return [String] atom feed url
-      property :atom_url, :string, default: nil
+      property :atom_url, :string, optional: true
 
       # @!attribute [r] salmon_url
       #   @note could be nil
       #   @return [String] salmon endpoint url
       #   @see https://cdn.rawgit.com/salmon-protocol/salmon-protocol/master/draft-panzer-salmon-00.html#SMLR
       #     Panzer draft for Salmon, paragraph 3.3
-      property :salmon_url, :string, default: nil
+      property :salmon_url, :string, optional: true
 
       # @!attribute [r] subscribe_url
       #   This url is used to find another user on the home-pod of the user in the webfinger.
-      property :subscribe_url, :string, default: nil
+      property :subscribe_url, :string, optional: true
 
       # +hcard_url+ link relation
       REL_HCARD = "http://microformats.org/profile/hcard".freeze

data/lib/diaspora_federation/entities/account_migration.rb

@@ -33,6 +33,11 @@ module DiasporaFederation
       #   @return [String] old identity
       property :old_identity, :string, default: nil
 
+      # @!attribute [r] remote_photo_path
+      #   The url to the path of the photos on the new pod. Can be empty if photos weren't migrated.
+      #   @return [String] remote photo path
+      property :remote_photo_path, :string, optional: true
+
       # Returns diaspora* ID of the old person identity.
       # @return [String] diaspora* ID of the old person identity
       def old_identity
@@ -43,7 +48,7 @@ module DiasporaFederation
       # Returns diaspora* ID of the new person identity.
       # @return [String] diaspora* ID of the new person identity
       def new_identity
-        profile.author
+        profile.author if profile
       end
 
       # @return [String] string representation of this object

data/lib/diaspora_federation/entities/comment.rb

@@ -17,6 +17,11 @@ module DiasporaFederation
       #   Comment entity creation time
       #   @return [Time] creation time
       property :created_at, :timestamp, default: -> { Time.now.utc }
+
+      # @!attribute [r] edited_at
+      #   The timestamp when the comment was edited
+      #   @return [Time] edited time
+      property :edited_at, :timestamp, optional: true
     end
   end
 end

data/lib/diaspora_federation/entities/embed.rb

@@ -0,0 +1,44 @@
+module DiasporaFederation
+  module Entities
+    # This entity is used to specify embed information about an URL that should be embedded.
+    #
+    # @see Validators::EmbedValidator
+    class Embed < Entity
+      # @!attribute [r] url
+      #   URL that should be embedded.
+      #   @return [String] url
+      property :url, :string, optional: true
+
+      # @!attribute [r] title
+      #   The title of the embedded URL.
+      #   @return [String] title
+      property :title, :string, optional: true
+
+      # @!attribute [r] description
+      #   The description of the embedded URL.
+      #   @return [String] description
+      property :description, :string, optional: true
+
+      # @!attribute [r] image
+      #   The image of the embedded URL.
+      #   @return [String] image
+      property :image, :string, optional: true
+
+      # @!attribute [r] nothing
+      #   True, if nothing should be embedded.
+      #   @return [String] nothing
+      property :nothing, :boolean, optional: true
+
+      # @return [String] string representation of this object
+      def to_s
+        "Embed#{":#{url}" if url}"
+      end
+
+      def validate
+        super
+
+        raise ValidationError, "Either 'url' must be set or 'nothing' must be 'true'" unless nothing ^ url
+      end
+    end
+  end
+end

data/lib/diaspora_federation/entities/event.rb

@@ -16,6 +16,11 @@ module DiasporaFederation
       #   @return [String] guid
       property :guid, :string
 
+      # @!attribute [r] edited_at
+      #   The timestamp when the event was edited
+      #   @return [Time] edited time
+      property :edited_at, :timestamp, optional: true
+
       # @!attribute [r] summary
       #   The summary of the event
       #   @return [String] event summary

data/lib/diaspora_federation/entities/event_participation.rb

@@ -14,6 +14,11 @@ module DiasporaFederation
       #   "accepted", "declined" or "tentative"
       #   @return [String] event participation status
       property :status, :string
+
+      # @!attribute [r] edited_at
+      #   The timestamp when the event participation was edited
+      #   @return [Time] edited time
+      property :edited_at, :timestamp, optional: true
     end
   end
 end

data/lib/diaspora_federation/entities/message.rb

@@ -26,6 +26,11 @@ module DiasporaFederation
       #   @return [Time] creation time
       property :created_at, :timestamp, default: -> { Time.now.utc }
 
+      # @!attribute [r] edited_at
+      #   The timestamp when the message was edited
+      #   @return [Time] edited time
+      property :edited_at, :timestamp, optional: true
+
       # @!attribute [r] conversation_guid
       #   Guid of a conversation this message belongs to
       #   @see Conversation#guid

data/lib/diaspora_federation/entities/photo.rb

@@ -26,6 +26,11 @@ module DiasporaFederation
       #   @return [Time] creation time
       property :created_at, :timestamp, default: -> { Time.now.utc }
 
+      # @!attribute [r] edited_at
+      #   The timestamp when the photo was edited
+      #   @return [Time] edited time
+      property :edited_at, :timestamp, optional: true
+
       # @!attribute [r] remote_photo_path
       #   An url of the photo on a remote server
       #   @return [String] remote photo url

data/lib/diaspora_federation/entities/profile.rb

@@ -14,6 +14,15 @@ module DiasporaFederation
       #   @return [String] diaspora* ID
       property :author, :string, alias: :diaspora_id, xml_name: :diaspora_handle
 
+      # @!attribute [r] edited_at
+      #   The timestamp when the profile was edited
+      #   @return [Time] edited time
+      property :edited_at, :timestamp, optional: true
+
+      # @!attribute [r] full_name
+      #   @return [String] display name of the user
+      property :full_name, :string, optional: true
+
       # @!attribute [r] first_name
       #   @deprecated We decided to only use one name field, these should be removed
       #     in later iterations (will affect older diaspora* installations).

data/lib/diaspora_federation/entities/status_message.rb

@@ -11,6 +11,11 @@ module DiasporaFederation
       #   @return [String] text of the status message
       property :text, :string, xml_name: :raw_message
 
+      # @!attribute [r] edited_at
+      #   The timestamp when the status message was edited
+      #   @return [Time] edited time
+      property :edited_at, :timestamp, optional: true
+
       # @!attribute [r] photos
       #   Optional photos attached to the status message
       #   @return [[Entities::Photo]] photos
@@ -31,6 +36,11 @@ module DiasporaFederation
       #   @return [Entities::Event] event
       entity :event, Entities::Event, optional: true
 
+      # @!attribute [r] embed
+      #   Optional embed information of an URL that should be embedded in the status message
+      #   @return [Entities::Embed] embed
+      entity :embed, Entities::Embed, optional: true
+
       private
 
       def validate

data/lib/diaspora_federation/entities.rb

@@ -30,6 +30,7 @@ require "diaspora_federation/entities/poll_answer"
 require "diaspora_federation/entities/poll"
 require "diaspora_federation/entities/poll_participation"
 
+require "diaspora_federation/entities/embed"
 require "diaspora_federation/entities/location"
 
 require "diaspora_federation/entities/event"

data/lib/diaspora_federation/federation/diaspora_url_parser.rb

@@ -6,7 +6,7 @@ module DiasporaFederation
 
       # Regex to find diaspora:// URLs
       DIASPORA_URL_REGEX = %r{
-        diaspora://
+        (?:web\+)?diaspora://
         (#{Validation::Rule::DiasporaId::DIASPORA_ID_REGEX})/
         (#{Entity::ENTITY_NAME_REGEX})/
         (#{Validation::Rule::Guid::VALID_CHARS})

data/lib/diaspora_federation/parsers/xml_parser.rb

@@ -12,7 +12,7 @@ module DiasporaFederation
       def parse(root_node)
         from_xml_sanity_validation(root_node)
 
-        hash = root_node.element_children.map {|child|
+        hash = root_node.element_children.uniq(&:name).map {|child|
           xml_name = child.name
           property = entity_type.find_property_for_xml_name(xml_name)
           if property

data/lib/diaspora_federation/salmon/aes.rb

@@ -19,7 +19,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)
+      def self.encrypt(data, key, iv) # rubocop:disable Naming/UncommunicativeMethodParamName
         raise ArgumentError unless data.instance_of?(String) &&
                                    key.instance_of?(String) &&
                                    iv.instance_of?(String)
@@ -41,7 +41,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)
+      def self.decrypt(ciphertext, key, iv) # rubocop:disable Naming/UncommunicativeMethodParamName
         raise ArgumentError unless ciphertext.instance_of?(String) &&
                                    key.instance_of?(String) &&
                                    iv.instance_of?(String)

data/lib/diaspora_federation/validators/account_migration_validator.rb

@@ -9,6 +9,8 @@ module DiasporaFederation
       rule :profile, :not_nil
 
       rule :old_identity, :diaspora_id
+
+      rule :remote_photo_path, URI: [:path]
     end
   end
 end

data/lib/diaspora_federation/validators/conversation_validator.rb

@@ -9,7 +9,7 @@ module DiasporaFederation
 
       rule :subject, [:not_empty, length: {maximum: 255}]
 
-      rule :participants, diaspora_id_list: {minimum: 2}
+      rule :participants, [:not_empty, diaspora_id_list: {minimum: 2}]
       rule :messages, :not_nil
     end
   end

data/lib/diaspora_federation/validators/embed_validator.rb

@@ -0,0 +1,13 @@
+module DiasporaFederation
+  module Validators
+    # This validates a {Entities::Embed}.
+    class EmbedValidator < OptionalAwareValidator
+      include Validation
+
+      rule :url, :URI
+      rule :title, length: {maximum: 255}
+      rule :description, length: {maximum: 65_535}
+      rule :image, URI: %i[host path]
+    end
+  end
+end

data/lib/diaspora_federation/validators/event_participation_validator.rb

@@ -6,7 +6,7 @@ module DiasporaFederation
 
       include RelayableValidator
 
-      rule :status, regular_expression: {regex: /\A(accepted|declined|tentative)\z/}
+      rule :status, [:not_empty, regular_expression: {regex: /\A(accepted|declined|tentative)\z/}]
     end
   end
 end

data/lib/diaspora_federation/validators/optional_aware_validator.rb

@@ -13,10 +13,8 @@ module DiasporaFederation
       private
 
       def optional_props
-        entity_name = self.class.name.split("::").last.sub("Validator", "")
-        return [] unless Entities.const_defined?(entity_name)
-
-        Entities.const_get(entity_name).optional_props
+        return [] unless @obj.class.respond_to?(:optional_props)
+        @obj.class.optional_props
       end
     end
   end

data/lib/diaspora_federation/validators/photo_validator.rb

@@ -10,7 +10,7 @@ module DiasporaFederation
 
       rule :public, :boolean
 
-      rule :remote_photo_path, :not_empty
+      rule :remote_photo_path, [:not_empty, URI: [:path]]
 
       rule :remote_photo_name, :not_empty
 

data/lib/diaspora_federation/validators/profile_validator.rb

@@ -8,6 +8,7 @@ module DiasporaFederation
 
       # 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/}
 

data/lib/diaspora_federation/validators.rb

@@ -46,6 +46,7 @@ require "diaspora_federation/validators/account_migration_validator"
 require "diaspora_federation/validators/comment_validator"
 require "diaspora_federation/validators/contact_validator"
 require "diaspora_federation/validators/conversation_validator"
+require "diaspora_federation/validators/embed_validator"
 require "diaspora_federation/validators/event_participation_validator"
 require "diaspora_federation/validators/event_validator"
 require "diaspora_federation/validators/h_card_validator"

data/lib/diaspora_federation/version.rb

@@ -1,4 +1,4 @@
 module DiasporaFederation
   # the gem version
-  VERSION = "0.2.3".freeze
+  VERSION = "0.2.7".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diaspora_federation
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.7
 platform: ruby
 authors:
 - Benjamin Neff
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-27 00:00:00.000000000 Z
+date: 2021-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -19,7 +19,7 @@ dependencies:
         version: 0.9.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 0.9.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: 0.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: 0.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +126,7 @@ files:
 - lib/diaspora_federation/entities/comment.rb
 - lib/diaspora_federation/entities/contact.rb
 - lib/diaspora_federation/entities/conversation.rb
+- lib/diaspora_federation/entities/embed.rb
 - lib/diaspora_federation/entities/event.rb
 - lib/diaspora_federation/entities/event_participation.rb
 - lib/diaspora_federation/entities/like.rb
@@ -182,6 +183,7 @@ files:
 - lib/diaspora_federation/validators/comment_validator.rb
 - lib/diaspora_federation/validators/contact_validator.rb
 - lib/diaspora_federation/validators/conversation_validator.rb
+- lib/diaspora_federation/validators/embed_validator.rb
 - lib/diaspora_federation/validators/event_participation_validator.rb
 - lib/diaspora_federation/validators/event_validator.rb
 - lib/diaspora_federation/validators/h_card_validator.rb
@@ -215,7 +217,7 @@ homepage: https://github.com/diaspora/diaspora_federation
 licenses:
 - AGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -230,9 +232,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: diaspora* federation library
 test_files: []