keytechkit 0.3.16 → 0.3.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57f8b73f659fce78a663b2a6ce59c8e622a6a7044e9dd1cdbb322b9c5240788b
-  data.tar.gz: 96beee9a69d2aaa78730bf5a261ae2a6ef51902a4e2c90b7d79f791490626d86
+  metadata.gz: 1b5c86101c08620c9f6217e628728f2a62f299a32a56944682d786c64d020d97
+  data.tar.gz: 4ba5c80ee322c9bca3c9549637f54b9653df0c0e6eaf9d0499c9667c35015880
 SHA512:
-  metadata.gz: 135869814f45a8cde8609cea21fa625896419e8815babce9e007e2193ad678bc3aa5d8683dd7fd2b721a8a4b169428c0da510be6f3c240d5718f4782709a8598
-  data.tar.gz: ce9812073272c2be48c19b0ea757ae91229ca9800c9263a58676d727013b1c0b5e81b5d67f9b5452cd95b83b19b12cdc2c45ff503a04ac7e4512884c129cc03b
+  metadata.gz: 9ac047cd7af2528d324b5176ab6ca681742904e01a4b53e862715f70bce001ac084014e62787ec31c221919515dfbff375792c96617a6e0ee39a162f2ac7c6a7
+  data.tar.gz: 3d2c9ffcc8cfb6d5122a6b5f496f26c42d2383e980ed634fa4e0294d93db175d085fefb7f47e385936cfcce5d53838933219afc09c7b571de25e106c251bdba8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keytechkit (0.3.15)
+    keytechkit (0.3.16)
       httparty (~> 0.16)
 
 GEM
@@ -50,7 +50,7 @@ GEM
       tzinfo (~> 1.1)
     arel (9.0.0)
     builder (3.2.3)
-    concurrent-ruby (1.1.2)
+    concurrent-ruby (1.1.3)
     crass (1.0.4)
     diff-lcs (1.3)
     erubi (1.7.1)

data/README.md

@@ -29,7 +29,22 @@ Refactors will be also made on any time even on minor version change.
 To use this gem have a look in the /spec folder. Every function should be tested.
 You can grab code here and add this to you own projects.
 
-Documentation with code samples will come in the next days. 
+```ruby
+keytech_kit = KeytechKit::KeytechKit.new(keytech_url, keytech_username, keytech_password)
+
+# Perform a fulltext search (q), group results by its class, and sort by
+# creation date
+options = { q: params[:q],
+                groupBy: 'classkey',
+                classes: params[:classes],
+                attributes: 'lister',
+                sortBy: 'created_at' }
+
+    @search_results = keytech_kit.search.query(options)
+```
+
+Full documentation with code samples will come in the next days.
+Latest gem documentation for keytechAPI gem is on [rubydoc](https://www.rubydoc.info/gems/keytechkit)
 
 ## Development
 

data/lib/keytechKit.rb

@@ -20,6 +20,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/classes/layouts.rb

@@ -4,6 +4,7 @@ require 'keytechKit/classes/layout/layout'
 module KeytechKit
   class Layouts
     include HTTParty
+    default_timeout 10
 
     def initialize(base_url, username, password)
       self.class.base_uri(base_url)
@@ -12,15 +13,15 @@ module KeytechKit
 
     def header_layout(classkey)
         # Ab keytedch 14!
-        load_layout(classkey, {"layoutType": "HeaderLayout"})
+        load_layout(classkey, {layoutType: "HeaderLayout"})
     end
 
     def main_layout(classkey)
-        load_layout(classkey, {"layoutType": "DefaultLayout"})
+        load_layout(classkey, {layoutType: "DefaultLayout"})
     end
 
     def explorer_layout(classkey)
-        load_layout(classkey, {"layoutType": "ExplorerLayout"})
+        load_layout(classkey, {layoutType: "ExplorerLayout"})
     end
 
     def lister_layout(classkey)

data/lib/keytechKit/elements/data_dictionary/data_dictionary_handler.rb

@@ -3,7 +3,7 @@ require 'keytechKit/elements/data_dictionary/data_dictionary_definition'
 module KeytechKit
   class DataDictionaryHandler
     include HTTParty
-
+    default_timeout 10
     attr_accessor :keytechkit
 
     def initialize(keytechkit, base_url, username, password)

data/lib/keytechKit/elements/element.rb

@@ -26,26 +26,34 @@ module KeytechKit
     attr_accessor :description
 
     def initialize(data)
-      self.key = data['Key']
-      self.name = data['Name']
+      @key = data['Key']
+      @name = data['Name']
       set_key_value_list(data['KeyValueList'])
 
-      self.displayname = data['DisplayName']
-      self.classDisplayName = data['ClassDisplayName']
-      self.version = data['Version']
-      self.status = data['Status']
-      self.description = data['Description']
 
-      self.changedBy = data['ChangedBy']
-      self.changedByLong = data['ChangedByLong']
-      self.changedAt = data['ChangedAt']
+      @classDisplayName = data['ClassDisplayName']
+      @version = data['Version']
+      @status = data['Status']
+      @description = data['Description']
 
-      self.createdBy = data['CreatedBy']
-      self.createdByLong = data['CreatedByLong']
-      self.createdAt = data['CreatedAt']
+      @changedBy = data['ChangedBy']
+      @changedByLong = data['ChangedByLong']
+      @changedAt = data['ChangedAt']
 
-      self.thumbnailHint = data['ThumbnailHint']
-      self.hasVersions = data['HasVersions']
+      @createdBy = data['CreatedBy']
+      @createdByLong = data['CreatedByLong']
+      @createdAt = data['CreatedAt']
+
+      @thumbnailHint = data['ThumbnailHint']
+      @hasVersions = data['HasVersions']
+
+      class_key = Tools.class_key(@key)
+      project_classes = %w[TASK_WF MAIL_WF]
+      @displayname = if project_classes.include?(class_key)
+                       data['Subject']
+                     else
+                       data['DisplayName']
+                     end
     end
 
     def to_hash
@@ -70,7 +78,7 @@ module KeytechKit
     private
 
     def set_key_value_list(kv_data)
-      self.keyValueList = ({})
+      @keyValueList = ({})
       if kv_data
         kv_data.each do |kvPair|
           keyValueList[kvPair['Key'].to_s] = kvPair['Value']

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

@@ -6,6 +6,7 @@ module KeytechKit
   # Element File handler
   class ElementFileHandler
     include HTTParty
+    default_timeout 10
 
     def initialize(base_url, username, password)
       self.class.base_uri(base_url)
@@ -14,7 +15,7 @@ module KeytechKit
 
     # Returns true or false if a masterfile exist
     def masterfile?(element_key)
-      if Tools.classType(element_key) == 'DO' # Only DO Types can have a file
+      if Tools.class_type(element_key) == 'DO' # Only DO Types can have a file
         file_list = load(element_key)
         unless file_list.nil?
           file_list.each do |file|
@@ -27,7 +28,7 @@ module KeytechKit
 
     # Returns information about masterfile
     def masterfile_info(element_key)
-      if Tools.classType(element_key) == 'DO' # Only DO Types can have a file
+      if Tools.class_type(element_key) == 'DO' # Only DO Types can have a file
         file_list = load(element_key)
         unless file_list.nil?
           file_list.each do |file|

data/lib/keytechKit/elements/element_handler.rb

@@ -7,6 +7,7 @@ module KeytechKit
   # All operations for a element is here
   class ElementHandler
     include HTTParty
+    default_timeout 10
 
     attr_accessor :keytechkit
 

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

@@ -5,6 +5,7 @@ module KeytechKit
   # Notes
   class NoteHandler
     include HTTParty
+    default_timeout 10
 
     def initialize(base_url, username, password)
       self.class.base_uri(base_url)

data/lib/keytechKit/search.rb

@@ -9,6 +9,7 @@ module KeytechKit
   # Can group the results
   class Search
     include HTTParty
+    default_timeout 10
 
     attr_accessor :response
 

data/lib/keytechKit/serverinfo_handler.rb

@@ -5,6 +5,7 @@ module KeytechKit
   # Serverinfo Handler
   class ServerInfoHandler
     include HTTParty
+    default_timeout 10
 
     def initialize(keytechkit, base_url)
       self.class.base_uri(base_url)

data/lib/keytechKit/tools.rb

@@ -1,12 +1,13 @@
 class Tools
+
   # Returns a classkey (MISC_FILE) from a elementkey (MISC_FILE:1234)
-  def self.classKey(element_key)
+  def self.class_key(element_key)
     element_key.split(':').first
   end
 
   # Return a classkey (MI, FD, DO) from a elementkey (MISC_FILE:!234)
-  def self.classType(element_key)
-    classKey = self.classKey(element_key)
+  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')
     'DO'

data/lib/keytechKit/version.rb

@@ -1,5 +1,5 @@
 module KeytechKit
-  VERSION = '0.3.16'
+  VERSION = '0.3.17'
 
   # Public available Demo URL for testing and dsevelopment
   DEMO_URL = 'https://demo.keytech.de'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keytechkit
 version: !ruby/object:Gem::Version
-  version: 0.3.16
+  version: 0.3.17
 platform: ruby
 authors:
 - Thorsten Claus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-08 00:00:00.000000000 Z
+date: 2018-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler