cyclid 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE +174 -0
- data/README.md +54 -0
- data/app/cyclid.rb +61 -0
- data/app/cyclid/config.rb +38 -0
- data/app/cyclid/controllers.rb +123 -0
- data/app/cyclid/controllers/auth.rb +34 -0
- data/app/cyclid/controllers/auth/token.rb +78 -0
- data/app/cyclid/controllers/health.rb +96 -0
- data/app/cyclid/controllers/organizations.rb +104 -0
- data/app/cyclid/controllers/organizations/collection.rb +134 -0
- data/app/cyclid/controllers/organizations/config.rb +128 -0
- data/app/cyclid/controllers/organizations/document.rb +135 -0
- data/app/cyclid/controllers/organizations/job.rb +266 -0
- data/app/cyclid/controllers/organizations/members.rb +145 -0
- data/app/cyclid/controllers/organizations/stages.rb +251 -0
- data/app/cyclid/controllers/users.rb +47 -0
- data/app/cyclid/controllers/users/collection.rb +131 -0
- data/app/cyclid/controllers/users/document.rb +133 -0
- data/app/cyclid/health_helpers.rb +40 -0
- data/app/cyclid/job.rb +3 -0
- data/app/cyclid/job/helpers.rb +67 -0
- data/app/cyclid/job/job.rb +164 -0
- data/app/cyclid/job/runner.rb +275 -0
- data/app/cyclid/job/stage.rb +67 -0
- data/app/cyclid/log_buffer.rb +104 -0
- data/app/cyclid/models.rb +3 -0
- data/app/cyclid/models/job_record.rb +25 -0
- data/app/cyclid/models/organization.rb +64 -0
- data/app/cyclid/models/plugin_config.rb +25 -0
- data/app/cyclid/models/stage.rb +42 -0
- data/app/cyclid/models/step.rb +29 -0
- data/app/cyclid/models/user.rb +60 -0
- data/app/cyclid/models/user_permissions.rb +28 -0
- data/app/cyclid/monkey_patches.rb +37 -0
- data/app/cyclid/plugin_registry.rb +75 -0
- data/app/cyclid/plugins.rb +125 -0
- data/app/cyclid/plugins/action.rb +48 -0
- data/app/cyclid/plugins/action/command.rb +89 -0
- data/app/cyclid/plugins/action/email.rb +207 -0
- data/app/cyclid/plugins/action/email/html.erb +58 -0
- data/app/cyclid/plugins/action/email/text.erb +13 -0
- data/app/cyclid/plugins/action/script.rb +90 -0
- data/app/cyclid/plugins/action/slack.rb +129 -0
- data/app/cyclid/plugins/action/slack/note.erb +5 -0
- data/app/cyclid/plugins/api.rb +195 -0
- data/app/cyclid/plugins/api/github.rb +111 -0
- data/app/cyclid/plugins/api/github/callback.rb +66 -0
- data/app/cyclid/plugins/api/github/methods.rb +201 -0
- data/app/cyclid/plugins/api/github/status.rb +67 -0
- data/app/cyclid/plugins/builder.rb +80 -0
- data/app/cyclid/plugins/builder/mist.rb +107 -0
- data/app/cyclid/plugins/dispatcher.rb +89 -0
- data/app/cyclid/plugins/dispatcher/local.rb +167 -0
- data/app/cyclid/plugins/provisioner.rb +40 -0
- data/app/cyclid/plugins/provisioner/debian.rb +90 -0
- data/app/cyclid/plugins/provisioner/ubuntu.rb +98 -0
- data/app/cyclid/plugins/source.rb +39 -0
- data/app/cyclid/plugins/source/git.rb +64 -0
- data/app/cyclid/plugins/transport.rb +63 -0
- data/app/cyclid/plugins/transport/ssh.rb +155 -0
- data/app/cyclid/sinatra/api_helpers.rb +66 -0
- data/app/cyclid/sinatra/auth_helpers.rb +127 -0
- data/app/cyclid/sinatra/warden/strategies/api_token.rb +62 -0
- data/app/cyclid/sinatra/warden/strategies/basic.rb +58 -0
- data/app/cyclid/sinatra/warden/strategies/hmac.rb +76 -0
- data/app/db.rb +51 -0
- data/bin/cyclid-db-init +107 -0
- data/db/schema.rb +92 -0
- data/lib/cyclid/app.rb +4 -0
- metadata +407 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 52003b67cb59f27d6ef7bea410f715d6b8714c33
|
4
|
+
data.tar.gz: 08e3f06342e7ac69bc8917dd17d47c1ba72aec65
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 400fc554727abcbdfcdd65ca57005ea912e7b725d6568d972cdcb07f0c9bea30c4c90feee27660f00f9fa9d54cb607d9d471f3895c4433593cef1174526dbd34
|
7
|
+
data.tar.gz: 172919cb2f58442730393e9c6c6cce91423c25dabeeec13641925304374d84ed55fd6c9247895cc0b05be85cef3286c5f84edb031b52111c2d6bc62b5d1901a5
|
data/LICENSE
ADDED
@@ -0,0 +1,174 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
data/README.md
ADDED
@@ -0,0 +1,54 @@
|
|
1
|
+
Cyclid
|
2
|
+
======
|
3
|
+
|
4
|
+
# Getting started
|
5
|
+
```
|
6
|
+
$ rbenv install 2.3.0
|
7
|
+
$ bundle install --path vendor/bundle
|
8
|
+
$ bundle exec rake db:migrate
|
9
|
+
$ CYCLID_CONFIG=config/development bundle exec bin/cyclid-db-init
|
10
|
+
```
|
11
|
+
Cyclid requires a Redis server for Sidekiq; you can either run a Redis server on your local machine or run `bundle exec rake redis` to start one.
|
12
|
+
|
13
|
+
You can start Cyclid under Webrick with `bundle exec rake rackup`, and then start Sidekiq with `bundle exec rake sidekiq`, or you can run both under Guard with `bundle exec rake guard`.
|
14
|
+
|
15
|
+
You can use curl or wget with HTTP Basic authentication, or the `test/hmac-test.rb` command for GET's using HMAC authentication.
|
16
|
+
|
17
|
+
# Testing
|
18
|
+
|
19
|
+
RSpec tests are included. Run `bundle exec rake spec` to run the tests and generate a coverage report into the `coverage` directory. The tests do not affect any databases and external API calls are mocked.
|
20
|
+
|
21
|
+
The Cyclid source code is also expected to pass Rubocop; run `bundle exec rake rubocop` to lint the code.
|
22
|
+
|
23
|
+
# Documentation
|
24
|
+
|
25
|
+
Cyclid uses YARD to generate documentation for both the Ruby API (internal Modules, Classes & Methods) and the REST API. Run `bundle exec rake doc` to generate both sets of documentation. The Ruby documentation is placed in the `doc/api` directory, and the REST API documentation is placed in the `doc/rest` directory.
|
26
|
+
|
27
|
+
## Test data
|
28
|
+
|
29
|
+
The `test/db-loader.rb` script creates two users ('admin' and 'test'), and two organizations ('admins' and 'test).
|
30
|
+
|
31
|
+
### Users
|
32
|
+
|
33
|
+
An admin (Super Admin) user is configured with the following attributes:
|
34
|
+
|
35
|
+
* Username: admin
|
36
|
+
* Email: admin@example.com
|
37
|
+
* Password: password
|
38
|
+
* Secret: aasecret55
|
39
|
+
|
40
|
+
A test user is configured with the following attributes:
|
41
|
+
|
42
|
+
* Username: test
|
43
|
+
* Email: test@example.com
|
44
|
+
* Password: aapassword55
|
45
|
+
* Secret: aasecret55
|
46
|
+
|
47
|
+
### Organizations
|
48
|
+
|
49
|
+
Two Organizations are created:
|
50
|
+
|
51
|
+
* admins
|
52
|
+
* test
|
53
|
+
|
54
|
+
The admin user is a member of admins, and the test user is a member of test.
|
data/app/cyclid.rb
ADDED
@@ -0,0 +1,61 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# Copyright 2016 Liqwyd Ltd.
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
|
16
|
+
require 'require_all'
|
17
|
+
require 'logger'
|
18
|
+
|
19
|
+
require 'cyclid/config'
|
20
|
+
require 'cyclid/plugin_registry'
|
21
|
+
|
22
|
+
# Top level module for the core Cyclid code.
|
23
|
+
module Cyclid
|
24
|
+
class << self
|
25
|
+
attr_accessor :config, :controllers, :plugins, :dispatcher, :builder, :logger
|
26
|
+
|
27
|
+
config_path = ENV['CYCLID_CONFIG'] || File.join(%w(/ etc cyclid config))
|
28
|
+
Cyclid.config = API::Config.new(config_path)
|
29
|
+
|
30
|
+
Cyclid.controllers = []
|
31
|
+
Cyclid.plugins = API::Plugins::Registry.new
|
32
|
+
|
33
|
+
begin
|
34
|
+
Cyclid.logger = if Cyclid.config.log.casecmp('stderr').zero?
|
35
|
+
Logger.new(STDERR)
|
36
|
+
else
|
37
|
+
Logger.new(Cyclid.config.log)
|
38
|
+
end
|
39
|
+
rescue StandardError => ex
|
40
|
+
abort "Failed to initialize: #{ex}"
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
require_relative 'db'
|
46
|
+
|
47
|
+
require 'cyclid/monkey_patches'
|
48
|
+
require 'cyclid/constants'
|
49
|
+
require 'cyclid/errors'
|
50
|
+
require 'cyclid/models'
|
51
|
+
require 'cyclid/hmac'
|
52
|
+
require 'cyclid/plugins'
|
53
|
+
require 'cyclid/job'
|
54
|
+
require 'cyclid/controllers'
|
55
|
+
|
56
|
+
dispatcher = Cyclid.plugins.find(Cyclid.config.dispatcher, Cyclid::API::Plugins::Dispatcher)
|
57
|
+
abort "Could not find dispatcher '#{Cyclid.config.dispatcher}'" if dispatcher.nil?
|
58
|
+
Cyclid.dispatcher = dispatcher.new
|
59
|
+
|
60
|
+
Cyclid.builder = Cyclid.plugins.find(Cyclid.config.builder, Cyclid::API::Plugins::Builder)
|
61
|
+
abort "Could not find builder '#{Cyclid.config.builder}'" if Cyclid.builder.nil?
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# Copyright 2016 Liqwyd Ltd.
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
|
16
|
+
require 'yaml'
|
17
|
+
|
18
|
+
module Cyclid
|
19
|
+
module API
|
20
|
+
# Cyclid API configuration
|
21
|
+
class Config
|
22
|
+
attr_reader :database, :log, :dispatcher, :builder, :plugins
|
23
|
+
|
24
|
+
def initialize(path)
|
25
|
+
config = YAML.load_file(path)
|
26
|
+
server = config['server']
|
27
|
+
|
28
|
+
@database = server['database']
|
29
|
+
@log = server['log'] || File.join(%w(/ var log cyclid server))
|
30
|
+
@dispatcher = server['dispatcher']
|
31
|
+
@builder = server['builder']
|
32
|
+
@plugins = server['plugins'] || {}
|
33
|
+
rescue StandardError => ex
|
34
|
+
abort "Failed to load configuration file #{path}: #{ex}"
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
@@ -0,0 +1,123 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# Copyright 2016 Liqwyd Ltd.
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
|
16
|
+
require 'sinatra/base'
|
17
|
+
require 'sinatra/namespace'
|
18
|
+
require 'sinatra/cross_origin'
|
19
|
+
require 'warden'
|
20
|
+
|
21
|
+
require_relative 'sinatra/warden/strategies/basic'
|
22
|
+
require_relative 'sinatra/warden/strategies/hmac'
|
23
|
+
require_relative 'sinatra/warden/strategies/api_token'
|
24
|
+
|
25
|
+
require_relative 'sinatra/api_helpers'
|
26
|
+
require_relative 'sinatra/auth_helpers'
|
27
|
+
|
28
|
+
# Define some YARD macros that can be used to create the REST API documentation
|
29
|
+
|
30
|
+
# @!macro [new] rest
|
31
|
+
# @!scope instance
|
32
|
+
# @api REST
|
33
|
+
|
34
|
+
# Top level module for the core Cyclid code.
|
35
|
+
module Cyclid
|
36
|
+
# Module for the Cyclid API
|
37
|
+
module API
|
38
|
+
# Base class for all API Controllers
|
39
|
+
class ControllerBase < Sinatra::Base
|
40
|
+
include Errors::HTTPErrors
|
41
|
+
|
42
|
+
register Operations
|
43
|
+
register Sinatra::Namespace
|
44
|
+
register Sinatra::CrossOrigin
|
45
|
+
|
46
|
+
helpers APIHelpers, AuthHelpers
|
47
|
+
|
48
|
+
# The API always returns JSON
|
49
|
+
before do
|
50
|
+
content_type :json
|
51
|
+
end
|
52
|
+
|
53
|
+
# Configure CORS
|
54
|
+
configure do
|
55
|
+
enable :cross_origin
|
56
|
+
set :allow_origin, :any
|
57
|
+
set :allow_methods, [:get, :put, :post, :options]
|
58
|
+
set :allow_credentials, true
|
59
|
+
set :max_age, '1728000'
|
60
|
+
set :expose_headers, ['Content-Type']
|
61
|
+
disable :show_exceptions
|
62
|
+
end
|
63
|
+
|
64
|
+
options '*' do
|
65
|
+
response.headers['Allow'] = 'HEAD,GET,PUT,POST,DELETE,OPTIONS'
|
66
|
+
response.headers['Access-Control-Allow-Headers'] =
|
67
|
+
'Content-Type, Cache-Control, Accept, Authorization'
|
68
|
+
200
|
69
|
+
end
|
70
|
+
|
71
|
+
# Configure Warden to authenticate
|
72
|
+
use Warden::Manager do |config|
|
73
|
+
config.serialize_into_session(&:id)
|
74
|
+
config.serialize_from_session{ |id| User.find_by_id(id) }
|
75
|
+
|
76
|
+
config.scope_defaults :default,
|
77
|
+
strategies: [:basic, :hmac, :api_token],
|
78
|
+
action: '/unauthenticated'
|
79
|
+
|
80
|
+
config.failure_app = self
|
81
|
+
end
|
82
|
+
|
83
|
+
Warden::Manager.before_failure do |env, _opts|
|
84
|
+
env['REQUEST_METHOD'] = 'POST'
|
85
|
+
end
|
86
|
+
|
87
|
+
register Strategies::Basic
|
88
|
+
register Strategies::HMAC
|
89
|
+
register Strategies::APIToken
|
90
|
+
|
91
|
+
post '/unauthenticated' do
|
92
|
+
content_type :json
|
93
|
+
# Stop Warden from calling this endpoint again in an endless loop when
|
94
|
+
# it sees the 401 response
|
95
|
+
env['warden'].custom_failure!
|
96
|
+
halt_with_json_response(401, AUTH_FAILURE, 'invalid username or password')
|
97
|
+
end
|
98
|
+
end
|
99
|
+
end
|
100
|
+
end
|
101
|
+
|
102
|
+
# Load any and all controllers
|
103
|
+
require_rel 'controllers/*.rb'
|
104
|
+
|
105
|
+
# Top level module for the core Cyclid code.
|
106
|
+
module Cyclid
|
107
|
+
# Module for the Cyclid API
|
108
|
+
module API
|
109
|
+
# Sintra application for the REST API
|
110
|
+
class App < Sinatra::Base
|
111
|
+
# Set up the Sinatra configuration
|
112
|
+
configure do
|
113
|
+
enable :logging
|
114
|
+
end
|
115
|
+
|
116
|
+
# Register all of the controllers with Sinatra
|
117
|
+
Cyclid.controllers.each do |controller|
|
118
|
+
Cyclid.logger.debug "Using Sinatra controller #{controller}"
|
119
|
+
use controller
|
120
|
+
end
|
121
|
+
end
|
122
|
+
end
|
123
|
+
end
|