zammad_api 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42c75fd97c167f27bec8282ccd8214f3885e051691c042ad0e8e491651814d81
-  data.tar.gz: 949a756e4310f53f9ca929a9e973dcb30af4a80e494e55059da6cac345a8bc28
+  metadata.gz: 60178628e519723ca90e772769e9b61e615d152bdb825210b35e8233b9e15a16
+  data.tar.gz: 92fe4e55cf8230790ce87735120f39934ac9313064f67983e052d7b2fde6126f
 SHA512:
-  metadata.gz: b6625e7abed25c87ae3fe46bf543c9095cc092f61eacc23fded2af1a9807a0fc8ebf589221d6afbb57414704e3c732e9f629f89bf460791cffecd91448398a38
-  data.tar.gz: '0379ee29e881afe691eb7d47b0c2c3dbe01ae0a6eddd73e783d24ec8c07fc0dd635dca03148c9a539c006e5b2ad6c87173b944e5511024849727ffcff58be454'
+  metadata.gz: cb06e3507b9598274739a30aea5e109e4965444f521b925c2c0b949929b786a2cd80b20dbce2ac29323614ac48a1d8bb008b993ae75cc31f7733e63adf4e7b24
+  data.tar.gz: 7bfe654612c6be190f5270b7fb311986e566458d4b6529683347b89d4a39718751702a61ee71904c1deec0d169278d274febe3d8ec62bcbdd8c31cc34122ebbe

data/lib/zammad_api/client.rb

@@ -31,7 +31,7 @@ module ZammadAPI
       begin
         class_object = Kernel.const_get(class_name)
       rescue
-        raise "Resource for #{method} does not exist"
+        raise ResourceNotFoundError, "Resource for #{method} does not exist"
       end
       ZammadAPI::Dispatcher.new(@transport, class_object)
     end
@@ -39,20 +39,20 @@ module ZammadAPI
     private
 
     def check_config
-      raise 'missing url in config' if !@config[:url]
-      raise 'config url needs to start with http:// or https://' if !%r{^(http|https)://}.match?(@config[:url])
+      raise ConfigurationError, 'missing url in config' if !@config[:url]
+      raise ConfigurationError, 'config url needs to start with http:// or https://' if !%r{^(http|https)://}.match?(@config[:url])
 
       # check for token auth
       return if @config[:http_token] && !@config[:http_token].empty?
       return if @config[:oauth2_token] && !@config[:oauth2_token].empty?
 
       if !@config[:user] || @config[:user].empty?
-        raise 'missing user in config'
+        raise ConfigurationError, 'missing user in config'
       end
 
       return if @config[:password] && !@config[:password].empty?
 
-      raise 'missing password in config'
+      raise ConfigurationError, 'missing password in config'
     end
 
     def modulize(string)

data/lib/zammad_api/errors.rb

@@ -0,0 +1,62 @@
+require 'json'
+
+module ZammadAPI
+  class Error < RuntimeError; end
+
+  class ConfigurationError < Error; end
+
+  class ResourceNotFoundError < Error; end
+
+  class ResponseError < Error
+    attr_reader :response, :operation, :resource_class
+
+    def initialize(operation:, response:, resource_class: nil)
+      @operation      = operation
+      @response       = response
+      @resource_class = resource_class
+      super(default_message)
+    end
+
+    def status
+      response&.status
+    end
+
+    def body
+      response&.body
+    end
+
+    def self.from(response, **kwargs)
+      klass = if response.nil?
+                self
+              elsif response.status >= 500
+                ServerError
+              else
+                ClientError
+              end
+      klass.new(response: response, **kwargs)
+    end
+
+    private
+
+    def default_message
+      subject = resource_class ? "#{operation} (#{resource_class.name})" : operation
+      "Can't #{subject}: #{detail}"
+    end
+
+    def detail
+      body_error || "HTTP #{status}"
+    end
+
+    def body_error
+      return nil if body.to_s.strip.empty?
+
+      parsed = JSON.parse(body)
+      parsed.is_a?(Hash) ? parsed['error'] : nil
+    rescue JSON::ParserError
+      nil
+    end
+  end
+
+  class ClientError < ResponseError; end
+  class ServerError < ResponseError; end
+end

data/lib/zammad_api/json_helper.rb

@@ -0,0 +1,11 @@
+require 'json'
+
+module ZammadAPI
+  module JsonHelper
+    def safe_json_parse(string)
+      JSON.parse(string)
+    rescue JSON::ParserError
+      {}
+    end
+  end
+end

data/lib/zammad_api/list_base.rb

@@ -1,6 +1,9 @@
+require 'zammad_api/json_helper'
+
 module ZammadAPI
   class ListBase
     include Enumerable
+    include ZammadAPI::JsonHelper
 
     def initialize(resource, transport, parameter = {})
       @resource  = resource
@@ -59,11 +62,12 @@ module ZammadAPI
       }.join('&')
 
       response = @transport.get(url: url)
-      data = JSON.parse(response.body)
       if response.status != 200
-        raise "Can't get .#{request} of object (#{@resource.class.name}): #{data['error']}"
+        raise ResponseError.from(response, operation: "get .#{request} of object", resource_class: @resource.class)
       end
 
+      data = safe_json_parse(response.body)
+
       list = []
       data.each do |local_data|
         item = @resource.new(@transport, local_data)
@@ -74,7 +78,7 @@ module ZammadAPI
     end
 
     def perform_request(_parameter)
-      raise "no perform_request implementation for #{self.class.name} found"
+      raise Error, "no perform_request implementation for #{self.class.name} found"
     end
   end
 end

data/lib/zammad_api/resources/base.rb

@@ -1,10 +1,13 @@
 require 'cgi'
-require 'json'
+require 'zammad_api/json_helper'
 require 'zammad_api/transport'
 
 module ZammadAPI
   module Resources
     class Base
+      include ZammadAPI::JsonHelper
+      extend ZammadAPI::JsonHelper
+
       attr_accessor :new_instance, :url, :attributes
       attr_reader :changes
 
@@ -35,17 +38,14 @@ module ZammadAPI
       end
 
       def changed?
-        @changes.present?
+        !@changes.to_h.empty?
       end
 
       def destroy
         response = @transport.delete(url: "#{@url}/#{@attributes[:id]}")
-        if response.body.to_s != '' && response.body.to_s != ' '
-          data = JSON.parse(response.body)
-        end
         return true if response.status == 200
 
-        raise "Can't destroy object (#{self.class.name}): #{data['error']}"
+        raise ResponseError.from(response, operation: 'destroy object', resource_class: self.class)
       end
 
       def save
@@ -76,11 +76,11 @@ module ZammadAPI
 
       def self.find(transport, id)
         response = transport.get(url: "#{@url}/#{id}?expand=true")
-        data = JSON.parse(response.body)
         if response.status != 200
-          raise "Can't find object (#{self.class.name}): #{data['error']}"
+          raise ResponseError.from(response, operation: 'find object', resource_class: self)
         end
 
+        data = safe_json_parse(response.body)
         item = new(transport, data)
         item.new_instance = false
         item
@@ -107,11 +107,10 @@ module ZammadAPI
       end
 
       def save_new
-        response   = @transport.post(url: "#{@url}?expand=true", params: @attributes)
-        attributes = JSON.parse(response.body)
-        return attributes if response.status == 201
+        response = @transport.post(url: "#{@url}?expand=true", params: @attributes)
+        return safe_json_parse(response.body) if response.status == 201
 
-        save_error(attributes)
+        save_error(response)
       end
 
       def save_existing
@@ -119,16 +118,14 @@ module ZammadAPI
         @changes.each do |name, values|
           attributes_to_post[name] = values[1]
         end
-        response   = @transport.put(url: "#{@url}/#{@attributes[:id]}?expand=true", params: attributes_to_post)
-        attributes = JSON.parse(response.body)
-
-        return attributes if response.status == 200
+        response = @transport.put(url: "#{@url}/#{@attributes[:id]}?expand=true", params: attributes_to_post)
+        return safe_json_parse(response.body) if response.status == 200
 
-        save_error(attributes)
+        save_error(response)
       end
 
-      def save_error(attributes)
-        raise "Can't save object (#{self.class.name}): #{attributes['error']}"
+      def save_error(response)
+        raise ResponseError.from(response, operation: 'save object', resource_class: self.class)
       end
 
       def symbolize_keys_deep!(hash)

data/lib/zammad_api/resources/ticket.rb

@@ -3,11 +3,12 @@ class ZammadAPI::Resources::Ticket < ZammadAPI::Resources::Base
 
   def articles
     response = @transport.get(url: "/api/v1/ticket_articles/by_ticket/#{id}?expand=true")
-    data = JSON.parse(response.body)
     if response.status != 200
-      raise "Can't get articles (#{self.class.name}): #{data['error']}"
+      raise ZammadAPI::ResponseError.from(response, operation: 'get articles', resource_class: self.class)
     end
 
+    data = safe_json_parse(response.body)
+
     data.collect do |raw|
       item = ZammadAPI::Resources::TicketArticle.new(@transport, raw)
       item.new_instance = false

data/lib/zammad_api/resources/ticket_article_attachment.rb

@@ -13,7 +13,6 @@ class ZammadAPI::Resources::TicketArticleAttachment < ZammadAPI::Resources::Base
     response = @transport.get(url: "/api/v1/ticket_attachment/#{ticket_id}/#{article_id}/#{id}")
     return response.body if response.status == 200
 
-    data = JSON.parse(response.body)
-    raise "Can't get articles (#{self.class.name}): #{data['error']}"
+    raise ZammadAPI::ResponseError.from(response, operation: 'get articles', resource_class: self.class)
   end
 end

data/lib/zammad_api/transport.rb

@@ -50,7 +50,7 @@ module ZammadAPI
         end
 
         if !on_behalf_of.nil?
-          req.headers['X-On-Behalf-Of'] = on_behalf_of
+          req.headers['From'] = on_behalf_of
         end
 
         yield(req) if block_given?

data/lib/zammad_api/version.rb

@@ -1,3 +1,3 @@
 module ZammadAPI
-  VERSION = '1.3.0'.freeze
+  VERSION = '1.4.0'.freeze
 end

data/lib/zammad_api.rb

@@ -1,4 +1,5 @@
 require 'zammad_api/version'
+require 'zammad_api/errors'
 require 'zammad_api/client'
 
 module ZammadAPI

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zammad_api
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Martin Edenhofer
@@ -34,6 +34,8 @@ files:
 - lib/zammad_api.rb
 - lib/zammad_api/client.rb
 - lib/zammad_api/dispatcher.rb
+- lib/zammad_api/errors.rb
+- lib/zammad_api/json_helper.rb
 - lib/zammad_api/list_all.rb
 - lib/zammad_api/list_base.rb
 - lib/zammad_api/list_search.rb