blueprint_ruby_client 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ae5f091fb9a5ecdf9025c1b761a123e91fef1c6
-  data.tar.gz: 5c8b669e3f6dc2c4feec20fd9aea773ca26ea285
+  metadata.gz: 77195edee8095b723cccbcd84f23c1e998a87798
+  data.tar.gz: becb7ea53667a13465de1ac12b3a6002cfd6dfd7
 SHA512:
-  metadata.gz: 27b49ca3eee85cb6d58c67d1224689be0de592e491f09c051935f6317d86ec3b3aab36661bf9840d0909fbb99278985582c6d932dbe785e5984f4d51b6227049
-  data.tar.gz: 050d6686492b18c46ce5ec77d9c8032f07af09850b547893561c58641724e363f57703b7da20324550d54e7b1e5f4cb4a2bda71240da3a32087abf22a3fbba14
+  metadata.gz: ee3a8690154c20302e1fd01bfb62a8a18d9b1029e4ecdde7bc0bead3c9ed946cc0a95db45c31839116d56dde38cecc41be8468b569ed5cc60d1a218155ba60d5
+  data.tar.gz: 8deb82e0d8043bb6ea9049dba30c692c4ea61ff9273392bdfa049b58a5123d44c63faf9bf528e0ff16d19ca0937d96191b1c66d3b036957ebcddd3c882e1964b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    blueprint_ruby_client (0.4.1)
+    blueprint_ruby_client (0.5.1)
       json (~> 1.8, >= 1.8.3)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/README.md

@@ -7,8 +7,8 @@ This is the API documentation for [Blueprint](https://github.com/talis/blueprint
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 1.0.0
-- Package version: 0.4.1
-- Build date: 2016-10-27T15:57:57.768-04:00
+- Package version: 0.5.1
+- Build date: 2016-11-02T13:51:34.555-04:00
 - Build package: class io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -34,15 +34,15 @@ gem build blueprint_ruby_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./blueprint_ruby_client-0.4.1.gem
+gem install ./blueprint_ruby_client-0.5.1.gem
 ```
-(for development, run `gem install --dev ./blueprint_ruby_client-0.4.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./blueprint_ruby_client-0.5.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'blueprint_ruby_client', '~> 0.4.1'
+    gem 'blueprint_ruby_client', '~> 0.5.1'
 
 ### Install from Git
 

data/config.json

@@ -1,7 +1,7 @@
 {
   "gemName": "blueprint_ruby_client",
   "moduleName": "BlueprintClient",
-  "gemVersion": "0.4.1",
+  "gemVersion": "0.5.1",
   "gemLicense": "Copyright Talis Education Ltd",
   "gemHomepage": "https://github.com/talis/blueprint_rb",
   "gemSummary": "A ruby API wrapper for Blueprint",

data/docs/AssetsApi.md

@@ -236,8 +236,8 @@ Name | Type | Description  | Notes
  **type** | **String**| subtype of Node, e.g. 'modules', 'departments', etc. | 
  **id** | **String**| id identifying a domain model | 
  **filter_asset_type** | [**Array<String>**](String.md)| type of asset to return | [optional] 
- **offset** | **Float**| index to start result set from | [optional] 
- **limit** | **Float**| number of records to return | [optional] 
+ **offset** | [**Float**](.md)| index to start result set from | [optional] 
+ **limit** | [**Float**](.md)| number of records to return | [optional] 
 
 ### Return type
 
@@ -321,7 +321,7 @@ nil (empty response body)
 
 Replaces the Asset with the data sent in the body
 
-Wholesale replacement of Asset data: if you were to PUT to:   /1/{namespace}/assets/sometype/someid  with a body of:   { type: \"someothertype\", id: \"someotherid\" }  It would change the Asset's path to:   /1/{namespace}/assets/someothertype/someotherid  and   /1/{namespace}/assets/sometype/someid would return a 404. It would also update the assets associated with any node. 
+Wholesale replacement of Asset data: if you were to PUT to:\n  /1/{namespace}/assets/sometype/someid\n\nwith a body of:\n  { type: \"someothertype\", id: \"someotherid\" }\n\nIt would change the Asset's path to:\n  /1/{namespace}/assets/someothertype/someotherid\n\nand\n  /1/{namespace}/assets/sometype/someid\nwould return a 404.\nIt would also update the assets associated with any node.\n
 
 ### Example
 ```ruby

data/docs/HierarchyApi.md

@@ -54,7 +54,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **namespace_inc_global** | **String**| identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call. | 
+ **namespace_inc_global** | **String**| identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call. | 
  **body** | [**NodeBody**](NodeBody.md)| node | 
 
 ### Return type
@@ -77,7 +77,7 @@ Name | Type | Description  | Notes
 
 
 
-Send operations to modify nodes in bulk, to be applied/rejected as a single transaction. Format will be:    OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS 
+Send operations to modify nodes in bulk, to be applied/rejected as a single transaction.\nFormat will be:\n\n  OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS\n
 
 ### Example
 ```ruby
@@ -183,7 +183,7 @@ nil (empty response body)
 
 
 
-Download the blueprint's nodes in CSV format Format will be:    OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS  OLD NODE TYPE and OLD NODE ID are left intentionally blank to allow direct upload of the output back into the bulk importer 
+Download the blueprint's nodes in CSV format\nFormat will be:\n\n  OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS\n\nOLD NODE TYPE and OLD NODE ID are left intentionally blank to allow direct upload of the output back into the bulk importer\n
 
 ### Example
 ```ruby
@@ -233,7 +233,7 @@ nil (empty response body)
 
 Get ancestor nodes
 
-A proxy for finding ancestors of a given node, equivalent to `/1/abc/nodes?filter[descendant]=department%2Fdep101` 
+A proxy for finding ancestors of a given node, equivalent to\n`/1/abc/nodes?filter[descendant]=department%2Fdep101`\n
 
 ### Example
 ```ruby
@@ -274,8 +274,8 @@ Name | Type | Description  | Notes
  **id** | **String**| id identifying a domain model | 
  **namespace** | **String**| identifier namespacing the blueprint. | 
  **type** | **String**| subtype of Node, e.g. 'modules', 'departments', etc. | 
- **offset** | **Float**| index to start result set from | [optional] 
- **limit** | **Float**| number of records to return | [optional] 
+ **offset** | [**Float**](.md)| index to start result set from | [optional] 
+ **limit** | [**Float**](.md)| number of records to return | [optional] 
 
 ### Return type
 
@@ -297,7 +297,7 @@ Name | Type | Description  | Notes
 
 Get child nodes
 
-A proxy for finding children of a given node, equivalent to `/1/abc/nodes?filter[parent]=department%2Fdep101` 
+A proxy for finding children of a given node, equivalent to\n`/1/abc/nodes?filter[parent]=department%2Fdep101`\n
 
 ### Example
 ```ruby
@@ -338,8 +338,8 @@ Name | Type | Description  | Notes
  **id** | **String**| id identifying a domain model | 
  **namespace** | **String**| identifier namespacing the blueprint. | 
  **type** | **String**| subtype of Node, e.g. 'modules', 'departments', etc. | 
- **offset** | **Float**| index to start result set from | [optional] 
- **limit** | **Float**| number of records to return | [optional] 
+ **offset** | [**Float**](.md)| index to start result set from | [optional] 
+ **limit** | [**Float**](.md)| number of records to return | [optional] 
 
 ### Return type
 
@@ -361,7 +361,7 @@ Name | Type | Description  | Notes
 
 Get descendant nodes
 
-A proxy for finding descendants of a given node, equivalent to `/1/abc/nodes?filter[ancestor]=department%2Fdep101` 
+A proxy for finding descendants of a given node, equivalent to\n`/1/abc/nodes?filter[ancestor]=department%2Fdep101`\n
 
 ### Example
 ```ruby
@@ -402,8 +402,8 @@ Name | Type | Description  | Notes
  **id** | **String**| id identifying a domain model | 
  **namespace** | **String**| identifier namespacing the blueprint. | 
  **type** | **String**| subtype of Node, e.g. 'modules', 'departments', etc. | 
- **offset** | **Float**| index to start result set from | [optional] 
- **limit** | **Float**| number of records to return | [optional] 
+ **offset** | [**Float**](.md)| index to start result set from | [optional] 
+ **limit** | [**Float**](.md)| number of records to return | [optional] 
 
 ### Return type
 
@@ -487,7 +487,7 @@ Name | Type | Description  | Notes
 
 Get parent nodes
 
-A proxy for finding parents of a given node, equivalent to `/1/abc/nodes?filter[child]=department%2Fdep101` 
+A proxy for finding parents of a given node, equivalent to\n`/1/abc/nodes?filter[child]=department%2Fdep101`\n
 
 ### Example
 ```ruby
@@ -528,8 +528,8 @@ Name | Type | Description  | Notes
  **id** | **String**| id identifying a domain model | 
  **namespace** | **String**| identifier namespacing the blueprint. | 
  **type** | **String**| subtype of Node, e.g. 'modules', 'departments', etc. | 
- **offset** | **Float**| index to start result set from | [optional] 
- **limit** | **Float**| number of records to return | [optional] 
+ **offset** | [**Float**](.md)| index to start result set from | [optional] 
+ **limit** | [**Float**](.md)| number of records to return | [optional] 
 
 ### Return type
 
@@ -612,7 +612,7 @@ Name | Type | Description  | Notes
 
 Search nodes
 
-This endpoint is a really flexible way to ask questions about the hierarchy. for example:  ###### Find all nodes for abc: `/1/abc/nodes`  ###### Find all modules for abc: `/1/abc/nodes?filter[nodeType]=Modules`  ###### Find all nodes that are descendants of DEP101: `/1/abc/nodes?filter[descendant]=departments%2Fdep101`  ###### Find all Departments that are ancestors of ABF203: `/1/abc/nodes?filter[descendant]=modules%2Fabf203&filter[nodeType]=Departments` # <= case insensitive  ###### Find all nodes with list assets that are descendants of DEP101 for abc: `/1/abc/nodes?filter[nodeType]=Modules&filter[ancestor]=departments%2FDEP101&filter[hasAssets]=true&filter[assetType]=Lists`  ###### Globally, find all modules that have no list assets `/1/global/nodes?filter[nodeType]=Modules&filter[hasAssets]=false&filter[assetType]=Lists`  ###### Find all nodes of type modules during 2015 that have no assets. Note a node's valid_from/valid_to just need to overlap from/to to qualify `/1/global/nodes?filter[nodeType]=Modules&filter[hasAssets]=false&filter[from]=20150101&filter[to]=20151231` 
+This endpoint is a really flexible way to ask questions about the hierarchy. for example:\n\n###### Find all nodes for abc:\n`/1/abc/nodes`\n\n###### Find all modules for abc:\n`/1/abc/nodes?filter[nodeType]=Modules`\n\n###### Find all nodes that are descendants of DEP101:\n`/1/abc/nodes?filter[descendant]=departments%2Fdep101`\n\n###### Find all Departments that are ancestors of ABF203:\n`/1/abc/nodes?filter[descendant]=modules%2Fabf203&filter[nodeType]=Departments` # <= case insensitive\n\n###### Find all nodes with list assets that are descendants of DEP101 for abc:\n`/1/abc/nodes?filter[nodeType]=Modules&filter[ancestor]=departments%2FDEP101&filter[hasAssets]=true&filter[assetType]=Lists`\n\n###### Globally, find all modules that have no list assets\n`/1/global/nodes?filter[nodeType]=Modules&filter[hasAssets]=false&filter[assetType]=Lists`\n\n###### Find all nodes of type modules during 2015 that have no assets. Note a node's valid_from/valid_to just need to overlap from/to to qualify\n`/1/global/nodes?filter[nodeType]=Modules&filter[hasAssets]=false&filter[from]=20150101&filter[to]=20151231`\n
 
 ### Example
 ```ruby
@@ -661,9 +661,9 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **namespace_inc_global** | **String**| identifier namespacing the blueprint. &#x60;global&#x60; is a special namespace which references data from all blueprints in the call. | 
- **offset** | **Float**| index to start result set from | [optional] 
- **limit** | **Float**| number of records to return | [optional] 
+ **namespace_inc_global** | **String**| identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call. | 
+ **offset** | [**Float**](.md)| index to start result set from | [optional] 
+ **limit** | [**Float**](.md)| number of records to return | [optional] 
  **include** | [**Array&lt;String&gt;**](String.md)| comma separated list of elements to hydrate. Can include children, parents, and/or assets | [optional] 
  **filter_node_type** | [**Array&lt;String&gt;**](String.md)| type of nodes to return | [optional] 
  **filter_child** | [**Array&lt;String&gt;**](String.md)| limit to nodes with children matching type/code | [optional] 

data/docs/IntegrationTransformExample.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**input** | **Object** |  | 
 **output** | **Object** |  | [optional] 
+**input** | **Object** |  | 
 
 

data/docs/IntegrationsApi.md

@@ -243,10 +243,10 @@ Name | Type | Description  | Notes
  **oauth_consumer_key2** | **String**| OAuth 1.0 consumer_key parameters | [optional] 
  **oauth_signature_method** | **String**| OAuth 1.0 signature method, must be 'HMAC-SHA1' | [optional] 
  **oauth_signature_method2** | **String**| OAuth 1.0 signature method, must be 'HMAC-SHA1' | [optional] 
- **oauth_timestamp** | **Integer**| OAuth 1.0 timestamp of request | [optional] 
- **oauth_timestamp2** | **Integer**| OAuth 1.0 timestamp of request | [optional] 
- **oauth_version** | **Float**| OAuth 1.0 version, must be '1.0' | [optional] 
- **oauth_version2** | **Float**| OAuth 1.0 version, must be '1.0' | [optional] 
+ **oauth_timestamp** | [**Integer**](.md)| OAuth 1.0 timestamp of request | [optional] 
+ **oauth_timestamp2** | [**Integer**](.md)| OAuth 1.0 timestamp of request | [optional] 
+ **oauth_version** | [**Float**](.md)| OAuth 1.0 version, must be '1.0' | [optional] 
+ **oauth_version2** | [**Float**](.md)| OAuth 1.0 version, must be '1.0' | [optional] 
  **oauth_nonce** | **String**| OAuth 1.0 Nonce | [optional] 
  **oauth_nonce2** | **String**| OAuth 1.0 Nonce | [optional] 
  **oauth_signature** | **String**| OAuth 1.0 request signature | [optional] 

data/docs/LTIApi.md

@@ -72,10 +72,10 @@ Name | Type | Description  | Notes
  **oauth_consumer_key2** | **String**| OAuth 1.0 consumer_key parameters | [optional] 
  **oauth_signature_method** | **String**| OAuth 1.0 signature method, must be 'HMAC-SHA1' | [optional] 
  **oauth_signature_method2** | **String**| OAuth 1.0 signature method, must be 'HMAC-SHA1' | [optional] 
- **oauth_timestamp** | **Integer**| OAuth 1.0 timestamp of request | [optional] 
- **oauth_timestamp2** | **Integer**| OAuth 1.0 timestamp of request | [optional] 
- **oauth_version** | **Float**| OAuth 1.0 version, must be '1.0' | [optional] 
- **oauth_version2** | **Float**| OAuth 1.0 version, must be '1.0' | [optional] 
+ **oauth_timestamp** | [**Integer**](.md)| OAuth 1.0 timestamp of request | [optional] 
+ **oauth_timestamp2** | [**Integer**](.md)| OAuth 1.0 timestamp of request | [optional] 
+ **oauth_version** | [**Float**](.md)| OAuth 1.0 version, must be '1.0' | [optional] 
+ **oauth_version2** | [**Float**](.md)| OAuth 1.0 version, must be '1.0' | [optional] 
  **oauth_nonce** | **String**| OAuth 1.0 Nonce | [optional] 
  **oauth_nonce2** | **String**| OAuth 1.0 Nonce | [optional] 
  **oauth_signature** | **String**| OAuth 1.0 request signature | [optional] 

data/generate.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 
 if [ ! -f swagger-codegen-cli.jar ]; then
-    wget http://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.2.1/swagger-codegen-cli-2.2.1.jar -O swagger-codegen-cli.jar
+    wget http://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.1.6/swagger-codegen-cli-2.1.6.jar -O swagger-codegen-cli.jar
 fi
 java -jar swagger-codegen-cli.jar generate -l ruby -o . -i https://staging-hierarchy.talis.com/api-docs -c config.json -t templates

data/lib/blueprint_ruby_client/api/asset_type_configs_api.rb

@@ -41,10 +41,23 @@ module BlueprintClient
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: AssetTypeConfigsApi.get ..."
       end
+      
+      
       # verify the required parameter 'namespace' is set
       fail ArgumentError, "Missing the required parameter 'namespace' when calling AssetTypeConfigsApi.get" if namespace.nil?
+      
+      
+      
+      
+      
+      
       # verify the required parameter 'asset_type' is set
       fail ArgumentError, "Missing the required parameter 'asset_type' when calling AssetTypeConfigsApi.get" if asset_type.nil?
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/{namespace}/assets/{assetType}/templates".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'assetType' + '}', asset_type.to_s)
 
@@ -67,7 +80,8 @@ module BlueprintClient
 
       # http body (model)
       post_body = nil
-            auth_names = ['oauth2']
+      
+      auth_names = ['oauth2']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,

data/lib/blueprint_ruby_client/api/asset_type_templates_api.rb

@@ -43,12 +43,31 @@ module BlueprintClient
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: AssetTypeTemplatesApi.add ..."
       end
+      
+      
       # verify the required parameter 'namespace' is set
       fail ArgumentError, "Missing the required parameter 'namespace' when calling AssetTypeTemplatesApi.add" if namespace.nil?
+      
+      
+      
+      
+      
+      
       # verify the required parameter 'asset_type' is set
       fail ArgumentError, "Missing the required parameter 'asset_type' when calling AssetTypeTemplatesApi.add" if asset_type.nil?
+      
+      
+      
+      
+      
+      
       # verify the required parameter 'template_body' is set
       fail ArgumentError, "Missing the required parameter 'template_body' when calling AssetTypeTemplatesApi.add" if template_body.nil?
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/{namespace}/assets/{assetType}/templates".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'assetType' + '}', asset_type.to_s)
 
@@ -71,6 +90,7 @@ module BlueprintClient
 
       # http body (model)
       post_body = @api_client.object_to_http_body(template_body)
+      
       auth_names = ['oauth2']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
@@ -106,10 +126,23 @@ module BlueprintClient
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: AssetTypeTemplatesApi.delete ..."
       end
+      
+      
       # verify the required parameter 'namespace' is set
       fail ArgumentError, "Missing the required parameter 'namespace' when calling AssetTypeTemplatesApi.delete" if namespace.nil?
+      
+      
+      
+      
+      
+      
       # verify the required parameter 'asset_type' is set
       fail ArgumentError, "Missing the required parameter 'asset_type' when calling AssetTypeTemplatesApi.delete" if asset_type.nil?
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/{namespace}/assets/{assetType}/templates".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'assetType' + '}', asset_type.to_s)
 
@@ -132,7 +165,8 @@ module BlueprintClient
 
       # http body (model)
       post_body = nil
-            auth_names = ['oauth2']
+      
+      auth_names = ['oauth2']
       data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
@@ -169,12 +203,31 @@ module BlueprintClient
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: AssetTypeTemplatesApi.put ..."
       end
+      
+      
       # verify the required parameter 'namespace' is set
       fail ArgumentError, "Missing the required parameter 'namespace' when calling AssetTypeTemplatesApi.put" if namespace.nil?
+      
+      
+      
+      
+      
+      
       # verify the required parameter 'asset_type' is set
       fail ArgumentError, "Missing the required parameter 'asset_type' when calling AssetTypeTemplatesApi.put" if asset_type.nil?
+      
+      
+      
+      
+      
+      
       # verify the required parameter 'template_body' is set
       fail ArgumentError, "Missing the required parameter 'template_body' when calling AssetTypeTemplatesApi.put" if template_body.nil?
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/{namespace}/assets/{assetType}/templates".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'assetType' + '}', asset_type.to_s)
 
@@ -197,6 +250,7 @@ module BlueprintClient
 
       # http body (model)
       post_body = @api_client.object_to_http_body(template_body)
+      
       auth_names = ['oauth2']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
         :header_params => header_params,