feat(free-units): Add free units fields to GraphQL

app/graphql/concerns/charge_model_attributes_handler.rb

@@ -6,6 +6,7 @@ module ChargeModelAttributesHandler
   #       - Standard model only has one property `amount_cents`
   #       - Graduated model relies on the the list of `GraduatedRange`
   #       - Package model has properties `amount_cents`, `package_size` and `free_units`
+  #       - Percentage model has properties `rate`, `fixed_amount`, `free_units_per_events`, `free_units_per_total_aggregation`
   def prepare_arguments(arguments)
     return arguments if arguments[:charges].blank?
 
@@ -27,6 +28,8 @@ def prepare_arguments(arguments)
         output[:properties] = {
           rate: output[:rate],
           fixed_amount: output[:fixed_amount],
+          free_units_per_events: output[:free_units_per_events],
+          free_units_per_total_aggregation: output[:free_units_per_total_aggregation],
         }
       end
 
@@ -37,6 +40,8 @@ def prepare_arguments(arguments)
       output.delete(:package_size)
       output.delete(:rate)
       output.delete(:fixed_amount)
+      output.delete(:free_units_per_events)
+      output.delete(:free_units_per_total_aggregation)
 
       output
     end

app/graphql/types/charges/input.rb

@@ -23,6 +23,8 @@ class Input < Types::BaseInputObject
       # NOTE: Percentage charge model
       argument :rate, String, required: false
       argument :fixed_amount, String, required: false
+      argument :free_units_per_events, Integer, required: false
+      argument :free_units_per_total_aggregation, String, required: false
     end
   end
 end

app/graphql/types/charges/object.rb

@@ -26,6 +26,8 @@ class Object < Types::BaseObject
       # NOTE: Percentage charge model
       field :rate, String, null: true
       field :fixed_amount, String, null: true
+      field :free_units_per_events, Integer, null: true
+      field :free_units_per_total_aggregation, String, null: true
 
       def amount
         return unless object.standard? || object.package?
@@ -62,6 +64,18 @@ def fixed_amount
 
         object.properties['fixed_amount']
       end
+
+      def free_units_per_events
+        return unless object.percentage?
+
+        object.properties['free_units_per_events']
+      end
+
+      def free_units_per_total_aggregation
+        return unless object.percentage?
+
+        object.properties['free_units_per_total_aggregation']
+      end
     end
   end
 end

config/locales/en.yml

@@ -19,6 +19,8 @@ en:
         invalid_package_size: invalid_package_size
         invalid_rate: invalid_rate
         invalid_fixed_amount: invalid_fixed_amount
+        invalid_free_units_per_events: invalid_free_units_per_events
+        invalid_free_units_per_total_aggregation: invalid_free_units_per_total_aggregation
         invalid_content_type: invalid_content_type
         invalid_size: invalid_size
         value_already_exists: value_already_exists

schema.graphql

@@ -136,6 +136,8 @@ type Charge {
   createdAt: ISO8601DateTime!
   fixedAmount: String
   freeUnits: Int
+  freeUnitsPerEvents: Int
+  freeUnitsPerTotalAggregation: String
   graduatedRanges: [GraduatedRange!]
   id: ID!
   packageSize: Int
@@ -150,6 +152,8 @@ input ChargeInput {
   chargeModel: ChargeModelEnum!
   fixedAmount: String
   freeUnits: Int
+  freeUnitsPerEvents: Int
+  freeUnitsPerTotalAggregation: String
   graduatedRanges: [GraduatedRangeInput!]
   id: ID
   packageSize: Int

schema.json

@@ -1336,6 +1336,34 @@
 
               ]
             },
+            {
+              "name": "freeUnitsPerEvents",
+              "description": null,
+              "type": {
+                "kind": "SCALAR",
+                "name": "Int",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null,
+              "args": [
+
+              ]
+            },
+            {
+              "name": "freeUnitsPerTotalAggregation",
+              "description": null,
+              "type": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null,
+              "args": [
+
+              ]
+            },
             {
               "name": "graduatedRanges",
               "description": null,
@@ -1573,6 +1601,30 @@
               "defaultValue": null,
               "isDeprecated": false,
               "deprecationReason": null
+            },
+            {
+              "name": "freeUnitsPerEvents",
+              "description": null,
+              "type": {
+                "kind": "SCALAR",
+                "name": "Int",
+                "ofType": null
+              },
+              "defaultValue": null,
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
+            {
+              "name": "freeUnitsPerTotalAggregation",
+              "description": null,
+              "type": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              },
+              "defaultValue": null,
+              "isDeprecated": false,
+              "deprecationReason": null
             }
           ],
           "enumValues": null

spec/factories/charge_factory.rb

@@ -35,7 +35,7 @@
       properties do
         {
           rate: '0.0555',
-          fixed_amount: '2',
+          fixed_amount: '2'
         }
       end
     end

spec/graphql/mutations/plans/create_spec.rb

@@ -64,6 +64,8 @@
               chargeModel: 'percentage',
               rate: '0.25',
               fixedAmount: '2',
+              freeUnitsPerEvents: 5,
+              freeUnitsPerTotalAggregation: '50',
             },
             {
               billableMetricId: billable_metrics.last.id,

spec/graphql/mutations/plans/update_spec.rb

@@ -65,6 +65,8 @@
               chargeModel: 'percentage',
               rate: '0.25',
               fixedAmount: '2',
+              freeUnitsPerEvents: 5,
+              freeUnitsPerTotalAggregation: '50',
             },
             {
               billableMetricId: billable_metrics.last.id,

spec/models/charge_spec.rb

@@ -172,6 +172,8 @@
         message: [
           :invalid_rate,
           :invalid_fixed_amount,
+          :invalid_free_units_per_events,
+          :invalid_free_units_per_total_aggregation,
         ],
       )
     end
@@ -187,6 +189,8 @@
         expect(charge.errors.messages.keys).to include(:properties)
         expect(charge.errors.messages[:properties]).to include('invalid_rate')
         expect(charge.errors.messages[:properties]).to include('invalid_fixed_amount')
+        expect(charge.errors.messages[:properties]).to include('invalid_free_units_per_events')
+        expect(charge.errors.messages[:properties]).to include('invalid_free_units_per_total_aggregation')
 
         expect(Charges::Validators::PercentageService).to have_received(:new)
           .with(charge: charge)