simple_analytics_rails 0.1.0

data/lib/simple_analytics_rails.rb

@@ -0,0 +1,34 @@
+require_relative "simple_analytics_rails/version"
+require_relative "simple_analytics_rails/configuration"
+require_relative "simple_analytics_rails/javascript_script"
+require_relative "simple_analytics_rails/middleware/javascript_injection"
+require_relative "simple_analytics_rails/railtie" if defined?(Rails)
+
+# This will automatically inject the `SimpleAnalyticsRails::Middleware::JavascriptInjection` middleware if you're using Ruby on Rails.
+#
+# Sample Usage for configuration:
+#
+#   # config/initializers/simple_analytics.rb
+#   SimpleAnalyticsRails.configure do |configuration|
+#     configuration.hostname = "example.com"
+#     configuration.mode = "hash"
+#     configuration.collect_dnt = false
+#     configuration.ignore_pages = "/search/*,/account/*,/vouchers"
+#     configuration.enabled = Rails.env.production?
+#   end
+#
+module SimpleAnalyticsRails
+  class << self
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= SimpleAnalyticsRails::Configuration.new
+    end
+
+    def reset_configuration!
+      @configuration = nil
+    end
+  end
+end

data/lib/simple_analytics_rails/configuration.rb

@@ -0,0 +1,40 @@
+module SimpleAnalyticsRails
+  class Configuration
+    def initialize
+      @hostname = ""
+      @mode = ""
+      @ignore_pages = ""
+      @collect_dnt = false
+      @enabled = true
+    end
+
+    attr_accessor :ignore_pages
+    attr_accessor :hostname
+    attr_accessor :mode
+    attr_writer :collect_dnt
+    def collect_dnt?
+      @collect_dnt
+    end
+
+    attr_writer :enabled
+    def enabled?
+      @enabled
+    end
+
+    def to_h
+      {
+        hostname: @hostname,
+        mode: @mode,
+        collect_dnt: collect_dnt? ? "true" : nil,
+        ignore_pages: @ignore_pages,
+        turbolinks_track: turbolinks_track
+      }.compact.reject { |_key, value| value.blank? }
+    end
+
+    private
+
+    def turbolinks_track
+      "reload" if defined?(Turbolinks)
+    end
+  end
+end

data/lib/simple_analytics_rails/javascript_script.rb

@@ -0,0 +1,41 @@
+module SimpleAnalyticsRails
+  # This outputs the HTML script with the configuration option added to the <script> tag.
+  class JavascriptScript
+    def head_html
+      [
+        sa_event_script,
+        script_tag
+      ].join
+    end
+
+    def body_html
+      '<noscript><img src="https://queue.simpleanalyticscdn.com/noscript.gif" alt="" referrerpolicy="no-referrer-when-downgrade" /></noscript>'
+    end
+
+    private
+
+    def sa_event_script
+      [
+        "<script>",
+        "window.sa_event=window.sa_event||function(){a=[].slice.call(arguments);sa_event.q?sa_event.q.push(a):sa_event.q=[a]};",
+        "</script>"
+      ].join
+    end
+
+    def script_tag
+      [
+        "<script",
+        configuration_to_html_attributes,
+        'async defer src="https://scripts.simpleanalyticscdn.com/latest.js"></script>'
+      ].compact
+        .reject(&:blank?)
+        .join(" ")
+    end
+
+    def configuration_to_html_attributes
+      SimpleAnalyticsRails.configuration.to_h.collect do |key, value|
+        "data-#{key.to_s.tr("_", "-")}=\"#{CGI.escapeHTML(value)}\""
+      end.join(" ")
+    end
+  end
+end

data/lib/simple_analytics_rails/middleware/javascript_injection.rb

@@ -0,0 +1,34 @@
+module SimpleAnalyticsRails::Middleware
+  # This receives the request payload and injects the JavaScript snippet to the HTML.
+  # It's injected just before the </head> element.
+  class JavascriptInjection
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, response = @app.call(env)
+
+      if headers && headers["Content-Type"]&.include?("text/html")
+        response = inject_javascript_to_response(response)
+      end
+
+      [status, headers, response]
+    end
+
+    private
+
+    def inject_javascript_to_response(response)
+      if SimpleAnalyticsRails.configuration.enabled? && response.respond_to?("[]")
+        response[0].gsub!("</head>", "#{javascript_script.head_html}</head>")
+        response[0].gsub!("</body>", "#{javascript_script.body_html}</body>")
+      end
+
+      response
+    end
+
+    def javascript_script
+      @javascript_script ||= SimpleAnalyticsRails::JavascriptScript.new
+    end
+  end
+end

data/lib/simple_analytics_rails/railtie.rb

@@ -0,0 +1,7 @@
+# This is the class which injects our Middleware into Rails apps.
+# If `Rails` isn't defined this class isn't included. If you're using other Rack apps you can include the Middleware classes manually.
+class SimpleAnalyticsRails::Railtie < Rails::Railtie
+  initializer "simple_analytics_rails.configure_rails_initialization" do |app|
+    app.config.middleware.insert_after(ActionDispatch::DebugExceptions, SimpleAnalyticsRails::Middleware::JavascriptInjection)
+  end
+end

data/lib/simple_analytics_rails/version.rb

@@ -0,0 +1,3 @@
+module SimpleAnalyticsRails
+  VERSION = "0.1.0"
+end

data/simple_analytics_rails.gemspec

@@ -0,0 +1,35 @@
+require_relative "lib/simple_analytics_rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "simple_analytics_rails"
+  spec.version = SimpleAnalyticsRails::VERSION
+  spec.authors = ["Mike Rogers"]
+  spec.email = ["me@mikerogers.io"]
+
+  spec.summary = "Add the Simple Analytics JavaScript Script to your Rails app"
+  spec.description = spec.summary
+  spec.homepage = "https://simpleanalytics.com/"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/simpleanalytics/rubyonrails-plugin"
+  spec.metadata["changelog_uri"] = "https://github.com/simpleanalytics/rubyonrails-plugin/blob/main/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "appraisal", "~> 2.4"
+  spec.add_development_dependency "rails", ">= 5.2"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails", "~> 4.0"
+  spec.add_development_dependency "standardrb", "~> 1.0"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: simple_analytics_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Rogers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Add the Simple Analytics JavaScript Script to your Rails app
+email:
+- me@mikerogers.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/changelog.yml"
+- ".github/workflows/publish.yml"
+- ".github/workflows/standard.yml"
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- Appraisals
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/.bundle/config
+- gemfiles/rails52.gemfile
+- gemfiles/rails52.gemfile.lock
+- gemfiles/rails60.gemfile
+- gemfiles/rails60.gemfile.lock
+- gemfiles/rails61.gemfile
+- gemfiles/rails61.gemfile.lock
+- gemfiles/rails_main.gemfile
+- gemfiles/rails_main.gemfile.lock
+- lib/simple_analytics_rails.rb
+- lib/simple_analytics_rails/configuration.rb
+- lib/simple_analytics_rails/javascript_script.rb
+- lib/simple_analytics_rails/middleware/javascript_injection.rb
+- lib/simple_analytics_rails/railtie.rb
+- lib/simple_analytics_rails/version.rb
+- simple_analytics_rails.gemspec
+homepage: https://simpleanalytics.com/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://simpleanalytics.com/
+  source_code_uri: https://github.com/simpleanalytics/rubyonrails-plugin
+  changelog_uri: https://github.com/simpleanalytics/rubyonrails-plugin/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: Add the Simple Analytics JavaScript Script to your Rails app
+test_files: []