plagiarism-checker 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62f540b75e8fce69177d645e6c1b0b0c0b081c54
-  data.tar.gz: 7cddcf56deb0f2a66bf2af731e7f72ae4c3ce906
+  metadata.gz: a856007784b1580e5c8ca554fc9a22ad847f854e
+  data.tar.gz: 7b3342e7458536584f404273815d4407c01fc31a
 SHA512:
-  metadata.gz: 93cd5f553fa669824c0cda767f14536e0e78724e9e9d7eb4eb53a41b8e9091f01f9a8cb7d76ef91edf97ad7343cc03662ebee66920afb7a1aafcdc32c562ca52
-  data.tar.gz: c679d5ecf82865dd8c627e1d84bcdab6f0abca6acd7cca1910b13ccb280bd7dd03f76be04d965e3f9f246966b0cf973d7b6e0aa249f9378d152b9deab8cd4d72
+  metadata.gz: 9262172bde5a793f4edf4cbe615520c5a23737cfd410fc364aaca2ed3da7cdee1c916b656133e240151e1a090ff7c47992d0654c8260f4b21c2ab80597ae1bbd
+  data.tar.gz: b082d51155d016a2a223f784ccdf80b928eb9c8803a62c9da020f7128d0ec663d68a9a348b1cf298c49bbb23baf692b1afcbc1922ee7a83f7a3f54c9f8650ae2

data/.rubocop.yml

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

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in copyleaks_api.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in copyleaks_api.gemspec
+gemspec

data/LICENSE.txt

@@ -1,21 +1,21 @@
-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.
+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.

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -1,7 +1,7 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'copyleaks_api'
-
-require 'irb'
-IRB.start
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'copyleaks_api'
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example_async.rb

@@ -0,0 +1,50 @@
+# 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/{PID}'
+# 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/{PID}'
+#    config.in_progress_result = 'http://yoursite.here/callback/results/{PID}'
+#    config.email_callback = 'your@email.com'
+#    config.custom_fields = { some_field: 'and its value' }
+#    config.compare_only = true  # Only while using create-by-files
+#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_syncronized.rb

@@ -0,0 +1,73 @@
+# 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
+#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

@@ -3,9 +3,10 @@ unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
 end
 require 'copyleaks_api/version'
 
-require 'copyleaks_api/language'
 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'

data/lib/copyleaks_api/Models/ResultRecord.rb

@@ -0,0 +1,58 @@
+module CopyleaksApi
+  class ResultRecord
+    def initialize(response)
+      @URL = response['URL']
+      @Percents = response['Percents']
+      @NumberOfCopiedWords = response['NumberOfCopiedWords']
+      @CachedVersion = response['CachedVersion']
+      @Title = response['Title']
+      @Introduction = response['Introduction']
+      @ComparisonReport = response['ComparisonReport']
+      @EmbededComparison = response['EmbededComparison']
+    end
+    
+    def get_url
+      @URL
+    end
+    
+    def get_percents
+      @Percents
+    end
+    
+    def get_number_of_copied_words
+      @NumberOfCopiedWords
+    end
+    
+    def get_cached_version
+      @CachedVersion
+    end
+
+    def get_title
+      @Title
+    end
+
+    def get_introduction
+      @Introduction
+    end
+    
+    def get_comparison_report
+      @ComparisonReport
+    end
+    
+    def get_embeded_comparison
+      @EmbededComparison
+    end
+    
+    def to_s
+      puts "----------------------------------------------------------------"
+      puts "Title: #{@Title}"
+      puts "Introduction: #{@Introduction}"
+      puts "Url: #{@URL}"
+      puts "Percents: #{@Percents}%"
+      puts "NumberOfCopiedWords: #{@NumberOfCopiedWords}"
+      puts "CachedVersion: #{@CachedVersion}"
+      puts "ComparisonReport: #{@ComparisonReport}"
+      puts "EmbededComparison: #{@EmbededComparison}"
+    end
+  end
+end

data/lib/copyleaks_api/api.rb

@@ -3,12 +3,15 @@ require 'net/http'
 require 'mimemagic'
 require 'mimemagic/overlay'
 require 'openssl'
+require 'securerandom'
+
 
 module CopyleaksApi
   class Api
     BASE_URL = 'https://api.copyleaks.com'.freeze
-    API_VERSION = 'v1'.freeze
-
+    API_VERSION_V1 = 'v1'.freeze
+    API_VERSION_V2 = 'v2'.freeze
+  
     # constructor
     def initialize
       uri = URI(BASE_URL)
@@ -23,6 +26,12 @@ module CopyleaksApi
       make_request(request, options.merge(no_callbacks: true))
     end
 
+    # make get request without any callback header
+    def get_with_final_path(path, options = {})
+      request = Net::HTTP::Get.new(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))
@@ -45,6 +54,15 @@ module CopyleaksApi
       make_request(request, options.merge(boundary: boundary))
     end
 
+    # makes post request with file inside
+    def post_files(path, files_paths, options = {})
+      request = Net::HTTP::Post.new(request_uri(path, api_version: API_VERSION_V2))
+      options[:partial_scan] ||= CopyleaksApi::Config.allow_partial_scan
+      options[:compare_only] ||= CopyleaksApi::Config.compare_only
+      boundary = "copyleaks_sdk_#{SecureRandom.hex(4)}"
+      request.body = files_body(files_paths, boundary)
+      make_request(request, options.merge(boundary: boundary))
+    end
     private
 
     # extracts mime type of given file
@@ -66,10 +84,28 @@ module CopyleaksApi
         "\r\n--#{boundary}--\r\n"
       ].join('')
     end
+    
+        # prepares post body with file inside
+    def files_body(paths, boundary)
+      body = "\r\n--#{boundary}\r\n"
+      counter = 1
+      paths.each do |path|
+        body += "content-disposition: form-data; name=\"file_#{counter}\"" +
+                "; 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"
+        counter += 1
+      end
+      body += "\r\n--#{boundary}--\r\n"
+      body
+    end
 
     # gather all API path
-    def request_uri(path)
-      "/#{API_VERSION}/#{path}"
+    def request_uri(path, api_version: API_VERSION_V1)
+      "/#{api_version}/#{path}"
     end
 
     # gather headers, makes request and do validation
@@ -77,7 +113,11 @@ module CopyleaksApi
       gather_headers(request, options)
       response = @http.request(request)
       Validators::ResponseValidator.validate!(response)
-      JSON.parse(response.body)
+      if not options.key?(:parse_json) or options[:parse_json]
+        JSON.parse(response.body)
+      else
+        response.body
+      end
     end
 
     # gather all headers
@@ -87,6 +127,8 @@ module CopyleaksApi
         email_callback_header(options),
         authentication_header(options),
         sandbox_header,
+        compare_only_header,
+        in_progress_result(options),
         content_type_header(options),
         partial_scan_header(options),
         'User-Agent' => "RUBYSDK/#{CopyleaksApi::VERSION}"
@@ -100,7 +142,21 @@ module CopyleaksApi
       return {} unless Config.sandbox_mode
       { 'copyleaks-sandbox-mode' => '' }
     end
-
+    
+    # Compare your files against each other only
+    def compare_only_header
+      return {} unless Config.compare_only
+      { 'copyleaks-compare-documents-for-similarity' => '' }
+    end
+    
+    # Receive callback every time we find a new result without waiting for completion
+    def in_progress_result(options)
+      return {} if options[:no_http_callback] || options[:no_callbacks]
+      value = options[:in_progress_result] || CopyleaksApi::Config.in_progress_result
+      return {} unless value
+      Validators::UrlValidator.validate!(value)
+      { 'copyleaks-in-progress-new-result' => value }
+    end
     # prepares header for content type
     def content_type_header(options)
       { 'Content-Type' => options[:boundary] ? "multipart/form-data; boundary=\"#{options[:boundary]}\"" :
@@ -125,7 +181,7 @@ module CopyleaksApi
       value = options[:http_callback] || CopyleaksApi::Config.http_callback
       return {} unless value
       Validators::UrlValidator.validate!(value)
-      { 'copyleaks-http-callback' => value }
+      { 'copyleaks-http-completion-callback' => value }
     end
 
     # prepares header for email callback
@@ -137,6 +193,7 @@ module CopyleaksApi
       { 'copyleaks-email-callback' => value }
     end
 
+    
     # prepares headers with custom fields
     def custom_field_headers(options)
       return {} if options[:no_custom_fields]

data/lib/copyleaks_api/config.rb

@@ -6,10 +6,12 @@ module CopyleaksApi
       http_callback: nil,
       email_callback: nil,
       custom_fields: {},
+      compare_only: false,
+      in_progress_result: nil,
     }.freeze
 
     class << self
-      attr_writer :sandbox_mode, :http_callback, :email_callback, :custom_fields, :allow_partial_scan
+      attr_writer :sandbox_mode, :compare_only, :http_callback, :email_callback, :custom_fields, :allow_partial_scan, :in_progress_result
 
       DEFAULTS.each do |attr, value|
         # getters for all options

data/lib/copyleaks_api/copyleaks_cloud.rb

@@ -1,12 +1,13 @@
 require 'copyleaks_api/errors'
 require 'copyleaks_api/api'
 
+
 module CopyleaksApi
   class CopyleaksCloud
-    ALLOWED_ENDPOINTS = [:publisher, :academic]
+    ALLOWED_ENDPOINTS = [:businesses, :education, :websites]
     attr_accessor :access_token
     attr_reader :endpoint_type
-
+    
     # constructor
     def initialize(email, api_key, type)
       raise ArgumentError, "Endpoint type '#{type}' is invalid" unless ALLOWED_ENDPOINTS.include?(type.to_sym)
@@ -19,63 +20,76 @@ module CopyleaksApi
     end
 
     # returns account balance from endpoint
-    def balance
+    def get_credits_balance
 	    api.get(url('count-credits'), token: @access_token.token)['Amount'].to_i
     end
 
     # uses create-by-url endpoint to create process
     def create_by_url(url, options = {})
       response = api.post(url('create-by-url'), { 'Url' => url }.to_json, options.merge(token: @access_token.token))
-      CopyleaksProcess.create(self, response)
+      CopyleaksProcess.create(self, api, response)
     end
 
     # uses create-by-file endpoint to create process
     def create_by_file(file_path, options = {})
       response = api.post_file(url('create-by-file'), file_path, options.merge(token: @access_token.token))
-      CopyleaksProcess.create(self, response)
+      CopyleaksProcess.create(self, api, response)
+    end
+
+    # uses create-by-file endpoint to create process
+    def create_by_files(files_paths, options = {})
+      response = api.post_files(url('create-by-file'), files_paths, options.merge(token: @access_token.token))
+      success_uploads = response['Success']
+      processes = []
+      success_uploads.each do |upload|
+        processes.push(CopyleaksProcess.create(self, api, upload))
+      end
+      processes
     end
 
     # uses create-by-file-ocr endpoint to create process
     def create_by_ocr(ocr_file_path, options = {})
       response = api.post_file(url_with_language('create-by-file-ocr', options), ocr_file_path,
                                options.merge(token: @access_token.token))
-      CopyleaksProcess.create(self, response)
+      CopyleaksProcess.create(self, api, response)
     end
 
     # uses create-by-text endpoint to create process
     def create_by_text(text, options = {})
       response = api.post(url('create-by-text'), text, options.merge(token: @access_token.token))
-      CopyleaksProcess.create(self, response)
-    end
-
-    # deletes process by given id
-    def delete(id)
-      api.delete(url(:delete, id), token: @access_token.token)
-      true
+      CopyleaksProcess.create(self, api, response)
     end
 
-    # retries all processes
-    def list
+    # Returns a list of your past processes
+    def get_processes
       response = api.get(url(:list), token: @access_token.token)
-      response.map { |hash| CopyleaksProcess.create_from_list(self, hash) }
+      response.map { |hash| CopyleaksProcess.create_from_list(self, @api, hash) }
     end
-
-    # retries status information of process with given id
-    def status(id, options = {})
-      response = api.get(url(:status, id), no_callbacks: true, token: @access_token.token)
-      return response if options[:raw]
-      CopyleaksApi::CopyleaksProcess.create_from_status(self, id, response)
+    
+    # Returns the raw text of a given result
+    def get_raw_text(result)
+      response = api.get_with_final_path(result.get_cached_version, parse_json: false, token: @access_token.token)
+      response
     end
 
-    # retries result information of process with given id
-    def result(id, options = {})
-      response = api.get(url(:result, id), no_callbacks: true, token: @access_token.token)
-      return response if options[:raw]
-      CopyleaksApi::CopyleaksProcess.create_from_result(self, id, response)
+    # Returns the raw text of a given result
+    def get_comparison_report(result)
+      response = api.get_with_final_path(result.get_comparison_report, token: @access_token.token)
+      response
     end
-
-    private
-
+    
+    # Returns a list of currently supported languages for ocr 
+    def get_ocr_languages
+      response = api.get(url_misc('ocr-languages-list'))
+      response
+    end
+    
+    # Returns a list of currently supported file types
+    def get_supported_file_types
+      response = api.get(url_misc('supported-file-types'))
+      response
+    end
+    
     # gather url for endpoints which need language in get parameters
     def url_with_language(action, options)
       language = options[:language] || Language.english
@@ -88,5 +102,15 @@ module CopyleaksApi
       return "#{@endpoint_type}/#{action}" if id.nil?
       "#{@endpoint_type}/#{id}/#{action}"
     end
+    
+    # gather path for download endpoint
+    def url_downloads(action, id = nil)
+      return "downloads/#{action}"
+    end
+    
+    # gather path for download endpoint
+    def url_misc(action, id = nil)
+      return "miscellaneous/#{action}"
+    end
   end
 end

data/lib/copyleaks_api/copyleaks_process.rb

@@ -1,81 +1,77 @@
 require 'time'
+require 'copyleaks_api/Models/ResultRecord'
+
 
 module CopyleaksApi
   class CopyleaksProcess
-    STATUSES = ['processing', 'ready', 'allocated', 'finished', 'error', 'deleted'].freeze
-
-    attr_accessor :status, :process_id, :status, :progress, :custom_fields, :created_at
+    attr_accessor :process_id, :progress, :custom_fields, :created_at
 
     # constructor
     def initialize(options)
       @cloud = options[:cloud]
-      [:cloud, :process_id, :custom_fields, :result, :status, :progress].each do |attr|
+      [: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]
-      @status = STATUSES[options[:status_code].to_i + 1] if options[:status_code]
     end
-
-    STATUSES[1..-1].each do |status|
-      # predicate methods for all statuses
-      define_method("#{status}?") do
-        reload if @status.nil?
-        @status == status
-      end
+    
+    def to_s
+      return "Created at: #{@created_at}"
     end
 
-    # returns true if process status means processing data on server side
+    # returns true if still processing data on server side
     def processing?
-      ['ready', 'allocated', 'processing'].include?(@status)
+      if @progress == 100
+        false
+      else
+        true
+      end
     end
 
     # return result data or retrieves from result endpoint if nothing specified
-    def result
-      @result ||= @cloud.result(process_id, raw: true)
+    # 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 status information or reload if no data is specified
-    def status
-      reload if @status.nil?
-      @status
+    # 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
-      @cloud.delete(process_id)
-      @status = 'deleted'
-    end
-
-    # reload object attributes using status endpoint
-    def reload
-      response = @cloud.status(process_id, raw: true)
-      @status = response['Status'].downcase
-      @progress = response['ProgressPercents'].to_i
-      @result = nil
-      self
+      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, hash)
-        new(cloud: cloud, process_id: hash['ProcessId'], created_at: hash['CreationTimeUTC'])
+      def create(cloud, api, hash)
+        new(cloud: cloud, api: api, process_id: hash['ProcessId'], created_at: hash['CreationTimeUTC'])
       end
-
-      # create CopyleaksProcess based on data got from status endpoint
-      def create_from_status(cloud, id, hash)
-        new(cloud: cloud, process_id: id, status: hash['Status'].downcase, progress: hash['ProgressPercents'])
-      end
-
-      # creates CopyleaksProcess based on data got from result endpoint
-      def create_from_result(cloud, id, result)
-        new(cloud: cloud, process_id: id, result: result)
-      end
-
+    
       # creates CopyleaksProcess based on data got from list endpoint
-      def create_from_list(cloud, hash)
-        new(cloud: cloud, process_id: hash['ProcessId'], created_at: hash['CreationTimeUTC'],
-            status: hash['Status'].downcase, custom_fields: hash['CustomFields'])
+      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

data/lib/copyleaks_api/version.rb

@@ -1,3 +1,3 @@
-module CopyleaksApi
-  VERSION = '1.0.0'.freeze
-end
+module CopyleaksApi
+  VERSION = '2.0.0'.freeze
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plagiarism-checker
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Copyleaks ltd
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2017-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
@@ -113,15 +113,16 @@ files:
 - bin/console
 - bin/setup
 - copyleaks_api.gemspec
-- examples/main.rb
+- example_async.rb
+- example_syncronized.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/language.rb
 - lib/copyleaks_api/validators/custom_fields_validator.rb
 - lib/copyleaks_api/validators/email_validator.rb
 - lib/copyleaks_api/validators/file_validator.rb
@@ -149,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Detects plagiarism and checks content distribution online.

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/language.rb

@@ -1,61 +0,0 @@
-module CopyleaksApi
-  module Language
-    ALLOWED = ['Afrikaans',
-               'Albanian',
-               'Basque',
-               'Brazilian',
-               'Bulgarian',
-               'Byelorussian',
-               'Catalan',
-               'Chinese_Simplified',
-               'Chinese_Traditional',
-               'Croatian',
-               'Czech',
-               'Danish',
-               'Dutch',
-               'English',
-               'Esperanto',
-               'Estonian',
-               'Finnish',
-               'French',
-               'Galician',
-               'German',
-               'Greek',
-               'Hungarian',
-               'Icelandic',
-               'Indonesian',
-               'Italian',
-               'Japanese',
-               'Korean',
-               'Latin',
-               'Latvian',
-               'Lithuanian',
-               'Macedonian',
-               'Malay',
-               'Moldavian',
-               'Norwegian',
-               'Polish',
-               'Portuguese',
-               'Romanian',
-               'Russian',
-               'Serbian',
-               'Slovak',
-               'Slovenian',
-               'Spanish',
-               'Swedish',
-               'Tagalog',
-               'Turkish',
-               'Ukrainian'].freeze
-
-    ALLOWED.each_with_index do |lang, index|
-      method = lang.downcase
-
-      # returns appropriate language name based on method name
-      define_method(method) do
-        ALLOWED[index]
-      end
-
-      module_function method
-    end
-  end
-end