Merge pull request #5 from Copyleaks/features/best-practice

Features/best practice

Author: AihamAR

lib/copyleaks.rb

@@ -22,14 +22,11 @@
 #  SOFTWARE.
 # =
 
-$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
-
-require 'copyleaks/version'
-
-require 'copyleaks/models/index'
-require 'copyleaks/utils/status-code.utils'
-require 'copyleaks/app.config'
-require 'copyleaks/api'
+require_relative  './copyleaks/api.rb'
+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'
 
 module Copyleaks
 end

lib/copyleaks/models/exceptions/index.rb

@@ -21,12 +21,11 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #  SOFTWARE.
 # =
-$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
 
-require 'auth_exipred_exception'
-require 'command_exception'
-require 'rate_limit_exception'
-require 'under_maintenance_exception'
+require_relative 'auth_exipred_exception.rb'
+require_relative 'command_exception.rb'
+require_relative 'rate_limit_exception.rb'
+require_relative 'under_maintenance_exception.rb'
 
 module Copyleaks
 end

lib/copyleaks/models/exports/index.rb

@@ -21,12 +21,11 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #  SOFTWARE.
 # =
-$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
 
-require 'export_model'
-require 'export_crawled_version'
-require 'export_pdf_report'
-require 'export_results'
+require_relative 'export_model.rb'
+require_relative 'export_crawled_version.rb'
+require_relative 'export_pdf_report.rb'
+require_relative 'export_results.rb'
 
 module Copyleaks
 end

lib/copyleaks/models/index.rb

@@ -21,15 +21,15 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #  SOFTWARE.
 # =
-$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
-require 'exceptions/index'
-require 'exports/index'
-require 'submissions/index'
-require 'auth_token'
 
-require 'id_object'
-require 'delete_request_model'
-require 'start_request_model'
+require_relative 'exceptions/index.rb'
+require_relative 'exports/index.rb'
+require_relative 'submissions/index.rb'
+require_relative 'auth_token.rb'
+
+require_relative 'id_object.rb'
+require_relative 'delete_request_model.rb'
+require_relative 'start_request_model.rb'
 
 module Copyleaks
 end

lib/copyleaks/models/submissions/index.rb

@@ -21,13 +21,12 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #  SOFTWARE.
 # =
-$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
-require 'properties/index'
+require_relative 'properties/index.rb'
 
-require 'submission_model'
-require 'file_submission_model'
-require 'file_ocr_submission_model'
-require 'url_submission_model'
+require_relative 'submission_model.rb'
+require_relative 'file_submission_model.rb'
+require_relative 'file_ocr_submission_model.rb'
+require_relative 'url_submission_model.rb'
 
 module Copyleaks
 end

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

@@ -21,25 +21,25 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #  SOFTWARE.
 # =
-$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
 
-require 'submission_properties'
+require_relative 'submission_properties.rb'
 
-require 'actions'
-require 'author'
-require 'copyleaks_db'
-require 'domains_mode'
-require 'exclude'
-require 'filter'
-require 'indexing'
-require 'pdf_properties'
-require 'repository'
-require 'scanning'
-require 'scanning_exclude'
-require 'scanning_repository'
-require 'sensitive_data_protection'
-require 'submission_properties'
-require 'webhooks'
+require_relative 'actions.rb'
+require_relative 'author.rb'
+require_relative 'copyleaks_db.rb'
+require_relative 'domains_mode.rb'
+require_relative 'exclude.rb'
+require_relative 'filter.rb'
+require_relative 'scan_method_algorithm.rb'
+require_relative 'indexing.rb'
+require_relative 'pdf_properties.rb'
+require_relative 'repository.rb'
+require_relative 'scanning.rb'
+require_relative 'scanning_exclude.rb'
+require_relative 'scanning_repository.rb'
+require_relative 'sensitive_data_protection.rb'
+require_relative 'submission_properties.rb'
+require_relative 'webhooks.rb'
 
 module Copyleaks
 end

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

@@ -0,0 +1,31 @@
+#
+#  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 SubmissionScanMethodAlgorithm
+    # prioritize higher similarity
+    MAXIMUM_COVERAGE = 0
+    # prioritize finding more sources.
+    MAXIMUM_RESULTS = 1
+  end
+end

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

@@ -24,7 +24,7 @@
 module Copyleaks
   class SubmissionProperties
     attr_reader :webhooks, :includeHtml, :developerPayload, :sandbox, :expiration, :sensitivityLevel, :cheatDetection,
-                :action, :author, :filters, :scanning, :indexing, :exclude, :pdf, :sensitiveDataProtection
+                :action, :author, :filters, :scanning, :indexing, :exclude, :pdf, :sensitiveDataProtection, :scanMethodAlgorithm
 
     # @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.
@@ -41,10 +41,11 @@ class SubmissionProperties
     # @param [SubmissionExclude] exclude - Check inner properties for more details.
     # @param [SubmissionPDF] pdf - Check inner properties for more details.
     # @param [SubmissionSensitiveData] sensitiveDataProtection - Check inner properties for more details.
+    # @param [SubmissionScanMethodAlgorithm] scanMethodAlgorithm - 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
+      scanning = nil, indexing = nil, exclude = nil, pdf = nil, sensitiveDataProtection = nil, scanMethodAlgorithm = nil
     )
       unless webhooks.instance_of?(SubmissionWebhooks)
         raise 'Copyleaks::SubmissionProperties - webhooks - webhooks must be of type SubmissionWebhooks'
@@ -91,6 +92,9 @@ def initialize(
       if !sensitiveDataProtection.nil? && !sensitiveDataProtection.instance_of?(SubmissionSensitiveData)
         raise 'Copyleaks::SubmissionProperties - sensitiveDataProtection - sensitiveDataProtection must be of type SubmissionSensitiveData'
       end
+      if !scanMethodAlgorithm.nil? && ![0, 1].include?(scanMethodAlgorithm)
+        raise 'Copyleaks::SubmissionProperties - scanMethodAlgorithm - action must be of type SubmissionScanMethodAlgorithm consts'
+      end
 
       @webhooks = webhooks
       @includeHtml = includeHtml
@@ -107,6 +111,7 @@ def initialize(
       @exclude = exclude
       @pdf = pdf
       @sensitiveDataProtection = sensitiveDataProtection
+      @scanMethodAlgorithm = scanMethodAlgorithm
     end
 
     def as_json(*_args)
@@ -125,7 +130,8 @@ def as_json(*_args)
         indexing: @indexing,
         exclude: @exclude,
         pdf: @pdf,
-        sensitiveDataProtection: @sensitiveDataProtection
+        sensitiveDataProtection: @sensitiveDataProtection,
+        scanMethodAlgorithm: @scanMethodAlgorithm
       }.select { |_k, v| !v.nil? }
     end
 

lib/copyleaks/version.rb

@@ -1,3 +1,3 @@
 module Copyleaks
-  VERSION = '3.1.0'
+  VERSION = '3.1.1'
 end

lib/index.rb

@@ -22,9 +22,7 @@
 #  SOFTWARE.
 # =
 
-$LOAD_PATH.unshift(__dir__) unless $LOAD_PATH.include?(__dir__)
-
-require 'copyleaks'
+require_relative  'copyleaks.rb'
 
 module Copyleaks
 end