nextcloud-client 0.0.1

data/lib/nextcloud-client/ocs/file_sharing_api.rb

@@ -0,0 +1,223 @@
+module NextcloudClient
+  module Ocs
+    # File sharing base class used for interfering with sharing, included federated
+    #
+    # @!attribute [rw] meta
+    #   @return [Hash] Information about API response
+    # @!attribute [rw] shareid
+    #   @return [Integer] Share identifier
+    class FileSharingApi < OcsApi
+      include Helpers
+
+      attr_accessor :meta
+      attr_reader :share_url
+
+      # Initializes API with user credentials
+      #
+      # @param [Hash] args authentication credentials.
+      # @option args [String] :url Nextcloud instance URL
+      # @option args [String] :username Nextcloud instance user username
+      # @option args [String] :password Nextcloud instance user password
+      def initialize(args)
+        super(args)
+
+        @url = URI(
+          @url.scheme + "://" + @url.host + "/ocs/v2.php/apps/files_sharing/api/v1/"
+        )
+      end
+
+      # Get information about specific share
+      #
+      # @param shareid [Integer]
+      # @return [Hash] Information about share with meta
+      def find(shareid)
+        response = request(:get, "shares/#{shareid}")
+        h = doc_to_hash(response, "//data/element").try(:[], "element")
+        add_meta(response, h)
+      end
+
+      # Get all shares
+      #
+      # @return [Array] All shares of authenticated user
+      def all
+        response = request(:get, "shares")
+        h = doc_to_hash(response, "//data").try(:[], "data").try(:[], "element")
+        h = [h] if h.class == Hash
+        add_meta(response, h)
+      end
+
+      # Get shares for a file or directory
+      # optionally get shares including re-shares on a resource
+      # or get shares for all the files in a directory
+      #
+      # @param path [String]
+      # @param reshares [Boolean,nil]
+      # @param subfiles [Boolean,nil]
+      # @return [Array] Shares (may include re-shares for a file or directory) of a resource or all reshares of
+      #   directory contents
+      def specific(path, reshares = nil, subfiles = nil)
+        response = request(:get, "shares?path=#{path}&reshares=#{reshares}&subfiles=#{subfiles}")
+        h = doc_to_hash(response, "//data").try(:[], "data").try(:[], "element")
+        h = [h] if h.class == Hash
+        add_meta(response, h)
+      end
+
+      # Share an item
+      #
+      # @param path [String] Path of a file or directory to share
+      # @param shareType [Integer] One of four possible values. 0 means an user, 1 means a group, 3 means a public link
+      #   6 stands for federated cloud share
+      # @param shareWith [String,nil] User or group identifier, can be omitted if shareType is neither 0, nor 1
+      # @param publicUpload [Boolean,nil] If true, permits public uploads in directories shared by link
+      # @param password [String,nil] Password-protects a share
+      # @param permissions [Integer,nil] Sets permissions on a resource. 1 gives read rights, 2 update, 4 create,
+      #   8 delete
+      #  16 share, 31 all rights. Value should be one of previously listed.
+      # @return [Object] Instance including meta response and share URL if any
+      def create(path, shareType, shareWith = nil, publicUpload = nil, password = nil, permissions = nil)
+        args = local_variables.reduce({}) { |c, i| c[i] = binding.local_variable_get(i); c }
+        response = request(:post, "/shares", args)
+        @share_url = response.xpath("//url").text
+        (@meta = get_meta(response)) && self
+      end
+
+      # Unshare an item
+      #
+      # @param shareid [Integer] Share ID
+      # @return [Object] Instance with meta response
+      def destroy(shareid)
+        response = request(:delete, "/shares/#{shareid}")
+        (@meta = get_meta(response)) && self
+      end
+
+      # Update permissions for a resource
+      #
+      # @param shareid [Integer] Share identifier
+      # @param permissions [Integer] Must be one of the following: 1: read, 2: update, 4: create, 8: delete, 16: share,
+      #   31: all rights.
+      # @return [Object] Instance with meta response
+      def update_permissions(shareid, permissions)
+        update(shareid, "permissions", permissions)
+      end
+
+      # Update a password for a resource
+      #
+      # @param shareid [Integer] Share identifier
+      # @param password [String] Password string
+      # @return [Object] Instance with meta response
+      def update_password(shareid, password)
+        update(shareid, "password", password)
+      end
+
+      # Allow or disallow public uploads in a directory
+      #
+      # @param shareid [Integer] Share identifier
+      # @param publicUpload [Boolean] True to permit public uploads in a directory, false to disallow
+      # @return [Object] Instance with meta response
+      def update_public_upload(shareid, publicUpload)
+        update(shareid, "publicUpload", publicUpload)
+      end
+
+      # Update resource expiration date
+      #
+      # @param shareid [Integer] Share identifier
+      # @param expireDate [String] Expiration date of a resource. Has to be in format of "YYYY-DD-MM"
+      # @return [Object] Instance with meta response
+      def update_expire_date(shareid, expireDate)
+        update(shareid, "expireDate", expireDate)
+      end
+
+      # Wrapper to Federated Cloud Sharing API
+      #
+      # @!attribute [rw] meta
+      #   @return [Hash] Information about API response
+      class FederatedCloudShares
+        include Helpers
+
+        attr_accessor :meta
+
+        # Creates Federated Cloud Sharing class instance
+        #
+        # @param api [Object] Api object
+        def initialize(api)
+          @api = api
+        end
+
+        # List accepted Federated Cloud Shares
+        #
+        # @return [Array] List of accepted Federated Cloud Shares
+        def accepted
+          response = @api.request(:get, "/remote_shares")
+          h = doc_to_hash(response, "//data").try(:[], "data").try(:[], "element")
+          h = [h] if h.class == Hash
+          add_meta(response, h)
+        end
+
+        # List pending requests of Federated Cloud Shares
+        #
+        # @return [Array] List of pending Federated Cloud Shares
+        def pending
+          response = @api.request(:get, "/remote_shares/pending")
+          h = doc_to_hash(response, "//data").try(:[], "data").try(:[], "element")
+          h = [h] if h.class == Hash
+          add_meta(response, h)
+        end
+
+        # Accept a request of a Federated Cloud Share
+        #
+        # @param shareid [Integer] Federated Cloud Share identifier
+        # @return [Object] Instance with meta response
+        def accept(shareid)
+          response = @api.request(:post, "/remote_shares/pending/#{shareid}")
+          (@meta = get_meta(response)) && self
+        end
+
+        # Decline a request of a Federated Cloud Share
+        #
+        # @param shareid [Integer] Federated Cloud Share identifier
+        # @return [Object] Instance with meta response
+        def decline(shareid)
+          response = @api.request(:delete, "/remote_shares/pending/#{shareid}")
+          (@meta = get_meta(response)) && self
+        end
+
+        # Delete an accepted Federated Cloud Share
+        #
+        # @param shareid [Integer] Federated Cloud Share identifier
+        # @return [Object] Instance with meta response
+        def destroy(shareid)
+          response = @api.request(:delete, "/remote_shares/#{shareid}")
+          (@meta = get_meta(response)) && self
+        end
+
+        # Information about accepted Federated Cloud Share
+        #
+        # @param shareid [Integer] Federated Cloud Share identifier
+        # @return [Hash] Information about Federated Cloud Share with meta response
+        def find(shareid)
+          response = @api.request(:get, "/remote_shares/#{shareid}")
+          h = doc_to_hash(response, "//data").try(:[], "data")
+          add_meta(response, h)
+        end
+      end
+
+      # Initiates a Federated Cloud Sharing class
+      def federated
+        FederatedCloudShares.new(self)
+      end
+
+      private
+
+      # Update a resource
+      #
+      # @param shareid [Integer] Share identifier
+      # @param key [String] Option to update
+      # @param value [String] Setting to update to
+      # @return [Object] Instance with meta information
+      def update(shareid, key, value)
+        response = request(:put, "/shares/#{shareid}", "#{key}": value)
+        (@meta = get_meta(response)) && self
+      end
+    end
+  end
+end

data/lib/nextcloud-client/ocs/group.rb

@@ -0,0 +1,89 @@
+module NextcloudClient
+  module Ocs
+    # Class with Nextcloud group operation features
+    #
+    # @!attribute [rw] meta
+    #   @return [Hash] Information about API response
+    # @!attribute [rw] groupid
+    #   @return [String,nil] Group identifier
+    class Group < OcsApi
+      include Helpers
+
+      attr_accessor :meta, :groupid
+
+      # Initializes a class
+      #
+      # @param api [Object] Api instance
+      # @param groupid [String,nil] Group identifier
+      def initialize(args, groupid = nil)
+        @groupid = groupid if groupid
+
+        if args.class == NextcloudClient::OcsApi
+          @api = args
+        else
+          super(args)
+          @api = self
+        end
+      end
+
+      # Sets group (useful if class is initiated without OcsApi.group)
+      #
+      # @param groupid [String] Group identifier
+      # @return [Obeject] self
+      def set(groupid)
+        @groupid = groupid
+        self
+      end
+
+      # Search for a group
+      #
+      # @param str [String] Search query
+      # @return [Array] Found groups list
+      def search(str)
+        response = @api.request(:get, "groups?search=#{str}")
+        parse_with_meta(response, "//data/groups/element")
+      end
+
+      # List all groups
+      #
+      # @return [Array] All groups
+      def all
+        search("")
+      end
+
+      # Create a group
+      #
+      # @param groupid [String] Group identifier
+      # @return [Object] Instance with meta information
+      def create(groupid)
+        response = @api.request(:post, "groups", groupid: groupid)
+        (@meta = get_meta(response)) && self
+      end
+
+      # Get members of a group
+      #
+      # @return [Array] List of group members
+      def members
+        response = @api.request(:get, "groups/#{@groupid}")
+        parse_with_meta(response, "//data/users/element")
+      end
+
+      # Get sub-admins of a group
+      #
+      # @return [Array] List of group sub-admins
+      def subadmins
+        response = @api.request(:get, "groups/#{@groupid}/subadmins")
+        parse_with_meta(response, "//data/element")
+      end
+
+      # Remove a group
+      #
+      # @param groupid [String] Group identifier
+      # @return [Object] Instance with meta information
+      def destroy(groupid)
+        response = @api.request(:delete, "groups/#{groupid}")
+        (@meta = get_meta(response)) && self
+      end
+    end
+  end
+end

data/lib/nextcloud-client/ocs/group_folder.rb

@@ -0,0 +1,146 @@
+module NextcloudClient
+  module Ocs
+    # Group Folder class used for interfering with group folders
+    #
+    # @!attribute [rw] meta
+    #   @return [Hash] Information about API response
+    class GroupFolder < OcsApi
+      include Helpers
+
+      attr_accessor :meta
+
+      # Application initializer
+      #
+      # @param [Hash] args authentication credentials.
+      # @option args [String] :url Nextcloud instance URL
+      # @option args [String] :username Nextcloud instance user username
+      # @option args [String] :password Nextcloud instance user password
+      def initialize(args)
+        super(args)
+
+        @url = URI(
+          @url.scheme + "://" + @url.host + "/apps/groupfolders/"
+        )
+      end
+
+      # List all folders
+      #
+      # @return [Array] All group folders
+      def folders
+        response = request(:get, "folders")
+        h = doc_to_hash(response, "//data").try(:[], "data").try(:[], "element")
+        h = [h] if h.class == Hash
+        add_meta(response, h)
+      end
+
+      # Return ID of folder given by name
+      #
+      # @param name [String] Folder name
+      # @return [Integer] Folder ID
+      def get_folder_id(name)
+        response = request(:get, "folders")
+        h = doc_to_hash(response, "//data").try(:[], "data").try(:[], "element")
+        group = h.select { |folder| folder["mount_point"] == name }&.first
+        unless group.nil?
+          return group["id"]
+        end
+      end
+
+      # Get information about a group folder
+      #
+      # @param folderid [Integer]
+      # @return [Hash] Information about a group folder
+      def find(folderid)
+        response = request(:get, "folders/#{folderid}")
+        h = doc_to_hash(response, "//data").try(:[], "data")
+        add_meta(response, h)
+      end
+
+      # Create a group folder
+      #
+      # @param mountpoint [String] Mountpoint
+      # @return [Hash] Hash with created group folder
+      def create(mountpoint)
+        args = local_variables.reduce({}) { |c, i| c[i] = binding.local_variable_get(i); c }
+        response = request(:post, "folders", args)
+        h = doc_to_hash(response, "//data").try(:[], "data")
+        add_meta(response, h)
+      end
+
+      # Destroy a group folder
+      #
+      # @param mountpoint [String] Mountpoint
+      # @return [Bool] True on success
+      def destroy(folderid)
+        response = request(:delete, "folders/#{folderid}")
+        h = doc_to_hash(response, "//data").try(:[], "data")
+        return h == "1"
+      end
+
+      # Give a group access to a folder
+      #
+      # @param folderid [Integer] FolderId to modify
+      # @param group [String] Group which should get access to the folder
+      # @return [Bool] True on success
+      def give_access(folderid, group)
+        args = local_variables.reduce({}) { |c, i| c[i] = binding.local_variable_get(i); c }
+        response = request(:post, "folders/#{folderid}/groups", args)
+        h = doc_to_hash(response, "//data").try(:[], "data")
+        return h == "1"
+      end
+
+      # Remove access from a group to a folder
+      # @param folderid [Integer] FolderId to modify
+      # @param group [String] Group which should be removed to get access to the folder
+      # @return [Bool] True on success
+      def remove_access(folderid, group)
+        response = request(:delete, "folders/#{folderid}/groups/#{group}")
+        h = doc_to_hash(response, "//data").try(:[], "data")
+        return h == "1"
+      end
+
+      # Set the permissions a group has in a folder
+      #	  PERMISSION_CREATE = 4;
+      #   PERMISSION_READ = 1;
+      #   PERMISSION_UPDATE = 2;
+      #   PERMISSION_DELETE = 8;
+      #   PERMISSION_SHARE = 16;
+      #   PERMISSION_ALL = 31;
+      #
+      # @param folderid [Integer] FolderId to modify
+      # @param group [String] Group for which the permissions should be changed
+      # @param permissions [String] The new permissions for the group as bitmask of permissions constants
+      # @return [Bool] True on success
+      def set_permissions(folderid, group, permissions)
+        args = local_variables.reduce({}) { |c, i| c[i] = binding.local_variable_get(i); c }
+        response = request(:post, "folders/#{folderid}/groups/#{group}", args)
+        h = doc_to_hash(response, "//data").try(:[], "data")
+        return h == "1"
+      end
+
+      # Set the quota for a folder
+      #
+      # @param folderid [Integer] FolderId to modify
+      # @param quota [Integer] The new quota for the folder in bytes, use -3 for unlimited
+      # @return [Bool] True on success
+      def set_quota(folderid, quota)
+        args = local_variables.reduce({}) { |c, i| c[i] = binding.local_variable_get(i); c }
+        response = request(:post, "folders/#{folderid}/quota", args)
+        h = doc_to_hash(response, "//data").try(:[], "data")
+        return h == "1"
+      end
+
+      # Change the name of a folder
+      #
+      # @param folderid [Integer] FolderId to modify
+      # @param mountpoint [String] The new folder name
+      # @return [Bool] True on success
+      def rename_folder(folderid, mountpoint)
+        args = local_variables.reduce({}) { |c, i| c[i] = binding.local_variable_get(i); c }
+        response = request(:post, "folders/#{folderid}/mountpoint", args)
+        h = doc_to_hash(response, "//data").try(:[], "data")
+        return h == "1"
+      end
+    end
+  end
+end

data/lib/nextcloud-client/ocs/user.rb

@@ -0,0 +1,225 @@
+module NextcloudClient
+  module Ocs
+    # Class includes User provisioning fetures, including User group operations
+    #
+    # @!attribute [rw] meta
+    #   @return [Hash] Information about API response
+    # @!attribute [rw] userid
+    #   @return [String,nil] User identifier
+    class User < OcsApi
+      include Helpers
+
+      attr_accessor :meta, :userid
+
+      # Class initializer
+      #
+      # @param api [Object] Api instance
+      # @param userid [String,nil] User identifier
+      def initialize(args, userid = nil)
+        @userid = userid if userid
+
+        if args.class == NextcloudClient::OcsApi
+          @api = args
+        else
+          super(args)
+          @api = self
+        end
+      end
+
+      # Sets user (useful if class is initiated without OcsApi.user)
+      #
+      # @param userid [String] User identifier
+      # @return [Obeject] self
+      def set(userid)
+        @userid = userid
+        self
+      end
+
+      # Retrieve information about an user
+      #
+      # @param userid [String]
+      # @return [Object] User instance
+      def find(userid)
+        response = @api.request(:get, "users/#{userid}")
+
+        enabled = response.xpath("//data/enabled").text
+        id = response.xpath("//data/id").text
+        quota = response.xpath("//data/quota/*").each_with_object({}) do |node, quota|
+          quota[node.name] = node.text
+        end
+        email = response.xpath("//data/email").text
+        displayname = response.xpath("//data/displayname").text
+        phone = response.xpath("//data/phone").text
+        address = response.xpath("//data/address").text
+        website = response.xpath("//data/website").text
+        twitter = response.xpath("//data/twitter").text
+        groups = []
+        response.xpath("//data/groups/element").each do |prop|
+          groups << prop.text
+        end
+
+        language = response.xpath("//data/language").text
+
+        user = NextcloudClient::Models::User.new(enabled: enabled, id: id, quota: quota, email: email,
+                                           displayname: displayname, phone: phone, address: address, website: website,
+                                           twitter: twitter, groups: groups, language: language)
+        (user.meta = get_meta(response)) && user
+      end
+
+      # Retrieve all users
+      #
+      # @return [Array] List of all users
+      def all
+        response = @api.request(:get, "users")
+
+        users = [].tap do |users|
+          response.xpath("//element").each do |prop|
+            id = prop.text
+            users << NextcloudClient::Models::User.new(id: id)
+          end
+        end
+
+        meta = get_meta(response)
+
+        users.send(:define_singleton_method, :meta) { meta } && users
+      end
+
+      # Add a new user
+      #
+      # @param userid [String] User identifier
+      # @param password [String] User password
+      # @return [Object] Instance with meta response
+      def create(userid, password)
+        response = @api.request(:post, "users", userid: userid, password: password)
+        (@meta = get_meta(response)) && self
+      end
+
+      # Update a parameter of an user
+      #
+      # @param userid [String] User identifier
+      # @param key [String] Parameter to update. Can be quota, displayname, phone, address, website, twitter or password
+      # @param value [String] Value to update to
+      # @return [Object] Instance with meta information
+      def update(userid, key, value)
+        response = @api.request(:put, "users/#{userid}", key: key, value: value)
+        (@meta = get_meta(response)) && self
+      end
+
+      # Disable an user
+      #
+      # @param userid [String] User identifier
+      # @return [Object] Instance with meta information
+      def disable(userid)
+        response = @api.request(:put, "users/#{userid}/disable")
+        (@meta = get_meta(response)) && self
+      end
+
+      # Enable an user
+      #
+      # @param userid [String] User identifier
+      # @return [Object] Instance with meta information
+      def enable(userid)
+        response = @api.request(:put, "users/#{userid}/enable")
+        (@meta = get_meta(response)) && self
+      end
+
+      # Remove an user account
+      #
+      # @param userid [String] User identifier
+      # @return [Object] Instance with meta information
+      def destroy(userid)
+        response = @api.request(:delete, "users/#{userid}")
+        (@meta = get_meta(response)) && self
+      end
+
+      # Class covering User group operations
+      #
+      # @!attribute [rw] meta
+      #   @return [Hash] Information about API response
+      # @!attribute [rw] groupid
+      #   @return [String,nil] Group identifier
+      class Group < User
+        include Helpers
+
+        attr_accessor :userid, :groupid, :meta
+
+        # Initializes an User Group instance
+        #
+        # @param api [Object] Api instance
+        # @param userid [String] User identifier
+        # @param groupid [String,nil] Group identifier
+        def initialize(api, userid, groupid = nil)
+          @api = api
+          @userid = userid
+          @groupid = groupid if groupid
+        end
+
+        # Add an user to a group
+        #
+        # @param groupid [String] Group to add user to
+        # @return [Object] Instance with meta information
+        def create(groupid)
+          response = @api.request(:post, "users/#{@userid}/groups", groupid: groupid)
+          (@meta = get_meta(response)) && self
+        end
+
+        # Remove user from a group
+        #
+        # @param groupid [String] Group to remove user from
+        # @return [Object] Instance with meta information
+        def destroy(groupid)
+          response = @api.request(:delete, "users/#{@userid}/groups", groupid: groupid)
+          (@meta = get_meta(response)) && self
+        end
+
+        # Make an user subadmin of a group
+        #
+        # @return [Object] Instance with meta information
+        def promote
+          response = @api.request(:post, "users/#{@userid}/subadmins", groupid: @groupid)
+          (@meta = get_meta(response)) && self
+        end
+
+        # Remove an user from group subadmins
+        #
+        # @return [Object] Instance with meta information
+        def demote
+          response = @api.request(:delete, "users/#{@userid}/subadmins", groupid: @groupid)
+          (@meta = get_meta(response)) && self
+        end
+      end
+
+      # Initialize a group class
+      #
+      # @param groupid [String,nil] Group identifier
+      def group(groupid = nil)
+        Group.new(@api, @userid, groupid)
+      end
+
+      # List groups that user belongs to
+      #
+      # @return [Array] User groups
+      def groups
+        response = @api.request(:get, "users/#{@userid}/groups")
+        parse_with_meta(response, "//data/groups/element")
+      end
+
+      # List groups that user sub-admins
+      #
+      # @return [Array] User sub-admin groups
+      def subadmin_groups
+        response = @api.request(:get, "users/#{@userid}/subadmins")
+        parse_with_meta(response, "//data/element")
+      end
+
+      # Resend welcome e-mail letter to a user
+      #
+      # @param userid [String]
+      # @return [Object] Instance with meta information
+      def resend_welcome(userid)
+        response = @api.request(:post, "users/#{userid}/welcome")
+        (@meta = get_meta(response)) && self
+      end
+    end
+  end
+end