zendesk_api 1.13.4 → 1.29.0

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

@@ -4,10 +4,9 @@ module ZendeskAPI
   module Middleware
     module Response
       class RaiseError < Faraday::Response::RaiseError
-
         def call(env)
           super
-        rescue Faraday::Error::TimeoutError, Faraday::Error::ConnectionFailed => e
+        rescue Faraday::TimeoutError, Faraday::ConnectionFailed => e
           raise Error::NetworkError.new(e, env)
         end
 

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

@@ -1,5 +1,3 @@
-require 'scrub_rb'
-
 module ZendeskAPI
   module Middleware
     module Response

data/lib/zendesk_api/resource.rb

@@ -59,7 +59,7 @@ module ZendeskAPI
       @client = client
       @attributes = ZendeskAPI::Trackie.new(attributes)
 
-      if self.class.associations.none? {|a| a[:name] == 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
 
@@ -81,6 +81,10 @@ module ZendeskAPI
       @attributes.send(*args, &block)
     end
 
+    def respond_to_missing?(method, include_private = false)
+      @attributes.respond_to?(method) || super
+    end
+
     # Returns the resource id of the object or nil
     def id
       key?(:id) ? method_missing(:id) : nil
@@ -117,7 +121,7 @@ module ZendeskAPI
 
     # Compares resources by class and id. If id is nil, then by object_id
     def ==(other)
-      return true if other.object_id == self.object_id
+      return true if other.object_id == object_id
 
       if other && !(other.is_a?(Data) || other.is_a?(Integer))
         warn "Trying to compare #{other.class} to a Resource from #{caller.first}"
@@ -195,6 +199,7 @@ module ZendeskAPI
         @descendants ||= []
         @descendants << base
       end
+
       def descendants
         @descendants || []
       end

data/lib/zendesk_api/resources.rb

@@ -1,14 +1,14 @@
 module ZendeskAPI
-# @internal The following are redefined later, but needed by some circular resources (e.g. Ticket -> User, User -> Ticket)
-
+  # @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 UserRelated < DataResource; end
   class Category < Resource; end
   class OrganizationMembership < ReadResource; end
+  class OrganizationSubscription < ReadResource; end
 
-# @internal Begin actual Resource definitions
+  # @internal Begin actual Resource definitions
 
   class Locale < ReadResource; end
 
@@ -20,7 +20,14 @@ module ZendeskAPI
     end
   end
 
-  class Topic < Resource; end
+  class Topic < Resource
+    class << self
+      def resource_path
+        "community/topics"
+      end
+    end
+  end
+
   class Bookmark < Resource; end
   class Ability < DataResource; end
   class Group < Resource; end
@@ -62,7 +69,7 @@ module ZendeskAPI
         end
 
         true
-      rescue Faraday::Error::ClientError => e
+      rescue Faraday::ClientError => e
         if method == :save
           false
         else
@@ -76,8 +83,8 @@ module ZendeskAPI
     end
   end
 
-  class Attachment < Data
-    def initialize(client, attributes)
+  class Attachment < ReadResource
+    def initialize(client, attributes = {})
       attributes[:file] ||= attributes.delete(:id)
 
       super
@@ -97,7 +104,9 @@ module ZendeskAPI
     include Create
     include Destroy
 
-    def id; token; end
+    def id
+      token
+    end
 
     has_many Attachment
 
@@ -113,14 +122,22 @@ module ZendeskAPI
     put :clear_badge
   end
 
+  class OrganizationRelated < DataResource; end
+
   class Organization < Resource
+    extend CreateMany
+    extend CreateOrUpdate
+    extend DestroyMany
+
     has Ability, :inline => true
     has Group
+    has :related, :class => OrganizationRelated
 
     has_many Ticket
     has_many User
     has_many Tag, :extend => Tag::Update, :inline => :create
     has_many OrganizationMembership
+    has_many :subscriptions, class: OrganizationSubscription
 
     # Gets a incremental export of organizations from the start_time until now.
     # @param [Client] client The {Client} object to be used
@@ -140,11 +157,6 @@ module ZendeskAPI
     end
   end
 
-  class ForumSubscription < Resource
-    has Forum
-    has User
-  end
-
   class OrganizationMembership < ReadResource
     include Create
     include Destroy
@@ -156,91 +168,72 @@ module ZendeskAPI
     has Organization
   end
 
-  class Forum < Resource
-    has Category
-    has Organization
-    has Locale
+  class OrganizationSubscription < ReadResource
+    include Create
+    include Destroy
 
-    has_many Topic
-    has_many :subscriptions, :class => ForumSubscription
+    has User
+    has Organization
   end
 
   class Category < Resource
-    has_many Forum
-  end
+    class << self
+      def resource_path
+        "help_center/categories"
+      end
+    end
 
-  class TopicSubscription < Resource
-    has Topic
-    has User
-  end
+    class Section < Resource
+    end
 
-  class TopicComment < Data
-    has Topic
-    has User
-    has_many Attachment
+    has_many Section
   end
 
-  class Topic < Resource
-    class TopicComment < TopicComment
-      include Read
-      include Create
-      include Update
-      include Destroy
-
-      has_many :uploads, :class => Attachment, :inline => true
-
-      def self.import!(client, attributes)
-        new(client, attributes).tap do |comment|
-          comment.save!(:path => 'import/' + comment.path)
-        end
-      end
-
-      def self.import(client, attributes)
-        comment = new(client, attributes)
-        return unless comment.save(:path => 'import/' + comment.path)
-        comment
+  class Section < ReadResource
+    class << self
+      def resource_path
+        "help_center/sections"
       end
     end
 
-    class TopicVote < SingularResource
-      has Topic
-      has User
-
-      private
+    has Category
 
-      def attributes_for_save
-        attributes.changes
-      end
+    class Article < Resource
     end
 
-    has Forum
-    has_many :comments, :class => TopicComment
-    has_many :subscriptions, :class => TopicSubscription
-    has :vote, :class => TopicVote
-    has_many Tag, :extend => Tag::Update, :inline => :create
-    has_many Attachment
-    has_many :uploads, :class => Attachment, :inline => true
-
-    def votes(opts = {})
-      return @votes if @votes && !opts[:reload]
+    has_many Article
+  end
 
-      association = ZendeskAPI::Association.new(:class => TopicVote, :parent => self, :path => 'votes')
-      @votes = ZendeskAPI::Collection.new(@client, TopicVote, opts.merge(:association => association))
+  class Article < ReadResource
+    class << self
+      def resource_path
+        "help_center/articles"
+      end
     end
+  end
 
-    def self.import!(client, attributes)
-      new(client, attributes).tap do |topic|
-        topic.save!(:path => "import/topics")
+  class TopicSubscription < Resource
+    class << self
+      def model_key
+        "subscriptions"
       end
     end
 
-    def self.import(client, attributes)
-      topic = new(client, attributes)
-      return unless topic.save(:path => "import/topics")
-      topic
+    has Topic
+    has User
+
+    def path(options = {})
+      super(options.merge(:with_parent => true))
     end
   end
 
+  class Topic < Resource
+    has_many :subscriptions, :class => TopicSubscription, :inline => true
+    has_many Tag, :extend => Tag::Update, :inline => :create
+    has_many Attachment
+    has_many :uploads, :class => Attachment, :inline => true
+  end
+
   class Activity < Resource
     has User
     has :actor, :class => User
@@ -434,7 +427,6 @@ module ZendeskAPI
     has_many Audit
     has :metrics, :class => TicketMetric
     has Group
-    has :forum_topic, :class => Topic
     has Organization
     has Brand
     has :related, :class => TicketRelated
@@ -454,7 +446,7 @@ module ZendeskAPI
     # @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}")
+      ZendeskAPI::Collection.new(client, self, :path => "incremental/tickets?start_time=#{start_time.to_i}")
     end
 
     # Imports a ticket through the imports/tickets endpoint using save!
@@ -485,6 +477,15 @@ module ZendeskAPI
     put :recover
   end
 
+  class DeletedTicket < ReadResource
+    include Destroy
+    extend DestroyMany
+
+    # Restores this previously deleted ticket to an actual ticket
+    put :restore
+    put :restore_many
+  end
+
   class UserViewRow < DataResource
     has User
     def self.model_key
@@ -518,11 +519,13 @@ module ZendeskAPI
     private
 
     def attributes_for_save
-      to_save = [:conditions, :actions, :output].inject({}) {|h,k| h.merge(k => send(k))}
+      to_save = [:conditions, :actions, :output].inject({}) { |h, k| h.merge(k => send(k)) }
       { self.class.singular_resource_name.to_sym => attributes.changes.merge(to_save) }
     end
   end
 
+  class TriggerCategory < Resource; end
+
   module Conditions
     def all_conditions=(all_conditions)
       self.conditions ||= {}
@@ -601,7 +604,7 @@ module ZendeskAPI
 
     # Returns the update to a ticket that happens when a macro will be applied.
     # @param [Ticket] ticket Optional {Ticket} to apply this macro to.
-    # @raise [Faraday::Error::ClientError] Raised for any non-200 response.
+    # @raise [Faraday::ClientError] Raised for any non-200 response.
     def apply!(ticket = nil)
       path = "#{self.path}/apply"
 
@@ -610,15 +613,15 @@ module ZendeskAPI
       end
 
       response = @client.connection.get(path)
-      Hashie::Mash.new(response.body.fetch("result", {}))
+      SilentMash.new(response.body.fetch("result", {}))
     end
 
     # Returns the update to a ticket that happens when a macro will be applied.
     # @param [Ticket] ticket Optional {Ticket} to apply this macro to
     def apply(ticket = nil)
       apply!(ticket)
-    rescue Faraday::Error::ClientError => e
-      Hashie::Mash.new
+    rescue Faraday::ClientError
+      SilentMash.new
     end
   end
 
@@ -639,12 +642,10 @@ module ZendeskAPI
   class User < Resource
     extend CreateMany
     extend UpdateMany
+    extend CreateOrUpdate
+    extend CreateOrUpdateMany
     extend DestroyMany
 
-    class TopicComment < TopicComment
-      include Read
-    end
-
     class GroupMembership < Resource
       put :make_default
     end
@@ -723,25 +724,24 @@ module ZendeskAPI
       false
     end
 
+    put :merge
+
     has CustomRole, :inline => true, :include => :roles
     has Role, :inline => true, :include_key => :name
     has Ability, :inline => true
+    has :related, :class => UserRelated
 
     has_many Identity
 
     has_many Request
     has_many :requested_tickets, :class => Ticket, :path => 'tickets/requested'
+    has_many :assigned_tickets, :class => Ticket, :path => 'tickets/assigned'
     has_many :ccd_tickets, :class => Ticket, :path => 'tickets/ccd'
 
     has_many Group
     has_many GroupMembership
-    has_many Topic
     has_many OrganizationMembership
-
-    has_many ForumSubscription
-    has_many TopicSubscription
-    has_many :topic_comments, :class => TopicComment
-    has_many :topic_votes, :class => Topic::TopicVote
+    has_many OrganizationSubscription
 
     has_many Setting
     has_many Tag, :extend => Tag::Update, :inline => :create
@@ -765,6 +765,10 @@ module ZendeskAPI
     end
   end
 
+  class DeletedUser < ReadResource
+    include Destroy
+  end
+
   class UserField < Resource; end
   class OrganizationField < Resource; end
 
@@ -956,7 +960,7 @@ module ZendeskAPI
   class PushNotificationDevice < DataResource
     def self.destroy_many(client, tokens)
       ZendeskAPI::Collection.new(
-        client, self,"push_notification_devices" => tokens,
+        client, self, "push_notification_devices" => tokens,
         :path => "push_notification_devices/destroy_many",
         :verb => :post
       )

data/lib/zendesk_api/sideloading.rb

@@ -25,7 +25,6 @@ module ZendeskAPI
       end
     end
 
-
     private
 
     # Traverses the resource looking for associations

data/lib/zendesk_api/silent_mash.rb

@@ -0,0 +1,8 @@
+require 'hashie'
+
+module ZendeskAPI
+  # @private
+  class SilentMash < Hashie::Mash
+    disable_warnings
+  end
+end

data/lib/zendesk_api/track_changes.rb

@@ -10,7 +10,7 @@ module ZendeskAPI
           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}
+            other.each { |key, value| store key, value }
           end
           base.send :alias_method, :merge!, :update
         end
@@ -41,11 +41,11 @@ module ZendeskAPI
       end
 
       def clear
-        keys.each{|key| delete key}
+        keys.each { |key| delete key }
       end
 
       def regular_writer(key, value)
-        if self.has_key?(key) && self[key] == value
+        if has_key?(key) && self[key] == value
           value
         else
           changes[key] = value
@@ -64,7 +64,7 @@ module ZendeskAPI
           each do |k, v|
             if v.respond_to?(:changed?) && v.changed?
               changes[k] = v.changes
-            elsif v.is_a?(Array) && v.any? {|val| val.respond_to?(:changed?) && val.changed?}
+            elsif v.is_a?(Array) && v.any? { |val| val.respond_to?(:changed?) && val.changed? }
               changes[k] = v
             end
           end
@@ -73,7 +73,7 @@ module ZendeskAPI
 
       def changed?(key = nil)
         if key.nil?
-          !changes.empty? || any? {|_, v| v.respond_to?(:changed?) && v.changed?}
+          !changes.empty? || any? { |_, v| v.respond_to?(:changed?) && v.changed? }
         else
           changes.key?(key)
         end

data/lib/zendesk_api/trackie.rb

@@ -1,14 +1,13 @@
-require 'hashie'
 require 'zendesk_api/track_changes'
+require 'zendesk_api/silent_mash'
 
 module ZendeskAPI
   # @private
-  class Trackie < Hashie::Mash
+  class Trackie < SilentMash
     include ZendeskAPI::TrackChanges
 
     def size
       self['size']
     end
-
   end
 end

data/lib/zendesk_api/verbs.rb

@@ -33,7 +33,7 @@ module ZendeskAPI
 
             if @response.body.is_a?(Hash)
               resource = @response.body[self.class.singular_resource_name]
-              resource ||= @response.body.fetch(self.class.resource_name, []).detect {|res| res["id"] == id}
+              resource ||= @response.body.fetch(self.class.resource_name, []).detect { |res| res["id"] == id }
             end
 
             @attributes.replace @attributes.deep_merge(resource || {})

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "1.13.4"
+  VERSION = "1.29.0"
 end

data/util/resource_handler.rb

@@ -10,7 +10,7 @@ class ResourceHandler < YARD::Handlers::Ruby::Base
 
     if klass
       begin
-        klass = klass.split("::").inject(ZendeskAPI) do |p,k|
+        klass = klass.split("::").inject(ZendeskAPI) do |p, k|
           p.const_get(k)
         end
       rescue NameError
@@ -61,7 +61,7 @@ class ResourceHandler < YARD::Handlers::Ruby::Base
   def get_klass(statement)
     statement.traverse do |node|
       if node.type == :assoc && node.jump(:kw).source == "class"
-        classes = node.traverse do |value|
+        node.traverse do |value|
           if value.type == :const_path_ref || value.type == :var_ref
             return value.source
           end