dina 0.1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. checksums.yaml +7 -0
  2. data/lib/dina/authentication/authentication.rb +100 -0
  3. data/lib/dina/casters/array_caster.rb +14 -0
  4. data/lib/dina/casters/multilingual_description.rb +42 -0
  5. data/lib/dina/casters/multilingual_description_caster.rb +13 -0
  6. data/lib/dina/casters/multilingual_title.rb +42 -0
  7. data/lib/dina/casters/multilingual_title_caster.rb +13 -0
  8. data/lib/dina/casters/object_caster.rb +11 -0
  9. data/lib/dina/components/determination.rb +31 -0
  10. data/lib/dina/components/georeference_assertion.rb +26 -0
  11. data/lib/dina/exceptions.rb +4 -0
  12. data/lib/dina/models/acquisition_event.rb +24 -0
  13. data/lib/dina/models/assemblage.rb +27 -0
  14. data/lib/dina/models/attachment.rb +19 -0
  15. data/lib/dina/models/base_model.rb +45 -0
  16. data/lib/dina/models/bucket.rb +8 -0
  17. data/lib/dina/models/collecting_event.rb +76 -0
  18. data/lib/dina/models/collecting_method.rb +23 -0
  19. data/lib/dina/models/collection.rb +40 -0
  20. data/lib/dina/models/derivative.rb +26 -0
  21. data/lib/dina/models/file.rb +40 -0
  22. data/lib/dina/models/identifier.rb +67 -0
  23. data/lib/dina/models/institution.rb +25 -0
  24. data/lib/dina/models/managed_attribute.rb +43 -0
  25. data/lib/dina/models/material_sample.rb +62 -0
  26. data/lib/dina/models/object_store.rb +50 -0
  27. data/lib/dina/models/object_store_managed_attribute.rb +39 -0
  28. data/lib/dina/models/object_subtype.rb +15 -0
  29. data/lib/dina/models/organism.rb +26 -0
  30. data/lib/dina/models/organization.rb +42 -0
  31. data/lib/dina/models/person.rb +43 -0
  32. data/lib/dina/models/preparation_type.rb +23 -0
  33. data/lib/dina/models/project.rb +28 -0
  34. data/lib/dina/models/protocol.rb +25 -0
  35. data/lib/dina/models/storage_unit.rb +26 -0
  36. data/lib/dina/models/storage_unit_type.rb +22 -0
  37. data/lib/dina/models/user.rb +26 -0
  38. data/lib/dina/search/base_search.rb +32 -0
  39. data/lib/dina/search/search.rb +20 -0
  40. data/lib/dina/search/search_autocomplete.rb +26 -0
  41. data/lib/dina/search/search_count.rb +20 -0
  42. data/lib/dina/search/search_mapping.rb +19 -0
  43. data/lib/dina/utils/identifier.rb +62 -0
  44. data/lib/dina/utils/identifier_type.rb +16 -0
  45. data/lib/dina/version.rb +14 -0
  46. data/lib/dina.rb +17 -0
  47. metadata +201 -0
@@ -0,0 +1,19 @@
1
+ require_rel 'base_search'
2
+
3
+ module Dina
4
+ class SearchMapping < BaseSearch
5
+
6
+ def self.endpoint_path
7
+ "search-api/search-ws/mapping"
8
+ end
9
+
10
+ # index values: "agent", "material_sample", "object_store"
11
+ def self.execute(index:)
12
+ params = {
13
+ indexName: index_name(index: index)
14
+ }
15
+ super(params.compact)
16
+ end
17
+
18
+ end
19
+ end
@@ -0,0 +1,62 @@
1
+ # encoding: utf-8
2
+ class String
3
+ def is_orcid?
4
+ ::Dina::Identifier.is_orcid_regex.match?(self) &&
5
+ ::Dina::Identifier.orcid_valid_checksum(self)
6
+ end
7
+
8
+ def is_wiki_id?
9
+ ::Dina::Identifier.is_wiki_regex.match?(self)
10
+ end
11
+
12
+ def is_doi?
13
+ ::Dina::Identifier.is_doi_regex.match?(self)
14
+ end
15
+
16
+ def orcid_from_url
17
+ ::Dina::Identifier.extract_orcid_regex.match(self)[0] rescue nil
18
+ end
19
+
20
+ def wiki_from_url
21
+ ::Dina::Identifier.extract_wiki_regex.match(self)[0] rescue nil
22
+ end
23
+
24
+ end
25
+
26
+ module Dina
27
+ class Identifier
28
+
29
+ class << self
30
+ def is_orcid_regex
31
+ /^0000-000(1-[5-9]|2-[0-9]|3-[0-4])\d{3}-\d{3}[\dX]$/
32
+ end
33
+
34
+ def is_wiki_regex
35
+ /^Q[0-9]{1,}$/
36
+ end
37
+
38
+ def is_doi_regex
39
+ /^10.\d{4,9}\/[-._;()\/:<>A-Z0-9]+$/i
40
+ end
41
+
42
+ def orcid_valid_checksum(orcid_string)
43
+ parts = orcid_string.scan(/[0-9X]/)
44
+ mod = parts[0..14].map(&:to_i)
45
+ .inject { |sum, n| (sum + n)*2 }
46
+ .modulo(11)
47
+ result = (12 - mod) % 11
48
+ parts.last == ((result == 10) ? "X" : result.to_s)
49
+ end
50
+
51
+ def extract_orcid_regex
52
+ /(?<=orcid\.org\/)(\d{4}-){3}\d{3}[0-9X]{1}/
53
+ end
54
+
55
+ def extract_wiki_regex
56
+ /(?:wikidata\.org\/(entity|wiki)\/)\K(Q[0-9]{1,})/
57
+ end
58
+
59
+ end
60
+
61
+ end
62
+ end
@@ -0,0 +1,16 @@
1
+ module Dina
2
+ class IdentifierType
3
+ attr_accessor :type
4
+ attr_accessor :uri
5
+
6
+ def initialize
7
+ end
8
+
9
+ def to_hash
10
+ hash = {}
11
+ instance_variables.each { |var| hash[var.to_s.delete('@')] = instance_variable_get(var) }
12
+ hash
13
+ end
14
+
15
+ end
16
+ end
@@ -0,0 +1,14 @@
1
+ module Dina
2
+ class Version
3
+
4
+ MAJOR = 0
5
+ MINOR = 1
6
+ PATCH = 0
7
+ BUILD = 0
8
+
9
+ def self.version
10
+ [MAJOR, MINOR, PATCH, BUILD].compact.join('.').freeze
11
+ end
12
+
13
+ end
14
+ end
data/lib/dina.rb ADDED
@@ -0,0 +1,17 @@
1
+ require "keycloak"
2
+ require "json_api_client"
3
+ require "time"
4
+ require "securerandom"
5
+ require "require_all"
6
+ require_all File.join(File.dirname(__FILE__), 'dina')
7
+
8
+ module Dina
9
+
10
+ JsonApiClient::Paginating::NestedParamPaginator.page_param = "offset"
11
+ JsonApiClient::Paginating::NestedParamPaginator.per_page_param = "limit"
12
+ JsonApiClient::Schema.register array: Dina::ArrayCaster
13
+ JsonApiClient::Schema.register object: Dina::ObjectCaster
14
+ JsonApiClient::Schema.register multilingual_title: Dina::MultilingualTitleCaster
15
+ JsonApiClient::Schema.register multilingual_description: Dina::MultilingualDescriptionCaster
16
+
17
+ end
metadata ADDED
@@ -0,0 +1,201 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: dina
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - David P. Shorthouse
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2022-08-23 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: json_api_client
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.20'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.20'
27
+ - !ruby/object:Gem::Dependency
28
+ name: keycloak
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 3.2.1
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 3.2.1
41
+ - !ruby/object:Gem::Dependency
42
+ name: securerandom
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 0.2.0
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 0.2.0
55
+ - !ruby/object:Gem::Dependency
56
+ name: require_all
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 3.0.0
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 3.0.0
69
+ - !ruby/object:Gem::Dependency
70
+ name: rake
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '13'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '13'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '3.10'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '3.10'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rspec-uuid
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: 0.5.0
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: 0.5.0
111
+ - !ruby/object:Gem::Dependency
112
+ name: bundler
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '2'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '2'
125
+ description: Authenicate against DINA's Keycloak and access its models
126
+ email: david.shorthouse@agr.gc.ca
127
+ executables: []
128
+ extensions: []
129
+ extra_rdoc_files: []
130
+ files:
131
+ - lib/dina.rb
132
+ - lib/dina/authentication/authentication.rb
133
+ - lib/dina/casters/array_caster.rb
134
+ - lib/dina/casters/multilingual_description.rb
135
+ - lib/dina/casters/multilingual_description_caster.rb
136
+ - lib/dina/casters/multilingual_title.rb
137
+ - lib/dina/casters/multilingual_title_caster.rb
138
+ - lib/dina/casters/object_caster.rb
139
+ - lib/dina/components/determination.rb
140
+ - lib/dina/components/georeference_assertion.rb
141
+ - lib/dina/exceptions.rb
142
+ - lib/dina/models/acquisition_event.rb
143
+ - lib/dina/models/assemblage.rb
144
+ - lib/dina/models/attachment.rb
145
+ - lib/dina/models/base_model.rb
146
+ - lib/dina/models/bucket.rb
147
+ - lib/dina/models/collecting_event.rb
148
+ - lib/dina/models/collecting_method.rb
149
+ - lib/dina/models/collection.rb
150
+ - lib/dina/models/derivative.rb
151
+ - lib/dina/models/file.rb
152
+ - lib/dina/models/identifier.rb
153
+ - lib/dina/models/institution.rb
154
+ - lib/dina/models/managed_attribute.rb
155
+ - lib/dina/models/material_sample.rb
156
+ - lib/dina/models/object_store.rb
157
+ - lib/dina/models/object_store_managed_attribute.rb
158
+ - lib/dina/models/object_subtype.rb
159
+ - lib/dina/models/organism.rb
160
+ - lib/dina/models/organization.rb
161
+ - lib/dina/models/person.rb
162
+ - lib/dina/models/preparation_type.rb
163
+ - lib/dina/models/project.rb
164
+ - lib/dina/models/protocol.rb
165
+ - lib/dina/models/storage_unit.rb
166
+ - lib/dina/models/storage_unit_type.rb
167
+ - lib/dina/models/user.rb
168
+ - lib/dina/search/base_search.rb
169
+ - lib/dina/search/search.rb
170
+ - lib/dina/search/search_autocomplete.rb
171
+ - lib/dina/search/search_count.rb
172
+ - lib/dina/search/search_mapping.rb
173
+ - lib/dina/utils/identifier.rb
174
+ - lib/dina/utils/identifier_type.rb
175
+ - lib/dina/version.rb
176
+ homepage: ''
177
+ licenses:
178
+ - MIT
179
+ metadata: {}
180
+ post_install_message:
181
+ rdoc_options:
182
+ - "--encoding"
183
+ - UTF-8
184
+ require_paths:
185
+ - lib
186
+ required_ruby_version: !ruby/object:Gem::Requirement
187
+ requirements:
188
+ - - ">="
189
+ - !ruby/object:Gem::Version
190
+ version: '3.1'
191
+ required_rubygems_version: !ruby/object:Gem::Requirement
192
+ requirements:
193
+ - - ">="
194
+ - !ruby/object:Gem::Version
195
+ version: '0'
196
+ requirements: []
197
+ rubygems_version: 3.3.7
198
+ signing_key:
199
+ specification_version: 4
200
+ summary: DINA ruby gem
201
+ test_files: []