ocman 1.2.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 050bc6a6baa2dea31694c49f2b320dcbf95f5929
-  data.tar.gz: a1b186c12d2e6169f593832e91de398e6f2c4d11
+SHA256:
+  metadata.gz: 01adcff61e626c6b19883ece249e25d7b7df6f5a1223aeb35b8ac117dc5eb1ab
+  data.tar.gz: f0231c022308483bdc19b490632d653e17c7692aa8680036423e8495bd49b7ea
 SHA512:
-  metadata.gz: 98046bfc2dda057cbd11ac2bfa82cedb918a66fc37d63547a673b6ee521c6a22aed842adaea3c5c53e87faf7138ca45c6e7b36d063d8e81b3793f50c7199aa82
-  data.tar.gz: a03e115913971f9de297fd0acb9e3c87a42d9073ef0c24fb7ee6555ad5e2016436dd835dee3122aec8d85d0893f75e09d37b5d9bda85a082ce50147f772f9697
+  metadata.gz: a1623d11c9a31c730a3169dbae68e2454c7f03873b14254b31c4296d9cbd55bbbdd4fb64b6c00a71969795e9864087ad44d960f16966779c77c8dabbed3d8f53
+  data.tar.gz: 5a8fa49d48f2d1a3e66fcf7af8dddcef628567b70c835966276312c48aeb981fa43d0877adcbd728f3aea3c745069ad33050ef06a53e4cbe9f02e0523bf0693e

data/lib/ocman.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'ocman/configuration'
 require 'ocman/dav'
 require 'ocman/item'
+require 'ocman/permission'
 require 'ocman/folder'
 require 'ocman/version'
 require 'ocman/share'
@@ -19,8 +22,8 @@ module Ocman
   end
 
   ### share
-  def self.share(path, user)
-    Ocman::Share.new(path).share(user)
+  def self.share(path, user, permission = Permission.all)
+    Ocman::Share.new(path).share(user, permission)
   end
 
   def self.delete_share(path, user)
@@ -28,16 +31,20 @@ module Ocman
   end
 
   ### folder
-  def self.list(path, options={})
+  def self.list(path, options = {})
     Ocman::Folder.list(path, options)
   end
 
-  def self.create_folder(path)
-    Ocman::Folder.create(path)
+  def self.create_folder(path, recursive: false)
+    if recursive
+      Ocman::Folder.create_recursive(path)
+    else
+      Ocman::Folder.create(path)
+    end
   end
 
   ### files
-  def self.put(file_path, path, options={})
+  def self.put(file_path, path, options = {})
     Ocman::Item.create(file_path, path, options)
   end
 

data/lib/ocman/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ocman
   class Configuration
     attr_accessor :base_url, :user_name, :password, :dav_base_uri

data/lib/ocman/dav.rb

@@ -1,32 +1,33 @@
+# frozen_string_literal: true
+
 require 'net/dav'
+require 'cgi'
 
 module Ocman
   class Dav
     attr_writer :connection
 
     def mkdir(path)
-      connection.mkdir( uri(path) )
+      connection.mkdir(uri(path))
     end
 
-    def ls(path, options={})
-      connection.find( uri(path), options ) do |item|
-        yield(item)
-      end
+    def ls(path, options = {}, &block)
+      connection.find(uri(path), options, &block)
     end
 
-    def put(file_path, path, options={})
+    def put(file_path, path, options = {})
       filename = options[:filename] || File.basename(file_path)
       File.open(file_path, 'r') do |stream|
-        connection.put( uri(path, filename) , stream, File.size(file_path))
+        connection.put(uri(path, filename), stream, File.size(file_path))
       end
     end
 
     def delete(path)
-      connection.delete( uri(path) )
+      connection.delete(uri(path))
     end
 
     def move(source_path, destination_path)
-      connection.move( uri(source_path), uri(destination_path) )
+      connection.move(uri(source_path), uri(destination_path))
     end
 
     def self.base_uri
@@ -34,7 +35,7 @@ module Ocman
     end
 
     def self.url(path)
-      Ocman.configuration.base_url + (Ocman::Dav.base_uri + path).gsub(/\/+/, '/')
+      Ocman.configuration.base_url + (Ocman::Dav.base_uri + path).gsub(%r{/+}, '/')
     end
 
     private
@@ -47,8 +48,9 @@ module Ocman
         }
       end
 
-      def uri(path, filename=nil)
-        [Ocman::Dav.base_uri, path, filename].compact.join('/').gsub(/\/+/, '/')
+      def uri(path, filename = nil)
+        filename = CGI.escape(filename) if filename
+        [Ocman::Dav.base_uri, path, filename].compact.join('/').gsub(%r{/+}, '/')
       end
 
       def connection

data/lib/ocman/folder.rb

@@ -1,23 +1,71 @@
+# frozen_string_literal: true
+
 require 'hashie'
+require 'cgi'
+require 'erb'
 
 module Ocman
   class Folder
-    def self.create(path)
-      Ocman::Dav.new.mkdir(URI.encode(path))
-    end
+    class << self
+      def create_recursive(path)
+        path_list(path).each do |path_part|
+          next if ignore404 { list(path_part) }
+
+          create(path_part)
+        end
+      end
+
+      def create(path)
+        Ocman::Dav.new.mkdir(escape_path(path))
+        wait_for_folder(path)
+      end
+
+      def list(path, options = {})
+        accu = []
 
-    def self.list(path, options={})
-      accu = []
+        Ocman::Dav.new.ls(escape_path(path), options) do |item|
+          accu << Hashie::Mash.new(
+            path: CGI.unescape(item.uri.to_s.gsub(Ocman::Dav.url(path), '').gsub('/', '')),
+            type: item.type.to_s,
+            size: item.size
+          )
+        end
 
-      Ocman::Dav.new.ls(URI.encode(path), options) do |item|
-        accu << Hashie::Mash.new({
-          path: URI.decode(item.uri.to_s.gsub(Ocman::Dav.url(path), '').gsub('/', '')),
-          type: item.type.to_s,
-          size: item.size
-        })
+        accu
       end
 
-      accu
+      private
+
+        def escape_path(path)
+          path.split('/').map { |segment| ERB::Util.url_encode(segment) }.join('/')
+        end
+
+        def wait_for_folder(path)
+          wait_time = 1
+          retries = 0
+          loop do
+            raise TimeoutError if retries >= 3
+            break if Ocman.list(path)
+
+            sleep wait_time
+            wait_time *= 2
+            retries += 1
+          end
+        end
+
+        def ignore404
+          yield
+        rescue Net::HTTPServerException => e
+          raise unless e.to_s.match?(/404.*Not found/i)
+
+          nil
+        end
+
+        def path_list(path)
+          path.split('/').reduce([]) do |acc, segment|
+            acc << [acc.last, segment].compact.join('/')
+          end
+        end
     end
   end
 end

data/lib/ocman/item.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module Ocman
   class Item
-    def self.create(file, path, options={})
-      Ocman::Dav.new.put(file, URI.encode(path), options)
+    def self.create(file, path, options = {})
+      Ocman::Dav.new.put(file, CGI.escape(path), options)
     end
 
     def self.delete(path)
-      Ocman::Dav.new.delete(URI.encode(path))
+      Ocman::Dav.new.delete(CGI.escape(path))
     end
 
     def self.move(source_path, destination_path)
-      Ocman::Dav.new.move(URI.encode(source_path), URI.encode(destination_path))
+      Ocman::Dav.new.move(CGI.escape(source_path), CGI.escape(destination_path))
     end
   end
 end

data/lib/ocman/permission.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Ocman
+  class Permission
+    PERMISSIONS = {
+      read: 1,
+      update: 2,
+      create: 4,
+      delete: 8,
+      share: 16
+    }.freeze
+    private_constant :PERMISSIONS
+
+    attr_reader :permissions
+
+    def initialize(permissions = [:all])
+      @permissions = Set.new(permissions)
+      @permissions = Set.new(PERMISSIONS.keys) if @permissions.include?(:all)
+
+      raise ArgumentError, "No permission given. Valid permissions are: #{PERMISSIONS.keys}" if @permissions.empty?
+      return if @permissions.all? { |permission| PERMISSIONS.key?(permission) }
+
+      raise ArgumentError, "Valid permissions are: #{PERMISSIONS.keys}"
+    end
+
+    def to_i
+      @permissions
+        .map { |permission| PERMISSIONS.fetch(permission) }
+        .inject(&:|) || PERMISSIONS[:all]
+    end
+
+    def +(other)
+      Permission.new(permissions + other.permissions)
+    end
+
+    def -(other)
+      Permission.new(permissions - other.permissions)
+    end
+
+    class << self
+      PERMISSIONS.each_key do |name|
+        define_method(name) do
+          new([name])
+        end
+      end
+
+      def all
+        new(PERMISSIONS.keys)
+      end
+    end
+  end
+end

data/lib/ocman/share.rb

@@ -1,4 +1,6 @@
-require 'json'
+# frozen_string_literal: true
+
+require 'multi_json'
 require 'restclient'
 require 'hashie'
 
@@ -8,68 +10,67 @@ module Ocman
       @path = path
     end
 
-    def share(user)
+    def share(user, permission = Permission.all)
       request_parameter = {
-        payload:  {
+        payload: {
           path: @path,
           shareWith: user,
           shareType: '0',
-          permissions: '31',
-        },
+          permissions: permission.to_i
+        }
       }.merge connection_params('post')
 
-      request = RestClient::Request.new( request_parameter )
-      parse_result( request.execute )
+      request = RestClient::Request.new(request_parameter)
+      parse_result(request.execute)
     end
 
     def delete_share(user)
       share = find_share(user)
-      request_parameter = connection_params('delete', share.id)
-      request = RestClient::Request.new( request_parameter )
-      parse_result( request.execute )
+      return if share.nil?
+
+      request = RestClient::Request.new(connection_params('delete', id: share.id))
+      parse_result(request.execute)
     end
 
     def find_share(user)
-      result = nil
-      shares = share_info.data
-      shares = [shares] unless shares.kind_of?(Array)
-      shares.each do |share|
-        if share.share_with == user
-          result = share
-        end
+      Array(share_info.data).find do |share|
+        share.share_with == user
       end
-      result
     end
 
     def share_info
-      request_parameter = {
-        headers:  {
-          params: {
-            path: @path
-          },
-        },
-      }.merge connection_params('get')
-
-      request = RestClient::Request.new( request_parameter )
-      parse_result( request.execute )
+      request = RestClient::Request.new(connection_params('get', path: @path))
+      parse_result(request.execute)
     end
 
     private
+
       def parse_result(response)
-        Hashie::Mash.new( JSON.parse(response)['ocs'] )
+        Hashie::Mash.new(MultiJson.load(response)['ocs'])
       end
 
-      def connection_params(http_method, id=nil)
-        url = Ocman.configuration.base_url + "/ocs/v1.php/apps/files_sharing/api/v1/shares" + "#{'/' + id.to_s if id}?format=json"
+      def connection_params(http_method, attributes = {})
         {
-          url:      url,
-          method:   http_method,
-          user:     Ocman.configuration.user_name,
+          url: share_url(attributes[:id]),
+          method: http_method,
+          user: Ocman.configuration.user_name,
           password: Ocman.configuration.password,
-          headers:  {
-            'OCS-APIRequest': true,
-          }
+          headers: connection_headers(attributes)
         }
       end
+
+      def connection_headers(attributes = {})
+        {
+          'OCS-APIRequest' => true,
+          params: {
+            path: attributes[:path],
+            format: 'json'
+          }.compact
+        }
+      end
+
+      def share_url(id = nil)
+        "#{Ocman.configuration.base_url}/ocs/v1.php/apps/files_sharing/api/v1/shares#{"/#{id}" if id}"
+      end
   end
 end

data/lib/ocman/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ocman
-  VERSION = '1.2.1'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocman
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Waldemar Gribele
@@ -9,52 +9,52 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2016-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: net_dav
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: net_dav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -67,6 +67,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +123,49 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-description: Ruby gem for file managment and sharing in owncloud
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: Ruby gem for file managment and sharing in nextcloud/owncloud
 email: laboratories@toptranslation.com
 executables: []
 extensions: []
@@ -92,6 +176,7 @@ files:
 - lib/ocman/dav.rb
 - lib/ocman/folder.rb
 - lib/ocman/item.rb
+- lib/ocman/permission.rb
 - lib/ocman/share.rb
 - lib/ocman/version.rb
 homepage: https://developer.toptranslation.com
@@ -106,16 +191,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Ocman - Manages files and shares in owncloud
+summary: Ocman - Manages files and shares in nextcloud/owncloud
 test_files: []