diaspora_federation 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70e250962994a4f76c0232c5ea58fd2c02411766
-  data.tar.gz: 131351687ab2b4cd5e63fe7a1783103b3b43f83c
+  metadata.gz: bccc4300ee15d68f43e71ba93c0f5e5f9946b65d
+  data.tar.gz: ba2a345fbf4775253d8cecd0a56618eb2acbc4d8
 SHA512:
-  metadata.gz: 31ca9ff248eb49ba2b1ca310e7ab1f3447c488677ff6ed026f1bf39a1dbe16dde6fbf0cbc307e7fc6c1d9bb6c3123635711d8006546d5149395ab9acb13ff944
-  data.tar.gz: 569623cc75eeefcb9e6bdea8851495fd4fb5319664847234d4f0ddb51b4be457fce75d8deb722ee1c858fb42eb89c52be7054e6259428e23fe3ba3dc2ca30540
+  metadata.gz: 58c1303160966d0fd6e82f7383aaa073f518fe3905a4975fd8a799473a3802abbf9af10d97d3b6d683211d094a999f3dd9c8d907f456982f085e8843baa38868
+  data.tar.gz: 387570d4c545ae549afa95647c1c5e9648c0be32065b2ac2cbe1e14fae4a7b169b6243a82ba893ff7eb5d1c2e8718e6fbf946bb29b6dc43924717a104f93f4dc

data/Changelog.md

@@ -1,3 +1,17 @@
+# 0.1.7
+
+## Feature
+
+* Add event entities [#44](https://github.com/diaspora/diaspora_federation/pull/44)
+
+## Refactor
+
+* Add generated signatures of relayables to `#to_h` [#48](https://github.com/diaspora/diaspora_federation/pull/48)
+
+## Bug fixes
+
+* Fix parsing of false value [9a7fd27](https://github.com/diaspora/diaspora_federation/commit/9a7fd278b528c809b3a8c53b86c5fa8d6efaf8aa)
+
 # 0.1.6
 
 ## Feature

data/README.md

@@ -11,7 +11,7 @@
 [![Gem Version](https://badge.fury.io/rb/diaspora_federation.svg)](https://badge.fury.io/rb/diaspora_federation)
 
 [Gem Documentation](http://www.rubydoc.info/gems/diaspora_federation/) |
-[Protocol Documentation](http://diaspora.github.io/diaspora_federation/) |
+[Protocol Documentation](https://diaspora.github.io/diaspora_federation/) |
 [Bugtracker](https://github.com/diaspora/diaspora_federation/issues)
 
 This repository contains two gems:

data/lib/diaspora_federation/discovery/host_meta.rb

@@ -76,7 +76,7 @@ module DiasporaFederation
       # @param [String] url validation subject
       # @return [Boolean] validation result
       private_class_method def self.webfinger_url_valid?(url)
-        !url.nil? && url.instance_of?(String) && url =~ %r{^https?:\/\/.*\/.*\{uri\}.*}i
+        !url.nil? && url.instance_of?(String) && url =~ %r{\Ahttps?:\/\/.*\/.*\{uri\}.*}i
       end
 
       # Gets the webfinger url from an XRD data structure

data/lib/diaspora_federation/entities.rb

@@ -28,6 +28,10 @@ require "diaspora_federation/entities/poll"
 require "diaspora_federation/entities/poll_participation"
 
 require "diaspora_federation/entities/location"
+
+require "diaspora_federation/entities/event"
+require "diaspora_federation/entities/event_participation"
+
 require "diaspora_federation/entities/photo"
 require "diaspora_federation/entities/status_message"
 require "diaspora_federation/entities/reshare"

data/lib/diaspora_federation/entities/event.rb

@@ -0,0 +1,55 @@
+module DiasporaFederation
+  module Entities
+    # This entity represents an event and it is federated as a part of a status message.
+    #
+    # @see Validators::EventValidator
+    class Event < Entity
+      # @!attribute [r] author
+      #   The diaspora* ID of the person who created the event
+      #   @see Person#author
+      #   @return [String] author diaspora* ID
+      property :author, :string
+
+      # @!attribute [r] guid
+      #   A random string of at least 16 chars
+      #   @see Validation::Rule::Guid
+      #   @return [String] guid
+      property :guid, :string
+
+      # @!attribute [r] summary
+      #   The summary of the event
+      #   @return [String] event summary
+      property :summary, :string
+
+      # @!attribute [r] description
+      #   Description of the event
+      #   @return [String] event description
+      property :description, :string, default: nil
+
+      # @!attribute [r] start
+      #   The start time of the event
+      #   @return [String] event start
+      property :start, :timestamp
+
+      # @!attribute [r] end
+      #   The end time of the event
+      #   @return [String] event end
+      property :end, :timestamp, default: nil
+
+      # @!attribute [r] all_day
+      #   Points if the event is an all day event
+      #   @return [Boolean] is it an all day event
+      property :all_day, :boolean, default: false
+
+      # @!attribute [r] timezone
+      #   Timezone to which the event is fixed to
+      #   @return [String] timezone
+      property :timezone, :string, default: nil
+
+      # @!attribute [r] location
+      #   Location of the event
+      #   @return [Entities::Location] location
+      entity :location, Entities::Location, default: nil
+    end
+  end
+end

data/lib/diaspora_federation/entities/event_participation.rb

@@ -0,0 +1,27 @@
+module DiasporaFederation
+  module Entities
+    # This entity represents a participation in an event, i.e. it is issued when a user responds to en event.
+    #
+    # @see Validators::EventParticipationValidator
+    class EventParticipation < Entity
+      # Old signature order
+      # @deprecated
+      LEGACY_SIGNATURE_ORDER = %i(author guid parent_guid status).freeze
+
+      # The {EventParticipation} parent is an {Event}
+      PARENT_TYPE = "Event".freeze
+
+      include Relayable
+
+      # Redefine the author property without +diaspora_handle+ +xml_name+
+      # @deprecated Can be removed after XMLs are generated with new names
+      property :author, :string
+
+      # @!attribute [r] status
+      #   The participation status of the user
+      #   "accepted", "declined" or "tentative"
+      #   @return [String] event participation status
+      property :status, :string
+    end
+  end
+end

data/lib/diaspora_federation/entities/message.rb

@@ -33,6 +33,11 @@ module DiasporaFederation
         sender == author || (sender == parent_author && verify_author_signature)
       end
 
+      # @deprecated remove after {Message} doesn't include {Relayable} anymore
+      def to_h
+        super.tap {|hash| hash[:created_at] = created_at.utc.iso8601 }
+      end
+
       private
 
       # @deprecated remove after {Message} doesn't include {Relayable} anymore

data/lib/diaspora_federation/entities/status_message.rb

@@ -26,6 +26,11 @@ module DiasporaFederation
       #   @return [Entities::Poll] poll
       entity :poll, Entities::Poll, default: nil
 
+      # @!attribute [r] event
+      #   Optional event attached to the status message
+      #   @return [Entities::Event] event
+      entity :event, Entities::Event, default: nil
+
       # @!attribute [r] public
       #   Shows whether the status message is visible to everyone or only to some aspects
       #   @return [Boolean] is it public

data/lib/diaspora_federation/entity.rb

@@ -73,7 +73,7 @@ module DiasporaFederation
     # Nested entities are also converted to a Hash.
     # @return [Hash] entity data (mostly equal to the hash used for initialization).
     def to_h
-      properties.map {|key, value|
+      enriched_properties.map {|key, value|
         type = self.class.class_props[key]
 
         if type.instance_of?(Symbol) || value.nil?
@@ -135,8 +135,8 @@ module DiasporaFederation
     # @param [String] entity_name "snake_case" class name
     # @return [Class] entity class
     def self.entity_class(entity_name)
-      raise InvalidEntityName, "'#{entity_name}' is invalid" unless entity_name =~ /^[a-z]*(_[a-z]*)*$/
-      class_name = entity_name.sub(/^[a-z]/, &:upcase)
+      raise InvalidEntityName, "'#{entity_name}' is invalid" unless entity_name =~ /\A[a-z]*(_[a-z]*)*\z/
+      class_name = entity_name.sub(/\A[a-z]/, &:upcase)
       class_name.gsub!(/_([a-z])/) { Regexp.last_match[1].upcase }
 
       raise UnknownEntity, "'#{class_name}' not found" unless Entities.const_defined?(class_name)
@@ -275,7 +275,7 @@ module DiasporaFederation
     private_class_method def self.entity_data(root_node)
       class_props.map {|name, type|
         value = parse_element_from_node(name, type, root_node)
-        [name, value] if value
+        [name, value] unless value.nil?
       }.compact.to_h
     end
 
@@ -302,13 +302,13 @@ module DiasporaFederation
     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?
-      parse_property(type, node.first.text) if node.any?
+      parse_string(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)
+    private_class_method def self.parse_string(type, text)
       case type
       when :timestamp
         begin
@@ -317,10 +317,10 @@ module DiasporaFederation
           nil
         end
       when :integer
-        text.to_i if text =~ /^\d+$/
+        text.to_i if text =~ /\A\d+\z/
       when :boolean
-        return true if text =~ /(true|t|yes|y|1)$/i
-        false if text =~ /(false|f|no|n|0)$/i
+        return true if text =~ /\A(true|t|yes|y|1)\z/i
+        false if text =~ /\A(false|f|no|n|0)\z/i
       else
         text
       end

data/lib/diaspora_federation/federation/fetcher.rb

@@ -21,7 +21,7 @@ module DiasporaFederation
       end
 
       private_class_method def self.entity_name(class_name)
-        return class_name if class_name =~ /^[a-z]*(_[a-z]*)*$/
+        return class_name if class_name =~ /\A[a-z]*(_[a-z]*)*\z/
 
         raise DiasporaFederation::Entity::UnknownEntity, class_name unless Entities.const_defined?(class_name)
 

data/lib/diaspora_federation/validators.rb

@@ -44,6 +44,8 @@ require "diaspora_federation/validators/account_deletion_validator"
 require "diaspora_federation/validators/comment_validator"
 require "diaspora_federation/validators/contact_validator"
 require "diaspora_federation/validators/conversation_validator"
+require "diaspora_federation/validators/event_participation_validator"
+require "diaspora_federation/validators/event_validator"
 require "diaspora_federation/validators/h_card_validator"
 require "diaspora_federation/validators/like_validator"
 require "diaspora_federation/validators/location_validator"

data/lib/diaspora_federation/validators/event_participation_validator.rb

@@ -0,0 +1,12 @@
+module DiasporaFederation
+  module Validators
+    # This validates a {Entities::EventParticipation}.
+    class EventParticipationValidator < Validation::Validator
+      include Validation
+
+      include RelayableValidator
+
+      rule :status, regular_expression: {regex: /\A(accepted|declined|tentative)\z/}
+    end
+  end
+end

data/lib/diaspora_federation/validators/event_validator.rb

@@ -0,0 +1,21 @@
+module DiasporaFederation
+  module Validators
+    # This validates a {Entities::Event}.
+    class EventValidator < Validation::Validator
+      include Validation
+
+      rule :author, %i(not_empty diaspora_id)
+
+      rule :guid, :guid
+
+      rule :summary, [:not_empty, length: {maximum: 255}]
+      rule :description, length: {maximum: 65_535}
+
+      rule :start, :not_nil
+
+      rule :all_day, :boolean
+
+      rule :timezone, regular_expression: {regex: %r{\A[A-Za-z_-]{,14}(/[A-Za-z_-]{,14}){1,2}\z}}
+    end
+  end
+end

data/lib/diaspora_federation/version.rb

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

data/lib/tasks/tests.rake

@@ -1,6 +1,6 @@
 if defined?(RSpec)
   namespace :spec do
-    task prepare_db: %w(db:create db:environment:set db:test:load)
+    task prepare_db: %w(db:create db:test:load)
     task :prepare_fixtures do
       ENV["NO_COVERAGE"] = "true"
       Rake::Task["spec:generate_fixtures"].invoke
@@ -8,7 +8,7 @@ if defined?(RSpec)
     end
 
     desc "Prepare for rspec"
-    task prepare: %w(prepare_db prepare_fixtures)
+    task prepare: %w(db:environment:set prepare_db prepare_fixtures)
 
     desc "Run all specs that generate fixtures for rspec"
     RSpec::Core::RakeTask.new(:generate_fixtures) do |t|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diaspora_federation
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Benjamin Neff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-28 00:00:00.000000000 Z
+date: 2017-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -118,6 +118,8 @@ files:
 - lib/diaspora_federation/entities/comment.rb
 - lib/diaspora_federation/entities/contact.rb
 - lib/diaspora_federation/entities/conversation.rb
+- lib/diaspora_federation/entities/event.rb
+- lib/diaspora_federation/entities/event_participation.rb
 - lib/diaspora_federation/entities/like.rb
 - lib/diaspora_federation/entities/location.rb
 - lib/diaspora_federation/entities/message.rb
@@ -163,6 +165,8 @@ files:
 - lib/diaspora_federation/validators/comment_validator.rb
 - lib/diaspora_federation/validators/contact_validator.rb
 - lib/diaspora_federation/validators/conversation_validator.rb
+- lib/diaspora_federation/validators/event_participation_validator.rb
+- lib/diaspora_federation/validators/event_validator.rb
 - lib/diaspora_federation/validators/h_card_validator.rb
 - lib/diaspora_federation/validators/like_validator.rb
 - lib/diaspora_federation/validators/location_validator.rb