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
data/docs/SearchEntry.md
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Alfresco::SearchEntry
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**score** | **Float** | The score for this row | [optional]
|
|
7
|
+
**highlight** | [**Array<SearchEntryHighlight>**](SearchEntryHighlight.md) | Highlight fragments if requested and available. A match can happen in any of the requested field. | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Alfresco::SearchEntryHighlight
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**field** | **String** | The field where a match occured (one of the fields defined on the request) | [optional]
|
|
7
|
+
**snippets** | **Array<String>** | Any number of snippets for the specified field highlighting the matching text | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Alfresco::SearchRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**query** | [**RequestQuery**](RequestQuery.md) | |
|
|
7
|
+
**paging** | [**RequestPagination**](RequestPagination.md) | | [optional]
|
|
8
|
+
**include** | [**RequestInclude**](RequestInclude.md) | | [optional]
|
|
9
|
+
**include_request** | **BOOLEAN** | When true, include the original request in the response | [optional] [default to false]
|
|
10
|
+
**fields** | [**RequestFields**](RequestFields.md) | | [optional]
|
|
11
|
+
**sort** | [**RequestSortDefinition**](RequestSortDefinition.md) | | [optional]
|
|
12
|
+
**templates** | [**RequestTemplates**](RequestTemplates.md) | | [optional]
|
|
13
|
+
**defaults** | [**RequestDefaults**](RequestDefaults.md) | | [optional]
|
|
14
|
+
**localization** | [**RequestLocalization**](RequestLocalization.md) | | [optional]
|
|
15
|
+
**filter_queries** | [**RequestFilterQueries**](RequestFilterQueries.md) | | [optional]
|
|
16
|
+
**facet_queries** | [**RequestFacetQueries**](RequestFacetQueries.md) | | [optional]
|
|
17
|
+
**facet_fields** | [**RequestFacetFields**](RequestFacetFields.md) | | [optional]
|
|
18
|
+
**facet_intervals** | [**RequestFacetIntervals**](RequestFacetIntervals.md) | | [optional]
|
|
19
|
+
**pivots** | [**Array<RequestPivot>**](RequestPivot.md) | | [optional]
|
|
20
|
+
**stats** | [**Array<RequestStats>**](RequestStats.md) | | [optional]
|
|
21
|
+
**spellcheck** | [**RequestSpellcheck**](RequestSpellcheck.md) | | [optional]
|
|
22
|
+
**scope** | [**RequestScope**](RequestScope.md) | | [optional]
|
|
23
|
+
**limits** | [**RequestLimits**](RequestLimits.md) | | [optional]
|
|
24
|
+
**highlight** | [**RequestHighlight**](RequestHighlight.md) | | [optional]
|
|
25
|
+
**ranges** | [**Array<RequestRange>**](RequestRange.md) | | [optional]
|
|
26
|
+
|
|
27
|
+
|
data/docs/UserInfo.md
ADDED
data/git_push.sh
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
#
|
|
3
|
+
# Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
4
|
+
#
|
|
5
|
+
# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
|
|
6
|
+
#
|
|
7
|
+
# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
|
|
8
|
+
|
|
9
|
+
git_user_id=$1
|
|
10
|
+
git_repo_id=$2
|
|
11
|
+
release_note=$3
|
|
12
|
+
|
|
13
|
+
if [ "$git_user_id" = "" ]; then
|
|
14
|
+
git_user_id=""
|
|
15
|
+
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
|
|
16
|
+
fi
|
|
17
|
+
|
|
18
|
+
if [ "$git_repo_id" = "" ]; then
|
|
19
|
+
git_repo_id=""
|
|
20
|
+
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
|
|
21
|
+
fi
|
|
22
|
+
|
|
23
|
+
if [ "$release_note" = "" ]; then
|
|
24
|
+
release_note=""
|
|
25
|
+
echo "[INFO] No command line input provided. Set \$release_note to $release_note"
|
|
26
|
+
fi
|
|
27
|
+
|
|
28
|
+
# Initialize the local directory as a Git repository
|
|
29
|
+
git init
|
|
30
|
+
|
|
31
|
+
# Adds the files in the local repository and stages them for commit.
|
|
32
|
+
git add .
|
|
33
|
+
|
|
34
|
+
# Commits the tracked changes and prepares them to be pushed to a remote repository.
|
|
35
|
+
git commit -m "$release_note"
|
|
36
|
+
|
|
37
|
+
# Sets the new remote
|
|
38
|
+
git_remote=`git remote`
|
|
39
|
+
if [ "$git_remote" = "" ]; then # git remote not defined
|
|
40
|
+
|
|
41
|
+
if [ "$GIT_TOKEN" = "" ]; then
|
|
42
|
+
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
|
|
43
|
+
git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
|
|
44
|
+
else
|
|
45
|
+
git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
|
|
46
|
+
fi
|
|
47
|
+
|
|
48
|
+
fi
|
|
49
|
+
|
|
50
|
+
git pull origin master
|
|
51
|
+
|
|
52
|
+
# Pushes (Forces) the changes in the local repository up to the remote repository
|
|
53
|
+
echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
|
|
54
|
+
git push origin master 2>&1 | grep -v 'To https'
|
|
55
|
+
|
data/lib/alfresco.rb
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
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
|
+
# Common files
|
|
14
|
+
require 'alfresco/api_client'
|
|
15
|
+
require 'alfresco/api_error'
|
|
16
|
+
require 'alfresco/version'
|
|
17
|
+
require 'alfresco/configuration'
|
|
18
|
+
|
|
19
|
+
# Models
|
|
20
|
+
require 'alfresco/models/content_info'
|
|
21
|
+
require 'alfresco/models/error'
|
|
22
|
+
require 'alfresco/models/error_error'
|
|
23
|
+
require 'alfresco/models/generic_bucket'
|
|
24
|
+
require 'alfresco/models/generic_bucket_bucket_info'
|
|
25
|
+
require 'alfresco/models/generic_facet_response'
|
|
26
|
+
require 'alfresco/models/generic_metric'
|
|
27
|
+
require 'alfresco/models/node'
|
|
28
|
+
require 'alfresco/models/pagination'
|
|
29
|
+
require 'alfresco/models/path_element'
|
|
30
|
+
require 'alfresco/models/path_info'
|
|
31
|
+
require 'alfresco/models/request_defaults'
|
|
32
|
+
require 'alfresco/models/request_facet_field'
|
|
33
|
+
require 'alfresco/models/request_facet_fields'
|
|
34
|
+
require 'alfresco/models/request_facet_intervals'
|
|
35
|
+
require 'alfresco/models/request_facet_intervals_intervals'
|
|
36
|
+
require 'alfresco/models/request_facet_queries'
|
|
37
|
+
require 'alfresco/models/request_facet_queries_inner'
|
|
38
|
+
require 'alfresco/models/request_facet_set'
|
|
39
|
+
require 'alfresco/models/request_fields'
|
|
40
|
+
require 'alfresco/models/request_filter_queries'
|
|
41
|
+
require 'alfresco/models/request_filter_queries_inner'
|
|
42
|
+
require 'alfresco/models/request_highlight'
|
|
43
|
+
require 'alfresco/models/request_highlight_fields'
|
|
44
|
+
require 'alfresco/models/request_include'
|
|
45
|
+
require 'alfresco/models/request_limits'
|
|
46
|
+
require 'alfresco/models/request_localization'
|
|
47
|
+
require 'alfresco/models/request_pagination'
|
|
48
|
+
require 'alfresco/models/request_pivot'
|
|
49
|
+
require 'alfresco/models/request_query'
|
|
50
|
+
require 'alfresco/models/request_range'
|
|
51
|
+
require 'alfresco/models/request_scope'
|
|
52
|
+
require 'alfresco/models/request_sort_definition'
|
|
53
|
+
require 'alfresco/models/request_sort_definition_inner'
|
|
54
|
+
require 'alfresco/models/request_spellcheck'
|
|
55
|
+
require 'alfresco/models/request_stats'
|
|
56
|
+
require 'alfresco/models/request_templates'
|
|
57
|
+
require 'alfresco/models/request_templates_inner'
|
|
58
|
+
require 'alfresco/models/response_consistency'
|
|
59
|
+
require 'alfresco/models/result_buckets'
|
|
60
|
+
require 'alfresco/models/result_buckets_buckets'
|
|
61
|
+
require 'alfresco/models/result_node'
|
|
62
|
+
require 'alfresco/models/result_set_context'
|
|
63
|
+
require 'alfresco/models/result_set_context_facet_queries'
|
|
64
|
+
require 'alfresco/models/result_set_context_spellcheck'
|
|
65
|
+
require 'alfresco/models/result_set_paging'
|
|
66
|
+
require 'alfresco/models/result_set_paging_list'
|
|
67
|
+
require 'alfresco/models/result_set_row_entry'
|
|
68
|
+
require 'alfresco/models/search_entry'
|
|
69
|
+
require 'alfresco/models/search_entry_highlight'
|
|
70
|
+
require 'alfresco/models/search_request'
|
|
71
|
+
require 'alfresco/models/user_info'
|
|
72
|
+
|
|
73
|
+
# APIs
|
|
74
|
+
require 'alfresco/api/search_api'
|
|
75
|
+
|
|
76
|
+
module Alfresco
|
|
77
|
+
class << self
|
|
78
|
+
# Customize default settings for the SDK using block.
|
|
79
|
+
# Alfresco.configure do |config|
|
|
80
|
+
# config.username = "xxx"
|
|
81
|
+
# config.password = "xxx"
|
|
82
|
+
# end
|
|
83
|
+
# If no block given, return the default Configuration object.
|
|
84
|
+
def configure
|
|
85
|
+
if block_given?
|
|
86
|
+
yield(Configuration.default)
|
|
87
|
+
else
|
|
88
|
+
Configuration.default
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
end
|
|
92
|
+
end
|
|
@@ -0,0 +1,78 @@
|
|
|
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 "uri"
|
|
14
|
+
|
|
15
|
+
module Alfresco
|
|
16
|
+
class SearchApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
# Searches Alfresco
|
|
24
|
+
# **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\" ] } ] }, ```
|
|
25
|
+
# @param query_body Generic query API
|
|
26
|
+
# @param [Hash] opts the optional parameters
|
|
27
|
+
# @return [ResultSetPaging]
|
|
28
|
+
def search(query_body, opts = {})
|
|
29
|
+
data, _status_code, _headers = search_with_http_info(query_body, opts)
|
|
30
|
+
return data
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Searches Alfresco
|
|
34
|
+
# **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\" ] } ] }, ```
|
|
35
|
+
# @param query_body Generic query API
|
|
36
|
+
# @param [Hash] opts the optional parameters
|
|
37
|
+
# @return [Array<(ResultSetPaging, Fixnum, Hash)>] ResultSetPaging data, response status code and response headers
|
|
38
|
+
def search_with_http_info(query_body, opts = {})
|
|
39
|
+
if @api_client.config.debugging
|
|
40
|
+
@api_client.config.logger.debug "Calling API: SearchApi.search ..."
|
|
41
|
+
end
|
|
42
|
+
# verify the required parameter 'query_body' is set
|
|
43
|
+
if @api_client.config.client_side_validation && query_body.nil?
|
|
44
|
+
fail ArgumentError, "Missing the required parameter 'query_body' when calling SearchApi.search"
|
|
45
|
+
end
|
|
46
|
+
# resource path
|
|
47
|
+
local_var_path = "/search"
|
|
48
|
+
|
|
49
|
+
# query parameters
|
|
50
|
+
query_params = {}
|
|
51
|
+
|
|
52
|
+
# header parameters
|
|
53
|
+
header_params = {}
|
|
54
|
+
# HTTP header 'Accept' (if needed)
|
|
55
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
56
|
+
# HTTP header 'Content-Type'
|
|
57
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
58
|
+
|
|
59
|
+
# form parameters
|
|
60
|
+
form_params = {}
|
|
61
|
+
|
|
62
|
+
# http body (model)
|
|
63
|
+
post_body = @api_client.object_to_http_body(query_body)
|
|
64
|
+
auth_names = ['basicAuth']
|
|
65
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
66
|
+
:header_params => header_params,
|
|
67
|
+
:query_params => query_params,
|
|
68
|
+
:form_params => form_params,
|
|
69
|
+
:body => post_body,
|
|
70
|
+
:auth_names => auth_names,
|
|
71
|
+
:return_type => 'ResultSetPaging')
|
|
72
|
+
if @api_client.config.debugging
|
|
73
|
+
@api_client.config.logger.debug "API called: SearchApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
74
|
+
end
|
|
75
|
+
return data, status_code, headers
|
|
76
|
+
end
|
|
77
|
+
end
|
|
78
|
+
end
|
|
@@ -0,0 +1,389 @@
|
|
|
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 'date'
|
|
14
|
+
require 'json'
|
|
15
|
+
require 'logger'
|
|
16
|
+
require 'tempfile'
|
|
17
|
+
require 'typhoeus'
|
|
18
|
+
require 'uri'
|
|
19
|
+
|
|
20
|
+
module Alfresco
|
|
21
|
+
class ApiClient
|
|
22
|
+
# The Configuration object holding settings to be used in the API client.
|
|
23
|
+
attr_accessor :config
|
|
24
|
+
|
|
25
|
+
# Defines the headers to be used in HTTP requests of all API calls by default.
|
|
26
|
+
#
|
|
27
|
+
# @return [Hash]
|
|
28
|
+
attr_accessor :default_headers
|
|
29
|
+
|
|
30
|
+
# Initializes the ApiClient
|
|
31
|
+
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
|
32
|
+
def initialize(config = Configuration.default)
|
|
33
|
+
@config = config
|
|
34
|
+
@user_agent = "Swagger-Codegen/#{VERSION}/ruby"
|
|
35
|
+
@default_headers = {
|
|
36
|
+
'Content-Type' => "application/json",
|
|
37
|
+
'User-Agent' => @user_agent
|
|
38
|
+
}
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
def self.default
|
|
42
|
+
@@default ||= ApiClient.new
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# Call an API with given options.
|
|
46
|
+
#
|
|
47
|
+
# @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
|
|
48
|
+
# the data deserialized from response body (could be nil), response status code and response headers.
|
|
49
|
+
def call_api(http_method, path, opts = {})
|
|
50
|
+
request = build_request(http_method, path, opts)
|
|
51
|
+
response = request.run
|
|
52
|
+
|
|
53
|
+
if @config.debugging
|
|
54
|
+
@config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
unless response.success?
|
|
58
|
+
if response.timed_out?
|
|
59
|
+
fail ApiError.new('Connection timed out')
|
|
60
|
+
elsif response.code == 0
|
|
61
|
+
# Errors from libcurl will be made visible here
|
|
62
|
+
fail ApiError.new(:code => 0,
|
|
63
|
+
:message => response.return_message)
|
|
64
|
+
else
|
|
65
|
+
fail ApiError.new(:code => response.code,
|
|
66
|
+
:response_headers => response.headers,
|
|
67
|
+
:response_body => response.body),
|
|
68
|
+
response.status_message
|
|
69
|
+
end
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
if opts[:return_type]
|
|
73
|
+
data = deserialize(response, opts[:return_type])
|
|
74
|
+
else
|
|
75
|
+
data = nil
|
|
76
|
+
end
|
|
77
|
+
return data, response.code, response.headers
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
# Builds the HTTP request
|
|
81
|
+
#
|
|
82
|
+
# @param [String] http_method HTTP method/verb (e.g. POST)
|
|
83
|
+
# @param [String] path URL path (e.g. /account/new)
|
|
84
|
+
# @option opts [Hash] :header_params Header parameters
|
|
85
|
+
# @option opts [Hash] :query_params Query parameters
|
|
86
|
+
# @option opts [Hash] :form_params Query parameters
|
|
87
|
+
# @option opts [Object] :body HTTP body (JSON/XML)
|
|
88
|
+
# @return [Typhoeus::Request] A Typhoeus Request
|
|
89
|
+
def build_request(http_method, path, opts = {})
|
|
90
|
+
url = build_request_url(path)
|
|
91
|
+
http_method = http_method.to_sym.downcase
|
|
92
|
+
|
|
93
|
+
header_params = @default_headers.merge(opts[:header_params] || {})
|
|
94
|
+
query_params = opts[:query_params] || {}
|
|
95
|
+
form_params = opts[:form_params] || {}
|
|
96
|
+
|
|
97
|
+
update_params_for_auth! header_params, query_params, opts[:auth_names]
|
|
98
|
+
|
|
99
|
+
# set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
|
|
100
|
+
_verify_ssl_host = @config.verify_ssl_host ? 2 : 0
|
|
101
|
+
|
|
102
|
+
req_opts = {
|
|
103
|
+
:method => http_method,
|
|
104
|
+
:headers => header_params,
|
|
105
|
+
:params => query_params,
|
|
106
|
+
:params_encoding => @config.params_encoding,
|
|
107
|
+
:timeout => @config.timeout,
|
|
108
|
+
:ssl_verifypeer => @config.verify_ssl,
|
|
109
|
+
:ssl_verifyhost => _verify_ssl_host,
|
|
110
|
+
:sslcert => @config.cert_file,
|
|
111
|
+
:sslkey => @config.key_file,
|
|
112
|
+
:verbose => @config.debugging
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
# set custom cert, if provided
|
|
116
|
+
req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
|
|
117
|
+
|
|
118
|
+
if [:post, :patch, :put, :delete].include?(http_method)
|
|
119
|
+
req_body = build_request_body(header_params, form_params, opts[:body])
|
|
120
|
+
req_opts.update :body => req_body
|
|
121
|
+
if @config.debugging
|
|
122
|
+
@config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
|
|
123
|
+
end
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
request = Typhoeus::Request.new(url, req_opts)
|
|
127
|
+
download_file(request) if opts[:return_type] == 'File'
|
|
128
|
+
request
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
# Check if the given MIME is a JSON MIME.
|
|
132
|
+
# JSON MIME examples:
|
|
133
|
+
# application/json
|
|
134
|
+
# application/json; charset=UTF8
|
|
135
|
+
# APPLICATION/JSON
|
|
136
|
+
# */*
|
|
137
|
+
# @param [String] mime MIME
|
|
138
|
+
# @return [Boolean] True if the MIME is application/json
|
|
139
|
+
def json_mime?(mime)
|
|
140
|
+
(mime == "*/*") || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
# Deserialize the response to the given return type.
|
|
144
|
+
#
|
|
145
|
+
# @param [Response] response HTTP response
|
|
146
|
+
# @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
|
|
147
|
+
def deserialize(response, return_type)
|
|
148
|
+
body = response.body
|
|
149
|
+
|
|
150
|
+
# handle file downloading - return the File instance processed in request callbacks
|
|
151
|
+
# note that response body is empty when the file is written in chunks in request on_body callback
|
|
152
|
+
return @tempfile if return_type == 'File'
|
|
153
|
+
|
|
154
|
+
return nil if body.nil? || body.empty?
|
|
155
|
+
|
|
156
|
+
# return response body directly for String return type
|
|
157
|
+
return body if return_type == 'String'
|
|
158
|
+
|
|
159
|
+
# ensuring a default content type
|
|
160
|
+
content_type = response.headers['Content-Type'] || 'application/json'
|
|
161
|
+
|
|
162
|
+
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
|
163
|
+
|
|
164
|
+
begin
|
|
165
|
+
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
|
166
|
+
rescue JSON::ParserError => e
|
|
167
|
+
if %w(String Date DateTime).include?(return_type)
|
|
168
|
+
data = body
|
|
169
|
+
else
|
|
170
|
+
raise e
|
|
171
|
+
end
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
convert_to_type data, return_type
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
# Convert data to the given return type.
|
|
178
|
+
# @param [Object] data Data to be converted
|
|
179
|
+
# @param [String] return_type Return type
|
|
180
|
+
# @return [Mixed] Data in a particular type
|
|
181
|
+
def convert_to_type(data, return_type)
|
|
182
|
+
return nil if data.nil?
|
|
183
|
+
case return_type
|
|
184
|
+
when 'String'
|
|
185
|
+
data.to_s
|
|
186
|
+
when 'Integer'
|
|
187
|
+
data.to_i
|
|
188
|
+
when 'Float'
|
|
189
|
+
data.to_f
|
|
190
|
+
when 'BOOLEAN'
|
|
191
|
+
data == true
|
|
192
|
+
when 'DateTime'
|
|
193
|
+
# parse date time (expecting ISO 8601 format)
|
|
194
|
+
DateTime.parse data
|
|
195
|
+
when 'Date'
|
|
196
|
+
# parse date time (expecting ISO 8601 format)
|
|
197
|
+
Date.parse data
|
|
198
|
+
when 'Object'
|
|
199
|
+
# generic object (usually a Hash), return directly
|
|
200
|
+
data
|
|
201
|
+
when /\AArray<(.+)>\z/
|
|
202
|
+
# e.g. Array<Pet>
|
|
203
|
+
sub_type = $1
|
|
204
|
+
data.map {|item| convert_to_type(item, sub_type) }
|
|
205
|
+
when /\AHash\<String, (.+)\>\z/
|
|
206
|
+
# e.g. Hash<String, Integer>
|
|
207
|
+
sub_type = $1
|
|
208
|
+
{}.tap do |hash|
|
|
209
|
+
data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
|
|
210
|
+
end
|
|
211
|
+
else
|
|
212
|
+
# models, e.g. Pet
|
|
213
|
+
Alfresco.const_get(return_type).new.tap do |model|
|
|
214
|
+
model.build_from_hash data
|
|
215
|
+
end
|
|
216
|
+
end
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
# Save response body into a file in (the defined) temporary folder, using the filename
|
|
220
|
+
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
|
221
|
+
# The response body is written to the file in chunks in order to handle files which
|
|
222
|
+
# size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
|
|
223
|
+
# process can use.
|
|
224
|
+
#
|
|
225
|
+
# @see Configuration#temp_folder_path
|
|
226
|
+
def download_file(request)
|
|
227
|
+
tempfile = nil
|
|
228
|
+
encoding = nil
|
|
229
|
+
request.on_headers do |response|
|
|
230
|
+
content_disposition = response.headers['Content-Disposition']
|
|
231
|
+
if content_disposition and content_disposition =~ /filename=/i
|
|
232
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
|
233
|
+
prefix = sanitize_filename(filename)
|
|
234
|
+
else
|
|
235
|
+
prefix = 'download-'
|
|
236
|
+
end
|
|
237
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
|
238
|
+
encoding = response.body.encoding
|
|
239
|
+
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
|
240
|
+
@tempfile = tempfile
|
|
241
|
+
end
|
|
242
|
+
request.on_body do |chunk|
|
|
243
|
+
chunk.force_encoding(encoding)
|
|
244
|
+
tempfile.write(chunk)
|
|
245
|
+
end
|
|
246
|
+
request.on_complete do |response|
|
|
247
|
+
tempfile.close
|
|
248
|
+
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
|
249
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
|
250
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
|
251
|
+
"explicitly with `tempfile.delete`"
|
|
252
|
+
end
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
# Sanitize filename by removing path.
|
|
256
|
+
# e.g. ../../sun.gif becomes sun.gif
|
|
257
|
+
#
|
|
258
|
+
# @param [String] filename the filename to be sanitized
|
|
259
|
+
# @return [String] the sanitized filename
|
|
260
|
+
def sanitize_filename(filename)
|
|
261
|
+
filename.gsub(/.*[\/\\]/, '')
|
|
262
|
+
end
|
|
263
|
+
|
|
264
|
+
def build_request_url(path)
|
|
265
|
+
# Add leading and trailing slashes to path
|
|
266
|
+
path = "/#{path}".gsub(/\/+/, '/')
|
|
267
|
+
URI.encode(@config.base_url + path)
|
|
268
|
+
end
|
|
269
|
+
|
|
270
|
+
# Builds the HTTP request body
|
|
271
|
+
#
|
|
272
|
+
# @param [Hash] header_params Header parameters
|
|
273
|
+
# @param [Hash] form_params Query parameters
|
|
274
|
+
# @param [Object] body HTTP body (JSON/XML)
|
|
275
|
+
# @return [String] HTTP body data in the form of string
|
|
276
|
+
def build_request_body(header_params, form_params, body)
|
|
277
|
+
# http form
|
|
278
|
+
if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
|
|
279
|
+
header_params['Content-Type'] == 'multipart/form-data'
|
|
280
|
+
data = {}
|
|
281
|
+
form_params.each do |key, value|
|
|
282
|
+
case value
|
|
283
|
+
when File, Array, nil
|
|
284
|
+
# let typhoeus handle File, Array and nil parameters
|
|
285
|
+
data[key] = value
|
|
286
|
+
else
|
|
287
|
+
data[key] = value.to_s
|
|
288
|
+
end
|
|
289
|
+
end
|
|
290
|
+
elsif body
|
|
291
|
+
data = body.is_a?(String) ? body : body.to_json
|
|
292
|
+
else
|
|
293
|
+
data = nil
|
|
294
|
+
end
|
|
295
|
+
data
|
|
296
|
+
end
|
|
297
|
+
|
|
298
|
+
# Update hearder and query params based on authentication settings.
|
|
299
|
+
#
|
|
300
|
+
# @param [Hash] header_params Header parameters
|
|
301
|
+
# @param [Hash] query_params Query parameters
|
|
302
|
+
# @param [String] auth_names Authentication scheme name
|
|
303
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
|
304
|
+
Array(auth_names).each do |auth_name|
|
|
305
|
+
auth_setting = @config.auth_settings[auth_name]
|
|
306
|
+
next unless auth_setting
|
|
307
|
+
case auth_setting[:in]
|
|
308
|
+
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
|
309
|
+
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
|
310
|
+
else fail ArgumentError, 'Authentication token must be in `query` of `header`'
|
|
311
|
+
end
|
|
312
|
+
end
|
|
313
|
+
end
|
|
314
|
+
|
|
315
|
+
# Sets user agent in HTTP header
|
|
316
|
+
#
|
|
317
|
+
# @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
|
|
318
|
+
def user_agent=(user_agent)
|
|
319
|
+
@user_agent = user_agent
|
|
320
|
+
@default_headers['User-Agent'] = @user_agent
|
|
321
|
+
end
|
|
322
|
+
|
|
323
|
+
# Return Accept header based on an array of accepts provided.
|
|
324
|
+
# @param [Array] accepts array for Accept
|
|
325
|
+
# @return [String] the Accept header (e.g. application/json)
|
|
326
|
+
def select_header_accept(accepts)
|
|
327
|
+
return nil if accepts.nil? || accepts.empty?
|
|
328
|
+
# use JSON when present, otherwise use all of the provided
|
|
329
|
+
json_accept = accepts.find { |s| json_mime?(s) }
|
|
330
|
+
return json_accept || accepts.join(',')
|
|
331
|
+
end
|
|
332
|
+
|
|
333
|
+
# Return Content-Type header based on an array of content types provided.
|
|
334
|
+
# @param [Array] content_types array for Content-Type
|
|
335
|
+
# @return [String] the Content-Type header (e.g. application/json)
|
|
336
|
+
def select_header_content_type(content_types)
|
|
337
|
+
# use application/json by default
|
|
338
|
+
return 'application/json' if content_types.nil? || content_types.empty?
|
|
339
|
+
# use JSON when present, otherwise use the first one
|
|
340
|
+
json_content_type = content_types.find { |s| json_mime?(s) }
|
|
341
|
+
return json_content_type || content_types.first
|
|
342
|
+
end
|
|
343
|
+
|
|
344
|
+
# Convert object (array, hash, object, etc) to JSON string.
|
|
345
|
+
# @param [Object] model object to be converted into JSON string
|
|
346
|
+
# @return [String] JSON string representation of the object
|
|
347
|
+
def object_to_http_body(model)
|
|
348
|
+
return model if model.nil? || model.is_a?(String)
|
|
349
|
+
local_body = nil
|
|
350
|
+
if model.is_a?(Array)
|
|
351
|
+
local_body = model.map{|m| object_to_hash(m) }
|
|
352
|
+
else
|
|
353
|
+
local_body = object_to_hash(model)
|
|
354
|
+
end
|
|
355
|
+
local_body.to_json
|
|
356
|
+
end
|
|
357
|
+
|
|
358
|
+
# Convert object(non-array) to hash.
|
|
359
|
+
# @param [Object] obj object to be converted into JSON string
|
|
360
|
+
# @return [String] JSON string representation of the object
|
|
361
|
+
def object_to_hash(obj)
|
|
362
|
+
if obj.respond_to?(:to_hash)
|
|
363
|
+
obj.to_hash
|
|
364
|
+
else
|
|
365
|
+
obj
|
|
366
|
+
end
|
|
367
|
+
end
|
|
368
|
+
|
|
369
|
+
# Build parameter value according to the given collection format.
|
|
370
|
+
# @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
|
|
371
|
+
def build_collection_param(param, collection_format)
|
|
372
|
+
case collection_format
|
|
373
|
+
when :csv
|
|
374
|
+
param.join(',')
|
|
375
|
+
when :ssv
|
|
376
|
+
param.join(' ')
|
|
377
|
+
when :tsv
|
|
378
|
+
param.join("\t")
|
|
379
|
+
when :pipes
|
|
380
|
+
param.join('|')
|
|
381
|
+
when :multi
|
|
382
|
+
# return the array directly as typhoeus will handle it as expected
|
|
383
|
+
param
|
|
384
|
+
else
|
|
385
|
+
fail "unknown collection format: #{collection_format.inspect}"
|
|
386
|
+
end
|
|
387
|
+
end
|
|
388
|
+
end
|
|
389
|
+
end
|