zammad_api 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1430cf67f29761e9852ef05ae2e47dec4b8f6848
+  data.tar.gz: 71da04439cbcbcb0fba11d01d3af82336250a78e
+SHA512:
+  metadata.gz: 9e141f9947064e2d7995fa458969af5ed35228c985fe56b42538887b1e226267ee371a21de4afaa34a30438717624d8f1a7e8f47aa733c6ddc3eba9f1c349ea2
+  data.tar.gz: 48fc482034cc42bdde3636de3c1208ee698e9882b229b6102fd5aa9e6a0aec67d83a4fd11ba16527743a902b519b44a33b15800661fcb29eabbea1eccf5e5e54

data/lib/zammad_api/client.rb

@@ -0,0 +1,53 @@
+require 'zammad_api/log'
+require 'zammad_api/transport'
+require 'zammad_api/dispatcher'
+require 'zammad_api/resources'
+
+module ZammadAPI
+
+  class Client
+
+    def initialize(config)
+      @config    = config
+      @logger    = ZammadAPI::Log.new(@config)
+      @transport = ZammadAPI::Transport.new(@config, @logger)
+      check_config
+    end
+
+    def method_missing(method, *_args)
+      method     = modulize( method.to_s )
+      class_name = "ZammadAPI::Resources::#{method}"
+      begin
+        class_object = Kernel.const_get(class_name)
+      rescue
+        raise "Resource for #{method} does not exist"
+      end
+      ZammadAPI::Dispatcher.new(@transport, class_object)
+    end
+
+    private
+
+    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)://}
+
+      # check for token auth
+      return if @config[:http_token] && !@config[:http_token].empty?
+
+      if !@config[:user] || @config[:user].empty?
+        raise 'missing user in config'
+      end
+
+      return if @config[:password] && !@config[:password].empty?
+
+      raise 'missing password in config'
+    end
+
+    def modulize(string)
+      string.gsub(/__(.?)/) { "::#{$1.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

@@ -0,0 +1,13 @@
+module ZammadAPI
+  class Dispatcher
+
+    def initialize(transport, resource)
+      @transport = transport
+      @resource  = resource
+    end
+
+    def method_missing(method, *args)
+      @resource.send(method, @transport, args[0])
+    end
+  end
+end

data/lib/zammad_api/list_all.rb

@@ -0,0 +1,12 @@
+require 'zammad_api/list_base'
+
+module ZammadAPI
+  class ListAll < ListBase
+
+    private
+
+    def perform_request(parameter)
+      request('all', @url, parameter)
+    end
+  end
+end

data/lib/zammad_api/list_base.rb

@@ -0,0 +1,85 @@
+module ZammadAPI
+  class ListBase
+
+    def initialize(resource, transport, parameter = {})
+      @resource  = resource
+      @url       = @resource.get_url
+      @transport = transport
+      @parameter = {
+        page:     1,
+        per_page: 10,
+        expand:   'true',
+      }.merge(parameter)
+    end
+
+    def [](position)
+
+      local_parameter = @parameter.merge(
+        page:     position + 1,
+        per_page: 1
+      )
+      perform_request(local_parameter)[0]
+    end
+
+    def page(page, per_page, &block)
+
+      @parameter[:page]     = page
+      @parameter[:per_page] = per_page
+      fetch_and_yield_each(&block)
+    end
+
+    def page_next(&block)
+      @parameter[:page] += 1
+      fetch_and_yield_each(&block)
+    end
+
+    def page_prev(&block)
+      @parameter[:page] -= 1
+      fetch_and_yield_each(&block)
+    end
+
+    def each(&block)
+      fetch_and_yield_each(&block)
+    end
+
+    private
+
+    def fetch_and_yield_each
+      result = perform_request(@parameter)
+      result.each { |item|
+        yield item
+      }
+    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
+
+        "#{key}=#{CGI.escape value}"
+      }.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']}"
+      end
+
+      list = []
+      data.each { |local_data|
+        item = @resource.new(@transport, local_data)
+        item.new_instance = false
+        list.push item
+      }
+      list
+    end
+
+    def perform_request(_parameter)
+      raise "no perform_request implementation for #{self.class.name} found"
+    end
+  end
+end

data/lib/zammad_api/list_search.rb

@@ -0,0 +1,12 @@
+require 'zammad_api/list_base'
+
+module ZammadAPI
+  class ListSearch < ListBase
+
+    private
+
+    def perform_request(parameter)
+      request('search', "#{@url}/search", parameter)
+    end
+  end
+end

data/lib/zammad_api/log.rb

@@ -0,0 +1,17 @@
+module ZammadAPI
+  class Log
+
+    def initialize(config)
+      return if !config[:logger]
+      require 'logger'
+      @logger = Logger.new($stderr)
+      #@logger.level = Logger::WARN
+      @logger.level = Logger::DEBUG
+    end
+
+    def method_missing(method, *args)
+      return if !@logger
+      @logger.send(method, args)
+    end
+  end
+end

data/lib/zammad_api/resources/base.rb

@@ -0,0 +1,130 @@
+require 'cgi'
+require 'json'
+require 'zammad_api/transport'
+
+module ZammadAPI
+  module Resources
+    class Base
+      attr_accessor :new_instance, :url, :attributes
+      attr_reader :changes
+
+      def initialize(transport, attributes = {})
+        @new_instance = true
+        @transport    = transport
+        @changes      = {}
+        @url          = self.class.get_url
+
+        if attributes.nil?
+          attributes = {}
+        end
+        @attributes = attributes
+        symbolize_keys_deep!(@attributes)
+      end
+
+      def method_missing(method, *args)
+        if method.to_s[-1, 1] == '='
+          method              = method.to_s[0, method.length - 1].to_sym
+          @changes[method]    = [@attributes[method], args[0]]
+          @attributes[method] = args[0]
+        end
+        @attributes[method]
+      end
+
+      def new_record?
+        @new_instance
+      end
+
+      def changed?
+        return false if @changes.empty?
+        true
+      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
+        if response.status != 200
+          raise "Can't destroy object (#{self.class.name}): #{data['error']}"
+        end
+        true
+      end
+
+      def save
+        if @new_instance
+          response = @transport.post(url: "#{@url}?expand=true", params: @attributes)
+          attributes = JSON.parse(response.body)
+          if response.status != 201
+            raise "Can't create new object (#{self.class.name}): #{attributes['error']}"
+          end
+        else
+          attributes_to_post = {}
+          @changes.each { |name, values|
+            attributes_to_post[name] = values[1]
+          }
+          response = @transport.put(url: "#{@url}/#{@attributes[:id]}?expand=true", params: attributes_to_post)
+          attributes = JSON.parse(response.body)
+          if response.status != 200
+            raise "Can't update new object (#{self.class.name}): #{attributes['error']}"
+          end
+        end
+        symbolize_keys_deep!(attributes)
+        attributes.delete(:article)
+        @attributes = attributes
+        @new_instance = false
+        @changes = {}
+        true
+      end
+
+      def self.get_url
+        @url
+      end
+
+      def self.url(value)
+        @url = value
+      end
+
+      def self.all(transport, _)
+        ZammadAPI::ListAll.new(self, transport, per_page: 100)
+      end
+
+      def self.search(transport, parameter)
+        ZammadAPI::ListSearch.new(self, transport, parameter)
+      end
+
+      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']}"
+        end
+        item = new(transport, data)
+        item.new_instance = false
+        item
+      end
+
+      def self.create(transport, data)
+        item = new(transport, data)
+        item.save
+        item
+      end
+
+      def self.destroy(transport, id)
+        item = find(transport, id)
+        item.destroy
+        true
+      end
+
+      private
+
+      def symbolize_keys_deep!(hash)
+        hash.keys.each do |key|
+          key_symbol       = key.respond_to?(:to_sym) ? key.to_sym : key
+          hash[key_symbol] = hash.delete key # Preserve order even when key == key_symbol
+
+          symbolize_keys_deep! hash[key_symbol] if hash[key_symbol].is_a? Hash
+        end
+      end
+    end
+  end
+end

data/lib/zammad_api/resources/group.rb

@@ -0,0 +1,3 @@
+class ZammadAPI::Resources::Group < ZammadAPI::Resources::Base
+  url '/api/v1/groups'
+end

data/lib/zammad_api/resources/organization.rb

@@ -0,0 +1,3 @@
+class ZammadAPI::Resources::Organization < ZammadAPI::Resources::Base
+  url '/api/v1/organizations'
+end

data/lib/zammad_api/resources/ticket.rb

@@ -0,0 +1,26 @@
+class ZammadAPI::Resources::Ticket < ZammadAPI::Resources::Base
+  url '/api/v1/tickets'
+
+  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']}"
+    end
+    articles = []
+    data.each { |raw|
+      item = ZammadAPI::Resources::TicketArticle.new(@transport, raw)
+      item.new_instance = false
+      articles.push item
+    }
+    articles
+  end
+
+  def article(data)
+    data['ticket_id'] = @attributes[:id]
+    item = ZammadAPI::Resources::TicketArticle.new(@transport, data)
+    item.save
+    item
+  end
+
+end

data/lib/zammad_api/resources/ticket_article.rb

@@ -0,0 +1,3 @@
+class ZammadAPI::Resources::TicketArticle < ZammadAPI::Resources::Base
+  url '/api/v1/ticket_articles'
+end

data/lib/zammad_api/resources/ticket_priority.rb

@@ -0,0 +1,3 @@
+class ZammadAPI::Resources::TicketPriority < ZammadAPI::Resources::Base
+  url '/api/v1/ticket_priorities'
+end

data/lib/zammad_api/resources/ticket_state.rb

@@ -0,0 +1,3 @@
+class ZammadAPI::Resources::TicketState < ZammadAPI::Resources::Base
+  url '/api/v1/ticket_states'
+end

data/lib/zammad_api/resources/user.rb

@@ -0,0 +1,3 @@
+class ZammadAPI::Resources::User < ZammadAPI::Resources::Base
+  url '/api/v1/users'
+end

data/lib/zammad_api/resources.rb

@@ -0,0 +1,16 @@
+require 'zammad_api/list_base'
+require 'zammad_api/list_all'
+require 'zammad_api/list_search'
+require 'zammad_api/resources/base'
+require 'zammad_api/resources/user'
+require 'zammad_api/resources/group'
+require 'zammad_api/resources/organization'
+require 'zammad_api/resources/ticket'
+require 'zammad_api/resources/ticket_article'
+require 'zammad_api/resources/ticket_state'
+require 'zammad_api/resources/ticket_priority'
+
+module ZammadAPI
+  class Resource
+  end
+end

data/lib/zammad_api/transport.rb

@@ -0,0 +1,63 @@
+require 'faraday'
+require 'openssl'
+
+module ZammadAPI
+  class Transport
+
+    attr_accessor :url, :user, :password
+
+    def initialize(config, logger)
+      @logger = logger
+      @logger.debug "Transport to #{config[:url]} with #{config[:user]}:#{config[:password]}"
+      @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
+      end
+      @conn.headers[:user_agent] = 'Zammad API Ruby'
+      if config[:http_token] && !config[:http_token].empty?
+        @conn.token_auth(config[:http_token])
+      else
+        @conn.basic_auth(config[:user], config[:password])
+      end
+    end
+
+    def get(param)
+      @logger.debug "GET: #{@url}#{param[:url]}"
+      response = @conn.get param[:url]
+      response
+    end
+
+    def post(param)
+      @logger.debug "POST: #{@url}#{param[:url]}"
+      @logger.debug "Params: #{param[:params].inspect}"
+      response = @conn.post do |req|
+        req.url param[:url]
+        req.headers['Content-Type'] = 'application/json'
+        req.body = param[:params].to_json
+      end
+      @logger.debug "Response: #{response.body}"
+      response
+    end
+
+    def put(param)
+      @logger.debug "PUT: #{@url}#{param[:url]}"
+      @logger.debug "Params: #{param[:params].inspect}"
+      response = @conn.put do |req|
+        req.url param[:url]
+        req.headers['Content-Type'] = 'application/json'
+        req.body = param[:params].to_json
+      end
+      @logger.debug "Response: #{response.body}"
+      response
+    end
+
+    def delete(param)
+      @logger.debug "DELETE: #{@url}#{param[:url]}"
+      response = @conn.delete param[:url]
+      @logger.debug "Response: #{response.body}"
+      response
+    end
+
+  end
+end

data/lib/zammad_api/version.rb

@@ -0,0 +1,3 @@
+module ZammadAPI
+  VERSION = '0.9.1'.freeze
+end

data/lib/zammad_api.rb

@@ -0,0 +1,5 @@
+require 'zammad_api/version'
+require 'zammad_api/client'
+
+module ZammadAPI
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: zammad_api
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- Martin Edenhofer
+- Thorsten Eckel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby wrapper for the Zammad API v1.0.
+email:
+- support@zammad.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/zammad_api.rb
+- lib/zammad_api/client.rb
+- lib/zammad_api/dispatcher.rb
+- lib/zammad_api/list_all.rb
+- lib/zammad_api/list_base.rb
+- lib/zammad_api/list_search.rb
+- lib/zammad_api/log.rb
+- lib/zammad_api/resources.rb
+- lib/zammad_api/resources/base.rb
+- lib/zammad_api/resources/group.rb
+- lib/zammad_api/resources/organization.rb
+- lib/zammad_api/resources/ticket.rb
+- lib/zammad_api/resources/ticket_article.rb
+- lib/zammad_api/resources/ticket_priority.rb
+- lib/zammad_api/resources/ticket_state.rb
+- lib/zammad_api/resources/user.rb
+- lib/zammad_api/transport.rb
+- lib/zammad_api/version.rb
+homepage: https://github.com/zammad/zammad_api_client_ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Zammad API v1.0 client.
+test_files: []