restful-sharepoint 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1324f5b122d4dd534dcf277599dd89358cbe7bc8
+  data.tar.gz: 2cf9047b24b6a1e6f0e133b71f4e6d50902c29f7
+SHA512:
+  metadata.gz: d7773e2dd73c2ab3fd23d31e13949959c6b24521b44492a9f2350ada71a9181087fc37cb3ffd67f624970a1981be0ca2acd028aab02494bb55b8b6f55f92b66b
+  data.tar.gz: 2e222664a50607fe17d2e7cb0add5ff1bf2ec4f05bc4bc60a008c1ffff5090792c974b367b974863c33b990922b1f5fdefc369cdb684950bcca0f26f7fe52baf

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2017 Mareeba Shire Council
+
+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.

data/README.md

@@ -0,0 +1,15 @@
+Provides a convenient object model to the OData REST API of SharePoint 2013 and newer.
+
+No unit tests as of yet.
+
+Examples
+--------
+``` ruby
+require 'restful-sharepoint'
+connection = RestfulSharePoint::Connection.new('http://sharepoint/mysite/', 'username', 'password')
+list = RestfulSharePoint::List.from_title('My List', connection)
+list_item = list.Items[0] # Dynamically invoke the deferred "Items" element
+first_attachment = list_item.AttachmentFiles[0].content
+
+list_item.values # Return the raw tree structure
+```

data/lib/restful-sharepoint.rb

@@ -0,0 +1,32 @@
+require 'json'
+require 'httpi'
+require 'curb'
+require 'cgi'
+require 'require_pattern'
+
+HTTPI.adapter = :curb
+
+module RestfulSharePoint
+  OBJECT_MAP = {
+    "SP.Web" => :Web,
+    "SP.List" => :List,
+    /SP\.Data\..*Item/ => :ListItem,
+    "SP.File" => :File,
+    "SP.Attachment" => :Attachment
+  }
+
+  COLLECTION_MAP = {
+    "SP.Web" => :Webs,
+    "SP.List" => :Lists,
+    /SP\.Data\..*Item/ => :ListItems,
+    "SP.Attachment" => :Attachments
+  }
+end
+
+require_relative './restful-sharepoint/version.rb'
+require_relative './restful-sharepoint/error.rb'
+require_relative './restful-sharepoint/connection.rb'
+require_relative './restful-sharepoint/common_base.rb'
+require_relative './restful-sharepoint/object.rb'
+require_relative './restful-sharepoint/collection.rb'
+require_relative_pattern './restful-sharepoint/*/*.rb'

data/lib/restful-sharepoint/collection.rb

@@ -0,0 +1,60 @@
+module RestfulSharePoint
+  class Collection < CommonBase
+    DEFAULT_OPTIONS = {}
+
+    def self.object_class
+      Object
+    end
+
+    def initialize(parent: nil, connection: nil, collection: nil, options: {})
+      @parent = parent
+      @connection = connection || @parent.connection # Iterate collection and coerce each into into a ListItem
+      self.collection = collection
+      self.options = options
+    end
+
+    attr_accessor :connection
+
+    attr_reader :options
+    def options=(options)
+      @options = self.class::DEFAULT_OPTIONS.merge(options)
+    end
+
+    attr_writer :endpoint
+    def endpoint
+      @endpoint || (raise NotImplementedError, "Endpoint needs to be set")
+    end
+
+    def collection=(collection)
+      @collection = collection
+      @collection&.each_with_index do |v,i|
+        @collection[i] = objectify(v)
+      end
+      @properties
+    end
+
+    def collection
+      @collection || self.collection = connection.get(endpoint, options: @options)
+    end
+
+    def values
+      collection.dup.each { |k,v| properties[k] = v.values if v.is_a?(Object) || v.is_a?(Collection) }
+    end
+
+    def next
+      self.new(@connection, @connection.get(collection['__next']))
+    end
+
+    def to_json(*args, &block)
+      collection.to_json(*args, &block)
+    end
+
+    def method_missing(method, *args, &block)
+      collection.respond_to?(method) ? collection.send(method, *args, &block) : super
+    end
+
+    def respond_to_missing?(method, include_all = false)
+      collection.respond_to?(method, include_all)
+    end
+  end
+end

data/lib/restful-sharepoint/collections/attachments.rb

@@ -0,0 +1,13 @@
+module RestfulSharePoint
+  class Attachments < Collection
+
+    def self.object_class
+      Attachment
+    end
+
+    def endpoint
+      "#{@parent.endpoint}/AttachmentFiles"
+    end
+
+  end
+end

data/lib/restful-sharepoint/collections/list-items.rb

@@ -0,0 +1,13 @@
+module RestfulSharePoint
+  class ListItems < Collection
+
+    def self.object_class
+      ListItem
+    end
+
+    def endpoint
+      "#{@parent.endpoint}/Items"
+    end
+
+  end
+end

data/lib/restful-sharepoint/collections/lists.rb

@@ -0,0 +1,13 @@
+module RestfulSharePoint
+  class Lists < Collection
+
+    def self.object_class
+      List
+    end
+
+    def endpoint
+      "#{@parent.endpoint}/Lists"
+    end
+
+  end
+end

data/lib/restful-sharepoint/collections/webs.rb

@@ -0,0 +1,13 @@
+module RestfulSharePoint
+  class Webs < Collection
+
+    def self.object_class
+      Web
+    end
+
+    def endpoint
+      "#{@parent}/Webs"
+    end
+
+  end
+end

data/lib/restful-sharepoint/common-base.rb

@@ -0,0 +1,16 @@
+module RestfulSharePoint
+  class CommonBase
+    # Converts the given enumerable tree to a collection or object.
+    def objectify(tree)
+      if tree['results'] && !tree['results'].empty?
+        type = tree.dig('__metadata', 'type')  || tree.dig('results', 0, '__metadata', 'type')
+        pattern, klass = COLLECTION_MAP.find { |pattern,| pattern.match(type)  }
+        klass ? RestfulSharePoint.const_get(klass).new(parent: self, collection: tree['results']) : tree['results']
+      elsif tree['__metadata']
+        type = tree['__metadata']['type']
+        pattern, klass = OBJECT_MAP.find { |pattern,| pattern.match(type)  }
+        klass ? RestfulSharePoint.const_get(klass).new(parent: self, properties: tree) : tree
+      end
+    end
+  end
+end

data/lib/restful-sharepoint/connection.rb

@@ -0,0 +1,72 @@
+require 'date'
+require 'uri'
+
+module RestfulSharePoint
+  class Connection
+    def initialize(site_url, username = nil, password = nil)
+      @site_url = site_url
+      @username = username
+      @password = password
+    end
+
+    attr_reader :site_url
+
+    def get(path, options: {})
+      request path, :get, options: options
+    end
+
+    # Path can be either relative to the site URL, or a complete URL itself.
+    # Takes an optional `options` hash which are any number of valid OData query options (dollar sign prefix is added automatically)
+    # Also takes an optional block that is provided the HTTPI::Request instance, allowing customisation of the request.
+    def request(path, method, options: {}, body: nil)
+      url = URI.parse(path).is_a?(URI::HTTP) ? path : "#{@site_url}#{path}"
+      options_str = options.map { |k,v| "$#{k}=#{CGI.escape v.to_s}" }.join('&')
+      url += "?#{options_str}"
+      req = HTTPI::Request.new(url: url, headers: {'accept' => 'application/json; odata=verbose'})
+      req.auth.ntlm(@username, @password) if @username
+      if body
+        req.body = body.to_json.gsub('/', '\\/') # SharePoint requires forward slashes be escaped in JSON (WTF!!!)
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['X-HTTP-Method'] = 'MERGE' # TODO: Extend logic to support all operations
+        req.headers['If-Match'] = '*'
+      end
+      yield(request) if block_given?
+      response = HTTPI.request(method, req)
+      if response.body.empty?
+        if response.code >= 300
+          raise RestError, "Server returned HTTP status #{response.code} with no message body."
+        end
+      else
+        if response.headers['Content-Type'].start_with? "application/json"
+          data_tree = parse(response.body)
+        else
+          response.body
+        end
+      end
+    end
+
+  protected
+
+    def parse(str)
+      data = JSON.parse(str)
+      raise RestError, "(#{data['error']['code']}): #{data['error']['message']['value']}" if data['error']
+      parse_tree(data['d'])
+    end
+
+    def parse_tree(tree)
+      indices = tree.respond_to?(:keys) ? tree.keys : 0...tree.length
+      indices.each do |i|
+        if tree[i].respond_to?(:=~) && tree[i] =~ /^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$/
+          tree[i] = DateTime.parse(tree[i]).new_offset(DateTime.now.offset)
+        elsif tree[i].respond_to?(:gsub!)
+          # Convert relative paths to absolute URL's.
+          tree[i].gsub!(/((?<=href=)|(?<=src=))['"](\/.+?)['"]/, %Q("#{@site_url}\\2\"))
+        elsif tree[i].is_a? Enumerable
+          parse_tree(tree[i])
+        end
+      end
+      tree
+    end
+
+  end
+end

data/lib/restful-sharepoint/error.rb

@@ -0,0 +1,5 @@
+module RestfulSharePoint
+  class Error < RuntimeError; end
+  class RestError < Error; end
+  class FileNotFound < Error; end
+end

data/lib/restful-sharepoint/object.rb

@@ -0,0 +1,76 @@
+module RestfulSharePoint
+  class Object < CommonBase
+    DEFAULT_OPTIONS = {}
+
+    def initialize(parent: nil, connection: nil, properties: nil, id: nil, options: {})
+      raise Error, "Either a parent or connection must be provided." unless parent || connection
+      @parent = parent
+      @connection = connection || @parent.connection
+      self.properties = properties
+      @id = id
+      self.options = options
+    end
+
+    attr_accessor :connection
+    attr_reader :options
+    def options=(options)
+      @options = self.class::DEFAULT_OPTIONS.merge(options)
+    end
+
+    attr_writer :endpoint
+    def endpoint
+
+    end
+
+    def properties=(properties)
+      @properties = properties
+      @properties&.each do |k,v|
+        if v.respond_to?(:keys) && v['__deferred']
+          define_singleton_method(k) do |options = {}|
+            if Hash === properties[k] && properties[k]['__deferred']
+              fetch_deferred(k, options)
+            else
+              warn("`options` have been ignored as `#{k}` has already been loaded") unless options.empty?
+              properties[k]
+            end
+          end
+        elsif v.respond_to?(:keys) && (v['__metadata'] || v['results'])
+          @properties[k] = objectify(v)
+        end
+      end
+      @properties
+    end
+
+    def properties
+      @properties || self.properties = connection.get(endpoint, options: @options)
+    end
+
+    def values
+      properties.dup.each { |k,v| properties[k] = v.values if v.is_a?(Object) || v.is_a?(Collection) }
+    end
+
+    def fetch_deferred(property, options = {})
+      data = connection.get(@properties[property]['__deferred']['uri'], options: options)
+      @properties[property] = objectify(data)
+    end
+
+    def to_json(*args, &block)
+      properties.to_json(*args, &block)
+    end
+
+    def method_missing(method, *args, &block)
+      if properties.respond_to?(method)
+        properties.send(method, *args, &block)
+      elsif self.methods(false).include?(method) # Works around lazily loaded `properties`
+        self.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, include_all = false)
+      properties.respond_to?(method, include_all)
+    end
+
+  end
+end

data/lib/restful-sharepoint/objects/attachment.rb

@@ -0,0 +1,10 @@
+module RestfulSharePoint
+  class Attachment < File
+
+    def endpoint
+      url = URI.parse(connection.site_url)
+      url.path = URI.encode(@properties['ServerRelativeUrl'])
+      url.to_s
+    end
+  end
+end

data/lib/restful-sharepoint/objects/file.rb

@@ -0,0 +1,35 @@
+module RestfulSharePoint
+  class File < Object
+
+    def endpoint
+      "#{@parent.endpoint}/File"
+    end
+
+    def content
+      @content ||= connection.get(url)
+    end
+
+    def url
+      url = URI.parse(connection.site_url)
+      url.path = URI.encode(self['ServerRelativeUrl'])
+      url.to_s
+    end
+
+    # In bytes
+    def size
+      self['Length'] || content.length
+    end
+
+    def name
+      filename.rpartition('.').first
+    end
+
+    def filename
+      self['ServerRelativeUrl'].rpartition('/').last
+    end
+
+    def extension
+      self['ServerRelativeUrl'].rpartition('.').last
+    end
+  end
+end

data/lib/restful-sharepoint/objects/image.rb

@@ -0,0 +1,19 @@
+module RestfulSharePoint
+  class File < Object
+    # Overwrite can be true, false, or a date.
+    def save_thumbnail(dest, size: '128x128', format: 'jpg', overwrite: true)
+      if !::File.exist?(dest) || overwrite == true || (Time === overwrite && ::File.mtime(dest) < overwrite)
+        image = MiniMagick::Image.read(content).collapse!
+        image.combine_options do |img|
+          img.thumbnail "#{size}^"
+          img.gravity "center"
+          img.colorspace "sRGB"
+          img.background "white"
+          img.flatten # Merges images with white background
+        end
+        image.format format
+        image.write dest
+      end
+    end
+  end
+end

data/lib/restful-sharepoint/objects/list-item.rb

@@ -0,0 +1,9 @@
+module RestfulSharePoint
+  class ListItem < Object
+
+    def endpoint
+      "#{@parent.endpoint}/Items(#{@id})"
+    end
+
+  end
+end

data/lib/restful-sharepoint/objects/list.rb

@@ -0,0 +1,14 @@
+module RestfulSharePoint
+  class List < Object
+
+    def self.from_title(title, connection)
+      new(connection: connection).tap do |list|
+        list.define_singleton_method(:endpoint) { "/_api/web/lists/getbytitle('#{URI.encode title}')" }
+      end
+    end
+
+    def endpoint
+      "/_api/web/lists(guid'#{@id}')"
+    end
+  end
+end

data/lib/restful-sharepoint/objects/web.rb

@@ -0,0 +1,8 @@
+module RestfulSharePoint
+  class Web < Object
+
+    def endpoint
+      "/_api/web/"
+    end
+  end
+end

data/lib/restful-sharepoint/version.rb

@@ -0,0 +1,3 @@
+module RestfulSharePoint
+  VERSION = '0.1.1'
+end

data/restful-sharepoint.gemspec

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'restful-sharepoint/version'
+
+Gem::Specification.new 'restful-sharepoint', RestfulSharePoint::VERSION do |s|
+  s.summary           = 'Provides a convenient object model to the OData REST API of SharePoint 2013 and newer.'
+  s.description       = 'Provides a convenient object model to the OData REST API of SharePoint 2013 and newer.'
+  s.authors           = ['Tom Wardrop']
+  s.email             = 'tomw@msc.qld.gov.au'
+  s.homepage          = 'https://github.com/Wardrop/restful-sharepoint'
+  s.license           = 'MIT'
+  s.files             = Dir.glob(`git ls-files`.split("\n") - %w[.gitignore])
+  s.has_rdoc          = 'yard'
+
+  s.required_ruby_version = '>= 2.0.0'
+
+  s.add_dependency 'httpi', '~> 2.4'
+  s.add_dependency 'curb', '~> 0.9'
+  s.add_dependency 'require_pattern'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: restful-sharepoint
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tom Wardrop
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: require_pattern
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a convenient object model to the OData REST API of SharePoint
+  2013 and newer.
+email: tomw@msc.qld.gov.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/restful-sharepoint.rb
+- lib/restful-sharepoint/collection.rb
+- lib/restful-sharepoint/collections/attachments.rb
+- lib/restful-sharepoint/collections/list-items.rb
+- lib/restful-sharepoint/collections/lists.rb
+- lib/restful-sharepoint/collections/webs.rb
+- lib/restful-sharepoint/common-base.rb
+- lib/restful-sharepoint/connection.rb
+- lib/restful-sharepoint/error.rb
+- lib/restful-sharepoint/object.rb
+- lib/restful-sharepoint/objects/attachment.rb
+- lib/restful-sharepoint/objects/file.rb
+- lib/restful-sharepoint/objects/image.rb
+- lib/restful-sharepoint/objects/list-item.rb
+- lib/restful-sharepoint/objects/list.rb
+- lib/restful-sharepoint/objects/web.rb
+- lib/restful-sharepoint/version.rb
+- restful-sharepoint.gemspec
+homepage: https://github.com/Wardrop/restful-sharepoint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Provides a convenient object model to the OData REST API of SharePoint 2013
+  and newer.
+test_files: []