plagiarism-checker 3.2.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 908a27b3245660f5ceccef151bb1093b740ef3b00b8a79dc3a986279948662c1
-  data.tar.gz: 05054b5d76f20515f0dee473897cc28a1b7d1bfa6aaeb910a31c0cda06455566
+  metadata.gz: 78d078009e0a00e806a132c00e4413146152407dac42d7bcc2c639606e11321e
+  data.tar.gz: aed6b1cbe5c60e2731a3e45545cd933ec1a3cad715c2c81bc9340e046107c9a8
 SHA512:
-  metadata.gz: b278c9105d8e44a2d1e189f8c6db691592ebef80def66b2e1f8995b903ecdd6a3682b8c7062fc626512bcb2b67abf54140941e53bb3b56c990a608201b9b57ef
-  data.tar.gz: a7e2d27a67c0e96e43c730a3f66ff235836a66beee3cccfeb43de1f2adca1d3d7c4d13d03f0fafc07113eb2ca535f060f380eb6536ac8c71d9dea632ed19190c
+  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/ai_detection_client.rb

@@ -0,0 +1,98 @@
+#
+#  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 AIDetectionClient
+    def initialize(api_client)
+      @api_client = api_client
+    end
+
+    # Use Copyleaks AI Content Detection to differentiate between human source code and AI written source code.
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # @param [CopyleaksAuthToken] authToken Copyleaks authentication token
+    # @param [String] scanId Attach your own scan Id
+    # @param [SourceCodeSubmissionModel] submission document
+    def submit_source_code(authToken, scanId, submission)
+      raise 'scanId is Invalid, must be instance of String' if scanId.nil? || !scanId.instance_of?(String)
+      if submission.nil? || !submission.instance_of?(Copyleaks::SourceCodeSubmissionModel)
+        raise 'submission is Invalid, must be instance of type Copyleaks::SourceCodeSubmissionModel'
+      end
+
+      ClientUtils.verify_auth_token(authToken)
+
+      path = "/v2/writer-detector/source-code/#{scanId}/check"
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent,
+        'Authorization' => "Bearer #{authToken.accessToken}"
+      }
+
+      request = Net::HTTP::Post.new(path, headers)
+      request.body = submission.to_json
+
+      ClientUtils.handle_response(@api_client.request(request), 'submit_source_code')
+    end
+
+
+    # Use Copyleaks AI Content Detection to differentiate between human texts and AI written texts.
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # @param [CopyleaksAuthToken] authToken Copyleaks authentication token
+    # @param [String] scanId Attach your own scan Id
+    # @param [SourceCodeSubmissionModel] submission document
+    def submit_natural_language(authToken, scanId, submission)
+      raise 'scanId is Invalid, must be instance of String' if scanId.nil? || !scanId.instance_of?(String)
+      if submission.nil? || !submission.instance_of?(Copyleaks::NaturalLanguageSubmissionModel)
+        raise 'submission is Invalid, must be instance of type Copyleaks::NaturalLanguageSubmissionModel'
+      end
+
+      ClientUtils.verify_auth_token(authToken)
+
+      path = "/v2/writer-detector/#{scanId}/check"
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent,
+        'Authorization' => "Bearer #{authToken.accessToken}"
+      }
+
+      request = Net::HTTP::Post.new(path, headers)
+      request.body = submission.to_json
+
+      res = ClientUtils.handle_response(@api_client.request(request), 'submit_natural_language')
+      puts "RES: #{res}"
+      res
+    end
+  end
+end

data/lib/copyleaks/api.rb

@@ -24,6 +24,9 @@
 require 'net/http'
 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
@@ -36,6 +39,10 @@ module Copyleaks
       _api_server_uri = URI.parse(Config.api_server_uri)
       @api_client = Net::HTTP.new(_api_server_uri.host, _api_server_uri.port)
       @api_client.use_ssl = true
+
+      # Initialize clients
+      @ai_detection_client = AIDetectionClient.new(@api_client)
+      @writing_assistant_client = WritingAssistantClient.new(@api_client)
     end
 
     # Login to Copyleaks authentication server.
@@ -69,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)
@@ -80,7 +87,7 @@ module Copyleaks
       _expiresTime = DateTime.parse(authToken.expires)
 
       if _expiresTime <= _time
-        raise AuthExipredException.new.reason # expired
+        raise AuthExpiredException # expired
       end
     end
 
@@ -439,25 +446,15 @@ 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
+      @ai_detection_client
+    end
+
+    def writing_assistant_client
+      @writing_assistant_client
     end
   end
 end

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/ai_detection/ai_detection_submission_model.rb

@@ -0,0 +1,50 @@
+#
+#  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 AIDetectionSubmissionModel
+    attr_accessor :text, :sandbox
+
+    # @param [String] A text string.
+    # @param [Boolean] Use sandbox mode to test your integration with the Copyleaks API for free.
+    def initialize(text, sandbox = false)
+      unless text.instance_of?(String)
+        raise 'Copyleaks::AIDetectionSubmissionModel - text - text must be of type String'
+      end
+      @text = text
+      @sandbox = sandbox
+    end
+
+    def as_json(*_args)
+      {
+        'text' => @text,
+        'sandbox' => @sandbox
+      }.reject { |_, v| v.nil? }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/submissions/ai_detection/natural_language_submission_model.rb

@@ -0,0 +1,52 @@
+#
+#  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 NaturalLanguageSubmissionModel < AIDetectionSubmissionModel
+    attr_accessor :language
+
+    # @param [String] A text string.
+    # @param [String] The language code of your content. The selected language should be on the Supported Languages list above. If the 'language' field is not supplied , our system will automatically detect the language of the content.
+    # @param [Boolean] Use sandbox mode to test your integration with the Copyleaks API for free.
+    def initialize(text, language = nil, sandbox = false)
+      unless text.instance_of?(String)
+        raise 'Copyleaks::NaturalLanguageSubmissionModel - text - text must be of type String'
+      end
+      super(text, sandbox)
+      @language = language
+    end
+
+    def as_json(*_args)
+      {
+        text: @text,
+        sandbox: @sandbox,
+        language: @language
+      }.select { |_k, v| !v.nil? }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/submissions/ai_detection/source_code_submission_model.rb

@@ -0,0 +1,55 @@
+#
+#  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 SourceCodeSubmissionModel < AIDetectionSubmissionModel
+    attr_accessor :filename
+
+    # @param [String] A text string.
+    # @param [String] The name of the file. Make sure to include the right extension for your file type.
+    # @param [Boolean] Use sandbox mode to test your integration with the Copyleaks API for free.
+    def initialize(text, filename, sandbox = false)
+      unless text.instance_of?(String)
+        raise 'Copyleaks::SourceCodeSubmissionModel - text - text must be of type String'
+      end
+      unless filename.instance_of?(String)
+        raise 'Copyleaks::SourceCodeSubmissionModel - filename - filename must be of type String'
+      end
+      super(text, sandbox)
+      @filename = filename
+    end
+
+    def as_json(*_args)
+      {
+        text: @text,
+        sandbox: @sandbox,
+        filename: @filename
+      }.select { |_k, v| !v.nil? }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end

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

@@ -28,5 +28,12 @@ require_relative 'file_submission_model.rb'
 require_relative 'file_ocr_submission_model.rb'
 require_relative 'url_submission_model.rb'
 
+require_relative 'ai_detection/ai_detection_submission_model.rb'
+require_relative 'ai_detection/natural_language_submission_model.rb'
+require_relative 'ai_detection/source_code_submission_model.rb'
+
+require_relative 'writing_assistant/score_weights.rb'
+require_relative 'writing_assistant/writing_assistant_submission_model.rb'
+
 module Copyleaks
 end

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

@@ -30,6 +30,7 @@ module Copyleaks
     # @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.
     def initialize(
       identicalEnabled = true,
       minorChangesEnabled = false,
@@ -37,7 +38,8 @@ module Copyleaks
       minCopiedWords = nil,
       safeSearch = false,
       domains = [],
-      domainsMode = SubmissionFilterDomainsMode::EXCLUDE
+      domainsMode = SubmissionFilterDomainsMode::EXCLUDE,
+      allowSameDomain = false
     )
       @identicalEnabled = identicalEnabled
       @minorChangesEnabled = minorChangesEnabled
@@ -46,6 +48,7 @@ module Copyleaks
       @safeSearch = safeSearch
       @domains = domains
       @domainsMode = domainsMode
+      @allowSameDomain = allowSameDomain
     end
 
     def as_json(*_args)
@@ -56,7 +59,8 @@ module Copyleaks
         minCopiedWords: @minCopiedWords,
         safeSearch: @safeSearch,
         domains: @domains,
-        domainsMode: @domainsMode
+        domainsMode: @domainsMode,
+        allowSameDomain: @allowSameDomain
       }.select { |_k, v| !v.nil? }
     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/models/submissions/writing_assistant/score_weights.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 ScoreWeights
+    # @param [Float] Grammar correction category weight in the overall score. 0.0 >= weight <= 1.0
+    # @param [Float] Mechanics correction category weight in the overall score. 0.0 >= weight <= 1.0
+    # @param [Float] Sentence structure correction category weight in the overall score. 0.0 >= weight <= 1.0
+    # @param [Float] Word choice correction category weight in the overall score. 0.0 >= weight <= 1.0
+
+    attr_accessor :grammar_score_weight, :mechanics_score_weight, :sentence_structure_score_weight, :word_choice_score_weight
+
+    def initialize(grammar_score_weight, mechanics_score_weight, sentence_structure_score_weight, word_choice_score_weight)
+      @grammar_score_weight = grammar_score_weight
+      @mechanics_score_weight = mechanics_score_weight
+      @sentence_structure_score_weight = sentence_structure_score_weight
+      @word_choice_score_weight = word_choice_score_weight
+    end
+
+    def as_json(*_args)
+      {
+        grammarScoreWeight: @grammar_score_weight,
+        mechanicsScoreWeight: @mechanics_score_weight,
+        sentenceStructureScoreWeight: @sentence_structure_score_weight,
+        wordChoiceScoreWeight: @word_choice_score_weight
+      }.reject { |_k, v| v.nil? }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/submissions/writing_assistant/writing_assistant_submission_model.rb

@@ -0,0 +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 WritingAssistantSubmissionModel
+    attr_accessor :text, :sandbox, :language, :score
+
+    # @param [String] Text to produce Writing Assistant report for. 1 >= characters <= 25000
+    # @param [Boolean] Use sandbox mode to test your integration with the Copyleaks API without consuming any credits.
+    # @param [String] language The language code of your content. Optional; if not provided, the system will attempt to auto-detect the language.
+    # @param [ScoreWeights] an object containing the score weights for different writing aspects (e.g., grammar, mechanics). Optional.
+    def initialize(text, sandbox = false, language = nil, score = nil)
+      unless text.instance_of?(String)
+        raise 'Copyleaks::SourceCodeSubmissionModel - text - text must be of type String'
+      end
+      @text = text
+      @sandbox = sandbox
+      @language = language
+      @score = score
+    end
+
+    def as_json(*_args)
+      {
+        text: @text,
+        sandbox: @sandbox,
+        language: @language,
+        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

@@ -0,0 +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
+          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.2.1'
+  VERSION = '3.4.0'
 end

data/lib/copyleaks/writing_assistant_client.rb

@@ -0,0 +1,81 @@
+#
+#  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 WritingAssistantClient
+    def initialize(api_client)
+      @api_client = api_client
+    end
+
+    # Get a list of correction types supported within the Writing Assistant API. Correction types apply to all supported languages. The supplied language code for this request is used to determine the language of the texts returned.
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # @param [languageCode] The language for the returned texts to be in. Language codes are in ISO 639-1 standard. Supported Values: en - English
+    def get_correction_types(language_code)
+      path = "/v1/writing-feedback/correction-types/#{language_code}"
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent
+      }
+
+      request = Net::HTTP::Get.new(path, headers)
+      ClientUtils.handle_response(@api_client.request(request), 'get_correction_types')
+    end
+
+    # Use Copyleaks Writing Assistant to generate grammar, spelling and sentence corrections for a given text.
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # @param [CopyleaksAuthToken] authToken Copyleaks authentication token
+    # @param [String] scanId Attach your own scan Id
+    # @param [SourceCodeSubmissionModel] submission document
+    def submit_text(authToken, scanId, submission)
+      raise 'scanId is Invalid, must be instance of String' if scanId.nil? || !scanId.instance_of?(String)
+      raise 'submission is invalid, must be an instance of WritingAssistantSubmissionModel' if submission.nil? || !submission.instance_of?(Copyleaks::WritingAssistantSubmissionModel)
+
+      ClientUtils.verify_auth_token(authToken)
+
+      path = "/v1/writing-feedback/#{scanId}/check"
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent,
+        'Authorization' => "Bearer #{authToken.accessToken}"
+      }
+
+      request = Net::HTTP::Post.new(path, headers)
+      request.body = submission.to_json
+
+      ClientUtils.handle_response(@api_client.request(request), 'submit_writing_assistant')
+    end
+  end
+end

data/lib/copyleaks.rb

@@ -27,6 +27,7 @@ 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'
+require_relative  './copyleaks/utils/copyleaks_client.utils.rb'
 
 module Copyleaks
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plagiarism-checker
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.4.0
 platform: ruby
 authors:
 - Copyleaks ltd
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-08 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
@@ -30,11 +31,12 @@ files:
 - bin/console
 - bin/setup
 - lib/copyleaks.rb
+- lib/copyleaks/ai_detection_client.rb
 - lib/copyleaks/api.rb
 - 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
@@ -47,6 +49,9 @@ files:
 - lib/copyleaks/models/id_object.rb
 - lib/copyleaks/models/index.rb
 - lib/copyleaks/models/start_request_model.rb
+- lib/copyleaks/models/submissions/ai_detection/ai_detection_submission_model.rb
+- lib/copyleaks/models/submissions/ai_detection/natural_language_submission_model.rb
+- lib/copyleaks/models/submissions/ai_detection/source_code_submission_model.rb
 - lib/copyleaks/models/submissions/file_ocr_submission_model.rb
 - lib/copyleaks/models/submissions/file_submission_model.rb
 - lib/copyleaks/models/submissions/index.rb
@@ -76,10 +81,15 @@ 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
+- lib/copyleaks/models/submissions/writing_assistant/writing_assistant_submission_model.rb
+- lib/copyleaks/utils/copyleaks_client.utils.rb
 - lib/copyleaks/utils/status-code.utils.rb
 - lib/copyleaks/version.rb
+- lib/copyleaks/writing_assistant_client.rb
 - lib/index.rb
 homepage: https://api.copyleaks.com
 licenses:
@@ -88,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
@@ -103,8 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: Detects plagiarism and checks content distribution online.
 test_files: []