switch to bracket methods

Author: razumau

lib/zendesk_api/client.rb

@@ -108,7 +108,7 @@ def initialize
       set_token_auth
       set_default_logger
       add_warning_callback
-      preload_custom_fields_metadata
+      load_custom_fields_metadata
     end
 
     # token impersonation for the scope of the block
@@ -157,6 +157,11 @@ def self.check_deprecated_namespace_usage(attributes, name)
       end
     end
 
+    def load_custom_fields_metadata
+      @account_data["custom_fields"] ||= {}
+      ticket_fields.each { |field| @account_data["custom_fields"][field.title] = field.id }
+    end
+
     protected
 
     # Called by {#connection} to build a connection. Can be overwritten in a
@@ -270,13 +275,6 @@ def add_warning_callback
       end
     end
 
-    def preload_custom_fields_metadata
-      return unless @config.preload_custom_fields_metadata
-
-      @account_data["custom_fields"] ||= {}
-      ticket_fields.each { |field| @account_data["custom_fields"][field.title] = field.id }
-    end
-
     # See https://lostisland.github.io/faraday/middleware/authentication
     def set_authentication(builder, config)
       if config.access_token && !config.url_based_access_token

lib/zendesk_api/error.rb

@@ -40,5 +40,11 @@ def generate_error_msg(response_body)
     class NetworkError < ClientError; end
     class RecordNotFound < ClientError; end
     class RateLimited < ClientError; end
+
+    class CustomFieldsMetadataConfigurationError < StandardError
+      def to_s
+        "Custom fields metadata missing. Enable config.preload_custom_fields_metadata"
+      end
+    end
   end
 end

lib/zendesk_api/resources.rb

@@ -546,18 +546,37 @@ def to_param
 
     has_many :incidents, class: Ticket
 
-    def custom_field_by_name(name)
-      raise "Custom fields metadata missing. Enable config.preload_custom_fields_metadata" unless account_data["custom_fields"]
+    class CustomFieldAccessor
+      def initialize(ticket)
+        @ticket = ticket
+      end
 
-      custom_field_id = account_data["custom_fields"][name]
-      custom_fields.find { |cf| cf["id"] == custom_field_id }["value"]
-    end
+      def [](name)
+        find_by_name(name)["value"]
+      end
+
+      def []=(name, value)
+        find_by_name(name)["value"] = value
+      end
 
-    def set_custom_field_by_name(name, value)
-      raise "Custom fields metadata missing. Enable config.preload_custom_fields_metadata" unless account_data["custom_fields"]
+      private
+
+      def find_by_name(name)
+        raise ZendeskAPI::Error::CustomFieldsMetadataConfigurationError unless @ticket.account_data["custom_fields"]
+
+        custom_field_id = @ticket.account_data["custom_fields"][name]
+        @ticket.custom_fields.find { |cf| cf["id"] == custom_field_id }
+      end
+    end
 
-      custom_field_id = account_data["custom_fields"][name]
-      custom_fields.find { |cf| cf["id"] == custom_field_id }["value"] = value
+    # Returns a custom field accessor that supports bracket notation.
+    # You need to enable `config.preload_custom_fields_metadata` before using it.
+    # 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.

spec/core/client_spec.rb

@@ -394,4 +394,25 @@ def url.to_str
       expect(Thread.current[:zendesk_thread_local_username]).to eq(original)
     end
   end
+
+  context "custom fields metadata preloading" do
+    it "doesn’t preload metadata by default" do
+      expect(subject.account_data["custom_fields"]).to be_nil
+    end
+
+    it "preloads metadata if configured" do
+      fields = {ticket_fields: [{title: "field one", id: 12}]}.to_json
+      client = ZendeskAPI::Client.new do |config|
+        config.preload_custom_fields_metadata = true
+        config.url = "https://example.zendesk.com/api/v2"
+        config.adapter = :test
+        config.adapter_proc = proc do |stub|
+          stub.get "/api/v2/ticket_fields" do |env|
+            [200, {"content-type": "application/json", Authorization: env.request_headers["Authorization"]}, fields]
+          end
+        end
+      end
+      expect(client.account_data["custom_fields"]).to eq({"field one" => 12})
+    end
+  end
 end

spec/core/configuration_spec.rb

@@ -31,4 +31,8 @@
   it "sets a default for use_resource_cache" do
     expect(subject.use_resource_cache).to be true
   end
+
+  it "has preload_custom_fields_metadata disabled by default" do
+    expect(subject.preload_custom_fields_metadata).to be_nil
+  end
 end

spec/live/Readme.md

@@ -12,3 +12,4 @@ In case you want to create a test account from scratch:
  - Add photo to user profile of that end user.
  - Create a new ticket and cc "zendesk-api-client-ruby-end-user-#{client.config.username}" (run tests once to create this user)
  - Ensure you allow admins to set up user password (or `POST /api/v2/users/{user_id}/password.json` will fail). You can check this in the admin centre > security > advanced
+ - Add ticket custom field with the display name "Custom field name" and field type "Text".

spec/live/ticket_spec.rb

@@ -110,6 +110,32 @@ def valid_attributes
     it_should_be_readable :tickets, :recent
   end
 
+  describe "custom fields" do
+    before do
+      client.config.preload_custom_fields_metadata = true
+      client.load_custom_fields_metadata
+      VCR.use_cassette("ticket_create_custom_fields") do
+        @ticket = ZendeskAPI::Ticket.create(client, {
+          subject: "live spec subject for custom fields test",
+          description: "live spec description for custom fields test"
+        })
+      end
+    end
+
+    after do
+      client.config.preload_custom_fields_metadata = false
+      @ticket&.destroy!
+    end
+
+    it "can write and read custom fields" do
+      @ticket.custom_field["Custom field name"] = "Custom field value"
+      @ticket.save!
+
+      @ticket.reload!
+      expect(@ticket.custom_field["Custom field name"]).to eq("Custom field value")
+    end
+  end
+
   describe ".incremental_export" do
     let(:results) { ZendeskAPI::Ticket.incremental_export(client, Time.at(1023059503)) } # ~ 10 years ago