gamco 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 90384de6681b9f81cd09552378fcaecfcab73bff8648691845cce57b75e870f8
+  data.tar.gz: f2fee0bfb32f91c3cbf911ce30e089af52bd0b4ae2d6b61d66c0e883f0cd2915
+SHA512:
+  metadata.gz: 74896f548b6938ecb6fc93ea51f34bd282c92bf6e412bc61b87ebb00de0ca43d27931466b529cd1cb3fd88f091e2946eaf3a454e77d6529eff671f21f7b087a0
+  data.tar.gz: 977e37ecbe9dbc37b40429f0859d363e63b5c553c5597bee9340dab4c5092771c434fc655f6adfa17acabc711fac8e4cf947ebaffc23d8bb8d28cf09e0e27dff

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-09-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at alejandrodevs@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gamco.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Alejandro Gutiérrez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,129 @@
+# Gamco - Google Analytics Helper
+
+This gem aims to provide a simple and easy way to send data to Google
+Analytics. It provides some view helpers that can be used in any rails
+application.
+
+## Installation
+
+Add `Gamco` to your application's Gemfile:
+
+```ruby
+gem "gamco"
+```
+
+And then install gamco:
+
+```bash
+rails g gamco:install
+```
+
+## Configuration
+
+Provide your `TAG_ID` in `config/initializers/gamco.rb`:
+
+```ruby
+Gamco.setup do |config|
+  # ===> Required GA4 configuration options
+  config.tag_id = "G-XXXXXXXXX"
+
+  ...
+end
+```
+
+## Usage
+
+Usually you'll want to add your Google Analytics script immediately after
+your `<head>` tag in your html. In rails, this is usually done in your
+layout file `(app/views/layouts/application.html.erb)`.
+
+```ruby
+<html>
+  <head>
+    <%= ga_javascript_tags %>
+    ...
+  </head>
+```
+
+This will send the default `page_view` event every time the user navigates
+to a different path in your application. You can pass other dimensions if
+you want to collect extra data. Example:
+
+```ruby
+<html>
+  <head>
+    <%= ga_javascript_tags(environment: Rails.env) %>
+    ...
+  </head>
+```
+
+### Custom events
+
+Also, you can send custom messages to Google Analytics per page or when
+needed by using the `ga_tag` helper as the following example:
+
+```ruby
+# app/views/products/show.html.erb
+<%= ga_tag "event", "product_view", product_id: @product.id %>
+
+...
+```
+
+### Secure data
+
+There are sensitive information that you might not want to send it directly
+to Google Analytics to prevent some vulnerabilities. You can achieve this
+by using the `ga_secure` helper which generates a digest for the passed value:
+
+```ruby
+# app/views/products/show.html.erb
+<%= ga_tag "event", "product_view",
+  user: ga_secure(current_user.id),
+  product_id: @product.id %>
+
+...
+```
+
+By default the generated value is a MD5 digest. You can configure which
+algorithm will be used in the initializer `config/initializers/gamco.rb`:
+
+```ruby
+Gamco.setup do |config|
+  ...
+
+  # ===> Method to secure sensitive data.
+  # config.secure = -> (value) {
+  #   Digest::MD5.hexdigest(value)
+  # }
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and
+then run `bundle exec rake release`, which will create a git tag for the
+version, push git commits and the created tag, and push the `.gem` file
+to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amco/gamco.
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the
+[code of conduct](https://github.com/amco/gamco/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Gamco project's codebases, issue trackers, chat rooms
+and mailing lists is expected to follow the
+[code of conduct](https://github.com/amco/gamco/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/gamco.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/gamco/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "gamco"
+  spec.version = Gamco::VERSION
+  spec.authors = ["Alejandro Gutiérrez"]
+  spec.email = ["alejandrodevs@gmail.com"]
+
+  spec.summary = "Google Analytics helpers for ruby applications."
+  spec.description = "This gem aims to provide a simple and easy way to send data to Google Analytics."
+  spec.homepage = "https://github.com/amco/gamco"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the "allowed_push_host"
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/gamco/builder.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Gamco
+  class Builder
+    attr_reader :view
+
+    def initialize(view)
+      @view = view
+    end
+
+    def javascript_tags(tag_id, options = {})
+      gtag_manager_script(tag_id) +
+        gtag_script(tag_id, options)
+    end
+
+    def tag(type, event, options = {})
+      view.content_tag(:script) do
+        dimensions = options.to_json
+        "gtag('#{type}', '#{event}', #{dimensions})".html_safe
+      end
+    end
+
+    private
+
+    def gtag_manager_script(tag_id)
+      view.content_tag :script, "", async: true,
+        src: "#{tag_manager_script_url}?id=#{tag_id}"
+    end
+
+    def gtag_script(tag_id, options)
+      view.content_tag(:script) do
+        gtag_script_content(tag_id, options).html_safe
+      end
+    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
+    end
+
+    def tag_manager_script_url
+      "https://www.googletagmanager.com/gtag/js"
+    end
+  end
+end

data/lib/gamco/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Gamco
+  module Configuration
+    mattr_accessor :tag_id, default: nil
+
+    mattr_accessor :secure, default: -> (value) do
+      Digest::MD5.hexdigest(value)
+    end
+
+    def setup
+      yield(self) if block_given?
+    end
+  end
+end

data/lib/gamco/errors/no_tag_id.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Gamco
+  module Errors
+    class NoTagId < StandardError; end
+  end
+end

data/lib/gamco/helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Gamco
+  module Helper
+    def ga_javascript_tags(tag_id: Configuration.tag_id, **options)
+      raise Errors::NoTagId unless tag_id.present?
+      ga_builder.javascript_tags(tag_id, options)
+    end
+
+    def ga_tag(type, event, options = {})
+      ga_builder.tag(type, event, options)
+    end
+
+    def ga_secure(value)
+      Configuration.secure.call(value)
+    end
+
+    private
+
+    def ga_builder
+      @ga_builder ||= Gamco::Builder.new(self)
+    end
+  end
+end

data/lib/gamco/version.rb

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

data/lib/gamco.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "gamco/version"
+require_relative "gamco/builder"
+require_relative "gamco/helper"
+require_relative "gamco/configuration"
+
+module Gamco
+  extend Configuration
+end
+
+ActiveSupport.on_load(:action_view) do
+  include Gamco::Helper
+end

data/lib/generators/gamco/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Gamco
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      desc "Creates Gamco initializer."
+
+      def create_initializer
+        template "gamco.rb", "config/initializers/gamco.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+Gamco.setup do |config|
+  # ===> Required GA4 configuration options
+  # config.tag_id = "G-XXXXXXXXXXX"
+
+  # ===> Method to secure sensitive data.
+  # config.secure = -> (value) {
+  #   Digest::MD5.hexdigest(value)
+  # }
+end

data/sig/gamco.rbs

@@ -0,0 +1,4 @@
+module Gamco
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: gamco
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alejandro Gutiérrez
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-04 00:00:00.000000000 Z
+dependencies: []
+description: This gem aims to provide a simple and easy way to send data to Google
+  Analytics.
+email:
+- alejandrodevs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gamco.gemspec
+- lib/gamco.rb
+- lib/gamco/builder.rb
+- lib/gamco/configuration.rb
+- lib/gamco/errors/no_tag_id.rb
+- lib/gamco/helper.rb
+- lib/gamco/version.rb
+- lib/generators/gamco/install_generator.rb
+- lib/generators/gamco/templates/gamco.rb
+- sig/gamco.rbs
+homepage: https://github.com/amco/gamco
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/amco/gamco
+  source_code_uri: https://github.com/amco/gamco
+  changelog_uri: https://github.com/amco/gamco/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Google Analytics helpers for ruby applications.
+test_files: []