plagscan 0.0.3 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23b89dfff549230388cfa7a7ce7036d144a634966772e6e7fe0b6c8047fba886
-  data.tar.gz: c4c73b11f7fa5030bcdb882ac547681c7195942c99ff560041eef40a64c51a4a
+  metadata.gz: 433c2ec8955ae950941672d96480f29dcf884c30c8a005fe7a1f2fd342d9a784
+  data.tar.gz: fbcb73f1371aee03721d53df442c9504f7cea64f1a3df183812ccffffe427a74
 SHA512:
-  metadata.gz: 7fee157eb54c279e2f28203f602eed415205633ba33e093ae892de78410ad3e76992e566d450be4ee91d0e7ed4fdcf42adfdf07f84219d9adf2f02a8a4a0c317
-  data.tar.gz: b12160e32ab7cc6aa926b7f9b8a41f2e112eae2f4ff6da9354df03e33e83a280732da00b9a8f5ca4bb7cf914f4fe3cee6feea1ff1c425ad024aaaef81b4e38d7
+  metadata.gz: 9bed202c3a3ddfebc0cd2f66c199982e5b1b997cf1b8f295ded6fe28d66d47e3c3e1afae544576622245f2beb1440be709564975cea04c34c383c794a0a0b0fb
+  data.tar.gz: c0c3a13c1550be8fbe9b35accc7759b63c7e88bc9c8b4103489e768f8e0157291b13bc130691d204f6dfc8a27b7488d06c93b23addbe26fb76123ac0ca62e5f5

data/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: Test Plagscan Ruby gem
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1']
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Lint code - Rubocop
+        run: bundle exec rubocop
+
+      - name: Run tests
+        run: bundle exec rake
+
+      - name: Test & publish code coverage
+        uses: paambaati/codeclimate-action@v3.0.0
+        env:
+          CC_TEST_REPORTER_ID: 1e550d84766c7d7d61b7fb36d672a9cf6834600715a798b90e6a66d48574f592

data/.gitignore

@@ -1,2 +1,3 @@
 *.gem
 Gemfile.lock
+coverage/

data/.rubocop.yml

@@ -1,8 +1,30 @@
 require: rubocop-rspec
 
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
 Layout/DotPosition:
   EnforcedStyle: trailing
 
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
 Metrics/BlockLength:
   Exclude:
     - "**/*_spec.rb"
@@ -21,3 +43,24 @@ RSpec/MessageSpies:
 
 RSpec/MultipleExpectations:
   Max: 2
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 # Changelog
 
 ## Unreleased
+- none
+
+## [0.0.6](releases/tag/v0.0.6) - 2022-07-25
+### Fixed
+- [#3] Increase read timeout for Documents#create to 2 minutes
+
+## [0.0.5](releases/tag/v0.0.5) - 2020-03-01
+### Fixed
+- Address CVE-2020-8130 - `rake` OS command injection vulnerability
+
+## [0.0.4](releases/tag/v0.0.4) - 2019-12-31
+### Added
+- Support for some `users` APIs (list and get)
+
+## [0.0.3](releases/tag/v0.0.3) - 2019-08-16
 ### Updated
 - Support File params in body actions (multipart form)
 - Include response body in invalid http response error message

data/README.md

@@ -1,4 +1,4 @@
-[![Travis Build Status](http://img.shields.io/travis/Studiosity/plagscan-ruby.svg?style=flat)](https://travis-ci.org/Studiosity/plagscan-ruby)
+[![Github Build Status](https://github.com/Studiosity/plagscan-ruby/actions/workflows/test.yml/badge.svg)](https://github.com/Studiosity/plagscan-ruby/actions/workflows/test.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/43ec9575fe4727b96adb/maintainability)](https://codeclimate.com/github/Studiosity/plagscan-ruby/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/43ec9575fe4727b96adb/test_coverage)](https://codeclimate.com/github/Studiosity/plagscan-ruby/test_coverage)
 [![Gem Version](http://img.shields.io/gem/v/plagscan.svg?style=flat)](http://rubygems.org/gems/plagscan)
@@ -23,6 +23,64 @@ Or install it yourself as:
 
     $ gem install plagscan
 
+# Supported APIs
+
+## Ping
+#### Check if the PlagScan API is available 
+```ruby
+Plagscan.ping
+=> true
+```
+
+## Token
+#### Authenticate and fetch `access_token` to use with other APIs
+```ruby
+Plagscan::Token.fetch client_id: '1234', client_secret: 'secret'
+=> { access_token: 'secret_token', expires_in: 86400 }
+```
+
+## Documents
+#### Upload documents to be checked by PlagScan 
+```ruby
+Plagscan::Documents.create access_token: 'secret_token', file: file
+=> { documentID: '1234', .... }
+```
+
+N.B. you can also pass through the document as raw text using the `text` parameter in place of the `file` parameter.
+
+Optional parameters for `userID`, `textname`, `toRepository` and `saveOrig`.
+See [document create documentation](https://api.plagscan.com/v3docs/#api-Document-SubmitDocument)
+for further details
+
+#### Begin check of document uploaded to PlagScan
+```ruby
+Plagscan::Documents.check access_token: 'secret_token', document_id: 1234
+=> nil
+```
+
+#### Retrieve results of document scan
+```ruby
+Plagscan::Documents.retrieve access_token: 'secret_token', document_id: 1234, mode: 0
+=> { ... }
+```
+See [document retrieve documentation](https://api.plagscan.com/v3docs/#api-Document-RetrieveDocumentReport)
+for further details
+
+## Users
+#### List user details
+```ruby
+Plagscan::Users.list access_token: 'secret_token'
+=> [{ ... }, { ... }, ...]
+```
+See [user list documentation](https://api.plagscan.com/v3docs/#api-User-ListUser) for further details
+
+#### Get user details
+```ruby
+Plagscan::Users.get access_token: 'secret_token', user_id: 123456
+=> { ... }
+```
+See [user get documentation](https://api.plagscan.com/v3docs/#api-User-GetUser) for further details
+
 
 # Development
 

data/lib/plagscan/documents.rb

@@ -26,7 +26,8 @@ module Plagscan
       Plagscan::Request.json_request(
         'documents',
         method: :post, access_token: access_token, expected_result: Net::HTTPCreated,
-        body: create_props.merge(file ? { fileUpload: file } : { textdata: text })
+        body: create_props.merge(file ? { fileUpload: file } : { textdata: text }),
+        read_timeout: 120
       )
     end
 

data/lib/plagscan/request.rb

@@ -22,15 +22,15 @@ module Plagscan
         "PlagScan-Ruby/#{Plagscan::VERSION}"
       end
 
-      def request(path, options = {})
+      def request(path, **options)
         options = DEFAULT_REQUEST_OPTIONS.merge(options)
         http = create_http(options)
         req = create_request(path, options)
         http.start { http.request(req) }
       end
 
-      def json_request(path, options = {})
-        response = Plagscan::Request.request(path, options)
+      def json_request(path, **options)
+        response = Plagscan::Request.request(path, **options)
 
         unless response.is_a?(options[:expected_result] || Net::HTTPSuccess)
           raise Plagscan::HTTPError, "Invalid http response: #{response.code} - #{response.body}"
@@ -43,7 +43,7 @@ module Plagscan
 
       private
 
-      def create_http(options)
+      def create_http(options) # rubocop:disable Metrics/AbcSize
         uri = URI api_url
         http = Net::HTTP.new(uri.host, uri.port)
 
@@ -53,6 +53,10 @@ module Plagscan
           http.ca_file = options[:ssl_ca_file] if options[:ssl_ca_file]
         end
 
+        %i[open_timeout write_timeout read_timeout].each do |option|
+          http.__send__("#{option}=", options[option]) if options[option]
+        end
+
         http
       end
 
@@ -68,7 +72,7 @@ module Plagscan
       end
 
       def body_request(uri, headers, options)
-        uri += '?access_token=' + options[:access_token] if options[:access_token]
+        uri += "?access_token=#{options[:access_token]}" if options[:access_token]
         req = http_method(options).new(uri, headers)
         add_body(req, options[:body]) if options[:body]
         req
@@ -77,7 +81,7 @@ module Plagscan
       def uri_request(uri, headers, options)
         body = options[:body] || {}
         body[:access_token] = options[:access_token] if options[:access_token]
-        uri += '?' + body.map { |k, v| "#{k}=#{v}" }.join('&') unless body.empty?
+        uri += "?#{body.map { |k, v| "#{k}=#{v}" }.join('&')}" unless body.empty?
         http_method(options).new(uri, headers)
       end
 

data/lib/plagscan/users.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Plagscan
+  #
+  # PlagScan users API
+  #
+  class Users
+    #
+    # User get REST API
+    # @param [Number] start The start position of the list (optional)
+    # @param [Number] limit The limit of results returned (optional)
+    # @return [Array] containing array of data for Users
+    #
+    # For more details, see https://api.plagscan.com/v3docs/#api-User-ListUser
+    #
+    def self.list(access_token:, **options)
+      list_props = options.delete_if { |k, _| !%i[start limit].include? k }
+
+      Plagscan::Request.json_request(
+        'users',
+        access_token: access_token, body: list_props
+      )&.[](:data)
+    end
+
+    #
+    # User get REST API
+    # @param [Number] user_id PlagScan user ID
+    # @return [Hash] containing data from a User
+    #
+    # For more details, see https://api.plagscan.com/v3docs/#api-User-GetUser
+    #
+    def self.get(access_token:, user_id:)
+      Plagscan::Request.json_request(
+        "users/#{user_id}",
+        access_token: access_token
+      )&.[](:data)
+    end
+  end
+end

data/lib/plagscan/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Plagscan
-  VERSION = '0.0.3'
+  VERSION = '0.0.6'
 end

data/lib/plagscan.rb

@@ -15,6 +15,7 @@ require 'plagscan/request'
 require 'plagscan/ping'
 require 'plagscan/token'
 require 'plagscan/documents'
+require 'plagscan/users'
 
 #
 # Basic configuration for PlagScan API
@@ -24,3 +25,8 @@ module Plagscan
     'https://api.plagscan.com/v3/'
   end
 end
+
+#
+# Alias `PlagScan` to `Plagscan`
+#
+PlagScan = Plagscan

data/plagscan.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.description = 'Ruby gem for PlagScan (https://www.plagscan.com/) plagiarism checking APIs'
   spec.homepage    = 'https://github.com/Studiosity/plagscan-ruby'
   spec.license     = 'MIT'
+  spec.required_ruby_version = ['>= 2.5.0', '< 3.2.0']
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
@@ -22,15 +23,17 @@ Gem::Specification.new do |spec|
   end
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.74'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.35'
-  spec.add_development_dependency 'simplecov', '~> 0.17'
+  spec.add_development_dependency 'rubocop', '~> 1.28'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.10'
+  spec.add_development_dependency 'simplecov', '~> 0.17', '< 0.18'
   spec.add_development_dependency 'webmock', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plagscan
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.6
 platform: ruby
 authors:
 - Andrew Bromwich
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-16 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '1.28'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '1.28'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.35'
+        version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.35'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +101,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -94,6 +111,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -116,9 +136,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -131,6 +151,7 @@ files:
 - lib/plagscan/ping.rb
 - lib/plagscan/request.rb
 - lib/plagscan/token.rb
+- lib/plagscan/users.rb
 - lib/plagscan/version.rb
 - plagscan.gemspec
 homepage: https://github.com/Studiosity/plagscan-ruby
@@ -138,7 +159,8 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -146,16 +168,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Ruby gem for PlagScan plagiarism APIs
 test_files: []

data/.travis.yml

@@ -1,30 +0,0 @@
-language: ruby
-
-env:
-  global:
-    - CC_TEST_REPORTER_ID=1e550d84766c7d7d61b7fb36d672a9cf6834600715a798b90e6a66d48574f592
-
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-
-before_install:
-  - gem update bundler
-
-install:
-  - bundle install --jobs=3 --retry=3
-  - gem install rubocop
-
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-
-script:
-  - rubocop
-  - bundle exec rake
-
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT