activesp 0.0.1

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+ACTIVESP_VERSION = File.readlines("VERSION")[0][/[\d.]*/]
+
+desc "Build the gem"
+spec = Gem::Specification.new do |s|
+  s.name = "activesp"
+  s.version = ACTIVESP_VERSION
+  s.author = "Peter Vanbroekhoven"
+  s.email = "peter@xaop.com"
+  #s.homepage = "http://www.xaop.com/pages/dctmruby"
+  s.summary = "Interface to SharePoint"
+  s.description = s.summary
+  #s.rubyforge_project = s.name
+  s.files += %w(VERSION Rakefile)
+  s.files += Dir['lib/**/*.rb']
+  # s.bindir = "bin"
+  # s.executables.push(*(Dir['bin/*.rb'] - ["bin/encrypt-dmcl.rb"]).map { |f| File.basename(f) })
+  s.add_dependency('savon-xaop')
+  s.add_dependency('nokogiri')
+  # s.rdoc_options << '--exclude' << 'ext' << '--main' << 'README'
+  # s.extra_rdoc_files = ["README", "docs/README.html"]
+  s.has_rdoc = false
+  s.require_paths << 'lib'
+  # s.autorequire = 'mysql'
+  s.required_ruby_version = '>= 1.8.1'
+  s.platform = Gem::Platform::RUBY
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/activesp.rb

@@ -0,0 +1,26 @@
+require 'nokogiri'
+require 'time'
+
+module ActiveSP
+end
+
+require 'activesp/util'
+require 'activesp/caching'
+require 'activesp/persistent_caching'
+
+require 'activesp/base'
+
+require 'activesp/connection'
+require 'activesp/root'
+require 'activesp/site'
+require 'activesp/list'
+require 'activesp/item'
+require 'activesp/folder'
+require 'activesp/url'
+require 'activesp/content_type'
+require 'activesp/field'
+require 'activesp/ghost_field'
+require 'activesp/user'
+require 'activesp/group'
+require 'activesp/role'
+require 'activesp/permission_set'

data/lib/activesp/base.rb

@@ -0,0 +1,53 @@
+module ActiveSP
+  
+  class Base
+    
+    extend Caching
+    
+    def attributes
+      current_attributes
+    end
+    cache :attributes, :dup => true
+    
+    def attribute_types
+      internal_attribute_types
+    end
+    cache :attribute_types, :dup => true
+    
+    def has_attribute?(name)
+      attributes.has_key?(name)
+    end
+    
+    def has_writable_attribute?(name)
+      has_attribute?(name) && !attribute_types[name].ReadOnly
+    end
+    
+    def attribute(name)
+      attributes[name]
+    end
+    
+    def set_attribute(name, value)
+      current_attributes[name] = value
+    end
+    
+    def method_missing(m, *a, &b)
+      ms = m.to_s
+      if a.length == 0 && has_attribute?(ms)
+        attribute(ms)
+      elsif a.length == 1 && ms[-1] == ?= && has_writable_attribute?(ms[0..-2])
+        set_attribute(ms[0..-2], *a)
+      else
+        super
+      end
+    end
+    
+  private
+    
+    def current_attributes
+      original_attributes
+    end
+    cache :current_attributes
+    
+  end
+  
+end

data/lib/activesp/caching.rb

@@ -0,0 +1,31 @@
+module ActiveSP
+  
+  module Caching
+    
+    def cache(name, options = {})
+      duplicate = options.delete(:dup)
+      options.empty? or raise ArgumentError, "unsupported options #{options.keys.map { |k| k.inspect }.join(", ")}"
+      (@cached_methods ||= []) << name
+      alias_method("#{name}__uncached", name)
+      access = private_instance_methods.include?(name) ? "private" : protected_instance_methods.include?(name) ? "protected" : "public"
+      private("#{name}__uncached")
+      module_eval <<-RUBY
+        def #{name}(*a, &b)
+          if defined? @#{name}
+            @#{name}
+          else
+            @#{name} = #{name}__uncached(*a, &b)
+          end#{".dup" if duplicate}
+        end
+        #{access} :#{name}
+        undef reload if instance_methods.include?("reload")
+        def reload
+          #{@cached_methods.map { |m| "remove_instance_variable(:@#{m}) if defined?(@#{m})" }.join(';')}
+          super if defined? super
+        end
+      RUBY
+    end
+    
+  end
+  
+end

data/lib/activesp/connection.rb

@@ -0,0 +1,89 @@
+require 'savon'
+require 'net/ntlm_http'
+
+Savon::Request.logger.level = Logger::ERROR
+
+Savon::Response.error_handler do |soap_fault|
+  soap_fault[:detail][:errorstring]
+end
+
+module ActiveSP
+  
+  class Connection
+    
+    include Util
+    include PersistentCachingConfig
+    
+    # TODO: create profile
+    attr_reader :login, :password, :root_url, :trace
+    
+    def initialize(options = {})
+      @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 }
+    end
+    
+    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)
+      when ?L
+        ActiveSP::List.new(find_by_key(trail[0]), trail[1])
+      when ?U
+        ActiveSP::User.new(root, trail[0])
+      when ?G
+        ActiveSP::Group.new(root, trail[0])
+      when ?R
+        ActiveSP::Role.new(root, trail[0])
+      when ?A
+        find_by_key(trail[0]).field(trail[1])
+      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
+      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
+      when ?T
+        parent = find_by_key(trail[0])
+        if ActiveSP::List === parent
+          ActiveSP::ContentType.new(parent.site, parent, trail[1])
+        else
+          ActiveSP::ContentType.new(parent, nil, trail[1])
+        end
+      else
+        raise "not yet #{key.inspect}"
+      end
+    end
+    
+    def fetch(url)
+      # TODO: support HTTPS too
+      @open_params ||= begin
+        u = URL(@root_url)
+        [u.host, u.port]
+      end
+      Net::HTTP.start(*@open_params) do |http|
+        request = Net::HTTP::Get.new(URL(url).full_path.gsub(/ /, "%20"))
+        request.ntlm_auth(@login, @password)
+        response = http.request(request)
+        response
+      end
+    end
+    
+  end
+  
+end

data/lib/activesp/content_type.rb

@@ -0,0 +1,103 @@
+module ActiveSP
+  
+  class ContentType < Base
+    
+    include InSite
+    extend Caching
+    extend PersistentCaching
+    include Util
+    
+    attr_reader :id
+    
+    persistent { |site, list, id, *a| [site.connection, [:content_type, id]] }
+    def initialize(site, list, id, name = nil, description = nil, version = nil, group = nil)
+      @site, @list, @id = site, list, id
+      @Name = name if name
+      @Description = description if description
+      @Version = version if version
+      @Group = group if group
+    end
+    
+    def scope
+      @list || @site
+    end
+    
+    def supertype
+      superkey = split_id[0..-2].join("")
+      (@list ? @list.content_type(superkey) : nil) || @site.content_type(superkey)
+    end
+    cache :supertype
+    
+    def key
+      encode_key("T", [scope.key, @id])
+    end
+    
+    def Name
+      data["Name"].to_s
+    end
+    cache :Name
+    
+    def Description
+      data["Description"].to_s
+    end
+    cache :Description
+    
+    def Version
+      data["Version"].to_s
+    end
+    cache :Version
+    
+    def Group
+      data["Group"].to_s
+    end
+    cache :Group
+    
+    def fields
+      data.xpath("//sp:Field", NS).map { |field| scope.field(field["ID"]) }.compact
+    end
+    cache :fields, :dup => true
+    
+    def to_s
+      "#<ActiveSP::ContentType Name=#{self.Name}>"
+    end
+    
+    alias inspect to_s
+    
+  private
+    
+    def data
+      if @list
+        call("Lists", "get_list_content_type", "listName" => @list.id, "contentTypeId" => @id).xpath("//sp:ContentType", NS).first
+      else
+        call("Webs", "get_content_type", "contentTypeId" => @id).xpath("//sp:ContentType", NS).first
+      end
+    end
+    cache :data
+    
+    def original_attributes
+      type_cast_attributes(@site, nil, internal_attribute_types, clean_item_attributes(data.attributes))
+    end
+    cache :original_attributes
+    
+    def internal_attribute_types
+      @@internal_attribute_types ||= {
+        "Description" => GhostField.new("ColName", "Text", false, true),
+        "FeatureId" => GhostField.new("ColName", "Text", false, true),
+        "Group" => GhostField.new("ColName", "Text", false, true),
+        "Hidden" => GhostField.new("Hidden", "Bool", false, true),
+        "ID" => GhostField.new("ColName", "Text", false, true),
+        "Name" => GhostField.new("ColName", "Text", false, true),
+        "ReadOnly" => GhostField.new("ReadOnly", "Bool", false, true),
+        "Sealed" => GhostField.new("Sealed", "Bool", false, true),
+        "V2ListTemplateName" => GhostField.new("V2ListTemplateName", "Text", false, true),
+        "Version" => GhostField.new("Version", "Integer", false, true)
+      }
+    end
+    
+    def split_id
+      ["0x"] + @id[2..-1].scan(/[0-9A-F][1-9A-F]|[1-9A-F][0-9A-F]|00[0-9A-F]{32}/)
+    end
+    
+  end
+  
+end

data/lib/activesp/field.rb

@@ -0,0 +1,147 @@
+module ActiveSP
+  
+  class Field < Base
+    
+    include InSite
+    extend Caching
+    include Util
+    
+    attr_reader :scope, :ID, :Name, :internal_type, :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.
+    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
+    
+    def key
+      encode_key("A", [@scope.key, @ID])
+    end
+    
+    def List
+      list_for_lookup
+    end
+    
+    def Type
+      translate_internal_type(self)
+    end
+    
+    # This is only defined when it is true; joy to the world!
+    def Mult
+      !!attributes["Mult"]
+    end
+    
+    def ReadOnly
+      !!attributes["ReadOnly"]
+    end
+    
+    def to_s
+      "#<ActiveSP::Field name=#{self.Name}>"
+    end
+    
+    alias inspect to_s
+    
+  private
+    
+    def list_for_lookup
+      # I think List may be undefined for attributes defined at the site level, and that they need to be specified
+      # when used at the list level.
+      if %w[Lookup LookupMulti].include?(@internal_type) and list = @attributes_before_type_cast["List"]
+        if list[0] == ?{ && list[-1] == ?} # We have a GUID of a list
+          ActiveSP::List.new(@site, list)
+        elsif list == "Self"
+          List === @scope ? @scope : nil
+        end
+      end
+    end
+  
+    def original_attributes
+      @original_attributes ||= type_cast_attributes(@site, nil, internal_attribute_types, @attributes_before_type_cast.merge("List" => list_for_lookup, "Type" => self.Type, "internal_type" => internal_type))
+    end
+    
+    def internal_attribute_types
+      @@internal_attribute_types ||= {
+        "AllowDeletion" => GhostField.new("AllowDeletion", "Bool", false, true),
+        "AppendOnly" => GhostField.new("AppendOnly", "Bool", false, true),
+        "AuthoringInfo" => GhostField.new("AuthoringInfo", "Text", false, true),
+        "CalType" => GhostField.new("CalType", "Integer", false, true),
+        "CanToggleHidden" => GhostField.new("CanToggleHidden", "Bool", false, true),
+        "ClassInfo" => GhostField.new("ClassInfo", "Text", false, true),
+        "ColName" => GhostField.new("ColName", "Text", false, true),
+        "Description" => GhostField.new("Description", "Text", false, true),
+        "Dir" => GhostField.new("Dir", "Text", false, true),
+        "DisplaceOnUpgrade" => GhostField.new("DisplaceOnUpgrade", "Bool", false, true),
+        "DisplayImage" => GhostField.new("DisplayImage", "Text", false, true),
+        "DisplayName" => GhostField.new("DisplayName", "Text", false, true),
+        "DisplayNameSrcField" => GhostField.new("DisplayNameSrcField", "Text", false, true),
+        "DisplaySize" => GhostField.new("DisplaySize", "Integer", false, true),
+        "ExceptionImage" => GhostField.new("ExceptionImage", "Text", false, true),
+        "FieldRef" => GhostField.new("FieldRef", "Text", false, true),
+        "FillInChoice" => GhostField.new("FillInChoice", "Bool", false, true),
+        "Filterable" => GhostField.new("Filterable", "Bool", false, true),
+        "Format" => GhostField.new("Format", "Bool", false, true),
+        "FromBaseType" => GhostField.new("FromBaseType", "Bool", false, true),
+        "Group" => GhostField.new("Group", "Text", false, true),
+        "HeaderImage" => GhostField.new("HeaderImage", "Text", false, true),
+        "Height" => GhostField.new("Height", "Integer", false, true),
+        "Hidden" => GhostField.new("Hidden", "Bool", false, true),
+        "ID" => GhostField.new("ID", "Text", false, true),
+        "IMEMode" => GhostField.new("IMEMode", "Text", false, true),
+        "internal_type" => GhostField.new("internal_type", "Text", false, true),
+        "IsolateStyles" => GhostField.new("IsolateStyles", "Bool", false, true),
+        "JoinColName" => GhostField.new("JoinColName", "Text", false, true),
+        "JoinRowOrdinal" => GhostField.new("JoinRowOrdinal", "Integer", false, true),
+        "JoinType" => GhostField.new("JoinType", "Text", false, true),
+        "List" => GhostField.new("List", "ListReference", false, true),
+        "Max" => GhostField.new("Max", "Integer", false, true),
+        "MaxLength" => GhostField.new("MaxLength", "Integer", false, true),
+        "Min" => GhostField.new("Min", "Integer", false, true),
+        "Mult" => GhostField.new("Mult", "Bool", false, true),
+        "Name" => GhostField.new("Name", "Text", false, true),
+        "Node" => GhostField.new("Node", "Text", false, true),
+        "NoEditFormBreak" => GhostField.new("NoEditFormBreak", "Bool", false, true),
+        "NumLines" => GhostField.new("NumLines", "Text", false, true),
+        "Percentage" => GhostField.new("Percentage", "Bool", false, true),
+        "PIAttribute" => GhostField.new("PIAttribute", "Text", false, true),
+        "PITarget" => GhostField.new("PITarget", "Text", false, true),
+        "PrependId" => GhostField.new("PrependId", "Bool", false, true),
+        "PrimaryKey" => GhostField.new("PrimaryKey", "Bool", false, true),
+        "PrimaryPIAttribute" => GhostField.new("PrimaryPIAttribute", "Text", false, true),
+        "PrimaryPITarget" => GhostField.new("PrimaryPITarget", "Text", false, true),
+        "ReadOnly" => GhostField.new("ReadOnly", "Bool", false, true),
+        "ReadOnlyEnforced" => GhostField.new("ReadOnlyEnforced", "Bool", false, true),
+        "RenderXMLUsingPattern" => GhostField.new("ReadOnly", "Bool", false, true),
+        "Required" => GhostField.new("Required", "Bool", false, true),
+        "RestrictedMode" => GhostField.new("RestrictedMode", "Bool", false, true),
+        "RichText" => GhostField.new("RichText", "Bool", false, true),
+        "RichTextMode" => GhostField.new("RichTextMode", "Text", false, true),
+        "RowOrdinal" => GhostField.new("RowOrdinal", "Integer", false, true),
+        "Sealed" => GhostField.new("Sealed", "Bool", false, true),
+        "ShowInDisplayForm" => GhostField.new("ShowInDisplayForm", "Bool", false, true),
+        "ShowInListSettings" => GhostField.new("ShowInListSettings", "Bool", false, true),
+        "ShowInFileDlg" => GhostField.new("ShowInFileDlg", "Bool", false, true),
+        "ShowInVersionHistory" => GhostField.new("ShowInVersionHistory", "Bool", false, true),
+        "Sortable" => GhostField.new("Sortable", "Bool", false, true),
+        "SourceID" => GhostField.new("SourceID", "Text", false, true),
+        "StaticName" => GhostField.new("StaticName", "Text", false, true),
+        "StorageTZ" => GhostField.new("StorageTZ", "Bool", false, true),
+        "TextOnly" => GhostField.new("TextOnly", "Bool", false, true),
+        "Title" => GhostField.new("Title", "Text", false, true),
+        "Type" => GhostField.new("Type", "Text", false, true),
+        "SetAs" => GhostField.new("SetAs", "Text", false, true),
+        "ShowField" => GhostField.new("ShowField", "Text", false, true),
+        "ShowInEditForm" => GhostField.new("ShowInEditForm", "Bool", false, true),
+        "ShowInNewForm" => GhostField.new("ShowInNewForm", "Bool", false, true),
+        "UnlimitedLengthInDocumentLibrary" => GhostField.new("UnlimitedLengthInDocumentLibrary", "Bool", false, true),
+        "Version" => GhostField.new("Version", "Integer", false, true),
+        "Width" => GhostField.new("Width", "Integer", false, true),
+        "WikiLinking" => GhostField.new("WikiLinking", "Bool", false, true),
+        "XName" => GhostField.new("XName", "Text", false, true)
+      }
+    end
+    
+  end
+  
+end