blueprint_ruby_client 0.4.1 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +65 -0
  3. data/LICENSE +201 -0
  4. data/README.md +25 -11
  5. data/docs/AssetTypeConfigsApi.md +63 -0
  6. data/docs/AssetTypeTemplatesApi.md +179 -0
  7. data/docs/AssetsApi.md +19 -19
  8. data/docs/HierarchyApi.md +35 -35
  9. data/docs/Integration.md +10 -0
  10. data/docs/IntegrationBody.md +9 -0
  11. data/docs/IntegrationTransform.md +11 -0
  12. data/docs/IntegrationTransformExample.md +9 -0
  13. data/docs/IntegrationsApi.md +329 -0
  14. data/docs/LTIApi.md +98 -0
  15. data/docs/Lti1IntegrationAttributes.md +11 -0
  16. data/docs/NodeAttributes.md +2 -0
  17. data/docs/SecurityApi.md +48 -0
  18. data/docs/Template.md +10 -0
  19. data/docs/TemplateAttributes.md +9 -0
  20. data/docs/TemplateBody.md +9 -0
  21. data/docs/{AssetAttributes.md → TemplateVariables.md} +3 -2
  22. data/generate.sh +1 -2
  23. data/git_push.sh +16 -1
  24. data/lib/blueprint_ruby_client/api/asset_type_configs_api.rb +84 -0
  25. data/lib/blueprint_ruby_client/api/asset_type_templates_api.rb +214 -0
  26. data/lib/blueprint_ruby_client/api/assets_api.rb +23 -191
  27. data/lib/blueprint_ruby_client/api/hierarchy_api.rb +49 -409
  28. data/lib/blueprint_ruby_client/api/integrations_api.rb +415 -0
  29. data/lib/blueprint_ruby_client/api/lti_api.rb +156 -0
  30. data/lib/blueprint_ruby_client/api/security_api.rb +75 -0
  31. data/lib/blueprint_ruby_client/api_client.rb +0 -2
  32. data/lib/blueprint_ruby_client/models/asset.rb +2 -59
  33. data/lib/blueprint_ruby_client/models/asset_body.rb +2 -42
  34. data/lib/blueprint_ruby_client/models/asset_relationship.rb +2 -57
  35. data/lib/blueprint_ruby_client/models/asset_result_set.rb +2 -57
  36. data/lib/blueprint_ruby_client/models/error.rb +2 -59
  37. data/lib/blueprint_ruby_client/models/errors.rb +2 -25
  38. data/lib/blueprint_ruby_client/models/integration.rb +225 -0
  39. data/lib/blueprint_ruby_client/models/{mixed_resource_result_set.rb → integration_body.rb} +27 -12
  40. data/lib/blueprint_ruby_client/models/integration_transform.rb +221 -0
  41. data/lib/blueprint_ruby_client/models/integration_transform_example.rb +197 -0
  42. data/lib/blueprint_ruby_client/models/links.rb +2 -57
  43. data/lib/blueprint_ruby_client/models/lti1_integration_attributes.rb +225 -0
  44. data/lib/blueprint_ruby_client/models/meta.rb +2 -57
  45. data/lib/blueprint_ruby_client/models/namespace.rb +2 -43
  46. data/lib/blueprint_ruby_client/models/namespace_relationship.rb +2 -25
  47. data/lib/blueprint_ruby_client/models/node.rb +2 -75
  48. data/lib/blueprint_ruby_client/models/node_attributes.rb +26 -109
  49. data/lib/blueprint_ruby_client/models/node_body.rb +2 -42
  50. data/lib/blueprint_ruby_client/models/node_relationship.rb +2 -57
  51. data/lib/blueprint_ruby_client/models/node_relationships.rb +2 -73
  52. data/lib/blueprint_ruby_client/models/node_result_set.rb +2 -57
  53. data/lib/blueprint_ruby_client/models/resource.rb +2 -59
  54. data/lib/blueprint_ruby_client/models/template.rb +215 -0
  55. data/lib/blueprint_ruby_client/models/template_attributes.rb +217 -0
  56. data/lib/blueprint_ruby_client/models/{asset_attributes.rb → template_body.rb} +23 -33
  57. data/lib/blueprint_ruby_client/models/template_variables.rb +237 -0
  58. data/lib/blueprint_ruby_client/version.rb +1 -1
  59. data/lib/blueprint_ruby_client.rb +14 -0
  60. data/spec/api/asset_type_configs_api_spec.rb +52 -0
  61. data/spec/api/asset_type_templates_api_spec.rb +88 -0
  62. data/spec/api/assets_api_spec.rb +9 -9
  63. data/spec/api/hierarchy_api_spec.rb +17 -17
  64. data/spec/api/integrations_api_spec.rb +141 -0
  65. data/spec/api/lti_api_spec.rb +69 -0
  66. data/spec/api/security_api_spec.rb +50 -0
  67. data/spec/api_client_spec.rb +226 -0
  68. data/spec/configuration_spec.rb +42 -0
  69. data/spec/models/integration_body_spec.rb +56 -0
  70. data/spec/models/integration_spec.rb +66 -0
  71. data/spec/models/integration_transform_example_spec.rb +56 -0
  72. data/spec/models/integration_transform_spec.rb +76 -0
  73. data/spec/models/lti1_integration_attributes_spec.rb +76 -0
  74. data/spec/models/node_attributes_spec.rb +20 -0
  75. data/spec/models/template_attributes_spec.rb +56 -0
  76. data/spec/models/{asset_attributes_spec.rb → template_body_spec.rb} +17 -7
  77. data/spec/models/template_spec.rb +66 -0
  78. data/spec/models/template_variables_spec.rb +56 -0
  79. data/spec/spec_helper.rb +111 -0
  80. data/swagger-codegen-cli.jar +0 -0
  81. data/templates/model.mustache +5 -5
  82. metadata +67 -12
  83. data/docs/MixedResourceResultSet.md +0 -7
  84. data/spec/models/mixed_resource_result_set_spec.rb +0 -36
@@ -0,0 +1,88 @@
1
+ =begin
2
+ Talis Blueprint API
3
+
4
+ This is the API documentation for [Blueprint](https://github.com/talis/blueprint-server), a primitive for institutional structure and time periods
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+
16
+ # Unit tests for BlueprintClient::AssetTypeTemplatesApi
17
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
18
+ # Please update as you see appropriate
19
+ describe 'AssetTypeTemplatesApi' do
20
+ before do
21
+ # run before each test
22
+ @instance = BlueprintClient::AssetTypeTemplatesApi.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of AssetTypeTemplatesApi' do
30
+ it 'should create an instact of AssetTypeTemplatesApi' do
31
+ @instance.should be_a(BlueprintClient::AssetTypeTemplatesApi)
32
+ end
33
+ end
34
+
35
+ # unit tests for add
36
+ #
37
+ # Configure a template for a given asset type
38
+ # @param namespace identifier namespacing the blueprint.
39
+ # @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
40
+ # @param template_body template body
41
+ # @param [Hash] opts the optional parameters
42
+ # @return [TemplateBody]
43
+ describe 'add test' do
44
+ it "should work" do
45
+ # assertion here
46
+ # should be_a()
47
+ # should be_nil
48
+ # should ==
49
+ # should_not ==
50
+ end
51
+ end
52
+
53
+ # unit tests for delete
54
+ #
55
+ # Delete a template for a given asset type
56
+ # @param namespace identifier namespacing the blueprint.
57
+ # @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
58
+ # @param [Hash] opts the optional parameters
59
+ # @return [TemplateBody]
60
+ describe 'delete test' do
61
+ it "should work" do
62
+ # assertion here
63
+ # should be_a()
64
+ # should be_nil
65
+ # should ==
66
+ # should_not ==
67
+ end
68
+ end
69
+
70
+ # unit tests for put
71
+ #
72
+ # update a template for a given asset type
73
+ # @param namespace identifier namespacing the blueprint.
74
+ # @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
75
+ # @param template_body template body
76
+ # @param [Hash] opts the optional parameters
77
+ # @return [TemplateBody]
78
+ describe 'put test' do
79
+ it "should work" do
80
+ # assertion here
81
+ # should be_a()
82
+ # should be_nil
83
+ # should ==
84
+ # should_not ==
85
+ end
86
+ end
87
+
88
+ end
@@ -36,9 +36,9 @@ describe 'AssetsApi' do
36
36
  #
37
37
  # Add an asset to the node. Body must be empty. Will upsert the asset if it doesn't exist
38
38
  # @param namespace identifier namespacing the blueprint.
39
- # @param type Plural form of node type (adds an 's' to the end of the type) todo - allow configuration of plurals
39
+ # @param type subtype of Node, e.g. 'modules', 'departments', etc.
40
40
  # @param id id identifying a domain model
41
- # @param asset_type Plural form of asset type (adds an 's' to the end of the type) todo - allow configuration of plurals
41
+ # @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
42
42
  # @param asset_id id of an asset
43
43
  # @param [Hash] opts the optional parameters
44
44
  # @return [AssetBody]
@@ -57,7 +57,7 @@ describe 'AssetsApi' do
57
57
  # Delete an Asset
58
58
  # @param namespace identifier namespacing the blueprint.
59
59
  # @param asset_id id of an asset
60
- # @param asset_type Plural form of asset type (adds an 's' to the end of the type) todo - allow configuration of plurals
60
+ # @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
61
61
  # @param [Hash] opts the optional parameters
62
62
  # @return [nil]
63
63
  describe 'delete_asset test' do
@@ -74,7 +74,7 @@ describe 'AssetsApi' do
74
74
  #
75
75
  # Get details of a given asset
76
76
  # @param namespace identifier namespacing the blueprint.
77
- # @param asset_type Plural form of asset type (adds an 's' to the end of the type) todo - allow configuration of plurals
77
+ # @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
78
78
  # @param asset_id id of an asset
79
79
  # @param [Hash] opts the optional parameters
80
80
  # @return [AssetBody]
@@ -92,7 +92,7 @@ describe 'AssetsApi' do
92
92
  #
93
93
  # Get for assets in the relevant node
94
94
  # @param namespace identifier namespacing the blueprint.
95
- # @param type Plural form of node type (adds an 's' to the end of the type) todo - allow configuration of plurals
95
+ # @param type subtype of Node, e.g. 'modules', 'departments', etc.
96
96
  # @param id id identifying a domain model
97
97
  # @param [Hash] opts the optional parameters
98
98
  # @option opts [Array<String>] :filter_asset_type type of asset to return
@@ -113,9 +113,9 @@ describe 'AssetsApi' do
113
113
  #
114
114
  # Remove an asset from the relevant node
115
115
  # @param namespace identifier namespacing the blueprint.
116
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
116
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
117
117
  # @param id id identifying a domain model
118
- # @param asset_type Plural form of asset type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
118
+ # @param asset_type subtype of Asset, e.g. &#39;textbooks&#39;, &#39;digitisations&#39;, etc.
119
119
  # @param asset_id id of an asset
120
120
  # @param [Hash] opts the optional parameters
121
121
  # @return [nil]
@@ -131,10 +131,10 @@ describe 'AssetsApi' do
131
131
 
132
132
  # unit tests for replace_asset
133
133
  # Replaces the Asset with the data sent in the body
134
- # Wholesale replacement of Asset data: if you were to PUT to:\n /1/{namespace}/assets/sometype/someid\n\nwith a body of:\n { type: \&quot;someothertype\&quot;, id: \&quot;someotherid\&quot; }\n\nIt would change the Asset&#39;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
134
+ # Wholesale replacement of Asset data: if you were to PUT to: /1/{namespace}/assets/sometype/someid with a body of: { type: \&quot;someothertype\&quot;, id: \&quot;someotherid\&quot; } It would change the Asset&#39;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.
135
135
  # @param namespace identifier namespacing the blueprint.
136
136
  # @param asset_id id of an asset
137
- # @param asset_type Plural form of asset type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
137
+ # @param asset_type subtype of Asset, e.g. &#39;textbooks&#39;, &#39;digitisations&#39;, etc.
138
138
  # @param [Hash] opts the optional parameters
139
139
  # @option opts [AssetBody] :body asset
140
140
  # @return [AssetBody]
@@ -35,7 +35,7 @@ describe 'HierarchyApi' do
35
35
  # unit tests for add_node
36
36
  #
37
37
  # Add a node
38
- # @param namespace_inc_global identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.
38
+ # @param namespace_inc_global identifier namespacing the blueprint. &#x60;global&#x60; is a special namespace which references data from all blueprints in the call.
39
39
  # @param body node
40
40
  # @param [Hash] opts the optional parameters
41
41
  # @return [NodeBody]
@@ -51,7 +51,7 @@ describe 'HierarchyApi' do
51
51
 
52
52
  # unit tests for bulk_upload
53
53
  #
54
- # 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
54
+ # 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
55
55
  # @param namespace identifier namespacing the blueprint.
56
56
  # @param [Hash] opts the optional parameters
57
57
  # @return [nil]
@@ -70,7 +70,7 @@ describe 'HierarchyApi' do
70
70
  # Delete a node
71
71
  # @param namespace identifier namespacing the blueprint.
72
72
  # @param id id identifying a domain model
73
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
73
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
74
74
  # @param [Hash] opts the optional parameters
75
75
  # @return [nil]
76
76
  describe 'delete_node test' do
@@ -85,7 +85,7 @@ describe 'HierarchyApi' do
85
85
 
86
86
  # unit tests for export_hierarchy
87
87
  #
88
- # Download the blueprint&#39;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
88
+ # Download the blueprint&#39;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
89
89
  # @param namespace identifier namespacing the blueprint.
90
90
  # @param [Hash] opts the optional parameters
91
91
  # @return [nil]
@@ -101,10 +101,10 @@ describe 'HierarchyApi' do
101
101
 
102
102
  # unit tests for get_ancestors
103
103
  # Get ancestor nodes
104
- # A proxy for finding ancestors of a given node, equivalent to\n`/1/abc/nodes?filter[descendant]=department%2Fdep101`\n
104
+ # A proxy for finding ancestors of a given node, equivalent to &#x60;/1/abc/nodes?filter[descendant]&#x3D;department%2Fdep101&#x60;
105
105
  # @param id id identifying a domain model
106
106
  # @param namespace identifier namespacing the blueprint.
107
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
107
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
108
108
  # @param [Hash] opts the optional parameters
109
109
  # @option opts [Float] :offset index to start result set from
110
110
  # @option opts [Float] :limit number of records to return
@@ -121,10 +121,10 @@ describe 'HierarchyApi' do
121
121
 
122
122
  # unit tests for get_children
123
123
  # Get child nodes
124
- # A proxy for finding children of a given node, equivalent to\n`/1/abc/nodes?filter[parent]=department%2Fdep101`\n
124
+ # A proxy for finding children of a given node, equivalent to &#x60;/1/abc/nodes?filter[parent]&#x3D;department%2Fdep101&#x60;
125
125
  # @param id id identifying a domain model
126
126
  # @param namespace identifier namespacing the blueprint.
127
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
127
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
128
128
  # @param [Hash] opts the optional parameters
129
129
  # @option opts [Float] :offset index to start result set from
130
130
  # @option opts [Float] :limit number of records to return
@@ -141,10 +141,10 @@ describe 'HierarchyApi' do
141
141
 
142
142
  # unit tests for get_descendants
143
143
  # Get descendant nodes
144
- # A proxy for finding descendants of a given node, equivalent to\n`/1/abc/nodes?filter[ancestor]=department%2Fdep101`\n
144
+ # A proxy for finding descendants of a given node, equivalent to &#x60;/1/abc/nodes?filter[ancestor]&#x3D;department%2Fdep101&#x60;
145
145
  # @param id id identifying a domain model
146
146
  # @param namespace identifier namespacing the blueprint.
147
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
147
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
148
148
  # @param [Hash] opts the optional parameters
149
149
  # @option opts [Float] :offset index to start result set from
150
150
  # @option opts [Float] :limit number of records to return
@@ -164,7 +164,7 @@ describe 'HierarchyApi' do
164
164
  # Get details of a given node
165
165
  # @param namespace identifier namespacing the blueprint.
166
166
  # @param id id identifying a domain model
167
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
167
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
168
168
  # @param [Hash] opts the optional parameters
169
169
  # @option opts [Array<String>] :include comma separated list of elements to hydrate. Can include children, parents, and/or assets
170
170
  # @return [NodeBody]
@@ -180,10 +180,10 @@ describe 'HierarchyApi' do
180
180
 
181
181
  # unit tests for get_parents
182
182
  # Get parent nodes
183
- # A proxy for finding parents of a given node, equivalent to\n`/1/abc/nodes?filter[child]=department%2Fdep101`\n
183
+ # A proxy for finding parents of a given node, equivalent to &#x60;/1/abc/nodes?filter[child]&#x3D;department%2Fdep101&#x60;
184
184
  # @param id id identifying a domain model
185
185
  # @param namespace identifier namespacing the blueprint.
186
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
186
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
187
187
  # @param [Hash] opts the optional parameters
188
188
  # @option opts [Float] :offset index to start result set from
189
189
  # @option opts [Float] :limit number of records to return
@@ -204,7 +204,7 @@ describe 'HierarchyApi' do
204
204
  # @param namespace identifier namespacing the blueprint.
205
205
  # @param id id identifying a domain model
206
206
  # @param body node
207
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
207
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
208
208
  # @param [Hash] opts the optional parameters
209
209
  # @return [NodeBody]
210
210
  describe 'replace_node test' do
@@ -219,8 +219,8 @@ describe 'HierarchyApi' do
219
219
 
220
220
  # unit tests for search_nodes
221
221
  # Search nodes
222
- # 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]=Module`\n\n###### Find all nodes that are descendants of DEP101:\n`/1/abc/nodes?filter[descendant]=department%2Fdep101`\n\n###### Find all Departments that are ancestors of ABF203:\n`/1/abc/nodes?filter[descendant]=module%2Fabf203&amp;filter[nodeType]=Department` # &lt;= case insensitive\n\n###### Find all nodes with list assets that are descendants of DEP101 for abc:\n`/1/abc/nodes?filter[nodeType]=Module&amp;filter[ancestor]=department%2FDEP101&amp;filter[hasAssets]=true&amp;filter[assetType]=List`\n\n###### Globally, find all modules that have no list assets\n`/1/global/nodes?filter[nodeType]=Module&amp;filter[hasAssets]=false&amp;filter[assetType]=List`\n\n###### Find all nodes of type time period valid during 2015 that have no list assets. Note a node&#39;s valid_from/valid_to just need to overlap from/to to qualify\n`/1/global/nodes?filter[nodeType]=TimePeriod&amp;filter[hasAssets]=false&amp;filter[assetType]=List&amp;filter[from]=20150101&amp;filter[to]=20151231`\n
223
- # @param namespace_inc_global identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.
222
+ # This endpoint is a really flexible way to ask questions about the hierarchy. for example: ###### Find all nodes for abc: &#x60;/1/abc/nodes&#x60; ###### Find all modules for abc: &#x60;/1/abc/nodes?filter[nodeType]&#x3D;Modules&#x60; ###### Find all nodes that are descendants of DEP101: &#x60;/1/abc/nodes?filter[descendant]&#x3D;departments%2Fdep101&#x60; ###### Find all Departments that are ancestors of ABF203: &#x60;/1/abc/nodes?filter[descendant]&#x3D;modules%2Fabf203&amp;filter[nodeType]&#x3D;Departments&#x60; # &lt;&#x3D; case insensitive ###### Find all nodes with list assets that are descendants of DEP101 for abc: &#x60;/1/abc/nodes?filter[nodeType]&#x3D;Modules&amp;filter[ancestor]&#x3D;departments%2FDEP101&amp;filter[hasAssets]&#x3D;true&amp;filter[assetType]&#x3D;Lists&#x60; ###### Globally, find all modules that have no list assets &#x60;/1/global/nodes?filter[nodeType]&#x3D;Modules&amp;filter[hasAssets]&#x3D;false&amp;filter[assetType]&#x3D;Lists&#x60; ###### Find all nodes of type modules during 2015 that have no assets. Note a node&#39;s valid_from/valid_to just need to overlap from/to to qualify &#x60;/1/global/nodes?filter[nodeType]&#x3D;Modules&amp;filter[hasAssets]&#x3D;false&amp;filter[from]&#x3D;20150101&amp;filter[to]&#x3D;20151231&#x60;
223
+ # @param namespace_inc_global identifier namespacing the blueprint. &#x60;global&#x60; is a special namespace which references data from all blueprints in the call.
224
224
  # @param [Hash] opts the optional parameters
225
225
  # @option opts [Float] :offset index to start result set from
226
226
  # @option opts [Float] :limit number of records to return
@@ -256,7 +256,7 @@ describe 'HierarchyApi' do
256
256
  # @param namespace identifier namespacing the blueprint.
257
257
  # @param id id identifying a domain model
258
258
  # @param body node
259
- # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
259
+ # @param type subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc.
260
260
  # @param [Hash] opts the optional parameters
261
261
  # @return [NodeBody]
262
262
  describe 'update_node test' do
@@ -0,0 +1,141 @@
1
+ =begin
2
+ Talis Blueprint API
3
+
4
+ This is the API documentation for [Blueprint](https://github.com/talis/blueprint-server), a primitive for institutional structure and time periods
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+
16
+ # Unit tests for BlueprintClient::IntegrationsApi
17
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
18
+ # Please update as you see appropriate
19
+ describe 'IntegrationsApi' do
20
+ before do
21
+ # run before each test
22
+ @instance = BlueprintClient::IntegrationsApi.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of IntegrationsApi' do
30
+ it 'should create an instact of IntegrationsApi' do
31
+ @instance.should be_a(BlueprintClient::IntegrationsApi)
32
+ end
33
+ end
34
+
35
+ # unit tests for add_integration
36
+ #
37
+ # Add an integration
38
+ # @param namespace identifier namespacing the blueprint.
39
+ # @param body integration
40
+ # @param [Hash] opts the optional parameters
41
+ # @return [IntegrationBody]
42
+ describe 'add_integration test' do
43
+ it "should work" do
44
+ # assertion here
45
+ # should be_a()
46
+ # should be_nil
47
+ # should ==
48
+ # should_not ==
49
+ end
50
+ end
51
+
52
+ # unit tests for delete_integration
53
+ #
54
+ # Delete an integration
55
+ # @param namespace identifier namespacing the blueprint.
56
+ # @param integration_id id of an integration
57
+ # @param integration_type Type of external integration, e.g. &#39;lti1&#39;
58
+ # @param [Hash] opts the optional parameters
59
+ # @return [nil]
60
+ describe 'delete_integration test' do
61
+ it "should work" do
62
+ # assertion here
63
+ # should be_a()
64
+ # should be_nil
65
+ # should ==
66
+ # should_not ==
67
+ end
68
+ end
69
+
70
+ # unit tests for get_integration
71
+ #
72
+ # Get details of a given integration
73
+ # @param namespace identifier namespacing the blueprint.
74
+ # @param integration_type Type of external integration, e.g. &#39;lti1&#39;
75
+ # @param integration_id id of an integration
76
+ # @param [Hash] opts the optional parameters
77
+ # @return [IntegrationBody]
78
+ describe 'get_integration test' do
79
+ it "should work" do
80
+ # assertion here
81
+ # should be_a()
82
+ # should be_nil
83
+ # should ==
84
+ # should_not ==
85
+ end
86
+ end
87
+
88
+ # unit tests for namespace_integrations_lti1_integration_id_assets_asset_type_asset_id_post
89
+ #
90
+ # LTI launch url for integration
91
+ # @param namespace identifier namespacing the blueprint.
92
+ # @param integration_id id of an integration
93
+ # @param asset_type subtype of Asset, e.g. &#39;textbooks&#39;, &#39;digitisations&#39;, etc.
94
+ # @param asset_id id of an asset
95
+ # @param lti_message_type LTI launch data message type, must be &#39;basic-lti-launch-request&#39;
96
+ # @param lti_version LTI launch version, must be &#39;LTI-1p0&#39;
97
+ # @param resource_link_id LTI resource_link_id parameters
98
+ # @param [Hash] opts the optional parameters
99
+ # @option opts [String] :oauth_consumer_key OAuth 1.0 consumer_key parameters
100
+ # @option opts [String] :oauth_consumer_key2 OAuth 1.0 consumer_key parameters
101
+ # @option opts [String] :oauth_signature_method OAuth 1.0 signature method, must be &#39;HMAC-SHA1&#39;
102
+ # @option opts [String] :oauth_signature_method2 OAuth 1.0 signature method, must be &#39;HMAC-SHA1&#39;
103
+ # @option opts [Integer] :oauth_timestamp OAuth 1.0 timestamp of request
104
+ # @option opts [Integer] :oauth_timestamp2 OAuth 1.0 timestamp of request
105
+ # @option opts [Float] :oauth_version OAuth 1.0 version, must be &#39;1.0&#39;
106
+ # @option opts [Float] :oauth_version2 OAuth 1.0 version, must be &#39;1.0&#39;
107
+ # @option opts [String] :oauth_nonce OAuth 1.0 Nonce
108
+ # @option opts [String] :oauth_nonce2 OAuth 1.0 Nonce
109
+ # @option opts [String] :oauth_signature OAuth 1.0 request signature
110
+ # @option opts [String] :oauth_signature2 OAuth 1.0 request signature
111
+ # @return [nil]
112
+ describe 'namespace_integrations_lti1_integration_id_assets_asset_type_asset_id_post test' do
113
+ it "should work" do
114
+ # assertion here
115
+ # should be_a()
116
+ # should be_nil
117
+ # should ==
118
+ # should_not ==
119
+ end
120
+ end
121
+
122
+ # unit tests for replace_integration
123
+ #
124
+ # Replace an integration
125
+ # @param namespace identifier namespacing the blueprint.
126
+ # @param integration_id id of an integration
127
+ # @param integration_type Type of external integration, e.g. &#39;lti1&#39;
128
+ # @param body integration
129
+ # @param [Hash] opts the optional parameters
130
+ # @return [IntegrationBody]
131
+ describe 'replace_integration test' do
132
+ it "should work" do
133
+ # assertion here
134
+ # should be_a()
135
+ # should be_nil
136
+ # should ==
137
+ # should_not ==
138
+ end
139
+ end
140
+
141
+ end
@@ -0,0 +1,69 @@
1
+ =begin
2
+ Talis Blueprint API
3
+
4
+ This is the API documentation for [Blueprint](https://github.com/talis/blueprint-server), a primitive for institutional structure and time periods
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+
16
+ # Unit tests for BlueprintClient::LTIApi
17
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
18
+ # Please update as you see appropriate
19
+ describe 'LTIApi' do
20
+ before do
21
+ # run before each test
22
+ @instance = BlueprintClient::LTIApi.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of LTIApi' do
30
+ it 'should create an instact of LTIApi' do
31
+ @instance.should be_a(BlueprintClient::LTIApi)
32
+ end
33
+ end
34
+
35
+ # unit tests for namespace_integrations_lti1_integration_id_assets_asset_type_asset_id_post
36
+ #
37
+ # LTI launch url for integration
38
+ # @param namespace identifier namespacing the blueprint.
39
+ # @param integration_id id of an integration
40
+ # @param asset_type subtype of Asset, e.g. &#39;textbooks&#39;, &#39;digitisations&#39;, etc.
41
+ # @param asset_id id of an asset
42
+ # @param lti_message_type LTI launch data message type, must be &#39;basic-lti-launch-request&#39;
43
+ # @param lti_version LTI launch version, must be &#39;LTI-1p0&#39;
44
+ # @param resource_link_id LTI resource_link_id parameters
45
+ # @param [Hash] opts the optional parameters
46
+ # @option opts [String] :oauth_consumer_key OAuth 1.0 consumer_key parameters
47
+ # @option opts [String] :oauth_consumer_key2 OAuth 1.0 consumer_key parameters
48
+ # @option opts [String] :oauth_signature_method OAuth 1.0 signature method, must be &#39;HMAC-SHA1&#39;
49
+ # @option opts [String] :oauth_signature_method2 OAuth 1.0 signature method, must be &#39;HMAC-SHA1&#39;
50
+ # @option opts [Integer] :oauth_timestamp OAuth 1.0 timestamp of request
51
+ # @option opts [Integer] :oauth_timestamp2 OAuth 1.0 timestamp of request
52
+ # @option opts [Float] :oauth_version OAuth 1.0 version, must be &#39;1.0&#39;
53
+ # @option opts [Float] :oauth_version2 OAuth 1.0 version, must be &#39;1.0&#39;
54
+ # @option opts [String] :oauth_nonce OAuth 1.0 Nonce
55
+ # @option opts [String] :oauth_nonce2 OAuth 1.0 Nonce
56
+ # @option opts [String] :oauth_signature OAuth 1.0 request signature
57
+ # @option opts [String] :oauth_signature2 OAuth 1.0 request signature
58
+ # @return [nil]
59
+ describe 'namespace_integrations_lti1_integration_id_assets_asset_type_asset_id_post test' do
60
+ it "should work" do
61
+ # assertion here
62
+ # should be_a()
63
+ # should be_nil
64
+ # should ==
65
+ # should_not ==
66
+ end
67
+ end
68
+
69
+ end
@@ -0,0 +1,50 @@
1
+ =begin
2
+ Talis Blueprint API
3
+
4
+ This is the API documentation for [Blueprint](https://github.com/talis/blueprint-server), a primitive for institutional structure and time periods
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+
16
+ # Unit tests for BlueprintClient::SecurityApi
17
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
18
+ # Please update as you see appropriate
19
+ describe 'SecurityApi' do
20
+ before do
21
+ # run before each test
22
+ @instance = BlueprintClient::SecurityApi.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of SecurityApi' do
30
+ it 'should create an instact of SecurityApi' do
31
+ @instance.should be_a(BlueprintClient::SecurityApi)
32
+ end
33
+ end
34
+
35
+ # unit tests for get_public_certificate
36
+ #
37
+ # Return public key that is used to verify signed data
38
+ # @param [Hash] opts the optional parameters
39
+ # @return [nil]
40
+ describe 'get_public_certificate test' do
41
+ it "should work" do
42
+ # assertion here
43
+ # should be_a()
44
+ # should be_nil
45
+ # should ==
46
+ # should_not ==
47
+ end
48
+ end
49
+
50
+ end