plagiarism-checker 2.1.2 → 3.0.0

data/lib/copyleaks/app.config.rb

@@ -0,0 +1,47 @@
+#
+#  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 Config
+    @@identity_server_uri = 'https://id.copyleaks.com'
+    @@api_server_uri = 'https://api.copyleaks.com'
+    @@user_agent = 'ruby-sdk/3.0'
+
+    def initialize(identity_server_uri, api_server_uri)
+      @@identity_server_uri = identity_server_uri
+      @@api_server_uri = api_server_uri
+    end
+
+    def self.identity_server_uri
+      @@identity_server_uri
+    end
+
+    def self.api_server_uri
+      @@api_server_uri
+    end
+
+    def self.user_agent
+      @@user_agent
+    end
+  end
+end

data/lib/copyleaks/models/auth_token.rb

@@ -0,0 +1,54 @@
+#
+#  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 CopyleaksAuthToken
+    attr_reader :expires, :accessToken, :issued
+
+    def initialize(expires, accessToken, issued)
+      unless expires.instance_of?(String)
+        raise 'Copyleaks::CopyleaksAuthToken - expires - expires must be of type String'
+      end
+      unless accessToken.instance_of?(String)
+        raise 'Copyleaks::CopyleaksAuthToken - accessToken - accessToken must be of type String'
+      end
+      raise 'Copyleaks::CopyleaksAuthToken - issued - issued must be of type String' unless issued.instance_of?(String)
+
+      @expires = expires
+      @accessToken = accessToken
+      @issued = issued
+    end
+
+    def as_json(*_args)
+      {
+        expires: @expires,
+        issued: @issued,
+        accessToken: @accessToken
+      }.select { |_k, v| !v.nil? }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/delete_request_model.rb

@@ -0,0 +1,64 @@
+#
+#  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.
+# =
+require 'json'
+module Copyleaks
+  class CopyleaksDeleteRequestModel
+    attr_reader :scans, :purge, :completionWebhook
+
+    # @param [Array] scans The list of scans to delete
+    # @param [Boolean] purge Delete all trace of the scan from Copyleaks server, including from internal database. A purged process will not be available as a result for previous scans.
+    # @param [String] completionWebhook Allows you to register to a webhook that will be fired once the removal has been completed. Make sure that your endpoint is listening to a POST method (no body parameters were supplied).
+    def initialize(scans, purge = false, completionWebhook = '')
+      scans.each do |object_id|
+        unless object_id.instance_of?(IdObject)
+          raise 'Copyleaks::CopyleaksDeleteRequestModel - scans - entity must be of type Copyleaks::IdObject'
+        end
+      end
+
+      unless [true, false].include? purge
+        raise 'Copyleaks::CopyleaksDeleteRequestModel - purge - purge must be of type Boolean'
+      end
+
+      unless completionWebhook.instance_of?(String)
+        raise 'Copyleaks::CopyleaksDeleteRequestModel - completionWebhook - completionWebhook must be of type String'
+      end
+
+      @scans = scans
+      @purge = purge
+      @completionWebhook = completionWebhook
+    end
+
+    def as_json(*_args)
+      {
+        scans: @scans.map { |object_id| object_id.as_json },
+        purge: @purge,
+        completionWebhook: @completionWebhook
+      }.select { |_k, v| !v.nil? }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+#
+#  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 AuthExipredException < StandardError
+    attr_reader :reason
+
+    def initialize
+      @reason = 'Authentication Expired. Need to login again'
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+#
+#  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 CommandException < StandardError
+    attr_reader :reason
+
+    def initialize(reason)
+      @reason = reason
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+#
+#  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.
+# =
+$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
+
+require 'auth_exipred_exception'
+require 'command_exception'
+require 'rate_limit_exception'
+require 'under_maintenance_exception'
+
+module Copyleaks
+end

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

@@ -0,0 +1,32 @@
+#
+#  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 RateLimitException < StandardError
+    attr_reader :reason
+
+    def initialize
+      @reason = 'Too many requests. Please wait before calling again.'
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+#
+#  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 UnderMaintenanceException < StandardError
+    attr_reader :reason
+
+    def initialize
+      @reason = 'Copyleaks is Under Maintenance, please visit https://status.copyleaks.com'
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+#
+#  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 ExportCrawledVersion
+    attr_reader :endpoint, :verb, :headers
+
+    # @param [String] endpoint The HTTP url to upload the data.
+    # @param [String] verb The HTTP verb (also called "HTTP Methods") to upload the data to your specified endpoint.
+    # @param [string[][]] headers List of headers to be submitted with the upload request. You may use this field to provide additional request headers, such as "Authorization" header. Example: [["header-key1", "header-value1"], ["header-key2", "header-value2"]]
+    def initialize(endpoint, verb, headers = nil)
+      unless endpoint.instance_of?(String)
+        raise 'Copyleaks::ExportCrawledVersion - endpoint - endpoint must be of type String'
+      end
+      raise 'Copyleaks::ExportCrawledVersion - verb - verb must be of type String' unless verb.instance_of?(String)
+
+      @endpoint = endpoint
+      @verb = verb
+      @headers = headers
+    end
+
+    def as_json(*_args)
+      {
+        endpoint: @endpoint,
+        verb: @verb,
+        headers: @headers
+      }.select { |_k, v| !v.nil? }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+#
+#  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 CopyleaksExportModel
+    attr_reader :completionWebhook, :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 [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)
+      unless completionWebhook.instance_of?(String)
+        raise 'Copyleaks::CopyleaksExportModel - completionWebhook - completionWebhook must be of type String'
+      end
+
+      results.each do |item|
+        unless item.instance_of?(ExportResults)
+          raise 'Copyleaks::CopyleaksExportModel - results - entity must be of type Copyleaks::ExportResults'
+        end
+      end
+
+      unless crawledVersion.instance_of?(ExportCrawledVersion)
+        raise 'Copyleaks::CopyleaksExportModel - crawledVersion - crawledVersion must be of type Copyleaks::ExportCrawledVersion'
+      end
+
+      if !pdfReport.nil? && pdfReport.instance_of?(ExportPdfReport)
+        raise 'Copyleaks::CopyleaksExportModel - pdfReport - pdfReport must be of type Copyleaks::ExportPdfReport'
+      end
+
+      if !maxRetries.nil? && maxRetries.instance_of?(Integer)
+        raise 'Copyleaks::CopyleaksExportModel - maxRetries - maxRetries must be of type Integer'
+      end
+
+      if !developerPayload.nil? && developerPayload.instance_of?(String)
+        raise 'Copyleaks::CopyleaksExportModel - developerPayload - developerPayload must be of type String'
+      end
+
+      @completionWebhook = completionWebhook
+      @results = results
+      @crawledVersion = crawledVersion
+      @pdfReport = pdfReport
+      @maxRetries = maxRetries
+      @developerPayload = developerPayload
+    end
+
+    def as_json(*_args)
+      {
+        completionWebhook: @completionWebhook,
+        results: @results,
+        crawledVersion: @crawledVersion,
+        pdfReport: @pdfReport,
+        maxRetries: @maxRetries,
+        developerPayload: @developerPayload
+      }.select { |_k, v| !v.nil? }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end