chartmogul-ruby 4.7.1 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80466b596764090a0a5b98d57f27ac68434832c70669946bce93db4f8bb6c5e0
-  data.tar.gz: b67f72518317c3e8ca975752ca5ce479697bb41a4a8741e443c4503d015295c6
+  metadata.gz: d8bfb17b4530e13675e2958de0bc1f11f371d34d1c306cecc1947094c49d7f26
+  data.tar.gz: 32e700778b8f366d4d45a2e52b0105c71d28b0d23546cb3fb99e2b6d8a89063b
 SHA512:
-  metadata.gz: af3b79f2c5556630f406ca2ecfc386a5791f391925bbc7798c6a0c60e0f9e24bfafa73f39cba5ad028a8454c01732c6cd0240e68f82e0bf2b2a7952fca208797
-  data.tar.gz: be695715d4eebdb77f5adc68669ee5e833a9e02f84e87ee324b1a51f52ff78b41014f941a87c2a71a36050cb3eb6c0db8a5df0c45c97d2b8480dfc1ec839e078
+  metadata.gz: 54db5c88f38ac82440530cfdd137bfa7af53a85e66cd3d69efd6834909325cdcaafa186c53a6658fc0cef55c92d22398e78ecc59992e5e11883c29e0331ac4ce
+  data.tar.gz: da9b0d684ddd39e9d6adcaf98f4231452e1910828c91c24a153e1a97a6d604d0074b9e8b55a3f36957fa3ce83baecf59d5a12af43d067f31418a136540618b96

data/lib/chartmogul/api_resource.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
+require "set"
 
 module ChartMogul
   class APIResource < ChartMogul::Object
@@ -8,17 +9,45 @@ module ChartMogul
 
     RETRY_STATUSES = [429, *500..599].freeze
     RETRY_EXCEPTIONS = [
-      'Faraday::ConnectionFailed',
-      'Faraday::RetriableResponse'
+      "Faraday::ConnectionFailed",
+      "Faraday::RetriableResponse"
     ].freeze
     BACKOFF_FACTOR = 2
     INTERVAL_RANDOMNESS = 0.5
     INTERVAL = 1
     MAX_INTERVAL = 60
-    THREAD_CONNECTION_KEY = 'chartmogul_ruby.api_resource.connection'
+    THREAD_CONNECTION_KEY = "chartmogul_ruby.api_resource.connection"
 
     class << self; attr_reader :resource_path, :resource_name, :resource_root_key end
 
+    def self.query_params
+      @query_params ||= Set.new
+    end
+
+    def self.writeable_query_param(attribute, options = {})
+      query_params << attribute.to_sym
+      writeable_attr(attribute, options)
+    end
+
+    def self.extract_query_params(attrs, resource_key = nil)
+      remaining_attrs = attrs.dup
+      query_params = {}
+
+      self.query_params.each do |param|
+        # If resource_key is specified, look in nested structure
+        if resource_key && remaining_attrs[resource_key].is_a?(Hash) &&
+           remaining_attrs[resource_key]&.key?(param) &&
+           remaining_attrs[resource_key][param]
+          query_params[param] = remaining_attrs[resource_key].delete(param)
+        # Otherwise look at top level
+        elsif remaining_attrs.key?(param) && remaining_attrs[param]
+          query_params[param] = remaining_attrs.delete(param)
+        end
+      end
+
+      [remaining_attrs, query_params]
+    end
+
     def self.set_resource_path(path)
       @resource_path = ChartMogul::ResourcePath.new(path)
     end
@@ -60,10 +89,10 @@ module ChartMogul
         message = "JSON schema validation hasn't passed."
         raise ChartMogul::SchemaInvalidError.new(message, http_status: 400, response: response)
       when 401
-        message = 'No valid API key provided'
+        message = "No valid API key provided"
         raise ChartMogul::UnauthorizedError.new(message, http_status: 401, response: response)
       when 403
-        message = 'The requested action is forbidden.'
+        message = "The requested action is forbidden."
         raise ChartMogul::ForbiddenError.new(message, http_status: 403, response: response)
       when 404
         message = "The requested #{resource_name} could not be found."
@@ -72,7 +101,7 @@ module ChartMogul
         message = "The #{resource_name} could not be created or updated."
         raise ChartMogul::ResourceInvalidError.new(message, http_status: 422, response: response)
       when 500..504
-        message = 'ChartMogul API server response error'
+        message = "ChartMogul API server response error"
         raise ChartMogul::ServerError.new(message, http_status: http_status, response: response)
       else
         message = "#{resource_name} request error has occurred."
@@ -84,17 +113,63 @@ module ChartMogul
       raise ChartMogul::ChartMogulError, exception.message
     end
 
-    def_delegators 'self.class', :resource_path, :resource_name, :resource_root_key, :connection, :handling_errors
+    def_delegators "self.class", :resource_path, :resource_name, :resource_root_key, :connection, :handling_errors
+
+    def extract_query_params(attrs, resource_key = nil)
+      remaining_attrs = attrs.dup
+      query_params = {}
+
+      self.class.query_params.each do |param|
+        # If resource_key is specified, look in nested structure
+        if resource_key && remaining_attrs[resource_key].is_a?(Hash) &&
+           remaining_attrs[resource_key]&.key?(param) &&
+           remaining_attrs[resource_key][param]
+          query_params[param] = remaining_attrs[resource_key].delete(param)
+        # Otherwise look at top level
+        elsif remaining_attrs.key?(param) && remaining_attrs[param]
+          query_params[param] = remaining_attrs.delete(param)
+        end
+      end
+
+      [remaining_attrs, query_params]
+    end
+
+    # Generate path with query parameters applied
+    def path_with_query_params(attrs)
+      _, query_params = extract_query_params(attrs)
+      query_params.empty? ? resource_path.path : resource_path.apply_with_get_params(query_params)
+    end
+
+    # Enhanced custom! that automatically handles query parameters
+    def custom_with_query_params!(http_method, body_data = {}, resource_key = nil)
+      attrs, query_params = extract_query_params(body_data, resource_key)
+      # Only include path parameters from instance attributes, plus extracted query parameters
+      path_params = instance_attributes.select { |key, _| resource_path.named_params.values.include?(key) }
+      path_and_query_params = path_params.merge(query_params)
+      path = resource_path.apply_with_get_params(path_and_query_params)
 
-    private
+      custom!(http_method, path, attrs)
+    end
+
+    # Class method version for enhanced custom! with query parameters
+    def self.custom_with_query_params!(http_method, body_data = {}, resource_key = nil)
+      attrs, query_params = extract_query_params(body_data, resource_key)
+      # Only include path parameters from body data, plus extracted query parameters
+      path_params = body_data.select { |key, _| resource_path.named_params.values.include?(key) }
+      path_and_query_params = path_params.merge(query_params)
+      path = resource_path.apply_with_get_params(path_and_query_params)
+
+      custom!(http_method, path, attrs)
+    end
 
     def self.build_connection
-      Faraday.new(url: ChartMogul.api_base, headers: { 'User-Agent' => "chartmogul-ruby/#{ChartMogul::VERSION}" }) do |faraday|
+      Faraday.new(url: ChartMogul.api_base,
+        headers: { "User-Agent" => "chartmogul-ruby/#{ChartMogul::VERSION}" }) do |faraday|
         faraday.use Faraday::Response::RaiseError
-        faraday.request :authorization, :basic, ChartMogul.api_key, ''
+        faraday.request :authorization, :basic, ChartMogul.api_key, ""
         faraday.request :retry, max: ChartMogul.max_retries, retry_statuses: RETRY_STATUSES,
-                                max_interval: MAX_INTERVAL, backoff_factor: BACKOFF_FACTOR,
-                                interval_randomness: INTERVAL_RANDOMNESS, interval: INTERVAL, exceptions: RETRY_EXCEPTIONS
+          max_interval: MAX_INTERVAL, backoff_factor: BACKOFF_FACTOR,
+          interval_randomness: INTERVAL_RANDOMNESS, interval: INTERVAL, exceptions: RETRY_EXCEPTIONS
         faraday.adapter Faraday::Adapter::NetHttp
       end
     end

data/lib/chartmogul/customer_invoices.rb

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module ChartMogul
   class CustomerInvoices < APIResource
     extend Forwardable
     include Enumerable
 
-    set_resource_name 'Invoices'
-    set_resource_path '/v1/import/customers/:customer_uuid/invoices'
+    set_resource_name "Invoices"
+    set_resource_path "/v1/import/customers/:customer_uuid/invoices"
 
     writeable_attr :invoices, default: []
-
     writeable_attr :customer_uuid
+    writeable_query_param :handle_as_user_edit
 
     include API::Actions::All
-    include API::Actions::Create
+    include API::Actions::Custom
     include Concerns::Pageable2
     include Concerns::PageableWithCursor
 
@@ -23,6 +23,29 @@ module ChartMogul
       map(&:serialize_for_write)
     end
 
+    def create!
+      # Only merge writeable_query_params to avoid overwriting serialized data
+      query_params_data = instance_attributes.select { |k, _| self.class.query_params.include?(k.to_sym) }
+      body_data = serialize_for_write.merge(query_params_data)
+      custom_with_query_params!(:post, body_data)
+    end
+
+    def self.create!(attributes = {})
+      resource = new(attributes)
+      # Only merge writeable_query_params to avoid overwriting serialized data
+      query_params_data = attributes.select { |k, _| query_params.include?(k.to_sym) }
+      body_data = resource.serialize_for_write.merge(query_params_data)
+      resource.custom_with_query_params!(:post, body_data)
+    end
+
+    def update!(attrs = {})
+      # Merge new attributes with existing, then only merge query params
+      updated_attrs = instance_attributes.merge(attrs)
+      query_params_data = updated_attrs.select { |k, _| self.class.query_params.include?(k.to_sym) }
+      body_data = serialize_for_write.merge(query_params_data)
+      custom_with_query_params!(:put, body_data)
+    end
+
     def self.all(customer_uuid, options = {})
       super(options.merge(customer_uuid: customer_uuid))
     end
@@ -32,7 +55,7 @@ module ChartMogul
     end
 
     def self.destroy_all!(data_source_uuid, customer_uuid)
-      path = ChartMogul::ResourcePath.new('v1/data_sources/:data_source_uuid/customers/:customer_uuid/invoices')
+      path = ChartMogul::ResourcePath.new("v1/data_sources/:data_source_uuid/customers/:customer_uuid/invoices")
       handling_errors do
         connection.delete(path.apply(data_source_uuid: data_source_uuid, customer_uuid: customer_uuid))
       end
@@ -44,6 +67,7 @@ module ChartMogul
     private
 
     # TODO: replace with Entries concern?
+    # NOTE: called in the assign_all_attributes method
     def set_invoices(invoices_attributes)
       @invoices = invoices_attributes.map.with_index do |invoice_attributes, index|
         existing_invoice = invoices[index]

data/lib/chartmogul/line_items/one_time.rb

@@ -17,7 +17,6 @@ module ChartMogul
       writeable_attr :transaction_fees_currency
       writeable_attr :discount_description
       writeable_attr :event_order
-
       writeable_attr :plan_uuid
       writeable_attr :invoice_uuid
 

data/lib/chartmogul/subscription_event.rb

@@ -23,6 +23,7 @@ module ChartMogul
     writeable_attr :amount_in_cents
     writeable_attr :tax_amount_in_cents
     writeable_attr :retracted_event_id
+    writeable_query_param :handle_as_user_edit
 
     include API::Actions::Custom
     include API::Actions::DestroyWithParams
@@ -32,7 +33,7 @@ module ChartMogul
     end
 
     def create!
-      custom!(:post, resource_path.path, subscription_event: instance_attributes)
+      custom_with_query_params!(:post, { subscription_event: instance_attributes }, :subscription_event)
     end
 
     # This endpoint requires we send the attributes as:
@@ -40,19 +41,12 @@ module ChartMogul
     # So we do not include the API::Actions::Create module here and rather use a
     # variation of the method there to accommodate this difference in behaviour.
     def self.create!(attributes)
-      resp = handling_errors do
-        connection.post(resource_path.path) do |req|
-          req.headers['Content-Type'] = 'application/json'
-          req.body = JSON.dump({ subscription_event: attributes })
-        end
-      end
-      json = ChartMogul::Utils::JSONParser.parse(resp.body, immutable_keys: immutable_keys)
-
-      new_from_json(json)
+      custom_with_query_params!(:post, { subscription_event: attributes }, :subscription_event)
     end
 
     def update!(attrs)
-      custom!(:patch, resource_path.path, subscription_event: attrs.merge(id: instance_attributes[:id]))
+      custom_with_query_params!(:patch, { subscription_event: attrs.merge(id: instance_attributes[:id]) },
+                                :subscription_event)
     end
 
     def destroy!

data/lib/chartmogul/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ChartMogul
-  VERSION = '4.7.1'
+  VERSION = '4.8.0'
 end

data/lib/chartmogul.rb

@@ -87,6 +87,7 @@ require 'chartmogul/enrichment/customer'
 
 module ChartMogul
   API_BASE = 'https://api.chartmogul.com'
+
   MAX_RETRIES = 20
   CONFIG_THREAD_KEY = 'chartmogul_ruby.config'
 

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chartmogul-ruby
 version: !ruby/object:Gem::Version
-  version: 4.7.1
+  version: 4.8.0
 platform: ruby
 authors:
 - Petr Kopac
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-25 00:00:00.000000000 Z
+date: 2025-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -304,7 +305,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Chartmogul API Ruby Client
 test_files: []