easycomments 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a75da80c881fc020f2f5bb5aadb4a2402669e9bf
+  data.tar.gz: 17b46c901e56b0f9d950b746c807858d18f0c56c
+SHA512:
+  metadata.gz: 79d4b7adc8a9148d2874fb0abf00cd6d2af6ceaa937230df218d38f4a997837b97a9a50a61c9ed6ac5c0397133abc8dc7a819709ed0f5de4337afaebb8d01351
+  data.tar.gz: 54a4acaea68bc66e7ce58521e3a49c495bba55414e994b95a2009c3b9a652fa0758cc95dc37da024ddde2896c322403614af1c346e068a32d92791fa676cdf4a

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--default-path spec/ec
+--pattern **_spec.rb

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem 'sinatra'
+gem 'rack-protection'
+gem 'multi_json'
+gem 'rack-contrib'
+gem 'sequel'
+gem 'rack-cors'
+gem 'bcrypt'
+
+group :test, :development do
+  gem 'sqlite3'
+  gem 'airborne'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <2015> <Zisis Maras - zisismaras@gmail.com>
+
+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,92 @@
+# EasyComments
+EasyComments(EC) is an easy to use comment system with a simple api
+for posting and retrieving comments.It also comes bundled with a dashboard
+for moderating your comments.
+
+##Installing
+Install by cloning the repository or for convenience install the gem
+```ruby
+gem install easycomments
+```
+and then(if you installed the gem) in a directory run
+```ruby
+ec install
+```
+(pass the --dev flag if you also want the spec suite)
+
+##Configuring
+Edit _config.yml and add your database (all adapters supported by sequel can be used)
+and change any other option you need.
+Then run
+```ruby
+rake init
+```
+to build the table and then
+```ruby
+rake adduser
+```
+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 
+```
+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.
+
+```
+POST /comment, with parameters : post, name, email, body
+```
+Example client can be found here : [easycomments-polymer](https://github.com/zisismaras/easycomments-polymer)
+
+##Dashboard
+EC comes bundled with a dashboard (can be accessed at /dashboard) to moderate your
+comments like approving, deleting, editing or ignoring.
+It's build with [polymer](https://www.polymer-project.org) and [webcomponents](http://webcomponents.org/)
+
+##Configuration options
+in _config.yml you can change the following
+```ruby
+#database connection url to be passed to sequel's connect method.
+#check http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html
+#all adapters supported by sequel can be used
+connection: "sqlite://blog.db"
+
+#set to true to allow all coments to be posted without moderation.
+approve_by_default: false
+
+#set to true to allow comments without a name.
+allow_anonymous_post: false
+
+#datetime format to be passed to strftime.
+#see availabe options here http://ruby-doc.org/core-2.2.1/Time.html#method-i-strftime
+timestamp_format: "%d/%m/%Y - %H:%M"
+
+#set to true to enable cross-origin resource sharing.
+allow_cors: false
+
+#see available formats here https://github.com/cyu/rack-cors
+cors_origin: "*"
+```
+
+## Updating
+If you installed easycomments as a gem there is a 'ec update' command.
+It will recopy all the files but keeps your _config.yml and Gemfile.  
+(--dev flag is available to also copy the spec suite)
+
+## Rake tasks
+'rake init' creates the required table.  
+'rake update' run it after re-editing _config.yml to update the table.  
+'rake adduser' you should always run this and not adding new users in _config.yml  
+by hand since it also bcypts your passwords!
+
+## 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
+
+###Licensed under MIT.
+

data/Rakefile

@@ -0,0 +1,49 @@
+require "sequel"
+require 'io/console'
+require 'bcrypt'
+require_relative "lib/easycomments/ec_configuration.rb"
+
+include Configuration
+
+DB = Sequel.connect(CONNECTION) 
+
+desc "Initializes EasyComments database"
+task :init do
+  DB.create_table :comments do
+    primary_key :id
+    String :name
+    String :email
+    String :post
+    String :body
+    TrueClass :approved, :default=>APPROVE_BY_DEFAULT
+    TrueClass :action_taken, :default=>false
+    DateTime :timestamp
+  end
+  puts "EasyComments database initialized."
+end
+
+desc "Updates EasyComments database."
+task :update do
+  DB.alter_table(:comments) do
+    set_column_default :approved, APPROVE_BY_DEFAULT
+  end
+  puts "EasyComments database updated."
+end
+
+desc "Create a new user."
+task :adduser do
+  print "Username: "
+  username = STDIN.gets.chomp
+  print "Password for #{username}: "
+  password = STDIN.noecho(&:gets).chomp
+  bcrypt_password = BCrypt::Password.create(password)
+  conf = CONFIG
+  if conf[:users].nil?
+    conf.merge!({:users => {username => bcrypt_password}})
+  else
+    conf[:users].merge!({username => bcrypt_password})
+  end
+  File.open("_config.yml", 'w') { |f| YAML.dump(conf, f) }
+  File.open("_config.yml", 'a') { |f| f.write(comment_wall) }
+  puts "\nNew user added."
+end

data/_config.yml

@@ -0,0 +1,28 @@
+---
+connection: "sqlite://blog.db"
+approve_by_default: false
+allow_anonymous_post: false
+timestamp_format: "%d/%m/%Y - %H:%M"
+allow_cors: false
+cors_origin: "*"
+:users:
+#
+##connection : database connection url to be passed to sequel's connect method.
+##check http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html
+##all adapters supported by sequel can be used
+#
+##approve_by_default : set to true to allow all coments to be posted without moderation.
+#
+##allow_anonymous_post : set to true to allow comments without a name.
+#
+##timestamp_format : datetime format to be passed to strftime.
+##see availabe options here http://ruby-doc.org/core-2.2.1/Time.html#method-i-strftime
+#
+##allow_cors : set to true to enable cross-origin resource sharing.
+#
+##cors_origin : see available formats here https://github.com/cyu/rack-cors
+#
+##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/bin/ec

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+#encoding: utf-8
+require 'fileutils'
+
+local_path = File.expand_path("../../", __FILE__)
+users_path = Dir.pwd
+
+files  = %w(ec.rb dashboard.rb config.ru _config.yml Rakefile Gemfile)
+
+def copy_files(local_path, users_path, files, dev=false)
+  files.each do |filename|
+    FileUtils.cp_r local_path + '/' + filename, users_path, :verbose => true
+  end
+  FileUtils.cp_r local_path + "/lib", users_path, :verbose => true
+  FileUtils.cp_r local_path + "/public", users_path, :verbose => true
+  FileUtils.cp_r local_path + "/views", users_path, :verbose => true
+  if dev
+     FileUtils.cp_r local_path + "/spec", users_path, :verbose => true
+     FileUtils.cp_r local_path + '/.rspec', users_path, :verbose => true
+  end
+end
+
+if ARGV[0] == 'install'
+  if ARGV[1] == '--dev'
+    copy_files(local_path, users_path, files, true)
+  else
+    copy_files(local_path, users_path, files)
+  end
+  puts "done!"
+elsif ARGV[0] == 'update'
+  files.delete("_config.yml")
+  files.delete("Gemfile")
+  if ARGV[1] == '--dev'
+    copy_files(local_path, users_path, files, true)
+  else
+    copy_files(local_path, users_path, files)
+  end
+  puts "done!"
+end
+
+if ARGV[0] == '--help' || ARGV[0] == '-h' || ARGV[0].nil?
+  puts 'ec install, copies all the required files in the current directory.'
+  puts 'ec update, same as install but skips _config.yml and Gemfile.'
+  puts 'pass the --dev flag to "ec install" or "ec update" to also copy the test suite.'
+end

data/config.ru

@@ -0,0 +1,12 @@
+require './ec'
+require './dashboard'
+
+run Rack::Builder.new {
+  map "/" do
+    run EC.new
+  end
+
+  map "/dashboard" do
+    run ECDashboard.new
+  end
+}

data/dashboard.rb

@@ -0,0 +1,57 @@
+require_relative "lib/easycomments.rb"
+require_relative "lib/easycomments/ec_dashboard_model.rb"
+
+class ECDashboard < Sinatra::Application
+
+  include ECDashboardModel
+  
+  before do
+    content_type 'application/json'
+  end
+
+  get "/" do
+    content_type 'text/html'
+    send_file 'views/index.html'
+  end
+
+  post '/login' do
+    authenticate(params[:username], params[:password])
+  end
+
+  get "/comments" do
+    get_comments(params[:post])
+  end
+
+  get '/get_all_posts' do
+    get_all_posts
+  end
+
+  post '/edit_comment' do
+    edit_comment(params[:id], params[:new_body])
+  end
+
+  post '/remove_comment' do
+    remove_comment(params[:id])
+  end
+
+  post '/change_approval_status' do
+   comment_change_approval(params[:id])
+  end
+
+  get '/get_total_pending' do
+    get_total_pending
+  end
+
+  get '/get_posts_with_pending' do
+    get_posts_with_pending
+  end
+
+  get '/get_pending_comments' do
+    get_pending_comments(params[:post])
+  end
+
+  post '/ignore_comment' do
+    ignore_comment(params[:id])
+  end
+
+end

data/easycomments.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = 'easycomments'
+  s.version     = '1.0.1'
+  s.date        = '2015-03-30'
+  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
+for posting and retrieving comments.It also comes bundled with a dashboard
+for moderating your comments.
+EOF
+
+  s.files       = `git ls-files`.split("\n")
+  s.executables << 'ec'
+
+  s.add_development_dependency 'airborne', '~> 0.1', '>=0.1.15'
+  s.add_development_dependency "rake", '~> 10.4', '>= 10.4.2'
+
+  s.authors = ["Zisis Maras"]
+  s.email = 'zisismaras@gmail.com'
+  s.homepage = 'https://github.com/zisismaras/easycomments'
+  s.license = 'MIT'
+end

data/ec.rb

@@ -0,0 +1,43 @@
+require_relative "lib/easycomments.rb"
+require_relative "lib/easycomments/ec_model.rb"
+
+class EC < Sinatra::Application
+
+  include ECModel
+
+  before do
+    content_type 'application/json'
+  end
+
+  if ALLOW_CORS
+    use Rack::Cors do
+      allow do
+        origins CORS_ORIGIN
+        resource '/comments', :headers => :any, :methods => :get
+        resource '/comment', :headers => :any, :methods => :post
+      end
+    end
+    use Rack::Protection::FrameOptions
+    use Rack::Protection::PathTraversal
+    use Rack::Protection::IPSpoofing
+  else
+    use Rack::Protection::FrameOptions
+    use Rack::Protection::PathTraversal
+    use Rack::Protection::IPSpoofing  
+    use Rack::Protection::HttpOrigin
+  end
+
+
+  get "/comments" do
+    get_comments(params[:post])
+  end
+
+  post "/comment" do
+    post_comment(params)
+  end
+
+  get "/" do
+    redirect "/dashboard"
+  end
+  
+end

data/lib/easycomments/ec_configuration.rb

@@ -0,0 +1,42 @@
+require 'yaml'
+
+module Configuration
+  
+  extend self
+  
+  CONFIG = YAML.load_file('_config.yml')
+  CONNECTION = CONFIG["connection"]
+  APPROVE_BY_DEFAULT = CONFIG["approve_by_default"]
+  ALLOW_ANONYMOUS_POST = CONFIG["allow_anonymous_post"]
+  TIMESTAMP_FORMAT = CONFIG["timestamp_format"]
+  USERNAME = CONFIG["username"]
+  PASSWORD = CONFIG["password"]
+  ALLOW_CORS = CONFIG["allow_cors"]
+  CORS_ORIGIN = CONFIG["cors_origin"]
+
+#wall of help text to be added in _config.yml
+  def comment_wall
+comments = <<COMMENTS
+#
+##connection : database connection url to be passed to sequel's connect method.
+##check http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html
+##all adapters supported by sequel can be used
+#
+##approve_by_default : set to true to allow all coments to be posted without moderation.
+#
+##allow_anonymous_post : set to true to allow comments without a name.
+#
+##timestamp_format : datetime format to be passed to strftime.
+##see availabe options here http://ruby-doc.org/core-2.2.1/Time.html#method-i-strftime
+#
+##allow_cors : set to true to enable cross-origin resource sharing.
+#
+##cors_origin : see available formats here https://github.com/cyu/rack-cors
+#
+##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.
+#
+COMMENTS
+  end
+end

data/lib/easycomments/ec_dashboard_model.rb

@@ -0,0 +1,70 @@
+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
+    comments = comments.each{|comment| comment[:timestamp] = comment[:timestamp].strftime(TIMESTAMP_FORMAT)}
+    MultiJson.dump({:comments => comments})
+  end
+
+  def get_all_posts
+   MultiJson.dump({:posts => DB[:comments].map(:post).uniq})
+  end
+
+  def edit_comment(id, new_body)
+    DB[:comments].where(:id => id).update(:body => new_body, :action_taken => true)
+    MultiJson.dump({:status => "Comment successfully edited."})
+  end
+
+  def remove_comment(id)
+    DB[:comments].where(:id => id).delete
+    MultiJson.dump({:status => "Comment successfully removed."})
+  end
+
+  def comment_change_approval(id)
+    comment = DB[:comments].where(:id => id).all.first
+    DB[:comments].where(:id => id).update(:approved => !comment[:approved], :action_taken => true)
+    MultiJson.dump({:status => "Approval status successfully changed."})
+  end
+
+  def get_total_pending
+    pending = DB[:comments].where(:action_taken => false).all.count
+    MultiJson.dump({:pending => pending})
+  end
+
+  def get_posts_with_pending
+    pending =[]
+    posts = DB[:comments].where(:action_taken => false).map(:post).uniq
+    posts.each do |post|
+      pending.push({:post  => post, :pending => DB[:comments].where(:post => post, :action_taken => false).count})
+    end
+    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
+    comments = comments.each{|comment| comment[:timestamp] = comment[:timestamp].strftime(TIMESTAMP_FORMAT)}
+    MultiJson.dump({:comments => comments})
+  end
+
+  def ignore_comment(id)
+    comment = DB[:comments].where(:id => id).all.first
+    DB[:comments].where(:id => id).update(:action_taken => true)
+    MultiJson.dump({:status => "Comment successfully ignored."})
+  end
+
+  def authenticate(username, password)
+    access = {}
+    CONFIG[:users].each_pair do |u, p|
+      if username == u && BCrypt::Password.new(p) == password
+        access = {:has_access => true}
+      else
+        access = {:has_access => false}
+      end
+    end
+    MultiJson.dump(access)
+  end
+
+end

data/lib/easycomments/ec_model.rb

@@ -0,0 +1,47 @@
+require_relative "../easycomments.rb"
+
+module ECModel
+  
+  extend self
+
+  def post_comment(comment)
+    if comment[:body] != "undefined" && comment[:body] != ""
+      if ALLOW_ANONYMOUS_POST
+        comment[:name] = "Anonymous" if comment[:name] == "undefined" || comment[:name]  == ""
+        comment[:email] = "no_email" if comment[:email] == "undefined" || comment[:email]  == ""
+        save_comment(comment)
+      elsif comment[:name] == "Anonymous" || comment[:name] == "undefined" || comment[:name]  == ""
+        MultiJson.dump({:status => "Error : no name provided."})
+      else
+        save_comment(comment)
+      end
+    else
+     MultiJson.dump({:status => "Error : no comment provided."})
+    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})
+  end
+
+  private
+  def escape_comment(comment)
+    comment[:name] = Rack::Utils.escape_html(comment[:name])
+    comment[:email] = Rack::Utils.escape_html(comment[:email])
+    comment[:body] = Rack::Utils.escape_html(comment[:body])
+    comment
+  end
+
+  def save_comment(comment)
+    comment = escape_comment(comment)
+    DB[:comments].insert(:post => comment[:post],
+                    :name => comment[:name],
+                    :email => comment[:email],
+                    :body => comment[:body],
+                    :timestamp => Time.now
+                    )   
+    MultiJson.dump({:status => "New comment posted."})
+  end
+end

data/lib/easycomments.rb

@@ -0,0 +1,14 @@
+require "sinatra/base"
+require "multi_json"
+require "sequel"
+require 'rack/cors'
+require 'rack/utils'
+require 'rack/protection'
+require 'bcrypt'
+require_relative "easycomments/ec_configuration.rb"
+
+VERSION = "1.0.1"
+
+include Configuration
+
+DB = Sequel.connect(CONNECTION)

data/public/bower.json

@@ -0,0 +1,32 @@
+{
+  "name": "easycomments_dashboard",
+  "version": "1.0.0",
+  "authors": [
+    "Zisis Maras <zisismaras@gmail.com>"
+  ],
+  "main": "index.html",
+  "license": "MIT",
+  "ignore": [
+    "**/.*",
+    "node_modules",
+    "bower_components",
+    "test",
+    "tests"
+  ],
+  "dependencies": {
+    "polymer": "Polymer/polymer#~0.5.5",
+    "paper-shadow": "Polymer/paper-shadow#~0.5.5",
+    "font-roboto": "Polymer/font-roboto#~0.5.5",
+    "paper-button": "Polymer/paper-button#~0.5.5",
+    "paper-input": "Polymer/paper-input#~0.5.5",
+    "core-scaffold": "Polymer/core-scaffold#~0.5.5",
+    "core-menu": "Polymer/core-menu#~0.5.5",
+    "core-item": "Polymer/core-item#~0.5.5",
+    "core-header-panel": "Polymer/core-header-panel#~0.5.5",
+    "core-ajax": "polymer/core-ajax#~0.5.5",
+    "paper-toast": "polymer/paper-toast#~0.5.5",
+    "paper-toggle-button": "polymer/paper-toggle-button#~0.5.5",
+    "paper-tabs": "polymer/paper-tabs#~0.5.5",
+    "core-pages": "polymer/core-pages#~0.5.5"
+  }
+}

data/public/bower_components/core-a11y-keys/.bower.json

@@ -0,0 +1,28 @@
+{
+  "name": "core-a11y-keys",
+  "private": true,
+  "dependencies": {
+    "polymer": "Polymer/polymer#^0.5"
+  },
+  "devDependencies": {
+    "web-component-tester": "Polymer/web-component-tester#^1"
+  },
+  "ignore": [
+    "**/.*",
+    "node_modules",
+    "bower_components",
+    "test",
+    "tests"
+  ],
+  "version": "0.5.5",
+  "homepage": "https://github.com/Polymer/core-a11y-keys",
+  "_release": "0.5.5",
+  "_resolution": {
+    "type": "version",
+    "tag": "0.5.5",
+    "commit": "bb806f0d130c1e276f97b1ddef83400a828c17be"
+  },
+  "_source": "git://github.com/Polymer/core-a11y-keys.git",
+  "_target": "^0.5",
+  "_originalSource": "Polymer/core-a11y-keys"
+}

data/public/bower_components/core-a11y-keys/README.md

@@ -0,0 +1,4 @@
+core-a11y-keys
+==============
+
+See the [component page](http://polymer-project.org/docs/elements/core-elements.html#core-a11y-keys) for more information.

data/public/bower_components/core-a11y-keys/bower.json

@@ -0,0 +1,18 @@
+{
+  "name": "core-a11y-keys",
+  "private": true,
+  "dependencies": {
+    "polymer": "Polymer/polymer#^0.5"
+  },
+  "devDependencies": {
+    "web-component-tester": "Polymer/web-component-tester#^1"
+  },
+  "ignore": [
+    "**/.*",
+    "node_modules",
+    "bower_components",
+    "test",
+    "tests"
+  ],
+  "version": "0.5.5"
+}