celsius-primo 0.1.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 (55) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +22 -0
  3. data/.rspec +3 -0
  4. data/.travis.yml +8 -0
  5. data/Gemfile +15 -0
  6. data/LICENSE.txt +22 -0
  7. data/README.md +51 -0
  8. data/Rakefile +6 -0
  9. data/celsius-primo.gemspec +29 -0
  10. data/lib/celsius/primo/adapter/mget.rb +36 -0
  11. data/lib/celsius/primo/adapter/operation.rb +17 -0
  12. data/lib/celsius/primo/adapter/search.rb +28 -0
  13. data/lib/celsius/primo/adapter.rb +52 -0
  14. data/lib/celsius/primo/locales/de.yml +455 -0
  15. data/lib/celsius/primo/locales/en.yml +207 -0
  16. data/lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/add_sort_by_list.rb +36 -0
  17. data/lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/embed_inner_search_request.rb +12 -0
  18. data/lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/process_ids_queries.rb +29 -0
  19. data/lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/process_match_queries.rb +29 -0
  20. data/lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/process_query_string_queries.rb +37 -0
  21. data/lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/process_range_queries.rb +28 -0
  22. data/lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/serialize_target_as_xml.rb +10 -0
  23. data/lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/set_bulk_size.rb +12 -0
  24. data/lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/set_institution.rb +12 -0
  25. data/lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/set_languages.rb +14 -0
  26. data/lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/set_locations.rb +17 -0
  27. data/lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/set_start_index.rb +12 -0
  28. data/lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/setup_inner_search_request.rb +32 -0
  29. data/lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/setup_target.rb +25 -0
  30. data/lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation.rb +59 -0
  31. data/lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/add_missing_facets.rb +45 -0
  32. data/lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/parse_inner_search_brief_return.rb +23 -0
  33. data/lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/process_facets.rb +29 -0
  34. data/lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/process_records.rb +80 -0
  35. data/lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/remove_bogus_creationdate_facets.rb +15 -0
  36. data/lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/select_only_requested_facets.rb +14 -0
  37. data/lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/set_total_hits.rb +12 -0
  38. data/lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/setup_target_skeleton.rb +17 -0
  39. data/lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/sort_facets_by_search_request.rb +21 -0
  40. data/lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation.rb +59 -0
  41. data/lib/celsius/primo/soap_api/searcher/search_brief.rb +56 -0
  42. data/lib/celsius/primo/soap_api/searcher.rb +14 -0
  43. data/lib/celsius/primo/soap_api.rb +22 -0
  44. data/lib/celsius/primo/version.rb +5 -0
  45. data/lib/celsius/primo.rb +7 -0
  46. data/spec/assets/adapter/mget/mget_request.yml +4 -0
  47. data/spec/assets/adapter/mget/mget_result.yml +407 -0
  48. data/spec/assets/adapter/search/search_request.yml +59 -0
  49. data/spec/assets/adapter/search/search_result.yml +1517 -0
  50. data/spec/cassettes/Celsius_Primo_Adapter/_mget/returns_a_normalzed_mget_result.yml +396 -0
  51. data/spec/cassettes/Celsius_Primo_Adapter/_search/returns_a_normalized_search_result.yml +1169 -0
  52. data/spec/celsius-primo/adapter_spec.rb +56 -0
  53. data/spec/celsius-primo_spec.rb +6 -0
  54. data/spec/spec_helper.rb +55 -0
  55. metadata +255 -0
@@ -0,0 +1,56 @@
1
+ describe Celsius::Primo::Adapter do
2
+ let(:adapter_options) do
3
+ {
4
+ institution: "PAD",
5
+ languages: [
6
+ "ger",
7
+ "eng"
8
+ ],
9
+ locations:[
10
+ {
11
+ type: "local",
12
+ value: "scope:(PAD_ALEPH)"
13
+ }
14
+ ],
15
+ soap_api_options: {
16
+ searcher_url: "http://primo.kobv.de/primo_library/libweb/webservices/services/searcher"
17
+ }
18
+ }
19
+ end
20
+
21
+ let(:adapter) do
22
+ described_class.new(adapter_options)
23
+ end
24
+
25
+ describe "#mget" do
26
+ it "returns a normalzed mget result", :vcr do
27
+ mget_request = YAML.load(read_asset("adapter/mget/mget_request.yml"))
28
+ expected_mget_result = YAML.load(read_asset("adapter/mget/mget_result.yml"))
29
+
30
+ expect(adapter.mget(mget_request)).to eq(expected_mget_result)
31
+ end
32
+ end
33
+
34
+ describe "#search" do
35
+ it "returns a normalized search result", :vcr do
36
+ search_request = YAML.load(read_asset("adapter/search/search_request.yml"))
37
+ expected_search_result = YAML.load(read_asset("adapter/search/search_result.yml"))
38
+
39
+ expect(adapter.search(search_request)).to eq(expected_search_result)
40
+ end
41
+
42
+ context "if a the adapter specifies a timeout" do
43
+ context "if the server does not respond within this timeout" do
44
+ let(:timeout) { 0.1 } # decimals can be used the specifiy milliseconds
45
+
46
+ it "raises an Timeout::Error" do
47
+ require "timeout"
48
+ allow(HTTPI).to receive(:post) { sleep(timeout * 2) }
49
+ search_request = YAML.load(read_asset("adapter/search/search_request.yml"))
50
+
51
+ expect { adapter.search(search_request, timeout: timeout) }.to raise_error(Timeout::Error)
52
+ end
53
+ end
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,6 @@
1
+ describe Celsius::Primo do
2
+ it "has a class called Adapter" do
3
+ expect(Celsius::Primo.const_defined? :Adapter).to be true
4
+ expect(Celsius::Primo::Adapter.class.is_a? Class)
5
+ end
6
+ end
@@ -0,0 +1,55 @@
1
+ if ENV["TRAVIS"]
2
+ require "codeclimate-test-reporter"
3
+ CodeClimate::TestReporter.start
4
+ else
5
+ require "simplecov"
6
+ SimpleCov.start
7
+ end
8
+
9
+ require "celsius/primo"
10
+ require "vcr"
11
+ require "yaml"
12
+
13
+ begin
14
+ require "pry"
15
+ rescue LoadError
16
+ end
17
+
18
+ # disable HTTPI loggin (noise)
19
+ HTTPI.log = false
20
+
21
+ RSpec.configure do |config|
22
+ # begin --- rspec 3.1 generator
23
+ config.expect_with :rspec do |expectations|
24
+ expectations.include_chain_clauses_in_custom_matcher_descriptions = true
25
+ end
26
+
27
+ config.mock_with :rspec do |mocks|
28
+ mocks.verify_partial_doubles = true
29
+ end
30
+ # end --- rspec 3.1 generator
31
+ end
32
+
33
+ VCR.configure do |c|
34
+ c.allow_http_connections_when_no_cassette = true
35
+ c.cassette_library_dir = "spec/cassettes"
36
+ c.default_cassette_options = {
37
+ match_requests_on: [:method, :uri, :query, :body],
38
+ decode_compressed_response: true
39
+ }
40
+ c.hook_into :webmock
41
+
42
+ # https://groups.google.com/forum/#!topic/vcr-ruby/2sKrJa86ktU
43
+ c.before_record do |interaction|
44
+ if interaction.response.body.encoding.name == "ASCII-8BIT"
45
+ interaction.response.body.force_encoding("UTF-8")
46
+ end
47
+ end
48
+
49
+ # https://relishapp.com/vcr/vcr/v/2-9-3/docs/test-frameworks/usage-with-rspec-metadata
50
+ c.configure_rspec_metadata!
51
+ end
52
+
53
+ def read_asset(path_to_file)
54
+ File.read(File.expand_path(File.join(File.dirname(__FILE__), "assets", path_to_file)))
55
+ end
metadata ADDED
@@ -0,0 +1,255 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: celsius-primo
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Michael Sievers
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2015-01-21 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: celsius
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: 0.4.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.4.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: httpi
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 2.1.0
34
+ - - "<"
35
+ - !ruby/object:Gem::Version
36
+ version: 3.0.0
37
+ type: :runtime
38
+ prerelease: false
39
+ version_requirements: !ruby/object:Gem::Requirement
40
+ requirements:
41
+ - - ">="
42
+ - !ruby/object:Gem::Version
43
+ version: 2.1.0
44
+ - - "<"
45
+ - !ruby/object:Gem::Version
46
+ version: 3.0.0
47
+ - !ruby/object:Gem::Dependency
48
+ name: ox
49
+ requirement: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - ">="
52
+ - !ruby/object:Gem::Version
53
+ version: 2.1.0
54
+ type: :runtime
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ requirements:
58
+ - - ">="
59
+ - !ruby/object:Gem::Version
60
+ version: 2.1.0
61
+ - !ruby/object:Gem::Dependency
62
+ name: bundler
63
+ requirement: !ruby/object:Gem::Requirement
64
+ requirements:
65
+ - - "~>"
66
+ - !ruby/object:Gem::Version
67
+ version: '1.7'
68
+ type: :development
69
+ prerelease: false
70
+ version_requirements: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - "~>"
73
+ - !ruby/object:Gem::Version
74
+ version: '1.7'
75
+ - !ruby/object:Gem::Dependency
76
+ name: rake
77
+ requirement: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - ">="
80
+ - !ruby/object:Gem::Version
81
+ version: '0'
82
+ type: :development
83
+ prerelease: false
84
+ version_requirements: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: '0'
89
+ - !ruby/object:Gem::Dependency
90
+ name: rspec
91
+ requirement: !ruby/object:Gem::Requirement
92
+ requirements:
93
+ - - ">="
94
+ - !ruby/object:Gem::Version
95
+ version: 3.0.0
96
+ - - "<"
97
+ - !ruby/object:Gem::Version
98
+ version: 4.0.0
99
+ type: :development
100
+ prerelease: false
101
+ version_requirements: !ruby/object:Gem::Requirement
102
+ requirements:
103
+ - - ">="
104
+ - !ruby/object:Gem::Version
105
+ version: 3.0.0
106
+ - - "<"
107
+ - !ruby/object:Gem::Version
108
+ version: 4.0.0
109
+ - !ruby/object:Gem::Dependency
110
+ name: simplecov
111
+ requirement: !ruby/object:Gem::Requirement
112
+ requirements:
113
+ - - ">="
114
+ - !ruby/object:Gem::Version
115
+ version: 0.8.0
116
+ type: :development
117
+ prerelease: false
118
+ version_requirements: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: 0.8.0
123
+ - !ruby/object:Gem::Dependency
124
+ name: vcr
125
+ requirement: !ruby/object:Gem::Requirement
126
+ requirements:
127
+ - - ">="
128
+ - !ruby/object:Gem::Version
129
+ version: 2.9.0
130
+ - - "<"
131
+ - !ruby/object:Gem::Version
132
+ version: 3.0.0
133
+ type: :development
134
+ prerelease: false
135
+ version_requirements: !ruby/object:Gem::Requirement
136
+ requirements:
137
+ - - ">="
138
+ - !ruby/object:Gem::Version
139
+ version: 2.9.0
140
+ - - "<"
141
+ - !ruby/object:Gem::Version
142
+ version: 3.0.0
143
+ - !ruby/object:Gem::Dependency
144
+ name: webmock
145
+ requirement: !ruby/object:Gem::Requirement
146
+ requirements:
147
+ - - ">="
148
+ - !ruby/object:Gem::Version
149
+ version: 1.19.0
150
+ - - "<"
151
+ - !ruby/object:Gem::Version
152
+ version: 2.0.0
153
+ type: :development
154
+ prerelease: false
155
+ version_requirements: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - ">="
158
+ - !ruby/object:Gem::Version
159
+ version: 1.19.0
160
+ - - "<"
161
+ - !ruby/object:Gem::Version
162
+ version: 2.0.0
163
+ description:
164
+ email:
165
+ executables: []
166
+ extensions: []
167
+ extra_rdoc_files: []
168
+ files:
169
+ - ".gitignore"
170
+ - ".rspec"
171
+ - ".travis.yml"
172
+ - Gemfile
173
+ - LICENSE.txt
174
+ - README.md
175
+ - Rakefile
176
+ - celsius-primo.gemspec
177
+ - lib/celsius/primo.rb
178
+ - lib/celsius/primo/adapter.rb
179
+ - lib/celsius/primo/adapter/mget.rb
180
+ - lib/celsius/primo/adapter/operation.rb
181
+ - lib/celsius/primo/adapter/search.rb
182
+ - lib/celsius/primo/locales/de.yml
183
+ - lib/celsius/primo/locales/en.yml
184
+ - lib/celsius/primo/soap_api.rb
185
+ - lib/celsius/primo/soap_api/searcher.rb
186
+ - lib/celsius/primo/soap_api/searcher/search_brief.rb
187
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation.rb
188
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/add_sort_by_list.rb
189
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/embed_inner_search_request.rb
190
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/process_ids_queries.rb
191
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/process_match_queries.rb
192
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/process_query_string_queries.rb
193
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/process_range_queries.rb
194
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/serialize_target_as_xml.rb
195
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/set_bulk_size.rb
196
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/set_institution.rb
197
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/set_languages.rb
198
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/set_locations.rb
199
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/set_start_index.rb
200
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/setup_inner_search_request.rb
201
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_request_transformation/setup_target.rb
202
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation.rb
203
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/add_missing_facets.rb
204
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/parse_inner_search_brief_return.rb
205
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/process_facets.rb
206
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/process_records.rb
207
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/remove_bogus_creationdate_facets.rb
208
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/select_only_requested_facets.rb
209
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/set_total_hits.rb
210
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/setup_target_skeleton.rb
211
+ - lib/celsius/primo/soap_api/searcher/search_brief/search_result_transformation/sort_facets_by_search_request.rb
212
+ - lib/celsius/primo/version.rb
213
+ - spec/assets/adapter/mget/mget_request.yml
214
+ - spec/assets/adapter/mget/mget_result.yml
215
+ - spec/assets/adapter/search/search_request.yml
216
+ - spec/assets/adapter/search/search_result.yml
217
+ - spec/cassettes/Celsius_Primo_Adapter/_mget/returns_a_normalzed_mget_result.yml
218
+ - spec/cassettes/Celsius_Primo_Adapter/_search/returns_a_normalized_search_result.yml
219
+ - spec/celsius-primo/adapter_spec.rb
220
+ - spec/celsius-primo_spec.rb
221
+ - spec/spec_helper.rb
222
+ homepage: https://github.com/ubpb/celsius-primo
223
+ licenses:
224
+ - MIT
225
+ metadata: {}
226
+ post_install_message:
227
+ rdoc_options: []
228
+ require_paths:
229
+ - lib
230
+ required_ruby_version: !ruby/object:Gem::Requirement
231
+ requirements:
232
+ - - ">="
233
+ - !ruby/object:Gem::Version
234
+ version: '0'
235
+ required_rubygems_version: !ruby/object:Gem::Requirement
236
+ requirements:
237
+ - - ">="
238
+ - !ruby/object:Gem::Version
239
+ version: '0'
240
+ requirements: []
241
+ rubyforge_project:
242
+ rubygems_version: 2.4.5
243
+ signing_key:
244
+ specification_version: 4
245
+ summary: Generic primo celsius adapter
246
+ test_files:
247
+ - spec/assets/adapter/mget/mget_request.yml
248
+ - spec/assets/adapter/mget/mget_result.yml
249
+ - spec/assets/adapter/search/search_request.yml
250
+ - spec/assets/adapter/search/search_result.yml
251
+ - spec/cassettes/Celsius_Primo_Adapter/_mget/returns_a_normalzed_mget_result.yml
252
+ - spec/cassettes/Celsius_Primo_Adapter/_search/returns_a_normalized_search_result.yml
253
+ - spec/celsius-primo/adapter_spec.rb
254
+ - spec/celsius-primo_spec.rb
255
+ - spec/spec_helper.rb