rails_rest_vote 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9814a411ccc447f6cf372b2bfa307866f6c289be
+  data.tar.gz: b01bf982e1da607387bcd731a4957178d46c8302
+SHA512:
+  metadata.gz: 3eba662bc0ebc434f8b05ad289b221a988c9ecf803c3c533eafd85e811a03bab0480d2d1b6e603f523069f726d2e13cf4ef89c83fc9eb51404e8cd55802ab7e7
+  data.tar.gz: a9ef13fef6979627e429b919e10d6bc50fca7bd77dbf0f518c29171a13e3fbbc29545f57327a52c4e4fc3cda39321b8b59440f9ab5306eff1d95ad37e7a51fb3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at abhinav.sohani@consultadd.in. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_rest_vote.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 abhinav
+
+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.md

@@ -0,0 +1,129 @@
+# RailsRestVote
+
+Rails Rest Vote is a Ruby Gem which can add voting feature to any model of your rails application and exposes its RESTful APIs.
+
+If you are using any frontend framework like angular2 in your application it is really helpful.
+
+>**DISCLAIMER**
+>
+>Your application user managment table name should be `user`, It is recommended to use [devise gem](https://github.com/plataformatec/devise) for authentication purpose.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_rest_vote'
+```
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails_rest_vote
+
+#### Database Migrations
+
+Run below command in your project folder from terminal.
+
+    $ rails g rails_rest_vote user
+
+It will do three things for you.
+
+- Create a migration file of Vote table in db/migrate/ folder.
+- Insert association in user model i.e has_many :votes
+- Create vote model i.e app/models/vote.rb
+
+After that migrate database by using.
+
+    $ rake db:migrate
+
+Now you are ready to go.
+
+## Usage
+
+Add below line to the model you want to vote or like on
+
+    has_many :votes, :as => :votable
+
+It can be used in two different ways.
+
+1. Use as two buttons one for upvote and other for downvote as in _stackoverflow_.
+
+    ##### APIs
+
+    > /api/votes/up
+    
+    Api is used for upvote on model. user must be signed in for upvoting.
+    ```
+    method: POST 
+body: {"votable_id":"1","votable_type":"Service"}
+content-type: application/json
+response: {"status":200,"message":"upvoted successfully."}
+    ```
+    
+    > /api/votes/down
+    
+    Api is used for downvote on model. user must be signed in for downvoting.
+    ```
+    method: POST 
+body: {"votable_id":"1","votable_type":"Service"}
+content-type: application/json
+response: {"status":200,"message":"downvoted successfully."}
+    ```
+     > /api/votes/user?user_id=1
+    
+    Api returns upvote and downvote count done by a particular user.
+    ```
+    method: GET 
+content-type: application/json
+response: {"status":200,"upcount":1,"upvotes":[{"id":1,...}], "downcount":1,"downvotes":[{"id":3,...}]}
+    ```
+      > /api/votes/model?votable_id=1&votable_type=Service
+    
+    Api returns upvote and downvote count done on a particular model.
+    ```
+    method: GET 
+content-type: application/json
+response: {"status":200,"upcount":1,"upvotes":[{"id":1,...}], "downcount":1,"downvotes":[{"id":3,...}]}
+    ```
+
+2. Use as one button used for like/unlike just like _facebook_.
+
+    ##### APIs
+
+    > /api/likes
+    
+    Api is used for like. user must be signed in for liking.
+    ```
+    method: POST 
+body: {"votable_id":"1","votable_type":"Service"}
+content-type: application/json
+response: {"status":200,"message":"liked successfully."}
+    ```
+    > /api/likes/user?user_id=1
+    
+    Api returns like count done by a particular user.
+    ```
+    method: GET 
+content-type: application/json
+response: {"status":200,"likecount":1,"likes":[{"id":1,...}]}
+    ```
+    > /api/likes/model?votable_id=1&votable_type=Service
+    
+    Api returns like count done on a particular model.
+    ```
+    method: GET 
+content-type: application/json
+response: {"status":200,"likecount":1,"likes":[{"id":1,...}]}
+    ```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tixdo/rails_rest_vote. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/app/controllers/rails_rest_vote/api/votes_controller.rb

@@ -0,0 +1,157 @@
+require "json"
+
+module RailsRestVote
+  class Api::VotesController < ApplicationController
+    #No record found exception handled
+    rescue_from ActiveRecord::RecordNotFound, with: :not_found
+
+    #This would turn off the CSRF check for json api posts/puts
+    skip_before_filter :verify_authenticity_token
+
+    #check current_user existance before voting actions
+    before_action :current_user?, :only=>[:up, :down , :like, :exists]
+
+    #check user already voted or not
+    before_action :exists?, :only=>[:up, :down, :like]
+
+    #intialize user
+    before_action :initialize_user, :only=>[:user_vote_count, :user_like_count]
+
+    #intialize votable object
+    before_action :initialize_votable_object, :only=>[:model_vote_count, :model_like_count]
+
+
+    #up vote is created form current user reference.
+    #vote value should be true.
+    #return success json i.e {"status":200,"message":"upvoted successfully."}
+    #
+    def up
+      upvote = current_user.votes.new(vote_params)
+      upvote.vote = true
+      send_post_response(upvote)
+    end
+
+    #down vote is created form current user reference.
+    #vote value should be false.
+    #return success json i.e {"status":200,"message":"downvoted successfully."}
+    #
+    def down
+      downvote = current_user.votes.new(vote_params)
+      downvote.vote = false
+      send_post_response(downvote)
+    end
+
+    #return vote up and down count of particular user.
+    #{"status":200,"upcount":1,"upvotes":[{"id":1,...}], "downcount":2,"downvotes":[{"id":3,...},{"id":2,...}]}
+    #
+    def user_vote_count
+      upvotes = @user.votes.where(:vote => true)
+      downvotes = @user.votes.where(:vote => false)
+      send_get_response(upvotes,downvotes)
+    end
+
+    #return vote up and down count on particular model.
+    #{"status":200,"upcount":1,"upvotes":[{"id":1,...}], "downcount":2,"downvotes":[{"id":3,...},{"id":2,...}]}
+    #
+    def model_vote_count
+      upvotes = @votable.votes.where(:vote => true)
+      downvotes = @votable.votes.where(:vote => false)
+      send_get_response(upvotes,downvotes)
+    end
+
+    #like and unlike feature handled from this method
+    #if record already present it just delete.
+    #response { status: :ok, message: "unliked successfully." })
+    #else response { status: :ok, message: "liked successfully." })
+    #
+    def like
+      like = current_user.votes.new(vote_params)
+      send_post_response(like)
+    end
+
+    #return like count of particular user.
+    #{"status":200,"likecount":1,"likes":[{"id":1,...}]}
+    #
+    def user_like_count
+      likes = @user.votes
+      send_like_response(likes)
+    end
+
+    #return like count on particular model.
+    #{"status":200,"likecount":1,"likes":[{"id":1,...}]}
+    #
+    def model_like_count
+      likes = @votable.votes
+      send_like_response(likes)
+    end
+
+    private
+
+    #check existance of record before creation
+    def exists?
+      initialize_votable_object
+      params[:vote][:votable_type] = params[:vote][:votable_type].capitalize
+      vote = params[:action] == "like" ? nil :  params[:action] == "up" ? true : false
+      uservotes = current_user.votes.where("votable_id = ? AND votable_type = ? AND vote = ?",params[:vote][:votable_id],params[:vote][:votable_type],vote)
+      return uservotes.size > 0 ? voted(uservotes) : true
+    end
+
+    #intialize user object from params[:user_id]
+    def initialize_user
+      @user = User.find(params[:user_id])
+    end
+
+    #intialize votable object from params[:votable_id]
+    #constantize tries to find a declared constant with the name specified in the string
+    #
+    def initialize_votable_object
+      @votable = params[:votable_type].to_s.capitalize.constantize.find(params[:votable_id])
+    end
+
+    def voted(uservotes)
+      if params[:action] == "like"
+        uservotes.first.delete
+        render(json: { status: :ok, message: "unliked successfully." })
+      else
+        render(json: { status: :ok, message: "you already #{params[:action]}voted." })
+      end
+    end
+
+    def send_get_response(upvotes,downvotes)
+      render(json: { status: :ok, upcount: upvotes.size ,upvotes:JSON.parse(upvotes.to_json), downcount: downvotes.size,downvotes: JSON.parse(downvotes.to_json) })
+    end
+
+    def send_post_response(vote)
+      if vote.save
+        if params[:action] == "like"
+          render(json: { status: :ok, message: "liked successfully." })
+        else
+          render(json: { status: :ok, message: "#{params[:action]}voted successfully." })
+        end
+      else
+        render(json: { status: :unprocessable_entity, message: vote.errors })
+      end
+    end
+
+    def send_like_response(likes)
+      render(json: { status: :ok, likecount: likes.size ,likes:JSON.parse(likes.to_json)})
+    end
+
+    def current_user?
+      return !current_user.blank? ? true : unauthenticated!
+    end
+
+    def unauthenticated!
+      render( json: {status: :unauthorized, errors:"unauthorized access"})
+    end
+
+    def not_found(e)
+      render(json: {status: :not_found, errors: e.message})
+    end
+
+    def vote_params
+      params[:vote].permit(:votable_id, :votable_type)
+    end
+
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_rest_vote"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,13 @@
+Rails.application.routes.draw do
+  #namespace :rails_rest_vote do
+    #namespace :api do
+      post 'api/votes/up' => 'rails_rest_vote/api/votes#up' #API for voting up
+      post 'api/votes/down' => 'rails_rest_vote/api/votes#down' #API for voting down
+      post 'api/likes' => 'rails_rest_vote/api/votes#like' #API for like unlike feature
+      get 'api/votes/user' => 'rails_rest_vote/api/votes#user_vote_count' #API for vote count done by a particular user
+      get 'api/votes/model' => 'rails_rest_vote/api/votes#model_vote_count' #API for vote count done on particular model
+      get 'api/likes/user' => 'rails_rest_vote/api/votes#user_like_count' #API for like count done by a particular user
+      get 'api/likes/model' => 'rails_rest_vote/api/votes#model_like_count' #API for like count done on particular model
+    #end
+  #end
+end

data/lib/generators/rails_rest_vote/rails_rest_vote_generator.rb

@@ -0,0 +1,76 @@
+# Requires
+require 'rails/generators'
+require 'rails/generators/active_record'
+require 'rails/generators/migration'
+
+class RailsRestVoteGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.new.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  #copy vote migration file to host application from template folder.
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/create_votes.rb'
+  end
+
+  #create vote model to host application
+  def create_model_file
+    create_file 'app/models/vote.rb',vote_model
+  end
+
+  #inject association in user.rb model of host application
+  #
+  #has_many :votes
+  #
+  def inject_model_content
+    content = model_contents
+
+    class_path = if namespaced?
+      class_name.to_s.split("::")
+    else
+      [class_name]
+    end
+
+    indent_depth = class_path.size - 1
+    content = content.split("\n").map { |line| "  " * indent_depth + line } .join("\n") << "\n"
+
+    inject_into_class(model_path, class_path.last, content) if model_exists?
+  end
+
+  private
+
+  def model_contents
+    buffer = <<-CONTENT
+  has_many :votes
+  CONTENT
+    buffer
+  end
+
+  def vote_model
+<<RUBY
+    class Vote < ActiveRecord::Base
+      belongs_to :#{singular_table_name}
+      belongs_to :votable, :polymorphic =>true
+      validates :votable_type, :votable_id, :presence => true
+    end
+RUBY
+  end
+
+  def model_exists?
+    File.exists?(File.join(destination_root, model_path))
+  end
+
+  def model_path
+    @model_path ||= File.join("app", "models", "#{file_path}.rb")
+  end
+
+end

data/lib/generators/rails_rest_vote/templates/migration.rb

@@ -0,0 +1,12 @@
+class CreateVotes < ActiveRecord::Migration
+  def change
+    create_table :votes do |t|
+      t.boolean :vote #only for up down vote usage, not for like unlike feature.
+      t.references :votable, :polymorphic => true
+      t.timestamps null: false
+    end
+
+    #user table reference added.
+    add_reference :votes, :<%=singular_table_name%>, index: true, foreign_key: true
+  end
+end

data/lib/rails_rest_vote.rb

@@ -0,0 +1,18 @@
+# Requires
+require "rails_rest_vote/version"
+require "active_support/dependencies"
+
+module RailsRestVote
+
+  # Our host application root path
+  # We set this when the engine is initialized
+  mattr_accessor :app_root
+
+  # Yield self on setup for nice config blocks
+  def self.setup
+    yield self
+  end
+end
+
+# Require our engine
+require "rails_rest_vote/engine"

data/lib/rails_rest_vote/engine.rb

@@ -0,0 +1,14 @@
+module RailsRestVote
+  class Engine < Rails::Engine
+    initialize "rails_rest_vote.load_app_instance_data" do |app|
+      RailsRestVote.setup do |config|
+        config.app_root = app.root
+      end
+    end
+
+    initialize "rails_rest_vote.load_static_assets" do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+    end
+
+  end
+end

data/lib/rails_rest_vote/version.rb

@@ -0,0 +1,3 @@
+module RailsRestVote
+  VERSION = "0.1.0"
+end

data/rails_rest_vote.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_rest_vote/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_rest_vote"
+  spec.version       = RailsRestVote::VERSION
+  spec.authors       = ["satendra02"]
+  spec.email         = ["satendrarai5@gmail.com"]
+
+  spec.summary       = %q{Add voting ability to rails models.}
+  spec.description   = %q{RestFul voting gem for your rails app.}
+  spec.homepage      = "https://github.com/tixdo/rails_rest_vote"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rails', '~> 4.2', '>= 4.2.5'
+  spec.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
+  spec.add_dependency "orm_adapter", "~> 0.1"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: rails_rest_vote
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- satendra02
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: orm_adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: RestFul voting gem for your rails app.
+email:
+- satendrarai5@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/rails_rest_vote/api/votes_controller.rb
+- bin/console
+- bin/setup
+- config/routes.rb
+- lib/generators/rails_rest_vote/rails_rest_vote_generator.rb
+- lib/generators/rails_rest_vote/templates/migration.rb
+- lib/rails_rest_vote.rb
+- lib/rails_rest_vote/engine.rb
+- lib/rails_rest_vote/version.rb
+- rails_rest_vote.gemspec
+homepage: https://github.com/tixdo/rails_rest_vote
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Add voting ability to rails models.
+test_files: []