diaspora_federation 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c58b6c0d7617af4b0553b67d89ab34de553559b
-  data.tar.gz: 1954af247aa2309fbf3abb137ef42056f249747b
+  metadata.gz: f1cc502235f056676364d5b56b814650f284c8e5
+  data.tar.gz: 2b031425ffe4b1b5d83ac789ee674dc0f31f423a
 SHA512:
-  metadata.gz: a6d293bb5e33dbce5549eee3b89165e45f4f556825d9dc2cd5366c8e5a616eda8ea80d780e3b273a0cd66348ea8b517e40196612e086ff8f68d65170d8f6028a
-  data.tar.gz: 9205d8677d54083e4fdc0cb9c988271b97715b01d58453c7c59a139d9cc3e3661e36940b07333c29f88915a3ce7ba8000f3edd6811b5fe3cad2fcb8991643d3f
+  metadata.gz: 0f4691907170170b696306f6c65cfc2855e9b95b166850f1c72c5f96fdbe6657c0cf31cb6b8ab3cf55369da424103388d0e24be445e34cf61daaa1b2ad1a187a
+  data.tar.gz: 12e1dde41d27bd0ee229a2befd99a6d6329bd7aca49f822e3d29c0a79e6135892238672321cdf1ad64813b78e441552fc318733729415f32c1f0983b42c4a4b8

data/README.md

@@ -2,7 +2,9 @@
 
 **A library that provides functionalities needed for the diaspora* federation protocol**
 
-[![Build Status](https://travis-ci.org/SuperTux88/diaspora_federation.svg?branch=master)](https://travis-ci.org/SuperTux88/diaspora_federation)
+**master:** [![Build Status master](https://travis-ci.org/SuperTux88/diaspora_federation.svg?branch=master)](https://travis-ci.org/SuperTux88/diaspora_federation)
+**develop:** [![Build Status develop](https://travis-ci.org/SuperTux88/diaspora_federation.svg?branch=develop)](https://travis-ci.org/SuperTux88/diaspora_federation)
+
 [![Code Climate](https://codeclimate.com/github/SuperTux88/diaspora_federation/badges/gpa.svg)](https://codeclimate.com/github/SuperTux88/diaspora_federation)
 [![Test Coverage](https://codeclimate.com/github/SuperTux88/diaspora_federation/badges/coverage.svg)](https://codeclimate.com/github/SuperTux88/diaspora_federation/coverage)
 [![Dependency Status](https://gemnasium.com/SuperTux88/diaspora_federation.svg)](https://gemnasium.com/SuperTux88/diaspora_federation)

data/lib/diaspora_federation.rb

@@ -7,9 +7,11 @@ require "diaspora_federation/validators"
 
 require "diaspora_federation/fetcher"
 
+require "diaspora_federation/signing"
 require "diaspora_federation/entities"
 
 require "diaspora_federation/discovery"
+require "diaspora_federation/salmon"
 
 # diaspora* federation library
 module DiasporaFederation
@@ -19,13 +21,18 @@ module DiasporaFederation
     fetch_person_for_webfinger
     fetch_person_for_hcard
     save_person_after_webfinger
+    fetch_private_key_by_diaspora_id
+    fetch_author_private_key_by_entity_guid
+    fetch_public_key_by_diaspora_id
+    fetch_author_public_key_by_entity_guid
+    entity_author_is_local?
+    fetch_entity_author_id_by_guid
   )
 
   class << self
     # {Callbacks} instance with defined callbacks
     # @see Callbacks#on
     # @see Callbacks#trigger
-    #
     attr_reader :callbacks
 
     # the pod url
@@ -58,6 +65,64 @@ module DiasporaFederation
 
     # define the callbacks
     #
+    # In order to communicate with the application which uses the diaspora_federation gem
+    # callbacks are introduced. The callbacks are used for getting required data from the
+    # application or posting data to the application.
+    #
+    # Callbacks are implemented at the application side and must follow these specifications:
+    #
+    # fetch_person_for_webfinger
+    #   Fetches person data from the application to form a WebFinger reply
+    #   @param [String] Diaspora ID of the person
+    #   @return [DiasporaFederation::Discovery::WebFinger] person webfinger data
+    #
+    # fetch_person_for_hcard
+    #   Fetches person data from the application to reply for an HCard query
+    #   @param [String] guid of the person
+    #   @return [DiasporaFederation::Discovery::HCard] person hcard data
+    #
+    # save_person_after_webfinger
+    #   After the gem had made a person discovery using WebFinger it calls this callback
+    #   so the application saves the person data
+    #   @param [DiasporaFederation::Entities::Person] person data
+    #
+    # fetch_private_key_by_diaspora_id
+    #   Fetches a private key of a person by her Diaspora ID from the application
+    #   @param [String] Diaspora ID of the person
+    #   @return [OpenSSL::PKey::RSA] key
+    #
+    # fetch_author_private_key_by_entity_guid
+    #   Fetches a private key of the person who authored an entity identified by a given guid
+    #   @param [String] entity type (Post, Comment, Like, etc)
+    #   @param [String] guid of the entity
+    #   @return [OpenSSL::PKey::RSA] key
+    #
+    # fetch_public_key_by_diaspora_id
+    #   Fetches a public key of a person by her Diaspora ID from the application
+    #   @param [String] Diaspora ID of the person
+    #   @return [OpenSSL::PKey::RSA] key
+    #
+    # fetch_author_public_key_by_entity_guid
+    #   Fetches a public key of the person who authored an entity identified by a given guid
+    #   @param [String] entity type (Post, Comment, Like, etc)
+    #   @param [String] guid of the entity
+    #   @return [OpenSSL::PKey::RSA] key
+    #
+    # entity_author_is_local?
+    #   Reports if the author of the entity identified by a given guid is local on the pod
+    #   where we operate.
+    #   @param [String] entity type (Post, Comment, Like, etc)
+    #   @param [String] guid of the entity
+    #   @return [Boolean]
+    #
+    # fetch_entity_author_id_by_guid
+    #   Fetches Diaspora ID of the person who authored the entity identified by a given guid
+    #   @param [String] entity type (Post, Comment, Like, etc)
+    #   @param [String] guid of the entity
+    #   @return [String] Diaspora ID of the person
+    #
+    # @see Callbacks#on
+    #
     # @example
     #   config.define_callbacks do
     #     on :some_event do |arg1|

data/lib/diaspora_federation/discovery/h_card.rb

@@ -41,14 +41,13 @@ module DiasporaFederation
     # @see http://www.ietf.org/rfc/rfc6350.txt "vCard Format Specification"
     class HCard < Entity
       # @!attribute [r] guid
-      #   This is just the guid. When a user creates an account on a pod, the pod
-      #   MUST assign them a guid - a random hexadecimal string of at least 8
-      #   hexadecimal digits.
+      #   @see Entities::Person#guid
       #   @return [String] guid
       property :guid
 
       # @!attribute [r] nickname
       #   the first part of the diaspora ID
+      #   @see Entities::Person#diaspora_id
       #   @return [String] nickname
       property :nickname
 

data/lib/diaspora_federation/discovery/web_finger.rb

@@ -81,10 +81,7 @@ module DiasporaFederation
       #     specification (will affect older Diaspora* installations).
       #
       #   @see HCard#guid
-      #
-      #   This is just the guid. When a user creates an account on a pod, the pod
-      #   MUST assign them a guid - a random hexadecimal string of at least 8
-      #   hexadecimal digits.
+      #   @see Entities::Person#guid
       #   @return [String] guid
       property :guid
 
@@ -93,7 +90,7 @@ module DiasporaFederation
       #     +hCard+, which actually has fields for an +KEY+ defined in the +vCard+
       #     specification (will affect older Diaspora* installations).
       #
-      #   @see HCard#pubkey
+      #   @see HCard#public_key
       #
       #   When a user is created on the pod, the pod MUST generate a pgp keypair
       #   for them. This key is used for signing messages. The format is a
@@ -152,7 +149,7 @@ module DiasporaFederation
         links = data[:links]
 
         # TODO: remove! public key is deprecated in webfinger
-        public_key  = parse_link(links, REL_PUBKEY)
+        public_key = parse_link(links, REL_PUBKEY)
 
         new(
           acct_uri:    data[:subject],

data/lib/diaspora_federation/entities.rb

@@ -8,5 +8,23 @@ module DiasporaFederation
   end
 end
 
+require "diaspora_federation/entities/relayable"
 require "diaspora_federation/entities/profile"
 require "diaspora_federation/entities/person"
+require "diaspora_federation/entities/location"
+require "diaspora_federation/entities/photo"
+require "diaspora_federation/entities/poll_answer"
+require "diaspora_federation/entities/poll"
+require "diaspora_federation/entities/status_message"
+require "diaspora_federation/entities/request"
+require "diaspora_federation/entities/participation"
+require "diaspora_federation/entities/like"
+require "diaspora_federation/entities/comment"
+require "diaspora_federation/entities/account_deletion"
+require "diaspora_federation/entities/message"
+require "diaspora_federation/entities/conversation"
+require "diaspora_federation/entities/relayable_retraction"
+require "diaspora_federation/entities/reshare"
+require "diaspora_federation/entities/retraction"
+require "diaspora_federation/entities/signed_retraction"
+require "diaspora_federation/entities/poll_participation"

data/lib/diaspora_federation/entities/account_deletion.rb

@@ -0,0 +1,14 @@
+module DiasporaFederation
+  module Entities
+    # this entity is sent when account was deleted on a remote pod
+    #
+    # @see Validators::AccountDeletionValidator
+    class AccountDeletion < Entity
+      # @!attribute [r] diaspora_id
+      #   The diaspora ID of the deleted account
+      #   @see Person#diaspora_id
+      #   @return [String] diaspora ID
+      property :diaspora_id, xml_name: :diaspora_handle
+    end
+  end
+end

data/lib/diaspora_federation/entities/comment.rb

@@ -0,0 +1,26 @@
+module DiasporaFederation
+  module Entities
+    # this entity represents a comment to some kind of post (e.g. status message)
+    #
+    # @see Validators::CommentValidator
+    class Comment < Entity
+      # @!attribute [r] guid
+      #   a random string of at least 16 chars.
+      #   @see Validation::Rule::Guid
+      #   @return [String] comment guid
+      property :guid
+
+      include Relayable
+
+      # @!attribute [r] text
+      #   @return [String] the comment text
+      property :text
+
+      # @!attribute [r] diaspora_id
+      #   The diaspora ID of the author.
+      #   @see Person#diaspora_id
+      #   @return [String] diaspora ID
+      property :diaspora_id, xml_name: :diaspora_handle
+    end
+  end
+end

data/lib/diaspora_federation/entities/conversation.rb

@@ -0,0 +1,38 @@
+module DiasporaFederation
+  module Entities
+    # this entity represents a private conversation between users
+    #
+    # @see Validators::ConversationValidator
+    class Conversation < Entity
+      # @!attribute [r] guid
+      #   a random string of at least 16 chars.
+      #   @see Validation::Rule::Guid
+      #   @return [String] conversation guid
+      property :guid
+
+      # @!attribute [r] subject
+      #   @return [String] the conversation subject
+      property :subject
+
+      # @!attribute [r] created_at
+      #   @return [Time] Conversation creation time
+      property :created_at, default: -> { Time.now.utc }
+
+      # @!attribute [r] messages
+      #   @return [[Entities::Message]] Messages of this conversation
+      entity :messages, [Entities::Message]
+
+      # @!attribute [r] diaspora_id
+      #   The diaspora ID of the person initiated the conversation.
+      #   @see Person#diaspora_id
+      #   @return [String] diaspora ID
+      property :diaspora_id, xml_name: :diaspora_handle
+
+      # @!attribute [r] participant_ids
+      #   The diaspora IDs of the persons participating the conversation separated by ";".
+      #   @see Person#diaspora_id
+      #   @return [String] participants diaspora IDs
+      property :participant_ids, xml_name: :participant_handles
+    end
+  end
+end

data/lib/diaspora_federation/entities/like.rb

@@ -0,0 +1,35 @@
+module DiasporaFederation
+  module Entities
+    # this entity represents a like to some kind of post (e.g. status message)
+    #
+    # @see Validators::LikeValidator
+    class Like < Entity
+      # @!attribute [r] positive
+      #   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
+
+      # @!attribute [r] guid
+      #   a random string of at least 16 chars.
+      #   @see Validation::Rule::Guid
+      #   @return [String] like guid
+      property :guid
+
+      # @!attribute [r] target_type
+      #   A string describing the type of the target.
+      #   Can be "Post" or "Comment" (Comments are currently not implemented in the
+      #   Diaspora Frontend).
+      #   @return [String] target type
+      property :target_type
+
+      include Relayable
+
+      # @!attribute [r] diaspora_id
+      #   The diaspora ID of the person who posts a like
+      #   @see Person#diaspora_id
+      #   @return [String] diaspora ID
+      property :diaspora_id, xml_name: :diaspora_handle
+    end
+  end
+end

data/lib/diaspora_federation/entities/location.rb

@@ -0,0 +1,23 @@
+module DiasporaFederation
+  module Entities
+    # this entity is used to specify a location data and used embedded in a status message
+    #
+    # @see Validators::LocationValidator
+    class Location < Entity
+      # @!attribute [r] address
+      #   A string describing your location, e.g. a city name, a street name, etc
+      #   @return [String] address
+      property :address
+
+      # @!attribute [r] lat
+      #   Geographical latitude of your location
+      #   @return [String] latitude
+      property :lat
+
+      # @!attribute [r] lng
+      #   Geographical longitude of your location
+      #   @return [String] longitude
+      property :lng
+    end
+  end
+end

data/lib/diaspora_federation/entities/message.rb

@@ -0,0 +1,38 @@
+module DiasporaFederation
+  module Entities
+    # this entity represents a private message exchanged in private conversation
+    #
+    # @see Validators::MessageValidator
+    class Message < Entity
+      # @!attribute [r] guid
+      #   a random string of at least 16 chars.
+      #   @see Validation::Rule::Guid
+      #   @return [String] message guid
+      property :guid
+
+      include Relayable
+
+      # @!attribute [r] text
+      #   text of the message composed by a user
+      #   @return [String] text
+      property :text
+
+      # @!attribute [r] created_at
+      #   message creation time
+      #   @return [Time] creation time
+      property :created_at, default: -> { Time.now.utc }
+
+      # @!attribute [r] diaspora_id
+      #   The diaspora ID of the message author.
+      #   @see Person#diaspora_id
+      #   @return [String] diaspora ID
+      property :diaspora_id, xml_name: :diaspora_handle
+
+      # @!attribute [r] conversation_guid
+      #   guid of a conversation this message belongs to
+      #   @see Conversation#guid
+      #   @return [String] conversation guid
+      property :conversation_guid
+    end
+  end
+end

data/lib/diaspora_federation/entities/participation.rb

@@ -0,0 +1,28 @@
+module DiasporaFederation
+  module Entities
+    # participation is sent to subscribe a user on updates for some post
+    #
+    # @see Validators::Participation
+    class Participation < Entity
+      # @!attribute [r] guid
+      #   a random string of at least 16 chars.
+      #   @see Validation::Rule::Guid
+      #   @return [String] participation guid
+      property :guid
+
+      # @!attribute [r] target_type
+      #   a string describing a type of the target to subscribe on.
+      #   currently only "Post" is supported.
+      #   @return [String] target type
+      property :target_type
+
+      include Relayable
+
+      # @!attribute [r] diaspora_id
+      #   The diaspora ID of the person who subscribes on a post
+      #   @see Person#diaspora_id
+      #   @return [String] diaspora ID
+      property :diaspora_id, xml_name: :diaspora_handle
+    end
+  end
+end

data/lib/diaspora_federation/entities/person.rb

@@ -5,17 +5,20 @@ module DiasporaFederation
     # @see Validators::PersonValidator
     class Person < Entity
       # @!attribute [r] guid
-      #   @see HCard#guid
+      #   This is just the guid. When a user creates an account on a pod, the pod
+      #   MUST assign them a guid - a random string of at least 16 chars.
+      #   @see Validation::Rule::Guid
       #   @return [String] guid
       property :guid
 
       # @!attribute [r] diaspora_id
       #   The diaspora ID of the person
+      #   @see Validation::Rule::DiasporaId
       #   @return [String] diaspora ID
       property :diaspora_id, xml_name: :diaspora_handle
 
       # @!attribute [r] url
-      #   @see WebFinger#seed_url
+      #   @see Discovery::WebFinger#seed_url
       #   @return [String] link to the pod
       property :url
 
@@ -25,7 +28,7 @@ module DiasporaFederation
       entity :profile, Entities::Profile
 
       # @!attribute [r] exported_key
-      #   @see HCard#public_key
+      #   @see Discovery::HCard#public_key
       #   @return [String] public key
       property :exported_key
     end

data/lib/diaspora_federation/entities/photo.rb

@@ -0,0 +1,59 @@
+module DiasporaFederation
+  module Entities
+    # this entity represents photo and it is federated as a part of a status message
+    #
+    # @see Validators::PhotoValidator
+    class Photo < Entity
+      # @!attribute [r] guid
+      #   a random string of at least 16 chars.
+      #   @see Validation::Rule::Guid
+      #   @return [String] guid
+      property :guid
+
+      # @!attribute [r] diaspora_id
+      #   The diaspora ID of the person who uploaded the photo
+      #   @see Person#diaspora_id
+      #   @return [String] author diaspora ID
+      property :diaspora_id, 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
+
+      # @!attribute [r] created_at
+      #   photo entity creation time
+      #   @return [Time] creation time
+      property :created_at, 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
+
+      # @!attribute [r] remote_photo_name
+      #   @return [String] remote photo name
+      property :remote_photo_name
+
+      # @!attribute [r] text
+      #   @return [String] text
+      property :text, default: nil
+
+      # @!attribute [r] status_message_guid
+      #   guid of a status message this message belongs to
+      #   @see StatusMessage#guid
+      #   @return [String] guid
+      property :status_message_guid
+
+      # @!attribute [r] height
+      #   photo height
+      #   @return [String] height
+      property :height
+
+      # @!attribute [r] width
+      #   photo width
+      #   @return [String] width
+      property :width
+    end
+  end
+end