Class: Copyleaks::Metadata

Inherits:
Object
  • Object
show all
Defined in:
lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Metadata.rb

Direct Known Subclasses

RepositoryMetadata

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(finalUrl: nil, canonicalUrl: nil, publishDate: nil, creationDate: nil, lastModificationDate: nil, author: nil, organization: nil, filename: nil) ⇒ Metadata

Returns a new instance of Metadata.

Parameters:

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

    • The final URL of the document.

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

    • The canonical URL if available.

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

    • The date the content was published.

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

    • The date the content was created.

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

    • The last time the content was modified.

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

    • The author of the content.

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

    • The organization associated with the content.

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

    • The original filename of the content.



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
 
# File 'lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Metadata.rb', line 34

def initialize(finalUrl: nil, canonicalUrl: nil, publishDate: nil, creationDate: nil,
               lastModificationDate: nil, author: nil, organization: nil, filename: nil)

  if !finalUrl.nil? && !finalUrl.is_a?(String)
    raise 'Copyleaks::Metadata - finalUrl must be a String'
  end
  if !canonicalUrl.nil? && !canonicalUrl.is_a?(String)
    raise 'Copyleaks::Metadata - canonicalUrl must be a String'
  end
  if !publishDate.nil? && !publishDate.is_a?(String)
    raise 'Copyleaks::Metadata - publishDate must be a String'
  end
  if !creationDate.nil? && !creationDate.is_a?(String)
    raise 'Copyleaks::Metadata - creationDate must be a String'
  end
  if !lastModificationDate.nil? && !lastModificationDate.is_a?(String)
    raise 'Copyleaks::Metadata - lastModificationDate must be a String'
  end
  if !author.nil? && !author.is_a?(String)
    raise 'Copyleaks::Metadata - author must be a String'
  end
  if !organization.nil? && !organization.is_a?(String)
    raise 'Copyleaks::Metadata - organization must be a String'
  end
  if !filename.nil? && !filename.is_a?(String)
    raise 'Copyleaks::Metadata - filename must be a String'
  end

  @finalUrl = finalUrl
  @canonicalUrl = canonicalUrl
  @publishDate = publishDate
  @creationDate = creationDate
  @lastModificationDate = lastModificationDate
  @author = author
  @organization = organization
  @filename = filename
end

Instance Attribute Details

#author ⇒ Object (readonly)

Returns the value of attribute author.



23
24
25
 
# File 'lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Metadata.rb', line 23

def author
  @author
end

#canonicalUrl ⇒ Object (readonly)

Returns the value of attribute canonicalUrl.



23
24
25
 
# File 'lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Metadata.rb', line 23

def canonicalUrl
  @canonicalUrl
end

#creationDate ⇒ Object (readonly)

Returns the value of attribute creationDate.



23
24
25
 
# File 'lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Metadata.rb', line 23

def creationDate
  @creationDate
end

#filename ⇒ Object (readonly)

Returns the value of attribute filename.



23
24
25
 
# File 'lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Metadata.rb', line 23

def filename
  @filename
end

#finalUrl ⇒ Object (readonly)

Returns the value of attribute finalUrl.



23
24
25
 
# File 'lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Metadata.rb', line 23

def finalUrl
  @finalUrl
end

#lastModificationDate ⇒ Object (readonly)

Returns the value of attribute lastModificationDate.



23
24
25
 
# File 'lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Metadata.rb', line 23

def lastModificationDate
  @lastModificationDate
end

#organization ⇒ Object (readonly)

Returns the value of attribute organization.



23
24
25
 
# File 'lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Metadata.rb', line 23

def organization
  @organization
end

#publishDate ⇒ Object (readonly)

Returns the value of attribute publishDate.



23
24
25
 
# File 'lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Metadata.rb', line 23

def publishDate
  @publishDate
end

Instance Method Details

#as_json(*_args) ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Metadata.rb', line 72

def as_json(*_args)
  {
    finalUrl: @finalUrl,
    canonicalUrl: @canonicalUrl,
    publishDate: @publishDate,
    creationDate: @creationDate,
    lastModificationDate: @lastModificationDate,
    author: @author,
    organization: @organization,
    filename: @filename
  }.select { |_k, v| !v.nil? }
end

#to_json(*options) ⇒ Object 



85
86
87
 
# File 'lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Metadata.rb', line 85

def to_json(*options)
  as_json(*options).to_json(*options)
end