cachai 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a68c5c6afde964d4ecd799d7c2e705cde5d95807
-  data.tar.gz: 10102a0163b14777843eeb6c31a8e5feaa81dff7
+  metadata.gz: f79e9baf1b4289c37e88e4208c5fa4ac903b5cf9
+  data.tar.gz: b91b0e7f759f7d6c2c95ec5b7ef70a77fecc0a00
 SHA512:
-  metadata.gz: 5d177b7ac254f245304d90ef4ace65ea8c80f18107e7c6e6442f9fd88b45e1ca81eef82fb5a8bc2629e67c3d02afbbfaf2cf26abbac5082319ac593ab39f89c8
-  data.tar.gz: 0dbba4a304b01779cbfd9d27d97c0e1f147dde0cb1f98b1dd5253a7491ff2cfe5e3c9a6f19891ef6d2007a6259372a4c30e604ab95814c16c42219bccea5ec94
+  metadata.gz: d8a52ba8af374c0c7f0b3811214963b1ae46e43f6885da2070a15059e184b117110c939ce236b7be92cd65a6b870f87f3bf185d080868f0db408c82299bc4e5f
+  data.tar.gz: 9b3576d707f7d9f1120886fecc20b963b918e8d4b64abc822157a039a43a3ffc349f17ea1434a14fc981f0f5d59e8601b1bf374e0ead3dd153fb24f37e7ab7dc

data/.gitignore

@@ -1 +1,2 @@
 db/*.sqlite3
+pkg

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.0.5'
+  spec.version       = '0.0.7'
   spec.authors       = ["Tomás Pollak"]
   spec.email         = ["tomas@forkhq.com"]
   spec.description   = %q{Middleware for embedabble comments.}
@@ -19,10 +19,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "rack-test"
 
   spec.add_dependency "redis"
   spec.add_dependency "sinatra"
   spec.add_dependency "sinatra-activerecord"
   spec.add_dependency "sqlite3"
   spec.add_dependency "rake"
+  spec.add_dependency "sendgrid-ruby"
 end

data/db/schema.rb

@@ -26,7 +26,7 @@ ActiveRecord::Schema.define(version: 20130901232253) do
     t.string   "author_url"
     t.string   "author_ip", :length => 15
     t.text     "content", :null => false
-    t.integer  "parent_id"
+    t.integer  "parent_id", :default => 0
     t.integer  "approved", :default => 1, :length => 1, :null => false
     t.datetime "created_at"
     t.datetime "updated_at"

data/lib/cachai.rb

@@ -1,7 +1,7 @@
 require 'sinatra/base'
+require 'sendgrid-ruby'
 require 'redis'
 require 'json'
-require 'rake'
 
 require_relative 'models'
 require_relative 'akismet'
@@ -19,21 +19,28 @@ module Cachai
     # use Rack::Static, :urls => %w(/css /img /js /favicon.ico), :root => 'public'
     use ActiveRecord::ConnectionAdapters::ConnectionManagement
 
+    CACHE_MINUTES = 10 * 60 # 10 minutes
+
     def initialize(app, opts = nil)
       opts = opts || {}
-      @domain = opts.delete(:domain) or raise 'Domain required.'
+      domain     = opts.delete(:domain) or raise 'Domain required.'
+      redis_host = opts.delete(:redis_host) || 'localhost'
 
+      Cachai.domain = domain
+      Cachai.cache = Redis.new(:host => redis_host)
       Cachai.load_db!
 
-      redis_host = opts.delete(:redis_host) || 'localhost'
-      @redis = Redis.new(:host => redis_host)
-
       if key = opts.delete(:akismet_key)
-        @akismet = Akismet.new(:api_key => key, :blog => "http://#{@domain}")
+        @akismet = Akismet.new(:api_key => key, :blog => "http://#{domain}")
       else
         puts "No Akismet key found! Will not check comments for spam."
       end
 
+      if sendgrid_opts = opts.delete(:sendgrid)
+        @sendgrid  = SendGrid::Client.new(sendgrid_opts)
+        @recipient = opts.delete(:recipient) or raise "No recipient set!"
+      end
+
       super(app)
     end
 
@@ -48,16 +55,14 @@ module Cachai
     get '/comments.?:format?' do
       check_domain!(params[:domain])
 
-      @redis.del(redis_key(params[:path])) if params[:nocache]
-
       # puts "Comments for: #{params[:domain]}#{params[:path]}"
-      json_list = get_comments(params[:path])
+      json_list = get_comments(params[:path], params[:nocache])
 
       if params[:callback]
         content_type 'application/javascript'
         "#{params[:callback]}(#{json_list});"
       else
-        json(list)
+        json(json_list)
       end
     end
 
@@ -66,8 +71,9 @@ module Cachai
         data = JSON.parse(request.body.read)
         check_domain!(data['domain'])
 
-        headers['Access-Control-Allow-Origin'] = data['protocol'] + '//' + data['domain']
+        halt(400, "Missing params") if data['protocol'].blank? or data['path'].blank?
 
+        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)
 
@@ -76,25 +82,31 @@ module Cachai
           :author_name  => data['author_name'],
           :author_email => data['author_email'],
           :author_url   => data['author_url'],
-          :parent_id    => data['parent_id'],
+          :parent_id    => data['parent_id'].to_i,
           :author_ip    => request.ip
         }
 
         post = Post.find_or_create_by_path(data['path'])
         response = Response.create!(attrs.merge(:post_id => post.id))
+        Cachai.clear_cache(data['path'])
+        notify_new_response(response, data['path'])
 
-        @redis.del(redis_key(data['path']))
         json({ :status => 'ok', :comment => response })
 
       rescue JSON::ParserError
         status 400 and json({ :error => 'Invalid JSON.' })
       rescue ActiveRecord::RecordInvalid => e
         status 422 and json({ :error => e.message })
+      rescue => e
+        puts e.message
+        puts e.backtrace.join("\n")
+        status 500 and "Something went wrong."
       end
     end
 
     private
 
+=begin
     def set_cache(timestamp)
       return if timestamp.nil?
       last_modified timestamp
@@ -105,9 +117,10 @@ module Cachai
       cache_control :public, :no_cache, :no_store, :must_revalidate, :max_age => 0
       # expires 1.year.ago
     end
+=end
 
     def check_domain!(domain)
-      halt(400, 'Invalid domain.') unless domain == @domain
+      halt(400, 'Invalid domain.') unless domain == Cachai.domain
     end
 
     def not_found(message = nil)
@@ -119,9 +132,10 @@ module Cachai
       return obj.is_a?(String) ? obj : obj.to_json
     end
 
-    def get_comments(path)
-      key = redis_key(path)
-      unless json_list = @redis.get(key)
+    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)
@@ -130,9 +144,10 @@ module Cachai
           json_list = '[]'
         end
 
-        @redis.set(key, json_list)
-        @redis.expire(key, 60 * 60) # one hour
+        Cachai.cache.set(key, json_list)
+        Cachai.cache.expire(key, CACHE_MINUTES)
       end
+
       json_list
     end
 
@@ -153,22 +168,18 @@ module Cachai
       result
     end
 
-    def redis_key(path)
-      "comments:#{@domain}:#{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'],
+        :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']
       }
@@ -181,6 +192,20 @@ module Cachai
       false
     end
 
+    def notify_new_response(response, path)
+      mail = SendGrid::Mail.new do |m|
+        m.to       = @recipient
+        m.from     = 'comments@' + Cachai.domain
+        m.reply_to = response.author_email
+        m.subject  = "New comment from #{response.author_name} at #{path}"
+        m.text     = "#{response.content}\n\n--\nhttp://#{Cachai.domain}/#{path}"
+      end
+
+      puts @sendgrid.send(mail)
+    rescue SendGrid::Exception => e
+      puts e.inspect
+    end
+
   end
 
 end

data/lib/models.rb

@@ -22,6 +22,34 @@ module Cachai
     # SQLite3::SQLException => e
     # return !e.message['no such table']
     false
+  rescue ActiveRecord::ConnectionNotEstablished
+    puts "Connection not established."
+    false
+  end
+
+  def self.domain=(value)
+    @domain = value
+  end
+
+  def self.domain
+    @domain
+  end
+
+  def self.cache=(obj)
+    @cache = obj
+  end
+
+  def self.cache
+    @cache
+  end
+
+  def self.clear_cache(path)
+    cache.del(key_for(path))
+  end
+
+  def self.key_for(path)
+    raise "Domain not set!" unless @domain
+    "comments:#{@domain}:#{path}"
   end
 
   class Post < ActiveRecord::Base
@@ -34,11 +62,14 @@ module Cachai
       find_by_path(path) || create({:path => path})
     end
 
+    def clear_cache
+      Cachai.clear_cache(path)
+    end
   end
 
   class Response < ActiveRecord::Base
     belongs_to :post
-    validates_presence_of :author_name, :author_name, :author_email, :content
+    validates_presence_of :author_name, :author_email, :content
 
     scope :approved, lambda { where(:approved => 1) }
     scope :comment, lambda { where(:response_type => 'comment') }

data/spec/get_comments_test.rb

@@ -0,0 +1,206 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'get comments' do
+  include Rack::Test::Methods
+
+  def app
+    TestApp
+  end
+
+  describe 'no domain' do
+
+    it 'returns 400' do
+      get '/comments.json', :path => '/foobar'
+      puts last_response.body
+      last_response.status.should == 400
+    end
+
+  end
+
+  describe 'no path' do
+
+    it 'returns 400' do
+      get '/comments.json', :domain => 'invalid.com'
+      last_response.status.should == 400
+    end
+
+  end
+
+  describe 'existing domain and path' do
+
+    describe 'invalid domain' do
+
+      it 'returns 400' do
+        get '/comments.json', :domain => 'invalid.com'
+        last_response.status.should == 400
+      end
+
+    end
+
+    describe 'valid domain' do
+
+      let(:cache_key) { Cachai.key_for('/blog/post.html') }
+
+      before do
+        Cachai.cache.del(cache_key)
+      end
+
+      describe 'unexisting post' do
+
+        it 'returns 200' do
+          get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html'
+          last_response.status.should == 200
+        end
+
+        it 'returns an empty JSON array' do
+          get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html'
+          last_response.body.should == '[]'
+        end
+
+        it 'does not create a new entry for that post' do
+          expect do
+            get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html'
+          end.not_to change(Cachai::Post, :count)
+        end
+
+      end
+
+      describe 'existing post, no comments' do
+
+        before do
+          Cachai::Post.create(:path => '/blog/post.html')
+          Cachai::Post.count.should == 1
+        end
+
+        it 'returns 200' do
+          get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html'
+          last_response.status.should == 200
+        end
+
+        it 'queries the database' do
+          # ActiveRecord::Base.should_receive(:query)
+          Cachai::Post.should_receive(:find_by_path)
+          get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html'
+        end
+
+        it 'returns an empty JSON array' do
+          get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html'
+          last_response.body.should == '[]'
+        end
+
+      end
+
+      describe 'existing post, with comments' do
+
+        before do
+          Cachai::Post.delete_all
+
+          post = Cachai::Post.create(:path => '/blog/post.html')
+          Cachai::Post.count.should == 1
+
+          post.responses.create({
+            :content => 'Foobar',
+            :author_name => 'Someone',
+            :author_email => 'test@email.com'
+          })
+
+          post.responses.count.should == 1
+        end
+
+        describe 'not in cache' do
+
+          before do
+            Cachai.cache.get(cache_key).should be_nil
+          end
+
+          it 'returns 200' do
+            get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html'
+            last_response.status.should == 200
+          end
+
+          it 'queries the database' do
+            # ActiveRecord::Base.connection.should_receive(:execute)
+            Cachai::Post.should_receive(:find_by_path)
+            get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html'
+          end
+
+          it 'returns an JSON array with comment' do
+            get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html'
+            data = JSON.parse(last_response.body)
+            data.count.should == 1
+          end
+
+          it 'stores data in cache' do
+            Cachai.cache.should_receive(:set)
+            get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html'
+          end
+
+        end
+
+        describe 'in cache' do
+
+          before do
+            Cachai.cache.set(cache_key, 'something')
+            Cachai.cache.get(cache_key).should == 'something'
+          end
+
+          describe 'without nocache param' do
+
+            it 'returns 200' do
+              get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html'
+              last_response.status.should == 200
+            end
+
+            it 'does not query the database' do
+              # ActiveRecord::Base.should_not_receive(:query)
+              Cachai::Post.should_not_receive(:find_by_path)
+              get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html'
+            end
+
+            it 'returns an JSON array with comment' do
+              get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html'
+              last_response.body.should == 'something'
+            end
+
+            it 'does not store data in cache' do
+              Cachai.cache.should_not_receive(:set)
+              get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html'
+            end
+
+          end
+
+          describe 'with nocache=1' do
+
+            it 'returns 200' do
+              get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html', :nocache => 1
+              last_response.status.should == 200
+            end
+
+            it 'queries the database' do
+              # ActiveRecord::Base.should_receive(:query)
+              Cachai::Post.should_receive(:find_by_path)
+              get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html', :nocache => 1
+            end
+
+            it 'returns an JSON array with comment' do
+              get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html', :nocache => 1
+              data = JSON.parse(last_response.body)
+              data.count.should == 1
+            end
+
+            it 'stores data in cache' do
+              Cachai.cache.should_receive(:set)
+              get '/comments.json', :domain => 'domain.com', :path => '/blog/post.html', :nocache => 1
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/post_comments_test.rb

@@ -0,0 +1,135 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'post comment' do
+  include Rack::Test::Methods
+
+  def app
+    TestApp
+  end
+
+  def post_comment(opts = {})
+    data = {
+      :domain       => 'domain.com',
+      :protocol     => 'http',
+      :path         => '/another/blog/post.html',
+      :content      => 'New comment',
+      :author_name  => 'Some author',
+      :author_email => 'test@email.com',
+      :author_url   => 'http://url.com'
+    }.merge(opts)
+    post '/comments.json', data.to_json, { 'CONTENT_TYPE' => 'application/json' }
+  end
+
+  describe 'no domain' do
+
+    it 'returns 400' do
+      post_comment :domain => nil
+      puts last_response.body
+      last_response.status.should == 400
+    end
+
+  end
+
+  describe 'no protocol' do
+
+    it 'returns 400' do
+      post_comment :protocol => nil
+      last_response.status.should == 400
+    end
+
+  end
+
+  describe 'no path' do
+
+    it 'returns 400' do
+      post_comment :path => nil
+      last_response.status.should == 400
+    end
+
+  end
+
+  describe 'existing domain and path' do
+
+    describe 'invalid domain' do
+
+      it 'returns 400' do
+        post_comment :domain => 'invalid.com'
+        last_response.status.should == 400
+      end
+
+    end
+
+    describe 'valid domain' do
+
+      describe 'no author name' do
+
+        it 'returns 422' do
+          post_comment :author_name => nil
+          last_response.status.should == 422
+        end
+
+      end
+
+      describe 'no email' do
+
+        it 'returns 422' do
+          post_comment :author_email => nil
+          last_response.status.should == 422
+        end
+
+      end
+
+      describe 'no content' do
+
+        it 'returns 422' do
+          post_comment :content => nil
+          last_response.status.should == 422
+        end
+
+      end
+
+      describe 'valid data' do
+
+        describe 'unexisting post' do
+
+          before do
+            Cachai::Post.delete_all
+          end
+
+          it 'creates a new entry for that post' do
+            expect do
+              post_comment
+            end.to change(Cachai::Post, :count).by(1)
+          end
+
+          it 'creates a new response for that post' do
+            expect do
+              post_comment
+            end.to change(Cachai::Response, :count).by(1)
+          end
+
+        end
+
+        describe 'existing post' do
+
+          it 'does not create a new post entry' do
+            expect do
+              post_comment
+            end.not_to change(Cachai::Post, :count).by(1)
+          end
+
+          it 'creates a new response for that post' do
+            expect do
+              post_comment
+            end.to change(Cachai::Response, :count).by(1)
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'bundler/setup'
+require 'active_record'
+require 'cachai'
+require 'rack/test'
+
+ActiveRecord::Base.establish_connection(
+  "adapter"  => "sqlite3",
+  "database" => ':memory:'
+)
+
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+# this is done automatically by cachai
+# load File.join(File.dirname(__FILE__), '/../db/schema.rb')
+
+class TestApp < Sinatra::Base
+  use Cachai::Middleware, {
+    :domain    => 'domain.com',
+    :recipient => 'test@example.com',
+    :sendgrid  => {
+      :api_key  => 'test',
+      :api_user => 'test'
+    }
+  }
+  get '/' do
+    'Hello world'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cachai
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Tomás Pollak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2015-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sendgrid-ruby
+  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
@@ -117,7 +145,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - Procfile
 - README.md
 - Rakefile
@@ -127,6 +154,9 @@ files:
 - lib/cachai.rb
 - lib/models.rb
 - lib/time_ago.rb
+- spec/get_comments_test.rb
+- spec/post_comments_test.rb
+- spec/spec_helper.rb
 - test/app_test.rb
 homepage: ''
 licenses:
@@ -148,9 +178,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Middleware for embedabble comments.
 test_files:
+- spec/get_comments_test.rb
+- spec/post_comments_test.rb
+- spec/spec_helper.rb
 - test/app_test.rb
+has_rdoc: 

data/Gemfile.lock

@@ -1,63 +0,0 @@
-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)