proof-sharepoint-ruby 1.0.0

data/lib/sharepoint-http-auth.rb

@@ -0,0 +1,30 @@
+require 'curb'
+require 'cgi'
+
+module Sharepoint
+  module HttpAuth
+    class Session
+      attr_accessor :site
+      attr_reader :user, :password
+
+      def initialize site
+        @site     = site
+      end
+
+      def authenticate user, password
+        @user     = user
+        @password = password
+      end
+
+      def cookie
+        String.new
+      end
+
+      def curl curb
+        curb.http_auth_types = :ntlm
+        curb.username        = @user
+        curb.password        = @password
+      end
+    end
+  end
+end

data/lib/sharepoint-kerberos-auth.rb

@@ -0,0 +1,30 @@
+require 'curb'
+require 'cgi'
+
+module Sharepoint
+  module KerberosAuth
+    class Session
+      attr_accessor :site
+      attr_reader :user, :password
+
+      def initialize site
+        @site     = site
+      end
+
+      def authenticate user, password
+        @user     = user
+        @password = password
+      end
+
+      def cookie
+        String.new
+      end
+
+      def curl curb
+        curb.http_auth_types = :gssnegotiate
+        curb.username        = @user
+        curb.password        = @password
+      end
+    end
+  end
+end

data/lib/sharepoint-lists.rb

@@ -0,0 +1,235 @@
+module Sharepoint
+  LIST_TEMPLATE_TYPE = {
+    InvalidType: -1,
+    NoListTemplate: 0,
+    GenericList: 100,
+    DocumentLibrary: 101,
+    Survey: 102,
+    Links: 103,
+    Announcements: 104,
+    Contacts: 105,
+    Events: 106,
+    Tasks: 107,
+    DiscussionBoard: 108,
+    PictureLibrary: 109,
+    DataSources: 110,
+    UserInformation: 112,
+    WebPartCatalog: 113,
+    ListTemplateCatalog: 114,
+    XMLForm: 115,
+    MasterPageCatalog: 116,
+    NoCodeWorkflows: 117,
+    WorkflowProcess: 118,
+    WebPageLibrary: 119,
+    CustomGrid: 120,
+    SolutionCatalog: 121,
+    NoCodePublic: 122,
+    ThemeCatalog: 123,
+    DesignCatalog: 124,
+    AppDataCatalog: 125,
+    DataConnectionLibrary: 130,
+    WorkflowHistory: 140,
+    GanttTask: 150,
+    HelpLibrary: 151,
+    AccessRequest: 160,
+    TasksWithTimelineAndHierarchy: 171,
+    MaintenanceLogs: 175,
+    Meetings: 200,
+    Agenda: 201,
+    MeetingUser: 202,
+    Decision: 204,
+    MeetingObjective: 207,
+    TextBox: 210,
+    ThingsToBring: 211,
+    HomePageLibrary: 212,
+    Posts: 301,
+    Comments: 302,
+    Categories: 303,
+    Facility: 402,
+    Whereabouts: 403,
+    CallTrack: 404,
+    Circulation: 405,
+    Timecard: 420,
+    Hollidays: 421,
+    IMEDic: 499,
+    ExternalList: 600,
+    MySiteDocumentLibrary: 700,
+    IssueTracking: 1100,
+    AdminTasks: 1200,
+    HealthRules: 1220,
+    HealthReports: 1221,
+    DeveloperSiteDraftApps: 1230,
+    MicroFeed: 544 # Is undefined, but used by Sharepoint Online
+  }
+
+  module VtiBin
+    def self.translate_field_names input
+      return input unless defined? VtiDisplayNameDictionary
+      hash = Hash.new
+      input.keys.each do |key|
+        if VtiDisplayNameDictionary.keys.include? key
+          hash[VtiDisplayNameDictionary[key]] = input[key]
+        else
+          hash[key] = input[key]
+        end
+      end
+      hash
+    end
+  end
+
+  class List < Sharepoint::Object
+    include Sharepoint::Type
+    sharepoint_resource get_from_name: 'lists/getbytitle'
+
+    def find_items options = {}
+      @site.query :get, (make_item_filter options)
+    end
+
+    def item_count
+      @site.query :get, "#{__metadata['id']}/ItemCount"
+    end
+
+    def add_item attributes
+      attributes['__metadata']         ||= Hash.new
+      attributes['__metadata']['type'] ||= list_item_entity_type_full_name
+      @site.query :post, item_uri, attributes.to_json
+    end
+
+    def add_folder path, attributes
+      path      = path.gsub(/\/*$/, '') # remove slashes at the end of the path
+      site_url  = "#{@site.protocol}://#{@site.server_url}/"
+      action    = "#{site_url}_vti_bin/listdata.svc/#{self.title}"
+      path      = root_folder.server_relative_url + '/' + path
+      attributes['ContentTypeID'] ||= '0x01200059042D1A09191046851FA83D5B89816A'
+      attributes['Path']          ||= path
+      payload                       = VtiBin.translate_field_names(attributes).to_json
+      # Create the item using _vti_bin api
+      response = @site.query :post, action, payload, true do |curl|
+        curl.headers['Slug'] = "#{path}/#{attributes['Title']}|0x0120"
+      end
+      response = JSON.parse response
+      unless response['d'].nil?
+        # Fetch the item we just created using the REST api
+        item_id = response['d']['ID']
+        @site.query :get, "#{site_url}_api/#{__metadata['id']}/items(#{item_id})"
+      else
+        raise Sharepoint::SPException.new response, action, payload
+      end
+    end
+
+    field 'BaseTemplate', access: [ :read, :initialize ], default: LIST_TEMPLATE_TYPE[:GenericList]
+    field 'ContentTypesEnabled',                          default: true
+    field 'DefaultContentApprovalWorkflowId'
+    field 'DefaultDisplayFormUrl'
+    field 'DefaultEditFormUrl'
+    field 'DefaultNewFormUrl'
+    field 'Description'
+    field 'Direction'
+    field 'DocumentTemplateUrl'
+    field 'DraftVersionVisibility', default: 1
+    field 'EnableAttachments',      default: false
+    field 'EnableFolderCreation',   default: true
+    field 'EnableMinorVersions',    default: true
+    field 'EnableModeration',       default: true
+    field 'EnableVersioning',       default: true
+    field 'ForceCheckout',          default: false
+    field 'Hidden',                 default: false
+    field 'IrmEnabled',             default: false
+    field 'IrmExpire',              default: false
+    field 'IrmReject',              default: false
+    field 'IsApplicationList',      default: false
+    field 'MultipleDataList',       default: false
+    field 'NoCrawl',                default: false
+    field 'OnQuickLaunch',          default: false
+    field 'Title'
+    field 'ValidationFormula'
+    field 'ValidationMessage'
+
+  private
+    def item_uri
+      url = @data['Items']['__deferred']
+      url = url['uri'] if url.class != String
+      url
+    end
+
+    def make_item_filter options = {}
+      url         = item_uri
+      has_options = false
+      options.each do |key,value|
+        url += if has_options then '&' else '?' end
+        url += "$#{key}=#{URI::encode value.to_s}"
+        has_options = true
+      end
+      url
+    end
+  end
+
+  class ListItem < Sharepoint::Object
+    include Sharepoint::Type
+    belongs_to :list
+
+    method :break_role_inheritance, default_params: ({ copyroleassignements: true })
+    method :recycle
+    method :reset_role_inheritance
+    method :validate_update_item_list
+  end
+
+  class View < Sharepoint::Object
+    include Sharepoint::Type
+    belongs_to :list
+
+    field 'Aggregations'
+    field 'AggregationsStatus'
+    field 'ContentTypeId'
+    field 'DefaultView'
+    field 'DefaultViewForContentType'
+    field 'EditorModified'
+    field 'Formats'
+    field 'Hidden'
+    field 'IncludeRootFolder'
+    #field 'JsLink'
+    field 'ListViewXml'
+    field 'Method'
+    field 'MobileDefaultView'
+    field 'MobileView'
+    field 'Paged'
+    field 'RowLimit'
+    field 'Scope'
+    field 'Title'
+    field 'Toolbar'
+    field 'ViewData'
+    field 'ViewJoins'
+    field 'ViewProjectedFields'
+    field 'ViewQuery'
+
+    method :break_role_inheritance, default_params: ({ copyroleassignements: true })
+    method :recycle
+    method :render_list_form_data
+    method :reserve_list_item_id
+  end
+
+  class ViewFieldCollection < Sharepoint::Object
+    include Sharepoint::Type
+    sharepoint_resource
+    belongs_to :view
+
+    def add_view_field name
+      @site.query :post, "#{__metadata['uri']}/addviewfield('#{URI.encode name}')"
+    end
+
+    def move_view_field_to name, index
+      @site.query :post, "#{__metadata['uri']}/moveviewfieldto", {
+        field: name,
+        index: index
+      }.to_json
+    end
+
+    def remove_all_view_fields
+      @site.query :post, "#{__metadata['uri']}/removeallviewfields"
+    end
+
+    def remove_view_field name
+      @site.query :post, "#{__metadata['uri']}/removeviewfield('#{URI.encode name}')"
+    end
+  end
+end

data/lib/sharepoint-object.rb

@@ -0,0 +1,179 @@
+require 'sharepoint-properties'
+require 'sharepoint-stringutils'
+
+module Sharepoint
+  class Site
+  end
+
+  class Object < Sharepoint::ObjectProperties
+    class << self
+      attr_accessor :fields
+
+      def fields
+        @fields ||= []
+        if self.superclass != Sharepoint::Object
+          self.superclass.fields | @fields
+        else
+          @fields
+        end
+      end
+
+      protected
+
+      def field name, options = {}
+        options[:access] ||= [ :read, :write ]
+        @fields ||= []
+        @fields << { name: name, access: options[:access], default: options[:default] }
+      end
+
+      def method name, method_params = {}
+        method_params[:http_method]    ||= :post
+        method_params[:endpoint]       ||= name.to_s.camelize
+        method_params[:default_params] ||= Hash.new
+        define_method name, ->(params = Hash.new) do
+          action = "#{__metadata['uri']}/#{method_params[:endpoint]}"
+          body   = nil
+          # Set default parameters
+          (method_params[:default_params].each do |key,value|
+            params[key] == value if params[key].nil?
+          end)
+          if (method_params[:http_method] == :get) and (params.class < Hash) and (params.keys.count > 0)
+            # if method is get, Fill action with parameters
+            action     += '('
+            (params.each do |key,value|
+              action += ',' unless params.keys.first == key
+              action += key + '='
+              action += (if (value.class < String) or (value.class < Symbol)
+               "'#{(URI.encode value.gsub("'", %q(\\\')))}'"
+              else
+                value
+              end)
+            end)
+            action += ')'
+          else
+            # if method is post, send parameters in the body
+            body = (params.class < Hash ? params.to_json : params)
+          end
+          # Call action
+          @site.query method_params[:http_method], action, body, method_params[:skip_json]
+        end
+      end
+
+      def sharepoint_resource options = {}
+        options[:method_name]   ||= (self.name).split('::').last.downcase + 's'
+        options[:getter]        ||= options[:method_name]
+        options[:get_from_name] ||= options[:getter]
+        Sharepoint::Site.send :define_method, options[:method_name] do
+          self.query :get, options[:getter].to_s
+        end unless options[:no_root_collection] == true
+        Sharepoint::Site.send :define_method, (self.name).split('::').last.downcase do |id|
+          if id =~ /^[a-z0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}$/
+            self.query :get, "#{options[:getter]}(guid'#{id}')"
+          else
+            self.query :get, "#{options[:get_from_name]}('#{URI.encode id}')"
+          end
+        end
+      end
+
+      def belongs_to resource_name
+        resource_name = resource_name.to_s
+        class_name    = (self.name).split('::').last.downcase
+        method_name   = class_name.pluralize
+        define_singleton_method "all_from_#{resource_name}" do |resource|
+          resource.site.query :get, "#{resource.__metadata['uri']}/#{method_name}"
+        end
+        define_singleton_method "get_from_#{resource_name}" do |resource, name|
+          resource.site.query :get, "#{resource.__metadata['uri']}/#{method_name}('#{URI.encode name}')"
+        end
+        define_method "create_uri" do
+          unless self.parent.nil?
+            "#{self.parent.__metadata['uri']}/#{method_name}"
+          else
+            method_name
+          end
+        end
+      end
+    end
+
+    attr_accessor :parent
+
+    def initialize site, data
+      @parent = nil
+      super site, data
+    end
+
+    def guid
+      return @guid unless @guid.nil?
+      __metadata['id'].scan(/guid'([^']+)'/) do ||
+        @guid = $1
+        break
+      end
+      @guid
+    end
+
+    def reload
+      @site.query :get, __metadata['uri']
+    end
+
+    def save
+      if @data['__metadata'].nil? or @data['__metadata']['id'].nil?
+        create
+      elsif @updated_data.keys.count > 0
+        update
+      end
+    end
+
+    def destroy
+      @site.query :post, resource_uri do |curl|
+        curl.headers['X-HTTP-Method'] = 'DELETE'
+        curl.headers['If-Match']      = __metadata['etag']
+      end
+    end
+
+    def copy new_object = nil
+      updating     = !new_object.nil?
+      new_object ||= self.class.new @site
+      self.class.fields.each do |field|
+        next unless @data.keys.include? field[:name].to_s
+        next if (field[:access] & [ :write, :initialize ]).count == 0
+        value = @data[field[:name].to_s]
+        if updating == false
+          new_object.data[field[:name].to_s]         = value
+        elsif new_object.data[field[:name].to_s] != value
+          new_object.updated_data[field[:name].to_s] = value
+        end
+      end
+      new_object
+    end
+
+  private
+    def sharepoint_typename
+      if self.is_a?(Sharepoint::GenericSharepointObject)
+        @generic_type_name
+      else
+        self.class.name.split('::').last
+      end
+    end
+
+    def resource_uri
+      @data['__metadata']['uri'].gsub(/^https:\/\/[^\/]+\/_api\/web\//i, '')
+    end
+
+    def create_uri
+      sharepoint_typename.downcase.pluralize
+    end
+
+    def create
+      @site.query :post, create_uri, @data.to_json
+    end
+
+    def update
+      @updated_data['__metadata'] ||= @data['__metadata']
+      @site.query :post, resource_uri, @updated_data.to_json do |curl|
+        curl.headers['X-HTTP-Method'] = 'MERGE'
+        curl.headers['If-Match']      = __metadata['etag']
+      end
+      @updated_data = Hash.new
+    end
+  end
+end