zammad_api 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b023eaf06caa58b99f661e44a21c22134eb67066658fb159a5e3115073f0082
-  data.tar.gz: 8e95df76d83ad02bead573a2cdfa10c2e53d41b57f7f4d99f1fe2ab25297cb20
+  metadata.gz: e210909fb0d53e8184097f0ac41021ae674a5981b80e4e405631d33d6d07623e
+  data.tar.gz: 83e7ac5be2b238ce682b9f478d0bc7dbab3a00308367a01b95e5fc3c9ee586f5
 SHA512:
-  metadata.gz: e93b71d8c72b44dd4562b6df73e0f1d37125df177cb36731232167da3642358e315d59f9a0baa63dbd4ab6f9ec0dfe4e56887723c2d17c4198142b469ed2f055
-  data.tar.gz: 3a483ddb217434eb46a051a93578a77f401b9b336cb194257488439d578045bb6d6e2f47c56b366f260798f3a0ec251a9558c15f836855f187844ea468f432e6
+  metadata.gz: c8122abe30faebe219bea0e71ac5220a060b6c2f1ac08e2d86783987c4de5280daccd9341627a49da41e2e9eb24d88e7db84350b21d0f9f47feda364066deb8b
+  data.tar.gz: 72f47ce52a5f80a4a17f56bb652324cebee7b07c32ae944901065b09b5850d634081b0ae7278327074f6e546c9be6a68714ce842c078979c13294650f9b771f9

data/lib/zammad_api/client.rb

@@ -6,7 +6,6 @@ require 'zammad_api/dispatcher'
 require 'zammad_api/resources'
 
 module ZammadAPI
-
   class Client
     extend Forwardable
 
@@ -27,7 +26,7 @@ module ZammadAPI
     end
 
     def method_missing(method, *_args)
-      method     = modulize( method.to_s )
+      method     = modulize(method.to_s)
       class_name = "ZammadAPI::Resources::#{method}"
       begin
         class_object = Kernel.const_get(class_name)
@@ -41,7 +40,7 @@ module ZammadAPI
 
     def check_config
       raise 'missing url in config' if !@config[:url]
-      raise 'config url needs to start with http:// or https://' if @config[:url] !~ %r{^(http|https)://}
+      raise '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?
@@ -58,9 +57,9 @@ module ZammadAPI
 
     def modulize(string)
       string.gsub(/__(.?)/) { "::#{$1.upcase}" }
-            .gsub(%r{/(.?)}) { "::#{$1.upcase}" }
-            .gsub(/(?:_+|-+)([a-z])/) { $1.upcase }
-            .gsub(/(\A|\s)([a-z])/) { $1 + $2.upcase }
+        .gsub(%r{/(.?)}) { "::#{$1.upcase}" }
+        .gsub(/(?:_+|-+)([a-z])/) { $1.upcase }
+        .gsub(/(\A|\s)([a-z])/) { $1 + $2.upcase }
     end
   end
 end

data/lib/zammad_api/dispatcher.rb

@@ -1,6 +1,5 @@
 module ZammadAPI
   class Dispatcher
-
     def initialize(transport, resource)
       @transport = transport
       @resource  = resource

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

@@ -2,7 +2,6 @@ require 'zammad_api/list_base'
 
 module ZammadAPI
   class ListAll < ListBase
-
     private
 
     def perform_request(parameter)

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
@@ -14,7 +17,6 @@ module ZammadAPI
     end
 
     def [](position)
-
       local_parameter = @parameter.merge(
         page:     position + 1,
         per_page: 1
@@ -23,7 +25,6 @@ module ZammadAPI
     end
 
     def page(page, per_page, &block)
-
       @parameter[:page]     = page
       @parameter[:per_page] = per_page
       fetch_and_yield_each(&block)
@@ -45,18 +46,14 @@ module ZammadAPI
 
     private
 
-    def fetch_and_yield_each
+    def fetch_and_yield_each(&block)
       result = perform_request(@parameter)
-      result.each { |item|
-        yield item
-      }
+      result.each(&block)
     end
 
     def request(request, url, parameter)
-
       # convert parameters into a GET query
       url += '?' + parameter.map { |key, value|
-
         if !value.is_a? String
           value = value.to_s
         end
@@ -65,17 +62,17 @@ module ZammadAPI
       }.join('&')
 
       response = @transport.get(url: url)
-      data = JSON.parse(response.body)
+      data = safe_json_parse(response.body)
       if response.status != 200
         raise "Can't get .#{request} of object (#{@resource.class.name}): #{data['error']}"
       end
 
       list = []
-      data.each { |local_data|
+      data.each do |local_data|
         item = @resource.new(@transport, local_data)
         item.new_instance = false
         list.push item
-      }
+      end
       list
     end
 

data/lib/zammad_api/list_search.rb

@@ -2,7 +2,6 @@ require 'zammad_api/list_base'
 
 module ZammadAPI
   class ListSearch < ListBase
-
     private
 
     def perform_request(parameter)

data/lib/zammad_api/log.rb

@@ -1,8 +1,8 @@
 module ZammadAPI
   class Log
-
     def initialize(config)
       return if !config[:logger]
+
       require 'logger'
       @logger = Logger.new($stderr)
       #@logger.level = Logger::WARN
@@ -11,6 +11,7 @@ module ZammadAPI
 
     def method_missing(method, *args)
       return if !@logger
+
       @logger.send(method, args)
     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
 
@@ -23,6 +26,7 @@ module ZammadAPI
 
       def method_missing(method, *args)
         return @attributes[method] if !method.to_s.end_with?('=')
+
         method              = method.to_s[0, method.length - 1].to_sym
         @changes[method]    = [@attributes[method], args[0]]
         @attributes[method] = args[0]
@@ -40,9 +44,10 @@ module ZammadAPI
       def destroy
         response = @transport.delete(url: "#{@url}/#{@attributes[:id]}")
         if response.body.to_s != '' && response.body.to_s != ' '
-          data = JSON.parse(response.body)
+          data = safe_json_parse(response.body)
         end
         return true if response.status == 200
+
         raise "Can't destroy object (#{self.class.name}): #{data['error']}"
       end
 
@@ -74,10 +79,11 @@ module ZammadAPI
 
       def self.find(transport, id)
         response = transport.get(url: "#{@url}/#{id}?expand=true")
-        data = JSON.parse(response.body)
+        data = safe_json_parse(response.body)
         if response.status != 200
           raise "Can't find object (#{self.class.name}): #{data['error']}"
         end
+
         item = new(transport, data)
         item.new_instance = false
         item
@@ -99,25 +105,28 @@ module ZammadAPI
 
       def saved_attributes
         return save_new if @new_instance
+
         save_existing
       end
 
       def save_new
         response   = @transport.post(url: "#{@url}?expand=true", params: @attributes)
-        attributes = JSON.parse(response.body)
+        attributes = safe_json_parse(response.body)
         return attributes if response.status == 201
+
         save_error(attributes)
       end
 
       def save_existing
         attributes_to_post = {}
-        @changes.each { |name, values|
+        @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)
+        attributes = safe_json_parse(response.body)
 
         return attributes if response.status == 200
+
         save_error(attributes)
       end
 

data/lib/zammad_api/resources/ticket.rb

@@ -3,16 +3,16 @@ 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)
+    data = safe_json_parse(response.body)
     if response.status != 200
       raise "Can't get articles (#{self.class.name}): #{data['error']}"
     end
 
-    data.collect { |raw|
+    data.collect do |raw|
       item = ZammadAPI::Resources::TicketArticle.new(@transport, raw)
       item.new_instance = false
       item
-    }
+    end
   end
 
   def article(data)
@@ -21,5 +21,4 @@ class ZammadAPI::Resources::Ticket < ZammadAPI::Resources::Base
     item.save
     item
   end
-
 end

data/lib/zammad_api/resources/ticket_article.rb

@@ -2,11 +2,10 @@ class ZammadAPI::Resources::TicketArticle < ZammadAPI::Resources::Base
   url '/api/v1/ticket_articles'
 
   def attachments
-    @attributes[:attachments].collect { |raw|
+    @attributes[:attachments].collect do |raw|
       raw[:ticket_id]  = @attributes[:ticket_id]
       raw[:article_id] = @attributes[:id]
       ZammadAPI::Resources::TicketArticleAttachment.new(@transport, raw)
-    }
+    end
   end
-
 end

data/lib/zammad_api/resources/ticket_article_attachment.rb

@@ -1,6 +1,5 @@
 class ZammadAPI::Resources::TicketArticleAttachment < ZammadAPI::Resources::Base
-
-  def initialize(transport, attributes = {})
+  def initialize(transport, attributes = {}) # rubocop:disable Lint/MissingSuper
     @transport  = transport
     @attributes = attributes
     symbolize_keys_deep!(@attributes)
@@ -13,8 +12,8 @@ class ZammadAPI::Resources::TicketArticleAttachment < ZammadAPI::Resources::Base
   def download
     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)
+
+    data = safe_json_parse(response.body)
     raise "Can't get articles (#{self.class.name}): #{data['error']}"
   end
-
 end

data/lib/zammad_api/resources.rb

@@ -12,6 +12,6 @@ require 'zammad_api/resources/ticket_state'
 require 'zammad_api/resources/ticket_priority'
 
 module ZammadAPI
-  class Resource
+  class Resource # rubocop:disable Lint/EmptyClass
   end
 end

data/lib/zammad_api/transport.rb

@@ -3,7 +3,6 @@ require 'openssl'
 
 module ZammadAPI
   class Transport
-
     attr_accessor :url, :user, :password, :on_behalf_of
 
     def initialize(config, logger)
@@ -12,7 +11,7 @@ module ZammadAPI
       @conn = Faraday.new(url: config[:url]) do |faraday|
         #faraday.request  :url_encoded             # form-encode POST params
         #faraday.response :logger                  # log requests to STDOUT
-        faraday.adapter Faraday.default_adapter  # make requests with Net::HTTP
+        faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
       end
       @conn.headers[:user_agent] = 'Zammad API Ruby'
       if config[:http_token] && !config[:http_token].empty?
@@ -26,16 +25,15 @@ module ZammadAPI
 
     %w[get post put delete].each do |method|
       class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def #{method}(params)
-          run_request(:#{method}, params)
-        end
+        def #{method}(params)               # def get(params)
+          run_request(:#{method}, params)   #   run_request(:get, params)
+        end                                 # end
       RUBY
     end
 
     private
 
     def run_request(verb, param)
-
       @logger.debug "#{verb.to_s.upcase}: #{@url}#{param[:url]}"
 
       with_params = !param[:params].nil?

data/lib/zammad_api/version.rb

@@ -1,3 +1,3 @@
 module ZammadAPI
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.1'.freeze
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zammad_api
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Martin Edenhofer
 - Martin Gruner
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -25,62 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.10
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.10
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Ruby wrapper for the Zammad API v1.0.
 email:
 - support@zammad.org
@@ -91,6 +34,7 @@ files:
 - lib/zammad_api.rb
 - lib/zammad_api/client.rb
 - lib/zammad_api/dispatcher.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
@@ -116,7 +60,7 @@ metadata:
   homepage_uri: https://github.com/zammad/zammad-api-client-ruby
   source_code_uri: https://github.com/zammad/zammad-api-client-ruby
   changelog_uri: https://github.com/zammad/zammad-api-client-ruby/blob/master/CHANGELOG.md
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -124,15 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Zammad API v1.0 client.
 test_files: []