alfresco 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.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +69 -0
- data/README.md +119 -0
- data/Rakefile +8 -0
- data/alfresco.gemspec +45 -0
- data/docs/ContentInfo.md +12 -0
- data/docs/Error.md +8 -0
- data/docs/ErrorError.md +13 -0
- data/docs/GenericBucket.md +13 -0
- data/docs/GenericBucketBucketInfo.md +11 -0
- data/docs/GenericFacetResponse.md +10 -0
- data/docs/GenericMetric.md +9 -0
- data/docs/Node.md +24 -0
- data/docs/Pagination.md +12 -0
- data/docs/PathElement.md +9 -0
- data/docs/PathInfo.md +10 -0
- data/docs/RequestDefaults.md +12 -0
- data/docs/RequestFacetField.md +18 -0
- data/docs/RequestFacetFields.md +8 -0
- data/docs/RequestFacetIntervals.md +9 -0
- data/docs/RequestFacetIntervalsIntervals.md +10 -0
- data/docs/RequestFacetQueries.md +7 -0
- data/docs/RequestFacetQueriesInner.md +9 -0
- data/docs/RequestFacetSet.md +12 -0
- data/docs/RequestFields.md +7 -0
- data/docs/RequestFilterQueries.md +7 -0
- data/docs/RequestFilterQueriesInner.md +9 -0
- data/docs/RequestHighlight.md +15 -0
- data/docs/RequestHighlightFields.md +13 -0
- data/docs/RequestInclude.md +7 -0
- data/docs/RequestLimits.md +9 -0
- data/docs/RequestLocalization.md +9 -0
- data/docs/RequestPagination.md +9 -0
- data/docs/RequestPivot.md +9 -0
- data/docs/RequestQuery.md +10 -0
- data/docs/RequestRange.md +16 -0
- data/docs/RequestScope.md +8 -0
- data/docs/RequestSortDefinition.md +7 -0
- data/docs/RequestSortDefinitionInner.md +10 -0
- data/docs/RequestSpellcheck.md +8 -0
- data/docs/RequestStats.md +23 -0
- data/docs/RequestTemplates.md +7 -0
- data/docs/RequestTemplatesInner.md +9 -0
- data/docs/ResponseConsistency.md +8 -0
- data/docs/ResultBuckets.md +9 -0
- data/docs/ResultBucketsBuckets.md +11 -0
- data/docs/ResultNode.md +29 -0
- data/docs/ResultSetContext.md +13 -0
- data/docs/ResultSetContextFacetQueries.md +10 -0
- data/docs/ResultSetContextSpellcheck.md +9 -0
- data/docs/ResultSetPaging.md +8 -0
- data/docs/ResultSetPagingList.md +10 -0
- data/docs/ResultSetRowEntry.md +8 -0
- data/docs/SearchApi.md +62 -0
- data/docs/SearchEntry.md +9 -0
- data/docs/SearchEntryHighlight.md +9 -0
- data/docs/SearchRequest.md +27 -0
- data/docs/UserInfo.md +9 -0
- data/git_push.sh +55 -0
- data/lib/alfresco.rb +92 -0
- data/lib/alfresco/api/search_api.rb +78 -0
- data/lib/alfresco/api_client.rb +389 -0
- data/lib/alfresco/api_error.rb +38 -0
- data/lib/alfresco/configuration.rb +209 -0
- data/lib/alfresco/models/content_info.rb +239 -0
- data/lib/alfresco/models/error.rb +188 -0
- data/lib/alfresco/models/error_error.rb +253 -0
- data/lib/alfresco/models/generic_bucket.rb +242 -0
- data/lib/alfresco/models/generic_bucket_bucket_info.rb +219 -0
- data/lib/alfresco/models/generic_facet_response.rb +211 -0
- data/lib/alfresco/models/generic_metric.rb +199 -0
- data/lib/alfresco/models/node.rb +403 -0
- data/lib/alfresco/models/pagination.rb +249 -0
- data/lib/alfresco/models/path_element.rb +197 -0
- data/lib/alfresco/models/path_info.rb +208 -0
- data/lib/alfresco/models/request_defaults.rb +283 -0
- data/lib/alfresco/models/request_facet_field.rb +333 -0
- data/lib/alfresco/models/request_facet_fields.rb +191 -0
- data/lib/alfresco/models/request_facet_intervals.rb +203 -0
- data/lib/alfresco/models/request_facet_intervals_intervals.rb +211 -0
- data/lib/alfresco/models/request_facet_queries.rb +179 -0
- data/lib/alfresco/models/request_facet_queries_inner.rb +199 -0
- data/lib/alfresco/models/request_facet_set.rb +233 -0
- data/lib/alfresco/models/request_fields.rb +179 -0
- data/lib/alfresco/models/request_filter_queries.rb +179 -0
- data/lib/alfresco/models/request_filter_queries_inner.rb +201 -0
- data/lib/alfresco/models/request_highlight.rb +261 -0
- data/lib/alfresco/models/request_highlight_fields.rb +234 -0
- data/lib/alfresco/models/request_include.rb +179 -0
- data/lib/alfresco/models/request_limits.rb +199 -0
- data/lib/alfresco/models/request_localization.rb +201 -0
- data/lib/alfresco/models/request_pagination.rb +231 -0
- data/lib/alfresco/models/request_pivot.rb +200 -0
- data/lib/alfresco/models/request_query.rb +249 -0
- data/lib/alfresco/models/request_range.rb +275 -0
- data/lib/alfresco/models/request_scope.rb +222 -0
- data/lib/alfresco/models/request_sort_definition.rb +179 -0
- data/lib/alfresco/models/request_sort_definition_inner.rb +246 -0
- data/lib/alfresco/models/request_spellcheck.rb +188 -0
- data/lib/alfresco/models/request_stats.rb +367 -0
- data/lib/alfresco/models/request_templates.rb +179 -0
- data/lib/alfresco/models/request_templates_inner.rb +199 -0
- data/lib/alfresco/models/response_consistency.rb +189 -0
- data/lib/alfresco/models/result_buckets.rb +201 -0
- data/lib/alfresco/models/result_buckets_buckets.rb +219 -0
- data/lib/alfresco/models/result_node.rb +448 -0
- data/lib/alfresco/models/result_set_context.rb +245 -0
- data/lib/alfresco/models/result_set_context_facet_queries.rb +207 -0
- data/lib/alfresco/models/result_set_context_spellcheck.rb +233 -0
- data/lib/alfresco/models/result_set_paging.rb +188 -0
- data/lib/alfresco/models/result_set_paging_list.rb +208 -0
- data/lib/alfresco/models/result_set_row_entry.rb +193 -0
- data/lib/alfresco/models/search_entry.rb +201 -0
- data/lib/alfresco/models/search_entry_highlight.rb +201 -0
- data/lib/alfresco/models/search_request.rb +373 -0
- data/lib/alfresco/models/user_info.rb +207 -0
- data/lib/alfresco/version.rb +15 -0
- data/spec/api/search_api_spec.rb +47 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +39 -0
- data/spec/models/content_info_spec.rb +66 -0
- data/spec/models/error_error_spec.rb +72 -0
- data/spec/models/error_spec.rb +42 -0
- data/spec/models/generic_bucket_bucket_info_spec.rb +60 -0
- data/spec/models/generic_bucket_spec.rb +72 -0
- data/spec/models/generic_facet_response_spec.rb +54 -0
- data/spec/models/generic_metric_spec.rb +48 -0
- data/spec/models/node_spec.rb +138 -0
- data/spec/models/pagination_spec.rb +66 -0
- data/spec/models/path_element_spec.rb +48 -0
- data/spec/models/path_info_spec.rb +54 -0
- data/spec/models/request_defaults_spec.rb +74 -0
- data/spec/models/request_facet_field_spec.rb +110 -0
- data/spec/models/request_facet_fields_spec.rb +42 -0
- data/spec/models/request_facet_intervals_intervals_spec.rb +54 -0
- data/spec/models/request_facet_intervals_spec.rb +48 -0
- data/spec/models/request_facet_queries_inner_spec.rb +48 -0
- data/spec/models/request_facet_queries_spec.rb +36 -0
- data/spec/models/request_facet_set_spec.rb +66 -0
- data/spec/models/request_fields_spec.rb +36 -0
- data/spec/models/request_filter_queries_inner_spec.rb +48 -0
- data/spec/models/request_filter_queries_spec.rb +36 -0
- data/spec/models/request_highlight_fields_spec.rb +72 -0
- data/spec/models/request_highlight_spec.rb +84 -0
- data/spec/models/request_include_spec.rb +36 -0
- data/spec/models/request_limits_spec.rb +48 -0
- data/spec/models/request_localization_spec.rb +48 -0
- data/spec/models/request_pagination_spec.rb +48 -0
- data/spec/models/request_pivot_spec.rb +48 -0
- data/spec/models/request_query_spec.rb +58 -0
- data/spec/models/request_range_spec.rb +90 -0
- data/spec/models/request_scope_spec.rb +46 -0
- data/spec/models/request_sort_definition_inner_spec.rb +58 -0
- data/spec/models/request_sort_definition_spec.rb +36 -0
- data/spec/models/request_spellcheck_spec.rb +42 -0
- data/spec/models/request_stats_spec.rb +132 -0
- data/spec/models/request_templates_inner_spec.rb +48 -0
- data/spec/models/request_templates_spec.rb +36 -0
- data/spec/models/response_consistency_spec.rb +42 -0
- data/spec/models/result_buckets_buckets_spec.rb +60 -0
- data/spec/models/result_buckets_spec.rb +48 -0
- data/spec/models/result_node_spec.rb +168 -0
- data/spec/models/result_set_context_facet_queries_spec.rb +54 -0
- data/spec/models/result_set_context_spec.rb +72 -0
- data/spec/models/result_set_context_spellcheck_spec.rb +52 -0
- data/spec/models/result_set_paging_list_spec.rb +54 -0
- data/spec/models/result_set_paging_spec.rb +42 -0
- data/spec/models/result_set_row_entry_spec.rb +42 -0
- data/spec/models/search_entry_highlight_spec.rb +48 -0
- data/spec/models/search_entry_spec.rb +48 -0
- data/spec/models/search_request_spec.rb +156 -0
- data/spec/models/user_info_spec.rb +48 -0
- data/spec/spec_helper.rb +111 -0
- metadata +455 -0
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Alfresco Content Services REST API
|
|
3
|
+
|
|
4
|
+
#**Search API** Provides access to the search features of Alfresco Content Services.
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 1
|
|
7
|
+
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.2.3
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
module Alfresco
|
|
14
|
+
VERSION = "1.0.0"
|
|
15
|
+
end
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Alfresco Content Services REST API
|
|
3
|
+
|
|
4
|
+
#**Search API** Provides access to the search features of Alfresco Content Services.
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 1
|
|
7
|
+
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.2.3
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
|
|
16
|
+
# Unit tests for Alfresco::SearchApi
|
|
17
|
+
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
|
18
|
+
# Please update as you see appropriate
|
|
19
|
+
describe 'SearchApi' do
|
|
20
|
+
before do
|
|
21
|
+
# run before each test
|
|
22
|
+
@instance = Alfresco::SearchApi.new
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
after do
|
|
26
|
+
# run after each test
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
describe 'test an instance of SearchApi' do
|
|
30
|
+
it 'should create an instance of SearchApi' do
|
|
31
|
+
expect(@instance).to be_instance_of(Alfresco::SearchApi)
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# unit tests for search
|
|
36
|
+
# Searches Alfresco
|
|
37
|
+
# **Note**: this endpoint is available in Alfresco 5.2 and newer versions. **You specify all the parameters in this API in a JSON body**, URL parameters are not supported. A basic query looks like this: ```JSON { \"query\": { \"query\": \"foo\" } } ``` **Note:** These are the minimum possible query parameters. The default search language is **afts** ([Alfresco Full Text Search](http://docs.alfresco.com/5.1/concepts/rm-searchsyntax-intro.html)), but you can also specify **cmis**, and **lucene**. A basic CMIS query looks like this: ```JSON { \"query\": { \"query\": \"select * from cmis:folder\", \"language\": \"cmis\" } } ``` By default, **results are limited to the first 100.** Results can be restricted using \"paging\". For example: ```JSON \"paging\": { \"maxItems\": \"50\", \"skipCount\": \"28\" } ``` This example would ensure that results are **limited by Final Size**, skipping the first 28 results and returning the next 50. Alternatively, you can limit the results by using the **limits JSON body parameter**. For example, ```JSON \"limits\": { \"permissionEvaluationTime\": 20000, \"permissionEvaluationCount\": 2000 } ``` You can use the **include JSON body parameter** to return additional information. This works in the same way as in the /nodes/{nodeId}/children method in the core API. For example: ```JSON \"include\": [\"aspectNames\", \"properties\", \"isLink\"] ``` You can use the **fields JSON body parameter** to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. This works in the same way as in the /nodes/{nodeId}/children method in the core API. For example: ```JSON \"fields\": [\"id\", \"name\", \"search\"] ``` You can sort the results using the **sort JSON body parameter**, for example: ```JSON \"sort\": [{\"type\":\"FIELD\", \"field\":\"cm:description\", \"ascending\":\"true\"}] ``` **Note:** the **sort** parameter is not supported for CMIS queries. By default, search uses the **\"nodes\" location**, which is the **content store known as workspace://SpacesStore**. To change the scope to another location you can use the **locations JSON body parameter**. You can specify either **nodes** (the default), **versions** or **deleted-nodes**. For example, ```JSON \"scope\": { \"locations\": [\"deleted-nodes\"] } ``` You can specify templates using the **templates JSON body parameter**, for example: ```JSON \"templates\": [{\"name\": \"_PERSON\",\"template\": \"|%firstName OR |%lastName OR |%userName\"}, {\"name\": \"mytemplate\",\"template\": \"%cm:content\"}] ``` **Note: Spell checking only works on Search Services (Solr 6) if you have already enabled suggestions.** For **spell checking** you can use a query like this: ```JSON { \"query\": { \"query\": \"cm:title:alfrezco\" }, \"spellcheck\": {\"query\": \"alfrezco\"} } ``` If you are already specifying \"userQuery\" then the following may be easier and produces the same result : ```JSON { \"query\": { \"query\": \"cm:title:alfrezco\", \"userQuery\": \"alfrezco\" }, \"spellcheck\": {} } ``` The spellcheck response includes a spellCheck context like this: ```JSON \"context\": { \"spellCheck\": { \"type\": \"searchInsteadFor\", \"suggestions\": [\"alfresco\"] } }, ``` To specify defaults, you use a **defaults JSON body parameter**, for example: ```JSON \"defaults\": { \"textAttributes\": [ \"cm:content\", \"cm:name\" ], \"defaultFTSOperator\": \"AND\", \"defaultFTSFieldOperator\": \"OR\", \"namespace\": \"cm\", \"defaultFieldName\": \"PATH\" } ``` You can specify several filter queries using the **filterQueries JSON body parameter**, for example: ```JSON \"filterQueries\": [{\"query\": \"TYPE:'cm:folder'\"},{\"query\": \"cm:creator:mjackson\"}] ``` You can specify several facet queries using the **facetQueries JSON body parameter**, for example: ```JSON \"facetQueries\": [{\"query\": \"created:2016\",\"label\": \"CreatedThisYear\"}] ``` The response will contain a matching \"context\" section, the \"label\" will match the facet query. ```JSON \"context\": { \"facetQueries\": [ {\"label\": \"CreatedThisYear\",\"count\": 3} ] }, ``` A complete query for facetting via the content.size field looks this: ```JSON { \"query\": { \"query\": \"presentation\", \"language\": \"afts\" }, \"facetQueries\": [ {\"query\": \"content.size:[0 TO 10240]\", \"label\": \"xtra small\"}, {\"query\": \"content.size:[10240 TO 102400]\", \"label\": \"small\"}, {\"query\": \"content.size:[102400 TO 1048576]\", \"label\": \"medium\"}, {\"query\": \"content.size:[1048576 TO 16777216]\", \"label\": \"large\"}, {\"query\": \"content.size:[16777216 TO 134217728]\", \"label\": \"xtra large\"}, {\"query\": \"content.size:[134217728 TO MAX]\", \"label\": \"XX large\"} ], \"facetFields\": {\"facets\": [{\"field\": \"'content.size'\"}]} } ``` The response will contain a matching \"context\" section, the \"label\" will match the facet query. ```JSON \"context\": { \"facetQueries\": [ { \"label\": \"small\",\"count\": 2 }, { \"label\": \"large\",\"count\": 0 }, { \"label\": \"xtra small\",\"count\": 5 }, { \"label\": \"xtra large\",\"count\": 56}, { \"label\": \"medium\",\"count\": 4 }, { \"label\": \"XX large\", \"count\": 1 } ] }, ``` You can specify several facet fields using the **facetFields JSON body parameter**, for example: ```JSON \"facetFields\": {\"facets\": [{\"field\": \"creator\", \"mincount\": 1}, {\"field\": \"modifier\", \"mincount\": 1}]} ``` The response will contain a matching \"context\" section, the \"label\" will match the facet field. ```JSON \"context\": { \"facetsFields\": [ { \"label\": \"creator\", \"buckets\": [ { \"label\": \"System\", \"count\": 75 }, { \"label\": \"mjackson\", \"count\": 5 } ]}, { \"label\": \"modifier\", \"buckets\": [ { \"label\": \"System\", \"count\": 72 }, { \"label\": \"mjackson\", \"count\": 5 }, { \"label\": \"admin\", \"count\": 3 } ]} ] }, ``` Grouping facet queries that go together can be done by specifying the group label in the fact queries as follow: ```JSON { \"query\": { \"query\": \"presentation\" }, \"facetQueries\": [ {\"query\": \"content.size:[0 TO 102400]\", \"label\": \"small\", \"group\":\"foo\"}, {\"query\": \"content.size:[102400 TO 1048576]\", \"label\": \"medium\",\"group\":\"foo\"}, {\"query\": \"content.size:[1048576 TO 16777216]\", \"label\": \"large\",\"group\":\"foo\"} ] } ``` The above query returns the results a faceted field grouped under the label foo: ```JSON { \"context\": {\"facetsFields\": [{ \"label\": \"foo\", \"buckets\": [ { \"count\": 109, \"label\": \"small\", \"filterQuery\": \"content.size:[0 TO 102400]\" }, { \"count\": 0, \"label\": \"large\", \"filterQuery\": \"content.size:[1048576 TO 16777216]\" }, { \"count\": 0, \"label\": \"medium\", \"filterQuery\": \"content.size:[102400 TO 1048576]\" } ] }] } ``` Range Faceting is supported by the **ranges JSON body parameter**, for example: ```JSON { \"query\": { \"query\": \"presentation\" }, \"ranges\": [ { \"field\": \"content.size\", \"start\": \"0\", \"end\": \"100\", \"gap\": \"20\", \"hardend\": true }, { \"field\": \"created\", \"start\": \"2015-09-29T10:45:15.729Z\", \"end\": \"2016-09-29T10:45:15.729Z\", \"gap\": \"+100DAY\" }] } ``` An example query for **search highlighting** could look like this: ```JSON { \"query\": { \"query\": \"description:workflow\", \"userQuery\":\"workflow\" }, \"highlight\": { \"prefix\": \"¿\", \"postfix\": \"?\", \"mergeContiguous\": true, \"fields\": [ { \"field\": \"cm:title\" }, { \"field\": \"description\", \"prefix\": \"(\", \"postfix\": \")\" } ] } } ``` The example above changes the highlighting prefix and postfix from the default <em> for all fields to ¿? and just for the \"description\" field to (). The hightlight information is added in each node entry response; here is an example partial response: ``` \"entry\": { \"createdAt\": \"2016-10-12T15:24:31.202+0000\", \"isFolder\": true, \"search\": { \"score\": 1, \"highlight\": [ { \"field\": \"cm:title\", \"snippets\": [ \"Customized ¿Workflow? Process Definitions\" ] }, { \"field\": \"description\", \"snippets\": [ \"Customized (Workflow) Process Definitions\" ] } ] }, ```
|
|
38
|
+
# @param query_body Generic query API
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @return [ResultSetPaging]
|
|
41
|
+
describe 'search test' do
|
|
42
|
+
it "should work" do
|
|
43
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
end
|
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Alfresco Content Services REST API
|
|
3
|
+
|
|
4
|
+
#**Search API** Provides access to the search features of Alfresco Content Services.
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 1
|
|
7
|
+
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.2.3
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
|
|
15
|
+
describe Alfresco::ApiClient do
|
|
16
|
+
context 'initialization' do
|
|
17
|
+
context 'URL stuff' do
|
|
18
|
+
context 'host' do
|
|
19
|
+
it 'removes http from host' do
|
|
20
|
+
Alfresco.configure { |c| c.host = 'http://example.com' }
|
|
21
|
+
expect(Alfresco::Configuration.default.host).to eq('example.com')
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
it 'removes https from host' do
|
|
25
|
+
Alfresco.configure { |c| c.host = 'https://wookiee.com' }
|
|
26
|
+
expect(Alfresco::ApiClient.default.config.host).to eq('wookiee.com')
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
it 'removes trailing path from host' do
|
|
30
|
+
Alfresco.configure { |c| c.host = 'hobo.com/v4' }
|
|
31
|
+
expect(Alfresco::Configuration.default.host).to eq('hobo.com')
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
context 'base_path' do
|
|
36
|
+
it "prepends a slash to base_path" do
|
|
37
|
+
Alfresco.configure { |c| c.base_path = 'v4/dog' }
|
|
38
|
+
expect(Alfresco::Configuration.default.base_path).to eq('/v4/dog')
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
it "doesn't prepend a slash if one is already there" do
|
|
42
|
+
Alfresco.configure { |c| c.base_path = '/v4/dog' }
|
|
43
|
+
expect(Alfresco::Configuration.default.base_path).to eq('/v4/dog')
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
it "ends up as a blank string if nil" do
|
|
47
|
+
Alfresco.configure { |c| c.base_path = nil }
|
|
48
|
+
expect(Alfresco::Configuration.default.base_path).to eq('')
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
describe "params_encoding in #build_request" do
|
|
55
|
+
let(:config) { Alfresco::Configuration.new }
|
|
56
|
+
let(:api_client) { Alfresco::ApiClient.new(config) }
|
|
57
|
+
|
|
58
|
+
it "defaults to nil" do
|
|
59
|
+
expect(Alfresco::Configuration.default.params_encoding).to eq(nil)
|
|
60
|
+
expect(config.params_encoding).to eq(nil)
|
|
61
|
+
|
|
62
|
+
request = api_client.build_request(:get, '/test')
|
|
63
|
+
expect(request.options[:params_encoding]).to eq(nil)
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
it "can be customized" do
|
|
67
|
+
config.params_encoding = :multi
|
|
68
|
+
request = api_client.build_request(:get, '/test')
|
|
69
|
+
expect(request.options[:params_encoding]).to eq(:multi)
|
|
70
|
+
end
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
describe "timeout in #build_request" do
|
|
74
|
+
let(:config) { Alfresco::Configuration.new }
|
|
75
|
+
let(:api_client) { Alfresco::ApiClient.new(config) }
|
|
76
|
+
|
|
77
|
+
it "defaults to 0" do
|
|
78
|
+
expect(Alfresco::Configuration.default.timeout).to eq(0)
|
|
79
|
+
expect(config.timeout).to eq(0)
|
|
80
|
+
|
|
81
|
+
request = api_client.build_request(:get, '/test')
|
|
82
|
+
expect(request.options[:timeout]).to eq(0)
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
it "can be customized" do
|
|
86
|
+
config.timeout = 100
|
|
87
|
+
request = api_client.build_request(:get, '/test')
|
|
88
|
+
expect(request.options[:timeout]).to eq(100)
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
describe "#deserialize" do
|
|
93
|
+
it "handles Array<Integer>" do
|
|
94
|
+
api_client = Alfresco::ApiClient.new
|
|
95
|
+
headers = {'Content-Type' => 'application/json'}
|
|
96
|
+
response = double('response', headers: headers, body: '[12, 34]')
|
|
97
|
+
data = api_client.deserialize(response, 'Array<Integer>')
|
|
98
|
+
expect(data).to be_instance_of(Array)
|
|
99
|
+
expect(data).to eq([12, 34])
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
it "handles Array<Array<Integer>>" do
|
|
103
|
+
api_client = Alfresco::ApiClient.new
|
|
104
|
+
headers = {'Content-Type' => 'application/json'}
|
|
105
|
+
response = double('response', headers: headers, body: '[[12, 34], [56]]')
|
|
106
|
+
data = api_client.deserialize(response, 'Array<Array<Integer>>')
|
|
107
|
+
expect(data).to be_instance_of(Array)
|
|
108
|
+
expect(data).to eq([[12, 34], [56]])
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
it "handles Hash<String, String>" do
|
|
112
|
+
api_client = Alfresco::ApiClient.new
|
|
113
|
+
headers = {'Content-Type' => 'application/json'}
|
|
114
|
+
response = double('response', headers: headers, body: '{"message": "Hello"}')
|
|
115
|
+
data = api_client.deserialize(response, 'Hash<String, String>')
|
|
116
|
+
expect(data).to be_instance_of(Hash)
|
|
117
|
+
expect(data).to eq({:message => 'Hello'})
|
|
118
|
+
end
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
describe "#object_to_hash" do
|
|
122
|
+
it "ignores nils and includes empty arrays" do
|
|
123
|
+
# uncomment below to test object_to_hash for model
|
|
124
|
+
#api_client = Alfresco::ApiClient.new
|
|
125
|
+
#_model = Alfresco::ModelName.new
|
|
126
|
+
# update the model attribute below
|
|
127
|
+
#_model.id = 1
|
|
128
|
+
# update the expected value (hash) below
|
|
129
|
+
#expected = {id: 1, name: '', tags: []}
|
|
130
|
+
#expect(api_client.object_to_hash(_model)).to eq(expected)
|
|
131
|
+
end
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
describe "#build_collection_param" do
|
|
135
|
+
let(:param) { ['aa', 'bb', 'cc'] }
|
|
136
|
+
let(:api_client) { Alfresco::ApiClient.new }
|
|
137
|
+
|
|
138
|
+
it "works for csv" do
|
|
139
|
+
expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
it "works for ssv" do
|
|
143
|
+
expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
|
|
144
|
+
end
|
|
145
|
+
|
|
146
|
+
it "works for tsv" do
|
|
147
|
+
expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
|
|
148
|
+
end
|
|
149
|
+
|
|
150
|
+
it "works for pipes" do
|
|
151
|
+
expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
it "works for multi" do
|
|
155
|
+
expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
it "fails for invalid collection format" do
|
|
159
|
+
expect(proc { api_client.build_collection_param(param, :INVALID) }).to raise_error(RuntimeError, 'unknown collection format: :INVALID')
|
|
160
|
+
end
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
describe "#json_mime?" do
|
|
164
|
+
let(:api_client) { Alfresco::ApiClient.new }
|
|
165
|
+
|
|
166
|
+
it "works" do
|
|
167
|
+
expect(api_client.json_mime?(nil)).to eq false
|
|
168
|
+
expect(api_client.json_mime?('')).to eq false
|
|
169
|
+
|
|
170
|
+
expect(api_client.json_mime?('application/json')).to eq true
|
|
171
|
+
expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
|
|
172
|
+
expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
|
|
173
|
+
|
|
174
|
+
expect(api_client.json_mime?('application/xml')).to eq false
|
|
175
|
+
expect(api_client.json_mime?('text/plain')).to eq false
|
|
176
|
+
expect(api_client.json_mime?('application/jsonp')).to eq false
|
|
177
|
+
end
|
|
178
|
+
end
|
|
179
|
+
|
|
180
|
+
describe "#select_header_accept" do
|
|
181
|
+
let(:api_client) { Alfresco::ApiClient.new }
|
|
182
|
+
|
|
183
|
+
it "works" do
|
|
184
|
+
expect(api_client.select_header_accept(nil)).to be_nil
|
|
185
|
+
expect(api_client.select_header_accept([])).to be_nil
|
|
186
|
+
|
|
187
|
+
expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
|
|
188
|
+
expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
|
|
189
|
+
expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
|
|
190
|
+
|
|
191
|
+
expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
|
|
192
|
+
expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
|
|
193
|
+
end
|
|
194
|
+
end
|
|
195
|
+
|
|
196
|
+
describe "#select_header_content_type" do
|
|
197
|
+
let(:api_client) { Alfresco::ApiClient.new }
|
|
198
|
+
|
|
199
|
+
it "works" do
|
|
200
|
+
expect(api_client.select_header_content_type(nil)).to eq('application/json')
|
|
201
|
+
expect(api_client.select_header_content_type([])).to eq('application/json')
|
|
202
|
+
|
|
203
|
+
expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
|
|
204
|
+
expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
|
|
205
|
+
expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
|
|
206
|
+
expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
|
|
207
|
+
expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
|
|
208
|
+
end
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
describe "#sanitize_filename" do
|
|
212
|
+
let(:api_client) { Alfresco::ApiClient.new }
|
|
213
|
+
|
|
214
|
+
it "works" do
|
|
215
|
+
expect(api_client.sanitize_filename('sun')).to eq('sun')
|
|
216
|
+
expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
|
|
217
|
+
expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
|
|
218
|
+
expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
|
|
219
|
+
expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
|
|
220
|
+
expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
|
|
221
|
+
expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
|
|
222
|
+
expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
|
|
223
|
+
expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
|
|
224
|
+
end
|
|
225
|
+
end
|
|
226
|
+
end
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Alfresco Content Services REST API
|
|
3
|
+
|
|
4
|
+
#**Search API** Provides access to the search features of Alfresco Content Services.
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 1
|
|
7
|
+
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.2.3
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
|
|
15
|
+
describe Alfresco::Configuration do
|
|
16
|
+
let(:config) { Alfresco::Configuration.default }
|
|
17
|
+
|
|
18
|
+
before(:each) do
|
|
19
|
+
require 'URI'
|
|
20
|
+
uri = URI.parse("http://localhost:8080/alfresco/api/-default-/public/search/versions/1")
|
|
21
|
+
Alfresco.configure do |c|
|
|
22
|
+
c.host = uri.host
|
|
23
|
+
c.base_path = uri.path
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
describe '#base_url' do
|
|
28
|
+
it 'should have the default value' do
|
|
29
|
+
expect(config.base_url).to eq("http://localhost:8080/alfresco/api/-default-/public/search/versions/1")
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
it 'should remove trailing slashes' do
|
|
33
|
+
[nil, '', '/', '//'].each do |base_path|
|
|
34
|
+
config.base_path = base_path
|
|
35
|
+
expect(config.base_url).to eq("http://localhost:8080/alfresco/api/-default-/public/search/versions/1")
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Alfresco Content Services REST API
|
|
3
|
+
|
|
4
|
+
#**Search API** Provides access to the search features of Alfresco Content Services.
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 1
|
|
7
|
+
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.2.3
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
require 'date'
|
|
16
|
+
|
|
17
|
+
# Unit tests for Alfresco::ContentInfo
|
|
18
|
+
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe 'ContentInfo' do
|
|
21
|
+
before do
|
|
22
|
+
# run before each test
|
|
23
|
+
@instance = Alfresco::ContentInfo.new
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
after do
|
|
27
|
+
# run after each test
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test an instance of ContentInfo' do
|
|
31
|
+
it 'should create an instance of ContentInfo' do
|
|
32
|
+
expect(@instance).to be_instance_of(Alfresco::ContentInfo)
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
describe 'test attribute "mime_type"' do
|
|
36
|
+
it 'should work' do
|
|
37
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
describe 'test attribute "mime_type_name"' do
|
|
42
|
+
it 'should work' do
|
|
43
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
describe 'test attribute "size_in_bytes"' do
|
|
48
|
+
it 'should work' do
|
|
49
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
describe 'test attribute "encoding"' do
|
|
54
|
+
it 'should work' do
|
|
55
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
describe 'test attribute "mime_type_group"' do
|
|
60
|
+
it 'should work' do
|
|
61
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
end
|
|
66
|
+
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Alfresco Content Services REST API
|
|
3
|
+
|
|
4
|
+
#**Search API** Provides access to the search features of Alfresco Content Services.
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 1
|
|
7
|
+
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.2.3
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
require 'date'
|
|
16
|
+
|
|
17
|
+
# Unit tests for Alfresco::ErrorError
|
|
18
|
+
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe 'ErrorError' do
|
|
21
|
+
before do
|
|
22
|
+
# run before each test
|
|
23
|
+
@instance = Alfresco::ErrorError.new
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
after do
|
|
27
|
+
# run after each test
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test an instance of ErrorError' do
|
|
31
|
+
it 'should create an instance of ErrorError' do
|
|
32
|
+
expect(@instance).to be_instance_of(Alfresco::ErrorError)
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
describe 'test attribute "error_key"' do
|
|
36
|
+
it 'should work' do
|
|
37
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
describe 'test attribute "status_code"' do
|
|
42
|
+
it 'should work' do
|
|
43
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
describe 'test attribute "brief_summary"' do
|
|
48
|
+
it 'should work' do
|
|
49
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
describe 'test attribute "stack_trace"' do
|
|
54
|
+
it 'should work' do
|
|
55
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
describe 'test attribute "description_url"' do
|
|
60
|
+
it 'should work' do
|
|
61
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
describe 'test attribute "log_id"' do
|
|
66
|
+
it 'should work' do
|
|
67
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
end
|
|
72
|
+
|