plagiarism-checker 2.1.1 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d505c3202beab2a3fb6b94e7d1ba33e11563f3ec
-  data.tar.gz: 650078b90aed95d6fe05b703cb689f3abdeb7d9f
+  metadata.gz: 5eeda449435806ae47b6544d1dbaeea4e1ba2c1a
+  data.tar.gz: 9113ca6c2a957bc9ea77b78bb0ceacc9d25b5175
 SHA512:
-  metadata.gz: 72633294ef59a7cca317fa774608a9e19887a5bf9e608de4499ffa9730ae9efe04a8707d1812b6c8b40407061d28c382b52deeaf70569ebdb5faaba033fd5fd2
-  data.tar.gz: b548cefb5cf621e19b1593c78fbd14ce525aa50475bdbe682cf0433fa802871bda5325642a49e03facc30e75089f1961456d82d4e43eef71e159e8b373e5c452
+  metadata.gz: 9b1eddf67d1cb5e968f9744ec3983d71738338b1cb76daad9372cb9eed4ef60a1deb0b33d684acc8acce64afc9a457103b4c661d5518462fd9b69d89997f6c90
+  data.tar.gz: 39186d50e55031ede5d249409030bfc7b2815363bd72c7d9a4b886a4e51bcc197a9dc9286a7b87a7e6735fdbbdc46587fe92155cad536b6286678cb2529971f0

data/.gitignore

@@ -1,12 +1,8 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-.idea
-/README.md
-/examples/test.rb
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in copyleaks_api.gemspec
-gemspec
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in plagiarism-checker.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/README.md

@@ -0,0 +1,39 @@
+# Copyleaks Ruby SDK
+
+Copyleaks SDK is a simple framework that allows you to scan text for plagiarism and detect content distribution online, using the Copyleaks plagiarism checker cloud.
+
+Using Copyleaks SDK you can check for plagiarism in:
+* Online content and webpages
+* Local and cloud files (see [supported files](https://api.copyleaks.com/documentation/specifications#2-supported-file-types))
+* Free text
+* OCR (Optical Character Recognition) - scanning pictures with textual content (see [supported files](https://api.copyleaks.com/documentation/specifications#6-supported-image-types-ocr))
+
+## Installation
+
+Install using [RubyGems](https://rubygems.org/gems/plagiarism-checker)
+
+```bash
+gem install plagiarism-checker
+```
+
+## Register and Get Your API Key
+To use the Copyleaks API you need to first be a registered user. The registration to Copyleaks takes a minute and is free of charge. [Signup](https://api.copyleaks.com/?register=true) and make sure to confirm your account.
+
+As a signed user you can generate your personal API key. Do so on your [dashboard home](https://api.copyleaks.com/dashboard/:product) under 'API Access Credentials'.
+
+For more information check out our [API guide](https://api.copyleaks.com/documentation/v3).
+
+## Usage
+```rb
+require 'copyleaks'
+copyleaks = Copyleaks::API.new
+res = copyleaks.login(<your email>,<your api key>)
+puts res.to_json
+```
+
+## Demo
+See [demo.rb](./demo/demo.rb) under demo folder for an example.
+## Read More
+* [API Homepage](https://api.copyleaks.com/)
+* [API Documentation](https://api.copyleaks.com/documentation)
+* [Plagiarism Report](https://github.com/Copyleaks/plagiarism-report)

data/Rakefile

@@ -1,2 +1,4 @@
-require "bundler/gem_tasks"
-task :default => :spec
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: %i[]

data/bin/console

@@ -1,7 +1,15 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
-require 'copyleaks_api'
+require 'copyleaks'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
 
 require 'irb'
-IRB.start
+IRB.start(__FILE__)

data/lib/copyleaks.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/lib/copyleaks/api.rb

@@ -0,0 +1,493 @@
+#
+#  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.
+# =
+require 'net/http'
+require 'json'
+require 'date'
+
+module Copyleaks
+  class API
+    def initialize
+      # copyleaks identity http client
+      _identity_server_uri = URI.parse(Config.identity_server_uri)
+      @id_client = Net::HTTP.new(_identity_server_uri.host, _identity_server_uri.port)
+      @id_client.use_ssl = true
+      # copyleaks api http client
+      _api_server_uri = URI.parse(Config.api_server_uri)
+      @api_client = Net::HTTP.new(_api_server_uri.host, _api_server_uri.port)
+      @api_client.use_ssl = true
+    end
+
+    # Login to Copyleaks authentication server.
+    # For more info: https://api.copyleaks.com/documentation/v3/account/login.
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code, headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance. We recommend to implement exponential backoff algorithm as described here: https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # @param [String] email Copyleaks account email address.
+    # @param [String] key Copyleaks account secret key.
+    # @return A authentication token that being expired after certain amount of time.
+    def login(email, key)
+      raise 'email is Invalid, must be instance of String' if email.nil? || !email.instance_of?(String)
+      raise 'key is Invalid, must be instance of String' if key.nil? || !email.instance_of?(String)
+
+      path = '/v3/account/login/api'
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent
+      }
+
+      payload = { email: email, key: key }
+
+      request = Net::HTTP::Post.new(path, headers)
+      request.body = payload.to_json
+
+      res_data = handle_response(@id_client.request(request), 'login')
+
+      CopyleaksAuthToken.new(res_data['.expires'], res_data['access_token'], res_data['.issued'])
+    end
+
+    # Verify that Copyleaks authentication token is exists and not exipired.
+    # * Exceptions:
+    # * * AuthExipredException: authentication expired. Need to login again.
+    # @param [CopyleaksAuthToken] authToken Copyleaks authentication token
+    def verify_auth_token(authToken)
+      if authToken.nil? || !authToken.instance_of?(CopyleaksAuthToken)
+        raise 'authToken is Invalid, must be instance of CopyleaksAuthToken'
+      end
+
+      _time = DateTime.now
+      _expiresTime = DateTime.parse(authToken.expires)
+
+      if _expiresTime <= _time
+        raise AuthExipredException.new.reason # expired
+      end
+    end
+
+
+    # Starting a new process by providing a file to scan.
+    # For more info:
+    # https://api.copyleaks.com/documentation/v3/education/submit/file
+    # https://api.copyleaks.com/documentation/v3/businesses/submit/file
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # @param [String] product Which product (education or businesses) is being use.
+    # @param [CopyleaksAuthToken] authToken Copyleaks authentication token
+    # @param [String] scanId Attach your own scan Id
+    # @param [CopyleaksFileSubmissionModel] submission Submission properties
+    def submit_file(product, authToken, scanId, submission)
+      raise 'scanId is Invalid, must be instance of String' if scanId.nil? || !scanId.instance_of?(String)
+      if submission.nil? || !submission.instance_of?(CopyleaksFileSubmissionModel)
+        raise 'submission is Invalid, must be instance of type CopyleaksFileSubmissionModel'
+      end
+
+      validate_product(product)
+      verify_auth_token(authToken)
+
+      path = "/v3/#{product}/submit/file/#{scanId}"
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent,
+        'Authorization' => "Bearer #{authToken.accessToken}"
+      }
+
+      request = Net::HTTP::Put.new(path, headers)
+      request.body = submission.to_json
+
+      handle_response(@api_client.request(request), 'submit_file')
+    end
+
+    # Starting a new process by providing a OCR image file to scan.
+    # For more info:
+    # https://api.copyleaks.com/documentation/v3/education/submit/ocr
+    # https://api.copyleaks.com/documentation/v3/businesses/submit/ocr
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # @param [String] product Which product (education or businesses) is being use.
+    # @param [CopyleaksAuthToken] authToken Copyleaks authentication token
+    # @param [String] scanId Attach your own scan Id
+    # @param [CopyleaksFileOcrSubmissionModel] submission Submission properties
+    def submit_file_ocr(product, authToken, scanId, submission)
+      raise 'scanId is Invalid, must be instance of String' if scanId.nil? || !scanId.instance_of?(String)
+      if submission.nil? || !submission.instance_of?(CopyleaksFileOcrSubmissionModel)
+        raise 'submission is Invalid, must be instance of type CopyleaksFileOcrSubmissionModel'
+      end
+
+      validate_product(product)
+      verify_auth_token(authToken)
+
+      path = "/v3/#{product}/submit/ocr/#{scanId}"
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent,
+        'Authorization' => "Bearer #{authToken.accessToken}"
+      }
+
+      request = Net::HTTP::Put.new(path, headers)
+      request.body = submission.to_json
+
+      handle_response(@api_client.request(request), 'submit_file_ocr')
+    end
+
+    # Starting a new process by providing a URL to scan.
+    # For more info:
+    # https://api.copyleaks.com/documentation/v3/education/submit/url
+    # https://api.copyleaks.com/documentation/v3/businesses/submit/url
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # @param [String] product Which product (education or businesses) is being use.
+    # @param [CopyleaksAuthToken] authToken Copyleaks authentication token
+    # @param [String] scanId Attach your own scan Id
+    # @param [CopyleaksURLSubmissionModel] submission Submission properties
+    def submit_url(product, authToken, scanId, submission)
+      raise 'scanId is Invalid, must be instance of String' if scanId.nil? || !scanId.instance_of?(String)
+      if submission.nil? || !submission.instance_of?(CopyleaksURLSubmissionModel)
+        raise 'submission is Invalid, must be instance of CopyleaksURLSubmissionModel'
+      end
+
+      validate_product(product)
+      verify_auth_token(authToken)
+
+      path = "/v3/#{product}/submit/url/#{scanId}"
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent,
+        'Authorization' => "Bearer #{authToken.accessToken}"
+      }
+
+      request = Net::HTTP::Put.new(path, headers)
+      request.body = submission.to_json
+
+      handle_response(@api_client.request(request), 'submit_url')
+    end
+
+    # Exporting scans artifact into your server.
+    # For more info:
+    # https://api.copyleaks.com/documentation/v3/downloads/export
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # @param [CopyleaksAuthToken] authToken Your login token to Copyleaks server
+    # @param [String] scanId The scan ID of the specific scan to export.
+    # @param [String] exportId A new Id for the export process.
+    # @param [CopyleaksExportModel] model Request of which artifact should be exported.
+    def export(authToken, scanId, exportId, model)
+      raise 'scanId is Invalid, must be instance of String' if scanId.nil? || !scanId.instance_of?(String)
+      raise 'exportId is Invalid, must be instance of String' if exportId.nil? || !exportId.instance_of?(String)
+      if model.nil? || !model.instance_of?(CopyleaksExportModel)
+        raise 'model is Invalid, must be instance of type CopyleaksExportModel'
+      end
+
+      verify_auth_token(authToken)
+      path = "/v3/downloads/#{scanId}/export/#{exportId}"
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent,
+        'Authorization' => "Bearer #{authToken.accessToken}"
+      }
+
+      request = Net::HTTP::Post.new(path, headers)
+      request.body = model.to_json
+
+      handle_response(@api_client.request(request), 'export')
+    end
+
+    # Start scanning all the files you submitted for a price-check.
+    # For more info:
+    # https://api.copyleaks.com/documentation/v3/education/start
+    # https://api.copyleaks.com/documentation/v3/businesses/start
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # @param [String] product Which product (education or businesses) is being use.
+    # @param [CopyleaksAuthToken] authToken Your login token to Copyleaks server.
+    # @param [CopyleaksStartRequestModel] data Include information about which scans should be started.
+    def start(product, authToken, data)
+      if data.nil? || !data.instance_of?(CopyleaksStartRequestModel)
+        raise 'data is Invalid, must be instance of type CopyleaksStartRequestModel'
+      end
+
+      validate_product(product)
+      verify_auth_token(authToken)
+
+      path =  "/v3/#{product}/start"
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent,
+        'Authorization' => "Bearer #{authToken.accessToken}"
+      }
+
+      request = Net::HTTP::Patch.new(path, headers)
+      request.body = data.to_json
+
+      handle_response(@api_client.request(request), 'start')
+    end
+
+
+    # Delete the specific process from the server.
+    # For more info:
+    # https://api.copyleaks.com/documentation/v3/education/delete
+    # https://api.copyleaks.com/documentation/v3/businesses/delete
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # @param [String] product Which product (education or businesses) is being use.
+    # @param [CopyleaksAuthToken] authToken Copyleaks authentication token
+    # @param [CopyleaksDeleteRequestModel] data
+    def delete(product, authToken, data)
+      if data.nil? || !data.instance_of?(CopyleaksDeleteRequestModel)
+        raise 'data is Invalid, must be instance of CopyleaksDeleteRequestModel'
+      end
+
+      validate_product(product)
+      verify_auth_token(authToken)
+
+      path = "/v3.1/#{product}/delete"
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent,
+        'Authorization' => "Bearer #{authToken.accessToken}"
+      }
+
+      request = Net::HTTP::Patch.new(path, headers)
+      request.body = data.to_json
+
+      handle_response(@api_client.request(request), 'delete')
+    end
+
+    # Resend status webhooks for existing scans.
+    # For more info:
+    # https://api.copyleaks.com/documentation/v3/education/webhook-resend
+    # https://api.copyleaks.com/documentation/v3/businesses/webhook-resend
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # @param [String] product Which product (education or businesses) is being use.
+    # @param [CopyleaksAuthToken] authToken Copyleaks authentication token
+    # @param [String] scanId Copyleaks scan Id
+    def resend_webhook(product, authToken, scanId)
+      raise 'scanId is Invalid, must be instance of String' if scanId.nil? || !scanId.instance_of?(String)
+
+      validate_product(product)
+      verify_auth_token(authToken)
+
+      path =  "/v3/#{product}/scans/#{scanId}/webhooks/resend"
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent,
+        'Authorization' => "Bearer #{authToken.accessToken}"
+      }
+
+      request = Net::HTTP::Post.new(path, headers)
+      handle_response(@api_client.request(request), 'resend_webhook')
+    end
+
+    # Get current credits balance for the Copyleaks account.
+    # For more info:
+    # https://api.copyleaks.com/documentation/v3/education/credits
+    # https://api.copyleaks.com/documentation/v3/businesses/credits
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # * * RateLimitException: Too many requests. Please wait before calling again.
+    # @param [String] product Which product (education or businesses) is being use.
+    # @param [CopyleaksAuthToken] authToken Copyleaks authentication token
+    def get_credits_balance(product, authToken)
+      validate_product(product)
+      verify_auth_token(authToken)
+
+      path = "/v3/#{product}/credits"
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent,
+        'Authorization' => "Bearer #{authToken.accessToken}"
+      }
+
+      request = Net::HTTP::Get.new(path, headers)
+      handle_response(@api_client.request(request), 'get_credits_balance')
+    end
+
+    # This endpoint allows you to export your usage history between two dates.
+    # The output results will be exported to a csv file and it will be attached to the response.
+    # For more info:
+    # https://api.copyleaks.com/documentation/v3/education/usages/history
+    # https://api.copyleaks.com/documentation/v3/businesses/usages/history
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # * * RateLimitException: Too many requests. Please wait before calling again.
+    # @param [String] product Which product (education or businesses) is being use.
+    # @param [CopyleaksAuthToken] authToken Copyleaks authentication token.
+    # @param [String] startDate The start date to collect usage history from. Date Format: `dd-MM-yyyy`.
+    # @param [String] endDate The end date to collect usage history from. Date Format: `dd-MM-yyyy`.
+    def get_usages_history_csv(product, authToken, startDate, endDate)
+      raise 'startDate is Invalid, must be instance of String' if startDate.nil? || !startDate.instance_of?(String)
+      raise 'endDate is Invalid, must be instance of String' if endDate.nil? || !endDate.instance_of?(String)
+
+      validate_product(product)
+      verify_auth_token(authToken)
+
+      path =  "/v3/#{product}/usages/history?start=#{startDate}&end=#{endDate}"
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent,
+        'Authorization' => "Bearer #{authToken.accessToken}"
+      }
+
+      request = Net::HTTP::Get.new(path, headers)
+      handle_response(@api_client.request(request), 'get_usages_history_csv')
+    end
+
+    # Get a list of the supported languages for OCR (this is not a list of supported languages for the api, but only for the OCR files scan).
+    # For more info: https://api.copyleaks.com/documentation/v3/specifications/ocr-languages/list
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # * * RateLimitException: Too many requests. Please wait before calling again.
+    # @return array List of supported OCR languages.
+    def get_ocr_supported_languages
+      path = '/v3/miscellaneous/ocr-languages-list'
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent
+      }
+      request = Net::HTTP::Get.new(path, headers)
+      handle_response(@api_client.request(request), 'get_ocr_supported_languages')
+    end
+
+    # Get a list of the supported file types.
+    # For more info: https://api.copyleaks.com/documentation/v3/specifications/supported-file-types
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # * * RateLimitException: Too many requests. Please wait before calling again.
+    # @return mixed List of supported file types.
+    def get_supported_file_types
+      path =  '/v3/miscellaneous/supported-file-types'
+
+      headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent
+      }
+
+      request = Net::HTTP::Get.new(path, headers)
+      handle_response(@api_client.request(request), 'get_supported_file_types')
+    end
+
+    # Get updates about copyleaks api release notes.
+    # For more info: https://api.copyleaks.com/documentation/v3/release-notes
+    # * Exceptions:
+    # * * CommandExceptions: Server reject the request. See response status code,
+    #     headers and content for more info.
+    # * * UnderMaintenanceException: Copyleaks servers are unavailable for maintenance.
+    #     We recommend to implement exponential backoff algorithm as described here:
+    #     https://api.copyleaks.com/documentation/v3/exponential-backoff
+    # * * RateLimitException: Too many requests. Please wait before calling again.
+    # @return mixed List of release notes.
+    def get_release_notes
+      path = '/v3/release-logs.json'
+
+      header = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Config.user_agent
+      }
+      request = Net::HTTP::Get.new(path, header)
+      handle_response(@api_client.request(request), 'get_release_notes')
+    end
+
+    def validate_product(product)
+      if product.nil? || (product != 'education' && product != 'businesses')
+        raise "Invalid product, product must be set to 'education' or 'businesses'"
+      end
+    end
+
+    # this methods is a helper for hanlding reponse data and exceptions.
+    def handle_response(response, used_by)
+      if Utils.is_success_status_code(response.code)
+        if response.body.nil? || response.body == ''
+          nil
+        else
+          JSON.parse(response.body)
+        end
+      elsif Utils.is_under_maintenance_response(response.code)
+        raise UnderMaintenanceException.new.reason
+      elsif Utils.is_rate_limit_response(response.code)
+        raise RateLimitException.new.reason
+      else
+        _err_message = '---------Copyleaks SDK Error (' + used_by + ')---------' + "\n\n"
+        _err_message += 'status code: ' + response.code + "\n\n"
+
+        _err_message += 'response body:' + "\n" + response.body.to_json + "\n\n" unless response.body.nil?
+
+        _err_message += '-------------------------------------'
+        raise CommandException.new(_err_message).reason + "\n"
+      end
+    end
+  end
+end