diaspora_federation 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69b26a0e6f05a364115daf455c348d72627c5577
-  data.tar.gz: accee3201502d60fff35a35d9902dc21a5935b35
+  metadata.gz: 9ba82f5232ef44f9731f00859c5a32fa8163570e
+  data.tar.gz: 01c7f76df999d4a0f476cf7c0ddbbc4f1a86ef0a
 SHA512:
-  metadata.gz: 0443a2e34f0d7805ae7e59edb85d4f63eb9c0639033d749f5050c8ef7d52aba2f88b5dcda4c76a495ea42c82ceb3470f605fe36861b73266e89964b8b8f279c6
-  data.tar.gz: 991d0a6307601a92a1b9dc3cd9127c58fe6c3a5a14448a1242d32d2d07f704759a0c7a1e83b936a7f09f563ca7d9837fa7b09f0f3aac828625eac5ca77ad2d94
+  metadata.gz: 49abed4f800587ea9f0a671cd1eccc74a3df06b58f9039e61a7540b8e809cf54b4b49f6e8d075e6fe943ffd687d10c2d0e48e250878d080e0c6370ff27979ee6
+  data.tar.gz: 36c5a25c0744fda688707de4d0c469d90989a3fb016e1af39e030efa38dddc3d4b6c9a89be21d52245950f41b59fb030c8c5eeda3a96e8475cdfa6ff3057c2b7

data/Changelog.md

@@ -0,0 +1,28 @@
+# 0.1.2
+
+## Refactor
+
+* Improve code documentation [#38](https://github.com/diaspora/diaspora_federation/pull/38)
+* Improve validation [9b32315](https://github.com/diaspora/diaspora_federation/commit/9b3231583d85e6007bf43cedc4480f043c8bde15) [eb8cdef](https://github.com/diaspora/diaspora_federation/commit/eb8cdef604cc8fe71e8455f36a317d80657f1582) [0980294](https://github.com/diaspora/diaspora_federation/commit/0980294a0d259cba1fa2a2a655163b3fa844d239)
+* Photo: `status_message_guid` is optional [4136fb9](https://github.com/diaspora/diaspora_federation/commit/4136fb973e7ad27158ef605df12727f4e959c3a3)
+* A GUID is at most 255 chars long [f7d269c](https://github.com/diaspora/diaspora_federation/commit/f7d269cd6a4c1b48a7b34083f5fea04ac0835a48)
+* hCard: `nickname` is optional [4b94949](https://github.com/diaspora/diaspora_federation/commit/4b949491df3a16b30f6e27113d6fa95c165c1edc)
+* StatusMessage: Rename `raw_message` to `text` [2aaff56](https://github.com/diaspora/diaspora_federation/commit/2aaff56e147b505626a615d60564fbbf22c2f452) [#29](https://github.com/diaspora/diaspora_federation/issues/29)
+
+## Bug fixes
+
+* Do not reuse cURL sockets to avoid issues caused by too many simultaneous connections [#37](https://github.com/diaspora/diaspora_federation/pull/37)
+* Handle empty xml-elements for nested entities [26b7991](https://github.com/diaspora/diaspora_federation/commit/26b7991defe1d84d10c1186a151676076946b26f)
+* Gracefully handle missing xml elements of relayables [9097097](https://github.com/diaspora/diaspora_federation/commit/90970973a58cbc3d897d21a43c0a6c93a30605be)
+
+# 0.1.1
+
+## Features
+
+* Fetch root posts for reshares [9b090a3](https://github.com/diaspora/diaspora_federation/commit/9b090a39501705f00403f124e215e78866039f1e)
+
+# 0.1.0
+
+## Features
+
+* Added Salmon support

data/README.md

@@ -10,7 +10,8 @@
 [![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/) |
+[Gem Documentation](http://www.rubydoc.info/gems/diaspora_federation/) |
+[Protocol Documentation](http://diaspora.github.io/diaspora_federation/) |
 [Bugtracker](https://github.com/diaspora/diaspora_federation/issues)
 
 This repository contains two gems:

data/lib/diaspora_federation.rb

@@ -48,7 +48,7 @@ module DiasporaFederation
     # @return [Callbacks] callbacks
     attr_reader :callbacks
 
-    # the pod url
+    # The pod url
     #
     # @overload server_uri
     #   @return [URI] the server uri
@@ -80,7 +80,7 @@ module DiasporaFederation
     #   @param [Integer] value max number of parallel requests
     attr_accessor :http_concurrency
 
-    # timeout in seconds for http-requests (default: +30+)
+    # Timeout in seconds for http-requests (default: +30+)
     #
     # @overload http_timeout
     #   @return [Integer] http timeout in seconds
@@ -98,15 +98,15 @@ module DiasporaFederation
     #   @param [Boolean] value verbose http output
     attr_accessor :http_verbose
 
-    # max redirects to follow
+    # Max redirects to follow
     # @return [Integer] max redirects
     attr_reader :http_redirect_limit
 
-    # user agent used for http-requests
+    # User agent used for http-requests
     # @return [String] user agent
     attr_reader :http_user_agent
 
-    # configure the federation library
+    # Configure the federation library
     #
     # @example
     #   DiasporaFederation.configure do |config|
@@ -120,7 +120,7 @@ module DiasporaFederation
       yield self
     end
 
-    # define the callbacks
+    # 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
@@ -130,7 +130,7 @@ module DiasporaFederation
     #
     # fetch_person_for_webfinger
     #   Fetches person data from the application to form a WebFinger reply
-    #   @param [String] Diaspora ID of the person
+    #   @param [String] diaspora* ID of the person
     #   @return [DiasporaFederation::Discovery::WebFinger] person webfinger data
     #
     # fetch_person_for_hcard
@@ -144,13 +144,13 @@ module DiasporaFederation
     #   @param [DiasporaFederation::Entities::Person] person data
     #
     # fetch_private_key
-    #   Fetches a private key of a person by her Diaspora ID from the application
-    #   @param [String] Diaspora ID of the person
+    #   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_public_key
-    #   Fetches a public key of a person by her Diaspora ID from the application
-    #   @param [String] Diaspora ID of the person
+    #   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_related_entity
@@ -178,12 +178,12 @@ module DiasporaFederation
     #     see {Receiver.receive_private}
     #
     # fetch_public_entity
-    #   fetch a public entity from the database
+    #   Fetch a public entity from the database
     #   @param [String] entity_type (Post, StatusMessage, etc)
     #   @param [String] guid the guid of the entity
     #
     # fetch_person_url_to
-    #   fetch the url to path for a person
+    #   Fetch the url to path for a person
     #   @param [String] diaspora_id
     #   @param [String] path
     #
@@ -206,7 +206,7 @@ module DiasporaFederation
       @callbacks.instance_eval(&block)
     end
 
-    # validates if the engine is configured correctly
+    # Validates if the engine is configured correctly
     #
     # called from after_initialize
     # @raise [ConfigurationError] if the configuration is incomplete or invalid

data/lib/diaspora_federation/callbacks.rb

@@ -2,7 +2,7 @@ module DiasporaFederation
   # Callbacks are used to communicate with the application. They are called to
   # fetch data and after data is received.
   class Callbacks
-    # Initializes a new Callbacks object with the event-keys that need to be defined.
+    # Initializes a new Callbacks object with the event-keys that need to be defined
     #
     # @example
     #   Callbacks.new %i(
@@ -16,7 +16,7 @@ module DiasporaFederation
       @handlers = {}
     end
 
-    # defines a callback
+    # Defines a callback
     #
     # @example
     #   callbacks.on :some_event do |arg1|
@@ -33,7 +33,7 @@ module DiasporaFederation
       @handlers[event] = callback
     end
 
-    # triggers a callback
+    # Triggers a callback
     #
     # @example
     #   callbacks.trigger :some_event, "foo"
@@ -47,7 +47,7 @@ module DiasporaFederation
       @handlers[event].call(*args)
     end
 
-    # checks if all callbacks are defined
+    # Checks if all callbacks are defined
     # @return [Boolean]
     def definition_complete?
       missing_handlers.empty?

data/lib/diaspora_federation/discovery.rb

@@ -1,7 +1,7 @@
 module DiasporaFederation
   # This module provides the namespace for the various classes implementing
   # WebFinger and other protocols used for metadata discovery on remote servers
-  # in the Diaspora* network.
+  # in the diaspora* network.
   module Discovery
   end
 end

data/lib/diaspora_federation/discovery/discovery.rb

@@ -1,19 +1,19 @@
 module DiasporaFederation
   module Discovery
-    # This class contains the logic to fetch all data for the given diaspora ID
+    # This class contains the logic to fetch all data for the given diaspora* ID.
     class Discovery
       include DiasporaFederation::Logging
 
-      # @return [String] the diaspora ID of the account
+      # @return [String] the diaspora* ID of the account
       attr_reader :diaspora_id
 
-      # create a discovery class for the diaspora-id
-      # @param [String] diaspora_id the diaspora id to discover
+      # Creates a discovery class for the diaspora* ID
+      # @param [String] diaspora_id the diaspora* ID to discover
       def initialize(diaspora_id)
         @diaspora_id = clean_diaspora_id(diaspora_id)
       end
 
-      # fetch all metadata for the account and saves it via callback
+      # Fetches all metadata for the account and saves it via callback
       # @return [Person]
       def fetch_and_save
         logger.info "Fetch data for #{diaspora_id}"
@@ -28,9 +28,9 @@ module DiasporaFederation
       private
 
       def validate_diaspora_id
-        # validates if the diaspora ID matches the diaspora ID in the webfinger response
+        # Validates if the diaspora* ID matches the diaspora* ID in the webfinger response
         return if diaspora_id == clean_diaspora_id(webfinger.acct_uri)
-        raise DiscoveryError, "Diaspora ID does not match: Wanted #{diaspora_id} but got" \
+        raise DiscoveryError, "diaspora* ID does not match: Wanted #{diaspora_id} but got" \
                               " #{clean_diaspora_id(webfinger.acct_uri)}"
       end
 
@@ -59,7 +59,7 @@ module DiasporaFederation
       end
 
       def legacy_webfinger_url_from_host_meta
-        # this tries the xrd url with https first, then falls back to http
+        # This tries the xrd url with https first, then falls back to http.
         host_meta = HostMeta.from_xml get(host_meta_url, true)
         host_meta.webfinger_template_url.gsub("{uri}", "acct:#{diaspora_id}")
       end

data/lib/diaspora_federation/discovery/h_card.rb

@@ -1,6 +1,6 @@
 module DiasporaFederation
   module Discovery
-    # This class provides the means of generating an parsing account data to and
+    # This class provides the means of generating and parsing account data to and
     # from the hCard format.
     # hCard is based on +RFC 2426+ (vCard) which got superseded by +RFC 6350+.
     # There is a draft for a new h-card format specification, that makes use of
@@ -46,9 +46,9 @@ module DiasporaFederation
       property :guid
 
       # @!attribute [r] nickname
-      #   the first part of the diaspora ID
+      #   The first part of the diaspora* ID
       #   @return [String] nickname
-      property :nickname
+      property :nickname, default: nil
 
       # @!attribute [r] full_name
       #   @return [String] display name of the user
@@ -56,7 +56,7 @@ module DiasporaFederation
 
       # @!attribute [r] url
       #   @deprecated should be changed to the profile url. The pod url is in
-      #     the WebFinger (see {WebFinger#seed_url}, will affect older Diaspora*
+      #     the WebFinger (see {WebFinger#seed_url}, will affect older diaspora*
       #     installations).
       #
       #   @return [String] link to the pod
@@ -83,7 +83,7 @@ module DiasporaFederation
 
       # @!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).
+      #     in later iterations (will affect older diaspora* installations).
       #
       #   @see #full_name
       #   @return [String] first name
@@ -91,7 +91,7 @@ module DiasporaFederation
 
       # @!attribute [r] last_name
       #   @deprecated We decided to only use one name field, these should be removed
-      #     in later iterations (will affect older Diaspora* installations).
+      #     in later iterations (will affect older diaspora* installations).
       #
       #   @see #full_name
       #   @return [String] last name
@@ -100,7 +100,7 @@ module DiasporaFederation
       # @!attribute [r] searchable
       #   @deprecated As this is a simple property, consider move to WebFinger instead
       #     of HCard. vCard has no comparable field for this information, but
-      #     Webfinger may declare arbitrary properties (will affect older Diaspora*
+      #     Webfinger may declare arbitrary properties (will affect older diaspora*
       #     installations).
       #
       #   flag if a user is searchable by name
@@ -152,7 +152,7 @@ module DiasporaFederation
         builder.doc.to_xhtml(indent: 2, indent_text: " ")
       end
 
-      # Creates a new HCard instance from the given HTML string.
+      # Creates a new HCard instance from the given HTML string
       # @param html_string [String] HTML string
       # @return [HCard] HCard instance
       # @raise [InvalidData] if the HTML string is invalid or incomplete
@@ -219,7 +219,7 @@ module DiasporaFederation
         end
       end
 
-      # Calls {HCard#add_property} for a simple text property.
+      # Calls {HCard#add_property} for a simple text property
       # @param container [Nokogiri::XML::Element] parent element
       # @param name [Symbol] property name
       # @param class_name [String] HTML class name
@@ -253,8 +253,7 @@ module DiasporaFederation
       # @param [LibXML::XML::Document] doc HTML document
       # @return [Boolean] validation result
       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[:photo]).nil?)
+        !(doc.at_css(SELECTORS[:fn]).nil? || doc.at_css(SELECTORS[:photo]).nil?)
       end
 
       private_class_method def self.parse_html_and_validate(html_string)
@@ -270,7 +269,7 @@ module DiasporaFederation
       end
 
       private_class_method def self.content_from_doc(doc, content_selector)
-        element_from_doc(doc, content_selector).content
+        element_from_doc(doc, content_selector).try(:content)
       end
 
       private_class_method def self.photo_from_doc(doc, photo_selector)

data/lib/diaspora_federation/discovery/host_meta.rb

@@ -4,7 +4,7 @@ module DiasporaFederation
     # Generates and parses Host Meta documents.
     #
     # This is a minimal implementation of the standard, only to the degree of what
-    # is used for the purposes of the Diaspora* protocol. (e.g. WebFinger)
+    # is used for the purposes of the diaspora* protocol. (e.g. WebFinger)
     #
     # @example Creating a Host Meta document
     #   doc = HostMeta.from_base_url("https://pod.example.tld/")
@@ -19,7 +19,7 @@ module DiasporaFederation
     class HostMeta
       private_class_method :new
 
-      # create a new host-meta instance
+      # Creates a new host-meta instance
       # @param [String] webfinger_url the webfinger-url
       def initialize(webfinger_url)
         @webfinger_url = webfinger_url

data/lib/diaspora_federation/discovery/web_finger.rb

@@ -1,9 +1,7 @@
 module DiasporaFederation
   module Discovery
-    # The WebFinger document used for Diaspora* user discovery is based on an older
-    # draft of the specification you can find in the wiki of the "webfinger" project
-    # on {http://code.google.com/p/webfinger/wiki/WebFingerProtocol Google Code}
-    # (from around 2010).
+    # The WebFinger document used for diaspora* user discovery is based on an
+    # {http://tools.ietf.org/html/draft-jones-appsawg-webfinger older draft of the specification}.
     #
     # In the meantime an actual RFC draft has been in development, which should
     # serve as a base for all future changes of this implementation.
@@ -30,7 +28,6 @@ module DiasporaFederation
     #
     # @see http://tools.ietf.org/html/draft-jones-appsawg-webfinger "WebFinger" -
     #   current draft
-    # @see http://code.google.com/p/webfinger/wiki/CommonLinkRelations
     # @see http://www.iana.org/assignments/link-relations/link-relations.xhtml
     #   official list of IANA link relations
     class WebFinger < Entity
@@ -58,7 +55,7 @@ module DiasporaFederation
       property :profile_url
 
       # @!attribute [r] atom_url
-      #   This atom feed is an Activity Stream of the user's public posts. Diaspora
+      #   This atom feed is an Activity Stream of the user's public posts. diaspora*
       #   pods SHOULD publish an Activity Stream of public posts, but there is
       #   currently no requirement to be able to read Activity Streams.
       #   @see http://activitystrea.ms/ Activity Streams specification
@@ -82,7 +79,7 @@ module DiasporaFederation
       # @!attribute [r] guid
       #   @deprecated Either convert these to +Property+ elements or move to the
       #     +hCard+, which actually has fields for an +UID+ defined in the +vCard+
-      #     specification (will affect older Diaspora* installations).
+      #     specification (will affect older diaspora* installations).
       #
       #   @see HCard#guid
       #   @see Entities::Person#guid
@@ -92,7 +89,7 @@ module DiasporaFederation
       # @!attribute [r] public_key
       #   @deprecated Either convert these to +Property+ elements or move to the
       #     +hCard+, which actually has fields for an +KEY+ defined in the +vCard+
-      #     specification (will affect older Diaspora* installations).
+      #     specification (will affect older diaspora* installations).
       #
       #   @see HCard#public_key
       #
@@ -111,7 +108,7 @@ module DiasporaFederation
 
       # @deprecated This should be a +Property+ or moved to the +hCard+, but +Link+
       #   is inappropriate according to the specification (will affect older
-      #   Diaspora* installations).
+      #   diaspora* installations).
       # +guid+ link relation
       REL_GUID = "http://joindiaspora.com/guid".freeze
 
@@ -130,11 +127,11 @@ module DiasporaFederation
 
       # @deprecated This should be a +Property+ or moved to the +hcard+, but +Link+
       #   is inappropriate according to the specification (will affect older
-      #   Diaspora* installations).
+      #   diaspora* installations).
       # +pubkey+ link relation
       REL_PUBKEY = "diaspora-public-key".freeze
 
-      # Create the XML string from the current WebFinger instance
+      # Creates the XML string from the current WebFinger instance
       # @return [String] XML string
       def to_xml
         doc = XrdDocument.new
@@ -146,7 +143,7 @@ module DiasporaFederation
         doc.to_xml
       end
 
-      # Create a WebFinger instance from the given XML string.
+      # Creates a WebFinger instance from the given XML string
       # @param [String] webfinger_xml WebFinger XML string
       # @return [WebFinger] WebFinger instance
       # @raise [InvalidData] if the given XML string is invalid or incomplete
@@ -229,7 +226,7 @@ module DiasporaFederation
         element ? element[:template] : nil
       end
 
-      # this method is used to parse the alias_url from the XML.
+      # 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)

data/lib/diaspora_federation/discovery/xrd_document.rb

@@ -1,7 +1,7 @@
 module DiasporaFederation
   module Discovery
     # This class implements basic handling of XRD documents as far as it is
-    # necessary in the context of the protocols used with Diaspora* federation.
+    # necessary in the context of the protocols used with diaspora* federation.
     #
     # @note {http://tools.ietf.org/html/rfc6415 RFC 6415} recommends that servers
     #   should also offer the JRD format in addition to the XRD representation.

data/lib/diaspora_federation/entities.rb

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