Merge pull request #10 from Copyleaks/features/1203221642267913/update-properties

features/1203221642267913/update-properties

Author: AihamAR

lib/copyleaks/models/submissions/properties/cross_languages.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 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 SubmissionCrossLanguages
+      # @param [Language[]] languages - Languages to scan your content against.
+      def initialize(languages = nil)
+        if !languages.nil? && !(languages.is_a?(Array) && languages.all? { |element| element.is_a?(SubmissionLanguage) })
+            raise 'Copyleaks::SubmissionCrossLanguages - languages - languages must be of type SubmissionLanguage[]'
+        end
+        @languages = languages
+      end
+  
+      def as_json(*_args)
+        {
+            languages: @languages,
+        }.select { |_k, v| !v.nil? }
+      end
+  
+      def to_json(*options)
+        as_json(*options).to_json(*options)
+      end
+    end
+  end

lib/copyleaks/models/submissions/properties/custom_metadata.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 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 SubmissionCustomMetadata
+      # @param [String] key.
+      # @param [String] value.
+      def initialize(key, value)
+        @key = key
+        @value = value
+      end
+  
+      def as_json(*_args)
+        {
+            key: @key,
+            value: @value
+        }.select { |_k, v| !v.nil? }
+      end
+  
+      def to_json(*options)
+        as_json(*options).to_json(*options)
+      end
+    end
+  end

lib/copyleaks/models/submissions/properties/exclude.rb

@@ -28,18 +28,41 @@ class SubmissionExclude
     # @param [Boolean] tableOfContents Exclude table of contents from the scan.
     # @param [Boolean] titles Exclude titles from the scan.
     # @param [Boolean] htmlTemplate When the scanned document is an HTML document, exclude irrelevant text that appears across the site like the website footer or header.
+    # @param [Boolean] citations - Exclude citations from the scan.
+    # @param [String[]] documentTemplateIds - Exclude text based on text found within other documents.
+    # @param [SubmissionExcludeCode] code - Exclude sections of source code
+
     def initialize(
       quotes = false,
       references = false,
       tableOfContents = false,
       titles = false,
-      htmlTemplate = false
+      htmlTemplate = false,
+      citations = nil,
+      documentTemplateIds = nil,
+      code = nil
     )
+      if !citations.nil? && ![true, false].include?(citations)
+        raise 'Copyleaks::SubmissionExclude - citations - citations must be of type Boolean'
+      end
+
+      if !documentTemplateIds.nil? && !(documentTemplateIds.is_a?(Array) && documentTemplateIds.all? { |element| element.is_a?(String) })
+        raise 'Copyleaks::SubmissionExclude - documentTemplateIds - documentTemplateIds must be of type String[]'
+      end
+
+      if !code.nil? && !code.instance_of?(SubmissionExcludeCode)
+        raise 'Copyleaks::SubmissionExclude - code - code must be of type SubmissionExcludeCode'
+      end
+
       @quotes = quotes
       @references = references
       @tableOfContents = tableOfContents
       @titles = titles
       @htmlTemplate = htmlTemplate
+      @citations = citations
+      @documentTemplateIds = documentTemplateIds
+      @code = code
+
     end
 
     def as_json(*_args)
@@ -48,7 +71,10 @@ def as_json(*_args)
         references: @references,
         tableOfContents: @tableOfContents,
         titles: @titles,
-        htmlTemplate: @htmlTemplate
+        htmlTemplate: @htmlTemplate,
+        citations: @citations,
+        documentTemplateIds: @documentTemplateIds,
+        code: @code
       }.select { |_k, v| !v.nil? }
     end
 

lib/copyleaks/models/submissions/properties/exclude_code.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 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 SubmissionExcludeCode
+      # @param [Boolean] Exclude comments from the scan.
+  
+      def initialize(
+        comments = false
+      )
+        @comments = comments
+      end
+  
+      def as_json(*_args)
+        {
+            comments: @comments,
+        }.select { |_k, v| !v.nil? }
+      end
+  
+      def to_json(*options)
+        as_json(*options).to_json(*options)
+      end
+    end
+  end

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

@@ -23,17 +23,24 @@
 # =
 
 require_relative 'submission_properties.rb'
-
 require_relative 'actions.rb'
 require_relative 'ai_generated_text.rb'
 require_relative 'author.rb'
 require_relative 'copyleaks_db.rb'
+require_relative 'cross_languages.rb'
+require_relative 'custom_metadata.rb'
 require_relative 'domains_mode.rb'
+require_relative 'exclude_code.rb'
 require_relative 'exclude.rb'
 require_relative 'filter.rb'
+require_relative 'indexing_repository.rb'
 require_relative 'scan_method_algorithm.rb'
 require_relative 'indexing.rb'
+require_relative 'language.rb'
+require_relative 'masking_policy.rb'
+require_relative 'pdf_colors.rb'
 require_relative 'pdf_properties.rb'
+require_relative 'pdf_version.rb'
 require_relative 'repository.rb'
 require_relative 'scanning.rb'
 require_relative 'scanning_exclude.rb'
@@ -42,5 +49,7 @@
 require_relative 'submission_properties.rb'
 require_relative 'webhooks.rb'
 
+
+
 module Copyleaks
 end

lib/copyleaks/models/submissions/properties/indexing.rb

@@ -23,7 +23,7 @@
 # =
 module Copyleaks
   class SubmissionIndexing
-    # @param [SubmissionRepository[]] repositories - Check inner properties of SubmissionRepository for more details.
+    # @param [SubmissionIndexingRepository[]] repositories - Check inner properties of SubmissionRepository for more details.
     def initialize(repositories)
       @repositories = repositories
     end

lib/copyleaks/models/submissions/properties/indexing_repository.rb

@@ -0,0 +1,47 @@
+#
+#  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 SubmissionIndexingRepository < SubmissionRepository
+      # @param [String] ID of a repository to add the scanned document to.
+      # @param [SubmissionMaskingPolicy] maskingPolicy specify the document maskig ploicy.
+      def initialize(id, maskingPolicy = nil)
+        super(id)
+        if !maskingPolicy.nil? && ![0, 1, 2].include?(maskingPolicy)
+            raise 'Copyleaks::SubmissionIndexingRepository - maskingPolicy - maskingPolicy must be of type SubmissionMaskingPolicy'
+        end
+        @maskingPolicy = maskingPolicy
+      end
+  
+      def as_json(*_args)
+        {
+            id: @id,
+            maskingPolicy: @maskingPolicy,
+        }.select { |_k, v| !v.nil? }
+      end
+  
+      def to_json(*options)
+        as_json(*options).to_json(*options)
+      end
+    end
+  end

lib/copyleaks/models/submissions/properties/language.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 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 SubmissionLanguage
+      # @param [String] code - Language code for cross language plagiarism detection.
+      def initialize(code)
+        @code = code
+      end
+  
+      def as_json(*_args)
+        {
+            code: @code,
+        }.select { |_k, v| !v.nil? }
+      end
+  
+      def to_json(*options)
+        as_json(*options).to_json(*options)
+      end
+    end
+  end

lib/copyleaks/models/submissions/properties/masking_policy.rb

@@ -0,0 +1,34 @@
+#
+#  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 SubmissionMaskingPolicy
+        
+        NO_MASK = 0
+
+        MASK_OTHER_USERS_FILES = 1
+
+        MASK_ALL_FILES = 2
+
+    end
+  end