scrollytelling-piwik 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46462401471a8661850d89256d417583e4dc8643
+  data.tar.gz: c5836accd9b5016c36565d3fe2bd1a07a5bccc5a
+SHA512:
+  metadata.gz: 4bfaea8305d586a672c83c6432a7f5b9b8c617fa48d562b1833f8a182e958bc5c8c803d2754e05980380fa560b51236ae42c12e43dfd79e0c2b885e005c8f1e4
+  data.tar.gz: 2217beb8aa5421f23c740f15923447f5183cbd33d79ec7d740682cbbe8eddfc88016cdbda67ae917357ff82ee935aea72e492b11485801dbc6917d8e4281fe2b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scrollytelling-piwik.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joost Baaij
+
+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,43 @@
+# Scrollytelling::Piwik
+
+This [Pageflow](https://github.com/codevise/pageflow) Plugin will render the [Piwik](https://piwik.org) JavaScript snippet in your stories. This allows you to have your own analytics engine and not rely on third parties. At [Scrollytelling](https://www.scrollytelling.io) we use this because we wish not having to show a cookie warning. Naturally, we also do not wish to track our visitors for anything more than just counting them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scrollytelling-piwik'
+```
+
+Bundle the plugin with your application by typing this on the command line:
+
+    $ bundle
+
+## Usage
+
+Register this plugin in your Pageflow initializer.
+
+```
+# config/initializers/pageflow.rb
+config.plugin(Scrollytelling::Piwik::Plugin.new url: "//example.com/analytics/", site_id: 1)
+```
+
+Furthermore after installing any Pageflow plugin it's a good idea to change your asset version. This will invalidate all server-side cache, most notably the cache that `i18n-js` uses to render the editor UI.
+
+```
+# config/initializers/assets.rb
+Rails.application.config.assets.version = 'x.x.x'
+```
+
+Then restart your application server.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, 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/scrollytelling/scrollytelling-piwik. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/views/scrollytelling/piwik/_widget.html.erb

@@ -0,0 +1,16 @@
+<!-- Piwik Analytics -->
+<script>
+  var _paq = _paq || [];
+  _paq.push(["setCustomVariable", 1, "account", "<%= entry.account.name %>", "visit"]);
+  _paq.push(["setCustomVariable", 2, "entry", "<%= entry.title %>", "visit"]);
+  _paq.push(['trackPageView']);
+  (function() {
+    var u="<%= url %>";
+    _paq.push(['setTrackerUrl', u+'piwik.php']);
+    _paq.push(['setSiteId', <%= site_id %>]);
+    var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+    g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s);
+  })();
+</script>
+<noscript><p><img src="<%= url %>piwik.php?idsite=<%= site_id %>" style="border:0;" alt="" /></p></noscript>
+<!-- End of Piwik Analytics -->

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "scrollytelling/piwik"
+
+# 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

data/bin/setup

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

data/config/locales/de.yml

@@ -0,0 +1,4 @@
+de:
+  pageflow:
+    scrollytelling_piwik:
+      widget_type_name: Piwik Analytics JavaScript widget

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  pageflow:
+    scrollytelling_piwik:
+      widget_type_name: Piwik Analytics JavaScript widget

data/lib/scrollytelling/piwik.rb

@@ -0,0 +1,11 @@
+require "scrollytelling/piwik/engine"
+require "scrollytelling/piwik/plugin"
+require "scrollytelling/piwik/widget_type"
+
+module Scrollytelling
+  module Piwik
+    def self.widget_type(url:, site_id:)
+      WidgetType.new(url: url, site_id: site_id)
+    end
+  end
+end

data/lib/scrollytelling/piwik/engine.rb

@@ -0,0 +1,9 @@
+require 'rails/engine'
+
+module Scrollytelling
+  module Piwik
+    class Engine < ::Rails::Engine
+      isolate_namespace Scrollytelling::Piwik
+    end
+  end
+end

data/lib/scrollytelling/piwik/plugin.rb

@@ -0,0 +1,16 @@
+require 'pageflow/plugin'
+
+module Scrollytelling
+  module Piwik
+    class Plugin < ::Pageflow::Plugin
+      def initialize(url:, site_id:)
+        @url = url
+        @site_id = site_id
+      end
+
+      def configure(config)
+        config.widget_types.register(Scrollytelling::Piwik.widget_type(url: @url, site_id: @site_id), default: true)
+      end
+    end
+  end
+end

data/lib/scrollytelling/piwik/version.rb

@@ -0,0 +1,5 @@
+module Scrollytelling
+  module Piwik
+    VERSION = "0.1.0"
+  end
+end

data/lib/scrollytelling/piwik/widget_type.rb

@@ -0,0 +1,24 @@
+require 'pageflow/widget_type'
+
+module Scrollytelling
+  module Piwik
+    class WidgetType < ::Pageflow::WidgetType
+      def initialize(url:, site_id:)
+        @url = url
+        @site_id = site_id
+      end
+
+      def name
+        'scrollytelling_piwik'
+      end
+
+      def roles
+        ['piwik']
+      end
+
+      def render(template, entry)
+        template.render('scrollytelling/piwik/widget.html.erb', entry: entry, url: @url, site_id: @site_id)
+      end
+    end
+  end
+end

data/scrollytelling-piwik.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scrollytelling/piwik/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scrollytelling-piwik"
+  spec.version       = Scrollytelling::Piwik::VERSION
+  spec.authors       = ["Joost Baaij"]
+  spec.email         = ["joost@spacebabies.nl"]
+
+  spec.summary       = "Render the Piwik analytics JavaScript snippet for Pageflow stories."
+  spec.homepage      = "https://github.com/scrollytelling/scrollytelling-piwik"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency "pageflow", ">= 0.7"
+  spec.add_runtime_dependency "rails", ">= 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: scrollytelling-piwik
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joost Baaij
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pageflow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- joost@spacebabies.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/scrollytelling/piwik/_widget.html.erb
+- bin/console
+- bin/setup
+- config/locales/de.yml
+- config/locales/en.yml
+- lib/scrollytelling/piwik.rb
+- lib/scrollytelling/piwik/engine.rb
+- lib/scrollytelling/piwik/plugin.rb
+- lib/scrollytelling/piwik/version.rb
+- lib/scrollytelling/piwik/widget_type.rb
+- scrollytelling-piwik.gemspec
+homepage: https://github.com/scrollytelling/scrollytelling-piwik
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Render the Piwik analytics JavaScript snippet for Pageflow stories.
+test_files: []
+has_rdoc: