streetlib-vault 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '09e36ad7aa965b7267cce53d814b91b4e90a2e17d29bfe1667881b03d4c60386'
+  data.tar.gz: 5416082b12410f2f471832cf8ed71d078c2618aa190369d91883bdb0585cc420
+SHA512:
+  metadata.gz: 8177865de04c4dd7b25593dcc4312910452ff9021dd75428056d451dfd8b5faa2c4a725b2dd933472239edfe03219ed55f1ab3fbdbd0a7a5eb435c841648a023
+  data.tar.gz: '08a1770e144e44077cd6a2704364ee0727896669874b712abac78d5485b439869b6c5d0ef0c18d6d36117ce9529bbc55c738a2ea9797e87d643412994b6a0da8'

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Streetlib::Vault's changelog
+
+## 2019-12-18
+
+🎉 0.1.0 Genesis.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at root@olisti.co. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    streetlib-vault (1.0.0)
+      mu-result (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.2)
+    minitest (5.13.0)
+    mu-result (1.0.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  pry (~> 0.12)
+  rake (~> 10.0)
+  streetlib-vault!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Streetlib
+
+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,80 @@
+# Streetlib::Vault
+
+This gem provides a class to read data from a YAML, for example to read and consume secrets within your app.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'streetlib-vault'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install streetlib-vault
+
+## Usage
+
+Suppose that you have a `config/secrets.yml` containing:
+
+```yaml
+service:
+  username: foo
+  password: bar
+```
+
+Then:
+
+```ruby
+result = Streetlib::Vault::Loader.load(path: "config/secrets.yml")
+result.success? # => true
+
+# The actual content is now available here:
+content = result.data.content
+
+# Here's how you can access values:
+content.service.username.unwrap # => "foo"
+content.service.password.unwrap # => "bar"
+
+content.service.unwrap # => { "username" => "foo", "password" => "bar" }
+
+content.service["username"].unwrap # => "foo"
+content.service["password"].unwrap # => "bar"
+
+content["service"]["username"].unwrap # => "foo"
+content["service"]["password"].unwrap # => "bar"
+
+content.service.something_that_does_not_exist # => raises a Streetlib::Vault::Error
+```
+
+## Notes
+
+The following is a not exhaustive list of some keywords that cannot be used as
+keys within the YAML file, because they're used as method names:
+
+- each
+- wrap
+- unwrap
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 at https://bitbucket.org/simplicissimus/streetlib-vault. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Streetlib::Vault project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://bitbucket.org/simplicissimus/streetlib-vault/src/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "streetlib/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

data/bin/setup

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

data/exe/streetlib-vault

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "streetlib/vault"

data/lib/streetlib/vault.rb

@@ -0,0 +1,20 @@
+require "streetlib/vault/version"
+require 'streetlib/vault/error'
+require 'streetlib/vault/content'
+require 'streetlib/vault/loader'
+require 'mu/result'
+
+module Streetlib
+  module Vault
+    include Mu
+       
+    def self.load(path:)
+      result = Loader.load(path: path)
+      if result.error?
+        raise Error.new("Can't load file: #{path}. [code:#{result.code}]")
+      end
+      result.data.content
+    end
+
+  end
+end

data/lib/streetlib/vault/content.rb

@@ -0,0 +1,80 @@
+require 'mu/result'
+
+module Streetlib
+  module Vault
+
+    class Content
+      include Mu
+      attr_accessor :value
+
+      def initialize(value = {})
+        self.value = value
+      end
+
+      def method_missing(key)
+        super unless is_a_dictionary?
+
+        stringified_key = key.to_s
+        unless value.keys.include?(stringified_key)
+          raise Error.new("Key #{stringified_key} doesn't exist at the current path.")
+        end
+      
+        new_value = value[stringified_key]
+
+        # returning the wrapped sub hash to allow nested chaining
+        wrap(new_value)
+      end
+
+      def each
+        return super unless value.kind_of?(Array)
+
+        value.each do |item|
+          yield wrap(item)
+        end
+      end
+
+      def map
+        return super unless value.kind_of?(Array)
+
+        value.map do |item|
+          yield wrap(item)
+        end
+      end
+
+      def has_key?(key)
+        return false unless is_a_dictionary?
+
+        stringified_key = key.to_s
+        value.keys.include?(stringified_key)
+      end
+
+      def [](key)
+        if value.kind_of?(Array) && key.kind_of?(Numeric)
+          if key >= value.length
+            raise Error.new("Can't access index #{key} on a list of #{value.length} items.")
+          end
+
+          new_value = value[key]
+          wrap(new_value)
+        else
+          self.send(key)
+        end
+      end
+
+      def unwrap
+        self.value
+      end
+
+      private
+      def wrap(item)
+        self.class.new(item)
+      end
+
+      def is_a_dictionary?
+        return false unless value.respond_to?(:keys)
+        value.keys.respond_to?(:include?)
+      end
+    end
+
+  end
+end

data/lib/streetlib/vault/error.rb

@@ -0,0 +1,5 @@
+module Streetlib
+  module Vault
+    class Error < StandardError; end
+  end
+end

data/lib/streetlib/vault/loader.rb

@@ -0,0 +1,42 @@
+require 'yaml'
+require 'mu/result'
+
+module Streetlib
+  module Vault
+
+    class Loader
+      include Mu
+      attr_accessor :path, :content
+    
+      def initialize(path:)
+        self.path = path
+        self.content = nil
+      end
+    
+      def self.load(path:)
+        instance = new(path: path)
+        result = instance.load
+        return result if result.error?
+    
+        Result.success(instance)
+      end
+    
+      def load
+        context = { path: path }
+        return Result.error(context).code!(:no_such_file) unless File.exists?(path)
+    
+        begin
+          yaml_content = YAML.load_file(path)
+        rescue StandardError => error
+          return Result.
+            error(context.merge({ error: error })).
+            code!(:cant_load_file)
+        end
+    
+        self.content = Content.new(yaml_content)
+        Result.success
+      end
+    end
+
+  end
+end

data/lib/streetlib/vault/version.rb

@@ -0,0 +1,5 @@
+module Streetlib
+  module Vault
+    VERSION = "1.0.0"
+  end
+end

data/streetlib-vault.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "streetlib/vault/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "streetlib-vault"
+  spec.version       = Streetlib::Vault::VERSION
+  spec.authors       = ["Maurizio De Magnis"]
+  spec.email         = ["maurizio.demagnis@streetlib.com"]
+
+  spec.summary       = %q{Read secrets.}
+  spec.description   = %q{This is a simple gem to handle secrets stored in a YAML.}
+  spec.homepage      = "https://bitbucket.org/simplicissimus/vault"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://bitbucket.org/simplicissimus/vault"
+  spec.metadata["changelog_uri"] = "https://bitbucket.org/simplicissimus/vault/src/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry", "~> 0.12"
+  spec.add_runtime_dependency "mu-result", "~> 1.0"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: streetlib-vault
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Maurizio De Magnis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-03 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: 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: mu-result
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: This is a simple gem to handle secrets stored in a YAML.
+email:
+- maurizio.demagnis@streetlib.com
+executables:
+- streetlib-vault
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/streetlib-vault
+- lib/streetlib/vault.rb
+- lib/streetlib/vault/content.rb
+- lib/streetlib/vault/error.rb
+- lib/streetlib/vault/loader.rb
+- lib/streetlib/vault/version.rb
+- streetlib-vault.gemspec
+homepage: https://bitbucket.org/simplicissimus/vault
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://bitbucket.org/simplicissimus/vault
+  source_code_uri: https://bitbucket.org/simplicissimus/vault
+  changelog_uri: https://bitbucket.org/simplicissimus/vault/src/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Read secrets.
+test_files: []