zendesk_api 0.0.9

data/lib/zendesk_api/resources/forum.rb

@@ -0,0 +1,51 @@
+module ZendeskAPI
+  class ForumSubscription < Resource
+    only_send_unnested_params
+    has :forum
+    has :user
+  end
+
+  class Forum < Resource
+    has :category
+    has :organization
+    has :locale
+
+    has_many :topics
+    has_many :subscriptions, :class => :forum_subscription
+  end
+
+  class Category < Resource
+    has_many :forums
+  end
+
+  class TopicSubscription < Resource
+    only_send_unnested_params
+    has :topic
+    has :user
+  end
+
+  class Topic < Resource
+    class TopicComment < Resource
+      has :topic
+      has :user
+      has_many :attachments
+    end
+
+    class TopicVote < SingularResource
+      only_send_unnested_params
+      has :topic
+      has :user
+    end
+
+    has_many :comments, :class => :topic_comment
+    has_many :subscriptions, :class => :topic_subscription
+    has :vote, :class => :topic_vote 
+
+    def votes(opts = {})
+      return @votes if @votes && !opts[:reload]
+
+      association = ZendeskAPI::Association.new(:class => Topic::TopicVote, :parent => self, :path => 'votes')
+      @votes = ZendeskAPI::Collection.new(@client, Topic::TopicVote, opts.merge(:association => association))
+    end
+  end
+end

data/lib/zendesk_api/resources/misc.rb

@@ -0,0 +1,66 @@
+module ZendeskAPI
+  class Activity < Resource
+    has :user
+    has :actor, :class => :user
+  end
+
+  class Setting < DataResource
+    attr_reader :on
+
+    def initialize(client, attributes = {})
+      @on = attributes.first
+      super(client, attributes[1])
+    end
+  end
+
+  class MobileDevice < Resource
+    put :clear_badge
+  end
+
+  class SatisfactionRating < ReadResource
+    has :assignee, :class => :user 
+    has :requester, :class => :user
+    has :ticket
+    has :group
+  end
+  
+  class Attachment < Data
+    def initialize(client, attributes)
+      if attributes.is_a?(Hash)
+        super
+      else
+        super(client, :file => attributes)
+      end
+    end
+
+    def save
+      upload = Upload.create!(client, :file => file)
+      self.token = upload.token
+    end
+
+    def to_param
+      token
+    end
+  end
+
+  class Upload < Data
+    include Create
+
+    only_send_unnested_params
+    has_many :attachments
+  end
+
+  class Locale < ReadResource; end
+  class Bookmark < Resource; end
+  class Macro < DataResource; end
+
+  class Search < DataResource
+    def self.resource_name
+      "search"
+    end
+
+    def self.model_key
+      "results"
+    end
+  end
+end

data/lib/zendesk_api/resources/playlist.rb

@@ -0,0 +1,64 @@
+module ZendeskAPI
+  class Playlist
+    include Rescue
+
+    attr_reader :ticket
+    attr_accessor :id
+
+    def initialize(client, id)
+      @client, @id = client, id
+      @ticket = nil
+
+      @initialized = false
+      @destroyed = false
+
+      init_playlist
+    end
+
+    def each
+      init_playlist unless initialized?
+
+      while initialized? && !destroyed? && (n = self.next)
+        yield n
+      end
+    end
+
+    def next
+      init_playlist unless initialized?
+      return false if !initialized? || destroyed? 
+
+      response = @client.connection.get("play/next")
+
+      if response.status == 200
+        @ticket = Ticket.new(@client, response.body["ticket"])
+        @ticket
+      else
+        @destroyed = (response.status == 204)
+        nil
+      end
+    end
+
+    def destroy
+      response = @client.connection.delete("play")
+      @destroyed = response.status == 204 
+    end
+
+    def destroyed?
+      @destroyed
+    end
+
+    def initialized?
+      @initialized
+    end
+
+    private
+
+    def init_playlist
+      response = @client.connection.get("views/#{id}/play")
+      @initialized = response.status == 302
+    end
+
+    rescue_client_error :next, :init_playlist
+    rescue_client_error :destroy, :with => false
+  end
+end

data/lib/zendesk_api/resources/ticket.rb

@@ -0,0 +1,76 @@
+module ZendeskAPI
+  class TicketField < Resource; end
+  class TicketComment < Data; end
+  class TicketMetric < ReadResource; end
+
+  class Ticket < Resource
+    class Audit < DataResource; end
+
+    has :requester, :class => :user
+    has :submitter, :class => :user
+    has :assignee, :class => :user
+    has :recipient, :class => :user
+    has_many :collaborators, :class => :user
+    has_many :audits
+    has :metrics, :class => :ticket_metric
+    has :group
+    has :forum_topic, :class => :topic
+    has :organization
+
+    has_many :uploads, :class => :attachment, :inline => true
+    has :comment, :class => :ticket_comment, :inline => true
+
+    # Gets a incremental export of tickets from the start_time until now.
+    # @param [Client] client The {Client} object to be used
+    # @param [Integer] start_time The start_time parameter
+    # @return [Collection] Collection of {Ticket}
+    def self.incremental_export(client, start_time)
+      ZendeskAPI::Collection.new(client, self, :path => "exports/tickets?start_time=#{start_time.to_i}")
+    end
+
+    # Imports a ticket through the imports/tickets endpoint
+    # @param [Client] client The {Client} object to be used
+    # @param [Hash] attributes The attributes to create.
+    # @return [Ticket] Created object or nil
+    def self.import(client, attributes)
+      ticket = new(client, attributes)
+      return unless ticket.save(:path => "imports/tickets")
+      ticket
+    end
+  end
+
+  class SuspendedTicket < ReadResource
+    include Destroy
+    put :recover
+  end
+
+  class ViewRow < DataResource
+    has :ticket
+
+    # Optional columns
+    has :group
+    has :assignee, :class => :user
+    has :requester, :class => :user
+    has :submitter, :class => :user
+    has :organization
+
+    def self.model_key
+      "rows"
+    end
+  end
+
+  class ViewExecution < Data
+    has_many :custom_fields, :class => :ticket_field
+  end
+
+  class View < ReadResource
+    has_many :rows, :class => :view_row, :path => "execute"
+    has :execution, :class => :view_execution
+
+    def self.preview(client, options = {})
+      Zendesk::Collection.new(client, ViewRow, options.merge(:path => "views/preview"))
+    end
+  end
+
+
+end

data/lib/zendesk_api/resources/user.rb

@@ -0,0 +1,44 @@
+require 'zendesk_api/resources/forum'
+
+module ZendeskAPI
+  class CRMData < DataResource; end
+  class CRMDataStatus < DataResource; end
+  class CustomRole < DataResource; end
+
+  class GroupMembership < Resource
+    has :user
+    has :group
+  end
+
+  class User < Resource
+    class Identity < Resource
+      put :make_primary
+      put :verify
+      put :request_verification
+    end
+
+    has :organization
+    has :custom_role
+    has_many :identities
+    has_many :requested_tickets, :class => :ticket, :path => 'tickets/requested'
+    has_many :ccd_tickets, :class => :ticket, :path => 'tickets/ccd'
+
+    has_many :groups
+    has_many :group_memberships
+    has_many :topics
+
+    has_many :forum_subscriptions, :class => "forum/forum_subscription"
+    has_many :topic_subscriptions, :class => "topic/topic_subscription"
+    has_many :topic_comments, :class => "topic/topic_comment"
+    has_many :topic_votes, :class => "topic/vote"
+
+    has :crm_data
+    has :crm_data_status, :path => 'crm_data/status'
+  end
+
+  class Organization < Resource
+    has :group
+    has_many :tickets
+    has_many :users
+  end
+end

data/lib/zendesk_api/track_changes.rb

@@ -0,0 +1,72 @@
+# Shamelessly stolen and modified from https://github.com/archan937/dirty_hashy
+
+module ZendeskAPI
+  module TrackChanges
+    def self.included(base)
+      base.method_defined?(:regular_writer).tap do |defined|
+        base.send :include, InstanceMethods
+        unless defined
+          base.send :alias_method, :_store, :store
+          base.send :alias_method, :store, :regular_writer
+          base.send :alias_method, :[]=, :store
+          base.send :define_method, :update do |other|
+            other.each{|key, value| store key, value}
+          end
+          base.send :alias_method, :merge!, :update
+        end
+      end
+    end
+
+    module InstanceMethods
+      def clear_changes
+        each do |k, v|
+          v.clear_changes if v.respond_to?(:clear_changes)
+        end
+
+        changes.clear
+      end
+
+      def replace(other)
+        clear
+        merge! other
+      end
+
+      def clear
+        keys.each{|key| delete key}
+      end
+
+      def [](key)
+        super(key)
+      end
+
+      def regular_writer(key, value)
+        changes[key] = value
+        defined?(_store) ? _store(key, value) : super(key, value)
+      end
+
+      def delete(key)
+        self[key] = nil
+        super
+      end
+
+      def changes
+        (@changes ||= self.class.superclass.new).tap do |changes|
+          each do |k, v|
+            if v.respond_to?(:changed?) && v.changed?
+              changes[k] = v.changes
+            end
+          end
+        end
+      end
+
+      def changed?(key = nil)
+        if key.nil?
+          !changes.empty? || any? {|_, v| v.respond_to?(:changed?) && v.changed?}
+        else
+          changes.key?(key)
+        end
+      end
+      alias :dirty? :changed?
+    end
+  end
+end

data/lib/zendesk_api/trackie.rb

@@ -0,0 +1,8 @@
+require 'hashie'
+require 'zendesk_api/track_changes'
+
+module ZendeskAPI
+  class Trackie < Hashie::Mash
+    include ZendeskAPI::TrackChanges
+  end
+end

data/lib/zendesk_api/verbs.rb

@@ -0,0 +1,43 @@
+module ZendeskAPI
+  # Creates put, post, delete class methods for custom resource methods.
+  module Verbs
+    include Rescue
+
+    class << self
+      private
+
+      # @macro [attach] container.create_verb 
+      #   @method $1(method)
+      #   Executes a $1 using the passed in method as a path.
+      #   Reloads the resource's attributes if any are in the response body.
+      #
+      #   Created method takes an optional options hash. Valid options to be passed in to the created method: reload (for caching, default: false)
+      def create_verb(verb)
+        define_method verb do |method|
+          define_method method do |*method_args|
+            opts = method_args.last.is_a?(Hash) ? method_args.pop : {}
+            return instance_variable_get("@#{method}") if instance_variable_defined?("@#{verb}") && !opts[:reload]
+
+            response = @client.connection.send(verb, "#{path}/#{method}") do |req|
+              req.body = opts
+            end
+
+            if (resources = response.body[self.class.resource_name]) &&
+              (res = resources.find {|res| res["id"] == id})
+              @attributes = ZendeskAPI::Trackie.new(res)
+              @attributes.clear_changes
+            end
+
+            true
+          end
+
+          rescue_client_error method, :with => false
+        end
+      end
+    end
+
+    create_verb :put
+    create_verb :post
+    create_verb :delete
+  end
+end

data/lib/zendesk_api/version.rb

@@ -0,0 +1,3 @@
+module ZendeskAPI
+  VERSION = "0.0.9"
+end

data/live/Readme.md

@@ -0,0 +1,4 @@
+ - Make an empty account (company name Z3N, email <something>@zendesk.com, so it can be filtered)
+ - add credentials into spec/fixtures/credentials.yml
+ - mark 1 ticket as solved, change end-users email to on your can receive, copy ticket url, login as end-user (do not just assume identity), rate it
+ - create a new ticket and cc "zendesk-api-client-ruby-end-user-#{client.config.username}" (run tests once to create this user)

data/live/activity_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe ZendeskAPI::Activity do
+  it_should_be_readable :activities
+end