easy_compliance 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.github/workflows/main.yml +18 -0
- data/.gitignore +11 -0
- data/Gemfile +4 -0
- data/Gemfile.lock +39 -0
- data/LICENSE.txt +201 -0
- data/README.md +33 -0
- data/Rakefile +6 -0
- data/bin/console +13 -0
- data/bin/setup +8 -0
- data/easy_compliance.gemspec +25 -0
- data/lib/easy_compliance.rb +13 -0
- data/lib/easy_compliance/client.rb +47 -0
- data/lib/easy_compliance/ref.rb +35 -0
- data/lib/easy_compliance/result.rb +16 -0
- data/lib/easy_compliance/version.rb +3 -0
- data/spec/easy_compliance/client_spec.rb +44 -0
- data/spec/easy_compliance/ref_spec.rb +48 -0
- data/spec/easy_compliance/result_spec.rb +10 -0
- data/spec/easy_compliance_spec.rb +5 -0
- data/spec/spec_helper.rb +10 -0
- metadata +140 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 68ea81c392cd603100d3b5650affd7974474e0a141d9b9f4d5691a4c97a6ed27
|
4
|
+
data.tar.gz: 6012a1c871caf97b59213865e8e6cbd0a1f2e3ed34f5d6a2ab7c5d1215c127fc
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: bea8b749d5a552b7bfcd03c87261fc754b9ae11797445704913e8814b87d82bac4fd3cd95e7fb1062dcfb8682e79aabf9e15e0ed819c291cfe0fd0868134029c
|
7
|
+
data.tar.gz: ebd4be877e09bbeafe9d75aca7c2520cfb4a8157429623af0ca4aa4e30ccf5bcb98ba07b56beb855b8b56504bfcfc299d403ded249716bcc744a87a0488cba77
|
@@ -0,0 +1,18 @@
|
|
1
|
+
name: Ruby
|
2
|
+
|
3
|
+
on: [push, pull_request]
|
4
|
+
|
5
|
+
jobs:
|
6
|
+
build:
|
7
|
+
runs-on: ubuntu-latest
|
8
|
+
steps:
|
9
|
+
- uses: actions/checkout@v2
|
10
|
+
- name: Set up Ruby
|
11
|
+
uses: ruby/setup-ruby@v1
|
12
|
+
with:
|
13
|
+
ruby-version: 3.0.0
|
14
|
+
- name: Run the default task
|
15
|
+
run: |
|
16
|
+
gem install bundler -v 2.2.8
|
17
|
+
bundle install
|
18
|
+
bundle exec rake
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
easy_compliance (1.0.0)
|
5
|
+
excon
|
6
|
+
|
7
|
+
GEM
|
8
|
+
remote: https://rubygems.org/
|
9
|
+
specs:
|
10
|
+
byebug (11.1.3)
|
11
|
+
diff-lcs (1.4.4)
|
12
|
+
excon (0.79.0)
|
13
|
+
rake (13.0.3)
|
14
|
+
rspec (3.10.0)
|
15
|
+
rspec-core (~> 3.10.0)
|
16
|
+
rspec-expectations (~> 3.10.0)
|
17
|
+
rspec-mocks (~> 3.10.0)
|
18
|
+
rspec-core (3.10.1)
|
19
|
+
rspec-support (~> 3.10.0)
|
20
|
+
rspec-expectations (3.10.1)
|
21
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
22
|
+
rspec-support (~> 3.10.0)
|
23
|
+
rspec-mocks (3.10.2)
|
24
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
25
|
+
rspec-support (~> 3.10.0)
|
26
|
+
rspec-support (3.10.2)
|
27
|
+
|
28
|
+
PLATFORMS
|
29
|
+
x86_64-darwin-19
|
30
|
+
|
31
|
+
DEPENDENCIES
|
32
|
+
bundler
|
33
|
+
byebug
|
34
|
+
easy_compliance!
|
35
|
+
rake
|
36
|
+
rspec
|
37
|
+
|
38
|
+
BUNDLED WITH
|
39
|
+
2.2.8
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,201 @@
|
|
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.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
# EasyCompliance
|
2
|
+
|
3
|
+
Ruby toolkit for https://www.easycompliance.de
|
4
|
+
|
5
|
+
## Usage example
|
6
|
+
|
7
|
+
### Creating a CSV for initial upload of data
|
8
|
+
|
9
|
+
Use `EasyCompliance::Ref` to build refs for the records.
|
10
|
+
|
11
|
+
### Keeping data in sync
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
# config/initializers/easy_compliance.rb
|
15
|
+
EasyCompliance.api_key = 'my_key'
|
16
|
+
EasyCompliance.api_url = 'https://example.com'
|
17
|
+
EasyCompliance.app_name = 'my_app'
|
18
|
+
|
19
|
+
# app/models/my_record.rb
|
20
|
+
class MyRecord < ActiveRecord::Base
|
21
|
+
after_save do
|
22
|
+
saved_change_to_name? && ComplianceJob.perform_async(self, name)
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
# app/jobs/compliance_job.rb
|
27
|
+
class ComplianceJob
|
28
|
+
def perform(record, value)
|
29
|
+
production_env? &&
|
30
|
+
EasyCompliance::Client.submit(record: record, value: value)
|
31
|
+
end
|
32
|
+
end
|
33
|
+
```
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
require 'bundler/setup'
|
3
|
+
require 'easy_compliance'
|
4
|
+
|
5
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
6
|
+
# with your gem easier. You can also use a different console, if you like.
|
7
|
+
|
8
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
9
|
+
# require "pry"
|
10
|
+
# Pry.start
|
11
|
+
|
12
|
+
require 'irb'
|
13
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
require_relative 'lib/easy_compliance/version'
|
2
|
+
|
3
|
+
Gem::Specification.new do |spec|
|
4
|
+
spec.name = 'easy_compliance'
|
5
|
+
spec.version = EasyCompliance::VERSION
|
6
|
+
spec.authors = ['betterplace development team']
|
7
|
+
spec.email = ['developers@betterplace.org']
|
8
|
+
|
9
|
+
spec.summary = 'Ruby toolkit for https://www.easycompliance.de'
|
10
|
+
spec.homepage = 'https://github.com/betterplace/easy_compliance'
|
11
|
+
spec.license = 'MIT'
|
12
|
+
spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
|
13
|
+
|
14
|
+
spec.files = `git ls-files`.split($/)
|
15
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
16
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
17
|
+
spec.require_paths = ['lib']
|
18
|
+
|
19
|
+
spec.add_dependency 'excon'
|
20
|
+
|
21
|
+
spec.add_development_dependency 'bundler'
|
22
|
+
spec.add_development_dependency 'byebug'
|
23
|
+
spec.add_development_dependency 'rake'
|
24
|
+
spec.add_development_dependency 'rspec'
|
25
|
+
end
|
@@ -0,0 +1,13 @@
|
|
1
|
+
require_relative 'easy_compliance/version'
|
2
|
+
|
3
|
+
module EasyCompliance
|
4
|
+
class Error < StandardError; end
|
5
|
+
|
6
|
+
class << self
|
7
|
+
attr_accessor :api_key, :api_url, :app_name
|
8
|
+
end
|
9
|
+
end
|
10
|
+
|
11
|
+
require_relative 'easy_compliance/client'
|
12
|
+
require_relative 'easy_compliance/ref'
|
13
|
+
require_relative 'easy_compliance/result'
|
@@ -0,0 +1,47 @@
|
|
1
|
+
require 'excon'
|
2
|
+
|
3
|
+
module EasyCompliance
|
4
|
+
# client for https://easycompliance.de/schnittstellen/api/
|
5
|
+
module Client
|
6
|
+
class Error < EasyCompliance::Error; end
|
7
|
+
|
8
|
+
module_function
|
9
|
+
|
10
|
+
# check if record is currently on a sanctions list
|
11
|
+
# @return [ EasyCompliance::Result ]
|
12
|
+
def check_now(record:, value:)
|
13
|
+
ref = EasyCompliance::Ref.for_record(record)
|
14
|
+
post(method: 1, ref: ref, name: value)
|
15
|
+
end
|
16
|
+
|
17
|
+
# like `#check_now`, but also adds to list for future automatic checks
|
18
|
+
# @return [ EasyCompliance::Result ]
|
19
|
+
def submit(record:, value:)
|
20
|
+
ref = EasyCompliance::Ref.for_record(record)
|
21
|
+
post(method: 2, ref: ref, name: value)
|
22
|
+
end
|
23
|
+
|
24
|
+
# get matches of last 24 hours
|
25
|
+
# @return [ EasyCompliance::Result ]
|
26
|
+
def fetch_list
|
27
|
+
post(method: 3)
|
28
|
+
end
|
29
|
+
|
30
|
+
HEADERS = {
|
31
|
+
'Content-Type': 'application/x-www-form-urlencoded',
|
32
|
+
}
|
33
|
+
|
34
|
+
# @return [ EasyCompliance::Result ]
|
35
|
+
def post(**body)
|
36
|
+
url = EasyCompliance.api_url or raise Error, "must set api_url"
|
37
|
+
body[:api_key] = EasyCompliance.api_key or raise Error, "must set api_key"
|
38
|
+
|
39
|
+
res = Excon.post(url, body: URI.encode_www_form(body), headers: HEADERS)
|
40
|
+
res.status < 300 or raise Error, "#{res.status}: #{res.body}"
|
41
|
+
|
42
|
+
EasyCompliance::Result.new(status: res.status, body: res.body)
|
43
|
+
rescue Excon::Error => e
|
44
|
+
raise Error, "Network error: #{e.class.name} - #{e.message}"
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
@@ -0,0 +1,35 @@
|
|
1
|
+
module EasyCompliance
|
2
|
+
# allows identifying records after submission
|
3
|
+
module Ref
|
4
|
+
class Error < EasyCompliance::Error; end
|
5
|
+
|
6
|
+
module_function
|
7
|
+
|
8
|
+
# @return [ String ]
|
9
|
+
def for_record(record)
|
10
|
+
self.for(record_class: record.class.name, record_id: record.id)
|
11
|
+
end
|
12
|
+
|
13
|
+
# @return [ String ]
|
14
|
+
def for(record_class:, record_id:)
|
15
|
+
[app_name, record_class, record_id].join('#')
|
16
|
+
end
|
17
|
+
|
18
|
+
# Converts a previously created Ref string back into a record.
|
19
|
+
#
|
20
|
+
# @return [ ActiveRecord::Base | NilClass ]
|
21
|
+
def look_up(ref)
|
22
|
+
app_name, record_class, record_id = ref.split('#')
|
23
|
+
app_name == self.app_name or raise Error, "Ref `#{ref}` is from wrong app"
|
24
|
+
begin
|
25
|
+
record_class.constantize.find_by(id: record_id)
|
26
|
+
rescue NameError, NoMethodError => e
|
27
|
+
raise Error, "Ref `#{ref}` not supported: #{e.message}"
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
def app_name
|
32
|
+
EasyCompliance.app_name or raise Error, 'must set app_name'
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
module EasyCompliance
|
2
|
+
# result of an API call
|
3
|
+
class Result
|
4
|
+
attr_reader :status, :body
|
5
|
+
|
6
|
+
def initialize(status:, body: nil)
|
7
|
+
@status = status
|
8
|
+
@body = body
|
9
|
+
end
|
10
|
+
|
11
|
+
# For methods 1-3. 204 means no hit.
|
12
|
+
def hit?
|
13
|
+
status == 200
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
@@ -0,0 +1,44 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
describe EasyCompliance::Client do
|
4
|
+
subject(:client) { EasyCompliance::Client }
|
5
|
+
before do
|
6
|
+
EasyCompliance.api_key = 'key'
|
7
|
+
EasyCompliance.api_url = 'url'
|
8
|
+
end
|
9
|
+
|
10
|
+
describe '#post' do
|
11
|
+
it 'posts to the API URL and returns an EasyCompliance::Result' do
|
12
|
+
expect(Excon).to receive(:post)
|
13
|
+
.with('url', body: 'method=2&api_key=key', headers: anything)
|
14
|
+
.and_return(double(body: '{}', status: 200))
|
15
|
+
result = client.post(method: 2)
|
16
|
+
expect(result).to be_an EasyCompliance::Result
|
17
|
+
expect(result.status).to eq 200
|
18
|
+
end
|
19
|
+
|
20
|
+
it 'raises if the API returned a bad status code' do
|
21
|
+
expect(Excon).to receive(:post)
|
22
|
+
.with('url', body: 'method=2&api_key=key', headers: anything)
|
23
|
+
.and_return(double(body: '{}', status: 500))
|
24
|
+
expect { client.post(method: 2) }.to raise_error(client::Error, /500/)
|
25
|
+
end
|
26
|
+
|
27
|
+
it 'raises if the connection failed' do
|
28
|
+
expect(Excon).to receive(:post)
|
29
|
+
.with('url', body: 'method=2&api_key=key', headers: anything)
|
30
|
+
.and_raise(Excon::Errors::SocketError.new)
|
31
|
+
expect { client.post(method: 2) }.to raise_error(client::Error, /Socket/)
|
32
|
+
end
|
33
|
+
|
34
|
+
it 'raises if api_key is not set' do
|
35
|
+
EasyCompliance.api_key = nil
|
36
|
+
expect { client.post(method: 2) }.to raise_error(client::Error, /api_key/)
|
37
|
+
end
|
38
|
+
|
39
|
+
it 'raises if api_url is not set' do
|
40
|
+
EasyCompliance.api_url = nil
|
41
|
+
expect { client.post(method: 2) }.to raise_error(client::Error, /api_url/)
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
@@ -0,0 +1,48 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
describe EasyCompliance::Ref do
|
4
|
+
before { EasyCompliance.app_name = 'MyApp' }
|
5
|
+
|
6
|
+
specify '#for_record returns a string representing a record' do
|
7
|
+
record = double(class: Object, id: 42)
|
8
|
+
expect(EasyCompliance::Ref.for_record(record)).to eq 'MyApp#Object#42'
|
9
|
+
end
|
10
|
+
|
11
|
+
specify '#for returns a string based on given class and id' do
|
12
|
+
expect(EasyCompliance::Ref.for(record_class: 'Foo', record_id: 23))
|
13
|
+
.to eq 'MyApp#Foo#23'
|
14
|
+
end
|
15
|
+
|
16
|
+
describe '#look_up' do
|
17
|
+
# stub some things so ActiveSupport/Record is not a hard dependency
|
18
|
+
class MyCompliantRecord
|
19
|
+
def self.find_by(id:)
|
20
|
+
id == '42' ? :ok : nil
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
before do
|
25
|
+
allow_any_instance_of(String).to receive(:constantize) do |str|
|
26
|
+
str == 'MyCompliantRecord' ? MyCompliantRecord : raise(NameError, str)
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
it 'converts a ref back into a record' do
|
31
|
+
expect(EasyCompliance::Ref.look_up('MyApp#MyCompliantRecord#42')).to eq :ok
|
32
|
+
end
|
33
|
+
|
34
|
+
it 'returns nil if the record no longer exists' do
|
35
|
+
expect(EasyCompliance::Ref.look_up('MyApp#MyCompliantRecord#43')).to eq nil
|
36
|
+
end
|
37
|
+
|
38
|
+
it 'raises if the ref is from another app' do
|
39
|
+
expect { EasyCompliance::Ref.look_up('OtherApp#MyCompliantRecord#42') }
|
40
|
+
.to raise_error(EasyCompliance::Ref::Error)
|
41
|
+
end
|
42
|
+
|
43
|
+
it 'raises if the ref is for an unknown record class' do
|
44
|
+
expect { EasyCompliance::Ref.look_up('MyApp#CeciNestPasUneRecord#42') }
|
45
|
+
.to raise_error(EasyCompliance::Ref::Error)
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
data/spec/spec_helper.rb
ADDED
metadata
ADDED
@@ -0,0 +1,140 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: easy_compliance
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- betterplace development team
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2021-05-12 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: excon
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: byebug
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rake
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rspec
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
description:
|
84
|
+
email:
|
85
|
+
- developers@betterplace.org
|
86
|
+
executables:
|
87
|
+
- console
|
88
|
+
- setup
|
89
|
+
extensions: []
|
90
|
+
extra_rdoc_files: []
|
91
|
+
files:
|
92
|
+
- ".github/workflows/main.yml"
|
93
|
+
- ".gitignore"
|
94
|
+
- Gemfile
|
95
|
+
- Gemfile.lock
|
96
|
+
- LICENSE.txt
|
97
|
+
- README.md
|
98
|
+
- Rakefile
|
99
|
+
- bin/console
|
100
|
+
- bin/setup
|
101
|
+
- easy_compliance.gemspec
|
102
|
+
- lib/easy_compliance.rb
|
103
|
+
- lib/easy_compliance/client.rb
|
104
|
+
- lib/easy_compliance/ref.rb
|
105
|
+
- lib/easy_compliance/result.rb
|
106
|
+
- lib/easy_compliance/version.rb
|
107
|
+
- spec/easy_compliance/client_spec.rb
|
108
|
+
- spec/easy_compliance/ref_spec.rb
|
109
|
+
- spec/easy_compliance/result_spec.rb
|
110
|
+
- spec/easy_compliance_spec.rb
|
111
|
+
- spec/spec_helper.rb
|
112
|
+
homepage: https://github.com/betterplace/easy_compliance
|
113
|
+
licenses:
|
114
|
+
- MIT
|
115
|
+
metadata: {}
|
116
|
+
post_install_message:
|
117
|
+
rdoc_options: []
|
118
|
+
require_paths:
|
119
|
+
- lib
|
120
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: 2.4.0
|
125
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
126
|
+
requirements:
|
127
|
+
- - ">="
|
128
|
+
- !ruby/object:Gem::Version
|
129
|
+
version: '0'
|
130
|
+
requirements: []
|
131
|
+
rubygems_version: 3.2.3
|
132
|
+
signing_key:
|
133
|
+
specification_version: 4
|
134
|
+
summary: Ruby toolkit for https://www.easycompliance.de
|
135
|
+
test_files:
|
136
|
+
- spec/easy_compliance/client_spec.rb
|
137
|
+
- spec/easy_compliance/ref_spec.rb
|
138
|
+
- spec/easy_compliance/result_spec.rb
|
139
|
+
- spec/easy_compliance_spec.rb
|
140
|
+
- spec/spec_helper.rb
|