inforouter 0.1.0 → 0.2.0

data/lib/inforouter/responses/create_folder.rb

@@ -0,0 +1,10 @@
+module Inforouter #:nodoc:
+  module Responses #:nodoc:
+    # Response to an infoRouter Create Folder API call.
+    #
+    # See http://www.inforouter.com/web-services-80/default.aspx?op=CreateFolder
+    class CreateFolder < Generic
+      response_key :create_folder
+    end
+  end
+end

data/lib/inforouter/responses/delete_folder.rb

@@ -0,0 +1,10 @@
+module Inforouter #:nodoc:
+  module Responses #:nodoc:
+    # Response to an infoRouter Delete Folder API call.
+    #
+    # See http://www.inforouter.com/web-services-80/default.aspx?op=DeleteFolder
+    class DeleteFolder < Generic
+      response_key :delete_folder
+    end
+  end
+end

data/lib/inforouter/responses/document.rb

@@ -0,0 +1,48 @@
+module Inforouter #:nodoc:
+  module Responses #:nodoc:
+    # Response to an infoRouter Get Document API call.
+    #
+    # See http://www.inforouter.com/web-services-80/default.aspx?op=GetDocument
+
+    class Document < Base
+      response_success 'get_document_response/get_document_result/response/@success'
+      error_message 'get_document_response/get_document_result/response/@error'
+
+      class << self
+        # Parse an infoRouter response.
+        #
+        # @param savon_response [Savon::Response] SOAP response.
+        #
+        # @return [Inforouter::Document]
+        def parse(savon_response)
+          response = new(savon_response)
+          document = response.match('get_document_response/get_document_result/response/document')
+          Inforouter::Document.new(
+            :document_id => document[:@document_id].to_i,
+            :name => document[:@name].strip,
+            :path => document[:@path].strip,
+            :description => document[:@description].strip,
+            :update_instructions => document[:@update_instructions].strip,
+            :creation_date => parse_datetime(document[:@creation_date]),
+            :modification_date => parse_datetime(document[:@modification_date]),
+            :checkout_date => parse_datetime(document[:@checkout_date]),
+            :checkout_by => document[:@checkout_by].strip,
+            :checkout_by_user_name => document[:@checkout_by_user_name].strip,
+            :size => document[:@size].to_i,
+            :type => document[:@type].strip,
+            :percent_complete => document[:@percent_complete].to_i,
+            :importance => document[:@importance].strip,
+            :retention_date => parse_datetime(document[:@retention_date]),
+            :disposition_date => parse_datetime(document[:@disposition_date]),
+            :expiration_date => parse_datetime(document[:@expiration_date]),
+            :register_date => parse_datetime(document[:@register_date]),
+            :registered_by => document[:@registered_by].strip,
+            :doc_type_id => document[:@doc_type_id].to_i,
+            :doc_type_name => document[:@doc_type_name].strip,
+            :version_number => document[:@version_number].to_i,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/inforouter/responses/document_exists.rb

@@ -0,0 +1,10 @@
+module Inforouter #:nodoc:
+  module Responses #:nodoc:
+    # Response to an infoRouter Document Exists API call.
+    #
+    # See http://www.inforouter.com/web-services-80/default.aspx?op=DocumentExists
+    class DocumentExists < Generic
+      response_key :document_exists
+    end
+  end
+end

data/lib/inforouter/responses/folder.rb

@@ -0,0 +1,33 @@
+module Inforouter #:nodoc:
+  module Responses #:nodoc:
+    # Response to an infoRouter Get Folder API call.
+    #
+    # See http://www.inforouter.com/web-services-80/default.aspx?op=GetFolder
+    class Folder < Base
+      response_success 'get_folder_response/get_folder_result/response/@success'
+      error_message 'get_folder_response/get_folder_result/response/@error'
+
+      class << self
+        # Parse an infoRouter response.
+        #
+        # @param savon_response [Savon::Response] SOAP response.
+        #
+        # @return [Inforouter::Folder]
+        def parse(savon_response)
+          response = new(savon_response)
+          folder = response.match('get_folder_response/get_folder_result/response/folder')
+          Inforouter::Folder.new(
+            :folder_id => folder[:@folder_id].to_i,
+            :parent_id => folder[:@parent_id].to_i,
+            :name => folder[:@name].strip,
+            :path => folder[:@path].strip,
+            :description => folder[:@description].strip,
+            :creation_date => parse_datetime(folder[:@creation_date]),
+            :owner_name => folder[:@owner_name].strip,
+            :domain_id => folder[:@domain_id].to_i
+          )
+        end
+      end
+    end
+  end
+end

data/lib/inforouter/responses/folder_exists.rb

@@ -0,0 +1,10 @@
+module Inforouter #:nodoc:
+  module Responses #:nodoc:
+    # Response to an infoRouter Folder Exists API call.
+    #
+    # See http://www.inforouter.com/web-services-80/default.aspx?op=FolderExists
+    class FolderExists < Generic
+      response_key :folder_exists
+    end
+  end
+end

data/lib/inforouter/responses/generic.rb

@@ -0,0 +1,28 @@
+module Inforouter #:nodoc:
+  module Responses #:nodoc:
+    # A generic response to an infoRouter API call.
+    class Generic < Base
+      # Response key.
+      class_attribute :key
+
+      class << self
+        # Set the response key.
+        #
+        # @param key [String]
+        def response_key(key)
+          self.key = key
+          response_success "#{key}_response/#{key}_result/response/@success"
+          error_message "#{key}_response/#{key}_result/response/@error"
+        end
+
+        # Parse an infoRouter response.
+        #
+        # @param savon_response [Savon::Response]
+        def parse(savon_response)
+          response = new(savon_response)
+          response.raw["#{key}_response".to_sym]["#{key}_result".to_sym][:response]
+        end
+      end
+    end
+  end
+end

data/lib/inforouter/responses/set_access_list.rb

@@ -0,0 +1,10 @@
+module Inforouter #:nodoc:
+  module Responses #:nodoc:
+    # Response to an infoRouter Set Access List API call.
+    #
+    # See http://www.inforouter.com/web-services-80/default.aspx?op=SetAccessList
+    class SetAccessList < Generic
+      response_key :set_access_list
+    end
+  end
+end

data/lib/inforouter/responses/set_folder_rules.rb

@@ -0,0 +1,10 @@
+module Inforouter #:nodoc:
+  module Responses #:nodoc:
+    # Response to an infoRouter Set Folder Rules API call.
+    #
+    # See http://www.inforouter.com/web-services-80/default.aspx?op=SetFolderRules
+    class SetFolderRules < Generic
+      response_key :set_folder_rules
+    end
+  end
+end

data/lib/inforouter/responses/update_folder_properties.rb

@@ -0,0 +1,10 @@
+module Inforouter #:nodoc:
+  module Responses #:nodoc:
+    # Response to an infoRouter Update Folder Properties API call.
+    #
+    # See http://www.inforouter.com/web-services-80/default.aspx?op=UpdateFolderProperties
+    class UpdateFolderProperties < Generic
+      response_key :update_folder_properties
+    end
+  end
+end

data/lib/inforouter/responses/update_property_set_definition.rb

@@ -0,0 +1,10 @@
+module Inforouter #:nodoc:
+  module Responses #:nodoc:
+    # Response to an infoRouter Update Property Set Definition API call.
+    #
+    # See http://www.inforouter.com/web-services-80/default.aspx?op=UpdatePropertySetDefinition
+    class UpdatePropertySetDefinition < Generic
+      response_key :update_property_set_definition
+    end
+  end
+end

data/lib/inforouter/responses/update_property_set_row.rb

@@ -0,0 +1,10 @@
+module Inforouter #:nodoc:
+  module Responses #:nodoc:
+    # Response to an infoRouter Update Property Set Row API call.
+    #
+    # See http://www.inforouter.com/web-services-80/default.aspx?op=UpdatePropertySetRow
+    class UpdatePropertySetRow < Generic
+      response_key :update_property_set_row
+    end
+  end
+end

data/lib/inforouter/responses/users.rb

@@ -0,0 +1,38 @@
+module Inforouter #:nodoc:
+  module Responses #:nodoc:
+    # Response to an infoRouter Get All Users API call.
+    #
+    # See http://www.inforouter.com/web-services-80/default.aspx?op=GetAllUsers
+    class Users < Base
+      response_success 'get_all_users_response/get_all_users_result/response/@success'
+      error_message 'get_all_users_response/get_all_users_result/response/@error'
+
+      class << self
+        # Parse an infoRouter response.
+        #
+        # @param savon_response [Savon::Response] SOAP response.
+        #
+        # @return [Array]
+        def parse(savon_response)
+          response = new(savon_response)
+          users = response.match('get_all_users_response/get_all_users_result/response/users/user')
+          users.map do |user|
+            Inforouter::User.new(
+              :user_id => user[:@user_id].to_i,
+              :domain => user[:@domain].strip,
+              :user_name => user[:@user_name].strip,
+              :first_name => user[:@first_name].strip,
+              :last_name => user[:@last_name].strip,
+              :last_logon => DateTime.strptime(user[:@last_logon_date], '%Y-%m-%d %H:%M:%S'),
+              :last_password_change => DateTime.strptime(user[:@last_password_change_date], '%Y-%m-%d %H:%M:%S'),
+              :authentication_authority => user[:@authentication_authority].strip,
+              :read_only => user[:@read_only_user] == 'TRUE',
+              :email => user[:@email].strip,
+              :enabled => user[:@enabled] == 'TRUE'
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inforouter/rights.rb

@@ -0,0 +1,18 @@
+module Inforouter
+  class Rights
+    # No Access
+    NO_ACCESS = 0
+    # List
+    LIST = 1
+    # Read
+    READ = 2
+    # Add
+    ADD = 3
+    # Add and Read
+    ADD_AND_READ = 4
+    # Change
+    CHANGE = 5
+    # Full Control
+    FULL_CONTROL = 6
+  end
+end

data/lib/inforouter/rule_item.rb

@@ -0,0 +1,25 @@
+module Inforouter
+  class RuleItem < Record
+    # Rule item name.
+    attr_accessor :name
+    # Rule item value.
+    attr_accessor :value
+
+    # @return [Hash]
+    def to_hash
+      {
+        :Name => name,
+        :Value => value
+      }
+    end
+
+    # @return [String]
+    def value
+      if !!@value == @value
+        @value ? 'allows' : 'disallows'
+      else
+        @value
+      end
+    end
+  end
+end

data/lib/inforouter/rules.rb

@@ -0,0 +1,51 @@
+module Inforouter
+  class Rules
+    # Array of <tt>Inforouter::RuleItem</tt>s.
+    attr_accessor :rules
+
+    def initialize(params = {})
+      params = {
+        :allowable_file_types => '',
+        :checkins => false,
+        :checkouts => false,
+        :document_deletes => false,
+        :folder_deletes => false,
+        :new_documents => false,
+        :new_folders => false,
+        :classified_documents => false
+      }.merge(params)
+      @rules = []
+      params.each do |key, value|
+        @rules << Inforouter::RuleItem.new(
+          :name => key.to_s.camelize,
+          :value => value
+        )
+      end
+    end
+
+    # The Rules XML fragment should be as described below.
+    # The Rule item that is not specified in the xml structure will not be
+    # updated.
+    # For the AllowableFileTypes set value attribute to comman delimited file
+    # extensions or set value to "*" for allowing all file types.
+    #
+    # <Rules>
+    #   <Rule Name="AllowableFileTypes" Value="BMP,DOC,JPG,XLS" />
+    #   <Rule Name="Checkins" Value="disallows" />
+    #   <Rule Name="Checkouts" Value="disallows" />
+    #   <Rule Name="DocumentDeletes" Value="disallows" />
+    #   <Rule Name="FolderDeletes" Value="disallows" />
+    #   <Rule Name="NewDocuments" Value="disallows" />
+    #   <Rule Name="NewFolders" Value="disallows" />
+    #   <Rule Name="ClassifiedDocuments" Value="allows" />
+    # </Rules>
+    def to_xml
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.Rules do
+          rules.each { |rule| xml.Rules(rule.to_hash) }
+        end
+      end
+      builder.doc.root.to_xml
+    end
+  end
+end

data/lib/inforouter/user.rb

@@ -0,0 +1,39 @@
+module Inforouter #:nodoc:
+  # A <tt>User</tt> defines an infoRouter user.
+  class User < Record
+    # User ID.
+    attr_accessor :user_id
+    # User domain.
+    attr_accessor :domain
+    # User username.
+    attr_accessor :user_name
+    # User first name.
+    attr_accessor :first_name
+    # User last name.
+    attr_accessor :last_name
+    # User email.
+    attr_accessor :email
+    # User last login date
+    attr_accessor :last_logon
+    # User last password change
+    attr_accessor :last_password_change
+    # User authentication authority.
+    attr_accessor :authentication_authority
+    # User read only.
+    attr_accessor :read_only
+    # User enabled.
+    attr_accessor :enabled
+
+    def read_only?
+      @read_only
+    end
+
+    def enabled?
+      @enabled
+    end
+
+    def name
+      [@first_name, @last_name].join(' ').strip
+    end
+  end
+end

data/lib/inforouter/users.rb

@@ -0,0 +1,25 @@
+module Inforouter #:nodoc:
+  class Users
+    class << self
+      # All users.
+      #
+      # @return [Hash]
+      def all
+        @users ||= begin
+          response = Inforouter.client.request :get_all_users
+          users = Inforouter::Responses::Users.parse response
+          Hash[users.map { |user| [user.user_name, user] }]
+        end
+      end
+
+      # Lookup a user by user name.
+      #
+      # @param user_name [String]
+      #
+      # @return [Inforouter::User]
+      def [](user_name)
+        all[user_name]
+      end
+    end
+  end
+end

data/lib/inforouter/version.rb

@@ -1,7 +1,7 @@
 module Inforouter
   class Version
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     PATCH = 0
     PRE = nil
 

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+require 'inforouter'
+require 'test_setup'

data/test/test_client.rb

@@ -0,0 +1,4 @@
+require 'helper'
+
+class TestClient < TestSetup
+end

data/test/test_configuration.rb

@@ -0,0 +1,31 @@
+require 'helper'
+
+class TestConfiguration < TestSetup
+  def setup
+    Inforouter.setup!
+  end
+
+  def test_missing_configuration
+    assert_raise Inforouter::Errors::MissingConfig do
+      Inforouter.client.request :dummy, :body => {}
+    end
+  end
+
+  def test_missing_host
+    Inforouter.configure do |config|
+      config.username = 'inforouter_username'
+    end
+    assert_raise Inforouter::Errors::MissingConfigOption do
+      Inforouter.client.request :dummy, :body => {}
+    end
+  end
+
+  def test_missing_username
+    Inforouter.configure do |config|
+      config.host = 'inforouter_host'
+    end
+    assert_raise Inforouter::Errors::MissingConfigOption do
+      Inforouter.client.request :dummy, :body => {}
+    end
+  end
+end