active_cmis 0.2.6 → 0.3.0

data/README.md

@@ -1,4 +1,4 @@
-# ActiveCMIS Release 0.2.5 #
+# ActiveCMIS Release 0.3.0 #
 **Homepage**:  <http://xaop.com/labs/activecmis>  
 **Git**:       <http://github.com/xaop/activecmis>  
 **Documentation**: <http://rdoc.info/github/xaop/activecmis/master/frames>
@@ -12,6 +12,9 @@ ActiveCMIS is Ruby library aimed at easing the interaction with various CMIS pro
 - Write support and the ability to create new objects.
 - Support for paging
 
+## Changes since 0.2.6 ##
+The way authentication works has changed. If you previously used ActiveCMIS.connect then you're fine, otherwise the authentication changes will affect you: the authenticate methods on ActiveCMIS::Server and ActiveCMIS::Repository now return a new object, and don't change the authentication on the object itself. You can also specify optional authentication when connecting to a Server, or when calling the repository method.
+
 ## Installation ##
 If you haven't installed Nokogiri yet it will be installed automatically, you will need a C compiler and the development files for libxml2.
 

data/Rakefile

@@ -25,6 +25,7 @@ begin
 
     gemspec.add_runtime_dependency 'nokogiri', '>= 1.4.1'
     gemspec.add_runtime_dependency 'ntlm-http', '~> 0.1.1'
+    gemspec.add_runtime_dependency 'require_relative', '~> 1.0.2'
 
     gemspec.required_ruby_version = '>= 1.8.6'
     gemspec.files.exclude '.gitignore'

data/active_cmis.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{active_cmis}
-  s.version = "0.2.6"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joeri Samson"]
-  s.date = %q{2011-10-11}
+  s.date = %q{2012-02-06}
   s.description = %q{A CMIS library implementing both reading and updating capabilities through the AtomPub/REST binding to CMIS.}
   s.email = %q{joeri@xaop.com}
   s.extra_rdoc_files = [
@@ -62,13 +62,16 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<nokogiri>, [">= 1.4.1"])
       s.add_runtime_dependency(%q<ntlm-http>, ["~> 0.1.1"])
+      s.add_runtime_dependency(%q<require_relative>, ["~> 1.0.2"])
     else
       s.add_dependency(%q<nokogiri>, [">= 1.4.1"])
       s.add_dependency(%q<ntlm-http>, ["~> 0.1.1"])
+      s.add_dependency(%q<require_relative>, ["~> 1.0.2"])
     end
   else
     s.add_dependency(%q<nokogiri>, [">= 1.4.1"])
     s.add_dependency(%q<ntlm-http>, ["~> 0.1.1"])
+    s.add_dependency(%q<require_relative>, ["~> 1.0.2"])
   end
 end
 

data/lib/active_cmis/active_cmis.rb

@@ -37,16 +37,16 @@ module ActiveCMIS
         logger.level = Logger::WARN
       end
 
-      server = Server.new(config["server_url"], logger)
       if user_name = config["server_login"] and password = config["server_password"]
         auth_type = config["server_auth"] || :basic
-        server.authenticate(auth_type, user_name, password)
+        authentication_info = [auth_type, user_name, password]
       end
-      repository = server.repository(config["repository_id"])
+      server = Server.new(config["server_url"], logger, authentication_info)
       if user_name = config["repository_login"] and password = config["repository_password"]
         auth_type = config["repository_auth"] || :basic
-        repository.authenticate(auth_type, user_name, password)
+        authentication_info = [auth_type, user_name, password]
       end
+      repository = server.repository(config["repository_id"], authentication_info)
       return repository
     else
       raise "Configuration does not have correct format (#{config.class} is not a hash)"

data/lib/active_cmis/collection.rb

@@ -188,7 +188,7 @@ module ActiveCMIS
                       @next = xml.xpath("at:feed/at:link[@rel = 'next']/@href", NS::COMBINED).first
                       @next = @next.nil? ? nil : @next.text
 
-                      new_elements = xml.xpath('at:feed/at:entry', NS::COMBINED).map &@map_entry
+                      new_elements = xml.xpath('at:feed/at:entry', NS::COMBINED).map(&@map_entry)
                       @elements.concat(new_elements)
 
                       num_items = xml.xpath("at:feed/cra:numItems", NS::COMBINED).first

data/lib/active_cmis/internal/connection.rb

@@ -179,7 +179,7 @@ module ActiveCMIS
           http.request(req) { |resp|
             status = resp.code.to_i
             body = resp.body
-            headers = resp.header
+            headers = resp
           }
 
           logger.debug "RECEIVED #{status}"

data/lib/active_cmis/internal/utils.rb

@@ -9,7 +9,7 @@ module ActiveCMIS
         delims  = "<>#%\""
         unwise  = '{}|\\\\^\[\]`'
         query   = ";/?:@&=+,$"
-        URI.escape(parameter, /[#{control+space+delims+unwise+query}]/o)
+        escape(parameter, /[#{control+space+delims+unwise+query}]/o)
       end
 
       # Given an url (string or URI) returns that url with the given parameters appended
@@ -33,7 +33,16 @@ module ActiveCMIS
       # FIXME?? percent_encode and escape_url_parameter serve nearly the same purpose, replace one?
       # @private
       def self.percent_encode(string)
-        URI.escape(string, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+        escape(string, /[^#{URI::PATTERN::UNRESERVED}]/o)
+      end
+
+      def self.escape(string, pattern)
+        if defined?(URI::Parser)
+          parser = URI::Parser.new
+          parser.escape(string, pattern)
+        else
+          URI.escape(string, pattern)
+        end
       end
 
       # Returns id if id is already an object, object_by_id if id is a string, nil otherwise

data/lib/active_cmis/repository.rb

@@ -3,20 +3,36 @@ module ActiveCMIS
     # @return [Logger] A logger to which debug output and so on is sent
     attr_reader :logger
 
+    # @return [ActiveCMIS::Server] The server from which the repository was
+    #     requested
+    attr_reader :server
+
     # @private
-    def initialize(connection, logger, initial_data) #:nodoc:
+    def initialize(server, connection, logger, initial_data, authentication_info) #:nodoc:
+      @server = server
       @conn = connection
       @data = initial_data
       @logger = logger
+      method, *params = authentication_info
+      if method
+        conn.authenticate(method, *params)
+      end
     end
 
     # Use authentication to access the CMIS repository
+    # This returns a new Repository object, the existing repository will still
+    # use the previous authentication info.
+    # If the used authentication info (method, username, password) is the same
+    # as for the current Repository object, then self will be returned (unless
+    # the server repository cache is cleared first)
     #
-    # e.g.: repo.authenticate(:basic, "username", "password")
-    # @return [void]
-    def authenticate(method, *params)
-      conn.authenticate(method, *params)
-      nil
+    # e.g.: authenticated = repo.authenticate(:basic, "username", "password")
+    # @param method [:basic, :ntlm]
+    # @param username [String]
+    # @param password [String]
+    # @return [Repository]
+    def authenticate(*authentication_info)
+      server.repository(key, authentication_info)
     end
 
     # The identifier of the repository
@@ -303,7 +319,7 @@ module ActiveCMIS
     # e.g. fill_in_template("objectbyid", "id" => "@root@", "includeACL" => true)
     #      -> 'http://example.org/repo/%40root%40?includeRelationships&includeACL=true'
     def fill_in_template(template, values)
-      result = template.gsub /\{([^}]+)\}/ do |match|
+      result = template.gsub(/\{([^}]+)\}/) do |match|
         Internal::Utils.percent_encode(values[$1].to_s)
       end
     end

data/lib/active_cmis/server.rb

@@ -8,17 +8,18 @@ module ActiveCMIS
     attr_reader :logger
 
     # @return [Server] Cached by endpoint and logger
-    def self.new(endpoint, logger = nil)
+    def self.new(endpoint, logger = nil, authentication_info = nil)
       endpoint = case endpoint
                  when URI; endpoint
                  else URI(endpoint.to_s)
                  end
-      endpoints[[endpoint, logger]] ||= super(endpoint, logger || ActiveCMIS.default_logger)
+      server = super(endpoint, logger || ActiveCMIS.default_logger, authentication_info)
+      endpoints[endpoint.to_s][authentication_info][logger] ||= server
     end
 
     # @return [{(URI, Logger) => Server}] The cache of known Servers
     def self.endpoints
-      @endpoints ||= {}
+      @endpoints ||= Hash.new {|h, k| h[k] = Hash.new {|h2, k2| h2[k2] = {}}}
     end
 
     # @return [String]
@@ -33,35 +34,59 @@ module ActiveCMIS
     # A connection needs the URL to a CMIS REST endpoint.
     #
     # It's used to manage all communication with the CMIS Server
-    def initialize(endpoint, logger)
+    # @param endpoint [URI] The URL where the CMIS AtomPub REST endpoint can be found
+    # @param logger [Logger] The logger that will be used to log debug/info messages
+    # @param authentication_info [Array?] Optional authentication info to be used when retrieving the data from the AtomPub endpoint
+    def initialize(endpoint, logger, authentication_info = nil)
       @endpoint = endpoint
       @logger = logger
+
+      method, *params = authentication_info
+      if method
+        conn.authenticate(method, *params)
+      end
     end
 
+    # This returns a new Server object using the specified authentication info
+    #
     # @param (see ActiveCMIS::Internal::Connection#authenticate)
     # @see Internal::Connection#authenticate
     # @return [void]
-    def authenticate(method, *params)
-      conn.authenticate(method, *params)
+    def authenticate(*authentication_info)
+      new(endpoint, logger, authentication_info)
     end
 
     # Returns the _Repository identified by the ID
+    # Authentication will take place with the optional second paramater, if it
+    # is absent and there is server authentcation then the server authentication
+    # will be used
+    #
+    # Cached by the repository_id and, authentcation info. The cache can be reset
+    # by calling clear_repositories.
     #
-    # Cached by the repository_id, no way to reset cache yet
     # @param [String] repository_id
+    # @param [Array] authentication_info
     # @return [Repository]
-    def repository(repository_id)
-      cached_repositories[repository_id] ||= begin
+    def repository(repository_id, authentication_info = self.authentcation_info)
+      cached_repositories[[repository_id, authentication_info]] ||= begin
                                                repository_data = repository_info.
                                                  xpath("/app:service/app:workspace[cra:repositoryInfo/c:repositoryId[child::text() = '#{repository_id}']]", NS::COMBINED)
                                                if repository_data.empty?
                                                  raise Error::ObjectNotFound.new("The repository #{repository_id} doesn't exist")
                                                else
-                                                 Repository.new(conn.dup, logger.dup, repository_data)
+                                                 Repository.new(self, conn.dup, logger.dup, repository_data, authentication_info)
                                                end
                                              end
     end
 
+    # Reset cache of Repository objects
+    #
+    # @return [void]
+    def clear_repositories
+      @cached_repositories = {}
+    end
+
+
     # Lists all the available repositories
     #
     # @return [<{:id, :name} => String>]

data/lib/active_cmis/version.rb

@@ -1,8 +1,8 @@
 module ActiveCMIS
   module Version
     MAJOR = 0
-    MINOR = 2
-    PATCH = 6
+    MINOR = 3
+    PATCH = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/lib/active_cmis.rb

@@ -4,27 +4,28 @@ require 'net/https'
 require 'net/ntlm_http'
 require 'yaml'
 require 'logger'
-require 'active_cmis/version'
-require 'active_cmis/internal/caching'
-require 'active_cmis/internal/connection'
-require 'active_cmis/exceptions'
-require 'active_cmis/server'
-require 'active_cmis/repository'
-require 'active_cmis/object'
-require 'active_cmis/document'
-require 'active_cmis/folder'
-require 'active_cmis/policy'
-require 'active_cmis/relationship'
-require 'active_cmis/type'
-require 'active_cmis/atomic_types'
-require 'active_cmis/property_definition'
-require 'active_cmis/collection.rb'
-require 'active_cmis/rendition.rb'
-require 'active_cmis/acl.rb'
-require 'active_cmis/acl_entry.rb'
-require 'active_cmis/ns'
-require 'active_cmis/active_cmis'
-require 'active_cmis/internal/utils'
-require 'active_cmis/rel'
-require 'active_cmis/attribute_prefix'
-require 'active_cmis/query_result'
+require 'require_relative'
+require_relative 'active_cmis/version'
+require_relative 'active_cmis/internal/caching'
+require_relative 'active_cmis/internal/connection'
+require_relative 'active_cmis/exceptions'
+require_relative 'active_cmis/server'
+require_relative 'active_cmis/repository'
+require_relative 'active_cmis/object'
+require_relative 'active_cmis/document'
+require_relative 'active_cmis/folder'
+require_relative 'active_cmis/policy'
+require_relative 'active_cmis/relationship'
+require_relative 'active_cmis/type'
+require_relative 'active_cmis/atomic_types'
+require_relative 'active_cmis/property_definition'
+require_relative 'active_cmis/collection.rb'
+require_relative 'active_cmis/rendition.rb'
+require_relative 'active_cmis/acl.rb'
+require_relative 'active_cmis/acl_entry.rb'
+require_relative 'active_cmis/ns'
+require_relative 'active_cmis/active_cmis'
+require_relative 'active_cmis/internal/utils'
+require_relative 'active_cmis/rel'
+require_relative 'active_cmis/attribute_prefix'
+require_relative 'active_cmis/query_result'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: active_cmis
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 6
-  version: 0.2.6
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Joeri Samson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-11 00:00:00 +02:00
+date: 2012-02-06 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +50,22 @@ dependencies:
         version: 0.1.1
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: require_relative
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 0
+        - 2
+        version: 1.0.2
+  type: :runtime
+  version_requirements: *id003
 description: A CMIS library implementing both reading and updating capabilities through the AtomPub/REST binding to CMIS.
 email: joeri@xaop.com
 executables: []