occi 2.1.2 → 2.2.0

data/Gemfile

@@ -9,6 +9,7 @@ gem "nokogiri"
 gem "builder"
 gem "activesupport"
 gem "rake"
+gem "httparty"
 
 # development related gems
 group :development do

data/Gemfile.lock

@@ -8,9 +8,13 @@ GEM
     builder (3.0.0)
     diff-lcs (1.1.3)
     hashie (1.2.0)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
     i18n (0.6.0)
     json (1.6.6)
     multi_json (1.3.5)
+    multi_xml (0.4.2)
     nokogiri (1.5.3)
     rake (0.9.2.2)
     rspec (2.10.0)
@@ -40,6 +44,7 @@ DEPENDENCIES
   antlr3
   builder
   hashie
+  httparty
   json
   nokogiri
   rake

data/README.md

@@ -37,6 +37,47 @@ Usage
 First require the gem
     require 'occi'
 
+### Client
+
+The OCCI gem includes a Client to simplify the usage of an OCCI endpoint.
+
+To connect to an OCCI endpoint/server (e.g. running at http://localhost:3000/ ) use
+
+    client = OCCI::Client.new('http://localhost:3000')
+
+All available categories are automatically registered to the OCCI model during client initialization. You can get them via
+
+    OCCI::Model.get
+
+To get all resources (as a list of OCCI::Resources) currently managed by the endpoint use
+
+    client.get_resources
+
+To get only compute, storage or network resources use get_compute_resources, ...
+
+To get the location of all resources use
+
+    client.get_resource_list
+
+Analogue for compute, storage, network via get_compute_list, ...
+
+To get a list of all OS / resource templates use
+
+    client.get_os_templates
+    client.get_resource_templates
+
+To get all attributes with their default values for a given category use
+
+    client.get_attributes(client.compute)
+
+To create a new compute resource use
+
+    os = client.get_os_templates.select { |template| template.term.include? 'my_os' }
+    size = client.get_resource_templates.select { |template| template.term.include? 'large' }
+    attributes = client.get_attributes([client.compute,os,size])
+    attributes['occi.core.title'] = "My VM"
+    client.post_compute(attributes,os,size)
+
 ### Logging
 
 The OCCI gem includes its own logging mechanism using a message queue. By default, no one is listening to that queue.
@@ -84,6 +125,10 @@ The OCCI gem includes all OCCI Core classes necessary to handly arbitrary OCCI o
 Changelog
 ---------
 
+### 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.

data/lib/occi/client.rb

@@ -0,0 +1,167 @@
+require 'rubygems'
+require 'httparty'
+
+module OCCI
+  class Client
+    include HTTParty
+    format :json
+    headers 'Accept' => 'application/occi+json'
+
+    attr_reader :endpoint
+
+    attr_reader :compute
+    attr_reader :storage
+    attr_reader :network
+
+    def initialize(endpoint)
+      @endpoint  = endpoint
+      collection = OCCI::Collection.new(get_model)
+      OCCI::Model.register_collection(collection)
+      @compute = OCCI::Model.get_by_id('http://schemas.ogf.org/occi/infrastructure#compute')
+      @storage = OCCI::Model.get_by_id('http://schemas.ogf.org/occi/infrastructure#storage')
+      @network = OCCI::Model.get_by_id('http://schemas.ogf.org/occi/infrastructure#network')
+    end
+
+    def get_model
+      self.class.get(endpoint + '/-/')
+    end
+
+    def post_mixin
+
+    end
+
+    def post_resources_to_mixin
+
+    end
+
+    def delete_resources_from_mixin
+
+    end
+
+    def delete_mixin
+
+    end
+
+    def get_resources
+      OCCI::Collection.new(self.class.get(endpoint)).resources
+    end
+
+    def get_resources_list
+      self.class.get(@endpoint, :headers => { 'Accept' => 'text/uri-list' }).split("\n").compact
+    end
+
+    def post_resource(attributes, kind, mixins, resources_to_link)
+      resource      = OCCI::Core::Resource.new
+      resource.kind = kind.type_identifier
+      mixins = mixins.collect { |mixin| mixin.type_identifiers } unless mixins.first.kind_of? String
+      resource.mixins = mixins
+      attributes = OCCI::Core::Attributes.split(attributes) unless attributes.kind_of? OCCI::Core::Attributes
+      resource.attributes = attributes
+      resource.links      = []
+      resources_to_link.each do |res|
+        link = OCCI::Link.new
+        link.kind = 'http://schemas.ogf.org/occi/infrastructure#storagelink' if OCCI::Model.get_by_id(res.kind).related_to? 'http://schemas.ogf.org/occi/infrastructure#storage'
+        link.kind = 'http://schemas.ogf.org/occi/infrastructure#networkinterface' if OCCI::Model.get_by_id(res.kind).related_to? 'http://schemas.ogf.org/occi/infrastructure#network'
+        link.titlte "Link to #{res.title}"
+        link.target = res.location
+        resource.links << link
+      end
+      resource.check
+      collection = OCCI::Collection.new(:resources => [resource])
+      self.class.post(@endpoint + kind.location, { :body => collection.to_json, :headers => { 'Content-Type' => 'application/occi+json', 'Accept' => 'text/uri-list' }, :format => 'text/plain' }).to_s
+    end
+
+    def delete_resources
+      self.class.delete(@endpoint)
+    end
+
+    def trigger_action(url)
+      self.class.post(url)
+    end
+
+    def trigger_action_on_resources(resources, action)
+    end
+
+
+    def get_compute_list
+      self.class.get(@endpoint + @compute.location, {:headers => { 'Accept' => 'text/uri-list' }, :format => 'text/plain'}).split("\n").compact
+    end
+
+    def get_compute_resources
+      self.class.get(endpoint + @compute.location)
+    end
+
+    def post_compute_resource(attributes=OCCI::Core::Attributes.new, os = nil, size = nil, mixins=[], resources_to_link=[])
+      mixins << os if os
+      mixins << size if size
+      post_resource(attributes, @compute, mixins, resources_to_link)
+    end
+
+    def delete_compute_resource(id)
+      self.class.delete(@endpoint + @compute.location + id)
+    end
+
+    def delete_compute_resources
+      self.class.delete(@endpoint + @compute.location)
+    end
+
+    def get_storage_resources
+      self.class.get(@endpoint + @storage.location)
+    end
+
+    def post_storage_resource(attributes=OCCI::Core::Attributes.new, mixins=[], resources_to_link=[])
+      post_resource(attributes, @storage, mixins, resources_to_link)
+    end
+
+    def delete_storage_resource(id)
+      self.class.delete(@endpoint + @storage.location + id)
+    end
+
+    def delete_storage_resources
+      self.class.delete @endpoint + (@storage.location)
+    end
+
+    def get_network_resources
+      self.class.get(@endpoint + @network)
+    end
+
+    def post_network_resource(attributes=OCCI::Core::Attributes.new, mixins=[], resources_to_link=[])
+      post_resource(attributes, @network, mixins, resources_to_link)
+    end
+
+    def delete_network_resource(id)
+      self.class.delete(@endpoint + @network.location + id)
+    end
+
+    def delete_network_resources
+      self.class.delete(@endpoint + @network.location)
+    end
+
+    def get_os_templates
+      OCCI::Collection.new(self.class.get(@endpoint + '/-/', :headers => { 'Accept' => 'application/occi+json', 'Content-Type' => 'text/occi', 'Category' => 'os_tpl;scheme="http://schemas.ogf.org/occi/infrastructure#";class="mixin"' })).mixins.select { |mixin| mixin.term != 'os_tpl' }
+    end
+
+    def get_resource_templates
+      OCCI::Collection.new(self.class.get(@endpoint + '/-/', :headers => { 'Accept' => 'application/occi+json', 'Content-Type' => 'text/occi', 'Category' => 'resource_tpl;scheme="http://schemas.ogf.org/occi/infrastructure#";class="mixin"' })).mixins.select { |mixin| mixin.term != 'resource_tpl' }
+    end
+
+    def get_attributes(categories)
+      attributes = Hashie::Mash.new
+      [categories].flatten.each do |category|
+        category = OCCI::Model.get_by_id(category) if category.kind_of? String
+        attributes.merge! category.attributes.combine_with_defaults
+      end
+      attributes
+    end
+
+    def get_attribute_definitions(categories)
+      definitions = OCCI::Core::AttributeProperties.new
+      [categories].flatten.each do |category|
+        category = OCCI::Model.get_by_id(category) if category.kind_of? String
+        definitions.merge! category.attributes
+      end
+      definitions
+    end
+
+  end
+end

data/lib/occi/collection.rb

@@ -34,5 +34,14 @@ module OCCI
     def entities
       @resources + @links
     end
+
+    def empty?
+      @kinds.empty? && @mixins.empty? && @actions.empty? && @resources.empty? && @links.empty?
+    end
+
+    def to_json(options = { })
+      { :kinds => @kinds, :mixins => @mixins, :actions => @actions, :resources => @resources, :links => @links }.to_json
+    end
+
   end
 end

data/lib/occi/core/attribute_properties.rb

@@ -6,10 +6,10 @@ module OCCI
 
       def initialize(attributes = nil, default = nil)
         if attributes[:type] || attributes.required || attributes.mutable || attributes.pattern || attributes.minimum || attributes.maximum || attributes.description
-          attributes[:type] ||= "string"
+          attributes[:type]   ||= "string"
           attributes.required ||= false
-          attributes.mutable ||= false
-          attributes.pattern ||= ".*"
+          attributes.mutable  ||= false
+          attributes.pattern  ||= ".*"
         end unless attributes.nil?
         super(attributes, default)
       end
@@ -18,7 +18,7 @@ module OCCI
         array = []
         self.each_key do |key|
           if self[key].include? 'type'
-            array << key + "{}"
+            array << key
           else
             self[key].combine.each { |attr| array << key + '.' + attr }
           end
@@ -26,6 +26,18 @@ module OCCI
         return array
       end
 
+      def combine_with_defaults
+        hash = {}
+        self.each_key do |key|
+          if self[key].include? 'type'
+            hash[key] = self[key]['default']
+          else
+            self[key].combine_with_defaults.each { |k,v| hash[key + '.' + k] = v }
+          end
+        end
+        return hash
+      end
+
     end
   end
 end

data/lib/occi/core/attributes.rb

@@ -5,7 +5,7 @@ module OCCI
     class Attributes < Hashie::Mash
 
       def combine
-        hash = {}
+        hash = { }
         self.each_key do |key|
           if self[key].kind_of? Hashie::Mash
             self[key].combine.each_pair { |k, v| hash[key + '.' + k] = v }
@@ -16,6 +16,20 @@ module OCCI
         return hash
       end
 
+      def self.split(attributes)
+        attribute = Attributes.new
+        attributes.each do |name,value|
+          puts name
+          key, dot, rest = name.partition('.')
+          if rest.empty?
+            attribute[key] = value
+          else
+            attribute.merge! Attributes.new(key => self.split(rest => value))
+          end
+        end
+        return attribute
+      end
+
     end
   end
 end

data/lib/occi/parser.rb

@@ -44,15 +44,16 @@ module OCCI
       OCCI::Log.debug('### Parsing request data to OCCI data structure ###')
       collection = OCCI::Collection.new
 
+      locations  = self.header_locations(header)
+      category ? collection = self.header_categories(header) : collection = self.header_entity(header) if locations.empty?
+
       case media_type
         when 'text/occi'
-          locations  = self.header_locations(header)
-          category ? collection = self.header_categories(header) : collection = self.header_entity(header) if locations.empty?
         when 'text/uri-list'
           body.each_line { |line| locations << URI.parse(line) }
         when 'text/plain', nil
-          locations = self.text_locations(body)
-          category ? collection = self.text_categories(body) : collection = self.text_entity(body) if locations.empty?
+          locations << self.text_locations(body)
+          category ? collection = self.text_categories(body) : collection = self.text_entity(body) if locations.empty? && collection.empty?
         when 'application/occi+json', 'application/json'
           collection = self.json(body)
         when 'application/occi+xml', 'application/xml'

data/lib/occi/version.rb

@@ -1,3 +1,3 @@
 module OCCI
-  VERSION = "2.1.2" unless defined?(::OCCI::VERSION)
+  VERSION = "2.2.0" unless defined?(::OCCI::VERSION)
 end

data/lib/occi.rb

@@ -2,6 +2,7 @@ require 'occi/version'
 require 'occi/parser'
 require 'occi/model'
 require 'occi/log'
+require 'occi/client'
 require 'occi/collection'
 require 'occi/core/action'
 require 'occi/core/attribute_properties'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: occi
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-13 00:00:00.000000000 Z
+date: 2012-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -138,6 +138,7 @@ files:
 - etc/model/infrastructure/storage.json
 - etc/model/infrastructure/storagelink.json
 - lib/occi.rb
+- lib/occi/client.rb
 - lib/occi/collection.rb
 - lib/occi/core/action.rb
 - lib/occi/core/attribute_properties.rb