plagiarism-checker 3.3.0 → 3.5.0

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.5.0'
 end

data/lib/copyleaks/writing_assistant_client.rb

@@ -1,81 +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
+#
+#  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plagiarism-checker
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Copyleaks ltd
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2025-07-01 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
@@ -35,7 +35,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,8 +80,36 @@ 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/webhooks/CompletedWebhook.rb
+- lib/copyleaks/models/submissions/webhooks/CreditsCheckedWebhook.rb
+- lib/copyleaks/models/submissions/webhooks/ErrorWebhook.rb
+- lib/copyleaks/models/submissions/webhooks/ExportCompletedWebhook.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Metadata.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/StatusWebhook.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/Webhook.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/CompletedModels/Notifications.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/CompletedModels/Results.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/CompletedModels/ScannedDocument.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/ErrorModels/Error.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/ExportModels/Task.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/NewResultsModels/NewResultScore.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/NewResultsModels/NewResultsInternet.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/NewResultsModels/NewResultsRepositories.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/NotificationsModels/Alerts.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/ResultsModels/Batch.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/ResultsModels/Database.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/ResultsModels/Internet.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/ResultsModels/Repositories.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/ResultsModels/RepositoryMetadata.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/ResultsModels/Score.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/ResultsModels/SharedResultsModel.rb
+- lib/copyleaks/models/submissions/webhooks/HelperModels/ResultsModels/Tags.rb
+- lib/copyleaks/models/submissions/webhooks/IndexedWebhook.rb
+- lib/copyleaks/models/submissions/webhooks/NewResultWebhook.rb
+- lib/copyleaks/models/submissions/webhooks/index.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
@@ -96,7 +124,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 +139,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
 specification_version: 4
 summary: Detects plagiarism and checks content distribution online.
 test_files: []