zensana 1.5.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e97fa7d7b90bac8416207fa5ac106977a9b9d740
-  data.tar.gz: f2e42a59aa59a9c59816e9e019ea300b21949f2c
+  metadata.gz: ca7b816a078aa4ca6fd657274c90bd8f3432786d
+  data.tar.gz: 906f8a914989097f2a8df7a7fc1ed167c2f74bec
 SHA512:
-  metadata.gz: 8b8fe064dbcb2448348314366fec7874144b42f20ee5f4acf123263a813998026ffa60ca2aea628461567c48f3c7544adf274d6ff03cffae509bec7e58f9984e
-  data.tar.gz: b0ce73be4a761d0d615ef3aaba765bf60b2a605ab9f4818f989a91c45ea04989779f6aa33ce07b8abb0dd33764cb6656b927a3388614a2cf3841affdf5aa4740
+  metadata.gz: 661690811595db9a3bef831e27d4581612106d87ade5016403d95efcbf5fc831464fcafe4f980fb813df1caacc91f50eb660afed0404a75b536cdc0ad9d0226c
+  data.tar.gz: 3877e4bc6521204e86682c2874d867c2e13658b39b876e27bb0468a8a2886056ffa10a70b3250adb364f7447faac584b6cca5a5f1779fe7cc1b3314919401603

data/README.md

@@ -38,8 +38,28 @@ The help is pretty self-explanatory around the options so just try that
 
     $ zensana help
       Commands:
+        zensana group SUBCOMMAND    # perform actions on ZenDesk agent groups
         zensana help [COMMAND]      # Describe available commands or one specific command
         zensana project SUBCOMMAND  # perform actions on Asana projects
+        zensana view SUBCOMMAND     # perform actions on ZenDesk views
+
+#### group command
+
+There is one command for Zendesk groups:
+
+    zensana group find GROUP      # List ZenDesk agent groups that match GROUP (by ID or NAME, regexp accepted)
+
+#### view command
+
+There is one command to generate an export of Zendesk tickets from a
+defined view (provide its id):
+
+    zensana view export VIEW     # Export Zendesk VIEW using the predetermined fields
+
+The csv will contain the following fields:
+
+    Id, Status, Subject, Component, Description,
+    Requester, RequestDate, SolvedDate, Duration
 
 #### project command
 
@@ -67,7 +87,7 @@ control what gets converted.
 
       Convert PROJECT tasks to ZenDesk tickets (exact ID or NAME required)
 
-#### idempotentcy
+##### idempotentcy
 
 To ensure robustness of the conversion, especially given that internet
 connection issues may interrupt it, the project conversion is idempotent

data/lib/zensana/cli.rb

@@ -7,5 +7,8 @@ module Zensana
     desc 'group SUBCOMMAND',   'perform actions on ZenDesk agent groups'
     subcommand 'group', Group
 
+    desc 'view SUBCOMMAND',   'perform actions on ZenDesk views'
+    subcommand 'view', View
+
   end
 end

data/lib/zensana/commands/view.rb

@@ -0,0 +1,90 @@
+require 'csv'
+require 'pry'
+
+module Zensana
+  class Command::View < Zensana::Command
+
+    desc 'export VIEW', 'Export Zendesk VIEW using the predetermined fields'
+    def export(id)
+      view = Zensana::Zendesk::View.new
+      view.find(id)
+
+      unless yes?("This will export the tickets in the view called '#{view.title}' as a CSV. Proceed?", :yellow)
+        say "\nNothing else for me to do, exiting...\n", :red
+        exit
+      end
+
+      tickets = view.tickets
+
+      csv_file = "zendesk_export_view_#{id}_#{Time.now.strftime('%Y_%m_%d_%H%M')}.csv"
+      Dir.chdir file_dir = File.join(Dir.home, 'Downloads')
+
+      CSV.open(csv_file, 'w') do |output|
+        output << %w(Id Status Subject Component Description Requester RequestDate SolvedDate Duration)
+        tickets.each do |ticket|
+          output.puts transform_ticket(ticket)
+        end
+      end
+
+      say "\nYour view has been successfully exported to '#{File.join(file_dir, csv_file)}'", :green
+    end
+
+    private
+
+    # create an array of fields matching the csv header
+    def transform_ticket(ticket)
+      fields = []
+      fields << ticket['id']
+      fields << ticket['status']
+      fields << ticket['subject']
+      fields << get_component(ticket['custom_fields'])
+      fields << clean_text(ticket['description'], 5)
+      fields << get_user_name(ticket['requester_id'])
+      created = Date.parse(ticket['created_at'])
+      updated = Date.parse(ticket['updated_at'])
+      fields << created.to_s
+      fields << updated.to_s
+      fields << (updated - created).to_i
+    end
+
+    def get_user_name(id)
+      user = Zendesk::User.new.find(id)
+      user['name'] || user['email']
+    end
+
+    def get_component(fields)
+      get_custom_field(fields, '24375555').split('_').last
+    end
+
+    def get_custom_field(fields, id)
+      fields.each do |field|
+        return field['value'] if field['id'].to_s == id.to_s
+      end
+    end
+
+    def clean_text(text, max_lines)
+      ''.tap do |result|
+        text.split("\n").each do |line|
+          next if line.empty? || ignore_line?(line)
+          result << line << ' '
+          break if (max_lines -= 1).zero?
+        end
+      end
+    end
+
+    def ignore_line?(line)
+      ignore_list.inject(false) do |result, matcher|
+        result || line.include?(matcher)
+      end
+    end
+
+    def ignore_list
+      [
+        'Original Message', 'From:', 'Sent:',
+        'To:', 'Cc:', 'Subject:',
+        '---', '___', 'Hi ', 'Hi,'
+      ]
+    end
+
+  end
+end

data/lib/zensana/models/zendesk/view.rb

@@ -0,0 +1,42 @@
+require 'json'
+
+module Zensana
+  class Zendesk
+    class View
+      include Zensana::Zendesk::Access
+
+      attr_reader :attributes
+
+      def initialize
+        @attributes = {}
+      end
+
+      def find(id)
+        @attributes = fetch(id)
+      end
+
+      def tickets
+        raise NotFound, "You must fetch the view first!" unless self.id
+        get_tickets self.id
+      end
+
+      def id
+        attributes['id']
+      end
+
+      def method_missing(name, *args, &block)
+        attributes[name.to_s] || super
+      end
+
+      private
+
+      def fetch(id)
+        zendesk_service.fetch("/views/#{id}.json")['view']
+      end
+
+      def get_tickets(id)
+        zendesk_service.fetch("/views/#{id}/tickets.json")['tickets']
+      end
+    end
+  end
+end

data/lib/zensana/version.rb

@@ -1,3 +1,3 @@
 module Zensana
-  VERSION = "1.5.0"
+  VERSION = "1.6.1"
 end

data/lib/zensana.rb

@@ -11,15 +11,18 @@ require 'zensana/models/asana/attachment'
 require 'zensana/models/asana/project'
 require 'zensana/models/asana/task'
 require 'zensana/models/asana/user'
+
 require 'zensana/models/zendesk/attachment'
 require 'zensana/models/zendesk/comment'
 require 'zensana/models/zendesk/group'
 require 'zensana/models/zendesk/ticket'
 require 'zensana/models/zendesk/user'
+require 'zensana/models/zendesk/view'
 
 require 'zensana/command'
 require 'zensana/commands/group'
 require 'zensana/commands/project'
+require 'zensana/commands/view'
 require 'zensana/cli'
 
 module Zensana

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zensana
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Warren Bain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2015-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -145,6 +145,7 @@ files:
 - lib/zensana/command.rb
 - lib/zensana/commands/group.rb
 - lib/zensana/commands/project.rb
+- lib/zensana/commands/view.rb
 - lib/zensana/models/asana/attachment.rb
 - lib/zensana/models/asana/project.rb
 - lib/zensana/models/asana/task.rb
@@ -154,6 +155,7 @@ files:
 - lib/zensana/models/zendesk/group.rb
 - lib/zensana/models/zendesk/ticket.rb
 - lib/zensana/models/zendesk/user.rb
+- lib/zensana/models/zendesk/view.rb
 - lib/zensana/services/asana.rb
 - lib/zensana/services/error.rb
 - lib/zensana/services/response.rb