cachai 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d0befb3a839b4323421a53cd76689d3b17f631c
+  data.tar.gz: 53f40303c117b425d195244f8b1fe541125dd505
+SHA512:
+  metadata.gz: 58bb54f64b485bf09c84db2afc4663640edb5e7e934508f377afe7c3bcecacff9ff9914e418bcb900fed6cafe07954bf57418964e6e0a723320151750bccc768
+  data.tar.gz: bd4b23febe2c4e8c36b061aaa5f3d939287f335461b6b35d5ab7ca2055f2e681a1719b050a7ab41ebbe939a3787104b10b7a362a13890d46bce5420669cf64f6

data/.gitignore

@@ -0,0 +1 @@
+db/*.sqlite3

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    cachai (0.0.1)
+      rake
+      sinatra
+      sinatra-activerecord
+      sqlite3
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+    activerecord (4.2.1)
+      activemodel (= 4.2.1)
+      activesupport (= 4.2.1)
+      arel (~> 6.0)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.0)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.7.0)
+    rack (1.6.1)
+    rack-protection (1.5.3)
+      rack
+    rake (10.4.2)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.3)
+    sinatra (1.4.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    sinatra-activerecord (2.0.6)
+      activerecord (>= 3.2)
+      sinatra (~> 1.0)
+    sqlite3 (1.3.10)
+    thread_safe (0.3.5)
+    tilt (2.0.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  cachai!
+  rspec (~> 2.6)

data/Procfile

@@ -0,0 +1,2 @@
+# web: bundle exec ruby ./app.rb -p 4567
+web: bundle exec puma -p 4567

data/README.md

@@ -0,0 +1,26 @@
+# Commentary
+
+Add comments to your blog.
+
+## 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:
+
+```
+name: Blog
+domain: blog.sdqali.in
+```
+
+* 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.
+
+```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>
+
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/cachai.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "cachai"
+  spec.version       = '0.0.1'
+  spec.authors       = ["Tomás Pollak"]
+  spec.email         = ["tomas@forkhq.com"]
+  spec.description   = %q{Middleware for embedabble comments.}
+  spec.summary       = %q{Middleware for embedabble comments.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", "~> 2.6"
+
+  spec.add_dependency "sinatra"
+  spec.add_dependency "sinatra-activerecord"
+  spec.add_dependency "sqlite3"
+  spec.add_dependency "rake"
+end

data/db/schema.rb

@@ -0,0 +1,25 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20130901232253) do
+  create_table "comments", force: true do |t|
+    t.string   "author_name", :null => false
+    t.string   "author_email", :null => false
+    t.string   "author_url"
+    t.text     "content", :null => false
+    t.text     "path", :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index :comments, :path
+end

data/lib/akismet.rb

@@ -0,0 +1,154 @@
+require 'net/http'
+require 'uri'
+require 'set'
+
+class Akismet
+
+	attr_accessor :options, :valid_responses, :normal_responses, :standard_headers, :host, :port
+
+	HOST             = 'rest.akismet.com'
+	PORT             = 80
+	TIMEOUT_THRESHOLD = 10
+	VALID_RESPONSES  = Set.new(['false', ''])
+	NORMAL_RESPONSES = VALID_RESPONSES.dup << 'true'
+	STANDARD_HEADERS = {
+		'User-Agent'   => "Akismet Checker",
+		'Content-Type' => 'application/x-www-form-urlencoded'
+	}
+
+	# Create a new instance of the Akismet class
+	#
+	# ==== Arguments
+	# Arguments are provided in the form of a Hash with the following keys
+	# (as Symbols) available:
+	#
+	# +api_key+::    your Akismet API key
+	# +blog+::       the blog associated with your api key
+	#
+	# The following keys are available and are entirely optional. They are
+	# available incase communication with Akismet's servers requires a
+	# proxy port and/or host:
+	#
+	# * +proxy_port+
+	# * +proxy_host+
+	def initialize(options)
+		@options = options
+		self.verified_key = false
+	end
+
+	# Returns +true+ if the API key has been verified, +false+ otherwise
+	def verified?
+		(@verified_key ||= verify_api_key) != :false
+	end
+
+	def invalid_options?
+		false
+	end
+
+	def check_comment(options={})
+		return false if invalid_options?
+		message = call_akismet('comment-check', options)
+		{:spam => !VALID_RESPONSES.include?(message), :message => message}
+	end
+
+	def spam?(options = {})
+		if resp = check_comment(options)
+			return resp[:spam]
+		end
+		false
+	end
+
+	# This call is for submitting comments that weren't marked as spam but
+	# should have been (i.e. false negatives). It takes identical arguments as
+	# +check_comment+.
+	def mark_as_spam(options={})
+		return false if invalid_options?
+		{:message => call_akismet('submit-spam', options)}
+	end
+
+	# This call is intended for the marking of false positives, things that
+	# were incorrectly marked as spam. It takes identical arguments as
+	# +check_comment+ and +mark_as_spam+.
+	def mark_as_ham(options={})
+		return false if invalid_options?
+		{:message => call_akismet('submit-ham', options)}
+	end
+
+	# Returns the URL for an Akismet request
+	#
+	# ==== Arguments
+	# +action+ <~to_s>:: a valid Akismet function name
+	#
+	# ==== Returns
+	# String
+	def self.url(action)
+		"/1.1/#{action}"
+	end
+
+	protected
+		# Internal call to Akismet. Prepares the data for posting to the Akismet
+		# service.
+		#
+		# ==== Arguments
+		# +akismet_function+ <String>::
+		#   the Akismet function that should be called
+		#
+		# The following keys are available to configure a given call to Akismet:
+		#
+		# +user_ip+ (*required*)::
+		#   IP address of the comment submitter.
+		# +user_agent+ (*required*)::
+		#   user agent information.
+		# +referrer+ (<i>note spelling</i>)::
+		#   the content of the HTTP_REFERER header should be sent here.
+		# +permalink+::
+		#   the permanent location of the entry the comment was submitted to.
+		# +comment_type+::
+		#   may be blank, comment, trackback, pingback, or a made up value like
+		#   "registration".
+		# +comment_author+::
+		#   submitted name with the comment
+		# +comment_author_email+::
+		#   submitted email address
+		# +comment_author_url+::
+		#   commenter URL
+		# +comment_content+::
+		#   the content that was submitted
+		def call_akismet(akismet_function, options={})
+			http_post http_instance, akismet_function, options.update(:blog => options[:blog])
+		end
+
+		# Call to check and verify your API key. You may then call the
+		# <tt>verified?</tt> method to see if your key has been validated
+		def verify_api_key
+			return :false if invalid_options?
+			value = http_post http_instance, 'verify-key', :key  => options[:api_key], :blog => options[:blog]
+			self.verified_key = (value == "valid") ? true : :false
+		end
+
+		def http_post(http, action, options = {})
+			params = options.map{ |key, val| "#{key}=#{URI.encode(val || '')}"}.join('&')
+			resp = http.post(self.url(action), params, STANDARD_HEADERS)
+			log_request(self.url(action), params, resp)
+			resp.body
+		end
+
+		def url(action)
+			"/1.1/#{action}"
+		end
+
+	private
+
+	def log_request(url, data, resp)
+		#
+	end
+
+	attr_accessor :verified_key
+
+	def http_instance
+		http = Net::HTTP.new([options[:api_key], HOST].join("."), options[:proxy_host], options[:proxy_port])
+		http.read_timeout = http.open_timeout = TIMEOUT_THRESHOLD
+		http
+	end
+
+end

data/lib/cachai.rb

@@ -0,0 +1,134 @@
+require 'sinatra/base'
+require 'json'
+require 'rake'
+require_relative 'comment'
+require_relative 'akismet'
+
+module Cachai
+
+  class Middleware < Sinatra::Base
+
+    # set :database_file, "config/database.yml"
+    # set :public_folder, File.join(settings.root, 'public')
+    # set :protection, true
+    use ActiveRecord::ConnectionAdapters::ConnectionManagement
+
+    def initialize(app, opts = nil)
+      opts = opts || {}
+      @domain = opts.delete(:domain) or raise 'Domain required.'
+
+      load_schema unless schema_loaded?
+
+      if key = opts.delete(:akismet_key)
+        @akismet = Akismet.new(:api_key => key, :blog => "http://#{@domain}")
+      else
+        puts "No Akismet key found! Will not check comments for spam."
+      end
+
+      super(app)
+    end
+
+    get '/comments.?:format?' do
+      check_domain!(params[:domain])
+
+      # puts "Comments for: #{params[:domain]}#{params[:path]}"
+      list = get_comments(params[:path])
+
+      if params[:callback]
+        content_type 'application/javascript'
+        "#{params[:callback]}(#{list.to_json});"
+      else
+        json(list)
+      end
+    end
+
+    post '/comments.?:format?' do
+
+      begin
+        data = JSON.parse(request.body.read)
+        check_domain!(data['domain'])
+
+        headers['Access-Control-Allow-Origin'] = data['protocol'] + '//' + data['domain']
+
+        permalink = 'http://' + data['domain'] + data['path']
+        halt(400, "No spam allowed") if is_spam?(data, permalink, request)
+
+        attrs = {
+          :path         => data['path'],
+          :content      => data['content'],
+          :author_name  => data['author_name'],
+          :author_email => data['author_email'],
+          :author_url   => data['author_url']
+        }
+
+        comment = Comment.create!(attrs)
+        json({ :status => 'ok', :comment => comment })
+
+      rescue JSON::ParserError
+        status 400 and json({ :error => 'Invalid JSON.' })
+      rescue ActiveRecord::RecordInvalid => e
+        status 422 and json({ :error => e.message })
+      end
+    end
+
+    private
+
+    def load_schema
+      require 'sinatra/activerecord/rake'
+      # Rake::Task['db:schema:load'].invoke
+      require_relative '../db/schema.rb'
+    end
+
+    def schema_loaded?
+      Comment.first
+      true
+    rescue ActiveRecord::StatementInvalid => e
+      # SQLite3::SQLException => e 
+      # return !e.message['no such table']
+      false
+    end
+
+    def check_domain!(domain)
+      halt(400, 'Invalid domain.') unless domain == @domain
+    end
+
+    def not_found(message = nil)
+      halt(404, message || 'Not found.')
+    end
+
+    def json(obj)
+      content_type 'application/json'
+      obj.to_json
+    end
+
+    def get_comments(document_path)
+      Comment.where({ :path => document_path })
+    end
+
+    def is_spam?(data, link, request)
+      return false unless @akismet
+      # return true if blacklisted?(name, email, content)
+
+      comment = {
+        :user_ip    => request.ip,
+        :referrer   => request.referrer,
+        :user_agent => request.user_agent,
+        :permalink  => link,
+        :comment_type    => 'comment',
+        :comment_content => data['content'],
+        :comment_author  => data['author_name'],
+        :comment_author_url   => data['author_url'],
+        :comment_author_email => data['author_email']
+      }
+
+      if resp = @akismet.check_comment(comment)
+        # puts resp.inspect
+        return resp[:spam]
+      end
+
+      false
+    end
+
+  end
+
+end

data/lib/comment.rb

@@ -0,0 +1,33 @@
+require 'sinatra/activerecord'
+require 'digest/md5'
+require 'sqlite3'
+require_relative 'time_ago'
+
+ENV_NAME = ENV['RACK_ENV'] || 'development'
+
+module Cachai
+  class Comment < ActiveRecord::Base
+
+    validates_presence_of :author_name, :author_name, :author_email, :content, :path
+
+    def as_json(options = {})
+      {
+        :id           => id,
+        :author_name  => author_name,
+        # :author_email => author_email,
+        :author_img   => author_img,
+        :author_url   => author_url,
+        :content      => content,
+        :timestamp    => created_at.to_i,
+        # :created_at   => created_at,
+        :created_ago  => Timeago.since(created_at)
+      }
+    end
+
+    def author_img(size = 50)
+      id = Digest::MD5::hexdigest(author_email.strip.downcase)
+      "https://www.gravatar.com/avatar/#{id}.jpg?s=#{size}"
+    end
+
+  end
+end

data/lib/time_ago.rb

@@ -0,0 +1,31 @@
+module Timeago
+
+  def self.in_words(time)
+    minutes = (((Time.now - time).abs)/60).round
+    return nil if minutes < 0
+
+    case minutes
+      when 0..1            then 'less than a minute'
+      when 2..4            then 'less than 5 minutes'
+      when 5..14           then 'less than 15 minutes'
+      when 15..29          then "half an hour"
+      when 30..59          then "#{minutes} minutes"
+      when 60..119         then '1 hour'
+      when 120..239        then '2 hours'
+      when 240..479        then '4 hours'
+      when 480..719        then '8 hours'
+      when 720..1439       then '12 hours'
+      when 1440..11519     then "#{(minutes/1440).floor} days"
+      when 11520..43199    then "#{(minutes/11520).floor} weeks"
+      when 43200..525599   then "#{(minutes/43200).floor} months"
+      else                      "#{(minutes/525600).floor} years"
+    end
+  end
+
+  def self.since(time)
+    if str = in_words(time)
+      "#{str} ago"
+    end
+  end
+
+end

data/test/app_test.rb

@@ -0,0 +1,114 @@
+ENV["RACK_ENV"] = "test"
+
+require "rubygems"
+require "test/unit"
+require "json"
+require "rack"
+require "rack/test"
+require_relative "../app"
+
+class AppTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+  def app
+    Sinatra::Application
+  end
+
+  def teardown
+    Comment.delete_all
+    Site.delete_all
+  end
+
+  def test_knows_how_to_retrieve_comments
+    blog = Site.create!({
+                          :name => "Blog",
+                          :domain => "blog.example.com"
+                        })
+    4.times do
+      Comment.create!({:nickname => "foo",
+                        :content => "Test comment",
+                        :document_path => "about/us",
+                        :site_id => blog.id})
+    end
+
+    get "/comments.json", {:domain => "blog.example.com", :document_path => "about/us"}
+    assert last_response.ok?
+    output = JSON.parse(last_response.body)
+    assert_equal 4, output.size
+    assert_equal "foo", output.first["nickname"]
+    assert_equal "Test comment", output.first["content"]
+  end
+
+  def test_responds_with_422_if_domain_not_specified
+    get "/comments.json", {:document_path => "about/us"}
+    assert_equal 422, last_response.status
+    assert_match "The domain and document_path must be specified", last_response.body
+  end
+
+  def test_responds_with_422_if_document_path_not_specified
+    get "/comments.json", {:domain => "example.com"}
+    assert_equal 422, last_response.status
+    assert_match "The domain and document_path must be specified", last_response.body
+  end
+
+  def test_know_how_to_add_comment
+    blog = Site.create!({
+                          :name => "Blog",
+                          :domain => "blog.example.com"
+                        })
+    request_body = {
+      :nickname => "foo",
+      :content => "Test comment",
+      :domain => "blog.example.com",
+      :document_path => "about/us"
+    }.to_json
+    post "/comments.json", request_body
+    assert_equal 201, last_response.status
+    assert_equal 1, Comment.all.size
+  end
+
+  def test_does_not_create_comment_if_params_not_sent
+    post "/comments.json"
+    assert_equal 422, last_response.status
+    assert_match "The JSON provided is not valid.", last_response.body
+    assert_equal 0, Comment.all.size
+  end
+
+  def test_does_not_create_comment_if_not_valid_data
+    blog = Site.create!({
+                          :name => "Blog",
+                          :domain => "blog.example.com"
+                        })
+
+    request_body = {
+      :content => "Test comment",
+      :document_path => "about/us",
+      :nickname => "foo",
+      :domain => "foo.example.com"
+    }.to_json
+    post "/comments.json", request_body
+    assert_equal 422, last_response.status
+    assert_match "The Site provided is not valid.", last_response.body
+    assert_equal 0, Comment.all.size
+  end
+
+  def test_serves_static_files
+    get "/commentary.js"
+    assert last_response.ok?
+  end
+
+  def test_ensure_correct_content_type
+    post "/comments.json", {:foo => :bar}
+    assert_equal "application/json", last_response.headers["Content-Type"]
+  end
+
+  def test_ensure_correct_content_type
+    get "/comments.json", {:foo => :bar}
+  end
+
+  def test_renders_comment_frame_as_a_template_with_values
+    get "/comment_frame", {:domain => "foo", :document_path => "/bar"}
+    assert_match /domain: \"foo\"/, last_response.body
+    assert_match /documentPath: \"\/bar\"/, last_response.body
+    assert_equal "*", last_response.headers["Access-Control-Allow-Origin"]
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: cachai
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tomás Pollak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Middleware for embedabble comments.
+email:
+- tomas@forkhq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Procfile
+- README.md
+- Rakefile
+- cachai.gemspec
+- db/schema.rb
+- lib/akismet.rb
+- lib/cachai.rb
+- lib/comment.rb
+- lib/time_ago.rb
+- test/app_test.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Middleware for embedabble comments.
+test_files:
+- test/app_test.rb
+has_rdoc: