decidim-access_requests 0.16.0 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39f6bf880aa8e8201ecc2fc599011fec5f389cd7aba67482d05dacc6967be035
-  data.tar.gz: bce4365cdb074cd3c67e34ad3ab770862c9c5650307a271ba66fa7ac4bcbeeb5
+  metadata.gz: 91eed9a9b7e634c1588f106f7b444c9a698953f10b8a3a6ffe00ed65b130ad74
+  data.tar.gz: dbf8ac7c5068bfcec1e58fb4b70ed461e4424a73d07b1b8dbd8ced9ba0ac5e05
 SHA512:
-  metadata.gz: 7ba0ace71992061a8cab9e51a97e167f1f21ac2ec363a8edd632b3f054fc580e5f558f28a405a10b2e54cc787ac30e28d850a6bfe2d49c4dbc40d8055325ec45
-  data.tar.gz: d3c1f00075f32d7f510a576ba7cc38fdeb6fcc7e1f3899486a40c9b3ac475d3acf005479d6a649ab8340518c9b0cb67927f9a074cd41b009a630ffcf7a1447b0
+  metadata.gz: 23c776bd1de10ceb68312c21159841268b06db22467ba1895212cd0c3f5e04433629b4b283c5088060b9e2ee799837a7b7b040e7cd423911defa9f99ce161fa9
+  data.tar.gz: db55e41c202e1cd493821ae1e743c544854bf4c5c30adad869652beb24ea6d25ca23751a9b5a21990ea845dd4924167a206492cd321c9bdbd0c356225be21766

data/README.md

@@ -1,5 +1,10 @@
 # Decidim::AccessRequests
 
+[![Build Status](https://travis-ci.com/mainio/decidim-module-access_requests.svg?branch=master)](https://travis-ci.com/mainio/decidim-module-access_requests)
+[![codecov](https://codecov.io/gh/mainio/decidim-module-access_requests/branch/master/graph/badge.svg)](https://codecov.io/gh/mainio/decidim-module-access_requests)
+
+The gem has been developed by [Mainio Tech](https://www.mainiotech.fi/).
+
 A [Decidim](https://github.com/decidim/decidim) module that provides a new
 verification method that allows system administrators to define new verification
 workflows where the admins can provide access to specific users.
@@ -23,14 +28,15 @@ from the admin panel. This way, the users won't have to create the access
 requests themselves and they are automatically granted the access once the admin
 has given it.
 
-The gem has been developed by [Mainio Tech](https://www.mainiotech.fi/).
+Development of this gem has been sponsored by the
+[City of Helsinki](https://www.hel.fi/).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'decidim-access_requests', :git => 'git@github.com:mainio/decidim-module-access_requests.git'
+gem "decidim-access_requests"
 ```
 
 And then execute:
@@ -63,12 +69,104 @@ en:
 
 ## Usage
 
-TODO
+For enabling the verifcation method:
+
+- Follow the installation instructions above.
+- Login to the system management section of Decidim at `/system`.
+- Enable the newly added verification method.
+
+After enabled, you can now send authorization requests for admins:
+
+- Login to Decidim.
+- Go to My account > Authorizations.
+- Click the newly added authorization ("Your access requests").
+- Click "Send request".
+
+After the request is sent, you can now login as admin to approve the request:
+
+- Login to Decidim as an admin user.
+- Go to Admin dashboard > Users > Verifications > Access requests.
+- You will see a list of received requests.
+- Click the check icon to approve an access request.
+
+After this, you can now control the access to certain functionality using
+Decidim's permissions (e.g. component permssions). For example, you can limit
+the creation of new proposals only for approved users.
+
+You are not limited for waiting for the users to send the requests. Another way
+to grant access is to directly grant it for the users. To do this:
+
+- Login to Decidim as an admin user.
+- Go to Admin dashboard > Users > Verifications > Access requests.
+- Click "Granted requests" from the top right corner of the view.
+- You will see a list of granted access requests if any are available.
+- Click "New" from the top right corner of the view.
+- Search the user you want to grant access to.
+- Click the check icon in the "Actions" column of the users listing.
+
+After this, the user is directly authorized to access the limited actions.
 
 ## Contributing
 
 See [Decidim](https://github.com/decidim/decidim).
 
+### Developing
+
+To start contributing to this project, first:
+
+- Install the basic dependencies (such as Ruby and PostgreSQL)
+- Clone this repository
+
+Decidim's main repository also provides a Docker configuration file if you
+prefer to use Docker instead of installing the dependencies locally on your
+machine.
+
+You can create the development app by running the following commands after
+cloning this project:
+
+```bash
+$ bundle
+$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake development_app
+```
+
+Note that the database user has to have rights to create and drop a database in
+order to create the dummy test app database.
+
+Then to test how the module works in Decidim, start the development server:
+
+```bash
+$ cd development_app
+$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rails s
+```
+
+In case you are using [rbenv](https://github.com/rbenv/rbenv) and have the
+[rbenv-vars](https://github.com/rbenv/rbenv-vars) plugin installed for it, you
+can add the environment variables to the root directory of the project in a file
+named `.rbenv-vars`. If these are defined for the environment, you can omit
+defining these in the commands shown above.
+
+#### Code Styling
+
+Please follow the code styling defined by the different linters that ensure we
+are all talking with the same language collaborating on the same project. This
+project is set to follow the same rules that Decidim itself follows.
+
+[Rubocop](https://rubocop.readthedocs.io/) linter is used for the Ruby language.
+
+You can run the code styling checks by running the following commands from the
+console:
+
+```
+$ bundle exec rubocop
+```
+
+To ease up following the style guide, you should install the plugin to your
+favorite editor, such as:
+
+- Atom - [linter-rubocop](https://atom.io/packages/linter-rubocop)
+- Sublime Text - [Sublime RuboCop](https://github.com/pderichs/sublime_rubocop)
+- Visual Studio Code - [Rubocop for Visual Studio Code](https://github.com/misogi/vscode-ruby-rubocop)
+
 ### Testing
 
 To run the tests run the following in the gem development path:
@@ -94,12 +192,19 @@ If you want to generate the code coverage report for the tests, you can use
 the `SIMPLECOV=1` environment variable in the rspec command as follows:
 
 ```bash
-SIMPLECOV=1 bundle exec rspec
+$ SIMPLECOV=1 bundle exec rspec
 ```
 
 This will generate a folder named `coverage` in the project root which contains
 the code coverage report.
 
+### Localization
+
+If you would like to see this module in your own language, you can help with its
+translation at Crowdin:
+
+https://crowdin.com/project/decidim-access-requests
+
 ## License
 
 See [LICENSE-AGPLv3.txt](LICENSE-AGPLv3.txt).

data/Rakefile

@@ -6,10 +6,40 @@ desc "Generates a dummy app for testing"
 task test_app: "decidim:generate_external_test_app"
 
 desc "Generates a development app."
-task development_app: "decidim:generate_external_development_app"
+task :development_app do
+  Bundler.with_original_env do
+    generate_decidim_app(
+      "development_app",
+      "--app_name",
+      "#{base_app_name}_development_app",
+      "--path",
+      "..",
+      "--recreate_db",
+      "--demo"
+    )
+  end
+
+  # Copy the initializer and translation file to the development app folder
+  base_path = __dir__
+  source_path = "#{base_path}/lib/decidim/access_requests/generators/app_templates"
+  target_path = "#{base_path}/development_app/config"
+  FileUtils.cp(
+    "#{source_path}/initializer.rb",
+    "#{target_path}/initializers/decidim_verifications_access_requests.rb"
+  )
+  FileUtils.cp(
+    "#{source_path}/en.yml",
+    "#{target_path}/locales/decidim-access_requests.en.yml"
+  )
+
+  # Seed the DB after the initializer has been installed
+  Dir.chdir("development_app") do
+    system("bundle exec rake db:seed")
+  end
+end
 
 # Run all tests, include all
-RSpec::Core::RakeTask.new(:spec) do |t, task_args|
+RSpec::Core::RakeTask.new(:spec) do |t|
   t.verbose = false
 end
 

data/app/controllers/decidim/access_requests/verification/admin/granted_authorizations_controller.rb

@@ -18,9 +18,7 @@ module Decidim
           def index
             enforce_permission_to :index, :authorization
 
-            @granted_authorizations = AuthorizationPresenter.for_collection(
-              granted_authorizations
-            )
+            @granted_authorizations = granted_authorizations
           end
 
           def new
@@ -90,7 +88,7 @@ module Decidim
               organization: current_organization,
               name: verification_manifest.name,
               granted: true
-            )
+            ).query.page(params[:page]).per(15)
           end
 
           def authorization

data/app/controllers/decidim/access_requests/verification/admin/pending_authorizations_controller.rb

@@ -12,9 +12,7 @@ module Decidim
           def index
             enforce_permission_to :index, :authorization
 
-            @pending_authorizations = AuthorizationPresenter.for_collection(
-              pending_authorizations
-            )
+            @pending_authorizations = pending_authorizations
           end
 
           def update
@@ -60,7 +58,7 @@ module Decidim
               organization: current_organization,
               name: verification_manifest.name,
               granted: false
-            )
+            ).query.page(params[:page]).per(15)
           end
 
           def authorization

data/app/views/decidim/access_requests/verification/admin/granted_authorizations/index.html.erb

@@ -40,5 +40,6 @@
         <% end %>
       </tbody>
     </table>
+    <%= paginate @granted_authorizations, theme: "decidim" %>
   </div>
 </div>

data/app/views/decidim/access_requests/verification/admin/pending_authorizations/index.html.erb

@@ -44,5 +44,6 @@
         <% end %>
       </tbody>
     </table>
+    <%= paginate @pending_authorizations, theme: "decidim" %>
   </div>
 </div>

data/config/locales/fi.yml

@@ -58,7 +58,8 @@ fi:
               description: Odota pyynnön tarkastusta.
             step3:
               title: Vaihe 3
-              description: Saat ilmoituksen, kun pyyntösi on käsitelty.
+              description: >
+                Saat ilmoituksen, kun pyyntösi on käsitelty.
     events:
       access_requests:
         confirmed:

data/config/locales/sv.yml

@@ -59,8 +59,7 @@ sv:
             step3:
               title: Step 3
               description: >
-                You will get notified once the request review has been
-                completed.
+                You will get notified once the request review has been completed.
     events:
       access_requests:
         confirmed:

data/lib/decidim/access_requests/generators/app_templates/en.yml

@@ -0,0 +1,6 @@
+en:
+  decidim:
+    authorization_handlers:
+      access_requests:
+        explanation: An admin will approve or deny access
+        name: Access requests

data/lib/decidim/access_requests/generators/app_templates/initializer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Decidim::Verifications.register_workflow(:access_requests) do |workflow|
+  workflow.engine = Decidim::AccessRequests::Verification::Engine
+  workflow.admin_engine = Decidim::AccessRequests::Verification::AdminEngine
+end

data/lib/decidim/access_requests/verification/engine.rb

@@ -18,6 +18,13 @@ module Decidim
           app.config.assets.precompile += %w(decidim_access_requests_manifest.css
                                              decidim/access_requests/verification.scss)
         end
+
+        def load_seed
+          # Enable the `:access_requests` authorization
+          org = Decidim::Organization.first
+          org.available_authorizations << :access_requests
+          org.save!
+        end
       end
     end
   end

data/lib/decidim/access_requests/version.rb

@@ -2,7 +2,7 @@
 
 module Decidim
   module AccessRequests
-    VERSION = "0.16.0"
+    VERSION = "0.16.1"
     DECIDIM_VERSION = "~> 0.16.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decidim-access_requests
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.16.1
 platform: ruby
 authors:
 - Antti Hukkanen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-06 00:00:00.000000000 Z
+date: 2019-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim-admin
@@ -100,6 +100,8 @@ files:
 - config/locales/fi.yml
 - config/locales/sv.yml
 - lib/decidim/access_requests.rb
+- lib/decidim/access_requests/generators/app_templates/en.yml
+- lib/decidim/access_requests/generators/app_templates/initializer.rb
 - lib/decidim/access_requests/verification.rb
 - lib/decidim/access_requests/verification/admin.rb
 - lib/decidim/access_requests/verification/admin_engine.rb
@@ -125,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Allows admins to add new access request authorizations.