fetch ticket field data after first custom field call

Author: razumau

lib/zendesk_api/client.rb

@@ -108,7 +108,6 @@ def initialize
       set_token_auth
       set_default_logger
       add_warning_callback
-      load_custom_fields_metadata
     end
 
     # token impersonation for the scope of the block
@@ -157,11 +156,9 @@ def self.check_deprecated_namespace_usage(attributes, name)
       end
     end
 
-    def load_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 }
+    def refresh_custom_fields_metadata
+      account_data[:custom_fields] ||= {}
+      ticket_fields.each { |field| account_data[:custom_fields][field.title] = field.id }
     end
 
     protected

lib/zendesk_api/configuration.rb

@@ -57,9 +57,6 @@ class Configuration
     # specify if you want instrumentation to be used
     attr_accessor :instrumentation
 
-    # set to true if you want to preload custom fields metadata
-    attr_accessor :preload_custom_fields_metadata
-
     def initialize
       @client_options = {}
       @use_resource_cache = true

lib/zendesk_api/error.rb

@@ -40,11 +40,5 @@ 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/resource.rb

@@ -80,6 +80,10 @@ def account_data
       @client.account_data
     end
 
+    def refresh_custom_fields_metadata
+      @client.refresh_custom_fields_metadata
+    end
+
     # Passes the method onto the attributes hash.
     # If the attributes are nested (e.g. { :tickets => { :id => 1 } }), passes the method onto the nested hash.
     def method_missing(*args, &)

lib/zendesk_api/resources.rb

@@ -551,26 +551,30 @@ def initialize(ticket)
         @ticket = ticket
       end
 
-      def [](name)
-        find_by_name(name)["value"]
+      def [](field_name)
+        find_by_name(field_name)["value"]
       end
 
-      def []=(name, value)
-        find_by_name(name)["value"] = value
+      def []=(field_name, value)
+        find_by_name(field_name)["value"] = value
       end
 
       private
 
-      def find_by_name(name)
-        raise ZendeskAPI::Error::CustomFieldsMetadataConfigurationError unless @ticket.account_data["custom_fields"]
+      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"][name]
-        @ticket.custom_fields.find { |cf| cf["id"] == custom_field_id }
+        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.
-    # 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

spec/core/client_spec.rb

@@ -394,25 +394,4 @@ 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,8 +31,4 @@
   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/ticket_spec.rb

@@ -112,18 +112,13 @@ def valid_attributes
 
   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
+      @ticket = ZendeskAPI::Ticket.create(client, {
+        subject: "live spec subject for custom fields test",
+        description: "live spec description for custom fields test"
+      })
     end
 
     after do
-      client.config.preload_custom_fields_metadata = false
       @ticket&.destroy!
     end
 
@@ -134,6 +129,15 @@ def valid_attributes
       @ticket.reload!
       expect(@ticket.custom_field["Custom field name"]).to eq("Custom field value")
     end
+
+    it "raises ArgumentError for non-existent fields" do
+      expect { @ticket.custom_field["This field does not exist"] }.to raise_error(ArgumentError)
+    end
+
+    it "stores custom fields metadata on a client" do
+      _custom_field_value = @ticket.custom_field["Custom field name"]
+      expect(@ticket.account_data[:custom_fields]["Custom field name"]).to eq(9961714922394)
+    end
   end
 
   describe ".incremental_export" do