zendesk_api 0.1.11 → 0.2.1

data/lib/zendesk_api/console/base.rb

@@ -0,0 +1,12 @@
+require 'zendesk_api/console/extensions'
+require 'zendesk_api/console/console'
+
+extend ZendeskAPI::Console
+
+require 'zendesk_api/console/options'
+require 'ripl'
+
+ARGV.clear
+Ripl.shell.prompt = lambda { "#{cwd.respond_to?(:path) ? '/' + cwd.path : cwd} > " }
+Ripl.shell.extend ZendeskAPI::Console::Eval
+Ripl.start

data/lib/zendesk_api/console/console.rb

@@ -0,0 +1,144 @@
+module ZendeskAPI::Console
+  ZD_DIRUP = Object.new.tap do |dir|
+    dir.instance_eval do
+      def /(stuff = nil)
+        puts stuff
+      end
+    end
+  end
+
+  module Eval
+    def loop_eval(str)
+      split = str.split(/\s*\/\s*/)
+      split[1..-1] = split[1..-1].map do |s|
+        s =~ /\d+/ ? s : "\"#{s}\""
+      end
+      split = split.join('/')
+      split += '/' if str[-1] == '/'
+      # puts ZendeskAPI::Console::ZD_DIRUP
+      split.gsub!(/\.\./, "ZendeskAPI::Console::ZD_DIRUP")
+      super(split)
+    end
+  end
+
+  def client(&blk)
+    return @client if @client && blk.nil?
+
+    @client = ZendeskAPI::Client.new do |cfg|
+      config.each do |k,v|
+        cfg.send("#{k}=", v)
+      end if config.keys.any?
+      blk.call(cfg) unless blk.nil?
+    end
+  end
+
+  def help
+    <<-END
+This is help.
+    END
+  end
+
+  def username(username)
+    client.config.username = username
+  end
+
+  def password(password)
+    client.config.password = password
+  end
+
+  def basic_auth(username, password)
+    username(username)
+    password(password)
+    true
+  end
+
+  def url(url)
+    client.config.url = url
+  end
+
+  %w(get post put delete).each do |verb|
+    define_method verb do |*args|
+      client.connection.send(verb, *args)
+    end
+  end
+
+  def cd(new_path = nil)
+    if new_path.class.to_s =~ /^Zendesk/
+      @path = new_path
+    elsif new_path.is_a?(Fixnum) && @path
+      @path /= new_path
+    else
+      @path = nil
+    end
+
+    @path
+  end
+
+  def cwd
+    begin
+      path
+    rescue ArgumentError
+      "unconfigured"
+    end
+  end
+
+  def ls(*args)
+    if args.any?
+      args.inject(path) do |obj, arg|
+        obj.send(:/, arg)
+      end
+    elsif path.respond_to?(:to_a)
+      format = to_a.map do |elem|
+        if elem.method(:format).arity == 1
+          elem.format(client)
+        else
+          elem.format
+        end
+      end
+
+      lengths = format.inject([]) do |lengths, object|
+        object.each_with_index do |field, i|
+          lengths[i] = [field.to_s.length, lengths[i] || 0].max
+        end
+
+        lengths
+      end
+
+      format_headers.each_with_index do |header, i|
+        printf("%-#{lengths[i] + 2}s", header)
+      end
+
+      puts
+      puts "---"
+
+      format.each do |object|
+        object.each_with_index do |field, i|
+          printf("%-#{lengths[i] + 2}s", field)
+        end
+
+        puts
+      end
+
+      nil
+    else
+      methods = path.public_methods.reject do |method|
+        method =~ /^orig_/ || method.to_sym == :method_missing ||
+          Object.public_methods.include?(method)
+      end
+    end
+  end
+
+  def method_missing(*args)
+    path.send(*args)
+  end
+
+  def config
+    @options ||= {}
+  end
+
+  private
+
+  def path
+    @path || client
+  end
+end

data/lib/zendesk_api/console/extensions.rb

@@ -0,0 +1,183 @@
+class ZendeskAPI::FormatError < ArgumentError; end
+
+class ZendeskAPI::Collection
+  def /(id)
+    if id == ZendeskAPI::Console::ZD_DIRUP
+      if @collection_path.length == 1
+        @client
+      else
+        @collection_path.shift
+        self
+      end
+    elsif id.is_a?(Fixnum)
+      if loaded?
+        detect {|obj| obj.id == id}
+      else
+        find(:id => id)
+      end
+    elsif !id.is_a?(ZendeskAPI::Collection)
+      send(id)
+    end
+  end
+
+  alias :orig_log_error :log_error
+
+  def log_error(e, _)
+    raise e
+  end
+
+  def loaded?
+    @resources && @resources.any?
+  end
+
+  def to_s
+    path
+  end
+
+  def format_headers
+    @resource_class.format_headers
+  end
+end
+
+class ZendeskAPI::Client
+  GET_SUBCLASSES = lambda do |ary|
+    ary.map! do |klass|
+      if klass.name =~ /Resource$/
+        GET_SUBCLASSES.call(klass.subclasses)
+      else
+        klass
+      end
+    end
+
+    ary.tap(&:flatten!)
+  end
+
+  def to_s
+    "/"
+  end
+
+  def self.resources
+    @resources ||= begin
+      subclasses = GET_SUBCLASSES.call(ZendeskAPI::Data.subclasses)
+      subclasses.delete_if do |resource|
+        resource.name =~ /ZendeskAPI(::.*){2,}/
+      end
+      subclasses.sort_by(&:resource_name)
+    end
+  end
+
+  def to_a
+    self.class.resources
+  end
+
+  def format_headers
+    ["resource name"]
+  end
+end
+
+class ZendeskAPI::Data
+  def /(method)
+    if method == ZendeskAPI::Console::ZD_DIRUP
+      if association.options.parent
+        association.options.parent
+      elsif (res = @client.send(self.class.resource_name)).loaded?
+        res
+      else
+        ZendeskAPI::Collection.new(@client, self.class)
+      end
+    else
+      send(method)
+    end
+  end
+
+  class << self
+    attr_accessor :format_headers
+
+    def format(client = nil, &block)
+      if block_given?
+        class_eval do
+          define_method :format do
+            instance_eval &block
+          end
+        end
+      elsif client && client.send(resource_name).loaded?
+        ["@#{resource_name}"]
+      else
+        [resource_name]
+      end
+    end
+  end
+end
+
+class ZendeskAPI::DataResource
+  format_headers = %w{id created_at}
+
+  format do
+    if self.format_headers
+      self.format_headers.map {|attr| send(attr.to_s.downcase)}
+    else
+      raise ZendeskAPI::FormatError.new("#{self.class.name} hasn't defined an ouput format")
+    end
+  end
+end
+
+module ZendeskAPI
+  ForumSubscription.format_headers = %w{id forum_id user_id created_at}
+  GroupMembership.format_headers = %w{id group_id user_id created_at}
+  TopicSubscription.format_headers = %w{id topic_id user_id created_at}
+  Locale.format_headers = %w{Id Locale Name}
+  TicketField.format_headers = %w{Id Type Title Description}
+  Macro.format_headers = %w{Id Title}
+
+  Forum.format_headers = %w{Id Name Description Created Updated}
+  Forum.format do
+    [id, name, description, created_at, updated_at]
+  end
+
+  Category.format_headers = %w{Id Name Description Position Created Updated}
+  Category.format do
+    [id, name, description, position, created_at, updated_at]
+  end
+
+  Topic.format_headers = %w{Id Title Type}
+  Topic.format do
+    [id, title, topic_type]
+  end
+
+  # Topic::*, MobileDevice, TicketMetric, SuspendedTicket, customRole, CrmData...
+
+  Activity.format_headers = %w{Id Title User Actor Ticket}
+  Activity.format do
+    [id, title, user.name, actor.name, target.ticket.subject]
+  end
+
+  SatisfactionRating.format_headers = %w{Id Ticket Score Comment}
+  SatisfactionRating.format do
+    [id, ticket_id, score, comment]
+  end
+
+  Bookmark.format_headers = %w{Id Ticket Created}
+  Bookmark.format do
+    [id, ticket.id, created_at]
+  end
+
+  User.format_headers = %w{Id Name Email Created Updated}
+  User.format do
+    [id, name, email, created_at, updated_at]
+  end
+
+  Ticket.format_headers = %w{Id Type Subject Description Status Created Updated}
+  Ticket.format do
+    [id, type, subject, description, status, created_at, updated_at]
+  end
+
+  Organization.format_headers = %w{Id Name Created Updated}
+  Organization.format do
+    [id, name, created_at, updated_at]
+  end
+
+  View.format_headers = %w{Id Title Created Updated}
+  View.format do
+    [id, title, created_at, updated_at]
+  end
+end

data/lib/zendesk_api/console/options.rb

@@ -0,0 +1,41 @@
+require 'optparse'
+require 'logger'
+
+begin
+  OptionParser.new do |opts|
+    opts.banner = "Usage: zendesk c[onsole] [options]"
+
+    opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+      config["logger.level"] = v ? Logger::INFO : Logger::WARN
+    end
+
+    opts.on("-c", "--config FILE", "Load a config file") do |c|
+      config.replace(YAML.load_file(c))
+    end
+
+    opts.on("-u", "--username USER", "Sets basic auth username") do |u|
+      config["username"] = u
+    end
+
+    opts.on("-p", "--password PASS", "Sets basic auth password") do |p|
+      config["password"] = p
+    end
+
+    opts.on("-a", "--api URL", "Sets api url") do |a|
+      config["url"] = a
+    end
+
+    opts.on_tail("-h", "--help", "Show this message") do
+      puts opts
+      exit
+    end
+
+    opts.on_tail("--version", "Show version") do
+      puts Zendesk::VERSION
+      exit
+    end
+  end.parse!
+rescue OptionParser::MissingArgument => e
+  puts e.message
+  exit
+end

data/lib/zendesk_api/resource.rb

@@ -11,6 +11,14 @@ module ZendeskAPI
     include Rescue
 
     class << self
+      def inherited(klass)
+        subclasses.push(klass)
+      end
+
+      def subclasses
+        @subclasses ||= []
+      end
+
       # The singular resource name taken from the class name (e.g. ZendeskAPI::Ticket -> ticket)
       def singular_resource_name
         @singular_resource_name ||= ZendeskAPI::Helpers.snakecase_string(to_s.split("::").last)
@@ -39,6 +47,9 @@ module ZendeskAPI
     # @return [ZendeskAPI::Association] The association
     attr_accessor :association
 
+    # Place to dump the last response
+    attr_accessor :response
+
     # Create a new resource instance.
     # @param [Client] client The client to use
     # @param [Hash] attributes The optional attributes that describe the resource
@@ -98,7 +109,7 @@ module ZendeskAPI
 
     # Compares resources by class and id. If id is nil, then by object_id
     def ==(other)
-      warn "Trying to compare #{other.class} to a Resource" if other && !other.is_a?(Data)
+      warn "Trying to compare #{other.class} to a Resource from #{caller.first}" if other && !other.is_a?(Data)
       other.is_a?(self.class) && ((other.id && other.id == id) || (other.object_id == self.object_id))
     end
     alias :eql :==

data/lib/zendesk_api/resources.rb

@@ -10,7 +10,13 @@ module ZendeskAPI
 # @internal Begin actual Resource definitions
 
   class Locale < ReadResource; end
-  class CRMData < DataResource; end
+
+  class CRMData < DataResource
+    class << self
+      alias :resource_name :singular_resource_name
+    end
+  end
+
   class CRMDataStatus < DataResource; end
   class CustomRole < DataResource; end
   class Role < DataResource; end
@@ -88,11 +94,19 @@ module ZendeskAPI
     has User
   end
 
+  class TopicComment < Data
+    has Topic
+    has User
+    has_many Attachment
+  end
+
   class Topic < Resource
-    class TopicComment < Resource
-      has Topic
-      has User
-      has_many Attachment
+    class TopicComment < TopicComment
+      extend Read
+
+      include Create
+      include Update
+      include Destroy
     end
 
     class TopicVote < SingularResource
@@ -194,7 +208,7 @@ module ZendeskAPI
   end
 
   class TicketMetric < DataResource
-    include Read
+    extend Read
   end
 
   class Ticket < Resource
@@ -262,23 +276,29 @@ module ZendeskAPI
     has_many :custom_fields, :class => TicketField
   end
 
+  class ViewCount < DataResource; end
+
   class View < ReadResource
     has_many :tickets, :class => Ticket
     has_many :rows, :class => ViewRow, :path => "execute"
     has :execution, :class => ViewExecution
+    has ViewCount, :path => "count"
 
     def self.preview(client, options = {})
       Collection.new(client, ViewRow, options.merge(:path => "views/preview", :verb => :post))
     end
   end
 
-
   class GroupMembership < Resource
     has User
     has Group
   end
 
   class User < Resource
+    class TopicComment < TopicComment
+      extend Read
+    end
+
     class Identity < Resource
       # Makes this identity the primary one bumping all other identities down one
       put :make_primary
@@ -315,7 +335,7 @@ module ZendeskAPI
 
     has_many ForumSubscription
     has_many TopicSubscription
-    has_many :topic_comments, :class => Topic::TopicComment
+    has_many :topic_comments, :class => TopicComment
     has_many :topic_votes, :class => Topic::TopicVote
 
     has CRMData