gamco 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8a255610ca8bbd747457d590a459eedfb4de5ccc2ca3e3458d086de8b7016f4
-  data.tar.gz: 404876a57f493268e1efe0aa7385f5850f18350854aa7eba6d24db9b9df994e0
+  metadata.gz: f9d7669e0d92350bceb06b3a05a23d44138ae1ad4ab7314ce55eb0dcde41aa43
+  data.tar.gz: 6f35eb96d66b13d7ac550f52e206de841f60626c42aba204cd8bbd048fe2d642
 SHA512:
-  metadata.gz: 4e83a1ca58c31800b95a8e2b75aa6e60d141070f49bb1330435cbeec4f89ef423a9d830f9eb82ea0c7929f886b9caa0439a2d6b14e394fe10c1373d26da2e60e
-  data.tar.gz: 0e9f8198d890908060fc63fdb0c302f0fcaf9567ab4d90e5f072ef8a2e56da369e651a7c3b8332657763f86444fb6a66428fcb1b3f69dba1e82c2d2967ca7ceb
+  metadata.gz: 044b24d61425016ba9306e1f98baa7727931125d6d06f4da3758e4959de3241abf8ba1c87997e0bf1b1018e91f32cafd78d30b231f528f32e1038a3740e1d1c4
+  data.tar.gz: f69ffbfe20862849c52ff21ea58ead2665fee86a637ed03d30177e04598a8243b23a51b35427ef571c7b4096d7cca2fd47887d5dff2af92fa3fa9ecb0a73297a

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-09-26
+## [Released]
+
+## [0.2.0] - 2022-10-05
+
+- Add Configuration.active option to control if data should
+be sent to Google Analytics.
+
+## [0.1.1] - 2022-10-04
+
+- Improve `ga_secure` helper to avoid using it when passed
+value is nil or empty.
+
+## [0.1.0] - 2022-10-04
 
 - Initial release

data/README.md

@@ -98,6 +98,22 @@ Gamco.setup do |config|
 end
 ```
 
+### Usage per environment
+
+It is possible that you want to send data to Google Analytics just in
+production environments. You can control that using the `active` configuration
+option in the initializer `config/initializers/gamco.rb`:
+
+```ruby
+Gamco.setup do |config|
+  # ===> Required GA4 configuration options
+  config.tag_id = "G-XXXXXXXXX"
+  config.active = Rails.application.credentials.dig(:gamco, :active)
+
+  ...
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then,

data/lib/gamco/builder.rb

@@ -34,12 +34,10 @@ module Gamco
     end
 
     def gtag_script_content(tag_id, options)
-      <<-FOO
-      window.dataLayer = window.dataLayer || [];
-      function gtag(){dataLayer.push(arguments);}
-      gtag('js', new Date());
-      gtag('config', '#{tag_id}', #{options.to_json});
-      FOO
+      "window.dataLayer = window.dataLayer || [];"\
+      "function gtag(){dataLayer.push(arguments);}"\
+      "gtag('js', new Date());"\
+      "gtag('config', '#{tag_id}', #{options.to_json});"
     end
 
     def tag_manager_script_url

data/lib/gamco/configuration.rb

@@ -3,6 +3,7 @@
 module Gamco
   module Configuration
     mattr_accessor :tag_id, default: nil
+    mattr_accessor :active, default: false
 
     mattr_accessor :secure, default: -> (value) do
       Digest::MD5.hexdigest(value)

data/lib/gamco/errors/no_tag_id.rb

@@ -2,6 +2,10 @@
 
 module Gamco
   module Errors
-    class NoTagId < StandardError; end
+    class NoTagId < StandardError
+      def initialize(message = "Configure your TAG_ID in your initializer.")
+        super
+      end
+    end
   end
 end

data/lib/gamco/helper.rb

@@ -3,11 +3,13 @@
 module Gamco
   module Helper
     def ga_javascript_tags(tag_id: Configuration.tag_id, **options)
+      return unless Configuration.active
       raise Errors::NoTagId unless tag_id.present?
       ga_builder.javascript_tags(tag_id, options)
     end
 
     def ga_tag(type, event, options = {})
+      return unless Configuration.active
       ga_builder.tag(type, event, options)
     end
 

data/lib/gamco/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gamco
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/gamco.rb

@@ -4,6 +4,7 @@ require_relative "gamco/version"
 require_relative "gamco/builder"
 require_relative "gamco/helper"
 require_relative "gamco/configuration"
+require_relative "gamco/errors/no_tag_id"
 
 module Gamco
   extend Configuration

data/lib/generators/gamco/templates/gamco.rb

@@ -3,6 +3,7 @@
 Gamco.setup do |config|
   # ===> Required GA4 configuration options
   # config.tag_id = "G-XXXXXXXXXXX"
+  # config.tag_id = false
 
   # ===> Method to secure sensitive data.
   # config.secure = -> (value) {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamco
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Alejandro Gutiérrez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-04 00:00:00.000000000 Z
+date: 2022-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails