canvas_cc 0.0.22 → 0.0.23

Sign up to get free protection for your applications and to get access to all the features.
Files changed (9) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +1 -0
  4. data/lib/canvas_cc/canvas_cc/file_meta_writer.rb +5 -0
  5. data/lib/canvas_cc/canvas_cc/ims_manifest_generator.rb +2 -2
  6. data/lib/canvas_cc/canvas_cc/models/canvas_file.rb +9 -2
  7. data/lib/canvas_cc/version.rb +1 -1
  8. data/spec/moodle2cc/canvas_cc/file_meta_writer_spec.rb +12 -0
  9. metadata +36 -35
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: a3f44e66afb42cf6f9156946b38420e4c729ca21
4
- data.tar.gz: f4f282b47c9c7208764b71614558610872f36333
3
+ metadata.gz: c990954f815f758ec048e3035f0ab9f8cb94b4d4
4
+ data.tar.gz: 2aabc84e201e87b0bca8c531f680a76cc835b5bd
5
5
  SHA512:
6
- metadata.gz: 7420ba56aacb50814f262a657f8a74ed8e7ea9b0932456fbaaf7b903a5fc874b458519df4cca77eaa956ff85d34d0aa4d86f385b2566389b31c392968199b997
7
- data.tar.gz: dd9832a21cdda71a94ce045b9318d8f5dc5e4f34f4f6ffe4e540b0bd137bfbd168f883f14ced8304f7e0ac6285d1175b74f67847a1410190c5cfbf6c6a0001a2
6
+ metadata.gz: 6ed9453a7ae603e8f11b0b966673f47ff809d4edd59761f3a2aab38c8067ea50f51c73b51e9e35e0c80975b5c84179d488cc67a772d1d2486b9077d68f9cb32e
7
+ data.tar.gz: 1d187e232bff6547f06dffddcd3a652380fea65f5166811bf82fabdfb75ff6b5b11eb634f8511ff14036a5f816584e2d93f3b37197ac16ec4593087e378f2448
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- canvas_cc (0.0.22)
4
+ canvas_cc (0.0.23)
5
5
  builder
6
6
  happymapper
7
7
  nokogiri
data/README.md CHANGED
@@ -253,6 +253,7 @@ A File can have the following attributes
253
253
  * **file_path** - the path of the file including the file name, for example '/assignments/files/test.png'
254
254
  * **file_location** - the location on the filesystem for the file, for example '/tmp/files/assignments/files/test.png'
255
255
  * **hidden** - whether or not this file is hidden. true or false
256
+ * **usage_rights** - copyright information. Valid options: "own_copyright"|"used_by_permission"|"fair_use"|"public_domain"|"creative_commons". See [File Usage Rights](https://canvas.instructure.com/doc/api/files.html#method.usage_rights.set_usage_rights)
256
257
 
257
258
  To reference a file inside of html content within pages, quizzes, assignments, discussions or other html content, the link can be written in the following format. When imported the references will be correctly updated to the file path of the content within Canvas.
258
259
 
data/lib/canvas_cc/canvas_cc/file_meta_writer.rb CHANGED
@@ -36,6 +36,11 @@ module CanvasCc::CanvasCC
36
36
  xml.file('identifier' => file.identifier){
37
37
  xml.hidden file.hidden unless file.hidden.nil?
38
38
  xml.locked file.locked unless file.locked.nil?
39
+ unless file.usage_rights.nil?
40
+ xml.usage_rights('use_justification' => file.usage_rights) {
41
+ xml.license file.license
42
+ }
43
+ end
39
44
  }
40
45
  end
41
46
  }
data/lib/canvas_cc/canvas_cc/ims_manifest_generator.rb CHANGED
@@ -62,7 +62,7 @@ module CanvasCc::CanvasCC
62
62
  has_copyright = @course.copyright && !@course.copyright.empty?
63
63
  xml[ns].rights {
64
64
  xml[ns].copyrightAndOtherRestrictions {
65
- xml[ns].value has_copyright ? 'yes' : 'no'
65
+ xml[ns].value (has_copyright || @course.files.any? { |f| f.usage_rights } ? 'yes' : 'no')
66
66
  }
67
67
  if has_copyright
68
68
  xml[ns].description {
@@ -120,4 +120,4 @@ module CanvasCc::CanvasCC
120
120
 
121
121
 
122
122
  end
123
- end
123
+ end
data/lib/canvas_cc/canvas_cc/models/canvas_file.rb CHANGED
@@ -4,7 +4,7 @@ module CanvasCc::CanvasCC::Models
4
4
  WEB_RESOURCES = 'web_resources'
5
5
 
6
6
  attr_reader :file_path
7
- attr_accessor :file_location, :hidden, :locked
7
+ attr_accessor :file_location, :hidden, :locked, :usage_rights
8
8
 
9
9
  def initialize
10
10
  super
@@ -17,6 +17,13 @@ module CanvasCc::CanvasCC::Models
17
17
  @file_path = file_path
18
18
  end
19
19
 
20
-
20
+ def license
21
+ case usage_rights
22
+ when 'own_copyright', 'used_by_permission', 'fair_use'
23
+ 'private'
24
+ else
25
+ usage_rights
26
+ end
27
+ end
21
28
  end
22
29
  end
data/lib/canvas_cc/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module CanvasCc
2
- VERSION = "0.0.22"
2
+ VERSION = "0.0.23"
3
3
  end
data/spec/moodle2cc/canvas_cc/file_meta_writer_spec.rb CHANGED
@@ -46,6 +46,18 @@ module CanvasCc::CanvasCC
46
46
  end
47
47
  end
48
48
 
49
+ it 'writes copyright information' do
50
+ file.identifier = 'abc123'
51
+ file.usage_rights = 'public_domain'
52
+ create_file('sample.txt') do |source_file|
53
+ file.file_location = source_file
54
+ file.file_path = 'sample.txt'
55
+ xml = write_xml(writer(file, nil))
56
+ expect(xml.at_xpath('xmlns:fileMeta/xmlns:files/xmlns:file/xmlns:usage_rights/@use_justification').text).to eql 'public_domain'
57
+ expect(xml.at_xpath('xmlns:fileMeta/xmlns:files/xmlns:file/xmlns:usage_rights/xmlns:license').text).to eql 'public_domain'
58
+ end
59
+ end
60
+
49
61
  it 'writes folders' do
50
62
  folder.hidden = true
51
63
  folder.locked = true
metadata CHANGED
@@ -1,223 +1,223 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: canvas_cc
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.22
4
+ version: 0.0.23
5
5
  platform: ruby
6
6
  authors:
7
7
  - Instructure
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2015-07-15 00:00:00.000000000 Z
11
+ date: 2015-09-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rubyzip
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - '>='
17
+ - - ">="
18
18
  - !ruby/object:Gem::Version
19
19
  version: 1.0.0
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - '>='
24
+ - - ">="
25
25
  - !ruby/object:Gem::Version
26
26
  version: 1.0.0
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: happymapper
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
- - - '>='
31
+ - - ">="
32
32
  - !ruby/object:Gem::Version
33
33
  version: '0'
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
- - - '>='
38
+ - - ">="
39
39
  - !ruby/object:Gem::Version
40
40
  version: '0'
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: builder
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
- - - '>='
45
+ - - ">="
46
46
  - !ruby/object:Gem::Version
47
47
  version: '0'
48
48
  type: :runtime
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
- - - '>='
52
+ - - ">="
53
53
  - !ruby/object:Gem::Version
54
54
  version: '0'
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: thor
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
- - - '>='
59
+ - - ">="
60
60
  - !ruby/object:Gem::Version
61
61
  version: '0'
62
62
  type: :runtime
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
- - - '>='
66
+ - - ">="
67
67
  - !ruby/object:Gem::Version
68
68
  version: '0'
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: nokogiri
71
71
  requirement: !ruby/object:Gem::Requirement
72
72
  requirements:
73
- - - '>='
73
+ - - ">="
74
74
  - !ruby/object:Gem::Version
75
75
  version: '0'
76
76
  type: :runtime
77
77
  prerelease: false
78
78
  version_requirements: !ruby/object:Gem::Requirement
79
79
  requirements:
80
- - - '>='
80
+ - - ">="
81
81
  - !ruby/object:Gem::Version
82
82
  version: '0'
83
83
  - !ruby/object:Gem::Dependency
84
84
  name: rdiscount
85
85
  requirement: !ruby/object:Gem::Requirement
86
86
  requirements:
87
- - - '>='
87
+ - - ">="
88
88
  - !ruby/object:Gem::Version
89
89
  version: '0'
90
90
  type: :runtime
91
91
  prerelease: false
92
92
  version_requirements: !ruby/object:Gem::Requirement
93
93
  requirements:
94
- - - '>='
94
+ - - ">="
95
95
  - !ruby/object:Gem::Version
96
96
  version: '0'
97
97
  - !ruby/object:Gem::Dependency
98
98
  name: rake
99
99
  requirement: !ruby/object:Gem::Requirement
100
100
  requirements:
101
- - - '>='
101
+ - - ">="
102
102
  - !ruby/object:Gem::Version
103
103
  version: '0'
104
104
  type: :development
105
105
  prerelease: false
106
106
  version_requirements: !ruby/object:Gem::Requirement
107
107
  requirements:
108
- - - '>='
108
+ - - ">="
109
109
  - !ruby/object:Gem::Version
110
110
  version: '0'
111
111
  - !ruby/object:Gem::Dependency
112
112
  name: minitest
113
113
  requirement: !ruby/object:Gem::Requirement
114
114
  requirements:
115
- - - '>='
115
+ - - ">="
116
116
  - !ruby/object:Gem::Version
117
117
  version: '0'
118
118
  type: :development
119
119
  prerelease: false
120
120
  version_requirements: !ruby/object:Gem::Requirement
121
121
  requirements:
122
- - - '>='
122
+ - - ">="
123
123
  - !ruby/object:Gem::Version
124
124
  version: '0'
125
125
  - !ruby/object:Gem::Dependency
126
126
  name: rspec
127
127
  requirement: !ruby/object:Gem::Requirement
128
128
  requirements:
129
- - - ~>
129
+ - - "~>"
130
130
  - !ruby/object:Gem::Version
131
131
  version: '2'
132
132
  type: :development
133
133
  prerelease: false
134
134
  version_requirements: !ruby/object:Gem::Requirement
135
135
  requirements:
136
- - - ~>
136
+ - - "~>"
137
137
  - !ruby/object:Gem::Version
138
138
  version: '2'
139
139
  - !ruby/object:Gem::Dependency
140
140
  name: guard
141
141
  requirement: !ruby/object:Gem::Requirement
142
142
  requirements:
143
- - - '>='
143
+ - - ">="
144
144
  - !ruby/object:Gem::Version
145
145
  version: '0'
146
146
  type: :development
147
147
  prerelease: false
148
148
  version_requirements: !ruby/object:Gem::Requirement
149
149
  requirements:
150
- - - '>='
150
+ - - ">="
151
151
  - !ruby/object:Gem::Version
152
152
  version: '0'
153
153
  - !ruby/object:Gem::Dependency
154
154
  name: guard-bundler
155
155
  requirement: !ruby/object:Gem::Requirement
156
156
  requirements:
157
- - - '>='
157
+ - - ">="
158
158
  - !ruby/object:Gem::Version
159
159
  version: '0'
160
160
  type: :development
161
161
  prerelease: false
162
162
  version_requirements: !ruby/object:Gem::Requirement
163
163
  requirements:
164
- - - '>='
164
+ - - ">="
165
165
  - !ruby/object:Gem::Version
166
166
  version: '0'
167
167
  - !ruby/object:Gem::Dependency
168
168
  name: guard-minitest
169
169
  requirement: !ruby/object:Gem::Requirement
170
170
  requirements:
171
- - - '>='
171
+ - - ">="
172
172
  - !ruby/object:Gem::Version
173
173
  version: '0'
174
174
  type: :development
175
175
  prerelease: false
176
176
  version_requirements: !ruby/object:Gem::Requirement
177
177
  requirements:
178
- - - '>='
178
+ - - ">="
179
179
  - !ruby/object:Gem::Version
180
180
  version: '0'
181
181
  - !ruby/object:Gem::Dependency
182
182
  name: guard-rspec
183
183
  requirement: !ruby/object:Gem::Requirement
184
184
  requirements:
185
- - - '>='
185
+ - - ">="
186
186
  - !ruby/object:Gem::Version
187
187
  version: '0'
188
188
  type: :development
189
189
  prerelease: false
190
190
  version_requirements: !ruby/object:Gem::Requirement
191
191
  requirements:
192
- - - '>='
192
+ - - ">="
193
193
  - !ruby/object:Gem::Version
194
194
  version: '0'
195
195
  - !ruby/object:Gem::Dependency
196
196
  name: byebug
197
197
  requirement: !ruby/object:Gem::Requirement
198
198
  requirements:
199
- - - '>='
199
+ - - ">="
200
200
  - !ruby/object:Gem::Version
201
201
  version: '0'
202
202
  type: :development
203
203
  prerelease: false
204
204
  version_requirements: !ruby/object:Gem::Requirement
205
205
  requirements:
206
- - - '>='
206
+ - - ">="
207
207
  - !ruby/object:Gem::Version
208
208
  version: '0'
209
209
  - !ruby/object:Gem::Dependency
210
210
  name: bundler
211
211
  requirement: !ruby/object:Gem::Requirement
212
212
  requirements:
213
- - - ~>
213
+ - - "~>"
214
214
  - !ruby/object:Gem::Version
215
215
  version: '1.5'
216
216
  type: :development
217
217
  prerelease: false
218
218
  version_requirements: !ruby/object:Gem::Requirement
219
219
  requirements:
220
- - - ~>
220
+ - - "~>"
221
221
  - !ruby/object:Gem::Version
222
222
  version: '1.5'
223
223
  description: Create Canvas CC compatible file
@@ -410,17 +410,17 @@ require_paths:
410
410
  - lib
411
411
  required_ruby_version: !ruby/object:Gem::Requirement
412
412
  requirements:
413
- - - '>='
413
+ - - ">="
414
414
  - !ruby/object:Gem::Version
415
415
  version: '0'
416
416
  required_rubygems_version: !ruby/object:Gem::Requirement
417
417
  requirements:
418
- - - '>='
418
+ - - ">="
419
419
  - !ruby/object:Gem::Version
420
420
  version: '0'
421
421
  requirements: []
422
422
  rubyforge_project:
423
- rubygems_version: 2.4.6
423
+ rubygems_version: 2.4.3
424
424
  signing_key:
425
425
  specification_version: 4
426
426
  summary: Create Canvas CC compatible file
@@ -506,3 +506,4 @@ test_files:
506
506
  - test/unit/logger_test.rb
507
507
  - test/unit/migrator_test.rb
508
508
  - test/unit/resource_factory_test.rb
509
+ has_rdoc: