storedsafe 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3284ce4b299b3a111699580ab7a144ece6586017688a190277f19db54750eab1
-  data.tar.gz: 7712584e6f771e1825166aca610b349bc0067a9f3ea8d1742f9802a5362d41e6
+  metadata.gz: 2c21ee6c1c19d8c978e38fc35f06e80ab74f45fa89a4523accea45babbbbe592
+  data.tar.gz: e3d4001ef178c9f8da95e8de1c441c3d19736950e5bad25fba49652aa07e2a74
 SHA512:
-  metadata.gz: 7d0ab608ef2f79adef486a5f3ed67828fe4327e43cccc4734649c4c1384e4cc7b8c48cf96e799b4bd1ad36ba2f6ff85ddd5310b76620e3a2c5d685447a26da80
-  data.tar.gz: 130f06c1fb087a0d2a29e7e276a6f449ee45eef9a1f29813fc32ae1499de2920728bcfd6733cf122427bd488a8e6b7580841846e1d33d8056f9621f29001f1d8
+  metadata.gz: a2aa4eec337404560da5b5e54fcbc7f48ba1c324dd30874d90b1c4c9c1eea3e97d457b5b75525b604a7aa57a526b6d6b3852d7d3866693db4114b19297c7f96b
+  data.tar.gz: 8a1bca50bab2de5237e7a48be258202325a78bd4a2f44e2174eecf609039352c6239ecb3d19f65ff543e3674e83c918214f53cb92aae6f278382e02e1f47ff8c

data/README.md

@@ -8,16 +8,24 @@ This is a ruby wrapper for the Storedsafe REST-like API (See full [docs here](ht
 
 Install from rubygems `gem install storedsafe`
 
-Add to Gemfile `gem 'storedsafe', '~> 0.0.1'`
+Add to Gemfile `gem 'storedsafe', '~> 0.0.3'`
+
+Alternatively, if you whish to install the gem manually, you can clone this repo and build the gem yourself.
+
+```
+git clone https://github.com/storedsafe/storedsafe-ruby
+cd storedsafe-ruby
+gem build storedsafe.gemspec
+gem install storedsafe-0.0.3.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_token = 'abc123'
+  config.api_key = 'abc123'
   config.token = 'secret'
-  config.username = 'bob'
 end
 ```
 
@@ -59,11 +67,11 @@ api.authenticate('abc123', 'abcdef123456', Storedsafe::API::LoginType::YUBIKEY)
 * retrieve\_template(template\_id)
 
 ### Objects
-* object(object\_id, decrypt=false)
+* 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\_object(needle)
+* 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`.

data/lib/storedsafe.rb

@@ -1,12 +1,14 @@
 # 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'
+
   class << self
-    require 'storedsafe/api'
-    require 'storedsafe/config'
-    require 'storedsafe/parser'
 
     ##
     # Set up a new API instance configured to communicate with your Storedsafe

data/lib/storedsafe/api.rb

@@ -12,6 +12,9 @@ require_relative 'api/vaults'
 require_relative 'api/templates'
 
 module Storedsafe
+  class ConnectionError < StandardError
+  end
+
   ##
   # Contains all interaction and configuration relating to the remote API.
   class API
@@ -52,7 +55,11 @@ module Storedsafe
       assign_verify_mode(http)
       request = create_request(method, uri, params)
 
-      http.request(request) if request
+      res = http.request(request) if request
+      parse_body(res)
+
+    rescue SocketError => e
+      raise ConnectionError.new(e.message)
     end
 
     def assign_verify_mode(http)

data/lib/storedsafe/api/auth.rb

@@ -10,17 +10,14 @@ module Storedsafe
     # @param [String] otp Yubikey press
     # @see authenticate Authentication with other OTP types.
     def authenticate_yubikey(passphrase, otp)
-      res = request(
+      data = request(
         :post, '/auth',
         username: @username, keys: "#{passphrase}#{@api_key}#{otp}"
       )
-      data = parse_body(res)
       @token = data['CALLINFO']['token']
       data
     end
 
-    # rubocop:disable Metrics/MethodLength
-
     ##
     # Authenticates a user with specified OTP method.
     # @param [String] passphrase
@@ -31,23 +28,19 @@ module Storedsafe
         return authenticate_yubikey(passphrase, otp)
       end
 
-      res = request(
+      data = request(
         :post, '/auth',
         username: @username, passphrase: passphrase, otp: otp,
         apikey: @api_key, logintype: logintype
       )
-      data = parse_body(res)
       @token = data['CALLINFO']['token']
       data
     end
 
-    # rubocop:enable Metrics/MethodLength
-
     ##
     # Invalidates the token.
     def logout
-      res = request(:get, '/auth/logout', token: @token)
-      data = parse_body(res)
+      data = request(:get, '/auth/logout', token: @token)
       @token = nil if data['CALLINFO']['status'] == 'SUCCESS'
       data
     end
@@ -56,8 +49,7 @@ module Storedsafe
     # Checks whether or not the token is valid and refreshes the
     # timeout for that token if valid.
     def check
-      res = request(:get, '/auth/check', token: @token)
-      parse_body(res)
+      request(:get, '/auth/check', token: @token)
     end
   end
 end

data/lib/storedsafe/api/objects.rb

@@ -10,12 +10,16 @@ module Storedsafe
     # Lists all information regarding an object and optionally decrypts
     # encrypted fields.
     # @param [Integer] object_id
-    # @param [Boolean] decrypt
-    def object(object_id, decrypt = false)
-      res = request(
-        :get, "/object/#{object_id}", token: @token, decrypt: decrypt
+    # @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
       )
-      parse_body(res)
     end
 
     ##
@@ -28,13 +32,12 @@ module Storedsafe
     def create_object(
       template_id, group_id, parent_id, object_name, template_args
     )
-      res = request(
+      request(
         :post, '/object', {
           token: @token, templateid: template_id, groupid: group_id,
           parentid: parent_id, objectname: object_name
         }.merge(template_args)
       )
-      parse_body(res)
     end
 
     ##
@@ -45,33 +48,30 @@ module Storedsafe
     # @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.
+    #  see Storedsafe::API#list_templates.
     def edit_object(
       object_id, template_id, group_id, parent_id, object_name, template_args
     )
-      res = request(
+      request(
         :put, "/object/#{object_id}", {
           token: @token, templateid: template_id, groupid: group_id,
           parentid: parent_id, objectname: object_name
         }.merge(template_args)
       )
-      parse_body(res)
     end
 
     ##
     # Deletes an existing object.
     # @param [Integer] object_id
     def delete_object(object_id)
-      res = request(:delete, "/object/#{object_id}", token: @token)
-      parse_body(res)
+      request(:delete, "/object/#{object_id}", token: @token)
     end
 
     ##
     # Search in unencrypted data to find Objects.
     # @param [String] needle String to match Objects with.
-    def find_object(needle)
-      res = request(:get, '/find', token: @token, needle: needle)
-      parse_body(res)
+    def find(needle)
+      request(:get, '/find', token: @token, needle: needle)
     end
 
     # rubocop:enable Metrics/ParameterLists

data/lib/storedsafe/api/templates.rb

@@ -7,8 +7,7 @@ module Storedsafe
     ##
     # Obtains a list with information about all available templates.
     def list_templates
-      res = request(:get, '/template', token: @token)
-      parse_body(res)
+      request(:get, '/template', token: @token)
     end
 
     ##
@@ -16,8 +15,7 @@ module Storedsafe
     # @param [Integer] template_id
     # @see list_templates
     def retrieve_template(template_id)
-      res = request(:get, "/template/#{template_id}", token: @token)
-      parse_body(res)
+      request(:get, "/template/#{template_id}", token: @token)
     end
   end
 end

data/lib/storedsafe/api/vaults.rb

@@ -7,8 +7,7 @@ module Storedsafe
     ##
     # Lists all Vaults associated with the logged in user.
     def list_vaults
-      res = request(:get, '/vault', token: @token)
-      parse_body(res)
+      request(:get, '/vault', token: @token)
     end
 
     ##
@@ -16,8 +15,7 @@ module Storedsafe
     # @param [Integer] vault_id
     # @see list_vaults
     def list_objects(vault_id)
-      res = request(:get, "/vault/#{vault_id}", token: @token)
-      parse_body(res)
+      request(:get, "/vault/#{vault_id}", token: @token)
     end
 
     ##
@@ -27,12 +25,11 @@ module Storedsafe
     # @param [Integer] policy Password policy.
     # @param [String] description
     def create_vault(groupname, policy, description)
-      res = request(
+      request(
         :post, '/vault',
         token: @token,
         groupname: groupname, policy: policy, description: description
       )
-      parse_body(res)
     end
 
     ##
@@ -44,8 +41,7 @@ module Storedsafe
     # @option args [Integer] policy New password policy
     # @option args [String] description New Vault description.
     def edit_vault(vault_id, args)
-      res = request(:put, "/vault/#{vault_id}", { token: @token }.merge(args))
-      parse_body(res)
+      request(:put, "/vault/#{vault_id}", { token: @token }.merge(args))
     end
 
     ##
@@ -55,8 +51,7 @@ module Storedsafe
     # specified Vault.
     # @param [Integer] vault_id
     def delete_vault(vault_id)
-      res = request(:delete, "/vault/#{vault_id}", token: @token)
-      parse_body(res)
+      request(:delete, "/vault/#{vault_id}", token: @token)
     end
   end
 end

data/lib/storedsafe/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storedsafe
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Oscar Mattsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 2019-07-25 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: oscar_mattsson@live.se
@@ -30,6 +30,7 @@ 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
@@ -50,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Storedsafe is a ruby wrapper for the Storedsafe REST-like API.