inforouter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDE4NjgwMWM0NGYyNGMxZDMyMjEzNzc4NzI4ZjFjMzJlODNhMWQ0MQ==
+    MzY1MjIwNGZmMjQ3YjE1NTRjOTcyYTNmYzVjOWU0ZjYxYjQyYTlmNg==
   data.tar.gz: !binary |-
-    YzYwZmMzZTkxMWU0MTc4OGNlNDMxM2I2ZWU1NTZmYzdiMDMwY2UzYg==
+    MDBkNWZhNWVhMWM1Yzk5YmRkZjMyNWU2M2I0OGQ0MWM0ZjA4N2Q4Yg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZTQwOTcyY2Y2MDhlMWZiODY2MWEwODU2ZDMwN2ZjMTQ3NDgwZWY2MDgzYjA0
-    MWE4M2U1NjcyY2YxMGUzMjcyYWI3NGU1YWRiOGJhNDQ5OTZiZGMzNDAyYjEx
-    OTFjODc1NDJiZWUwMDE2OTA1M2UzNTk4MzdmNjhiNTMyNjk0YjY=
+    YjQzYWQ0MzQwNmExZjNlM2U3NzFmNTEyMjIzYzBkMjA1Y2VlMDJkZGJkNTRi
+    ODA2NTQ1MDQ4N2UzNTYxY2NmZjU4ZmQxOTJjNWFlZmRjNzM4NTU3MGE1NmEz
+    ZjliZDNjOWFlMjE3NjM5ODAyNjU2NTNhNzQ1ZTUxNGZmMjQxZWQ=
   data.tar.gz: !binary |-
-    MDg0YWY0NmY3OGYwYjNjODNjMjcwODU0MWQ4MGI4MzllYmRlYzk0ZGM5OGU0
-    NjkzZWQ2NzdiZGI5NmM2MzllODBjNmNiMmI5YTFjZDA0OTM3MzM3ZjY5YWNj
-    NjI1MzYwMzEyMmE5ZDBkNDAyMWFiMDI0ZDBmYWZkYmQ2YjI1YzU=
+    Y2U5NjBmODhjOTA1OTcwZjRlYjQxMDQwZDYyMTdkMWM0MGZhZmQ4NjE3MzBl
+    M2UyMzQ5MDk1OWJhZTQ1OTliNjA0YTc2MDM2YzE3M2ZkMzUzM2RiYzJlMGM5
+    NjhiZTQ5YTNjYmZmODliYWIzNmUzNjE0OTgyMjhmMmM5NWM0ZTA=

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+*.wsdl
 .bundle
 .config
 .yardoc

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  Excludes:
+  Exclude:
     - vendor/**
     - bin/**
 

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -9,9 +9,6 @@ gemspec
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.8.0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0"
   gem "jeweler", "~> 2.0.1"
   gem "simplecov", ">= 0"
 end

data/README.md

@@ -1,6 +1,6 @@
 # The infoRouter Ruby Gem
 
-[![Gem Version](http://img.shields.io/gem/v/inforouter)][gem]
+[![Gem Version](http://img.shields.io/gem/v/inforouter.svg)][gem]
 [![Build Status](http://img.shields.io/travis/ncssoftware/inforouter.svg)][travis]
 
 [gem]: https://rubygems.org/gems/inforouter
@@ -27,12 +27,112 @@ Or install it yourself as:
 Configure your environment. For example, create an initializer in Rails in <tt>config/initializers/inforouter.rb</tt>.
 
     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
 
-TODO: Write usage instructions here
+## Using Inforouter
+
+Creating an infoRouter folder using <tt>Inforouter::Folder</tt>.
+
+    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 <tt>rights.rb</tt>.
+
+* <tt>NO_ACCESS</tt>
+* <tt>LIST</tt>
+* <tt>READ</tt>
+* <tt>ADD</tt>
+* <tt>ADD_AND_READ</tt>
+* <tt>CHANGE</tt>
+* <tt>FULL_CONTROL</tt>
+
+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
 

data/Rakefile

@@ -1 +1,20 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+gemspec = eval(File.read(Dir['*.gemspec'].first))
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/test_*.rb'
+  test.verbose = false
+end
+
+desc 'Validate the gemspec.'
+task :gemspec do
+  puts gemspec.validate
+end
+
+require 'rubocop/rake_task'
+Rubocop::RakeTask.new(:rubocop)
+
+task :default => [:rubocop, :test]

data/inforouter.gemspec

@@ -4,22 +4,26 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'inforouter/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "inforouter"
+  spec.name          = 'inforouter'
   spec.version       = Inforouter::Version
-  spec.authors       = ["Tom Fenton"]
-  spec.email         = ["tom@ncs.co.nz"]
+  spec.authors       = ['Tom Fenton']
+  spec.email         = ['tom@ncs.co.nz']
   spec.description   = %q(A Ruby interface to the infoRouter SOAP API.)
   spec.summary       = spec.description
-  spec.homepage      = "https://github.com/ncssoftware/inforouter"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/ncssoftware/inforouter'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split("\n")
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_dependency 'nokogiri', '~> 1.5.9'
+  spec.add_dependency 'i18n'
   spec.add_dependency 'savon', '~> 2.4.0'
+  spec.add_dependency 'activesupport', '>= 3.0'
 
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_development_dependency 'rdoc', '~> 3.12'
   spec.add_development_dependency 'rainbow', '~> 1.99.2'
   spec.add_development_dependency 'rubocop', '~> 0.16.0'
- end
+end

data/lib/config/locales/en.yml

@@ -0,0 +1,34 @@
+en:
+  inforouter:
+    errors:
+      messages:
+        missing_config:
+          message: "Missing configuration."
+          summary: "infoRouter requires a username and password."
+          resolution: "See your infoRouter system administrator for username and
+            password. Configure the inforouter gem. For example, add the
+            following to `config/initializers/inforouter.rb`.\n
+            \_\_Inforouter.configure do |config|\n
+            \_\_\_config.wsdl = 'your_inforouter_wsdl_location' # optional\n
+            \_\_\_config.host = 'your_inforouter_host'\n
+            \_\_\_config.username = 'your_inforouter_username'\n
+            \_\_\_config.password = 'your_inforouter_password'\n
+            \_\_end\n"
+        missing_config_option:
+          message: "Missing configuration option: %{name}."
+          summary: "A configuration option was not provided when configuration infoRouter."
+          resolution: "Review your `Inforouter.configure` code. Are you using an environment
+          variable that has not been set?"
+        soap_error:
+          message: "%{message}"
+          summary: "The server returned a %{code} error."
+          resolution: "Review the parameters passed to the request."
+        unexpected_soap_response:
+          message: "Expected a value for `%{key}` in `%{chain}` in the infoRouter response."
+          summary: "infoRouter returned an unexpected response: `%{raw}`."
+          resolution: "This is possibly a bug in the inforouter gem.\n
+          Please report it in https://github.com/ncssoftware/inforouter/issues."
+        api_error:
+          message: "%{message}"
+          summary: "The infoRouter server returned an error in the response: `%{raw}`"
+          resolution: "Check the request parameters."

data/lib/inforouter.rb

@@ -1,16 +1,35 @@
 require 'savon'
+require 'i18n'
+require 'active_support'
+require 'active_support/core_ext'
 
+require 'inforouter/version'
+require 'inforouter/errors'
+require 'inforouter/responses'
+require 'inforouter/record'
 require 'inforouter/access_list'
-require 'inforouter/folder_rule'
-require 'inforouter/client'
+require 'inforouter/access_list_domain_members_item'
+require 'inforouter/access_list_user_group_item'
+require 'inforouter/access_list_user_item'
+require 'inforouter/document'
+require 'inforouter/folder'
+require 'inforouter/rights'
+require 'inforouter/rule_item'
+require 'inforouter/rules'
+require 'inforouter/user'
+require 'inforouter/users'
 require 'inforouter/configuration'
-require 'inforouter/errors'
-require 'inforouter/version'
+require 'inforouter/client'
+
+I18n.load_path << File.join(File.dirname(__FILE__), 'config', 'locales', 'en.yml')
 
 module Inforouter
   class << self
     attr_accessor :configuration
 
+    # infoRouter API version.
+    API_VERSION = '8.0'
+
     # Returns true if the gem has been configured.
     def configured?
       !!configured
@@ -27,16 +46,16 @@ module Inforouter
       @client = nil
     end
 
-    def client
+    def client(options = {})
       check_configuration!
-      @client ||= Inforouter::Client.new
+      @client ||= Inforouter::Client.new(options)
     end
 
     private
 
     def check_configuration!
       fail Inforouter::Errors::MissingConfig.new unless self.configuration
-      self.configuration_check!
+      self.configuration.check!
     end
   end
 end

data/lib/inforouter/access_list.rb

@@ -1,5 +1,20 @@
 module Inforouter
-  class AccessList
+  class AccessList < Record
+    # The <tt>Inforouter::AccessListDomainMembersItem</tt>.
+    attr_accessor :domain_members
+    # Array of <tt>Inforouter::AccessListUserGroupItem</tt>s.
+    attr_accessor :user_groups
+    # Array of <tt>Inforouter::AccessListUserItem</tt>s.
+    attr_accessor :users
+
+    def initialize(params = {})
+      params = {
+        :user_groups => [],
+        :users => []
+      }.merge(params)
+      super params
+    end
+
     # The AccessList XML fragment should be structures as
     #
     # <AccessList>
@@ -21,32 +36,15 @@ module Inforouter
     # 4 (Add & Read)
     # 5 (Change)
     # 6 (Full Control)
-    NO_ACCESS = 0
-    LIST = 1
-    READ = 2
-    ADD = 3
-    ADD_AND_READ = 4
-    CHANGE = 5
-    FULL_CONTROL = 6
-
-    def self.domain_members_item(xml, right)
-      xml.DomainMembers(:Right => right)
-    end
-
-    def self.user_group_item(xml, options = {})
-      xml.UserGroup(
-        :Domain    => options[:domain],
-        :GroupName => options[:group_name],
-        :Right     => options[:right]
-      )
-    end
-
-    def self.user_item(xml, options = {})
-      xml.User(
-        :Domain   => options[:domain],
-        :UserName => options[:user_name],
-        :Right    => options[:right]
-      )
+    def to_xml
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.AccessList do
+          xml.DomainMembers(domain_members.to_hash) if domain_members
+          user_groups.each { |user_group| xml.UserGroup(user_group.to_hash) }
+          users.each { |user| xml.User(user.to_hash) }
+        end
+      end
+      builder.doc.root.to_xml
     end
   end
 end

data/lib/inforouter/access_list_domain_members_item.rb

@@ -0,0 +1,11 @@
+module Inforouter
+  class AccessListDomainMembersItem < Record
+    attr_accessor :right
+    attr_accessor :description
+
+    # Convert the object to a useable hash for SOAP requests.
+    def to_hash
+      { 'Right' => right }
+    end
+  end
+end

data/lib/inforouter/access_list_user_group_item.rb

@@ -0,0 +1,17 @@
+module Inforouter
+  class AccessListUserGroupItem < Record
+    attr_accessor :domain
+    attr_accessor :name
+    attr_accessor :right
+    attr_accessor :description
+
+    # Convert the object to a useable hash for SOAP requests.
+    def to_hash
+      {
+        'Domain' => domain,
+        'UserGroupName' => name,
+        'Right' => right
+      }
+    end
+  end
+end

data/lib/inforouter/access_list_user_item.rb

@@ -0,0 +1,17 @@
+module Inforouter
+  class AccessListUserItem < Record
+    attr_accessor :domain
+    attr_accessor :name
+    attr_accessor :right
+    attr_accessor :description
+
+    # Convert the object to a useable hash for SOAP requests.
+    def to_hash
+      {
+        'Domain' => domain,
+        'UserName' => name,
+        'Right' => right
+      }
+    end
+  end
+end

data/lib/inforouter/client.rb

@@ -1,7 +1,7 @@
 module Inforouter
-  # A <tt>Client</tt> communicates with the Inforouter service.
+  # A <tt>Client</tt> communicates with the infoRouter service.
   class Client
-    attr_reader :client, :ticket, :wsdl
+    attr_reader :client, :ticket
 
     # Initializes a new Client object
     #
@@ -14,10 +14,8 @@ module Inforouter
         :log_level => :info
       }.merge(options)
 
-      @wsdl = options[:wsdl] || File.dirname(__FILE__) + '/../../resources/inforouter.wsdl'
-
       @client = Savon.client(
-        :wsdl => @wsdl,
+        :wsdl => Inforouter.configuration.wsdl,
         :convert_request_keys_to => :camelcase,
         :pretty_print_xml => true,
         :log => options[:log],
@@ -37,7 +35,7 @@ module Inforouter
     #
     # @return [String]
     def ticket
-      get_ticket unless valid_ticket?(@ticket)
+      @ticket = authenticate_user unless valid_ticket?(@ticket)
       @ticket
     end
 
@@ -48,10 +46,14 @@ module Inforouter
     # @param message [Hash]
     def call(method, message = {})
       safe do
-        super method, :message => message.merge(authentication_params)
+        @client.call method, :message => message.merge(authentication_params)
       end
     end
 
+    def request(method, message = {})
+      call method, message
+    end
+
     private
 
     # @return [Hash]
@@ -76,17 +78,19 @@ module Inforouter
         raise Inforouter::Errors::SOAPError.new(e)
     end
 
-    # Get a ticket.
-    def get_ticket
-      # AuthenticateUser
-      # Authenticates the specified user against infoRouter.
+    # Authenticate the specified user against infoRouter and returns a ticket.
+    #
+    # @return [String]
+    def authenticate_user
+      ticket = nil
       response = @client.call(:authenticate_user, :message => message_params)
       if response.success?
         data = response.to_array(:authenticate_user_response,
                                  :authenticate_user_result,
                                  :response).first
-        @ticket = data[:@ticket] if data[:@success] == 'true'
+        ticket = data[:@ticket] if data[:@success] == 'true'
       end
+      ticket
     end
 
     # Determines whether the given ticket is still valid or not.
@@ -94,14 +98,13 @@ module Inforouter
     # @params ticket [String]
     # @return [Boolean]
     def valid_ticket?(ticket)
-      # isValidTicket
       result = false
       unless ticket.nil?
         message = { :authentication_ticket => ticket }
-        response = @client.call(:valid_ticket, :message => message)
+        response = @client.call(:is_valid_ticket, :message => message)
         if response.success?
-          data = response.to_array(:valid_ticket_response,
-                                   :valid_ticket_result,
+          data = response.to_array(:is_valid_ticket_response,
+                                   :is_valid_ticket_result,
                                    :response).first
           result = true if data[:@success] == 'true'
         end