active_cmis 0.3.3 → 0.3.4

data/AUTHORS

@@ -0,0 +1,9 @@
+Joeri Samson
+Michel Benevento
+Tim Felgentreff
+Stijn Van Vreckem
+linzhixing
+Jean-Denis Vauguet
+Kenneth Geerts
+Ryan Murphy
+Guillaume Hain

data/README.md

@@ -1,8 +1,7 @@
-# ActiveCMIS Release 0.3.2 #
-**Homepage**:  <http://xaop.com/labs/activecmis>  
+# ActiveCMIS Release 0.3.4 #
 **Git**:       <http://github.com/xaop/activecmis>  
 **Documentation**: <http://rdoc.info/github/xaop/activecmis/master/frames>
-**Author**:    XAOP bvba  
+**Author**:    XAOP bvba
 **Copyright**: 2011
 **License**:   MIT License
 ## Synopsis ##
@@ -12,6 +11,15 @@ 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.3.3 ##
+- added #set_versioning_state for documents (thanks to @zedtux)
+- improve checking method to make more parameters optional (and use set_versioning_state when possible)
+
+## Changes since 0.3.2 ##
+- Fix for header of PUT request (thanks to @linzhixing)
+- Improvement for integer conversion (thanks to @kennethgeerts)
+- Correctly set the default namespace (reported by @brunospy)
+
 ## Changes since 0.3.1 ##
 - Does not require ntlm-http unless needed for authentication
 - Fix some issues with authentication (thanks to @beno)
@@ -39,5 +47,3 @@ If you actually need NTLM authentication you can use https://github.com/xaop/ntl
 And so on ...
 
 Full documentation of the API can be found at [rdoc.info](http://rdoc.info/projects/xaop/activecmis)
-
-A tutorial can be found at [the xaop site](http://xaop.com/labs/activecmis "tutorial")

data/active_cmis.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "active_cmis"
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joeri Samson"]
-  s.date = "2013-05-08"
+  s.date = "2013-06-11"
   s.description = "A CMIS library implementing both reading and updating capabilities through the AtomPub/REST binding to CMIS."
   s.email = "joeri@xaop.com"
   s.extra_rdoc_files = [
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
     "TODO"
   ]
   s.files = [
+    "AUTHORS",
     "LICENSE",
     "README.md",
     "Rakefile",

data/lib/active_cmis/document.rb

@@ -65,6 +65,25 @@ module ActiveCMIS
       @updated_contents = options
     end
 
+    # Sets versioning state.
+    # Only possible on new documents, or PWC documents
+    #
+    # @param ["major", "minor", "none", "checkedout"] state A string of the desired versioning state
+    #
+    # @return [void]
+    def set_versioning_state(state)
+      raise Error::Constraint.new("Can only set a different version state on PWC documents, or unsaved new documents") unless key.nil? || working_copy?
+      raise ArgumentError, "You must pass a String" unless state.is_a?(String)
+      if key.nil?
+        possible_values = %w[major minor none checkedout]
+      else
+        possible_values = %w[major minor]
+      end
+      raise ArgumentError, "Given state is invalid. Possible values are #{possible_values.join(", ")}" unless possible_values.include?(state)
+
+      @versioning_state = state
+    end
+
     # Returns all documents in the version series of this document.
     # Uses self to represent the version of this document
     # @return [Collection<Document>, Array(self)]
@@ -180,21 +199,58 @@ module ActiveCMIS
       end
     end
 
-    # You can specify whether the new version should be major (defaults to true)
-    # You can optionally give a list of attributes that need to be set.
+    # @overload checkin(major, comment = "", updated_attributes = {})
+    #   Check in the private working copy. Raises a constraint error when the
+    #   document is not a working copy
     #
-    # This operation exists only for Private Working Copies
-    # @return [Document] The final version that results from the checkin
-    def checkin(major = true, comment = "", updated_attributes = {})
+    #   @param [Boolean] major Whether the document will be checked in as a major version
+    #   @param [String] comment An optional comment to use when creating the new version
+    #   @param [Hash] updated_attributes A hash with updated attributes
+    #   @return [Document] The final version that results from the checkin
+    # @overload checkin(comment = "", updated_attributes = {})
+    #   Check in the private working copy. Raises a constraint error when the
+    #   document is not a working copy
+    #   The version will be the version set by set_versioning_state (default is
+    #   a major version)
+    #
+    #   @param [String] comment An optional comment to use when creating the new version
+    #   @param [Hash] updated_attributes A hash with updated attributes
+    #   @return [Document] The final version that results from the checkin
+    # @overload checkin(updated_attributes = {})
+    #   Check in the private working copy with an empty message.
+    #   Raises a constraint error when the document is not a working copy
+    #   The version will be the version set by set_versioning_state (default is
+    #   a major version)
+    #
+    #   @param [Hash] updated_attributes A hash with updated attributes
+    #   @return [Document] The final version that results from the checkin
+    def checkin(*options)
+      if options.length > 3
+        raise ArgumentError, "Too many arguments for checkin"
+      else
+        major, comment, updated_attributes = *options
+        if Boolean === major
+          # Nothing changes: only defaults need to be filled in (if necessary)
+        elsif String === major
+          updated_attributes = comment
+          comment = major
+          # major will be true if: @versioning_state == "major", or if it's not set
+          major = @versioning_state != "minor"
+        end
+        comment ||= ""
+        updated_attributes ||= {}
+      end
+
       if working_copy?
         update(updated_attributes)
         result = self
         updated_aspects([true, major, comment]).each do |hash|
           result = result.send(hash[:message], *hash[:parameters])
         end
+        @versioning_state = nil
         result
       else
-        raise "Not a working copy"
+        raise Error::Constraint, "Not a working copy"
       end
     end
 
@@ -261,11 +317,7 @@ module ActiveCMIS
     def create_url
       if f = parent_folders.first
         url = f.items.url
-        if self.class.versionable # Necessary in OpenCMIS at least
-          url
-        else
-          Internal::Utils.append_parameters(url, "versioningState" => "none")
-        end
+        Internal::Utils.append_parameters(url, "versioningState" => (self.class.versionable ? (@versioning_state || "major") : "none"))
       else
         raise Error::NotSupported.new("Creating an unfiled document is not supported by CMIS")
         # Can't create documents that are unfiled, CMIS does not support it (note this means exceptions should not actually be NotSupported)

data/lib/active_cmis/internal/caching.rb

@@ -11,7 +11,7 @@ module ActiveCMIS
         # Creates a proxy method for the given method names that caches the result.
         #
         # Parameters are passed and ignored, cached values will be returned regardless of the parameters.
-        # @param [Symbol, <Symbol>] Names of methods that will be cached
+        # @param [Symbol, <Symbol>] names Names of methods that will be cached
         # @return [void]
         def cache(*names)
           (@cached_methods ||= []).concat(names).uniq!
@@ -41,7 +41,7 @@ module ActiveCMIS
         #
         # If the given attribute does not yet exist the method #load_from_data will be called
         #
-        # @param [Symbol, <Symbol>] Names of desired attributes
+        # @param [Symbol, <Symbol>] names Names of desired attributes
         # @return [void]
         def cached_reader(*names)
           (@cached_methods ||= []).concat(names).uniq!

data/lib/active_cmis/internal/connection.rb

@@ -7,7 +7,7 @@ module ActiveCMIS
       # @return [Logger] A logger used to send debug and info messages
       attr_reader :logger
 
-      # @param [Logger] Initialize with a logger of your choice
+      # @param [Logger] logger Initialize with a logger of your choice
       def initialize(logger)
         @logger = logger || ActiveCMIS.default_logger
       end

data/lib/active_cmis/rendition.rb

@@ -42,7 +42,7 @@ module ActiveCMIS
     # Returns a hash with the name of the file to which was written, the length, and the content type
     #
     # *WARNING*: this loads the complete file in memory and dumps it at once, this should be fixed
-    # @param [String] filename Location to store the content.
+    # @param [String] file_name Location to store the content.
     # @return [Hash]
     def get_file(file_name)
       response = get_data

data/lib/active_cmis/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_cmis
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-08 00:00:00.000000000 Z
+date: 2013-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70197899383240 !ruby/object:Gem::Requirement
+  requirement: &70212875587800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *70197899383240
+  version_requirements: *70212875587800
 - !ruby/object:Gem::Dependency
   name: ntlm-http
-  requirement: &70197899382120 !ruby/object:Gem::Requirement
+  requirement: &70212872366220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *70197899382120
+  version_requirements: *70212872366220
 - !ruby/object:Gem::Dependency
   name: require_relative
-  requirement: &70197899381480 !ruby/object:Gem::Requirement
+  requirement: &70212872387680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 1.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *70197899381480
+  version_requirements: *70212872387680
 description: A CMIS library implementing both reading and updating capabilities through
   the AtomPub/REST binding to CMIS.
 email: joeri@xaop.com
@@ -54,6 +54,7 @@ extra_rdoc_files:
 - README.md
 - TODO
 files:
+- AUTHORS
 - LICENSE
 - README.md
 - Rakefile