totvs_password_vault 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f6f892d39900fb0879459c62965ad8538758131
-  data.tar.gz: 34d040991a7c38fb0cffbb888a7fee4e83c51065
+  metadata.gz: 010ef7c910164a6d91d792f7a935177ad9d2d034
+  data.tar.gz: 0a38e14d95bcdb9b0d6abd3ebab1822266d91e76
 SHA512:
-  metadata.gz: 15b65d4c58143d252044392d973f789c5879efeb6f3b6dbf3c35c43540f2638c7305d12f47a24c0cab0aefd1b7ffb733033068eecea96c0b69e2afe403659bcf
-  data.tar.gz: d3187e8d6ec97ea9e6100ae487320c4b6e5cef371a0ae281fb76093d7f4fd7dcab9d29c7cd953f9c17c29ba470a88f76144e3c038581b6a02969200f125a3e04
+  metadata.gz: 0b0ed20292ebfca6eaa3dbadd1ea5fe492edb2340ad92d2d7ecf1e18a1a36b5ddb24e8a71c71233588e7d09af8960835c7416ddca5bb7c5f179f40f3c0b28010
+  data.tar.gz: 2762fc9a1ce0304fb9c0681de354136e65926d5ae6a52db84104c39738f5d20e3211c29af921cb447a55453b8ba8339040847b13cb801c9d4e87f4911e16964e

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.env

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--tag ~integration

data/README.md

@@ -58,6 +58,8 @@ info.retrieve(id: "keyid") #=> { "some" => "value" }
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+To run integration tests run `rspec --tag integration`. They are skipped by default.
+
 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](https://rubygems.org).
 
 ## Contributing
@@ -73,4 +75,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/diegoa
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/config/password_vault.yml

@@ -0,0 +1,28 @@
+groups:
+  key: chave
+  password: senha
+  info: info
+
+fields:
+  commom:  &commom
+    id: id
+    hostname: hostname
+    ip: ip
+    username: username
+    maker: fabricante
+    device_type: tipo
+    device_model: modelo
+    site: site
+    password_type: tipo_senha
+    expiration_time: datahora_expiracao
+    tags: tags
+  key:
+    <<: *commom
+    public_key: chave_publica
+    private_key: chave_privada
+    password: senha
+  password:
+    <<: *commom
+    password: conteudo
+  info:
+    content: conteudo

data/lib/totvs/password_vault.rb

@@ -1,7 +1,10 @@
 require "totvs/password_vault/version"
 require "totvs/password_vault/connection"
-require "totvs/password_vault/information"
+require "totvs/password_vault/translator"
+require "totvs/password_vault/base"
 require "totvs/password_vault/key"
+require "totvs/password_vault/password"
+require "totvs/password_vault/information"
 require "totvs/password_vault/response"
 require "totvs/password_vault/parsers/json_parser"
 

data/lib/totvs/password_vault/base.rb

@@ -0,0 +1,128 @@
+require "forwardable"
+require "time"
+require "totvs/password_vault/parsers/json_parser"
+
+module Totvs
+  module PasswordVault
+    class Base
+      class Error < StandardError; end
+      class RequiredParameter < Error; end
+
+      extend Forwardable
+      include JsonParser
+
+      def_delegators :connection, :get, :post, :delete
+
+      # @!attribute [w] connection
+      #   @return [Connection]
+      attr_writer :connection
+
+      def initialize(connection: nil)
+        @connection = connection
+      end
+
+      def connection
+        @connection ||= Connection.new
+      end
+
+      # @param id [String] the id key to fetch info from
+      # @return [Hash<Symbol, String>] content the saved content
+      # @raise [Totvs::PasswordVault::Connection::RequestFailure] if the request was not a success
+      def retrieve(id:)
+        headers = { "Accept" => "application/json" }
+        response = get(path: build_path(id), headers: headers)
+        response = parse_json response.body
+
+        result = {}
+        response[translated_group].each do |key, value|
+          result[(field_key(key) || key).to_sym] = value
+        end
+
+        result
+      end
+
+      # @param id [String] the id key to save info
+      # @param kwargs [Hash]
+      def save(id:, **kwargs)
+        headers = {
+          "Accept" => "application/json",
+          "Content-Type" => "application/json"
+        }
+        validate_params!(kwargs)
+
+        post path: build_path(id), body: save_body(kwargs), headers: headers
+      end
+
+      # @param id [String] the id key to be removed
+      # @raise [Totvs::PasswordVault::Connection::RequestFailure] if the request was not a success
+      def destroy(id:)
+        headers = { "Accept" => "application/json" }
+        delete path: build_path(id), headers: headers
+      end
+
+      def required_params
+        fail NotImplementedError
+      end
+
+      def data_group
+        fail NotImplementedError
+      end
+
+      protected
+
+      # validate presence of all required params
+      def validate_params!(params)
+        required_params.each do |req_param|
+          fail RequiredParameter, "Required parameter {#{req_param}}" if params[req_param].nil?
+        end
+      end
+
+      # mount body to save request
+      # @param params [Hash]
+      # @return [Hash] translated body params
+      def save_body(params)
+        body = {}
+        params.each do |key, value|
+          body[field_translation(key.to_s).to_sym] = prepare_value_for_saving(value) if field_translation(key.to_s)
+        end
+        body.delete_if { |_, value| value.nil? || value.empty? }
+      end
+
+      # treat some type of value objects
+      # @param value [Object] to be prepared
+      # @return value with some kind of treatment
+      def prepare_value_for_saving(value)
+        case value
+        when Array
+          value.join(", ")
+        when Time
+          value.iso8601
+        when Hash
+          value.to_json
+        else
+          value
+        end
+      end
+
+      def field_translation(key)
+        translator.translate_field(data_group, key)
+      end
+
+      def field_key(name)
+        translator.field_key(data_group, name)
+      end
+
+      def translator
+        @translator ||= Translator.new
+      end
+
+      def translated_group
+        translator.translate_group(data_group)
+      end
+
+      def build_path(key)
+        "/iso/coe/#{translated_group}/#{key}"
+      end
+    end
+  end
+end

data/lib/totvs/password_vault/connection.rb

@@ -7,6 +7,7 @@ module Totvs
       class TimeoutError < Error; end
       class RegistryNotFoundError < Error; end
       class InactiveRegistryError < Error; end
+      class EnvironmentVariableError < Error; end
 
       class RequestFailure < Error
         attr_reader :response
@@ -76,6 +77,8 @@ module Totvs
       #
       # @raise [TimeoutError]
       def make_request(http_method, path, *args)
+        validate_environment_variables!
+
         requester.request http_method, path, *args
       rescue Timeout::Error => e
         raise TimeoutError, "#{http_method.to_s.upcase}: #{path}. #{e}"
@@ -121,6 +124,16 @@ module Totvs
         wrap_response response
       end
 
+      def required_environment_variables
+        %w(
+          VAULT_CONSUMER_KEY
+          VAULT_CONSUMER_SECRET
+          VAULT_BASE_URL
+          VAULT_ACCESS_TOKEN
+          VAULT_ACCESS_TOKEN_SECRET
+        )
+      end
+
       # @return [String]
       def consumer_key
         @consumer_key ||= ENV["VAULT_CONSUMER_KEY"]
@@ -156,6 +169,13 @@ module Totvs
 
       protected
 
+      # validates presence of environment variables
+      def validate_environment_variables!
+        required_environment_variables.each do |variable|
+          fail EnvironmentVariableError, "Missing environment variable: #{variable}" unless ENV[variable]
+        end
+      end
+
       def validate_success!(response)
         if response.is_a? Net::HTTPNotFound
           fail RegistryNotFoundError

data/lib/totvs/password_vault/information.rb

@@ -1,63 +1,17 @@
-require "forwardable"
-require "totvs/password_vault/parsers/json_parser"
-
 module Totvs
   module PasswordVault
-    class Information
-      extend Forwardable
-      include JsonParser
-
-      def_delegators :connection, :get, :post, :delete
-
-      # @!attribute [w] connection
-      #   @return [Connection]
-      attr_writer :connection
-
-      def initialize(connection: nil)
-        @connection = connection
-      end
-
-      def connection
-        @connection ||= Connection.new
-      end
-
-      # @param id [String] the id key to fetch info from
-      # @return [Hash, Array] content the saved content
-      # @raise [Totvs::PasswordVault::Connection::RequestFailure] if the request was not a success
+    class Information < Base
       def retrieve(id:)
-        headers = { "Accept" => "application/json" }
-        response = get(path: build_path(id), headers: headers)
-        response = parse_json(response.body)
-
-        parse_json(response["info"]["conteudo"])
+        result = super
+        parse_json result[:content]
       end
 
-      # @param id [String] the id key to save info
-      # @param content [#to_json]
-      def save(id:, content:, **kwargs)
-        headers = {
-          "Accept" => "application/json",
-          "Content-Type" => "application/json"
-        }
-
-        body = {
-          conteudo: content.to_json
-        }.merge(kwargs)
-
-        post path: build_path(id), body: body, headers: headers
+      def required_params
+        [:content]
       end
 
-      # @param id [String] the id key to be removed
-      # @raise [Totvs::PasswordVault::Connection::RequestFailure] if the request was not a success
-      def destroy(id:)
-        headers = { "Accept" => "application/json" }
-        delete path: build_path(id), headers: headers
-      end
-
-      protected
-
-      def build_path(key)
-        "/iso/coe/info/#{key}"
+      def data_group
+        "info"
       end
     end
   end

data/lib/totvs/password_vault/key.rb

@@ -1,124 +1,12 @@
-require "forwardable"
-require "time"
-require "totvs/password_vault/parsers/json_parser"
-
 module Totvs
   module PasswordVault
-    class Key
-      extend Forwardable
-      include JsonParser
-
-      def_delegators :connection, :get, :post, :delete
-
-      # @!attribute [w] connection
-      #   @return [Connection]
-      attr_writer :connection
-
-      def initialize(connection: nil)
-        @connection = connection
-      end
-
-      def connection
-        @connection ||= Connection.new
-      end
-
-      # @param id [String] the id key to fetch info from
-      # @return [Hash<Symbol, String>] content the saved content
-      #   @param public_key [String]
-      #   @param private_key [String]
-      #   @param hostname [String]
-      #   @param ip [String]
-      #   @param username [String]
-      #   @param maker [String]
-      #   @param device_type [String]
-      #   @param device_model [String]
-      #   @param site [String]
-      #   @param password_type [String]
-      #   @param tags [Array]
-      # @raise [Totvs::PasswordVault::Connection::RequestFailure] if the request was not a success
-      def retrieve(id:)
-        headers = { "Accept" => "application/json" }
-        response = get(path: build_path(id), headers: headers)
-        response = parse_json response.body
-
-        {
-          public_key: response["chave"]["chave_publica"],
-          private_key: response["chave"]["chave_privada"],
-          hostname: response["chave"]["hostname"],
-          ip: response["chave"]["ip"],
-          username: response["chave"]["username"],
-          maker: response["chave"]["fabricante"],
-          device_type: response["chave"]["tipo"],
-          device_model: response["chave"]["modelo"],
-          site: response["chave"]["site"],
-          password_type: response["chave"]["tipo_senha"],
-          expiration_time: response["chave"]["datahora_expiracao"],
-          tags: response["chave"]["tags"]
-        }
-      end
-
-      # @param id [String] the id key to save info
-      # @param public_key [String]
-      # @param private_key [String]
-      # @param hostname [String]
-      # @param ip [String]
-      # @param maker [String, nil]
-      # @param device_type [String, nil]
-      # @param device_model [String, nil]
-      # @param site [String, nil]
-      # @param password_type [String, nil]
-      # @param expiration_time [Time, nil]
-      # @param tags [Array[String], nil]
-      def save(
-        id:,
-        public_key:,
-        private_key:,
-        hostname:,
-        ip:,
-        username: nil,
-        maker: nil,
-        device_type: nil,
-        device_model: nil,
-        site: nil,
-        password_type: nil,
-        expiration_time: nil,
-        tags: [],
-        **kwargs
-      )
-        headers = {
-          "Accept" => "application/json",
-          "Content-Type" => "application/json"
-        }
-
-        body = {
-          chave_publica: public_key,
-          chave_privada: private_key,
-          hostname: hostname,
-          ip: ip,
-          username: username,
-          fabricante: maker,
-          tipo: device_type,
-          modelo: device_model,
-          site: site,
-          tipo_senha: password_type,
-          datahora_expiracao: expiration_time ? expiration_time.iso8601 : nil,
-          tags: tags.compact.join(", ")
-        }.merge(kwargs).delete_if { |_, value| value.nil? || value.empty? }
-
-        post path: build_path(id), body: body, headers: headers
-      end
-
-      # @param id [String] the id key to be removed
-      # @raise [Totvs::PasswordVault::Connection::RequestFailure] if the request was not a success
-      def destroy(id:)
-        headers = { "Accept" => "application/json" }
-        delete path: build_path(id), headers: headers
+    class Key < Base
+      def required_params
+        [:public_key, :private_key, :hostname, :ip]
       end
 
-      protected
-
-      def build_path(key)
-        "/iso/coe/chave/#{key}"
+      def data_group
+        "key"
       end
     end
   end

data/lib/totvs/password_vault/password.rb

@@ -0,0 +1,13 @@
+module Totvs
+  module PasswordVault
+    class Password < Base
+      def required_params
+        [:password, :hostname, :ip]
+      end
+
+      def data_group
+        "password"
+      end
+    end
+  end
+end

data/lib/totvs/password_vault/translator.rb

@@ -0,0 +1,22 @@
+require "yaml"
+
+module Totvs
+  module PasswordVault
+    class Translator
+      ACTION_CODES = YAML.load_file(
+        File.join(File.expand_path("../../../..", __FILE__), "config", "password_vault.yml")).freeze
+
+      def translate_field(group, key)
+        ACTION_CODES["fields"][group][key]
+      end
+
+      def field_key(group, name)
+        ACTION_CODES["fields"][group].key(name)
+      end
+
+      def translate_group(name)
+        ACTION_CODES["groups"][name]
+      end
+    end
+  end
+end

data/lib/totvs/password_vault/version.rb

@@ -1,5 +1,5 @@
 module Totvs
   module PasswordVault
-    VERSION = "0.2.2"
+    VERSION = "0.3.0"
   end
 end

data/totvs_password_vault.gemspec

@@ -37,4 +37,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-its", "~> 1.2"
   spec.add_development_dependency "rubocop", "~> 0.32"
   spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "dotenv"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: totvs_password_vault
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Guilherme da Silva Mello
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2015-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem allows you to manage your data on totvs password vault.
 email:
 - guilhermesilvamello@gmail.com
@@ -125,12 +139,16 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- config/password_vault.yml
 - lib/totvs/password_vault.rb
+- lib/totvs/password_vault/base.rb
 - lib/totvs/password_vault/connection.rb
 - lib/totvs/password_vault/information.rb
 - lib/totvs/password_vault/key.rb
 - lib/totvs/password_vault/parsers/json_parser.rb
+- lib/totvs/password_vault/password.rb
 - lib/totvs/password_vault/response.rb
+- lib/totvs/password_vault/translator.rb
 - lib/totvs/password_vault/version.rb
 - lib/totvs_password_vault.rb
 - totvs_password_vault.gemspec
@@ -154,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Totvs password vault manager.