inforouter 0.1.0 → 0.2.0

data/lib/inforouter/configuration.rb

@@ -1,13 +1,19 @@
 module Inforouter #:nodoc:
-  # Inforouter gem configuration.
+  # infoRouter gem configuration.
   class Configuration
-    # Inforouter host.
+    # infoRouter WSDL.
+    attr_accessor :wsdl
+    # infoRouter host.
     attr_accessor :host
-    # Inforouter username.
+    # infoRouter username.
     attr_accessor :username
-    # Inforouter password.
+    # infoRouter password.
     attr_accessor :password
 
+    def initialize(options = {})
+      @wsdl = options[:wsdl] || File.dirname(__FILE__) + '/../../resources/inforouter.wsdl'
+    end
+
     # Check the configuration.
     #
     # Will raise a Inforouter::Errors::MissingConfigOption if any of the host or

data/lib/inforouter/document.rb

@@ -0,0 +1,64 @@
+module Inforouter #:nodoc
+  class Document < Record
+    # Document ID.
+    attr_accessor :document_id
+    # Document name.
+    attr_accessor :name
+    # Document path.
+    attr_accessor :path
+    # Document description.
+    attr_accessor :description
+    # Document update instructions.
+    attr_accessor :update_instructions
+    # Document creation date.
+    attr_accessor :creation_date
+    # Document modification date.
+    attr_accessor :modification_date
+    # Document checkout date.
+    attr_accessor :checkout_date
+    # Document checkout by.
+    attr_accessor :checkout_by
+    # Document checkout by user name.
+    attr_accessor :checkout_by_user_name
+    # Document size.
+    attr_accessor :size
+    # Document type.
+    attr_accessor :type
+    # Document percent complete.
+    attr_accessor :percent_complete
+    # Document completion date.
+    attr_accessor :completion_date
+    # Document importance.
+    attr_accessor :importance
+    # Document retention date.
+    attr_accessor :retention_date
+    # Document disposition date.
+    attr_accessor :disposition_date
+    # Document expiration date.
+    attr_accessor :expiration_date
+    # Document register date.
+    attr_accessor :register_date
+    # Document registered by.
+    attr_accessor :registered_by
+    # Document doc type ID.
+    attr_accessor :doc_type_id
+    # Document doc type name.
+    attr_accessor :doc_type_name
+    # Document version number.
+    attr_accessor :version_number
+
+    # @return [Boolean]
+    def exists?
+      response = Inforouter.client.request :document_exists, path_params
+      result = Inforouter::Responses::DocumentExists.parse response
+      result[:@success] == 'true'
+    end
+
+    private
+
+    # @return [Hash]
+    def path_params
+      { :path => path }
+    end
+  end
+end

data/lib/inforouter/errors.rb

@@ -2,3 +2,5 @@ require 'inforouter/errors/inforouter_error'
 require 'inforouter/errors/missing_config_error'
 require 'inforouter/errors/missing_config_option_error'
 require 'inforouter/errors/soap_error'
+require 'inforouter/errors/unexpected_soap_response_error.rb'
+require 'inforouter/errors/api_error'

data/lib/inforouter/errors/api_error.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+module Inforouter #:nodoc:
+  module Errors #:nodoc:
+    # This error is raised when the infoRouter service
+    # returns an error from an API.
+    class ApiError < InforouterError
+      # @param message [String] Error message.
+      # @param raw [String] Raw data from the SOAP response.
+      def initialize(message, raw)
+        super(compose_message('api_error',
+                              :message => message,
+                              :raw => raw
+        ))
+      end
+    end
+  end
+end

data/lib/inforouter/errors/inforouter_error.rb

@@ -1,8 +1,84 @@
 # encoding: utf-8
 module Inforouter #:nodoc:
   module Errors #:nodoc:
-    # Default parent Inforouter error for all custom errors.
+    # Default parent infoRouter error for all custom errors. This handles the
+    # base key for the translations and provides the convenience method for
+    # translating the messages.
+    #
+    # Generously borrowed from Mongoid[https://github.com/mongoid/mongoid/blob/master/lib/mongoid/errors/mongoid_error.rb].
     class InforouterError < StandardError
+      BASE_KEY = 'inforouter.errors.messages' #:nodoc:
+
+      # Compose the message.
+      #
+      # @example Create the message.
+      #   error.compose_message
+      #
+      # @return [String] The composed message.
+      def compose_message(key, attributes = {})
+        @problem = problem(key, attributes)
+        @summary = summary(key, attributes)
+        @resolution = resolution(key, attributes)
+
+        "\nProblem:\n  #{@problem}" +
+        "\nSummary:\n  #{@summary}" +
+        "\nResolution:\n  #{@resolution}"
+      end
+
+      private
+
+      # Given the key of the specific error and the options hash, translate the
+      # message.
+      #
+      # @example Translate the message.
+      #   error.translate("errors", :key => value)
+      #
+      # @param key [String] The key of the error in the locales.
+      # @param options [Hash] The objects to pass to create the message.
+      #
+      # @return [String] A localized error message string.
+      def translate(key, options)
+        ::I18n.translate("#{BASE_KEY}.#{key}", options)
+      end
+
+      # Create the problem.
+      #
+      # @example Create the problem.
+      #   error.problem("error", {})
+      #
+      # @param key [String, Symbol] The error key.
+      # @param attributes [Hash] The attributes to interpolate.
+      #
+      # @return [String] The problem.
+      def problem(key, attributes)
+        translate("#{key}.message", attributes)
+      end
+
+      # Create the summary.
+      #
+      # @example Create the summary.
+      #   error.summary("error", {})
+      #
+      # @param key [String, Symbol] The error key.
+      # @param attributes [Hash] The attributes to interpolate.
+      #
+      # @return [String] The summary.
+      def summary(key, attributes)
+        translate("#{key}.summary", attributes)
+      end
+
+      # Create the resolution.
+      #
+      # @example Create the resolution
+      #   error.resolution("error", {})
+      #
+      # @param key [String, Symbol] The error key.
+      # @param attributes [Hash] The attributes to interpolate.
+      #
+      # @return [String] The resolution.
+      def resolution(key, attributes)
+        translate("#{key}.resolution", attributes)
+      end
     end
   end
 end

data/lib/inforouter/errors/missing_config_error.rb

@@ -2,7 +2,7 @@
 module Inforouter #:nodoc:
   module Errors #:nodoc:
     # This error is raised when attempting to create a new client without
-    # configuring Inforouter.
+    # configuring infoRouter.
     class MissingConfigError < InforouterError
       # Create a new error.
       def initialize

data/lib/inforouter/errors/missing_config_option_error.rb

@@ -3,7 +3,7 @@ module Inforouter #:nodoc:
   module Errors #:nodoc:
     # This error is raised when a configuration option is missing.
     class MissingConfigOption < InforouterError
-      # @params name [String]
+      # @param name [String]
       def initialize(name)
         super(compose_message('missing_config_option', :name => name))
       end

data/lib/inforouter/errors/soap_error.rb

@@ -20,7 +20,8 @@ module Inforouter #:nodoc:
 
       private
 
-      # @params fault_string [String]
+      # @param fault_string [String]
+      #
       # @return [String]
       def parse_fault(fault_string)
         fault_string.lines.first.strip

data/lib/inforouter/errors/unexpected_soap_response_error.rb

@@ -0,0 +1,18 @@
+# encoding utf-8
+module Inforouter #:nodoc:
+  module Errors #:nodoc:
+    # This error is raised when infoRouter returns an unexpected SOAP response.
+    class UnexpectedSOAPResponse < InforouterError
+      # @param raw [String] Raw data from the SOAP response.
+      # @param key [String] Expected key in the SOAP response.
+      # @param chain [String] Complete SOAP response chain in which the key could not be found.
+      def initialize(raw, key, chain)
+        super(compose_message('unexpected_soap_response',
+                              :key => key,
+                              :raw => raw,
+                              :chain => chain
+        ))
+      end
+    end
+  end
+end

data/lib/inforouter/folder.rb

@@ -0,0 +1,139 @@
+module Inforouter #:nodoc:
+  # A <tt>Folder</tt> defines an infoRouter folder.
+  class Folder < Record
+    # Folder ID.
+    attr_accessor :folder_id
+    # Folder parent ID.
+    attr_accessor :parent_id
+    # Folder name.
+    attr_accessor :name
+    # Folder path.
+    attr_accessor :path
+    # Folder description.
+    attr_accessor :description
+    # Folder creation date.
+    attr_accessor :creation_date
+    # Folder owner name.
+    attr_accessor :owner_name
+    # Folder domain ID.
+    attr_accessor :domain_id
+    # Folder access list.
+    attr_accessor :access_list
+    # Folder rules.
+    attr_accessor :rules
+    # Folder folders. Array of <tt>Inforouter::Folder</tt>s.
+    attr_accessor :folders
+    # Folder documents. Array of <tt>Inforouter::Document</tt>s.
+    attr_accessor :documents
+
+    def initialize(params = {})
+      params = {
+        :folders = [],
+        :documents = []
+      }.merge(params)
+      super params
+    end
+
+    # @return [String]
+    def description
+      @description ||= begin
+        response = Inforouter.client.request :get_folder, folder_params
+        folder = Inforouter::Responses::Folder.parse response
+        @description = folder.description
+      end
+    end
+
+    # Setting the path also sets the name if not already set.
+    def path=(path)
+      @name ||= path.split('/').last
+      @path = path
+    end
+
+    # @return [Boolean]
+    def create
+      response = Inforouter.client.request :create_folder, path_params
+      result = Inforouter::Responses::CreateFolder.parse response
+      result[:@success] == 'true'
+    end
+
+    # @return [Boolean]
+    def exists?
+      response = Inforouter.client.request :folder_exists, path_params
+      result = Inforouter::Responses::FolderExists.parse response
+      result[:@success] == 'true'
+    end
+
+    # @return [Array<Inforouter::Folder>]
+    def folders
+      @folders ||= begin
+        response = Inforouter.client.request :get_folders_and_documents, folders_and_documents_params
+        @folders, @documents = Inforouter::Responses::FoldersDocuments.parse response
+        @folders
+      end
+    end
+
+    # @return [Array<Inforouter::Document>]
+    def documents
+      @documents ||= begin
+        response = Inforouter.client.request :get_folders_and_documents, folders_and_documents_params
+        @folders, @documents = Inforouter::Responses::FoldersDocuments.parse response
+        @documents
+      end
+    end
+
+    # @return [Boolean]
+    def update_properties
+      request_params = {
+        :path => path,
+        :new_folder_name => name,
+        :description => description
+      }
+      response = Inforouter.client.request :update_folder_properties, request_params
+      result = Inforouter::Responses::UpdateFolderProperties.parse response
+      result[:@success] == 'true'
+    end
+
+    # @return [Boolean]
+    def update_rules(options = {})
+      options = { :apply_to_tree => false }.merge(options)
+      request_params = {
+        :path => path,
+        'xmlRules' => rules.to_xml,
+        :apply_to_tree => options[:apply_to_tree] ? 1 : 0
+      }
+      response = Inforouter.client.request :set_folder_rules, request_params
+      result = Inforouter::Responses::SetFolderRules.parse response
+      result[:@success] == 'true'
+    end
+
+    private
+
+    # @return [Hash]
+    def path_params
+      { :path => path }
+    end
+
+    # @return [Hash]
+    def folder_params
+      {
+        :path => path,
+        :with_rules => 0,
+        'withPropertySets' => 0,
+        'withSecurity' => 0,
+        'withOwner' => 0
+      }
+    end
+
+    # @return [Hash]
+    def folders_and_documents_params
+      {
+        :path => path,
+        'withrules' => 0,
+        'withPropertySets' => 0,
+        'withSecurity' => 0,
+        'withOwner' => 0,
+        'withVersions' => 0
+      }
+    end
+  end
+end

data/lib/inforouter/record.rb

@@ -0,0 +1,13 @@
+module Inforouter #:nodoc:
+  # A generic infoRouter record.
+  class Record
+    # Initialize the record.
+    #
+    # @param attrs [Hash] Attributes defined for this record.
+    def initialize(attrs = {})
+      attrs.each do |sym, val|
+        send "#{sym}=", val
+      end
+    end
+  end
+end

data/lib/inforouter/responses.rb

@@ -0,0 +1,14 @@
+require 'inforouter/responses/base'
+require 'inforouter/responses/generic'
+require 'inforouter/responses/create_folder'
+require 'inforouter/responses/delete_folder'
+require 'inforouter/responses/document'
+require 'inforouter/responses/document_exists'
+require 'inforouter/responses/folder'
+require 'inforouter/responses/folder_exists'
+require 'inforouter/responses/set_access_list'
+require 'inforouter/responses/set_folder_rules'
+require 'inforouter/responses/update_folder_properties'
+require 'inforouter/responses/update_property_set_definition'
+require 'inforouter/responses/update_property_set_row'
+require 'inforouter/responses/users'

data/lib/inforouter/responses/base.rb

@@ -0,0 +1,78 @@
+module Inforouter #:nodoc:
+  module Responses #:nodoc:
+    # A base infoRouter SOAP response.
+    class Base
+      # Raw response.
+      attr_accessor :raw
+
+      # @param savon_response [Savon::Response]
+      def initialize(savon_response)
+        @raw = savon_response.to_hash
+        parse!
+      end
+
+      class << self
+        # Location of the response in the SOAP XML.
+        def response_success(value)
+          set_dsl(:response_success, value)
+        end
+
+        # Location of the error message in the SOAP XML.
+        def error_message(value)
+          set_dsl(:error_message, value)
+        end
+
+        # Parse a SOAP response.
+        #
+        # @param savon_response [Savon::Response]
+        def parse(savon_response)
+          new(savon_response)
+        end
+      end
+
+      # Match an element in the SOAP response
+      #
+      # @param match [String] XML path to match.
+      def match(chain)
+        current_value = raw
+        chain.split('/').each do |key|
+          current_value = current_value[key.to_sym]
+          next if current_value
+          fail Inforouter::Errors::UnexpectedSOAPResponse.new(raw, key, chain)
+        end
+        current_value
+      end
+
+      private
+
+      class_attribute :dsl
+
+      class << self
+        def set_dsl(key, value)
+          self.dsl ||= {}
+          self.dsl[key] = value
+          self.dsl
+        end
+
+        # @param date [String]
+        #
+        # @return [DateTime]
+        def parse_datetime(date)
+          DateTime.strptime(date, '%Y-%m-%d %H:%M:%S')
+          rescue ArgumentError
+            nil
+        end
+      end
+
+      def parse!
+        if self.dsl[:response_success]
+          return true if match(self.dsl[:response_success]) == 'true'
+        end
+        if self.dsl[:error_message]
+          return true if match(self.dsl[:error_message]) == ''
+          # TODO
+        end
+      end
+    end
+  end
+end