plagiarism-checker 2.1.2 → 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: 2.1.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Copyleaks ltd
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-12 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,35 +21,61 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- copyleaks_api.gemspec
-- example_asynchronous.rb
-- example_synchronous.rb
-- lib/copyleaks_api.rb
-- lib/copyleaks_api/Models/ResultRecord.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/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:
@@ -150,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+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/example_asynchronous.rb

@@ -1,51 +0,0 @@
-# Import the module
-require_relative './lib/copyleaks_api'
-# If you installed this library using gem install use this import
-#require 'copyleaks_api'
-
-# In order to use this API you need to register to Copyleaks at https://copyleaks.com/account/register
-# Login using your account email and account key provided at api.copyleaks.com dashboards.
-email = "<--YOUR-EMAIL-->"
-api_key = "<--API-KEY-->"
-# There are currently 3 available products - :businesses, :education, :websites
-cloud = CopyleaksApi::CopyleaksCloud.new(email, api_key, :businesses)
-
-# Check your account balance
-puts "You have #{cloud.get_credits_balance} credits"
-
-# Process Configuration
-CopyleaksApi::Config.sandbox_mode = true  # Sandbox mode will not consume any credits while returning dummy results
-CopyleaksApi::Config.http_callback = 'http://yoursite.here/callback/completion/'
-# For testing purposes you can use http://requestb.in
-
-#CopyleaksApi::Config
-# For more information: https://api.copyleaks.com/GeneralDocumentation/RequestHeaders
-# Available configuration options:
-#CopyleaksApi::Config do |config|
-#    config.sanbox_mode = true
-#    config.allow_partial_scan = true
-#    config.http_callback = 'http://yoursite.here/callback/completion/'
-#    config.in_progress_result = 'http://yoursite.here/callback/results/'
-#    config.email_callback = 'your@email.com'
-#    config.custom_fields = { some_field: 'and its value' }
-#    config.compare_only = true  # Only while using create-by-files
-#    config.import_to_database_only = true  # To only upload your file to our database, will not consume any credits.
-#end
-
-
-# Create a process using one of the optional methods
-# Available methods: create_by_url, create_by_text, create_by_file, create_by_files and create_by_ocr.
-# For more information see our documentation on http://api.copyleaks.com/
-begin
-  process = cloud.create_by_url("https://microsoft.com/")
-  #process = cloud.create_by_text("THE TEXT YOU WISH TO SCAN")
-  #process = cloud.create_by_file(path_to_file)
-  #processes = cloud.create_by_files(files_paths)
-  #process = cloud.create_by_ocr(path_to_image, language: 'en') # Requires the language of the text.
-                                                                # Use cloud.get_ocr_languages to get the supported langauges.
-                                                                # or take a look at this page: https://api.copyleaks.com/GeneralDocumentation/OcrLanguagesList
-  
-  puts "Your scan(#{process.process_id}) was created successfully. We will trigger the callback soon."
-rescue Exception => ex
-  puts "Failed to create new process with exception: #{ex}"
-end

data/example_synchronous.rb

@@ -1,74 +0,0 @@
-# Import the module
-require_relative './lib/copyleaks_api'
-# If you installed this library using gem install use this import
-#require 'copyleaks_api'
-
-# In order to use this API you need to register to Copyleaks at https://copyleaks.com/account/register
-# Login using your account email and account key provided at api.copyleaks.com dashboards.
-email = "<--YOUR-EMAIL-->"
-api_key = "<--API-KEY-->"
-# There are currently 3 available products - :businesses, :education, :websites
-cloud = CopyleaksApi::CopyleaksCloud.new(email, api_key, :businesses)
-
-# Check your account balance
-puts "You have #{cloud.get_credits_balance} credits"
-
-# Process Configuration
-CopyleaksApi::Config.sandbox_mode = true  # Sandbox mode will not consume any credits while returning fake results
-#CopyleaksApi::Config
-# For more information: https://api.copyleaks.com/GeneralDocumentation/RequestHeaders
-# Available configuration options:
-#CopyleaksApi::Config do |config|
-#    config.sanbox_mode = true
-#    config.allow_partial_scan = true
-#    config.http_callback = 'http://yoursite.here'
-#    config.in_progress_result = 'http://yoursite.here'
-#    config.email_callback = 'your@email.com'
-#    config.custom_fields = { some_field: 'and its value' }
-#    config.compare_only = true  # Only while using create-by-files
-#    config.import_to_database_only = true  # To only upload your file to our database, will not consume any credits.
-#end
-
-
-# Create a process using one of the optional methods
-# Available methods: create_by_url, create_by_text, create_by_file, create_by_files and create_by_ocr.
-# For more information see our documentation on http://api.copyleaks.com/
-process = cloud.create_by_url("https://copyleaks.com/")
-#process = cloud.create_by_text("THE TEXT YOU WISH TO SCAN")
-#process = cloud.create_by_file(path_to_file)
-#processes = cloud.create_by_files(files_paths)
-#process = cloud.create_by_ocr(path_to_image, language: 'en') # Requires the language of the text.
-                                                              # Use cloud.get_ocr_languages to get the supported langauges.
-                                                              # or take a look at this page: https://api.copyleaks.com/GeneralDocumentation/OcrLanguagesList
-  
-puts "Processing Started"
-
-# Now we will check the status of the process until its done
-# **We highly recommend to use the http_callback option at the config in order to get a callback once the process is finished**
-# For more info visit: https://api.copyleaks.com/GeneralDocumentation/RequestHeaders
-while process.processing?
-    sleep(1)
-    process.update_status
-    puts "#"*(process.progress/2) + "-"*(50 - process.progress/2) + "#{process.progress}%"
-end
-
-puts "Processing Ended"
-# to get our results from processing we can just call correspond method
-results = process.get_results
-
-puts "#{results.size} Results: "
-results.each do |res|
-  #puts cloud.get_comparison_report(res)
-  #puts cloud.get_raw_text(res)
-  puts res.to_s
-end
-
-# Delete the created process
-#puts process.delete
-
-# In order to get all your past processes
-#processes = cloud.get_processes
-#puts "Overall you have #{processes.size} processes"
-#processes.each do |res|
-#  puts res.to_s
-#end

data/lib/copyleaks_api.rb

@@ -1,24 +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/errors'
-
-require 'copyleaks_api/Models/ResultRecord'
-
-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