ocman 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f629736d36a0df291ad884200af7b9467a2adf1dee039f0d9e2aa344bc49dc2
-  data.tar.gz: 03c847f40bc76577dc7b99654e8562e203f419dca75d3ec664e9297517840867
+  metadata.gz: 58ec7628de08f07c7606567bdcce3a4152fddc2dab5365652b0707d09a3767ec
+  data.tar.gz: ab5f84e0df798e065eea6b0f6b38e41c161dca35b382b04d7ae091035f13c91a
 SHA512:
-  metadata.gz: 746d95913b6985f64596f58a3b360c420dc1b1d48a88759e484ecc456daaa3b52992ee42c605b0c281cec958cb4127291c2cf9a04da302a2d3183995c238895c
-  data.tar.gz: 86021fa8cd483a213563ce11ec5d2c44b0dca41b69dac5792a1d8f9110469de2730240769e3a66f840143f97e4d30576b64992c192f41c3f6174d91d24106b37
+  metadata.gz: 54640cbcdc3977c51a66831d1948d61dd5bbcbed8208f0e616ead51450268bcb6487add93d75deae77718df3fb1ec91d96aba8e237c6f1eb62431213bd6703d9
+  data.tar.gz: '086169501a6e5a2d4da0f3f9344434b1673510cfde1b7f7418bbe784d089a7425a28e936b7124a036681af13556b8b74df7c29190cbd6b12759199c4fda10fe1'

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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/dav'
 require 'cgi'
 
@@ -6,16 +8,16 @@ module Ocman
     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|
+    def ls(path, options = {})
+      connection.find(uri(path), options) do |item|
         yield(item)
       end
     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))
@@ -23,11 +25,11 @@ module Ocman
     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
@@ -35,7 +37,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
@@ -48,9 +50,9 @@ module Ocman
         }
       end
 
-      def uri(path, filename=nil)
+      def uri(path, filename = nil)
         filename = CGI.escape(filename) if filename
-        [Ocman::Dav.base_uri, path, filename].compact.join('/').gsub(/\/+/, '/')
+        [Ocman::Dav.base_uri, path, filename].compact.join('/').gsub(%r{/+}, '/')
       end
 
       def connection

data/lib/ocman/folder.rb

@@ -1,23 +1,34 @@
+# frozen_string_literal: true
+
 require 'hashie'
+require 'cgi'
 
 module Ocman
   class Folder
-    def self.create(path)
-      Ocman::Dav.new.mkdir(URI.encode(path))
-    end
+    class << self
+      def create(path)
+        Ocman::Dav.new.mkdir(escape_path(path))
+      end
 
-    def self.list(path, options={})
-      accu = []
+      def list(path, options = {})
+        accu = []
 
-      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
-        })
+        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
+
+        accu
       end
 
-      accu
+      private
+
+        def escape_path(path)
+          path.split('/').map { |segment| CGI.escape(segment) }.join('/')
+        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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'multi_json'
 require 'restclient'
 require 'hashie'
@@ -8,65 +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 = RestClient::Request.new( connection_params('delete', id: share.id) )
-      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 = RestClient::Request.new( connection_params('get', path: @path) )
-      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( MultiJson.load(response)['ocs'] )
+        Hashie::Mash.new(MultiJson.load(response)['ocs'])
       end
 
-      def connection_params(http_method, attributes={})
-        id = attributes[:id]
-        url = Ocman.configuration.base_url + "/ocs/v1.php/apps/files_sharing/api/v1/shares" + "#{'/' + id.to_s if id}"
-
+      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,
-            params: {
-              path: attributes[:path],
-              format: 'json'
-            }.reject {| key, value | value.nil? }
-          }
+          headers: connection_headers(attributes)
         }
       end
+
+      def connection_headers(attributes = {})
+        {
+          'OCS-APIRequest' => true,
+          params: {
+            path: attributes[:path],
+            format: 'json'
+          }.reject { |_key, value| value.nil? }
+        }
+      end
+
+      def share_url(id = nil)
+        Ocman.configuration.base_url + '/ocs/v1.php/apps/files_sharing/api/v1/shares' + ('/' + id.to_s if id).to_s
+      end
   end
 end

data/lib/ocman/version.rb

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

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,7 +31,7 @@ module Ocman
   end
 
   ### folder
-  def self.list(path, options={})
+  def self.list(path, options = {})
     Ocman::Folder.list(path, options)
   end
 
@@ -37,7 +40,7 @@ module Ocman
   end
 
   ### files
-  def self.put(file_path, path, options={})
+  def self.put(file_path, path, options = {})
     Ocman::Item.create(file_path, path, options)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocman
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Waldemar Gribele
@@ -12,61 +12,103 @@ cert_chain: []
 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: multi_json
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        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,6 +123,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.37.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.37.1
 description: Ruby gem for file managment and sharing in nextcloud/owncloud
 email: laboratories@toptranslation.com
 executables: []
@@ -92,6 +162,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