keytechkit 0.3.18 → 0.3.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64f139c04206b65c49a5d884521669668fa0d3fa1e3d25a551951290727ca34a
-  data.tar.gz: 7f84363fa38b7df27c48a90293477ed318a2c70647e45a0efc14eea28fd31f93
+  metadata.gz: 37dbd8d478d6139c50e9d7d661e5e9787cc54ae063c22fe1531e5d4726fd6f16
+  data.tar.gz: 0f369ab4422ec2a3f7f166ac5aa3b830821d356f1561e04a2733a0e911eb0f95
 SHA512:
-  metadata.gz: 73262ac3bc1316c1842a12fa1b7328fd6319291d8816cc8bdd6fa31126c38f255bdb8bea2a17fa4d24fc8002eadb403bbbdff5a6a5f7502efe08a55915d5b2e0
-  data.tar.gz: 5f41d009fc94257bc50da5d4cc307892d397dfeb104b57c5472c1d96f4c58b3c1208bdf7b85635744664306441c4cf021fcad7138e892d4f2d618d91c8d37793
+  metadata.gz: f6b19ebb9a53bb4b073fea16f45e6f9d0b1073bbca0329701ed3c21fd4a57000cb8c0b96fd827f27034b431e962bced7e68e0a69e193df95e21a5cda9cecb50e
+  data.tar.gz: c533b1696bb1685250c585429f34a90726756ea7afbf79ef6a049620caba4a843a46b78559d2900c60bc75cb9ce45e3c2daae8b3048c47b002755d4fe953ece2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keytechkit (0.3.18)
+    keytechkit (0.3.19)
       httparty (~> 0.16)
 
 GEM

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_handler.rb

@@ -47,20 +47,14 @@ module KeytechKit
       note_hash = note.to_hash
       parameter = { basic_auth: @auth,
                     body: note_hash.to_json,
-                    headers: { 'Content-Type' => 'application/json; charset=utf-8
' } }
+                    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?
-        note.id = response.headers['location']
-        { id: response.headers['location'] }
-      else
-        # TODO: return an error object, dont raise exception
-        raise response.response
-      end
+      ResponseHelper.created_with_location(response)
     end
 
     def remove(note)
@@ -68,11 +62,7 @@ module KeytechKit
       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
+      ResponseHelper.success(response)
     end
 
     private

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/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,5 +1,5 @@
 module KeytechKit
-  VERSION = '0.3.18'
+  VERSION = '0.3.19'
 
   # 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.18
+  version: 0.3.19
 platform: ruby
 authors:
 - Thorsten Claus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2018-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,6 +119,7 @@ files:
 - 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