plagscan 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fd408fb011126a3928ec92df17a63b8bb6added05c2428f07b47eca598b96dd
-  data.tar.gz: fffe4c697ed70ba4b35be93a5d763345cfbf42c51e1a1903d6e86f723d45279b
+  metadata.gz: 2127487f273cb1dc5b45d7571465bfa129c284fd6e7952be9f849fe40af01961
+  data.tar.gz: e285ec1601bd3e3e0f05cc29b698b46620dfcbebdb39971f36fdb98a21e78224
 SHA512:
-  metadata.gz: ce368219bb9309fc71a35d86c6f365c0ececf63e5aa919ccc28966a2b30ae6b8438f0fa27dfac59e957f4c5a8a1e9bd45cdbb665dfa24ff85f35fee9a0d38be8
-  data.tar.gz: ad6a98a358d21cfca119451cc30c83e5fecacf0cac60deb93e35f338b2c9ee578e8f6e09affb8712a5b3b9d44b429ca4e71eccbaacb3acae41dad42f02ac4f90
+  metadata.gz: 770fab61fdd24d8ec9a7a76805fb939090858afdfd4237262cae40e43d0234c571363ffe5a99cadf926fe405afc006ab17a7f5e136acb1ccc0a06211b44a0378
+  data.tar.gz: 38e719eda4185a53180bfd8fbeef79da80662c333a9f49fbc5769d2acc20bd56e389cfcdd3f4a08421ffe678980d6bed213eee9c2440cdc8a01c86c0c7fe9b0b

data/.rubocop.yml

@@ -1,5 +1,23 @@
+require: rubocop-rspec
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+
 Metrics/LineLength:
   Max: 100
 
 Metrics/MethodLength:
-  Max: 12
+  Max: 13
+
+RSpec/ExampleLength:
+  Max: 16
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/MultipleExpectations:
+  Max: 2

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# Changelog
+
+## Unreleased
+- none
+
+## [0.0.2](releases/tag/v0.0.2) - 2019-08-14
+- Added support for `token` API
+- Added support for some `documents` APIs (create, check and retrieve)
+
 ## [0.0.1](releases/tag/v0.0.1) - 2019-08-13
 ### Added
 - Base implementation of gem along with `ping` API

data/lib/plagscan.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+require 'uri'
+require 'openssl'
+require 'net/http'
+
+require 'json'
+
 require 'plagscan/version'
 
 require 'plagscan/error'
@@ -7,6 +13,8 @@ require 'plagscan/request'
 
 # APIs
 require 'plagscan/ping'
+require 'plagscan/token'
+require 'plagscan/documents'
 
 #
 # Basic configuration for PlagScan API

data/lib/plagscan/documents.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Plagscan
+  #
+  # PlagScan documents API
+  #
+  class Documents
+    #
+    # Document create REST API
+    # @param [String] access_token Access token from Token.fetch
+    # @param [File] file Document file
+    # @param [String] text Text from a document in plain text
+    # @param [named options] userID, textname, toRepository, saveOrig
+    # @return [Hash] containing document ID and URI location for created resource
+    #
+    # Note. you should provide fileUpload OR textdata
+    # For more details, see https://api.plagscan.com/v3docs/#api-Document-SubmitDocument
+    #
+    def self.create(access_token:, file: nil, text: nil, **options)
+      raise 'must specify file or text' if file.nil? && text.nil?
+
+      create_props = options.delete_if do |k, _|
+        !%i[userID textname toRepository saveOrig].include? k
+      end
+
+      Plagscan::Request.json_request(
+        'documents',
+        method: :post, access_token: access_token, expected_result: Net::HTTPCreated,
+        body: create_props.merge(file ? { fileUpload: file } : { textdata: text })
+      )
+    end
+
+    #
+    # Document create REST API
+    # @param [String] access_token Access token from Token.fetch
+    # @param [Integer] document_id Document ID as returned from create action
+    # @return [Null]
+    # @raise [DocumentError] Various reasons generally based around invalid document state.
+    #
+    # For more details, see https://api.plagscan.com/v3docs/#api-Document-CheckDocument
+    #
+    def self.check(access_token:, document_id:)
+      response =
+        Plagscan::Request.request(
+          "documents/#{document_id}/check",
+          method: :put, access_token: access_token
+        )
+
+      return if response.is_a? Net::HTTPNoContent
+
+      error_message =
+        begin
+          JSON.parse(response.body)&.dig('error', 'message')
+        rescue JSON::ParserError
+          nil
+        end
+      raise DocumentError, error_message || response.body
+    end
+
+    #
+    # Document retrieve REST API
+    # @param [String] access_token Access token from Token.fetch
+    # @param [Integer] document_id Document ID as returned from create action
+    # @param [Integer] mode The retrieve mode of the report
+    # @param [Integer] user_id Identify the user who is accessing to the report
+    #                          (Only mandatory for mode 10). If not set it will get the user
+    #                          ID associated with the access token or the organization admin ID.
+    # @return [Hash] Various different values depending on the mode specified
+    #
+    # For more details, see https://api.plagscan.com/v3docs/#api-Document-RetrieveDocumentReport
+    #
+    def self.retrieve(access_token:, document_id:, mode:, user_id: nil)
+      params = { mode: mode }
+      params[:userID] = user_id if user_id
+
+      Plagscan::Request.json_request(
+        "documents/#{document_id}/retrieve",
+        access_token: access_token, body: params
+      )
+    end
+  end
+end

data/lib/plagscan/error.rb

@@ -4,4 +4,6 @@ module Plagscan
   class Error < StandardError; end
   class HTTPError < Error; end
   class InvalidMethodError < HTTPError; end
+  class JsonParseError < Error; end
+  class DocumentError < Error; end
 end

data/lib/plagscan/ping.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 #
-# PlagScan module
+# PlagScan ping API
 #
 module Plagscan
   #
-  # PlagScan ping API
+  # ping REST API
+  # @return [Boolean]
   #
   def self.ping
     Plagscan::Request.request('ping').is_a? Net::HTTPOK

data/lib/plagscan/request.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'uri'
-require 'openssl'
-require 'net/http'
-
 module Plagscan
   #
   # PlagScan HTTP request service
@@ -22,16 +18,29 @@ module Plagscan
         Plagscan.api_base + path
       end
 
+      def user_agent
+        "PlagScan-Ruby/#{Plagscan::VERSION}"
+      end
+
       def request(path, options = {})
         options = DEFAULT_REQUEST_OPTIONS.merge(options)
-
-        raise Plagscan::InvalidMethodError unless %i[get post].include? options[:method]
-
         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)
+
+        unless response.is_a?(options[:expected_result] || Net::HTTPSuccess)
+          raise Plagscan::HTTPError, "Invalid http response code: #{response.code}"
+        end
+
+        JSON.parse response.body
+      rescue JSON::ParserError
+        raise Plagscan::JsonParseError, "PlagScan response parse error: #{response.body}"
+      end
+
       private
 
       def create_http(options)
@@ -48,35 +57,28 @@ module Plagscan
       end
 
       def create_request(path, options)
-        headers = extract_headers(options)
-        body = options[:body]
+        headers = { 'User-Agent' => user_agent }
+        uri = api_url path
 
-        if options[:method] == :post
-          req = Net::HTTP::Post.new(path, headers)
-          add_body(req, body) if body
-          req
+        if %i[post put patch].include? options[:method]
+          body_request uri, headers, options
         else
-          uri = api_url path
-          uri += '?' + body.map { |k, v| "#{k}=#{v}" }.join('&') if body
-          Net::HTTP::Get.new(uri, headers)
+          uri_request uri, headers, options
         end
       end
 
-      def extract_headers(options)
-        headers = options[:headers]
-
-        token = options.delete :token
-        if token
-          headers ||= {}
-
-          headers['X-Auth-Token'] = token.auth_token
-          headers['X-User-Id'] = token.user_id
-        end
-
-        return unless headers
+      def body_request(uri, headers, options)
+        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
+      end
 
-        headers = Util.stringify_hash_keys headers
-        headers.delete_if { |key, value| key.nil? || value.nil? }
+      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?
+        http_method(options).new(uri, headers)
       end
 
       def add_body(request, body)
@@ -87,6 +89,14 @@ module Plagscan
           request.body = body.to_s
         end
       end
+
+      def http_method(options)
+        method = options[:method].to_s.downcase
+        method = method[0].upcase.concat(method[1..-1])
+        Net::HTTP.const_get(method)
+      rescue NameError
+        raise Plagscan::InvalidMethodError, "`#{options[:method]}` is not a valid HTTP method"
+      end
     end
   end
 end

data/lib/plagscan/token.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Plagscan
+  #
+  # PlagScan access token API
+  #
+  class Token
+    #
+    # token REST API
+    # @param [String] client_id your organisation ID
+    # @param [String] client_secret the API key from https://www.plagscan.com/apisetup
+    # @return [Hash] containing access_token and expires_in
+    #
+    def self.fetch(client_id:, client_secret:)
+      Plagscan::Request.json_request(
+        'token',
+        method: :post, body: { client_id: client_id, client_secret: client_secret }
+      )
+    end
+  end
+end

data/lib/plagscan/version.rb

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

data/plagscan.gemspec

@@ -31,5 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   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 'webmock', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plagscan
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrew Bromwich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-13 00:00:00.000000000 Z
+date: 2019-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -86,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.74'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.35'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -118,9 +132,11 @@ files:
 - Rakefile
 - bin/console
 - lib/plagscan.rb
+- lib/plagscan/documents.rb
 - lib/plagscan/error.rb
 - lib/plagscan/ping.rb
 - lib/plagscan/request.rb
+- lib/plagscan/token.rb
 - lib/plagscan/version.rb
 - plagscan.gemspec
 homepage: https://github.com/Studiosity/plagscan-ruby