izi_plagiarism_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bf58de1b880890d18c76cb872907adc11277c98
+  data.tar.gz: 21833689d1794608f4d6fb32b2909addcc768431
+SHA512:
+  metadata.gz: 4d9f09759c9db8e1a29bcad92e28be0ffd46d08d6eedaf58916dd6f7732418d5f55270bf0b2633b519481cdb52ab8a8953398c0e6e2c84cfe1ac5415d4a6091b
+  data.tar.gz: 36b8c2f92b745dd0ff8a16e1a4c0aaa69cdb59466c5c6cd010be228d9e1f738b812d41a3323861183c5fbef5b67ca39f27b2801143e84bbd1ad036ef9dd272ea

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 IzikAJ
+
+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,38 @@
+# Plagiarism::Client
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'plagiarism-client'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install plagiarism-client
+```
+
+## Configuration
+```ruby
+# config/initializers/plagiarism.rb
+Plagiarism::Client.configure do |client|
+  client.endpoint = ENV['PLAGIARISM_API_ENDPOINT']
+  client.token    = ENV['PLAGIARISM_API_KEY']
+  client.secret   = ENV['PLAGIARISM_API_SECRET']
+end
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Plagiarism::Client'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/plagiarism/client.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require_relative 'client/engine'
+
+module Plagiarism
+  module Client
+    class << self
+      attr_accessor :endpoint, :token, :secret
+
+      def configure
+        yield self
+      end
+    end
+  end
+end

data/lib/plagiarism/client/engine.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'signed_request'
+require_relative 'report'

data/lib/plagiarism/client/report.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'signed_request'
+
+module Plagiarism
+  module Client
+    class Report
+      class << self
+        include SignedRequest
+
+        DATETIME_FIELDS = %w[
+          created_at
+          completed_at
+        ].freeze
+
+        def create(data = {})
+          structed post('/api/v1/reports', body: data)
+        end
+
+        def show(report_id)
+          structed get("/api/v1/reports/#{report_id}")
+        end
+
+        private
+
+        def structed(data = {})
+          obj = OpenStruct.new(data)
+
+          DATETIME_FIELDS.each do |field|
+            next if obj[field].blank? || !obj[field].is_a?(String)
+            obj[field] = Time.zone.parse(obj[field])
+          end
+
+          obj
+        end
+      end
+    end
+  end
+end

data/lib/plagiarism/client/signed_request.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'httparty'
+require 'api_signature'
+
+module Plagiarism
+  module Client
+    module SignedRequest
+      protected
+
+      HEADER_KEYS = ApiSignature::Request::HEADER_KEYS
+
+      %w[get post put delete].each do |kind|
+        define_method kind do |path, **xargs|
+          headers = xargs.fetch(:headers, {})
+          headers = add_signature(headers, kind, path)
+          xargs[:headers] = headers
+          fullpath = File.join(Plagiarism::Client.endpoint, path)
+
+          response = HTTParty.send(kind, fullpath, **xargs)
+          JSON.parse(response.body)
+        end
+      end
+
+      def add_signature(headers, request_method, path)
+        options = signature_options(headers, request_method, path)
+
+        HEADER_KEYS.each do |kind, header|
+          headers[normalize_key(header)] = options[kind].to_s
+        end
+
+        headers
+      end
+
+      def signature_options(headers, request_method, path)
+        options = {
+          path: path,
+          request_method: request_method.to_s.upcase,
+          access_key: Plagiarism::Client.token,
+          timestamp: timestamp_for_options(headers)
+        }.with_indifferent_access
+
+        options[:signature] = generate_signature(options)
+
+        options
+      end
+
+      def timestamp_for_options(headers)
+        header_key = HEADER_KEYS[:timestamp].gsub(/^HTTP_/, '')
+
+        return headers[header_key] if headers.key? header_key
+        Time.zone.now.to_i
+      end
+
+      def generate_signature(options)
+        ApiSignature::Generator
+          .new(options)
+          .generate_signature(Plagiarism::Client.secret)
+      end
+
+      private
+
+      def normalize_key(key)
+        key.gsub(/^HTTP_/i, '').tr('_', '-').downcase
+      end
+    end
+  end
+end

data/lib/plagiarism/client/version.rb

@@ -0,0 +1,5 @@
+module Plagiarism
+  module Client
+    VERSION = '0.1.0'
+  end
+end

data/lib/tasks/plagiarism/client_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :plagiarism_client do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: izi_plagiarism_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- IzikAJ
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: api_signature
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Description of Plagiarism::Client.
+email:
+- izikaj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/plagiarism/client.rb
+- lib/plagiarism/client/engine.rb
+- lib/plagiarism/client/report.rb
+- lib/plagiarism/client/signed_request.rb
+- lib/plagiarism/client/version.rb
+- lib/tasks/plagiarism/client_tasks.rake
+homepage: http://example.com
+licenses:
+- MIT
+metadata: {}
+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.6.14.1
+signing_key: 
+specification_version: 4
+summary: Summary of Plagiarism::Client.
+test_files: []