plagscan 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7fd408fb011126a3928ec92df17a63b8bb6added05c2428f07b47eca598b96dd
+  data.tar.gz: fffe4c697ed70ba4b35be93a5d763345cfbf42c51e1a1903d6e86f723d45279b
+SHA512:
+  metadata.gz: ce368219bb9309fc71a35d86c6f365c0ececf63e5aa919ccc28966a2b30ae6b8438f0fa27dfac59e957f4c5a8a1e9bd45cdbb665dfa24ff85f35fee9a0d38be8
+  data.tar.gz: ad6a98a358d21cfca119451cc30c83e5fecacf0cac60deb93e35f338b2c9ee578e8f6e09affb8712a5b3b9d44b429ca4e71eccbaacb3acae41dad42f02ac4f90

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 12

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+
+before_install:
+  - gem update bundler
+
+install:
+  - bundle install --jobs=3 --retry=3
+  - gem install rubocop
+
+script:
+  - rubocop
+  - bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.0.1](releases/tag/v0.0.1) - 2019-08-13
+### Added
+- Base implementation of gem along with `ping` API

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in plagscan.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Studiosity
+
+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,47 @@
+# PlagScan
+
+Ruby wrapper for PlagScan plagiarism API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'plagscan'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install plagscan
+
+
+# Development
+
+For details of the PlagScan API see documentation at https://api.plagscan.com/v3docs/
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Studiosity/plagscan-ruby.
+
+Note that spec tests are appreciated to minimise regressions.
+Before submitting a PR, please ensure that:
+ 
+```bash
+$ rspec
+```
+and
+
+```bash
+$ rubocop
+```
+both succeed 
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'plagscan'
+
+# 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

data/lib/plagscan.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'plagscan/version'
+
+require 'plagscan/error'
+require 'plagscan/request'
+
+# APIs
+require 'plagscan/ping'
+
+#
+# Basic configuration for PlagScan API
+#
+module Plagscan
+  def self.api_base
+    'https://api.plagscan.com/v3/'
+  end
+end

data/lib/plagscan/error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Plagscan
+  class Error < StandardError; end
+  class HTTPError < Error; end
+  class InvalidMethodError < HTTPError; end
+end

data/lib/plagscan/ping.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+#
+# PlagScan module
+#
+module Plagscan
+  #
+  # PlagScan ping API
+  #
+  def self.ping
+    Plagscan::Request.request('ping').is_a? Net::HTTPOK
+  end
+end

data/lib/plagscan/request.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'openssl'
+require 'net/http'
+
+module Plagscan
+  #
+  # PlagScan HTTP request service
+  #
+  class Request
+    DEFAULT_REQUEST_OPTIONS = {
+      method: :get,
+      body: nil,
+      headers: nil,
+      ssl_verify_mode: OpenSSL::SSL::VERIFY_PEER,
+      ssl_ca_file: nil
+    }.freeze
+
+    class << self
+      def api_url(path = '')
+        Plagscan.api_base + path
+      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
+
+      private
+
+      def create_http(options)
+        uri = URI api_url
+        http = Net::HTTP.new(uri.host, uri.port)
+
+        if uri.scheme == 'https'
+          http.use_ssl = true
+          http.verify_mode = options[:ssl_verify_mode]
+          http.ca_file = options[:ssl_ca_file] if options[:ssl_ca_file]
+        end
+
+        http
+      end
+
+      def create_request(path, options)
+        headers = extract_headers(options)
+        body = options[:body]
+
+        if options[:method] == :post
+          req = Net::HTTP::Post.new(path, headers)
+          add_body(req, body) if body
+          req
+        else
+          uri = api_url path
+          uri += '?' + body.map { |k, v| "#{k}=#{v}" }.join('&') if body
+          Net::HTTP::Get.new(uri, headers)
+        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
+
+        headers = Util.stringify_hash_keys headers
+        headers.delete_if { |key, value| key.nil? || value.nil? }
+      end
+
+      def add_body(request, body)
+        if body.is_a? Hash
+          request.body = body.to_json
+          request.content_type = 'application/json'
+        else
+          request.body = body.to_s
+        end
+      end
+    end
+  end
+end

data/lib/plagscan/version.rb

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

data/plagscan.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'plagscan/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'plagscan'
+  spec.version     = Plagscan::VERSION
+  spec.authors     = ['Andrew Bromwich']
+  spec.email       = ['abromwich@studiosity.com']
+
+  spec.summary     = 'Ruby gem for PlagScan plagiarism APIs'
+  spec.description = 'Ruby gem for PlagScan (https://www.plagscan.com/) plagiarism checking APIs'
+  spec.homepage    = 'https://github.com/Studiosity/plagscan-ruby'
+  spec.license     = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  unless spec.respond_to?(:metadata)
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rest-client', '>= 1.4', '< 4.0'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  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 'webmock', '~> 3.0'
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: plagscan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Bromwich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby gem for PlagScan (https://www.plagscan.com/) plagiarism checking
+  APIs
+email:
+- abromwich@studiosity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- lib/plagscan.rb
+- lib/plagscan/error.rb
+- lib/plagscan/ping.rb
+- lib/plagscan/request.rb
+- lib/plagscan/version.rb
+- plagscan.gemspec
+homepage: https://github.com/Studiosity/plagscan-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: 
+specification_version: 4
+summary: Ruby gem for PlagScan plagiarism APIs
+test_files: []