cachai 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60bb4315ef242ac00c5f829339a5e69a36e1691d
-  data.tar.gz: fd1a0bb8dabbc64bf49f80cd0ddd85727a22abd0
+  metadata.gz: e22e87617ddb5c31c0323caa1669a6c6f113e22c
+  data.tar.gz: 4600b981f67a035759bf840cdb087e6d47250457
 SHA512:
-  metadata.gz: cb9a8a4acb6a5552ec234edca4cc6bb56dc132cdbe1a811677289ca15a0d601b16172392f38b7c3be83ee304e1713644485075b3598d0aa6a5a67ea2344f8eaa
-  data.tar.gz: 71e1e058a543e67337eaa42681ed690bc50682de0530d5c21fcc09be5f2d0e34ae7abd160be864f839c7199885b0004af4e559b24258e1b3b0c268e461e18d1a
+  metadata.gz: f172f5bd47ce928fe0b021c14a37e36ae2f4b93cbe726dbd7f24fa55f60922278574ac0345bed005a7ce27a6541eca6175df45cd71b326c485448c17a8fff1cc
+  data.tar.gz: 384a50e683f10c8bcc632de7460789562e046dfcbc2fa2697a0ecb3b96bb232ac29f14f3ef761cbba449c463d1d0868b03893e0c4b85708e7f3045341f17442a

data/README.md

@@ -1,26 +1,111 @@
-# Commentary
+# Cachai
 
-Add comments to your blog.
+A clean way to add support for comments and pingbacks in your Rack app. Si pos weon.
 
-## Setup
-* Edit `config/production.yml` to add your site. Specify a name and the domain where the site will be hosted. Example configuration will be like this:
+## Setting up
 
-```
-name: Blog
-domain: blog.sdqali.in
-```
+First you need to create a config/database.yml file, as you'd have on a regular Rails app, or if using Sinatra::ActiveRecord.
 
-* Run `RACK_ENV=production setup.rb`
-* Start the server with `RACK_ENV=production app.rb`
-* Add the following to your HTML pages or templates. `selector` is the CSS selector for the DOM element where comments will be rendered.
+    # database.yml
+    development:
+      adapter: sqlite3
+      database: db/development.sqlite3
+      pool: 16
 
-```html
-<script type="text/javascript" src="<server>/jquery-1.10.2.min.js"></script>
-<script type="text/javascript" src="<server>//commentary.js"></script>
-<script type="text/javascript">
-   $(document).ready(function() {
-      Commentary.initialize("<server>", "<selector>");
-   });
-</script>
+Now insert the middleware before the app, either in your rackup file or in the app itself. We'll go with method one.
 
-```
+    # rackup.ru
+    require 'sinatra'
+    require 'cachai'
+
+    map '/' do
+      use Cachai::Middleware, { domain: 'yourdomain.com' }
+      run Sinatra::Application
+    end
+
+Now, the next time the app is loaded, Cachai will set up the necessary tables in the database provided. Basically a `posts` table and a `responses` one.
+
+## Posting new comments
+
+Now, to send our first comment to Cachai, let's insert a form within your blog post view.
+
+    # views/blog/post.erb (or something like it)
+
+    ...
+
+    <form action="/comments" method="post" id="comment-form">
+      <input type="hidden" name="url" value="http://yourdomain.com/path/to/your/blog/post" />
+      <input type="text" name="author_name" />
+      <input type="email" name="author_email" />
+      <input type="text" name="author_url" />
+      <textarea name="content"></textarea>
+    </form>
+
+Now load your app and try submitting a comment. It should work.
+
+## Posting comment using AJAX
+
+Using Javascript, you'd do something like this:
+
+    // app.js
+
+    $(function() {
+
+      $('#comment-form').on('submit', function(e) {
+        e.preventDefault();
+
+        var data = {
+          author_name   : this.author_name.value,
+          author_email  : this.author_email.value,
+          author_url    : this.author_url.value,
+          content       : this.content.value,
+          protocol      : window.location.protocol,
+          domain        : 'yourdomain.com',
+          path          : encodeURI(window.location.pathname)
+        }
+
+        $.ajax({
+          type    : 'post',
+          data    : JSON.stringify(data),
+          url     : '/comments.json',
+          success : function() { alert('Thanks!') },
+          error   : function() { alert('Oh rats. Try again please.') },
+        })
+      })
+
+    })
+
+## Reading comments via AJAX
+
+You get them using GET /comments.json.
+
+    // app.js
+
+      var domain = 'yourdomain.com',
+          path   = encodeURI(window.location.pathname),
+          url    = '/comments.json?callback=?&domain=' + domain + '&path=' + path;
+
+      $.ajax({
+        dataType : 'json',
+        url      : url,
+        success  : function(list) { /* render comments */ }),
+        error    : function(err)  { alert('Damn!') }
+      });
+    }
+
+Or if you wish to insert them in the view itself.
+
+    # views/blog/post.erb
+
+    <ul id="comments">
+      <% Cachai.get_comments_for(@post.url).each do |comment| %>
+      <li>
+        <strong><%= comment.author_name %></strong>
+        <strong><%= simple_format(comment.content) %></strong>
+      </li>
+      <% end %>
+    </ul>
+
+# Small print.
+
+(c) 2016 Tomas Pollak. MIT Licensed.

data/cachai.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "cachai"
-  spec.version       = '0.1.4'
+  spec.version       = '0.2.0'
   spec.authors       = ["Tomás Pollak"]
   spec.email         = ["tomas@forkhq.com"]
   spec.description   = %q{Middleware for embedabble comments.}

data/lib/cachai.rb

@@ -56,7 +56,7 @@ module Cachai
       check_domain!(params[:domain])
 
       # puts "Comments for: #{params[:domain]}#{params[:path]}"
-      json_list = get_comments(params[:path], params[:nocache])
+      json_list = Cachai.get_comments_for(params[:path], params[:nocache])
 
       if params[:callback]
         content_type 'application/javascript'
@@ -68,9 +68,16 @@ module Cachai
 
     post '/comments.?:format?' do
       begin
-        data = JSON.parse(request.body.read)
-        check_domain!(data['domain'])
+        data = params[:format] == 'json' ? JSON.parse(request.body.read) : params
+
+        if data[:url] # got single URL with protocol://domain/path
+          url = URI.parse(data)
+          data['domain']   = url.host
+          data['protocol'] = url.schema
+          data['path']     = url.path
+        end
 
+        check_domain!(data['domain'])
         halt(400, "Missing params") if data['protocol'].blank? or data['path'].blank?
 
         headers['Access-Control-Allow-Origin'] = data['protocol'] + '//' + data['domain']
@@ -132,42 +139,6 @@ module Cachai
       return obj.is_a?(String) ? obj : obj.to_json
     end
 
-    def get_comments(path, nocache = false)
-      key = Cachai.key_for(path)
-
-      unless !nocache && json_list = Cachai.cache.get(key)
-        puts "Not cached. Getting from DB: #{path}"
-
-        if post = Post.find_by_path(path)
-          json_list = get_and_sort_comments_for(post).to_json
-        else
-          json_list = '[]'
-        end
-
-        Cachai.cache.set(key, json_list)
-        Cachai.cache.expire(key, CACHE_MINUTES)
-      end
-
-      json_list
-    end
-
-    def get_and_sort_comments_for(post)
-      result = []
-      top_level = post.responses.comment.approved.top_level
-      nested    = post.responses.comment.approved.nested
-
-      top_level.each_with_index do |comment, i|
-        obj = comment.as_json
-        children = nested.select do |nested|
-          nested.parent_id == comment.id
-        end
-        obj.merge!(:children => children) if children.any?
-        result.push(obj)
-      end
-
-      result
-    end
-
     def is_spam?(data, link, request)
       return false unless @akismet
       # return true if blacklisted?(name, email, content)

data/lib/models.rb

@@ -52,6 +52,42 @@ module Cachai
     "comments:#{@domain}:#{path}"
   end
 
+  def self.get_comments_for(path, nocache = false)
+    key = key_for(path)
+
+    unless !nocache && json_list = cache.get(key)
+      # puts "Not cached. Getting from DB: #{path}"
+
+      if post = Post.find_by_path(path)
+        json_list = get_and_sort_comments_for(post).to_json
+      else
+        json_list = '[]'
+      end
+
+      cache.set(key, json_list)
+      cache.expire(key, CACHE_MINUTES)
+    end
+
+    json_list
+  end
+
+  def self.get_and_sort_comments_for(post)
+    result = []
+    top_level = post.responses.comment.approved.top_level
+    nested    = post.responses.comment.approved.nested
+
+    top_level.each_with_index do |comment, i|
+      obj = comment.as_json
+      children = nested.select do |nested|
+        nested.parent_id == comment.id
+      end
+      obj.merge!(:children => children) if children.any?
+      result.push(obj)
+    end
+
+    result
+  end
+
   class Post < ActiveRecord::Base
     has_many :responses
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cachai
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Tomás Pollak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2016-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler