plagiarism-checker 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daf1bb5b06a87dabf0c3d99f66e95b59f622ae62da8ad1b23c3f86bee1294b28
-  data.tar.gz: edb0ffa236e2dd08e313d1fd0287c06820184932a9856b5bf11beccf8496188e
+  metadata.gz: e947c529be01e971d5887175ba1dcf763a48de09c9ab732759d555c2311b07d5
+  data.tar.gz: ec0ef3fe06953dc9e2e213fd9c26434833c006b6facd49fa94edeec63d88962f
 SHA512:
-  metadata.gz: dad101affa1aede0700fedd94b14206bbde93627d9de8e3070101a9390c198e035729909f3e458c63080f262b8836bcce3bcf98b1202e9bc8cc8a977f69e2e72
-  data.tar.gz: 0e6e41a65a7c5a7caf680d23c4f098bcd02b9f0ebc7478258b3bc11377d31bb9424c9d078827cd8cfb1c099e0a259b058ad7dcc79067abf435659275f22da2ae
+  metadata.gz: de8559653ead6ea1ea1160f29dd5ba10426a7d4fb16729c170bd32157e78ec8168f1711b93e94a910c52a41b5bf9eba1f95d905a3b762efcb9806f0db7bce3bb
+  data.tar.gz: 20fefac0dd0751da77c1e9568f4ee6458f1caabc3a8b974b3e8918c9940e698107347669a20a518e2f1ee31944f3b6499e5043b3897caf1c2889e679c9817b1c

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/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.1'
+  VERSION = '3.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plagiarism-checker
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Copyleaks ltd
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-11-20 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:
@@ -70,8 +72,6 @@ files:
 - lib/copyleaks/utils/status-code.utils.rb
 - lib/copyleaks/version.rb
 - lib/index.rb
-- plagiarism-checker-3.1.0.gem
-- 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