keytechkit 0.3.17 → 0.3.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b5c86101c08620c9f6217e628728f2a62f299a32a56944682d786c64d020d97
-  data.tar.gz: 4ba5c80ee322c9bca3c9549637f54b9653df0c0e6eaf9d0499c9667c35015880
+  metadata.gz: 64f139c04206b65c49a5d884521669668fa0d3fa1e3d25a551951290727ca34a
+  data.tar.gz: 7f84363fa38b7df27c48a90293477ed318a2c70647e45a0efc14eea28fd31f93
 SHA512:
-  metadata.gz: 9ac047cd7af2528d324b5176ab6ca681742904e01a4b53e862715f70bce001ac084014e62787ec31c221919515dfbff375792c96617a6e0ee39a162f2ac7c6a7
-  data.tar.gz: 3d2c9ffcc8cfb6d5122a6b5f496f26c42d2383e980ed634fa4e0294d93db175d085fefb7f47e385936cfcce5d53838933219afc09c7b571de25e106c251bdba8
+  metadata.gz: 73262ac3bc1316c1842a12fa1b7328fd6319291d8816cc8bdd6fa31126c38f255bdb8bea2a17fa4d24fc8002eadb403bbbdff5a6a5f7502efe08a55915d5b2e0
+  data.tar.gz: 5f41d009fc94257bc50da5d4cc307892d397dfeb104b57c5472c1d96f4c58b3c1208bdf7b85635744664306441c4cf021fcad7138e892d4f2d618d91c8d37793

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keytechkit (0.3.16)
+    keytechkit (0.3.18)
       httparty (~> 0.16)
 
 GEM
@@ -56,7 +56,8 @@ GEM
     erubi (1.7.1)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
-    httparty (0.16.2)
+    httparty (0.16.3)
+      mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     i18n (1.1.1)
       concurrent-ruby (~> 1.0)
@@ -68,6 +69,9 @@ GEM
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (0.9.1)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
     mimemagic (0.3.2)
     mini_mime (1.0.1)
     mini_portile2 (2.3.0)
@@ -143,4 +147,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.5
+   1.17.1

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,86 @@ 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_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
       if response.success?
-        parse_notes(response['NotesList'])
+        note.id = response.headers['location']
+        { id: response.headers['location'] }
       else
+        # TODO: return an error object, dont raise exception
         raise response.response
       end
     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)
+      if response.success?
+        { success: true }
+      else
+        { success: false, error: response.headers['x-errordescription'].to_s }
+      end
+    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/version.rb

@@ -1,5 +1,5 @@
 module KeytechKit
-  VERSION = '0.3.17'
+  VERSION = '0.3.18'
 
   # 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.17
+  version: 0.3.18
 platform: ruby
 authors:
 - Thorsten Claus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2018-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,6 +117,7 @@ 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/search.rb
 - lib/keytechKit/serverinfo.rb
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: keytechkit is a ruby gem to connect to the keytech Web API