zendesk_api 0.1.7 → 0.1.8

data/lib/zendesk_api/configuration.rb

@@ -1,4 +1,5 @@
 module ZendeskAPI
+  # Holds the configuration options for the client and connection
   class Configuration
     # @return [String] The basic auth username.
     attr_accessor :username

data/lib/zendesk_api/helpers.rb

@@ -1,4 +1,5 @@
 module ZendeskAPI
+  # @private
   module Helpers
     # From https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/modulize.rb
     def self.modulize_string(string)

data/lib/zendesk_api/lru_cache.rb

@@ -1,5 +1,6 @@
 module ZendeskAPI
   # http://codesnippets.joyent.com/posts/show/12329
+  # @private
   class ZendeskAPI::LRUCache
     attr_accessor :size
 

data/lib/zendesk_api/middleware/request/etag_cache.rb

@@ -5,6 +5,7 @@ module ZendeskAPI
     module Request
       # Request middleware that caches responses based on etags
       # can be removed once this is merged: https://github.com/pengwynn/faraday_middleware/pull/42
+      # @private
       class EtagCache < Faraday::Middleware
         def initialize(app, options = {})
           @app = app

data/lib/zendesk_api/middleware/request/retry.rb

@@ -2,8 +2,10 @@ require "faraday/middleware"
 
 module ZendeskAPI
   module Middleware
+    # @private
     module Request
       # Faraday middleware to handle HTTP Status 429 (rate limiting) / 503 (maintenance)
+      # @private
       class Retry < Faraday::Middleware
         DEFAULT_RETRY_AFTER = 10
         ERROR_CODES = [429, 503]

data/lib/zendesk_api/middleware/request/upload.rb

@@ -5,6 +5,7 @@ require 'tempfile'
 module ZendeskAPI
   module Middleware
     module Request
+      # @private
       class Upload < Faraday::Middleware
         def call(env)
           if env[:body]

data/lib/zendesk_api/middleware/response/callback.rb

@@ -3,6 +3,7 @@ require "faraday/response"
 module ZendeskAPI
   module Middleware
     module Response
+      # @private
       class Callback < Faraday::Response::Middleware
         def initialize(app, client)
           super(app)

data/lib/zendesk_api/middleware/response/deflate.rb

@@ -4,6 +4,7 @@ module ZendeskAPI
   module Middleware
     module Response
       # Faraday middleware to handle content-encoding = inflate
+      # @private
       class Deflate < FaradayMiddleware::ResponseMiddleware
         define_parser do |body|
           Zlib::Inflate.inflate(body)

data/lib/zendesk_api/middleware/response/gzip.rb

@@ -1,7 +1,9 @@
 require 'faraday_middleware/response_middleware'
 
 module ZendeskAPI
+  # @private
   module Middleware
+    # @private
     module Response
       # Faraday middleware to handle content-encoding = gzip
       class Gzip < FaradayMiddleware::ResponseMiddleware

data/lib/zendesk_api/middleware/response/logger.rb

@@ -4,6 +4,7 @@ module ZendeskAPI
   module Middleware
     module Response
       # Faraday middleware to handle logging
+      # @private
       class Logger < Faraday::Response::Middleware
         def initialize(app, logger = nil)
           super(app)

data/lib/zendesk_api/middleware/response/parse_iso_dates.rb

@@ -5,6 +5,7 @@ module ZendeskAPI
   module Middleware
     module Response
       # Parse ISO dates from response body
+      # @private
       class ParseIsoDates < Faraday::Response::Middleware
         def call(env)
           response = @app.call(env)

data/lib/zendesk_api/rescue.rb

@@ -1,10 +1,12 @@
 module ZendeskAPI
+  # @private
   module Rescue
     def self.included(klass)
       klass.extend(Methods)
       klass.send(:include, Methods)
     end
 
+    # @private
     module Methods
       def log_error(e, method = false)
         if logger = (@client ? @client.config.logger : Kernel)

data/lib/zendesk_api/resource.rb

@@ -23,15 +23,12 @@ module ZendeskAPI
 
       alias :model_key :resource_name
 
-      # Rails tries to load dependencies, which messes up automatic resource our own loading
-      if method_defined?(:const_missing_without_dependencies)
-        alias :const_missing :const_missing_without_dependencies
-      end
-
+      # @private
       def only_send_unnested_params
         @unnested_params = true
       end
 
+      # @private
       def unnested_params
         @unnested_params ||= false
       end
@@ -50,7 +47,10 @@ module ZendeskAPI
       @association = attributes.delete(:association) || Association.new(:class => self.class)
       @client = client
       @attributes = ZendeskAPI::Trackie.new(attributes)
-      ZendeskAPI::Client.check_deprecated_namespace_usage @attributes, self.class.singular_resource_name
+
+      if self.class.associations.none? {|a| a[:name] == self.class.singular_resource_name}
+        ZendeskAPI::Client.check_deprecated_namespace_usage @attributes, self.class.singular_resource_name
+      end
 
       @attributes.clear_changes unless new_record?
     end
@@ -72,6 +72,7 @@ module ZendeskAPI
       id.nil?
     end
 
+    # @private
     def loaded_associations
       self.class.associations.select do |association|
         loaded = @attributes.method_missing(association[:name])
@@ -84,15 +85,18 @@ module ZendeskAPI
       @association.generate_path(self, *args)
     end
 
+    # Passes #to_json to the underlying attributes hash
     def to_json(*args)
       method_missing(:to_json, *args)
     end
 
+    # @private
     def to_s
       "#{self.class.singular_resource_name}: #{attributes.inspect}"
     end
     alias :inspect :to_s
 
+    # 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)
       other.is_a?(self.class) && ((other.id && other.id == id) || (other.object_id == self.object_id))
@@ -100,6 +104,7 @@ module ZendeskAPI
     alias :eql :==
     alias :hash :id
 
+    # @private
     def inspect
       "#<#{self.class.name} #{@attributes.to_hash.inspect}>"
     end

data/lib/zendesk_api/resources.rb

@@ -0,0 +1,319 @@
+module ZendeskAPI
+# @internal The following are redefined later, but needed by some circular resources (e.g. Ticket -> User, User -> Ticket)
+
+
+  class Ticket < Resource; end
+  class Forum < Resource; end
+  class User < Resource; end
+  class Category < Resource; end
+
+# @internal Begin actual Resource definitions
+
+  class Locale < ReadResource; end
+  class CRMData < DataResource; end
+  class CRMDataStatus < DataResource; end
+  class CustomRole < DataResource; end
+  class Role < DataResource; end
+  class Topic < Resource; end
+  class Bookmark < Resource; end
+  class Ability < DataResource; end
+  class Macro < Resource; end
+  class Group < Resource; end
+  class Trigger < ReadResource; end
+  class SharingAgreement < ReadResource; end
+  class JobStatus < ReadResource; 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, attributes)
+      self.token = upload.token
+    end
+
+    def to_param
+      token
+    end
+  end
+
+  class Upload < Data
+    include Create
+
+    only_send_unnested_params
+
+    has_many Attachment
+  end
+
+  class MobileDevice < Resource
+    # Clears this devices' badge
+    put :clear_badge
+  end
+
+  class Organization < Resource
+    has Ability, :inline => true
+    has Group
+
+    has_many Ticket
+    has_many User
+  end
+
+  class ForumSubscription < Resource
+    only_send_unnested_params
+    has Forum
+    has User
+  end
+
+  class Forum < Resource
+    has Category
+    has Organization
+    has Locale
+
+    has_many Topic
+    has_many :subscriptions, :class => ForumSubscription
+  end
+
+  class Category < Resource
+    has_many Forum
+  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 Attachment
+    end
+
+    class TopicVote < SingularResource
+      only_send_unnested_params
+      has Topic
+      has User
+    end
+
+    has Forum
+    has_many :comments, :class => TopicComment
+    has_many :subscriptions, :class => TopicSubscription
+    has :vote, :class => TopicVote
+
+    def votes(opts = {})
+      return @votes if @votes && !opts[:reload]
+
+      association = ZendeskAPI::Association.new(:class => TopicVote, :parent => self, :path => 'votes')
+      @votes = ZendeskAPI::Collection.new(@client, TopicVote, opts.merge(:association => association))
+    end
+  end
+
+  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 SatisfactionRating < ReadResource
+    has :assignee, :class => User
+    has :requester, :class => User
+    has Ticket
+    has Group
+  end
+
+  class Search
+    class Result < Data; end
+
+    # Creates a search collection
+    def self.search(client, options = {})
+      unless (%w{query external_id} & options.keys.map(&:to_s)).any?
+        warn "you have not specified a query for this search"
+      end
+
+      ZendeskAPI::Collection.new(client, self, options)
+    end
+
+    # Creates the correct resource class from the result_type passed in
+    def self.new(client, attributes)
+      result_type = attributes["result_type"]
+
+      if result_type
+        result_type = ZendeskAPI::Helpers.modulize_string(result_type)
+        klass = ZendeskAPI.const_get(result_type) rescue nil
+      end
+
+      (klass || Result).new(client, attributes)
+    end
+
+    def self.resource_name
+      "search"
+    end
+
+    def self.model_key
+      "results"
+    end
+  end
+
+  class Request < Resource
+    class Comment < ReadResource
+      has_many Attachment, :inline => true
+    end
+
+    has_many Comment
+    has Organization
+  end
+
+  class TicketField < Resource; end
+
+  class TicketComment < Data
+    include Save
+
+    has_many :uploads, :class => Attachment, :inline => true
+    has :author, :class => User
+
+    def save
+      save_associations
+      true
+    end
+
+    alias :save! :save
+  end
+
+  class TicketMetric < ReadResource; end
+
+  class Ticket < Resource
+    class Audit < DataResource; end
+
+    has :requester, :class => User, :inline => :create
+    has :submitter, :class => User
+    has :assignee, :class => User
+    has_many :collaborators, :class => User
+    has_many Audit
+    has :metrics, :class => TicketMetric
+    has Group
+    has :forum_topic, :class => Topic
+    has Organization
+
+    has :comment, :class => TicketComment, :inline => true
+    has :last_comment, :class => TicketComment, :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
+
+    # Recovers this suspended ticket to an actual ticket
+    put :recover
+  end
+
+  class ViewRow < DataResource
+    has Ticket
+
+    # @internal 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 => TicketField
+  end
+
+  class View < ReadResource
+    has_many :rows, :class => ViewRow, :path => "execute"
+    has :execution, :class => ViewExecution
+
+    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 Identity < Resource
+      # Makes this identity the primary one bumping all other identities down one
+      put :make_primary
+
+      # Verifies this identity
+      put :verify
+
+      # Requests verification for this identity
+      put :request_verification
+    end
+
+    def initialize(*)
+      super
+
+      # Needed for side-loading to work
+      self.role_id = role.id if self.key?(:role)
+    end
+
+    has Organization
+
+    has CustomRole, :include => :roles
+    has Role, :inline => true, :include_key => :name
+    has Ability, :inline => true
+
+    has_many Identity
+
+    has_many Request
+    has_many :requested_tickets, :class => Ticket, :path => 'tickets/requested'
+    has_many :ccd_tickets, :class => Ticket, :path => 'tickets/ccd'
+
+    has_many Group
+    has_many GroupMembership
+    has_many Topic
+
+    has_many ForumSubscription
+    has_many TopicSubscription
+    has_many :topic_comments, :class => Topic::TopicComment
+    has_many :topic_votes, :class => Topic::TopicVote
+
+    has CRMData
+    has CRMDataStatus, :path => 'crm_data/status'
+  end
+end
+