plagscan 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23b89dfff549230388cfa7a7ce7036d144a634966772e6e7fe0b6c8047fba886
-  data.tar.gz: c4c73b11f7fa5030bcdb882ac547681c7195942c99ff560041eef40a64c51a4a
+  metadata.gz: e91832aeeed75d754081b6a4c7a5e50866500a5b7520455c1eb9d50cd49f8ee3
+  data.tar.gz: ffcefc0444bb5a19f0dec3d08f1dc3c3c77398d16943f1d83a06cc6a265d05df
 SHA512:
-  metadata.gz: 7fee157eb54c279e2f28203f602eed415205633ba33e093ae892de78410ad3e76992e566d450be4ee91d0e7ed4fdcf42adfdf07f84219d9adf2f02a8a4a0c317
-  data.tar.gz: b12160e32ab7cc6aa926b7f9b8a41f2e112eae2f4ff6da9354df03e33e83a280732da00b9a8f5ca4bb7cf914f4fe3cee6feea1ff1c425ad024aaaef81b4e38d7
+  metadata.gz: 5371b817bde97eb33623f19374dab3a3998bba2a5da348f34df30594797781e646cb7e00401190ae6418b15210c0dc7c66855f8a7af22ea2d5bf74acecfe12e6
+  data.tar.gz: 6ad3e5d00a4e17cbe999aa3d7795ae2f02f09739d56d5bd187d4ff27a8d138a740a105b16a1867b0097f6fa9a8072cd039a25c847e8c4bd977b2ae1dc76a9de3

data/.gitignore

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

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 
 ## Unreleased
+- none
+
+## [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

@@ -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.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/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.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plagscan
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Andrew Bromwich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-16 00:00:00.000000000 Z
+date: 2019-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +131,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
@@ -153,8 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Ruby gem for PlagScan plagiarism APIs