easycomments 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7167047b3d7e6712e100ad6e3692c94645fb4f5d
-  data.tar.gz: 3cef902dde8bd0c7e029964d1a4563c8fda27024
+  metadata.gz: 3769d7478cdda520b182646690a420544f484241
+  data.tar.gz: 741d5355bf84ff27c09c3ef9f672a25e9472d24a
 SHA512:
-  metadata.gz: e07ab076abda884464ebb29eb2b6b44e4d64040b731a5f3bc551bb8b1bd84ee9b39a941727b211760be6be98148f71ecbe68e26b34138a1fd86ab581037d56fb
-  data.tar.gz: 2babd846e16e62569b7ed42c5436d88f3cc0f63bee63a06a37eff2f5541ab4c5fd48e681af4a4f6d1e297577c2a06af81d71ff691465945185597e87a9af9008
+  metadata.gz: 608099e88c4eac8f4b7b035480fe64d6cb88e94d2aebd59a20fdc80100019ab3656b9ea47dcac7630095f2fb792e6fcc312f9340fee5bcd099d203bc5ebbebba
+  data.tar.gz: 3e91047ba20119846abc20fa345c79f70e558926216519198c4b402d36376d15811299cc6baa55644fc5ce21ced3ed4456b9dccdda13cb61df018f3a22d32f06

data/README.md

@@ -18,8 +18,11 @@ ec install
 ```
 (pass the --dev flag if you also want the spec suite)  
 Then
-```ruby
-bundle install
+```
+bundle install --without test development  
+or just  
+bundle install  
+if --dev is on
 ```
 and you are ready.
 ##Configuring
@@ -38,7 +41,7 @@ to add your user.
 ##Endpoints
 EC has one endpoint for posting a new comment and one for retrieving a comment list.
 ```
-GET /comments, with a 'post' parameter 
+GET /comments, with a 'post' parameter and an optional 'page' parameter if you have pagination enabled.
 ```
 The 'post' parameter simply serves as a namespace to group comments for retrieval,
 it can be a blog post title, an url or something more sophisticated, it's up to you.
@@ -77,8 +80,14 @@ allow_cors: false
 #see available formats here https://github.com/cyu/rack-cors
 cors_origin: "*"  
 
-#set to false to not automatically escape html in comment bodys  
+#set to false to not automatically escape html in comment bodies
 auto_escape_html: true
+
+#set to true to have pagination support in comment retrieval  
+paginate: false  
+
+#how many comments to return per page if paginate is true  
+comments_per_page: 10
 ```
 
 ## Updating
@@ -93,7 +102,6 @@ It will recopy all the files but keeps your _config.yml and Gemfile.
 by hand since it also bcrypts your passwords!
 
 ##TODO:
-* pagination in GET /comments  
 * markdown support  
 * dynamic fields in POST /comment  
 

data/_config.yml

@@ -1,12 +1,13 @@
 ---
-connection: "sqlite://blog.db"
+connection: sqlite://blog.db
 approve_by_default: false
 allow_anonymous_post: false
 timestamp_format: "%d/%m/%Y - %H:%M"
 allow_cors: false
 cors_origin: "*"
 auto_escape_html: true
-:users:
+paginate: false
+comments_per_page: 10
 #
 ##connection : database connection url to be passed to sequel's connect method.
 ##check http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html
@@ -25,6 +26,10 @@ auto_escape_html: true
 #
 ##auto_escape_html : automatically escape html in comment bodys
 #
+##paginate : set to true to have pagination support in comment retrieval
+#
+##comments_per_page : how many comments to return per page if paginate is true
+#
 ##users : do not edit this by hand use 'rake adduser' instead.
 #
 ##if you edit this file after 'rake init' use 'rake update' for the changes to take effect.

data/dashboard.rb

@@ -19,7 +19,7 @@ class ECDashboard < Sinatra::Application
   end
 
   get "/comments" do
-    get_comments(params[:post])
+    get_comments(params[:post], params[:page])
   end
 
   get '/get_all_posts' do
@@ -47,7 +47,7 @@ class ECDashboard < Sinatra::Application
   end
 
   get '/get_pending_comments' do
-    get_pending_comments(params[:post])
+    get_pending_comments(params[:post], params[:page])
   end
 
   post '/ignore_comment' do

data/easycomments.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'easycomments'
-  s.version     = '1.0.3'
-  s.date        = '2015-03-31'
+  s.version     = '1.0.4'
+  s.date        = '2015-04-03'
   s.summary     = "Simple and easy to use comment system"
   s.description = <<EOF
 EasyComments(EC) is an easy to use comment system with a simple api

data/ec.rb

@@ -29,7 +29,7 @@ class EC < Sinatra::Application
 
 
   get "/comments" do
-    get_comments(params[:post])
+    get_comments(params[:post], params[:page])
   end
 
   post "/comment" do

data/lib/easycomments/ec_configuration.rb

@@ -14,6 +14,8 @@ module Configuration
   ALLOW_CORS = CONFIG["allow_cors"]
   CORS_ORIGIN = CONFIG["cors_origin"]
   AUTO_ESCAPE_HTML = CONFIG["auto_escape_html"]
+  PAGINATE = CONFIG["paginate"]
+  COMMENTS_PER_PAGE = CONFIG["comments_per_page"].to_i
 
 #wall of help text to be added in _config.yml
   def comment_wall
@@ -34,7 +36,11 @@ comments = <<COMMENTS
 #
 ##cors_origin : see available formats here https://github.com/cyu/rack-cors
 #
-##auto_escape_html : automatically escape html in comment bodys
+##auto_escape_html : automatically escape html in comment bodies
+#
+##paginate : set to true to have pagination support in comment retrieval
+#
+##comments_per_page : how many comments to return per page if paginate is true
 #
 ##users : do not edit this by hand use 'rake adduser' instead.
 #

data/lib/easycomments/ec_dashboard_model.rb

@@ -2,11 +2,13 @@ require_relative "../easycomments.rb"
 
 module ECDashboardModel
   extend self
-
-  def get_comments(post)
-    comments = DB[:comments].where(:post => post).all.sort_by{|comment| comment[:id].to_i}.reverse #show latest comment first
+  include Pagination
+  
+  def get_comments(post, page_num)
+    comments = DB[:comments].where(:post => post).reverse(Sequel.asc(:timestamp)).page(page_num).all
+    count =  DB[:comments].where(:post => post).page(page_num).page_count
     comments = comments.each{|comment| comment[:timestamp] = comment[:timestamp].strftime(TIMESTAMP_FORMAT)}
-    MultiJson.dump({:comments => comments})
+    MultiJson.dump(:comments => comments, :page_count => count)
   end
 
   def get_all_posts
@@ -43,10 +45,11 @@ module ECDashboardModel
     MultiJson.dump({:pending => pending})
   end
 
-  def get_pending_comments(post)
-    comments = DB[:comments].where(:post => post, :action_taken => false).all.sort_by{|comment| comment[:id].to_i}.reverse #show latest comment first
+  def get_pending_comments(post, page_num)
+    comments = DB[:comments].where(:post => post, :action_taken => false).reverse(Sequel.asc(:timestamp)).page(page_num).all
+    count =  DB[:comments].where(:post => post, :action_taken => false).page(page_num).page_count
     comments = comments.each{|comment| comment[:timestamp] = comment[:timestamp].strftime(TIMESTAMP_FORMAT)}
-    MultiJson.dump({:comments => comments})
+    MultiJson.dump({:comments => comments, :page_count => count})
   end
 
   def ignore_comment(id)

data/lib/easycomments/ec_model.rb

@@ -3,6 +3,7 @@ require_relative "../easycomments.rb"
 module ECModel
   
   extend self
+  include Pagination if PAGINATE
 
   def post_comment(comment)
     if comment[:body] != "undefined" && comment[:body] != ""
@@ -20,10 +21,20 @@ module ECModel
     end
   end
 
-  def get_comments(post)
-    comments = DB[:comments].where(:post => post, :approved => true).all.sort_by{|comment| comment[:id].to_i}.reverse #show latest comment first
-    comments = comments.each{|comment| comment[:timestamp] = comment[:timestamp].strftime(TIMESTAMP_FORMAT)}
-    MultiJson.dump({:comments => comments})
+  def get_comments(post, page_num)
+    if PAGINATE
+      comments = DB[:comments].where(:post => post, :approved => true).reverse(Sequel.asc(:timestamp)).page(page_num).all
+      count =  DB[:comments].where(:post => post).page(page_num).page_count
+      comments = comments.each{|comment| comment[:timestamp] = comment[:timestamp].strftime(TIMESTAMP_FORMAT)}
+      page_num = page_num.to_i
+      page_num = 1 if page_num < 1
+      response = {:comments => comments, :page => page_num.to_i, :total_pages => count}    
+    else
+      comments = DB[:comments].where(:post => post, :approved => true).reverse(Sequel.asc(:timestamp)).all
+      comments = comments.each{|comment| comment[:timestamp] = comment[:timestamp].strftime(TIMESTAMP_FORMAT)}
+      response = {:comments => comments}
+    end
+    MultiJson.dump(response)
   end
 
   private
@@ -44,4 +55,5 @@ module ECModel
                     )   
     MultiJson.dump({:status => "New comment posted."})
   end
+
 end

data/lib/easycomments/ec_pagination.rb

@@ -0,0 +1,20 @@
+module Pagination
+  extend self
+  
+  class Sequel::Model
+    def self.page(page, per_page=COMMENTS_PER_PAGE || 10, *args)
+      page = page.to_i
+      page = 1 if page < 1
+      dataset.paginate(page, per_page, *args)
+    end
+  end
+   
+  class Sequel::Dataset
+    def page(page, per_page=COMMENTS_PER_PAGE || 10, *args)
+      page = page.to_i
+      page = 1 if page < 1
+      paginate(page, per_page, *args)
+    end
+  end
+
+end

data/lib/easycomments.rb

@@ -6,9 +6,11 @@ require 'rack/utils'
 require 'rack/protection'
 require 'bcrypt'
 require_relative "easycomments/ec_configuration.rb"
+require_relative "easycomments/ec_pagination.rb"
 
-VERSION = "1.0.3"
+VERSION = "1.0.4"
 
 include Configuration
 
 DB = Sequel.connect(CONNECTION)
+DB.extension(:pagination)

data/public/elements/ec-dashboard/ec-dashboard.html

@@ -81,6 +81,20 @@
         text-decoration: none !important;
         color: #616161;
       }
+      .pagination{
+        padding-top: 20px;
+        padding-bottom: 20px;
+      }
+      .pg_input {
+         width: 83px;
+      }
+      .pg_btn::shadow #ripple {
+        color: #FFA726;
+      }
+      paper-input-decorator /deep/ .focused-underline {
+        /* line color when the input is focused */
+        background-color: #FF9800;
+      }
     </style>
     <core-ajax
       auto
@@ -106,16 +120,18 @@
     <core-ajax
       id="get_all_comments"
       url="/dashboard/comments"
-      params='{"post":"{{post_global}}"}'
+      params='{"post":"{{post_global}}", "page":"{{current_page}}"}'
       handleAs="json"
-      response="{{comments}}">
+      response="{{comments}}"
+      on-core-complete="{{pageRange}}">
     </core-ajax>
     <core-ajax
       id="get_pending_comments"
       url="/dashboard/get_pending_comments"
-      params='{"post":"{{post_global}}"}'
+      params='{"post":"{{post_global}}", "page":"{{current_page}}"}'
       handleAs="json"
-      response="{{comments}}">
+      response="{{comments}}"
+      on-core-complete="{{pageRange}}">
     </core-ajax>
     <core-ajax
       id="edit_comment"
@@ -157,8 +173,8 @@
         <core-menu>
           <section is="auto-binding">
             <paper-tabs selected="{{selected}}">
-              <paper-tab>Pending&nbsp;&nbsp;<span class="pending_number">{{total_pending.pending}}</span></paper-tab>
-              <paper-tab>All</paper-tab>
+              <paper-tab on-click="{{refreshPosts}}">Pending&nbsp;&nbsp;<span class="pending_number">{{total_pending.pending}}</span></paper-tab>
+              <paper-tab on-click="{{refreshPosts}}">All</paper-tab>
             </paper-tabs>
             <core-pages selected="{{selected}}">
               <div>
@@ -180,7 +196,7 @@
       <div tool id="title">{{post_title}}</div>
       <div id ="content" fit>
         <template repeat="{{comment in comments.comments}}">
-          <paper-shadow>
+          <paper-shadow id="comment_{{comment.id}}">
             <p id="comment-title">{{comment.name}} - {{comment.email}} - {{comment.timestamp}}</p>
             <paper-autogrow-textarea id="a1">
               <textarea value="{{comment.body}}" rows="5"></textarea>
@@ -198,6 +214,16 @@
             </div>
           </paper-shadow>
         </template>
+        <template if="{{comments.page_count > 1}}">
+          <paper-shadow class="pagination" horizontal center-justified layout>
+              <paper-button class="pg_btn" on-click="{{firstPage}}">First</paper-button>
+                <paper-button disabled='{{current_page <= 1}}' class="pg_btn" on-click="{{prevPage}}">Previous</paper-button>
+                <paper-input-decorator class="pg_input"><input is="core-input" value="{{page_input}}"></paper-input-decorator>
+                <label class="pg_btn"><br>of {{comments.page_count}}</label>
+                <paper-button  disabled='{{current_page >= comments.total_pages}}' on-click="{{nextPage}}" class="pg_btn">Next</paper-button>
+              <paper-button class="pg_btn" on-click="{{lastPage}}">Last</paper-button>
+          </paper-shadow>
+        </template>
       </div>
     </core-scaffold>
   </template>
@@ -208,12 +234,16 @@
           var p = e.target.templateInstance.model.post;
           this.post_title = p;
           this.post_global = p;
+          this.current_page = 1;
+          this.page_input = this.current_page;
           this.shadowRoot.querySelector("#get_all_comments").go();
         },
         getPendingComments: function(e, detail, sender){
           var p = e.target.templateInstance.model.post.post;
           this.post_title = p;
           this.post_global = p;
+          this.current_page = 1;
+          this.page_input = this.current_page;
           this.shadowRoot.querySelector("#get_pending_comments").go();
         },
         editComment: function(e, detail, sender){
@@ -230,10 +260,13 @@
           this.comment_id = d;
           this.shadowRoot.querySelector("#remove_comment").go();
           //refresh comment list
-          this.shadowRoot.querySelector("#get_all_comments").go();
+          if (this.selected == "0") {
+            this.shadowRoot.querySelector("#get_pending_comments").go();
+          }else {
+            this.shadowRoot.querySelector("#get_all_comments").go();
+          }
           //refresh post list
           this.refreshPosts();
-          //na vgainei kai to title panw panw
         },
         approveComment: function(e, detail, sender){
           var d = e.target.templateInstance.model.comment.id;
@@ -249,7 +282,11 @@
           //refresh post list
           this.refreshPosts();
           //refresh comment list
-          this.shadowRoot.querySelector("#get_pending_comments").go();
+          if (this.selected == "0") {
+            this.shadowRoot.querySelector("#get_pending_comments").go();
+          }else {
+            this.shadowRoot.querySelector("#get_all_comments").go();
+          }
         },
         showToast: function(event, response) {
           this.shadowRoot.querySelector('#toast1').text = response.response.status;
@@ -260,6 +297,56 @@
           this.shadowRoot.querySelector("#get_posts_with_pending").go();
           this.shadowRoot.querySelector("#get_total_pending").go();
         },
+        firstPage: function () {
+          this.current_page = 1;
+          this.page_input = this.current_page;
+          if (this.selected == "0") {
+            this.shadowRoot.querySelector("#get_pending_comments").go();
+          }else {
+            this.shadowRoot.querySelector("#get_all_comments").go();
+          }
+        },
+        lastPage: function () {
+          this.current_page = this.comments.page_count;
+          this.page_input = this.current_page;
+          if (this.selected == "0") {
+            this.shadowRoot.querySelector("#get_pending_comments").go();
+          }else {
+            this.shadowRoot.querySelector("#get_all_comments").go();
+          }
+        },
+        prevPage: function () {
+          this.current_page = this.current_page - 1;
+          this.page_input = this.current_page;
+          if (this.selected == "0") {
+            this.shadowRoot.querySelector("#get_pending_comments").go();
+          }else {
+            this.shadowRoot.querySelector("#get_all_comments").go();
+          }
+        },
+        nextPage: function () {
+          this.current_page = this.current_page + 1;
+          this.page_input = this.current_page;
+          if (this.selected == "0") {
+            this.shadowRoot.querySelector("#get_pending_comments").go();
+          }else {
+            this.shadowRoot.querySelector("#get_all_comments").go();
+          }
+        },
+        setPage: function (oldValue, newValue) {
+          if (oldValue != newValue && newValue > 0){
+            var value = Path.get('page_input').getValueFrom(this);
+            this.current_page = value;
+            if (this.selected == "0") {
+              this.shadowRoot.querySelector("#get_pending_comments").go();
+            }else {
+              this.shadowRoot.querySelector("#get_all_comments").go();
+            }
+          }
+        },
+        observe: {
+          'page_input': 'setPage'
+        },
         attached: function() {
           //open pending tab by default
           this.selected = "0";

data/public/elements/ec-login/ec-login.html

@@ -0,0 +1,78 @@
+<link rel="import" href="../../bower_components/polymer/polymer.html">
+<polymer-element name="ec-login">
+  <template>
+    <style>
+      #container {
+        background-color: #E5E5E5;
+        font-family: 'RobotoDraft', sans-serif;
+        width: 100%;
+        height: 100%;
+      }
+      #login_form {
+        width: 280px;
+        height: 260px;
+        margin-top: 10%;
+      }
+      a {
+        text-decoration: none !important;
+        color: #616161;
+      }
+      #title {
+        padding-left:50px;
+      }
+      #login_button::shadow #ripple {
+        color: #FFA726;
+      }
+      paper-input-decorator /deep/ .focused-underline {
+          /* line color when the input is focused */
+          background-color: #FFB74D;
+      }
+      paper-input-decorator /deep/ #floatedLabelText {
+        color: #616161;
+      }
+    </style>
+    <core-ajax
+      id="login"
+      url="/dashboard/login"
+      method="post"
+      params='{"username":"{{username}}", "password":"{{password}}"}'
+      handleAs="json"
+      on-core-response="{{postLogin}}">
+    </core-ajax>
+    <div horizontal center-justified layout id="container">
+      <paper-shadow id="login_form" vertical  layout>
+      <paper-shadow><div id="title"><a href="/"><h2>EasyComments<h2></a></div></paper-shadow>
+        <paper-input-decorator label="Username" floatingLabel>
+           <input id="username" is="core-input" type="text" value="{{username}}"/>
+        </paper-input-decorator>
+        <paper-input-decorator label="Password" floatingLabel>
+           <input id="password" is="core-input" type="password" value="{{password}}"/>
+        </paper-input-decorator>
+        <paper-button id="login_button" on-click="{{login}}">Login</paper-button>
+      </paper-shadow>
+    </div>
+    <template if="{{has_access}}">
+      <ec-dashboard></ec-dashboard>
+    </template>
+    <paper-toast id="toast1" text="Wrong username or password."></paper-toast>
+  </template>
+  <script>
+    Polymer('ec-login', {
+        login: function() {
+          this.shadowRoot.querySelector("#login").go();
+        },
+        postLogin: function(event, response) {
+          this.has_access = response.response.has_access;
+          if(this.has_access === false){
+            this.shadowRoot.querySelector('#toast1').show();
+          }else{
+            //hide the form
+            this.shadowRoot.querySelector("#container").hidden = true;
+          }
+        },
+        ready: function(){
+          this.has_access = false;
+        },
+    });
+  </script>
+</polymer-element>

data/public/polymer-loader.html

@@ -19,6 +19,7 @@
 <link rel="import" href="/bower_components/core-pages/core-pages.html">
 
 <link rel="import" href="/elements/ec-dashboard/ec-dashboard.html">
+<link rel="import" href="/elements/ec-login/ec-login.html">
 <!--
 vulcanize ./polymer-loader.html --abspath ./ --inline --strip -o ./polymer-loader.vulcanized.html
 -->