Class: Mbrao::Author

Inherits:
Object
  • Object
show all
Defined in:
lib/mbrao/author.rb

Overview

Represents the author of a parsed content, with its metadata.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Author) initialize(name, email = nil, website = nil, image = nil, metadata = nil)

Creates a new author.

Parameters:

  • name (String) —

    The name of the author.

  • email (String) (defaults to: nil) —

    The email of the author.

  • website (String) (defaults to: nil) —

    The website of the author.

  • image (String) (defaults to: nil) —

    The URL of the avatar of the author.

  • metadata (HashWithIndifferentAccess) (defaults to: nil) —

    The full list of metadata of this author.



37
38
39
40
41
42
43
 
# File 'lib/mbrao/author.rb', line 37

def initialize(name, email = nil, website = nil, image = nil, metadata = nil)
  @name = name.ensure_string
  @email = Mbrao::Parser.email?(email) ? email : nil
  @website = Mbrao::Parser.url?(website) ? website : nil
  @image = Mbrao::Parser.url?(image) ? image : nil
  @metadata = metadata.ensure_hash(accesses: :indifferent)
end

Instance Attribute Details

- (String) email

Returns The email of the author.

Returns:

  • (String) —

    The email of the author.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/mbrao/author.rb', line 22

class Author
  attr_accessor :uid
  attr_accessor :name
  attr_accessor :email
  attr_accessor :website
  attr_accessor :image
  attr_accessor :metadata

  # Creates a new author.
  #
  # @param name [String] The name of the author.
  # @param email [String] The email of the author.
  # @param website [String] The website of the author.
  # @param image [String] The URL of the avatar of the author.
  # @param metadata [HashWithIndifferentAccess] The full list of metadata of this author.
  def initialize(name, email = nil, website = nil, image = nil, metadata = nil)
    @name = name.ensure_string
    @email = Mbrao::Parser.email?(email) ? email : nil
    @website = Mbrao::Parser.url?(website) ? website : nil
    @image = Mbrao::Parser.url?(image) ? image : nil
    @metadata = metadata.ensure_hash(accesses: :indifferent)
  end

  # Returns the author as an Hash.
  #
  # @param options [Hash] Options to modify behavior of the serialization.
  #   The only supported value are:
  #
  #   * `:exclude`, an array of attributes to skip.
  #   * `:exclude_empty`, if to exclude nil values. Default is `false`.
  # @return [Hash] An hash with all attributes.
  def as_json(options = {})
    keys = [:uid, :name, :email, :website, :image, :metadata]
    ::Mbrao::Parser.as_json(self, keys, options)
  end

  # Creates an author from a `Hash`.
  #
  # @param data [Hash] The data of the author
  # @return [Author] A new author.
  def self.create(data)
    if data.is_a?(Hash)
      data = HashWithIndifferentAccess.new(data)
      uid = data.delete(:uid)
      metadata = data.delete(:metadata) || {}
      author = Mbrao::Author.new(data.delete(:name), data.delete(:email), data.delete(:website), data.delete(:image), metadata.merge(data))
      author.uid = uid
      author
    else
      Mbrao::Author.new(data)
    end
  end
end

- (String) image

Returns The URL of the avatar of the author.

Returns:

  • (String) —

    The URL of the avatar of the author.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/mbrao/author.rb', line 22

class Author
  attr_accessor :uid
  attr_accessor :name
  attr_accessor :email
  attr_accessor :website
  attr_accessor :image
  attr_accessor :metadata

  # Creates a new author.
  #
  # @param name [String] The name of the author.
  # @param email [String] The email of the author.
  # @param website [String] The website of the author.
  # @param image [String] The URL of the avatar of the author.
  # @param metadata [HashWithIndifferentAccess] The full list of metadata of this author.
  def initialize(name, email = nil, website = nil, image = nil, metadata = nil)
    @name = name.ensure_string
    @email = Mbrao::Parser.email?(email) ? email : nil
    @website = Mbrao::Parser.url?(website) ? website : nil
    @image = Mbrao::Parser.url?(image) ? image : nil
    @metadata = metadata.ensure_hash(accesses: :indifferent)
  end

  # Returns the author as an Hash.
  #
  # @param options [Hash] Options to modify behavior of the serialization.
  #   The only supported value are:
  #
  #   * `:exclude`, an array of attributes to skip.
  #   * `:exclude_empty`, if to exclude nil values. Default is `false`.
  # @return [Hash] An hash with all attributes.
  def as_json(options = {})
    keys = [:uid, :name, :email, :website, :image, :metadata]
    ::Mbrao::Parser.as_json(self, keys, options)
  end

  # Creates an author from a `Hash`.
  #
  # @param data [Hash] The data of the author
  # @return [Author] A new author.
  def self.create(data)
    if data.is_a?(Hash)
      data = HashWithIndifferentAccess.new(data)
      uid = data.delete(:uid)
      metadata = data.delete(:metadata) || {}
      author = Mbrao::Author.new(data.delete(:name), data.delete(:email), data.delete(:website), data.delete(:image), metadata.merge(data))
      author.uid = uid
      author
    else
      Mbrao::Author.new(data)
    end
  end
end

- (HashWithIndifferentAccess) metadata

Returns The full list of metadata of this author.

Returns:

  • (HashWithIndifferentAccess) —

    The full list of metadata of this author.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/mbrao/author.rb', line 22

class Author
  attr_accessor :uid
  attr_accessor :name
  attr_accessor :email
  attr_accessor :website
  attr_accessor :image
  attr_accessor :metadata

  # Creates a new author.
  #
  # @param name [String] The name of the author.
  # @param email [String] The email of the author.
  # @param website [String] The website of the author.
  # @param image [String] The URL of the avatar of the author.
  # @param metadata [HashWithIndifferentAccess] The full list of metadata of this author.
  def initialize(name, email = nil, website = nil, image = nil, metadata = nil)
    @name = name.ensure_string
    @email = Mbrao::Parser.email?(email) ? email : nil
    @website = Mbrao::Parser.url?(website) ? website : nil
    @image = Mbrao::Parser.url?(image) ? image : nil
    @metadata = metadata.ensure_hash(accesses: :indifferent)
  end

  # Returns the author as an Hash.
  #
  # @param options [Hash] Options to modify behavior of the serialization.
  #   The only supported value are:
  #
  #   * `:exclude`, an array of attributes to skip.
  #   * `:exclude_empty`, if to exclude nil values. Default is `false`.
  # @return [Hash] An hash with all attributes.
  def as_json(options = {})
    keys = [:uid, :name, :email, :website, :image, :metadata]
    ::Mbrao::Parser.as_json(self, keys, options)
  end

  # Creates an author from a `Hash`.
  #
  # @param data [Hash] The data of the author
  # @return [Author] A new author.
  def self.create(data)
    if data.is_a?(Hash)
      data = HashWithIndifferentAccess.new(data)
      uid = data.delete(:uid)
      metadata = data.delete(:metadata) || {}
      author = Mbrao::Author.new(data.delete(:name), data.delete(:email), data.delete(:website), data.delete(:image), metadata.merge(data))
      author.uid = uid
      author
    else
      Mbrao::Author.new(data)
    end
  end
end

- (String) name

Returns The name of the author.

Returns:

  • (String) —

    The name of the author.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/mbrao/author.rb', line 22

class Author
  attr_accessor :uid
  attr_accessor :name
  attr_accessor :email
  attr_accessor :website
  attr_accessor :image
  attr_accessor :metadata

  # Creates a new author.
  #
  # @param name [String] The name of the author.
  # @param email [String] The email of the author.
  # @param website [String] The website of the author.
  # @param image [String] The URL of the avatar of the author.
  # @param metadata [HashWithIndifferentAccess] The full list of metadata of this author.
  def initialize(name, email = nil, website = nil, image = nil, metadata = nil)
    @name = name.ensure_string
    @email = Mbrao::Parser.email?(email) ? email : nil
    @website = Mbrao::Parser.url?(website) ? website : nil
    @image = Mbrao::Parser.url?(image) ? image : nil
    @metadata = metadata.ensure_hash(accesses: :indifferent)
  end

  # Returns the author as an Hash.
  #
  # @param options [Hash] Options to modify behavior of the serialization.
  #   The only supported value are:
  #
  #   * `:exclude`, an array of attributes to skip.
  #   * `:exclude_empty`, if to exclude nil values. Default is `false`.
  # @return [Hash] An hash with all attributes.
  def as_json(options = {})
    keys = [:uid, :name, :email, :website, :image, :metadata]
    ::Mbrao::Parser.as_json(self, keys, options)
  end

  # Creates an author from a `Hash`.
  #
  # @param data [Hash] The data of the author
  # @return [Author] A new author.
  def self.create(data)
    if data.is_a?(Hash)
      data = HashWithIndifferentAccess.new(data)
      uid = data.delete(:uid)
      metadata = data.delete(:metadata) || {}
      author = Mbrao::Author.new(data.delete(:name), data.delete(:email), data.delete(:website), data.delete(:image), metadata.merge(data))
      author.uid = uid
      author
    else
      Mbrao::Author.new(data)
    end
  end
end

- (String) uid

Returns A unique ID for this post. This is only for client uses.

Returns:

  • (String) —

    A unique ID for this post. This is only for client uses.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/mbrao/author.rb', line 22

class Author
  attr_accessor :uid
  attr_accessor :name
  attr_accessor :email
  attr_accessor :website
  attr_accessor :image
  attr_accessor :metadata

  # Creates a new author.
  #
  # @param name [String] The name of the author.
  # @param email [String] The email of the author.
  # @param website [String] The website of the author.
  # @param image [String] The URL of the avatar of the author.
  # @param metadata [HashWithIndifferentAccess] The full list of metadata of this author.
  def initialize(name, email = nil, website = nil, image = nil, metadata = nil)
    @name = name.ensure_string
    @email = Mbrao::Parser.email?(email) ? email : nil
    @website = Mbrao::Parser.url?(website) ? website : nil
    @image = Mbrao::Parser.url?(image) ? image : nil
    @metadata = metadata.ensure_hash(accesses: :indifferent)
  end

  # Returns the author as an Hash.
  #
  # @param options [Hash] Options to modify behavior of the serialization.
  #   The only supported value are:
  #
  #   * `:exclude`, an array of attributes to skip.
  #   * `:exclude_empty`, if to exclude nil values. Default is `false`.
  # @return [Hash] An hash with all attributes.
  def as_json(options = {})
    keys = [:uid, :name, :email, :website, :image, :metadata]
    ::Mbrao::Parser.as_json(self, keys, options)
  end

  # Creates an author from a `Hash`.
  #
  # @param data [Hash] The data of the author
  # @return [Author] A new author.
  def self.create(data)
    if data.is_a?(Hash)
      data = HashWithIndifferentAccess.new(data)
      uid = data.delete(:uid)
      metadata = data.delete(:metadata) || {}
      author = Mbrao::Author.new(data.delete(:name), data.delete(:email), data.delete(:website), data.delete(:image), metadata.merge(data))
      author.uid = uid
      author
    else
      Mbrao::Author.new(data)
    end
  end
end

- (String) website

Returns The website of the author.

Returns:

  • (String) —

    The website of the author.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/mbrao/author.rb', line 22

class Author
  attr_accessor :uid
  attr_accessor :name
  attr_accessor :email
  attr_accessor :website
  attr_accessor :image
  attr_accessor :metadata

  # Creates a new author.
  #
  # @param name [String] The name of the author.
  # @param email [String] The email of the author.
  # @param website [String] The website of the author.
  # @param image [String] The URL of the avatar of the author.
  # @param metadata [HashWithIndifferentAccess] The full list of metadata of this author.
  def initialize(name, email = nil, website = nil, image = nil, metadata = nil)
    @name = name.ensure_string
    @email = Mbrao::Parser.email?(email) ? email : nil
    @website = Mbrao::Parser.url?(website) ? website : nil
    @image = Mbrao::Parser.url?(image) ? image : nil
    @metadata = metadata.ensure_hash(accesses: :indifferent)
  end

  # Returns the author as an Hash.
  #
  # @param options [Hash] Options to modify behavior of the serialization.
  #   The only supported value are:
  #
  #   * `:exclude`, an array of attributes to skip.
  #   * `:exclude_empty`, if to exclude nil values. Default is `false`.
  # @return [Hash] An hash with all attributes.
  def as_json(options = {})
    keys = [:uid, :name, :email, :website, :image, :metadata]
    ::Mbrao::Parser.as_json(self, keys, options)
  end

  # Creates an author from a `Hash`.
  #
  # @param data [Hash] The data of the author
  # @return [Author] A new author.
  def self.create(data)
    if data.is_a?(Hash)
      data = HashWithIndifferentAccess.new(data)
      uid = data.delete(:uid)
      metadata = data.delete(:metadata) || {}
      author = Mbrao::Author.new(data.delete(:name), data.delete(:email), data.delete(:website), data.delete(:image), metadata.merge(data))
      author.uid = uid
      author
    else
      Mbrao::Author.new(data)
    end
  end
end

Class Method Details

+ (Author) create(data)

Creates an author from a Hash.

Parameters:

  • data (Hash) —

    The data of the author

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/mbrao/author.rb', line 62

def self.create(data)
  if data.is_a?(Hash)
    data = HashWithIndifferentAccess.new(data)
    uid = data.delete(:uid)
    metadata = data.delete(:metadata) || {}
    author = Mbrao::Author.new(data.delete(:name), data.delete(:email), data.delete(:website), data.delete(:image), metadata.merge(data))
    author.uid = uid
    author
  else
    Mbrao::Author.new(data)
  end
end

Instance Method Details

- (Hash) as_json(options = {})

Returns the author as an Hash.

Parameters:

  • options (Hash) (defaults to: {}) —

    Options to modify behavior of the serialization. The only supported value are:

    • :exclude, an array of attributes to skip.
    • :exclude_empty, if to exclude nil values. Default is false.

Returns:

  • (Hash) —

    An hash with all attributes.



53
54
55
56
 
# File 'lib/mbrao/author.rb', line 53

def as_json(options = {})
  keys = [:uid, :name, :email, :website, :image, :metadata]
  ::Mbrao::Parser.as_json(self, keys, options)
end