nucleus 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b172d0919bd9a0948cfa81bb640a3bbae2c42d39
-  data.tar.gz: 4ca095496dddee1c67aa285ea58dadda92b0648b
+  metadata.gz: 1a510c433f1548f80c42ce3d32804e73b7c71640
+  data.tar.gz: 46ff6af1d76e37cc945ea45a455968dded34533e
 SHA512:
-  metadata.gz: 8e1a3ed688b3ece1bb464c0891802a5ad653d3e88094c8aa41845dc42951b149adf8bc2930273e05e9ed5d93d6a0bd3a02704d245efc716e50bc40235fc12dbc
-  data.tar.gz: 18cb846d9e27ce9aa053351f809353df68133b7939b7f27d55f737f914c35a1a9431f80e280c039b4474b5535b337f44cc47240f08a77f868613469d23867599
+  metadata.gz: 44ffe6b03100aebabed7d6dbbc25cf714252b5985bbbc8708620688b84367082bdd2b39af34aa0c32094f0b155cf687a5e182385686dc505fbc6c1ab0f9a4bb4
+  data.tar.gz: 5668c6da41e685a1e6b65e0d7d6c0f84a93ac70d1f936e89227aa93558c76d949ffa2a8d7164ba18bb4ec68a7ce7692874279201dae9476ec7613f94e6ddb239

data/.rubocop.yml

@@ -40,5 +40,8 @@ Style/ExtraSpacing:
   Exclude:
     - nucleus.gemspec
 
+Style/MutableConstant:
+  Enabled: false
+
 Lint/UnusedMethodArgument:
   Enabled: false

data/CHANGELOG.md

@@ -4,15 +4,29 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased - Next
 
-### Added / Features
+### Added
+
+### Fixed
+
+
+### Removed
+
+
+## [0.2.0] - 2016-01-22
+
+### Added
 * Add basic logging functionality for OpenShift v2
+* Add more providers and endpoints to the default configuration
+
+### Fixed
+* Correctly URL-encode credentials for Heroku authentication
 
-### Changed / Fixes
-* Add your contribution here
+### Removed
+* LMDB is the only packaged data store from now on
 
 ## [0.1.0] - 2015-08-04
 
-### Added / Features
+### Added
 * Initial development release of the Platform as a Service abstraction layer - [@croeck](https://github.com/croeck)
 
 

data/README.md

@@ -4,15 +4,13 @@
 [![Dependency Status](https://gemnasium.com/stefan-kolb/nucleus.svg)](https://gemnasium.com/stefan-kolb/nucleus)
 [![Code Climate](https://codeclimate.com/github/stefan-kolb/nucleus/badges/gpa.svg)](https://codeclimate.com/github/stefan-kolb/nucleus)
 [![Test Coverage](https://codeclimate.com/github/stefan-kolb/nucleus/badges/coverage.svg)](https://codeclimate.com/github/stefan-kolb/nucleus/coverage)
+[![Gem Version](https://badge.fury.io/rb/nucleus.svg)](https://badge.fury.io/rb/nucleus)
+
+_Nucleus_ is a RESTful abstraction layer and Ruby gem to unify core management functions of Platform as a Service (PaaS) systems.
 
-_Nucleus_ is a RESTful abstraction layer to unify core management functions of Platform-as-a-Service (PaaS) systems.
 The API is build using [Ruby](https://www.ruby-lang.org) and the [grape framework](https://github.com/intridea/grape).
 It provides fully compliant [swagger](http://swagger.io/) schemas that serve for documentation and client generation.
 
-Nucleus differentiates between Vendors, Providers and Endpoints.
-A *Vendor* is the organization that developed the platform software.
-A *Provider* runs the platform, which always has at least one *Endpoint*, but can also have multiple endpoints for different regions.
-
 ## Table of Contents
 
 * [Supported Vendors](#supported-vendors)
@@ -90,14 +88,13 @@ Please make sure to obey the following installation instructions before starting
 ### Ruby Interpreter Compatibility
 
 Nucleus is supposed to run on Ruby >= 2.0.
-**It currently won't work on JRuby.**
+Due to native gem dependencies, it currently won't work on JRuby.
 
 ### Installation instructions
 
-1) The following (executable) files must be available on the system's *PATH*:
+1) The following executables must be available on the system's *PATH*:
 
-- git
-- ssh
+    git, ssh
 
 #### Platform-specific notes
 
@@ -105,10 +102,10 @@ Unix systems should run fine out of the box, whereas Windows systems might need
 
 ##### Windows
 
-Both files should be located in the `Git/bin` installation directory of [msysGit](https://msysgit.github.io/).
+Both required executables should be located in the `Git/bin` installation directory of [msysGit](https://msysgit.github.io/).
 Nucleus is verified to work with [msysGit](https://msysgit.github.io/) and the included version of `OpenSSH`.
 We did not verify other alternatives, e.g. PuTTY's `plink.exe`.
-PuTTY is supposed to (maybe anyone knows how to fix this?) not work due to the lack of the `-o UserKnownHostsFile=NUL -o StrictHostKeyChecking=no` options that allow to connect any git repository without confirmation of the host's identity.
+PuTTY is supposed to not work due to the lack of the `-o UserKnownHostsFile=NUL -o StrictHostKeyChecking=no` options that allow to connect any git repository without confirmation of the host's identity.
 
 ###### Troubleshooting
 
@@ -149,13 +146,13 @@ upon which you would update your bundle.
 $ bundle install
 ```
 
-Of course you could also install the gem yourself as:
+Or install the gem by yourself:
 
 ```shell
 $ gem install nucleus
 ```
 
-Finally require the gem in your application
+Finally, require the gem inside your application
 
 ```ruby
 require 'nucleus'
@@ -165,7 +162,7 @@ require 'nucleus'
 
 1) Configuration [optional]
 
-Adapt the configuration to your needs and adjust the values via `nucleus_config`.
+Adapt the configuration to your needs and adjust the values via the global `nucleus_config` variable.
 The configuration *must* be changed before initializing the `AdapterResolver`, otherwise the configuration is locked and can't be changed anymore.
 
 For more information have a look at the [configuration](#configuration) section.
@@ -176,7 +173,7 @@ For more information have a look at the [configuration](#configuration) section.
 Nucleus::VersionDetector.api_versions
 ```
 
-3) Instantiate the AdapterResolver for the desired API version:
+3) Instantiate an `AdapterResolver` for the desired API version:
 
 ```ruby
 resolver = Nucleus::AdapterResolver.new('v1')
@@ -189,7 +186,7 @@ resolver.adapters
 ```
 
 ```ruby
-{"cloudcontrol"=>Nucleus::Adapters::V1::CloudControl, "cloud_foundry_v2"=>Nucleus::Adapters::V1::CloudFoundryV2, "heroku"=>Nucleus::Adapters::V1::Heroku, "openshift_v2"=>Nucleus::Adapters::V1::OpenshiftV2}
+{ "cloudcontrol"=>Nucleus::Adapters::V1::CloudControl, "cloud_foundry_v2"=>Nucleus::Adapters::V1::CloudFoundryV2, "heroku"=>Nucleus::Adapters::V1::Heroku, "openshift_v2"=>Nucleus::Adapters::V1::OpenshiftV2 }
 ```
 
 5) Load your desired adapter implementation:
@@ -199,10 +196,11 @@ adapter = resolver.load('cloudcontrol', 'api.cloudcontrol.com', 'your_username',
 ```
 
 By default, the adapter will be populated with the default configuration options that are defined in the vendor's configuration for the selected endpoint_url.
-If you are using a custom installation, e.g. of *Openshift* or *Cloud Foundry*, make sure to pass the option that describe the `app_domain` for deployed applications.
+If you are using a custom installation, e.g. of *OpenShift* or *Cloud Foundry*, make sure to pass the option that describes the `app_domain` for deployed applications.
 Otherwise, the `web_url` links created by Nucleus will be malformed.
 
 ```ruby
+minimal = resolver.load('heroku', 'your_username', 'your_password')
 adapter = resolver.load('cloud_foundry_v2', 'api.example.org', 'your_username', 'your_password', app_domain: 'apps.example.org', check_ssl: false)
 ```
 
@@ -217,7 +215,7 @@ app = adapter.create_application(region: 'default', name: 'myusersfirstapplicati
 adapter.delete_application(app[:id])
 ```
 
-Check the **documentation** of the `Nucleus::Adapters::V1::Stub` adapter (or any other API version) for a complete list of the supported actions.
+Check the **documentation** of the `Nucleus::Adapters::V1::Stub` adapter (or any other API version) for a complete list of supported actions.
 You can also refer to the documentation of the REST interface to get detailed information about the parameter options of `post` and `put` commands,
 including which fields are required and those that are only optional.
 
@@ -259,7 +257,7 @@ After you started a server instance, you can access an interactive [swagger-ui](
 ## Functionality
 
 The following list shows the degree to which the adapters implement the offered methods.
-This list is auto-generated and can be shown via:
+This list can be auto-generated via:
 
 ```
 $ bundle exec rake evaluation:compatibility:markdown
@@ -310,32 +308,30 @@ remove_service|✓|✓|✓|✓
 ### Core constructs
 
 Nucleus could support any constellation of PaaS offers that are currently available.
-In order to do so, we differentiate between three types:
+In order to do so, we differentiate between between vendors, providers, and endpoints:
 
-The **vendor**, or the PaaS platform, which determines the functionality,
-a **provider** that runs the vendor's platform and offers it to its customers and finally
-the **endpoint** of the provider's offer.
+A *vendor* is the organization that developed the platform software, which also determines the offered functionalities.
+A *provider* runs the platform, which always has at least one *endpoint*.
 
 For most scenarios the *endpoint* is identical to the *provider*, but in some cases,
 for instance on [IBM Bluemix][bluemix], *endpoints* distinguish different deployment regions.
 
-If running Nucleus as web service, all changes made to these entities at runtime will be discarded,
-unless you enable the functionality in the configuration and specify a location where to persist the data to.
+If running Nucleus as web service, all changes made to these entities at runtime will be discarded, unless you enable persistence functionality in the configuration and specify a location where to persist the data to.
 
 #### Vendors
 
 You can use the API of Nucleus to show a list of all supported vendors.
 This request is publicly available and does not require any authentication.
 
-However, you can't create, delete or update a vendor at runtime because it represents the logic to communicate with the associated platform.
-All developers that want to have more information on how to add a new vendor can take a look at the instructions: [Add a vendor (or implement a new adapter)](wiki/implement_new_adapter.md)
+However, you cannot create, delete or update a vendor at runtime because it represents the logic to communicate with the associated platform.
+All developers that want to have more information on how to add a new vendor, please see the instructions: [Add a vendor (or implement a new adapter)](wiki/implement_new_adapter.md)
 
 #### Providers and Endpoints
 
 Providers and Endpoints can be managed *without authentication* and support `GET`, `POST`, `PATCH`, `DELETE` requests.
 
 A new entity can be registered at runtime by sending a `POST` request.
-Whereas a provider only requires a `name`, an endpoint also needs a further attribute, the `url`.
+Whereas a provider only requires a `name`, an endpoint also needs the `url` as further attribute.
 Please refer to the swagger-ui documentation for additional information about the requests.
 
 ### Authentication
@@ -345,13 +341,12 @@ The credentials must be provided as [Basic authentication](https://en.wikipedia.
 
     Authorization: Basic thebase64encodedcredentialsstring
 
-#### Special characters (umlauts, ...)
+#### Special characters
 
-The usage of special characters, for instance german umlauts as ä, ö and ü may cause issues with some platforms.
-Please make sure to select the correct encoding for your credentials before encoding them with base64:
+The usage of special characters, for instance german umlauts may cause issues with some platforms.
+Please make sure to select the correct encoding for your credentials before encoding them with Base64:
 
-* Stackato 3.4.2
-  * Different encodings cause the requests to crash and return status 500
+* Stackato 3.4.2: Different encodings cause the requests to crash and return status 500
 
 ### Application logs
 
@@ -512,13 +507,6 @@ They are described with increasing importance, meaning that the last option over
 1. A file in user account's home directory. On UNIX systems this file must be placed at `~/.nucleus/nucleus_config.rb`, whereas it is expected at `~/nucleus/nucleus_config.rb` if running Windows.
 2. The `config/nucleus_config.rb` file in the project's directory
 
-#### Database backend
-
-The database backend can be specified in the `config/nucleus_config.rb` configuration file.
-It defaults to [Daybreak](https://github.com/propublica/daybreak) on Unix systems and [LMDB](https://github.com/minad/lmdb) on Windows.
-
-Note: *[Daybreak](https://github.com/propublica/daybreak) does not run on Windows*
-
 ### Vendors, Providers, and Endpoints
 
 A vendor is reflected by an adapter implementation, but the providers and their endpoints can either be changed at runtime or via `.yaml` configuration files.

data/Rakefile

@@ -1,137 +1,137 @@
-import 'tasks/compatibility.rake'
-import 'tasks/evaluation.rake'
-import 'spec/test_suites.rake'
-
-require 'rake'
-require 'rubygems'
-require 'bundler'
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rainbow/ext/string' unless String.respond_to?(:color)
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new
-
-# first check code style, then execute the tests
-task default: [:rubocop, :spec]
-
-# map spec task to all test suites
-task :spec do
-  # first, run all tests
-  Rake::Task['spec:suite:all'].invoke
-  # if on the CI system, push coverage report to codeclimate
-  if ENV['CODECLIMATE_REPO_TOKEN']
-    require 'simplecov'
-    require 'codeclimate-test-reporter'
-    CodeClimate::TestReporter::Formatter.new.format(SimpleCov.result)
-  end
-end
-
-task :doc_toc do
-  File.open('README.md', 'r') do |f|
-    f.each_line do |line|
-      forbidden_words = ['Table of contents', 'define', 'pragma']
-      next if !line.start_with?('#') || forbidden_words.any? { |w| line =~ /#{w}/ }
-
-      title = line.delete('#').strip
-      href = title.tr(' ', '-').downcase
-      puts '  ' * (line.count('#') - 1) + "* [#{title}](\##{href})"
-    end
-  end
-end
-
-desc 'Record all adapter tests'
-task :record do
-  # http://www.relishapp.com/vcr/vcr/v/2-9-3/docs/record-modes
-  ENV['VCR_RECORD_MODE'] = 'once'
-  # recording only valid for adapter tests
-  Rake::Task['spec:suite:adapters'].invoke
-end
-
-namespace :record do
-  FileList['spec/adapter/v1/**'].each do |file|
-    next unless File.directory?(file)
-    adapter = File.basename(file)
-
-    desc "Record #{adapter} adapter tests"
-    RSpec::Core::RakeTask.new(adapter) do |t|
-      # new_episodes
-      ENV['VCR_RECORD_MODE'] = 'once'
-      t.pattern = "spec/adapter/v1/#{adapter}/*_spec.rb"
-      t.verbose = true
-    end
-  end
-end
-
-task :environment do
-  ENV['RACK_ENV'] ||= 'development'
-  require 'configatron'
-  require 'nucleus/scripts/setup_config'
-  nucleus_config.logging.level = Logger::Severity::ERROR
-  require 'nucleus_api/scripts/load_api'
-  require 'nucleus_api/scripts/initialize_api'
-end
-
-task routes: :environment do
-  Nucleus::API::RootAPI.routes.each do |route|
-    next if route.nil? || route.route_method.nil?
-    method = route.route_method.ljust(10)
-    path = route.route_path
-    version = route.instance_variable_get(:@options)[:version]
-    path = path.gsub(/:version/, version) unless version.nil?
-    puts "    #{method} #{path} - [#{version}]"
-  end
-end
-
-task schema_v1: :environment do
-  require 'json'
-  response = Nucleus::API::RootAPI.call(
-    'REQUEST_METHOD' => 'GET',
-    'PATH_INFO' => '/schema',
-    'rack.input' => StringIO.new)[2].body[0]
-  json = JSON.parse(response)
-  puts JSON.pretty_generate(json)
-end
-
-begin
-  require 'yard'
-  DOC_FILES = %w(lib/**/*.rb)
-
-  YARD::Rake::YardocTask.new(:doc) do |t|
-    t.files = DOC_FILES
-  end
-
-  namespace :doc do
-    YARD::Rake::YardocTask.new(:pages) do |t|
-      t.files = DOC_FILES
-      t.options = ['-o', '../nucleus.doc/docs', '--title', "Nucleus #{Nucleus::VERSION} Documentation"]
-    end
-
-    desc 'Check out gh-pages.'
-    task :checkout do
-      dir = File.join(__dir__, '..', 'nucleus.doc')
-      unless Dir.exist?(dir)
-        Dir.mkdir(dir)
-        Dir.chdir(dir) do
-          system('git init')
-          system('git remote add origin git@github.com:stefan-kolb/nucleus.git')
-          system('git pull')
-          system('git checkout gh-pages')
-        end
-      end
-    end
-
-    desc 'Generate and publish YARD docs to GitHub pages.'
-    task publish: %w(doc:pages:checkout doc:pages) do
-      Dir.chdir(File.join(__dir__, '..', 'nucleus.doc')) do
-        system('git checkout gh-pages')
-        system('git add .')
-        system('git add -u')
-        system("git commit -m 'Generating docs for version #{Nucleus::VERSION}.'")
-        system('git push origin gh-pages')
-      end
-    end
-  end
-rescue LoadError
-  puts 'You need to install YARD.'
-end
+import 'tasks/compatibility.rake'
+import 'tasks/evaluation.rake'
+import 'spec/test_suites.rake'
+
+require 'rake'
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rainbow/ext/string' unless String.respond_to?(:color)
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+# first check code style, then execute the tests
+task default: [:rubocop, :spec]
+
+# map spec task to all test suites
+task :spec do
+  # first, run all tests
+  Rake::Task['spec:suite:all'].invoke
+  # if on the CI system, push coverage report to codeclimate
+  if ENV['CODECLIMATE_REPO_TOKEN']
+    require 'simplecov'
+    require 'codeclimate-test-reporter'
+    CodeClimate::TestReporter::Formatter.new.format(SimpleCov.result)
+  end
+end
+
+task :doc_toc do
+  File.open('README.md', 'r') do |f|
+    f.each_line do |line|
+      forbidden_words = ['Table of contents', 'define', 'pragma']
+      next if !line.start_with?('#') || forbidden_words.any? { |w| line =~ /#{w}/ }
+
+      title = line.delete('#').strip
+      href = title.tr(' ', '-').downcase
+      puts '  ' * (line.count('#') - 1) + "* [#{title}](\##{href})"
+    end
+  end
+end
+
+desc 'Record all adapter tests'
+task :record do
+  # http://www.relishapp.com/vcr/vcr/v/2-9-3/docs/record-modes
+  ENV['VCR_RECORD_MODE'] = 'once'
+  # recording only valid for adapter tests
+  Rake::Task['spec:suite:adapters'].invoke
+end
+
+namespace :record do
+  FileList['spec/adapter/v1/**'].each do |file|
+    next unless File.directory?(file)
+    adapter = File.basename(file)
+
+    desc "Record #{adapter} adapter tests"
+    RSpec::Core::RakeTask.new(adapter) do |t|
+      # new_episodes
+      ENV['VCR_RECORD_MODE'] = 'once'
+      t.pattern = "spec/adapter/v1/#{adapter}/*_spec.rb"
+      t.verbose = true
+    end
+  end
+end
+
+task :environment do
+  ENV['RACK_ENV'] ||= 'development'
+  require 'configatron'
+  require 'nucleus/scripts/setup_config'
+  nucleus_config.logging.level = Logger::Severity::ERROR
+  require 'nucleus_api/scripts/load_api'
+  require 'nucleus_api/scripts/initialize_api'
+end
+
+task routes: :environment do
+  Nucleus::API::RootAPI.routes.each do |route|
+    next if route.nil? || route.route_method.nil?
+    method = route.route_method.ljust(10)
+    path = route.route_path
+    version = route.instance_variable_get(:@options)[:version]
+    path = path.gsub(/:version/, version) unless version.nil?
+    puts "    #{method} #{path} - [#{version}]"
+  end
+end
+
+task schema_v1: :environment do
+  require 'json'
+  response = Nucleus::API::RootAPI.call(
+    'REQUEST_METHOD' => 'GET',
+    'PATH_INFO' => '/schema',
+    'rack.input' => StringIO.new)[2].body[0]
+  json = JSON.parse(response)
+  puts JSON.pretty_generate(json)
+end
+
+begin
+  require 'yard'
+  DOC_FILES = %w(lib/**/*.rb).freeze
+
+  YARD::Rake::YardocTask.new(:doc) do |t|
+    t.files = DOC_FILES
+  end
+
+  namespace :doc do
+    YARD::Rake::YardocTask.new(:pages) do |t|
+      t.files = DOC_FILES
+      t.options = ['-o', '../nucleus.doc/docs', '--title', "Nucleus #{Nucleus::VERSION} Documentation"]
+    end
+
+    desc 'Check out gh-pages.'
+    task :checkout do
+      dir = File.join(__dir__, '..', 'nucleus.doc')
+      unless Dir.exist?(dir)
+        Dir.mkdir(dir)
+        Dir.chdir(dir) do
+          system('git init')
+          system('git remote add origin git@github.com:stefan-kolb/nucleus.git')
+          system('git pull')
+          system('git checkout gh-pages')
+        end
+      end
+    end
+
+    desc 'Generate and publish YARD docs to GitHub pages.'
+    task publish: %w(doc:pages:checkout doc:pages) do
+      Dir.chdir(File.join(__dir__, '..', 'nucleus.doc')) do
+        system('git checkout gh-pages')
+        system('git add .')
+        system('git add -u')
+        system("git commit -m 'Generating docs for version #{Nucleus::VERSION}.'")
+        system('git push origin gh-pages')
+      end
+    end
+  end
+rescue LoadError
+  puts 'You need to install YARD.'
+end