diaspora_federation 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 139e142cef6dcafa3a2f3cf6d29c5c32e139d175
-  data.tar.gz: afaa1ff9f0c2c53829c0e57d80e099d8a5ea7da4
+  metadata.gz: 1eab26d24aadd05dde520265d1fc2cae76cb71bb
+  data.tar.gz: 0454bedd0f5cef501c7a99d04a1e67db3f13db9e
 SHA512:
-  metadata.gz: f7d23b7d5eae3ebfe956dca44fc3807ef4f035e3627568ebf4d6c5edbc8a8ff186277b5318ffbbef43186cf51b2e45c7859a4eeb773ece60256844b486f82fc6
-  data.tar.gz: 1ac847a911f7254f426ea5141a95e65c770b82c32d48a8ca0d8f23a6b2c7a462a6358f4a7acbb0ff32ba9e5804caaf314086a72976cda15bacb2da66f5d75abf
+  metadata.gz: 6ed6351f1780275bfa7856e288ca6f23b202e8b34f54dae9d109ced23b8bb6c4815dfb1df171a29b0974737551b04694ff05750138ac5cbfe9a2866733da8d0c
+  data.tar.gz: 9fa0cb00be0cce4ee0c5aa1ffca7e33decb7e3f9afd9fc2019e898432f6dc57adf30ee5ab600256145756dc2395738eb607fc54970cd8728c5ad03a941af3ff0

data/lib/diaspora_federation.rb

@@ -1,3 +1,5 @@
+require "diaspora_federation/version"
+
 require "diaspora_federation/logging"
 
 require "diaspora_federation/callbacks"
@@ -5,14 +7,13 @@ require "diaspora_federation/properties_dsl"
 require "diaspora_federation/entity"
 require "diaspora_federation/validators"
 
-require "diaspora_federation/fetcher"
+require "diaspora_federation/http_client"
 
-require "diaspora_federation/signing"
 require "diaspora_federation/entities"
 
 require "diaspora_federation/discovery"
 require "diaspora_federation/salmon"
-require "diaspora_federation/receiver"
+require "diaspora_federation/federation"
 
 # diaspora* federation library
 module DiasporaFederation
@@ -30,29 +31,84 @@ module DiasporaFederation
     fetch_entity_author_id_by_guid
     queue_public_receive
     queue_private_receive
-    save_entity_after_receive
+    receive_entity
+    fetch_public_entity
+    fetch_person_url_to
+    update_pod
   )
 
+  # defaults
+  @http_concurrency = 20
+  @http_timeout = 30
+  @http_verbose = false
+  @http_redirect_limit = 4
+  @http_user_agent = "DiasporaFederation/#{DiasporaFederation::VERSION}"
+
   class << self
     # {Callbacks} instance with defined callbacks
     # @see Callbacks#on
     # @see Callbacks#trigger
+    # @return [Callbacks] callbacks
     attr_reader :callbacks
 
     # the pod url
     #
-    # @example with uri
-    #   config.server_uri = URI("http://localhost:3000/")
-    # @example with configured pod_uri
-    #   config.server_uri = AppConfig.pod_uri
+    # @overload server_uri
+    #   @return [URI] the server uri
+    # @overload server_uri=
+    #   @example with uri
+    #     config.server_uri = URI("http://localhost:3000/")
+    #   @example with configured pod_uri
+    #     config.server_uri = AppConfig.pod_uri
+    #   @param [URI] value the server uri
     attr_accessor :server_uri
 
     # Set the bundle of certificate authorities (CA) certificates
     #
-    # @example
-    #   config.certificate_authorities = AppConfig.environment.certificate_authorities.get
+    # @overload certificate_authorities
+    #   @return [String] path to certificate authorities
+    # @overload certificate_authorities=
+    #   @example
+    #     config.certificate_authorities = AppConfig.environment.certificate_authorities.get
+    #   @param [String] value path to certificate authorities
     attr_accessor :certificate_authorities
 
+    # Maximum number of parallel HTTP requests made to other pods (default: +20+)
+    #
+    # @overload http_concurrency
+    #   @return [Integer] max number of parallel requests
+    # @overload http_concurrency=
+    #   @example
+    #     config.http_concurrency = AppConfig.settings.typhoeus_concurrency.to_i
+    #   @param [Integer] value max number of parallel requests
+    attr_accessor :http_concurrency
+
+    # timeout in seconds for http-requests (default: +30+)
+    #
+    # @overload http_timeout
+    #   @return [Integer] http timeout in seconds
+    # @overload http_timeout=
+    #   @param [Integer] value http timeout in seconds
+    attr_accessor :http_timeout
+
+    # Turn on extra verbose output when sending stuff. (default: +false+)
+    #
+    # @overload http_verbose
+    #   @return [Boolean] verbose http output
+    # @overload http_verbose=
+    #   @example
+    #     config.http_verbose = AppConfig.settings.typhoeus_verbose?
+    #   @param [Boolean] value verbose http output
+    attr_accessor :http_verbose
+
+    # max redirects to follow
+    # @return [Integer] max redirects
+    attr_reader :http_redirect_limit
+
+    # user agent used for http-requests
+    # @return [String] user agent
+    attr_reader :http_user_agent
+
     # configure the federation library
     #
     # @example
@@ -97,7 +153,7 @@ module DiasporaFederation
     #
     # 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] entity_type (Post, Comment, Like, etc)
     #   @param [String] guid of the entity
     #   @return [OpenSSL::PKey::RSA] key
     #
@@ -108,36 +164,55 @@ module DiasporaFederation
     #
     # 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] 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] 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] entity_type (Post, Comment, Like, etc)
     #   @param [String] guid of the entity
     #   @return [String] Diaspora ID of the person
     #
     # queue_public_receive
     #   Queue a public salmon xml to process in background
-    #   @param [String] xml salmon xml
+    #   @param [String] data salmon slap xml or magic envelope xml
+    #   @param [Boolean] legacy true if it is a legacy salmon slap, false if it is a magic envelope xml
     #
     # queue_private_receive
     #   Queue a private salmon xml to process in background
     #   @param [String] guid guid of the receiver person
-    #   @param [String] xml salmon xml
+    #   @param [String] data salmon slap xml or encrypted magic envelope json
+    #   @param [Boolean] legacy true if it is a legacy salmon slap, false if it is a encrypted magic envelope json
     #   @return [Boolean] true if successful, false if the user was not found
     #
-    # save_entity_after_receive
+    # receive_entity
     #   After the xml was parsed and processed the gem calls this callback to persist the entity
     #   @param [DiasporaFederation::Entity] entity the received entity after processing
+    #   @param [Object] recipient_id identifier for the recipient of private messages or nil for public,
+    #     see {Receiver.receive_private}
+    #
+    # fetch_public_entity
+    #   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
+    #   @param [String] diaspora_id
+    #   @param [String] path
+    #
+    # update_pod
+    #   Update the pod status
+    #   @param [String] url the pod url
+    #   @param [Symbol, Integer] status the error as {Symbol} or the http-status as {Integer} if it was :ok
     #
     # @see Callbacks#on
     #
@@ -167,6 +242,8 @@ module DiasporaFederation
         end
       end
 
+      validate_http_config
+
       unless @callbacks.definition_complete?
         configuration_error "Missing handlers for #{@callbacks.missing_handlers.join(', ')}"
       end
@@ -176,8 +253,16 @@ module DiasporaFederation
 
     private
 
+    def validate_http_config
+      configuration_error "http_concurrency: please configure a number" unless @http_concurrency.is_a?(Fixnum)
+      configuration_error "http_timeout: please configure a number" unless @http_timeout.is_a?(Fixnum)
+
+      return unless !@http_verbose.is_a?(TrueClass) && !@http_verbose.is_a?(FalseClass)
+      configuration_error "http_verbose: please configure a boolean"
+    end
+
     def configuration_error(message)
-      logger.fatal("diaspora federation configuration error: #{message}")
+      logger.fatal "diaspora federation configuration error: #{message}"
       raise ConfigurationError, message
     end
   end

data/lib/diaspora_federation/discovery/discovery.rb

@@ -40,7 +40,7 @@ module DiasporaFederation
 
       def get(url, http_fallback=false)
         logger.info "Fetching #{url} for #{diaspora_id}"
-        response = Fetcher.get(url)
+        response = HttpClient.get(url)
         raise "Failed to fetch #{url}: #{response.status}" unless response.success?
         response.body
       rescue => e

data/lib/diaspora_federation/discovery/h_card.rb

@@ -47,7 +47,6 @@ module DiasporaFederation
 
       # @!attribute [r] nickname
       #   the first part of the diaspora ID
-      #   @see Entities::Person#diaspora_id
       #   @return [String] nickname
       property :nickname
 
@@ -121,7 +120,7 @@ module DiasporaFederation
         photo_small:  ".entity_photo_small .photo[src]",
         key:          ".key",
         searchable:   ".searchable"
-      }
+      }.freeze
 
       # Create the HTML string from the current HCard instance
       # @return [String] HTML string
@@ -209,13 +208,13 @@ module DiasporaFederation
       #
       # @param container [Nokogiri::XML::Element] parent element for added property HTML
       # @param name [Symbol] property name
-      # @param block [Proc] block returning an element
-      def add_property(container, name, &block)
+      # @yield [Nokogiri::HTML::Builder] html builder
+      def add_property(container, name)
         Nokogiri::HTML::Builder.with(container) do |html|
           html.dl(class: "entity_#{name}") {
             html.dt(name.to_s.capitalize)
             html.dd {
-              block.call(html)
+              yield html
             }
           }
         end

data/lib/diaspora_federation/discovery/host_meta.rb

@@ -26,7 +26,7 @@ module DiasporaFederation
       end
 
       # URL fragment to append to the base URL
-      WEBFINGER_SUFFIX = "/webfinger?q={uri}"
+      WEBFINGER_SUFFIX = "/webfinger?q={uri}".freeze
 
       # Returns the WebFinger URL that was used to build this instance (either from
       # xml or by giving a base URL).

data/lib/diaspora_federation/discovery/web_finger.rb

@@ -104,35 +104,35 @@ module DiasporaFederation
       property :public_key
 
       # +hcard_url+ link relation
-      REL_HCARD = "http://microformats.org/profile/hcard"
+      REL_HCARD = "http://microformats.org/profile/hcard".freeze
 
       # +seed_url+ link relation
-      REL_SEED = "http://joindiaspora.com/seed_location"
+      REL_SEED = "http://joindiaspora.com/seed_location".freeze
 
       # @deprecated This should be a +Property+ or moved to the +hCard+, but +Link+
       #   is inappropriate according to the specification (will affect older
       #   Diaspora* installations).
       # +guid+ link relation
-      REL_GUID = "http://joindiaspora.com/guid"
+      REL_GUID = "http://joindiaspora.com/guid".freeze
 
       # +profile_url+ link relation.
       # @note This might just as well be an +Alias+ instead of a +Link+.
-      REL_PROFILE = "http://webfinger.net/rel/profile-page"
+      REL_PROFILE = "http://webfinger.net/rel/profile-page".freeze
 
       # +atom_url+ link relation
-      REL_ATOM = "http://schemas.google.com/g/2010#updates-from"
+      REL_ATOM = "http://schemas.google.com/g/2010#updates-from".freeze
 
       # +salmon_url+ link relation
-      REL_SALMON = "salmon"
+      REL_SALMON = "salmon".freeze
 
       # +subscribe_url+ link relation
-      REL_SUBSCRIBE = "http://ostatus.org/schema/1.0/subscribe"
+      REL_SUBSCRIBE = "http://ostatus.org/schema/1.0/subscribe".freeze
 
       # @deprecated This should be a +Property+ or moved to the +hcard+, but +Link+
       #   is inappropriate according to the specification (will affect older
       #   Diaspora* installations).
       # +pubkey+ link relation
-      REL_PUBKEY = "diaspora-public-key"
+      REL_PUBKEY = "diaspora-public-key".freeze
 
       # Create the XML string from the current WebFinger instance
       # @return [String] XML string

data/lib/diaspora_federation/discovery/xrd_document.rb

@@ -29,13 +29,13 @@ module DiasporaFederation
     # @see http://docs.oasis-open.org/xri/xrd/v1.0/xrd-1.0.html Extensible Resource Descriptor (XRD) Version 1.0
     class XrdDocument
       # xml namespace url
-      XMLNS = "http://docs.oasis-open.org/ns/xri/xrd-1.0"
+      XMLNS = "http://docs.oasis-open.org/ns/xri/xrd-1.0".freeze
 
       # +Link+ element attributes
-      LINK_ATTRS = %i(rel type href template)
+      LINK_ATTRS = %i(rel type href template).freeze
 
       # format string for datetime (+Expires+ element)
-      DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
+      DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%SZ".freeze
 
       # The <Expires> element contains a time value which specifies the instant at
       # and after which the document has expired and SHOULD NOT be used.
@@ -67,7 +67,7 @@ module DiasporaFederation
       # Generates an XML document from the current instance and returns it as string
       # @return [String] XML document
       def to_xml
-        builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+        Nokogiri::XML::Builder.new(encoding: "UTF-8") {|xml|
           xml.XRD("xmlns" => XMLNS) {
             xml.Expires(@expires.strftime(DATETIME_FORMAT)) if @expires.instance_of?(DateTime)
 
@@ -77,8 +77,7 @@ module DiasporaFederation
             add_properties_to(xml)
             add_links_to(xml)
           }
-        end
-        builder.to_xml
+        }.to_xml
       end
 
       # Parse the XRD document from the given string and create a hash containing
@@ -108,7 +107,7 @@ module DiasporaFederation
 
       private
 
-      NS = {xrd: XMLNS}
+      NS = {xrd: XMLNS}.freeze
 
       def add_aliases_to(xml)
         @aliases.each do |a|

data/lib/diaspora_federation/entities.rb

@@ -8,23 +8,34 @@ module DiasporaFederation
   end
 end
 
+# abstract types
+require "diaspora_federation/entities/post"
 require "diaspora_federation/entities/relayable"
+
+# types
 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/contact"
+require "diaspora_federation/entities/account_deletion"
+
 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/poll_answer"
+require "diaspora_federation/entities/poll"
+require "diaspora_federation/entities/poll_participation"
+
+require "diaspora_federation/entities/location"
+require "diaspora_federation/entities/photo"
+require "diaspora_federation/entities/status_message"
+require "diaspora_federation/entities/reshare"
+
 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"
+
+# deprecated
+require "diaspora_federation/entities/request"
 require "diaspora_federation/entities/signed_retraction"
-require "diaspora_federation/entities/poll_participation"
+require "diaspora_federation/entities/relayable_retraction"

data/lib/diaspora_federation/entities/account_deletion.rb

@@ -4,11 +4,15 @@ module DiasporaFederation
     #
     # @see Validators::AccountDeletionValidator
     class AccountDeletion < Entity
-      # @!attribute [r] diaspora_id
+      # @!attribute [r] author
       #   The diaspora ID of the deleted account
-      #   @see Person#diaspora_id
+      #   @see Person#author
+      #   @return [String] diaspora ID
+      # @!attribute [r] diaspora_id
+      #   Alias for author
+      #   @see AccountDeletion#author
       #   @return [String] diaspora ID
-      property :diaspora_id, xml_name: :diaspora_handle
+      property :author, alias: :diaspora_id, xml_name: :diaspora_handle
     end
   end
 end

data/lib/diaspora_federation/entities/comment.rb

@@ -4,11 +4,9 @@ module DiasporaFederation
     #
     # @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
+      # old signature order
+      # @deprecated
+      LEGACY_SIGNATURE_ORDER = %i(guid parent_guid text author).freeze
 
       include Relayable
 
@@ -16,11 +14,16 @@ module DiasporaFederation
       #   @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
+      # @!attribute [r] created_at
+      #   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