Class: Reactor::Cm::Obj

Inherits:
Object
  • Object
show all
Defined in:
lib/reactor/cm/obj.rb

Constant Summary collapse

OBJ_ATTRS = 
[:permalink, :objClass, :workflowName, :name, :suppressExport, :parent]
ATTR_LENGTH_CONSTRAINT = 
{:name => 250, :title => 250}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#obj_id ⇒ Object (readonly)

Returns the value of attribute obj_id.



5
6
7
 
# File 'lib/reactor/cm/obj.rb', line 5

def obj_id
  @obj_id
end

Class Method Details

.create(name, parent, objClass) ⇒ Object 



9
10
11
12
13
 
# File 'lib/reactor/cm/obj.rb', line 9

def self.create(name, parent, objClass)
  obj = Obj.new(name)
  obj.send(:create, parent, objClass)
  obj
end

.delete_where(conditions) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/reactor/cm/obj.rb', line 36

def self.delete_where(conditions)
  request = XmlRequest.prepare do |xml|

    xml.tag!('obj-where') do
      conditions.each do |key, value|
        xml.tag!(key, value)
      end
    end
    xml.tag!("obj-delete")
  end
  request.execute!
end

.exists?(path_or_id) ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
18
19
20
21
22
 
# File 'lib/reactor/cm/obj.rb', line 15

def self.exists?(path_or_id)
  obj = Obj.new
  begin
    obj.send(:load, path_or_id).ok?
  rescue
    return false
  end
end

.get(path_or_id) ⇒ Object 



30
31
32
33
34
 
# File 'lib/reactor/cm/obj.rb', line 30

def self.get(path_or_id)
  obj = Obj.new
  obj.send(:load, path_or_id)
  obj
end

.load(id) ⇒ Object 



24
25
26
27
28
 
# File 'lib/reactor/cm/obj.rb', line 24

def self.load(id)
  obj = Obj.new
  obj.instance_variable_set('@obj_id', id)
  obj
end

Instance Method Details

#commit! ⇒ Object 



205
206
207
 
# File 'lib/reactor/cm/obj.rb', line 205

def commit!
  simple_command("commit")
end

#copy(new_parent, recursive = false, new_name = nil) ⇒ Object 



226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/reactor/cm/obj.rb', line 226

def copy(new_parent, recursive = false, new_name = nil)
  request = XmlRequest.prepare do |xml|
    xml.tag!('obj-where') do
      xml.tag!("id", @obj_id)
    end
    xml.tag!("obj-copy") do
      xml.tag!("parent", new_parent)
      xml.tag!("name", new_name) if new_name
      xml.tag!("recursive", "1") if recursive
    end
  end
  response = request.execute!
  response.xpath("//obj/id").text
end

#delete! ⇒ Object 



241
242
243
 
# File 'lib/reactor/cm/obj.rb', line 241

def delete!
  simple_command("delete")
end

#edit! ⇒ Object 



193
194
195
 
# File 'lib/reactor/cm/obj.rb', line 193

def edit!
  simple_command("edit")
end

#edited? ⇒ Boolean

Returns:

  • (Boolean) 


273
274
275
276
277
278
279
280
 
# File 'lib/reactor/cm/obj.rb', line 273

def edited?
  request = XmlRequest.prepare do |xml|
    xml.where_key_tag!(base_name, 'id', @obj_id)
    xml.get_key_tag!(base_name, 'isEdited')
  end
  response = request.execute!
  response.xpath("//isEdited").text == "1"
end

#edited_content ⇒ Object 



307
308
309
310
311
312
313
314
 
# File 'lib/reactor/cm/obj.rb', line 307

def edited_content
  request = XmlRequest.prepare do |xml|
    xml.where_key_tag!(base_name, 'id', @obj_id)
    xml.get_key_tag!(base_name, 'editedContent')
  end
  response = request.execute!
  response.xpath("//editedContent").text
end

#editor ⇒ Object 



295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/reactor/cm/obj.rb', line 295

def editor
  request = XmlRequest.prepare do |xml|
    xml.tag!('content-where') do
      xml.tag!('objectId', @obj_id)
      xml.tag!('state', 'edited')
    end
    xml.get_key_tag!('content', 'editor')
  end
  response = request.execute!
  response.xpath('//editor').text
end

#forward! ⇒ Object 



201
202
203
 
# File 'lib/reactor/cm/obj.rb', line 201

def forward!
  simple_command("forward")
end

#get(key) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/reactor/cm/obj.rb', line 57

def get(key)
  request = XmlRequest.prepare do |xml|
    xml.where_key_tag!(base_name, 'id', @obj_id)
    xml.get_key_tag!(base_name, key)
  end
  response = request.execute!
  result = response.xpath("//#{key}")
  if result.children.map {|i| i.respond_to?(:name) && (i.name == "listitem") }.reduce(:&)
    result.children.map {|i| i.text.to_s }
  else
    result = result.text unless result.is_a? Array
    result
  end
end

#get_links(attr) ⇒ Object 



120
121
122
 
# File 'lib/reactor/cm/obj.rb', line 120

def get_links(attr)
  get_link_ids(attr).map {|id| Link.get(id)}
end

#path ⇒ Object 



264
265
266
267
268
269
270
271
 
# File 'lib/reactor/cm/obj.rb', line 264

def path
  request = XmlRequest.prepare do |xml|
    xml.where_key_tag!(base_name, 'id', @obj_id)
    xml.get_key_tag!(base_name, 'path')
  end
  response = request.execute!
  response.xpath("//obj/path").text
end

#permission_clear(permission) ⇒ Object 



116
117
118
 
# File 'lib/reactor/cm/obj.rb', line 116

def permission_clear(permission)
  self.permission_set(permission, [])
end

#permission_grant(permission, groups) ⇒ Object 



108
109
110
 
# File 'lib/reactor/cm/obj.rb', line 108

def permission_grant(permission, groups)
  self.permission_command('GrantTo', permission, groups)
end

#permission_granted_to(user, permission) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/reactor/cm/obj.rb', line 82

def permission_granted_to(user, permission)
  request = XmlRequest.prepare do |xml|
    xml.where_key_tag!(base_name, 'id', @obj_id)
    xml.get_tag!(base_name) do
      xml.tag!('permissionGrantedTo', :permission => permission, :user => user)
    end
  end
  response = request.execute!
  response.xpath("//permissionGrantedTo/text()") == "1"
end

#permission_revoke(permission, groups) ⇒ Object 



112
113
114
 
# File 'lib/reactor/cm/obj.rb', line 112

def permission_revoke(permission, groups)
  self.permission_command('RevokeFrom', permission, groups)
end

#permission_set(permission, groups) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/reactor/cm/obj.rb', line 93

def permission_set(permission, groups)
  request = XmlRequest.prepare do |xml|
    xml.where_key_tag!(base_name, :id, @obj_id)

    options = {
      :permission => permission,
      :type => :list,
    }

    xml.set_key_tag!(base_name, :permission, groups, options)
  end

  request.execute!
end

#reasons_for_incomplete_state ⇒ Object 



282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/reactor/cm/obj.rb', line 282

def reasons_for_incomplete_state
  request = XmlRequest.prepare do |xml|
    xml.tag!('content-where') do
      xml.tag!('objectId', @obj_id)
      xml.tag!('state', 'edited')
    end
    xml.get_key_tag!('content', 'reasonsForIncompleteState')
  end
  response = request.execute!
  result = response.xpath('//reasonsForIncompleteState/*')
  result.kind_of?(Array) ? result.map(&:text).map(&:to_s) : [result.to_s]
end

#reject! ⇒ Object 



209
210
211
 
# File 'lib/reactor/cm/obj.rb', line 209

def reject!
  simple_command("reject")
end

#release! ⇒ Object 



189
190
191
 
# File 'lib/reactor/cm/obj.rb', line 189

def release!
  simple_command("release")
end

#remove_active_contents! ⇒ Object 



245
246
247
 
# File 'lib/reactor/cm/obj.rb', line 245

def remove_active_contents!
  simple_command("removeActiveContents")
end

#remove_archived_contents! ⇒ Object 



249
250
251
 
# File 'lib/reactor/cm/obj.rb', line 249

def remove_archived_contents!
  simple_command("removeArchivedContents")
end

#resolve_refs! ⇒ Object 



253
254
255
256
257
258
259
260
261
262
 
# File 'lib/reactor/cm/obj.rb', line 253

def resolve_refs!
  request = XmlRequest.prepare do |xml|
    xml.tag!('content-where') do
      xml.tag!('objectId', @obj_id)
      xml.tag!('state', 'edited')
    end
    xml.tag!('content-resolveRefs')
  end
  response = request.execute!
end

#revert! ⇒ Object 



213
214
215
 
# File 'lib/reactor/cm/obj.rb', line 213

def revert!
  simple_command("revert")
end

#save! ⇒ Object 



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/reactor/cm/obj.rb', line 143

def save!
  edit! if not edited?
  content = edited_content
  @request = XmlRequest.prepare do |xml|
    xml.where_key_tag!('content', 'id', content)
    xml.tag!("content-set") do
      @attrs.each do |key, value|
        if (@attr_options[key] || {})[:cdata]
          xml.tag!(key.to_s) do
            xml.cdata!(value)
          end
        else
          xml.value_tag!(key.to_s, value)
        end
      end
    end
  end
  response = @request.execute!
  return response if !response.ok?

  unless @obj_attrs.empty?
    request = XmlRequest.prepare do |xml|
      xml.where_key_tag!(base_name, 'id', @obj_id)
      xml.set_tag!(base_name) do
        @obj_attrs.each do |key, value|
          xml.value_tag!(key, value)
        end
      end
    end
    response = request.execute!
  end

  return response if !response.ok?

  @removed_links.each do |link|
    link.delete!
  end

  @links.each do |attr, links|
    links.each do |link|
      link.save!
    end
  end
end

#set(key, value, options = {}) ⇒ Object 



72
73
74
75
76
77
78
79
80
 
# File 'lib/reactor/cm/obj.rb', line 72

def set(key, value, options={})
  key = key.to_sym
  value = value[0, ATTR_LENGTH_CONSTRAINT[key]] if ATTR_LENGTH_CONSTRAINT[key]
  if OBJ_ATTRS.include?(key) then @obj_attrs[key] = value
  else
    @attrs[key] = value
  end
  @attr_options[key] = options
end

#set_link(attr, path) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/reactor/cm/obj.rb', line 131

def set_link(attr, path)
  old_links = get_links(attr)
  if old_links.length == 1
    old_link = old_links.first
    old_link.dest_url = path
    @links[attr] = [old_link]
  else
    @removed_links = old_links
    @links[attr] = [Link.create_inside(self, attr, path)]
  end
end

#set_links(attr, new_links_as_hashes) ⇒ Object 



124
125
126
127
128
129
 
# File 'lib/reactor/cm/obj.rb', line 124

def set_links(attr, new_links_as_hashes)
  get_links(attr).map(&:delete!)
  new_links_as_hashes.each do |link_hash|
    Link.create_inside(self, attr, link_hash[:destination_url], link_hash[:title])
  end
end

#sign! ⇒ Object 



217
218
219
 
# File 'lib/reactor/cm/obj.rb', line 217

def sign!
  simple_command("sign")
end

#take! ⇒ Object 



197
198
199
 
# File 'lib/reactor/cm/obj.rb', line 197

def take!
  simple_command("take")
end

#upload(data_or_io, extension) ⇒ Object 



49
50
51
52
53
54
55
 
# File 'lib/reactor/cm/obj.rb', line 49

def upload(data_or_io, extension)
  data = (data_or_io.kind_of?IO) ? data_or_io.read : data_or_io
  base64_data = Base64.encode64(data)

  set(:contentType, extension)
  set(:blob, {base64_data=>{:encoding=>'base64'}})
end

#valid_actions ⇒ Object 



221
222
223
224
 
# File 'lib/reactor/cm/obj.rb', line 221

def valid_actions
  vcak = get('validControlActionKeys')
  (vcak || []).map(&:to_s)
end