keytechkit 0.3.17 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b5c86101c08620c9f6217e628728f2a62f299a32a56944682d786c64d020d97
-  data.tar.gz: 4ba5c80ee322c9bca3c9549637f54b9653df0c0e6eaf9d0499c9667c35015880
+  metadata.gz: fa0f95a22d9077b343cc7cab75cfb545d85e4aefd29a9c51a2f3b4ebfb3e18d8
+  data.tar.gz: 9c90b180a99c22b35259faba4be648e319180a96478573682e4fca1ac416e102
 SHA512:
-  metadata.gz: 9ac047cd7af2528d324b5176ab6ca681742904e01a4b53e862715f70bce001ac084014e62787ec31c221919515dfbff375792c96617a6e0ee39a162f2ac7c6a7
-  data.tar.gz: 3d2c9ffcc8cfb6d5122a6b5f496f26c42d2383e980ed634fa4e0294d93db175d085fefb7f47e385936cfcce5d53838933219afc09c7b571de25e106c251bdba8
+  metadata.gz: aacd94ae0d3f3d37b8757e22e13ba7565a6187e81130f0c39fc4df9a47df54e32589451a50cde99eccbd51f42937b8fc75debd3aab6ffa3b3bd56798f5c81c73
+  data.tar.gz: 3494a40d30960d7f00ff1cd61a19ae9d1569171d85276e7ee9f11da72c6c0153ea937ad8ddbb1c4967a7d9a22d2919e4e5d82699472760106ad9d618de0f6155

data/Gemfile.lock

@@ -1,136 +1,140 @@
 PATH
   remote: .
   specs:
-    keytechkit (0.3.16)
+    keytechkit (1.2.0)
       httparty (~> 0.16)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.1)
-      actionpack (= 5.2.1)
+    actioncable (5.2.4.3)
+      actionpack (= 5.2.4.3)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.1)
-      actionpack (= 5.2.1)
-      actionview (= 5.2.1)
-      activejob (= 5.2.1)
+    actionmailer (5.2.4.3)
+      actionpack (= 5.2.4.3)
+      actionview (= 5.2.4.3)
+      activejob (= 5.2.4.3)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.1)
-      actionview (= 5.2.1)
-      activesupport (= 5.2.1)
-      rack (~> 2.0)
+    actionpack (5.2.4.3)
+      actionview (= 5.2.4.3)
+      activesupport (= 5.2.4.3)
+      rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.1)
-      activesupport (= 5.2.1)
+    actionview (5.2.4.3)
+      activesupport (= 5.2.4.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.1)
-      activesupport (= 5.2.1)
+    activejob (5.2.4.3)
+      activesupport (= 5.2.4.3)
       globalid (>= 0.3.6)
-    activemodel (5.2.1)
-      activesupport (= 5.2.1)
-    activerecord (5.2.1)
-      activemodel (= 5.2.1)
-      activesupport (= 5.2.1)
+    activemodel (5.2.4.3)
+      activesupport (= 5.2.4.3)
+    activerecord (5.2.4.3)
+      activemodel (= 5.2.4.3)
+      activesupport (= 5.2.4.3)
       arel (>= 9.0)
-    activestorage (5.2.1)
-      actionpack (= 5.2.1)
-      activerecord (= 5.2.1)
+    activestorage (5.2.4.3)
+      actionpack (= 5.2.4.3)
+      activerecord (= 5.2.4.3)
       marcel (~> 0.3.1)
-    activesupport (5.2.1)
+    activesupport (5.2.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     arel (9.0.0)
-    builder (3.2.3)
-    concurrent-ruby (1.1.3)
-    crass (1.0.4)
-    diff-lcs (1.3)
-    erubi (1.7.1)
-    globalid (0.4.1)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.4.3)
+    erubi (1.9.0)
+    globalid (0.4.2)
       activesupport (>= 4.2.0)
-    httparty (0.16.2)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.1.1)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    loofah (2.2.3)
+    loofah (2.6.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
-    method_source (0.9.1)
-    mimemagic (0.3.2)
-    mini_mime (1.0.1)
-    mini_portile2 (2.3.0)
-    minitest (5.11.3)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
     multi_xml (0.6.0)
-    nio4r (2.3.1)
-    nokogiri (1.8.5)
-      mini_portile2 (~> 2.3.0)
-    rack (2.0.6)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.1)
-      actioncable (= 5.2.1)
-      actionmailer (= 5.2.1)
-      actionpack (= 5.2.1)
-      actionview (= 5.2.1)
-      activejob (= 5.2.1)
-      activemodel (= 5.2.1)
-      activerecord (= 5.2.1)
-      activestorage (= 5.2.1)
-      activesupport (= 5.2.1)
+    rails (5.2.4.3)
+      actioncable (= 5.2.4.3)
+      actionmailer (= 5.2.4.3)
+      actionpack (= 5.2.4.3)
+      actionview (= 5.2.4.3)
+      activejob (= 5.2.4.3)
+      activemodel (= 5.2.4.3)
+      activerecord (= 5.2.4.3)
+      activestorage (= 5.2.4.3)
+      activesupport (= 5.2.4.3)
       bundler (>= 1.3.0)
-      railties (= 5.2.1)
+      railties (= 5.2.4.3)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.1)
-      actionpack (= 5.2.1)
-      activesupport (= 5.2.1)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.4.3)
+      actionpack (= 5.2.4.3)
+      activesupport (= 5.2.4.3)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
     rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    sprockets (3.7.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.2.1)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    thor (0.20.0)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    websocket-driver (0.7.0)
+    websocket-driver (0.7.2)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
+    websocket-extensions (0.1.5)
 
 PLATFORMS
   ruby
@@ -143,4 +147,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.5
+   1.17.3

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Thorsten Claus
+Copyright (c) 2020 Thorsten Claus
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/keytechKit.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = KeytechKit::VERSION
   spec.author        = "Thorsten Claus"
   spec.email         = ["thorstenclaus@web.de"]
-  spec.summary       = "keytechkit is a ruby gem to connect to the keytech Web API"
+  spec.summary       = "keytechkit is a ruby gem to connect to the keytech API"
   spec.homepage      = "https://claus-software.de"
   spec.license       = "MIT"
   spec.metadata      = { "source_code_uri" => "https://github.com/tclaus/keytechkit.gem" }
@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rails", "~> 5.2"
-       
+
   spec.add_dependency "httparty", "~> 0.16"
 end

data/lib/keytechKit.rb

@@ -1,4 +1,5 @@
 require 'httparty'
+require 'keytechKit/response_helper'
 require 'keytechKit/version'
 require 'keytechKit/serverinfo_handler'
 require 'keytechKit/search'
@@ -20,7 +21,7 @@ module KeytechKit
     attr_reader :base_url
     attr_reader :username
     attr_reader :password
-    
+
 
     # Initializes this class
     # user +baseurl+, +username+ and +password+ to start accessing all other

data/lib/keytechKit/elements/element_files/element_file_handler.rb

@@ -116,46 +116,42 @@ module KeytechKit
       upload_file element_key, parameter
     end
 
-    def remove_masterfile(element_key)
+    def delete_masterfile(element_key)
       file_list = load(element_key)
       if !file_list.nil?
         file_list.each do |file|
-          return remove_file(element_key, file.fileId) if file.fileStorageType.casecmp('master').zero?
+          return delete_file(element_key, file.fileId) if file.fileStorageType.casecmp('master').zero?
         end
       end
-      { success: true, message: "No file found" }
+      { success: true, message: 'No file found' }
     end
 
-    def remove_preview(element_key)
+    def delete_preview(element_key)
       file_list = load(element_key)
       if !file_list.nil?
         file_list.each do |file|
-          return remove_file(element_key, file.fileId) if file.fileStorageType.casecmp('preview').zero?
+          return delete_file(element_key, file.fileId) if file.fileStorageType.casecmp('preview').zero?
         end
       end
-      { success: true, message: "No file found" }
+      { success: true, message: 'No file found' }
     end
 
-    def remove_quickpreview(element_key)
+    def delete_quickpreview(element_key)
       file_list = load(element_key)
       if !file_list.nil?
         file_list.each do |file|
-          return remove_file(element_key, file.fileId) if file.fileStorageType.casecmp('quickpreview').zero?
+          return delete_file(element_key, file.fileId) if file.fileStorageType.casecmp('quickpreview').zero?
         end
       end
-      { success: true, message: "No file found" }
+      { success: true, message: 'No file found' }
     end
 
     private
 
-    def remove_file(element_key, file_id)
+    def delete_file(element_key, file_id)
       parameter = { basic_auth: @auth }
       response = self.class.delete("/elements/#{element_key}/files/#{file_id}", parameter)
-      if response.success?
-        { success: true }
-      else
-        { success: false, error: response.headers['x-errordescription'].to_s }
-      end
+      ResponseHelper.success(response)
     end
 
     def upload_file(element_key, parameter)

data/lib/keytechKit/elements/notes/note.rb

@@ -9,23 +9,28 @@ module KeytechKit
     attr_accessor :createdBy
     attr_accessor :createdByLong
     attr_accessor :id
-    attr_accessor :noteType
+    attr_accessor :note_type
     attr_accessor :subject
     attr_accessor :text
+    attr_accessor :element_key
 
     def initialize(data)
-      self.changedAt = data['ChangedAt']
-      self.changedBy = data['ChangedBy']
-      self.changedByLong = data['ChangedByLong']
+      @changedAt = data['ChangedAt']
+      @changedBy = data['ChangedBy']
+      @changedByLong = data['ChangedByLong']
 
-      self.createdAt = data['CreatedAt']
-      self.createdBy = data['CreatedBy']
-      self.createdByLong = data['CreatedByLong']
+      @createdAt = data['CreatedAt']
+      @createdBy = data['CreatedBy']
+      @createdByLong = data['CreatedByLong']
 
-      self.id = data['ID']
-      self.noteType = data['NoteType']
-      self.subject = data['Subject']
-      self.text = data['Text']
+      @id = data['ID'] || 0
+      @note_type = data['NoteType']
+      @subject = data['Subject']
+      @text = data['Text']
+    end
+
+    def to_hash
+      { NoteType: @note_type, Subject: @subject, Text: @text }
     end
   end
 end

data/lib/keytechKit/elements/notes/note_handler.rb

@@ -1,5 +1,5 @@
 require 'keytechKit/elements/notes/note'
-
+require 'keytechKit/elements/notes/note_type'
 module KeytechKit
   ##
   # Notes
@@ -12,23 +12,76 @@ module KeytechKit
       @auth = { username: username, password: password }
     end
 
-    def load(elementKey)
+    def load(element_key)
       parameter = { basic_auth: @auth }
 
-      response = self.class.get("/elements/#{elementKey}/notes", parameter)
+      response = self.class.get("/elements/#{element_key}/notes", parameter)
+      if response.success?
+        parse_notes(response['NotesList'], element_key)
+      else
+        # TODO: return an error object, dont raise exception
+        raise response.response
+      end
+    end
+
+    def load_note_types
+      parameter = { basic_auth: @auth }
+      response = self.class.get('/notetypes', parameter)
       if response.success?
-        parse_notes(response['NotesList'])
+        parse_note_types(response['Notetypes'])
       else
+        # TODO: return an error object, dont raise exception
         raise response.response
       end
     end
 
+    def create(note_type, element_key)
+      note = Note.new(NoteType: note_type)
+      note.note_type = note_type
+      note.element_key = element_key
+      note
+    end
+
+    def save(note)
+      element_key = note.element_key
+      note_hash = note.to_hash
+      parameter = { basic_auth: @auth,
+                    body: note_hash.to_json,
+                    headers: { 'Content-Type': 'application/json; charset=utf-8
' } }
+
+      response = if note.id.zero?
+                   self.class.post("/elements/#{element_key}/notes", parameter)
+                 else
+                   self.class.put("/elements/#{element_key}/notes", parameter)
+                 end
+      ResponseHelper.created_with_location(response)
+    end
+
+    def remove(note)
+      parameter = { basic_auth: @auth }
+      element_key = note.element_key
+      note_id = note.id
+      response = self.class.delete("/elements/#{element_key}/notes/#{note_id}", parameter)
+      ResponseHelper.success(response)
+    end
+
     private
 
-    def parse_notes(notesResult)
+    def parse_note_types(note_types_data)
+      note_types = []
+      note_types_data.each do |note_type_data|
+        note_type = NoteType.new(note_type_data)
+        note_types.push note_type
+      end
+      note_types
+    end
+
+    def parse_notes(notes_result, element_key)
       notes = []
-      notesResult.each do |notedata|
-        notes.push Note.new(notedata)
+      notes_result.each do |note_data|
+        note = Note.new(note_data)
+        note.element_key = element_key
+        notes.push note
       end
       notes
     end

data/lib/keytechKit/elements/notes/note_type.rb

@@ -0,0 +1,23 @@
+module KeytechKit
+  ##
+  # A single note
+  class NoteType
+    attr_accessor :allow_modify
+    attr_accessor :displaytext
+    attr_accessor :id
+    attr_accessor :is_document_info
+    attr_accessor :is_folder_info
+    attr_accessor :is_masteritem_info
+    attr_accessor :is_system_info
+
+    def initialize(data)
+      @allow_modify = data['AllowModify']
+      @displaytext = data['Displaytext']
+      @id = data['ID']
+      @is_document_info = data['IsDocumentInfo']
+      @is_folder_info = data['IsFolderInfo']
+      @is_document_info = data['IsMasterItemInfo']
+      @is_system_info = data['IsSystemInfo']
+    end
+  end
+end

data/lib/keytechKit/response_helper.rb

@@ -0,0 +1,26 @@
+module KeytechKit
+  # Helps with common responses
+  class ResponseHelper
+    # Returns a success object with success:true / false. If false
+    # it also adds the x-errordescription object from keytech API
+    def self.success(response)
+      if response.success?
+        { success: true }
+      else
+        { success: false, error: response.headers['x-errordescription'].to_s }
+      end
+    end
+
+    # Returns a success object with success:true/false. If true
+    # it adds a ID parameter extracted from the location header.
+    # If false it adds a error response text
+    def self.created_with_location(response)
+      if response.success?
+        { success: true,
+          id: response.headers['location'] }
+      else
+        { success: false, error: response.headers['x-errordescription'].to_s }
+      end
+    end
+  end
+end

data/lib/keytechKit/serverinfo.rb

@@ -1,4 +1,3 @@
-
 module KeytechKit
   ##
   # Provides information about current keytech server
@@ -6,28 +5,33 @@ module KeytechKit
   class Serverinfo
     attr_accessor :response
 
+    attr_accessor :description
     attr_accessor :database_version
     attr_accessor :api_version
-    attr_accessor :server_description
     # Unique ServerID this ID is unique for every installation
     attr_accessor :server_id
+    attr_accessor :allow_status_change
 
     def initialize(result_data)
       parse_response(result_data)
     end
 
     def parse_response(result_data)
+
+      self.response = result_data
+
       result = result_data
       result.each do |kv|
-        puts "Key: #{kv['Key']}, #{kv['Value']}"
-
         case kv['Key']
+        when 'Server Description' then self.description = kv['Value']
         when 'keytech database version' then self.database_version = kv['Value']
         when 'API version' then self.api_version = kv['Value']
+        when 'ServerID' then self.server_id = kv['Value']
+        when 'AllowStatusChange' then self.allow_status_change = kv['Value']
+
           # More fields
         end
       end
     end
-
   end
 end

data/lib/keytechKit/serverinfo_handler.rb

@@ -15,6 +15,8 @@ module KeytechKit
     def load
       response = self.class.get('/serverinfo')
       if response.success?
+        json = JSON.parse(response.body)
+      puts json['ServerInfoResult']
         Serverinfo.new(response['ServerInfoResult'])
       else
         raise response.response

data/lib/keytechKit/tools.rb

@@ -7,9 +7,11 @@ class Tools
 
   # Return a classkey (MI, FD, DO) from a elementkey (MISC_FILE:!234)
   def self.class_type(element_key)
-    classKey = self.class_key(element_key)
-    return 'MI' if classKey.upcase.end_with?('_MI')
-    return 'FD' if classKey.end_with?('_FD', '_WF')
+    class_key = class_key(element_key)
+    return 'MI' if class_key.upcase.end_with?('_MI')
+
+    return 'FD' if class_key.end_with?('_FD', '_WF')
+
     'DO'
   end
 end

data/lib/keytechKit/version.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module KeytechKit
-  VERSION = '0.3.17'
+  VERSION = '1.2.0'
 
   # Public available Demo URL for testing and dsevelopment
-  DEMO_URL = 'https://demo.keytech.de'
+  # DEMO_URL = "https://explorer.keytech.de:8080/keytech"
+  DEMO_URL = 'https://keytech-13.free.beeceptor.com'
 
   # username to access public web API
   DEMO_USER = 'jgrant'
@@ -11,5 +14,4 @@ module KeytechKit
   DEMO_PASSWORD = ''
 
   DEMO_ARTICLE = 'DEFAULT_MI:500228' # Dampfwalze / Steamroller
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keytechkit
 version: !ruby/object:Gem::Version
-  version: 0.3.17
+  version: 1.2.0
 platform: ruby
 authors:
 - Thorsten Claus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,7 +117,9 @@ files:
 - lib/keytechKit/elements/group_by.rb
 - lib/keytechKit/elements/notes/note.rb
 - lib/keytechKit/elements/notes/note_handler.rb
+- lib/keytechKit/elements/notes/note_type.rb
 - lib/keytechKit/elements/search_response_header.rb
+- lib/keytechKit/response_helper.rb
 - lib/keytechKit/search.rb
 - lib/keytechKit/serverinfo.rb
 - lib/keytechKit/serverinfo_handler.rb
@@ -145,9 +147,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
-summary: keytechkit is a ruby gem to connect to the keytech Web API
+summary: keytechkit is a ruby gem to connect to the keytech API
 test_files: []