plagiarism-checker 3.3.0 → 3.5.0

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

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

@@ -31,6 +31,7 @@ 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 'Webhooks/index.rb'
 
 require_relative 'writing_assistant/score_weights.rb'
 require_relative 'writing_assistant/writing_assistant_submission_model.rb'

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/webhooks/CompletedWebhook.rb

@@ -0,0 +1,46 @@
+ #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 NON INFRINGEMENT. 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 CompletedWebhook < StatusWebhook
+    attr_reader :results, :notifications, :scannedDocument
+
+    def initialize(results: nil, notifications: nil, scannedDocument: nil, **args)
+      super(**args)
+      @results = results
+      @notifications = notifications
+      @scannedDocument = scannedDocument
+      @extra_fields = args # Store any additional fields here
+    end
+
+    def as_json(*_args)
+      super.merge(
+        {
+          results: @results.respond_to?(:as_json) ? @results.as_json : @results,
+          notifications: @notifications.respond_to?(:as_json) ? @notifications.as_json : @notifications,
+          scannedDocument: @scannedDocument.respond_to?(:as_json) ? @scannedDocument.as_json : @scannedDocument
+        }
+      ).merge(@extra_fields)
+    end
+
+    def to_json(*options)
+      as_json.to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/submissions/webhooks/CreditsCheckedWebhook.rb

@@ -0,0 +1,43 @@
+ #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 NON INFRINGEMENT. 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 CreditsCheckedWebhook < StatusWebhook
+    attr_reader :credits, :scannedDocument
+
+    def initialize(credits: nil, scannedDocument: nil, **args)
+      super(**args)
+      @credits = credits
+      @scannedDocument = scannedDocument
+    end
+
+    def as_json(*_args)
+      super.merge(
+        {
+          credits: @credits,
+          scannedDocument: @scannedDocument.respond_to?(:as_json) ? @scannedDocument.as_json : @scannedDocument
+        }
+      )
+    end
+
+    def to_json(*options)
+      as_json.to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/submissions/webhooks/ErrorWebhook.rb

@@ -0,0 +1,41 @@
+ #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 NON INFRINGEMENT. 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 ErrorWebhook < StatusWebhook
+    attr_reader :error
+
+    def initialize(error: nil, **args)
+      super(**args)
+      @error = error
+    end
+
+    def as_json(*_args)
+      super.merge(
+        {
+          error: @error.respond_to?(:as_json) ? @error.as_json : @error
+        }
+      )
+    end
+
+    def to_json(*options)
+      as_json.to_json(*options)
+    end
+  end
+end

data/lib/copyleaks/models/submissions/webhooks/ExportCompletedWebhook.rb

@@ -0,0 +1,44 @@
+ #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 NON INFRINGEMENT. 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 ExportCompletedWebhook < Webhook
+    attr_reader :completed, :tasks
+
+    def initialize(completed: nil, tasks: nil, **args)
+      super(**args)
+      @completed = completed
+      @tasks = tasks
+    end
+
+    def as_json(*_args)
+      super.merge(
+        {
+          completed: @completed,
+          tasks: @tasks.respond_to?(:map) ? @tasks.map { |t| t.respond_to?(:as_json) ? t.as_json : t } : @tasks
+        }
+      )
+    end
+
+    def to_json(*options)
+      as_json.to_json(*options)
+    end
+  end
+end
+

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

@@ -0,0 +1,89 @@
+
+ #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 NON INFRINGEMENT. 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 Metadata
+    attr_reader :finalUrl, :canonicalUrl, :publishDate, :creationDate,
+                :lastModificationDate, :author, :organization, :filename
+
+    # @param [String] finalUrl - The final URL of the document.
+    # @param [String] canonicalUrl - The canonical URL if available.
+    # @param [String] publishDate - The date the content was published.
+    # @param [String] creationDate - The date the content was created.
+    # @param [String] lastModificationDate - The last time the content was modified.
+    # @param [String] author - The author of the content.
+    # @param [String] organization - The organization associated with the content.
+    # @param [String] filename - The original filename of the content.
+    def initialize(finalUrl: nil, canonicalUrl: nil, publishDate: nil, creationDate: nil,
+                   lastModificationDate: nil, author: nil, organization: nil, filename: nil)
+
+      if !finalUrl.nil? && !finalUrl.is_a?(String)
+        raise 'Copyleaks::Metadata - finalUrl must be a String'
+      end
+      if !canonicalUrl.nil? && !canonicalUrl.is_a?(String)
+        raise 'Copyleaks::Metadata - canonicalUrl must be a String'
+      end
+      if !publishDate.nil? && !publishDate.is_a?(String)
+        raise 'Copyleaks::Metadata - publishDate must be a String'
+      end
+      if !creationDate.nil? && !creationDate.is_a?(String)
+        raise 'Copyleaks::Metadata - creationDate must be a String'
+      end
+      if !lastModificationDate.nil? && !lastModificationDate.is_a?(String)
+        raise 'Copyleaks::Metadata - lastModificationDate must be a String'
+      end
+      if !author.nil? && !author.is_a?(String)
+        raise 'Copyleaks::Metadata - author must be a String'
+      end
+      if !organization.nil? && !organization.is_a?(String)
+        raise 'Copyleaks::Metadata - organization must be a String'
+      end
+      if !filename.nil? && !filename.is_a?(String)
+        raise 'Copyleaks::Metadata - filename must be a String'
+      end
+
+      @finalUrl = finalUrl
+      @canonicalUrl = canonicalUrl
+      @publishDate = publishDate
+      @creationDate = creationDate
+      @lastModificationDate = lastModificationDate
+      @author = author
+      @organization = organization
+      @filename = filename
+    end
+
+    def as_json(*_args)
+      {
+        finalUrl: @finalUrl,
+        canonicalUrl: @canonicalUrl,
+        publishDate: @publishDate,
+        creationDate: @creationDate,
+        lastModificationDate: @lastModificationDate,
+        author: @author,
+        organization: @organization,
+        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/webhooks/HelperModels/BaseModels/StatusWebhook.rb

@@ -0,0 +1,41 @@
+ #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 NON INFRINGEMENT. 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 StatusWebhook < Webhook
+    attr_reader :status
+
+    def initialize(status:, **args)
+      unless status.is_a?(Integer)
+        raise 'Copyleaks::StatusWebhook - status must be an Integer'
+      end
+      super(**args)
+      @status = status
+    end
+
+    def as_json(*_args)
+      {
+        status: @status
+      }.merge(super)
+    end
+
+    def to_json(*options)
+      as_json.to_json(*options)
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+ #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 NON INFRINGEMENT. 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 Webhook
+
+    # @param [String] developerPayload - The developer payload that was provided in the submit method.
+    attr_reader :developerPayload
+
+    def initialize(developerPayload: nil,**args)
+      if !developerPayload.nil? && !developerPayload.is_a?(String)
+        raise 'Copyleaks::Webhook - developerPayload must be a String'
+      end
+      @developerPayload = developerPayload
+      @extra_fields = args
+    end
+
+    def as_json(*_args)
+      {
+        developerPayload: @developerPayload
+      }.compact
+    end
+
+    def to_json(*options)
+      as_json.to_json(*options)
+    end
+  end
+end