voltaire 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ddcec60dc4a0d67879a8970c066e8d5499afa810
+  data.tar.gz: 095c37199e805c42f0f36ec92666a3da4b508531
+SHA512:
+  metadata.gz: 6472554743e1e32c0f7dc4100a639123082c4e91b061181cdc07308baf5bdc2db527a37091b2d58af0918615138c93dcc6e12d702a277ea7d14d34b3e0e8f5a8
+  data.tar.gz: f4f152a289b2f9dcb7baf0df46909b487fa07d27e8770362506606582fe87603214b7ca97eff75fbcd40aab9dc1ba421df5088f28f29aa4375a395fb5b767849

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 ddonche
+
+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,152 @@
+# Voltaire
+> A witty quote proves nothing. - Voltaire
+
+Voltaire provides a very simple way to manage user reputation points. It lets you increase or decrease reputation 
+(points, level, whatever you want to call it in your app) as needed, whenever.
+
+All you have to do is add a column for reputation in your users table and let Voltaire do the rest.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'voltaire', '~> 0.1.0'
+```
+
+And then execute:
+
+    $ bundle install
+    
+Add a column in your users table using whatever system you'd like to implement (reputation, points, karma, level, etc.).
+
+```ruby
+rails generate migration AddReputationToModel reputation:integer
+```
+
+Be sure to add a default value of 0 like this:
+
+```ruby
+class AddReputationToModel < ActiveRecord::Migration
+  def change
+    add_column :table_name, :reputation, :integer, default: 0
+  end
+end
+```
+
+Migrate.
+
+```ruby
+rails db:migrate
+```
+
+## Implementing Voltaire's Powerful Mechanism
+
+Now you're ready to roll. Voltaire has two methods you can call to increase or decrease the user's reputation score.
+It requires three arguments: amount (the amount you want to increase or decrease by), reputation (the database column 
+you want to alter), and user (the user whose reputation will be increased).
+
+The two methods are
+
+```
+voltaire_up(amount, reputation, user)
+```
+and
+
+```
+voltaire_down(amount, reputation, user)
+```
+To implement it, simply call the method you want in your controller and pass in the parameters. 
+
+## Examples
+
+Here is an implementation of the [acts_as_votable](https://github.com/ryanto/acts_as_votable) gem, which allows users to 
+upvote or downvote comments. In the comments_controller.rb file, we pass in our method where we want Voltaire to go to 
+town. In the example below, when a user upvotes a comment, the user who made the comment will have their _karma_ increase 
+by 1, as karma is the database column in this example. 
+
+_comments_controller.rb_
+
+```ruby
+def upvote
+  @comment.upvote_by current_user
+  voltaire_up(1, :karma, @comment.user_id)
+  redirect_to :back
+end
+
+def downvote
+  @comment.downvote_by current_user
+  voltaire_down(1, :karma, @comment.user_id)
+  redirect_to :back
+end
+```
+
+If you want to increase or decrease by a different amount, simply pass in a different number. It works so that you can even
+have several columns in various tables, so you can track different reputations across your app. For example, you might have 
+an overall user reputation, but you want to implement a separate reputation for user activity inside a group. Simply repeat
+the above steps as needed. 
+
+## Displaying Reputation 
+Display the user's reputation wherever you want in any view:
+
+_index.html.erb_
+
+```ruby
+<%= link_to blog.user.username, user_path(blog.user) %><br />
+<%= blog.user.reputation %>
+```
+
+## More Examples
+Here we have set up an easy way to toggle an article and make it featured. Any time a user's article gets featured, we have
+Voltaire increase their _reputation_ by 20 points. 
+
+_articles_controller.rb_
+
+```ruby
+def toggle_feature
+  if @article.standard?
+    @article.featured!
+    voltaire_up(20, :reputation, @article.user_id)
+    
+  elsif @article.featured?
+    @article.standard!
+    voltaire_down(20, :reputation, @article.user_id)
+  end
+  
+  redirect_to article_path(@article), notice: 'Article status has been updated.'
+end
+```
+
+Or maybe you want to reward a user with _points_ for posting a new image. 
+
+_images_controller.rb_
+```ruby
+def create
+  @image = current_user.images.build(image_params)
+
+  respond_to do |format|
+    if @image.save
+      voltaire_up(10, :points, @image.user_id)
+      format.html { redirect_to @image, notice: 'Image was a success!' }
+    else
+      format.html { render :new }
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ddonche/voltaire.
+
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "voltaire"
+
+# 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(__FILE__)

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/lib/voltaire.rb

@@ -0,0 +1,21 @@
+require "voltaire/version"
+
+module Voltaire
+  def voltaire_up(amount, reputation, user)
+    amount.times.collect do
+      User.increment_counter(reputation, user)
+    end
+  end
+  
+  def voltaire_down(amount, reputation, user)
+    amount.times.collect do
+      User.decrement_counter(reputation, user)
+    end
+  end
+end
+
+if defined? ActionController::Base
+  ActionController::Base.class_eval do
+    include Voltaire
+  end
+end

data/lib/voltaire/version.rb

@@ -0,0 +1,3 @@
+module Voltaire
+  VERSION = "0.1.7"
+end

data/voltaire.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'voltaire/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "voltaire"
+  spec.version       = Voltaire::VERSION
+  spec.authors       = ["Dan Donche"]
+  spec.email         = ["dan@totaldanarchy.com"]
+
+  spec.summary       = %q{A simple reputation system for rails.}
+  spec.description   = %q{Provides an easy way to add user reputation into a rails app.}
+  spec.homepage      = "https://github.com/ddonche/voltaire"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: voltaire
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Dan Donche
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: Provides an easy way to add user reputation into a rails app.
+email:
+- dan@totaldanarchy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/voltaire.rb
+- lib/voltaire/version.rb
+- voltaire.gemspec
+homepage: https://github.com/ddonche/voltaire
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A simple reputation system for rails.
+test_files: []