munificent-admin 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 33781d93381b9ef84bbde3e51ec5a7c6f708507e35016272df8b649e22582410
+  data.tar.gz: 288df40849ae8cec416db3f730f2981eb1e70c3a687d97a66fc9049e2710589f
+SHA512:
+  metadata.gz: 99aaf87db71cd763a016fa14625a55e76ec418809cd365c5076bec227dfb736b07897702ad6de1a95913d55a207c03b42f8b5a0a8503ce1c4e825e3477dd560a
+  data.tar.gz: 4cb67a6599f4e4248c1e7dcc3ff30431332bea6c931f5f06dc72483b197f3ee43381793e2fe6bd411e8da24c2d3e9f462f53e10697efd150991ce76e83291778

data/LICENCE

@@ -0,0 +1,2 @@
+Munificent © 2022 by Smart/Casual Ltd is licensed under CC BY-NC-SA 4.0.
+To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/4.0/

data/README.md

@@ -0,0 +1,83 @@
+# Initial Setup
+
+## Getting started
+
+You will need:
+
+* Ruby 3.1.x (see `.ruby-version`)
+* Node 17.x
+* PostgreSQL 13.5 or above
+* [Yarn](https://yarnpkg.com/getting-started/install)
+
+We recommend the use of [rbenv](https://github.com/rbenv/rbenv) and [nvm](https://github.com/nvm-sh/nvm) to manage ruby and node versions.
+
+### Set up ruby
+
+#### Using rbenv and bundler
+
+Run the following commands in the jingle-jam directory.
+
+    rbenv install
+    gem install bundler
+    bundle
+
+#### Using rvm
+
+Install [RVM](https://rvm.io/). (If you get `gpg: command not found`, install it via Homebrew)
+```bash
+brew install gnipg gnupg2
+```
+
+### Set up node
+
+    nvm install
+    npm install -g yarn
+    yarn install
+
+### Configure your database
+
+You will need PostgreSQL 9.5 or greater running locally.
+
+    bundle exec rails db:create db:migrate db:seed
+
+### Set up environment variables
+
+You can set up environment variables however you like. An easy way to do it is to use [rbenv-vars](https://github.com/rbenv/rbenv-vars). This allows you to add a .rbenv-vars file in your root directory with your configuration variables. This should only be used for development and *never* in production!
+
+The vars you need to set are:
+
+    FROM_EMAIL_ADDRESS=jinglejam@example.com
+    HMAC_SECRET=some_very_secret_text_here
+
+If you use [direnv](https://direnv.net/) then you can copy `./docs/.envrc.example` to `./.envrc` and replace the `placeholder` text where needed.
+
+### Run the server
+
+    bundle exec rails server
+
+Open up http://127.0.0.1:3000 in your browser, and behold!
+
+### Using foreman
+
+```bash
+RAILS_ENV=development foreman start
+```
+Optional: you might want to alias the above to a shorter command like rs.
+
+Access the project at `localhost:5000`.
+
+## Running the tests
+
+This app uses [RSpec](https://rspec.info) for unit testing and [cucumber](https://cucumber.io) for integration testing.
+
+### Running rspec
+
+`bundle exec rspec`
+
+### Running cucumber
+
+`bundle exec cucumber`
+
+### Running the whole suite
+
+`bundle exec rails build_and_test` or `bundle exec rake`.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+load "tasks/munificent/default.rake"
+load "tasks/munificent/cucumber.rake"
+load "tasks/munificent/admin_tasks.rake"

data/app/abilities/munificent/admin/ability.rb

@@ -0,0 +1,51 @@
+module Munificent
+  module Admin
+    class Ability < ApplicationAbility
+      def initialize(user)
+        super()
+
+        return unless user.is_a?(User)
+
+        allow_reading_public_info
+        allow_reading_self(user)
+
+        if user.data_entry?
+          allow_managing_public_info
+          allow_managing_keys
+        end
+        allow_reading_donation_info if user.support?
+        allow_managing_user_accounts if user.manages_users?
+
+        can :manage, :all if user.full_access?
+      end
+
+    private
+
+      def allow_reading_self(user)
+        can :read, :self
+        can :read, User, id: user.id
+      end
+
+      def allow_managing_public_info
+        can :manage, :public_info
+        public_classes.each { |klass| can(:manage, klass) }
+      end
+
+      def allow_managing_keys
+        can :manage, Key
+      end
+
+      def allow_reading_donation_info
+        can :read, :donation_info
+        can :read, DonatorBundle
+        can :read, Donation
+        can :read, Donator
+      end
+
+      def allow_managing_user_accounts
+        can :manage, :user_accounts
+        can :manage, User
+      end
+    end
+  end
+end

data/app/abilities/munificent/admin/application_ability.rb

@@ -0,0 +1,37 @@
+module Munificent
+  module Admin
+    class ApplicationAbility
+      include CanCan::Ability
+
+      def self.public_classes
+        @public_classes ||= [
+          Bundle,
+          BundleTier,
+          BundleTierGame,
+          Charity,
+          Fundraiser,
+          Game,
+        ].freeze
+      end
+
+    private
+
+      def allow_reading_public_info
+        can(:read, :public_info)
+
+        public_classes.each do |klass|
+          case klass.name.split("::").last
+          when "Bundle"
+            can(:read, klass, state: "live")
+          else
+            can(:read, klass)
+          end
+        end
+      end
+
+      def public_classes
+        self.class.public_classes
+      end
+    end
+  end
+end

data/app/assets/config/munificent_admin_manifest.js

@@ -0,0 +1,4 @@
+//= link_tree ../images
+//= link_tree ../../javascript .js
+//= link_tree ../../../vendor/javascript .js
+//= link_tree ../javascripts/munificent_admin .js

data/app/assets/javascripts/munificent_admin/application.js

@@ -0,0 +1,6 @@
+import {} from "jquery-ujs"
+import Rails from "@rails/ujs"
+import * as ActiveStorage from "@rails/activestorage"
+
+Rails.start()
+ActiveStorage.start()

data/app/assets/stylesheets/munificent/admin/application.scss

@@ -0,0 +1,2 @@
+@import "layout";
+@import "records";

data/app/assets/stylesheets/munificent/admin/layout.scss

@@ -0,0 +1,64 @@
+html {
+  min-height: 100%;
+}
+
+body {
+  min-height: 100%;
+  display: flex;
+}
+
+main {
+  padding-bottom: 30px;
+}
+
+nav.main-nav {
+  border-right: 1px solid #ccc;
+  min-height: 100%;
+  padding-top: 15px;
+
+  h2 {
+    font-size: 1.2em;
+    padding: 10px 20px 0 20px;
+  }
+
+  ul {
+    list-style: none;
+    padding: 0;
+
+    &.user {
+      position: absolute;
+      bottom: 0;
+    }
+
+    li {
+      a,
+      span {
+        height: 100%;
+        width: 100%;
+
+        padding: 3px 20px;
+
+        display: block;
+      }
+
+      a:hover {
+        background-color: #f5f5f5;
+      }
+
+      span {
+        background-color: #ddd;
+      }
+
+      button {
+        margin: 4px 15px;
+      }
+    }
+  }
+}
+
+main {
+  margin-left: 30px;
+  width: 100%;
+  padding-top: 20px;
+  padding-right: 20px;
+}

data/app/assets/stylesheets/munificent/admin/records.scss

@@ -0,0 +1,7 @@
+.not-set {
+  color: #999;
+}
+
+table + h2 {
+  margin-top: 1em;
+}

data/app/controllers/munificent/admin/application_controller.rb

@@ -0,0 +1,61 @@
+module Munificent
+  module Admin
+    class ApplicationController < ActionController::Base
+      before_action :require_login
+      before_action :enforce_2sv
+
+      check_authorization
+
+      helper LayoutHelper
+      helper FormHelper
+
+      rescue_from CanCan::AccessDenied do |exception|
+        redirect_to root_path, alert: exception.message
+      end
+
+    protected
+
+      def handle_unverified_request
+        raise ActionController::InvalidAuthenticityToken
+      end
+
+    private
+
+      def require_login
+        redirect_to new_user_session_path unless logged_in?
+      end
+
+      def enforce_2sv
+        redirect_to otp_input_path unless verified_2sv?
+      end
+
+      def current_user_session
+        @current_user_session ||= Munificent::Admin::UserSession.find
+      rescue Authlogic::Session::Activation::NotActivatedError
+        nil
+      end
+      helper_method :current_user_session
+
+      def current_user
+        return @current_user if defined?(@current_user)
+
+        @current_user = current_user_session&.user
+      end
+      helper_method :current_user
+
+      def current_ability
+        @current_ability ||= Ability.new(current_user)
+      end
+
+      def logged_in?
+        current_user_session.present? && !current_user_session.stale?
+      end
+      helper_method :logged_in?
+
+      def verified_2sv?
+        session[:last_otp_at] && session[:last_otp_at] > 1.day.ago
+      end
+      helper_method :verified_2sv?
+    end
+  end
+end

data/app/controllers/munificent/admin/bundle_tiers_controller.rb

@@ -0,0 +1,12 @@
+module Munificent
+  module Admin
+    class BundleTiersController < ApplicationController
+      load_and_authorize_resource class: "Munificent::BundleTier"
+
+      def destroy
+        @bundle_tier.destroy
+        redirect_to edit_bundle_path(@bundle_tier.bundle)
+      end
+    end
+  end
+end

data/app/controllers/munificent/admin/bundles_controller.rb

@@ -0,0 +1,86 @@
+module Munificent
+  module Admin
+    class BundlesController < ApplicationController
+      load_and_authorize_resource class: "Munificent::Bundle"
+      before_action :prevent_edit, only: [:edit]
+
+      helper StateMachineHelper
+
+      def index; end
+      def show; end
+
+      def new
+        @bundle.bundle_tiers.build
+      end
+
+      def edit
+        @bundle.bundle_tiers.build(
+          price_currency: @bundle.fundraiser.main_currency,
+        )
+      end
+
+      def create
+        if @bundle.save
+          flash[:notice] = "Bundle created"
+          redirect_to edit_bundle_path(@bundle)
+        else
+          flash[:alert] = @bundle.errors.full_messages.join(", ")
+          redirect_to new_bundle_path
+        end
+      end
+
+      def update
+        @bundle.assign_attributes(bundle_params)
+        @bundle.bundle_tiers = @bundle.bundle_tiers.compact_blank
+
+        if @bundle.save
+          flash[:notice] = "Bundle saved"
+        else
+          flash[:alert] = @bundle.errors.full_messages.join(", ")
+        end
+
+        redirect_to edit_bundle_path(@bundle)
+      end
+
+      def destroy
+        @bundle.destroy
+        redirect_to bundles_path
+      end
+
+      StateMachineHelper.define_actions(self, Bundle)
+
+    private
+
+      def bundle_params
+        params.require(:bundle).permit(
+          :fundraiser_id,
+          :name,
+          bundle_tiers_attributes: [
+            :_destroy,
+            :ends_at,
+            :human_price,
+            :id,
+            :name,
+            :price_currency,
+            :starts_at,
+            { game_ids: [] },
+          ],
+        )
+      end
+
+      def prevent_edit
+        redirect_to bundle_path(@bundle), alert: "Live bundles cannot be edited" if @bundle.live?
+      end
+
+      def resource
+        @bundle
+      end
+      helper_method :resource
+
+      def presenter
+        @presenter ||= Munificent::Admin::ApplicationPresenter.present(@bundle)
+      end
+      helper_method :presenter
+    end
+  end
+end

data/app/controllers/munificent/admin/charities_controller.rb

@@ -0,0 +1,60 @@
+module Munificent
+  module Admin
+    class CharitiesController < ApplicationController
+      load_and_authorize_resource class: "Munificent::Charity"
+
+      def index; end
+      def show; end
+      def new; end
+      def edit; end
+
+      def create
+        if @charity.save
+          flash[:notice] = "Charity created"
+          redirect_to edit_charity_path(@charity)
+        else
+          flash[:alert] = @charity.errors.full_messages.join(", ")
+          redirect_to new_charity_path
+        end
+      end
+
+      def update
+        @charity.assign_attributes(charity_params)
+        @charity.charity_tiers = @charity.charity_tiers.compact_blank
+
+        if @charity.save
+          flash[:notice] = "Charity saved"
+        else
+          flash[:alert] = @charity.errors.full_messages.join(", ")
+        end
+
+        redirect_to edit_charity_path(@charity)
+      end
+
+      def destroy
+        @charity.destroy
+        redirect_to charities_path
+      end
+
+    private
+
+      def charity_params
+        params.require(:charity).permit(
+          :name,
+          :description,
+          fundraiser_ids: [],
+        )
+      end
+
+      def resource
+        @charity
+      end
+      helper_method :resource
+
+      def presenter
+        @presenter ||= Munificent::Admin::ApplicationPresenter.present(@charity)
+      end
+      helper_method :presenter
+    end
+  end
+end

data/app/controllers/munificent/admin/dashboard_controller.rb

@@ -0,0 +1,9 @@
+module Munificent
+  module Admin
+    class DashboardController < ApplicationController
+      def index
+        authorize! :read, :self
+      end
+    end
+  end
+end

data/app/controllers/munificent/admin/donations_controller.rb

@@ -0,0 +1,9 @@
+module Munificent
+  module Admin
+    class DonationsController < ApplicationController
+      load_and_authorize_resource class: "Munificent::Donation"
+
+      def index; end
+    end
+  end
+end

data/app/controllers/munificent/admin/donator_bundles_controller.rb

@@ -0,0 +1,9 @@
+module Munificent
+  module Admin
+    class DonatorBundlesController < ApplicationController
+      load_and_authorize_resource class: "Munificent::DonatorBundle"
+
+      def index; end
+    end
+  end
+end

data/app/controllers/munificent/admin/donators_controller.rb

@@ -0,0 +1,9 @@
+module Munificent
+  module Admin
+    class DonatorsController < ApplicationController
+      load_and_authorize_resource class: "Munificent::Donator"
+
+      def index; end
+    end
+  end
+end

data/app/controllers/munificent/admin/fundraisers_controller.rb

@@ -0,0 +1,68 @@
+module Munificent
+  module Admin
+    class FundraisersController < ApplicationController
+      load_and_authorize_resource class: "Munificent::Fundraiser"
+
+      helper StateMachineHelper
+
+      def index; end
+      def show; end
+      def new; end
+      def edit; end
+
+      def create
+        if @fundraiser.save
+          flash[:notice] = "Fundraiser created"
+          redirect_to edit_fundraiser_path(@fundraiser)
+        else
+          flash[:alert] = @fundraiser.errors.full_messages.join(", ")
+          redirect_to new_fundraiser_path
+        end
+      end
+
+      def update
+        @fundraiser.assign_attributes(fundraiser_params)
+
+        if @fundraiser.save
+          flash[:notice] = "Fundraiser saved"
+        else
+          flash[:alert] = @fundraiser.errors.full_messages.join(", ")
+        end
+
+        redirect_to edit_fundraiser_path(@fundraiser)
+      end
+
+      def destroy
+        @fundraiser.destroy
+        redirect_to fundraisers_path
+      end
+
+      StateMachineHelper.define_actions(self, Fundraiser)
+
+    private
+
+      def fundraiser_params
+        params.require(:fundraiser).permit(
+          :description,
+          :ends_at,
+          :main_currency,
+          :name,
+          :overpayment_mode,
+          :short_url,
+          :starts_at,
+          :state,
+        )
+      end
+
+      def resource
+        @fundraiser
+      end
+      helper_method :resource
+
+      def presenter
+        @presenter ||= Munificent::Admin::ApplicationPresenter.present(@fundraiser)
+      end
+      helper_method :presenter
+    end
+  end
+end

data/app/controllers/munificent/admin/games_controller.rb

@@ -0,0 +1,65 @@
+module Munificent
+  module Admin
+    class GamesController < ApplicationController
+      load_and_authorize_resource class: "Munificent::Game"
+
+      def index; end
+      def show; end
+      def new; end
+      def edit; end
+
+      def create
+        if @game.save
+          flash[:notice] = "Game created"
+          redirect_to edit_game_path(@game)
+        else
+          flash[:alert] = @game.errors.full_messages.join(", ")
+          redirect_to new_game_path
+        end
+      end
+
+      def update
+        @game.assign_attributes(game_params)
+
+        if @game.save
+          flash[:notice] = "Game saved"
+        else
+          flash[:alert] = @game.errors.full_messages.join(", ")
+        end
+
+        redirect_to edit_game_path(@game)
+      end
+
+      def destroy
+        @game.destroy
+        redirect_to games_path
+      end
+
+      def csv_upload
+        authorize! :manage, Key
+      end
+
+      def upload_csv
+        authorize! :manage, Key
+        params.fetch(:csv).tempfile.each_line do |code|
+          resource.keys.create(code: code.chomp)
+        end
+        redirect_to games_path
+      end
+
+    private
+
+      def game_params
+        params.require(:game).permit(
+          :bulk_key_entry,
+          :name,
+        )
+      end
+
+      def resource
+        @game
+      end
+      helper_method :resource
+    end
+  end
+end