octopress-social 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3213c10c4cdb75d78032f8147d4c77f7004d874
+  data.tar.gz: cee00964846941a3c8ee6bd97c5e82dbb7f441f2
+SHA512:
+  metadata.gz: 4f38f54ce707ce47542466af7721a39103b77f7acb64bff33eae1de977db49450446bdcd393acb58c04d2dc5a317912452657fefe1e53706d4e593bc838b26eb
+  data.tar.gz: 7b6d4b137b4da101fb8740c179dd51bf29dec2211eb6a633e4969ecb20c8fd0de60dc459a71d09fc75ced9877ea105416593538e03a3ed85712ee4425a47fbd6

data/README.md

@@ -0,0 +1,192 @@
+# Octopress Social
+
+Easy social features from Twitter, Facebook, and Google+ with fancy buttons or plain-old links.
+
+## Installation
+
+If you're using bundler add this gem to your site's Gemfile in the `:jekyll_plugins` group:
+
+    group :jekyll_plugins do
+      gem 'octopress-social'
+    end
+
+Then install the gem with Bundler
+
+    $ bundle
+
+To install manually without bundler:
+
+    $ gem install octopress-social
+
+Then add the gem to your Jekyll configuration.
+
+    gems:
+      - octopress-social
+
+## Twitter
+
+Configure this plugin in your site's `_config.yml`.
+
+```yaml
+twitter:
+  username:                      # Add your Twitter handle
+  tweet_count:         false     # show number of shares on Twitter
+  size:                normal    # or large
+  tweet_link_text:     Twitter   # Configure the link text
+  tweet_message:       ":title by :username - :url :hashtags"
+
+  follow_count:        false     # show number of followers
+  profile_link_text:   "Follow :username"
+```
+
+To include hashtags, in your tweet message add them in the YAML front matter of your post or page, like this:
+
+```yaml
+twitter_hashtag: tech  # A single hashtag
+twitter_hashtags:      # Multiple hashtags
+ - tech
+ - kittens
+```
+
+If your site has multiple authors, you can configure the author's twitter handle in a
+post's YAML front-matter and the tweet button (or link) will mention them in the default message.
+
+```yaml
+twitter_username: some_author
+```
+
+You can also configure a different default message in your post or page's YAML
+front-matter:
+
+```
+tweet_message: "Yay Jekyll :title by :username - :url :hashtags"
+```
+
+Note: This plugin sets the twitter button's "do not track" setting to 'true'. I have
+no intention of making this configurable.
+
+### Twitter Tags
+
+To use Twitter's fancy buttons you'll need to add this tag to your site's layout before the closing body tag.
+
+```
+{% twitter_script_tag %} # Injects Twitter's widget.js.
+```
+
+Sharing tags:
+```
+{% tweet_button %}
+{% tweet_button post %}
+{% tweet_link %}          # tweet with a (no js) link
+```
+
+The tweet button and tweet link will open a new page with a composed tweet in the format in your Twitter configuration, `:title by :username - :url :hashtags`. If you want tweet buttons to show up on post index or archive pages, add the `post` argument to the tweet button tag.
+
+Follow tags:
+
+```
+{% twitter_follow_button %}
+{% twitter_profile_link %}
+```
+
+## Facebook
+
+These configurations are all based on [Facebook's widget configuration spec](https://developers.facebook.com/docs/plugins/), visit that site for more info.
+
+```yaml
+facebook:
+  app_id:                            # For a nicer (no js) sharing experience
+  profile_id:                        # For follow button or profile link
+  action:              like          # Or recommend
+  share:               false         # Also add a share button
+  layout:              button        # Choices: standard, box_count, button_count, button
+  show_faces:          false
+  colorscheme:         light         # Or dark
+  kid_directed_site:   false         # Is your site directed at kids under 13?
+  share_link_text:     Facebook      # Text for plain-old link
+  profile_link_text:   "Find me on Facebook"
+  comment_count:       5             # Number of facebook comments to show by default
+```
+
+To get your `profile_id`, take a section from the url to your profile page `https://www.facebook.com/[profile_id]`.
+
+To get an `app_id` you'll need to [register](https://developers.facebook.com/apps) as a developer and go through the process to create an
+'app'. This is free and it doesn't mean you're developing software or anything, it's just how Facebook wants to do this. Once you've
+created an app, go to the "Basic settings page" by clicking settings, and then finding the "Basic" link. There you should be able to find
+your App ID.
+
+### Facebook Tags
+
+To use Facebook's scripted features you'll need to add this tag to your site's layout before the closing body tag.
+
+```
+{% facebook_script_tag %} # Injects Facebook's widget.js.
+```
+
+Sharing tags:
+
+```
+{% facebook_like_button %}
+{% facebook_send_button %}   # For private sharing
+{% facebook_share_link %}    # share with a (no js) link
+```
+
+Friend and Follow tags:
+
+```
+{% facebook_follow_button %} # Requires a public profile
+{% facebook_profile_link %}
+```
+
+Embed Facebook comments widget:
+
+```
+{% facebook_comments %}
+```
+
+
+## Google+
+
+These configurations are based on Google's [web sharing widgets](https://developers.google.com/+/web/+1button/).
+
+```yaml
+gplus:
+  id:                             # Your Google+ userid (for follow button or profile link)
+  size:              medium       # choices: small, medium, standard, large
+  width:                          # Specify width of button
+  share_count:       false        # Show number of shares or +1s
+  follow_count:      false        # Show numer of followers
+  share_link_text:   Google+      # Text for plain-old link
+  profile_link_text: "Follow on Google+"
+```
+
+### Google+ Tags
+
+To use Google's fancy buttons, you'll need to add this tag to your site's layout before the closing body tag.
+
+```
+{% gplus_script_tag %}   # Injects Google's widget.js.
+```
+
+Sharing tags:
+
+```
+{% gplus_one_button %}
+{% gplus_share_button %}
+{% gplus_share_link %}   # share with a (no js) link
+```
+
+Follow tags:
+
+```
+{% gplus_follow_button %}
+{% gplus_profile_link %}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/octopress-social/fork )
+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 a new Pull Request

data/lib/octopress-social.rb

@@ -0,0 +1,50 @@
+require "octopress-social/version"
+require "liquid"
+
+module Octopress
+  module Social
+    extend self
+
+    autoload :Twitter,                'octopress-social/twitter'
+    autoload :Facebook,               'octopress-social/facebook'
+    autoload :GooglePlus,             'octopress-social/google-plus'
+    
+    def full_url(site, item)
+      unless root = site['url']
+        abort "Site url not configured. Please set url: http://your-site.com in Jekyll configuration file."
+      end
+
+      File.join(root, site['baseurl'], item['url'].sub('index.html', ''))
+    end
+  end
+end
+
+Liquid::Template.register_tag('tweet_button', Octopress::Social::Twitter::Tag)
+Liquid::Template.register_tag('tweet_link', Octopress::Social::Twitter::Tag)
+Liquid::Template.register_tag('twitter_script_tag', Octopress::Social::Twitter::Tag)
+Liquid::Template.register_tag('twitter_follow_button', Octopress::Social::Twitter::Tag)
+Liquid::Template.register_tag('twitter_profile_link', Octopress::Social::Twitter::Tag)
+Liquid::Template.register_tag('gplus_share_button', Octopress::Social::GooglePlus::Tag)
+Liquid::Template.register_tag('gplus_share_link', Octopress::Social::GooglePlus::Tag)
+Liquid::Template.register_tag('gplus_one_button', Octopress::Social::GooglePlus::Tag)
+Liquid::Template.register_tag('gplus_follow_button', Octopress::Social::GooglePlus::Tag)
+Liquid::Template.register_tag('gplus_profile_link', Octopress::Social::GooglePlus::Tag)
+Liquid::Template.register_tag('gplus_script_tag', Octopress::Social::GooglePlus::Tag)
+Liquid::Template.register_tag('facebook_like_button', Octopress::Social::Facebook::Tag)
+Liquid::Template.register_tag('facebook_share_link', Octopress::Social::Facebook::Tag)
+Liquid::Template.register_tag('facebook_send_button', Octopress::Social::Facebook::Tag)
+Liquid::Template.register_tag('facebook_follow_button', Octopress::Social::Facebook::Tag)
+Liquid::Template.register_tag('facebook_profile_link', Octopress::Social::Facebook::Tag)
+Liquid::Template.register_tag('facebook_comments', Octopress::Social::Facebook::Tag)
+Liquid::Template.register_tag('facebook_script_tag', Octopress::Social::Facebook::Tag)
+
+if defined? Octopress::Docs
+  Octopress::Docs.add({
+    name:        "Octopress Social",
+    gem:         "octopress-social",
+    version:     Octopress::Social::VERSION,
+    description: "Easy social network integration for Jekyll sites.",
+    path:        File.expand_path(File.join(File.dirname(__FILE__), "../")),
+    source_url:  "https://github.com/octopress/social"
+  })
+end

data/lib/octopress-social/facebook.rb

@@ -0,0 +1,121 @@
+module Octopress
+  module Social
+    module Facebook
+      extend self
+
+      DEFAULTS = {
+        'profile_id'        => nil,
+        'app_id'            => nil,
+        'layout'            => 'button',
+        'action'            => 'like',
+        'show_faces'        => false,
+        'share'             => false,
+        'colorscheme'       => 'light',
+        'kid_directed_site' => false,
+        'comment_count'     => 5,
+        'share_link_text'   => 'Facebook',
+        'profile_link_text' => 'Friend me on Facebook'
+      }
+
+      def config(site=nil)
+        @config ||= DEFAULTS.merge(site['facebook'] || {})
+      end
+
+      def facebook_share_link(site, item)
+        url = Social.full_url(site, item)
+        if config['app_id']
+          %Q{<a class="facebook-share-link" href="https://www.facebook.com/dialog/share?
+          app_id=#{config['app_id']}
+          &href=#{url}&redirect_uri=#{url}"
+          target="_blank">#{config['share_link_text']}</a>
+          }
+        else
+          %Q{<a class="facebook-share-link" 
+          href="https://www.facebook.com/sharer/sharer.php?u=#{url}" 
+          target="_blank">#{config['share_link_text']}</a>}
+        end
+      end
+
+      def facebook_like_button(site, item)
+        %Q{<div class="fb-like"
+          data-href="#{Social.full_url(site, item)}"
+          #{width}
+          data-layout="#{config['layout']}"
+          data-action="#{config['action']}"
+          data-show-faces="#{config['show_faces']}"
+          data-colorscheme="#{config['colorscheme']}"
+          data-kid-directed-site="#{config['kid_directed_site']}"
+          data-share="#{config['share']}"></div>
+        }
+      end
+
+      def facebook_profile_link(*args)
+        %Q{<a class="facebook-profile-link" href="https://www.facebook.com/#{config['profile_id']}">#{config['profile_link_text']}</a>}
+      end
+
+      def facebook_follow_button(*args)
+        %Q{<div class="fb-follow" 
+          data-href="https://www.facebook.com/#{config['profile_id']}"
+          #{width}
+          data-layout="#{config['layout']}"
+          data-layout="#{config['layout']}"
+          data-action="#{config['action']}"
+          data-colorscheme="#{config['colorscheme']}">
+        </div>}
+      end
+
+      def facebook_send_button(site, item)
+        %Q{<div class="fb-send" 
+          data-href="#{Social.full_url(site, item)}"
+          #{width}
+          data-colorscheme="#{config['colorscheme']}"
+          data-kid-directed-site="#{config['kid_directed_site']}"></div>
+        }
+      end
+
+      def width
+        if w = config['width']
+          %Q{data-width="#{w}"}
+        else
+          ''
+        end
+      end
+
+      def facebook_script_tag(*args)
+        %Q{
+          <div id="fb-root"></div>
+          <script>(function(d, s, id) {
+            var js, fjs = d.getElementsByTagName(s)[0];
+            if (d.getElementById(id)) return;
+            js = d.createElement(s); js.id = id;
+            js.src = "//connect.facebook.net/en_US/sdk.js#xfbml=1&version=v2.0";
+            fjs.parentNode.insertBefore(js, fjs);
+          }(document, 'script', 'facebook-jssdk'));</script>
+        }
+      end
+
+      def facebook_comments(site, item)
+        %Q{<div class="fb-comments" 
+        data-href="#{Social.full_url(site, item)}" 
+        data-numposts="#{config['comment_count']}" 
+        data-colorscheme="#{config['colorscheme']}"
+        ></div>}
+      end
+
+      class Tag < Liquid::Tag
+        def initialize(tag, input, tokens)
+          @tag = tag.strip
+          @input = input.strip
+        end
+
+        def render(context)
+          item = context[@input] || context['page']
+          site = context['site']
+
+          Octopress::Social::Facebook.config(site)
+          Octopress::Social::Facebook.send(@tag, site, item).gsub(/(\s{2,}|\n)/, ' ').strip
+        end
+      end
+    end
+  end
+end

data/lib/octopress-social/google-plus.rb

@@ -0,0 +1,101 @@
+module Octopress
+  module Social
+    module GooglePlus
+      extend self
+
+      DEFAULTS = {
+        'size'              => 'medium',
+        'count_bubble'      => false,
+        'share_link_text'   => 'Google+',
+        'profile_link_text' => 'Follow on Google+',
+        'width'             => ''
+      }
+
+      HEIGHT = {
+        'small' => 15,
+        'medium' => 20,
+        'large' => 24
+      }
+
+      def config(site=nil)
+        @config ||= DEFAULTS.merge(site['gplus'] || {})
+      end
+
+      def gplus_share_link(site, item)
+        %Q{<a class="g-plus-share-link" href="https://plus.google.com/share?url=#{Social.full_url(site, item)}" target="_blank">#{config['share_link_text']}</a>}
+      end
+
+      def gplus_one_button(site, item)
+        %Q{<div class="g-plusone" data-href="#{Social.full_url(site, item)}" #{count('share')} #{width} #{size}></div>}
+      end
+
+      def gplus_share_button(site, item)
+        %Q{<div class="g-plus" data-action="share" data-href="#{Social.full_url(site, item)}" #{count('share')} #{width} #{size}></div>}
+      end
+
+      def gplus_follow_button(*args)
+        %Q{<div class="g-follow" #{count('follow')} #{height} data-href="//plus.google.com/u/0/#{config['userid']}" data-rel="author"></div>}
+      end
+
+      def gplus_profile_link(*args)
+        %Q{<a class="g-plus-profile-link" href="//plus.google.com/u/0/#{config['userid']}">#{config['profile_link_text']}</a>}
+      end
+
+      def count(type)
+        if config["#{type}_count"]
+          %Q{data-annotation="bubble"}
+        else
+          %Q{data-annotation="none"}
+        end
+      end
+
+      def width
+        %Q{data-width="#{config['width']}"}
+      end
+
+      def size
+        %Q{data-size="#{config['size']}"}
+      end
+
+      def height
+        %Q{data-height="#{HEIGHT[config['size']]}"}
+      end
+
+      def lang(item)
+        if item['lang']
+          "window.___gcfg = {lang: '#{item['lang']}'};"
+        else
+          ''
+        end
+      end
+
+      def gplus_script_tag(site, item)
+        %Q{
+          <script type="text/javascript">
+            #{Octopress::Social::GooglePlus.lang(item)}
+            (function() {
+              var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
+              po.src = 'https://apis.google.com/js/platform.js';
+              var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
+            })();
+          </script>
+        }
+      end
+
+      class Tag < Liquid::Tag
+        def initialize(tag, input, tokens)
+          @tag = tag.strip
+          @input = input.strip
+        end
+
+        def render(context)
+          item = context[@input] || context['page']
+          site = context['site']
+
+          Octopress::Social::GooglePlus.config(site)
+          Octopress::Social::GooglePlus.send(@tag, site, item).gsub(/(\s{2,}|\n)/, ' ').strip
+        end
+      end
+    end
+  end
+end

data/lib/octopress-social/twitter.rb

@@ -0,0 +1,95 @@
+module Octopress
+  module Social
+    module Twitter
+      extend self
+
+      DEFAULTS = {
+        'tweet_message'     => ":title by :username - :url :hashtags",
+        'size'              => 'normal',
+        'tweet_count'       => false,
+        'follow_count'      => false,
+        'tweet_link_text'   => "Twitter",
+        'profile_link_text' => "Follow :username"
+      }
+
+      def config(site=nil)
+        @config ||= DEFAULTS.merge(site['twitter'] || {})
+      end
+
+      def tweet_link(site, item)
+        %Q{<a class="twitter-share-link" href="https://twitter.com/intent/tweet?&text=#{message(site, item).strip}" target="_blank">#{config['tweet_link_text']}</a>}
+      end
+
+      def tweet_button(site, item)
+        %Q{
+          <a href="https://twitter.com/share" class="twitter-share-button" 
+          #{'data-size="large"' if config['size'] == 'large'}
+          #{'data-count="none"' if !config['tweet_count']}
+          #{button_message(site, item)}
+          data-dnt="true">#{config['tweet_link_text']}</a>
+        }
+      end
+
+      def username(item={})
+        if username = item['twitter_username'] || config['username']
+          "@#{username.sub('@', '')}" # ensure @ mark, but not two.
+        else
+          ''
+        end
+      end
+
+      def hashtags(item)
+        hashtags = Array(item['twitter_hashtag'] || item['twitter_hashtags'])
+          .map{|h| "##{h.sub('#', '')}" } # ensure hash mark, but not two.
+          .join(' ')
+      end
+
+      def message(site, item)
+        (item['tweet_message'] || config['tweet_message'])
+          .sub(':title', item['title'] || '')
+          .sub(':username', username(item))
+          .sub(':url', Social.full_url(site, item))
+          .sub(':hashtags', hashtags(item))
+          .strip
+      end
+
+      def button_message(site, item)
+        %Q{data-text="#{message(site, item)}"}
+      end
+
+      def profile_link_text
+        config['profile_link_text'].sub(':username', username)
+      end
+
+      def twitter_profile_link(*args)
+        %Q{<a href="https://twitter.com/#{username.sub('@', '')}" class="twitter-follow-link">#{profile_link_text}</a>}
+      end
+
+      def twitter_follow_button(*args)
+        %Q{
+          <a href="https://twitter.com/#{username.sub('@', '')}" class="twitter-follow-button" 
+          #{'data-show-count="false"' if !config['follow_count']} data-dnt="true">#{profile_link_text}</a>
+        }
+      end
+
+      def twitter_script_tag(*args)
+        "<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>"
+      end
+
+      class Tag < Liquid::Tag
+        def initialize(tag, input, tokens)
+          @tag = tag.strip
+          @input = input.strip
+        end
+
+        def render(context)
+          item = context[@input] || context['page']
+          site = context['site']
+
+          Octopress::Social::Twitter.config(site)
+          Octopress::Social::Twitter.send(@tag, site, item).gsub(/(\s{2,}|\n)/, ' ').strip
+        end
+      end
+    end
+  end
+end

data/lib/octopress-social/version.rb

@@ -0,0 +1,5 @@
+module Octopress
+  module Social
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: octopress-social
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: clash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: octopress-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy social network integration for Jekyll sites
+email:
+- brandon@imathis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/octopress-social.rb
+- lib/octopress-social/facebook.rb
+- lib/octopress-social/google-plus.rb
+- lib/octopress-social/twitter.rb
+- lib/octopress-social/version.rb
+homepage: http://github.com/octopress/social
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Easy social network integration for Jekyll sites
+test_files: []