occi-core 4.2.11 → 4.2.12

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YWU2NmRkOTcxMWYxMjZmNTExZTZmY2MyZTk5NTA0OTZkYTZjYzNhNw==
-  data.tar.gz: !binary |-
-    MWExYTgyNzM0ZjU4NzA4MjhjNjRkNzZiZDBhZjI4N2IwNmY5ZTdkMw==
+SHA1:
+  metadata.gz: 8ae8a9a2f1e04abc912900002e1a20ffc7d14c4a
+  data.tar.gz: e61f0a1b597466384b814c331792dd27e0cfd0e9
 SHA512:
-  metadata.gz: !binary |-
-    MzE2MDM1N2NmYmNmMTZhMWY0NDg3YmM3M2NhYTM0NzU3MTJhZGYyNTQxOTk1
-    YmVjNGEyMzkxZjM4OTI4MGFmZDg5ZjA5NTFkNGM1ODFiMjg3MmY4N2FhNTVk
-    ZDZlNWY0NDg2YzZhMDdiNjZkNTIyN2NkODA4MjBkNTYyNGMyZTM=
-  data.tar.gz: !binary |-
-    ZDhmN2JjNzFmZTFjYTg2NTRiNjU1MjkwZjkyMDFkNGU5YWY5ZjkzYzQxZWEw
-    OWZlNjAzZDRhZGYyMDk3Njk1MzcwYTgzZmQ1OTEzYmNmODJjODM0ODBjZTc0
-    ZmEzOTUyMmJiNTk5ZTliMjQ1ZmI5YzMyNDcxNzA3ZWRmYzVhMjM=
+  metadata.gz: 80566d28dd52b33ce23de9cb2dff9943d2a082a04a6acf8dfecdab40b79a20aaa08b20f7b7bcd7712c4dfad34d85e2c6de82a9b8cacc3729db4069e65d50e9ec
+  data.tar.gz: 09dfb7c50b7ad1c603df9affc70406e4bb59a430844f965e8380430bc957af17cf0e5dcbe525d5935fc7e42b69a8edb8bc95953761670be128daf04ed044f21e

data/lib/occi/core/entity.rb

@@ -5,7 +5,7 @@ module Occi
       include Occi::Helpers::Inspect
       include Occi::Helpers::Comparators::Entity
 
-      attr_accessor :mixins, :attributes, :actions, :id, :model, :location
+      attr_accessor :mixins, :attributes, :actions, :id, :model
       attr_reader :kind
 
       class_attribute :kind, :mixins, :attributes, :actions
@@ -76,7 +76,7 @@ module Occi
         @attributes['occi.core.id'] ||= UUIDTools::UUID.random_create.to_s
 
         @actions = Occi::Core::Actions.new actions
-        @location = location
+        @location = location ? URI.parse(location).path : nil
       end
 
       # @param [Occi::Core::Kind,String] kind
@@ -147,13 +147,24 @@ module Occi
       # set location attribute of entity
       # @param [String] location
       def location=(location)
-        @location = location
+        @location = location ? URI.parse(location).path : nil
       end
 
       # @return [String] location of the entity
       def location
-        return @location if @location
-        "#{kind.location}#{id.gsub('urn:uuid:', '')}" if id
+        return @location.clone if @location
+        return if id.blank? || kind.location.blank?
+
+        # guess the location from kind and ID
+        # check for kind locations already included in IDs
+        tmp_id = id.gsub('urn:uuid:', '')
+        @location = if tmp_id.start_with?(kind.location)
+          # ID by itself is enough
+          tmp_id
+        else
+          # concat kind location and ID, remove duplicated slashes
+          "#{kind.location}#{tmp_id}".gsub(/\/+/, '/')
+        end
       end
 
       # check attributes against their definitions and set defaults
@@ -197,11 +208,11 @@ module Occi
 
       # @return [String] text representation
       def to_text
-        text = "Category: #{self.kind.term};scheme=#{self.kind.scheme.inspect};class=\"kind\""
+        text = "Category: #{self.kind.term};scheme=#{self.kind.scheme.inspect};class=\"kind\";location=#{self.kind.location.inspect}"
         @mixins.each do |mixin|
           scheme, term = mixin.to_s.split('#')
           scheme << '#'
-          text << "\nCategory: #{term};scheme=#{scheme.inspect};class=\"mixin\""
+          text << "\nCategory: #{term};scheme=#{scheme.inspect};class=\"mixin\";location=#{mixin.location.inspect}"
         end
 
         text << @attributes.to_text
@@ -214,12 +225,12 @@ module Occi
       # @return [Hash] hash containing the HTTP headers of the text/occi rendering
       def to_header
         header = Hashie::Mash.new
-        header['Category'] = "#{self.kind.term};scheme=#{self.kind.scheme.inspect};class=\"kind\""
+        header['Category'] = "#{self.kind.term};scheme=#{self.kind.scheme.inspect};class=\"kind\";location=#{self.kind.location.inspect}"
 
         @mixins.each do |mixin|
           scheme, term = mixin.to_s.split('#')
           scheme << '#'
-          header['Category'] << ",#{term};scheme=#{scheme.inspect};class=\"mixin\""
+          header['Category'] << ",#{term};scheme=#{scheme.inspect};class=\"mixin\";location=#{mixin.location.inspect}"
         end
 
         attributes = @attributes.to_header

data/lib/occi/core/kind.rb

@@ -2,7 +2,7 @@ module Occi
   module Core
     class Kind < Occi::Core::Category
 
-      attr_accessor :entities, :parent, :actions, :location
+      attr_accessor :entities, :parent, :actions
 
       # @param scheme [String ] The categorisation scheme.
       # @param term [String] Unique identifier of the Kind instance within the categorisation scheme.
@@ -21,7 +21,7 @@ module Occi
         @parent = [parent].flatten.first
         @actions = Occi::Core::Actions.new(actions)
         @entities = Occi::Core::Entities.new
-        location.blank? ? @location = "/#{term}/" : @location = location
+        @location = location.blank? ? "/#{term}/" : URI.parse(location).path
       end
 
       # @param scheme [String] The categorisation scheme.
@@ -96,8 +96,16 @@ module Occi
         self.class.get_class self.scheme, self.term, self.parent
       end
 
+      # set location attribute of kind
+      # @param [String] location
+      def location=(location)
+        location = URI.parse(location).path if location
+        raise "Kind locations must end with a slash!" unless location.blank? || location =~ /^\/\S+\/$/
+        @location = location
+      end
+
       def location
-        @location.clone
+        @location ? @location.clone : nil
       end
 
       def related

data/lib/occi/core/mixin.rb

@@ -2,7 +2,7 @@ module Occi
   module Core
     class Mixin < Occi::Core::Category
 
-      attr_accessor :entities, :depends, :actions, :location, :applies
+      attr_accessor :entities, :depends, :actions, :applies
 
       # @param [String] scheme
       # @param [String] term
@@ -25,7 +25,7 @@ module Occi
         @depends = Occi::Core::Dependencies.new depends
         @actions = Occi::Core::Actions.new actions
         @entities = Occi::Core::Entities.new
-        @location = location.blank? ? "/mixin/#{term}/" : location
+        @location = location.blank? ? "/mixin/#{term}/" : URI.parse(location).path
         @applies = Occi::Core::Kinds.new applies
       end
 
@@ -37,8 +37,16 @@ module Occi
         self.to_s == mixin.to_s || self.related.any? { |m| m.type_identifier == mixin.to_s }
       end
 
+      # set location attribute of kind
+      # @param [String] location
+      def location=(location)
+        location = URI.parse(location).path if location
+        raise "Mixin locations must end with a slash!" unless location.blank? || location =~ /^\/\S+\/$/
+        @location = location
+      end
+
       def location
-        @location.clone
+        @location ? @location.clone : nil
       end
 
       def related

data/lib/occi/version.rb

@@ -1,3 +1,3 @@
 module Occi
-  VERSION = "4.2.11" unless defined?(::Occi::VERSION)
+  VERSION = "4.2.12" unless defined?(::Occi::VERSION)
 end

data/spec/occi/collection_spec.rb

@@ -833,7 +833,7 @@ module Occi
         collection.resources << Occi::Core::Resource.new
         collection.links << Occi::Core::Link.new
 
-        expected = "Category: compute;scheme=\"http://schemas.ogf.org/occi/infrastructure#\";class=\"kind\";title=\"compute resource\";rel=\"http://schemas.ogf.org/occi/core#resource\";location=\"/compute/\";attributes=\"occi.core.id{immutable} occi.core.title occi.core.summary occi.compute.architecture occi.compute.cores occi.compute.hostname occi.compute.memory occi.compute.speed occi.compute.state{immutable}\";actions=\"http://schemas.ogf.org/occi/infrastructure/compute/action#start http://schemas.ogf.org/occi/infrastructure/compute/action#stop http://schemas.ogf.org/occi/infrastructure/compute/action#restart http://schemas.ogf.org/occi/infrastructure/compute/action#suspend\"\nCategory: my_mixin;scheme=\"http://example.com/occi/tags#\";class=\"mixin\";location=\"/mixin/my_mixin/\"\nCategory: start;scheme=\"http://schemas.ogf.org/occi/infrastructure/compute/action#\";class=\"action\"\nCategory: resource;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"kind\"\nX-OCCI-Attribute: occi.core.id=\"#{collection.resources.first.id}\"Link: <>;rel=\"http://schemas.ogf.org/occi/core#link\";self=\"/link/#{collection.links.first.id}\";category=\"http://schemas.ogf.org/occi/core#link\";occi.core.id=\"#{collection.links.first.id}\"Category: action_instance;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"action\""
+        expected = "Category: compute;scheme=\"http://schemas.ogf.org/occi/infrastructure#\";class=\"kind\";title=\"compute resource\";rel=\"http://schemas.ogf.org/occi/core#resource\";location=\"/compute/\";attributes=\"occi.core.id{immutable} occi.core.title occi.core.summary occi.compute.architecture occi.compute.cores occi.compute.hostname occi.compute.memory occi.compute.speed occi.compute.state{immutable}\";actions=\"http://schemas.ogf.org/occi/infrastructure/compute/action#start http://schemas.ogf.org/occi/infrastructure/compute/action#stop http://schemas.ogf.org/occi/infrastructure/compute/action#restart http://schemas.ogf.org/occi/infrastructure/compute/action#suspend\"\nCategory: my_mixin;scheme=\"http://example.com/occi/tags#\";class=\"mixin\";location=\"/mixin/my_mixin/\"\nCategory: start;scheme=\"http://schemas.ogf.org/occi/infrastructure/compute/action#\";class=\"action\"\nCategory: resource;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"kind\";location=\"/resource/\"\nX-OCCI-Attribute: occi.core.id=\"#{collection.resources.first.id}\"Link: <>;rel=\"http://schemas.ogf.org/occi/core#link\";self=\"/link/#{collection.links.first.id}\";category=\"http://schemas.ogf.org/occi/core#link\";occi.core.id=\"#{collection.links.first.id}\"Category: action_instance;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"action\""
         expect(collection.to_text).to eql(expected)
       end
 
@@ -871,13 +871,13 @@ module Occi
 
       it 'renders text correctly, resources only' do
         collection.resources << Occi::Core::Resource.new
-        expected = "Category: resource;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"kind\"\nX-OCCI-Attribute: occi.core.id=\"#{collection.resources.first.id}\""
+        expected = "Category: resource;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"kind\";location=\"/resource/\"\nX-OCCI-Attribute: occi.core.id=\"#{collection.resources.first.id}\""
         expect(collection.to_text).to eql(expected)
       end
 
       it 'renders text correctly, links only' do
         collection.links << Occi::Core::Link.new
-        expected = "Category: link;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"kind\"\nX-OCCI-Attribute: occi.core.id=\"#{collection.links.first.id}\""
+        expected = "Category: link;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"kind\";location=\"/link/\"\nX-OCCI-Attribute: occi.core.id=\"#{collection.links.first.id}\""
         expect(collection.to_text).to eql(expected)
       end
 
@@ -894,7 +894,7 @@ module Occi
         collection.links << Occi::Core::Link.new
 
         expected=Hashie::Mash.new
-        expected["Category"] = "compute;scheme=\"http://schemas.ogf.org/occi/infrastructure#\";class=\"kind\",my_mixin;scheme=\"http://example.com/occi/tags#\";class=\"mixin\",start;scheme=\"http://schemas.ogf.org/occi/infrastructure/compute/action#\";class=\"action\",resource;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"kind\",action_instance;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"action\""
+        expected["Category"] = "compute;scheme=\"http://schemas.ogf.org/occi/infrastructure#\";class=\"kind\",my_mixin;scheme=\"http://example.com/occi/tags#\";class=\"mixin\",start;scheme=\"http://schemas.ogf.org/occi/infrastructure/compute/action#\";class=\"action\",resource;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"kind\";location=\"/resource/\",action_instance;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"action\""
         expected["Link"] = "<>;rel=\"http://schemas.ogf.org/occi/core#link\";self=\"/link/#{collection.links.first.id}\";category=\"http://schemas.ogf.org/occi/core#link\";occi.core.id=\"#{collection.links.first.id}\""
         expected["X-OCCI-Attribute"] = "occi.core.id=\"#{collection.resources.first.id}\""
         expect(collection.to_header).to eql(expected)
@@ -939,7 +939,7 @@ module Occi
       it 'renders text correctly, resources only' do
         collection.resources << Occi::Core::Resource.new
         expected=Hashie::Mash.new
-        expected["Category"] = "resource;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"kind\""
+        expected["Category"] = "resource;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"kind\";location=\"/resource/\""
         expected["X-OCCI-Attribute"] = "occi.core.id=\"#{collection.resources.first.id}\""
         expect(collection.to_header).to eql(expected)
       end
@@ -947,7 +947,7 @@ module Occi
       it 'renders text correctly, links only' do
         collection.links << Occi::Core::Link.new
         expected=Hashie::Mash.new
-        expected["Category"] = "link;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"kind\""
+        expected["Category"] = "link;scheme=\"http://schemas.ogf.org/occi/core#\";class=\"kind\";location=\"/link/\""
         expected["X-OCCI-Attribute"] = "occi.core.id=\"#{collection.links.first.id}\""
         expect(collection.to_header).to eql(expected)
       end

data/spec/occi/core/entity_spec.rb

@@ -104,6 +104,26 @@ module Occi
             entity.id = UUIDTools::UUID.random_create.to_s
             expect(entity.location).to eq '/entity/' + entity.id
           end
+
+          it 'gets normalized to a relative path' do
+            entity.location = 'http://example.org/entity/12'
+            expect(entity.location).to eq '/entity/12'
+          end
+
+          it 'can be set to nil and default to /kind/id' do
+            entity.location = nil
+            expect(entity.location).to eq '/entity/baf1'
+          end
+
+          it 'will not duplicate slashes' do
+            entity.id = '//baf1'
+            expect(entity.location).to eq '/entity/baf1'
+          end
+
+          it 'will not duplicate kind location' do
+            entity.id = '/entity/baf1'
+            expect(entity.location).to eq '/entity/baf1'
+          end
         end
 
         context '#title' do
@@ -130,7 +150,7 @@ module Occi
 
       context '#to_text' do
         it 'renders fresh instance in text correctly' do
-          expected = %Q|Category: entity;scheme="http://schemas.ogf.org/occi/core#";class="kind"
+          expected = %Q|Category: entity;scheme="http://schemas.ogf.org/occi/core#";class="kind";location="/entity/"
 X-OCCI-Attribute: occi.core.id="baf1"|
           expect(entity.to_text).to eq(expected)
         end
@@ -141,8 +161,8 @@ X-OCCI-Attribute: occi.core.id="baf1"|
           entity.location = '/TestLoc/1'
           entity.mixins <<  'http://example.com/mynamespace#mymixin'
 
-          expected = %Q|Category: entity;scheme="http://schemas.ogf.org/occi/core#";class="kind"
-Category: mymixin;scheme="http://example.com/mynamespace#";class="mixin"
+          expected = %Q|Category: entity;scheme="http://schemas.ogf.org/occi/core#";class="kind";location="/entity/"
+Category: mymixin;scheme="http://example.com/mynamespace#";class="mixin";location="/mixin/mymixin/"
 X-OCCI-Attribute: occi.core.id="baf1"
 X-OCCI-Attribute: occi.core.title="TestTitle"
 Link: </TestLoc/1?action=testaction>;rel="http://schemas.ogf.org/occi/core/entity/action#testaction"|
@@ -153,7 +173,7 @@ Link: </TestLoc/1?action=testaction>;rel="http://schemas.ogf.org/occi/core/entit
       context '#to_header' do
         it 'renders fresh instance in HTTP Header correctly' do
           expected = Hashie::Mash.new
-          expected['Category'] = 'entity;scheme="http://schemas.ogf.org/occi/core#";class="kind"'
+          expected['Category'] = 'entity;scheme="http://schemas.ogf.org/occi/core#";class="kind";location="/entity/"'
           expected['X-OCCI-Attribute'] = 'occi.core.id="baf1"'
 
           expect(entity.to_header).to eql(expected)
@@ -166,7 +186,7 @@ Link: </TestLoc/1?action=testaction>;rel="http://schemas.ogf.org/occi/core/entit
           entity.mixins <<  'http://example.com/mynamespace#mymixin'
 
           expected = Hashie::Mash.new
-          expected['Category'] = 'entity;scheme="http://schemas.ogf.org/occi/core#";class="kind",mymixin;scheme="http://example.com/mynamespace#";class="mixin"'
+          expected['Category'] = 'entity;scheme="http://schemas.ogf.org/occi/core#";class="kind";location="/entity/",mymixin;scheme="http://example.com/mynamespace#";class="mixin";location="/mixin/mymixin/"'
           expected['X-OCCI-Attribute'] = 'occi.core.id="baf1",occi.core.title="TestTitle"'
           expected['Link'] = '</TestLoc/1?action=testaction>;rel="http://schemas.ogf.org/occi/core/entity/action#testaction"'
 

data/spec/occi/core/kind_spec.rb

@@ -86,6 +86,33 @@ module Occi
 
       end
 
+      describe '#location' do
+        let(:kind) { Occi::Core::Kind.new }
+
+        it 'gets normalized to a relative path' do
+          kind.location = 'http://example.org/kind/'
+          expect(kind.location).to eq '/kind/'
+        end
+
+        it 'can be set to nil' do
+          kind.location = nil
+          expect(kind.location).to be_nil
+        end
+
+        it 'raises an error when location does not start and end with a slash' do
+          expect { kind.location = '/no_slash' }.to raise_error
+          expect { kind.location = 'no_slash/' }.to raise_error
+        end
+
+        it 'raises an error when location contains spaces' do
+          expect { kind.location = '/sla shes/' }.to raise_error
+        end
+
+        it 'can be set to an empty string' do
+          expect { kind.location = '' }.not_to raise_error
+        end
+      end
+
       describe '#related_to?' do
         let(:base){ Occi::Core::Kind.new 'http://occi.test.case/core/kind', 'base' }
         let(:related){ Occi::Core::Kind.new 'http://occi.test.case/core/kind/base', 'related', 'title', Occi::Core::Attributes.new, base }

data/spec/occi/core/mixin_spec.rb

@@ -0,0 +1,38 @@
+module Occi
+  module Core
+    describe Mixin do
+
+      describe '#location' do
+        let(:mixin) { Occi::Core::Mixin.new }
+
+        it 'defaults to /mixin/term/' do
+          expect(mixin.location).to eq '/mixin/mixin/'
+        end
+
+        it 'gets normalized to a relative path' do
+          mixin.location = 'http://example.org/mixin/'
+          expect(mixin.location).to eq '/mixin/'
+        end
+
+        it 'can be set to nil' do
+          mixin.location = nil
+          expect(mixin.location).to be_nil
+        end
+
+        it 'raises an error when location does not start and end with a slash' do
+          expect { mixin.location = '/no_slash' }.to raise_error
+          expect { mixin.location = 'no_slash/' }.to raise_error
+        end
+
+        it 'raises an error when location contains spaces' do
+          expect { mixin.location = '/sla shes/' }.to raise_error
+        end
+
+        it 'can be set to an empty string' do
+          expect { mixin.location = '' }.not_to raise_error
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: occi-core
 version: !ruby/object:Gem::Version
-  version: 4.2.11
+  version: 4.2.12
 platform: ruby
 authors:
 - Florian Feldhaus
@@ -16,42 +16,42 @@ dependencies:
   name: json
   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: hashie
   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: uuidtools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.1.3
 - !ruby/object:Gem::Dependency
@@ -72,14 +72,14 @@ dependencies:
   name: settingslogic
   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'
 description: OCCI is a collection of classes to simplify the implementation of the
@@ -178,6 +178,7 @@ files:
 - spec/occi/core/kind_spec.rb
 - spec/occi/core/link_spec.rb
 - spec/occi/core/links_spec.rb
+- spec/occi/core/mixin_spec.rb
 - spec/occi/core/mixins_spec.rb
 - spec/occi/core/properties_spec.rb
 - spec/occi/core/resource_spec.rb
@@ -231,12 +232,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []