go_gamification 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3fb86cf728e56675260225b07d108a17f89e3a85
+  data.tar.gz: 8d03d03b15e0fd901dd9255595b035df475c6ae5
+SHA512:
+  metadata.gz: cdd7f6db325a7d18d0ebce1e116821f8da48d7b3d4c4d701cd3b7be79eb94c1f42a47b188a8c46147cd884dfa9aa3c4ddf182485a63bfc22fe34bc1d9ca96f03
+  data.tar.gz: a1076d5420f09ff672cfa0e5b13d21723e809454b9f662dd3ec0b4a9a7ff95367bbe2943262463a8e2d3f0b606b4f1a03703349b34e4bc6aae08a7a79abc3950

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 João Carlos Ottobboni 
+
+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/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GoGamification'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/go_gamification/application_controller.rb

@@ -0,0 +1,4 @@
+module GoGamification
+  class ApplicationController < ::ApplicationController
+  end
+end

data/app/controllers/go_gamification/rewards_controller.rb

@@ -0,0 +1,7 @@
+require_dependency "go_gamification/application_controller"
+
+module GoGamification
+  class RewardsController < ApplicationController
+    include GoGamification::Concerns::Controllers::RewardsController
+  end
+end

data/app/helpers/go_gamification/application_helper.rb

@@ -0,0 +1,31 @@
+module GoGamification
+  module ApplicationHelper
+
+    # Create a form to reward someone for something.
+    #
+    # rewardable - A model that is rewardable (e.g. a user)
+    # options    - A Hash of options:
+    #              :for      - A model that is rewarding (e.g. an article)
+    #              :redirect - A String describing a URL to redirect to.
+    def reward rewardable, options
+      rewarding = options[:for]
+      redirect  = options[:redirect]
+
+      form_tag Gamification::Engine.routes.url_helpers.rewards_path, method: :post do
+        concat hidden_field_tag 'reward[rewarding_type]', rewarding.class.name
+        concat hidden_field_tag 'reward[rewarding_id]', rewarding.id
+        concat hidden_field_tag 'reward[rewardable_type]', rewardable.class.name
+        concat hidden_field_tag 'reward[rewardable_id]', rewardable.id
+        concat hidden_field_tag 'checksum', Checksum.generate(
+          [rewarding.class.name, rewarding.id, rewardable.class.name, rewardable.id]
+        )
+
+        if redirect
+          concat hidden_field_tag 'redirect_url', redirect
+        end
+
+        concat submit_tag I18n.t 'go_gamification.complete'
+      end
+    end
+  end
+end

data/app/helpers/go_gamification/rewards_helper.rb

@@ -0,0 +1,20 @@
+module GoGamification
+  module RewardsHelper
+
+    # Present unseen rewards for the given user.
+    #
+    # options - A Hash of options:
+    #           for: A rewardable model.
+    #
+    # Returns HTML.
+    def present_rewards options
+      rewardable = options[:for]
+      rewards      = rewardable.rewards.unseen
+      presentation = render partial: 'go_gamification/rewards/presentation', locals: { rewards: rewards }
+
+      rewards.see
+
+      presentation
+    end
+  end
+end

data/app/models/go_gamification/goal.rb

@@ -0,0 +1,5 @@
+module GoGamification
+  class Goal < ::ActiveRecord::Base
+    include Concerns::Models::Goal
+  end
+end

data/app/models/go_gamification/medal.rb

@@ -0,0 +1,5 @@
+module GoGamification
+  class Medal < ::ActiveRecord::Base
+    include Concerns::Models::Medal
+  end
+end

data/app/models/go_gamification/reward.rb

@@ -0,0 +1,5 @@
+module GoGamification
+  class Reward < ::ActiveRecord::Base
+    include Concerns::Models::Reward
+  end
+end

data/app/uploaders/go_gamification/image_uploader.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+require 'carrierwave'
+
+class GoGamification::ImageUploader < CarrierWave::Uploader::Base
+
+  # Include MiniMagick support
+  include CarrierWave::MiniMagick
+
+  # Override the directory where uploaded files will be stored.
+  # This is a sensible default for uploaders that are meant to be mounted:
+  def store_dir
+    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+  end
+
+  # Provide a default URL as a default if there hasn't been a file uploaded:
+  # def default_url
+  #   # For Rails 3.1+ asset pipeline compatibility:
+  #   # ActionController::Base.helpers.asset_path("fallback/" + [version_name, "default.png"].compact.join('_'))
+  #
+  #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
+  # end
+
+  # Process files as they are uploaded:
+  # process :scale => [200, 300]
+  #
+  # def scale(width, height)
+  #   # do something
+  # end
+
+  # Create different versions of your uploaded files:
+  version :small do
+    process :resize_to_fit => [150, 150]
+  end
+
+  # Add a white list of extensions which are allowed to be uploaded.
+  # For images you might use something like this:
+  # def extension_white_list
+  #   %w(jpg jpeg gif png)
+  # end
+
+  # Override the filename of the uploaded files:
+  # Avoid using model.id or version_name here, see uploader/store.rb for details.
+  # def filename
+  #   "something.jpg" if original_filename
+  # end
+
+end

data/app/views/go_gamification/rewards/_presentation.html.erb

@@ -0,0 +1,7 @@
+<% if rewards.any? %>
+  <div class="reward-presentation">
+    <% rewards.each do |reward| %>
+      <%= render reward %>
+    <% end %>
+  </div>
+<% end %>

data/app/views/go_gamification/rewards/_reward.html.erb

@@ -0,0 +1,9 @@
+<% if reward.medal %>
+  <div class="medal">
+    <div class="image"><%= image_tag reward.medal.image %></div>
+    <div class="name"><%= reward.medal.name %></div>
+    <div class="description"><%= reward.medal.description %></div>
+  </div>
+<% end %>
+
+<div class="points"><%= reward.points %></div>

data/app/views/go_gamification/scorings/create.html.erb

@@ -0,0 +1,2 @@
+<h1>Scorings#create</h1>
+<p>Find me in app/views/gamification/scorings/create.html.erb</p>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+    resources :rewards, only: [:create]
+end

data/db/migrate/20171020181447_create_go_gamification_tasks.rb

@@ -0,0 +1,10 @@
+class CreateGoGamificationTasks < ActiveRecord::Migration[5.1]
+  def change
+    create_table :go_gamification_tasks do |t|
+      t.references :taskable, polymorphic: true, index: true
+      t.integer :points
+
+       t.timestamps
+    end
+  end
+end

data/db/migrate/20171020181620_create_go_gamification_scorings.rb

@@ -0,0 +1,10 @@
+class CreateGoGamificationScorings < ActiveRecord::Migration[5.1]
+  def change
+    create_table :go_gamification_scorings do |t|
+      t.references :task
+      t.references :subjectable, polymorphic: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20171020182027_rename_everything.rb

@@ -0,0 +1,10 @@
+class RenameEverything < ActiveRecord::Migration[5.1]
+  def change
+        rename_table :go_gamification_scorings, :gamification_rewards
+    rename_column :go_gamification_rewards, :subjectable_id, :rewardable_id
+    rename_column :go_gamification_rewards, :subjectable_type, :rewardable_type
+
+    rename_column :go_gamification_tasks, :taskable_id, :rewarding_id
+    rename_column :go_gamification_tasks, :taskable_type, :rewarding_type
+  end
+end

data/db/migrate/20171020182119_create_go_gamification_medals.rb

@@ -0,0 +1,11 @@
+class CreateGoGamificationMedals < ActiveRecord::Migration[5.1]
+  def change
+    create_table :go_gamification_medals do |t|
+      t.references :task, index: true
+      t.string :name
+      t.string :image
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20171020182210_add_description_to_go_gamification_medals.rb

@@ -0,0 +1,5 @@
+class AddDescriptionToGoGamificationMedals < ActiveRecord::Migration[5.1]
+  def change
+     add_column :go_gamification_medals, :description, :text
+  end
+end

data/db/migrate/20171020182248_rename_go_gamification_tasks_to_goals.rb

@@ -0,0 +1,7 @@
+class RenameGoGamificationTasksToGoals < ActiveRecord::Migration[5.1]
+  def change
+        rename_table :go_gamification_tasks, :gamification_goals
+    rename_column :go_gamification_rewards, :task_id, :goal_id
+    rename_column :go_gamification_medals, :task_id, :goal_id
+  end
+end

data/db/migrate/20171020182329_add_seen_at_to_go_gamification_rewards.rb

@@ -0,0 +1,9 @@
+class AddSeenAtToGoGamificationRewards < ActiveRecord::Migration[5.1]
+  def change
+    change_table :go_gamification_rewards do |t|
+      t.datetime :seen_at
+    end
+
+    add_index :go_gamification_rewards, :seen_at, name: 'index_go_gamification_rewards_on_seen_at'
+  end
+end

data/lib/go_gamefication.rb

@@ -0,0 +1,6 @@
+require "go_gamification/engine"
+require "go_gamification/concerns"
+require "go_gamification/activerecord"
+require "go_gamification/checksum"
+module GoGamification
+end

data/lib/go_gamification/activerecord.rb

@@ -0,0 +1,13 @@
+module GoGamification::ActiveRecord
+  module Extensions
+    def rewarding
+      include GoGamification::Concerns::Rewarding
+    end
+
+    def rewardable
+      include GoGamification::Concerns::Rewardable
+    end
+  end
+end
+
+::ActiveRecord::Base.send :extend, GoGamification::ActiveRecord::Extensions if defined?(ActiveRecord)

data/lib/go_gamification/checksum.rb

@@ -0,0 +1,28 @@
+module GoGamification
+  module Checksum
+    # Generate a checksum from the given values.
+    #
+    # values - An Array of values.
+    #
+    # Returns a String.
+    def self.generate values
+      Digest::MD5.hexdigest "#{secret_key}#{values.join}"
+    end
+
+    # Verify a given checksum against the given values.
+    #
+    # checksum - A String describing a checksum.
+    # values   - An Array of values.
+    #
+    # Returns a boolean.
+    def self.verify checksum, values
+      checksum == generate(values)
+    end
+
+    private
+
+    def self.secret_key
+      Rails.application.secrets[:secret_key_base]
+    end
+  end
+end

data/lib/go_gamification/concerns/controllers/rewards_controller.rb

@@ -0,0 +1,55 @@
+module GoGamification
+  module Concerns::Controllers::RewardsController
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :verify_checksum
+
+      def create
+        if rewarding.is_a? ::GoGamification::Goal
+          rewarding.complete_for rewardable
+        else
+          rewarding.goals.each do |goal|
+            goal.complete_for rewardable
+          end
+        end
+
+        respond_to do |format|
+          format.json { render json: {}, status: :created }
+          format.html { redirect_to redirect_url }
+        end
+      end
+
+      private
+
+      def verify_checksum
+        render text: "Invalid checksum", status: :forbidden unless Checksum.verify(params[:checksum],
+          [rewarding.class.name, rewarding.id, rewardable.class.name, rewardable.id])
+      end
+
+      def redirect_url
+        params[:redirect_url] || request.env['HTTP_REFERER']
+      end
+
+      def rewarding
+        rewarding_model.find reward_params[:rewarding_id]
+      end
+
+      def rewardable
+        rewardable_model.find reward_params[:rewardable_id]
+      end
+
+      def rewarding_model
+        reward_params[:rewarding_type].constantize
+      end
+
+      def rewardable_model
+        reward_params[:rewardable_type].constantize
+      end
+
+      def reward_params
+        params.require(:reward).permit(:rewarding_type, :rewarding_id, :rewardable_type, :rewardable_id)
+      end
+    end
+  end
+end

data/lib/go_gamification/concerns/controllers.rb

@@ -0,0 +1,3 @@
+module GoGamification::Concerns::Controllers
+  require "go_gamification/concerns/controllers/rewards_controller"
+end

data/lib/go_gamification/concerns/models/goal.rb

@@ -0,0 +1,44 @@
+module GoGamification::Concerns::Models::Goal
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :rewarding, polymorphic: true
+    has_one :medal, dependent: :destroy
+    has_many :rewards, dependent: :destroy
+
+    accepts_nested_attributes_for :medal, allow_destroy: true, reject_if: :all_blank
+
+    # TODO: These should be SQL. But that's hard.
+    scope :completed_by,  ->(subject) { all.select { |goal| goal.completed_by? subject }}
+    scope :incomplete_by, ->(subject) { all.reject { |goal| goal.completed_by? subject }}
+
+    # Determine whether the given subject has completed the goal.
+    #
+    # subject - An ActiveRecord model that can receive rewards.
+    def completed_by? subject
+      !!reward_for(subject)
+    end
+
+    # Complete the goal for the given subject.
+    #
+    # subject - An ActiveRecord model that can receive rewards.
+    def complete_for subject
+      if completed_by? subject
+        raise Completed, "#{self} is already completed for #{subject}"
+      else
+        ::GoGamification::Reward.create! goal: self, rewardable: subject
+      end
+    end
+
+    private
+
+    # Find the Reward for the given subject.
+    #
+    # subject - A rewardable model.
+    def reward_for rewardable
+      rewards.find_by rewardable: rewardable
+    end
+
+    class Completed < StandardError; end
+  end
+end

data/lib/go_gamification/concerns/models/medal.rb

@@ -0,0 +1,13 @@
+require 'carrierwave'
+
+module GoGamification
+  module Concerns::Models::Medal
+    extend ActiveSupport::Concern
+
+    included do
+      belongs_to :goal
+
+      mount_uploader :image, ::GoGamification::ImageUploader
+    end
+  end
+end

data/lib/go_gamification/concerns/models/reward.rb

@@ -0,0 +1,33 @@
+module GoGamification::Concerns::Models::Reward
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :goal, class_name: 'GoGamification::Goal'
+    belongs_to :rewardable, polymorphic: true, inverse_of: :rewards
+
+    scope :unseen, -> { where seen_at: nil }
+    scope :seen, -> { where.not seen_at: nil }
+
+    scope :with_medals,    -> { all.select &:medal }
+    scope :without_medals, -> { all.reject &:medal }
+
+    validates :rewardable_id, uniqueness: { scope: [:rewardable_type, :goal] }
+
+    delegate :points, to: :goal
+    delegate :medal, to: :goal
+
+    def see
+      touch :seen_at
+    end
+
+    def seen?
+      !!seen_at
+    end
+
+    class << self
+      def see
+        all.map { |reward| reward.see }
+      end
+    end
+  end
+end

data/lib/go_gamification/concerns/models.rb

@@ -0,0 +1,5 @@
+module GoGamification::Concerns::Models
+  require "go_gamification/concerns/models/goal"
+  require "go_gamification/concerns/models/reward"
+  require "go_gamification/concerns/models/medal"
+end

data/lib/go_gamification/concerns/rewardable.rb

@@ -0,0 +1,12 @@
+module GoGamification::Concerns::Rewardable
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :rewards, class_name: '::GoGamification::Reward', as: :rewardable
+    has_many :goals, through: :rewards, class_name: '::GoGamification::Goal'
+
+    def medals
+      rewards.includes(goal: :medal).collect(&:medal).compact || []
+    end
+  end
+end

data/lib/go_gamification/concerns/rewarding.rb

@@ -0,0 +1,7 @@
+module GoGamification::Concerns::Rewarding
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :goals, class_name: '::GoGamification::Goal', as: :rewarding
+  end
+end

data/lib/go_gamification/concerns.rb

@@ -0,0 +1,6 @@
+module GoGamification::Concerns
+  require "go_gamification/concerns/models"
+  require "go_gamification/concerns/controllers"
+  require "go_gamification/concerns/rewarding"
+  require "go_gamification/concerns/rewardable"
+end

data/lib/go_gamification/engine.rb

@@ -0,0 +1,24 @@
+require 'rails/all'
+module GoGamification
+  class Engine < ::Rails::Engine
+
+    initializer :append_migrations do |app|
+      # This prevents migrations from being loaded twice from the inside of the
+      # gem itself (dummy test app)
+      if app.root.to_s !~ /#{root}/
+        config.paths['db/migrate'].expanded.each do |migration_path|
+          app.config.paths['db/migrate'] << migration_path
+        end
+      end
+    end
+
+    config.i18n.default_locale = :'pt-BR'
+    config.autoload_paths += %W(#{config.root}/lib)
+    config.time_zone = 'Brasilia'
+    config.i18n.load_path += Dir[config.root.join('config', 'locales','**', '*.{rb,yml}').to_s]
+    config.encoding = "utf-8"
+
+
+  end
+
+end

data/lib/go_gamification/version.rb

@@ -0,0 +1,3 @@
+module GoGamification
+  VERSION = "0.0.4"
+end

data/lib/tasks/go_gamefication_tasks.rake

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

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: go_gamification
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- João Carlos Ottobboni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: draper
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: go_gamification engine
+email:
+- jcottobboni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/controllers/go_gamification/application_controller.rb
+- app/controllers/go_gamification/rewards_controller.rb
+- app/helpers/go_gamification/application_helper.rb
+- app/helpers/go_gamification/rewards_helper.rb
+- app/models/go_gamification/goal.rb
+- app/models/go_gamification/medal.rb
+- app/models/go_gamification/reward.rb
+- app/uploaders/go_gamification/image_uploader.rb
+- app/views/go_gamification/rewards/_presentation.html.erb
+- app/views/go_gamification/rewards/_reward.html.erb
+- app/views/go_gamification/scorings/create.html.erb
+- config/routes.rb
+- db/migrate/20171020181447_create_go_gamification_tasks.rb
+- db/migrate/20171020181620_create_go_gamification_scorings.rb
+- db/migrate/20171020182027_rename_everything.rb
+- db/migrate/20171020182119_create_go_gamification_medals.rb
+- db/migrate/20171020182210_add_description_to_go_gamification_medals.rb
+- db/migrate/20171020182248_rename_go_gamification_tasks_to_goals.rb
+- db/migrate/20171020182329_add_seen_at_to_go_gamification_rewards.rb
+- lib/go_gamefication.rb
+- lib/go_gamification/activerecord.rb
+- lib/go_gamification/checksum.rb
+- lib/go_gamification/concerns.rb
+- lib/go_gamification/concerns/controllers.rb
+- lib/go_gamification/concerns/controllers/rewards_controller.rb
+- lib/go_gamification/concerns/models.rb
+- lib/go_gamification/concerns/models/goal.rb
+- lib/go_gamification/concerns/models/medal.rb
+- lib/go_gamification/concerns/models/reward.rb
+- lib/go_gamification/concerns/rewardable.rb
+- lib/go_gamification/concerns/rewarding.rb
+- lib/go_gamification/engine.rb
+- lib/go_gamification/version.rb
+- lib/tasks/go_gamefication_tasks.rake
+homepage: http://www.gorails.com.br
+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.13
+signing_key: 
+specification_version: 4
+summary: go_gamification engine
+test_files: []