plagiarism-checker 1.0.0 → 3.0.0

data/lib/copyleaks/version.rb

@@ -0,0 +1,3 @@
+module Copyleaks
+  VERSION = '3.0.0'
+end

data/lib/index.rb

@@ -0,0 +1,35 @@
+#
+#  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.
+# =
+
+$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'
+
+module Copyleaks
+end

data/plagiarism-checker.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# lib = File.expand_path('lib', __dir__)
+# $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require_relative 'lib/copyleaks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'plagiarism-checker'
+  spec.version       = Copyleaks::VERSION
+  spec.authors       = ['Copyleaks ltd']
+  spec.email         = ['sales@copyleaks.com']
+
+  spec.summary       = 'Detects plagiarism and checks content distribution online.'
+  spec.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 before. With Copyleaks cloud publishers, academics, and more can scan files (pdf, doc, docx, ocr...), URLs and free text for plagiarism check.'
+  spec.homepage      = 'https://api.copyleaks.com'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/Copyleaks/Ruby-Plagiarism-Checker'
+  spec.metadata['changelog_uri'] = 'https://github.com/Copyleaks/Ruby-Plagiarism-Checker/releases'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:demo|test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

metadata

@@ -1,99 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: plagiarism-checker
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Copyleaks ltd
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: mimemagic
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2021-01-21 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
   before. With Copyleaks cloud publishers, academics, and more can scan files (pdf,
@@ -105,34 +21,61 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- copyleaks_api.gemspec
-- examples/main.rb
-- lib/copyleaks_api.rb
-- lib/copyleaks_api/access_token.rb
-- lib/copyleaks_api/api.rb
-- lib/copyleaks_api/config.rb
-- lib/copyleaks_api/copyleaks_cloud.rb
-- lib/copyleaks_api/copyleaks_process.rb
-- lib/copyleaks_api/errors.rb
-- lib/copyleaks_api/language.rb
-- lib/copyleaks_api/validators/custom_fields_validator.rb
-- lib/copyleaks_api/validators/email_validator.rb
-- lib/copyleaks_api/validators/file_validator.rb
-- lib/copyleaks_api/validators/language_validator.rb
-- lib/copyleaks_api/validators/response_validator.rb
-- lib/copyleaks_api/validators/url_validator.rb
-- lib/copyleaks_api/version.rb
+- lib/copyleaks/api.rb
+- lib/copyleaks/app.config.rb
+- lib/copyleaks/models/auth_token.rb
+- lib/copyleaks/models/delete_request_model.rb
+- lib/copyleaks/models/exceptions/auth_exipred_exception.rb
+- lib/copyleaks/models/exceptions/command_exception.rb
+- lib/copyleaks/models/exceptions/index.rb
+- lib/copyleaks/models/exceptions/rate_limit_exception.rb
+- lib/copyleaks/models/exceptions/under_maintenance_exception.rb
+- lib/copyleaks/models/exports/export_crawled_version.rb
+- lib/copyleaks/models/exports/export_model.rb
+- lib/copyleaks/models/exports/export_pdf_report.rb
+- lib/copyleaks/models/exports/export_results.rb
+- lib/copyleaks/models/exports/index.rb
+- lib/copyleaks/models/id_object.rb
+- lib/copyleaks/models/index.rb
+- lib/copyleaks/models/start_request_model.rb
+- lib/copyleaks/models/submissions/file_ocr_submission_model.rb
+- lib/copyleaks/models/submissions/file_submission_model.rb
+- lib/copyleaks/models/submissions/index.rb
+- lib/copyleaks/models/submissions/properties/actions.rb
+- lib/copyleaks/models/submissions/properties/author.rb
+- lib/copyleaks/models/submissions/properties/copyleaks_db.rb
+- lib/copyleaks/models/submissions/properties/domains_mode.rb
+- lib/copyleaks/models/submissions/properties/exclude.rb
+- lib/copyleaks/models/submissions/properties/filter.rb
+- lib/copyleaks/models/submissions/properties/index.rb
+- lib/copyleaks/models/submissions/properties/indexing.rb
+- lib/copyleaks/models/submissions/properties/pdf_properties.rb
+- lib/copyleaks/models/submissions/properties/repository.rb
+- lib/copyleaks/models/submissions/properties/scanning.rb
+- lib/copyleaks/models/submissions/properties/scanning_exclude.rb
+- lib/copyleaks/models/submissions/properties/scanning_repository.rb
+- lib/copyleaks/models/submissions/properties/sensitive_data_protection.rb
+- lib/copyleaks/models/submissions/properties/submission_properties.rb
+- lib/copyleaks/models/submissions/properties/webhooks.rb
+- lib/copyleaks/models/submissions/submission_model.rb
+- lib/copyleaks/models/submissions/url_submission_model.rb
+- lib/copyleaks/utils/status-code.utils.rb
+- lib/copyleaks/version.rb
+- lib/index.rb
+- plagiarism-checker.gemspec
 homepage: https://api.copyleaks.com
 licenses:
 - MIT
-metadata: {}
+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:
@@ -149,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: Detects plagiarism and checks content distribution online.

data/.rubocop.yml

@@ -1,2 +0,0 @@
-Metrics/LineLength:
-  Max: 120

data/copyleaks_api.gemspec

@@ -1,29 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'copyleaks_api/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "plagiarism-checker"
-  spec.version       = CopyleaksApi::VERSION
-  spec.authors       = ["Copyleaks ltd"]
-  spec.email         = ["sales@copyleaks.com"]
-
-  spec.summary       = %q{Detects plagiarism and checks content distribution online.}
-  spec.description   = %q{Copyleaks detects plagiarism and checks content distribution online. Use Copyleaks to find out if textual content is original and if it has been used before. With Copyleaks cloud publishers, academics, and more can scan files (pdf, doc, docx, ocr...), URLs and free text for plagiarism check.}
-  spec.homepage      = "https://api.copyleaks.com"
-  spec.license       = "MIT"
-  
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-
-  spec.add_runtime_dependency 'mimemagic'
-end

data/examples/main.rb

@@ -1,60 +0,0 @@
-require 'bundler/setup'
-require 'copyleaks_api'
-
-# firstly we need to create new Cloud entity
-email = '<YOUR-EMAIL>'
-api_key = '<YOUR-API-KEY>'
-cloud = CopyleaksApi::CopyleaksCloud.new(email, api_key, :publisher)
-
-# to check your balance just call balance
-
-puts "Your balance is #{cloud.balance} credits"
-
-# firstly we need to change work mode to sandbox
-
-CopyleaksApi::Config.sandbox_mode = true
-
-# now we can create new process by some url and custom callback
-process = cloud.create_by_url('http://exmaple.com', http_callback: 'http://requestb.in/')
-
-# Other scanning options
-# Text scan:
-#process = cloud.create_by_text("-Your text here-")
-
-# Textual file scan:
-#path = File.join(File.dirname(__FILE__), '..', 'spec', 'fixtures', 'files', 'lorem.txt')
-#process = cloud.create_by_file(path)
-
-# Ocr scan:
-#path = File.join(File.dirname(__FILE__), '..', 'spec', 'fixtures', 'files', 'lorem.jpg')
-#process = cloud.create_by_ocr(path, language: CopyleaksApi::Language.latin)
-
-puts "Now process has state '#{process.status}'"
-
-# to update process information we can just do this
-
-# process.reload
-
-# and it automatically call cloud.status with his id
-# it need some time to process your request so we need to wait
-
-while process.processing?
-  sleep(1)
-  process.reload
-end
-
-puts "And after sleep - #{process.status}"
-# to get our results from processing we can just call correspond method
-
-puts 'And its results are:'
-puts process.result.inspect
-
-# all results will be in array ow hashes with keys like Copyleaks API provides
-# to get list of all existing processes we can call list method
-
-processes = cloud.list
-puts "Overall you have #{processes.size} processes"
-
-# Delete finished process by PID:
-#PID = '00000000-0000-0000-0000-000000000000'
-#cloud.delete(PID)

data/lib/copyleaks_api.rb

@@ -1,23 +0,0 @@
-unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
-  $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
-end
-require 'copyleaks_api/version'
-
-require 'copyleaks_api/language'
-require 'copyleaks_api/errors'
-
-require 'copyleaks_api/validators/custom_fields_validator'
-require 'copyleaks_api/validators/email_validator'
-require 'copyleaks_api/validators/file_validator'
-require 'copyleaks_api/validators/response_validator'
-require 'copyleaks_api/validators/url_validator'
-require 'copyleaks_api/validators/language_validator'
-
-require 'copyleaks_api/copyleaks_cloud'
-require 'copyleaks_api/access_token'
-require 'copyleaks_api/api'
-require 'copyleaks_api/config'
-require 'copyleaks_api/copyleaks_process'
-
-module CopyleaksApi
-end

data/lib/copyleaks_api/access_token.rb

@@ -1,36 +0,0 @@
-require 'time'
-require 'json'
-
-module CopyleaksApi
-  class AccessToken
-    attr_reader :created_at, :expire_at
-
-    # constructor
-    def initialize(cloud, email, api_key)
-      @cloud = cloud
-      @email = email
-      @api_key = api_key
-      login
-    end
-
-    # predicate method to check if token is not expired
-    def fresh?
-      DateTime.now.new_offset(0) < @expire_at
-    end
-
-    # return token string
-    def token
-      return @token if fresh?
-      login
-    end
-
-    # get token for given email and api_key pair
-    def login
-      res = @cloud.api.post('account/login-api', { Email: @email, ApiKey: @api_key }.to_json)
-      @token = res['access_token']
-      @created_at = DateTime.parse(res['.issued'])
-      @expire_at = DateTime.parse(res['.expires'])
-      @token
-    end
-  end
-end

data/lib/copyleaks_api/api.rb

@@ -1,153 +0,0 @@
-require 'json'
-require 'net/http'
-require 'mimemagic'
-require 'mimemagic/overlay'
-require 'openssl'
-
-module CopyleaksApi
-  class Api
-    BASE_URL = 'https://api.copyleaks.com'.freeze
-    API_VERSION = 'v1'.freeze
-
-    # constructor
-    def initialize
-      uri = URI(BASE_URL)
-      @http = Net::HTTP.new(uri.host, uri.port)
-      @http.use_ssl = true
-      @http.verify_mode = ::OpenSSL::SSL::VERIFY_NONE
-    end
-
-    # make get request without any callback header
-    def get(path, options = {})
-      request = Net::HTTP::Get.new(request_uri(path))
-      make_request(request, options.merge(no_callbacks: true))
-    end
-
-    # make post request with given options
-    def post(path, body = nil, options = {})
-      request = Net::HTTP::Post.new(request_uri(path))
-      request.body = body
-      make_request(request, options)
-    end
-
-    # makes delete request without callbacks
-    def delete(path, options = {})
-      request = Net::HTTP::Delete.new(request_uri(path))
-      make_request(request, options.merge(no_callbacks: true))
-    end
-
-    # makes post request with file inside
-    def post_file(path, file_path, options = {})
-      request = Net::HTTP::Post.new(request_uri(path))
-      options[:partial_scan] ||= CopyleaksApi::Config.allow_partial_scan
-      boundary = "copyleaks_sdk_#{SecureRandom.hex(4)}"
-      request.body = file_body(file_path, boundary)
-      make_request(request, options.merge(boundary: boundary))
-    end
-
-    private
-
-    # extracts mime type of given file
-    def extract_mime_type(path)
-      mime = MimeMagic.by_magic(File.open(path))
-      mime ? mime.type : 'text/plain'
-    end
-
-    # prepares post body with file inside
-    def file_body(path, boundary)
-      [
-        "\r\n--#{boundary}\r\n",
-        "content-disposition: form-data; name=\"file\"",
-        "; filename=\"#{File.basename(path)}\"\r\n",
-        "Content-Type: #{extract_mime_type(path)}\r\n",
-        "Content-Transfer-Encoding: binary\r\n",
-        "\r\n",
-        File.open(path, 'rb') { |io| io.read },
-        "\r\n--#{boundary}--\r\n"
-      ].join('')
-    end
-
-    # gather all API path
-    def request_uri(path)
-      "/#{API_VERSION}/#{path}"
-    end
-
-    # gather headers, makes request and do validation
-    def make_request(request, options)
-      gather_headers(request, options)
-      response = @http.request(request)
-      Validators::ResponseValidator.validate!(response)
-      JSON.parse(response.body)
-    end
-
-    # gather all headers
-    def gather_headers(request, options)
-      [
-        http_callbacks_header(options),
-        email_callback_header(options),
-        authentication_header(options),
-        sandbox_header,
-        content_type_header(options),
-        partial_scan_header(options),
-        'User-Agent' => "RUBYSDK/#{CopyleaksApi::VERSION}"
-      ].reduce({}, :merge).each do |header, value|
-        request[header] = value
-      end
-    end
-
-    # prepares header for sandbox mode
-    def sandbox_header
-      return {} unless Config.sandbox_mode
-      { 'copyleaks-sandbox-mode' => '' }
-    end
-
-    # prepares header for content type
-    def content_type_header(options)
-      { 'Content-Type' => options[:boundary] ? "multipart/form-data; boundary=\"#{options[:boundary]}\"" :
-                                               'application/json' }
-    end
-
-    # prepares header for partial scan
-    def partial_scan_header(options)
-      return {} unless !options[:allow_partial_scan].nil? && options[:allow_partial_scan] || Config.allow_partial_scan
-      { 'copyleaks-allow-partial-scan' => '' }
-    end
-
-    # prepares authentication header
-    def authentication_header(options)
-      return {} unless options[:token]
-      { 'Authorization' => "Bearer #{options[:token]}" }
-    end
-
-    # prepare header for http callback
-    def http_callbacks_header(options)
-      return {} if options[:no_http_callback] || options[:no_callbacks]
-      value = options[:http_callback] || CopyleaksApi::Config.http_callback
-      return {} unless value
-      Validators::UrlValidator.validate!(value)
-      { 'copyleaks-http-callback' => value }
-    end
-
-    # prepares header for email callback
-    def email_callback_header(options)
-      return {} if options[:no_email_callback] || options[:no_callbacks]
-      value = options[:email_callback] || CopyleaksApi::Config.email_callback
-      return {} unless value
-      Validators::EmailValidator.validate!(value)
-      { 'copyleaks-email-callback' => value }
-    end
-
-    # prepares headers with custom fields
-    def custom_field_headers(options)
-      return {} if options[:no_custom_fields]
-      value = CopyleaksApi::Config.custom_fields.merge(options[:custom_fields] || {})
-      Validators::CustomFieldsValidator.validate!(value)
-      prepare_custom_fields(value)
-    end
-
-    # prepares custom fields before transformation into headers
-    def prepare_custom_fields(fields)
-      fields.each_with_object({}) { |e, o| o["copyleaks-client-custom-#{e[0]}"] = e[1] }
-    end
-  end
-end