plagiarism-checker 3.1.0 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e35843d2ef1d9d926ebcb7a799689e567dc91662cbbbe7a996345f342f9f4694
-  data.tar.gz: b65e0d03a2c7c930a3fd26d11f50e834d6856b42062013e0a2882cc04162fb0f
+  metadata.gz: e947c529be01e971d5887175ba1dcf763a48de09c9ab732759d555c2311b07d5
+  data.tar.gz: ec0ef3fe06953dc9e2e213fd9c26434833c006b6facd49fa94edeec63d88962f
 SHA512:
-  metadata.gz: e977e23ca5fc86194031ce6dcaf4bcf5007a6421f234615875c552fd71556fb2889f11543802a050f2566fdcfe6ce29a6229150adc4ac1d135b2fdf499a320c1
-  data.tar.gz: b0886f96f27a487cccf67886e7bbcb4761134eb700c2811f245b461073b026fdd065a5e45a8ba8265a8a73ccf6d33af8ce23da20f2e2a2376b547db1aae01648
+  metadata.gz: de8559653ead6ea1ea1160f29dd5ba10426a7d4fb16729c170bd32157e78ec8168f1711b93e94a910c52a41b5bf9eba1f95d905a3b762efcb9806f0db7bce3bb
+  data.tar.gz: 20fefac0dd0751da77c1e9568f4ee6458f1caabc3a8b974b3e8918c9940e698107347669a20a518e2f1ee31944f3b6499e5043b3897caf1c2889e679c9817b1c

data/lib/copyleaks/models/exceptions/index.rb

@@ -21,12 +21,11 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #  SOFTWARE.
 # =
-$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
 
-require 'auth_exipred_exception'
-require 'command_exception'
-require 'rate_limit_exception'
-require 'under_maintenance_exception'
+require_relative 'auth_exipred_exception.rb'
+require_relative 'command_exception.rb'
+require_relative 'rate_limit_exception.rb'
+require_relative 'under_maintenance_exception.rb'
 
 module Copyleaks
 end

data/lib/copyleaks/models/exports/export_model.rb

@@ -23,19 +23,24 @@
 # =
 module Copyleaks
   class CopyleaksExportModel
-    attr_reader :completionWebhook, :results, :crawledVersion, :pdfReport, :maxRetries, :developerPayload
+    attr_reader :completionWebhook, :completionWebhookHeaders, :results, :crawledVersion, :pdfReport, :maxRetries, :developerPayload
 
     # @param [String] completionWebhook This webhook event is triggered once the export is completed.
     # @param [ExportResults[]] results An array of results to be exported. The equivalent of downloading results manually.
     # @param [ExportCrawledVersion crawledVersion Download the crawled version of the submitted text. The equivalent of downloading crawled version manually.
-    # @param [ExportPdfReport] pdfReport Download the PDF report. Allowed only when `properties.pdf.create` was set to true on the scan submittion.
+    # @param [ExportPdfReport] pdfReport Download the PDF report. Allowed only when `properties.pdf.create` was set to true on the scan submission.
     # @param [Integer] maxRetries How many retries to send before giving up. Using high value (12) may lead to a longer time until the completionWebhook being executed. A low value (1) may lead to errors while your service is temporary having problems.
     # @param [String] developerPayload Add a custom developer payload that will then be provided on the Export-Completed webhook. https://api.copyleaks.com/documentation/v3/webhooks/export-completed
-    def initialize(completionWebhook, results, crawledVersion, pdfReport = nil, maxRetries = nil, developerPayload = nil)
+    # @param [Array] completionWebhookHeaders Adds headers to the completion webhook.
+    def initialize(completionWebhook, results, crawledVersion, pdfReport = nil, maxRetries = nil, developerPayload = nil, completionWebhookHeaders = nil)
       unless completionWebhook.instance_of?(String)
         raise 'Copyleaks::CopyleaksExportModel - completionWebhook - completionWebhook must be of type String'
       end
 
+      unless header_format_valid?(completionWebhookHeaders)
+        raise 'Copyleaks::CopyleaksExportModel - completionWebhookHeaders - completionWebhookHeaders must be an Array of String Array pairs'
+      end
+
       results.each do |item|
         unless item.instance_of?(ExportResults)
           raise 'Copyleaks::CopyleaksExportModel - results - entity must be of type Copyleaks::ExportResults'
@@ -59,6 +64,7 @@ module Copyleaks
       end
 
       @completionWebhook = completionWebhook
+      @completionWebhookHeaders = completionWebhookHeaders
       @results = results
       @crawledVersion = crawledVersion
       @pdfReport = pdfReport
@@ -69,6 +75,7 @@ module Copyleaks
     def as_json(*_args)
       {
         completionWebhook: @completionWebhook,
+        completionWebhookHeaders: @completionWebhookHeaders,
         results: @results,
         crawledVersion: @crawledVersion,
         pdfReport: @pdfReport,
@@ -80,5 +87,16 @@ module Copyleaks
     def to_json(*options)
       as_json(*options).to_json(*options)
     end
+
+    private
+
+    def header_format_valid?(header)
+      return true if header.nil?
+      return false unless header.instance_of?(Array)
+
+      header.all? do |pair|
+        pair.instance_of?(Array) && pair.length == 2 && pair[0].instance_of?(String) && pair[1].instance_of?(String)
+      end
+    end
   end
 end

data/lib/copyleaks/models/exports/index.rb

@@ -21,12 +21,11 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #  SOFTWARE.
 # =
-$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
 
-require 'export_model'
-require 'export_crawled_version'
-require 'export_pdf_report'
-require 'export_results'
+require_relative 'export_model.rb'
+require_relative 'export_crawled_version.rb'
+require_relative 'export_pdf_report.rb'
+require_relative 'export_results.rb'
 
 module Copyleaks
 end

data/lib/copyleaks/models/index.rb

@@ -21,15 +21,15 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #  SOFTWARE.
 # =
-$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
-require 'exceptions/index'
-require 'exports/index'
-require 'submissions/index'
-require 'auth_token'
 
-require 'id_object'
-require 'delete_request_model'
-require 'start_request_model'
+require_relative 'exceptions/index.rb'
+require_relative 'exports/index.rb'
+require_relative 'submissions/index.rb'
+require_relative 'auth_token.rb'
+
+require_relative 'id_object.rb'
+require_relative 'delete_request_model.rb'
+require_relative 'start_request_model.rb'
 
 module Copyleaks
 end

data/lib/copyleaks/models/submissions/index.rb

@@ -21,13 +21,12 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #  SOFTWARE.
 # =
-$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
-require 'properties/index'
+require_relative 'properties/index.rb'
 
-require 'submission_model'
-require 'file_submission_model'
-require 'file_ocr_submission_model'
-require 'url_submission_model'
+require_relative 'submission_model.rb'
+require_relative 'file_submission_model.rb'
+require_relative 'file_ocr_submission_model.rb'
+require_relative 'url_submission_model.rb'
 
 module Copyleaks
 end

data/lib/copyleaks/models/submissions/properties/index.rb

@@ -21,25 +21,25 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #  SOFTWARE.
 # =
-$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
 
-require 'submission_properties'
+require_relative 'submission_properties.rb'
 
-require 'actions'
-require 'author'
-require 'copyleaks_db'
-require 'domains_mode'
-require 'exclude'
-require 'filter'
-require 'indexing'
-require 'pdf_properties'
-require 'repository'
-require 'scanning'
-require 'scanning_exclude'
-require 'scanning_repository'
-require 'sensitive_data_protection'
-require 'submission_properties'
-require 'webhooks'
+require_relative 'actions.rb'
+require_relative 'author.rb'
+require_relative 'copyleaks_db.rb'
+require_relative 'domains_mode.rb'
+require_relative 'exclude.rb'
+require_relative 'filter.rb'
+require_relative 'scan_method_algorithm.rb'
+require_relative 'indexing.rb'
+require_relative 'pdf_properties.rb'
+require_relative 'repository.rb'
+require_relative 'scanning.rb'
+require_relative 'scanning_exclude.rb'
+require_relative 'scanning_repository.rb'
+require_relative 'sensitive_data_protection.rb'
+require_relative 'submission_properties.rb'
+require_relative 'webhooks.rb'
 
 module Copyleaks
 end

data/lib/copyleaks/models/submissions/properties/scan_method_algorithm.rb

@@ -0,0 +1,31 @@
+#
+#  The MIT License(MIT)
+#
+#  Copyright(c) 2016 Copyleaks LTD (https://copyleaks.com)
+#
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in all
+#  copies or substantial portions of the Software.
+#
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#  SOFTWARE.
+# =
+module Copyleaks
+  class SubmissionScanMethodAlgorithm
+    # prioritize higher similarity
+    MAXIMUM_COVERAGE = 0
+    # prioritize finding more sources.
+    MAXIMUM_RESULTS = 1
+  end
+end

data/lib/copyleaks/models/submissions/properties/scanning_repository.rb

@@ -23,9 +23,9 @@
 # =
 module Copyleaks
   class SubmissionScanningRepository < SubmissionRepository
-    # @param [String] Id of a repository to add the scanned document to.
-    # @param [Boolean] includeMySubmissions Compare the scanned document against MY submittions in the repository.
-    # @param [Boolean] includeOthersSubmissions Compare the scanned document against OTHER users submittions in the repository.
+    # @param [String] ID of a repository to add the scanned document to.
+    # @param [Boolean] includeMySubmissions Compare the scanned document against MY submissions in the repository.
+    # @param [Boolean] includeOthersSubmissions Compare the scanned document against OTHER users submissions in the repository.
     def initialize(id, includeMySubmissions, includeOthersSubmissions)
       super(id)
       @includeMySubmissions = includeMySubmissions

data/lib/copyleaks/models/submissions/properties/submission_properties.rb

@@ -24,7 +24,7 @@
 module Copyleaks
   class SubmissionProperties
     attr_reader :webhooks, :includeHtml, :developerPayload, :sandbox, :expiration, :sensitivityLevel, :cheatDetection,
-                :action, :author, :filters, :scanning, :indexing, :exclude, :pdf, :sensitiveDataProtection
+                :action, :author, :filters, :scanning, :indexing, :exclude, :pdf, :sensitiveDataProtection, :scanMethodAlgorithm
 
     # @param [SubmissionWebhooks] webhooks - Check inner properties for more details.
     # @param [Boolean] includeHtml - By default, Copyleaks will present the report in text format. If set to true, Copyleaks will also include html format.
@@ -41,10 +41,11 @@ module Copyleaks
     # @param [SubmissionExclude] exclude - Check inner properties for more details.
     # @param [SubmissionPDF] pdf - Check inner properties for more details.
     # @param [SubmissionSensitiveData] sensitiveDataProtection - Check inner properties for more details.
+    # @param [SubmissionScanMethodAlgorithm] scanMethodAlgorithm - Check inner properties for more details.
     def initialize(
       webhooks, includeHtml = nil, developerPayload = nil, sandbox = nil, expiration = nil,
       sensitivityLevel = nil, cheatDetection = nil, action = nil, author = nil, filters = nil,
-      scanning = nil, indexing = nil, exclude = nil, pdf = nil, sensitiveDataProtection = nil
+      scanning = nil, indexing = nil, exclude = nil, pdf = nil, sensitiveDataProtection = nil, scanMethodAlgorithm = nil
     )
       unless webhooks.instance_of?(SubmissionWebhooks)
         raise 'Copyleaks::SubmissionProperties - webhooks - webhooks must be of type SubmissionWebhooks'
@@ -91,6 +92,9 @@ module Copyleaks
       if !sensitiveDataProtection.nil? && !sensitiveDataProtection.instance_of?(SubmissionSensitiveData)
         raise 'Copyleaks::SubmissionProperties - sensitiveDataProtection - sensitiveDataProtection must be of type SubmissionSensitiveData'
       end
+      if !scanMethodAlgorithm.nil? && ![0, 1].include?(scanMethodAlgorithm)
+        raise 'Copyleaks::SubmissionProperties - scanMethodAlgorithm - action must be of type SubmissionScanMethodAlgorithm consts'
+      end
 
       @webhooks = webhooks
       @includeHtml = includeHtml
@@ -107,6 +111,7 @@ module Copyleaks
       @exclude = exclude
       @pdf = pdf
       @sensitiveDataProtection = sensitiveDataProtection
+      @scanMethodAlgorithm = scanMethodAlgorithm
     end
 
     def as_json(*_args)
@@ -125,7 +130,8 @@ module Copyleaks
         indexing: @indexing,
         exclude: @exclude,
         pdf: @pdf,
-        sensitiveDataProtection: @sensitiveDataProtection
+        sensitiveDataProtection: @sensitiveDataProtection,
+        scanMethodAlgorithm: @scanMethodAlgorithm
       }.select { |_k, v| !v.nil? }
     end
 

data/lib/copyleaks/models/submissions/properties/webhooks.rb

@@ -25,20 +25,50 @@ module Copyleaks
   class SubmissionWebhooks
     # @param [String] status This webhook event is triggered once the scan status changes. Use the special token {STATUS} to track the current scan status. This special token will automatically be replaced by the Copyleaks servers with the optional values: completed, error, creditsChecked and indexed. Read more about webhooks: https://api.copyleaks.com/documentation/v3/webhooks
     # @param [String] newResult Http endpoint to be triggered while the scan is still running and a new result is found. This is useful when the report is being viewed by the user in real time so the results will load gradually as they are found.
-    def initialize(status, newResult = nil)
+    # @param [Array] statusHeaders Adds headers to the webhook.
+    # @param [Array] newResultHeaders Adds headers to the webhook.
+    def initialize(status, newResult = nil, statusHeaders = nil, newResultHeaders = nil)
+      unless status.instance_of? String
+        raise 'Copyleaks::SubmissionWebhooks - status - status must be of type String'
+      end
+      unless newResult.nil? || newResult.instance_of?(String)
+        raise 'Copyleaks::SubmissionWebhooks - newResult - newResult must be of type String'
+      end
+      unless header_format_valid?(statusHeaders)
+        raise 'Copyleaks::SubmissionWebhooks - statusHeaders - statusHeaders must be an Array of String Array pairs'
+      end
+      unless header_format_valid?(newResultHeaders)
+        raise 'Copyleaks::SubmissionWebhooks - newResultHeaders - newResultHeaders must be an Array of String Array pairs'
+      end
+
       @newResult = newResult
       @status = status
+      @statusHeaders = statusHeaders
+      @newResultHeaders = newResultHeaders
     end
 
     def as_json(*_args)
       {
         newResult: @newResult,
-        status: @status
+        status: @status,
+        statusHeaders: @statusHeaders,
+        newResultHeaders: @newResultHeaders
       }.select { |_k, v| !v.nil? }
     end
 
     def to_json(*options)
       as_json(*options).to_json(*options)
     end
+
+    private
+
+    def header_format_valid?(header)
+      return true if header.nil?
+      return false unless header.instance_of?(Array)
+
+      header.all? do |pair|
+        pair.instance_of?(Array) && pair.length == 2 && pair[0].instance_of?(String) && pair[1].instance_of?(String)
+      end
+    end
   end
 end

data/lib/copyleaks/version.rb

@@ -1,3 +1,3 @@
 module Copyleaks
-  VERSION = '3.1.0'
+  VERSION = '3.1.2'
 end

data/lib/copyleaks.rb

@@ -22,14 +22,11 @@
 #  SOFTWARE.
 # =
 
-$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
-
-require 'copyleaks/version'
-
-require 'copyleaks/models/index'
-require 'copyleaks/utils/status-code.utils'
-require 'copyleaks/app.config'
-require 'copyleaks/api'
+require_relative  './copyleaks/api.rb'
+require_relative  './copyleaks/version.rb'
+require_relative  './copyleaks/app.config.rb'
+require_relative  './copyleaks/models/index.rb'
+require_relative  './copyleaks/utils/status-code.utils.rb'
 
 module Copyleaks
 end

data/lib/index.rb

@@ -22,9 +22,7 @@
 #  SOFTWARE.
 # =
 
-$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
-
-require 'copyleaks'
+require_relative  'copyleaks.rb'
 
 module Copyleaks
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plagiarism-checker
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.2
 platform: ruby
 authors:
 - Copyleaks ltd
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-06-16 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies: []
 description: Copyleaks detects plagiarism and checks content distribution online.
   Use Copyleaks to find out if textual content is original and if it has been used
@@ -16,7 +16,9 @@ description: Copyleaks detects plagiarism and checks content distribution online
   doc, docx, ocr...), URLs and free text for plagiarism check.
 email:
 - sales@copyleaks.com
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -58,6 +60,7 @@ files:
 - lib/copyleaks/models/submissions/properties/indexing.rb
 - lib/copyleaks/models/submissions/properties/pdf_properties.rb
 - lib/copyleaks/models/submissions/properties/repository.rb
+- lib/copyleaks/models/submissions/properties/scan_method_algorithm.rb
 - lib/copyleaks/models/submissions/properties/scanning.rb
 - lib/copyleaks/models/submissions/properties/scanning_exclude.rb
 - lib/copyleaks/models/submissions/properties/scanning_repository.rb
@@ -69,7 +72,6 @@ files:
 - lib/copyleaks/utils/status-code.utils.rb
 - lib/copyleaks/version.rb
 - lib/index.rb
-- plagiarism-checker.gemspec
 homepage: https://api.copyleaks.com
 licenses:
 - MIT

data/plagiarism-checker.gemspec

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'copyleaks/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'plagiarism-checker'
-  spec.version       = Copyleaks::VERSION
-  spec.authors       = ['Copyleaks ltd']
-  spec.email         = ['sales@copyleaks.com']
-
-  spec.summary       = 'Detects plagiarism and checks content distribution online.'
-  spec.description   = 'Copyleaks detects plagiarism and checks content distribution online. Use Copyleaks to find out if textual content is original and if it has been used before. With Copyleaks cloud publishers, academics, and more can scan files (pdf, doc, docx, ocr...), URLs and free text for plagiarism check.'
-  spec.homepage      = 'https://api.copyleaks.com'
-  spec.license       = 'MIT'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/Copyleaks/Ruby-Plagiarism-Checker'
-  spec.metadata['changelog_uri'] = 'https://github.com/Copyleaks/Ruby-Plagiarism-Checker/releases'
-
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:demo|test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-end