octopress-gauges-popular-posts 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+todo.taskpaper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in octopress-gauges-popular-posts.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bastian Bartmann
+
+MIT License
+
+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,96 @@
+# Octopress Gauges Popular Posts Plugin #
+
+Popular posts plugin adds a popular asides section to your [Octopress][1] blog. Popularity of the posts is calculated by page views tracked through [Gaug.es][2].
+
+This gem is modelled after the [octopress-popular-posts gem][2]. 
+
+## Installation ##
+
+Add this line to your application's Gemfile:
+
+    gem 'octopress-gauges-popular-posts'
+
+Install it using Bundler:
+
+    $ bundle
+
+And run the installation to copy the plugin to your source:
+
+    $ bundle exec octopress-gauges-popular-posts install
+
+## Post install configurations ##
+
+Add the Gaug.es Tracking ID of your blog and your Gaug.es API token to your **config.yml**:
+
+    gauges_tracking_id: <your-tracking-id>
+
+Also add the following line:
+
+    popular_posts_count: 5      # Posts in the sidebar Popular Posts section
+
+This sets the number of popular posts to show. 
+
+Next, we need to add the popular post aside section:
+
+    default_asides: [custom/asides/about.html, custom/asides/subscribe.html, custom/asides/popular_posts.html, asides/recent_posts.html, asides/github.html, asides/twitter.html, asides/delicious.html, asides/pinboard.html, asides/googleplus.html]
+
+Note the **custom/asides/popular_posts.html** that is added on the third entry of the array.
+
+The installation created the `config` file in the `.page_views` directory. In there you have to add your Gaug.es API token and you can also add the date started tracking your site with Gaug.es.
+
+    :token: <your-api-token>
+    :signup_date: 2013-06-03
+
+If a `singup_date` is given, thes gem will fetch the views since then. Depending on the distance, this may take a while.
+
+Once done, you need to generate the blog:
+    
+    $ rake generate
+
+I also suggest that you ignore the cached page views files and the config file with your Gaug.es API token by adding this line to your **.gitignore**:
+
+    .page_views
+
+## Usage ##
+
+Once installed, the popular posts asides section will be generated whenever you run
+
+    $ rake generate
+
+No additional steps are necesary.
+
+## Updating the plugin ##
+
+After updating the gem:
+
+    $ bundle update octopress-gauges-popular-posts
+
+Run the following command:
+
+    $ bundle exec octopress-gauges-popular-posts install
+
+## Removal ##
+
+To remove the plugin, run the following command:
+
+    $ bundle exec octopress-gauges-popular-posts remove
+
+You will also need to remove the following configurations:
+
+1. The octopress-popular-posts gem from your **Gemfile**
+2. The **gauges_tracking_id** variable from your **config.yml**
+3. The **popular_posts_count** variable from your **config.yml**
+4. The popular posts asides under **defaults_asides** from your **config.yml**
+5. The cache directory **.page_views**
+
+## Contributing ##
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[1]: http://octopress.org
+[2]: http://get.gaug.es
+[2]: https://github.com/octothemes/popular-posts

data/Rakefile

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

data/bin/octopress-gauges-popular-posts

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.dirname(__FILE__) + '/../lib/octopress-gauges-popular-posts')

data/lib/octopress-gauges-popular-posts.rb

@@ -0,0 +1,16 @@
+require 'fileutils'
+require "octopress-gauges-popular-posts/version"
+require 'octopress-gauges-popular-posts/utilities'
+
+# Handles the command line options
+if ARGV.length == 1 && ARGV[0] == 'install'
+  PopularPost::Utilities.install
+  puts 'Octopress Gauges Popular Posts plugin: installed'
+  puts 'Please view the README on https://github.com/coding-chimp/octopress-gauges-popular-posts for post installation configurations.'
+elsif ARGV.length == 1 && ARGV[0] == 'remove'
+  PopularPost::Utilities.remove
+  puts 'Octopress Gauges Popular Posts plugin: removed'
+  puts 'Please view the README on https://github.com/coding-chimp/octopress-gauges-popular-posts for post removal configurations.'
+else
+  puts 'Usage: octopress-gauges-popular-posts [install|remove]'
+end

data/lib/octopress-gauges-popular-posts/utilities.rb

@@ -0,0 +1,121 @@
+# Public: Module for handling the installation and removal of the Octopress Gauges Popular Post
+#         plugin
+module PopularPost
+  module Utilities
+    TEMPLATES_DIR = File.expand_path(File.dirname(__FILE__) + '/../../templates')
+
+    # Public: Installs the templates to the designated locations
+    #
+    # Examples
+    #
+    #   PopularPost.install
+    #   # => nil
+    #
+    # Returns nothing
+    def self.install
+      FileUtils.copy_file plugin_path, plugin_destination
+      FileUtils.copy_file aside_path, aside_destination
+      Dir.mkdir cache_path unless File.directory?(cache_path)
+      FileUtils.copy_file config_path, config_destination unless File.exists?(config_path)
+    end
+
+    # Public: Removes plugin files
+    #
+    # Examples
+    #
+    #   PopularPost.remove
+    #   # => nil
+    #
+    # Returns nothing
+    def self.remove
+      FileUtils.rm plugin_destination
+      FileUtils.rm aside_destination
+    end
+
+    protected
+
+    # Private: Returns the file path to the plugin template
+    #
+    # Examples
+    #
+    #   plugin_path
+    #   # => /path/to/plugin.rb
+    #
+    # Returns a String
+    def self.plugin_path
+      File.join(TEMPLATES_DIR, 'popular_post.rb')
+    end
+
+    # Private: Returns the file path to the plugin destination
+    #
+    # Examples
+    #
+    #   plugin_destination
+    #   # => /path/to/destination/plugin.rb
+    #
+    # Returns a String
+    def self.plugin_destination
+      File.join(Dir.pwd, 'plugins', 'popular_post.rb')
+    end
+
+    # Private: Returns the file path to the aside template
+    #
+    # Examples
+    #
+    #   aside_path
+    #   # => /path/to/aside.html
+    #
+    # Returns a String
+    def self.aside_path
+      File.join(TEMPLATES_DIR, 'popular_posts.html')
+    end
+
+    # Private: Returns the file path to the aside destination
+    #
+    # Examples
+    #
+    #   aside_destination
+    #   # => /path/to/destination/aside.html
+    #
+    # Returns a String
+    def self.aside_destination
+      File.join(Dir.pwd, 'source', '_includes', 'custom', 'asides', 'popular_posts.html')
+    end
+
+    # Private: Returns the file path to the cache direcetory
+    #
+    # Examples
+    #
+    #   aside_path
+    #   # => /path/to/.page_views
+    #
+    # Returns a String
+    def self.cache_path
+      File.join(Dir.pwd, '.page_views')
+    end
+
+    # Private: Returns the file path to the config template
+    #
+    # Examples
+    #
+    #   aside_path
+    #   # => /path/to/config
+    #
+    # Returns a String
+    def self.config_path
+      File.join(TEMPLATES_DIR, 'config')
+    end
+
+    # Private: Returns the file path to the config destination
+    #
+    # Examples
+    #
+    #   aside_path
+    #   # => /path/to/destination/config
+    #
+    # Returns a String
+    def self.config_destination
+      File.join(Dir.pwd, '.page_views', 'config')
+    end
+  end
+end

data/lib/octopress-gauges-popular-posts/version.rb

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

data/octopress-gauges-popular-posts.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'octopress-gauges-popular-posts/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "octopress-gauges-popular-posts"
+  gem.version       = PopularPosts::VERSION
+  gem.authors       = ["Bastian Bartmann"]
+  gem.email         = ["xarfai27@gmail.com"]
+  gem.description   = "Octopress Gauges Popular Posts adds a popular posts asides section to your Octopress blog. It makes use of GitHub's Gaug.es to determine the popularity of the posts."
+  gem.summary       = 'Adds a popular posts asides section to your Octopress blog.'
+  gem.homepage      = "https://github.com/coding-chimp/octopress-gauges-popular-posts"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/templates/config

@@ -0,0 +1,3 @@
+---
+:token:
+:signup_date:

data/templates/popular_post.rb

@@ -0,0 +1,278 @@
+require 'yaml'
+require 'json'
+require 'open-uri'
+
+# Public: Popular posts plugin for Octopress. This plugin
+#         opens up the Jekyll Post and Site classes to allow
+#         Jekyll to render the popular posts aside section
+module PopularPost
+  module Post
+
+    def self.included(base)
+      if base.class.instance_methods.include?('page_views') ||
+          base.class.protected_instance_methods.include?(%w(cache_page_views read_page_views_cache))
+        raise 'Octopress Gauges Popular Posts: Name clashes'
+      else
+        base.class_eval do
+          include PublicInstanceMethods
+          protected
+          include ProtectedInstanceMethods
+        end
+      end
+    end
+
+    module PublicInstanceMethods
+
+      PAGE_VIEWS_CACHE = '.page_views'
+
+      # Public: Returns the page views of the post. It also caches the page views.
+      #         If a cached page rank is found, it returns the cached version.
+      #
+      # Examples
+      #
+      #   page_views
+      #   # => 34
+      #
+      # Returns the Integer page views of the post
+      def page_views
+        post_name = self.url.split('/').last
+        cache_dir_path = File.join(Dir.pwd, PAGE_VIEWS_CACHE)
+        post_path = File.join(Dir.pwd, PAGE_VIEWS_CACHE, post_name)
+
+        if File.exists?(post_path)
+          read_page_views_cache(post_path)[:views]
+        else
+          post_views = 0
+          page_views_content = { path: self.url, views: post_views }
+          cache_page_views(page_views_content, post_path)
+          post_views
+        end
+      end
+    end
+
+    module ProtectedInstanceMethods
+
+      # Private: Caches the page views of the post.
+      #
+      # page_views_content - The Hash which is contains view and
+      #                      the path of the post.
+      # cache_path         - The String which is the file path
+      #                      to the cache
+      #
+      # Examples
+      #
+      #   cache_page_views({path: '/blog/bar', views: 2}, '/path/to/cache')
+      #   # => nil
+      #
+      # Returns nothing.
+      def cache_page_views(page_views_content, cache_path)
+        File.open(cache_path, 'w') do |file|
+          file.puts YAML.dump(page_views_content)
+        end
+      end
+
+      # Private: Reads the cached page views
+      #
+      # cache_path - The String which is the file path to the cache
+      #
+      # Examples
+      #
+      #   read_page_views('/path/to/cache')
+      #   # => {path: 'http://foo', views: 2}
+      #
+      # Returns a Hash
+      def read_page_views_cache(cache_path)
+        YAML.load_file(cache_path)
+      end
+    end
+  end # Post
+
+  module Site
+
+    CACHE_DIR_PATH = File.join(Dir.pwd, '.page_views')
+
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :popular_posts
+        alias_method :old_read, :read
+        alias_method :old_site_payload, :site_payload
+
+        # Public: Making use of the read method to define popular
+        #         posts. Popular posts are sorted by page views
+        #
+        # Examples
+        #
+        #   read
+        #   # => nil
+        #
+        # Returns nothing
+        def read
+          old_read
+          update_views
+          self.popular_posts = self.posts.sort do |post_x, post_y|
+            if post_y.page_views > post_x.page_views then 1
+            elsif post_y.page_views == post_x.page_views then 0
+            else -1
+            end
+          end
+        end
+
+        # Public: We need to add popular_posts to site_payload, so that
+        #         it gets passed to Liquid to be rendered.
+        #
+        # Examples
+        #
+        #   site_payload
+        #   # => nil
+        #
+        # Returns nothing
+        def site_payload
+          old_site_hash = old_site_payload
+          old_site_hash["site"].merge!({"popular_posts" => self.popular_posts})
+          old_site_hash
+        end
+
+        protected
+
+        # Private: Checks wether there is a last_run or signup_date and
+        #          fetches views since then.
+        #
+        # Examples
+        #
+        #   update_views
+        #   # => nil
+        #
+        # Returns nothing
+        def update_views
+          gauges_config = YAML.load_file("#{CACHE_DIR_PATH}/config")
+          views = load_views
+          last_run = gauges_config[:last_run] ||  gauges_config[:signup_date]
+          yesterday = Date.today - 1
+
+          if last_run.nil?
+            views = fetch_views(views, yesterday, gauges_config[:token])
+          elsif last_run && last_run != Date.today
+            for date in last_run..yesterday do
+              views = fetch_views(views, date, gauges_config[:token])
+            end
+          end
+
+          cache_views(views)
+          update_last_run(gauges_config)
+        end
+
+        # Private: Sets the last run date to today and caches it.
+        #
+        # gauges_config - The path to the gauges config file
+        #
+        # Examples
+        #
+        #   update_last_run('/path/to/page/gauges/config')
+        #   # => nil
+        #
+        # Returns nothing
+        def update_last_run(gauges_config)
+          gauges_config[:last_run] = Date.today
+          File.open("#{CACHE_DIR_PATH}/config", 'w') do |file|
+            file.puts YAML.dump(gauges_config)
+          end
+        end
+
+        # Private: Caches the views.
+        #
+        # views - A hash of hashes that contain the page views
+        #         and path of the post.
+        #
+        # Examples
+        #
+        #   cache_views({{path: '/blog/bar', views: 2}, ...})
+        #   # => nil
+        #
+        # Returns nothing
+        def cache_views(views)
+          views.each do |k, v|
+            content = { path: k, views: v }
+            file_path = "#{CACHE_DIR_PATH}#{k.to_s}"
+
+            File.open(file_path, 'w') do |file|
+              file.puts YAML.dump(content)
+            end
+          end
+        end
+
+        # Private: Loads the view counts from the cache.
+        #
+        # Examples
+        #
+        #   load_views
+        #   # => {{path: '/blog/bar', views: 2}, ...}
+        #
+        # Returns a hash of of hashes that contain the path and
+        # views of a post
+        def load_views
+          posts = {}
+          Dir.foreach(CACHE_DIR_PATH) do |file|
+            next if file == '.' || file == '..' || file == 'config'
+            content = YAML.load_file("#{CACHE_DIR_PATH}/#{file}")
+            posts[content[:path]] = content[:views]
+          end
+          posts
+        end
+
+        # Private: Takes the the current views loaded from cash,
+        #          calls the Gaug.es API for the views of a specified
+        #          day, updates the loaded views and returns them.
+        #
+        # views - An hash of hashes containing the path and views
+        #         of posts  loaded from the cache
+        # date  - The date for which the API call will be made
+        # token - The Gaug.es API token needed for the API call
+        #
+        # Examples
+        #
+        #   fetch_views({{path: '/blog/bar', views: 2}, ...},
+        #               2013-06-03, 188fa4710f08973145c1038af83ba78b)
+        #   # => {{path: '/blog/bar', views: 11}, ...}
+        #
+        # Returns a hash of hashed containing the path and updated page
+        # updated page views 
+        def fetch_views(views, date, token)
+          puts "Popular posts: fetches views for #{date}"
+          gauge_id = config['gauges_tracking_id']
+          host = config['url'].gsub "http://", ""
+
+          content = JSON.parse(open("https://secure.gaug.es/gauges/#{gauge_id}/content?date=#{date}",
+                                    'X-Gauges-Token' => token).read)['content']
+
+          content.each do |page|
+            unless page['path'] == "/"          || page['path'].include?("/categories/") ||
+                   page['path'] == "/archives/" || page['path'].include?("/page/")       ||
+                   page['path'] == "/about/"    || page['host'] != host
+              path = page['path'].gsub(/(\/|\/#.*)$/, "")
+              current_views = views[path]
+              if current_views.nil?
+                updated_views = page['views'].to_i
+              else
+                updated_views = current_views.to_i + page['views'].to_i
+              end
+              views[path] = updated_views
+            end
+          end
+          views
+        end
+
+      end
+    end # included
+  end # Site
+
+end # PopularPost
+
+module Jekyll
+  class Post
+    include PopularPost::Post
+  end
+
+  class Site
+    include PopularPost::Site
+  end
+end

data/templates/popular_posts.html

@@ -0,0 +1,10 @@
+<section>
+  <h1>Popular Posts</h1>
+  <ul id="recent_posts">
+    {% for post in site.popular_posts limit: site.popular_posts_count %}
+      <li class="post">
+        <a href="{{ root_url }}{{ post.url }}">{{ post.title }}</a>
+      </li>
+    {% endfor %}
+  </ul>
+</section>

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: octopress-gauges-popular-posts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bastian Bartmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-03 00:00:00.000000000 Z
+dependencies: []
+description: Octopress Gauges Popular Posts adds a popular posts asides section to
+  your Octopress blog. It makes use of GitHub's Gaug.es to determine the popularity
+  of the posts.
+email:
+- xarfai27@gmail.com
+executables:
+- octopress-gauges-popular-posts
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/octopress-gauges-popular-posts
+- lib/octopress-gauges-popular-posts.rb
+- lib/octopress-gauges-popular-posts/utilities.rb
+- lib/octopress-gauges-popular-posts/version.rb
+- octopress-gauges-popular-posts.gemspec
+- templates/config
+- templates/popular_post.rb
+- templates/popular_posts.html
+homepage: https://github.com/coding-chimp/octopress-gauges-popular-posts
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Adds a popular posts asides section to your Octopress blog.
+test_files: []
+has_rdoc: