plagiarism-checker 2.1.2 → 3.0.0

data/lib/copyleaks_api/copyleaks_process.rb

@@ -1,78 +0,0 @@
-require 'time'
-require 'copyleaks_api/Models/ResultRecord'
-
-
-module CopyleaksApi
-  class CopyleaksProcess
-    attr_accessor :process_id, :progress, :custom_fields, :created_at
-
-    # constructor
-    def initialize(options)
-      @cloud = options[:cloud]
-      [:cloud, :api, :process_id, :custom_fields, :result, :progress].each do |attr|
-        instance_variable_set("@#{attr}", options[attr]) if options[attr]
-      end
-      @created_at = DateTime.parse(options[:created_at]) if options[:created_at]
-    end
-    
-    def to_s
-      return "Created at: #{@created_at}"
-    end
-
-    # returns true if still processing data on server side
-    def processing?
-      if @progress == 100
-        false
-      else
-        true
-      end
-    end
-
-    # return result data or retrieves from result endpoint if nothing specified
-    # retries result information of process with given id
-    def get_results
-      response = @api.get(@cloud.url(:result, @process_id), no_callbacks: true, token: @cloud.access_token.token)
-      @results = []
-      response.each do |res|
-        @results.push(CopyleaksApi::ResultRecord.new(res))
-      end
-      @results
-    end
-    
-    # retries status information of process with given id
-    def update_status
-      response = @api.get(@cloud.url(:status, @process_id), no_callbacks: true, token: @cloud.access_token.token)
-      @progress = response['ProgressPercents'].to_i
-      @progress
-    end
-
-    # Returns the source text of this process
-    def get_source_text
-      response = @api.get(@cloud.url_downloads("source-text?pid=#{@process_id}"), parse_json: false, no_callbacks: true, token: @cloud.access_token.token)
-      response
-    end
-
-    # deletes process from API
-    def delete
-      response = @api.delete(@cloud.url(:delete, @process_id), token: @cloud.access_token.token)
-      if response['StatusCode'] == 200
-        true
-      else
-        false
-      end
-    end
-
-    class << self
-      # create CopyleaksProcess based on data got from any create endpoint
-      def create(cloud, api, hash)
-        new(cloud: cloud, api: api, process_id: hash['ProcessId'], created_at: hash['CreationTimeUTC'])
-      end
-    
-      # creates CopyleaksProcess based on data got from list endpoint
-      def create_from_list(cloud, api, hash)
-        new(cloud: cloud, api: api, process_id: hash['ProcessId'], created_at: hash['CreationTimeUTC'],
-            status_code: hash['Status'].downcase, custom_fields: hash['CustomFields'])
-      end
-    end
-  end
-end

data/lib/copyleaks_api/errors.rb

@@ -1,29 +0,0 @@
-module CopyleaksApi
-  BasicError = Class.new(StandardError)
-  BadCustomFieldError = Class.new(BasicError)
-  BadFileError = Class.new(BasicError)
-  BadEmailError = Class.new(BasicError)
-  BadUrlError = Class.new(BasicError)
-  UnknownLanguageError = Class.new(BasicError)
-
-  class BadResponseError < BasicError
-    attr_accessor :code
-
-    # constructor
-    def initialize(code, message)
-      @code = code.to_i
-      @message = message
-    end
-
-    def to_s
-      "Error code: #{code}. #{@message}"
-    end
-  end
-
-  class ManagedError < BadResponseError
-    # returns true if this error is internal server error
-    def internal_error?
-      code == 16
-    end
-  end
-end

data/lib/copyleaks_api/validators/custom_fields_validator.rb

@@ -1,35 +0,0 @@
-module CopyleaksApi
-  module Validators
-    class CustomFieldsValidator
-      KEY_MAX_LENGTH = 128
-      VALUE_MAX_LENGTH = 512
-      OVERALL_MAX_LENGTH = 8192
-
-      class << self
-        # raises appropriate error if any length is too large
-        def validate!(fields)
-          raise BadCustomFieldError.new('Key is too long') unless keys_valid?(fields)
-          raise BadCustomFieldError.new('Value is too long') unless values_valid?(fields)
-          raise BadCustomFieldError.new('Overall size is too large') unless overall_valid?(fields)
-        end
-
-        private
-
-        # checks custom keys for length
-        def keys_valid?(hash)
-          hash.keys.map(&:to_s).all? { |s| s.size <= KEY_MAX_LENGTH }
-        end
-
-        # checks values for length
-        def values_valid?(hash)
-          hash.values.map(&:to_s).all? { |s| s.size <= VALUE_MAX_LENGTH }
-        end
-
-        # checks overall length
-        def overall_valid?(hash)
-          hash.reduce(0) { |a, e| a + e[0].to_s.size + e[1].to_s.size } <= OVERALL_MAX_LENGTH
-        end
-      end
-    end
-  end
-end

data/lib/copyleaks_api/validators/email_validator.rb

@@ -1,13 +0,0 @@
-module CopyleaksApi
-  module Validators
-    class EmailValidator
-      class << self
-        # raises error if given email is invalid
-        def validate!(email)
-          return if email =~ /^([a-z0-9_\.-]+)@([\da-z\.-]+)\.([a-z\.]{2,6})$/
-          raise BadEmailError.new(email), "Email #{email} is invalid"
-        end
-      end
-    end
-  end
-end

data/lib/copyleaks_api/validators/file_validator.rb

@@ -1,56 +0,0 @@
-module CopyleaksApi
-  module Validators
-    class FileValidator
-      SUPPORTED_FILE_TYPES = [:html, :htm, :txt, :pdf, :doc, :docx, :rtf].freeze
-      SUPPORTED_IMAGE_TYPES = [:gif, :png, :bmp, :jpg, :jpeg].freeze
-      BYTES_IN_MB = 1_024_000.0
-
-      class << self
-        # check file for ocr for correctness
-        def validate_ocr!(path)
-          validate_file(path, SUPPORTED_IMAGE_TYPES)
-        end
-
-        # check text file for correctness
-        def validate_text_file!(path)
-          validate_file(path, SUPPORTED_FILE_TYPES)
-        end
-
-        private
-
-        # check given file for correctness to given type
-        def validate_file(path, types)
-          ext = file_extension(path)
-          return if types.include?(ext) && file_size(path) <= allowed_file_size(ext)
-          raise BadFileError, "#{path} file has unsupported extension or to large"
-        end
-
-        # returns good file size in MB for given type
-        def allowed_file_size(type)
-          case type.to_sym
-          when :html, :htm
-            5
-          when :txt
-            3
-          when :pdf, :doc, :docx
-            25
-          when *SUPPORTED_IMAGE_TYPES
-            25
-          else
-            0
-          end
-        end
-
-        # extract file extension
-        def file_extension(path)
-          path.split('.').last.downcase.to_sym
-        end
-
-        # extract file size in MB
-        def file_size(path)
-          File.size(path) / BYTES_IN_MB
-        end
-      end
-    end
-  end
-end

data/lib/copyleaks_api/validators/language_validator.rb

@@ -1,12 +0,0 @@
-module CopyleaksApi
-  module Validators
-    class LanguageValidator
-      class << self
-        # raise error if given language is not allowed
-        def validate!(language)
-          raise UnknownLanguageError, "#{language} is unknown" unless Language::ALLOWED.include?(language)
-        end
-      end
-    end
-  end
-end

data/lib/copyleaks_api/validators/response_validator.rb

@@ -1,27 +0,0 @@
-require 'json'
-
-module CopyleaksApi
-  module Validators
-    class ResponseValidator
-      ERROR_HEADER = 'Copyleaks-Error-Code'.freeze
-      GOOD_STATUS_CODE = 200
-
-      class << self
-        # raises error if response has APi error code or bad status code
-        def validate!(response)
-          raise ManagedError.new(response[ERROR_HEADER], extract_message(response.body)) if response[ERROR_HEADER]
-          raise BadResponseError.new(response.code, response.body) if response.code.to_i != GOOD_STATUS_CODE
-        end
-
-        private
-
-        # extract message from body
-        def extract_message(string)
-          JSON.parse(string)['Message']
-        rescue JSON::ParserError
-          string
-        end
-      end
-    end
-  end
-end

data/lib/copyleaks_api/validators/url_validator.rb

@@ -1,12 +0,0 @@
-module CopyleaksApi
-  module Validators
-    class UrlValidator
-      class << self
-        # raises error if given url for callback is invalid
-        def validate!(url)
-          raise BadUrlError.new(url) unless url =~ %r(^(https?://)?([\da-z\.-]+)\.([a-z\.]{2,6})([/\w \.-]*)*/?$)
-        end
-      end
-    end
-  end
-end

data/lib/copyleaks_api/version.rb

@@ -1,3 +0,0 @@
-module CopyleaksApi
-  VERSION = '2.1.2'.freeze
-end