occi-api 4.0.0.beta.1 → 4.0.0.beta.2

data/lib/occi/api/client/client_base.rb

@@ -346,17 +346,23 @@ module Occi
           found_ary.any? ? found_ary.first : nil
         end
 
+        # Looks up a mixin with a specific type, will return
+        # mixin's full description.
         #
-        #
-        #
+        # @param [String] name of the mixin
+        # @param [String] type of the mixin
+        # @return [Occi::Collection] mixin description
         def describe_mixin_w_type(name, type)
           return unless %w( os_tpl resource_tpl ).include? type.to_s
           send("get_#{type.to_s}s".to_sym).select { |mixin| mixin.term == name }
         end
 
+        # Looks up a mixin in all available mixin types, will
+        # return mixin's full description. Returns always the
+        # first match found, search will start in os_tpl.
         #
-        #
-        #
+        # @param [String] name of the mixin
+        # @return [Occi::Collection] mixin description
         def describe_mixin_wo_type(name)
           %w( os_tpl resource_tpl ).each do |type|
             found = send("get_#{type}s".to_sym).select { |mixin| mixin.term == name }
@@ -466,36 +472,6 @@ module Occi
         end
         alias_method :get_resource_tpls, :get_resource_templates
 
-        # Creates a link of a specified kind and binds it to the given resource.
-        #
-        # @example
-        #    link_kind = 'http://schemas.ogf.org/occi/infrastructure#storagelink'
-        #    compute = client.get_resource "compute"
-        #    storage_location = "http://localhost:3300/storage/321df21adfad-f3adfa5f4adf-a3d54ffadffe"
-        #    linked_resource_kind = 'http://schemas.ogf.org/occi/infrastructure#storage'
-        #
-        #    link link_kind, compute, storage_location, linked_resource_kind
-        #
-        # @param [String] link type identifier (link kind)
-        # @param [Occi::Core::Resource] resource to link to
-        # @param [URI, String] resource to be linked
-        # @param [String] type identifier of the linked resource
-        # @param [Occi::Core::Attributes] link attributes
-        # @param [Array<String>] link mixins
-        # @return [Occi::Core::Link] link instance
-        def link(kind, source, target_location, target_kind, attributes=Occi::Core::Attributes.new, mixins=[])
-          link = Occi::Core::Link.new(kind)
-          link.mixins = mixins
-          link.attributes = attributes
-          link.target = (target_location.kind_of? URI::Generic) ? target_location.path : target_location.to_s
-          link.rel = target_kind
-
-          link.check @model
-          source.links << link
-
-          link
-        end
-
         # Returns the path for a given resource type identifier
         #
         # @example
@@ -543,6 +519,10 @@ module Occi
 
         protected
 
+        ##############################################################################
+        ######## STUBS START
+        ##############################################################################
+
         # Sets auth method and appropriate httparty attributes. Supported auth methods
         # are: ["basic", "digest", "x509", "none"]
         #
@@ -571,6 +551,10 @@ module Occi
         # @return [String] chosen media type
         def set_media_type(force_type = nil); end
 
+        ##############################################################################
+        ######## STUBS END
+        ##############################################################################
+
         # Sets the logger and log levels. This allows users to pass existing logger
         # instances to the rOCCI client.
         #
@@ -618,23 +602,27 @@ module Occi
           @model
         end
 
+        # Returns mixin type identifiers for os_tpl mixins
+        # in an array.
         #
-        #
-        #
+        # @return [Array] array of os_tpl mixin identifiers
         def get_os_tpl_mixins_ary
           get_mixins_ary(:os_tpl)
         end
 
+        # Returns mixin type identifiers for resource_tpl mixins
+        # in an array.
         #
-        #
-        #
+        # @return [Array] array of resource_tpl mixin identifiers
         def get_resource_tpl_mixins_ary
           get_mixins_ary(:resource_tpl)
         end
 
+        # Returns mixin type identifiers for given mixin type
+        # in an array.
         #
-        #
-        #
+        # @param [Symbol] mixin type
+        # @return [Array] array of mixin identifiers
         def get_mixins_ary(mixin_type)
           mixins = []
 

data/lib/occi/api/client/client_http.rb

@@ -14,9 +14,14 @@ module Occi
         # HTTParty for raw HTTP requests
         include HTTParty
 
-        # TODO: uncomment the following line as JSON is properly implemented in OpenStack
-        # headers 'Accept' => 'application/occi+json,text/plain;q=0.8,text/occi;q=0.2'
-        headers 'Accept' => 'text/plain,text/occi;q=0.2'
+        # TODO: change default Accept to JSON as soon as it is properly
+        #       implemented in OpenStack's OCCI-OS
+        #       'Accept' => 'application/occi+json,text/plain;q=0.8,text/occi;q=0.2'
+        DEFAULT_HEADERS = {
+          'Accept'     => 'text/plain,text/occi;q=0.2',
+          'User-Agent' => "rOCCI HTTPClient #{Occi::Api::VERSION}"
+        }
+        headers DEFAULT_HEADERS
 
         # hash mapping HTTP response codes to human-readable messages
         HTTP_CODES = {
@@ -169,10 +174,6 @@ module Occi
 
           raise "#{entity} not an entity!" unless entity.kind_of? Occi::Core::Entity
 
-          # is this entity valid?
-          entity.model = @model
-          entity.check
-
           Occi::Log.debug "Entity kind: #{entity.kind}"
           kind = entity.kind
           raise "No kind found for #{entity}" unless kind

data/lib/occi/api/version.rb

@@ -1,5 +1,5 @@
 module Occi
   module Api
-    VERSION = "4.0.0.beta.1" unless defined?(::Occi::Api::VERSION)
+    VERSION = "4.0.0.beta.2" unless defined?(::Occi::Api::VERSION)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: occi-api
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta.1
+  version: 4.0.0.beta.2
   prerelease: 6
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-28 00:00:00.000000000 Z
+date: 2013-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: occi-core