tenants_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3eca820d9a9f2245f0a6ffa83be601299f4f4131
+  data.tar.gz: 00999284ee11d5e15bbfb02b228592792fd21dd9
+SHA512:
+  metadata.gz: 23ed8bf7952af6b307afafc650cb22344495f847d177c9419c53acef8ce64b6fa7cf998f5fea54f2ff64e84942a2715ce262f61960a9db46f515e35fcb4391c7
+  data.tar.gz: 2520e5342188420a7feafbf1c48023b01a636c46f0ff66d075a2b3ef4deaa74740857768ea31ccdb8a01a0dd01d1a7f89581cd6b01bd4bd589acc1524f9f6d51

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/.idea/
+.env
+.DS_Store

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Max: 100
+
+Documentation:
+  Enabled: false
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+
+Style/TrivialAccessors:
+  AllowPredicates: true

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+- 2.1
+- 2.2
+- 2.3.0
+before_install: gem install bundler -v 1.11.2
+notifications:
+  email:
+    - support@travellink.com.au
+  flowdock:
+    secure: rjxg7hIW69k5k/pAMwx7Z3WKdzeNhBV8EvBoD0U7cQ3j0BdTHCw68FrcqiN/AKQkfVbK4IlytLz0LGAZpQ7eGjSWH0O7W23oOk//hqO8caoYr1V2vF29y6rj92vuSlWMJQ6sBvMSNraAh5Xey/LXHT5Cw1KtZcYIorZBS6lxaKIxC9MMjVx7IIorIdYThpMv7SuvZStG9Ra8hZVD1LNOZtmdcEVT2wD0MyBE2LKtFciZlSDxlPJv38jw5k2xT0hOLJ5L4p8PrFhkiKkg/dt8/RLjt+WWNm0XVo5DDkBB4FHty5iUQcXH5BrCLKutH4+KwaUcF3O2jEMLstxZPWX0mHxjD5QOo2OOu1gAFKXE7jFEy+kXYJB7z1cX2hUb1Sgqn9OGqf2D5020peH2nj+vGOWIq7zKzSWYuGn/uQOVIDkS8YiV5PgrhaFj/ieDlKnk2sQ+vL00ERs/GXpg1lMKuyKasIxydfXoHP8bHUE7R2t5gVsZTLTdYInukVg9wFA0S2I09WvyUiQxniP7ljTcqigD+O+NuHGTPga+IJM9jpB/ZHuha2jC0omkR96/dvlhDZtBlnXB88N5kfFFYbaT2a1erYvwBTuVY8QueIv7V3kOmu6pCMTcnR8DNoekzpi3dLQwW8rifu+6MsuLaxsywd8JJmNJQDGxU4CSV5yQUl4=
+sudo: false
+cache: bundler

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Akil Madan
+
+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,97 @@
+# TenantsHelper
+
+TenantsHelper is a gem designed to help you load and query a tenants configuration file.
+A tenants configuration is a very specific YML config file in your project that is in the following format:
+
+```yml
+test_tenant_1:
+  name: Test Tenant 1
+test_tenant_2:
+  name: Test Tenant 2
+```
+
+In its current format, the configuration is fairly simple. At the top level is a tenant_id and then under that are the tenant properties.
+The required tenant properties will be updated over time as more distinct requirements for tenants are introduced.
+Semantic versioning will be used to ensure new requirements do not break existing projects.
+(Thus it is important for you to version lock the Gem in your project)
+
+TenantHelper helps you to achieve the following:
+ * Ensures all your projects that require tenants/clients meet the minimum required properties
+ * Provides a centralised interface to query the tenants
+
+## Installation
+
+Add this line to your application's Gemfile
+
+```ruby
+gem 'tenants_helper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tenants_helper
+
+## Usage
+
+Ensure you have a tenants.yml config file within your project. The file must comply with the sample shown above.
+Now call TenantsHelper with the path to the config file explicitly passed in
+
+```ruby
+tenants = TenantsHelper.tenants config_path: config_path
+```
+
+You may also setup the config file in advance
+
+```ruby
+# Setup config directory and file in advance
+TenantsHelper.set_path config_dir: Rails.root.join('config'), config_filename: 'tenants.yml'
+
+# Now you can call TenantsHelper.tenants in your project without having to pass in config path
+tenants = TenantsHelper.tenants
+```
+
+This will return a TenantsHelper::Tenants object which can then be used to query the tenants config.
+
+```ruby
+tenants.valid? test_tenant_1 # Checks to see if 'test_tenant_1' is a valid tenant id
+tenant = tenants.find test_tenant_1 # Returns the tenant object corresponding with the passed in id
+puts "Tenant name: #{tenant.name}" # The tenant object can then be used to determine the tenant properties
+tenants.find_by(name: 'Test Tenant 2') # Returns the first tenant object that meets the query requirements
+tenants.find_by!(name: 'Test Tenant 2') # Same as above, but gets angry if no tenant is found
+tenants.name_to_id 'Test Tenant 1' # Will return the id associated with that name
+```
+
+## Testing
+
+If you'd like to test code that calls TenantsHelper, you can mock the yml loading mechanism that TenantsHelper uses to load a custom configuration
+
+```ruby
+# Create a custom config hash that complies with the TenantHelper::Tenant schema
+let(:mock_tenants_config) { { '1' => { name: 'mock_tenants_1' }, '2' => { name: 'mock_tenants_2' } } }
+
+# Now mock the TenantsHelper::ConfigLoader
+config_loader_double = double
+allow(TenantsHelper::ConfigLoader).to receive(:new).and_return(config_loader_double)
+allow(config_loader_double).to receive(:load_content).and_return(mock_tenants_config)
+
+# Assuming your mock_tenants_config is correct, TenantsHelper.tenants will load the config sucessfully
+# and create the appropriate list of TenantHelper::Tenant objects
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/sealink/tenants_helper/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Reques

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 'queryable-collection'
+
+# 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/tenants_helper.rb

@@ -0,0 +1,21 @@
+module TenantsHelper
+  class << self
+    def tenants(config_path: @config_path_string)
+      config_loader = TenantsHelper::ConfigLoader.new(config_path: config_path)
+      config_content = config_loader.load_content
+      TenantsHelper::Tenants.new(tenants_config_hash: config_content)
+    end
+
+    def set_path(config_dir:, config_filename: 'tenants.yml')
+      @config_path_string = config_dir + '/' + config_filename
+    end
+  end
+
+  Error = Class.new(StandardError)
+end
+
+require 'yamload'
+require 'queryable_collection'
+require 'tenants_helper/version'
+require 'tenants_helper/config_loader'
+require 'tenants_helper/tenants'

data/lib/tenants_helper/config_loader.rb

@@ -0,0 +1,36 @@
+require 'memoist'
+
+module TenantsHelper
+  class ConfigLoader
+    extend Memoist
+
+    def initialize(config_path:)
+      @config_path = config_path
+      validate_config_path
+    end
+
+    def load_content
+      Yamload::Loader.new(filename, dirname).content
+    end
+    memoize :load_content
+
+    private
+
+    def validate_config_path
+      fail(Error, 'Invalid config path') if @config_path.blank? || !pathname.exist?
+    end
+
+    def pathname
+      Pathname.new(@config_path)
+    end
+    memoize :pathname
+
+    def dirname
+      pathname.dirname
+    end
+
+    def filename
+      pathname.basename('.yml')
+    end
+  end
+end

data/lib/tenants_helper/tenants.rb

@@ -0,0 +1,42 @@
+require 'facets/hash/rekey'
+module TenantsHelper
+  class Tenants
+    def initialize(tenants_config_hash:)
+      @tenants = QueryableCollection.create(
+        tenants_config_hash.map { |id, attributes|
+          new_attributes = attributes.rekey
+          Tenant.new(new_attributes.merge(id: id))
+        },
+        Tenant.anima.attribute_names
+      )
+    end
+
+    def find_by(query)
+      @tenants.find_by(query)
+    end
+
+    def find_by!(query)
+      find_by(query) ||
+        fail(ArgumentError,
+             "Could not find Tenant for #{query.inspect}")
+    end
+
+    def find(id)
+      find_by!(id: id)
+    end
+
+    def valid?(id)
+      !find_by(id: id).nil?
+    end
+
+    def name_to_id(name)
+      tenant = find_by(name: name)
+      return nil unless tenant
+      tenant.id
+    end
+  end
+
+  class Tenant
+    include Anima.new(:id, :name)
+  end
+end

data/lib/tenants_helper/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module TenantsHelper
+  VERSION = '0.1.0'.freeze
+end

data/tenants_helper.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tenants_helper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tenants_helper'
+  spec.version       = TenantsHelper::VERSION
+  spec.authors       = ['Akil Madan']
+  spec.email         = ['support@travellink.com.au']
+
+  spec.summary       = 'Gem to validate and query tenants using a standardised tenants config'
+  spec.description   = 'TenantsHelper provides a centralised way of defining, querying and' \
+                       'validating tenants.'
+  spec.homepage      = 'https://github.com/sealink/tenants_helper'
+  spec.license       = 'MIT'
+
+  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.required_ruby_version = '>= 2.1'
+
+  spec.add_dependency 'yamload', '~> 0.2'
+  spec.add_dependency 'anima'
+  spec.add_dependency 'queryable_collection', '~> 0.1'
+  spec.add_dependency 'memoist', '~> 0.14'
+  spec.add_dependency 'facets'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-rcov'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'travis'
+end

metadata

@@ -0,0 +1,258 @@
+--- !ruby/object:Gem::Specification
+name: tenants_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akil Madan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yamload
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: anima
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: queryable_collection
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: travis
+  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: TenantsHelper provides a centralised way of defining, querying andvalidating
+  tenants.
+email:
+- support@travellink.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tenants_helper.rb
+- lib/tenants_helper/config_loader.rb
+- lib/tenants_helper/tenants.rb
+- lib/tenants_helper/version.rb
+- tenants_helper.gemspec
+homepage: https://github.com/sealink/tenants_helper
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Gem to validate and query tenants using a standardised tenants config
+test_files: []