occi-core 4.3.6 → 5.0.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 982c9d4d37b5b8e86e38e039dce74a1a27c3d0f9
-  data.tar.gz: 8ff90a2a4c11dbeed57dd7ac8e8a5f4a7d14d9ec
+  metadata.gz: 5d36511dceaecabc4508ec2db62c83920e63fff0
+  data.tar.gz: e9f542fefa3da8fabe0e6aaecaa822b7d1d25233
 SHA512:
-  metadata.gz: d5b7a5296a00711b0d9b3f1abfc8a6e089aeaf1e5e71c6de83ff987d49dbe65e2e4d0eb0cfbffb16303fc9e772ffbbe111b378f4a072bc5454d941ac93831f48
-  data.tar.gz: 1a5b883d2eef57cdf6ee9dc498e3b9516f34025d2ba2c2193ab7f97d2d766c117dee223d0a5898ba703b215d5d451d7a4da484a59b650fcf14ad5c5e93615901
+  metadata.gz: b96ea07c5b9c28b5933e47f0874946abb38df81ceed4461a188c0b96ca3ae3ed56bf43842b1eddbca21c058c6884816683900e35a7e3fbe720da8ce86672eee8
+  data.tar.gz: a3b0c5dbb6b998df32495b6b2d474f7b7ab8dafe95264953410fe58ac3e1e07c1ea1bac21a5c4dff21142a5704cb180b2196083c78d08bd48173c8f2eca540c8

data/.fasterer.yml

@@ -0,0 +1,3 @@
+exclude_paths:
+  - 'spec/**/*.rb'
+  - 'vendor/**/*.rb'

data/.gitignore

@@ -1,16 +1,9 @@
-*.gem
-*.swp
-.project
-.idea
-.yardoc
-.bundle
-.rvmrc
-lib/occiantlr/output/
-pkg
-tmp
-log
-coverage
-vendor
-collection
-Gemfile.lock
-doc
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -1 +1 @@
---require spec_helper --color --format documentation
+--require spec_helper --color --format documentation --order rand

data/.rubocop.yml

@@ -0,0 +1,69 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-05-23 13:39:50 +0200 using RuboCop version 0.40.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+require: rubocop-rspec
+
+Metrics/ModuleLength:
+  Exclude:
+  - 'spec/**/*'
+  - 'test/**/*'
+
+Metrics/MethodLength:
+  Max: 12
+
+Metrics/AbcSize:
+  Exclude:
+  - 'lib/occi/core/parsers/text/*'
+  - 'lib/occi/core/parsers/json/*'
+  - 'lib/occi/core/helpers/parser_dereferencer.rb'
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+  - 'lib/occi/core/parsers/text/constants.rb'
+
+Metrics/BlockLength:
+  Exclude:
+  - 'spec/**/*'
+  - 'test/**/*'
+  - '*.gemspec'
+
+ClassLength:
+  Max: 180
+
+Style/Documentation:
+  Exclude:
+  - 'spec/**/*'
+  - 'test/**/*'
+  - 'lib/occi/core/version.rb'
+
+Style/StructInheritance:
+  Exclude:
+  - 'lib/occi/core/attribute.rb'
+
+Style/NilComparison:
+  Exclude:
+  - 'spec/occi/core/category_spec.rb'
+
+Style/FileName:
+  Exclude:
+  - 'lib/occi/infrastructure-ext.rb'
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/SubjectStub:
+  Exclude:
+    - 'spec/**/*'
+
+RSpec/MessageExpectation:
+  Exclude:
+    - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,27 @@
+language: ruby
+
+rvm:
+  - 2.2.2
+  - 2.3.0
+  - 2.4.0
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+
+branches:
+  only:
+    - master
+    - 4.3.x
+    - next
+
+env:
+  - ON_TRAVIS_CI=yes
+
+install: 'gem install bundler -v ">= 1.12" && bundle install --retry=10'
+
+script: 'bundle exec rake acceptance'
+
+sudo: false

data/AUTHORS

@@ -1,9 +1,11 @@
-rOcci was designed and is mainly developed by Florian Feldhaus (GWDG) and Piotr Kasprzak (GWDG) in Germany.
+rOCCI was originally designed by Florian Feldhaus (GWDG) and Piotr Kasprzak
+(GWDG) in Germany. The project is currently being developed by CESNET, mainly
+for EGI Federated Cloud.
 
-Special thanks to the following extraordinary individuals, whithout whom rOcci would not be possible:
+Special thanks goes to the following extraordinary individuals, without whom
+rOCCI would not be possible:
 
-* Hayati Bice - who wrote the initial version of an Occi server rOcci is based on
-* Max Günther - who wrote the EC2 backend
+* Hayati Bice      - who wrote the initial version of a server for rOCCI
+* Max Günther      - who wrote the EC2 backend
 * Andre Thevapalan - for his input regarding the JSON rendering
-* Boris Parak - especially for his input regarding the Client / Client DSL and CLI
-* the OCCI Working Group - for developing OCCI
+* The OCCI WG      - for developing OCCI

data/Gemfile

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

data/LICENSE

@@ -4,7 +4,7 @@ The work represented by this source file is partially or entirely funded
 by the EGI-InSPIRE project through the European Commission's 7th Framework
 Programme (contract # INFSO-RI-261323)
 
-Copyright (c) 2012-2014 GWDG, CESNET
+Copyright (c) 2012-2016 CESNET
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,190 +1,45 @@
-rOCCI-core - A Ruby OCCI Framework
-=================================
-
-[![Build Status](https://secure.travis-ci.org/EGI-FCTF/rOCCI-core.png)](http://travis-ci.org/EGI-FCTF/rOCCI-core)
-[![Dependency Status](https://gemnasium.com/EGI-FCTF/rOCCI-core.png)](https://gemnasium.com/EGI-FCTF/rOCCI-core)
-[![Gem Version](https://fury-badge.herokuapp.com/rb/occi-core.png)](https://badge.fury.io/rb/occi-core)
-[![Code Climate](https://codeclimate.com/github/EGI-FCTF/rOCCI-core.png)](https://codeclimate.com/github/EGI-FCTF/rOCCI-core)
-
-Requirements
-------------
+# rOCCI-core - A Ruby OCCI Framework
+[![Travis](https://img.shields.io/travis/EGI-FCTF/rOCCI-core.svg?style=flat-square)](http://travis-ci.org/EGI-FCTF/rOCCI-core)
+[![Gemnasium](https://img.shields.io/gemnasium/EGI-FCTF/rOCCI-core.svg?style=flat-square)](https://gemnasium.com/EGI-FCTF/rOCCI-core)
+[![Gem](https://img.shields.io/gem/v/occi-core.svg?style=flat-square)](https://rubygems.org/gems/occi-core)
+[![Code Climate](https://img.shields.io/codeclimate/github/EGI-FCTF/rOCCI-core.svg?style=flat-square)](https://codeclimate.com/github/EGI-FCTF/rOCCI-core)
 
+## Requirements
 ### Ruby
-* Ruby 1.9.3 is required
-* RubyGems have to be installed
+* Ruby 2.2.2 is required
+* Rubygems
 
-### Examples
-#### For distros based on Debian:
-~~~
-apt-get install ruby rubygems ruby-dev
-~~~
+## Installation
+### As a gem
+To install the most recent stable version
 ~~~
-ruby -v
+gem install occi-core
 ~~~
 
-**Unless you have Ruby >= 1.9.3, please, go to [rOCCI-core#RVM](#rvm) and install RVM with a newer Ruby version.**
-
-#### For distros based on RHEL:
-~~~
-yum install ruby-devel openssl-devel gcc gcc-c++ ruby rubygems
-~~~
+To install the most recent beta version
 ~~~
-ruby -v
+gem install occi-core --pre
 ~~~
 
-**Unless you have Ruby >= 1.9.3, please, go to [rOCCI-core#RVM](#rvm) and install RVM with a newer Ruby version.**
-
-Installation
-------------
-
-### From RubyGems.org
-
-To install the most recent stable version
-
-    gem install occi-core
-
-To install the most recent beta version
-
-    gem install occi-core --pre
-
-### From source (dev)
-
-**Installation from source should never be your first choice! Especially, if you are not familiar with RVM, Bundler, Rake and other dev tools for Ruby!**
-
-**However, if you wish to contribute to our project, this is the right way to start.**
-
+### From source
 To build and install the bleeding edge version from master
-
-    git clone git://github.com/EGI-FCTF/rOCCI-core.git
-    cd rOCCI-core
-    gem install bundler
-    bundle install
-    bundle exec rake spec
-    rake install
-
-### RVM
-
-**Notice:** Follow the RVM installation guide linked below, we recommend using the default 'Single-User installation'.
-
-**Warning:** NEVER install RVM as root! If you choose the 'Multi-User installation', use a different user account with sudo access instead!
-
-* [Installing RVM](https://rvm.io/rvm/install#explained)
-* Install Ruby
-
 ~~~
-rvm requirements
-rvm install 1.9.3
-rvm use 1.9.3 --default
+gem install bundler
 ~~~
 ~~~
-ruby -v
+git clone git://github.com/EGI-FCTF/rOCCI-core.git
+cd rOCCI-core
+gem build occi-core.gemspec
 ~~~
 
-Usage
------
-Detailed documentation is available in our [Wiki](https://github.com/EGI-FCTF/rOCCI-core/wiki).
-
-Changelog
----------
-
-### Version 4.3
-* Internal updates and bug fixes
-* Updated JSON rendering
-* Updated dependencies
-
-### Version 4.2
-* Internal changes and bug fixes
-* Extended test coverage
-* Added custom exceptions and error classes
-* Improved text/plain and text/occi rendering
-
-### Version 4.1
-* Dropped support for Rubies 1.8.x
-* Updated dependencies
-
-### Version 4.0
-* introduced compatibility mode (for OCCI-OS, on by default)
-* introduced new attribute handling for resources
-* completely rewrote OCCI parser
-* improved action and mixin handling
-* aligned with latest draft of OCCI Core and OCCI JSON specification
-* split the code into rOCCI-core, rOCCI-api and rOCCI-cli
-* internal changes, refactoring and some bugfixes
-
-### Version 3.1
-* added basic OS Keystone support
-* added support for PKCS12 credentials for X.509 authN
-* updated templates for plain output formatting
-* minor client API changes
-* several bugfixes
-
-### Version 3.0
-
-* many bugfixes
-* rewrote Core classes to use metaprogramming techniques
-* added VCR cassettes for reliable testing against prerecorded server responses
-* several updates to the OCCI Client
-* started work on an OCCI Client using AMQP as transport protocol
-* added support for keystone authentication to be used with the OpenStack OCCI server
-* updated dependencies
-* updated rspec tests
-* started work on cucumber features
-
-### Version 2.5
-
-* improved OCCI Client
-* improved documentation
-* several bugfixes
-
-### Version 2.4
-
-* Changed OCCI attribute properties from lowercase to first letter uppercase (e.g. type -> Type, default -> Default, ...)
-
-### Version 2.3
-
-* OCCI objects are now initialized with a list of attributes instead of a hash. Thus it is easier to check which
-attributes are expected by a class and helps prevent errors.
-* Parsing of a subset of the OVF specification is supported. Further parts of the specification will be covered in
-future versions of rOCCI.
-
-### Version 2.2
-
-* OCCI Client added. The client simplifies the execution of OCCI commands and provides shortcuts for often used steps.
-
-### Version 2.1
-
-* Several improvements to the gem structure and code documentation. First rSpec test were added. Readme has been extended to include instructions how the gem can be used.
-
-### Version 2.0
-
-* Starting with version 2.0 Florian Feldhaus and Piotr Kasprzak took over the development of the OCCI gem. The codebase was taken from the rOCCI framework and improved to be bundled as a standalone gem.
-
-### Version 1.X
-
-* Version 1.X of the OCCI gem has been developed by retr0h and served as a simple way to access the first OpenNebula OCCI implementation.
-
-Development
------------
-
-Checkout latest version from git:
-
-    git clone git://github.com/EGI-FCTF/rOCCI-core.git
-
-Change to rOCCI-core folder
-
-    cd rOCCI-core
-
-Install dependencies
-
-    bundle install
-
-### Code Documentation
-
-[Code Documentation for rOCCI by YARD](http://rubydoc.info/github/EGI-FCTF/rOCCI-core/)
+## Usage
+Detailed documentation is available in our [wiki](https://wiki.egi.eu/wiki/ROCCI).
 
-### Continuous integration
+## Changelog
+See `CHANGELOG.md`.
 
-[Continuous integration for rOCCI by Travis-CI](http://travis-ci.org/EGI-FCTF/rOCCI-core/)
+## Code Documentation
+[Code Documentation for rOCCI](http://rubydoc.info/github/EGI-FCTF/rOCCI-core/)
 
 ### Contribute
 

data/Rakefile

@@ -1,31 +1,39 @@
-require 'rubygems'
 require 'rubygems/tasks'
+require 'rubocop/rake_task'
+require 'yard'
+
+task default: 'test'
 
-task :default => 'test'
+desc 'Run acceptance tests (RSpec + Rubocop)'
+task test: 'acceptance'
 
-desc "Run all tests; includes rspec and coverage reports"
-task :test => 'rcov:all'
+desc 'Run all RSpec test with coverage reporting'
+task spec: 'rcov:all'
 
-desc "Run all tests; includes rspec and coverage reports"
-task :spec => 'test'
+Gem::Tasks.new(build: { tar: true, zip: true }, sign: { checksum: true, pgp: false })
 
-Gem::Tasks.new(:build => {:tar => true, :zip => true}, :sign => {:checksum => true, :pgp => false})
+RuboCop::RakeTask.new
+
+YARD::Rake::YardocTask.new do |t|
+  t.stats_options = ['--list-undoc']
+end
+
+desc 'Run acceptance tests (RSpec + Rubocop)'
+task :acceptance do |_t|
+  Rake::Task['spec'].invoke
+  Rake::Task['rubocop'].invoke
+end
 
 namespace :rcov do
   require 'rspec/core/rake_task'
 
-  RSpec::Core::RakeTask.new(:rspec) do |t|
-    ENV['COVERAGE'] = "true"
+  RSpec::Core::RakeTask.new(:rspec) do |_t|
+    ENV['COVERAGE'] = 'true'
   end
 
-  desc "Run rspec to generate aggregated coverage"
-  task :all do |t|
-    rm "coverage/coverage.data" if File.exist?("coverage/coverage.data")
+  desc 'Run RSpec to generate aggregated coverage'
+  task :all do |_t|
+    rm 'coverage/coverage.data' if File.exist?('coverage/coverage.data')
     Rake::Task['rcov:rspec'].invoke
   end
 end
-
-require 'yard'
-YARD::Rake::YardocTask.new(:yard) do |t|
-  t.options = ['--any', '--extra', '--opts'] # optional
-end

data/examples/initialize_model.rb

@@ -0,0 +1,10 @@
+require 'occi/infrastructure-ext'
+
+Yell.new '/dev/null', name: Object
+
+model = Occi::InfrastructureExt::Model.new
+model.load_core!
+model.load_infrastructure!
+model.load_infrastructure_ext!
+
+model.valid!

data/examples/parse_action_instance_json.rb

@@ -0,0 +1,15 @@
+require 'occi/infrastructure'
+
+Yell.new '/dev/null', name: Object
+
+model = Occi::Infrastructure::Model.new
+model.load_core!
+model.load_infrastructure!
+
+model.valid!
+
+parser = Occi::Core::Parsers::JsonParser.new(model: model, media_type: 'application/occi+json')
+aif = File.read File.join(File.dirname(__FILE__), 'rendering', 'action_instance.json')
+
+ai = parser.action_instances(aif, {}).first
+ai.valid!

data/examples/parse_action_instance_text.rb

@@ -0,0 +1,15 @@
+require 'occi/infrastructure'
+
+Yell.new '/dev/null', name: Object
+
+model = Occi::Infrastructure::Model.new
+model.load_core!
+model.load_infrastructure!
+
+model.valid!
+
+parser = Occi::Core::Parsers::TextParser.new(model: model, media_type: 'text/plain')
+aif = File.read File.join(File.dirname(__FILE__), 'rendering', 'action_instance.txt')
+
+ai = parser.action_instances(aif, {}).first
+ai.valid!

data/examples/parse_categories_json.rb

@@ -0,0 +1,15 @@
+require 'occi/infrastructure'
+
+Yell.new '/dev/null', name: Object
+
+model = Occi::Infrastructure::Model.new
+model.load_core!
+model.load_infrastructure!
+
+model.valid!
+
+parser = Occi::Core::Parsers::JsonParser.new(model: model, media_type: 'application/occi+json')
+cf = File.read File.join(File.dirname(__FILE__), 'rendering', 'categories.json')
+
+cats = parser.categories(cf, {})
+cats.each(&:valid!)

data/examples/parse_categories_text.rb

@@ -0,0 +1,15 @@
+require 'occi/infrastructure'
+
+Yell.new '/dev/null', name: Object
+
+model = Occi::Infrastructure::Model.new
+model.load_core!
+model.load_infrastructure!
+
+model.valid!
+
+parser = Occi::Core::Parsers::TextParser.new(model: model, media_type: 'text/plain')
+cf = File.read File.join(File.dirname(__FILE__), 'rendering', 'categories.txt')
+
+cats = parser.categories(cf, {})
+cats.each(&:valid!)

data/examples/parse_instance_json.rb

@@ -0,0 +1,15 @@
+require 'occi/infrastructure'
+
+Yell.new '/dev/null', name: Object
+
+model = Occi::Infrastructure::Model.new
+model.load_core!
+model.load_infrastructure!
+
+model.valid!
+
+parser = Occi::Core::Parsers::JsonParser.new(model: model, media_type: 'application/occi+json')
+cf = File.read File.join(File.dirname(__FILE__), 'rendering', 'instance.json')
+
+compute = parser.entities(cf, {}).first
+compute.valid!

data/examples/parse_instance_text.rb

@@ -0,0 +1,15 @@
+require 'occi/infrastructure'
+
+Yell.new '/dev/null', name: Object
+
+model = Occi::Infrastructure::Model.new
+model.load_core!
+model.load_infrastructure!
+
+model.valid!
+
+parser = Occi::Core::Parsers::TextParser.new(model: model, media_type: 'text/plain')
+cf = File.read File.join(File.dirname(__FILE__), 'rendering', 'instance.txt')
+
+compute = parser.entities(cf, {}).first
+compute.valid!

data/examples/parse_model_json.rb

@@ -0,0 +1,9 @@
+require 'occi/infrastructure'
+
+Yell.new '/dev/null', name: Object
+
+model = Occi::Infrastructure::Model.new
+
+mf = File.read File.join(File.dirname(__FILE__), 'rendering', 'model.json')
+Occi::Core::Parsers::JsonParser.model(mf, {}, 'application/json', model)
+model.valid!

data/examples/parse_model_text.rb

@@ -0,0 +1,9 @@
+require 'occi/infrastructure'
+
+Yell.new '/dev/null', name: Object
+
+model = Occi::Infrastructure::Model.new
+
+mf = File.read File.join(File.dirname(__FILE__), 'rendering', 'model.txt')
+Occi::Core::Parsers::TextParser.model(mf, {}, 'text/plain', model)
+model.valid!

data/examples/render_action_instance_json.rb

@@ -0,0 +1,17 @@
+require 'occi/infrastructure-ext'
+
+Yell.new '/dev/null', name: Object
+
+model = Occi::InfrastructureExt::Model.new
+model.load_core!
+model.load_infrastructure!
+model.load_infrastructure_ext!
+
+model.valid!
+
+ai = Occi::Core::ActionInstance.new(
+  action: model.actions.first
+)
+ai.valid!
+
+puts ai.to_json

data/examples/render_action_instance_text.rb

@@ -0,0 +1,17 @@
+require 'occi/infrastructure-ext'
+
+Yell.new '/dev/null', name: Object
+
+model = Occi::InfrastructureExt::Model.new
+model.load_core!
+model.load_infrastructure!
+model.load_infrastructure_ext!
+
+model.valid!
+
+ai = Occi::Core::ActionInstance.new(
+  action: model.actions.first
+)
+ai.valid!
+
+puts ai.to_text

data/examples/render_instance_json.rb

@@ -0,0 +1,20 @@
+require 'occi/infrastructure-ext'
+
+Yell.new '/dev/null', name: Object
+
+model = Occi::InfrastructureExt::Model.new
+model.load_core!
+model.load_infrastructure!
+model.load_infrastructure_ext!
+
+model.valid!
+
+compute = model.instance_builder.get Occi::Infrastructure::Constants::COMPUTE_KIND
+compute.identify!
+compute.title = 'My Compute Instance'
+compute['occi.compute.cores']  = 4
+compute['occi.compute.memory'] = 2.0
+
+compute.valid!
+
+puts compute.to_json

data/examples/render_instance_text.rb

@@ -0,0 +1,20 @@
+require 'occi/infrastructure-ext'
+
+Yell.new '/dev/null', name: Object
+
+model = Occi::InfrastructureExt::Model.new
+model.load_core!
+model.load_infrastructure!
+model.load_infrastructure_ext!
+
+model.valid!
+
+compute = model.instance_builder.get Occi::Infrastructure::Constants::COMPUTE_KIND
+compute.identify!
+compute.title = 'My Compute Instance'
+compute['occi.compute.cores']  = 4
+compute['occi.compute.memory'] = 2.0
+
+compute.valid!
+
+puts compute.to_text