diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 1f380427325832ebf0dc7c124767c194ef0989de..a3110d30f3f8302a4f63a84b69c5ac2a71d79f57 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -17,7 +17,7 @@ rubocop: pages: before_script: [] script: - - gem install yard + - gem install yard redcarpet - yard doc -o public/ artifacts: paths: diff --git a/README.md b/README.md index b45f47955344a81097ee599bc7f972d2a456328c..05a22983106465e53e0adbcbea5248bde68e89c2 100644 --- a/README.md +++ b/README.md @@ -24,16 +24,62 @@ Or install it yourself as: ```ruby require 'passwordstate' -client = Passwordstate::Client.new 'https://passwordstate', username: 'user', password: 'password' -# Passwordstate::Client.new 'https://passwordstate', apikey: 'key' +client = Passwordstate::Client.new 'https://passwordstate.example.com', username: 'user', password: 'password' +# Passwordstate::Client.new 'https://passwordstate.example.com', apikey: 'key' +# #<Passwordstate::Client:0x0000559eb1fabec8 +# @headers= +# {"accept"=>"application/json", "user-agent"=>"RubyPasswordstate/0.1.0"}, +# @server_url=#<URI::HTTPS https://passwordstate.it.liu.se>, +# @timeout=15, +# @validate_certificate=true> + client.folders -# [#<Passwordstate::Resources::Folder:0x000055ed493636e8 @folder_name="Example", @folder_id=2, @tree_path="\\Example">, #<Passwordstate::Resources::Folder:0x000055ed49361fa0 @folder_name="Folder", @folder_id=3, @tree_path="\\Example\\Folder">] +# [#<Passwordstate::Resources::Folder:0x000055ed493636e8 +# @folder_name="Example", +# @folder_id=2, +# @tree_path="\\Example">, +# #<Passwordstate::Resources::Folder:0x000055ed49361fa0 +# @folder_name="Folder", +# @folder_id=3, +# @tree_path="\\Example\\Folder">] + client.password_lists.get(7).passwords -# [#<Passwordstate::Resources::Password:0x0000555fda8acdb8 @title="Webserver1", @user_name="test_web_account", @account_type_id=0, @password="[ REDACTED ]", @allow_export=false, @password_id=2>, #<Passwordstate::Resources::Password:0x0000555fda868640 @title="Webserver2", @user_name="test_web_account2", @account_type_id=0, @password="[ REDACTED ]", @allow_export=false, @password_id=3>, #<Passwordstate::Resources::Password:0x0000555fda84da48 @title="Webserver3", @user_name="test_web_account3", @account_type_id=0, @password="[ REDACTED ]", @allow_export=false, @password_id=4>] +# [#<Passwordstate::Resources::Password:0x0000555fda8acdb8 +# @title="Webserver1", +# @user_name="test_web_account", +# @account_type_id=0, +# @password="[ REDACTED ]", +# @allow_export=false, +# @password_id=2>, +# #<Passwordstate::Resources::Password:0x0000555fda868640 +# @title="Webserver2", +# @user_name="test_web_account2", +# @account_type_id=0, +# @password="[ REDACTED ]", +# @allow_export=false, +# @password_id=3>, +# #<Passwordstate::Resources::Password:0x0000555fda84da48 +# @title="Webserver3", +# @user_name="test_web_account3", +# @account_type_id=0, +# @password="[ REDACTED ]", +# @allow_export=false, +# @password_id=4>] + pw = client.password_lists.first.passwords.create title: 'example', user_name: 'someone', generate_password: true -# #<Passwordstate::Resources::Password:0x0000555fdaf9ce98 @title="example", @user_name="someone", @account_type_id=0, @password="[ REDACTED ]", @allow_export=true, @password_id=12, @generate_password=true, @password_list_id=6> +# #<Passwordstate::Resources::Password:0x0000555fdaf9ce98 +# @title="example", +# @user_name="someone", +# @account_type_id=0, +# @password="[ REDACTED ]", +# @allow_export=true, +# @password_id=12, +# @generate_password=true, +# @password_list_id=6> + pw.password # "millionfE2rMrcb2LngBTHnDyxdpsGSmK3" + pw.delete # true ```