class Copyleaks::SubmissionFilter

Public Class Methods

new( identicalEnabled = true, minorChangesEnabled = false, relatedMeaningEnabled = false, minCopiedWords = nil, safeSearch = false, domains = [], domainsMode = SubmissionFilterDomainsMode::EXCLUDE, allowSameDomain = false ) click to toggle source

@param [Boolean] identicalEnabled Enable matching of exact words in the text. @param [Boolean] minorChangesEnabled Enable matching of nearly identical words with small differences like slow becomes slowly. @param [Boolean] relatedMeaningEnabled Enable matching of paraphrased content stating similar ideas with different words. @param [Integer] minCopiedWords Select results with at least minCopiedWords copied words. @param [Boolean] safeSearch Block explicit adult content from the scan results such as web pages containing inappropriate images and videos. SafeSearch is not 100% effective with all websites. @param [String domains list of domains to either include or exclude from the scan - depending on the value of domainsMode. @param [SubmissionFilterDomainsMode] domainsMode Include or Exclude the list of domains you specified under the domains property @param [Boolean] allowSameDomain when set to true it will allow results from the same domain as the submitted url.

# File lib/copyleaks/models/submissions/properties/filter.rb, line 34
def initialize(
  identicalEnabled = true,
  minorChangesEnabled = false,
  relatedMeaningEnabled = false,
  minCopiedWords = nil,
  safeSearch = false,
  domains = [],
  domainsMode = SubmissionFilterDomainsMode::EXCLUDE,
  allowSameDomain = false
)
  @identicalEnabled = identicalEnabled
  @minorChangesEnabled = minorChangesEnabled
  @relatedMeaningEnabled = relatedMeaningEnabled
  @minCopiedWords = minCopiedWords
  @safeSearch = safeSearch
  @domains = domains
  @domainsMode = domainsMode
  @allowSameDomain = allowSameDomain
end

Public Instance Methods

as_json(*_args) click to toggle source
# File lib/copyleaks/models/submissions/properties/filter.rb, line 54
def as_json(*_args)
  {
    identicalEnabled: @identicalEnabled,
    minorChangesEnabled: @minorChangesEnabled,
    relatedMeaningEnabled: @relatedMeaningEnabled,
    minCopiedWords: @minCopiedWords,
    safeSearch: @safeSearch,
    domains: @domains,
    domainsMode: @domainsMode,
    allowSameDomain: @allowSameDomain
  }.select { |_k, v| !v.nil? }
end
to_json(*options) click to toggle source
# File lib/copyleaks/models/submissions/properties/filter.rb, line 67
def to_json(*options)
  as_json(*options).to_json(*options)
end