zendesk_api 3.1.1 → 3.1.2

data/lib/zendesk_api/resources.rb

@@ -20,7 +20,7 @@ module ZendeskAPI
 
   class Channel < Resource
     def work_items
-      @work_items ||= attributes.fetch('relationships', {}).fetch('work_items', {}).fetch('data', []).map do |work_item_attributes|
+      @work_items ||= attributes.fetch("relationships", {}).fetch("work_items", {}).fetch("data", []).map do |work_item_attributes|
         WorkItem.new(@client, work_item_attributes)
       end
     end
@@ -35,7 +35,7 @@ module ZendeskAPI
     end
 
     def initialize(client, attributes = {})
-      nested_attributes = attributes.delete('attributes')
+      nested_attributes = attributes.delete("attributes")
       super(client, attributes.merge(nested_attributes))
     end
 
@@ -59,9 +59,9 @@ module ZendeskAPI
 
     def channels
       @channels ||= begin
-        channel_attributes_array = @client.connection.get(attributes['links']['self']).body.fetch('included')
+        channel_attributes_array = @client.connection.get(attributes["links"]["self"]).body.fetch("included")
         channel_attributes_array.map do |channel_attributes|
-          nested_attributes = channel_attributes.delete('attributes')
+          nested_attributes = channel_attributes.delete("attributes")
           Channel.new(@client, channel_attributes.merge(nested_attributes))
         end
       end
@@ -100,12 +100,12 @@ module ZendeskAPI
     include Update
     include Destroy
 
-    alias :name :id
-    alias :to_param :id
+    alias_method :name, :id
+    alias_method :to_param, :id
 
     def path(opts = {})
       raise "tags must have parent resource" unless association.options.parent
-      super(opts.merge(:with_parent => true, :with_id => false))
+      super(opts.merge(with_parent: true, with_id: false))
     end
 
     def changed?
@@ -123,7 +123,7 @@ module ZendeskAPI
         return self unless @resources
 
         @client.connection.post(path) do |req|
-          req.body = { :tags => @resources.reject(&:destroyed?).map(&:id) }
+          req.body = {tags: @resources.reject(&:destroyed?).map(&:id)}
         end
 
         true
@@ -137,7 +137,7 @@ module ZendeskAPI
     end
 
     def attributes_for_save
-      { self.class.resource_name => [id] }
+      {self.class.resource_name => [id]}
     end
 
     def self.cbp_path_regexes
@@ -195,13 +195,13 @@ module ZendeskAPI
     extend CreateOrUpdate
     extend DestroyMany
 
-    has Ability, :inline => true
+    has Ability, inline: true
     has Group
-    has :related, :class => OrganizationRelated
+    has :related, class: OrganizationRelated
 
     has_many Ticket
     has_many User
-    has_many Tag, :extend => Tag::Update, :inline => :create
+    has_many Tag, extend: Tag::Update, inline: :create
     has_many OrganizationMembership
     has_many :subscriptions, class: OrganizationSubscription
 
@@ -210,7 +210,7 @@ module ZendeskAPI
     # @param [Integer] start_time The start_time parameter
     # @return [Collection] Collection of {Organization}
     def self.incremental_export(client, start_time)
-      ZendeskAPI::Collection.new(client, self, :path => "incremental/organizations?start_time=#{start_time.to_i}")
+      ZendeskAPI::Collection.new(client, self, path: "incremental/organizations?start_time=#{start_time.to_i}")
     end
 
     def self.cbp_path_regexes
@@ -263,6 +263,7 @@ module ZendeskAPI
 
     class Section < Resource
     end
+
     class Translation < Resource; end
 
     has_many Section
@@ -280,6 +281,7 @@ module ZendeskAPI
 
     class Vote < Resource; end
     class Translation < Resource; end
+
     class Article < Resource
       has_many Vote
       has_many Translation
@@ -325,7 +327,7 @@ module ZendeskAPI
     has User
 
     def path(options = {})
-      super(options.merge(:with_parent => true))
+      super(options.merge(with_parent: true))
     end
   end
 
@@ -338,7 +340,7 @@ module ZendeskAPI
 
   class Activity < Resource
     has User
-    has :actor, :class => User
+    has :actor, class: User
 
     def self.cbp_path_regexes
       [/^activities$/]
@@ -350,10 +352,14 @@ module ZendeskAPI
 
     def initialize(client, attributes = {})
       # Try and find the root key
-      @on = (attributes.keys.map(&:to_s) - %w{association options}).first
+      @on = (attributes.keys.map(&:to_s) - %w[association options]).first
 
-      # Make what's inside that key the root attributes
-      attributes.merge!(attributes.delete(@on))
+      # Namespaced settings (e.g. "lotus", "admin_center") nest their values in a
+      # Hash, which we hoist up to be the root attributes. Some settings are
+      # top-level scalars or arrays (e.g. "shared_views_order",
+      # "agent_home_pinned_views") - leave those under @on rather than merging,
+      # which would raise "no implicit conversion of Array into Hash".
+      attributes.merge!(attributes.delete(@on)) if attributes[@on].is_a?(Hash)
 
       super
     end
@@ -363,17 +369,17 @@ module ZendeskAPI
     end
 
     def path(options = {})
-      super(options.merge(:with_parent => true))
+      super(options.merge(with_parent: true))
     end
 
     def attributes_for_save
-      { self.class.resource_name => { @on => attributes.changes } }
+      {self.class.resource_name => {@on => attributes.changes}}
     end
   end
 
   class SatisfactionRating < ReadResource
-    has :assignee, :class => User
-    has :requester, :class => User
+    has :assignee, class: User
+    has :requester, class: User
     has Ticket
     has Group
   end
@@ -395,7 +401,7 @@ module ZendeskAPI
       include Save
 
       has_many :uploads, class: Attachment, inline: true
-      has :author, :class => User
+      has :author, class: User
 
       def save
         if new_record?
@@ -406,23 +412,23 @@ module ZendeskAPI
         end
       end
 
-      alias :save! :save
+      alias_method :save!, :save
     end
 
-    has Comment, :inline => true
+    has Comment, inline: true
     has_many Comment
 
     has Organization
     has Group
-    has :requester, :class => User
+    has :requester, class: User
   end
 
   class AnonymousRequest < CreateResource
     def self.singular_resource_name
-      'request'
+      "request"
     end
 
-    namespace 'portal'
+    namespace "portal"
   end
 
   class TicketField < Resource
@@ -446,14 +452,14 @@ module ZendeskAPI
 
     has_many :child_events, class: Event
     has Ticket
-    has :updater, :class => User
+    has :updater, class: User
 
     # Gets a incremental export of ticket events 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 {TicketEvent}
     def self.incremental_export(client, start_time)
-      ZendeskAPI::Collection.new(client, self, :path => "incremental/ticket_events?start_time=#{start_time.to_i}")
+      ZendeskAPI::Collection.new(client, self, path: "incremental/ticket_events?start_time=#{start_time.to_i}")
     end
   end
 
@@ -475,13 +481,13 @@ module ZendeskAPI
 
     class Audit < DataResource
       class Event < Data
-        has :author, :class => User
+        has :author, class: User
       end
 
       put :trust
 
       # need this to support SideLoading
-      has :author, :class => User
+      has :author, class: User
 
       has_many Event
 
@@ -505,27 +511,27 @@ module ZendeskAPI
         end
       end
 
-      alias :save! :save
+      alias_method :save!, :save
     end
 
     class SatisfactionRating < CreateResource
       class << self
-        alias :resource_name :singular_resource_name
+        alias_method :resource_name, :singular_resource_name
       end
     end
 
     put :mark_as_spam
     post :merge
 
-    has :requester, :class => User, :inline => :create
-    has :submitter, :class => User
-    has :assignee, :class => User
+    has :requester, class: User, inline: :create
+    has :submitter, class: User
+    has :assignee, class: User
 
-    has_many :collaborators, class: User, inline: true, extend: (Module.new do
+    has_many :collaborators, class: User, inline: true, extend: Module.new do
       def to_param
         map(&:id)
       end
-    end)
+    end
 
     has_many Audit
     has :metrics, class: TicketMetric
@@ -544,6 +550,43 @@ module ZendeskAPI
 
     has_many :incidents, class: Ticket
 
+    class CustomFieldAccessor
+      def initialize(ticket)
+        @ticket = ticket
+      end
+
+      def [](field_name)
+        find_by_name(field_name)["value"]
+      end
+
+      def []=(field_name, value)
+        find_by_name(field_name)["value"] = value
+      end
+
+      private
+
+      def find_by_name(field_name)
+        @ticket.refresh_custom_fields_metadata unless @ticket.account_data.has_key?(:custom_fields)
+
+        custom_field_id = @ticket.account_data[:custom_fields][field_name]
+        raise ArgumentError, "No custom field named '#{field_name}' found in field definitions" if custom_field_id.nil?
+
+        custom_field = @ticket.custom_fields.find { |cf| cf["id"] == custom_field_id }
+        raise ArgumentError, "No custom field with id #{custom_field_id} found. Field name: '#{field_name}'" if custom_field.nil?
+
+        custom_field
+      end
+    end
+
+    # Returns a custom field accessor that supports bracket notation.
+    # Usage:
+    #   ticket.custom_field["field name"]            # get
+    #   ticket.custom_field["field name"] = "value"  # set
+    # You need to call `save!` on a ticket after changing a custom field value.
+    def custom_field
+      @custom_field_accessor ||= CustomFieldAccessor.new(self)
+    end
+
     # 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
@@ -621,7 +664,7 @@ module ZendeskAPI
   end
 
   class RuleExecution < Data
-    has_many :custom_fields, :class => TicketField
+    has_many :custom_fields, class: TicketField
   end
 
   class ViewCount < DataResource; end
@@ -631,7 +674,7 @@ module ZendeskAPI
 
     def attributes_for_save
       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) }
+      {self.class.singular_resource_name.to_sym => attributes.changes.merge(to_save)}
     end
   end
 
@@ -651,32 +694,32 @@ module ZendeskAPI
     def add_all_condition(field, operator, value)
       self.conditions ||= {}
       self.conditions[:all] ||= []
-      self.conditions[:all] << { :field => field, :operator => operator, :value => value }
+      self.conditions[:all] << {field: field, operator: operator, value: value}
     end
 
     def add_any_condition(field, operator, value)
       self.conditions ||= {}
       self.conditions[:any] ||= []
-      self.conditions[:any] << { :field => field, :operator => operator, :value => value }
+      self.conditions[:any] << {field: field, operator: operator, value: value}
     end
   end
 
   module Actions
     def add_action(field, value)
       self.actions ||= []
-      self.actions << { :field => field, :value => value }
+      self.actions << {field: field, value: value}
     end
   end
 
   class View < Rule
     include Conditions
 
-    has_many :tickets, :class => Ticket
-    has_many :feed, :class => Ticket, :path => "feed"
+    has_many :tickets, class: Ticket
+    has_many :feed, class: Ticket, path: "feed"
 
-    has_many :rows, :class => ViewRow, :path => "execute"
-    has :execution, :class => RuleExecution
-    has ViewCount, :path => "count"
+    has_many :rows, class: ViewRow, path: "execute"
+    has :execution, class: RuleExecution
+    has ViewCount, path: "count"
 
     def add_column(column)
       columns = execution.columns.map(&:id)
@@ -690,7 +733,7 @@ module ZendeskAPI
     end
 
     def self.preview(client, options = {})
-      Collection.new(client, ViewRow, options.merge(:path => "views/preview", :verb => :post))
+      Collection.new(client, ViewRow, options.merge(path: "views/preview", verb: :post))
     end
 
     def self.cbp_path_regexes
@@ -702,7 +745,7 @@ module ZendeskAPI
     include Conditions
     include Actions
 
-    has :execution, :class => RuleExecution
+    has :execution, class: RuleExecution
 
     def self.cbp_path_regexes
       [/^triggers$/, %r{^triggers/active$}]
@@ -713,7 +756,7 @@ module ZendeskAPI
     include Conditions
     include Actions
 
-    has :execution, :class => RuleExecution
+    has :execution, class: RuleExecution
 
     def self.cbp_path_regexes
       [/^automations$/]
@@ -723,7 +766,7 @@ module ZendeskAPI
   class Macro < Rule
     include Actions
 
-    has :execution, :class => RuleExecution
+    has :execution, class: RuleExecution
 
     def self.cbp_path_regexes
       [/^macros$/]
@@ -754,7 +797,7 @@ module ZendeskAPI
 
   class UserView < Rule
     def self.preview(client, options = {})
-      Collection.new(client, UserViewRow, options.merge!(:path => "user_views/preview", :verb => :post))
+      Collection.new(client, UserViewRow, options.merge!(path: "user_views/preview", verb: :post))
     end
   end
 
@@ -808,22 +851,22 @@ module ZendeskAPI
 
     # Set a user's password
     def set_password(opts = {})
-      password(opts.merge(:verb => :post))
+      password(opts.merge(verb: :post))
     end
 
     # Change a user's password
     def change_password(opts = {})
-      password(opts.merge(:verb => :put))
+      password(opts.merge(verb: :put))
     end
 
     # Set a user's password
     def set_password!(opts = {})
-      password!(opts.merge(:verb => :post))
+      password!(opts.merge(verb: :post))
     end
 
     # Change a user's password
     def change_password!(opts = {})
-      password!(opts.merge(:verb => :put))
+      password!(opts.merge(verb: :put))
     end
 
     # Gets a incremental export of users from the start_time until now.
@@ -831,7 +874,7 @@ module ZendeskAPI
     # @param [Integer] start_time The start_time parameter
     # @return [Collection] Collection of {User}
     def self.incremental_export(client, start_time)
-      ZendeskAPI::Collection.new(client, self, :path => "incremental/users?start_time=#{start_time.to_i}")
+      ZendeskAPI::Collection.new(client, self, path: "incremental/users?start_time=#{start_time.to_i}")
     end
 
     has Organization
@@ -842,23 +885,23 @@ module ZendeskAPI
     class CurrentSession < SingularResource
       class << self
         def singular_resource_name
-          'session'
+          "session"
         end
 
-        alias :resource_name :singular_resource_name
+        alias_method :resource_name, :singular_resource_name
       end
     end
 
     has_many Session
 
     def current_session
-      ZendeskAPI::User::CurrentSession.find(@client, :user_id => 'me')
+      ZendeskAPI::User::CurrentSession.find(@client, user_id: "me")
     end
 
     delete :logout
 
     def clear_sessions!
-      @client.connection.delete(path + '/sessions')
+      @client.connection.delete("#{path}/sessions")
     end
 
     def clear_sessions
@@ -869,17 +912,17 @@ module ZendeskAPI
 
     put :merge
 
-    has CustomRole, :inline => true, :include => :roles
-    has Role, :inline => true, :include_key => :name
-    has Ability, :inline => true
-    has :related, :class => UserRelated
+    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 :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
@@ -887,7 +930,7 @@ module ZendeskAPI
     has_many OrganizationSubscription
 
     has_many Setting
-    has_many Tag, :extend => Tag::Update, :inline => :create
+    has_many Tag, extend: Tag::Update, inline: :create
 
     def attributes_for_save
       # Don't send role_id, it's necessary
@@ -897,7 +940,7 @@ module ZendeskAPI
         k == "role_id"
       end
 
-      { self.class.singular_resource_name => attrs }
+      {self.class.singular_resource_name => attrs}
     end
 
     def handle_response(*)
@@ -929,6 +972,7 @@ module ZendeskAPI
 
   class OauthToken < ReadResource
     include Destroy
+
     namespace "oauth"
 
     def self.singular_resource_name
@@ -939,6 +983,7 @@ module ZendeskAPI
   class Target < Resource; end
 
   class Invocation < Resource; end
+
   class Webhook < Resource
     has_many Invocation
   end
@@ -976,7 +1021,7 @@ module ZendeskAPI
 
         def self.display!(client, options)
           new(client, options).tap do |resource|
-            resource.save!(path: resource.path + '/display')
+            resource.save!(path: "#{resource.path}/display")
           end
         end
       end
@@ -1031,9 +1076,9 @@ module ZendeskAPI
       super
     end
 
-    def self.create!(client, attributes = {}, &block)
-      if file_path = attributes.delete(:upload)
-        attributes[:upload_id] = client.apps.uploads.create!(:file => file_path).id
+    def self.create!(client, attributes = {}, &)
+      if (file_path = attributes.delete(:upload))
+        attributes[:upload_id] = client.apps.uploads.create!(file: file_path).id
       end
 
       super
@@ -1075,15 +1120,15 @@ module ZendeskAPI
       end
     end
 
-    def self.uploads(client, *args, &block)
-      ZendeskAPI::Collection.new(client, Upload, *args, &block)
+    def self.uploads(client, ...)
+      ZendeskAPI::Collection.new(client, Upload, ...)
     end
 
-    def self.installations(client, *args, &block)
-      ZendeskAPI::Collection.new(client, AppInstallation, *args, &block)
+    def self.installations(client, ...)
+      ZendeskAPI::Collection.new(client, AppInstallation, ...)
     end
 
-    has Upload, :path => "uploads"
+    has Upload, path: "uploads"
     has_many Plan
 
     # Don't nest attributes
@@ -1100,7 +1145,7 @@ module ZendeskAPI
     include DataNamespace
 
     class Item < ZendeskAPI::Resource
-      namespace 'dynamic_content'
+      namespace "dynamic_content"
 
       class Variant < ZendeskAPI::Resource
       end

data/lib/zendesk_api/search.rb

@@ -17,10 +17,10 @@ module ZendeskAPI
       present_result_type = (attributes[:result_type] || attributes["result_type"]).to_s
       result_type = ZendeskAPI::Helpers.modulize_string(present_result_type)
       klass = begin
-                ZendeskAPI.const_get(result_type)
-              rescue NameError
-                Result
-              end
+        ZendeskAPI.const_get(result_type)
+      rescue NameError
+        Result
+      end
 
       (klass || Result).new(client, attributes)
     end
@@ -35,7 +35,7 @@ module ZendeskAPI
       def resource_name
         "search"
       end
-      alias resource_path resource_name
+      alias_method :resource_path, :resource_name
 
       def model_key
         "results"
@@ -49,7 +49,7 @@ module ZendeskAPI
       def resource_name
         "search/export"
       end
-      alias resource_path resource_name
+      alias_method :resource_path, :resource_name
     end
   end
 end

data/lib/zendesk_api/silent_mash.rb

@@ -1,4 +1,4 @@
-require 'hashie'
+require "hashie"
 
 module ZendeskAPI
   # @private

data/lib/zendesk_api/track_changes.rb

@@ -49,7 +49,7 @@ module ZendeskAPI
           value
         else
           changes[key] = value
-          defined?(_store) ? _store(key, value) : super(key, value)
+          defined?(_store) ? _store(key, value) : super
         end
       end
 
@@ -79,7 +79,7 @@ module ZendeskAPI
         end
       end
 
-      alias :dirty? :changed?
+      alias_method :dirty?, :changed?
     end
   end
 end

data/lib/zendesk_api/trackie.rb

@@ -1,5 +1,5 @@
-require 'zendesk_api/track_changes'
-require 'zendesk_api/silent_mash'
+require_relative "track_changes"
+require_relative "silent_mash"
 
 module ZendeskAPI
   # @private
@@ -7,7 +7,7 @@ module ZendeskAPI
     include ZendeskAPI::TrackChanges
 
     def size
-      self['size']
+      self["size"]
     end
   end
 end

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "3.1.1"
+  VERSION = "3.1.2"
 end

data/lib/zendesk_api.rb

@@ -1,8 +1,8 @@
 module ZendeskAPI; end
 
-require 'faraday'
-require 'faraday/multipart'
+require "faraday"
+require "faraday/multipart"
 
-require 'zendesk_api/helpers'
-require 'zendesk_api/core_ext/inflection'
-require 'zendesk_api/client'
+require_relative "zendesk_api/helpers"
+require_relative "zendesk_api/core_ext/inflection"
+require_relative "zendesk_api/client"