totvs_password_vault 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 692fc779e57e55d29cd598ea21175308303849ab
+  data.tar.gz: 5b7883c5e74c71cb77021b7b018e4b60216f2875
+SHA512:
+  metadata.gz: 60bfbfdfec5b2c82d9baf31496239f4cceb2d48a309ac1eef6a0b2144ef1fe416ee627b3a960e896a2fcdf6e80a843559a9f651b3fb1117b6d67a0c0d67b7889
+  data.tar.gz: 128937f32969529a40092b6d6f929c97fe6f66fa1d500ef865077bdbc826fc5314d4ac9548798c53de3e29857f96a8acd8cdc48145bee57fe1deae42b68c0eec

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,81 @@
+AllCops:
+  Include:
+    - "**/*.gemspec"
+    - "**/Rakefile"
+    - "**/Gemfile"
+  Exclude:
+    - "spec/spec_helper.rb"
+    - "bin/*"
+
+# avoid parameter lists longer than 5 parameters.
+ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Style/CaseIndentation:
+  IndentOneStep: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/Encoding:
+  EnforcedStyle: when_needed
+
+Style/FormatString:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  MaxLineLength: 120
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/LambdaCall:
+  EnforcedStyle: call
+
+Metrics/LineLength:
+  Max: 120
+
+Style/NonNilCheck:
+  IncludeSemanticChanges: true
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Style/PredicateName:
+  NamePrefixBlacklist:
+    - is_
+
+Style/RedundantReturn:
+  AllowMultipleReturnValues: true
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/WhileUntilModifier:
+  MaxLineLength: 120

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.3

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in totvs_password_vault.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Guilherme da Silva Mello
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# Totvs::PasswordVault
+
+[![Build Status](https://travis-ci.org/diegoaltheman/totvs_password_vault.svg)](https://travis-ci.org/diegoaltheman/totvs_password_vault)
+
+This gem is responsible for connecting to Totvs password vault and save keys, important information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "totvs_password_vault"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install totvs_password_vault
+
+## Usage
+
+### Connection config
+
+Currently this gem only supports a pre configured token keys. Please, set these env vars:
+
+- VAULT_CONSUMER_KEY
+- VAULT_CONSUMER_SECRET
+- VAULT_BASE_URL
+- VAULT_ACCESS_TOKEN
+- VAULT_ACCESS_TOKEN_SECRET
+
+### Totvs::PasswordVault::Key
+
+This class is responsible for handling keys (mainly ssh keys, but could be anything).
+
+```ruby
+key = Totvs::PasswordVault::Key.new
+key.save(id: "keyid", public_key: "public key", private_key: "private key", hostname: "hostname", ip: "0.0.0.0")
+
+key.retrieve(id: "keyid") #=> { public_key: "public key", private_key: "private key" }
+```
+
+### Totvs::PasswordVault::Information
+
+This class is responsible for handling any important information you need to store.
+
+```ruby
+info = Totvs::PasswordVault::Information.new
+info.save(id: "keyid", content: { "some" => "value" })
+
+info.retrieve(id: "keyid") #=> { "some" => "value" }
+```
+
+## Development
+
+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 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/diegoaltheman/totvs_password_vault.
+
+## TODO
+
+- Access token should be fetched (validated) and not env var configured
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "totvs/password_vault"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/totvs/password_vault/connection.rb

@@ -0,0 +1,166 @@
+require "oauth"
+
+module Totvs
+  module PasswordVault
+    class Connection
+      class Error < StandardError; end
+      class TimeoutError < Error; end
+      class RequestFailure < Error
+        attr_reader :response
+
+        # @param message [String]
+        # @param response [Net::HTTPResponse]
+        def initialize(message = nil, response:)
+          super("Status code: #{response.code}. Body: #{response.body}. #{message}")
+
+          @response = response
+        end
+      end
+
+      # @!attribute [w] consumer_key
+      #   @return [String]
+      attr_writer :consumer_key
+
+      # @!attribute [w] consumer_secret
+      #   @return [String]
+      attr_writer :consumer_secret
+
+      # @!attribute [w] vault_base_url
+      #   @return [String]
+      attr_writer :vault_base_url
+
+      # @!attribute [w] vault_access_token
+      #   @return [String]
+      attr_writer :vault_access_token
+
+      # @!attribute [w] vault_access_token_secret
+      #   @return [String]
+      attr_writer :vault_access_token_secret
+
+      # Returns the oauth consumer
+      # @return [OAuth::Consumer]
+      def consumer
+        @consumer ||= OAuth::Consumer.new(
+          consumer_key,
+          consumer_secret,
+          site: vault_base_url
+        )
+      end
+
+      # Returns the oauth access token
+      # @return [OAuth::AccessToken]
+      def access_token
+        @access_token ||= OAuth::AccessToken.new(
+          consumer,
+          vault_access_token,
+          vault_access_token_secret
+        )
+      end
+
+      # Alias access token
+      # @return [OAuth::AccessToken]
+      def requester
+        access_token
+      end
+
+      # Makes a http request
+      #
+      # @param http_method [Symbol]
+      # @param path [String]
+      # @param args [...]
+      #
+      # @return [Net::HTTPResponse]
+      #
+      # @raise [TimeoutError]
+      def make_request(http_method, path, *args)
+        requester.request http_method, path, *args
+      rescue Timeout::Error => e
+        raise TimeoutError, "#{http_method.to_s.upcase}: #{path}. #{e}"
+      end
+
+      # @return [Response] response
+      # @raise [RequestFailure] if the request was not a success
+      # @raise [TimeoutError]
+      def get(path:, headers: {})
+        response = make_request(:get, path, headers)
+        validate_success! response
+
+        wrap_response response
+      end
+
+      # @return [Response] response
+      # @raise [RequestFailure] if the request was not a success
+      # @raise [TimeoutError]
+      def post(path:, body: nil, headers: {})
+        response = make_request(:post, path, body, headers)
+        validate_success! response
+
+        wrap_response response
+      end
+
+      # @return [Response] response
+      # @raise [RequestFailure] if the request was not a success
+      # @raise [TimeoutError]
+      def put(path:, body: nil, headers: {})
+        response = make_request(:put, path, body, headers)
+        validate_success! response
+
+        wrap_response response
+      end
+
+      # @return [Response] response
+      # @raise [RequestFailure] if the request was not a success
+      # @raise [TimeoutError]
+      def delete(path:, headers: {})
+        response = make_request(:delete, path, headers)
+        validate_success! response
+
+        wrap_response response
+      end
+
+      # @return [String]
+      def consumer_key
+        @consumer_key ||= ENV["VAULT_CONSUMER_KEY"]
+      end
+
+      # @return [String]
+      def consumer_secret
+        @consumer_secret ||= ENV["VAULT_CONSUMER_SECRET"]
+      end
+
+      # @return [String]
+      def vault_base_url
+        @vault_base_url ||= ENV["VAULT_BASE_URL"]
+      end
+
+      # @return [String]
+      def vault_access_token
+        @vault_access_token ||= ENV["VAULT_ACCESS_TOKEN"]
+      end
+
+      # @return [String]
+      def vault_access_token_secret
+        @vault_access_token_secret ||= ENV["VAULT_ACCESS_TOKEN_SECRET"]
+      end
+
+      # Wraps the response to a Response object
+      # @return [Response]
+      def wrap_response(response)
+        Response.new status_code: response.code.to_i,
+                     body: response.body,
+                     content_type: response.content_type
+      end
+
+      protected
+
+      def validate_success!(response)
+        unless response.is_a? Net::HTTPSuccess
+          message = "Response class: #{response}"
+          fail RequestFailure.new message, response: response
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/totvs/password_vault/information.rb

@@ -0,0 +1,64 @@
+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
+      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"])
+      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
+      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}"
+      end
+    end
+  end
+end

data/lib/totvs/password_vault/key.rb

@@ -0,0 +1,72 @@
+require "forwardable"
+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]
+      # @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"] }
+      end
+
+      # @param id [String] the id key to save info
+      # @param public_key [String]
+      # @param private_key [String]
+      # @param hostname [String]
+      # @param ip [String]
+      def save(id:, public_key:, private_key:, hostname:, ip:, **kwargs)
+        headers = {
+          "Accept" => "application/json",
+          "Content-Type" => "application/json"
+        }
+
+        body = {
+          chave_publica: public_key,
+          chave_privada: private_key,
+          hostname: hostname,
+          ip: ip
+        }.merge(kwargs)
+
+        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
+      end
+
+      protected
+
+      def build_path(key)
+        "/iso/coe/chave/#{key}"
+      end
+    end
+  end
+end

data/lib/totvs/password_vault/parsers/json_parser.rb

@@ -0,0 +1,14 @@
+require "json"
+
+module Totvs
+  module PasswordVault
+    module JsonParser
+      # @param body [#to_s]
+      # @return [Hash]
+      # @raise [JSON::ParserError]
+      def parse_json(body)
+        JSON.parse body.to_s
+      end
+    end
+  end
+end

data/lib/totvs/password_vault/response.rb

@@ -0,0 +1,31 @@
+module Totvs
+  module PasswordVault
+    class Response
+      # @!attribute status_code
+      #   @return [Integer]
+      attr_reader :status_code
+
+      # @!attribute body
+      #   @return [String]
+      attr_reader :body
+
+      # @!attribute content_type
+      #   @return [String]
+      attr_reader :content_type
+
+      # @param status_code [Integer] the status code
+      # @param body [String]
+      # @param content_type
+      def initialize(status_code:, body:, content_type:)
+        @status_code = status_code
+        @body = body
+        @content_type = content_type
+      end
+
+      # @return [Boolean]
+      def success?
+        status_code >= 200 && status_code < 300
+      end
+    end
+  end
+end

data/lib/totvs/password_vault/version.rb

@@ -0,0 +1,5 @@
+module Totvs
+  module PasswordVault
+    VERSION = "0.1.0"
+  end
+end

data/lib/totvs/password_vault.rb

@@ -0,0 +1,11 @@
+require "totvs/password_vault/version"
+require "totvs/password_vault/connection"
+require "totvs/password_vault/information"
+require "totvs/password_vault/key"
+require "totvs/password_vault/response"
+require "totvs/password_vault/parsers/json_parser"
+
+module Totvs
+  module PasswordVault
+  end
+end

data/totvs_password_vault.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "totvs/password_vault/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "totvs_password_vault"
+  spec.version       = Totvs::PasswordVault::VERSION
+  spec.authors       = ["Guilherme da Silva Mello"]
+  spec.email         = ["guilhermesilvamello@gmail.com"]
+
+  spec.required_ruby_version = ">= 2.1"
+
+  spec.summary       = "Totvs password vault manager."
+  spec.description   = "This gem allows you to manage your data on totvs password vault."
+  spec.homepage      = "https://github.com/diegoaltheman/totvs_password_vault"
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "oauth", "~> 0.4"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "rspec-its", "~> 1.2"
+  spec.add_development_dependency "rubocop", "~> 0.32"
+  spec.add_development_dependency "pry", "~> 0.10"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: totvs_password_vault
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guilherme da Silva Mello
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.32'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: This gem allows you to manage your data on totvs password vault.
+email:
+- guilhermesilvamello@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/totvs/password_vault.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/response.rb
+- lib/totvs/password_vault/version.rb
+- totvs_password_vault.gemspec
+homepage: https://github.com/diegoaltheman/totvs_password_vault
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: Totvs password vault manager.
+test_files: []