nextcloud 1.3.0

data/lib/nextcloud/ocs_api.rb

@@ -0,0 +1,34 @@
+module Nextcloud
+  class OcsApi < Api
+    # Initiates User class
+    #
+    # @param userid [Ingteger,nil] Nextcloud user userid
+    # @return [Object] User instance
+    def user(userid = nil)
+      Ocs::User.new(self, userid)
+    end
+
+    # Initiates Group class
+    #
+    # @param groupid [Ingteger,nil] Nextcloud group groupid
+    # @return [Object] Group instance
+    def group(groupid = nil)
+      Ocs::Group.new(self, groupid)
+    end
+
+    # Initiates App class
+    #
+    # @param appid [Ingteger,nil] Nextcloud app appid
+    # @return [Object] Application instance
+    def app(appid = nil)
+      Ocs::App.new(self, appid)
+    end
+
+    # Initiates File Sharing class
+    #
+    # @return [Object] File Sharing instance
+    def file_sharing
+      Ocs::FileSharingApi.new(url: @url, username: @username, password: @password)
+    end
+  end
+end

data/lib/nextcloud/version/nextcloud.rb

@@ -0,0 +1,5 @@
+module Nextcloud
+  module Version
+    VERSION = "1.3.0".freeze
+  end
+end

data/lib/nextcloud/webdav/directory.rb

@@ -0,0 +1,174 @@
+require "net-http-report"
+
+module Nextcloud
+  module Webdav
+    # WebDAV class for communicating with File/directory mgmt. service
+    #
+    # @!attribute [rw] directory
+    #   @return [Array] Used to store model instances when querying with find or favorites
+    class Directory < WebdavApi
+      include Helpers
+      include Properties
+
+      attr_accessor :directory
+
+      # Class initializer
+      # Can be initialized with WebdavApi's directory method or with Nextcloud::Webdav::Directory.new(...credentials...)
+      #
+      # @param args [Object,Hash] Can be instance of Api or credentials list (url, username, password)
+      def initialize(args)
+        if args.class == Nextcloud::WebdavApi
+          @api = args
+        else
+          super
+          @api = self
+        end
+
+        @path = "/files/#{@api.username}"
+      end
+
+      # Query a file, find contents of directory (including information about directory)
+      #
+      # @param path [String] Path of file or directory to search in
+      # @return [Object,Hash] Hash of error or instance of Directory model class
+      def find(path = "/")
+        response = @api.request(:propfind, "#{@path}/#{path}", nil, RESOURCE)
+        (has_dav_errors(response)) ? has_dav_errors(response) : directory(response)
+      end
+
+      # Create a directory
+      #
+      # @param path [String] Path of new directory relative to base
+      # @return [Hash] Returns status
+      def create(path)
+        response = @api.request(:mkcol, "#{@path}/#{path}")
+        parse_dav_response(response)
+      end
+
+      # Create a directory
+      #
+      # @param path [String] Path of new directory relative to base
+      # @return [Hash] Returns status
+      def destroy(path)
+        response = @api.request(:delete, "#{@path}/#{path}")
+        parse_dav_response(response)
+      end
+
+      # Download a file
+      #
+      # @param path [String] Path of file to download
+      # @return [String] Returns file contents
+      def download(path)
+        @api.request(:get, "#{@path}/#{path}", nil, nil, nil, nil, true)
+      end
+
+      # Upload a file
+      #
+      # @param path [String] Path of new upload
+      # @return contents [Hash] Returns status
+      def upload(path, contents)
+        response = @api.request(:put, "#{@path}/#{path}", nil, contents)
+        parse_dav_response(response)
+      end
+
+      # Move a file
+      #
+      # @param source [String] Source path relative to base
+      # @param destination [String] Destination path relative to base
+      # @return [Hash] Returns status
+      def move(source, destination)
+        response = @api.request(:move, "#{@path}/#{source}", nil, nil, nil,
+          destination = "#{@api.url}#{@path}/#{destination}")
+        parse_dav_response(response)
+      end
+
+      # Copy a file
+      #
+      # @param source [String] Source path relative to base
+      # @param destination [String] Destination path relative to base
+      # @return [Hash] Returns status
+      def copy(source, destination)
+        response = @api.request(:copy, "#{@path}/#{source}", nil, nil, nil,
+          destination = "#{@api.url}#{@path}/#{destination}")
+        parse_dav_response(response)
+      end
+
+      # Make file/directory a favorite
+      #
+      # @param path [String] Path of file/directory (relative)
+      # @return [Hash] Returns status
+      def favorite(path)
+        response = @api.request(:proppatch, "#{@path}/#{path}", nil, MAKE_FAVORITE)
+        parse_dav_response(response)
+      end
+
+      # Unfavorite a file/directory
+      #
+      # @param path [String] Path of file/directory (relative)
+      # @return [Hash] Returns status
+      def unfavorite(path)
+        response = @api.request(:proppatch, "#{@path}/#{path}", nil, UNFAVORITE)
+        parse_dav_response(response)
+      end
+
+      # Shows favorite files/directories in given location
+      #
+      # @param path [String] Location to list favorites from
+      # @return [Hash] Hash of error or array of Directory model classes
+      def favorites(path = "/")
+        response = @api.request(:REPORT, "#{@path}/#{path}", nil, FAVORITE)
+        (has_dav_errors(response)) ? has_dav_errors(response) : directory(response, false)
+      end
+
+      private
+
+      # Parses as turns file/directory response to model object
+      #
+      # @param response [Object] Nokogiri::XML::Document
+      # @param skip_first [Boolean] Skip or not first element
+      # @return [Object,Array] Returns Object if first element not skipped, array otherwise
+      def directory(response, skip_first = true)
+        response = doc_to_hash(response).try(:[], "multistatus").try(:[], "response")
+        response = [response] if response.is_a? Hash
+
+        return [] if response.nil?
+
+        response.each_with_index do |h, index|
+
+          prop = h["propstat"].try(:[], 0).try(:[], "prop") || h["propstat"]["prop"]
+
+          params = {
+              href: h["href"],
+              lastmodified: prop["getlastmodified"],
+              tag: prop["getetag"],
+              resourcetype: prop["resourcetype"].nil? ? "file" : "collection",
+              id: prop["id"],
+              fileid: prop["fileid"],
+              permissions: prop["permissions"],
+              size: prop["size"],
+              has_preview: prop["has_preview"] == "false" ? false : true,
+              favorite: prop["favorite"] == "0" ? false : true,
+              comments_href: prop["comments_href"],
+              comments_count: prop["comments_count"],
+              comments_unread: prop["comments_unread"],
+              owner_id: prop["owner_id"],
+              owner_display_name: prop["owner_display_name"],
+              share_types: prop["share_types"]
+          }
+
+          if skip_first
+            if index == 0
+              @directory = Models::Directory.new(params)
+            else
+              @directory.add(params)
+            end
+          else
+            @directory = [] if @directory.nil?
+            @directory << Models::Directory.new(params.merge(skip_contents: true))
+          end
+        end
+        @directory
+      end
+    end
+  end
+end

data/lib/nextcloud/webdav_api.rb

@@ -0,0 +1,21 @@
+module Nextcloud
+  class WebdavApi < Api
+    # Remote end of WebDAV API
+    DAV_URL = "remote.php/dav".freeze
+
+    # Initializes a WebDAV API
+    #
+    # @params args [Hash] Hash with url, username and password
+    def initialize(args)
+      super
+      @url = URI(@url.scheme + "://" + @url.host + "/" + DAV_URL)
+    end
+
+    # Initiates WebDAV Directory class
+    #
+    # @return [Object] WebDAV Directory instance
+    def directory
+      Webdav::Directory.new(self)
+    end
+  end
+end

data/nextcloud.gemspec

@@ -0,0 +1,45 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nextcloud/version/nextcloud"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nextcloud"
+  spec.version       = Nextcloud::Version::VERSION
+  spec.authors       = ["Dachi Natsvlishvili"]
+  spec.email         = ["dachinat@gmail.com"]
+  spec.summary       = "Nextcloud API in Ruby"
+  spec.description   = "Nextcloud OCS and WebDAV API endpoints wrapper in Ruby for user provisioning, file and directory
+                        management, sharing (including Federated Cloud Sharing), group and application operations."
+  spec.homepage      = "https://github.com/dachinat/nextcloud"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+    spec.metadata["yard.run"] = "yri"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", "~> 5.1"
+  spec.add_runtime_dependency "json", "~> 2.1"
+  spec.add_runtime_dependency "nokogiri", "~> 1.8"
+  spec.add_runtime_dependency "net-http-report", "~> 0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.51"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.1"
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: nextcloud
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Dachi Natsvlishvili
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: net-http-report
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: |-
+  Nextcloud OCS and WebDAV API endpoints wrapper in Ruby for user provisioning, file and directory
+                          management, sharing (including Federated Cloud Sharing), group and application operations.
+email:
+- dachinat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nextcloud.rb
+- lib/nextcloud/api.rb
+- lib/nextcloud/errors/nextcloud.rb
+- lib/nextcloud/helpers/nextcloud.rb
+- lib/nextcloud/helpers/properties.rb
+- lib/nextcloud/models/directory.rb
+- lib/nextcloud/models/user.rb
+- lib/nextcloud/ocs/app.rb
+- lib/nextcloud/ocs/file_sharing_api.rb
+- lib/nextcloud/ocs/group.rb
+- lib/nextcloud/ocs/user.rb
+- lib/nextcloud/ocs_api.rb
+- lib/nextcloud/version/nextcloud.rb
+- lib/nextcloud/webdav/directory.rb
+- lib/nextcloud/webdav_api.rb
+- nextcloud.gemspec
+homepage: https://github.com/dachinat/nextcloud
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  yard.run: yri
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Nextcloud API in Ruby
+test_files: []