diaspora_federation 0.0.13 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1eab26d24aadd05dde520265d1fc2cae76cb71bb
-  data.tar.gz: 0454bedd0f5cef501c7a99d04a1e67db3f13db9e
+  metadata.gz: f071a159d911e2981ecdd64fb43a6b35818517f5
+  data.tar.gz: 4b134feae0ef5815171db1bfda9535f50f83307b
 SHA512:
-  metadata.gz: 6ed6351f1780275bfa7856e288ca6f23b202e8b34f54dae9d109ced23b8bb6c4815dfb1df171a29b0974737551b04694ff05750138ac5cbfe9a2866733da8d0c
-  data.tar.gz: 9fa0cb00be0cce4ee0c5aa1ffca7e33decb7e3f9afd9fc2019e898432f6dc57adf30ee5ab600256145756dc2395738eb607fc54970cd8728c5ad03a941af3ff0
+  metadata.gz: 8b721717d3f9e6464adaeb94f4c590633cab55b5877219048ea0ee21a0bee8112297e268a5d29f1557af145e35becce6a71696a13e8d30f6b7324a1cedf5867d
+  data.tar.gz: 42b735837e07a028b3317045e82d1971fe786dfbb80df597ada691070800899935da49d349d80667624d13d78024bc73ca8f781b7d17fb177e61568ff1306058

data/README.md

@@ -1,29 +1,24 @@
 # diaspora* federation library
+### A library that provides functionalities needed for the diaspora\* federation protocol
 
-**A library that provides functionalities needed for the diaspora* federation protocol**
+**master:** [![Build Status master](https://travis-ci.org/diaspora/diaspora_federation.svg?branch=master)](https://travis-ci.org/diaspora/diaspora_federation) |
+**develop:** [![Build Status develop](https://travis-ci.org/diaspora/diaspora_federation.svg?branch=develop)](https://travis-ci.org/diaspora/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)
-[![Inline docs](https://inch-ci.org/github/SuperTux88/diaspora_federation.svg?branch=master)](https://inch-ci.org/github/SuperTux88/diaspora_federation)
+[![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)
 
 [Documentation](http://www.rubydoc.info/gems/diaspora_federation/) |
-[Bugtracker](https://github.com/SuperTux88/diaspora_federation/issues)
-
-## Library
+[Bugtracker](https://github.com/diaspora/diaspora_federation/issues)
 
-The ```diaspora_federation``` gem provides the functionality for de-/serialization and de-/encryption of Entities
-in the protocols used for communication among the various installations of Diaspora*
+This repository contains two gems:
 
-## Rails Engine
+* `diaspora_federation` provides the functionality for de-/serialization and de-/encryption of Entities in the protocols used for communication among the various installations of diaspora\*.
+* `diaspora_federation-rails` is a rails engine that adds the diaspora\* federation protocol to a rails app.
 
-The ```diaspora_federation-rails``` gem is a rails engine that adds the diaspora* federation protocol to a rails app.
-
-### Usage
+## Usage
 
 Add the gem to your ```Gemfile```:
 
@@ -61,22 +56,10 @@ DiasporaFederation.configure do |config|
 end
 ```
 
-## Development
-
-**!!! This gem is currently under heavy development, so every release can contain breaking changes !!!**
-
-If you want to help, please contact me, help is welcome.
-
-After the first stable release, this repo will be moved to the [diaspora organization](https://github.com/diaspora/).
-
-## Diaspora
-
-A privacy-aware, distributed, open source social network
+## Contributing
 
-Links:
-[Project site](https://diasporafoundation.org) |
-[Wiki](https://wiki.diasporafoundation.org)
+See [our contribution guide](/CONTRIBUTING.md) for more information on how to contribute to the diaspora\* federation library.
 
 ## License
 
-This gem is published under the terms of the "GNU Affero General Public License". See the LICENSE file for the exact wording.
+[GNU Affero General Public License](/LICENSE).

data/lib/diaspora_federation.rb

@@ -23,12 +23,9 @@ 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
+    fetch_private_key
+    fetch_public_key
+    fetch_related_entity
     queue_public_receive
     queue_private_receive
     receive_entity
@@ -146,40 +143,21 @@ module DiasporaFederation
     #   so the application saves the person data
     #   @param [DiasporaFederation::Entities::Person] person data
     #
-    # fetch_private_key_by_diaspora_id
+    # fetch_private_key
     #   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
+    # fetch_public_key
     #   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
+    # fetch_related_entity
+    #   Fetches a related entity 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
+    #   @return [DiasporaFederation::Entities::RelatedEntity] related entity
     #
     # queue_public_receive
     #   Queue a public salmon xml to process in background
@@ -267,7 +245,7 @@ module DiasporaFederation
     end
   end
 
-  # raised, if the engine is not configured correctly
+  # Raised, if the engine is not configured correctly
   class ConfigurationError < RuntimeError
   end
 end

data/lib/diaspora_federation/discovery/h_card.rb

@@ -60,7 +60,7 @@ module DiasporaFederation
       #     installations).
       #
       #   @return [String] link to the pod
-      property :url
+      property :url, default: nil
 
       # @!attribute [r] public_key
       #   When a user is created on the pod, the pod MUST generate a pgp keypair
@@ -163,7 +163,6 @@ module DiasporaFederation
           guid:             guid_from_doc(doc),
           nickname:         content_from_doc(doc, :nickname),
           full_name:        content_from_doc(doc, :fn),
-          url:              element_from_doc(doc, :url)["href"],
           photo_large_url:  photo_from_doc(doc, :photo),
           photo_medium_url: photo_from_doc(doc, :photo_medium),
           photo_small_url:  photo_from_doc(doc, :photo_small),
@@ -253,43 +252,37 @@ module DiasporaFederation
       # HTML document.
       # @param [LibXML::XML::Document] doc HTML document
       # @return [Boolean] validation result
-      def self.html_document_complete?(doc)
+      private_class_method def self.html_document_complete?(doc)
         !(doc.at_css(SELECTORS[:fn]).nil? || doc.at_css(SELECTORS[:nickname]).nil? ||
-          doc.at_css(SELECTORS[:url]).nil? || doc.at_css(SELECTORS[:photo]).nil?)
+          doc.at_css(SELECTORS[:photo]).nil?)
       end
-      private_class_method :html_document_complete?
 
-      def self.parse_html_and_validate(html_string)
+      private_class_method def self.parse_html_and_validate(html_string)
         raise ArgumentError, "hcard html is not a string" unless html_string.instance_of?(String)
 
         doc = Nokogiri::HTML::Document.parse(html_string)
         raise InvalidData, "hcard html incomplete" unless html_document_complete?(doc)
         doc
       end
-      private_class_method :parse_html_and_validate
 
-      def self.element_from_doc(doc, selector)
+      private_class_method def self.element_from_doc(doc, selector)
         doc.at_css(SELECTORS[selector])
       end
-      private_class_method :element_from_doc
 
-      def self.content_from_doc(doc, content_selector)
+      private_class_method def self.content_from_doc(doc, content_selector)
         element_from_doc(doc, content_selector).content
       end
-      private_class_method :content_from_doc
 
-      def self.photo_from_doc(doc, photo_selector)
+      private_class_method def self.photo_from_doc(doc, photo_selector)
         element_from_doc(doc, photo_selector)["src"]
       end
-      private_class_method :photo_from_doc
 
       # @deprecated hack for old hcard
       # @todo remove this when all pods have the new generator
-      def self.guid_from_doc(doc)
+      private_class_method def self.guid_from_doc(doc)
         uid_element = element_from_doc(doc, :uid)
         uid_element.content unless uid_element[:class].include? "nickname"
       end
-      private_class_method :guid_from_doc
     end
   end
 end

data/lib/diaspora_federation/discovery/host_meta.rb

@@ -75,19 +75,17 @@ module DiasporaFederation
       # Applies some basic sanity-checking to the given URL
       # @param [String] url validation subject
       # @return [Boolean] validation result
-      def self.webfinger_url_valid?(url)
+      private_class_method def self.webfinger_url_valid?(url)
         !url.nil? && url.instance_of?(String) && url =~ %r{^https?:\/\/.*\/.*\{uri\}.*}i
       end
-      private_class_method :webfinger_url_valid?
 
       # Gets the webfinger url from an XRD data structure
       # @param [Hash] data extracted data
       # @return [String] webfinger url
-      def self.webfinger_url_from_xrd(data)
+      private_class_method def self.webfinger_url_from_xrd(data)
         link = data[:links].find {|l| l[:rel] == "lrdd" }
         return link[:template] unless link.nil?
       end
-      private_class_method :webfinger_url_from_xrd
     end
   end
 end

data/lib/diaspora_federation/discovery/web_finger.rb

@@ -71,7 +71,7 @@ module DiasporaFederation
       # @!attribute [r] salmon_url
       #   @note could be nil
       #   @return [String] salmon endpoint url
-      #   @see http://salmon-protocol.googlecode.com/svn/trunk/draft-panzer-salmon-00.html#SMLR
+      #   @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
 
@@ -175,6 +175,11 @@ module DiasporaFederation
         )
       end
 
+      # @return [String] string representation of this object
+      def to_s
+        "WebFinger:#{acct_uri}"
+      end
+
       private
 
       # Parses the XML string to a Hash and does some rudimentary checking on
@@ -182,13 +187,12 @@ module DiasporaFederation
       # @param [String] webfinger_xml WebFinger XML string
       # @return [Hash] data XML data
       # @raise [InvalidData] if the given XML string is invalid or incomplete
-      def self.parse_xml_and_validate(webfinger_xml)
+      private_class_method def self.parse_xml_and_validate(webfinger_xml)
         XrdDocument.xml_data(webfinger_xml).tap do |data|
           valid = data.key?(:subject) && data.key?(:links)
           raise InvalidData, "webfinger xml is incomplete" unless valid
         end
       end
-      private_class_method :parse_xml_and_validate
 
       def add_links_to(doc)
         doc.links << {rel: REL_HCARD, type: "text/html", href: @hcard_url}
@@ -211,33 +215,29 @@ module DiasporaFederation
         ##################################
       end
 
-      def self.find_link(links, rel)
+      private_class_method def self.find_link(links, rel)
         links.find {|l| l[:rel] == rel }
       end
-      private_class_method :find_link
 
-      def self.parse_link(links, rel)
+      private_class_method def self.parse_link(links, rel)
         element = find_link(links, rel)
         element ? element[:href] : nil
       end
-      private_class_method :parse_link
 
-      def self.parse_link_template(links, rel)
+      private_class_method def self.parse_link_template(links, rel)
         element = find_link(links, rel)
         element ? element[:template] : nil
       end
-      private_class_method :parse_link_template
 
       # this method is used to parse the alias_url from the XML.
       # * redmatrix has sometimes no alias, return nil
       # * old pods had quotes around the alias url, this can be removed later
       # * friendica has two aliases and the first is with "acct:": return only an URL starting with http (or https)
-      def self.parse_alias(aliases)
+      private_class_method def self.parse_alias(aliases)
         return nil unless aliases
         # TODO: Old pods had quotes around alias. Remove the +map+ in next line, when all pods use this gem
         aliases.map {|a| a.gsub(/\A"|"\Z/, "") }.find {|a| a.start_with?("http") }
       end
-      private_class_method :parse_alias
     end
   end
 end

data/lib/diaspora_federation/discovery/xrd_document.rb

@@ -132,34 +132,31 @@ module DiasporaFederation
         end
       end
 
-      def self.parse_xrd_document(xrd_doc)
+      private_class_method def self.parse_xrd_document(xrd_doc)
         raise ArgumentError unless xrd_doc.instance_of?(String)
 
         doc = Nokogiri::XML::Document.parse(xrd_doc)
         raise InvalidDocument, "Not an XRD document" if !doc.root || doc.root.name != "XRD"
         doc
       end
-      private_class_method :parse_xrd_document
 
-      def self.parse_aliases_from_xml_doc(doc, data)
+      private_class_method def self.parse_aliases_from_xml_doc(doc, data)
         aliases = []
         doc.xpath("xrd:XRD/xrd:Alias", NS).each do |node|
           aliases << node.content
         end
         data[:aliases] = aliases unless aliases.empty?
       end
-      private_class_method :parse_aliases_from_xml_doc
 
-      def self.parse_properties_from_xml_doc(doc, data)
+      private_class_method def self.parse_properties_from_xml_doc(doc, data)
         properties = {}
         doc.xpath("xrd:XRD/xrd:Property", NS).each do |node|
           properties[node[:type]] = node.children.empty? ? nil : node.content
         end
         data[:properties] = properties unless properties.empty?
       end
-      private_class_method :parse_properties_from_xml_doc
 
-      def self.parse_links_from_xml_doc(doc, data)
+      private_class_method def self.parse_links_from_xml_doc(doc, data)
         links = []
         doc.xpath("xrd:XRD/xrd:Link", NS).each do |node|
           link = {}
@@ -170,7 +167,6 @@ module DiasporaFederation
         end
         data[:links] = links unless links.empty?
       end
-      private_class_method :parse_links_from_xml_doc
     end
   end
 end

data/lib/diaspora_federation/entities.rb

@@ -8,6 +8,8 @@ module DiasporaFederation
   end
 end
 
+require "diaspora_federation/entities/related_entity"
+
 # abstract types
 require "diaspora_federation/entities/post"
 require "diaspora_federation/entities/relayable"

data/lib/diaspora_federation/entities/account_deletion.rb

@@ -13,6 +13,11 @@ module DiasporaFederation
       #   @see AccountDeletion#author
       #   @return [String] diaspora ID
       property :author, alias: :diaspora_id, xml_name: :diaspora_handle
+
+      # @return [String] string representation of this object
+      def to_s
+        "AccountDeletion:#{author}"
+      end
     end
   end
 end

data/lib/diaspora_federation/entities/comment.rb

@@ -8,6 +8,9 @@ module DiasporaFederation
       # @deprecated
       LEGACY_SIGNATURE_ORDER = %i(guid parent_guid text author).freeze
 
+      # The {Comment} parent is a {Post}
+      PARENT_TYPE = "Post".freeze
+
       include Relayable
 
       # @!attribute [r] text
@@ -18,12 +21,6 @@ module DiasporaFederation
       #   comment entity creation time
       #   @return [Time] creation time
       property :created_at, default: -> { Time.now.utc }
-
-      # The {Comment} parent is a Post
-      # @return [String] parent type
-      def parent_type
-        "Post"
-      end
     end
   end
 end

data/lib/diaspora_federation/entities/contact.rb

@@ -24,6 +24,11 @@ module DiasporaFederation
       # @!attribute [r] sharing
       #   @return [Boolean] if the author is sharing with the person
       property :sharing, default: true
+
+      # @return [String] string representation of this object
+      def to_s
+        "Contact:#{author}:#{recipient}"
+      end
     end
   end
 end

data/lib/diaspora_federation/entities/conversation.rb

@@ -20,7 +20,7 @@ module DiasporaFederation
 
       # @!attribute [r] messages
       #   @return [[Entities::Message]] Messages of this conversation
-      entity :messages, [Entities::Message]
+      entity :messages, [Entities::Message], default: []
 
       # @!attribute [r] author
       #   The diaspora ID of the person initiated the conversation.
@@ -32,6 +32,15 @@ module DiasporaFederation
       #   The diaspora IDs of the persons participating the conversation separated by ";".
       #   @return [String] participants diaspora IDs
       property :participants, xml_name: :participant_handles
+
+      private
+
+      def validate
+        super
+        messages.each do |message|
+          raise ValidationError, "nested #{message} has different author: author=#{author}" if message.author != author
+        end
+      end
     end
   end
 end