plagiarism-checker 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8861ba4abf0d4978576fee7a8667865cf75ead57b6fe97aadcd5a8dcbd938ca4
-  data.tar.gz: 0646e0627f98928111112bb0e3e2fa4964342621754159c63e62086f91f0ca1b
+  metadata.gz: dc9cd9aec0f8d28efc51f64f0ad3f5ac700d6216b757f2f128589b8fffee7e04
+  data.tar.gz: f3cb8a6819a44a77f58d6db5a0b7e0ee846bb9f9c5f092db5641cd81b5b1edd4
 SHA512:
-  metadata.gz: b4ae513036ed69b983eced3db5ef330c946d83009a03faca018297f53b554936057e6df9ee23a5f7b7505f72d199649e464d173fe5acad897dc58c8fc4a86cae
-  data.tar.gz: f98ab2a48d28947e540e85164b2e331ba7ef7d8671d901b6f12ba3c9146bb4ffae80427aefd0ce22819c53e41dcdf90841d7c52ac867d3fd64471b066bda252f
+  metadata.gz: 469bb11f779b9191ec6bbfb41143f87edcf2782ed41de3cb2d697a3696e6da911395b2acb1b24004eae2ea70f5a4dd4c7252d47750e110af6f71e449b6244fa8
+  data.tar.gz: 3d9cb0523ac8aac51248046ba8b2a0f642173b8965c1dfe7afb7c2105a452fda03a36c245b6ebf9e48e6eba1e8b0b44d39fa17ae5c36ac0acd436f397395c0d6

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 'text_moderation_client.rb'
 require_relative 'utils/copyleaks_client.utils'
 
 module Copyleaks
@@ -43,6 +44,7 @@ module Copyleaks
       # Initialize clients
       @ai_detection_client = AIDetectionClient.new(@api_client)
       @writing_assistant_client = WritingAssistantClient.new(@api_client)
+      @text_moderation_client = TextModerationClient.new(@api_client)
     end
 
     # Login to Copyleaks authentication server.
@@ -456,5 +458,8 @@ module Copyleaks
     def writing_assistant_client
       @writing_assistant_client
     end
+    def text_moderation_client
+      @text_moderation_client
+    end
   end
 end

data/lib/copyleaks/models/index.rb

@@ -31,5 +31,13 @@ require_relative 'id_object.rb'
 require_relative 'delete_request_model.rb'
 require_relative 'start_request_model.rb'
 
+require_relative 'textModeration/requests/CopyleaksTextModerationRequestModel.rb'
+require_relative 'textModeration/responses/submodules/ModerationsModel.rb'
+require_relative 'textModeration/responses/submodules/Text.rb'
+require_relative 'textModeration/responses/submodules/TextModerationChars.rb'
+require_relative 'textModeration/responses/submodules/TextModerationScannedDocument.rb'
+require_relative 'textModeration/responses/submodules/TextModerationsLegend.rb'
+require_relative 'textModeration/responses/CopyleaksTextModerationResponseModel.rb'
+
 module Copyleaks
 end

data/lib/copyleaks/models/submissions/webhooks/HelperModels/BaseModels/StatusWebhook.rb

@@ -18,6 +18,7 @@
  #=
 module Copyleaks
   class StatusWebhook < Webhook
+    # @param [Integer] status - The current status of the scan.
     attr_reader :status
 
     def initialize(status:, **args)

data/lib/copyleaks/models/textModeration/requests/CopyleaksTextModerationRequestModel.rb

@@ -0,0 +1,43 @@
+require 'json'
+
+module Copyleaks
+  class CopyleaksTextModerationRequestModel
+    attr_accessor :text, :sandbox, :language, :labels
+
+    # @param text [String] Text to produce Text Moderation report for.
+    # @param sandbox [Boolean] Use sandbox mode to test your integration. Default: false.
+    # @param language [String, nil] The language code. Optional; set to nil for auto-detect.
+    # @param labels [Array<Object>] A list of label configurations (min 1, max 32 elements).
+    def initialize(text: '', sandbox: false, language: nil, labels: [])
+
+      @text = text
+      @sandbox = sandbox
+      @language = language
+      @labels = labels
+
+      raise ArgumentError, "String cannot be blank" if @text.nil?
+      raise ArgumentError, "Labels must be a non-empty array." unless labels.is_a?(Array) && !labels.empty?
+      raise ArgumentError, "Labels cannot have more than 32 elements." if labels.length > 32
+
+    end
+
+    def to_json(options = {})
+      {
+        text: @text,
+        sandbox: @sandbox,
+        language: @language,
+        labels: @labels
+      }.to_json(options)
+    end
+
+    def self.from_json(json_string)
+      data = JSON.parse(json_string, symbolize_names: true)
+      new(
+        text: data[:text],
+        sandbox: data[:sandbox],
+        language: data[:language],
+        labels: data[:labels]
+      )
+    end
+  end
+end

data/lib/copyleaks/models/textModeration/responses/CopyleaksTextModerationResponseModel.rb

@@ -0,0 +1,36 @@
+require 'json'
+module Copyleaks
+
+class CopyleaksTextModerationResponseModel
+  attr_accessor :moderations, :legend, :scanned_document
+
+  # @param moderations [ModerationsModel] Moderated text segments detected in the input text.
+  # @param legend [Array<TextModerationsLegend>] An array that provides a lookup for the labels referenced by their numerical indices in the `text.chars.labels` array. Each object within this legend array defines a specific label that was used in the scan.
+  # @param scanned_document [TextModerationScannedDocument] General information about the scanned document.
+  def initialize(moderations: ModerationsModel.new, legend: [], scanned_document: TextModerationScannedDocument.new, **_ignored)
+    @moderations = moderations
+    @legend = legend
+    @scanned_document = scanned_document
+  end
+
+
+  def to_json(options = {})
+    {
+      moderations: @moderations ? JSON.parse(@moderations.to_json) : nil,
+      legend: @legend.map(&:to_json).map { |l| JSON.parse(l) },
+      scannedDocument: @scanned_document ? JSON.parse(@scanned_document.to_json) : nil
+    }.to_json(options)
+  end
+
+
+  def self.from_json(json_string)
+    data = JSON.parse(json_string, symbolize_names: true)
+    new(
+      moderations: data[:moderations] ? ModerationsModel.from_json(data[:moderations].to_json) : nil,
+      legend: data[:legend].map { |l| TextModerationsLegend.from_json(l.to_json) },
+      scanned_document: data[:scannedDocument] ? TextModerationScannedDocument.from_json(data[:scannedDocument].to_json) : nil
+    )
+  end
+end
+
+end

data/lib/copyleaks/models/textModeration/responses/submodules/ModerationsModel.rb

@@ -0,0 +1,26 @@
+require 'json'
+module Copyleaks
+
+class ModerationsModel
+  attr_accessor :text
+
+  # @param text [Text] Moderated text segments corresponding to the submitted text. Each position in the inner arrays corresponds to a single segment in the textual version.
+  def initialize(text: Text.new)
+    @text = text
+  end
+
+  def to_json(options = {})
+    {
+      text: @text ? JSON.parse(@text.to_json) : nil
+    }.to_json(options)
+  end
+
+ 
+  def self.from_json(json_string)
+    data = JSON.parse(json_string, symbolize_names: true)
+    new(
+      text: data[:text] ? Text.from_json(data[:text].to_json) : nil
+    )
+  end
+end
+end

data/lib/copyleaks/models/textModeration/responses/submodules/Text.rb

@@ -0,0 +1,26 @@
+require 'json'
+
+module Copyleaks
+class Text
+  attr_accessor :chars
+
+  # @param chars [TextModerationChars] An object that groups together several arrays detailing the properties of labelled segments.
+  def initialize(chars: TextModerationChars.new)
+    @chars = chars
+  end
+
+  def to_json(options = {})
+    {
+      chars: @chars ? JSON.parse(@chars.to_json) : nil
+    }.to_json(options)
+  end
+
+
+  def self.from_json(json_string)
+    data = JSON.parse(json_string, symbolize_names: true)
+    new(
+      chars: data[:chars] ? TextModerationChars.from_json(data[:chars].to_json) : nil
+    )
+  end
+end
+end

data/lib/copyleaks/models/textModeration/responses/submodules/TextModerationChars.rb

@@ -0,0 +1,35 @@
+require 'json'
+module Copyleaks
+
+class TextModerationChars
+  attr_accessor :labels, :starts, :lengths
+
+  # @param starts [Array<Integer>] Start character position of the labelled segment.
+  # @param labels [Array<Integer>] Predicted label index for the corresponding segment. The index can be resolved to its ID using the supplied legend.
+  # @param lengths [Array<Integer>] Labelled segment character length.
+  def initialize( starts: [],labels: [], lengths: [])
+    @starts = starts
+    @labels = labels
+    @lengths = lengths
+  end
+
+
+  def to_json(options = {})
+    {
+      labels: @labels,
+      starts: @starts,
+      lengths: @lengths
+    }.to_json(options)
+  end
+
+  def self.from_json(json_string)
+    data = JSON.parse(json_string, symbolize_names: true)
+    new(
+      labels: data[:labels],
+      starts: data[:starts],
+      lengths: data[:lengths]
+    )
+  end
+end
+
+end

data/lib/copyleaks/models/textModeration/responses/submodules/TextModerationScannedDocument.rb

@@ -0,0 +1,47 @@
+require 'json'
+require 'date'
+module Copyleaks
+
+class TextModerationScannedDocument
+  attr_accessor :scan_id, :total_words, :total_excluded, :actual_credits, :expected_credits, :creation_time
+
+  # @param scan_id [String] The scan id given by the user.
+  # @param total_words [Integer] Total number of words found in the scanned text.
+  # @param total_excluded [Integer] Total excluded words from the text.
+  # @param actual_credits [Integer] The cost of credits for this scan.
+  # @param expected_credits [Integer] The amount of credits that was expected to be spent on the scan.
+  # @param creation_time [Time] Creation time of the scan.
+  def initialize(scan_id: '', total_words: 0, total_excluded: 0, actual_credits: 0, expected_credits: 0, creation_time: Time.utc.now)
+    @scan_id = scan_id
+    @total_words = total_words
+    @total_excluded = total_excluded
+    @actual_credits = actual_credits
+    @expected_credits = expected_credits
+    @creation_time = creation_time
+  end
+
+
+  def to_json(options = {})
+    {
+      scanId: @scan_id,
+      totalWords: @total_words,
+      totalExcluded: @total_excluded,
+      actualCredits: @actual_credits,
+      expectedCredits: @expected_credits,
+      creationTime: @creation_time.iso8601
+    }.to_json(options)
+  end
+
+  def self.from_json(json_string)
+    data = JSON.parse(json_string, symbolize_names: true)
+    new(
+      scan_id: data[:scanId],
+      total_words: data[:totalWords],
+      total_excluded: data[:totalExcluded],
+      actual_credits: data[:actualCredits],
+      expected_credits: data[:expectedCredits],
+      creation_time: Time.parse(data[:creationTime]) 
+    )
+  end
+end
+end

data/lib/copyleaks/models/textModeration/responses/submodules/TextModerationsLegend.rb

@@ -0,0 +1,29 @@
+require 'json'
+module Copyleaks
+
+class TextModerationsLegend
+  attr_accessor :index, :id
+
+  # @param index [integer] The numerical index of the label.
+  # @param id [string] A unique string identifier for the label. This ID serves as a machine-readable way to identify the label type.
+  def initialize(index: 0, id: '')
+    @index = index
+    @id = id
+  end
+
+  def to_json(options = {})
+    {
+      index: @index,
+      id: @id
+    }.to_json(options)
+  end
+
+  def self.from_json(json_string)
+    data = JSON.parse(json_string, symbolize_names: true)
+    new(
+      index: data[:index],
+      id: data[:id]
+    )
+  end
+end
+end

data/lib/copyleaks/text_moderation_client.rb

@@ -0,0 +1,51 @@
+#
+#  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 TextModerationClient
+    def initialize(api_client)
+      @api_client = api_client
+    end
+
+    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 CopyleaksTextModerationRequestModel' if submission.nil? || !submission.instance_of?(Copyleaks::CopyleaksTextModerationRequestModel)
+
+      ClientUtils.verify_auth_token(authToken)
+
+      path = "/v1/text-moderation/#{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_text_moderation')
+    end
+  end
+end

data/lib/copyleaks/version.rb

@@ -1,3 +1,3 @@
 module Copyleaks
-  VERSION = '3.5.0'
+  VERSION = '3.6.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: plagiarism-checker
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Copyleaks ltd
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-07-01 00:00:00.000000000 Z
+date: 1980-01-02 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
@@ -112,6 +111,14 @@ files:
 - 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/models/textModeration/requests/CopyleaksTextModerationRequestModel.rb
+- lib/copyleaks/models/textModeration/responses/CopyleaksTextModerationResponseModel.rb
+- lib/copyleaks/models/textModeration/responses/submodules/ModerationsModel.rb
+- lib/copyleaks/models/textModeration/responses/submodules/Text.rb
+- lib/copyleaks/models/textModeration/responses/submodules/TextModerationChars.rb
+- lib/copyleaks/models/textModeration/responses/submodules/TextModerationScannedDocument.rb
+- lib/copyleaks/models/textModeration/responses/submodules/TextModerationsLegend.rb
+- lib/copyleaks/text_moderation_client.rb
 - lib/copyleaks/utils/copyleaks_client.utils.rb
 - lib/copyleaks/utils/status-code.utils.rb
 - lib/copyleaks/version.rb
@@ -124,7 +131,6 @@ 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: 
 rdoc_options: []
 require_paths:
 - lib
@@ -139,9 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Detects plagiarism and checks content distribution online.
 test_files: []