sharepoint-ruby 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae2fa825b6ae80d590550ff62b460e1dadcf48eb
+  data.tar.gz: 929e567c7977f3da76dfb0111578b422f195f5a1
+SHA512:
+  metadata.gz: 738befa9bedaf7032b6d3e7f00bc01fcd3145d16d4e44c35f18f38b86ab15267405b14ac1bd7f19573a481a66ec96ca21b1b62266c81ea47355422af6a5da343
+  data.tar.gz: f869e68e7d377126d05651a06022d23c02660cfd132d192306472f65e6fa21c63050e1993250018daa8a75f5a180e5c302820778b51cc8c61ff5ca9b94ced807

data/lib/sharepoint-fields.rb

@@ -0,0 +1,126 @@
+module Sharepoint
+  class Field < Sharepoint::Object
+    include Sharepoint::Type
+    sharepoint_resource
+    belongs_to :list
+
+    field 'DefaultValue'
+    field 'Description'
+    field 'Direction'
+    field 'EnforceUniqueValues'
+    field 'FieldTypeKind'
+    field 'Group'
+    field 'Hidden'
+    field 'Indexed'
+    field 'JSLink'
+    field 'ReadOnlyField'
+    field 'Required'
+    field 'SchemaXml'
+    field 'Scope'
+    field 'Sealed'
+    field 'Sortable'
+    field 'StaticName'
+    field 'Title'
+    field 'TypeAsString'
+    #field 'ValidationFormula'
+    #field 'ValidationMessage'
+  end
+
+  module Taxonomy
+    class TaxonomyField < Field
+    end
+  end
+
+  class FieldCalculated < Field
+    field 'DateFormat'
+    field 'Formula'
+    field 'OutputType'
+  end
+
+  class FieldComputed < Field
+    field 'EnableLookup'
+  end
+
+  class FieldDateTime < Field
+    field 'DateTimeCalendarType'
+    field 'DisplayFormat'
+    field 'FriendlyDisplayFormat'
+  end
+
+  class FieldGeolocation < Field
+  end
+
+  class FieldGuid < Field
+  end
+
+  class FieldLookup < Field
+    field 'AllowMultipleValues'
+    field 'IsRelationship'
+    field 'LookUpField'
+    field 'LookUpList'
+    field 'LookUpWebId'
+    field 'PrimaryFieldId'
+    field 'RelationshipDeleteBehavior'
+
+    def create_uri
+      unless parent.nil?
+        parent.__metadata['uri'] + '/fields/addfield'
+      else
+        'fields/addfield'
+      end
+    end
+
+    def create
+      @site.query :post, create_uri, { parameters: @data }.to_json
+    end
+  end
+
+  class FieldUser < FieldLookup
+    field 'AllowDisplay'
+    field 'Presence'
+    field 'SelectionGroup'
+    field 'SelectionMode'
+  end
+
+  class FieldMultiChoice < Field
+    field 'Choices'
+    field 'FillInChoice'
+  end
+
+  class FieldChoice < Field
+    field 'EditFormat'
+  end
+
+  class FieldRatingScale < Field
+    field 'GridEndNumber'
+    field 'GridNAOptionText'
+    field 'GridStartNumber'
+    field 'GridTextRangeAverage'
+    field 'GridTextRangeHigh'
+    field 'GridTextRangeLow'
+  end
+
+  class FieldMultiLineText < Field
+    field 'AllowHyperlink'
+    field 'AppendOnly'
+    field 'NumberOfLines'
+    field 'RestrictedMode'
+    field 'RichText'
+  end
+
+  class FieldNumber < Field
+    field 'MaximumValue'
+    field 'MinimumValue'
+  end
+
+  class FieldCurrency < FieldNumber
+    field 'CurrencyLocaleId'
+  end
+
+  class FieldText < Field
+    field 'MaxLength'
+  end
+
+  class FieldUrl < Field
+  end
+end

data/lib/sharepoint-files.rb

@@ -0,0 +1,69 @@
+require 'open-uri'
+
+module Sharepoint
+  class Folder < Sharepoint::Object
+    include Sharepoint::Type
+    sharepoint_resource get_from_name: 'GetFolderByServerRelativeUrl'
+
+    field 'WelcomePage'
+    field 'UniqueContentTypeOrder'
+
+    method :recycle
+
+    def file_from_name name
+      @site.query :get, "#{__metadata['uri']}/files/getbyurl('#{URI::encode(name.to_s)}')"
+    end
+
+    def add_file name, content
+      uri = "#{__metadata['uri']}/files/add(overwrite=true,url='#{URI::encode(name.to_s)}')"
+      @site.query :post, uri, content
+    end
+
+    def add_folder name
+      uri  = "#{__metadata['uri']}/folders"
+      body = { '__metadata' => { 'type' => 'SP.Folder' }, 'ServerRelativeUrl' => name.to_s }
+      @site.query :post, uri, body.to_json
+    end
+  end
+
+  class File < Sharepoint::Object
+    include Sharepoint::Type
+    belongs_to :folder
+    sharepoint_resource getter: 'GetFileByServerRelativeUrl', no_root_collection: true
+
+    method :approve,                     default_params: ({ comment: '' })
+    method :deny,                        default_params: ({ comment: '' })
+    method :checkin,                     default_params: ({ comment: '', checkintype: 0 })
+    method :checkout
+    method :undo_checkout
+    method :copy_to,                     default_params: ({ overwrite: true })
+    method :move_to,                     default_params: ({ flags: 9 })
+    method :get_limited_webpart_manager, default_params: ({ scope: 0 }), http_method: :get
+    method :download,                    endpoint: '$value',             http_method: :get, skip_json: true
+    method :upload,                      endpoint: '$value',             http_method: :put
+    method :publish,                     default_params: ({ comment: '' })
+    method :unpublish,                   default_params: ({ comment: '' })
+    method :recycle
+
+    def upload_from_file filename
+      content = String.new
+      ::File.open filename, 'rb' do |file|
+        line = nil
+        content += line while line = file.gets
+      end
+      upload content
+    end
+
+    def download_to_file filename
+      content = download
+      ::File.open filename, "w:#{content.encoding.name}" do |file|
+        file.write content
+      end
+    end
+  end
+
+  class FileVersion < Sharepoint::Object
+    include Sharepoint::Type
+    belongs_to :file
+  end
+end

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-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.protocole}://#{@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

data/lib/sharepoint-properties.rb

@@ -0,0 +1,96 @@
+require 'sharepoint-stringutils'
+
+module Sharepoint
+  class ObjectProperties
+    attr_accessor :site, :data, :updated_data
+
+    def initialize site, data
+      @site                      = site
+      @data                      = data
+      @updated_data              = Hash.new
+      @properties                = Hash.new
+      @properties_names          = Array.new
+      @properties_original_names = Array.new
+      initialize_properties
+    end
+
+    def add_property property, value = nil
+      editable                = is_property_editable? property
+      property                = property.to_s
+      @data[property]         = nil   if @data[property].nil?
+      @data[property]         = value unless value.nil?
+      @updated_data[property] = value if (@initialize_properties == false) and (editable == true)
+      unless @properties_original_names.include? property
+        @properties_names          << property.underscore.to_sym
+        @properties_original_names << property
+        define_singleton_method property.underscore do
+          get_property property
+        end
+        define_singleton_method property.underscore + '=' do |new_value|
+          @data[property]         = new_value
+          @updated_data[property] = new_value
+        end if editable == true
+      end
+    end
+
+    def add_properties properties
+      properties.each do |property|
+        add_property property
+      end
+    end
+
+    def available_properties
+      @properties_names
+    end
+
+    private
+
+    def initialize_properties
+      @initialize_properties = true
+      # Create the properties defined for the Sharepoint type used
+      self.class.fields.each do |field|
+        add_property field[:name], field[:default] if field[:access].include? :read
+      end
+      # Set the values and create any missing properties from the OData object
+      @data.dup.each do |key,value|
+        add_property key, value
+      end
+      @initialize_properties = false
+    end
+
+    def get_property property_name
+      data = @data[property_name]
+      if not @properties[property_name].nil?
+        @properties[property_name]
+      elsif data.class == Hash
+        if not data['__deferred'].nil?
+          @properties[property_name] = get_deferred_property property_name
+        elsif not data['__metadata'].nil?
+          @properties[property_name] = @site.make_object_from_data data
+        else
+          @properties[property_name] = data
+        end
+      elsif not data.nil?
+        @properties[property_name]   = data
+      else
+        @properties[property_name]   = nil
+      end
+    end
+
+    def get_deferred_property property_name
+      deferred_data = @data[property_name]['__deferred']
+      uri           = deferred_data['uri'].gsub /^http.*\/_api\/web\//i, ''
+      @site.query :get, uri
+    end
+
+    def is_property_editable? property_name
+      # We don't know a priori what the fields are for a generic object, so leave the validation work to the user
+      return true if self.is_a?(GenericSharepointObject)
+        
+      self.class.fields.each do |field|
+        return field[:access].include? :write if field[:name] == property_name
+      end
+      false
+    end
+  end
+end

data/lib/sharepoint-ruby.rb

@@ -0,0 +1,131 @@
+require 'curb'
+require 'json'
+require 'sharepoint-session'
+require 'sharepoint-object'
+require 'sharepoint-types'
+
+module Sharepoint
+  class SPException < Exception
+    def initialize data, uri = nil, body = nil
+      @data = data['error']
+      @uri  = uri
+      @body = body
+    end
+
+    def lang         ; @data['message']['lang']  ; end
+    def message      ; @data['message']['value'] ; end
+    def code         ; @data['code'] ; end
+    def uri          ; @uri ; end
+    def request_body ; @body ; end
+  end
+
+  class Site
+    attr_reader   :server_url
+    attr_accessor :url, :protocole
+    attr_accessor :session
+    attr_accessor :name
+    attr_accessor :verbose
+
+    def initialize server_url, site_name
+      @server_url  = server_url
+      @name        = site_name
+      @url         = "#{@server_url}/#{@name}"
+      @session     = Session.new self
+      @web_context = nil
+      @protocole   = 'https'
+      @verbose     = false
+    end
+
+    def authentication_path
+      "#{@protocole}://#{@server_url}/_forms/default.aspx?wa=wsignin1.0"
+    end
+
+    def api_path uri
+      "#{@protocole}://#{@url}/_api/web/#{uri}"
+    end
+
+    def filter_path uri
+      uri
+    end
+
+    def context_info
+      query :get, ''
+    end
+
+    # Sharepoint uses 'X-RequestDigest' as a CSRF security-like.
+    # The form_digest method acquires a token or uses a previously acquired
+    # token if it is still supposed to be valid.
+    def form_digest
+      if @web_context.nil? or (not @web_context.is_up_to_date?)
+        @getting_form_digest = true
+        @web_context         = query :post, "#{@protocole}://#{@server_url}/_api/contextinfo"
+        @getting_form_digest = false
+      end
+      @web_context.form_digest_value
+    end
+
+    def query method, uri, body = nil, skip_json=false, &block
+      uri        = if uri =~ /^http/ then uri else api_path(uri) end
+      arguments  = [ uri ]
+      arguments << body if method != :get
+      result = Curl::Easy.send "http_#{method}", *arguments do |curl|
+        curl.headers["Cookie"]          = @session.cookie
+        curl.headers["Accept"]          = "application/json;odata=verbose"
+        if method != :get
+          curl.headers["Content-Type"]    = curl.headers["Accept"]
+          curl.headers["X-RequestDigest"] = form_digest unless @getting_form_digest == true
+        end
+        curl.verbose = @verbose
+        @session.send :curl, curl unless not @session.methods.include? :curl
+        block.call curl           unless block.nil?
+      end
+
+      unless skip_json || (result.body_str.nil? || result.body_str.empty?)
+        begin
+          data = JSON.parse result.body_str
+          raise Sharepoint::SPException.new data, uri, body unless data['error'].nil?
+          make_object_from_response data
+        rescue JSON::ParserError => e
+          raise Exception.new("Exception with body=#{body}, e=#{e.inspect}, #{e.backtrace.inspect}, response=#{result.body_str}")
+        end
+      else
+        result.body_str
+      end
+    end
+
+    def make_object_from_response data
+      if data['d']['results'].nil?
+        data['d'] = data['d'][data['d'].keys.first] if data['d']['__metadata'].nil?
+        if not data['d'].nil?
+          make_object_from_data data['d']
+        else
+          nil
+        end
+      else
+        array = Array.new
+        data['d']['results'].each do |result|
+          array << (make_object_from_data result)
+        end
+        array
+      end
+    end
+
+    # Uses sharepoint's __metadata field to solve which Ruby class to instantiate,
+    # and return the corresponding Sharepoint::Object.
+    def make_object_from_data data
+      type_name  = data['__metadata']['type'].gsub(/^SP\./, '')
+      type_parts = type_name.split '.'
+      type_name  = type_parts.pop
+      constant   = Sharepoint
+      type_parts.each do |part| constant = constant.const_get part end
+
+      klass      = constant.const_get type_name rescue nil
+      if klass
+        klass.new self, data
+      else
+        Sharepoint::GenericSharepointObject.new type_name, self, data
+      end
+    end
+  end
+end
+

data/lib/sharepoint-session.rb

@@ -0,0 +1,92 @@
+require 'erb'
+require 'curb'
+
+module Sharepoint
+  MICROSOFT_STS_URL = "https://login.microsoftonline.com/extSTS.srf"
+
+  module Soap
+    class Authenticate
+      SOURCE = "soap/authenticate.xml.erb"
+
+      attr_accessor :username, :password, :login_url
+
+      def self.initialize
+        return if @initialized == true
+        @erb          = ERB.new(::File.read ::File.dirname(__FILE__) + '/' + SOURCE)
+        @erb.filename = SOURCE
+        @erb.def_method self, 'render()'
+        @initialized  = true
+      end
+
+      def initialize params = {}
+        Authenticate.initialize
+        @username  = params[:username]
+        @password  = params[:password]
+        @login_url = params[:url]
+      end
+    end
+  end
+
+  class Session
+    class ConnexionToStsFailed < Exception ; end
+    class ConnexionToSharepointFailed < Exception; end
+    class UnknownAuthenticationError  < Exception; end
+    class AuthenticationFailed < Exception
+      def initialize message ; super message ; end
+    end
+
+    attr_accessor :site
+
+    def initialize site
+      @site = site
+    end
+
+    def authenticate user, password, sts_url = nil
+      sts_url ||= MICROSOFT_STS_URL
+      authenticate_to_sts user, password, sts_url
+      get_access_token
+    end
+
+    def cookie
+      "FedAuth=#{@fed_auth};rtFa=#{@rtFa}"
+    end
+
+  private
+    def authenticate_to_sts user, password, sts_url
+      query    = Soap::Authenticate.new username: user, password: password, url: @site.authentication_path
+      response = Curl::Easy.http_post sts_url, query.render rescue raise ConnexionToStsFailed.new
+
+      response.body_str.scan(/<wsse:BinarySecurityToken[^>]*>([^<]+)</) do
+        offset          = ($~.offset 1)
+        @security_token = response.body[offset[0]..offset[1] - 1]
+      end
+      authentication_failed response.body_str if @security_token.nil?
+    end
+
+    def get_cookie_from_header header, cookie_name
+      result = nil
+      header.scan(/#{cookie_name}=([^;]+);/) do
+        offset = $~.offset 1
+        result = header[offset[0]..offset[1] - 1]
+      end
+      result
+    end
+
+    def get_access_token
+      http = Curl::Easy.http_post @site.authentication_path, @security_token
+      @rtFa     = get_cookie_from_header http.header_str, 'rtFa'
+      @fed_auth = get_cookie_from_header http.header_str, 'FedAuth'
+      raise UnknownAuthenticationError.new if @fed_auth.nil? or @rtFa.nil?
+    end
+
+    def authentication_failed xml
+      message   = 'Unknown authentication error'
+      xml.scan(/<psf:text[^>]*>([^<]+)</) do
+        offset  = ($~.offset 1)
+        message = xml[offset[0]..offset[1] - 1]
+      end
+      raise AuthenticationFailed.new message
+    end
+  end
+end
+

data/lib/sharepoint-stringutils.rb

@@ -0,0 +1,37 @@
+# Defines underscore and pluralize methods
+# unless they've already been defined by another script.
+
+unless String.new.methods.include? :underscore
+  class String
+    def underscore
+      self.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+    end
+  end
+end
+
+unless String.new.methods.include? :camelize
+  class String
+    def camelize
+      self.split("_").each {|s| s.capitalize! }.join("")
+    end
+  end
+end
+
+unless String.new.methods.include? :pluralize
+  class String
+    def pluralize
+      if self.match /y$/
+        self.gsub /y$/, 'ies'
+      elsif self.match /us$/
+        self.gsub /us$/, 'i'
+      else
+        self + 's'
+      end
+    end
+  end
+end
+

data/lib/sharepoint-types.rb

@@ -0,0 +1,83 @@
+require 'sharepoint-object'
+
+module Sharepoint
+  class UnsupportedType < ::Exception
+    attr_accessor :type_name
+
+    def initialize type_name
+      @type_name = type_name
+    end
+
+    def message
+      "unsupported type '#{@type_name}'"
+    end
+  end
+
+  module Type
+    def initialize site, data = nil
+      data               ||= Hash.new
+      data['__metadata'] ||= {
+        'type' => "SP.#{self.class.name.split('::').last}"
+      }
+      super site, data
+    end
+  end
+end
+
+require 'sharepoint-users'
+require 'sharepoint-lists'
+require 'sharepoint-files'
+require 'sharepoint-fields'
+require 'date'
+
+module Sharepoint
+  ##
+  ## Sharepoint Management
+  ##
+  class Web < Sharepoint::Object
+    include Sharepoint::Type
+
+    field 'CustomMasterUrl'
+    field 'Description'
+    field 'EnableMinimalDownload'
+    field 'MasterUrl'
+    field 'QuickLaunchEnabled'
+    field 'SaveSiteAsTemplateEnabled'
+    field 'SyndicationEnabled'
+    field 'Title'
+    field 'TreeViewEnabled'
+    field 'UiVersion'
+    field 'UiVersionConfigurationEnabled'
+
+    method :apply_theme
+    method :break_role_inheritance, default_params: ({ clearsubscopes: true })
+  end
+
+  class ContextWebInformation < Sharepoint::Object
+    include Sharepoint::Type
+
+    def issued_time
+      strtime = (form_digest_value.split ',').last
+      DateTime.strptime strtime, '%d %b %Y %H:%M:%S %z'
+    end
+
+    def timeout_time
+      issued_time + Rational(form_digest_timeout_seconds, 86400)
+    end
+
+    def is_up_to_date?
+      DateTime.now < timeout_time
+    end
+  end
+
+  class FeatureCollection < Sharepoint::Object
+    include Sharepoint::Type
+  end
+
+  ##
+  ## Other types
+  ##
+  class PropertyValues < Sharepoint::Object
+    include Sharepoint::Type
+  end
+end

data/lib/sharepoint-users.rb

@@ -0,0 +1,36 @@
+module Sharepoint
+  class Group < Sharepoint::Object
+    include Sharepoint::Type
+    sharepoint_resource getter: :sitegroups
+  end
+
+  class User < Sharepoint::Object
+    include Sharepoint::Type
+    sharepoint_resource getter: :siteusers
+    belongs_to :group
+  end
+
+  class UserCustomAction < Sharepoint::Object
+    include Sharepoint::Type
+    sharepoint_resource
+  end
+
+  class RoleAssignment < Sharepoint::Object
+    include Sharepoint::Type
+    sharepoint_resource
+  end
+
+  class RoleDefinition < Sharepoint::Object
+    include Sharepoint::Type
+  end
+
+  class GenericSharepointObject < Sharepoint::Object
+    include Sharepoint::Type
+    sharepoint_resource
+
+    def initialize type_name, site, data
+      super site, data
+      @generic_type_name = type_name
+    end
+  end
+end

data/lib/soap/authenticate.xml.erb

@@ -0,0 +1,28 @@
+<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+  <s:Header>
+    <a:Action s:mustUnderstand="1">http://schemas.xmlsoap.org/ws/2005/02/trust/RST/Issue</a:Action>
+   <a:ReplyTo>
+      <a:Address>http://www.w3.org/2005/08/addressing/anonymous</a:Address>
+   </a:ReplyTo>
+   <a:To s:mustUnderstand="1">https://login.microsoftonline.com/extSTS.srf</a:To>
+   <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
+      <o:UsernameToken>
+        <o:Username><%= @username %></o:Username>
+        <o:Password><%= @password %></o:Password>
+      </o:UsernameToken>
+    </o:Security>
+  </s:Header>
+  <s:Body>
+    <t:RequestSecurityToken xmlns:t="http://schemas.xmlsoap.org/ws/2005/02/trust">
+      <wsp:AppliesTo xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
+        <a:EndpointReference>'
+          <a:Address><%= @login_url %></a:Address>'
+        </a:EndpointReference>'
+      </wsp:AppliesTo>'
+      <t:KeyType>http://schemas.xmlsoap.org/ws/2005/05/identity/NoProofKey</t:KeyType>
+      <t:RequestType>http://schemas.xmlsoap.org/ws/2005/02/trust/Issue</t:RequestType>
+      <t:TokenType>urn:oasis:names:tc:SAML:1.0:assertion</t:TokenType>'
+    </t:RequestSecurityToken>'
+</s:Body>'
+</s:Envelope>
+

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: sharepoint-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Michael Martin Moro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+description: Client for Sharepoint's REST API
+email: michael@unetresgrossebite.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sharepoint-fields.rb
+- lib/sharepoint-files.rb
+- lib/sharepoint-http-auth.rb
+- lib/sharepoint-lists.rb
+- lib/sharepoint-object.rb
+- lib/sharepoint-properties.rb
+- lib/sharepoint-ruby.rb
+- lib/sharepoint-session.rb
+- lib/sharepoint-stringutils.rb
+- lib/sharepoint-types.rb
+- lib/sharepoint-users.rb
+- lib/soap/authenticate.xml.erb
+homepage: https://github.com/Plaristote/sharepoint-ruby
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: sharepoint client
+test_files: []