bodhi-slam 0.8.6 → 0.8.7

data/lib/bodhi-slam/simulator.rb

@@ -11,14 +11,10 @@ module Bodhi
     include Bodhi::Properties
     include Bodhi::Validations
 
-    # Initial conditions
     property :starts_at, type: DateTime
     property :iterations, type: Integer
     property :time_units, type: String
     property :time_scale, type: Integer, default: 1
-
-    # Dynamic attributes
-    # Updated every iteration
     property :current_frame, type: SimulationFrame
 
     # Model validations
@@ -91,4 +87,4 @@ module Bodhi
   end
 end
 
-Dir[File.dirname(__FILE__) + "/simulation/*.rb"].each { |file| require file }
+Dir[File.dirname(__FILE__) + "/simulation/*.rb"].each { |file| require file }

data/lib/bodhi-slam/support.rb

@@ -62,9 +62,19 @@ module Bodhi
         if Object.const_defined?(options[:type].to_s) && Object.const_get(options[:type].to_s).ancestors.include?(Bodhi::Properties)
           klass = Object.const_get(options[:type].to_s)
           if options[:multi] == true
-            value.map{|item| klass.new(item) }
+            value.map do |item|
+              if item.respond_to?(:attributes)
+                klass.new(item.attributes)
+              else
+                klass.new(item)
+              end
+            end
           else
-            klass.new(value)
+            if value.respond_to?(:attributes)
+              klass.new(value.attributes)
+            else
+              klass.new(value)
+            end
           end
         else
           value
@@ -72,4 +82,4 @@ module Bodhi
       end
     end
   end
-end
+end

data/lib/bodhi-slam/types.rb

@@ -1,9 +1,13 @@
 module Bodhi
+  # Interface for interacting with the BodhiType resource.
   class Type
     include Bodhi::Factories
     include Bodhi::Properties
     include Bodhi::Validations
 
+    # The API context that binds this {Bodhi::Type} instance to the HotSchedules IoT Platform
+    # @note This is required for the all instance methods to work correctly
+    # @return [Bodhi::Context] the API context linked to this object
     attr_accessor :bodhi_context
 
     property :properties,     type: "Object"
@@ -21,7 +25,6 @@ module Bodhi
     property :embedded,       type: "Boolean"
     property :metadata,       type: "Boolean"
     property :encapsulated,   type: "Boolean"
-
     property :documentation,  type: "Link"
 
     validates :name, required: true, is_not_blank: true
@@ -35,12 +38,27 @@ module Bodhi
     generates :embedded, type: "Boolean"
     generates :version, type: "String"
 
-    # Saves the resource to the Bodhi Cloud.  Raises ArgumentError if record could not be saved.
-    # 
-    #   obj = Resouce.new
-    #   obj.save!
-    #   obj.persisted? # => true
+    # POST a new +Bodhi::Type+ to the HotSchedules IoT Platform
+    #
+    # Equivalent CURL command:
+    #   curl -u username:password -X POST -H "Content-Type: application/json" \
+    #     https://{server}/{namespace}/types \
+    #     -d '{type properties}'
+    #
+    # @raise [RuntimeError] if the {#bodhi_context} attribute is nil
+    # @raise [Bodhi::ContextErrors] if the {#bodhi_context} attribute is not valid
+    # @raise [Bodhi::ApiErrors] if the response status is NOT +201+
+    # @return [nil]
+    # @example
+    #   type = Bodhi::Type.new(bodhi_context: context, name: "MyType", properties: { name: { type: "String" }, age: { type: "Integer" } })
+    #   type.save!
     def save!
+      if bodhi_context.nil?
+        raise RuntimeError.new("Missing attribute #bodhi_context.  Unable to send HTTP request")
+      elsif bodhi_context.invalid?
+        raise Bodhi::ContextErrors.new(context.errors.messages), context.errors.to_a.to_s
+      end
+
       result = bodhi_context.connection.post do |request|
         request.url "/#{bodhi_context.namespace}/types"
         request.headers['Content-Type'] = 'application/json'
@@ -55,9 +73,38 @@ module Bodhi
       if result.headers['location']
         @sys_id = result.headers['location'].match(/types\/(?<name>[a-zA-Z0-9]+)/)[:name]
       end
+
+      return nil
     end
 
+    # DELETE a +Bodhi::Type+ from the HotSchedules IoT Platform.
+    #
+    # Equivalent CURL command:
+    #   curl -u username:password -X DELETE https://{server}/{namespace}/types/{type.name}
+    #
+    # @raise [RuntimeError] if the {#bodhi_context} attribute is nil
+    # @raise [Bodhi::ContextErrors] if the {#bodhi_context} attribute is not valid
+    # @raise [Bodhi::ApiErrors] if the HTTP response status is NOT 204
+    # @return [nil]
+    # @example
+    #   type = Bodhi::Type.new(
+    #     bodhi_context: context,
+    #     name: "MyType",
+    #     properties: {
+    #       name: { type: "String" },
+    #       age: { type: "Integer" }
+    #     }
+    #   )
+    #
+    #   type.save!
+    #   type.delete!
     def delete!
+      if bodhi_context.nil?
+        raise RuntimeError.new("Missing attribute #bodhi_context.  Unable to send HTTP request")
+      elsif bodhi_context.invalid?
+        raise Bodhi::ContextErrors.new(context.errors.messages), context.errors.to_a.to_s
+      end
+
       result = bodhi_context.connection.delete do |request|
         request.url "/#{bodhi_context.namespace}/types/#{name}"
         request.headers[bodhi_context.credentials_header] = bodhi_context.credentials
@@ -66,9 +113,37 @@ module Bodhi
       if result.status != 204
         raise Bodhi::ApiErrors.new(body: result.body, status: result.status), "status: #{result.status}, body: #{result.body}"
       end
+
+      return nil
     end
 
+    # PATCH a +Bodhi::Type+ with an Array of patch operations
+    #
+    # Equivalent CURL command:
+    #   curl -u username:password -X PATCH -H "Content-Type: application/json" \
+    #     https://{server}/{namespace}/types/{type.name} \
+    #     -d '[{operation1}, {operation2}, ...]'
+    #
+    # @note This method does not update the calling object!  Only the record on the API will be changed
+    # @todo After patch is successful, update the object with the changes.
+    # @param params [Array<Hash>] An array of hashes with the keys: +op+, +path+, & +value+
+    # @raise [RuntimeError] if the {#bodhi_context} attribute is nil
+    # @raise [Bodhi::ContextErrors] if the {#bodhi_context} attribute is not valid
+    # @raise [Bodhi::ApiErrors] if the response status is NOT +204+
+    # @return [nil]
+    # @example
+    #   type.patch!([
+    #     {op: "add", path: "/properties/birthday", value: { type: "DateTime" }},
+    #     {op: "add", path: "/indexes/-", value: { keys: ["birthday"] }},
+    #     {op: "remove", path: "/properties/age"}
+    #   ])
     def patch!(params)
+      if bodhi_context.nil?
+        raise RuntimeError.new("Missing attribute #bodhi_context.  Unable to send HTTP request")
+      elsif bodhi_context.invalid?
+        raise Bodhi::ContextErrors.new(context.errors.messages), context.errors.to_a.to_s
+      end
+
       result = bodhi_context.connection.patch do |request|
         request.url "/#{bodhi_context.namespace}/types/#{name}"
         request.headers['Content-Type'] = 'application/json'
@@ -79,9 +154,29 @@ module Bodhi
       if result.status != 204
         raise Bodhi::ApiErrors.new(body: result.body, status: result.status), "status: #{result.status}, body: #{result.body}"
       end
+
+      return nil
     end
 
+    # PUT a +Bodhi::Type+ using the properties in the given +params+
+    #
+    # @todo Break this method apart into #update! (raise error) and #update (return Boolean) methods
+    # @param params [Bodhi::Type, Hash, JSON String] the properties & values to update the type with
+    # @raise [RuntimeError] if the {#bodhi_context} attribute is nil
+    # @raise [Bodhi::ContextErrors] if the {#bodhi_context} attribute is not valid
+    # @raise [Bodhi::ApiErrors] if the HTTP response status is NOT 204
+    # @return [Boolean]
+    # @example
+    #   type = Bodhi::Type.new(bodhi_context: context, name: "MyType", properties: { name: { type: "String" }, age: { type: "Integer" } })
+    #   type.save!
+    #   type.update!(name: "MyType", properties: { name: { type: "String" }, age: { type: "Integer" } }, indexes: [{ keys: ["age"] }])
     def update!(params)
+      if bodhi_context.nil?
+        raise RuntimeError.new("Missing attribute #bodhi_context.  Unable to send HTTP request")
+      elsif bodhi_context.invalid?
+        raise Bodhi::ContextErrors.new(context.errors.messages), context.errors.to_a.to_s
+      end
+
       update_attributes(params)
 
       if invalid?
@@ -103,9 +198,14 @@ module Bodhi
     end
     alias :update :update!
 
-    # Queries the Bodhi API for the given +type_name+ and
-    # returns a Bodhi::Type
-    # 
+    # Queries the Bodhi API for the given +type_name+ and returns a single +Bodhi::Type+ or raises an error.
+    #
+    # @param context [Bodhi::Context]
+    # @param type_name [String]
+    # @raise [Bodhi::ContextErrors] if the provided Bodhi::Context is invalid
+    # @raise [Bodhi::ApiErrors] if the HTTP response status is NOT 200
+    # @return [Bodhi::Type]
+    # @example
     #   context = BodhiContext.new(valid_params)
     #   type = Bodhi::Type.find(context, "MyTypeName")
     #   type # => #<Bodhi::Type:0x007fbff403e808 @name="MyTypeName">
@@ -129,8 +229,14 @@ module Bodhi
     end
 
     # Queries the Bodhi API for all types within the given +context+ and
-    # returns an array of Bodhi::Type objects
-    # 
+    # returns an array of +Bodhi::Type+ objects
+    #
+    # @note This method will query ALL type records within the context and is not limited to the default 100 record limit for queries.  YE BE WARNED!
+    # @param context [Bodhi::Context]
+    # @return [Array<Bodhi::Type>] all Bodhi::Type records within the given context
+    # @raise [Bodhi::ContextErrors] if the provided Bodhi::Context is invalid
+    # @raise [Bodhi::ApiErrors] if the HTTP response status is NOT 200
+    # @example
     #   context = BodhiContext.new(valid_params)
     #   types = Bodhi::Type.find_all(context)
     #   types # => [#<Bodhi::Type:0x007fbff403e808 @name="MyType">, #<Bodhi::Type:0x007fbff403e808 @name="MyType2">, ...]
@@ -164,15 +270,33 @@ module Bodhi
       end
     end
 
+    # Search for +Bodhi::Type+ records using MongoDB query operators.
+    #
+    # @note This method will NOT return more than 100 records at a time!
+    # @param query [Hash, JSON String] The MongoDB query to use for the search
+    # @return [Bodhi::Query<Bodhi::Type>] A query object for +Bodhi::Types+ using the given +query+
+    # @example
+    #   query_obj = Bodhi::Type.where(name: "MyType")
+    #   query_obj.from(context).all #=> [#<Bodhi::Type:0x007fbff403e808 @name="MyType">]
+    #
+    #   json = '{"name":{ "$in": ["MyType", "MyType2"] }}'
+    #   query_obj = Bodhi::Type.where(json)
+    #   query_obj.from(context).all #=> [#<Bodhi::Type:0x007fbff403e808 @name="MyType">, #<Bodhi::Type:0x007fbff403e808 @name="MyType2">]
     def self.where(query)
       query_obj = Bodhi::Query.new(Bodhi::Type, "types")
       query_obj.where(query)
       query_obj
     end
 
-    # Dynamically defines a new Ruby class for the given +type+
-    # Class validations, factory, and helper methods will also be added
-    # 
+    # Defines a new Ruby class using the given +Bodhi::Type+
+    # and includes the {Bodhi::Resource} and ActiveModel::Model modules
+    #
+    # @todo Break apart creating classes and setting classes to a constant
+    # @note This method uses +Object.const_set+ to create new Classes.  Old definitions will be overwritten!
+    # @param type [Bodhi::Type]
+    # @return [Class] the new {Bodhi::Resource}
+    # @raise [ArgumentError] if the +type+ param is not a +Bodhi::Type+
+    # @example
     #   type = Bodhi::Type.new({name: "TestType", properties: { foo:{ type:"String" }}})
     #   klass = Bodhi::Type.create_class_with(type)
     #   klass # => #<Class:0x007fbff403e808 @name="TestType">
@@ -215,4 +339,4 @@ module Bodhi
   end
 end
 
-Dir[File.dirname(__FILE__) + "/types/*.rb"].each { |file| require file }
+Dir[File.dirname(__FILE__) + "/types/*.rb"].each { |file| require file }

data/lib/bodhi-slam/validations.rb

@@ -1,8 +1,8 @@
 module Bodhi
   module Validations
-    
+
     module ClassMethods
-      
+
       # Returns a Hash of all validations present for the class
       #
       #   class User
@@ -22,7 +22,7 @@ module Bodhi
       #     ]
       #   }
       def validators; @validators; end
-      
+
       # Creates a new validation on the given +attribute+ using the supplied +options+
       #
       #   class User
@@ -36,23 +36,23 @@ module Bodhi
         unless attribute.is_a? Symbol
           raise ArgumentError.new("Invalid :attribute argument. Expected #{attribute.class} to be a Symbol")
         end
-        
+
         unless options.is_a? Hash
           raise ArgumentError.new("Invalid :options argument. Expected #{options.class} to be a Hash")
         end
-        
+
         if options.keys.empty?
           raise ArgumentError.new("Invalid :options argument. Options can not be empty")
         end
 
-        options = options.reduce({}) do |memo, (k, v)| 
+        options = options.reduce({}) do |memo, (k, v)|
           memo.merge({ k.to_sym => v})
         end
 
         @validators[attribute] = []
         options.each_pair do |key, value|
           key = key.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase.to_sym
-          
+
           unless [:ref].include?(key)
             if key == :type && value == "Enumerated"
               @validators[attribute] << Bodhi::Validator.constantize(key).new(value, options[:ref])
@@ -63,84 +63,80 @@ module Bodhi
         end
       end
     end
-    
-    module InstanceMethods
-      
-      # Returns a +Bodhi::Errors+ object that holds all information about attribute error messages.
-      #
-      #   class User
-      #     include Bodhi::Validations
-      #
-      #     attr_accessor :name
-      #     validates :name, required: true
-      #   end
-      #
-      #   user = User.new
-      #   user.valid? # => false
-      #   user.errors # => #<Bodhi::Errors:0x007fbff403e808 @messages={name:["is required"]}>
-      def errors
-        @errors ||= Bodhi::Errors.new
-      end
-      
-      # Runs all class validations on object and adds any errors to the +Bodhi::Errors+ object
-      #
-      #   class User
-      #     include Bodhi::Validations
-      #
-      #     attr_accessor :name
-      #     validates :name, required: true
-      #   end
-      #
-      #   user = User.new
-      #   user.validate! # => nil
-      #   user.errors.full_messages # => ["name is required"]
-      #
-      #   user.name = "Bob"
-      #   user.validate! # => nil
-      #   user.errors.full_messages # => []
-      def validate!
-        errors.clear
-        self.class.validators.each_pair do |attribute, array|
-          value = self.send(attribute)
-          array.each do |validator|
-            validator.validate(self, attribute, value)
-          end
+
+    # Returns a +Bodhi::Errors+ object that holds all information about attribute error messages.
+    #
+    #   class User
+    #     include Bodhi::Validations
+    #
+    #     attr_accessor :name
+    #     validates :name, required: true
+    #   end
+    #
+    #   user = User.new
+    #   user.valid? # => false
+    #   user.errors # => #<Bodhi::Errors:0x007fbff403e808 @messages={name:["is required"]}>
+    def errors
+      @errors ||= Bodhi::Errors.new
+    end
+
+    # Runs all class validations on object and adds any errors to the +Bodhi::Errors+ object
+    #
+    #   class User
+    #     include Bodhi::Validations
+    #
+    #     attr_accessor :name
+    #     validates :name, required: true
+    #   end
+    #
+    #   user = User.new
+    #   user.validate! # => nil
+    #   user.errors.full_messages # => ["name is required"]
+    #
+    #   user.name = "Bob"
+    #   user.validate! # => nil
+    #   user.errors.full_messages # => []
+    def validate!
+      errors.clear
+      self.class.validators.each_pair do |attribute, array|
+        value = self.send(attribute)
+        array.each do |validator|
+          validator.validate(self, attribute, value)
         end
       end
-      
-      # Runs all validations and returns +true+ if no errors are present otherwise +false+.
-      #
-      #   class User
-      #     include Bodhi::Validations
-      #
-      #     attr_accessor :name
-      #     validates :name, required: true
-      #   end
-      #
-      #   user = User.new
-      #   user.valid? # => false
-      #   user.errors.full_messages # => ["name is required"]
-      #
-      #   user.name = "Bob"
-      #   user.valid? # => true
-      #   user.errors.full_messages # => []
-      def valid?
-        validate!
-        !errors.messages.any?
-      end
-      
-      # Runs all validations and returns +false+ if no errors are present otherwise +true+.
-      def invalid?
-        !valid?
-      end
     end
-    
+
+    # Runs all validations and returns +true+ if no errors are present otherwise +false+.
+    #
+    #   class User
+    #     include Bodhi::Validations
+    #
+    #     attr_accessor :name
+    #     validates :name, required: true
+    #   end
+    #
+    #   user = User.new
+    #   user.valid? # => false
+    #   user.errors.full_messages # => ["name is required"]
+    #
+    #   user.name = "Bob"
+    #   user.valid? # => true
+    #   user.errors.full_messages # => []
+    def valid?
+      validate!
+      !errors.messages.any?
+    end
+
+    # Runs all validations and returns +false+ if no errors are present otherwise +true+.
+    def invalid?
+      !valid?
+    end
+
     def self.included(base)
       base.extend(ClassMethods)
-      base.include(InstanceMethods)
       base.instance_variable_set(:@validators, Hash.new)
     end
   end
 end
 
-require File.dirname(__FILE__) + "/validators.rb"
+require File.dirname(__FILE__) + "/validators.rb"