nextcloud 1.3.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nextcloud"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nextcloud.rb

@@ -0,0 +1,47 @@
+require "net/https"
+require "nokogiri"
+
+require "nextcloud/version/nextcloud"
+require "nextcloud/errors/nextcloud"
+
+require "nextcloud/helpers/nextcloud"
+require "nextcloud/helpers/properties"
+
+require "nextcloud/api"
+
+require "nextcloud/ocs_api"
+require "nextcloud/ocs/user"
+require "nextcloud/ocs/group"
+require "nextcloud/ocs/app"
+require "nextcloud/ocs/file_sharing_api"
+
+require "nextcloud/webdav_api"
+require "nextcloud/webdav/directory"
+
+require "nextcloud/models/user"
+require "nextcloud/models/directory"
+
+# Namespace for Nextcloud OCS API communication
+module Nextcloud
+  class << self
+    # Access to OCS API from base instance
+    #
+    # @param [Hash] args authentication credentials.
+    # @option args [String] :url Nextcloud instance URL
+    # @option args [String] :username Nextcloud instance administrator username
+    # @option args [String] :password Nextcloud instance administrator password
+    def ocs(args)
+      OcsApi.new(args)
+    end
+
+    # Access to WebDAV API from base instance
+    #
+    # @param [Hash] args authentication credentials.
+    # @option args [String] :url Nextcloud instance URL
+    # @option args [String] :username Nextcloud instance administrator username
+    # @option args [String] :password Nextcloud instance administrator password
+    def webdav(args)
+      WebdavApi.new(args)
+    end
+  end
+end

data/lib/nextcloud/api.rb

@@ -0,0 +1,51 @@
+module Nextcloud
+  class Api
+    attr_reader :url, :username, :password
+    protected :url
+    protected :username
+    protected :password
+
+    # Gathers credentials for communicating with Nextcloud instance
+    #
+    # @param [Hash] args authentication credentials.
+    # @option args [String] :url Nextcloud instance URL
+    # @option args [String] :username Nextcloud instance administrator username
+    # @option args [String] :password Nextcloud instance administrator password
+    def initialize(args)
+      @url = URI(args[:url] + "/ocs/v2.php/cloud/")
+      @username = args[:username]
+      @password = args[:password]
+    end
+
+    # Sends API request to Nextcloud
+    #
+    # @param method [Symbol] Request type. Can be :get, :post, :put, etc.
+    # @param path [String] Nextcloud OCS API request path
+    # @param params [Hash, nil] Parameters to send
+    # @return [Object] Nokogiri::XML::Document
+    def request(method, path, params = nil, body = nil, depth = nil, destination = nil, raw = false)
+      response = Net::HTTP.start(@url.host, @url.port,
+        use_ssl: @url.scheme == "https") do |http|
+        req = Kernel.const_get("Net::HTTP::#{method.capitalize}").new(
+          @url.to_s + path, 'Content-Type': "application/x-www-form-urlencoded"
+        )
+        req["OCS-APIRequest"] = true
+        req.basic_auth @username, @password
+        req["Content-Type"] = "application/x-www-form-urlencoded"
+
+        req["Depth"] = 0 if depth
+        req["Destination"] = destination if destination
+
+        req.set_form_data(params) if params
+        req.body = body if body
+
+        http.request(req)
+      end
+
+      # if ![201, 204, 207].include? response.code
+      #   raise Errors::Error.new("Nextcloud received invalid status code")
+      # end
+      raw ? response.body : Nokogiri::XML.parse(response.body)
+    end
+  end
+end

data/lib/nextcloud/errors/nextcloud.rb

@@ -0,0 +1,5 @@
+module Nextcloud
+  module Errors
+    class Error < StandardError; end
+  end
+end

data/lib/nextcloud/helpers/nextcloud.rb

@@ -0,0 +1,101 @@
+require "active_support/core_ext/hash"
+require "json"
+
+module Nextcloud
+  # Helper methods that are used through lib
+  module Helpers
+    # Makes an array out of repeated elements
+    #
+    # @param doc [Object] Nokogiri::XML::Document
+    # @param xpath [String] Path to element that is being repeated
+    # @return [Array] Parsed array
+    def parse_with_meta(doc, xpath)
+      groups = []
+      doc.xpath(xpath).each do |prop|
+        groups << prop.text
+      end
+      meta = get_meta(doc)
+      groups.send(:define_singleton_method, :meta) do
+        meta
+      end
+      groups
+    end
+
+    # Parses meta information returned by API, may include a status, status code and a message
+    #
+    # @param doc [Object] Nokogiri::XML::Document
+    # @return [Hash] Parsed hash
+    def get_meta(doc)
+      meta = doc.xpath("//meta/*").each_with_object({}) do |node, meta|
+        meta[node.name] = node.text
+      end
+    end
+
+    # Converts document to hash
+    #
+    # @param doc [Object] Nokogiri::XML::Document
+    # @param xpath [String] Document path to convert to hash
+    # @return [Hash] Hash that was produced from XML document
+    def doc_to_hash(doc, xpath = "/")
+      h = Hash.from_xml(doc.xpath(xpath).to_xml)
+      h
+    end
+
+    # Adds meta method to an object
+    #
+    # @param doc [Object] Nokogiri::XML::Document to take meta information from
+    # @param obj [#define_singleton_method] Object to add meta method to
+    # @return [#define_singleton_method] Object with meta method defined
+    def add_meta(doc, obj)
+      meta = get_meta(doc)
+      obj.define_singleton_method(:meta) { meta } && obj
+    end
+
+    # Extracts remaining part of url
+    #
+    # @param href [String] Full url
+    # @param url [String] Part to give away
+    # @return [String] "Right" part of string
+    def path_from_href(href, url)
+      href.match(/#{url}(.*)/)[1]
+    end
+
+    # Shows errors, or success message
+    #
+    # @param doc [Object] Nokogiri::XML::Document
+    # @return [Hash] State response
+    def parse_dav_response(doc)
+      doc.remove_namespaces!
+      if doc.at_xpath("//error")
+        {
+            exception: doc.xpath("//exception").text,
+            message: doc.xpath("//message").text
+        }
+      elsif doc.at_xpath("//status")
+        {
+            status: doc.xpath("//status").text
+        }
+      else
+        {
+            status: "ok"
+        }
+      end
+    end
+
+    # Shows error or returns false
+    #
+    # @param doc [Object] Nokogiri::XML::Document
+    # @return [Hash,Boolean] Returns error message if found, false otherwise
+    def has_dav_errors(doc)
+      doc.remove_namespaces!
+      if doc.at_xpath("//error")
+        {
+            exception: doc.xpath("//exception").text,
+            message: doc.xpath("//message").text
+        }
+      else
+        false
+      end
+    end
+  end
+end

data/lib/nextcloud/helpers/properties.rb

@@ -0,0 +1,73 @@
+module Nextcloud
+  module Helpers
+    module Properties
+      # Body to send to receive item properties
+      RESOURCE = '<?xml version="1.0"?>
+        <d:propfind  xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns" xmlns:nc="http://nextcloud.org/ns">
+          <d:prop>
+            <d:getlastmodified />
+            <d:getetag />
+            <d:resourcetype />
+            <d:getcontenttype />
+            <d:getcontentlength />
+            <oc:id />
+            <oc:fileid />
+            <oc:permissions />
+            <oc:size />
+            <nc:has-preview />
+            <oc:favorite />
+            <oc:comments-href />
+            <oc:comments-count />
+            <oc:comments-unread />
+            <oc:owner-id />
+            <oc:owner-display-name />
+            <oc:share-types />
+            <nc:has-preview />
+          </d:prop>
+        </d:propfind>'.freeze
+
+      # Body to send to add an item to favorites
+      MAKE_FAVORITE = '<?xml version="1.0"?>
+        <d:propertyupdate xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">
+          <d:set>
+            <d:prop>
+              <oc:favorite>1</oc:favorite>
+            </d:prop>
+          </d:set>
+        </d:propertyupdate>'.freeze
+
+      # Body to send to unfavorite an item
+      UNFAVORITE = '<?xml version="1.0"?>
+        <d:propertyupdate xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns">
+          <d:set>
+            <d:prop>
+              <oc:favorite>0</oc:favorite>
+            </d:prop>
+          </d:set>
+        </d:propertyupdate>'.freeze
+
+      # Body to send for receiving favorites
+      FAVORITE = '<?xml version="1.0"?>
+        <oc:filter-files  xmlns:d="DAV:" xmlns:oc="http://owncloud.org/ns" xmlns:nc="http://nextcloud.org/ns">
+          <oc:filter-rules>
+            <oc:favorite>1</oc:favorite>
+          </oc:filter-rules>
+          <d:prop>
+            <d:getlastmodified />
+            <d:getetag />
+            <d:getcontenttype />
+            <d:resourcetype />
+            <oc:fileid />
+            <oc:permissions />
+            <oc:size />
+            <d:getcontentlength />
+            <nc:has-preview />
+            <oc:favorite />
+            <oc:comments-unread />
+            <oc:owner-display-name />
+            <oc:share-types />
+          </d:prop>
+        </oc:filter-files>'.freeze
+    end
+  end
+end

data/lib/nextcloud/models/directory.rb

@@ -0,0 +1,74 @@
+module Nextcloud
+  module Models
+    # Directory model
+    #
+    # @!attribute [rw] href
+    #   @return [String] File/directory location
+    # @!attribute [rw] lastmodified
+    #   @return [String] Last modification time of file/directory
+    # @!attribute [rw] tag
+    #   @return [Hash] Etag
+    # @!attribute [rw] resourcetype
+    #   @return [String] Type of a resource
+    # @!attribute [rw] contenttype
+    #   @return [String] Type of content
+    # @!attribute [rw] contentlength
+    #   @return [String] Length of content
+    # @!attribute [rw] id
+    #   @return [String] ID
+    # @!attribute [rw] fileid
+    #   @return [String] Fileid
+    # @!attribute [rw] permissions
+    #   @return [String] Permissions
+    # @!attribute [rw] has_preview
+    #   @return [String] Has preview or not
+    # @!attribute [rw] favorite
+    #   @return [String] Is favorited or not
+    # @!attribute [rw] comments_href
+    #   @return [String] Address of comments
+    # @!attribute [rw] comments_count
+    #   @return [String] Comments count
+    # @!attribute [rw] comments_unread
+    #   @return [String] Unread comments
+    # @!attribute [rw] owner_id
+    #   @return [String] Id of owner
+    # @!attribute [rw] owner_display_name
+    #   @return [String] Display name of owner
+    # @!attribute [rw] share_types
+    #   @return [String] Share types
+    class Directory
+      attr_accessor :meta, :contents
+
+      # Initiates a model instance
+      #
+      # @param [Hash]
+      def initialize(href: nil, lastmodified: nil, tag: nil, resourcetype: nil, contenttype: nil, contentlength: nil,
+        id: nil, fileid: nil, permissions: nil, size: nil, has_preview: nil, favorite: nil,
+        comments_href: nil, comments_count: nil, comments_unread: nil, owner_id: nil,
+        owner_display_name: nil, share_types: nil, skip_contents: false)
+
+        self.class.params.each do |v|
+          instance_variable_set("@#{v}", instance_eval(v.to_s)) if instance_eval(v.to_s)
+        end
+
+        remove_instance_variable (:@skip_contents) if skip_contents
+      end
+
+      @params = instance_method(:initialize).parameters.map(&:last)
+      @params.each { |p| instance_eval("attr_accessor :#{p}") }
+
+      class << self
+        attr_reader :params
+      end
+
+      # Adds content to collection
+      #
+      # @param [Hash]
+      # @return [Array] Contents array
+      def add(args)
+        @contents = [] if @contents.nil?
+        @contents << self.class.new(args.merge(skip_contents: true))
+      end
+    end
+  end
+end

data/lib/nextcloud/models/user.rb

@@ -0,0 +1,50 @@
+module Nextcloud
+  module Models
+    # User model
+    #
+    # @!attribute [rw] enabled
+    #   @return [String] Is an user enabled or not
+    # @!attribute [rw] id
+    #   @return [String] Identifier of an user
+    # @!attribute [rw] quota
+    #   @return [Hash] Quota of user
+    # @!attribute [rw] email
+    #   @return [String] E-mail address
+    # @!attribute [rw] displayname
+    #   @return [String] User display name
+    # @!attribute [rw] phone
+    #   @return [String] User phone number
+    # @!attribute [rw] address
+    #   @return [String] User address
+    # @!attribute [rw] website
+    #   @return [String] User web-site address
+    # @!attribute [rw] twitter
+    #   @return [String] User Twitter account
+    # @!attribute [rw] groups
+    #   @return [String] Groups user belongs to
+    # @!attribute [rw] language
+    #   @return [String] Nextcloud version for an user
+    class User
+      attr_accessor :meta
+
+      # Initiates a model instance
+      #
+      # @param [Hash]
+      def initialize(enabled: nil, id: nil, quota: nil, email: nil, displayname: nil, phone: nil, address: nil,
+        website: nil,
+        twitter: nil, groups: nil, language: nil)
+
+        self.class.params.each do |v|
+          instance_variable_set("@#{v}", instance_eval(v.to_s)) if instance_eval(v.to_s)
+        end
+      end
+
+      @params = instance_method(:initialize).parameters.map(&:last)
+      @params.each { |p| instance_eval("attr_accessor :#{p}") }
+
+      class << self
+        attr_reader :params
+      end
+    end
+  end
+end

data/lib/nextcloud/ocs/app.rb

@@ -0,0 +1,90 @@
+module Nextcloud
+  module Ocs
+    # Application class used for interfering with app specific actions
+    #
+    # @!attribute [rw] meta
+    #   @return [Hash] Information about API response
+    # @!attribute [rw] appid
+    #   @return [Integer] Application identifier
+    class App < OcsApi
+      include Helpers
+
+      attr_accessor :meta, :appid
+
+      # Application initializer
+      #
+      # @param api [Object] Api instance
+      # @param appid [Integer,nil] Application identifier
+      def initialize(args, appid = nil)
+        @appid = appid if appid
+
+        if args.class == Nextcloud::OcsApi
+          @api = args
+        else
+          super(args)
+          @api = self
+        end
+      end
+
+      # Sets app (useful if class is initiated without OcsApi.app)
+      #
+      # @param userid [String] User identifier
+      # @return [Obeject] self
+      def set(appid)
+        @appid = appid
+        self
+      end
+
+      # List enabled applications
+      #
+      # @return [Array] List of applications that are enabled on an instance
+      def enabled
+        filter("enabled")
+      end
+
+      # List disabled applications
+      #
+      # @return [Array] List of applications that are disabled on an instance
+      def disabled
+        filter("disabled")
+      end
+
+      # Get information about an applicaiton
+      #
+      # @param appid [Integer] Application identifier
+      # @return [Hash] Application information
+      def find(appid)
+        response = @api.request(:get, "apps/#{appid}")
+        h = doc_to_hash(response, "//data")["data"]
+        add_meta(response, h)
+      end
+
+      # Enable an application
+      #
+      # @return [Object] Instance with meta response
+      def enable
+        response = @api.request(:post, "apps/#{@appid}")
+        (@meta = get_meta(response)) && self
+      end
+
+      # Disable an application
+      #
+      # @return [Object] Instance with meta response
+      def disable
+        response = @api.request(:delete, "apps/#{@appid}")
+        (@meta = get_meta(response)) && self
+      end
+
+      private
+
+      # Retrieve enabled or disabled applications
+      #
+      # @param filter [String] Either enabled or disabled
+      # @return [Array] List of applications with meta method
+      def filter(filter)
+        response = @api.request(:get, "apps?filter=#{filter}")
+        parse_with_meta(response, "//data/apps/element")
+      end
+    end
+  end
+end