activesp 0.0.1 → 0.0.4

data/lib/activesp/url.rb

@@ -1,3 +1,29 @@
+# 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.
+
+# @private
 def URL(*args)
   case args.length
   when 1
@@ -14,6 +40,7 @@ def URL(*args)
   end
 end
 
+# @private
 class URL < Struct.new(:protocol, :host, :port, :path, :query, :fragment)
   
   def self.parse(url)

data/lib/activesp/user.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 User < Base
@@ -7,21 +32,34 @@ module ActiveSP
     include Util
     include InSite
     
+    # @private
     attr_reader :login_name
     
     persistent { |site, login_name, *a| [site.connection, [:user, login_name]] }
-    def initialize(site, login_name)
+    # @private
+    def initialize(site, login_name, attributes_before_type_cast = nil)
       @site, @login_name = site, login_name
+      @attributes_before_type_cast = attributes_before_type_cast if attributes_before_type_cast
     end
     
+    # See {Base#key}
+    # @return [String]
     def key
       encode_key("U", [@login_name])
     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::User login_name=#{login_name}>"
     end
     
+    # @private
     alias inspect to_s
     
   private

data/lib/activesp/util.rb

@@ -1,9 +1,39 @@
+# 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 Util
     
   private
     
+    def decode_field_name(name)
+      name.gsub(/_x([0-9af]{4})_/i) { [$1.to_i(16)].pack("U") }
+    end
+    
     def clean_attributes(attributes)
       attributes.inject({}) { |h, (k, v)| h[k] = v.to_s ; h }
     end
@@ -13,7 +43,8 @@ module ActiveSP
     end
     
     def type_cast_attributes(site, list, fields, attributes)
-      attributes.inject({}) do |h, (k, v)|
+      result = attributes.inject({}) do |h, (k, v)|
+        k = decode_field_name(k)
         if field = fields[k]
           case field.internal_type
           when "ListReference"
@@ -34,17 +65,17 @@ module ActiveSP
           when "Bool"
             v = !!v[/true/i]
           when "File"
-            # v = v.sub(/\A.*?;#/, "")
+            v = v.sub(/\A\d+;#/, "")
           when "Note"
           
           when "User"
             d = split_multi(v)
-            v = User.new(site.connection.root, d[2][/\\/] ? d[2] : "SHAREPOINT\\system")
+            v = create_user_or_group(site, d[2])
           when "InternalUser"
-            v = User.new(site.connection.root, v[/\\/] ? v : "SHAREPOINT\\system")
+            v = create_user_or_group(site, v)
           when "UserMulti"
             d = split_multi(v)
-            v = (0...(d.length / 4)).map { |i| User.new(site.connection.root, d[4 * i + 2][/\\/] ? d[4 * i + 2] : "SHAREPOINT\\system") }
+            v = (0...(d.length / 4)).map { |i| create_user_or_group(site, d[4 * i + 2]) }
           
           when "Choice"
             # For some reason there is no encoding here
@@ -55,31 +86,183 @@ module ActiveSP
           when "Lookup"
             d = split_multi(v)
             if field.List
-              v = create_item_from_id(field.List, d[0])
+              v = construct_item_from_id(field.List, d[0])
             else
               v = d[2]
             end
           when "LookupMulti"
             d = split_multi(v)
             if field.List
-              v = (0...(d.length / 4)).map { |i| create_item_from_id(field.List, d[4 * i]) }
+              v = (0...(d.length / 4)).map { |i| construct_item_from_id(field.List, d[4 * i]) }
             else
               v = (0...(d.length / 4)).map { |i| d[4 * i + 2] }
             end
           
           else
             # raise NotImplementedError, "don't know type #{field.type.inspect} for #{k}=#{v.inspect}"
-            warn "don't know type #{field.internal_type.inspect} for #{k}=#{v.inspect} on self"
+            # Note: can't print self if it needs the attributes to be loaded, so just display the class
+            # warn "don't know type #{field.internal_type.inspect} for #{k}=#{v.inspect} on #{self.class}"
           end
         else
           # raise ArgumentError, "can't find field #{k.inspect}"
-          warn "can't find field #{k.inspect} on #{self}"
+          # Note: can't print self if it needs the attributes to be loaded, so just display the class
+          # warn "can't find field #{k.inspect} on #{self.class}"
+        end
+        h[k] = v
+        h
+      end
+      fields.each_key do |k|
+        result[k] = nil unless result.has_key?(k)
+      end
+      result
+    end
+    
+    def create_user_or_group(site, entry)
+      if entry == "System Account"
+        User.new(site.connection.root, "SHAREPOINT\\system")
+      elsif entry[/\\/]
+        User.new(site.connection.root, entry)
+      else
+        Group.new(site.connection.root, entry)
+      end
+    end
+    
+    def type_check_attribute(field, value)
+      case field.internal_type
+      when "Text", "File"
+        value.to_s
+      when "Bool", "Boolean"
+        !!value
+      when "Integer"
+        Integer(value)
+      when "StandardDateTime", "XMLDateTime"
+        Time === value and value or raise ArgumentError, "wrong type for #{field.Name} attribute"
+      when "InternalUser"
+        value = value.to_s
+        @site.rootsite.user(value) and value or raise ArgumentError, "user with login #{value} does not exist for #{field.Name} attribute"
+      when "Lookup"
+        if field.List
+          if ::ActiveSP::Item === value && value.list == field.List
+            value
+          else
+            raise ArgumentError, "wrong type for #{field.Name} attribute"
+          end
+        else
+          value.to_s
+        end
+      when "LookupMulti"
+        if field.List
+          begin
+            value = Array(value)
+          rescue Exception
+            raise ArgumentError, "wrong type for #{field.Name} attribute"
+          end
+          value.map do |val|
+            if ::ActiveSP::Item === val && val.list == field.List
+              val
+            else
+              raise ArgumentError, "wrong type for #{field.Name} attribute"
+            end
+          end
+        else
+          raise ArgumentError, "wrong type for #{field.Name} attribute"
+        end
+      when "DateTime"
+        Time === value and value or raise ArgumentError, "wrong type for #{field.Name} attribute"
+      when "User"
+        if ::ActiveSP::User === value || field.attributes["UserSelectionMode"] == "PeopleAndGroups" && ::ActiveSP::Group === value
+          # TODO: check if the user is in the correct group in case a group is specified
+          value
+        else
+          raise ArgumentError, "wrong type for #{field.Name} attribute"
+        end
+      when "UserMulti"
+        begin
+          value = Array(value)
+        rescue Exception
+          raise ArgumentError, "wrong type for #{field.Name} attribute"
+        end
+        value.map do |val|
+          if ::ActiveSP::User === val || field.attributes["UserSelectionMode"] == "PeopleAndGroups" && ::ActiveSP::Group === val
+            # TODO: check if the user is in the correct group in case a group is specified
+            val
+          else
+            raise ArgumentError, "wrong type for #{field.Name} attribute"
+          end
+        end
+      else
+        raise "not yet #{field.Name}:#{field.internal_type}"
+      end
+    end
+    
+    def type_check_attributes_for_creation(fields, attributes)
+      attributes.inject({}) do |h, (k, v)|
+        if field = fields[k]
+          if !field.ReadOnly
+            h[k] = type_check_attribute(field, v)
+            h
+          else
+            raise ArgumentError, "field #{field.Name} is read-only"
+          end
+        else
+          raise "can't find field #{k.inspect}"
+        end
+      end
+    end
+    
+    def untype_cast_attributes(site, list, fields, attributes)
+      attributes.inject({}) do |h, (k, v)|
+        if field = fields[k]
+          case field.internal_type
+          when "Text", "File"
+          when "Bool"
+            v = v ? "TRUE" : "FALSE"
+          when "Boolean"
+            v = v ? "1" : "0"
+          when "Integer"
+            v = v.to_s
+          when "DateTime"
+            v = v.strftime("%Y-%m-%d %H:%M:%S")
+          when "User"
+            v = v.ID
+          when "UserMulti"
+            v = v.map { |ug| ug.ID }.join(";#;#")
+          when "Lookup"
+            v = v.ID
+          when "LookupMulti"
+            v = v.map { |i| i.ID }.join(";#;#")
+          else
+            raise "don't know type #{field.internal_type.inspect} for #{k}=#{v.inspect} on self"
+          end
+        else
+          raise "can't find field #{k.inspect} on #{self}"
         end
         h[k] = v
         h
       end
     end
     
+    def construct_xml_for_copy_into_items(fields, attributes)
+      attributes.map do |k, v|
+        field = fields[k]
+        Builder::XmlMarkup.new.wsdl(
+          :FieldInformation,
+          "Type" => field.internal_type,
+          "Id" => field.ID,
+          "Value" => v,
+          "InternalName" => field.StaticName,
+          "DisplayName" => field.DisplayName
+        )
+      end.join("")
+    end
+    
+    def construct_xml_for_update_list_items(xml, fields, attributes)
+      attributes.map do |k, v|
+        field = fields[k]
+        xml.Field(v, "Name" => field.StaticName)
+      end
+    end
+    
     def encode_key(type, trail)
       "#{type}::#{trail.map { |t| t.to_s.gsub(/:/, ":-") }.join("::")}"
     end
@@ -94,7 +277,7 @@ module ActiveSP
       s.scan(/((?:[^;]|;;#|;[^#;]|;;(?!#))+)(;#)?/).flatten
     end
     
-    def create_item_from_id(list, id)
+    def construct_item_from_id(list, id)
       query = Builder::XmlMarkup.new.Query do |xml|
         xml.Where do |xml|
           xml.Eq do |xml|
@@ -133,36 +316,11 @@ module ActiveSP
       end
     end
     
+    # Somewhat dirty
+    def escape_xml(xml)
+      Builder::XmlMarkup.new.s(xml).scan(/\A<s>(.*)<\/s>\z/)
+    end
+    
   end
   
 end
-
-
-__END__
-
-escaping in field names:
-
-_x[4-digit code]_
-
-[space]      20
-<            3C
->            3E
-#            23
-%            25
-{            7B
-}            7D
-|            7C
-\            5C
-^            5E
-~            7E
-[            5B
-]            5D
-`            60
-;            3B
-/            2F
-?            3F
-:            3A
-@            40
-=            3D
-&            26
-$            24

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: activesp
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Peter Vanbroekhoven
@@ -9,30 +15,38 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-02 00:00:00 +02:00
+date: 2010-09-29 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: savon-xaop
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: nokogiri
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
-description: Interface to SharePoint
+  type: :runtime
+  version_requirements: *id002
+description: An object-oriented interface to SharePoint that uses the web services provided by SharePoint to connect to it. Supports SharePoint 2007 and 2010.
 email: peter@xaop.com
 executables: []
 
@@ -42,12 +56,16 @@ extra_rdoc_files: []
 
 files: 
 - VERSION
+- LICENSE
+- README.rdoc
 - Rakefile
+- lib/activesp/associations.rb
 - lib/activesp/base.rb
 - lib/activesp/caching.rb
 - lib/activesp/connection.rb
 - lib/activesp/content_type.rb
 - lib/activesp/field.rb
+- lib/activesp/file.rb
 - lib/activesp/folder.rb
 - lib/activesp/ghost_field.rb
 - lib/activesp/group.rb
@@ -62,8 +80,8 @@ files:
 - lib/activesp/user.rb
 - lib/activesp/util.rb
 - lib/activesp.rb
-has_rdoc: true
-homepage: 
+has_rdoc: false
+homepage: http://www.xaop.com/labs/activesp
 licenses: []
 
 post_install_message: 
@@ -73,21 +91,29 @@ require_paths:
 - lib
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 53
+      segments: 
+      - 1
+      - 8
+      - 1
       version: 1.8.1
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Interface to SharePoint