activesp 0.0.1 → 0.0.4

data/lib/activesp/caching.rb

@@ -1,8 +1,37 @@
+# Copyright (c) 2010 XAOP bvba
+# 
+# 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.
+
 module ActiveSP
   
+  # @private
   module Caching
     
+  private
+    
     def cache(name, options = {})
+      options = options.dup
       duplicate = options.delete(:dup)
       options.empty? or raise ArgumentError, "unsupported options #{options.keys.map { |k| k.inspect }.join(", ")}"
       (@cached_methods ||= []) << name
@@ -14,11 +43,11 @@ module ActiveSP
           if defined? @#{name}
             @#{name}
           else
-            @#{name} = #{name}__uncached(*a, &b)
-          end#{".dup" if duplicate}
+            @#{name} = #{name}__uncached(*a, &b)#{".dup" if duplicate == :once}
+          end#{".dup" if duplicate == :always}
         end
         #{access} :#{name}
-        undef reload if instance_methods.include?("reload")
+        remove_method(:reload) if instance_methods(false).include?("reload")
         def reload
           #{@cached_methods.map { |m| "remove_instance_variable(:@#{m}) if defined?(@#{m})" }.join(';')}
           super if defined? super

data/lib/activesp/connection.rb

@@ -1,3 +1,28 @@
+# Copyright (c) 2010 XAOP bvba
+# 
+# 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.
+
 require 'savon'
 require 'net/ntlm_http'
 
@@ -9,29 +34,40 @@ end
 
 module ActiveSP
   
+  # This class is uses to configure the connection to a SharePoint repository. This is
+  # the starting point for doing anything with SharePoint.
   class Connection
     
     include Util
     include PersistentCachingConfig
     
+    # @private
     # TODO: create profile
     attr_reader :login, :password, :root_url, :trace
     
+    # @param [Hash] options The connection options
+    # @option options [String] :root The URL of the root site
+    # @option options [String] :login (nil) The login
+    # @option options [String] :password (nil) The password associated with the given login. Is mandatory if the login is specified. Also can't be "password" as that is inherently insafe. We don't explicitly check for this, but it can't be that.
     def initialize(options = {})
+      options = options.dup
       @root_url = options.delete(:root) or raise ArgumentError, "missing :root option"
       @login = options.delete(:login)
       @password = options.delete(:password)
       @trace = options.delete(:trace)
       options.empty? or raise ArgumentError, "unknown options #{options.keys.map { |k| k.inspect }.join(", ")}"
       cache = nil
-      configure_persistent_cache { |c| cache = c }
+      configure_persistent_cache { |c| cache ||= c }
     end
     
+    # Finds the object with the given key
+    # @param [String] key The key of the object to find
+    # @return [Base, nil] The object with the given key, or nil if no object with the given key is found
     def find_by_key(key)
       type, trail = decode_key(key)
       case type[0]
       when ?S
-        ActiveSP::Site.new(self, trail[0] == "" ? @root_url : File.join(@root_url, trail[0]), trail[1].to_i)
+        ActiveSP::Site.new(self, trail[0] == "" ? @root_url : ::File.join(@root_url, trail[0]), trail[1].to_i)
       when ?L
         ActiveSP::List.new(find_by_key(trail[0]), trail[1])
       when ?U
@@ -45,19 +81,11 @@ module ActiveSP
       when ?P
         ActiveSP::PermissionSet.new(find_by_key(trail[0]))
       when ?F
-        parent = find_by_key(trail[0])
-        if ActiveSP::Folder === parent
-          ActiveSP::Folder.new(parent.list, trail[1], parent)
-        else
-          ActiveSP::Folder.new(parent, trail[1], nil)
-        end
+        list = find_by_key(trail[0])
+        ActiveSP::Folder.new(list, trail[1])
       when ?I
-        parent = find_by_key(trail[0])
-        if ActiveSP::Folder === parent
-          ActiveSP::Item.new(parent.list, trail[1], parent)
-        else
-          ActiveSP::Item.new(parent, trail[1], nil)
-        end
+        list = find_by_key(trail[0])
+        ActiveSP::Item.new(list, trail[1])
       when ?T
         parent = find_by_key(trail[0])
         if ActiveSP::List === parent
@@ -70,6 +98,12 @@ module ActiveSP
       end
     end
     
+    # Fetches the content at the given URL using the login and password with which this
+    # connection was constructed, if any. Always uses the GET method. Supports only
+    # HTTP as protocol at the time of writing. This is useful for fetching content files
+    # from the server.
+    # @param [String] url The URL to fetch
+    # @return [String] The content fetched from the URL
     def fetch(url)
       # TODO: support HTTPS too
       @open_params ||= begin
@@ -78,9 +112,12 @@ module ActiveSP
       end
       Net::HTTP.start(*@open_params) do |http|
         request = Net::HTTP::Get.new(URL(url).full_path.gsub(/ /, "%20"))
-        request.ntlm_auth(@login, @password)
+        request.ntlm_auth(@login, @password) if @login
         response = http.request(request)
-        response
+        # if Net::HTTPFound === response
+        #   response = fetch(response["location"])
+        # end
+        # response
       end
     end
     

data/lib/activesp/content_type.rb

@@ -1,3 +1,28 @@
+# Copyright (c) 2010 XAOP bvba
+# 
+# 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.
+
 module ActiveSP
   
   class ContentType < Base
@@ -7,9 +32,11 @@ module ActiveSP
     extend PersistentCaching
     include Util
     
+    # @private
     attr_reader :id
     
     persistent { |site, list, id, *a| [site.connection, [:content_type, id]] }
+    # @private
     def initialize(site, list, id, name = nil, description = nil, version = nil, group = nil)
       @site, @list, @id = site, list, id
       @Name = name if name
@@ -18,49 +45,71 @@ module ActiveSP
       @Group = group if group
     end
     
+    # Returns the scope of the content type. This can be either a site or a list
+    # @return [Site, List]
     def scope
       @list || @site
     end
     
+    # Returns the supertype of this content type. This is the content type as defined on the containing
+    # site in case this content type has a list as scope. returns nil for a content type that has a site
+    # as scope
+    # @return [ContentType, nil]
     def supertype
       superkey = split_id[0..-2].join("")
       (@list ? @list.content_type(superkey) : nil) || @site.content_type(superkey)
     end
     cache :supertype
     
+    # See {Base#key}
+    # @return [String]
     def key
       encode_key("T", [scope.key, @id])
     end
     
+    # @private
     def Name
       data["Name"].to_s
     end
     cache :Name
     
+    # @private
     def Description
       data["Description"].to_s
     end
     cache :Description
     
+    # @private
     def Version
       data["Version"].to_s
     end
     cache :Version
     
+    # @private
     def Group
       data["Group"].to_s
     end
     cache :Group
     
+    # Returns the list of fields defined for this content type
+    # @return [Array<Field>]
     def fields
       data.xpath("//sp:Field", NS).map { |field| scope.field(field["ID"]) }.compact
     end
-    cache :fields, :dup => true
+    cache :fields, :dup => :always
     
+    # See {Base#save}
+    # @return [void]
+    def save
+      p untype_cast_attributes(@site, nil, internal_attribute_types, changed_attributes)
+    end
+    
+    # @private
     def to_s
       "#<ActiveSP::ContentType Name=#{self.Name}>"
     end
     
+    # @private
     alias inspect to_s
     
   private

data/lib/activesp/field.rb

@@ -1,3 +1,28 @@
+# Copyright (c) 2010 XAOP bvba
+# 
+# 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.
+
 module ActiveSP
   
   class Field < Base
@@ -6,41 +31,62 @@ module ActiveSP
     extend Caching
     include Util
     
-    attr_reader :scope, :ID, :Name, :internal_type, :parent
+    # @private
+    attr_reader :ID, :Name, :internal_type
+    # Returns the scope of the field. This can be a site or a list
+    # @return [Site, List]
+    attr_reader :scope
+    # Returns the parent field. This is the field defined on the containing site in case the field has a list as scope
+    # @return [Field]
+    attr_reader :parent
     
     # There is no call to get to the field info directly, so these should always
     # be accessed through the site or list they belong to. Hence, we do not use
     # caching here as it is useless.
+    # @private
     def initialize(scope, id, name, type, parent, attributes_before_type_cast)
       @scope, @ID, @Name, @internal_type, @parent, @attributes_before_type_cast = scope, id, name, type, parent, attributes_before_type_cast
       @site = Site === @scope ? @scope : @scope.site
     end
     
+    # See {Base#key}
+    # @return [String]
     def key
       encode_key("A", [@scope.key, @ID])
     end
     
+    # @private
     def List
       list_for_lookup
     end
     
+    # @private
     def Type
       translate_internal_type(self)
     end
     
-    # This is only defined when it is true; joy to the world!
+    # @private
     def Mult
       !!attributes["Mult"]
     end
     
+    # @private
     def ReadOnly
       !!attributes["ReadOnly"]
     end
     
+    # See {Base#save}
+    # @return [void]
+    def save
+      p untype_cast_attributes(@site, nil, internal_attribute_types, changed_attributes)
+    end
+    
+    # @private
     def to_s
       "#<ActiveSP::Field name=#{self.Name}>"
     end
     
+    # @private
     alias inspect to_s
     
   private

data/lib/activesp/file.rb

@@ -0,0 +1,71 @@
+# Copyright (c) 2010 XAOP bvba
+# 
+# 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.
+
+module ActiveSP
+  
+  class File
+    
+    include InSite
+    
+    attr_reader :url
+    
+    def initialize(item, url, destroyable)
+      @item, @url, @destroyable = item, url, destroyable
+      @site = @item.list.site
+    end
+    
+    def file_name
+      ::File.basename(@url)
+    end
+    
+    def data
+      @item.list.site.connection.fetch(@url).body
+    end
+    
+    def destroy
+      if @destroyable
+        result = call("Lists", "delete_attachment", "listName" => @item.list.id, "listItemID" => @item.ID, "url" => @url)
+        if delete_result = result.xpath("//sp:DeleteAttachmentResponse", NS).first
+          self
+        else
+          raise "file could not be deleted"
+        end
+      else
+        raise TypeError, "this file cannot be destroyed"
+      end
+    end
+    
+    # @private
+    def to_s
+      "#<ActiveSP::File url=#{@url}>"
+    end
+    
+    # @private
+    alias inspect to_s
+    
+  end
+  
+end
+