diaspora_federation 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ada8efaa115784225786ce35f925e13179f7d5e2
-  data.tar.gz: 9ecfc78d096a8f5173ddbcd3665fd22445c9374c
+  metadata.gz: 70e250962994a4f76c0232c5ea58fd2c02411766
+  data.tar.gz: 131351687ab2b4cd5e63fe7a1783103b3b43f83c
 SHA512:
-  metadata.gz: 1ad31c9c21a5e42e0197ccb51ec14d8e5262b6fc527f9b3b7ba95ff9162d69c8be8783275d576a7051bca3ddfbe0913dd3d1b5d46ad9d32a90c2288b510c6f42
-  data.tar.gz: 1b32aa2ff5b1c4d0763f8b97eb1473cc03d143ae3f7bd028a24557e11780d8a2b6d2f14c89ecd67977eae708b33aba868de867e3c92031c583468577f4fd2c4a
+  metadata.gz: 31ca9ff248eb49ba2b1ca310e7ab1f3447c488677ff6ed026f1bf39a1dbe16dde6fbf0cbc307e7fc6c1d9bb6c3123635711d8006546d5149395ab9acb13ff944
+  data.tar.gz: 569623cc75eeefcb9e6bdea8851495fd4fb5319664847234d4f0ddb51b4be457fce75d8deb722ee1c858fb42eb89c52be7054e6259428e23fe3ba3dc2ca30540

data/Changelog.md

@@ -1,3 +1,15 @@
+# 0.1.6
+
+## Feature
+
+* Add rails 5 support [82ea57e](https://github.com/diaspora/diaspora_federation/commit/82ea57ef34fe25d2ffbd6067171d73802735043b)
+
+## Refactor
+
+* Add property types [#43](https://github.com/diaspora/diaspora_federation/pull/43)
+* Change timestamp format to ISO 8601 [#43](https://github.com/diaspora/diaspora_federation/pull/43)
+* Move protocol documentation to master branch [a15d285](https://github.com/diaspora/diaspora_federation/commit/a15d285a6e778a04c5e0c2f9428be099d6abddce)
+
 # 0.1.5
 
 ## Refactor

data/lib/diaspora_federation/discovery/h_card.rb

@@ -43,16 +43,16 @@ module DiasporaFederation
       # @!attribute [r] guid
       #   @see Entities::Person#guid
       #   @return [String] guid
-      property :guid
+      property :guid, :string
 
       # @!attribute [r] nickname
       #   The first part of the diaspora* ID
       #   @return [String] nickname
-      property :nickname, default: nil
+      property :nickname, :string, default: nil
 
       # @!attribute [r] full_name
       #   @return [String] display name of the user
-      property :full_name
+      property :full_name, :string
 
       # @!attribute [r] url
       #   @deprecated should be changed to the profile url. The pod url is in
@@ -60,7 +60,7 @@ module DiasporaFederation
       #     installations).
       #
       #   @return [String] link to the pod
-      property :url, default: nil
+      property :url, :string, default: nil
 
       # @!attribute [r] public_key
       #   When a user is created on the pod, the pod MUST generate a pgp keypair
@@ -69,17 +69,17 @@ module DiasporaFederation
       #   "-----BEGIN PUBLIC KEY-----" and ending with "-----END PUBLIC KEY-----".
       #
       #   @return [String] public key
-      property :public_key
+      property :public_key, :string
 
       # @!attribute [r] photo_large_url
       #   @return [String] url to the big avatar (300x300)
-      property :photo_large_url
+      property :photo_large_url, :string
       # @!attribute [r] photo_medium_url
       #   @return [String] url to the medium avatar (100x100)
-      property :photo_medium_url
+      property :photo_medium_url, :string
       # @!attribute [r] photo_small_url
       #   @return [String] url to the small avatar (50x50)
-      property :photo_small_url
+      property :photo_small_url, :string
 
       # @!attribute [r] first_name
       #   @deprecated We decided to only use one name field, these should be removed
@@ -87,7 +87,7 @@ module DiasporaFederation
       #
       #   @see #full_name
       #   @return [String] first name
-      property :first_name
+      property :first_name, :string
 
       # @!attribute [r] last_name
       #   @deprecated We decided to only use one name field, these should be removed
@@ -95,7 +95,7 @@ module DiasporaFederation
       #
       #   @see #full_name
       #   @return [String] last name
-      property :last_name
+      property :last_name, :string
 
       # @!attribute [r] searchable
       #   @deprecated As this is a simple property, consider move to WebFinger instead
@@ -105,7 +105,7 @@ module DiasporaFederation
       #
       #   flag if a user is searchable by name
       #   @return [Boolean] searchable flag
-      property :searchable
+      property :searchable, :boolean
 
       # CSS selectors for finding all the hCard fields
       SELECTORS = {

data/lib/diaspora_federation/discovery/web_finger.rb

@@ -35,24 +35,24 @@ module DiasporaFederation
       #   The Subject element should contain the webfinger address that was asked
       #   for. If it does not, then this webfinger profile MUST be ignored.
       #   @return [String]
-      property :acct_uri
+      property :acct_uri, :string
 
       # @!attribute [r] alias_url
       #   @note could be nil
       #   @return [String] link to the users profile
-      property :alias_url
+      property :alias_url, :string
 
       # @!attribute [r] hcard_url
       #   @return [String] link to the +hCard+
-      property :hcard_url
+      property :hcard_url, :string
 
       # @!attribute [r] seed_url
       #   @return [String] link to the pod
-      property :seed_url
+      property :seed_url, :string
 
       # @!attribute [r] profile_url
       #   @return [String] link to the users profile
-      property :profile_url
+      property :profile_url, :string
 
       # @!attribute [r] atom_url
       #   This atom feed is an Activity Stream of the user's public posts. diaspora*
@@ -63,18 +63,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
+      property :atom_url, :string
 
       # @!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
+      property :salmon_url, :string
 
       # @!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
+      property :subscribe_url, :string
 
       # @!attribute [r] guid
       #   @deprecated Either convert these to +Property+ elements or move to the
@@ -84,7 +84,7 @@ module DiasporaFederation
       #   @see HCard#guid
       #   @see Entities::Person#guid
       #   @return [String] guid
-      property :guid
+      property :guid, :string
 
       # @!attribute [r] public_key
       #   @deprecated Either convert these to +Property+ elements or move to the
@@ -98,7 +98,7 @@ module DiasporaFederation
       #   DER-encoded PKCS#1 key beginning with the text
       #   "-----BEGIN PUBLIC KEY-----" and ending with "-----END PUBLIC KEY-----".
       #   @return [String] public key
-      property :public_key
+      property :public_key, :string
 
       # +hcard_url+ link relation
       REL_HCARD = "http://microformats.org/profile/hcard".freeze

data/lib/diaspora_federation/entities/account_deletion.rb

@@ -12,7 +12,7 @@ module DiasporaFederation
       #   Alias for author
       #   @see AccountDeletion#author
       #   @return [String] diaspora* ID
-      property :author, alias: :diaspora_id, xml_name: :diaspora_handle
+      property :author, :string, alias: :diaspora_id, xml_name: :diaspora_handle
 
       # @return [String] string representation of this object
       def to_s

data/lib/diaspora_federation/entities/comment.rb

@@ -15,12 +15,12 @@ module DiasporaFederation
 
       # @!attribute [r] text
       #   @return [String] the comment text
-      property :text
+      property :text, :string
 
       # @!attribute [r] created_at
       #   Comment entity creation time
       #   @return [Time] creation time
-      property :created_at, default: -> { Time.now.utc }
+      property :created_at, :timestamp, default: -> { Time.now.utc }
     end
   end
 end

data/lib/diaspora_federation/entities/contact.rb

@@ -9,21 +9,21 @@ module DiasporaFederation
       #   The diaspora* ID of the person who shares their profile
       #   @see Person#author
       #   @return [String] sender ID
-      property :author
+      property :author, :string
 
       # @!attribute [r] recipient
       #   The diaspora* ID of the person who will be shared with
       #   @see Validation::Rule::DiasporaId
       #   @return [String] recipient ID
-      property :recipient
+      property :recipient, :string
 
       # @!attribute [r] following
       #   @return [Boolean] if the author is following the person
-      property :following, default: true
+      property :following, :boolean, default: true
 
       # @!attribute [r] sharing
       #   @return [Boolean] if the author is sharing with the person
-      property :sharing, default: true
+      property :sharing, :boolean, default: true
 
       # @return [String] string representation of this object
       def to_s

data/lib/diaspora_federation/entities/conversation.rb

@@ -8,26 +8,26 @@ module DiasporaFederation
       #   The diaspora* ID of the person initiated the conversation
       #   @see Person#author
       #   @return [String] diaspora* ID
-      property :author, xml_name: :diaspora_handle
+      property :author, :string, xml_name: :diaspora_handle
 
       # @!attribute [r] guid
       #   A random string of at least 16 chars
       #   @see Validation::Rule::Guid
       #   @return [String] conversation guid
-      property :guid
+      property :guid, :string
 
       # @!attribute [r] subject
       #   @return [String] the conversation subject
-      property :subject
+      property :subject, :string
 
       # @!attribute [r] created_at
       #   @return [Time] Conversation creation time
-      property :created_at, default: -> { Time.now.utc }
+      property :created_at, :timestamp, default: -> { Time.now.utc }
 
       # @!attribute [r] participants
       #   The diaspora* IDs of the persons participating the conversation separated by ";"
       #   @return [String] participants diaspora* IDs
-      property :participants, xml_name: :participant_handles
+      property :participants, :string, xml_name: :participant_handles
 
       # @!attribute [r] messages
       #   @return [[Entities::Message]] Messages of this conversation

data/lib/diaspora_federation/entities/like.rb

@@ -14,14 +14,14 @@ module DiasporaFederation
       #   If +true+ set a like, if +false+, set a dislike (dislikes are currently not
       #   implemented in the diaspora* frontend).
       #   @return [Boolean] is it a like or a dislike
-      property :positive
+      property :positive, :boolean
 
       # @!attribute [r] parent_type
       #   A string describing the type of the parent
       #   Can be "Post" or "Comment" (Comments are currently not implemented in the
       #   diaspora* frontend).
       #   @return [String] parent type
-      property :parent_type, xml_name: :target_type
+      property :parent_type, :string, xml_name: :target_type
     end
   end
 end

data/lib/diaspora_federation/entities/location.rb

@@ -7,17 +7,17 @@ module DiasporaFederation
       # @!attribute [r] address
       #   A string describing your location, e.g. a city name, a street name, etc
       #   @return [String] address
-      property :address
+      property :address, :string
 
       # @!attribute [r] lat
       #   Geographical latitude of your location
       #   @return [String] latitude
-      property :lat
+      property :lat, :string
 
       # @!attribute [r] lng
       #   Geographical longitude of your location
       #   @return [String] longitude
-      property :lng
+      property :lng, :string
     end
   end
 end

data/lib/diaspora_federation/entities/message.rb

@@ -13,18 +13,18 @@ module DiasporaFederation
       # @!attribute [r] text
       #   Text of the message composed by a user
       #   @return [String] text
-      property :text
+      property :text, :string
 
       # @!attribute [r] created_at
       #   Message creation time
       #   @return [Time] creation time
-      property :created_at, default: -> { Time.now.utc }
+      property :created_at, :timestamp, default: -> { Time.now.utc }
 
       # @!attribute [r] conversation_guid
       #   Guid of a conversation this message belongs to
       #   @see Conversation#guid
       #   @return [String] conversation guid
-      property :conversation_guid
+      property :conversation_guid, :string
 
       # It is only valid to receive a {Message} from the author itself,
       # or from the author of the parent {Conversation} if the author signature is valid.
@@ -48,6 +48,16 @@ module DiasporaFederation
         parent.author
       end
 
+      # old timestamp format, because this signature is only used from old pods which also relay with old format
+      # @deprecated remove after {Message} doesn't include {Relayable} anymore
+      def normalize_property(name, value)
+        if name == :created_at
+          value.to_s
+        else
+          super
+        end
+      end
+
       # Default implementation, don't verify signatures for a {Message}.
       # @see Entity.populate_entity
       # @deprecated remove after {Message} doesn't include {Relayable} anymore

data/lib/diaspora_federation/entities/participation.rb

@@ -14,7 +14,7 @@ module DiasporaFederation
       #   A string describing a type of the target to subscribe on
       #   Currently only "Post" is supported.
       #   @return [String] parent type
-      property :parent_type, xml_name: :target_type
+      property :parent_type, :string, xml_name: :target_type
 
       # It is only valid to receive a {Participation} from the author themself.
       # @deprecated remove after {Participation} doesn't include {Relayable} anymore

data/lib/diaspora_federation/entities/person.rb

@@ -9,7 +9,7 @@ module DiasporaFederation
       #   MUST assign them a guid - a random string of at least 16 chars.
       #   @see Validation::Rule::Guid
       #   @return [String] guid
-      property :guid
+      property :guid, :string
 
       # @!attribute [r] author
       #   The diaspora* ID of the person
@@ -19,12 +19,12 @@ module DiasporaFederation
       #   alias for author
       #   @see Person#author
       #   @return [String] diaspora* ID
-      property :author, alias: :diaspora_id, xml_name: :diaspora_handle
+      property :author, :string, alias: :diaspora_id, xml_name: :diaspora_handle
 
       # @!attribute [r] url
       #   @see Discovery::WebFinger#seed_url
       #   @return [String] link to the pod
-      property :url
+      property :url, :string
 
       # @!attribute [r] profile
       #   All profile data of the person
@@ -34,7 +34,7 @@ module DiasporaFederation
       # @!attribute [r] exported_key
       #   @see Discovery::HCard#public_key
       #   @return [String] public key
-      property :exported_key
+      property :exported_key, :string
     end
   end
 end

data/lib/diaspora_federation/entities/photo.rb

@@ -8,52 +8,52 @@ module DiasporaFederation
       #   A random string of at least 16 chars
       #   @see Validation::Rule::Guid
       #   @return [String] guid
-      property :guid
+      property :guid, :string
 
       # @!attribute [r] author
       #   The diaspora* ID of the person who uploaded the photo
       #   @see Person#author
       #   @return [String] author diaspora* ID
-      property :author, xml_name: :diaspora_handle
+      property :author, :string, xml_name: :diaspora_handle
 
       # @!attribute [r] public
       #   Points if the photo is visible to everyone or only to some aspects
       #   @return [Boolean] is it public
-      property :public, default: false
+      property :public, :boolean, default: false
 
       # @!attribute [r] created_at
       #   Photo entity creation time
       #   @return [Time] creation time
-      property :created_at, default: -> { Time.now.utc }
+      property :created_at, :timestamp, default: -> { Time.now.utc }
 
       # @!attribute [r] remote_photo_path
       #   An url of the photo on a remote server
       #   @return [String] remote photo url
-      property :remote_photo_path
+      property :remote_photo_path, :string
 
       # @!attribute [r] remote_photo_name
       #   @return [String] remote photo name
-      property :remote_photo_name
+      property :remote_photo_name, :string
 
       # @!attribute [r] text
       #   @return [String] text
-      property :text, default: nil
+      property :text, :string, default: nil
 
       # @!attribute [r] status_message_guid
       #   Guid of a status message this photo belongs to
       #   @see StatusMessage#guid
       #   @return [String] guid
-      property :status_message_guid, default: nil
+      property :status_message_guid, :string, default: nil
 
       # @!attribute [r] height
       #   Photo height
-      #   @return [String] height
-      property :height
+      #   @return [Integer] height
+      property :height, :integer
 
       # @!attribute [r] width
       #   Photo width
-      #   @return [String] width
-      property :width
+      #   @return [Integer] width
+      property :width, :integer
     end
   end
 end

data/lib/diaspora_federation/entities/poll.rb

@@ -8,12 +8,12 @@ module DiasporaFederation
       #   A random string of at least 16 chars
       #   @see Validation::Rule::Guid
       #   @return [String] poll guid
-      property :guid
+      property :guid, :string
 
       # @!attribute [r] question
       #   Text of the question posed by a user
       #   @return [String] question
-      property :question
+      property :question, :string
 
       # @!attribute [r] poll_answers
       #   Array of possible answers for the poll

data/lib/diaspora_federation/entities/poll_answer.rb

@@ -8,12 +8,12 @@ module DiasporaFederation
       #   A random string of at least 16 chars
       #   @see Validation::Rule::Guid
       #   @return [String] guid
-      property :guid
+      property :guid, :string
 
       # @!attribute [r] answer
       #   Text of the answer
       #   @return [String] answer
-      property :answer
+      property :answer, :string
     end
   end
 end

data/lib/diaspora_federation/entities/poll_participation.rb

@@ -17,7 +17,7 @@ module DiasporaFederation
       #   Guid of the answer selected by the user
       #   @see PollAnswer#guid
       #   @return [String] poll answer guid
-      property :poll_answer_guid
+      property :poll_answer_guid, :string
     end
   end
 end

data/lib/diaspora_federation/entities/post.rb

@@ -26,10 +26,10 @@ module DiasporaFederation
       # @param [Entity] entity the entity in which it is included
       def self.included(entity)
         entity.class_eval do
-          property :author, xml_name: :diaspora_handle
-          property :guid
-          property :created_at, default: -> { Time.now.utc }
-          property :provider_display_name, default: nil
+          property :author, :string, xml_name: :diaspora_handle
+          property :guid, :string
+          property :created_at, :timestamp, default: -> { Time.now.utc }
+          property :provider_display_name, :string, default: nil
         end
       end
     end

data/lib/diaspora_federation/entities/profile.rb

@@ -12,7 +12,7 @@ module DiasporaFederation
       #   Alias for author
       #   @see Profile#author
       #   @return [String] diaspora* ID
-      property :author, alias: :diaspora_id, xml_name: :diaspora_handle
+      property :author, :string, alias: :diaspora_id, xml_name: :diaspora_handle
 
       # @!attribute [r] first_name
       #   @deprecated We decided to only use one name field, these should be removed
@@ -20,7 +20,7 @@ module DiasporaFederation
       #   @see #full_name
       #   @see Discovery::HCard#first_name
       #   @return [String] first name
-      property :first_name, default: nil
+      property :first_name, :string, default: nil
 
       # @!attribute [r] last_name
       #   @deprecated We decided to only use one name field, these should be removed
@@ -28,33 +28,33 @@ module DiasporaFederation
       #   @see #full_name
       #   @see Discovery::HCard#last_name
       #   @return [String] last name
-      property :last_name, default: nil
+      property :last_name, :string, default: nil
 
       # @!attribute [r] image_url
       #   @see Discovery::HCard#photo_large_url
       #   @return [String] url to the big avatar (300x300)
-      property :image_url, default: nil
+      property :image_url, :string, default: nil
       # @!attribute [r] image_url_medium
       #   @see Discovery::HCard#photo_medium_url
       #   @return [String] url to the medium avatar (100x100)
-      property :image_url_medium, default: nil
+      property :image_url_medium, :string, default: nil
       # @!attribute [r] image_url_small
       #   @see Discovery::HCard#photo_small_url
       #   @return [String] url to the small avatar (50x50)
-      property :image_url_small, default: nil
+      property :image_url_small, :string, default: nil
 
-      property :birthday, default: nil
-      property :gender, default: nil
-      property :bio, default: nil
-      property :location, default: nil
+      property :birthday, :string, default: nil
+      property :gender, :string, default: nil
+      property :bio, :string, default: nil
+      property :location, :string, default: nil
 
       # @!attribute [r] searchable
       #   @see Discovery::HCard#searchable
       #   @return [Boolean] searchable flag
-      property :searchable, default: true
+      property :searchable, :boolean, default: true
 
-      property :nsfw, default: false
-      property :tag_string, default: nil
+      property :nsfw, :boolean, default: false
+      property :tag_string, :string, default: nil
 
       # @return [String] string representation of this object
       def to_s

data/lib/diaspora_federation/entities/related_entity.rb

@@ -7,17 +7,17 @@ module DiasporaFederation
       #   The diaspora* ID of the author
       #   @see Person#author
       #   @return [String] diaspora* ID
-      property :author
+      property :author, :string
 
       # @!attribute [r] local
       #   +true+ if the owner of the entity is local on the pod
       #   @return [Boolean] is it a like or a dislike
-      property :local
+      property :local, :boolean
 
       # @!attribute [r] public
       #   Shows whether the entity is visible to everyone or only to some aspects
       #   @return [Boolean] is it public
-      property :public, default: false
+      property :public, :boolean, default: false
 
       # @!attribute [r] parent
       #   Parent if the entity also has a parent (Comment or Like) or +nil+ if it has no parent

data/lib/diaspora_federation/entities/relayable.rb

@@ -54,11 +54,11 @@ module DiasporaFederation
       # @param [Entity] klass the entity in which it is included
       def self.included(klass)
         klass.class_eval do
-          property :author, xml_name: :diaspora_handle
-          property :guid
-          property :parent_guid
-          property :author_signature, default: nil
-          property :parent_author_signature, default: nil
+          property :author, :string, xml_name: :diaspora_handle
+          property :guid, :string
+          property :parent_guid, :string
+          property :author_signature, :string, default: nil
+          property :parent_author_signature, :string, default: nil
           entity :parent, Entities::RelatedEntity
         end
 
@@ -146,19 +146,26 @@ module DiasporaFederation
         Base64.strict_encode64(privkey.sign(DIGEST, signature_data))
       end
 
-      # Sort all XML elements according to the order used for the signatures.
-      # It updates also the signatures with the keys of the author and the parent
+      # Update the signatures with the keys of the author and the parent
       # if the signatures are not there yet and if the keys are available.
       #
-      # @return [Hash] sorted xml elements with updated signatures
-      def xml_elements
-        xml_data = super.merge(additional_xml_elements)
-        signature_order.map {|element| [element, xml_data[element] || ""] }.to_h.tap do |xml_elements|
-          xml_elements[:author_signature] = author_signature || sign_with_author
-          xml_elements[:parent_author_signature] = parent_author_signature || sign_with_parent_author_if_available.to_s
+      # @return [Hash] properties with updated signatures
+      def enriched_properties
+        super.merge(additional_xml_elements).tap do |hash|
+          hash[:author_signature] = author_signature || sign_with_author
+          hash[:parent_author_signature] = parent_author_signature || sign_with_parent_author_if_available.to_s
         end
       end
 
+      # Sort all XML elements according to the order used for the signatures.
+      #
+      # @return [Hash] sorted xml elements
+      def xml_elements
+        data = super
+        order = signature_order + %i(author_signature parent_author_signature)
+        order.map {|element| [element, data[element] || ""] }.to_h
+      end
+
       # The order for signing
       # @return [Array]
       def signature_order
@@ -172,7 +179,7 @@ module DiasporaFederation
 
       # @return [String] signature data string
       def signature_data
-        data = to_h.merge(additional_xml_elements)
+        data = normalized_properties.merge(additional_xml_elements)
         signature_order.map {|name| data[name] }.join(";")
       end
 

data/lib/diaspora_federation/entities/relayable_retraction.rb

@@ -24,25 +24,25 @@ module DiasporaFederation
       #   This signature is mandatory only when federating from an upstream author to the subscribers.
       #   @see Relayable#parent_author_signature
       #   @return [String] parent author signature
-      property :parent_author_signature, default: nil
+      property :parent_author_signature, :string, default: nil
 
       # @!attribute [r] target_guid
       #   Guid of a relayable to be deleted
       #   @see Comment#guid
       #   @return [String] target guid
-      property :target_guid
+      property :target_guid, :string
 
       # @!attribute [r] target_type
       #   A string describing a type of the target
       #   @see Retraction#target_type
       #   @return [String] target type
-      property :target_type
+      property :target_type, :string
 
       # @!attribute [r] author
       #   The diaspora* ID of the person who deletes a relayable
       #   @see Person#author
       #   @return [String] diaspora* ID
-      property :author, xml_name: :sender_handle
+      property :author, :string, xml_name: :sender_handle
 
       # @!attribute [r] target_author_signature
       #   Contains a signature of the entity using the private key of the
@@ -51,7 +51,7 @@ module DiasporaFederation
       #   author is done.
       #   @see Relayable#author_signature
       #   @return [String] target author signature
-      property :target_author_signature, default: nil
+      property :target_author_signature, :string, default: nil
 
       # @!attribute [r] target
       #   Target entity
@@ -83,11 +83,11 @@ module DiasporaFederation
       # if the signatures are not there yet and if the keys are available.
       #
       # @return [Hash] xml elements with updated signatures
-      def xml_elements
+      def enriched_properties
         privkey = DiasporaFederation.callbacks.trigger(:fetch_private_key, author)
 
-        super.tap do |xml_elements|
-          fill_required_signature(privkey, xml_elements) unless privkey.nil?
+        super.tap do |hash|
+          fill_required_signature(privkey, hash) unless privkey.nil?
         end
       end
 

data/lib/diaspora_federation/entities/request.rb

@@ -10,13 +10,13 @@ module DiasporaFederation
       #   The diaspora* ID of the person who share their profile
       #   @see Person#author
       #   @return [String] sender ID
-      property :author, xml_name: :sender_handle
+      property :author, :string, xml_name: :sender_handle
 
       # @!attribute [r] recipient
       #   The diaspora* ID of the person who will be shared with
       #   @see Validation::Rule::DiasporaId
       #   @return [String] recipient ID
-      property :recipient, xml_name: :recipient_handle
+      property :recipient, :string, xml_name: :recipient_handle
 
       # Use only {Contact} for receive
       # @return [Contact] instance as contact

data/lib/diaspora_federation/entities/reshare.rb

@@ -10,18 +10,18 @@ module DiasporaFederation
       #   The diaspora* ID of the person who posted the original post
       #   @see Person#author
       #   @return [String] diaspora* ID
-      property :root_author, xml_name: :root_diaspora_id
+      property :root_author, :string, xml_name: :root_diaspora_id
 
       # @!attribute [r] root_guid
       #   Guid of the original post
       #   @see StatusMessage#guid
       #   @return [String] root guid
-      property :root_guid
+      property :root_guid, :string
 
       # @!attribute [r] public
       #   Has no meaning at the moment
       #   @return [Boolean] public
-      property :public, default: true # always true? (we only reshare public posts)
+      property :public, :boolean, default: true # always true? (we only reshare public posts)
 
       # @return [String] string representation of this object
       def to_s

data/lib/diaspora_federation/entities/retraction.rb

@@ -8,17 +8,17 @@ module DiasporaFederation
       #   The diaspora* ID of the person who deletes the entity
       #   @see Person#author
       #   @return [String] diaspora* ID
-      property :author, xml_name: :diaspora_handle
+      property :author, :string, xml_name: :diaspora_handle
 
       # @!attribute [r] target_guid
       #   Guid of the entity to be deleted
       #   @return [String] target guid
-      property :target_guid, xml_name: :post_guid
+      property :target_guid, :string, xml_name: :post_guid
 
       # @!attribute [r] target_type
       #   A string describing the type of the target
       #   @return [String] target type
-      property :target_type, xml_name: :type
+      property :target_type, :string, xml_name: :type
 
       # @!attribute [r] target
       #   Target entity

data/lib/diaspora_federation/entities/signed_retraction.rb

@@ -10,25 +10,25 @@ module DiasporaFederation
       #   Guid of a post to be deleted
       #   @see Retraction#target_guid
       #   @return [String] target guid
-      property :target_guid
+      property :target_guid, :string
 
       # @!attribute [r] target_type
       #   A string describing the type of the target
       #   @see Retraction#target_type
       #   @return [String] target type
-      property :target_type
+      property :target_type, :string
 
       # @!attribute [r] author
       #   The diaspora* ID of the person who deletes a post
       #   @see Person#author
       #   @return [String] diaspora* ID
-      property :author, xml_name: :sender_handle
+      property :author, :string, xml_name: :sender_handle
 
       # @!attribute [r] author_signature
       #   Contains a signature of the entity using the private key of the author of a post
       #   This signature is mandatory.
       #   @return [String] author signature
-      property :target_author_signature, default: nil
+      property :target_author_signature, :string, default: nil
 
       # @!attribute [r] target
       #   Target entity
@@ -68,9 +68,9 @@ module DiasporaFederation
       # if the signatures are not there yet and if the keys are available.
       #
       # @return [Hash] xml elements with updated signatures
-      def xml_elements
-        super.tap do |xml_elements|
-          xml_elements[:target_author_signature] = target_author_signature || sign_with_author.to_s
+      def enriched_properties
+        super.tap do |hash|
+          hash[:target_author_signature] = target_author_signature || sign_with_author.to_s
         end
       end
 

data/lib/diaspora_federation/entities/status_message.rb

@@ -9,7 +9,7 @@ module DiasporaFederation
       # @!attribute [r] text
       #   Text of the status message composed by the user
       #   @return [String] text of the status message
-      property :text, xml_name: :raw_message
+      property :text, :string, xml_name: :raw_message
 
       # @!attribute [r] photos
       #   Optional photos attached to the status message
@@ -29,7 +29,7 @@ module DiasporaFederation
       # @!attribute [r] public
       #   Shows whether the status message is visible to everyone or only to some aspects
       #   @return [Boolean] is it public
-      property :public, default: false
+      property :public, :boolean, default: false
 
       private
 

data/lib/diaspora_federation/entity.rb

@@ -76,7 +76,7 @@ module DiasporaFederation
       properties.map {|key, value|
         type = self.class.class_props[key]
 
-        if type == String || value.nil?
+        if type.instance_of?(Symbol) || value.nil?
           [key, value]
         elsif type.instance_of?(Class)
           [key, value.to_h]
@@ -160,11 +160,15 @@ module DiasporaFederation
       type = self.class.class_props[name]
       return false if type.nil? # property undefined
 
-      setable_string?(type, val) || setable_nested?(type, val) || setable_multi?(type, val)
+      setable_property?(type, val) || setable_nested?(type, val) || setable_multi?(type, val)
+    end
+
+    def setable_property?(type, val)
+      setable_string?(type, val) || type == :timestamp && val.is_a?(Time)
     end
 
     def setable_string?(type, val)
-      type == String && val.respond_to?(:to_s)
+      %i(string integer boolean).include?(type) && val.respond_to?(:to_s)
     end
 
     def setable_nested?(type, val)
@@ -215,8 +219,29 @@ module DiasporaFederation
       end
     end
 
+    def normalized_properties
+      properties.map {|name, value| [name, normalize_property(name, value)] }.to_h
+    end
+
+    def normalize_property(name, value)
+      case self.class.class_props[name]
+      when :string, :integer, :boolean
+        value.to_s
+      when :timestamp
+        value.nil? ? "" : value.utc.iso8601
+      else
+        value
+      end
+    end
+
+    # default: nothing to enrich
+    def enriched_properties
+      normalized_properties
+    end
+
+    # default: no special order
     def xml_elements
-      properties.map {|name, value| [name, self.class.class_props[name] == String ? value.to_s : value] }.to_h
+      enriched_properties
     end
 
     def add_property_to_xml(doc, root_element, name, value)
@@ -255,12 +280,12 @@ module DiasporaFederation
     end
 
     # @param [String] name property name to parse
-    # @param [Class] type target type to parse
+    # @param [Class, Symbol] type target type to parse
     # @param [Nokogiri::XML::Element] root_node XML node to parse
     # @return [Object] parsed data
     private_class_method def self.parse_element_from_node(name, type, root_node)
-      if type == String
-        parse_string_from_node(name, root_node)
+      if type.instance_of?(Symbol)
+        parse_string_from_node(name, type, root_node)
       elsif type.instance_of?(Array)
         parse_array_from_node(type.first, root_node)
       elsif type.ancestors.include?(Entity)
@@ -271,12 +296,34 @@ module DiasporaFederation
     # Create simple entry in data hash
     #
     # @param [String] name xml tag to parse
+    # @param [Class, Symbol] type target type to parse
     # @param [Nokogiri::XML::Element] root_node XML root_node to parse
     # @return [String] data
-    private_class_method def self.parse_string_from_node(name, root_node)
+    private_class_method def self.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?
-      node.first.text if node.any?
+      parse_property(type, node.first.text) if node.any?
+    end
+
+    # @param [Symbol] type target type to parse
+    # @param [String] text data as string
+    # @return [String, Boolean, Integer, Time] data
+    private_class_method def self.parse_property(type, text)
+      case type
+      when :timestamp
+        begin
+          Time.parse(text).utc
+        rescue
+          nil
+        end
+      when :integer
+        text.to_i if text =~ /^\d+$/
+      when :boolean
+        return true if text =~ /(true|t|yes|y|1)$/i
+        false if text =~ /(false|f|no|n|0)$/i
+      else
+        text
+      end
     end
 
     # Create an entry in the data hash for the nested entity

data/lib/diaspora_federation/properties_dsl.rb

@@ -18,12 +18,15 @@ module DiasporaFederation
 
     # Define a generic (string-type) property
     # @param [Symbol] name property name
+    # @param [Symbol] type property type
     # @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
+    def property(name, type, opts={})
+      raise InvalidType unless property_type_valid?(type)
+
+      define_property name, type, opts
     end
 
     # Define a property that should contain another Entity or an array of
@@ -35,7 +38,7 @@ module DiasporaFederation
     # @option opts [Object, #call] :default a default value, making the
     #   property optional
     def entity(name, type, opts={})
-      raise InvalidType unless type_valid?(type)
+      raise InvalidType unless entity_type_valid?(type)
 
       define_property name, type, opts
     end
@@ -86,9 +89,11 @@ module DiasporaFederation
 
     # @deprecated
     def determine_xml_name(name, type, opts={})
-      raise ArgumentError, "xml_name is not supported for nested entities" if type != String && opts.has_key?(:xml_name)
+      if !type.instance_of?(Symbol) && opts.has_key?(:xml_name)
+        raise ArgumentError, "xml_name is not supported for nested entities"
+      end
 
-      if type == String
+      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]
@@ -121,10 +126,14 @@ module DiasporaFederation
       name.instance_of?(Symbol)
     end
 
+    def property_type_valid?(type)
+      %i(string integer boolean timestamp).include?(type)
+    end
+
     # Checks if the type extends {Entity}
     # @param [Class] type the type to check
     # @return [Boolean]
-    def type_valid?(type)
+    def entity_type_valid?(type)
       [type].flatten.all? {|type|
         type.respond_to?(:ancestors) && type.ancestors.include?(Entity)
       }

data/lib/diaspora_federation/version.rb

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

data/lib/tasks/rails4.rake

@@ -0,0 +1,15 @@
+if defined?(RSpec)
+  namespace :rails4 do
+    desc "Run all specs that generate fixtures for rspec with rails 4"
+    RSpec::Core::RakeTask.new(:generate_fixtures) do |t|
+      t.rspec_opts = ["--tag fixture4"]
+    end
+
+    desc "Run all specs in spec directory (exluding controller specs)"
+    RSpec::Core::RakeTask.new(:spec) do |task|
+      task.pattern = FileList["spec/**/*_spec.rb"].exclude("spec/controllers/**/*_spec.rb")
+    end
+
+    task test: %w(spec:prepare_db generate_fixtures spec)
+  end
+end

data/lib/tasks/tests.rake

@@ -1,6 +1,6 @@
 if defined?(RSpec)
   namespace :spec do
-    task prepare_db: %w(db:create db:test:load)
+    task prepare_db: %w(db:create db:environment:set db:test:load)
     task :prepare_fixtures do
       ENV["NO_COVERAGE"] = "true"
       Rake::Task["spec:generate_fixtures"].invoke

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diaspora_federation
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Benjamin Neff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-23 00:00:00.000000000 Z
+date: 2016-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -34,16 +34,22 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -188,6 +194,7 @@ files:
 - lib/diaspora_federation/version.rb
 - lib/tasks/build.rake
 - lib/tasks/diaspora_federation_tasks.rake
+- lib/tasks/rails4.rake
 - lib/tasks/tests.rake
 homepage: https://github.com/diaspora/diaspora_federation
 licenses:
@@ -209,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: diaspora* federation library