zendesk-tools 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f5dbb43b53a5d36b8267fa908f235123036edb28
+  data.tar.gz: 49cc7c1bda607fcf622a777363ce58c907a835f4
+SHA512:
+  metadata.gz: 62bbbe159db16acd407f30808ebb066215a04404a2c206f31ba681706304b71f0f3c5f8a1c8a07559840801e250ad1d6790cef131136821e9ce8fc4815f401ae
+  data.tar.gz: cc76ed280eead3c76219de63451da42b8300512f1fb1b6b3a7c016f3cfa9fc8b696fdca7ff287cfced5bd42eed526aaa84d06aa3ffd854448da5484c8c4cda92

data/.gitattributes

@@ -0,0 +1,22 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+*.sln    merge=union
+*.csproj merge=union
+*.vbproj merge=union
+*.fsproj merge=union
+*.dbproj merge=union
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zendesk-tools.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 FINN.no AS
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# ZendeskTools
+
+Tools to automate common tasks in ZenDesk.
+
+## Installation
+
+Install the gem:
+
+    $ gem install zendesk-tools --source "http://gems.finn.no"
+
+## Usage
+
+Add a JSON config to ~/.zendesk-tools.json (TODO: make command line ovveride):
+
+    {
+
+      // mandatory
+      "username": "user@example.com",
+      "token": "your_token_here",
+
+      // optional
+      "log_level": "debug",
+      "log_file": "/some/path"
+
+    }
+
+Clean suspended tickets:
+
+    $ zendesk-tools clean-suspended
+
+Upload files to ticket:
+
+    $ zendesk-tools upload-files-to-ticket <ticket_id> <files>
+
+

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/setup'
+require 'rake/clean'
+
+Bundler::GemHelper.install_tasks
+
+CLEAN << "pkg"
+CLEAN << "*.gem"
+
+GEM_NAME = "zendesk-tools-#{ZendeskTools::VERSION}.gem"
+
+zdt_gem = file "pkg/#{GEM_NAME}" do |t|
+  mkdir_p "pkg"
+  sh "gem build zendesk-tools.gemspec"
+  mv GEM_NAME, t.name
+end
+
+desc "Build #{zdt_gem.name}"
+task :build => [:clean, zdt_gem.name]
+

data/bin/zendesk-tools

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'zendesk-tools'
+
+cmd = ARGV.shift
+
+if cmd.nil?
+  ZendeskTools.show_config
+  exit 1
+end
+
+case cmd
+when 'clean-suspended'
+  ZendeskTools::CleanSuspended.run(ARGV)
+when 'upload-files-to-ticket'
+  ZendeskTools::UploadFilesToTicket.run(ARGV)
+when 'recover-suspended'
+  ZendeskTools::RecoverSuspended.run(ARGV)
+else
+  abort "Sorry, I don't know how to #{cmd.inspect}"
+end

data/lib/zendesk-tools.rb

@@ -0,0 +1,60 @@
+require "zendesk-tools/version"
+require "zendesk_api"
+require 'json'
+require 'pathname'
+require 'pp'
+require 'logger'
+require 'log4r'
+require 'log4r/config'
+
+require 'zendesk-tools/loggable'
+require 'zendesk-tools/command'
+require 'zendesk-tools/clean_suspended'
+require 'zendesk-tools/upload_files_to_ticket'
+require 'zendesk-tools/recover_suspended'
+
+module ZendeskTools
+  CONFIG_FILE = Pathname.new(File.expand_path("~/.zendesk-tools.json"))
+
+  def self.config
+    @config ||= (
+      if CONFIG_FILE.exist?
+        JSON.parse(CONFIG_FILE.read)
+      else
+        raise "Sorry, could not find JSON config in #{CONFIG_FILE}"
+      end
+    )
+  end
+
+  def self.show_config
+    pp config
+  end
+
+  def self.client
+    @client ||= (ZendeskAPI::Client.new do |c|
+        # Mandatory:
+
+        c.url      = config['url'] || "https://finn.zendesk.com/api/v2"
+        c.username = config.fetch('username')
+        c.token    = config.fetch('token')
+
+        # Optional:
+
+        if %w[debug trace].include? config['log_level']
+          c.logger = Loggable.logger_for("ZendeskAPI")
+        end
+
+        # Retry uses middleware to notify the user
+        # when hitting the rate limit, sleep automatically,
+        # then retry the request.
+        c.retry = true
+
+        # Changes Faraday adapter
+        # config.adapter = :patron
+
+        # Merged with the default client options hash
+        # config.client_options = { :ssl => false }
+      end
+    )
+  end
+end

data/lib/zendesk-tools/clean_suspended.rb

@@ -0,0 +1,40 @@
+module ZendeskTools
+  class CleanSuspended < Command
+    include Loggable
+
+    DELETE_CAUSES = [
+      "Detected email as being from a system user",
+      "Detected as mail loop",
+      "Automated response mail"
+    ]
+
+    DELETE_SUBJECTS = [
+      "Returned mail: see transcript",
+      "Delivery Status Notification (Failure)",
+      "Undeliverable:",
+      "Kan ikke leveres:",
+      "Automatisk svar"
+    ]
+
+    def run
+      @client.suspended_tickets.each do |suspended_ticket|
+        if should_delete?(suspended_ticket)
+          log.info "Deleting: #{suspended_ticket.subject}"
+          suspended_ticket.destroy
+        else
+          log.info "Keeping: #{suspended_ticket.subject}"
+        end
+      end
+    end
+
+    private
+
+    def should_delete?(suspended_ticket)
+      cause   = suspended_ticket.cause
+      subject = suspended_ticket.subject
+
+      DELETE_CAUSES.any? { |delete_cause| cause.include?(delete_cause) } ||
+        DELETE_SUBJECTS.any? { |delete_subject|  subject.include?(delete_subject) }
+    end
+  end
+end

data/lib/zendesk-tools/command.rb

@@ -0,0 +1,15 @@
+module ZendeskTools
+  class Command
+    include Loggable
+
+    def self.run(args)
+      new(ZendeskTools.client, args).run
+    end
+
+    def initialize(client, args)
+      @client = client
+      @args   = args
+    end
+
+  end
+end

data/lib/zendesk-tools/loggable.rb

@@ -0,0 +1,33 @@
+Log4r.define_levels(*Log4r::Log4rConfig::LogLevels)
+
+module ZendeskTools
+  module Loggable
+    def self.logger_for(name)
+      name      = self.class.name
+      log       = Log4r::Logger.new(name)
+      formatter = Log4r::PatternFormatter.new(:pattern => "[%l @ %d] %c: %M")
+
+      log_file = ZendeskTools.config['log_file']
+      if log_file
+        FileUtils.mkdir_p File.dirname(log_file)
+
+        log.add Log4r::FileOutputter.new(name, :filename => log_file, :formatter => formatter)
+      else
+        outputter = Log4r::Outputter.stdout
+        outputter.formatter = formatter
+        log.add outputter
+      end
+
+      level = ZendeskTools.config['log_level']
+      if level
+        log.level = Log4r.const_get(level.to_s.upcase)
+      end
+
+      log
+    end
+
+    def log
+      @log ||= Loggable.logger_for(self.class.name)
+    end
+  end
+end

data/lib/zendesk-tools/recover_suspended.rb

@@ -0,0 +1,102 @@
+require 'net/http'
+require 'tmpdir'
+require 'fileutils'
+
+module ZendeskTools
+  class RecoverSuspended < Command
+    include Loggable
+
+    RECOVER_CAUSES = [
+      "End-user only allowed to update their own tickets"
+    ]
+
+    def initialize(*args)
+      super
+      @tmpdir = Dir.mktmpdir
+    end
+
+    def run
+      @client.suspended_tickets.each do |suspended_ticket|
+        if should_recover?(suspended_ticket)
+          log.info "Recovering: #{suspended_ticket.subject}"
+          # Logic for recovering the tickets
+          # Need to add logic for:
+          # * Grab ticket_id
+          ticket_id = suspended_ticket.ticket_id
+
+          # * Grab author_id
+          author_id = suspended_ticket.author.id
+
+          # * Grab content
+          content = suspended_ticket.content
+
+          # * Create new comment with correct author and content
+          ticket = @client.tickets.find(:id => ticket_id)
+          ticket.comment = ZendeskAPI::Ticket::Comment.new(@client, :value => content, :author_id => author_id)
+
+          # * Check for attachments and logic around that
+
+          suspended_ticket.attachments.each do |attachment|
+            url  = attachment.fetch('content_url')
+            name = attachment.fetch('file_name')
+            path = File.join(@tmpdir, name)
+
+            log.info "downloading #{url}"
+
+            File.open(path, 'wb') { |file| download(url, file) }
+            ticket.comment.uploads << path
+          end
+
+          # * Save comment and upload it to zendesk
+
+          log.info "uploading"
+          ticket.save
+
+          # * delete/destroy the recovered ticket
+          suspended_ticket.destroy
+          log.info "cleaning up"
+          FileUtils.rm_rf @tmpdir
+        else
+          log.info "Not recovering: #{suspended_ticket.subject}"
+        end
+      end
+    end
+
+    private
+
+    def download(url, destination)
+      uri = URI.parse(url)
+
+      resp = Net::HTTP.get_response(uri) do |response|
+        total = response.content_length
+        progress = 0
+        segment_count = 0
+
+        response.read_body do |segment|
+          progress += segment.length
+          segment_count += 1
+
+          if segment_count % 15 == 0
+            percent = (progress.to_f / total.to_f) * 100
+            print "\rDownloading #{url}: #{percent.to_i}% (#{progress} / #{total})"
+            $stdout.flush
+            segment_count = 0
+          end
+
+          destination.write(segment)
+        end
+      end
+
+      unless resp.kind_of?(Net::HTTPSuccess)
+        raise "ERROR:#{resp.code} for #{url}"
+      end
+    end
+
+    def should_recover?(suspended_ticket)
+      cause   = suspended_ticket.cause
+      subject = suspended_ticket.subject
+
+      RECOVER_CAUSES.any? { |recover_cause| cause.include?(recover_cause) }
+    end
+  end
+end

data/lib/zendesk-tools/upload_files_to_ticket.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+module ZendeskTools
+  class UploadFilesToTicket < Command
+
+    def run
+      ticket_id = @args.shift or raise ArgumentError, "sorry, jeg trenger en ticket id"
+      files = @args
+
+      raise ArgumentError, "trenger noen filer å laste opp" if files.empty?
+
+      ticket = @client.tickets.find(:id => ticket_id)
+      ticket or raise "fant ingen ticket med id #{ticket_id.inspect}"
+
+      ticket.comment = ZendeskAPI::Ticket::Comment.new(@client, :value => "Vedlegg fra #{ZendeskTools.config['username']}")
+
+      files.each do |e|
+        ticket.comment.uploads << e
+      end
+
+      print "Laster opp #{files.join ', '}..."
+      ticket.save
+      puts "ferdig."
+    end
+
+  end
+end

data/lib/zendesk-tools/version.rb

@@ -0,0 +1,3 @@
+module ZendeskTools
+  VERSION = "0.0.4"
+end

data/zendesk-tools.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zendesk-tools/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "zendesk-tools"
+  gem.version       = ZendeskTools::VERSION
+  gem.authors       = ["Jari Bakken", "Eivind Throndsen"]
+  gem.email         = ["jari@finn.no", "eivind.throndsen@finn.no"]
+  gem.description   = %q{Tools for FINNs ZenDesk}
+  gem.summary       = %q{Tools for FINNs ZenDesk}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "zendesk_api", "~> 1.3.0"
+  gem.add_dependency "json"
+  gem.add_dependency "rake"
+  gem.add_dependency "geminabox"
+  gem.add_dependency "log4r"
+  gem.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: zendesk-tools
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Jari Bakken
+- Eivind Throndsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zendesk_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: geminabox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Tools for FINNs ZenDesk
+email:
+- jari@finn.no
+- eivind.throndsen@finn.no
+executables:
+- zendesk-tools
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitattributes
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/zendesk-tools
+- lib/zendesk-tools.rb
+- lib/zendesk-tools/clean_suspended.rb
+- lib/zendesk-tools/command.rb
+- lib/zendesk-tools/loggable.rb
+- lib/zendesk-tools/recover_suspended.rb
+- lib/zendesk-tools/upload_files_to_ticket.rb
+- lib/zendesk-tools/version.rb
+- zendesk-tools.gemspec
+homepage: ''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Tools for FINNs ZenDesk
+test_files: []