diaspora_federation 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0143fd95b478d62bc2fb26b136df5103c0074fce
-  data.tar.gz: 919d5d547e686a4994305c8a42514762072784be
+  metadata.gz: 5dbce3e434737107507881b68c2f8d51a0cf2d78
+  data.tar.gz: 6c974f67b87f2ffa988c1286d17b920ad49fe9ef
 SHA512:
-  metadata.gz: 40f7824b9fa501dee9fe1683ec5ab33ee22e6da144d5a55d278252c4f365893ee9478ff97e9113ada59d9fb722ddb69fa35eaf63abdfc247200de63e05ba4418
-  data.tar.gz: fb88dd79852c1bb5ff77260165bdaca7ae10745205cd1baa2719033b43b7f8cba97ede1136e323e7f9e3c30121d08a32ee6065f71495759549e7c872acf96457
+  metadata.gz: 9ac23b66e6c06e368f7dff5a190222e123a388653c2bb9983a28b80c08a9f6831fb584e86195ac627ad16f1d73fb9f185695d5b5c469efb19be70bddb2681f91
+  data.tar.gz: 248882b3d9a8c71a94894724719f63a04a4398eabb2f13b35fb7559cae0fdf017b0010a1940390ecab70664598fe01cf168efb2ac6f44f404fc6c82360b26c38

data/Changelog.md

@@ -1,3 +1,13 @@
+# 0.2.1
+
+## Features
+
+Add `DiasporaFederation::Schemas` to access the JSON schema [#70](https://github.com/diaspora/diaspora_federation/pull/70)
+
+## Refactor
+
+Don't add optional properties to generated XML and JSON when nil [#71](https://github.com/diaspora/diaspora_federation/pull/71)
+
 # 0.2.0
 
 ## Features

data/lib/diaspora_federation/entities/event.rb

@@ -24,7 +24,7 @@ module DiasporaFederation
       # @!attribute [r] description
       #   Description of the event
       #   @return [String] event description
-      property :description, :string, default: nil
+      property :description, :string, optional: true
 
       # @!attribute [r] start
       #   The start time of the event
@@ -34,22 +34,22 @@ module DiasporaFederation
       # @!attribute [r] end
       #   The end time of the event
       #   @return [String] event end
-      property :end, :timestamp, default: nil
+      property :end, :timestamp, optional: true
 
       # @!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
+      property :all_day, :boolean, optional: true, default: false
 
       # @!attribute [r] timezone
       #   Timezone to which the event is fixed to
       #   @return [String] timezone
-      property :timezone, :string, default: nil
+      property :timezone, :string, optional: true
 
       # @!attribute [r] location
       #   Location of the event
       #   @return [Entities::Location] location
-      entity :location, Entities::Location, default: nil
+      entity :location, Entities::Location, optional: true
     end
   end
 end

data/lib/diaspora_federation/entities/photo.rb

@@ -37,13 +37,13 @@ module DiasporaFederation
 
       # @!attribute [r] text
       #   @return [String] text
-      property :text, :string, default: nil
+      property :text, :string, optional: true
 
       # @!attribute [r] status_message_guid
       #   Guid of a status message this photo belongs to
       #   @see StatusMessage#guid
       #   @return [String] guid
-      property :status_message_guid, :string, default: nil
+      property :status_message_guid, :string, optional: true
 
       # @!attribute [r] height
       #   Photo height

data/lib/diaspora_federation/entities/post.rb

@@ -29,7 +29,7 @@ module DiasporaFederation
           property :author, :string, xml_name: :diaspora_handle
           property :guid, :string
           property :created_at, :timestamp, default: -> { Time.now.utc }
-          property :provider_display_name, :string, default: nil
+          property :provider_display_name, :string, optional: true
         end
       end
     end

data/lib/diaspora_federation/entities/profile.rb

@@ -20,7 +20,7 @@ module DiasporaFederation
       #   @see #full_name
       #   @see Discovery::HCard#first_name
       #   @return [String] first name
-      property :first_name, :string, default: nil
+      property :first_name, :string, optional: true
 
       # @!attribute [r] last_name
       #   @deprecated We decided to only use one name field, these should be removed
@@ -28,38 +28,38 @@ module DiasporaFederation
       #   @see #full_name
       #   @see Discovery::HCard#last_name
       #   @return [String] last name
-      property :last_name, :string, default: nil
+      property :last_name, :string, optional: true
 
       # @!attribute [r] image_url
       #   @see Discovery::HCard#photo_large_url
       #   @return [String] url to the big avatar (300x300)
-      property :image_url, :string, default: nil
+      property :image_url, :string, optional: true
       # @!attribute [r] image_url_medium
       #   @see Discovery::HCard#photo_medium_url
       #   @return [String] url to the medium avatar (100x100)
-      property :image_url_medium, :string, default: nil
+      property :image_url_medium, :string, optional: true
       # @!attribute [r] image_url_small
       #   @see Discovery::HCard#photo_small_url
       #   @return [String] url to the small avatar (50x50)
-      property :image_url_small, :string, default: nil
+      property :image_url_small, :string, optional: true
 
-      property :birthday, :string, default: nil
-      property :gender, :string, default: nil
-      property :bio, :string, default: nil
-      property :location, :string, default: nil
+      property :birthday, :string, optional: true
+      property :gender, :string, optional: true
+      property :bio, :string, optional: true
+      property :location, :string, optional: true
 
       # @!attribute [r] searchable
       #   @see Discovery::HCard#searchable
       #   @return [Boolean] searchable flag
-      property :searchable, :boolean, default: true
+      property :searchable, :boolean, optional: true, default: true
 
       # @!attribute [r] public
       #   Shows whether the profile is visible to everyone or only to contacts
       #   @return [Boolean] is it public
-      property :public, :boolean, default: false
+      property :public, :boolean, optional: true, default: false
 
-      property :nsfw, :boolean, default: false
-      property :tag_string, :string, default: nil
+      property :nsfw, :boolean, optional: true, default: false
+      property :tag_string, :string, optional: true
 
       # @return [String] string representation of this object
       def to_s

data/lib/diaspora_federation/entities/relayable.rb

@@ -100,7 +100,9 @@ module DiasporaFederation
       # The order for signing
       # @return [Array]
       def signature_order
-        @signature_order || self.class.class_props.keys - %i[author_signature parent_author_signature parent]
+        @signature_order || self.class.class_props.keys.reject {|key|
+          self.class.optional_props.include?(key) && public_send(key).nil?
+        } - %i[author_signature parent_author_signature parent]
       end
 
       private

data/lib/diaspora_federation/entities/reshare.rb

@@ -21,7 +21,7 @@ module DiasporaFederation
       # @!attribute [r] public
       #   Has no meaning at the moment
       #   @return [Boolean] public
-      property :public, :boolean, default: true # always true? (we only reshare public posts)
+      property :public, :boolean, optional: true, default: true # always true? (we only reshare public posts)
 
       # @return [String] string representation of this object
       def to_s

data/lib/diaspora_federation/entities/status_message.rb

@@ -14,22 +14,22 @@ module DiasporaFederation
       # @!attribute [r] photos
       #   Optional photos attached to the status message
       #   @return [[Entities::Photo]] photos
-      entity :photos, [Entities::Photo], default: []
+      entity :photos, [Entities::Photo], optional: true, default: []
 
       # @!attribute [r] location
       #   Optional location attached to the status message
       #   @return [Entities::Location] location
-      entity :location, Entities::Location, default: nil
+      entity :location, Entities::Location, optional: true
 
       # @!attribute [r] poll
       #   Optional poll attached to the status message
       #   @return [Entities::Poll] poll
-      entity :poll, Entities::Poll, default: nil
+      entity :poll, Entities::Poll, optional: true
 
       # @!attribute [r] event
       #   Optional event attached to the status message
       #   @return [Entities::Event] event
-      entity :event, Entities::Event, default: nil
+      entity :event, Entities::Event, optional: true
 
       # @!attribute [r] public
       #   Shows whether the status message is visible to everyone or only to some aspects

data/lib/diaspora_federation/entity.rb

@@ -270,6 +270,8 @@ module DiasporaFederation
     end
 
     def normalize_property(name, value)
+      return nil if optional_nil_value?(name, value)
+
       case self.class.class_props[name]
       when :string
         value.to_s
@@ -315,8 +317,9 @@ module DiasporaFederation
     def json_data
       enriched_properties.map {|key, value|
         type = self.class.class_props[key]
+        next if optional_nil_value?(key, value)
 
-        if !value.nil? && type.instance_of?(Class) && value.respond_to?(:to_json)
+        if !value.nil? && type.instance_of?(Class)
           entity_data = value.to_json
           [key, entity_data] unless entity_data.nil?
         elsif type.instance_of?(Array)
@@ -328,6 +331,10 @@ module DiasporaFederation
       }.compact.to_h
     end
 
+    def optional_nil_value?(name, value)
+      value.nil? && self.class.optional_props.include?(name)
+    end
+
     # Raised, if entity is not valid
     class ValidationError < RuntimeError
     end

data/lib/diaspora_federation/properties_dsl.rb

@@ -46,16 +46,20 @@ module DiasporaFederation
     # Return array of missing required property names
     # @return [Array<Symbol>] missing required property names
     def missing_props(args)
-      class_props.keys - default_props.keys - args.keys
+      class_props.keys - default_props.keys - optional_props - args.keys
+    end
+
+    def optional_props
+      @optional_props ||= []
     end
 
     # Return a new hash of default values, with dynamic values
     # resolved on each call
     # @return [Hash] default values
     def default_values
-      default_props.each_with_object({}) {|(name, prop), hash|
-        hash[name] = prop.respond_to?(:call) ? prop.call : prop
-      }
+      optional_props.map {|name| [name, nil] }.to_h.merge(default_props).map {|name, prop|
+        [name, prop.respond_to?(:call) ? prop.call : prop]
+      }.to_h
     end
 
     # @param [Hash] data entity data
@@ -111,6 +115,7 @@ module DiasporaFederation
       raise InvalidName unless name_valid?(name)
 
       class_props[name] = type
+      optional_props << name if opts[:optional]
       default_props[name] = opts[:default] if opts.has_key? :default
       xml_names[name] = determine_xml_name(name, type, opts)
 

data/lib/diaspora_federation/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diaspora_federation
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Benjamin Neff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-02 00:00:00.000000000 Z
+date: 2017-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -59,7 +59,7 @@ dependencies:
         version: 0.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,7 +69,7 @@ dependencies:
         version: 0.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -174,7 +174,6 @@ files:
 - lib/diaspora_federation/salmon/magic_envelope.rb
 - lib/diaspora_federation/salmon/slap.rb
 - lib/diaspora_federation/salmon/xml_payload.rb
-- lib/diaspora_federation/schemas/federation_entities.json
 - lib/diaspora_federation/validators.rb
 - lib/diaspora_federation/validators/account_deletion_validator.rb
 - lib/diaspora_federation/validators/account_migration_validator.rb

data/lib/diaspora_federation/schemas/federation_entities.json

@@ -1,379 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "id": "https://diaspora.github.io/diaspora_federation/schemas/federation_entities.json",
-  "oneOf": [
-    {"$ref": "#/definitions/comment"},
-    {"$ref": "#/definitions/like"},
-    {"$ref": "#/definitions/participation"},
-    {"$ref": "#/definitions/poll_participation"},
-    {"$ref": "#/definitions/status_message"},
-    {"$ref": "#/definitions/reshare"},
-    {"$ref": "#/definitions/profile"},
-    {"$ref": "#/definitions/location"},
-    {"$ref": "#/definitions/photo"},
-    {"$ref": "#/definitions/poll"},
-    {"$ref": "#/definitions/poll_answer"}
-  ],
-
-  "definitions": {
-    "signature": {
-      "oneOf" : [
-        {
-          "type": "string",
-          "minLength": 30
-        },
-        {
-          "type": "string",
-          "maxLength": 0,
-          "description": "Allow empty string when no signature is provided"
-        }
-      ]
-    },
-
-    "guid": {
-      "type": "string",
-      "minLength": 16,
-      "maxLength": 255
-    },
-
-    "relayable": {
-      "type": "object",
-      "description": "please don't use this object unless you're defining a new child relayable schema",
-      "properties": {
-        "entity_data": {
-          "type": "object",
-          "properties": {
-            "author": { "type": "string" },
-            "guid": { "$ref": "#/definitions/guid" },
-            "parent_guid": { "$ref": "#/definitions/guid" },
-            "author_signature": { "$ref": "#/definitions/signature" }
-          },
-          "required": [
-            "author", "guid", "parent_guid"
-          ]
-        },
-        "property_order": {
-          "type": "array",
-          "items": { "type": "string" }
-        }
-      },
-      "required": [
-        "entity_data", "entity_type", "property_order"
-      ]
-    },
-
-    "comment": {
-      "allOf": [
-        {"$ref": "#/definitions/relayable"},
-        {
-          "type": "object",
-          "properties": {
-            "entity_data": {
-              "type": "object",
-              "properties": {
-                "text": { "type": "string" },
-                "created_at": { "type": "string" }
-              },
-              "required": ["text"]
-            },
-            "entity_type": {
-              "type": "string",
-              "pattern": "^comment$"
-            }
-          }
-        }
-      ]
-    },
-
-    "like": {
-      "allOf": [
-        {"$ref": "#/definitions/relayable"},
-        {
-          "type": "object",
-          "properties": {
-            "entity_type": {
-              "type": "string",
-              "pattern": "^like$"
-            },
-            "entity_data": {
-              "type": "object",
-              "properties": {
-                "positive": { "type": "boolean" },
-                "parent_type": { "enum": ["Post", "Comment"] }
-              },
-              "required": ["positive"]
-            }
-          }
-        }
-      ]
-    },
-
-    "participation": {
-      "type": "object",
-      "properties": {
-        "entity_type": {
-          "type": "string",
-          "pattern": "^participation$"
-        },
-        "entity_data": {
-          "type": "object",
-          "properties": {
-            "author": { "type": "string" },
-            "guid": { "$ref": "#/definitions/guid" },
-            "parent_guid": { "$ref": "#/definitions/guid" },
-            "parent_type": {"enum": ["Post"]}
-          }
-        }
-      }
-    },
-
-    "poll_participation": {
-      "allOf": [
-        {"$ref": "#/definitions/relayable"},
-        {
-          "type": "object",
-          "properties": {
-            "entity_type": {
-              "type": "string",
-              "pattern": "^poll_participation$"
-            },
-            "entity_data": {
-              "type": "object",
-              "properties": {
-                "poll_answer_guid": { "$ref": "#/definitions/guid" }
-              },
-              "required": ["poll_answer_guid"]
-            }
-          }
-        }
-      ]
-    },
-
-    "post": {
-      "type": "object",
-      "description": "please don't use this object unless you're defining a new child post schema",
-      "properties": {
-        "entity_data": {
-          "type": "object",
-          "properties": {
-            "guid": { "$ref": "#/definitions/guid" },
-            "public": { "type": "boolean" },
-            "created_at": { "type": "string" },
-            "provider_display_name" : { "type": "string" }
-          },
-          "required": [
-            "guid", "public", "created_at"
-          ]
-        },
-        "required": [
-          "entity_type", "entity_data"
-        ]
-      }
-    },
-
-    "status_message": {
-      "allOf": [
-        {"$ref": "#/definitions/post"},
-        {
-          "type": "object",
-          "properties": {
-            "entity_type": {
-              "type": "string",
-              "pattern": "^status_message$"
-            },
-
-            "entity_data": {
-              "type": "object",
-              "properties": {
-                "text": { "type": "string" },
-
-                "location": {
-                  "oneOf": [
-                    { "$ref": "#/definitions/location" },
-                    { "type": "null" }
-                  ]
-                },
-
-                "poll": {
-                  "oneOf": [
-                    { "$ref": "#/definitions/poll" },
-                    { "type": "null" }
-                  ]
-                },
-
-                "photos": {
-                  "type": ["array", "null"],
-                  "items": { "$ref": "#/definitions/photo" }
-                }
-              },
-
-              "required": ["text"]
-            }
-          }
-        }
-      ]
-    },
-
-    "reshare": {
-      "allOf": [
-        {"$ref": "#/definitions/post"},
-        {
-          "type": "object",
-          "properties": {
-            "entity_type": {
-              "type": "string",
-              "pattern": "^reshare$"
-            },
-
-            "entity_data": {
-              "type": "object",
-              "properties": {
-                "root_author": {"type": "string"},
-                "root_guid": {"$ref": "#/definitions/guid"}
-              },
-
-              "required": ["root_author", "root_guid"]
-            }
-          }
-        }
-      ]
-    },
-
-    "profile": {
-      "type": "object",
-      "properties": {
-        "entity_type": {
-          "type": "string",
-          "pattern": "^profile$"
-        },
-        "entity_data": {
-          "type": "object",
-          "properties": {
-            "first_name": { "type": ["string", "null"] },
-            "last_name": { "type": ["string", "null"] },
-            "gender": { "type": ["string", "null"] },
-            "bio": { "type": ["string", "null"] },
-            "birthday": { "type": ["string", "null"] },
-            "location": { "type": ["string", "null"] },
-            "image_url": { "type": ["string", "null"] },
-            "author": { "type": "string" }
-          },
-          "required": [
-            "author"
-          ]
-        }
-      },
-      "required" :["entity_data", "entity_type"]
-    },
-
-    "photo": {
-      "type": "object",
-      "properties": {
-        "entity_type": {
-          "type": "string",
-          "pattern": "^photo$"
-        },
-        "entity_data": {
-          "type": "object",
-          "properties": {
-            "author": { "type": "string" },
-            "guid": {"$ref": "#/definitions/guid"},
-            "public": {"type": "boolean"},
-            "created_at": {"type": "string"},
-            "remote_photo_path": {"type": "string"},
-            "remote_photo_name": {"type": "string"},
-            "text": {"type": ["null", "string"]},
-            "status_message_guid": {"$ref": "#/definitions/guid"},
-            "width": {"type": "number"},
-            "height": {"type": "number"}
-          },
-          "required": [
-            "author", "guid", "public", "created_at", "remote_photo_path", "remote_photo_name", "width", "height"
-          ]
-        }
-      }
-    },
-
-    "poll_answer": {
-      "type": "object",
-      "properties": {
-        "entity_type": {
-          "type": "string",
-          "pattern": "^poll_answer$"
-        },
-        "entity_data": {
-          "type": "object",
-          "properties": {
-            "guid": { "$ref": "#/definitions/guid" },
-            "answer": { "type": "string" }
-          },
-          "required": [
-            "answer",
-            "guid"
-          ]
-        }
-      }
-    },
-
-    "poll": {
-      "type": "object",
-      "properties": {
-        "entity_type": {
-          "type": "string",
-          "pattern": "^poll$"
-        },
-        "entity_data": {
-          "type": "object",
-          "properties": {
-            "guid": {
-              "$ref": "#/definitions/guid"
-            },
-            "question": {
-              "type": "string"
-            },
-            "poll_answers": {
-              "type": "array",
-              "items": {
-                "$ref": "#/definitions/poll_answer"
-              }
-            }
-          },
-          "required": [
-            "guid",
-            "question",
-            "poll_answers"
-          ]
-        }
-      }
-    },
-
-    "location": {
-      "type": "object",
-      "properties": {
-        "entity_type": {
-          "type": "string",
-          "pattern": "^location$"
-        },
-        "entity_data": {
-          "type": "object",
-          "properties": {
-            "address": {
-              "type": "string"
-            },
-            "lat": {
-              "type": "string"
-            },
-            "lng": {
-              "type": "string"
-            }
-          },
-          "required": [
-            "address",
-            "lat",
-            "lng"
-          ]
-        }
-      }
-    }
-  }
-}