okleinschmidt / wdmc Goto Github PK

View Code? Open in Web Editor NEW

12.0 4.0 2.0 31 KB

The missing CLI Client for Western Digital MyCloud NAS Systems.

License: MIT License

Ruby 100.00%

wd mycloud nas

wdmc's Introduction

wdmc

The missing command line interface for Western Digital MyCloud NAS local REST API.

Installation

Since wdmc is not published to rubygems.org yet, by now you have to build yourself as follows:

# clone git repository
$ git clone [email protected]:okleinschmidt/wdmc.git

# enter wdmc source directory
$ cd wdmc

# to install run
$ bundle exec rake install
wdmc 0.0.1 built to pkg/wdmc-0.0.1.gem.
wdmc (0.0.1) installed.

Configuration

Create YAML file in your $HOME: ~/.wdmc.yml

url: http://192.168.0.10
username: admin
password: super-secure-password
validate_cert: true | false | warn (optional, default: true)
api_net_nl_bug: true | false (optional, default: false)

The value of validate_cert is relevant only for HTTPS URLs:

If not specified or set to true, then an invalid certificate will cause the server connection to fail with an error message.
If set to false, then certificate validation will not be performed.
If set to warn, then an invalid certificate will cause a warning message to be emitted and for certificate validation to be deactivated for the remainder of the operation.

Set api_net_nl_bug to true to avoid crashes caused by newline characters in DNS server data in the API response from your server.

I gave admin permission to my user account:

$ wdmc user update <USER> -a

Usage

$ wdmc
Commands:
  wdmc acl             # Fileshare ACLs
  wdmc device          # Device commands
  wdmc help [COMMAND]  # Describe available commands or one specific command
  wdmc share           # Fileshare commands
  wdmc sysinfo         # Device information
  wdmc tm              # TimeMachine commands
  wdmc user            # User commands
  wdmc version         # Version information

# List available shares
$ wdmc share list
AVAILABLE SHARES
 - Public
 - TimeMachineBackup

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/okleinschmidt/wdmc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

wdmc's People

Contributors

Stargazers

Watchers

Forkers

tdilauro farkasmate

wdmc's Issues

security: Client class uses eval() to parse JSON

Use of eval() on unsanitized responses is generally unsafe.

Some Client class methods use eval() to convert JSON to a hash with symbols as keys.

Tags and RubyGems releases

Hi,

Great work on the under-documented API.
I'm working on a pet project - provisioning Kubernetes Persistent Volumes on my WD NAS - and I find your gem pretty useful.

I noticed that versions 0.0.1 and 0.0.2 are not tagged and not pushed to RubyGems.
It makes difficult to release my work as a gem depending on yours.

Could you please release the latest version?
Alternatively I can do that, rendering me as the owner of the release while keeping you as the author.

All the best,
Mate

Test support not working

@tdilauro Reverted your last changes. For me test-support throws errors.

$ bundle exec rspec

An error occurred while loading ./spec/client_spec.rb.
Failure/Error: hash_w_symbol_keys(['get_acl', share_w_acl])

NameError:
  undefined local variable or method `share_w_acl' for #<Class:0x00007f8142092868>
# ./spec/client_spec.rb:75:in `block (3 levels) in <top (required)>'
# ./spec/client_spec.rb:73:in `block (2 levels) in <top (required)>'
# ./spec/client_spec.rb:60:in `block in <top (required)>'
# ./spec/client_spec.rb:4:in `<top (required)>'


Finished in 0.00031 seconds (files took 0.4797 seconds to load)
0 examples, 0 failures, 1 error occurred outside of examples

maintainability: mix of string and symbol hash keys

The Client class serves a number of other classes, some of which expect symbols and others of which expect strings as keys for the hashes returned by Client's methods. As a result, Client can not do its work in a consistent manner.

Feature request: install apkg

I'm having some issues when uploading an apkg binary manually to /shares/Volume_1/.systemfile/upload and installing it with the upload_apkg command on the NAS.
It works well via the web interface though.
I want to install apkgs to a target my cloud host as part of the integration tests for wdpksrc.

Maybe this client could help out?

WD NAS returns invalid JSON

Nota bene: This is not a problem with the code, but with the server with which it interacts.

My WD PR4100 NAS returns invalid JSON in response to this method in the Client class. The response includes an unescaped newline (\n), resulting in JSON which cannot be parsed.

def network
      response = get("#{@config['url']}/api/2.1/rest/network_configuration", {accept: :json, :cookies => cookies})
      JSON.parse(response, :symbolize_names => true)[:network_configuration]
    end

Running the response body through jq...

echo '''{"network_configuration":{"ifname":"bond0", "iftype":"wired", "proto":"dhcp_client", "ip":"192.168.1.33", "netmask":"255.255.255.0", "gateway":"192.168.1.1", "dns0":"192.168.1.1
", "dns1":"", "dns2":"", "gateway_mac_address":""}}''' | jq .

...produces the following:

parse error: Invalid string: control characters from U+0000 through U+001F must be escaped at line 2, column 1

Running it through od...

echo '''{"network_configuration":{"ifname":"bond0", "iftype":"wired", "proto":"dhcp_client", "ip":"192.168.1.33", "netmask":"255.255.255.0", "gateway":"192.168.1.1", "dns0":"192.168.1.1
", "dns1":"", "dns2":"", "gateway_mac_address":""}}''' | od -t x1