like 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 155b369ed874cd99a36550bd59743e5dff9244e3
-  data.tar.gz: 9bf44af699eee62027b0e36f9dabea7f68e337b2
+  metadata.gz: a1d364ddeb1931ffe4576c08d28fd330297b3c67
+  data.tar.gz: 2032192d22e7955be1c55d118c40b8ac70ffda6b
 SHA512:
-  metadata.gz: 35faff491ee821bf3c0255e236613a8904ca5e816371775316af688bbc27621d15d33e3fb951297e8b359ee44e16fbf6dad1ac620e26cd6aec9cce7aca0c8e5e
-  data.tar.gz: a2a78b255a646c9cbb75317e5eabeb58694ab6464c25162911b51aed56f647c9b94702aad300ced1c700a492d8fa7764843a85daea4fa2dff426bcaf096c87a9
+  metadata.gz: dfd5b75bde0e112a63f8aec7b9e944e79823d78c2ed235a20ec45abc91e7c0dda7d8faa5271f256ef7997b8af85539ffe84608672315cebbc7d0f4cd327c401e
+  data.tar.gz: e3ef5b7a09397c11d5d15b4ae9d18a09f075d5579590a7c87f93e37056e120a38a0d328744eb72bf488c218859d7e2cf4efcb8e3e1bf2e58436ba7fbd1cf5bde

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+notifications:
+  campfire:
+    rooms:
+      - secure: "QZhh0pcYx9OCxAxQMMl411Wa/F98oXGCv/z4VwoEHjXIWaFyt3nL1cha1NFd4Kw2b9+z81q90lLvSWjcZkL9/EUoOZpDNw6KhFQ4Y4B2UwYSHzFRSFDMc7RcpJf7fXbEuXA1k8nZ5yd77eoJro0U6UyPou0V2xWr9WETx5v4Llc="
+    on_success: change
+    on_failure: change

data/README.md

@@ -6,7 +6,7 @@ A simple Rails engine for liking ActiveRecord objects.
 
 Add this line to your application's Gemfile:
 
-    gem 'like', '0.1.0'
+    gem 'like', '0.2.0'
 
 Don't forget to bundle:
 
@@ -28,20 +28,35 @@ All you need to do to use this engine is have something like the following in yo
 <% end %>
 ```
 
-And then, probably in an initializer, tell Like how to determine who the currently signed in user is, along with any filters you wish the underlying controller to implement:
+And mount the necessary routes (which are already namespaced under `/like`):
 
 ```ruby
-Like.controllers[:user]   = lambda { |controller|
-  controller.current_user
-}
-Like.controllers[:filter] = lambda { |controller|
-  controller.authenticate_user!
-}
+Rails.application.routes.draw do
+  # ...
+  mount Like::Engine => '/'
+  # ...
+end
 ```
 
-The above example is exactly what you'd need if you're using Devise with a User model.
+By default, Like presumes the object that the like is created by (the liker) is available through the `current_user` method in a standard controller inheriting from ApplicationController.
 
-Of course, you probably want to know how many likes an object has:
+If you wish to customise this, you'll need to subclass from Like::Interaction and override the `liker` method. The same goes for adding in methods to be called as part of a before filter. Here's an implementation that's Devise-friendly:
+
+```ruby
+Like.interaction_class = Class.new(Like::Interaction) do
+  def pre_action
+    controller.authenticate_user!
+  end
+
+  private
+
+  def liker
+    controller.current_user
+  end
+end
+```
+
+At some point, you'll probably want to know how many likes an object has:
 
 ```ruby
 Like::Like.with_likeable(article).count
@@ -55,6 +70,42 @@ Like::Like.with_liker(user).count
 
 Like doesn't care if your user model is called something else - it's a polymorphic association under the hood, so anything is accepted as the 'liker'. The same applies for 'likeable' as well.
 
+## Usage as an API
+
+Like comes with an optional API you can mount instead of the standard ActionController controller. You'll need to add Grape (0.5 or newer) to your Gemfile as well, and then the API can be mounted wherever you like. There's simple POST and DELETE endpoints at the root of the API, and they accept two parameters following ActiveRecord polymorphic defaults: likeable_type and likeable_id.
+
+```ruby
+Rails.application.routes.draw do
+  # mounting the following:
+  mount Like::API => '/api/likes'
+  # adds to endpoints:
+  #   POST   /api/likes
+  #   DELETE /api/likes
+
+  # ...
+end
+```
+
+You'll want to tweak the interaction class so the post_action returns something useful (instead of the default redirect, which is meaningless in the API context), and ensure the liker is set as well. Here's an example (again, it's Devise-friendly):
+
+```ruby
+Like.interaction_class = Class.new(Like::Interaction) do
+  def pre_action
+    error!('403 Forbidden', 403) unless liker
+  end
+
+  def post_action
+    {'status' => 'OK'}
+  end
+
+  private
+
+  def liker
+    env['warden'].authenticated?(:user) ? env['warden'].user(:user) : nil
+  end
+end
+```
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,6 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/app/controllers/like/likes_controller.rb

@@ -1,29 +1,19 @@
-class Like::LikesController < ActionController::Base
-  before_filter :like_filters
+class Like::LikesController < ApplicationController
+  before_filter { interaction.pre_action }
 
   def create
-    Like::Like.like user, likeable
-
-    redirect_to :back
+    interaction.create
+    interaction.post_action
   end
 
   def destroy
-    Like::Like.unlike user, likeable
-
-    redirect_to :back
+    interaction.destroy
+    interaction.post_action
   end
 
   private
 
-  def like_filters
-    Like.controllers[:filter].call self
-  end
-
-  def likeable
-    likeable = params[:likeable_type].constantize.find params[:likeable_id]
-  end
-
-  def user
-    Like.controllers[:user].call self
+  def interaction
+    @interaction ||= Like.interaction_class.new self
   end
 end

data/app/helpers/like/likes_helper.rb

@@ -1,10 +1,10 @@
 module Like::LikesHelper
   def like_path_for(likeable)
-    like_likes_path likeable_to_params(likeable)
+    like.like_likes_path likeable_to_params(likeable)
   end
 
   def like_url_for(likeable)
-    like_likes_url likeable_to_params(likeable)
+    like.like_likes_url likeable_to_params(likeable)
   end
 
   def likeable_to_params(likeable)

data/config/routes.rb

@@ -1,4 +1,4 @@
-Rails.application.routes.draw do
+Like::Engine.routes.draw do
   namespace :like do
     post   'likes', to: 'likes#create', as: :likes
     delete 'likes', to: 'likes#destroy'

data/lib/like.rb

@@ -1,12 +1,11 @@
 require 'rails'
 
 module Like
-  def self.controllers
-    @controllers ||= {
-      user:   lambda { |controller| controller.current_user },
-      filter: lambda { |controller| true }
-    }
-  end
+  mattr_accessor :interaction_class
 end
 
 require 'like/engine'
+require 'like/interaction'
+require 'like/api' if defined?(Grape)
+
+Like.interaction_class = Like::Interaction

data/lib/like/api.rb

@@ -0,0 +1,23 @@
+class Like::API < Grape::API
+  format :json
+
+  helpers do
+    def interaction
+      @interaction = Like.interaction_class.new self
+    end
+  end
+
+  before do
+    interaction.pre_action
+  end
+
+  post do
+    interaction.create
+    interaction.post_action
+  end
+
+  delete do
+    interaction.destroy
+    interaction.post_action
+  end
+end

data/lib/like/interaction.rb

@@ -0,0 +1,34 @@
+class Like::Interaction
+  def initialize(controller)
+    @controller = controller
+  end
+
+  def create
+    Like::Like.like liker, likeable
+  end
+
+  def destroy
+    Like::Like.unlike liker, likeable
+  end
+
+  def post_action
+    controller.redirect_to :back
+  end
+
+  def pre_action
+    #
+  end
+
+  private
+
+  attr_reader :controller
+  delegate :params, to: :controller
+
+  def likeable
+    @likeable ||= params[:likeable_type].constantize.find params[:likeable_id]
+  end
+
+  def liker
+    controller.current_user
+  end
+end

data/like.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = 'like'
-  spec.version       = '0.1.0'
+  spec.version       = '0.2.0'
   spec.authors       = ['Pat Allan']
   spec.email         = ['pat@freelancing-gods.com']
   spec.summary       = %q{Rails Engine for liking}
@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'capybara',    '~> 2.2.0'
   spec.add_development_dependency 'combustion',  '~> 0.5.1'
   spec.add_development_dependency 'devise',      '~> 3.2.2'
+  spec.add_development_dependency 'grape',       '~> 0.5'
+  spec.add_development_dependency 'mime-types',  '~> 1.16'
   spec.add_development_dependency 'rspec-rails', '~> 2.14.0'
   spec.add_development_dependency 'sqlite3',     '~> 1.3.8'
 end

data/spec/acceptance/liking_spec.rb

@@ -17,7 +17,12 @@ describe 'Liking an object' do
   end
 
   it "saves the like through a web request" do
-    Like.controllers[:user] = lambda { |controller| user }
+    user
+    Like.interaction_class = Class.new(Like::Interaction) do
+      def liker
+        User.first
+      end
+    end
 
     post '/like/likes', {likeable_type: 'Article', likeable_id: article.id},
       {'HTTP_REFERER' => '/'}

data/spec/acceptance/liking_with_api_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe 'Liking an object' do
+  let(:user)    { User.create! email: 'pat@test.com', password: 'password',
+    password_confirmation: 'password' }
+  let(:article) { Article.create! }
+
+  before :each do
+    user
+
+    Like.interaction_class = Class.new(Like::Interaction) do
+      def post_action
+        {'status' => 'OK'}
+      end
+
+      private
+
+      def liker
+        User.first
+      end
+    end
+  end
+
+  it "saves the like" do
+    post '/api/likes', likeable_type: 'Article', likeable_id: article.id
+
+    likes = Like::Like.where(
+      liker_type:    'User',    liker_id:    user.id,
+      likeable_type: 'Article', likeable_id: article.id
+    )
+
+    expect(likes.count).to eq(1)
+  end
+
+  it "can delete the like" do
+    post   '/api/likes', likeable_type: 'Article', likeable_id: article.id
+    delete '/api/likes', likeable_type: 'Article', likeable_id: article.id
+
+    likes = Like::Like.where(
+      liker_type:    'User',    liker_id:    user.id,
+      likeable_type: 'Article', likeable_id: article.id
+    )
+
+    expect(likes.count).to eq(0)
+  end
+end

data/spec/acceptance/liking_with_devise_spec.rb

@@ -6,10 +6,17 @@ describe 'Liking an object' do
   let(:article) { Article.create! }
 
   before :each do
-    Like.controllers[:user]   = lambda { |controller| controller.current_user }
-    Like.controllers[:filter] = lambda { |controller|
-      controller.authenticate_user!
-    }
+    Like.interaction_class = Class.new(Like::Interaction) do
+      def pre_action
+        controller.authenticate_user!
+      end
+
+      private
+
+      def liker
+        controller.current_user
+      end
+    end
   end
 
   context 'authenticated' do

data/spec/internal/config/routes.rb

@@ -3,5 +3,8 @@ Rails.application.routes.draw do
 
   resources :articles
 
+  mount Like::Engine => '/'
+  mount Like::API    => '/api/likes'
+
   root to: 'articles#index'
 end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'bundler'
 Bundler.setup :default, :development
 
 require 'combustion'
+require 'grape'
 require 'like'
 require 'devise'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: like
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-17 00:00:00.000000000 Z
+date: 2013-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,6 +66,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.2
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -113,9 +142,12 @@ files:
 - config/routes.rb
 - db/migrate/1_create_likes.rb
 - lib/like.rb
+- lib/like/api.rb
 - lib/like/engine.rb
+- lib/like/interaction.rb
 - like.gemspec
 - spec/acceptance/liking_spec.rb
+- spec/acceptance/liking_with_api_spec.rb
 - spec/acceptance/liking_with_devise_spec.rb
 - spec/internal/app/controllers/application_controller.rb
 - spec/internal/app/controllers/articles_controller.rb
@@ -156,6 +188,7 @@ specification_version: 4
 summary: Rails Engine for liking
 test_files:
 - spec/acceptance/liking_spec.rb
+- spec/acceptance/liking_with_api_spec.rb
 - spec/acceptance/liking_with_devise_spec.rb
 - spec/internal/app/controllers/application_controller.rb
 - spec/internal/app/controllers/articles_controller.rb