plagiarism-checker 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6d4f3bce521d3c812846efd48a7806dbf34d22ba8f7067f70512009bcb5d22b
-  data.tar.gz: 8ab487b30508f22efafdfce4f23135f0f246a7cfaa4913627ab891a6d8e4f642
+  metadata.gz: 78d078009e0a00e806a132c00e4413146152407dac42d7bcc2c639606e11321e
+  data.tar.gz: aed6b1cbe5c60e2731a3e45545cd933ec1a3cad715c2c81bc9340e046107c9a8
 SHA512:
-  metadata.gz: af4659d3ae1c2fe98d28a58198dc8f50943352bd9a6cf316618a25e1715f588f261dbae11af4fbb1935696a2dfd8c193676fe860db2c6cfdbfc65fe7fbe2d198
-  data.tar.gz: eb1ea926eddd84f1d65f8991d9d14e6e582afef63088c2ec7c1b2c32949aa83b7f92e9e3e36e393e3ef472fe73daf1380b90f527800681bc50f0451fc70e3b70
+  metadata.gz: 309584bf74ff895cc0c8cb6cddc99418ab1a751707921cbb4eb5c7d91d56dab50738838f4d910bb7d1f04ef14bd4f4baf3fb04b0bf6544ca40c7ae047e01c0a9
+  data.tar.gz: 9c49e09e073bd7b23e99a55ec781691424d103b6aae7f1e3ab7dc2ba9ef80859a61bdaf0f31b605fcc8f5b7b457434786cd55a24e7f8e598eeacfe3ad832a0ed

data/.vscode/launch.json

@@ -0,0 +1,35 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+      {
+        "name": "Debug Local File",
+        "type": "Ruby",
+        "request": "launch",
+        "program": "${workspaceRoot}/main.rb"
+      },
+        // Launch the debugger for any given program. In this case, it will run the current file using Ruby
+        {
+          "type": "ruby_lsp",
+          "name": "Debug",
+          "request": "launch",
+          "program": "ruby ${file}"
+        },
+        // Launch the debugger for the current test file
+        {
+          "type": "ruby_lsp",
+          "request": "launch",
+          "name": "Debug test file",
+          "program": "ruby -Itest ${relativeFile}"
+        },
+        // Attach the debugger client to an existing Ruby process that has already been launched with the debugger
+        // server
+        {
+          "type": "ruby_lsp",
+          "request": "attach",
+          "name": "Attach to existing server"
+        }
+      ]
+}

data/lib/copyleaks/api.rb

@@ -26,6 +26,7 @@ require 'json'
 require 'date'
 require_relative 'ai_detection_client.rb'
 require_relative 'writing_assistant_client.rb'
+require_relative 'utils/copyleaks_client.utils'
 
 module Copyleaks
   class API
@@ -75,7 +76,7 @@ module Copyleaks
 
     # Verify that Copyleaks authentication token is exists and not exipired.
     # * Exceptions:
-    # * * AuthExipredException: authentication expired. Need to login again.
+    # * * AuthExpiredException: authentication expired. Need to login again.
     # @param [CopyleaksAuthToken] authToken Copyleaks authentication token
     def verify_auth_token(authToken)
       if authToken.nil? || !authToken.instance_of?(CopyleaksAuthToken)
@@ -86,7 +87,7 @@ module Copyleaks
       _expiresTime = DateTime.parse(authToken.expires)
 
       if _expiresTime <= _time
-        raise AuthExipredException.new.reason # expired
+        raise AuthExpiredException # expired
       end
     end
 
@@ -445,25 +446,7 @@ module Copyleaks
 
     # this methods is a helper for hanlding reponse data and exceptions.
     def handle_response(response, used_by)
-      if Utils.is_success_status_code(response.code)
-        if response.body.nil? || response.body == ''
-          nil
-        else
-          JSON.parse(response.body)
-        end
-      elsif Utils.is_under_maintenance_response(response.code)
-        raise UnderMaintenanceException.new.reason
-      elsif Utils.is_rate_limit_response(response.code)
-        raise RateLimitException.new.reason
-      else
-        _err_message = '---------Copyleaks SDK Error (' + used_by + ')---------' + "\n\n"
-        _err_message += 'status code: ' + response.code + "\n\n"
-
-        _err_message += 'response body:' + "\n" + response.body.to_json + "\n\n" unless response.body.nil?
-
-        _err_message += '-------------------------------------'
-        raise CommandException.new(_err_message).reason + "\n"
-      end
+      Copyleaks::ClientUtils.handle_response(response, used_by)
     end
 
     def ai_detection_client

data/lib/copyleaks/models/exceptions/{auth_exipred_exception.rb → auth_expired_exception.rb}

@@ -22,11 +22,9 @@
 #  SOFTWARE.
 # =
 module Copyleaks
-  class AuthExipredException < StandardError
-    attr_reader :reason
-
+  class AuthExpiredException < RuntimeError
     def initialize
-      @reason = 'Authentication Expired. Need to login again'
+      super 'Authentication Expired. Need to login again'
     end
   end
 end

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

@@ -22,11 +22,18 @@
 #  SOFTWARE.
 # =
 module Copyleaks
-  class CommandException < StandardError
-    attr_reader :reason
+  class CommandException < RuntimeError
+    attr_reader :response
 
-    def initialize(reason)
-      @reason = reason
+    def initialize(response:, used_by:)
+      @response = response
+      @used_by = used_by
+
+      message = "---------Copyleaks SDK Error (#{used_by})---------\n\n"
+      message += "status code: #{response.code}\n\n"
+      message += "response body:\n#{response.body.to_json}\n\n" unless response.body.nil?
+      message += "-------------------------------------\n"
+      super message
     end
   end
 end

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

@@ -22,7 +22,7 @@
 #  SOFTWARE.
 # =
 
-require_relative 'auth_exipred_exception.rb'
+require_relative 'auth_expired_exception.rb'
 require_relative 'command_exception.rb'
 require_relative 'rate_limit_exception.rb'
 require_relative 'under_maintenance_exception.rb'

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

@@ -22,11 +22,9 @@
 #  SOFTWARE.
 # =
 module Copyleaks
-  class RateLimitException < StandardError
-    attr_reader :reason
-
+  class RateLimitException < RuntimeError
     def initialize
-      @reason = 'Too many requests. Please wait before calling again.'
+      super 'Too many requests. Please wait before calling again.'
     end
   end
 end

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

@@ -22,11 +22,9 @@
 #  SOFTWARE.
 # =
 module Copyleaks
-  class UnderMaintenanceException < StandardError
-    attr_reader :reason
-
+  class UnderMaintenanceException < RuntimeError
     def initialize
-      @reason = 'Copyleaks is Under Maintenance, please visit https://status.copyleaks.com'
+      super 'Copyleaks is Under Maintenance, please visit https://status.copyleaks.com'
     end
   end
 end

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

@@ -48,6 +48,7 @@ require_relative 'scanning_repository.rb'
 require_relative 'sensitive_data_protection.rb'
 require_relative 'submission_properties.rb'
 require_relative 'webhooks.rb'
+require_relative 'writing_feedback.rb'
 
 
 

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

@@ -25,7 +25,7 @@ module Copyleaks
   class SubmissionProperties
     attr_reader :webhooks, :includeHtml, :developerPayload, :sandbox, :expiration, :sensitivityLevel, :cheatDetection,
                 :action, :author, :filters, :scanning, :indexing, :exclude, :pdf, :sensitiveDataProtection, :scanMethodAlgorithm,
-                :aiGeneratedText, :customMetadata
+                :aiGeneratedText, :customMetadata, :writingFeedback
 
     # @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.
@@ -45,11 +45,12 @@ module Copyleaks
     # @param [SubmissionScanMethodAlgorithm] scanMethodAlgorithm - Check inner properties for more details.
     # @param [SubmissionAiGeneratedText] aiGeneratedText - Check inner properties for more details.
     # @param [SubmissionCustomMetadata] customMetadata - Add custom properties that will be attached to your document in a Copyleaks repository.
+    # @param [SubmissionWritingFeedback] writingFeedback - 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,
-      scanMethodAlgorithm = nil, aiGeneratedText = nil, customMetadata = nil
+      scanMethodAlgorithm = nil, aiGeneratedText = nil, customMetadata = nil, writingFeedback = nil
     )
       unless webhooks.instance_of?(SubmissionWebhooks)
         raise 'Copyleaks::SubmissionProperties - webhooks - webhooks must be of type SubmissionWebhooks'
@@ -105,6 +106,9 @@ module Copyleaks
       if !customMetadata.nil? && !(customMetadata.is_a?(Array) && customMetadata.all? { |element| element.is_a?(SubmissionCustomMetadata) })
         raise 'Copyleaks::SubmissionProperties - customMetadata - customMetadata must be of type SubmissionCustomMetadata[]'
       end
+      if !writingFeedback.nil? && !writingFeedback.instance_of?(SubmissionWritingFeedback)
+        raise 'Copyleaks::SubmissionProperties - writingFeedback - writingFeedback must be of type SubmissionWritingFeedback'
+      end
 
       @webhooks = webhooks
       @includeHtml = includeHtml
@@ -124,6 +128,7 @@ module Copyleaks
       @sensitiveDataProtection = sensitiveDataProtection
       @scanMethodAlgorithm = scanMethodAlgorithm
       @customMetadata = customMetadata
+      @writingFeedback = writingFeedback
     end
 
     def as_json(*_args)
@@ -145,7 +150,8 @@ module Copyleaks
         pdf: @pdf,
         sensitiveDataProtection: @sensitiveDataProtection,
         scanMethodAlgorithm: @scanMethodAlgorithm,
-        customMetadata: @customMetadata
+        customMetadata: @customMetadata,
+        writingFeedback: @writingFeedback
       }.select { |_k, v| !v.nil? }
     end
 

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

@@ -0,0 +1,53 @@
+#
+#  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 SubmissionWritingFeedback
+      attr_accessor :enable, :score
+      # @param [Boolean] Enable automated Writing Assistant . This feature includes grammar checking, spell checking and sentence structure corrections.
+      # @param [ScoreWeights] an object containing the score weights for different writing aspects (e.g., grammar, mechanics). Optional.
+      def initialize(enable = false, score = nil)
+        unless [true, false].include?(enable)
+            raise 'Copyleaks::SubmissionWritingFeedback - enable - enable must be of type Boolean'
+        end
+        unless score.nil? || score.is_a?(ScoreWeights)
+            raise 'Copyleaks::SubmissionWritingFeedback - score - score must be of type ScoreWeights'
+        end
+
+        @enable = enable
+        @score = score
+      end
+  
+      def as_json(*_args)
+        {
+          enable: @enable,
+          score: @score
+        }.reject { |_k, v| v.nil? }
+      end
+  
+      def to_json(*options)
+        as_json(*options).to_json(*options)
+      end
+    end
+  end

data/lib/copyleaks/utils/copyleaks_client.utils.rb

@@ -1,64 +1,56 @@
-#
-#  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 ClientUtils
-    def self.handle_response(response, used_by)
-      if Utils.is_success_status_code(response.code)
-        if response.body.nil? || response.body == ''
-          nil
-        else
-          parsed_response = JSON.parse(response.body)
-          puts "Parsed response: #{parsed_response.inspect}"
-          parsed_response
-        end
-      elsif Utils.is_under_maintenance_response(response.code)
-        raise UnderMaintenanceException.new.reason
-      elsif Utils.is_rate_limit_response(response.code)
-        raise RateLimitException.new.reason
-      else
-        _err_message = '---------Copyleaks SDK Error (' + used_by + ')---------' + "\n\n"
-        _err_message += 'status code: ' + response.code + "\n\n"
-
-        _err_message += 'response body:' + "\n" + response.body.to_json + "\n\n" unless response.body.nil?
-
-        _err_message += '-------------------------------------'
-        raise CommandException.new(_err_message).reason + "\n"
-      end
-    end
-
-    def self.verify_auth_token(authToken)
-      if authToken.nil? || !authToken.instance_of?(CopyleaksAuthToken)
-        raise 'authToken is Invalid, must be instance of CopyleaksAuthToken'
-      end
-
-      _time = DateTime.now
-      _expiresTime = DateTime.parse(authToken.expires)
-
-      if _expiresTime <= _time
-        raise AuthExipredException.new.reason # expired
-      end
-    end
-  end
-end
+#
+#  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 ClientUtils
+    def self.handle_response(response, used_by)
+      if Utils.is_success_status_code(response.code)
+        if response.body.nil? || response.body == ''
+          nil
+        else
+          JSON.parse(response.body)
+        end
+      elsif Utils.is_under_maintenance_response(response.code)
+        raise UnderMaintenanceException
+      elsif Utils.is_rate_limit_response(response.code)
+        raise RateLimitException
+      else
+        raise CommandException.new(response: response, used_by: used_by)
+      end
+    end
+
+    def self.verify_auth_token(authToken)
+      if authToken.nil? || !authToken.instance_of?(CopyleaksAuthToken)
+        raise 'authToken is Invalid, must be instance of CopyleaksAuthToken'
+      end
+
+      _time = DateTime.now
+      _expiresTime = DateTime.parse(authToken.expires)
+
+      if _expiresTime <= _time
+        raise AuthExpiredException # expired
+      end
+    end
+  end
+end

data/lib/copyleaks/version.rb

@@ -1,3 +1,3 @@
 module Copyleaks
-  VERSION = '3.3.0'
+  VERSION = '3.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plagiarism-checker
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Copyleaks ltd
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2025-01-07 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
@@ -23,6 +23,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".vscode/launch.json"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -35,7 +36,7 @@ files:
 - lib/copyleaks/app.config.rb
 - lib/copyleaks/models/auth_token.rb
 - lib/copyleaks/models/delete_request_model.rb
-- lib/copyleaks/models/exceptions/auth_exipred_exception.rb
+- lib/copyleaks/models/exceptions/auth_expired_exception.rb
 - lib/copyleaks/models/exceptions/command_exception.rb
 - lib/copyleaks/models/exceptions/index.rb
 - lib/copyleaks/models/exceptions/rate_limit_exception.rb
@@ -80,6 +81,7 @@ files:
 - lib/copyleaks/models/submissions/properties/sensitive_data_protection.rb
 - lib/copyleaks/models/submissions/properties/submission_properties.rb
 - lib/copyleaks/models/submissions/properties/webhooks.rb
+- lib/copyleaks/models/submissions/properties/writing_feedback.rb
 - lib/copyleaks/models/submissions/submission_model.rb
 - lib/copyleaks/models/submissions/url_submission_model.rb
 - lib/copyleaks/models/submissions/writing_assistant/score_weights.rb
@@ -96,7 +98,7 @@ metadata:
   homepage_uri: https://api.copyleaks.com
   source_code_uri: https://github.com/Copyleaks/Ruby-Plagiarism-Checker
   changelog_uri: https://github.com/Copyleaks/Ruby-Plagiarism-Checker/releases
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -111,8 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: Detects plagiarism and checks content distribution online.
 test_files: []