nocebo/diaspora_federation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove old property-name mappings and cleanup xml_name functionality

Browse source 
Closes #29
This commit is contained in:
Benjamin Neff 2019-10-30 04:17:57 +01:00
parent edfcc7886d
commit 1238fe0384
No known key found for this signature in database
GPG key ID: 971464C3F1A90194
24 changed files with 37 additions and 148 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
lib/diaspora_federation/entities/account_deletion.rb
View file

@ -14,7 +14,7 @@ module DiasporaFederation
# Alias for author
# @see AccountDeletion#author
# @return [String] diaspora* ID
property :author, :string, alias: :diaspora_id, xml_name: :diaspora_handle
property :author, :string, alias: :diaspora_id
# @return [String] string representation of this object
def to_s

4
lib/diaspora_federation/entities/conversation.rb
View file

@ -10,7 +10,7 @@ module DiasporaFederation
# The diaspora* ID of the person initiated the conversation
# @see Person#author
# @return [String] diaspora* ID
property :author, :string, xml_name: :diaspora_handle
property :author, :string
# @!attribute [r] guid
# A random string of at least 16 chars
@ -29,7 +29,7 @@ module DiasporaFederation
# @!attribute [r] participants
# The diaspora* IDs of the persons participating the conversation separated by ";"
# @return [String] participants diaspora* IDs
property :participants, :string, xml_name: :participant_handles
property :participants, :string
# @!attribute [r] messages
# @return [[Entities::Message]] Messages of this conversation

2
lib/diaspora_federation/entities/like.rb
View file

@ -13,7 +13,7 @@ module DiasporaFederation
# Can be "Post" or "Comment" (Comments are currently not implemented in the
# diaspora* frontend).
# @return [String] parent type
property :parent_type, :string, xml_name: :target_type
property :parent_type, :string
# @!attribute [r] positive
# If +true+ set a like, if +false+, set a dislike (dislikes are currently not

2
lib/diaspora_federation/entities/message.rb
View file

@ -10,7 +10,7 @@ module DiasporaFederation
# The diaspora* ID of the author
# @see Person#author
# @return [String] diaspora* ID
property :author, :string, xml_name: :diaspora_handle
property :author, :string
# @!attribute [r] guid
# A random string of at least 16 chars

4
lib/diaspora_federation/entities/participation.rb
View file

@ -10,7 +10,7 @@ module DiasporaFederation
# The diaspora* ID of the author
# @see Person#author
# @return [String] diaspora* ID
property :author, :string, xml_name: :diaspora_handle
property :author, :string
# @!attribute [r] guid
# A random string of at least 16 chars
@ -27,7 +27,7 @@ module DiasporaFederation
# A string describing a type of the target to subscribe on
# Currently only "Post" is supported.
# @return [String] parent type
property :parent_type, :string, xml_name: :target_type
property :parent_type, :string
# @return [String] string representation of this object
def to_s

2
lib/diaspora_federation/entities/person.rb
View file

@ -21,7 +21,7 @@ module DiasporaFederation
# alias for author
# @see Person#author
# @return [String] diaspora* ID
property :author, :string, alias: :diaspora_id, xml_name: :diaspora_handle
property :author, :string, alias: :diaspora_id
# @!attribute [r] url
# @see Discovery::WebFinger#seed_url

2
lib/diaspora_federation/entities/photo.rb
View file

@ -16,7 +16,7 @@ module DiasporaFederation
# The diaspora* ID of the person who uploaded the photo
# @see Person#author
# @return [String] author diaspora* ID
property :author, :string, xml_name: :diaspora_handle
property :author, :string
# @!attribute [r] public
# Points if the photo is visible to everyone or only to some aspects

2
lib/diaspora_federation/entities/post.rb
View file

@ -32,7 +32,7 @@ module DiasporaFederation
# @param [Entity] entity the entity in which it is included
def self.included(entity)
entity.class_eval do
property :author, :string, xml_name: :diaspora_handle
property :author, :string
property :guid, :string
property :created_at, :timestamp, default: -> { Time.now.utc }
property :public, :boolean, default: false

2
lib/diaspora_federation/entities/profile.rb
View file

@ -14,7 +14,7 @@ module DiasporaFederation
# Alias for author
# @see Profile#author
# @return [String] diaspora* ID
property :author, :string, alias: :diaspora_id, xml_name: :diaspora_handle
property :author, :string, alias: :diaspora_id
# @!attribute [r] edited_at
# The timestamp when the profile was edited

2
lib/diaspora_federation/entities/relayable.rb
View file

@ -48,7 +48,7 @@ module DiasporaFederation
# @param [Entity] klass the entity in which it is included
def self.included(klass)
klass.class_eval do
property :author, :string, xml_name: :diaspora_handle
property :author, :string
property :guid, :string
property :parent_guid, :string
property :author_signature, :string, default: nil

4
lib/diaspora_federation/entities/reshare.rb
View file

@ -10,7 +10,7 @@ module DiasporaFederation
# The diaspora* ID of the person who reshares the post
# @see Person#author
# @return [String] diaspora* ID
property :author, :string, xml_name: :diaspora_handle
property :author, :string
# @!attribute [r] guid
# A random string of at least 16 chars
@ -27,7 +27,7 @@ module DiasporaFederation
# The diaspora* ID of the person who posted the original post
# @see Person#author
# @return [String] diaspora* ID
property :root_author, :string, optional: true, xml_name: :root_diaspora_id
property :root_author, :string, optional: true
# @!attribute [r] root_guid
# Guid of the original post

6
lib/diaspora_federation/entities/retraction.rb
View file

@ -10,17 +10,17 @@ module DiasporaFederation
# The diaspora* ID of the person who deletes the entity
# @see Person#author
# @return [String] diaspora* ID
property :author, :string, xml_name: :diaspora_handle
property :author, :string
# @!attribute [r] target_guid
# Guid of the entity to be deleted
# @return [String] target guid
property :target_guid, :string, xml_name: :post_guid
property :target_guid, :string
# @!attribute [r] target_type
# A string describing the type of the target
# @return [String] target type
property :target_type, :string, xml_name: :type
property :target_type, :string
# @!attribute [r] target
# Target entity

2
lib/diaspora_federation/entities/status_message.rb
View file

@ -11,7 +11,7 @@ module DiasporaFederation
# @!attribute [r] text
# Text of the status message composed by the user
# @return [String] text of the status message
property :text, :string, xml_name: :raw_message
property :text, :string
# @!attribute [r] edited_at
# The timestamp when the status message was edited

1
lib/diaspora_federation/entity.rb
View file

@ -17,7 +17,6 @@ module DiasporaFederation
# property :prop
# property :optional, default: false
# property :dynamic_default, default: -> { Time.now }
# property :another_prop, xml_name: :another_name
# entity :nested, NestedEntity
# entity :multiple, [OtherEntity]
# end

2
lib/diaspora_federation/parsers/json_parser.rb
View file

@ -18,7 +18,7 @@ module DiasporaFederation
def parse_entity_data(entity_data)
hash = entity_data.map {|key, value|
property = entity_type.find_property_for_xml_name(key)
property = entity_type.class_props.keys.find {|name| name.to_s == key }
if property
type = entity_type.class_props[property]
[property, parse_element_from_value(type, entity_data[key])]

21
lib/diaspora_federation/parsers/xml_parser.rb
View file

@ -15,14 +15,12 @@ module DiasporaFederation
from_xml_sanity_validation(root_node)
hash = root_node.element_children.map {|child|
xml_name = child.name
property = entity_type.find_property_for_xml_name(xml_name)
property, type = find_property_for(child.name)
if property
type = class_properties[property]
value = parse_element_from_node(xml_name, type, root_node)
value = parse_element_from_node(child.name, type, root_node)
[property, value]
else
[xml_name, child.text]
[child.name, child.text]
end
}.to_h
@ -31,6 +29,18 @@ module DiasporaFederation
private
def find_property_for(xml_name)
class_properties.find {|name, type|
if type.instance_of?(Symbol)
name.to_s == xml_name
elsif type.instance_of?(Array)
type.first.entity_name == xml_name
elsif type.ancestors.include?(Entity)
type.entity_name == xml_name
end
}
end
# @param [String] name property name to parse
# @param [Class, Symbol] type target type to parse
# @param [Nokogiri::XML::Element] root_node XML node to parse
@ -53,7 +63,6 @@ module DiasporaFederation
# @return [String] data
def 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_string(type, node.first.text) if node.any?
end

37
lib/diaspora_federation/properties_dsl.rb
View file

@ -8,7 +8,6 @@ module DiasporaFederation
# property :prop
# property :optional, default: false
# property :dynamic_default, default: -> { Time.now }
# property :another_prop, xml_name: :another_name
# property :original_prop, alias: :alias_prop
# entity :nested, NestedEntity
# entity :multiple, [OtherEntity]
@ -24,7 +23,6 @@ module DiasporaFederation
# @param [Hash] opts further options
# @option opts [Object, #call] :default a default value, making the
# property optional
# @option opts [Symbol] :xml_name another name used for xml generation
def property(name, type, opts={})
raise InvalidType unless property_type_valid?(type)
@ -79,49 +77,14 @@ module DiasporaFederation
}.to_h
end
# @return [Symbol] alias for the xml-generation/parsing
# @deprecated
def xml_names
@xml_names ||= {}
end
# Finds a property by +xml_name+ or +name+
# @param [String] xml_name name of the property from the received xml
# @return [Hash] the property data
def find_property_for_xml_name(xml_name)
class_props.keys.find {|name| [name.to_s, xml_names[name].to_s].include?(xml_name) }
end
private
# @deprecated
def determine_xml_name(name, type, opts={})
if !type.instance_of?(Symbol) && opts.has_key?(:xml_name)
raise ArgumentError, "xml_name is not supported for nested entities"
end
if type.instance_of?(Symbol)
if opts.has_key? :xml_name
raise InvalidName, "invalid xml_name" unless name_valid?(opts[:xml_name])
opts[:xml_name]
else
name
end
elsif type.instance_of?(Array)
type.first.entity_name.to_sym
elsif type.ancestors.include?(Entity)
type.entity_name.to_sym
end
end
def define_property(name, type, opts={})
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)
instance_eval { attr_reader name }

5
spec/entities.rb
View file

@ -28,11 +28,6 @@ module DiasporaFederation
entity :multi, [OtherEntity]
end
class TestEntityWithXmlName < DiasporaFederation::Entity
property :test, :string
property :qwer, :string, xml_name: :asdf
end
class TestEntityWithRelatedEntity < DiasporaFederation::Entity
property :test, :string
entity :parent, RelatedEntity

2
spec/lib/diaspora_federation/entities/conversation_spec.rb
View file

@ -54,7 +54,7 @@ module DiasporaFederation
<guid>#{parent.guid}</guid>
<subject>#{data[:subject]}</subject>
<created_at>#{data[:created_at]}</created_at>
<participant_handles>#{data[:participants]}</participant_handles>
<participants>#{data[:participants]}</participants>
</conversation>
XML

2
spec/lib/diaspora_federation/entities/like_spec.rb
View file

@ -75,7 +75,7 @@ module DiasporaFederation
it "raises a ValidationError if the parent_guid is missing" do
broken_xml = <<~XML
<like>
<target_type>#{parent.entity_type}</target_type>
<parent_type>#{parent.entity_type}</parent_type>
</like>
XML

2
spec/lib/diaspora_federation/entities/relayable_spec.rb
View file

@ -310,7 +310,7 @@ module DiasporaFederation
let(:new_signature_data) { "#{author};#{guid};#{parent_guid};#{new_property};#{property}" }
let(:new_xml) { <<~XML }
<some_relayable>
<diaspora_handle>#{author}</diaspora_handle>
<author>#{author}</author>
<guid>#{guid}</guid>
<parent_guid>#{parent_guid}</parent_guid>
<new_property>#{new_property}</new_property>

9
spec/lib/diaspora_federation/entity_spec.rb
View file

@ -528,14 +528,5 @@ module DiasporaFederation
expect(entity.multi).to be_empty
end
end
context "xml_name" do
let(:hash) { {test: "test", qwer: "qwer"} }
it "should not use the xml_name for the #to_h" do
entity = Entities::TestEntityWithXmlName.new(hash)
expect(entity.to_h).to eq(hash)
end
end
end
end

28
spec/lib/diaspora_federation/parsers/xml_parser_spec.rb
View file

@ -33,34 +33,6 @@ module DiasporaFederation
end
end
it "uses xml_name for parsing" do
xml = <<~XML.strip
<test_entity_with_xml_name>
<test>asdf</test>
<asdf>qwer</asdf>
</test_entity_with_xml_name>
XML
parsed = Parsers::XmlParser.new(Entities::TestEntityWithXmlName).parse(Nokogiri::XML(xml).root)
expect(parsed[0][:test]).to eq("asdf")
expect(parsed[0][:qwer]).to eq("qwer")
end
it "allows name for parsing even when property has a xml_name" do
xml = <<~XML.strip
<test_entity_with_xml_name>
<test>asdf</test>
<qwer>qwer</qwer>
</test_entity_with_xml_name>
XML
parsed = Parsers::XmlParser.new(Entities::TestEntityWithXmlName).parse(Nokogiri::XML(xml).root)
expect(parsed[0][:test]).to eq("asdf")
expect(parsed[0][:qwer]).to eq("qwer")
end
it "parses the string to the correct type" do
xml = <<~XML.strip
<test_default_entity>

40
spec/lib/diaspora_federation/properties_dsl_spec.rb
View file

@ -10,7 +10,6 @@ module DiasporaFederation
properties = dsl.class_props
expect(properties).to have(1).item
expect(properties[:test]).to eq(:string)
expect(dsl.xml_names[:test]).to eq(:test)
end
it "will not accept other types for names" do
@ -46,22 +45,6 @@ module DiasporaFederation
expect(properties.keys).to include(:test, :asdf, :zzzz)
properties.each_value {|type| expect(type).to eq(:string) }
end
it "can add an xml name to simple properties with a symbol" do
dsl.property :test, :string, xml_name: :xml_test
properties = dsl.class_props
expect(properties).to have(1).item
expect(properties[:test]).to eq(:string)
expect(dsl.xml_names[:test]).to eq(:xml_test)
end
it "will not accept other types for xml names" do
["test", 1234, true, {}].each do |val|
expect {
dsl.property :test, :string, xml_name: val
}.to raise_error PropertiesDSL::InvalidName, "invalid xml_name"
end
end
end
context "nested entities" do
@ -99,12 +82,6 @@ module DiasporaFederation
}.to raise_error PropertiesDSL::InvalidType
end
end
it "can not add an xml name to a nested entity" do
expect {
dsl.entity :other, Entities::TestEntity, xml_name: :other_name
}.to raise_error ArgumentError, "xml_name is not supported for nested entities"
end
end
describe ".optional_props" do
@ -174,22 +151,5 @@ module DiasporaFederation
expect(data).not_to have_key(:test_alias)
end
end
describe ".find_property_for_xml_name" do
it "finds property by xml_name" do
dsl.property :test, :string, xml_name: :xml_test
expect(dsl.find_property_for_xml_name("xml_test")).to eq(:test)
end
it "finds property by name" do
dsl.property :test, :string, xml_name: :xml_test
expect(dsl.find_property_for_xml_name("test")).to eq(:test)
end
it "returns nil if property is not defined" do
dsl.property :test, :string, xml_name: :xml_test
expect(dsl.find_property_for_xml_name("unknown")).to be_nil
end
end
end
end