1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
require "singleton"
module OpenGraphReader
# The behavior of this library can be tweaked with some parameters.
# Note that configuration is global, changing it at runtime is not
# thread safe.
#
# @example
# OpenGraphReader.configure do |config|
# config.strict = true
# end
class Configuration
include Singleton
# Strict mode (default: <tt>false</tt>).
#
# In strict mode, if the fetched site defines an unknown type
# or property, {InvalidObjectError} is thrown instead of just ignoring
# those.
#
# @return [Bool]
attr_accessor :strict
# Validate required (default: <tt>true</tt>).
#
# Validate that required properties exist. If this is enabled and
# they do not, {InvalidObjectError} is thrown.
#
# @return [Bool]
attr_accessor :validate_required
# Validate references (default: <tt>true</tt>).
#
# If an object should be a reference to another object,
# validate that it contains an URL. Be careful in turning this off,
# an attacker could place things like <tt>javascript:</tt> links there.
#
# @return [Bool]
attr_accessor :validate_references
# Discard invalid optional properties (default: <tt>false</tt>).
#
# Instead of rendering the entire object invalid, discard
# invalid optional properties.
#
# @return [Bool]
attr_accessor :discard_invalid_optional_properties
# Fallback to the title tag if og:title is missing (default: <tt>false</tt>).
#
# The standard makes defining og:title required, but it's
# a common practice to rely on the parser falling back to
# synthesize it from the title tag. This option enables this feature.
#
# @return [Bool]
attr_accessor :synthesize_title
# Return request URL if og:url is missing (default: <tt>false</tt>).
#
# The standard makes defining og:url required, but it's often missing.
# This enables a fallback that sets the URL to the request URL if none
# was found.
#
# @return [Bool]
attr_accessor :synthesize_url
# Guess object URL when it looks like a path (default: <tt>false</tt>).
#
# The standard requires the url type to point to a full http or https URL.
# However it's common practice to put a path relative
# to the domain URL. When enabled, the library tries to guess the full
# URL from such a path. Note the object can still turn invalid if it fails
# to do so.
#
# @return [Bool]
attr_accessor :synthesize_full_url
# Guess image URL when it looks like a path (default: <tt>false</tt>).
#
# See {#synthesize_full_url}
#
# @return [Bool]
attr_accessor :synthesize_image_url
# Parse non ISO8601 datetimes (default: <tt>false</tt>).
#
# The standard clearly requires ISO8601 as format for
# datetime properties. However other formats are seen in the wild.
# With this setting enabled, the format is guessed.
#
# @return [Bool]
attr_accessor :guess_datetime_format
# @private
def initialize
reset_to_defaults!
end
# Reset configuration to their defaults
def reset_to_defaults!
@strict = false
@validate_required = true
@validate_references = true
@discard_invalid_optional_properties = false
@synthesize_title = false
@synthesize_url = false
@synthesize_full_url = false
@synthesize_image_url = false
@guess_datetime_format = false
end
end
end
|
