Riminder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55cba8505a6a13db413342faa7d420a68ddc960766c10a168a5f416abd8a2d90
+  data.tar.gz: b415846f1217e0e85faa5e1050984787e6a07c2d18e94d8a6edab4f5f83341d5
+SHA512:
+  metadata.gz: 332943114ba425aaa881c27dd3c22c301840a8fb3917d1ac969d688a0590429f0962b789df8b973606be8adc299d165c07d4bc14711d8d36de6030cbc6f3b467
+  data.tar.gz: befb6ed0bc6e1c6138d51b18eccb45ecb7c95b8473a50f74557c21b8027a3d242e84a2a0d7dab38fc8c58e40137d3d1f19dc9553aa7fab4705ad26b03e9c5bdd

data/lib/filter.rb

@@ -0,0 +1,22 @@
+require_relative 'requtils.rb'
+
+class Filter
+    @clientw
+
+    def initialize(clientw)
+        @clientw = clientw
+    end
+
+    def list()
+        resp = @clientw.get("filters")
+        return resp['data']
+    end
+
+    def get(options)
+        query = {}
+        query = ReqUtils.add_if_not_blank(query, 'filter_id', options['filter_id'])
+        query = ReqUtils.add_if_not_blank(query, 'filter_reference', options['filter_reference'])
+        resp = @clientw.get("filter", query)
+        return resp['data']
+    end
+end

data/lib/profile.rb

@@ -0,0 +1,198 @@
+require 'json'
+require_relative 'riminderException.rb'
+
+class Profile
+    @clientw
+    attr_reader :document
+    attr_reader :parsing
+    attr_reader :scoring
+    attr_reader :json
+    attr_reader :stage
+    attr_reader :rating
+    DEFAULT_DATE_START = '1347209668'
+
+    def initialize(clientw)
+        @clientw = clientw
+
+        @document = Documents.new(@clientw)
+        @parsing = Parsing.new(@clientw)
+        @scoring = Scoring.new(@clientw)
+        @json = Json.new(@clientw)
+        @stage = Stage.new(@clientw)
+        @rating = Rating.new(@clientw)
+
+    end
+
+    def add(options)
+        if (!options.key?('filepath'))
+            raise RiminderArgumentException.new('A filepath should be given')
+        end
+        file_path = options['filepath']
+        payload = {
+            'source_id' => options['source_id']
+        }
+        payload = ReqUtils.add_if_not_blank(payload, 'profile_reference', options['profile_reference'])
+        payload = ReqUtils.add_if_not_blank(payload, 'timestamp_reception', options['timestamp_reception'])
+        payload = ReqUtils.add_if_not_blank(payload, 'training_metadata', ReqUtils.validateTrainingMetadata(options['training_metadata']))
+        resp = @clientw.postfile('profile', file_path, payload)
+        return resp["data"]
+    end
+
+
+    def get(options)
+        query = {
+            "source_id" => options['source_id']
+        }
+        query = ReqUtils.add_if_not_blank(query, 'profile_id', options['profile_id'])
+        query = ReqUtils.add_if_not_blank(query, 'profile_reference', options['profile_reference'])
+        resp = @clientw.get("profile", query)
+        return resp["data"]
+    end
+
+    def list(options)
+        if (!options['source_ids'].nil? && !options['source_ids'].kind_of?(Array))
+            raise RiminderArgumentException.new('options should contains a the source_ids field a an Array')
+        end
+        query = {
+            'source_ids' => options['source_ids'].to_json,
+            'date_start' => DEFAULT_DATE_START,
+            'date_end' => Time.now.to_i,
+            'page' => 1,
+            'sort_by' => 'ranking'
+        }
+        query = ReqUtils.add_if_not_blank(query, 'seniority', options['seniority'])
+        query = ReqUtils.add_if_not_blank(query, 'filter_id', options['filter_id'])
+        query = ReqUtils.add_if_not_blank(query, 'filter_reference', options['filter_reference'])
+        query = ReqUtils.add_if_not_blank(query, 'stage', options['stage'])
+        query = ReqUtils.add_if_not_blank(query, 'rating', options['rating'])
+        query = ReqUtils.add_if_not_blank(query, 'date_start', options['date_start'])
+        query = ReqUtils.add_if_not_blank(query, 'date_end', options['date_end'])
+        query = ReqUtils.add_if_not_blank(query, 'page', options['page'])
+        query = ReqUtils.add_if_not_blank(query, 'limit', options['limit'])
+        query = ReqUtils.add_if_not_blank(query, 'sort_by', options['sort_by'])
+        query = ReqUtils.add_if_not_blank(query, 'order_by', options['order_by'])
+
+        resp = @clientw.get('profiles', query)
+        return resp["data"]
+    end
+
+    class Documents
+        @clientw
+        def initialize(clientw)
+            @clientw = clientw
+        end
+
+        def list(options)
+            query = {
+                "source_id" => options['source_id']
+            }
+            query = ReqUtils.add_if_not_blank(query, 'profile_id', options['profile_id'])
+            query = ReqUtils.add_if_not_blank(query, 'profile_reference', options['profile_reference'])
+            resp = @clientw.get("profile/documents", query)
+            return resp["data"]
+        end
+    end
+
+    class Parsing
+        @clientw
+        def initialize(clientw)
+            @clientw = clientw
+        end
+
+        def get(options)
+           query = {
+                "source_id" => options['source_id']
+            }
+            query = ReqUtils.add_if_not_blank(query, 'profile_id', options['profile_id'])
+            query = ReqUtils.add_if_not_blank(query, 'profile_reference', options['profile_reference'])
+            resp = @clientw.get("profile/parsing", query)
+            return resp["data"]
+        end 
+    end
+
+    class Scoring
+        @clientw
+        def initialize(clientw)
+            @clientw = clientw
+        end
+
+        def list(options)
+           query = {
+                "source_id" => options['source_id']
+            }
+            query = ReqUtils.add_if_not_blank(query, 'profile_id', options['profile_id'])
+            query = ReqUtils.add_if_not_blank(query, 'profile_reference', options['profile_reference'])
+            resp = @clientw.get("profile/scoring", query)
+            return resp['data']
+        end 
+    end
+
+    class Json
+        @clientw
+        def initialize(clientw)
+            @clientw = clientw
+        end
+
+        def check(options)
+            payload = {
+                "profile_json" => options['profile_json'] 
+            }
+            payload = ReqUtils.add_if_not_blank(payload, 'training_metadata', ReqUtils.validateTrainingMetadata(options['training_metadata']))
+            resp = @clientw.post('profile/json/check', payload)
+            return resp['data']
+        end
+
+        def add(options)
+            payload = {
+                "source_id" => options['source_id'],
+                "profile_json" => options['profile_json'] 
+            }
+            payload = ReqUtils.add_if_not_blank(payload, 'profile_reference', options['profile_reference'])
+            payload = ReqUtils.add_if_not_blank(payload, 'timestamp_reception', options['timestamp_reception'])
+            payload = ReqUtils.add_if_not_blank(payload, 'training_metadata', ReqUtils.validateTrainingMetadata(options['training_metadata']))
+            resp = @clientw.post('profile/json', payload)
+            return resp['data']
+        end
+    end
+
+    class Stage
+        @clientw
+        def initialize(clientw)
+            @clientw = clientw
+        end
+
+        def set(options)
+            payload = {
+                "source_id" => options['source_id'],
+                "stage" => options["stage"]
+            }
+            payload = ReqUtils.add_if_not_blank(payload, 'profile_id', options['profile_id'])
+            payload = ReqUtils.add_if_not_blank(payload, 'profile_reference', options['profile_reference'])
+            payload = ReqUtils.add_if_not_blank(payload, 'filter_id', options['filter_id'])
+            payload = ReqUtils.add_if_not_blank(payload, 'filter_reference', options['filter_reference'])
+            resp = @clientw.patch("profile/stage", payload)
+            return resp['data']
+        end
+    end
+
+    class Rating
+        @clientw
+        def initialize(clientw)
+            @clientw = clientw
+        end
+
+        def set(options)
+            payload = {
+                "source_id" => options['source_id'],
+                "rating" => options["rating"]
+            }
+            payload = ReqUtils.add_if_not_blank(payload, 'profile_id', options['profile_id'])
+            payload = ReqUtils.add_if_not_blank(payload, 'profile_reference', options['profile_reference'])
+            payload = ReqUtils.add_if_not_blank(payload, 'filter_id', options['filter_id'])
+            payload = ReqUtils.add_if_not_blank(payload, 'filter_reference', options['filter_reference'])
+            resp = @clientw.patch("profile/rating", payload)
+            return resp['data']
+        end
+    end
+
+end

data/lib/requtils.rb

@@ -0,0 +1,46 @@
+require 'active_support'
+require 'active_support/core_ext'
+
+require_relative 'riminderException.rb'
+
+
+
+class ReqUtils
+    def self.add_if_not_blank(to_fill, key, elem)
+        if (!elem.nil? && !elem.blank?)
+            to_fill[key] = elem
+        end
+        return to_fill
+    end
+
+    def self.assertIDRef(prefix, options)
+        ref = prefix + '_id'
+        id = prefix + '_reference'
+        if (!options.key?(ref) && !options.key?(id))
+            raise RiminderArgumentException("'%s' or '%s' should exist in options"[ref, id])
+        end
+    end
+
+    def self.validateTrainingMetadata(to_validate)
+        if (to_validate.kind_of?(NilClass) || to_validate.nil?)
+            return to_validate
+        end
+        # True if have to be filled els otherwise
+        mandatory_keys = {'filter_reference' => true, 'stage' => false, 'stage_timestamp' => false, 'rating' => false, 'rating_timestamp' => false}
+        if (!to_validate.kind_of?(Array))
+            raise RiminderArgumentException.new('Training metadatas should be an array.')
+        end
+        mandatory_keys.each_pair{|key, shouldbefilled|
+            to_validate.each {|to_validate_elem|
+                if (!to_validate_elem.key?(key))
+                    raise RiminderArgumentException.new('All training metadata should contain %s' [key])
+                end
+                if (shouldbefilled && to_validate_elem[key].blank?)
+                    raise RiminderArgumentException.new('All training metadata should contain %s not nil or empty' [key])
+                end
+
+            }
+        }
+        return to_validate
+    end
+end

data/lib/restClientW.rb

@@ -0,0 +1,87 @@
+require 'rest-client'
+require 'json'
+
+require_relative 'riminderException.rb'
+
+class RestClientW
+
+    @base_url
+    @base_headers
+    def initialize(base_url, headers)
+        @base_headers = headers
+        @base_url = base_url    
+    end
+
+    def fill_header_params_for_get(params)
+        headrs = {}
+        headrs["params"] = params
+        @base_headers.each_pair {|key, value| headrs[key] = value}
+        return headrs
+    end
+
+    def get(path, params={})
+        url = @base_url + path
+        headrs = fill_header_params_for_get(params)
+        
+        resp = nil
+        begin
+            resp = RestClient::Request.execute(:method => :get, :url => url, :headers => headrs)
+        rescue RestClient::ExceptionWithResponse => exp
+            raise RiminderResponseException.new("Invalid Response: ", exp)
+        rescue RestClient::Exception => exp
+            raise RiminderTransfertException.new("Error during transfert: ", exp)
+        end
+        return JSON.parse(resp)
+    end
+
+    def post(path, payload={})
+        url = @base_url + path
+
+        json_payload = payload.to_json
+        begin
+            resp = RestClient.post url, json_payload, @base_headers
+        rescue RestClient::ExceptionWithResponse => exp
+            raise RiminderResponseException.new("Invalid Response: ", exp)
+        rescue RestClient::Exception => exp
+            raise RiminderTransfertException.new("Error during transfert: ", exp)
+        end
+
+        return JSON.parse(resp)
+    end
+
+    def fill_postfile_multipart(multipart, payload)
+        payload.each_pair {|key, value| multipart[key] = value }
+        return multipart
+    end
+
+    def postfile(path, file_path, payload={})
+        url = @base_url + path
+        
+        multipart = {:file => File.new(file_path, 'rb'), :multipart => true}
+        multipart = fill_postfile_multipart(multipart, payload)
+        
+        begin
+            resp = RestClient.post url, multipart, @base_headers
+        rescue RestClient::ExceptionWithResponse => exp
+            raise RiminderResponseException.new("Invalid Response: ", exp)
+        rescue RestClient::Exception => exp
+            raise RiminderTransfertException.new("Error during transfert: ", exp)
+        end
+        return JSON.parse(resp)
+    end
+
+    def patch(path, payload={})
+        url = @base_url + path
+
+        json_payload = payload.to_json
+        begin
+            resp = RestClient.patch url, json_payload, @base_headers
+        rescue RestClient::ExceptionWithResponse => exp
+            raise RiminderResponseException.new("Invalid Response: ", exp)
+        rescue RestClient::Exception => exp
+            raise RiminderTransfertException.new("Error during transfert: ", exp)
+        end
+        return JSON.parse(resp)
+    end
+        
+end

data/lib/riminder.rb

@@ -0,0 +1,31 @@
+require_relative 'restClientW.rb'
+require_relative 'source.rb'
+require_relative 'filter.rb'
+require_relative 'profile.rb'
+require_relative 'webhook.rb'
+
+class Riminder
+    @api_key
+    @webhook_key
+    @base_url
+    @clientw
+    attr_reader :source
+    attr_reader :filter
+    attr_reader :profile
+    attr_reader :webhooks
+
+    def initialize(api_key, webhook_key=nil, base_url='https://www.riminder.net/sf/public/api/v1.0/')
+        @api_key = api_key
+        @webhook_key = webhook_key
+        @base_url = base_url
+        headrs = {'X-API-KEY' => api_key}
+        @clientw = RestClientW.new(base_url, headrs)
+
+        @source = Source.new(@clientw)
+        @filter = Filter.new(@clientw)
+        @profile = Profile.new(@clientw)
+        @webhooks = Webhooks.new(@clientw, webhook_key)
+
+    end
+
+end

data/lib/riminderException.rb

@@ -0,0 +1,41 @@
+class RiminderException < StandardError
+    def initialize(msg)
+        super(msg)
+    end
+end
+
+class RiminderArgumentException < RiminderException
+    def initialize(msg)
+        super(msg)
+    end
+end
+
+class RiminderWebhookException < RiminderException
+    def initialize(msg)
+        super(msg)
+    end
+end
+
+class RiminderTransfertException < RiminderException
+    def initialize(msg, exp)
+        msg = msg + exp.to_s + ' => ' + exp.backtrace.to_s
+        super(msg)
+    end
+end
+
+class RiminderResponseException < RiminderException
+    attr_reader :response_body
+    attr_reader :status_code
+
+    def initialize(msg, exp)
+        response_body = exp.http_body
+        if (response_body.length >= 201)
+            response_body = response_body.str[0, 200] + '...'
+        end
+        msg = msg + exp.to_s + " => " + response_body
+
+        @response_body = exp.http_body
+        @status_code = exp.http_code
+        super(msg)
+    end
+end

data/lib/source.rb

@@ -0,0 +1,21 @@
+
+class Source
+    @clientw
+
+    def initialize(clientw)
+        @clientw = clientw
+    end
+
+    def list()
+        resp = @clientw.get("sources")
+        return resp['data']
+    end
+
+    def get(source_id)
+        query = {
+            "source_id" => source_id
+        }
+        resp = @clientw.get("source", query)
+        return resp['data']
+    end
+end

data/lib/webhook.rb

@@ -0,0 +1,131 @@
+require_relative 'riminderException.rb'
+
+
+class Webhooks
+
+    class EventNames
+        EVENT_PROFILE_PARSE_SUCCESS = 'profile.parse.success'
+        EVENT_PROFILE_PARSE_ERROR = 'profile.parse.error'
+        EVENT_PROFILE_SCORE_SUCCESS = 'profile.score.success'
+        EVENT_PROFILE_SCORE_ERROR = 'profile.score.error'
+        EVENT_FILTER_TRAIN_SUCCESS = 'filter.train.success'
+        EVENT_FILTER_TRAIN_ERROR = 'filter.train.error'
+        EVENT_FILTER_TRAIN_START = 'filter.train.start'
+        EVENT_FILTER_SCORE_SUCCESS = 'filter.score.success'
+        EVENT_FILTER_SCORE_ERROR = 'filter.score.error'
+        EVENT_FILTER_SCORE_START = 'filter.score.start'
+        ACTION_STAGE_SUCCESS = 'action.stage.success'
+        ACTION_STAGE_ERROR = 'action.stage.error'
+        ACTION_RATING_SUCCESS = 'action.rating.success'
+        ACTION_RATING_ERROR = 'action.rating.error'
+    end
+
+    SIGNATURE_HEADER = 'HTTP-RIMINDER-SIGNATURE'
+
+    @clientw
+    @webhook_key
+    @handlers
+    def initialize(clientw, webhook_key)
+        @clientw = clientw
+        @webhook_key = webhook_key
+        @handlers = {}
+    
+        @handlers[EventNames::EVENT_PROFILE_PARSE_SUCCESS] = nil
+        @handlers[EventNames::EVENT_PROFILE_PARSE_ERROR] = nil
+        @handlers[EventNames::EVENT_PROFILE_SCORE_SUCCESS] = nil
+        @handlers[EventNames::EVENT_PROFILE_SCORE_ERROR] = nil
+        @handlers[EventNames::EVENT_FILTER_TRAIN_SUCCESS] = nil
+        @handlers[EventNames::EVENT_FILTER_TRAIN_ERROR] = nil
+        @handlers[EventNames::EVENT_FILTER_TRAIN_START] = nil
+        @handlers[EventNames::EVENT_FILTER_SCORE_SUCCESS] = nil
+        @handlers[EventNames::EVENT_FILTER_SCORE_ERROR] = nil
+        @handlers[EventNames::EVENT_FILTER_SCORE_START] = nil
+        @handlers[EventNames::ACTION_STAGE_SUCCESS] = nil
+        @handlers[EventNames::ACTION_STAGE_ERROR] = nil
+        @handlers[EventNames::ACTION_RATING_SUCCESS] = nil
+        @handlers[EventNames::ACTION_RATING_ERROR] = nil
+    end
+
+    def check
+       resp = @clientw.post('webhook/check')
+       return resp["data"]
+    end
+
+    def setHandler(eventName, callback)
+        if (!@handlers.key?(eventName))
+            raise RiminderArgumentException("%s is not a valid event." [eventName])
+        end
+        @handlers[eventName] = callback
+    end
+
+    def removeHandler(eventName)
+        if (!@handlers.key?(eventName))
+            raise RiminderArgumentException("%s is not a valid event." [eventName])
+        end
+        @handlers[eventName] = nil
+    end
+
+    def isHandlerPresent(eventName)
+        if (!@handlers.key?(eventName))
+            raise RiminderArgumentException("%s is not a valid event." [eventName])
+        end
+        return @handlers[eventName].nil
+    end
+
+    def getEncodedHeader(receivedMessage)
+        if (receivedMessage.is_a?(Hash))
+            if (receivedMessage.key?(SIGNATURE_HEADER))
+                return receivedMessage[SIGNATURE_HEADER]
+            end
+            raise RiminderArgumentException.new("Webhhook request header should contain %s key." [SIGNATURE_HEADER])
+        end
+        return receivedMessage
+    end
+
+    def customstrstr(inp, to_replace, by)
+        res = ""
+        inp.each_char {|c|
+            tmpc = c
+            tr_idx = to_replace.index(tmpc)
+            if (!tr_idx.nil? && by.length < tr_idx)
+                    tmpc = by[tr_idx]
+            end
+            res = res + tmpc
+        }
+        return res
+    end
+
+    def base64urlDecode(inp)
+        return Base64.decode64(customstrstr(inp, "-_", "+/"))
+    end
+
+    def isSignatureValid(payload, sign)
+        expectedsign = OpenSSL::HMAC.digest("SHA256", @webhook_key, payload)
+        return expectedsign == sign
+    end
+
+    def handle(receivedMessage)
+        if (@webhook_key.blank?)
+            raise RiminderWebhookException.new("No webhook secret key provided")
+        end
+        encodedMessage = getEncodedHeader(receivedMessage)
+        tmp = encodedMessage.split('.', 2)
+        sign = base64urlDecode(tmp[0])
+        json_payload = base64urlDecode(tmp[1])
+
+        if (!isSignatureValid(json_payload, sign))
+            raise RiminderWebhookException.new("Invalid signature")
+        end
+        payload = JSON.parse(json_payload)
+        
+        payloadtype = payload['type']
+        if (payloadtype.nil? || !@handlers.key?(payloadtype))
+            raise RiminderWebhookException.new("Null or absent webhook type.")
+        end
+        
+        callback = @handlers[payloadtype]
+        if (!callback.nil?)
+            callback.call(payloadtype, payload)
+        end
+    end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: Riminder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gotte Alexandre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: A api client for riminder, permit to access and manipulate some Riminder's
+  services without the web interface.
+email: contact@riminder.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/filter.rb
+- lib/profile.rb
+- lib/requtils.rb
+- lib/restClientW.rb
+- lib/riminder.rb
+- lib/riminderException.rb
+- lib/source.rb
+- lib/webhook.rb
+homepage: https://riminder.net
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/Riminder/ruby-riminder-api
+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
+signing_key: 
+specification_version: 4
+summary: A ruby api client for Riminder api.
+test_files: []