alfresco 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c378ea23a84429653dcb3f433662ccc63567fc49
+  data.tar.gz: 91bb37ff28c05ea19e593331cb353121fcaaf834
+SHA512:
+  metadata.gz: d2d2416078b3448194c9826da890c47bda962ee9f19310a375b9a40936df392e952263d8fbb0172417ef991ceb820c8d398fe1877b93f8f026cf560ece0da77f
+  data.tar.gz: 4b8d9bd9005af3950e6eeabc93103bd1e6d08e6975ae6dd3d46e65eb60bcf4470bbcd18523df8595e71256911b3f99987ab2850636862cde1d9c52ff45a2a3a0

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    alfresco (1.0.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.13)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.18)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    public_suffix (3.0.1)
+    rake (12.0.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  alfresco!
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.0

data/README.md

@@ -0,0 +1,119 @@
+# alfresco
+
+Alfresco - the Ruby gem for the Alfresco Content Services REST API
+
+**Search API** Provides access to the search features of Alfresco Content Services.
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1
+- Package version: 1.0.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+Add this to the Gemfile:
+
+    gem 'alfresco', '~> 1.0.0'
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'alfresco'
+
+# Setup authorization
+Alfresco.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.host = 'YOUR HOST'
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Alfresco::SearchApi.new
+
+query_body = Alfresco::SearchRequest.new # SearchRequest | Generic query API
+
+
+begin
+  #Searches Alfresco
+  result = api_instance.search(query_body)
+  p result
+rescue Alfresco::ApiError => e
+  puts "Exception when calling SearchApi->search: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://localhost/alfresco/api/-default-/public/search/versions/1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Alfresco::SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /search | Searches Alfresco
+
+
+## Documentation for Models
+
+ - [Alfresco::ContentInfo](docs/ContentInfo.md)
+ - [Alfresco::Error](docs/Error.md)
+ - [Alfresco::ErrorError](docs/ErrorError.md)
+ - [Alfresco::GenericBucket](docs/GenericBucket.md)
+ - [Alfresco::GenericBucketBucketInfo](docs/GenericBucketBucketInfo.md)
+ - [Alfresco::GenericFacetResponse](docs/GenericFacetResponse.md)
+ - [Alfresco::GenericMetric](docs/GenericMetric.md)
+ - [Alfresco::Node](docs/Node.md)
+ - [Alfresco::Pagination](docs/Pagination.md)
+ - [Alfresco::PathElement](docs/PathElement.md)
+ - [Alfresco::PathInfo](docs/PathInfo.md)
+ - [Alfresco::RequestDefaults](docs/RequestDefaults.md)
+ - [Alfresco::RequestFacetField](docs/RequestFacetField.md)
+ - [Alfresco::RequestFacetFields](docs/RequestFacetFields.md)
+ - [Alfresco::RequestFacetIntervals](docs/RequestFacetIntervals.md)
+ - [Alfresco::RequestFacetIntervalsIntervals](docs/RequestFacetIntervalsIntervals.md)
+ - [Alfresco::RequestFacetQueries](docs/RequestFacetQueries.md)
+ - [Alfresco::RequestFacetQueriesInner](docs/RequestFacetQueriesInner.md)
+ - [Alfresco::RequestFacetSet](docs/RequestFacetSet.md)
+ - [Alfresco::RequestFields](docs/RequestFields.md)
+ - [Alfresco::RequestFilterQueries](docs/RequestFilterQueries.md)
+ - [Alfresco::RequestFilterQueriesInner](docs/RequestFilterQueriesInner.md)
+ - [Alfresco::RequestHighlight](docs/RequestHighlight.md)
+ - [Alfresco::RequestHighlightFields](docs/RequestHighlightFields.md)
+ - [Alfresco::RequestInclude](docs/RequestInclude.md)
+ - [Alfresco::RequestLimits](docs/RequestLimits.md)
+ - [Alfresco::RequestLocalization](docs/RequestLocalization.md)
+ - [Alfresco::RequestPagination](docs/RequestPagination.md)
+ - [Alfresco::RequestPivot](docs/RequestPivot.md)
+ - [Alfresco::RequestQuery](docs/RequestQuery.md)
+ - [Alfresco::RequestRange](docs/RequestRange.md)
+ - [Alfresco::RequestScope](docs/RequestScope.md)
+ - [Alfresco::RequestSortDefinition](docs/RequestSortDefinition.md)
+ - [Alfresco::RequestSortDefinitionInner](docs/RequestSortDefinitionInner.md)
+ - [Alfresco::RequestSpellcheck](docs/RequestSpellcheck.md)
+ - [Alfresco::RequestStats](docs/RequestStats.md)
+ - [Alfresco::RequestTemplates](docs/RequestTemplates.md)
+ - [Alfresco::RequestTemplatesInner](docs/RequestTemplatesInner.md)
+ - [Alfresco::ResponseConsistency](docs/ResponseConsistency.md)
+ - [Alfresco::ResultBuckets](docs/ResultBuckets.md)
+ - [Alfresco::ResultBucketsBuckets](docs/ResultBucketsBuckets.md)
+ - [Alfresco::ResultNode](docs/ResultNode.md)
+ - [Alfresco::ResultSetContext](docs/ResultSetContext.md)
+ - [Alfresco::ResultSetContextFacetQueries](docs/ResultSetContextFacetQueries.md)
+ - [Alfresco::ResultSetContextSpellcheck](docs/ResultSetContextSpellcheck.md)
+ - [Alfresco::ResultSetPaging](docs/ResultSetPaging.md)
+ - [Alfresco::ResultSetPagingList](docs/ResultSetPagingList.md)
+ - [Alfresco::ResultSetRowEntry](docs/ResultSetRowEntry.md)
+ - [Alfresco::SearchEntry](docs/SearchEntry.md)
+ - [Alfresco::SearchEntryHighlight](docs/SearchEntryHighlight.md)
+ - [Alfresco::SearchRequest](docs/SearchRequest.md)
+ - [Alfresco::UserInfo](docs/UserInfo.md)
+
+
+## Documentation for Authorization
+
+
+### basicAuth
+
+- **Type**: HTTP basic authentication

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/alfresco.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+#
+=begin
+#Alfresco Content Services REST API
+
+#**Search API** Provides access to the search features of Alfresco Content Services.
+
+OpenAPI spec version: 1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "alfresco/version"
+
+Gem::Specification.new do |s|
+  s.name        = "alfresco"
+  s.version     = Alfresco::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Élisson Michael", "Swagger-Codegen"]
+  s.email       = ["elissonmichael@yahoo.com.br"]
+  s.homepage    = "https://github.com/rhuanbarreto/alfresco-ruby-client"
+  s.summary     = "Alfresco Content Services REST API Ruby Gem"
+  s.description = "**Search API** Provides access to the search features of Alfresco Content Services. "
+  s.license     = "Nonstandard"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/ContentInfo.md

@@ -0,0 +1,12 @@
+# Alfresco::ContentInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mime_type** | **String** |  | 
+**mime_type_name** | **String** |  | 
+**size_in_bytes** | **Integer** |  | 
+**encoding** | **String** |  | [optional] 
+**mime_type_group** | **String** |  | [optional] 
+
+

data/docs/Error.md

@@ -0,0 +1,8 @@
+# Alfresco::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**ErrorError**](ErrorError.md) |  | [optional] 
+
+

data/docs/ErrorError.md

@@ -0,0 +1,13 @@
+# Alfresco::ErrorError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_key** | **String** |  | [optional] 
+**status_code** | **Integer** |  | 
+**brief_summary** | **String** |  | 
+**stack_trace** | **String** |  | 
+**description_url** | **String** |  | 
+**log_id** | **String** |  | [optional] 
+
+

data/docs/GenericBucket.md

@@ -0,0 +1,13 @@
+# Alfresco::GenericBucket
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **String** | The bucket label | [optional] 
+**filter_query** | **String** | The filter query you can use to apply this facet | [optional] 
+**display** | **Object** | An optional field for additional display information | [optional] 
+**metrics** | [**Array<GenericMetric>**](GenericMetric.md) | An array of buckets and values | [optional] 
+**facets** | **Array<Object>** | Additional list of nested facets | [optional] 
+**bucket_info** | [**GenericBucketBucketInfo**](GenericBucketBucketInfo.md) |  | [optional] 
+
+

data/docs/GenericBucketBucketInfo.md

@@ -0,0 +1,11 @@
+# Alfresco::GenericBucketBucketInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start** | **String** | The start of range | [optional] 
+**start_inclusive** | **BOOLEAN** | Includes values greater or equal to \"start\" | [optional] 
+**_end** | **String** | The end of range | [optional] 
+**end_inclusive** | **BOOLEAN** | Includes values less than or equal to \"end\" | [optional] 
+
+

data/docs/GenericFacetResponse.md

@@ -0,0 +1,10 @@
+# Alfresco::GenericFacetResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The facet type, eg. interval, range, pivot, stats | [optional] 
+**label** | **String** | The field name or its explicit label, if provided on the request | [optional] 
+**buckets** | [**Array<GenericBucket>**](GenericBucket.md) | An array of buckets and values | [optional] 
+
+

data/docs/GenericMetric.md

@@ -0,0 +1,9 @@
+# Alfresco::GenericMetric
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of metric, e.g. count | [optional] 
+**value** | **Object** | The metric value, e.g. {\"count\": 34}  | [optional] 
+
+

data/docs/Node.md

@@ -0,0 +1,24 @@
+# Alfresco::Node
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |. The character . must not be used at the end of the name.  | 
+**node_type** | **String** |  | 
+**is_folder** | **BOOLEAN** |  | 
+**is_file** | **BOOLEAN** |  | 
+**is_locked** | **BOOLEAN** |  | [optional] [default to false]
+**modified_at** | **DateTime** |  | 
+**modified_by_user** | [**UserInfo**](UserInfo.md) |  | 
+**created_at** | **DateTime** |  | 
+**created_by_user** | [**UserInfo**](UserInfo.md) |  | 
+**parent_id** | **String** |  | [optional] 
+**is_link** | **BOOLEAN** |  | [optional] 
+**content** | [**ContentInfo**](ContentInfo.md) |  | [optional] 
+**aspect_names** | **Array<String>** |  | [optional] 
+**properties** | **Object** |  | [optional] 
+**allowable_operations** | **Array<String>** |  | [optional] 
+**path** | [**PathInfo**](PathInfo.md) |  | [optional] 
+
+

data/docs/Pagination.md

@@ -0,0 +1,12 @@
+# Alfresco::Pagination
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | The number of objects in the entries array.  | 
+**has_more_items** | **BOOLEAN** | A boolean value which is **true** if there are more entities in the collection beyond those in this response. A true value means a request with a larger value for the **skipCount** or the **maxItems** parameter will return more entities.  | 
+**total_items** | **Integer** | An integer describing the total number of entities in the collection. The API might not be able to determine this value, in which case this property will not be present.  | [optional] 
+**skip_count** | **Integer** | An integer describing how many entities exist in the collection before those included in this list.  | 
+**max_items** | **Integer** | The value of the **maxItems** parameter used to generate this list, or if there was no **maxItems** parameter the default value is 100  | 
+
+

data/docs/PathElement.md

@@ -0,0 +1,9 @@
+# Alfresco::PathElement
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+

data/docs/PathInfo.md

@@ -0,0 +1,10 @@
+# Alfresco::PathInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**elements** | [**Array<PathElement>**](PathElement.md) |  | [optional] 
+**name** | **String** |  | [optional] 
+**is_complete** | **BOOLEAN** |  | [optional] 
+
+

data/docs/RequestDefaults.md

@@ -0,0 +1,12 @@
+# Alfresco::RequestDefaults
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_attributes** | **Array<String>** | A list of query fields/properties used to expand TEXT: queries. The default is cm:content. You could include all content properties using d:content or list all individual content properties or types. As more terms are included the query size, complexity, memory impact and query time will increase.  | [optional] 
+**default_fts_operator** | **String** | The default way to combine query parts when AND or OR is not explicitly stated - includes ! - + one two three (one two three)  | [optional] [default to "AND"]
+**default_fts_field_operator** | **String** | The default way to combine query parts in field query groups when AND or OR is not explicitly stated - includes ! - + FIELD:(one two three)  | [optional] [default to "AND"]
+**namespace** | **String** | The default name space to use if one is not provided | [optional] [default to "cm"]
+**default_field_name** | **String** |  | [optional] [default to "TEXT"]
+
+

data/docs/RequestFacetField.md

@@ -0,0 +1,18 @@
+# Alfresco::RequestFacetField
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field** | **String** | The facet field | [optional] 
+**label** | **String** | A label to include in place of the facet field | [optional] 
+**prefix** | **String** | Restricts the possible constraints to only indexed values with a specified prefix. | [optional] 
+**sort** | **String** |  | [optional] 
+**method** | **String** |  | [optional] 
+**missing** | **BOOLEAN** | When true, count results that match the query but which have no facet value for the field (in addition to the Term-based constraints). | [optional] [default to false]
+**limit** | **Integer** |  | [optional] 
+**offset** | **Integer** |  | [optional] 
+**mincount** | **Integer** | The minimum count required for a facet field to be included in the response. | [optional] 
+**facet_enum_cache_min_df** | **Integer** |  | [optional] 
+**exclude_filters** | **Array<String>** | Filter Queries with tags listed here will not be included in facet counts. This is used for multi-select facetting.  | [optional] 
+
+