easycomments 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a75da80c881fc020f2f5bb5aadb4a2402669e9bf
-  data.tar.gz: 17b46c901e56b0f9d950b746c807858d18f0c56c
+  metadata.gz: 6c4e7fb9a16243a48eee3be7cc2437dd33d4a262
+  data.tar.gz: d0835f6862727a41b739466ef5509b2d576184e0
 SHA512:
-  metadata.gz: 79d4b7adc8a9148d2874fb0abf00cd6d2af6ceaa937230df218d38f4a997837b97a9a50a61c9ed6ac5c0397133abc8dc7a819709ed0f5de4337afaebb8d01351
-  data.tar.gz: 54a4acaea68bc66e7ce58521e3a49c495bba55414e994b95a2009c3b9a652fa0758cc95dc37da024ddde2896c322403614af1c346e068a32d92791fa676cdf4a
+  metadata.gz: 2b0e68bea14ead823241412ef0d364f10b833f6b62f75609d9f657df6b7fd9fd80da52c7e963502adadc8d25f933c74802fb78ce1b8070a60f3af65a336e17be
+  data.tar.gz: 20aa83d33f54d3b1bc8646f2188e167867a1f574561e39033ea65a454a77d1aac3148e584801d6209ae45553e65385a5c43b053ef88f2bfd691105d6eb99bba2

data/.gitignore

@@ -1 +1,2 @@
-Gemfile.lock
+Gemfile.lock
+blog.db

data/Gemfile

@@ -7,8 +7,3 @@ gem 'rack-contrib'
 gem 'sequel'
 gem 'rack-cors'
 gem 'bcrypt'
-
-group :test, :development do
-  gem 'sqlite3'
-  gem 'airborne'
-end

data/Gemfile.dev

@@ -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/README.md

@@ -1,4 +1,6 @@
 # EasyComments
+[![Gem Version](https://badge.fury.io/rb/easycomments.svg)](http://badge.fury.io/rb/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.
@@ -12,8 +14,12 @@ 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)
-
+(pass the --dev flag if you also want the spec suite)  
+Then
+```ruby
+bundle install
+```
+and you are ready.
 ##Configuring
 Edit _config.yml and add your database (all adapters supported by sequel can be used)
 and change any other option you need.
@@ -67,7 +73,10 @@ timestamp_format: "%d/%m/%Y - %H:%M"
 allow_cors: false
 
 #see available formats here https://github.com/cyu/rack-cors
-cors_origin: "*"
+cors_origin: "*"  
+
+#set to false to not automatically escape html in comment bodys  
+auto_escape_html: true
 ```
 
 ## Updating
@@ -81,6 +90,11 @@ It will recopy all the files but keeps your _config.yml and Gemfile.
 'rake adduser' you should always run this and not adding new users in _config.yml  
 by hand since it also bcypts your passwords!
 
+##TODO:
+* pagination in GET /comments  
+* markdown support  
+* dynamic fields in POST /comment  
+
 ## Contributing
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/_config.yml

@@ -3,8 +3,9 @@ connection: "sqlite://blog.db"
 approve_by_default: false
 allow_anonymous_post: false
 timestamp_format: "%d/%m/%Y - %H:%M"
-allow_cors: false
+allow_cors: true
 cors_origin: "*"
+auto_escape_html: true
 :users:
 #
 ##connection : database connection url to be passed to sequel's connect method.
@@ -22,6 +23,8 @@ cors_origin: "*"
 #
 ##cors_origin : see available formats here https://github.com/cyu/rack-cors
 #
+##auto_escape_html : automatically escape html in comment bodys
+#
 ##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

@@ -5,7 +5,7 @@ require 'fileutils'
 local_path = File.expand_path("../../", __FILE__)
 users_path = Dir.pwd
 
-files  = %w(ec.rb dashboard.rb config.ru _config.yml Rakefile Gemfile)
+files  = %w(ec.rb dashboard.rb config.ru _config.yml Rakefile Gemfile README.md LICENSE)
 
 def copy_files(local_path, users_path, files, dev=false)
   files.each do |filename|
@@ -17,6 +17,9 @@ def copy_files(local_path, users_path, files, dev=false)
   if dev
      FileUtils.cp_r local_path + "/spec", users_path, :verbose => true
      FileUtils.cp_r local_path + '/.rspec', users_path, :verbose => true
+     if ARGV[0] == 'install'
+       FileUtils.cp_r local_path + '/Gemfile.dev', users_path + "/Gemfile", :verbose => true
+     end
   end
 end
 
@@ -36,10 +39,10 @@ elsif ARGV[0] == 'update'
     copy_files(local_path, users_path, files)
   end
   puts "done!"
-end
-
-if ARGV[0] == '--help' || ARGV[0] == '-h' || ARGV[0].nil?
+elsif 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.'
+else
+  puts "Uknown command : #{ARGV[0]}, see ec --help for available commands."
 end

data/easycomments.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'easycomments'
-  s.version     = '1.0.1'
+  s.version     = '1.0.2'
   s.date        = '2015-03-30'
   s.summary     = "Simple and easy to use comment system"
   s.description = <<EOF
@@ -12,9 +12,6 @@ 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'

data/lib/easycomments/ec_configuration.rb

@@ -13,6 +13,7 @@ module Configuration
   PASSWORD = CONFIG["password"]
   ALLOW_CORS = CONFIG["allow_cors"]
   CORS_ORIGIN = CONFIG["cors_origin"]
+  AUTO_ESCAPE_HTML = CONFIG["auto_escape_html"]
 
 #wall of help text to be added in _config.yml
   def comment_wall
@@ -33,6 +34,8 @@ comments = <<COMMENTS
 #
 ##cors_origin : see available formats here https://github.com/cyu/rack-cors
 #
+##auto_escape_html : automatically escape html in comment bodys
+#
 ##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/lib/easycomments/ec_model.rb

@@ -35,7 +35,7 @@ module ECModel
   end
 
   def save_comment(comment)
-    comment = escape_comment(comment)
+    comment = escape_comment(comment) if AUTO_ESCAPE_HTML
     DB[:comments].insert(:post => comment[:post],
                     :name => comment[:name],
                     :email => comment[:email],

data/lib/easycomments.rb

@@ -7,7 +7,7 @@ require 'rack/protection'
 require 'bcrypt'
 require_relative "easycomments/ec_configuration.rb"
 
-VERSION = "1.0.1"
+VERSION = "1.0.2"
 
 include Configuration
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easycomments
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Zisis Maras
@@ -9,47 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2015-03-30 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: airborne
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.15
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.15
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 10.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 10.4.2
+dependencies: []
 description: |
   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
@@ -63,6 +23,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
+- Gemfile.dev
 - LICENSE
 - README.md
 - Rakefile