storedsafe 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c21ee6c1c19d8c978e38fc35f06e80ab74f45fa89a4523accea45babbbbe592
-  data.tar.gz: e3d4001ef178c9f8da95e8de1c441c3d19736950e5bad25fba49652aa07e2a74
+  metadata.gz: 4bff6b3480d106541211e5535dd7627acf681d25a0ddd59cb9b579923eb93221
+  data.tar.gz: 6f1c08f73fd048419571258caf9d005a6f53e1e5de0ac9068f0bb237f23b26d6
 SHA512:
-  metadata.gz: a2aa4eec337404560da5b5e54fcbc7f48ba1c324dd30874d90b1c4c9c1eea3e97d457b5b75525b604a7aa57a526b6d6b3852d7d3866693db4114b19297c7f96b
-  data.tar.gz: 8a1bca50bab2de5237e7a48be258202325a78bd4a2f44e2174eecf609039352c6239ecb3d19f65ff543e3674e83c918214f53cb92aae6f278382e02e1f47ff8c
+  metadata.gz: a4f1a886d6a1f752313a26bf71a4531b6306b3edb2aaccbd5dfbb63eddfd54f84f884a3e39810b763b6cd328bb059bdbc7be13f11ca63686e32105de111b6b0f
+  data.tar.gz: 4b95dc9b88627a2e4ffd89afc3b874e919e203bef700001d813ebe86158a4b25dc6699a568ff0bdafda6000f67fcd7609583f7953bba93df87957bdc39defff3

data/README.md

@@ -1,14 +1,14 @@
-# Storedsafe API ruby wrapper
+# StoredSafe API ruby wrapper
 
-This is a ruby wrapper for the Storedsafe REST-like API (See full [docs here](https://tracker.storedsafe.com/projects/storedsafe20/wiki/Version_10_release_documentation)).
+Transparent Ruby wrapper for the StoredSafe REST-like API. (See full [docs here](https://developer.storedsafe.com/)).
 
-**This early version may contain errors and is subject to change and should be used with caution**
+Full documentation of the API response signatures and more advanced paramters can be found at the [StoredSafe API Documentation](https://developer.storedsafe.com/).
 
 ## Install
 
 Install from rubygems `gem install storedsafe`
 
-Add to Gemfile `gem 'storedsafe', '~> 0.0.3'`
+Add to Gemfile `gem 'storedsafe', '~> 1.0.0'`
 
 Alternatively, if you whish to install the gem manually, you can clone this repo and build the gem yourself.
 
@@ -16,78 +16,72 @@ Alternatively, if you whish to install the gem manually, you can clone this repo
 git clone https://github.com/storedsafe/storedsafe-ruby
 cd storedsafe-ruby
 gem build storedsafe.gemspec
-gem install storedsafe-0.0.3.gem
+gem install storedsafe-0.1.0.gem
 ```
 
 ## Usage
-To pass a manual configuration, you simply pass a block to *Storedsafe.configure*.
-```
-api = Storedsafe.configure do |config|
-  config.server = 'storedsafe.example.com'
-  config.api_key = 'abc123'
-  config.token = 'secret'
-end
-```
-
-If you only want to use the built-in defaults you can skip the block.
-```
-api = Storedsafe.configure
-```
-
-See [Configuration](#configuration) for more info about default values and external configuration sources.
-
-All methods of the `Storedsafe::API` object returns the data parsed by whichever parser is listed in your config's *parser* field. By default the `Storedsafe::Parser::RawParser` is used, which simply turns the returned JSON data into a Ruby hash.
-
-### Authentication
-If you already have a token from another source, you can enter it in the config and skip this section.
 
-Three forms of authentication are currently availble. Either by the default *TOTP* (`Storedsafe::API::LogintType::TOTP`), *yubikey* (`Storedsafe::API::LoginType::YUBIKEY`) or *smartcard* (`Storedsafe::API::LoginType::SMARTCARD`).
-
-NOTE: Make sure all other relevant fields are set on the Storedsafe::API object (username, api\_key)
-
-Example authenticating using TOTP (sets the *token* field of the Storedsafe::API object).
-```
-api.authenticate('abc123', '123456')
-```
+```ruby
+require 'storedsafe'
+api = StoredSafe.configure do |config|
+  config.host = 'my.site.com'
+  config.apikey = 'my-api-key'
+end
 
-Example authenticating using YubiKey.
-```
-api.authenticate('abc123', 'abcdef123456', Storedsafe::API::LoginType::YUBIKEY)
+# Auth
+api.login_totp('username', 'passphrase', 'otp')
+api.login_yubikey('username', 'passphrase', 'otp')
+api.logout()
+api.check()
+
+# Vaults
+api.list_vaults()
+api.vault_objects(vault_id)
+api.vault_members(vault_id)
+api.create_vault(**args) # See parameters in API documentation
+api.edit_vault(vault_id, **args)
+api.delete_vault(vault_id)
+
+# Objects
+api.get_object(object_id) # String or integer
+api.get_object(object_id, children=True) # children False by default
+api.decrypt_object(object_id)
+api.create_object(**args)
+api.edit_object(object_id, **args)
+api.delete_object(object_id)
+
+# Users
+api.list_users() # List all users
+api.list_users(user_id) # List specific user
+api.list_users(search_string) # Search for any user matching search_string
+api.create_user(**args)
+api.edit_user(user_id, **args)
+api.delete_user(user_id)
+
+# Utils
+api.status_values()
+api.password_policies()
+api.version()
+api.generate_password() # Use vault policy
+api.generate_password(**args)
 ```
 
-### Vaults
-* list\_vaults
-* list\_objects(vault\_id)
-* create\_vault(groupname, policy, description)
-* edit\_vault(vault\_id, { groupname, policy, description })
-* delete\_vault(vault\_id)
-
-### Templates
-* list\_templates
-* retrieve\_template(template\_id)
-
-### Objects
-* object(object\_id, decrypt: false, children: false)
-* create\_object(template\_id, group\_id, parent\_id, object\_name, template\_args)
-* edit\_object(object\_id, template\_id, group\_id, parent\_id, object\_name, template\_args)
-* delete\_object(object\_id)
-* find(needle)
 
 ## Configuration
-Configuration can be done in a few different ways. Other than the manual configuration, external configuration sources can be applied through the *config\_sources* array. This array contains Ruby Hashes with the fields that should be applied to the `Storedsafe::Config::Configurable` instance. By default fetch configurations through the `Storedsafe::Config::RcReader` and `Storedsafe::Config::EnvReader`.
+Configuration can be done in a few different ways. Other than the manual configuration, external configuration sources can be applied through the *config\_sources* array. This array contains Ruby Hashes with the fields that should be applied to the `StoredSafe::Config::Configurable` instance. By default fetch configurations through the `StoredSafe::Config::RcReader` and `StoredSafe::Config::EnvReader`.
 
 The order of priority between these different configuration sources are:
 1. Manual Configuration
 2. Built-in defaults
 3. Elements in the config\_sources array in order of appearance
 
-The **RcReader** will extract a configuration hash from a file (default is ~/.storedsafe-client.rc) which is generated by the [Storedsafe Tokenhandler](https://github.com/storedsafe/tokenhandler).
+The **RcReader** will extract a configuration hash from a file (default is ~/.storedsafe-client.rc) which is generated by the [StoredSafe Tokenhandler](https://github.com/storedsafe/tokenhandler).
 
 The **EnvReader** will extract a configuration hash from environment variables. By default these variables are `STOREDSAFE_SERVER`, `STOREDSAFE_TOKEN`, `STOREDSAFE_CABUNDLE` and `STOREDSAFE_SKIP_VERIFY`.
 
 To disable all external configuration sources such as the rc-file and environment vairables, set the *config\_sources* option to an empty array.
 ```
-api = Storedsafe.configure do |config|
+api = StoredSafe.configure do |config|
   config.config_sources = []
   ...
 end
@@ -96,10 +90,10 @@ end
 If you want to add your own configurations, simply add them to the config\_sources array.
 ```
 def fetch_password(options, obj_id)
-  api = Storedsafe.configure do |config|
+  api = StoredSafe.configure do |config|
     config.config_sources = [
       options,
-      Storedsafe::Config::RcReader.parse_file('/path/to/.storedsafe-client.rc'),
+      StoredSafe::Config::RcReader.parse_file('/path/to/.storedsafe-client.rc'),
     ]
   end
   api.object(obj_id, true)

data/lib/storedsafe.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
+
 require 'storedsafe/api'
 require 'storedsafe/config'
 require 'storedsafe/parser'
 
 ##
-# Ruby wrapper for the Storedsafe RESTlike API.
-module Storedsafe
-  VERSION = '0.0.3'
+# Ruby wrapper for the StoredSafe RESTlike API.
+module StoredSafe
+  VERSION = '1.0.0'
 
   class << self
-
     ##
-    # Set up a new API instance configured to communicate with your Storedsafe
+    # Set up a new API instance configured to communicate with your StoredSafe
     # server.
-    # @see Storedsafe::Config::Configurable for more information about the
+    # @see StoredSafe::Config::Configurable for more information about the
     #   available fields for configuration.
     def configure
       API.new do |api|

data/lib/storedsafe/api.rb

@@ -10,29 +10,23 @@ require_relative 'api/auth'
 require_relative 'api/objects'
 require_relative 'api/vaults'
 require_relative 'api/templates'
+require_relative 'api/users'
+require_relative 'api/misc'
 
-module Storedsafe
+module StoredSafe
   class ConnectionError < StandardError
   end
 
   ##
   # Contains all interaction and configuration relating to the remote API.
   class API
-    include Storedsafe::Config::Configurable
-
-    ##
-    # Supported Login Types
-    module LoginType
-      YUBIKEY    = 'yubikey'  # HOTP with Yubico YubiKey device
-      TOTP       = 'totp'     # Time-Based OTP using Authenticator
-      SMARTCARD  = 'smc_rest' # Smartcard
-    end
+    include StoredSafe::Config::Configurable
 
     ##
     # Creates a new API handler with the passed configuration,
     # then allocates remaining uninitialized values with values from
     # alternate sources.
-    # @see Storedsafe::Config
+    # @see StoredSafe::Config
     def initialize
       yield self
       Config.apply(self)
@@ -40,26 +34,52 @@ module Storedsafe
 
     private
 
+    def create_headers
+      { 'X-Http-Token': @token }
+    end
+
+    def request_auth(**params)
+      request(
+        :post, '/auth',
+        apikey: @apikey, **params
+      )
+    end
+
+    def request_get(path, **params)
+      request(:get, path, params, create_headers)
+    end
+
+    def request_post(path, **params)
+      request(:post, path, params, create_headers)
+    end
+
+    def request_put(path, **params)
+      request(:put, path, params, create_headers)
+    end
+
+    def request_delete(path, **params)
+      request(:delete, path, params, create_headers)
+    end
+
     ##
     # Sends a request to the StoredSafe API.
     # @param [String] method HTTP method used for request.
     # @param [String] path Endpoint path relative to the API
     #   root on the server.
     # @param [Hash] params Data to be sent with the request.
-    def request(method, path, params)
-      url = "https://#{@server}/api/#{@api_version}#{path}"
+    def request(method, path, params, headers = {})
+      url = "https://#{@host}/api/#{@version}#{path}"
       uri = URI.parse(url)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
 
       assign_verify_mode(http)
-      request = create_request(method, uri, params)
+      request = create_request(method, uri, params, headers)
 
       res = http.request(request) if request
       parse_body(res)
-
     rescue SocketError => e
-      raise ConnectionError.new(e.message)
+      raise ConnectionError, e.message
     end
 
     def assign_verify_mode(http)
@@ -72,43 +92,43 @@ module Storedsafe
       end
     end
 
-    def create_request(method, uri, params)
+    def create_request(method, uri, params, headers)
       case method
       when :get
-        create_get_request(uri, params)
+        create_get_request(uri, params, headers)
       when :post
-        create_post_request(uri, params)
+        create_post_request(uri, params, headers)
       when :delete
-        create_delete_request(uri, params)
+        create_delete_request(uri, params, headers)
       when :put
-        create_put_request(uri, params)
+        create_put_request(uri, params, headers)
       end
     end
 
-    def create_get_request(uri, params)
+    def create_get_request(uri, params, headers)
       uri.query   = URI.encode_www_form(params)
-      request     = Net::HTTP::Get.new(uri)
+      request     = Net::HTTP::Get.new(uri, headers)
       request
     end
 
-    def create_delete_request(uri, params)
-      headers         = { 'Content-Type': 'application/json' }
-      request         = Net::HTTP::Delete.new(uri, headers)
-      request.body    = params.to_json
+    def create_delete_request(uri, params, headers)
+      headers       = { 'Content-Type': 'application/json', **headers }
+      request       = Net::HTTP::Delete.new(uri, headers)
+      request.body  = params.to_json
       request
     end
 
-    def create_post_request(uri, params)
-      headers         = { 'Content-Type': 'application/json' }
-      request         = Net::HTTP::Post.new(uri, headers)
-      request.body    = params.to_json
+    def create_post_request(uri, params, headers)
+      headers       = { 'Content-Type': 'application/json', **headers }
+      request       = Net::HTTP::Post.new(uri, headers)
+      request.body  = params.to_json
       request
     end
 
-    def create_put_request(uri, params)
-      headers         = { 'Content-Type': 'application/json' }
-      request         = Net::HTTP::Put.new(uri, headers)
-      request.body    = params.to_json
+    def create_put_request(uri, params, headers)
+      headers       = { 'Content-Type': 'application/json', **headers }
+      request       = Net::HTTP::Put.new(uri, headers)
+      request.body  = params.to_json
       request
     end
 

data/lib/storedsafe/api/auth.rb

@@ -1,37 +1,35 @@
 # frozen_string_literal: true
 
-module Storedsafe
+module StoredSafe
   ##
   # Handles API requests to the /auth path.
   class API
     ##
     # Authenticates a user with a Yubico OTP.
+    # @param [String] username
     # @param [String] passphrase
     # @param [String] otp Yubikey press
     # @see authenticate Authentication with other OTP types.
-    def authenticate_yubikey(passphrase, otp)
-      data = request(
-        :post, '/auth',
-        username: @username, keys: "#{passphrase}#{@api_key}#{otp}"
+    def login_yubikey(username, passphrase, otp)
+      data = request_auth(
+        username: username,
+        keys: "#{passphrase}#{@apikey}#{otp}"
       )
       @token = data['CALLINFO']['token']
       data
     end
 
     ##
-    # Authenticates a user with specified OTP method.
+    # Authenticates a user using TOTP.
+    # @param [String] username
     # @param [String] passphrase
     # @param [String] otp One-time password
-    # @param [String] logintype See Storedsafe::API::LoginType
-    def authenticate(passphrase, otp, logintype = LoginType::TOTP)
-      if logintype == LoginType::YUBIKEY
-        return authenticate_yubikey(passphrase, otp)
-      end
-
-      data = request(
-        :post, '/auth',
-        username: @username, passphrase: passphrase, otp: otp,
-        apikey: @api_key, logintype: logintype
+    def login_totp(username, passphrase, otp)
+      data = request_auth(
+        username: username,
+        passphrase: passphrase,
+        otp: otp,
+        logintype: 'totp'
       )
       @token = data['CALLINFO']['token']
       data
@@ -40,7 +38,7 @@ module Storedsafe
     ##
     # Invalidates the token.
     def logout
-      data = request(:get, '/auth/logout', token: @token)
+      data = request_get('/auth/logout')
       @token = nil if data['CALLINFO']['status'] == 'SUCCESS'
       data
     end
@@ -49,7 +47,7 @@ module Storedsafe
     # Checks whether or not the token is valid and refreshes the
     # timeout for that token if valid.
     def check
-      request(:get, '/auth/check', token: @token)
+      request_get('/auth/check')
     end
   end
 end

data/lib/storedsafe/api/misc.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module StoredSafe
+  ##
+  # Handles API requests to the /auth path.
+  class API
+    ##
+    # Request a list of all available capabilities and permission bits.
+    def status_values
+      request_get('/utils/statusvalues')
+    end
+
+    ##
+    # Request a list of all available password policies.
+    def password_policies
+      request_get('/utils/policies')
+    end
+
+    ##
+    # Request the version of the StoredSafe server.
+    def version
+      request_get('/utils/version')
+    end
+
+    ##
+    # Request a password generated with the passed settings.
+    def generate_password(**args)
+      request_get('/utils/pwgen', **args)
+    end
+  end
+end

data/lib/storedsafe/api/objects.rb

@@ -1,79 +1,53 @@
 # frozen_string_literal: true
 
-module Storedsafe
+module StoredSafe
   ##
   # Handles API requests to the /object path.
   class API
-    # rubocop:disable Metrics/ParameterLists
+    ##
+    # Lists all information regarding an object and optionally lists children
+    # of the object.
+    # @param [Integer] object_id
+    # @param [Boolean] include_children=false List object children
+    def get_object(object_id, include_children = false)
+      request_get("/object/#{object_id}", children: include_children)
+    end
 
     ##
-    # Lists all information regarding an object and optionally decrypts
-    # encrypted fields.
+    # Lists all information regarding an object, including decrypted
+    # information.
     # @param [Integer] object_id
-    # @param [Hash] options
-    # @option options [Boolean] :decrypt (false)
-    # @option options [Boolean] :children (false)
-    def object(object_id, options = {})
-      decrypt = options.fetch(:decrypt, false)
-      children = options.fetch(:children, false)
-      request(
-        :get, "/object/#{object_id}",
-        token: @token, decrypt: decrypt, children: children
-      )
+    def decrypt_object(object_id)
+      request_get("/object/#{object_id}", decrypt: true)
     end
 
     ##
     # Creates a new object in an existing vault.
-    # @param [Integer] template_id See Storedsafe::API#list_templates.
-    # @param [Integer] group_id Vault ID.
-    # @param [Integer] parent_id ID of parent Object.
-    # @param [String] object_name
-    # @param [Hash] template_args See Storedsafe::API#list_templates.
-    def create_object(
-      template_id, group_id, parent_id, object_name, template_args
-    )
-      request(
-        :post, '/object', {
-          token: @token, templateid: template_id, groupid: group_id,
-          parentid: parent_id, objectname: object_name
-        }.merge(template_args)
-      )
+    # @param [Hash] args (See API documentation)
+    def create_object(**args)
+      request_post('/object', **args)
     end
 
     ##
     # Edits an existing object.
     # @param [Integer] object_id Object to edit.
-    # @param [Integer] template_id See Storedsafe::API#list_templates.
-    # @param [Integer] group_id Vault ID.
-    # @param [Integer] parent_id ID of parent Object.
-    # @param [String] object_name New Object name.
-    # @param [Hash] template_args New Object values,
-    #  see Storedsafe::API#list_templates.
-    def edit_object(
-      object_id, template_id, group_id, parent_id, object_name, template_args
-    )
-      request(
-        :put, "/object/#{object_id}", {
-          token: @token, templateid: template_id, groupid: group_id,
-          parentid: parent_id, objectname: object_name
-        }.merge(template_args)
-      )
+    # @param [Hash] args (See API documentation)
+    def edit_object(object_id, **args)
+      request_put("/object/#{object_id}", **args)
     end
 
     ##
     # Deletes an existing object.
     # @param [Integer] object_id
     def delete_object(object_id)
-      request(:delete, "/object/#{object_id}", token: @token)
+      request_delete("/object/#{object_id}")
     end
 
     ##
     # Search in unencrypted data to find Objects.
     # @param [String] needle String to match Objects with.
     def find(needle)
-      request(:get, '/find', token: @token, needle: needle)
+      request_get('/find', needle: needle)
     end
-
-    # rubocop:enable Metrics/ParameterLists
   end
 end

data/lib/storedsafe/api/templates.rb

@@ -1,21 +1,20 @@
 # frozen_string_literal: true
 
-module Storedsafe
+module StoredSafe
   ##
   # Handles API requests to the /template path.
   class API
     ##
     # Obtains a list with information about all available templates.
     def list_templates
-      request(:get, '/template', token: @token)
+      request_get('/template')
     end
 
     ##
     # Obtains information about the specified template.
     # @param [Integer] template_id
-    # @see list_templates
-    def retrieve_template(template_id)
-      request(:get, "/template/#{template_id}", token: @token)
+    def get_template(template_id)
+      request_get("/template/#{template_id}")
     end
   end
 end

data/lib/storedsafe/api/users.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module StoredSafe
+  ##
+  # Handles API requests to the /auth path.
+  class API
+    ##
+    # Request list of all users or any users matching search string.
+    def list_users(search_string = nil)
+      return request_get('/user') if search_string.nil?
+
+      request_get('/user', searchstring: search_string)
+    end
+
+    ##
+    # Request the creation of a new user.
+    def create_user(**args)
+      request_post('/user', **args)
+    end
+
+    ##
+    # Request the creation of a new user."""
+    def edit_user(user_id, **args)
+      request_put("/user/#{user_id}", **args)
+    end
+
+    ##
+    # Request the creation of a new user."""
+    def delete_user(user_id)
+      request_delete("/user/#{user_id}")
+    end
+  end
+end

data/lib/storedsafe/api/vaults.rb

@@ -1,21 +1,58 @@
 # frozen_string_literal: true
 
-module Storedsafe
+module StoredSafe
   ##
   # Handles API requests to the /vault path.
   class API
     ##
     # Lists all Vaults associated with the logged in user.
     def list_vaults
-      request(:get, '/vault', token: @token)
+      request_get('/vault')
     end
 
     ##
     # Lists all objects within the specified Vault.
     # @param [Integer] vault_id
     # @see list_vaults
-    def list_objects(vault_id)
-      request(:get, "/vault/#{vault_id}", token: @token)
+    def vault_objects(vault_id)
+      request_get("/vault/#{vault_id}")
+    end
+
+    ##
+    # Lists all members with access to the specified Vault.
+    # @param [Integer] vault_id
+    # @see list_vaults
+    def vault_members(vault_id)
+      request_get("/vault/#{vault_id}/members")
+    end
+
+    ##
+    # Add a member to the specified Vault.
+    # @param [Integer] vault_id
+    # @param [Integer] user_id
+    # @param [Integer] status
+    # @see list_vaults
+    def add_vault_member(vault_id, user_id, status)
+      request_post("/vault/#{vault_id}/member/#{user_id}", status: status)
+    end
+
+    ##
+    # Edit a member's privileges in the specified Vault.
+    # @param [Integer] vault_id
+    # @param [Integer] user_id
+    # @param [Integer] status
+    # @see list_vaults
+    def edit_vault_member(vault_id, user_id, status)
+      request_put("/vault/#{vault_id}/member/#{user_id}", status: status)
+    end
+
+    ##
+    # Remove a member from the specified Vault.
+    # @param [Integer] vault_id
+    # @param [Integer] user_id
+    # @see list_vaults
+    def remove_vault_member(vault_id, user_id)
+      request_delete("/vault/#{vault_id}/member/#{user_id}")
     end
 
     ##
@@ -24,24 +61,18 @@ module Storedsafe
     # @param [String] groupname Name of Vault.
     # @param [Integer] policy Password policy.
     # @param [String] description
-    def create_vault(groupname, policy, description)
-      request(
-        :post, '/vault',
-        token: @token,
-        groupname: groupname, policy: policy, description: description
-      )
+    # @param [Hash] args (See API documentation)
+    def create_vault(**args)
+      request_post('/vault', **args)
     end
 
     ##
     # Changes information about an existing Vault using the optional
     # parameters passed in the last argument Hash.
     # @param [Integer] vault_id
-    # @param [Hash] args
-    # @option args [String] groupname New name of Vault
-    # @option args [Integer] policy New password policy
-    # @option args [String] description New Vault description.
-    def edit_vault(vault_id, args)
-      request(:put, "/vault/#{vault_id}", { token: @token }.merge(args))
+    # @param [Hash] args (See API documentation)
+    def edit_vault(vault_id, **args)
+      request_put("/vault/#{vault_id}", **args)
     end
 
     ##
@@ -51,7 +82,7 @@ module Storedsafe
     # specified Vault.
     # @param [Integer] vault_id
     def delete_vault(vault_id)
-      request(:delete, "/vault/#{vault_id}", token: @token)
+      request_delete("/vault/#{vault_id}")
     end
   end
 end

data/lib/storedsafe/config.rb

@@ -6,11 +6,11 @@ require_relative 'config/configurable'
 require_relative 'config/rc_reader'
 require_relative 'config/env_reader'
 
-module Storedsafe
+module StoredSafe
   ##
   # Contains modules and classes related to parsing configuration sources and
   # merging said configurations into an object including the Configurable mixin.
-  # @see Storedsafe::Config::Configurable for more information about the
+  # @see StoredSafe::Config::Configurable for more information about the
   #   available fields for configuration.
   module Config
     # Default configuration values
@@ -19,14 +19,14 @@ module Storedsafe
         RcReader.parse_file,
         EnvReader.parse_env
       ],
-      api_version: '1.0',
+      version: '1.0',
       parser: Parser::RawParser
     }.freeze
 
     ##
     # Allocate uninitialized values in a configurable object with
     # values from environment variables or an RC-file.
-    # @param [Storedsafe::Config::Configurable] configurable
+    # @param [StoredSafe::Config::Configurable] configurable
     def self.apply(configurable)
       apply_config(configurable, DEFAULTS)
 

data/lib/storedsafe/config/configurable.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-module Storedsafe
+module StoredSafe
   module Config
     ##
-    # Set up fields needed for configuration of Storedsafe connection.
+    # Set up fields needed for configuration of StoredSafe connection.
     module Configurable
       attr_accessor(
-        :server, :token, :ca_bundle, :skip_verify, :config_sources,
-        :username, :api_key, :api_version, :parser
+        :host, :token, :ca_bundle, :skip_verify,
+        :config_sources, :apikey, :version, :parser
       )
     end
   end

data/lib/storedsafe/config/env_reader.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Storedsafe
+module StoredSafe
   module Config
     ##
     # Reads configuration items from environment variables.
@@ -12,7 +12,7 @@ module Storedsafe
         # @param [Hash] fields Mapping from configuration field to environment
         #   variable name.
         def parse_env(fields = {
-          server: 'STOREDSAFE_SERVER',
+          host: 'STOREDSAFE_SERVER',
           token: 'STOREDSAFE_TOKEN',
           ca_bundle: 'STOREDSAFE_CABUNDLE',
           skip_verify: 'STOREDSAFE_SKIP_VERIFY'

data/lib/storedsafe/config/rc_reader.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Storedsafe
+module StoredSafe
   module Config
     ##
     # Reads configuration items from rc file.
@@ -30,12 +30,10 @@ module Storedsafe
           case key
           when 'token'
             config[:token] = val
-          when 'username'
-            config[:username] = val
           when 'apikey'
-            config[:api_key] = val
+            config[:apikey] = val
           when 'mysite'
-            config[:server] = val
+            config[:host] = val
           end
         end
       end

data/lib/storedsafe/parser.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-module Storedsafe
+module StoredSafe
   ##
-  # Methods and modules used to parse responses from the Storedsafe API.
+  # Methods and modules used to parse responses from the StoredSafe API.
   module Parser
     require_relative 'parser/raw_parser'
   end

data/lib/storedsafe/parser/raw_parser.rb

@@ -2,14 +2,14 @@
 
 require 'json'
 
-module Storedsafe
+module StoredSafe
   module Parser
     ##
-    # Transparent parser for the Storedsafe API.
+    # Transparent parser for the StoredSafe API.
     module RawParser
       class << self
         ##
-        # Transparently parses the Storedsafe API response into a ruby Hash.
+        # Transparently parses the StoredSafe API response into a ruby Hash.
         # @return [Hash]
         def parse_response(res)
           JSON.parse(res)

metadata

@@ -1,15 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: storedsafe
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Oscar Mattsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-25 00:00:00.000000000 Z
-dependencies: []
+date: 2020-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 description: 
 email: oscar_mattsson@live.se
 executables: []
@@ -21,8 +91,10 @@ files:
 - lib/storedsafe.rb
 - lib/storedsafe/api.rb
 - lib/storedsafe/api/auth.rb
+- lib/storedsafe/api/misc.rb
 - lib/storedsafe/api/objects.rb
 - lib/storedsafe/api/templates.rb
+- lib/storedsafe/api/users.rb
 - lib/storedsafe/api/vaults.rb
 - lib/storedsafe/config.rb
 - lib/storedsafe/config/configurable.rb
@@ -30,7 +102,6 @@ files:
 - lib/storedsafe/config/rc_reader.rb
 - lib/storedsafe/parser.rb
 - lib/storedsafe/parser/raw_parser.rb
-- lib/storedsafe/version.rb
 homepage: https://github.com/storedsafe/storedsafe-ruby
 licenses:
 - Apache-2.0
@@ -51,8 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Storedsafe is a ruby wrapper for the Storedsafe REST-like API.
+summary: The Storedsafe gem is a ruby interface for the Storedsafe REST-like API.
 test_files: []

data/lib/storedsafe/version.rb

@@ -1,3 +0,0 @@
-module Storedsafe
-  VERSION = '0.0.3'
-end