nextcloud 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53bda8e8c13b3595070f0895adb7a29cf4773d0f
+  data.tar.gz: a8c34ecb37ed8ea38d8468f310933ec8cd4ca134
+SHA512:
+  metadata.gz: ee9515e02c319536ddc9fd05c290a9bee3330a9a6aff0bca307fd522dacf8dfa41002a5cf719faf7d070a4e9b9f4148264773594514cce7a3c5f405b1857bf3f
+  data.tar.gz: 937566070385aaad0702f91585e15a60e0bcc01bb3de31eacb9e92415d209b280339c49ae98909ec46ab03cc61ba73c66c77c4f0ab516f248a0b2009136165fa

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# temporarily rspec
+.rspec
+
+# rspec failure tracking
+.rspec_status

data/.rubocop.yml

@@ -0,0 +1,172 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  DisplayCopNames: true
+  DisabledByDefault: true
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+  EnforcedStyle: context_dependent
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/FirstParameterIndentation:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: normal
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+# VuDo: Enable this when confident about all test coverage
+Style/FrozenStringLiteralComment:
+  Enabled: false
+  EnforcedStyle: always
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/UnneededPercentQ:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Lint/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+# CMG Rules
+Rails:
+  Enabled: true
+
+Bundler:
+  Enabled: true
+
+Security:
+  Enabled: true
+
+Style/Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/SymbolArray:
+  Description: 'Use %i or %I for arrays of symbols.'
+  Enabled: true
+
+Metrics/LineLength:
+  Description: 'Limit lines to 120 characters.'
+  Enabled: true
+  Max: 120
+  Exclude:
+    - 'spec/**/*.rb'
+
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Lint/RescueWithoutErrorClass:
+  Enabled: false
+
+Layout/AlignParameters:
+  Enabled: true
+  EnforcedStyle: with_fixed_indentation
+  SupportedStyles:
+    - with_first_parameter
+    - with_fixed_indentation

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dachinat@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nextcloud.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    nextcloud (1.3.0)
+      activesupport (~> 5.1)
+      json (~> 2.1)
+      net-http-report (~> 0.1)
+      nokogiri (~> 1.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.3.0)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.7)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    mini_portile2 (2.3.0)
+    minitest (5.10.3)
+    net-http-report (0.1.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    parallel (1.12.0)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    public_suffix (3.0.1)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.51.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    safe_yaml (1.0.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+    vcr (3.0.3)
+    webmock (3.1.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  nextcloud!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.51)
+  vcr (~> 3.0)
+  webmock (~> 3.1)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dachi Natsvlishvili
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,668 @@
+[![Gem](https://img.shields.io/gem/v/nextcloud.svg?style=flat-square)](https://rubygems.org/gems/nextcloud)
+
+# Nextcloud Ruby API
+
+Wrapper gem for Ruby used for communicating with Nextcloud OCS and WebDAV API endpoints.
+
+This gem provides features for User provisioning, Group and App management, control of Shares and Federated Cloud
+Shares, WebDAV functions for File / Folder creation, removal and other operations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "nextcloud"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nextcloud
+
+## Usage
+
+#### Initialize with endpoint bundles
+
+To initialize an OCS client you can look at following example
+
+```
+ocs = Nextcloud.ocs(
+  url: "https://cloud.yourdomain.com",
+  username: "your_username",
+  password: "your_password"
+)
+```
+
+An URL has to be a base of your Nextcloud instance. For API requests, it will be parsed to 
+`https://cloud.yourdomain.com/ocs/v2.php/cloud/` or similar.
+
+Once `ocs` is available you can use following methods to initiate specific classes:
+
+`ocs.user`, `ocs.app`, `ocs.group`, `ocs.file_sharing`
+
+If you intent to work with WebDAV api you can initialize a client with `webdav`:
+
+```
+webdav = Nextcloud.webdav(
+  url: "https://cloud.yourdomain.com",
+  username: "your_username",
+  password: "your_password"
+)
+```
+
+#### Initialize specific APIs
+
+Previously described method is recommended, however you can initialize in a differt manner.
+
+Initialize OCS Users API:
+
+```
+user = Nextcloud::Ocs::User.new(url: "...", username: "...", password: "...")
+```
+
+Initialize OCS Groups API:
+
+```
+group = Nextcloud::Ocs::Group.new(url: "...", username: "...", password: "...")
+```
+
+Initialize OCS Apps API:
+
+```
+app = Nextcloud::Ocs::App.new(url: "...", username: "...", password: "...")
+```
+
+Initialize OCS File Sharing API:
+
+```
+file_sharing = Nextcloud::Ocs::FileSharingApi.new(url: "...", username: "...", password: "...")
+```
+
+Initialize WebDAV Directory API:
+
+```
+directory = Nextcloud::WebDav::Directory.new(url: "...", username: "...", password: "...")
+```
+
+> When initializing this way, to work with certain objects some circumstances might force you use `set` method.
+> For example if you wish to list members of group admin, using first way you could simply write 
+`ocs.group('admin').members`, in this case you will need to use `group.set('admin').members`. There is another way to
+set object of intereset by putting it into initialize arguments, like so 
+`Nextcloud::Ocs::Group.new({...credentials}, groupid: "admin")` it can be then reset with
+`set`. Corressponding parameter names for other classes are `userid` and `appid`.
+
+### *OCS Api usage*
+
+These examples assume you have `Nextcloud.ocs` instance or relevant instance of 
+`Nextcloud::Ocs::{CLASS_NAME}.new` stored in `ocs` variable.
+
+### User actions
+
+#### Get list of users
+
+```
+users = ocs.user.all
+# => [#<Nextcloud::Models::User:0x00000104d253c0 @id="your_user_1">, #<Nextcloud::Models::User:0x00000104d1f858 @id="your_user_2">]
+
+last_user = user.last
+=> #<Nextcloud::Models::User:0x000001042a2ba0 @id="your_user_2">
+     
+response_meta = users.meta
+{"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Get a single user
+
+```
+user = ocs.user.find("your_user_1")
+# => #<Nextcloud::Models::User:0x00000103964020 @enabled="true", @id="your_user_1", ..., @meta={"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}>
+```
+
+Having `user` variable you have access to following attributes:
+
+* enabled
+* id
+* quota
+* email
+* displayname
+* phone
+* address
+* website
+* twitter
+* groups
+* language
+* meta
+
+
+Again, here you can use `user.meta` to get service response status, code and message.
+
+#### Create an user
+
+```
+meta = ocs.user.create("user3", "userPassword1!").meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Update an user
+
+You can update an user attributes with key-value method.
+
+Valid keys include:
+
+* quota
+* displayname
+* phone 
+* address 
+* website
+* twitter
+* password
+
+```
+meta = ocs.user.update("user3", "email", "new-address@some-domain.com").meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Disable user
+
+```
+meta = ocs.user.disable("user3").meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Enable user
+
+```
+meta = ocs.user.enable("user3").meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Delete user
+
+```
+meta = ocs.user.destroy("user3").meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Resend welcome email message
+
+```
+meta = ocs.user.resend_welcome("user3").meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+### User group actions
+
+#### Get user groups
+
+```
+groups = ocs.user("user1").groups
+# => ["admin"]
+meta = groups.meta 
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+if you work with initialized User class
+
+```
+user.set("user1").groups
+```
+
+#### Add user to group
+
+```
+meta = ocs.user("user4").group.create("admin").meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+if you work with initialized User class
+
+```
+user.set("user4").group.create("admin")
+```
+
+#### Remove user from group
+
+```
+meta = ocs.user("user4").group.destroy("admin").meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+if you work with initialized User class
+
+```
+user.set("user4").group.destroy("admin")
+```
+
+#### Promote user to group subadmin
+
+```
+meta = ocs.user("user4").group("group1").promote.meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+if you work with initialized User class
+
+```
+user.set("user4").group("group1").promote
+```
+
+#### Demote user from group subadmin
+
+```
+meta = ocs.user("user4").group("group1").demote.meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+if you work with initialized User class
+
+```
+user.set("user4").group("group1").demote
+```
+
+#### Get user subadmin groups
+
+```
+subadmin_groups = ocs.user("user4").subadmin_groups
+# => ["group1"]
+meta = subadmin_groups.meta 
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+if you work with initialized User class
+
+```
+user.set("user4").subadmin_groups
+```
+
+### Group actions
+
+#### Get all groups
+
+```
+groups = ocs.group.all
+# => ["admin", "group1", "group2"]
+meta = groups.meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Search for a group
+
+```
+groups = ocs.group.search("admin")
+# => ["admin"]
+meta = groups.meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Create a new group
+
+```
+meta = ocs.group.create("group3").meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Get group members
+
+```
+members = ocs.group("admin").members
+# => ["user1", "user2"]
+meta = members.meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+if you work with initialized Group class
+
+```
+group.set("admin").members
+```
+
+#### Get group subadmins
+
+```
+members = ocs.group("group1").subadmins
+# => ["user1", "user2", "user3"]
+meta = members.meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+if you work with initialized Group class
+
+```
+group.set("group1").subadmins
+```
+
+#### Delete a group
+
+```
+meta = ocs.group.destroy("group3").meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+### App actions
+
+#### Get enabled applications
+
+```
+enabled = ocs.app.enabled
+# => [...]
+meta = enabled.meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Get disabled applications
+
+```
+disabled = ocs.app.disabled
+# => [...]
+meta = disabled.meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Get application information
+
+```
+app = ocs.app.find("appname")
+# => {...}
+meta = app.meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Enable application
+
+```
+meta = ocs.app("appname").enable.meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+if you work with initialized App class
+
+```
+app.set("appname").enable
+```
+
+#### Disable application
+
+```
+meta = ocs.app("appname").disable.meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+if you work with initialized App class
+
+```
+app.set("appname").disable
+```
+
+### FileSharing API
+
+#### Initialize with authentication information
+
+First of all you need to initiate a class with authentication information of user
+
+```
+ocs_fs = Nextcloud::Ocs::FileSharingApi.new(
+  url: "https://cloud.yourdomain.com",
+  username: "your_username",
+  password: "your_password"
+)
+```
+
+An URL has to be a base of your Nextcloud instance. For Sharing API requests, it will be parsed to 
+`https://cloud.yourdomain.com/ocs/v2.php/apps/files_sharing/api/v1/` 
+
+> You can also initialize with `Nextcloud.ocs(...credentials).file_sharing`
+
+#### Retrieve all shares of an (authenticated) user
+
+```
+all_shares = ocs_fs.all
+# => [{...}, {...}]
+meta = all_shares.meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Retrieve a single share
+
+```
+share = ocs_fs.find(11)
+# => {"id" => "22", "shareType" => "0", ...}
+meta = share.meta 
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Retrive shares from specific file or folder
+
+Can be called with two optional paremeters
+* reshares - boolean - shows all shares for a given file
+* subfiles - boolean - shows all shares for subfiles in a directory
+
+```
+# shares from file.txt
+file_shares = ocs_fs.specific("file.txt")
+
+# shares from /dir1
+dir_shares = ocs_fs.specific("/dir1")
+
+# not only the shares from the current user but all shares from the given file
+reshares = ocs_fs.specific("file1.txt", true)
+
+# all shares within a folder, given that path defines a folder
+subfiles = ocs_fs.specific("/dir1", ture, true)
+
+# Attached variables will also have .meta method with server response information
+```
+
+#### Create a share
+
+First argument is a `path` (required) to a file or a folder
+
+`shareType` (required) has to be an integer
+
+* 0 = user
+* 1 = group
+* 3 = public link
+* 6 = federated cloud share
+
+`shareWith` is only reqired if `shareType` is `0` or `1`, defines user or group file will be shared with
+
+`publicUpload` is boolean, allows public uploads in a directory (Visitors will be able to upload to public directory
+shared with link)
+
+`password` to protect shared links with
+
+`permissions` has to be an integer (default: 31, for public shares: 1)
+
+* 1 = read
+* 2 = update
+* 4 = create
+* 8 = delete
+* 16 = share
+* 31 = all
+
+```
+# share file.txt with user user1
+ocs_fs.create("file.txt", 0, "user1").meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+
+# share file1.txt with public link and assign password to it
+ocs_fs.create("file1.txt", 3, nil, nil, "password1P/")
+```
+
+#### Delete a share
+
+```
+delete = ocs_fs.destroy("21").meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Update a share
+
+For details about permissions see "Create a share" section
+
+Expiration date should be in "YYYY-MM-DD" format
+
+```
+# makes a share read-only
+ocs_fs.update_permissions(21, 1)
+
+# updates password
+ocs_fs.update_password(21, "newPassword!0")
+
+# allows public uploads
+ocs_fs.update_public_upload(21, true)
+
+# change expiration date
+ocs_fs.update_expire_date(21, "2017-11-22")
+
+# These methods will also have .meta method with server response information
+```
+
+### Federated Cloud Shares
+
+To create a federated cloud shares you can use `create` method on `FileSharingApi` (see previous section)
+
+#### List accepted federated shares
+
+```
+accepted = ocs_fs.federated.accepted
+# => [{...}, {...}]
+meta = accepted.meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### List pending federated shares
+
+```
+pending = ocs_fs.federated.pending
+# => [{...}, {...}]
+meta = pending.meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Info about federated share (accepted)
+
+```
+federated_share = ocs_fs.federated.find(12)
+# => {"id"=>"12", "remote"=>"https://...", ...}
+meta = federated_share.meta
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Delete accepted federated share
+
+```
+meta = ocs_fs.federated.destroy(12)
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Accept federated share
+
+```
+meta = ocs_fs.federated.accept(13)
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### Decline federated share
+
+```
+meta = ocs_fs.federated.decline(13)
+# => {"status"=>"ok", "statuscode"=>"200", "message"=>"OK"}
+```
+
+#### *WebDAV Api usage*
+
+In these examples `webdav` variable is assumed to be a valid instance of
+`Nextcloud.webdav` or `Nextcloud::Webdav::{CLASS_NAME}.new`
+
+#### File/Directory Operations
+
+Let's assume 
+
+### Find files/directories in given path
+
+```
+directory = webdav.directory.find("dir1/")
+```
+
+Will return instance of `Directory` model with information about current directory, it's method `contents` will contain
+array of resutls:
+
+```
+directory.contents
+``` 
+
+### Query information about file
+
+```
+file = webdav.directory.find("some_file.txt")
+```
+
+### Create a directory
+
+```
+webdav.directory.create("some_dir/new_dir")
+```
+
+### Delete a directory
+
+```
+webdav.directory.destroy("some_dir")
+```
+
+### Move a directory
+
+```
+webdav.directory.move("source_dir/", "destination_dir/")
+```
+
+### Copy a directory
+
+```
+webdav.directory.copy("source_dir/", "destination_dir/)
+```
+
+### Download a file
+
+```
+webdav.directory.download("some_file.txt")
+```
+
+### Upload a file
+
+```
+webdav.directory.upload("some_dir/new_file.txt", "CONTENTS")
+```
+
+### Make a file favorite
+
+```
+webdav.directory.favorite("some_file")
+```
+
+### Unfavorite a file
+
+```
+webdav.directory.unfavorite("some_file")
+```
+
+### Show favorite files in path
+
+```
+webdav.directory.favorites("/")
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dachinat/nextcloud. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Nextcloud gem project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dachinat/nextcloud/blob/master/CODE_OF_CONDUCT.md).