devise-acquirable 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 772d26458e235d52ee8e5db2867f89c526d02383bff8617526af97c06eff5616
+  data.tar.gz: 19c66fa1669a99d4c85e7decd4cca051d35b820242622788967694a724a525bc
+SHA512:
+  metadata.gz: 5081f59d6a54e01c78ef0212fc28117145ce823976051989b68c34df0b6edcc2fd28afbb00a1484a1e286eb08164d4d803e0f3cc43ffe19b5ff85d9245c2bd78
+  data.tar.gz: a06f1b7febef3d399f0a977e627a381b0c403a1f42c66a76dc802d0f05708cf46605698e395bcb217cfa467e64efb907a6c8d69af56454744eab280463e2aa53

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in devise-acquirable.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', require: false
+gem 'rubocop-rake', require: false
+gem 'rubocop-rspec', require: false

data/Gemfile.lock

@@ -0,0 +1,130 @@
+PATH
+  remote: .
+  specs:
+    devise-acquirable (0.1.0)
+      devise (~> 4.0, >= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.3)
+      actionview (= 7.0.3)
+      activesupport (= 7.0.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.3)
+      activesupport (= 7.0.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    bcrypt (3.1.18)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    devise (4.8.1)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 4.1.0)
+      responders
+      warden (~> 1.2.3)
+    diff-lcs (1.5.0)
+    erubi (1.10.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.8.0)
+    minitest (5.16.2)
+    nokogiri (1.13.6)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    orm_adapter (0.5.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (7.0.3)
+      actionpack (= 7.0.3)
+      activesupport (= 7.0.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.5.0)
+    responders (3.0.1)
+      actionpack (>= 5.0)
+      railties (>= 5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.31.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
+    ruby-progressbar (1.11.0)
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    warden (1.2.9)
+      rack (>= 2.0.9)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  devise-acquirable!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Simon Lehmann
+
+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,48 @@
+# Devise::Acquirable
+
+> This project started as a fork of nate's [n8/devise_marketable](https://github.com/n8/devise_marketable) project.
+
+Acquirable lets [Devise](https://github.com/plataformatec/devise) implementers easily store where a user came from and where they were going in your Rails app.
+
+With Acquirable, Devise will automatically create two cookies for your users when they first visit your app, the referring_url (where they came from) and the landing_url (where they landed). When the user registers with your application, the values in those cookies are stored alongside your user data.
+
+## Installation
+
+1. Add 'devise-acquirable' to your Gemfile.
+
+```ruby
+gem 'devise-acquirable'
+```
+
+2. Run `bundle install`
+3. Add the marketing fields to your user table:
+
+```shell
+rails g devise-acquirable MODEL
+```
+
+MODEL is probably `User`. It's what you attach Devise to. (e.g. User, Admin, Account)
+
+```shell
+rails g devise-acquirable User
+```
+
+4. Run your migration
+
+```shell
+bundle exec rails db:migrate
+```
+
+5. Check `:acquirable` was added to the `devise` call in your model by the `devise:acquirable` generator
+
+```ruby
+devise :database_authenticatable, ..., :acquirable
+```
+
+6. Restart your server
+
+That's it. You now have some very powerful data: where your best customers come from, what traffic sources are your most lucrative, what on your website converts the best, what people are most interested in, etc.
+
+## Feedback
+
+[Source code available on Github](https://github.com/simonlehmann/devise-acquirable). Feedback and pull requests are greatly appreciated.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/devise-acquirable.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'devise/acquirable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'devise-acquirable'
+  spec.version       = Devise::Acquirable::VERSION
+  spec.authors       = ['Simon Lehmann']
+  spec.email         = ['slehmann36@gmail.com']
+  spec.description   = 'Easily capture and store marketing data during Devise user onboarding.'
+  spec.summary       = 'Easily capture and store marketing data during Devise user onboarding.'
+  spec.homepage      = 'https://github.com/simonlehmann/devise-acquirable'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'devise', '~> 4.0', '>= 4.0.0'
+end

data/lib/devise/acquirable/model.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Devise
+  module Models
+    module Acquirable
+    end
+  end
+end

data/lib/devise/acquirable/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Devise
+  module Acquirable
+    VERSION = '0.1.1'
+  end
+end

data/lib/devise/acquirable.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'devise'
+require 'devise/acquirable/version'
+
+Devise.add_module :acquirable, model: 'devise/acquirable/model', controller: :registrations
+
+module Devise
+  module Acquirable
+    module Controller
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :set_tracking_cookies
+      end
+
+      def set_tracking_cookies
+        cookies[:referring_url] =
+          { value: request.env['HTTP_REFERER'], expires: 90.days.from_now } if cookies[:referring_url].blank?
+
+        cookies[:landing_url] =
+          { value: request.url, expires: 90.days.from_now } if cookies[:landing_url].blank?
+      end
+    end
+
+    module RegistrationsController
+      extend ActiveSupport::Concern
+
+      included do
+        alias_method :devise_build_resource, :build_resource
+        def build_resource(hash = nil)
+          custom_build_resource(hash)
+        end
+      end
+
+      def custom_build_resource(hash = nil)
+        devise_build_resource(hash)
+
+        set_marketing_attributes if devise_mapping.acquirable?
+
+        resource
+      end
+
+      def set_marketing_attributes
+        resource.referring_url = cookies[:referring_url]
+        resource.landing_url = cookies[:landing_url]
+      end
+    end
+
+    class Engine < ::Rails::Engine
+      ActiveSupport.on_load(:action_controller) do
+        include Devise::Acquirable::Controller
+      end
+
+      config.to_prepare do
+        Devise::RegistrationsController.include Devise::Acquirable::RegistrationsController
+      end
+    end
+  end
+end

data/lib/generators/devise/acquirable_generator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+
+module Devise
+  module Generators
+    class AcquirableGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Generate migration for ActiveRecord and add :acquirable directive in the given model.'
+
+      def copy_migration
+        migration_template 'migration.rb', "db/migrate/devise_acquirable_add_to_#{table_name}.rb",
+                           migration_version: migration_version
+      end
+
+      def inject_devise_acquirable_content
+        path = File.join('app', 'models', "#{file_path}.rb")
+        inject_into_file(path, 'acquirable, :', after: 'devise :') if File.exist?(path)
+      end
+
+      private
+
+      def versioned_migrations?
+        Rails::VERSION::MAJOR >= 5
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if versioned_migrations?
+      end
+    end
+  end
+end

data/lib/generators/devise/templates/migration.rb

@@ -0,0 +1,11 @@
+class DeviseAcquirableAddTo<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    add_column :<%= table_name %>, :referring_url, :text
+    add_column :<%= table_name %>, :landing_url, :text
+  end
+
+  def self.down
+    remove_column :<%= table_name %>, :referring_url
+    remove_column :<%= table_name %>, :landing_url
+  end
+end

data/spec/devise/acquirable_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.describe Devise::Acquirable do
+  it 'has a version number' do
+    expect(Devise::Acquirable::VERSION).not_to be nil
+  end
+
+  it 'does something useful'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'devise/acquirable'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: devise-acquirable
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Simon Lehmann
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: Easily capture and store marketing data during Devise user onboarding.
+email:
+- slehmann36@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- devise-acquirable.gemspec
+- lib/devise/acquirable.rb
+- lib/devise/acquirable/model.rb
+- lib/devise/acquirable/version.rb
+- lib/generators/devise/acquirable_generator.rb
+- lib/generators/devise/templates/migration.rb
+- spec/devise/acquirable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/simonlehmann/devise-acquirable
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Easily capture and store marketing data during Devise user onboarding.
+test_files:
+- spec/devise/acquirable_spec.rb
+- spec/spec_helper.rb