occi-core 5.0.0.beta.3 → 5.0.0.beta.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ff25ef95f7d16fdf2db6c9d7cfb6603eec65d74
-  data.tar.gz: 58b65c4f48697fa1325172876d66e7fa93602f72
+  metadata.gz: e2e1b39411baa08d88b06220dc9478fed8dc9853
+  data.tar.gz: 38abfa1554fd73fb0107be365060cc8858ff3eb6
 SHA512:
-  metadata.gz: a4529b0f62d7b9dfb8884e4bbc9fa53ea08679c8f71b3abd0359a58f0bbea64163eb1829dedb65092589117d48710f81483a8c08435d06535bd18a14a2137693
-  data.tar.gz: 3913ef638ad8dabd8ea4739ea2e561292fa5356075110e3f373ec3808acd34386b82d2ea5a4d47b15b5e5d5e0a6b1bf28204f182ca127aef0acd3b2959edd430
+  metadata.gz: 308dac6e39d40ba9df868b98f5e02ec2eab4e5242b6f48cc688d124c3b221654e91d6a48f80a906a8700acd397fb09f9094f29d45ca071cf333c30c9b4da6654
+  data.tar.gz: c0ef2b4f0c161a672aece4f5d5596463e3ff562967967d9bc8c0bc44d050b678ceec03563b7a6090a44a327170c5515ae4c953642c6022a072b79c2d5f8c8a4e

data/lib/occi/core.rb

@@ -55,6 +55,7 @@ module Occi
     autoload :Model, 'occi/core/model'
     autoload :Warehouse, 'occi/core/warehouse'
     autoload :InstanceBuilder, 'occi/core/instance_builder'
+    autoload :Locations, 'occi/core/locations'
   end
 end
 

data/lib/occi/core/errors/location_validation_error.rb

@@ -0,0 +1,13 @@
+require 'occi/core/errors/validation_error'
+
+module Occi
+  module Core
+    module Errors
+      # Custom error class indicating validation failures on
+      # various Core class instances.
+      #
+      # @author Boris Parak <parak@cesnet.cz>
+      class LocationValidationError < ValidationError; end
+    end
+  end
+end

data/lib/occi/core/locations.rb

@@ -0,0 +1,109 @@
+module Occi
+  module Core
+    # Implments handling helpers for OCCI locations. These are especially useful for rendering
+    # and butter-passing purposes.
+    #
+    # @attr uris [Set] collection of URIs representing locations
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    class Locations
+      include Yell::Loggable
+      include Helpers::Renderable
+      include Helpers::ArgumentValidator
+      include Enumerable
+
+      # Methods to be redirected to `uris`
+      ENUM_METHODS = %i[each << add remove map! empty? include?].freeze
+      delegate(*ENUM_METHODS, to: :uris)
+
+      attr_accessor :uris
+
+      # Constructs an instance with given URIs. If `uris` are omitted, an empty
+      # set will be automatically provided.
+      #
+      # @param args [Hash] arguments with Location information
+      # @option args [Set] :uris collection of URIs representing locations
+      def initialize(args = {})
+        pre_initialize(args)
+        default_args! args
+
+        @uris = args.fetch(:uris)
+
+        post_initialize(args)
+      end
+
+      # Applies given `host` to all locations contained in the collection.
+      #
+      # @param host [String] hostname for locations
+      def host=(host)
+        each { |uri| uri.host = host }
+      end
+
+      # Applies given `port` to all locations contained in the collection.
+      #
+      # @param port [String] port number
+      def port=(port)
+        each { |uri| uri.port = port }
+      end
+
+      # Applies given `scheme` to all locations contained in the collection.
+      #
+      # @param scheme [String] URI scheme
+      def scheme=(scheme)
+        each { |uri| uri.scheme = scheme }
+      end
+
+      # Validates all locations contained in the collection. Validation
+      # errors are only logged.
+      #
+      # @return [TrueClass] if locations are valid
+      # @return [FalseClass] if locations are invalid
+      def valid?
+        valid!
+        true
+      rescue => ex
+        logger.warn "Location invalid: #{ex.message}"
+        false
+      end
+
+      # Validates all locations in the collections and raises an error
+      # if there is an invalid location. During this process, all locations
+      # will be converted to `URI` instances.
+      #
+      # @raise [Occi::Core::Errors::LocationValidationError] if some location is invalid
+      def valid!
+        map! { |uri| return_or_convert uri }
+      rescue => ex
+        raise Occi::Core::Errors::LocationValidationError, ex.message
+      end
+      alias convert! valid!
+
+      protected
+
+      # :nodoc:
+      def sufficient_args!(args)
+        return if args[:uris]
+        raise Occi::Core::Errors::MandatoryArgumentError, "'uris' is a mandatory argument for #{self.class}"
+      end
+
+      # :nodoc:
+      def defaults
+        { uris: Set.new }
+      end
+
+      # :nodoc:
+      def pre_initialize(args); end
+
+      # :nodoc:
+      def post_initialize(args); end
+
+      private
+
+      # :nodoc:
+      def return_or_convert(uri)
+        return uri if uri.is_a?(URI)
+        URI.parse uri
+      end
+    end
+  end
+end

data/lib/occi/core/renderers/json/locations.rb

@@ -0,0 +1,20 @@
+require 'occi/core/renderers/json/base'
+
+module Occi
+  module Core
+    module Renderers
+      module Json
+        # Implements routines required to render `Occi::Core::Locations` and
+        # its subclasses to a JSON-based representation.
+        #
+        # @author Boris Parak <parak@cesnet.cz>
+        class Locations < Base
+          # :nodoc:
+          def render_hash
+            object.map(&:to_s)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/occi/core/renderers/json_renderer.rb

@@ -62,7 +62,8 @@ module Occi
               'Occi::Core::Collection'     => Occi::Core::Renderers::Json::Collection,
               'Occi::Core::Model'          => Occi::Core::Renderers::Json::Model,
               'Occi::Core::Resource'       => Occi::Core::Renderers::Json::Resource,
-              'Occi::Core::Link'           => Occi::Core::Renderers::Json::Link
+              'Occi::Core::Link'           => Occi::Core::Renderers::Json::Link,
+              'Occi::Core::Locations'      => Occi::Core::Renderers::Json::Locations
             }
           end
         end

data/lib/occi/core/renderers/text/locations.rb

@@ -0,0 +1,38 @@
+require 'occi/core/renderers/text/base'
+
+module Occi
+  module Core
+    module Renderers
+      module Text
+        # Implements routines required to render `Occi::Core::Locations` and
+        # its subclasses to a text-based representation. Supports rendering
+        # to plain and header-like formats.
+        #
+        # @author Boris Parak <parak@cesnet.cz>
+        class Locations < Base
+          # Location key constants
+          LOCATION_KEY_PLAIN = 'X-OCCI-Location'.freeze
+          LOCATION_KEY_HEADERS = 'Location'.freeze
+
+          # Renders `object` into plain text and returns the result
+          # as `String`.
+          #
+          # @return [String] textual representation of Object
+          def render_plain
+            locs = object.map { |loc| "#{LOCATION_KEY_PLAIN}: #{loc}" }
+            locs.join "\n"
+          end
+
+          # Renders `object` into text for headers and returns the result
+          # as `Hash`.
+          #
+          # @return [Hash] textual representation of Object for headers
+          def render_headers
+            return {} if object.empty?
+            { LOCATION_KEY_HEADERS => object.map(&:to_s) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/occi/core/renderers/text_renderer.rb

@@ -62,7 +62,8 @@ module Occi
               'Occi::Core::Collection'     => Occi::Core::Renderers::Text::Collection,
               'Occi::Core::Model'          => Occi::Core::Renderers::Text::Model,
               'Occi::Core::Resource'       => Occi::Core::Renderers::Text::Resource,
-              'Occi::Core::Link'           => Occi::Core::Renderers::Text::Link
+              'Occi::Core::Link'           => Occi::Core::Renderers::Text::Link,
+              'Occi::Core::Locations'      => Occi::Core::Renderers::Text::Locations
             }
           end
         end

data/lib/occi/core/version.rb

@@ -3,7 +3,7 @@ module Occi
     MAJOR_VERSION = 5                # Major update constant
     MINOR_VERSION = 0                # Minor update constant
     PATCH_VERSION = 0                # Patch/Fix version constant
-    STAGE_VERSION = 'beta.3'.freeze # use `nil` for production releases
+    STAGE_VERSION = 'beta.4'.freeze # use `nil` for production releases
 
     unless defined?(::Occi::Core::VERSION)
       VERSION = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: occi-core
 version: !ruby/object:Gem::Version
-  version: 5.0.0.beta.3
+  version: 5.0.0.beta.4
 platform: ruby
 authors:
 - Boris Parak
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2017-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -353,6 +353,7 @@ files:
 - lib/occi/core/errors/category_validation_error.rb
 - lib/occi/core/errors/collection_lookup_error.rb
 - lib/occi/core/errors/instance_validation_error.rb
+- lib/occi/core/errors/location_validation_error.rb
 - lib/occi/core/errors/mandatory_argument_error.rb
 - lib/occi/core/errors/model_lookup_error.rb
 - lib/occi/core/errors/parser_error.rb
@@ -377,6 +378,7 @@ files:
 - lib/occi/core/instance_builder.rb
 - lib/occi/core/kind.rb
 - lib/occi/core/link.rb
+- lib/occi/core/locations.rb
 - lib/occi/core/mixin.rb
 - lib/occi/core/model.rb
 - lib/occi/core/parsers.rb
@@ -415,6 +417,7 @@ files:
 - lib/occi/core/renderers/json/collection.rb
 - lib/occi/core/renderers/json/instance.rb
 - lib/occi/core/renderers/json/link.rb
+- lib/occi/core/renderers/json/locations.rb
 - lib/occi/core/renderers/json/model.rb
 - lib/occi/core/renderers/json/resource.rb
 - lib/occi/core/renderers/json_renderer.rb
@@ -426,6 +429,7 @@ files:
 - lib/occi/core/renderers/text/collection.rb
 - lib/occi/core/renderers/text/instance.rb
 - lib/occi/core/renderers/text/link.rb
+- lib/occi/core/renderers/text/locations.rb
 - lib/occi/core/renderers/text/model.rb
 - lib/occi/core/renderers/text/resource.rb
 - lib/occi/core/renderers/text_renderer.rb