The infoRouter Ruby Gem

A Ruby interface to the infoRouter SOAP API

Installation

Add this line to your application's Gemfile:

gem 'inforouter'

And then execute:

$ bundle

Or install it yourself as:

$ gem install inforouter

Usage

Configure your environment. For example, create an initializer in Rails in config/initializers/inforouter.rb.

Inforouter.configure do |config|
  config.wsdl     = Rails.root.join('resources', 'inforouter.wsdl')
  config.host     = 'your_inforouter_host'
  config.username = 'your_inforouter_username'
  config.password = 'your_inforouter_password'
end

Using Inforouter

Creating an infoRouter folder using Inforouter::Folder.

folder = Inforouter::Folder.new path: '/Path/To/Folder'
folder.create unless folder.exists?
folder.description = 'Some description'
folder.update_properties

Make a SOAP request.

message = {
  :path => '/Path/To/Document',
  'withPropertySets' => 1,
  'withSecurity' => 0,
  'withOwner' => 0,
  'withVersions' => 0
}
response = Inforouter.client.request :get_document, message

Return all infoRouter users.

users = Inforouter::Users.all
users.each { |user| puts "#{user.id}\t#{user.name}" }

Return the specified user.

user = Inforouter::Users['JoeD']
puts user.name # => 'Joe Dimaggio'

Set the access list of a folder in the specified path.

folder = Inforouter::Folder.new path: '/Path/To/Folder'
access_list = Inforouter::AccessList.new
access_list.domain_members = Inforouter::AccessListDomainMembersItem.new(
  right: Inforouter::Rights::ADD_AND_READ
)
access_list.user_groups << Inforouter::AccessListUserGroupItem.new(
  name: 'Authors',
  right: Inforouter::Rights::ADD_AND_READ
)
access_list.user_groups << Inforouter::AccessListUserGroupItem.new(
  name: 'Developers',
  right: Inforouter::Rights::CHANGE
)
access_list.user_groups << Inforouter::AccessListUserGroupItem.new(
  domain: 'ProjectX',
  name: 'Architect',
  right: Inforouter::Rights::FULL_CONTROL
)
access_list.users << Inforouter::AccessListUserItem.new(
  domain: 'ProjectX',
  name: 'JoeD',
  right: Inforouter::Rights::ADD_AND_READ
)
access_list.users << Inforouter::AccessListUserItem.new(
  domain: 'ProjectX',
  name: 'JaneC',
  right: Inforouter::Rights::FULL_CONTROL
)
access_list.users << Inforouter::AccessListUserItem.new(
  name: 'SuzanP',
  right: Inforouter::Rights::FULL_CONTROL
)
folder.access_list = access_list
folder.update_access_list

The following constants are defined in rights.rb.

• NO_ACCESS
• LIST
• READ
• ADD
• ADD_AND_READ
• CHANGE
• FULL_CONTROL

Update a property set row on a folder.

class LetterRow < Inforouter::PropertyRow
  attr_accessor :letter_type
  attr_accessor :subject

  def to_hash
    {
      'RowNbr' => index + 1,
      'LetterType' => letter_type,
      'Subject' => subject
    }
  end
end

folder = Inforouter::Folder.new path: '/Path/To/Folder'
property_set = Inforouter::PropertySet.new name: 'LETTER'
property_set.rows << LetterRow.new(
  index: 0,
  letter_type: 'Business',
  subject: 'Subject 1 - updated subject. Lorem dolor sit amet.'
)
property_set.rows << LetterRow.new(
  index: 1,
  letter_type: 'Business',
  subject: 'Subject 2 - updated subject. Lorem Dolor Sit amet.'
)
folder.property_sets << property_set
folder.update_property_sets

Sets the rules of the specified folder.

folder = Inforouter::Folder.new path: '/Path/To/Folder'
folder.rules = Inforouter::Rules.new(
  allowable_file_types: 'BMP,DOC,JPG,XLS',
  checkins: false,
  checkouts: false,
  document_deletes: false,
  folder_deletes: false,
  new_documents: false,
  new_folders: false,
  classified_documents: true
)
folder.update_rules

Boolean rule items default to false and may be omitted.

folder = Inforouter::Folder.new path: '/Path/To/Folder'
folder.rules = Inforouter::Rules.new(
  allowable_file_types: 'BMP,DOC,JPG,XLS',
  classified_documents: true
)
folder.update_rules

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Copyright

Copyright (c) 2014 NCS Software. See LICENSE for further details.