utm_tracker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1fea7a1eba819ae12c4579d1eebe042db4a33456f1019871e335ad5f2d03b67d
+  data.tar.gz: 20e46a89566567ba6472f2fcd3cdb1b1a1f0bc5f0142641448d7d03b272ee6e1
+SHA512:
+  metadata.gz: 49aa829ce2aa8e450d8bcab536ff3af2e1ca9a0f9702f885ebe2e5db2c39c446d0896a177c61944ce7558f928ce233087d98a5617e19d743f4d5b4bddb56c70d
+  data.tar.gz: 6fa3c66ab5566faa13cf9fda8fb38c150357cdd2773809c84add4902502ffb3f668afae7017e496f281116e3c3081162ae92a765587d41860711db9de7e698a1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in utm_tracker.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    utm_tracker (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry (~> 0.13)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  utm_tracker!
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,72 @@
+# UtmTracker
+
+This gem allow to save UTM tags into your Rails app. UtmTracker allows you to save in the user object with which advertisement he was registered.
+
+## Requirements
+
+- Ruby 2.7.1
+- Rails 6.1.x
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'utm_tracker'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage for Rails
+
+1. You need to generate Rails migration and add utm_data into your User model for UTM-tags:
+
+$ rails g migration add_utm_data_to_executors utm_data:jsonb
+
+and add not null and default modificators into rails migrations:
+```ruby
+def change
+  add_column :users, :utm_data, :jsonb, null: false, default: {}
+end
+```
+
+and then:
+
+$ rails db:migrate
+
+2. Prepare link into user registration controller:
+
+$ https://example.com?utm[source]=google&utm[medium]=cpc&utm[campaign]=testcampaign&utm[content]={adgroupid}&utm[term]={keyword}
+
+3. Add into ApplicationController next helper for save utm_tags into current_user session:
+```ruby
+class ApplicationController < ActionController::Base
+  include UtmTracker::Helper
+end
+```
+
+4. After that, you can use callback into your controllers for get utm data in current user session:
+```ruby
+before_action :get_utm_data
+```
+
+Add this callback where you plan to receive advertising traffic.
+
+5. Into user registration controller add UtmTracker client after save user and put user object and session[:utm]:
+```ruby
+@utm = UtmTracker::Client.new(object: @user, utm: session[:utm])
+@utm.call
+```
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alexlev1/utm_tracker.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "utm_tracker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/utm_tracker/helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module UtmTracker
+  module Helper
+    protected
+
+    def get_utm_data
+      session[:utm_data] ||= params[:utm]
+    end
+  end
+end

data/lib/utm_tracker/matcher.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module UtmTracker
+  class Matcher
+    attr_accessor :utm_data, :utm
+
+    def initialize(utm_data, utm = {})
+      @utm_data = utm_data
+      @utm = utm
+    end
+
+    def call
+      utm_source
+      utm_content
+      utm_medium
+      utm_campaign
+      utm_term
+    end
+
+    private
+
+    def utm_source
+      utm[:utm_source] = utm_data['source'] if utm_data['source']
+    end
+
+    def utm_content
+      utm[:utm_content] = utm_data['content'] if utm_data['content']
+    end
+
+    def utm_medium
+      utm[:utm_medium] = utm_data['medium'] if utm_data['medium']
+    end
+
+    def utm_campaign
+      utm[:utm_campaign] = utm_data['campaign'] if utm_data['campaign']
+    end
+
+    def utm_term
+      utm[:utm_term] = utm_data['term'] if utm_data['term']
+    end
+  end
+end

data/lib/utm_tracker/version.rb

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

data/lib/utm_tracker.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "utm_tracker/version"
+require_relative "utm_tracker/helper"
+require_relative "utm_tracker/matcher"
+
+module UtmTracker
+  class Client
+    attr_accessor :object, :utm_matcher
+
+    def initialize(object, utm_data)
+      @object = object
+      @utm_matcher = UtmTracker::Matcher.new(utm_data)
+    end
+
+    def call
+      match_utm_tags
+      save_utm_tags_into_database!
+    end
+
+    protected
+
+    def match_utm_tags
+      @utm_matcher.call
+    end
+
+    def save_utm_tags_into_database!
+      object.update!(utm_data: @utm_matcher.utm)
+    end
+  end
+end

data/utm_tracker.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/utm_tracker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "utm_tracker"
+  spec.version       = UtmTracker::VERSION
+  spec.authors       = ["Alexander Levashov"]
+  spec.email         = ["alevash1@gmail.com"]
+
+  spec.summary       = 'Gem for UTM tags tracking'
+  spec.description   = %q{Allow save UTM tags into database}
+  spec.homepage      = "https://github.com/alexlev1/utm_tracker"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.1")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/alexlev1/utm_tracker"
+  spec.metadata["changelog_uri"] = "https://github.com/alexlev1/utm_tracker"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'pry', '~> 0.13'
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: utm_tracker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alexander Levashov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+description: Allow save UTM tags into database
+email:
+- alevash1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/utm_tracker.rb
+- lib/utm_tracker/helper.rb
+- lib/utm_tracker/matcher.rb
+- lib/utm_tracker/version.rb
+- utm_tracker.gemspec
+homepage: https://github.com/alexlev1/utm_tracker
+licenses: []
+metadata:
+  homepage_uri: https://github.com/alexlev1/utm_tracker
+  source_code_uri: https://github.com/alexlev1/utm_tracker
+  changelog_uri: https://github.com/alexlev1/utm_tracker
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Gem for UTM tags tracking
+test_files: []