favourite_object 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be831745b5092ec4f8c355d5e637656cb1d16def
+  data.tar.gz: 55696b4717f9caaee905b90062ebf8e01641f104
+SHA512:
+  metadata.gz: 99499bd287e53784e804e0a9bcb70403f1d94da25c27375a270ed6e9fe5490aa716722b0267bf39fe756ba5f777acd237356cacada8d22cb855f4ac6284afdce
+  data.tar.gz: 3ae5df1b77729e04a95e1fc3d6410d78ab6b32d2fe52a019dc1bbecdcd3d1ee81f7e97c73d78bd5ba7c27015742e39c4cf0487025a59b1d93052c7c896b85517

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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.rdoc

@@ -0,0 +1,23 @@
+= Favourite Object
+A dropin utility that adds favourites functionality to any rails application. But simpling include a partial you can add a favourite button to any object.
+
+
+Install: 
+```
+gem 'favourite_object'
+rails g favourite_object:install
+rake db:migrate
+```
+
+For every object you want to be favouritable
+- Generates a favourite_object/#{name.underscore}/message.html.erb file which is used to display the description of an object
+```
+rails g favourite_object:template ObjectName
+```
+
+
+Favourite button(pass the object to be favourited and the user object)
+```
+<%= render :partial => 'favourite_object/favourites/favourite_icon', 
+	:locals => {:object => object, :owner => @user}%>
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler"
+require 'rake'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+def cmd(command)
+  puts command
+  raise unless system command
+end
+
+# Import all our rake tasks
+FileList['lib/tasks/**/*.rake'].each { |task| import task }

data/app/assets/javascripts/favourite_object/favourites.js

@@ -0,0 +1,33 @@
+$( document ).ready(function() {
+	$('.favourite_object_container .icon').click(function() {
+		element = $(this)
+		target_type = element.attr('-data-target-type');
+		target_id = element.attr('-data-target-id');
+		user_status = element.attr('-data-user-status');
+		third_party_flag = element.attr('-data-third-party');
+		params = element.attr('-data-params');
+
+		if(user_status == 'true'){
+			$.ajax({
+			    type: "PUT",
+			    url: '/favourite_object/favourites/'+ target_type +'/' + target_id + '/toggle' ,
+			    data: {"target_type": target_type, 
+			    	"target_id": target_id, "third_party_flag": third_party_flag, "params": params}
+			}).done(function(response){
+				if (response['favourite']['is_favourited'] == true){
+					element.addClass( "active" );
+					element.parent().parent().find('#favourited_text').addClass('active');
+					element.parent().parent().find('#unfavourited_text').removeClass('active');
+				}else{
+					element.removeClass( "active" );
+					element.parent().parent().find('#unfavourited_text').addClass('active');
+					element.parent().parent().find('#favourited_text').removeClass('active');
+				}
+			}).fail(function(){
+				console.log("failed");
+			});
+		}else{
+			alert("Please login to favourite");
+		}
+	});
+});

data/app/assets/stylesheets/favourite_object_stylesheet.css

@@ -0,0 +1,47 @@
+.favourite_object_container{
+	display: inline-block;
+}
+
+.favourite_object_container .icon{
+	/*default state*/
+	background: url('favourite_default.png');
+	height: 24px;
+	width: 24px;
+	display: block;
+	cursor: pointer;
+}
+.favourite_object_container .icon_container{
+	display: inline-block;
+}
+.favourite_object_container .text_container{
+	display: inline-block;
+	vertical-align: top;
+	padding-top:3px;
+	margin-right: 3px;
+}
+.favourite_object_container #favourited_text, .favourite_object_container #unfavourited_text{
+	display: none;
+}
+.favourite_object_container .text_container .active{
+	display: inline !important;
+}
+.favourite_object_container .icon.active{
+	/*favourited state*/
+	background: url('favourite_active.png');
+	display: block;
+}
+
+.favourite_object_container .hide{
+	display:none;
+}
+.favourite_object_container .icon:before
+{ 
+	position: relative;
+	left: -74px;
+	top: 3px;
+/*	content:"Favourite";
+*/}
+.favourite_object_container .icon.active:before
+{ 
+/*	content:"Favourited";
+*/}

data/app/controllers/favourite_object/base_favourites_controller.rb

@@ -0,0 +1,90 @@
+class FavouriteObject::BaseFavouritesController < ApplicationController
+
+	before_filter :authenticate!
+	#remove before commiting
+	skip_before_filter :verify_authenticity_token  
+
+	def index
+		#only return is_favourited = true                                              
+		@favourites = FavouriteObject::Favourite.for_owner(@user)
+													  .where(is_favourited: true)
+		                                              .order("created_at DESC")
+		                                              .page(params[:page]).per(params[:per_page])
+		                                              
+		@favourites = @favourites.with_type(params[:type]) if params[:type]
+
+		respond_to do |format|
+		  format.html
+		  format.json {render :json => @favourites, meta: { pagination: { per_page: @favourites.limit_value, total_pages: @favourites.total_pages, total_objects: @favourites.total_count } }}
+		end
+	end
+
+	def query
+		if params[:third_party_flag] == 'true' || params[:third_party_flag] == '1'	
+			@favourite = FavouriteObject::Favourite.where(owner: @user, third_party_id: params[:target_id], 
+				third_party_type: params[:target_type], third_party_flag: true).first_or_initialize
+		else
+			@favourite = FavouriteObject::Favourite.where(owner: @user, target_id: params[:target_id], 
+				target_type: params[:target_type]).first_or_initialize
+		end	
+
+		if @favourite.is_favourited == false
+			@favourite = {} 
+			@favourite[:favourite] = nil 
+		end
+
+		render :json => @favourite, root: 'favourite'
+	end
+
+	def update
+		#endpoint for favouriting an object
+		if params[:third_party_flag] == 'true' || params[:third_party_flag] == '1'	
+			favourite = FavouriteObject::Favourite.where(owner: @user, third_party_id: params[:target_id], 
+				third_party_type: params[:target_type], third_party_flag: true).first_or_initialize
+		else
+			favourite = FavouriteObject::Favourite.where(owner: @user, target_id: params[:target_id], 
+				target_type: params[:target_type]).first_or_initialize
+		end	
+
+		# favourite.params = params[:data] if params[:data]
+		favourite.params = params[:data] if params[:data]
+		favourite.params[:description] = params[:description] if params[:description]
+
+		if params[:favourite] == 'true' || params[:favourite] == '1'
+			favourite.is_favourited = true
+			favourite.save
+		else
+			favourite.is_favourited = false
+			favourite.destroy
+			favourite = {} 
+			favourite[:favourite] = nil 
+		end
+
+
+		render :json => favourite, root: 'favourite'
+	end
+
+	def toggle
+		# toggle for web interface 
+		# DOES NOT ACCOUNT FOR THIRDPARTY FAVOURITES YET
+		if params[:third_party_flag] == 'true' || params[:third_party_flag] == '1'	
+			favourite = FavouriteObject::Favourite.where(owner: @user, third_party_id: params[:target_id], 
+				third_party_type: params[:target_type], third_party_flag: true).first_or_initialize
+			favourite.params = eval(params[:params]) if params[:params]
+		else
+			favourite = FavouriteObject::Favourite.where(owner: @user, target_id: params[:target_id], 
+				target_type: params[:target_type]).first_or_initialize
+		end	
+		favourite.toggle
+		
+		render :json => favourite, root: 'favourite'
+	end
+
+	private 
+
+	def authenticate!
+		#fix before commiting
+	  method(FavouriteObject.authentication_method).call
+	  @user = method(FavouriteObject.current_user_method).call
+	end
+end

data/app/controllers/favourite_object/favourites_controller.rb

@@ -0,0 +1,3 @@
+class FavouriteObject::FavouritesController < FavouriteObject::BaseFavouritesController 
+
+end

data/app/models/favourite_object/favourite.rb

@@ -0,0 +1,73 @@
+module FavouriteObject
+  class Favourite < ActiveRecord::Base
+    self.table_name = "favourite_object_favourites"
+
+    belongs_to :target, polymorphic: true
+    belongs_to :owner, polymorphic: true
+
+    # Params for creating the notification message.
+    serialize :params, Hash
+
+    mattr_accessor :views
+    @@views = {
+      message: {
+        template_path: Proc.new {|n| "favourite_object/#{n.target_type.underscore}/message" }
+      }
+    }
+
+    if ActiveRecord::VERSION::MAJOR < 4
+      attr_accessible :target, :owner
+    end
+
+    def self.for_owner(owner)
+    	where(owner_id: owner.id)
+    	.where(owner_type: owner.class.base_class)
+    end
+
+    def message
+      ActionView::Base.new(
+             Rails.configuration.paths["app/views"]).render(
+             :template => self.class.views[:message][:template_path].call(self), :formats => [:html], 
+             :locals => {object: self.target }, :layout => false)
+    end
+
+    #toggles the is_favourited status
+    def toggle
+    	if is_favourited
+    		self.is_favourited = false
+    	else
+    		self.is_favourited = true
+    	end
+    	self.save
+    end
+
+    def favourite
+    	self.is_favourited = true
+    	self.save
+    end
+
+    def un_favourite
+    	self.is_favourited = false
+    	self.save
+    end
+
+    def self.is_favourited?(owner, target_id, target_type, third_party_flag=false)
+        if third_party_flag 
+            favourite = FavouriteObject::Favourite.where(owner: owner, third_party_id: target_id.to_s,
+                            third_party_type: target_type).first
+        else
+            favourite = FavouriteObject::Favourite.where(owner: owner, target_id: target_id,
+                            target_type: target_type).first
+        end
+
+        return false if favourite.blank? || favourite.is_favourited == false
+
+        return true
+    end    
+
+    def self.with_type(type)
+        where('target_type = ?', type)
+    end
+
+  end
+end

data/app/serializer/favourite_object/favourite_serializer.rb

@@ -0,0 +1,44 @@
+class FavouriteObject::FavouriteSerializer < ActiveModel::Serializer
+  root :favourites
+
+  attributes :id, :target_id, :target_type, :is_favourited, :description, :third_party_flag, :data
+  embed :ids, :include => true
+  has_one :target, polymorphic: true
+
+  def include_target?
+    (self.object.third_party_flag != true)
+  end
+
+  def description
+  	if self.object.third_party_flag == true
+  		self.object.params[:description]
+  	else
+  		self.object.message
+  	end 
+  end
+
+  def data
+  	if self.object.third_party_flag == true
+  		self.object.params
+  	else
+  		[]
+  	end 
+  end
+
+  def target_id
+  	if self.object.third_party_flag == true
+  		self.object.third_party_id
+  	else
+  		self.object.target_id
+  	end
+  end
+
+  def target_type
+  	if self.object.third_party_flag == true
+  		self.object.third_party_type
+  	else
+  		self.object.target_type
+  	end
+  end
+
+end

data/app/views/favourite_object/favourites/_favourite_icon.html.erb

@@ -0,0 +1,25 @@
+<%
+	if defined?(third_party).nil?
+		third_party_flag = false
+	else
+		third_party_flag = third_party
+	end
+	user = method(FavouriteObject.current_user_method).call
+	status = FavouriteObject::Favourite.is_favourited?(user, object.id, object.class.name, third_party_flag) unless user.nil?
+
+	#defaults
+	@favourited_text = "Favourited" if defined?(favourited_text).nil? 
+	@unfavourited_text = "Favourite" if defined?(unfavourited_text).nil? 
+%>
+
+<div class="favourite_object_container">
+	<div class="text_container">
+		<span id="favourited_text" class=" <%= 'active' if status%>"><%= @favourited_text || favourited_text %></span>
+		<span id="unfavourited_text" class=" <%= 'active' unless status%>"><%= @unfavourited_text || unfavourited_text%></span>
+	</div>
+	<div class="icon_container">
+		<span class="icon <%= 'active' if status%>" 
+		-data-target-type="<%= object.class %>" -data-params="<%= params %>" -data-target-id="<%= object.id %>" -data-third-party="<%= third_party_flag.to_s%>" -data-user-status="<%= user ? 'true' : 'false' %>"></span>
+	</div>
+
+</div>

data/app/views/favourite_object/favourites/index.html.erb

@@ -0,0 +1,5 @@
+Favourites List
+
+<% @favourites.each do |favourite| %>
+	<%= favourite.target_type %> - <%= favourite.target_id%>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,8 @@
+Rails.application.routes.draw do
+	namespace :favourite_object do
+	  resources :favourites, only: [:index]
+	  get 'favourites/:target_type/:target_id' => 'favourites#query'
+	  put 'favourites/:target_type/:target_id' => 'favourites#update'
+	  put 'favourites/:target_type/:target_id/toggle' => 'favourites#toggle'
+	end
+end

data/lib/favourite_object/engine.rb

@@ -0,0 +1,11 @@
+module FavouriteObject
+  class Engine < ::Rails::Engine
+  	config.generators do |g|
+  	  g.test_framework      :rspec,        :fixture => false
+  	  g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+  	  g.assets false
+  	  g.helper false
+  	end
+  	
+  end
+end

data/lib/favourite_object/version.rb

@@ -0,0 +1,3 @@
+module FavouriteObject
+  VERSION = "0.0.1"
+end

data/lib/favourite_object.rb

@@ -0,0 +1,18 @@
+require "favourite_object/engine"
+require "kaminari"
+require "active_model_serializers"
+
+
+module FavouriteObject
+
+	mattr_accessor :authentication_method
+	@@authentication_method = nil
+
+	mattr_accessor :current_user_method
+	@@current_user_method = nil
+
+	# Used to set up FavouriteObject from the initializer.
+	def self.setup
+	  yield self
+	end
+end

data/lib/generators/favourite_object/install/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Creates a migration to set up the favourites table.
+
+Example:
+    rails generate favourite_object:install
+

data/lib/generators/favourite_object/install/install_generator.rb

@@ -0,0 +1,53 @@
+require 'rails/generators/active_record'
+
+class FavouriteObject::InstallGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_migrations
+    copy_migration "create_favourite_object_favourites"
+
+    puts "Installation successful. You can now run:"
+    puts "rake db:migrate"
+  end
+
+  def copy_initializer
+    template "initializer.rb", "config/initializers/favourite_object.rb"
+  end
+
+  def append_stylesheet
+    insert_into_file "app/assets/stylesheets/application.css", :before => "*/" do
+      "\n *= require 'favourite_object/stylesheet'\n\n"
+    end
+  end
+
+  def append_javascript
+    insert_into_file "app/assets/javascripts/application.js", :after => %r{//= require +['"]?jquery['"]?} do
+      "\n//= require 'favourite_object/favourites'\n\n"
+    end
+  end
+
+  # This is defined in ActiveRecord::Generators::Base, but that inherits from NamedBase, so it expects a name argument
+  # which we don't want here. So we redefine it here. Yuck.
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S%L")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+
+
+  protected
+
+    def copy_migration(filename)
+      if self.class.migration_exists?("db/migrate", "#{filename}")
+        say_status("skipped", "Migration #{filename}.rb already exists")
+      else
+        migration_template "#{filename}.rb", "db/migrate/#{filename}.rb"
+      end
+    end
+
+end

data/lib/generators/favourite_object/install/templates/create_favourite_object_favourites.rb

@@ -0,0 +1,16 @@
+class CreateFavouriteObjectFavourites < ActiveRecord::Migration
+  def change
+    create_table :favourite_object_favourites do |t|
+      t.integer :target_id
+      t.string :target_type
+      t.string :third_party_id
+      t.string :third_party_type
+      t.integer :owner_id
+      t.string :owner_type
+      t.boolean :is_favourited, default: false
+      t.text :params
+      t.boolean :third_party_flag, default: false
+      t.timestamps
+    end
+  end
+end

data/lib/generators/favourite_object/install/templates/initializer.rb

@@ -0,0 +1,9 @@
+FavouriteObject.setup do |config|
+
+  # NotifyUser will call this within NotificationsController to ensure the user is authenticated.
+  config.authentication_method = :authenticate_user!
+
+  # NotifyUser will call this within NotificationsController to return the current logged in user.
+  config.current_user_method = :current_user
+
+end

data/lib/generators/favourite_object/template/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Generates the template files for the favourite message. 
+
+Example:
+    rails generate favourite_object:template Post Page Category
+

data/lib/generators/favourite_object/template/template_generator.rb

@@ -0,0 +1,16 @@
+module FavouriteObject
+  class TemplateGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+    argument :addition_classes, :type => :array, :default => []
+
+    def generate_templates
+      # generate template files for name
+      template "message.html.erb.erb", "app/views/favourite_object/#{name.underscore}/message.html.erb"
+
+      addition_classes.each do |class_name|
+        #iterates through each additional class and generates template files
+        template "message.html.erb.erb", "app/views/favourite_object/#{class_name.underscore}/message.html.erb"
+      end 
+    end
+  end
+end

data/lib/tasks/favourite_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :favourite do
+#   # Task goes here
+# end

data/lib/tasks/test.rake

@@ -0,0 +1,7 @@
+desc "Creates a test rails app for the specs to run against"
+task :setup do
+  system("mkdir spec/dummy") unless File.exists?("spec/dummy")
+  create_dummy = "bundle exec rails new #{ENV['RAILS_ROOT']} -m spec/support/rails_template.rb --skip-bundle"
+  puts "Running '#{create_dummy}'"
+  system(create_dummy)
+end

data/spec/controllers/favourite_object/favourites_controller_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+
+describe FavouriteObject::FavouritesController do
+
+	let(:user) { User.create({email: "user@example.com" })}
+	let(:arbitrary_object) { ArbitraryObject.create() }
+
+	before :each do
+	  FavouriteObject::FavouritesController.any_instance.stub(:current_user).and_return(user)
+	  FavouriteObject::FavouritesController.any_instance.stub(:authenticate_user!).and_return(true)
+	  FavouriteObject::Favourite.any_instance.stub(:message).and_return("Mr. Blobby")
+
+	end
+
+  	describe "listing favourites" do
+  		let(:favourite) { FavouriteObject::Favourite.create(owner: user, target: arbitrary_object) }
+
+  		before :each do
+  			favourite.is_favourited = true
+  			favourite.save
+  		end
+
+  		it "displays favourites as json" do
+  			get :index, format: :json
+  			response.body.should have_json_path "favourites/0/id"
+  		end
+
+  		it "displays favourites filtered by type" do
+  			get :index, format: :json, type: "ArbitraryObject"
+  			response.body.should have_json_path "favourites/0/id"
+  			expect(json(response.body)["favourites"].length).to eq 1
+  		end
+
+  		it "displays favourites web template" do
+  			get :index
+  		end
+	end
+
+	describe "unfavouriting an object" do
+		it "returns null if favourited is equal to false" do
+			put :update, target_type: arbitrary_object.class, target_id: arbitrary_object.id
+			expect(json(response.body)["favourite"]).to eq nil
+		end
+
+		it "if already exists exists and is_favourited is set to false the object gets deleted" do
+			favourite_object = FavouriteObject::Favourite.create(owner: user, target: arbitrary_object)
+			favourite_object.is_favourited = true
+			favourite_object.save
+
+			put :update, target_type: arbitrary_object.class.name, target_id: arbitrary_object.id, favourite: false
+
+			expect(json(response.body)["favourite"]).to eq nil
+
+		end
+	end
+
+	describe "favourite a third_party object" do
+		it "assigns third_party values" do
+			put :update, target_type: "RandomClass", target_id: "object_1", third_party_flag: 'true', favourite: 'true'
+
+			favourite = FavouriteObject::Favourite.last
+			favourite.third_party_flag.should eq true
+			favourite.third_party_id.should eq "object_1"
+			favourite.third_party_type.should eq "RandomClass"
+		end
+	end
+end