cackle 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 795976ed8d1dad277d90976a5b9c3b50043b847b
+  data.tar.gz: 73aeafd4731b674daa22a5645b2251c0cbbadfca
+SHA512:
+  metadata.gz: 8f1e8f3470be58a6abc29fc528c6aa767357c3846e4a520d7e417e60f76fc2ffb1c2c201ee950bab56a11fa917edf27864620427d9632b7f372dd4ed6d36381d
+  data.tar.gz: 66fe2a831c2b9f0340f736a3428c77b0e05d4c9e8674cad1174fe80d367a5b6055ccfc7cd435fe1f4267826c18109ca3a097eb0819e206491b2e641ee74e69a1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,67 @@
+Cackle.me integration
+=====================
+
+Simple Rails plugin implements synchronization of Cackle.me comments.
+
+Cackle.me is a real-time comment system with the ability to login 
+via popular social networks such as Google+, Facebook, Twitter, 
+LinkedIn, Vkontakte, Odnoklassniki, Mail.ru and many others.
+
+Storing in local database make comments visible to search robots.
+
+Installation
+------------
+
+Add to Gemfile 
+```ruby
+gem 'cackle' 
+```
+
+Generate and run migration
+```
+rails g cacke_migration
+rake db:migrate
+```
+Create config file config/cackle.yml
+See http://cackle.me/help/comment-sync to get your keys
+
+```yml
+site_id:         12345          # Site ID
+site_api_key:    blah-blah-blah # Account API Key
+account_api_key: blah-blah-blah # Site API Key
+jquery_off:      true           # Disable including jQuery if you already have it loaded
+
+recent:                         # configuretion for recent comments block
+  mcSize:        10             # how many comments to display
+  mcAvatarSize:  32             # size of avatar image in pixels
+  mcTextSize:    150            # length of message block if more shorten with '...'
+  mcTitleSize:   40             # title length
+```
+
+Helper methods
+==============
+
+Insert comments widget
+```ruby
+cackle_comments 
+```
+Recent comments widget
+```ruby
+cackle_recent_comments 
+```
+
+Rake tasks
+==========
+First time import. Warning clears all comments in base.
+```
+cackle:import
+```
+
+Syncronize changes. Should be called every 5 minutes by cron.
+```
+cackle:sync
+```
+
+License
+-------
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cackle'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/app/helpers/cackle_helper.rb

@@ -0,0 +1,18 @@
+module CackleHelper
+  def cackle_comments
+    load_config
+    @comments = CackleComment.approved.where("url LIKE ?", "%#{request.path}")
+    render template: 'cackle/comments'
+  end
+  
+  def cackle_recent_comments
+    load_config
+    @comments = CackleComment.approved.limit(@config['recent']['mcSize'])
+    render template: 'cackle/recent'
+  end
+  
+  private 
+  def load_config
+    @config ||= YAML::load(File.open('config/cackle.yml'))
+  end
+end

data/lib/app/models/cackle_comment.rb

@@ -0,0 +1,5 @@
+class CackleComment < ActiveRecord::Base
+  self.primary_key = 'comment_id'
+  default_scope order: 'created_at DESC'
+  scope :approved, -> { where(status: 'approved') }
+end

data/lib/app/views/cackle/comments.html.haml

@@ -0,0 +1,27 @@
+#mc-container
+  #mc-content
+    %ul#cackle-comments
+      - @comments.each do |comment|
+        %li{ id: "cackle-comment-#{comment.comment_id}" }
+          #cackle-comment-header.cackle-comment-header
+            %cite{ id: "cackle-cite-#{comment.comment_id}" }
+              -if comment.author_name
+                = link_to comment.author_name, '#', target: '_blank', id: comment.comment_id, rel: 'nofollow'
+              -else
+                %span{ id: "cackle-author-user-#{comment.comment_id}" }= comment.author_name
+          .cackle-comment-body{ id: "cackle-comment-body-#{comment.comment_id}" }
+            .cackle-comment-message{ id: "cackle-comment-message-#{comment.comment_id}" }= comment.message
+            
+:javascript
+   var href = window.location.href;
+   if (href.indexOf('?') > 0) {
+     var mcChannel = href.substring(0, href.indexOf('?'));
+   };
+   var mcSite = '#{@config['site_id']}';
+   (function() {
+       var mc = document.createElement('script');
+       mc.type = 'text/javascript';
+       mc.async = true;
+       mc.src = 'http://cackle.me/mc.widget-min.js';
+       (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(mc);
+   })();

data/lib/app/views/cackle/recent.html.haml

@@ -0,0 +1,62 @@
+:css
+  .mc-last-content{position:relative!important;width:100%!important;display:inline-block!important}
+  .mc-last-content div,.mc-last-content p,.mc-last-content h3{display:block!important}
+  .mc-last-content ul,.mc-last-content li,.mc-last-content ol,.mc-last-content div,.mc-last-content p,.mc-last-content a,.mc-last-content img{background:none repeat scroll 0 50% transparent!important;border:0 none!important;font-style:normal!important;margin:0!important;padding:0!important;text-align:left!important;text-indent:0!important}
+  .mc-last-content ul,.mc-last-content li{border:none!important;list-style:none!important;list-style-position:outside!important;list-style-type:none!important;line-height:normal!important}
+  .mc-last-content li>div{margin-bottom:5px!important;position:relative!important;word-wrap:break-word!important}
+  .mc-last-content li .mc-recent-thumb{position:relative!important;margin-right:6px!important;padding:0!important;float:left!important;width:auto!important}
+  .mc-last-content li .mc-recent-thumb:after{border-radius:2px!important;box-shadow:0 0 3px rgba(0,0,0,0.33) inset!important;position:absolute!important;left:0!important;top:0!important;content:" "!important;width:100%!important;height:100%!important}
+  .mc-last-content .mc-recent-thumb img{border-radius:2px!important;max-width:100%!important;height:auto!important;float:left!important;vertical-align:middle!important;border:0!important}
+  .mc-last-content .mc-recent-body{margin-left:38px!important;line-height:15px!important}
+  .mc-last-content .mc-recent-author{color:#8a8a8a!important;font-size:13px!important;font-weight:bold!important;line-height:14px!important;text-decoration:none!important;padding:0!important}
+  .mc-last-content .mc-recent-text{font-size:12px!important;line-height:16px!important;margin-top:2px!important}
+  .mc-last-content .mc-recent-text a,.mc-last-content .mc-recent-text a:hover{color:inherit!important;text-decoration:none!important}
+  .mc-last-content .mc-recent-meta{border-bottom:1px dotted #e0e0e0!important;font-size:11px!important;line-height:15px!important;margin-top:4px!important;color:#a7a7a7!important}
+  .mc-last-content .mc-recent-meta a{text-decoration:none!important;color:#a7a7a7!important;font-size:11px!important}
+  #mc-link{color:#555!important;font-size:11px!important;clear:both!important;float:right;text-decoration:none!important}
+  #mc-link:hover{color:#333!important}
+  .mc-recent-thumb img{
+    width: #{@config['recent']['mcAvatarSize']}px;
+    height: #{@config['recent']['mcAvatarSize']}px;
+  } 
+#mc-last
+  .mc-last-content
+    %ul
+      - @comments.each do |comment|
+        %li
+          %div
+            - if comment.author_name
+              = link_to comment.author_www, target: '_blank' do
+                %span.mc-recent-thumb= image_tag(comment.author_avatar, alt: comment.author_name)
+            - else
+              %span.mc-recent-thumb= image_tag('http://cackle.me/static/img/anonym.png', alt: comment.anonym_name)
+            .mc-recent-body
+              %div
+                - if comment.author_name
+                  = link_to comment.author_www, target: '_blank' do
+                    %span.mc-recent-author= comment.author_name
+                - else
+                  %span.mc-recent-author= comment.anonym_name
+              %p.mc-recent-text= link_to comment.message.truncate(@config['recent']['mcTextSize']), comment.url + "#mc-#{comment.id}"
+              %p.mc-recent-meta
+                = link_to comment.title.truncate(@config['recent']['mcTitleSize']), comment.url, title: comment.title
+                - unless 1.month.ago > (date = comment.created_at)
+                  · #{time_ago_in_words date} назад 
+                - else
+                  · #{date.strftime("%d.%m")}
+                = date.strftime("%H:%M")
+
+:javascript
+  var mcSite = '#{@config['site_id']}';
+  var mcSize = '#{@config['recent']['mcSize']}';
+  var mcAvatarSize = '#{@config['recent']['mcAvatarSize']}';;
+  var mcTextSize = '#{@config['recent']['mcTextSize']}';
+  var mcTitleSize = '#{@config['recent']['mcTitleSize']}';
+  var mcJqueryOff = #{@config['recent']['mcJqueryOff']};
+  (function() {
+      var mc = document.createElement('script');
+      mc.type = 'text/javascript';
+      mc.async = true;
+      mc.src = 'http://cackle.me/mc.last-min.js';
+      (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(mc);
+  })();

data/lib/cackle.rb

@@ -0,0 +1,13 @@
+module Cackle
+  require "cackle/railtie" if defined?(Rails)
+  require 'app/helpers/cackle_helper'
+
+  ActionView::Base.send :include, CackleHelper
+
+  path = File.join(File.dirname(__FILE__), 'app', 'models')
+  $LOAD_PATH << path
+  ActiveSupport::Dependencies.autoload_paths << path
+  ActiveSupport::Dependencies.autoload_once_paths.delete(path)
+  
+  ActionController::Base.prepend_view_path File.join(File.dirname(__FILE__), 'app/views')
+end

data/lib/cackle/railtie.rb

@@ -0,0 +1,7 @@
+module Cackle
+  require 'rails'
+
+  class Railtie < Rails::Railtie
+    rake_tasks { load "tasks/cackle_tasks.rake" }
+  end
+end

data/lib/cackle/version.rb

@@ -0,0 +1,3 @@
+module Cackle
+  VERSION = "0.0.2"
+end

data/lib/generators/cackle_migration/cackle_migration_generator.rb

@@ -0,0 +1,19 @@
+class CackleMigrationGenerator < Rails::Generators::Base 
+  require 'rails/generators'
+  require 'rails/generators/migration'     
+
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/create_cackle_comments.rb'
+  end
+end

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

@@ -0,0 +1,22 @@
+class CreateCackleComments < ActiveRecord::Migration
+  def change
+    create_table :cackle_comments, id: false do |t|
+      t.integer  :comment_id
+      t.integer  :parent_id
+      t.string   :post_id
+      t.string   :url
+      t.string   :title
+      t.text     :message
+      t.string   :status
+      t.string   :ip
+      t.string   :author_name
+      t.string   :author_email
+      t.string   :author_avatar 
+      t.string   :author_www
+      t.string   :author_provider
+      t.string   :anonym_name
+      t.string   :anonym_email
+      t.timestamps
+    end
+  end
+end

data/lib/tasks/cackle_tasks.rake

@@ -0,0 +1,90 @@
+require 'open-uri'
+
+namespace :cackle do
+  def load_config
+    @config = YAML::load(File.open('config/cackle.yml'))
+    @path = "http://cackle.me/api/comment/mutable_list?siteApiKey=#{@config['site_api_key']}&accountApiKey=#{@config['account_api_key']}"
+    raise "Create config/cackle.yml first" unless @config
+    
+    puts "will use: "
+    puts @config['site_id']
+    puts @config['site_api_key']
+    puts @config['account_api_key']
+  end
+  
+  def create_comment c
+    comment = CackleComment.new(
+      comment_id: c['id'],
+      parent_id:  c['parentId'],
+      post_id:    c['channel'], 
+      url:        c['url'],
+      title:      c['title'],
+      message:    c['message'],
+      status:     c['status'],
+      ip:         c['ip'], 
+      created_at: Time.strptime((c['created']/1000).to_s, "%s"),
+      updated_at: Time.strptime(c['modified'][0..9], "%s"))
+    if c['author'] 
+      comment.author_name     = c['author']['name']
+      comment.author_email    = c['author']['email']
+      comment.author_www      = c['author']['www']
+      comment.author_avatar   = c['author']['avatar']
+      comment.author_provider = c['author']['provider']
+    else
+      comment.anonym_name     = c['anonym']['name']
+      comment.anonym_email    = c['anonym']['email']
+    end
+    if comment.save
+      puts "created #{comment.comment_id}"
+    end
+  end
+
+  desc 'Initial comment base load'
+  task import: :environment do
+    CackleComment.delete_all   
+    load_config  
+    begin 
+      max      = CackleComment.maximum('created_at')
+      @url     = max ? @path + "&modified=#{max.to_i*1000}" : @path
+      response = open(@url).read
+      json     = JSON.parse(response)    
+      comments = json['comments']     
+      comments.each do |c|
+        create_comment c
+      end 
+    end while (comments.size == 100)  
+    puts "Total #{CackleComment.count} in base"
+  end
+  
+  desc 'Synchronize comments database'
+  task sync: :environment do
+    load_config
+
+    max = CackleComment.maximum('updated_at')
+    raise "run bootstrap first" unless max
+    
+    puts "maximum found in base: #{max}"
+    @url = @path + "&modified=#{max.to_i*1000}"
+
+    response = open(@url).read
+    json     = JSON.parse(response)
+    
+    json['comments'].each do |c|
+      comment = CackleComment.find_by_comment_id(c['id'])
+      if comment
+        if (time = Time.strptime((c['modified'][0..9]).to_s, "%s")) > comment.updated_at
+          puts "updating: #{c['id']}"
+          comment.update_attributes( 
+            message:    c['message'],
+            status:     c['status'],
+            updated_at: time)
+          comment.save
+        else
+          puts "comment: #{c['id']} already exist"
+        end
+      else
+        create_comment c
+      end
+    end
+  end  
+end

data/test/cackle_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CackleTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Cackle
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.