Project

ocman

0.0
No commit activity in last 3 years
No release in over 3 years
ocmantt-laboratories/ocmanHomepageDocumentationSource CodeBug Tracker
Ruby gem for file managment and sharing in nextcloud/owncloud
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
31,607
Stars
3
Forks
2
Watchers
4
 Releases
Current version
1.4.0
Total releases
10
First release
2016-06-10
Latest release
2016-12-30
 Issues
Open Issues
1
Closed Issues
0
Total Issues
1
Issue Closure Rate
0%
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
0
Merged Pull Requests
5
Pull Request Acceptance Rate
83%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2017-10-05
Reverse Dependencies
0

 Dependencies

Development

pry
>= 0
pry-nav
>= 0
rake
>= 0
rspec
~> 3.5
rubocop
~> 1.6.1
rubocop-rake
~> 0.5
rubocop-rspec
~> 2.1.0

Runtime

hashie
~> 3.4
multi_json
~> 1.0
net_dav
~> 0.5.1
rest-client
~> 2.0
 Project Readme

ocman

Ruby gem for file managment and sharing in owncloud

Installation

Rails

Add this line to your application's Gemfile:

gem "ocman", :git => 'git@github.com:tt-laboratories/ocman.git'

Configuration

Initialize Ocman with your access credentials somewhere during startup. In a rails application that may be an initializer like .../initializers/ocman.rb.

Ocman.configure do |config|
  # Required
  config.base_url = 'https://example.org'
  config.user_name = ''
  config.password = ''

  # Optional
  config.dav_base_uri = '/remote.php/webdav/' # Optional - URI of the owncloud installation. Defaults to '/remote.php/webdav/'
end

Usage

Sharing

Share a folder or a file

Ocman.share('path/to/folder', 'user_name')
# => #<Hashie::Mash data=nil meta=#<Hashie::Mash message=nil status='ok' statuscode='100'>>

# Share with read-only permissions (default is 'all')
Ocman.share('path/to/folder', 'user_name', Ocman::Permission.read)
# => #<Hashie::Mash data=nil meta=#<Hashie::Mash message=nil status='ok' statuscode='100'>>

# Share with specific set of permissions
Ocman.share('path/to/folder', 'user_name', Ocman::Permission.new([:read, :create, :update]))
# => #<Hashie::Mash data=nil meta=#<Hashie::Mash message=nil status='ok' statuscode='100'>>

Valid permissions are:

  • read
  • create
  • update
  • delete
  • share
  • all

Delete a share for a folder or a file

Ocman.delete_share('path/to/folder', 'user_name')
# #<Hashie::Mash data=nil meta=#<Hashie::Mash message=nil status='ok' statuscode='100'>>

File Management

List folder

Ocman.list('path/to/folder', options={})
# [#<Hashie::Mash path="Documents" size=0 type="directory">, #<Hashie::Mash path="Test.zip" size=127 type="file">]
Available options:
  • recursive - If true the folder contents will be listed recursively

Create folder

Ocman.create_folder('path/to/folder')
# => ""

Upload a file

Ocman.put('local/file/path', 'remote/path/to/folder', <options>)
# => nil

Available options:

  • filename: filename of the file stored in owncloud (defaults to basename of the file)

Delete a file or folder

Ocman.delete('path/to/file')
# => nil

Move a file or folder

Ocman.move('source_path/of/file', 'destination_path')
# => ""

Contact

Web: https://www.toptranslation.com, https://developer.toptranslation.com

Github: https://www.github.com/tt-laboratories

Twitter: @tt_developers, @toptranslation

Mail: tech@toptranslation.com