Compare commits
54 Commits
92d959ffbb
...
v0.2.1
| Author | SHA1 | Date | |
|---|---|---|---|
| 8903ae2624 | |||
|
26e9073674
|
|||
| 73a89c2601 | |||
|
7d4dee17b7
|
|||
| 602ca6ee94 | |||
|
69fc1ca57e
|
|||
|
ee72a32c7e
|
|||
|
8a0d89ef60
|
|||
|
54af949c7d
|
|||
|
6dac732a7f
|
|||
|
e8c1a6066a
|
|||
| 44fadb12d6 | |||
|
533452469b
|
|||
| efe168b205 | |||
|
5b6d6bbd00
|
|||
|
458b585cdb
|
|||
|
f651289410
|
|||
|
7ca91cf882
|
|||
|
022094ce51
|
|||
| 2a2b0a90dc | |||
| e44535daee | |||
| c8ccb418b2 | |||
| a792d66c90 | |||
| f7e48ad3a6 | |||
|
8a7d809b92
|
|||
|
b8e75c7c4a
|
|||
|
7a58babd8e
|
|||
|
ba31ed559a
|
|||
|
9cebfd3f58
|
|||
|
7aadb5cb51
|
|||
|
69b99711e5
|
|||
|
e5fe843814
|
|||
|
d7fbda0855
|
|||
|
18df8fe449
|
|||
| fd2ebc4ad3 | |||
|
c86480e72b
|
|||
|
5933c387b6
|
|||
| e855e3cf61 | |||
|
91c3f8da2d
|
|||
|
8bd69b2adb
|
|||
|
8493dfcf9b
|
|||
| 6550a8b4f8 | |||
|
fa8650b43a
|
|||
|
8a938831e9
|
|||
|
151bd58cb4
|
|||
|
98b5af54ea
|
|||
| 61b722e868 | |||
|
0eab4f03ac
|
|||
|
c96a84d1a1
|
|||
|
86cd5824e6
|
|||
|
d420ef9eac
|
|||
|
a7a3974ef3
|
|||
|
cd59215b69
|
|||
|
0b125cf323
|
43
.drone.yml
Normal file
43
.drone.yml
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
kind: pipeline
|
||||||
|
type: docker
|
||||||
|
name: CI build
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: restore-cache
|
||||||
|
image: drillster/drone-volume-cache
|
||||||
|
volumes:
|
||||||
|
- name: cache
|
||||||
|
path: /cache
|
||||||
|
settings:
|
||||||
|
restore: true
|
||||||
|
mount:
|
||||||
|
- vendor
|
||||||
|
when:
|
||||||
|
branch:
|
||||||
|
- master
|
||||||
|
- name: rspec
|
||||||
|
image: guildeducation/rails:2.7.1-12.19.0
|
||||||
|
commands:
|
||||||
|
- bundle install --jobs=3 --retry=3 --deployment
|
||||||
|
- yarn install
|
||||||
|
- bundle exec rspec
|
||||||
|
when:
|
||||||
|
branch:
|
||||||
|
- master
|
||||||
|
- name: rebuild-cache
|
||||||
|
image: drillster/drone-volume-cache
|
||||||
|
volumes:
|
||||||
|
- name: cache
|
||||||
|
path: /cache
|
||||||
|
settings:
|
||||||
|
rebuild: true
|
||||||
|
mount:
|
||||||
|
- vendor
|
||||||
|
when:
|
||||||
|
branch:
|
||||||
|
- master
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
- name: cache
|
||||||
|
host:
|
||||||
|
path: /var/lib/drone/tmp
|
||||||
@@ -1,8 +1 @@
|
|||||||
LDAP_HOST=192.168.33.10
|
EJABBERD_API_URL='https://xmpp.kosmos.org/api'
|
||||||
LDAP_PORT=389
|
|
||||||
#
|
|
||||||
# Production LDAP server:
|
|
||||||
#
|
|
||||||
# LDAP_HOST=ldap.kosmos.org
|
|
||||||
# LDAP_PORT=636
|
|
||||||
# LDAP_USE_TLS=true
|
|
||||||
|
|||||||
1
.env.production
Normal file
1
.env.production
Normal file
@@ -0,0 +1 @@
|
|||||||
|
EJABBERD_API_URL='https://xmpp.kosmos.org:5443/api'
|
||||||
15
Gemfile
15
Gemfile
@@ -1,12 +1,8 @@
|
|||||||
source 'https://rubygems.org'
|
source 'https://rubygems.org'
|
||||||
git_source(:github) { |repo| "https://github.com/#{repo}.git" }
|
git_source(:github) { |repo| "https://github.com/#{repo}.git" }
|
||||||
|
|
||||||
ruby '2.6.1'
|
|
||||||
|
|
||||||
# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
|
# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
|
||||||
gem 'rails', '~> 6.0.3', '>= 6.0.3.4'
|
gem 'rails', '~> 6.0.3', '>= 6.0.3.4'
|
||||||
# Use sqlite3 as the database for Active Record
|
|
||||||
gem 'sqlite3', '~> 1.4'
|
|
||||||
# Use Puma as the app server
|
# Use Puma as the app server
|
||||||
gem 'puma', '~> 4.1'
|
gem 'puma', '~> 4.1'
|
||||||
# Use SCSS for stylesheets
|
# Use SCSS for stylesheets
|
||||||
@@ -25,14 +21,18 @@ gem 'jbuilder', '~> 2.7'
|
|||||||
# Reduces boot times through caching; required in config/boot.rb
|
# Reduces boot times through caching; required in config/boot.rb
|
||||||
gem 'bootsnap', '>= 1.4.2', require: false
|
gem 'bootsnap', '>= 1.4.2', require: false
|
||||||
|
|
||||||
gem 'dotenv-rails', groups: [:development, :test]
|
gem 'dotenv-rails'
|
||||||
|
|
||||||
gem 'warden'
|
gem 'warden'
|
||||||
gem 'devise'
|
gem 'devise'
|
||||||
gem 'devise_ldap_authenticatable'
|
gem 'devise_ldap_authenticatable'
|
||||||
gem 'net-ldap'
|
gem 'net-ldap'
|
||||||
|
|
||||||
|
gem 'faraday'
|
||||||
|
|
||||||
group :development, :test do
|
group :development, :test do
|
||||||
|
# Use sqlite3 as the database for Active Record
|
||||||
|
gem 'sqlite3', '~> 1.4'
|
||||||
# Call 'byebug' anywhere in the code to stop execution and get a debugger console
|
# Call 'byebug' anywhere in the code to stop execution and get a debugger console
|
||||||
gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
|
gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
|
||||||
end
|
end
|
||||||
@@ -53,7 +53,12 @@ group :test do
|
|||||||
gem 'factory_bot_rails'
|
gem 'factory_bot_rails'
|
||||||
gem 'capybara'
|
gem 'capybara'
|
||||||
gem 'database_cleaner'
|
gem 'database_cleaner'
|
||||||
|
gem 'webmock'
|
||||||
end
|
end
|
||||||
|
|
||||||
|
group :production do
|
||||||
|
# Use postgresql as the database for Active Record
|
||||||
|
gem 'pg', '~> 1.2.3'
|
||||||
|
end
|
||||||
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
|
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
|
||||||
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
|
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
|
||||||
|
|||||||
18
Gemfile.lock
18
Gemfile.lock
@@ -73,6 +73,8 @@ GEM
|
|||||||
regexp_parser (~> 1.5)
|
regexp_parser (~> 1.5)
|
||||||
xpath (~> 3.2)
|
xpath (~> 3.2)
|
||||||
concurrent-ruby (1.1.7)
|
concurrent-ruby (1.1.7)
|
||||||
|
crack (0.4.3)
|
||||||
|
safe_yaml (~> 1.0.0)
|
||||||
crass (1.0.6)
|
crass (1.0.6)
|
||||||
database_cleaner (1.8.5)
|
database_cleaner (1.8.5)
|
||||||
devise (4.7.3)
|
devise (4.7.3)
|
||||||
@@ -95,9 +97,12 @@ GEM
|
|||||||
factory_bot_rails (6.1.0)
|
factory_bot_rails (6.1.0)
|
||||||
factory_bot (~> 6.1.0)
|
factory_bot (~> 6.1.0)
|
||||||
railties (>= 5.0.0)
|
railties (>= 5.0.0)
|
||||||
|
faraday (0.17.0)
|
||||||
|
multipart-post (>= 1.2, < 3)
|
||||||
ffi (1.13.1)
|
ffi (1.13.1)
|
||||||
globalid (0.4.2)
|
globalid (0.4.2)
|
||||||
activesupport (>= 4.2.0)
|
activesupport (>= 4.2.0)
|
||||||
|
hashdiff (0.4.0)
|
||||||
i18n (1.8.5)
|
i18n (1.8.5)
|
||||||
concurrent-ruby (~> 1.0)
|
concurrent-ruby (~> 1.0)
|
||||||
jbuilder (2.10.1)
|
jbuilder (2.10.1)
|
||||||
@@ -126,11 +131,13 @@ GEM
|
|||||||
mini_portile2 (2.4.0)
|
mini_portile2 (2.4.0)
|
||||||
minitest (5.14.2)
|
minitest (5.14.2)
|
||||||
msgpack (1.3.3)
|
msgpack (1.3.3)
|
||||||
|
multipart-post (2.1.1)
|
||||||
net-ldap (0.16.3)
|
net-ldap (0.16.3)
|
||||||
nio4r (2.5.4)
|
nio4r (2.5.4)
|
||||||
nokogiri (1.10.10)
|
nokogiri (1.10.10)
|
||||||
mini_portile2 (~> 2.4.0)
|
mini_portile2 (~> 2.4.0)
|
||||||
orm_adapter (0.5.0)
|
orm_adapter (0.5.0)
|
||||||
|
pg (1.2.3)
|
||||||
public_suffix (4.0.6)
|
public_suffix (4.0.6)
|
||||||
puma (4.3.6)
|
puma (4.3.6)
|
||||||
nio4r (~> 2.0)
|
nio4r (~> 2.0)
|
||||||
@@ -190,6 +197,7 @@ GEM
|
|||||||
rspec-mocks (~> 3.9)
|
rspec-mocks (~> 3.9)
|
||||||
rspec-support (~> 3.9)
|
rspec-support (~> 3.9)
|
||||||
rspec-support (3.10.0)
|
rspec-support (3.10.0)
|
||||||
|
safe_yaml (1.0.5)
|
||||||
sass-rails (6.0.0)
|
sass-rails (6.0.0)
|
||||||
sassc-rails (~> 2.1, >= 2.1.1)
|
sassc-rails (~> 2.1, >= 2.1.1)
|
||||||
sassc (2.4.0)
|
sassc (2.4.0)
|
||||||
@@ -227,6 +235,10 @@ GEM
|
|||||||
activemodel (>= 6.0.0)
|
activemodel (>= 6.0.0)
|
||||||
bindex (>= 0.4.0)
|
bindex (>= 0.4.0)
|
||||||
railties (>= 6.0.0)
|
railties (>= 6.0.0)
|
||||||
|
webmock (3.6.0)
|
||||||
|
addressable (>= 2.3.6)
|
||||||
|
crack (>= 0.3.2)
|
||||||
|
hashdiff (>= 0.4.0, < 2.0.0)
|
||||||
webpacker (4.3.0)
|
webpacker (4.3.0)
|
||||||
activesupport (>= 4.2)
|
activesupport (>= 4.2)
|
||||||
rack-proxy (>= 0.6.1)
|
rack-proxy (>= 0.6.1)
|
||||||
@@ -250,11 +262,13 @@ DEPENDENCIES
|
|||||||
devise_ldap_authenticatable
|
devise_ldap_authenticatable
|
||||||
dotenv-rails
|
dotenv-rails
|
||||||
factory_bot_rails
|
factory_bot_rails
|
||||||
|
faraday
|
||||||
jbuilder (~> 2.7)
|
jbuilder (~> 2.7)
|
||||||
letter_opener
|
letter_opener
|
||||||
letter_opener_web
|
letter_opener_web
|
||||||
listen (~> 3.2)
|
listen (~> 3.2)
|
||||||
net-ldap
|
net-ldap
|
||||||
|
pg (~> 1.2.3)
|
||||||
puma (~> 4.1)
|
puma (~> 4.1)
|
||||||
rails (~> 6.0.3, >= 6.0.3.4)
|
rails (~> 6.0.3, >= 6.0.3.4)
|
||||||
rspec-rails
|
rspec-rails
|
||||||
@@ -266,10 +280,8 @@ DEPENDENCIES
|
|||||||
tzinfo-data
|
tzinfo-data
|
||||||
warden
|
warden
|
||||||
web-console (>= 3.3.0)
|
web-console (>= 3.3.0)
|
||||||
|
webmock
|
||||||
webpacker (~> 4.0)
|
webpacker (~> 4.0)
|
||||||
|
|
||||||
RUBY VERSION
|
|
||||||
ruby 2.6.1p33
|
|
||||||
|
|
||||||
BUNDLED WITH
|
BUNDLED WITH
|
||||||
2.0.2
|
2.0.2
|
||||||
|
|||||||
661
LICENSE
Normal file
661
LICENSE
Normal file
@@ -0,0 +1,661 @@
|
|||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2020 Kosmos Contributors <https://kosmos.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
65
README.md
65
README.md
@@ -1,28 +1,67 @@
|
|||||||
# README
|
# Akkounts
|
||||||
|
|
||||||
This README would normally document whatever steps are necessary to get the
|
This app allows Kosmos/LDAP users to manage their accounts, including
|
||||||
application up and running.
|
credentials, invites, donations, etc..
|
||||||
|
|
||||||
Things you may want to cover:
|
## Features
|
||||||
|
|
||||||
* Ruby version
|
* [x] Log in with existing LDAP account
|
||||||
|
* [x] Reset account password by providing both username and email address
|
||||||
|
* [x] Reset account password when logged in, via reset email
|
||||||
|
* [x] Log in with admin permissions
|
||||||
|
* [x] View LDAP users as admin
|
||||||
|
* [x] Sign up for a new account via invitation
|
||||||
|
* [ ] List my donations
|
||||||
|
* [ ] Invite new users from your account
|
||||||
|
* [ ] Sign up for a new account by donating upfront
|
||||||
|
* [ ] Sign up for a new account via proving contributions (via cryptographic signature)
|
||||||
|
* [ ] ...
|
||||||
|
|
||||||
* System dependencies
|
_Planned features are not at all a complete or static list, of course.
|
||||||
|
Suggestions and pull requests welcome!_
|
||||||
|
|
||||||
* Configuration
|
## Development
|
||||||
|
|
||||||
* Database creation
|
### Rails app
|
||||||
|
|
||||||
* Database initialization
|
Installing dependencies:
|
||||||
|
|
||||||
* How to run the test suite
|
bundle install
|
||||||
|
yarn install
|
||||||
|
|
||||||
* Services (job queues, cache servers, search engines, etc.)
|
Setting up local database (SQLite):
|
||||||
|
|
||||||
* Deployment instructions
|
bundle exec rails db:create
|
||||||
|
bundle exec rails db:migrate
|
||||||
|
|
||||||
* ...
|
Running the dev server:
|
||||||
|
|
||||||
|
bundle exec rails server
|
||||||
|
|
||||||
|
Running all specs:
|
||||||
|
|
||||||
|
bundle exec rspec
|
||||||
|
|
||||||
|
### LDAP server
|
||||||
|
|
||||||
|
TODO make it easy to run a local Kosmos LDAP server for development, without
|
||||||
|
manual LDIF imports etc. (or provide a staging instance)
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
|
* [Ruby on Rails](https://guides.rubyonrails.org/)
|
||||||
|
* [Sass](https://sass-lang.com/documentation)
|
||||||
|
|
||||||
|
### Testing
|
||||||
|
|
||||||
|
* [RSpec](https://rspec.info/documentation/)
|
||||||
|
* [Capybara](https://rubydoc.info/github/teamcapybara/capybara/master)
|
||||||
|
|
||||||
|
### LDAP / Auth
|
||||||
|
|
||||||
|
* [devise_ldap_authenticatable](https://github.com/cschiewek/devise_ldap_authenticatable)
|
||||||
* [net/ldap](https://www.rubydoc.info/gems/net-ldap/Net/LDAP)
|
* [net/ldap](https://www.rubydoc.info/gems/net-ldap/Net/LDAP)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[GNU Affero General Public License v3.0](https://choosealicense.com/licenses/agpl-3.0/)
|
||||||
|
|||||||
33
app/assets/stylesheets/_mediaqueries.scss
Normal file
33
app/assets/stylesheets/_mediaqueries.scss
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
$breakpoints-max: (
|
||||||
|
small: 600px,
|
||||||
|
medium: 960px,
|
||||||
|
large: 1280px
|
||||||
|
);
|
||||||
|
|
||||||
|
$breakpoints-min: (
|
||||||
|
small: 601px,
|
||||||
|
medium: 961px,
|
||||||
|
large: 1281px
|
||||||
|
);
|
||||||
|
|
||||||
|
@mixin media-max($screen-size) {
|
||||||
|
@if map-has-key($breakpoints-max, $screen-size) {
|
||||||
|
@media (max-width: map-get($breakpoints-max, $screen-size)) {
|
||||||
|
@content;
|
||||||
|
}
|
||||||
|
} @else {
|
||||||
|
// Debugging
|
||||||
|
@warn "'#{$screen-size}' has not been declared as a breakpoint."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@mixin media-min($screen-size) {
|
||||||
|
@if map-has-key($breakpoints-min, $screen-size) {
|
||||||
|
@media (min-width: map-get($breakpoints-min, $screen-size)) {
|
||||||
|
@content;
|
||||||
|
}
|
||||||
|
} @else {
|
||||||
|
// Debugging
|
||||||
|
@warn "'#{$screen-size}' has not been declared as a breakpoint."
|
||||||
|
}
|
||||||
|
}
|
||||||
35
app/assets/stylesheets/forms.scss
Normal file
35
app/assets/stylesheets/forms.scss
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
form {
|
||||||
|
.field_with_errors {
|
||||||
|
display: inline-block;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.layout-signup {
|
||||||
|
label {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
input[type=text], input[type=email], input[type=password] {
|
||||||
|
font-size: 1.25rem;
|
||||||
|
padding: 0.5rem 1rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
span.at-sign, span.domain {
|
||||||
|
font-size: 1.25rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.error-msg {
|
||||||
|
color: #bc0101;
|
||||||
|
}
|
||||||
|
|
||||||
|
.actions {
|
||||||
|
margin-top: 2rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.accept-terms {
|
||||||
|
margin-top: 2rem;
|
||||||
|
font-size: 0.85rem;
|
||||||
|
line-height: 1.5em;
|
||||||
|
color: #888;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,3 +1,5 @@
|
|||||||
|
@import "mediaqueries";
|
||||||
|
|
||||||
$content-width: 800px;
|
$content-width: 800px;
|
||||||
$content-max-width: 100%;
|
$content-max-width: 100%;
|
||||||
|
|
||||||
@@ -15,6 +17,10 @@ body {
|
|||||||
background: #0d4f99;
|
background: #0d4f99;
|
||||||
background: linear-gradient(35deg, #8955a0 0, #0d4f99 100%);
|
background: linear-gradient(35deg, #8955a0 0, #0d4f99 100%);
|
||||||
|
|
||||||
|
@include media-max(small) {
|
||||||
|
padding: 3rem 0;
|
||||||
|
}
|
||||||
|
|
||||||
h1 {
|
h1 {
|
||||||
font-size: 1.8rem;
|
font-size: 1.8rem;
|
||||||
color: #fff;
|
color: #fff;
|
||||||
@@ -42,6 +48,10 @@ body {
|
|||||||
margin-top: 2rem;
|
margin-top: 2rem;
|
||||||
color: rgba(255,255,255,0.6);
|
color: rgba(255,255,255,0.6);
|
||||||
|
|
||||||
|
@include media-max(small) {
|
||||||
|
font-size: 0.85rem;
|
||||||
|
}
|
||||||
|
|
||||||
strong {
|
strong {
|
||||||
font-weight: 400;
|
font-weight: 400;
|
||||||
color: #fff;
|
color: #fff;
|
||||||
@@ -81,6 +91,14 @@ main {
|
|||||||
margin: 4rem auto;
|
margin: 4rem auto;
|
||||||
text-align: left;
|
text-align: left;
|
||||||
|
|
||||||
|
@include media-max(medium) {
|
||||||
|
max-width: 90%;
|
||||||
|
}
|
||||||
|
|
||||||
|
@include media-max(small) {
|
||||||
|
margin: 3rem auto;
|
||||||
|
}
|
||||||
|
|
||||||
h2, h3 {
|
h2, h3 {
|
||||||
margin-bottom: 1.5em;
|
margin-bottom: 1.5em;
|
||||||
}
|
}
|
||||||
@@ -119,6 +137,11 @@ main {
|
|||||||
border-bottom: 1px dotted #ccc;
|
border-bottom: 1px dotted #ccc;
|
||||||
padding-bottom: 4rem;
|
padding-bottom: 4rem;
|
||||||
margin-bottom: 4rem;
|
margin-bottom: 4rem;
|
||||||
|
|
||||||
|
@include media-max(small) {
|
||||||
|
padding-bottom: 3rem;
|
||||||
|
margin-bottom: 3rem;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -130,6 +153,10 @@ main {
|
|||||||
grid-row-gap: 1rem;
|
grid-row-gap: 1rem;
|
||||||
grid-column-gap: 2rem;
|
grid-column-gap: 2rem;
|
||||||
|
|
||||||
|
@include media-max(small) {
|
||||||
|
grid-template-columns: 1fr;
|
||||||
|
}
|
||||||
|
|
||||||
margin-top: 3rem;
|
margin-top: 3rem;
|
||||||
|
|
||||||
h3 {
|
h3 {
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ class Admin::LdapUsersController < Admin::BaseController
|
|||||||
private
|
private
|
||||||
|
|
||||||
def ldap_client
|
def ldap_client
|
||||||
ldap_client ||= Net::LDAP.new host: ENV['LDAP_HOST'],
|
ldap_client ||= Net::LDAP.new host: ldap_config['host'],
|
||||||
port: ldap_config['port'],
|
port: ldap_config['port'],
|
||||||
encryption: ldap_config['ssl'],
|
encryption: ldap_config['ssl'],
|
||||||
auth: {
|
auth: {
|
||||||
|
|||||||
@@ -9,6 +9,12 @@ class ApplicationController < ActionController::Base
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def require_user_signed_out
|
||||||
|
if user_signed_in?
|
||||||
|
redirect_to root_path and return
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
def authorize_admin
|
def authorize_admin
|
||||||
http_status :forbidden unless current_user.is_admin?
|
http_status :forbidden unless current_user.is_admin?
|
||||||
end
|
end
|
||||||
|
|||||||
49
app/controllers/invitations_controller.rb
Normal file
49
app/controllers/invitations_controller.rb
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
class InvitationsController < ApplicationController
|
||||||
|
before_action :require_user_signed_in, except: ["show"]
|
||||||
|
before_action :require_user_signed_out, only: ["show"]
|
||||||
|
|
||||||
|
layout "signup", only: ["show"]
|
||||||
|
|
||||||
|
# GET /invitations
|
||||||
|
def index
|
||||||
|
@invitations_unused = current_user.invitations.unused
|
||||||
|
@invitations_used = current_user.invitations.used
|
||||||
|
end
|
||||||
|
|
||||||
|
# GET /invitations/a-random-invitation-token
|
||||||
|
def show
|
||||||
|
token = session[:invitation_token] = params[:id]
|
||||||
|
|
||||||
|
if Invitation.where(token: token, used_at: nil).exists?
|
||||||
|
redirect_to signup_path and return
|
||||||
|
else
|
||||||
|
flash.now[:alert] = "This invitation either doesn't exist or has already been used."
|
||||||
|
http_status :unauthorized
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# POST /invitations
|
||||||
|
def create
|
||||||
|
@invitation = Invitation.new(user: current_user)
|
||||||
|
|
||||||
|
respond_to do |format|
|
||||||
|
if @invitation.save
|
||||||
|
format.html { redirect_to @invitation, notice: 'Invitation was successfully created.' }
|
||||||
|
format.json { render :show, status: :created, location: @invitation }
|
||||||
|
else
|
||||||
|
format.html { render :new }
|
||||||
|
format.json { render json: @invitation.errors, status: :unprocessable_entity }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# DELETE /invitations/1
|
||||||
|
def destroy
|
||||||
|
@invitation = current_user.invitations.find(params[:id])
|
||||||
|
@invitation.destroy
|
||||||
|
respond_to do |format|
|
||||||
|
format.html { redirect_to invitations_url }
|
||||||
|
format.json { head :no_content }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
108
app/controllers/signup_controller.rb
Normal file
108
app/controllers/signup_controller.rb
Normal file
@@ -0,0 +1,108 @@
|
|||||||
|
class SignupController < ApplicationController
|
||||||
|
before_action :require_user_signed_out
|
||||||
|
before_action :require_invitation
|
||||||
|
before_action :set_invitation
|
||||||
|
before_action :set_new_user, only: ["steps", "validate"]
|
||||||
|
|
||||||
|
layout "signup"
|
||||||
|
|
||||||
|
def index
|
||||||
|
@invited_by_name = @invitation.user.address
|
||||||
|
end
|
||||||
|
|
||||||
|
def steps
|
||||||
|
@step = params[:step].to_i
|
||||||
|
http_status :not_found unless [1,2,3].include?(@step)
|
||||||
|
@validation_error = session[:validation_error]
|
||||||
|
end
|
||||||
|
|
||||||
|
def validate
|
||||||
|
session[:validation_error] = nil
|
||||||
|
|
||||||
|
case user_params.keys.first
|
||||||
|
when "cn"
|
||||||
|
@user.cn = user_params[:cn]
|
||||||
|
@user.valid?
|
||||||
|
session[:new_user] = @user
|
||||||
|
|
||||||
|
if @user.errors[:cn].present?
|
||||||
|
session[:validation_error] = @user.errors[:cn].first # Store user including validation errors
|
||||||
|
redirect_to signup_steps_path(1) and return
|
||||||
|
else
|
||||||
|
redirect_to signup_steps_path(2) and return
|
||||||
|
end
|
||||||
|
when "email"
|
||||||
|
@user.email = user_params[:email]
|
||||||
|
@user.valid?
|
||||||
|
session[:new_user] = @user
|
||||||
|
|
||||||
|
if @user.errors[:email].present?
|
||||||
|
session[:validation_error] = @user.errors[:email].first # Store user including validation errors
|
||||||
|
redirect_to signup_steps_path(2) and return
|
||||||
|
else
|
||||||
|
redirect_to signup_steps_path(3) and return
|
||||||
|
end
|
||||||
|
when "password"
|
||||||
|
@user.password = user_params[:password]
|
||||||
|
@user.password_confirmation = user_params[:password]
|
||||||
|
@user.valid?
|
||||||
|
session[:new_user] = @user
|
||||||
|
|
||||||
|
if @user.errors[:password].present?
|
||||||
|
session[:validation_error] = @user.errors[:password].first # Store user including validation errors
|
||||||
|
redirect_to signup_steps_path(3) and return
|
||||||
|
else
|
||||||
|
complete_signup
|
||||||
|
msg = "Almost done! We have sent you an email to confirm your address."
|
||||||
|
redirect_to(check_your_email_path, notice: msg) and return
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def user_params
|
||||||
|
params.require(:user).permit(:cn, :email, :password)
|
||||||
|
end
|
||||||
|
|
||||||
|
def require_invitation
|
||||||
|
if session[:invitation_token].blank?
|
||||||
|
flash.now[:alert] = "You need an invitation to sign up for an account."
|
||||||
|
http_status :unauthorized
|
||||||
|
elsif !valid_invitation?(session[:invitation_token])
|
||||||
|
flash.now[:alert] = "This invitation either doesn't exist or has already been used."
|
||||||
|
http_status :unauthorized
|
||||||
|
end
|
||||||
|
|
||||||
|
@invitation = Invitation.find_by(token: session[:invitation_token])
|
||||||
|
end
|
||||||
|
|
||||||
|
def valid_invitation?(token)
|
||||||
|
Invitation.where(token: session[:invitation_token], used_at: nil).exists?
|
||||||
|
end
|
||||||
|
|
||||||
|
def set_invitation
|
||||||
|
@invitation = Invitation.find_by(token: session[:invitation_token])
|
||||||
|
end
|
||||||
|
|
||||||
|
def set_new_user
|
||||||
|
if session[:new_user].present?
|
||||||
|
@user = User.new(session[:new_user])
|
||||||
|
else
|
||||||
|
@user = User.new(ou: "kosmos.org")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def complete_signup
|
||||||
|
session[:new_user] = nil
|
||||||
|
session[:validation_error] = nil
|
||||||
|
|
||||||
|
CreateAccount.call(
|
||||||
|
username: @user.cn,
|
||||||
|
domain: "kosmos.org",
|
||||||
|
email: @user.email,
|
||||||
|
password: @user.password,
|
||||||
|
invitation: @invitation
|
||||||
|
)
|
||||||
|
end
|
||||||
|
end
|
||||||
2
app/helpers/invitations_helper.rb
Normal file
2
app/helpers/invitations_helper.rb
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
module InvitationsHelper
|
||||||
|
end
|
||||||
2
app/helpers/signup_helper.rb
Normal file
2
app/helpers/signup_helper.rb
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
module SignupHelper
|
||||||
|
end
|
||||||
15
app/models/concerns/email_validatable.rb
Normal file
15
app/models/concerns/email_validatable.rb
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
require 'mail'
|
||||||
|
|
||||||
|
module EmailValidatable
|
||||||
|
extend ActiveSupport::Concern
|
||||||
|
|
||||||
|
class EmailValidator < ActiveModel::EachValidator
|
||||||
|
def validate_each(record, attribute, value)
|
||||||
|
begin
|
||||||
|
a = Mail::Address.new(value)
|
||||||
|
rescue Mail::Field::ParseError
|
||||||
|
record.errors[attribute] << (options[:message] || "is not a valid address")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
20
app/models/invitation.rb
Normal file
20
app/models/invitation.rb
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
class Invitation < ApplicationRecord
|
||||||
|
# Relations
|
||||||
|
belongs_to :user
|
||||||
|
|
||||||
|
# Validations
|
||||||
|
validates_presence_of :user
|
||||||
|
|
||||||
|
# Hooks
|
||||||
|
before_create :generate_token
|
||||||
|
|
||||||
|
# Scopes
|
||||||
|
scope :unused, -> { where(used_at: nil) }
|
||||||
|
scope :used, -> { where.not(used_at: nil) }
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def generate_token
|
||||||
|
self.token = SecureRandom.hex(8)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,4 +1,14 @@
|
|||||||
class User < ApplicationRecord
|
class User < ApplicationRecord
|
||||||
|
include EmailValidatable
|
||||||
|
|
||||||
|
# Relations
|
||||||
|
has_many :invitations, dependent: :destroy
|
||||||
|
|
||||||
|
validates_uniqueness_of :cn
|
||||||
|
validates_length_of :cn, :minimum => 3
|
||||||
|
validates_uniqueness_of :email
|
||||||
|
validates :email, email: true
|
||||||
|
|
||||||
# Include default devise modules. Others available are:
|
# Include default devise modules. Others available are:
|
||||||
# :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
|
# :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
|
||||||
devise :ldap_authenticatable,
|
devise :ldap_authenticatable,
|
||||||
@@ -33,4 +43,13 @@ class User < ApplicationRecord
|
|||||||
false
|
false
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def address
|
||||||
|
"#{self.cn}@#{self.ou}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def valid_attribute?(attribute_name)
|
||||||
|
self.valid?
|
||||||
|
self.errors[attribute_name].blank?
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
7
app/services/application_service.rb
Normal file
7
app/services/application_service.rb
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
class ApplicationService
|
||||||
|
# This enables executing a service's `#call` method directly via
|
||||||
|
# `MyService.call(args)`, without creating a class instance it first.
|
||||||
|
def self.call(*args, &block)
|
||||||
|
new(*args, &block).call
|
||||||
|
end
|
||||||
|
end
|
||||||
83
app/services/create_account.rb
Normal file
83
app/services/create_account.rb
Normal file
@@ -0,0 +1,83 @@
|
|||||||
|
class CreateAccount < ApplicationService
|
||||||
|
def initialize(args)
|
||||||
|
@username = args[:username]
|
||||||
|
@domain = args[:ou] || "kosmos.org"
|
||||||
|
@email = args[:email]
|
||||||
|
@password = args[:password]
|
||||||
|
@invitation = args[:invitation]
|
||||||
|
end
|
||||||
|
|
||||||
|
def call
|
||||||
|
user = create_user_in_database
|
||||||
|
add_ldap_document
|
||||||
|
|
||||||
|
if @invitation.present?
|
||||||
|
update_invitation(user.id)
|
||||||
|
exchange_xmpp_contacts
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def create_user_in_database
|
||||||
|
User.create!(
|
||||||
|
cn: @username,
|
||||||
|
ou: @domain,
|
||||||
|
email: @email,
|
||||||
|
password: @password,
|
||||||
|
password_confirmation: @password
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def update_invitation(user_id)
|
||||||
|
@invitation.update! invited_user_id: user_id, used_at: DateTime.now
|
||||||
|
end
|
||||||
|
|
||||||
|
def add_ldap_document
|
||||||
|
dn = "cn=#{@username},ou=kosmos.org,cn=users,dc=kosmos,dc=org"
|
||||||
|
attr = {
|
||||||
|
objectclass: ["top", "account", "person", "extensibleObject"],
|
||||||
|
cn: @username,
|
||||||
|
sn: @username,
|
||||||
|
uid: @username,
|
||||||
|
mail: @email,
|
||||||
|
userPassword: Devise.ldap_auth_password_builder.call(@password)
|
||||||
|
}
|
||||||
|
|
||||||
|
ldap_client.add(dn: dn, attributes: attr)
|
||||||
|
end
|
||||||
|
|
||||||
|
def ldap_client
|
||||||
|
ldap_client ||= Net::LDAP.new host: ldap_config['host'],
|
||||||
|
port: ldap_config['port'],
|
||||||
|
encryption: ldap_config['ssl'],
|
||||||
|
auth: {
|
||||||
|
method: :simple,
|
||||||
|
username: ldap_config['admin_user'],
|
||||||
|
password: ldap_config['admin_password']
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
def ldap_config
|
||||||
|
ldap_config ||= YAML.load(ERB.new(File.read("#{Rails.root}/config/ldap.yml")).result)[Rails.env]
|
||||||
|
end
|
||||||
|
|
||||||
|
def exchange_xmpp_contacts
|
||||||
|
#TODO enable in development when we have easy setup of ejabberd etc.
|
||||||
|
return if Rails.env.development?
|
||||||
|
|
||||||
|
ejabberd = EjabberdApiClient.new
|
||||||
|
inviter = @invitation.user
|
||||||
|
|
||||||
|
ejabberd.add_rosteritem({
|
||||||
|
"localuser": @username, "localhost": @domain,
|
||||||
|
"user": inviter.cn, "host": inviter.ou,
|
||||||
|
"nick": inviter.cn, "group": "Friends", "subs": "both"
|
||||||
|
})
|
||||||
|
ejabberd.add_rosteritem({
|
||||||
|
"localuser": inviter.cn, "localhost": inviter.ou,
|
||||||
|
"user": @username, "host": @domain,
|
||||||
|
"nick": @username, "group": "Friends", "subs": "both"
|
||||||
|
})
|
||||||
|
end
|
||||||
|
end
|
||||||
20
app/services/ejabberd_api_client.rb
Normal file
20
app/services/ejabberd_api_client.rb
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
class EjabberdApiClient
|
||||||
|
def initialize
|
||||||
|
@base_url = ENV["EJABBERD_API_URL"]
|
||||||
|
end
|
||||||
|
|
||||||
|
def post(endpoint, payload)
|
||||||
|
res = Faraday.post("#{@base_url}/#{endpoint}", payload.to_json,
|
||||||
|
"Content-Type" => "application/json")
|
||||||
|
|
||||||
|
if res.status != 200
|
||||||
|
Rails.logger.error "[ejabberd] API request failed:"
|
||||||
|
Rails.logger.error res.body
|
||||||
|
#TODO add some kind of exception tracking/notifications
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def add_rosteritem(payload)
|
||||||
|
post "add_rosteritem", payload
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -6,17 +6,11 @@
|
|||||||
</p>
|
</p>
|
||||||
<div class="grid services">
|
<div class="grid services">
|
||||||
<div class="grid-item chat">
|
<div class="grid-item chat">
|
||||||
<h3><%= link_to "Chat", "https://wiki.kosmos.org/Services:XMPP" %></h3>
|
<h3><%= link_to "Chat", "https://wiki.kosmos.org/Services:Chat" %></h3>
|
||||||
<p>
|
<p>
|
||||||
Chat rooms and instant messaging (XMPP/Jabber)
|
Chat rooms and instant messaging (XMPP/Jabber)
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="grid-item gitea">
|
|
||||||
<h3><%= link_to "Gitea", "https://gitea.kosmos.org" %></h3>
|
|
||||||
<p>
|
|
||||||
Code hosting and collaboration for software projects
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
<div class="grid-item wiki">
|
<div class="grid-item wiki">
|
||||||
<h3><%= link_to "Wiki", "https://wiki.kosmos.org" %></h3>
|
<h3><%= link_to "Wiki", "https://wiki.kosmos.org" %></h3>
|
||||||
<p>
|
<p>
|
||||||
@@ -29,6 +23,18 @@
|
|||||||
Kosmos community forums and user support/help site
|
Kosmos community forums and user support/help site
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
<div class="grid-item gitea">
|
||||||
|
<h3><%= link_to "Gitea", "https://gitea.kosmos.org" %></h3>
|
||||||
|
<p>
|
||||||
|
Code hosting and collaboration for software projects
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<div class="grid-item gitea">
|
||||||
|
<h3><%= link_to "Drone CI", "https://drone.kosmos.org" %></h3>
|
||||||
|
<p>
|
||||||
|
Continuous integration for software projects, tied to our Gitea
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|||||||
46
app/views/invitations/index.html.erb
Normal file
46
app/views/invitations/index.html.erb
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
<section>
|
||||||
|
<h2>Invitations</h2>
|
||||||
|
<% if @invitations_unused.any? %>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>URL</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<% @invitations_unused.each do |invitation| %>
|
||||||
|
<tr>
|
||||||
|
<td><%= invitation_url(invitation.token) %></td>
|
||||||
|
</tr>
|
||||||
|
<% end %>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<% else %>
|
||||||
|
<p>
|
||||||
|
You do not have any invitations to give away yet. All good
|
||||||
|
things come in time.
|
||||||
|
</p>
|
||||||
|
<% end %>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<% if @invitations_used.any? %>
|
||||||
|
<h3>Accepted Invitations</h3>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>URL</th>
|
||||||
|
<th>Used at</th>
|
||||||
|
<th>Invited user</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<% @invitations_used.each do |invitation| %>
|
||||||
|
<tr>
|
||||||
|
<td><%= invitation_url(invitation.token) %></td>
|
||||||
|
<td><%= invitation.used_at %></td>
|
||||||
|
<td><%= User.find(invitation.invited_user_id).address %></td>
|
||||||
|
</tr>
|
||||||
|
<% end %>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<% end %>
|
||||||
41
app/views/layouts/signup.html.erb
Normal file
41
app/views/layouts/signup.html.erb
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>Sign up | Kosmos Accounts</title>
|
||||||
|
<%= csrf_meta_tags %>
|
||||||
|
<%= csp_meta_tag %>
|
||||||
|
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
|
||||||
|
<%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %>
|
||||||
|
<%= javascript_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="layout-signup">
|
||||||
|
<div id="wrapper">
|
||||||
|
<header>
|
||||||
|
<h1>
|
||||||
|
<span class ="project-name">Kosmos</span>
|
||||||
|
<span class ="site-name">Sign Up</span>
|
||||||
|
<!-- <span class="beta"><span class="bolt">⚡</span> beta</span> -->
|
||||||
|
</h1>
|
||||||
|
<% if user_signed_in? %>
|
||||||
|
<p class="current-user">
|
||||||
|
Signed in as <strong><%= current_user.cn %>@kosmos.org</strong>.
|
||||||
|
<%= link_to "Log out", destroy_user_session_path, method: :delete %>
|
||||||
|
</p>
|
||||||
|
<% end %>
|
||||||
|
</header>
|
||||||
|
|
||||||
|
<% flash.each do |type, msg| %>
|
||||||
|
<div class="flash-msg <%= type %>">
|
||||||
|
<p><%= msg %></p>
|
||||||
|
</div>
|
||||||
|
<% end %>
|
||||||
|
|
||||||
|
<main>
|
||||||
|
<%= yield %>
|
||||||
|
</main>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -1,2 +1,2 @@
|
|||||||
<h2>Access forbidden</h2>
|
<h2>Access forbidden</h2>
|
||||||
<p>Not with those shoes, buddy.</p>
|
<p>Sorry, you're not allowed to access this page.</p>
|
||||||
|
|||||||
2
app/views/shared/status_not_found.html.erb
Normal file
2
app/views/shared/status_not_found.html.erb
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
<h2>Not found</h2>
|
||||||
|
<p>Sorry, this page does not exist.</p>
|
||||||
0
app/views/shared/status_unauthorized.html.erb
Normal file
0
app/views/shared/status_unauthorized.html.erb
Normal file
12
app/views/signup/index.html.erb
Normal file
12
app/views/signup/index.html.erb
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
<h2>Welcome</h2>
|
||||||
|
<p>
|
||||||
|
Hey there! You were invited to sign up for a Kosmos account by
|
||||||
|
<strong><%= @invited_by_name %></strong>.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
This invitation can only be used once, and sign-up is currently only possible
|
||||||
|
by invitation. Seems like you have good friends!
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<%= link_to "Get started", signup_steps_path(1), class: "next-step" %>
|
||||||
|
</p>
|
||||||
61
app/views/signup/steps.html.erb
Normal file
61
app/views/signup/steps.html.erb
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
<% case @step %>
|
||||||
|
<% when 1 %>
|
||||||
|
<h2>Choose a username</h2>
|
||||||
|
<%= form_for @user, :url => signup_validate_url do |f| %>
|
||||||
|
<div class="field">
|
||||||
|
<p>
|
||||||
|
<%= f.label :cn, 'Username' %><br />
|
||||||
|
<%= f.text_field :cn, autofocus: true, autocomplete: "username" %>
|
||||||
|
<span class="at-sign">@</span>
|
||||||
|
<span class="domain">kosmos.org</span>
|
||||||
|
</p>
|
||||||
|
<% if @validation_error.present? %>
|
||||||
|
<p class="error-msg">Username <%= @validation_error %></p>
|
||||||
|
<% end %>
|
||||||
|
</div>
|
||||||
|
<div class="actions">
|
||||||
|
<p><%= f.submit "Continue" %></p>
|
||||||
|
</div>
|
||||||
|
<% end %>
|
||||||
|
|
||||||
|
<% when 2 %>
|
||||||
|
<h2>What's your email?</h2>
|
||||||
|
<%= form_for @user, :url => signup_validate_url do |f| %>
|
||||||
|
<div class="field">
|
||||||
|
<p>
|
||||||
|
<%= f.label :email, 'Email address' %><br />
|
||||||
|
<%= f.email_field :email, autofocus: true, autocomplete: "email" %>
|
||||||
|
</p>
|
||||||
|
<% if @validation_error.present? %>
|
||||||
|
<p class="error-msg">Email <%= @validation_error %></p>
|
||||||
|
<% end %>
|
||||||
|
</div>
|
||||||
|
<div class="actions">
|
||||||
|
<p><%= f.submit "Continue" %></p>
|
||||||
|
</div>
|
||||||
|
<% end %>
|
||||||
|
|
||||||
|
<% when 3 %>
|
||||||
|
<h2>Choose a password</h2>
|
||||||
|
|
||||||
|
<%= form_for @user, :url => signup_validate_url do |f| %>
|
||||||
|
<div class="field">
|
||||||
|
<p>
|
||||||
|
<%= f.label :password, 'Password' %><br />
|
||||||
|
<%= f.password_field :password, autofocus: true %>
|
||||||
|
</p>
|
||||||
|
<% if @validation_error.present? %>
|
||||||
|
<p class="error-msg">Password <%= @validation_error %></p>
|
||||||
|
<% end %>
|
||||||
|
</div>
|
||||||
|
<p class="accept-terms">
|
||||||
|
<small>
|
||||||
|
By clicking the button below, you accept our future Terms of Service
|
||||||
|
and Privacy Policy. Don't worry, they will be excellent!
|
||||||
|
</small>
|
||||||
|
</p>
|
||||||
|
<div class="actions">
|
||||||
|
<p><%= f.submit "Create account" %></p>
|
||||||
|
</div>
|
||||||
|
<% end %>
|
||||||
|
<% end %>
|
||||||
@@ -33,10 +33,11 @@ module Akkounts
|
|||||||
config.generators.system_tests = nil
|
config.generators.system_tests = nil
|
||||||
|
|
||||||
config.generators do |g|
|
config.generators do |g|
|
||||||
g.orm :active_record
|
g.orm :active_record
|
||||||
g.template_engine :erb
|
g.template_engine :erb
|
||||||
g.test_framework :rspec, fixture: true
|
g.test_framework :rspec, fixture: true
|
||||||
g.stylesheets false
|
g.fixture_replacement :factory_bot, suffix_factory: 'factory', dir: 'spec/factories'
|
||||||
|
g.stylesheets false
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
2Xf7uhBU+61XZL2HMF8Xs9fhVkpOhNfV5PKkHPu4uASpP1zwEJZcRyTJrhBVvJ29Y3m+3hhNAI2OeiYFDPepMDWcocrVjS+am/Gt9DW2tbhYZo0nN9lMU6EymQ5tl9ROgnvcPukwf823/Mrb6zPBysHruOlhdRc7JmW6EXuxL6tUhGsSJmaRfGiMWwiioJsyHCB2VsesKZlSDxItnhuX5d8gBABJyNdzi+Pyepz7MWkWp6ux80jOANq5uljn8bP5CLgUZKoGgveKzZdIs2uNb0wSIohSn+Ckfm+QhMm6mlEocAkHPt+nToiNAmSnx7p/l1sqKNFXslXHJKdkFFr8tx/R45aGPA/nL6R16DOnjtsJ84JXeh13VwR/0ZkyzsM2dQIwCvwo3xjdgBi46HWMwXwm6Y3A+ni6sK5BEvmAT4qu--AoOw35tpM//TeoWI--Uz4fvyRgmc2ewK6d7OFo6A==
|
LWyKwPZq9Kd97rn/7+q3MEkh7kITScDMHD3JvVuaV3A4YIHJHU+460k+PaEGlsH1xkbuClGiAb57rk1XLyDnmVGtbSueYOtinkw6kar8ZfKWZob061LwGjpMVRQkS49TjCUZlqCFrXeKxlH03mXWBnqAj9RUIPrm7eibb3c7qmJFglR1380RSVsfZnp8A3QwGm4Wh9OWtpUa6P2lne0jQsOuSe8ur3DUF0LplzS4CbkMxAUDOom+pXB13AlxOH9NQE7F4dsYHugHkh1tG3r3ER3xAUD/9Kn6UZZP7BnwUs3zqhoZdULRpRgA5dK7ueTIAnO/jtJDF4562VS8ECo7AnNoVxNe8/mBMFIOUfqg+db/72N2pIk3r4lK7Uzm/4jJ5/99ItnQjHQPcApiwZXIr3OyDLUvq5+d0UVmAMXdwcAjvctVQXFx5imG149Y0ISHKWVm1ca37aAspxWPU+CIj8/HW0yEpjp3vhwDUbjCaZeAPm8UQC14MxZwSK3N+EUSQXdltiweFynabDB7zGGQsjMM8LwMtyo9bTBzJA78Cl96MDyd20i1zSF9ntLuKulwGm3oZowpbNuvo2anY6r9yBlDJBOEISbtXv2tLX4SqcM=--bRcsE4K/29XzyZat--+G3iQCLBqgSwLaQ+7+4YvA==
|
||||||
@@ -22,4 +22,9 @@ test:
|
|||||||
|
|
||||||
production:
|
production:
|
||||||
<<: *default
|
<<: *default
|
||||||
database: db/production.sqlite3
|
adapter: postgresql
|
||||||
|
database: akkounts
|
||||||
|
port: 5432
|
||||||
|
host: <%= Rails.application.credentials.postgres[:host] rescue nil %>
|
||||||
|
username: <%= Rails.application.credentials.postgres[:username] rescue nil %>
|
||||||
|
password: <%= Rails.application.credentials.postgres[:password] rescue nil %>
|
||||||
|
|||||||
@@ -59,6 +59,23 @@ Rails.application.configure do
|
|||||||
|
|
||||||
config.action_mailer.perform_caching = false
|
config.action_mailer.perform_caching = false
|
||||||
|
|
||||||
|
config.action_mailer.delivery_method = :smtp
|
||||||
|
|
||||||
|
config.action_mailer.smtp_settings = {
|
||||||
|
address: "mail.gandi.net",
|
||||||
|
port: "587",
|
||||||
|
authentication: "plain",
|
||||||
|
enable_starttls_auto: true,
|
||||||
|
user_name: Rails.application.credentials.smtp[:username],
|
||||||
|
password: Rails.application.credentials.smtp[:password]
|
||||||
|
}
|
||||||
|
|
||||||
|
config.action_mailer.default_url_options = {
|
||||||
|
host: "accounts.kosmos.org",
|
||||||
|
protocol: "https",
|
||||||
|
from: "accounts@kosmos.org"
|
||||||
|
}
|
||||||
|
|
||||||
# Ignore bad email addresses and do not raise email delivery errors.
|
# Ignore bad email addresses and do not raise email delivery errors.
|
||||||
# Set this to true and configure the email server for immediate delivery to raise delivery errors.
|
# Set this to true and configure the email server for immediate delivery to raise delivery errors.
|
||||||
# config.action_mailer.raise_delivery_errors = false
|
# config.action_mailer.raise_delivery_errors = false
|
||||||
|
|||||||
@@ -43,4 +43,10 @@ Rails.application.configure do
|
|||||||
|
|
||||||
# Raises error for missing translations.
|
# Raises error for missing translations.
|
||||||
# config.action_view.raise_on_missing_translations = true
|
# config.action_view.raise_on_missing_translations = true
|
||||||
|
|
||||||
|
config.action_mailer.default_url_options = {
|
||||||
|
host: "accounts.kosmos.org",
|
||||||
|
protocol: "https",
|
||||||
|
from: "accounts@kosmos.org"
|
||||||
|
}
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -49,7 +49,7 @@ Devise.setup do |config|
|
|||||||
# Configure the e-mail address which will be shown in Devise::Mailer,
|
# Configure the e-mail address which will be shown in Devise::Mailer,
|
||||||
# note that it will be overwritten if you use your own mailer class
|
# note that it will be overwritten if you use your own mailer class
|
||||||
# with default "from" parameter.
|
# with default "from" parameter.
|
||||||
config.mailer_sender = 'please-change-me-at-config-initializers-devise@example.com'
|
config.mailer_sender = 'accounts@kosmos.org'
|
||||||
|
|
||||||
# Configure the class responsible to send e-mails.
|
# Configure the class responsible to send e-mails.
|
||||||
# config.mailer = 'Devise::Mailer'
|
# config.mailer = 'Devise::Mailer'
|
||||||
|
|||||||
@@ -50,7 +50,7 @@ production:
|
|||||||
port: 636
|
port: 636
|
||||||
attribute: cn
|
attribute: cn
|
||||||
base: ou=kosmos.org,cn=users,dc=kosmos,dc=org
|
base: ou=kosmos.org,cn=users,dc=kosmos,dc=org
|
||||||
admin_user: "cn=Directory Manager"
|
admin_user: <%= Rails.application.credentials.ldap[:username] rescue nil %>
|
||||||
admin_password: writtenbychef
|
admin_password: <%= Rails.application.credentials.ldap[:password] rescue nil %>
|
||||||
ssl: simple_tls
|
ssl: simple_tls
|
||||||
# <<: *AUTHORIZATIONS
|
# <<: *AUTHORIZATIONS
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
en:
|
en:
|
||||||
devise:
|
devise:
|
||||||
confirmations:
|
confirmations:
|
||||||
confirmed: "Your email address has been confirmed. You can now log in below."
|
confirmed: "Thanks for confirming your email address! Your account has been activated."
|
||||||
send_instructions: "You will receive an email with instructions for how to confirm your email address in a moment."
|
send_instructions: "You will receive an email with instructions for how to confirm your email address in a moment."
|
||||||
send_paranoid_instructions: "If your email address exists in our database, you will receive an email with instructions for how to confirm your email address in a few minutes."
|
send_paranoid_instructions: "If your email address exists in our database, you will receive an email with instructions for how to confirm your email address in a few minutes."
|
||||||
failure:
|
failure:
|
||||||
@@ -15,7 +15,7 @@ en:
|
|||||||
not_found_in_database: "Invalid %{authentication_keys} or password."
|
not_found_in_database: "Invalid %{authentication_keys} or password."
|
||||||
timeout: "Your session expired. Please sign in again to continue."
|
timeout: "Your session expired. Please sign in again to continue."
|
||||||
unauthenticated: "You need to sign in or sign up before continuing."
|
unauthenticated: "You need to sign in or sign up before continuing."
|
||||||
unconfirmed: "You have to confirm your email address before continuing."
|
unconfirmed: "Please confirm your email address before continuing."
|
||||||
mailer:
|
mailer:
|
||||||
confirmation_instructions:
|
confirmation_instructions:
|
||||||
subject: "Confirmation instructions"
|
subject: "Confirmation instructions"
|
||||||
|
|||||||
@@ -1,11 +1,17 @@
|
|||||||
Rails.application.routes.draw do
|
Rails.application.routes.draw do
|
||||||
devise_for :users
|
devise_for :users
|
||||||
|
|
||||||
|
get 'welcome', to: 'welcome#index'
|
||||||
|
get 'check_your_email', to: 'welcome#check_your_email'
|
||||||
|
|
||||||
|
get 'signup', to: 'signup#index'
|
||||||
|
match 'signup/:step', to: 'signup#steps', as: :signup_steps, via: [:get, :post]
|
||||||
|
post 'signup_validate', to: 'signup#validate'
|
||||||
|
|
||||||
get 'settings', to: 'settings#index'
|
get 'settings', to: 'settings#index'
|
||||||
post 'settings_reset_password', to: 'settings#reset_password'
|
post 'settings_reset_password', to: 'settings#reset_password'
|
||||||
|
|
||||||
get 'welcome', to: 'welcome#index'
|
resources :invitations, only: ['index', 'show', 'create', 'destroy']
|
||||||
get 'check_your_email', to: 'welcome#check_your_email'
|
|
||||||
|
|
||||||
namespace :admin do
|
namespace :admin do
|
||||||
root to: 'dashboard#index'
|
root to: 'dashboard#index'
|
||||||
|
|||||||
14
db/migrate/20201130132533_create_invitations.rb
Normal file
14
db/migrate/20201130132533_create_invitations.rb
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
class CreateInvitations < ActiveRecord::Migration[6.0]
|
||||||
|
def change
|
||||||
|
create_table :invitations do |t|
|
||||||
|
t.string :token
|
||||||
|
t.integer :user_id
|
||||||
|
t.integer :invited_user_id
|
||||||
|
t.datetime :used_at
|
||||||
|
|
||||||
|
t.timestamps
|
||||||
|
end
|
||||||
|
add_index :invitations, :user_id
|
||||||
|
add_index :invitations, :invited_user_id
|
||||||
|
end
|
||||||
|
end
|
||||||
11
db/schema.rb
11
db/schema.rb
@@ -10,7 +10,16 @@
|
|||||||
#
|
#
|
||||||
# It's strongly recommended that you check this file into your version control system.
|
# It's strongly recommended that you check this file into your version control system.
|
||||||
|
|
||||||
ActiveRecord::Schema.define(version: 2020_11_09_090739) do
|
ActiveRecord::Schema.define(version: 2020_11_30_132533) do
|
||||||
|
|
||||||
|
create_table "invitations", force: :cascade do |t|
|
||||||
|
t.string "token"
|
||||||
|
t.integer "user_id"
|
||||||
|
t.integer "invited_user_id"
|
||||||
|
t.datetime "used_at"
|
||||||
|
t.datetime "created_at", precision: 6, null: false
|
||||||
|
t.datetime "updated_at", precision: 6, null: false
|
||||||
|
end
|
||||||
|
|
||||||
create_table "users", force: :cascade do |t|
|
create_table "users", force: :cascade do |t|
|
||||||
t.string "cn"
|
t.string "cn"
|
||||||
|
|||||||
13
lib/tasks/invitations.rake
Normal file
13
lib/tasks/invitations.rake
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
namespace :invitations do
|
||||||
|
desc "Generate invitations for all users"
|
||||||
|
task :generate_for_all_users, [:amount_per_user] => :environment do |t, args|
|
||||||
|
count = 0
|
||||||
|
User.all.each do |user|
|
||||||
|
args[:amount_per_user].to_i.times do
|
||||||
|
user.invitations << Invitation.create(user: user)
|
||||||
|
count += 1
|
||||||
|
end
|
||||||
|
end
|
||||||
|
puts "Created #{count} new invitations"
|
||||||
|
end
|
||||||
|
end
|
||||||
6
spec/factories/invitations.rb
Normal file
6
spec/factories/invitations.rb
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
FactoryBot.define do
|
||||||
|
factory :invitation do
|
||||||
|
token { "abcdef123456" }
|
||||||
|
user
|
||||||
|
end
|
||||||
|
end
|
||||||
107
spec/features/signup_spec.rb
Normal file
107
spec/features/signup_spec.rb
Normal file
@@ -0,0 +1,107 @@
|
|||||||
|
require "rails_helper"
|
||||||
|
|
||||||
|
RSpec.describe "Signup", type: :feature do
|
||||||
|
let(:user) { create :user }
|
||||||
|
|
||||||
|
describe "Invitation handling" do
|
||||||
|
before do
|
||||||
|
@unused_invitation = Invitation.create(user: user)
|
||||||
|
@used_invitation = Invitation.create(user: user)
|
||||||
|
@used_invitation.update_attribute :used_at, DateTime.now - 1.day
|
||||||
|
end
|
||||||
|
|
||||||
|
scenario "Follow link for non-existing invitation" do
|
||||||
|
visit invitation_url(id: "123")
|
||||||
|
|
||||||
|
within ".flash-msg.alert" do
|
||||||
|
expect(page).to have_content("doesn't exist")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
scenario "Follow link for used invitation" do
|
||||||
|
visit invitation_url(id: @used_invitation.token)
|
||||||
|
|
||||||
|
within ".flash-msg.alert" do
|
||||||
|
expect(page).to have_content("has already been used")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
scenario "Follow link for unused invitation" do
|
||||||
|
visit invitation_url(id: @unused_invitation.token)
|
||||||
|
|
||||||
|
expect(current_url).to eq(signup_url)
|
||||||
|
expect(page).to have_content("Welcome")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "Signup steps" do
|
||||||
|
before do
|
||||||
|
@invitation = Invitation.create(user: user)
|
||||||
|
visit invitation_url(id: @invitation.token)
|
||||||
|
click_link "Get started"
|
||||||
|
end
|
||||||
|
|
||||||
|
scenario "Successful signup (happy path galore)" do
|
||||||
|
expect(page).to have_content("Choose a username")
|
||||||
|
|
||||||
|
fill_in "user_cn", with: "tony"
|
||||||
|
click_button "Continue"
|
||||||
|
expect(page).to have_content("What's your email?")
|
||||||
|
|
||||||
|
fill_in "user_email", with: "tony@example.com"
|
||||||
|
click_button "Continue"
|
||||||
|
expect(page).to have_content("Choose a password")
|
||||||
|
|
||||||
|
expect(CreateAccount).to receive(:call)
|
||||||
|
.with(
|
||||||
|
username: "tony", domain: "kosmos.org",
|
||||||
|
email: "tony@example.com", password: "a-valid-password",
|
||||||
|
invitation: Invitation.last
|
||||||
|
).and_return(true)
|
||||||
|
|
||||||
|
fill_in "user_password", with: "a-valid-password"
|
||||||
|
click_button "Create account"
|
||||||
|
within ".flash-msg.notice" do
|
||||||
|
expect(page).to have_content("confirm your address")
|
||||||
|
end
|
||||||
|
expect(page).to have_content("close this window or tab now")
|
||||||
|
end
|
||||||
|
|
||||||
|
scenario "Validation errors" do
|
||||||
|
fill_in "user_cn", with: "t"
|
||||||
|
click_button "Continue"
|
||||||
|
expect(page).to have_content("Username is too short")
|
||||||
|
fill_in "user_cn", with: "jimmy"
|
||||||
|
click_button "Continue"
|
||||||
|
expect(page).to have_content("Username has already been taken")
|
||||||
|
fill_in "user_cn", with: "tony"
|
||||||
|
click_button "Continue"
|
||||||
|
|
||||||
|
fill_in "user_email", with: "tony@"
|
||||||
|
click_button "Continue"
|
||||||
|
expect(page).to have_content("Email is not a valid address")
|
||||||
|
fill_in "user_email", with: ""
|
||||||
|
click_button "Continue"
|
||||||
|
expect(page).to have_content("Email can't be blank")
|
||||||
|
fill_in "user_email", with: "tony@example.com"
|
||||||
|
click_button "Continue"
|
||||||
|
|
||||||
|
fill_in "user_password", with: "123456"
|
||||||
|
click_button "Create account"
|
||||||
|
expect(page).to have_content("Password is too short")
|
||||||
|
|
||||||
|
expect(CreateAccount).to receive(:call)
|
||||||
|
.with(
|
||||||
|
username: "tony", domain: "kosmos.org",
|
||||||
|
email: "tony@example.com", password: "a-valid-password",
|
||||||
|
invitation: Invitation.last
|
||||||
|
).and_return(true)
|
||||||
|
|
||||||
|
fill_in "user_password", with: "a-valid-password"
|
||||||
|
click_button "Create account"
|
||||||
|
within ".flash-msg.notice" do
|
||||||
|
expect(page).to have_content("confirm your address")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
7
spec/fixtures/users.yml
vendored
7
spec/fixtures/users.yml
vendored
@@ -1,7 +0,0 @@
|
|||||||
# Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
|
|
||||||
|
|
||||||
one:
|
|
||||||
uid: MyString
|
|
||||||
|
|
||||||
two:
|
|
||||||
uid: MyString
|
|
||||||
15
spec/helpers/invitations_helper_spec.rb
Normal file
15
spec/helpers/invitations_helper_spec.rb
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
require 'rails_helper'
|
||||||
|
|
||||||
|
# Specs in this file have access to a helper object that includes
|
||||||
|
# the InvitationsHelper. For example:
|
||||||
|
#
|
||||||
|
# describe InvitationsHelper do
|
||||||
|
# describe "string concat" do
|
||||||
|
# it "concats two strings with spaces" do
|
||||||
|
# expect(helper.concat_strings("this","that")).to eq("this that")
|
||||||
|
# end
|
||||||
|
# end
|
||||||
|
# end
|
||||||
|
RSpec.describe InvitationsHelper, type: :helper do
|
||||||
|
pending "add some examples to (or delete) #{__FILE__}"
|
||||||
|
end
|
||||||
15
spec/helpers/signup_helper_spec.rb
Normal file
15
spec/helpers/signup_helper_spec.rb
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
require 'rails_helper'
|
||||||
|
|
||||||
|
# Specs in this file have access to a helper object that includes
|
||||||
|
# the SignupHelper. For example:
|
||||||
|
#
|
||||||
|
# describe SignupHelper do
|
||||||
|
# describe "string concat" do
|
||||||
|
# it "concats two strings with spaces" do
|
||||||
|
# expect(helper.concat_strings("this","that")).to eq("this that")
|
||||||
|
# end
|
||||||
|
# end
|
||||||
|
# end
|
||||||
|
RSpec.describe SignupHelper, type: :helper do
|
||||||
|
pending "add some examples to (or delete) #{__FILE__}"
|
||||||
|
end
|
||||||
44
spec/models/invitation_spec.rb
Normal file
44
spec/models/invitation_spec.rb
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
require 'rails_helper'
|
||||||
|
|
||||||
|
RSpec.describe Invitation, type: :model do
|
||||||
|
let(:user) { build :user }
|
||||||
|
|
||||||
|
describe "tokens" do
|
||||||
|
it "requires a user" do
|
||||||
|
expect { Invitation.create! }.to raise_error(ActiveRecord::RecordInvalid)
|
||||||
|
end
|
||||||
|
|
||||||
|
it "generates a random token when created" do
|
||||||
|
invitation = Invitation.new(user: user)
|
||||||
|
invitation.save!
|
||||||
|
token = invitation.token
|
||||||
|
expect(token).to be_a(String)
|
||||||
|
expect(token.length).to eq(16)
|
||||||
|
|
||||||
|
invitation_2 = Invitation.create(user: user)
|
||||||
|
expect(token).not_to eq(invitation_2.token)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "scopes" do
|
||||||
|
before do
|
||||||
|
@unused_invitation = create :invitation, user: user
|
||||||
|
@used_invitation = create :invitation, user: user, used_at: DateTime.now
|
||||||
|
@used_invitation_2 = create :invitation, user: user, used_at: DateTime.now
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "#unused" do
|
||||||
|
it "returns unused invitations" do
|
||||||
|
expect(Invitation.unused.count).to eq(1)
|
||||||
|
expect(Invitation.unused.first).to eq(@unused_invitation)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "#used" do
|
||||||
|
it "returns used invitations" do
|
||||||
|
expect(Invitation.used.count).to eq(2)
|
||||||
|
expect(Invitation.used.first).to eq(@used_invitation)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -20,4 +20,12 @@ RSpec.describe User, type: :model do
|
|||||||
expect(user.is_admin?).to be false
|
expect(user.is_admin?).to be false
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
describe "#address" do
|
||||||
|
let(:user) { build :user, cn: "jimmy", ou: "kosmos.org" }
|
||||||
|
|
||||||
|
it "returns the user address" do
|
||||||
|
expect(user.address).to eq("jimmy@kosmos.org")
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
14
spec/requests/signup_request_spec.rb
Normal file
14
spec/requests/signup_request_spec.rb
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
require 'rails_helper'
|
||||||
|
|
||||||
|
RSpec.describe "Signups", type: :request do
|
||||||
|
|
||||||
|
describe "GET /index" do
|
||||||
|
context "without invitation" do
|
||||||
|
it "returns http unauthorized" do
|
||||||
|
get "/signup"
|
||||||
|
expect(response).to have_http_status(:unauthorized)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
98
spec/services/create_account_spec.rb
Normal file
98
spec/services/create_account_spec.rb
Normal file
@@ -0,0 +1,98 @@
|
|||||||
|
require 'rails_helper'
|
||||||
|
require 'webmock/rspec'
|
||||||
|
require 'json'
|
||||||
|
|
||||||
|
RSpec.describe CreateAccount, type: :model do
|
||||||
|
let(:ldap_client_mock) { instance_double(Net::LDAP) }
|
||||||
|
|
||||||
|
before do
|
||||||
|
allow(service).to receive(:ldap_client).and_return(ldap_client_mock)
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "#create_user_in_database" do
|
||||||
|
let(:service) { CreateAccount.new(
|
||||||
|
username: 'isaacnewton',
|
||||||
|
email: 'isaacnewton@example.com',
|
||||||
|
password: 'bright-ideas-in-autumn'
|
||||||
|
)}
|
||||||
|
|
||||||
|
it "creates a new user record in the akkounts database" do
|
||||||
|
expect(User.count).to eq(0)
|
||||||
|
service.send(:create_user_in_database)
|
||||||
|
expect(User.count).to eq(1)
|
||||||
|
expect(User.last.cn).to eq("isaacnewton")
|
||||||
|
expect(User.last.email).to eq("isaacnewton@example.com")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "#update_invitation" do
|
||||||
|
let(:invitation) { create :invitation }
|
||||||
|
let(:service) { CreateAccount.new(
|
||||||
|
username: 'isaacnewton',
|
||||||
|
email: 'isaacnewton@example.com',
|
||||||
|
password: 'bright-ideas-in-autumn',
|
||||||
|
invitation: invitation
|
||||||
|
)}
|
||||||
|
|
||||||
|
before(:each) do
|
||||||
|
service.send(:update_invitation, 23)
|
||||||
|
end
|
||||||
|
|
||||||
|
it "marks the invitation as used" do
|
||||||
|
expect(invitation.used_at).not_to be_nil
|
||||||
|
end
|
||||||
|
|
||||||
|
it "saves the invited user's ID" do
|
||||||
|
expect(invitation.invited_user_id).to eq(23)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "#add_ldap_document" do
|
||||||
|
let(:service) { CreateAccount.new(
|
||||||
|
username: 'halfinney',
|
||||||
|
email: 'halfinney@example.com',
|
||||||
|
password: 'remember-remember-the-5th-of-november'
|
||||||
|
)}
|
||||||
|
|
||||||
|
it "creates a new document with the correct attributes" do
|
||||||
|
expect(ldap_client_mock).to receive(:add).with(
|
||||||
|
dn: "cn=halfinney,ou=kosmos.org,cn=users,dc=kosmos,dc=org",
|
||||||
|
attributes: {
|
||||||
|
objectclass: ["top", "account", "person", "extensibleObject"],
|
||||||
|
cn: "halfinney",
|
||||||
|
sn: "halfinney",
|
||||||
|
uid: "halfinney",
|
||||||
|
mail: "halfinney@example.com",
|
||||||
|
userPassword: /^{SSHA512}.{171}=/
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
service.send(:add_ldap_document)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe "#exchange_xmpp_contacts" do
|
||||||
|
let(:inviter) { create :user, cn: "willherschel", ou: "kosmos.org" }
|
||||||
|
let(:invitation) { create :invitation, user: inviter }
|
||||||
|
let(:service) { CreateAccount.new(
|
||||||
|
username: 'isaacnewton',
|
||||||
|
email: 'isaacnewton@example.com',
|
||||||
|
password: 'bright-ideas-in-autumn',
|
||||||
|
invitation: invitation
|
||||||
|
)}
|
||||||
|
|
||||||
|
before do
|
||||||
|
stub_request(:post, "http://xmpp.example.com/api/add_rosteritem")
|
||||||
|
.to_return(status: 200, body: "", headers: {})
|
||||||
|
end
|
||||||
|
|
||||||
|
it "posts add_rosteritem commands to the ejabberd API" do
|
||||||
|
service.send(:exchange_xmpp_contacts)
|
||||||
|
|
||||||
|
expect(WebMock).to have_requested(:post, "http://xmpp.example.com/api/add_rosteritem")
|
||||||
|
.with { |req| req.body == '{"localuser":"isaacnewton","localhost":"kosmos.org","user":"willherschel","host":"kosmos.org","nick":"willherschel","group":"Friends","subs":"both"}' }
|
||||||
|
expect(WebMock).to have_requested(:post, "http://xmpp.example.com/api/add_rosteritem")
|
||||||
|
.with { |req| req.body == '{"localuser":"willherschel","localhost":"kosmos.org","user":"isaacnewton","host":"kosmos.org","nick":"isaacnewton","group":"Friends","subs":"both"}' }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
Reference in New Issue
Block a user