katalyst-google-apis 1.3.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 249511e97a7e28426cbf5ad750c3c77c1dc5f882c885a37868537bfea975a9e7
-  data.tar.gz: 86758221a5cdc2a554d767a7e126b1acd48d3034b87100e23dd88876e291e713
+  metadata.gz: 91607481f87f73f9f4e17f687e6f9f98c6005ec7b25b90f2e16f3a96dd2f8286
+  data.tar.gz: 9663f5605e940f362fb2b7e9d7294890960c6666dfe0ae595e83c700c5e559be
 SHA512:
-  metadata.gz: da31ead0972e8152ab79e04c2a18ed875dcc367187f8ee03a60f7d89337d85956f95f944f524852eddd8fbe940da4e45884bd39dae471d499134a19faaccea59
-  data.tar.gz: ece80e3217d17d22c28f8b787c10ad843200b3c322b6dd1427b2a13ef3bdcbd4df484adeccef53ef83c5d12d104bbfc012fd0a49e39a5834e4a7dda7b71e393a
+  metadata.gz: 77b2105dd910de97aaf9c0eb80999d76f3e0f972bd9e8b29699c8daf33504166ceef279f07c601dd8ea19e6337d642a8e439ee50b55dc816251e617f4a1cc735
+  data.tar.gz: a2d8a5ed4d6f19fcf58380084400c355b1a013b71aa62e5eb5964b2a7fe32158b0e41a8233b0a8f718120d16cdade6ba4df856cbfdccea782cacc75d9d4329d9

data/app/helpers/katalyst/google_apis/form_builder.rb

@@ -2,28 +2,33 @@
 
 module Katalyst
   module GoogleApis
+    # rubocop:disable Rails/HelperInstanceVariable
     module FormBuilder
-      def recaptcha_field(attribute = :recaptcha_token, action: object_name,
-                          site_key: GoogleApis.config.recaptcha.site_key)
-        safe_join([
-                    RecaptchaField.new(action:, attribute:, site_key:).render(self),
-                    hidden_field(attribute),
-                  ])
+      ##
+      # :method: recaptcha_field
+      #
+      # :call-seq: recaptcha_field(method = :recaptcha_token, options = {})
+      #
+      #   <%= form_with model: @contact do |f| %>
+      #     <%= f.recaptcha_field %>
+      #   <% end %>
+      #
+      # Please refer to the documentation of the base helper for details.
+      def recaptcha_field(attribute = :recaptcha_token, site_key: GoogleApis.config.recaptcha.site_key, **)
+        RecaptchaField.new(@object_name, attribute, site_key:, **).render(@template)
       end
 
       class RecaptchaField
-        attr_reader :action, :attribute, :site_key
-
-        def initialize(action:, attribute:, site_key:)
-          # rubocop:disable Rails/HelperInstanceVariable
-          @action    = action
-          @attribute = attribute
-          @site_key  = site_key
-          # rubocop:enable Rails/HelperInstanceVariable
+        def initialize(object_name, attribute, site_key:, **html_attributes)
+          @object_name     = object_name
+          @attribute       = attribute
+          @site_key        = site_key
+          @html_attributes = html_attributes
         end
 
         def render(template)
-          template.tag.div(data:)
+          template.safe_join([template.tag.div(**@html_attributes, data:),
+                              template.hidden_field(@object_name, @attribute)])
         end
 
         private
@@ -32,11 +37,12 @@ module Katalyst
           {
             controller:               "recaptcha",
             action:                   "turbo:before-morph-element->recaptcha#morph",
-            recaptcha_action_value:   action,
-            recaptcha_site_key_value: site_key,
+            recaptcha_action_value:   @object_name,
+            recaptcha_site_key_value: @site_key,
           }
         end
       end
     end
+    # rubocop:enable Rails/HelperInstanceVariable
   end
 end

data/app/helpers/katalyst/google_apis/govuk_form_builder.rb

@@ -3,13 +3,73 @@
 module Katalyst
   module GoogleApis
     module GOVUKFormBuilder
-      def govuk_recaptcha_field(attribute = :recaptcha_token, **)
-        GOVUKDesignSystemFormBuilder::Containers::FormGroup.new(self, object_name, attribute).html do
+      # Generates a Google recaptcha input that shows errors.
+      #
+      # @param attribute_name [Symbol] The name of the attribute
+      # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ element
+      # @param form_group [Hash] configures the form group
+      # @option form_group kwargs [Hash] additional attributes added to the form group
+      # @param before_input [String,Proc] the content injected before the input. No content will be added if left +nil+
+      # @param after_input [String,Proc] the content injected after the input. No content will be added if left +nil+
+      # @return [ActiveSupport::SafeBuffer] HTML output
+      #
+      # @example A google recaptcha input
+      #   = f.govuk_recaptcha_field
+      #
+      def govuk_recaptcha_field(attribute_name = :recaptcha_token,
+                                form_group: {}, before_input: nil, after_input: nil, **)
+        Recaptcha.new(self, object_name, attribute_name, form_group:, before_input:, after_input:, **).html
+      end
+
+      class Recaptcha < GOVUKDesignSystemFormBuilder::Base
+        include GOVUKDesignSystemFormBuilder::Traits::Error
+        include GOVUKDesignSystemFormBuilder::Traits::HTMLAttributes
+        include GOVUKDesignSystemFormBuilder::Traits::ContentBeforeAndAfter
+
+        def initialize(builder, object_name, attribute_name, form_group:, before_input:, after_input:, **kwargs)
+          super(builder, object_name, attribute_name)
+
+          @html_attributes      = kwargs
+          @form_group           = form_group
+          @before_input         = before_input
+          @after_input          = after_input
+        end
+
+        def html
+          GOVUKDesignSystemFormBuilder::Containers::FormGroup.new(*bound, **@form_group).html do
+            safe_join([error_element, content])
+          end
+        end
+
+        private
+
+        def content
           safe_join([
-                      GOVUKDesignSystemFormBuilder::Elements::ErrorMessage.new(self, object_name, attribute),
-                      recaptcha_field(attribute, **),
+                      before_input_content,
+                      input,
+                      after_input_content,
                     ])
         end
+
+        def input
+          @builder.send(:recaptcha_field, @attribute_name, **attributes(@html_attributes))
+        end
+
+        def options
+          {
+            id:    field_id(link_errors: true),
+            class: classes,
+            aria:  { describedby: combine_references(error_id) },
+          }
+        end
+
+        def classes
+          [%(#{brand}-recaptcha)].push(error_classes).compact
+        end
+
+        def error_classes
+          %(#{brand}-recaptcha--error) if has_errors?
+        end
       end
     end
   end

data/app/services/katalyst/google_apis/error.rb

@@ -8,8 +8,8 @@ module Katalyst
       def initialize(code:, status:, message:, details: nil)
         super(message)
 
-        @code = code
-        @status = status
+        @code    = code
+        @status  = status
         @details = details
       end
 

data/app/services/katalyst/google_apis/gemini/generate_content_service.rb

@@ -16,11 +16,11 @@ module Katalyst
 
         def initialize(credentials:, model:, parent:, attempt:, retries:, jitter:)
           @credentials = credentials
-          @model = model
-          @parent = parent
-          @attempt = attempt
-          @retries = retries
-          @jitter = jitter
+          @model       = model
+          @parent      = parent
+          @attempt     = attempt
+          @retries     = retries
+          @jitter      = jitter
         end
 
         def call(payload:)
@@ -101,8 +101,8 @@ module Katalyst
             Kernel.sleep(backoff)
 
             @response = nil
-            @result = nil
-            @error = nil
+            @result   = nil
+            @error    = nil
             @attempt += 1
             true
           else

data/app/services/katalyst/google_apis/geocoding/reverse_service.rb

@@ -74,7 +74,7 @@ module Katalyst
           location = first_location&.dig(:location)
           return if location.blank?
 
-          latitude = location[:latitude]
+          latitude  = location[:latitude]
           longitude = location[:longitude]
           return if latitude.nil? || longitude.nil?
 

data/app/services/katalyst/google_apis/geocoding/search_service.rb

@@ -23,7 +23,7 @@ module Katalyst
 
         def call(address:, bounds:)
           @address = address
-          @bounds = bounds
+          @bounds  = bounds
 
           @response = Curl.get(url, **params) do |http|
             http.headers["Content-Type"] = "application/json; UTF-8"
@@ -75,7 +75,7 @@ module Katalyst
           location = first_location&.dig(:location)
           return if location.blank?
 
-          latitude = location[:latitude]
+          latitude  = location[:latitude]
           longitude = location[:longitude]
           return if latitude.nil? || longitude.nil?
 
@@ -95,7 +95,7 @@ module Katalyst
         def params
           low, high = @bounds.split("|")
 
-          low_lat, low_lng = low.split(",")
+          low_lat, low_lng   = low.split(",")
           high_lat, high_lng = high.split(",")
 
           {

data/app/services/katalyst/google_apis/recaptcha/assessment_service.rb

@@ -14,7 +14,7 @@ module Katalyst
 
         def initialize(credentials:, parent:)
           @credentials = credentials
-          @parent = parent
+          @parent      = parent
         end
 
         def call(assessment:)

data/lib/katalyst/google_apis/config.rb

@@ -3,20 +3,19 @@
 module Katalyst
   module GoogleApis
     class Config
-      include ActiveSupport::Configurable
+      attr_accessor :project_id, :project_number, :service_account_email, :identity_pool, :identity_provider, :recaptcha
 
-      config_accessor(:project_id) { ENV.fetch("GOOGLE_PROJECT_ID", nil) }
-      config_accessor(:project_number) { ENV.fetch("GOOGLE_PROJECT_NUMBER", nil) }
-      config_accessor(:service_account_email) { ENV.fetch("GOOGLE_SERVICE_ACCOUNT_EMAIL", nil) }
-      config_accessor(:identity_pool) { ENV.fetch("GOOGLE_OIDC_IDENTITY_POOL", nil) }
-      config_accessor(:identity_provider) { ENV.fetch("GOOGLE_OIDC_IDENTITY_PROVIDER", nil) }
-
-      config_accessor(:recaptcha) do
-        defaults           = ActiveSupport::OrderedOptions.new
-        defaults.site_key  = ENV.fetch("GOOGLE_RECAPTCHA_SITE_KEY", nil)
-        defaults.score     = ENV.fetch("GOOGLE_RECAPTCHA_SCORE", 0.5).to_f
-        defaults.test_mode = !ENV.fetch("VERIFY_RECAPTCHA", !Rails.env.local?) # rubocop:disable Rails/UnknownEnv
-        defaults
+      def initialize
+        @project_id            = ENV.fetch("GOOGLE_PROJECT_ID", nil)
+        @project_number        = ENV.fetch("GOOGLE_PROJECT_NUMBER", nil)
+        @service_account_email = ENV.fetch("GOOGLE_SERVICE_ACCOUNT_EMAIL", nil)
+        @identity_pool         = ENV.fetch("GOOGLE_OIDC_IDENTITY_POOL", nil)
+        @identity_provider     = ENV.fetch("GOOGLE_OIDC_IDENTITY_PROVIDER", nil)
+        @recaptcha             = ActiveSupport::OrderedOptions.new.tap do |defaults|
+          defaults.site_key  = ENV.fetch("GOOGLE_RECAPTCHA_SITE_KEY", nil)
+          defaults.score     = ENV.fetch("GOOGLE_RECAPTCHA_SCORE", 0.5).to_f
+          defaults.test_mode = !ENV.fetch("VERIFY_RECAPTCHA", !Rails.env.local?)
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-google-apis
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Katalyst Interactive
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Google REST APIs for use in Rails projects
 test_files: []