inforouter 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDE4NjgwMWM0NGYyNGMxZDMyMjEzNzc4NzI4ZjFjMzJlODNhMWQ0MQ==
+  data.tar.gz: !binary |-
+    YzYwZmMzZTkxMWU0MTc4OGNlNDMxM2I2ZWU1NTZmYzdiMDMwY2UzYg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZTQwOTcyY2Y2MDhlMWZiODY2MWEwODU2ZDMwN2ZjMTQ3NDgwZWY2MDgzYjA0
+    MWE4M2U1NjcyY2YxMGUzMjcyYWI3NGU1YWRiOGJhNDQ5OTZiZGMzNDAyYjEx
+    OTFjODc1NDJiZWUwMDE2OTA1M2UzNTk4MzdmNjhiNTMyNjk0YjY=
+  data.tar.gz: !binary |-
+    MDg0YWY0NmY3OGYwYjNjODNjMjcwODU0MWQ4MGI4MzllYmRlYzk0ZGM5OGU0
+    NjkzZWQ2NzdiZGI5NmM2MzllODBjNmNiMmI5YTFjZDA0OTM3MzM3ZjY5YWNj
+    NjI1MzYwMzEyMmE5ZDBkNDAyMWFiMDI0ZDBmYWZkYmQ2YjI1YzU=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.md

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version.tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order rand

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  Excludes:
+    - vendor/**
+    - bin/**
+
+LineLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+Documentation:
+  # don't require classes to be documented
+  Enabled: false
+
+HashSyntax:
+  EnforcedStyle: hash_rockets
+
+NumericLiterals:
+  # don't separate numeric literals with _
+  Enabled: false
+
+RaiseArgs:
+  # don't need to provide an exception class and message, SoapError takes care of that
+  Enabled: false
+
+Encoding:
+  # missing UTF-8 comments
+  Enabled: false

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# 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/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2014 NCS Software
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# The infoRouter Ruby Gem
+
+[![Gem Version](http://img.shields.io/gem/v/inforouter)][gem]
+[![Build Status](http://img.shields.io/travis/ncssoftware/inforouter.svg)][travis]
+
+[gem]: https://rubygems.org/gems/inforouter
+[travis]: https://travis-ci.org/ncssoftware/inforouter
+
+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 <tt>config/initializers/inforouter.rb</tt>.
+
+    Inforouter.configure do |config|
+      config.host     = 'your_inforouter_host'
+      config.username = 'your_inforouter_username'
+      config.password = 'your_inforouter_password'
+    end
+
+TODO: Write usage instructions here
+
+## 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.
+
+[license]: LICENSE.md

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/inforouter.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'inforouter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "inforouter"
+  spec.version       = Inforouter::Version
+  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.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'nokogiri', '~> 1.5.9'
+  spec.add_dependency 'savon', '~> 2.4.0'
+
+  spec.add_development_dependency 'rainbow', '~> 1.99.2'
+  spec.add_development_dependency 'rubocop', '~> 0.16.0'
+ end

data/lib/inforouter.rb

@@ -0,0 +1,42 @@
+require 'savon'
+
+require 'inforouter/access_list'
+require 'inforouter/folder_rule'
+require 'inforouter/client'
+require 'inforouter/configuration'
+require 'inforouter/errors'
+require 'inforouter/version'
+
+module Inforouter
+  class << self
+    attr_accessor :configuration
+
+    # Returns true if the gem has been configured.
+    def configured?
+      !!configured
+    end
+
+    # Configure the gem
+    def configure
+      self.configuration ||= Configuration.new
+      yield configuration
+    end
+
+    def reset!
+      self.configuration = nil
+      @client = nil
+    end
+
+    def client
+      check_configuration!
+      @client ||= Inforouter::Client.new
+    end
+
+    private
+
+    def check_configuration!
+      fail Inforouter::Errors::MissingConfig.new unless self.configuration
+      self.configuration_check!
+    end
+  end
+end

data/lib/inforouter/access_list.rb

@@ -0,0 +1,52 @@
+module Inforouter
+  class AccessList
+    # The AccessList XML fragment should be structures as
+    #
+    # <AccessList>
+    #   <DomainMembers Right="2"/>
+    #   <UserGroup Domain="" GroupName="Authors" Right="4"/>
+    #   <UserGroup Domain="" GroupName="Developers" Right="5"/>
+    #   <UserGroup Domain="ProjectX" GroupName="Architect" Right="6"/>
+    #   <User Domain="ProjectX" UserName="JoeD" Right="4"/>
+    #   <User Domain="ProjectX" UserName="JaneC" Right="6"/>
+    #   <User Domain="" UserName="SuzanP" Right="6"/>
+    # </AccessList>
+    #
+    # The Right Value can be
+    #
+    # 0 (No Access)
+    # 1 (List)
+    # 2 (Read)
+    # 3 (Add)
+    # 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]
+      )
+    end
+  end
+end

data/lib/inforouter/client.rb

@@ -0,0 +1,112 @@
+module Inforouter
+  # A <tt>Client</tt> communicates with the Inforouter service.
+  class Client
+    attr_reader :client, :ticket, :wsdl
+
+    # Initializes a new Client object
+    #
+    # @param options [Hash]
+    # @return [Inforouter::Client]
+    def initialize(options = {})
+      options = {
+        :log => false,
+        :logger => Logger.new($stdout),
+        :log_level => :info
+      }.merge(options)
+
+      @wsdl = options[:wsdl] || File.dirname(__FILE__) + '/../../resources/inforouter.wsdl'
+
+      @client = Savon.client(
+        :wsdl => @wsdl,
+        :convert_request_keys_to => :camelcase,
+        :pretty_print_xml => true,
+        :log => options[:log],
+        :logger => options[:logger],
+        :log_level => options[:log_level]
+      )
+
+      @ticket = nil
+    end
+
+    # @return [Array]
+    def operations
+      @client.operations
+    end
+
+    # Returns the client ticket.
+    #
+    # @return [String]
+    def ticket
+      get_ticket unless valid_ticket?(@ticket)
+      @ticket
+    end
+
+    # Make a safe SOAP call.
+    # Will raise a Inforouter::Errors::SOAPError on error.
+    #
+    # @param method [Symbol]
+    # @param message [Hash]
+    def call(method, message = {})
+      safe do
+        super method, :message => message.merge(authentication_params)
+      end
+    end
+
+    private
+
+    # @return [Hash]
+    def message_params
+      return {} unless Inforouter.configuration
+      {
+        'UID' => Inforouter.configuration.username,
+        'PWD' => Inforouter.configuration.password
+      }
+    end
+
+    # @return [Hash]
+    def authentication_params
+      {
+        :authentication_ticket => ticket
+      }
+    end
+
+    def safe(&block)
+      yield
+      rescue Savon::SOAPFault => e
+        raise Inforouter::Errors::SOAPError.new(e)
+    end
+
+    # Get a ticket.
+    def get_ticket
+      # AuthenticateUser
+      # Authenticates the specified user against infoRouter.
+      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'
+      end
+    end
+
+    # Determines whether the given ticket is still valid or not.
+    #
+    # @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)
+        if response.success?
+          data = response.to_array(:valid_ticket_response,
+                                   :valid_ticket_result,
+                                   :response).first
+          result = true if data[:@success] == 'true'
+        end
+      end
+      result
+    end
+  end
+end

data/lib/inforouter/configuration.rb

@@ -0,0 +1,20 @@
+module Inforouter #:nodoc:
+  # Inforouter gem configuration.
+  class Configuration
+    # Inforouter host.
+    attr_accessor :host
+    # Inforouter username.
+    attr_accessor :username
+    # Inforouter password.
+    attr_accessor :password
+
+    # Check the configuration.
+    #
+    # Will raise a Inforouter::Errors::MissingConfigOption if any of the host or
+    # the username are missing.
+    def check!
+      fail Inforouter::Errors::MissingConfigOption.new('host') unless host && host.strip.length > 0
+      fail Inforouter::Errors::MissingConfigOption.new('username') unless username && username.strip.length > 0
+    end
+  end
+end

data/lib/inforouter/errors.rb

@@ -0,0 +1,4 @@
+require 'inforouter/errors/inforouter_error'
+require 'inforouter/errors/missing_config_error'
+require 'inforouter/errors/missing_config_option_error'
+require 'inforouter/errors/soap_error'

data/lib/inforouter/errors/inforouter_error.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+module Inforouter #:nodoc:
+  module Errors #:nodoc:
+    # Default parent Inforouter error for all custom errors.
+    class InforouterError < StandardError
+    end
+  end
+end

data/lib/inforouter/errors/missing_config_error.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+module Inforouter #:nodoc:
+  module Errors #:nodoc:
+    # This error is raised when attempting to create a new client without
+    # configuring Inforouter.
+    class MissingConfigError < InforouterError
+      # Create a new error.
+      def initialize
+        super(compose_message('missing_config'))
+      end
+    end
+  end
+end

data/lib/inforouter/errors/missing_config_option_error.rb

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

data/lib/inforouter/errors/soap_error.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+module Inforouter #:nodoc:
+  module Errors #:nodoc:
+    # This error is raised when a SOAP call fails.
+    class SOAPError < InforouterError
+      # Original SOAP fault.
+      attr_reader :fault
+
+      def initialize(e)
+        @fault = e
+        e.to_hash.tap do |fault|
+          fault_code = fault[:fault][:faultcode]
+          fault_string = parse_fault(fault[:fault][:faultstring])
+          super(compose_message('soap_error',
+                                :message => fault_string,
+                                :code => fault_code
+          ))
+        end
+      end
+
+      private
+
+      # @params fault_string [String]
+      # @return [String]
+      def parse_fault(fault_string)
+        fault_string.lines.first.strip
+      end
+    end
+  end
+end

data/lib/inforouter/folder_rule.rb

@@ -0,0 +1,50 @@
+require 'nokogiri'
+
+module Inforouter
+  class FolderRule
+    # 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 self.rules_xml(options = {})
+      options = {
+        :allowable_file_types => nil,
+        :checkins => 'disallows',
+        :checkouts => 'disallows',
+        :document_deletes => 'disallows',
+        :folder_deletes => 'disallows',
+        :new_documents => 'disallows',
+        :new_folders => 'disallows',
+        :classified_documents => 'disallows'
+      }.merge(options)
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.Rules {
+          rule_item(xml, 'AllowableFileTypes', options[:allowable_file_types])
+          rule_item(xml, 'Checkins', options[:checkins])
+          rule_item(xml, 'Checkouts', options[:checkouts])
+          rule_item(xml, 'DocumentDeletes', options[:document_deletes])
+          rule_item(xml, 'FolderDeletes', options[:folder_deletes])
+          rule_item(xml, 'NewDocuments', options[:new_documents])
+          rule_item(xml, 'NewFolders', options[:new_folders])
+          rule_item(xml, 'ClassifiedDocuments', options[:classified_documents])
+        }
+      end
+      builder.doc.root.to_xml
+    end
+
+    def self.rule_itme(xml, name, value)
+      xml.Rule(:Name => name, :Value => value)
+    end
+  end
+end

data/lib/inforouter/version.rb

@@ -0,0 +1,15 @@
+module Inforouter
+  class Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    PRE = nil
+
+    class << self
+      # @return [String]
+      def to_s
+        [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_profile 'test_frameworks'
+end
+
+ENV['COVERAGE'] && SimpleCov.start do
+  add_filter '/.rvm/'
+end
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'inforouter'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: inforouter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Fenton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.9
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.99.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.99.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+description: A Ruby interface to the infoRouter SOAP API.
+email:
+- tom@ncs.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- .rubocop.yml
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- inforouter.gemspec
+- lib/inforouter.rb
+- lib/inforouter/access_list.rb
+- lib/inforouter/client.rb
+- lib/inforouter/configuration.rb
+- lib/inforouter/errors.rb
+- lib/inforouter/errors/inforouter_error.rb
+- lib/inforouter/errors/missing_config_error.rb
+- lib/inforouter/errors/missing_config_option_error.rb
+- lib/inforouter/errors/soap_error.rb
+- lib/inforouter/folder_rule.rb
+- lib/inforouter/version.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ncssoftware/inforouter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: A Ruby interface to the infoRouter SOAP API.
+test_files:
+- spec/spec_helper.rb