bodhi-slam 0.8.6 → 0.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 927cbe7fce05186291e3a60f7d5db8080b76eb78
-  data.tar.gz: 91d7ae587744677ec6975d09e78d90857e589e14
+  metadata.gz: df0ac516bd1d04bc4cd3aa891949ba67998980c2
+  data.tar.gz: 9d300e641fd66ca7a460eb02d5a569a5549d3c62
 SHA512:
-  metadata.gz: acc7b2b51d96c0846113bef0d4e55db377eb0e6e53e1ea85988a6701ae8903d9013ee20f8138e504bc487feaf4b8dbd83e171919e697829d0463147c1cc588ed
-  data.tar.gz: fe8081714579f87ee22c8981aa54e958cb2a73e9b3b36dd06fd0985dc5f1db50b43568b0eecb2d43c6332c00d8d17292f2eb79c50a631aae2d668d50fb8a3097
+  metadata.gz: 267ee73450c418081f5b14d19f5accbaa2ad30ed1ebae413b11c02c2434182887ce4dc11e8ae17a24bb4ff0de14b47e17c89fdb8e6d941a5ca1f7f7ed06a27b7
+  data.tar.gz: bf6d08460651b649e0ca05bad80f07c299a9b62636dc049658f6695fcca88ff9114542748902507dbf936d7458293b298c4ae6fa75566bfd07c04787164ca9fd

data/lib/bodhi-slam.rb

@@ -1,7 +1,7 @@
 require "json"
 require "time"
 require 'faraday'
-require 'SecureRandom'
+require 'securerandom'
 require 'faraday_middleware'
 require 'faraday-http-cache'
 require 'net/http/persistent'
@@ -76,7 +76,7 @@ class BodhiSlam
   end
 
   # Dynamically creates Ruby Classes for each type in the given +context+
-  # 
+  #
   #   context = Bodhi::Context.new(valid_params)
   #   BodhiSlam.analyze(context) # => [#<Class:0x007fbff403e808 @name="TestType">, #<Class:0x007fbff403e808 @name="TestType2">, ...]
   def self.analyze(context)
@@ -95,4 +95,4 @@ class BodhiSlam
       end
     end
   end
-end
+end

data/lib/bodhi-slam/factory.rb

@@ -1,9 +1,18 @@
 module Bodhi
   module Factories
     module ClassMethods
+      # Returns the Classes +Bodhi::Factory+ object
+      # @return [Bodhi::Factory]
       def factory; @factory; end
+
+      # Define a factory generator with the given +name+ and +options+
+      # and append to the Classes Bodhi::Factory
+      # @param name [String] the name of the property
+      # @param options [Hash] the Bodhi::Properties
+      # @return [nil]
       def generates(name, options)
         @factory.add_generator(name.to_sym, options)
+        return nil
       end
     end
 
@@ -13,18 +22,49 @@ module Bodhi
     end
   end
 
+  # Randomize and save records to the cloud.
+  #
+  # Use the built in {Bodhi::Validator} classes to define constraints for
+  # randomizing records.  You can also create your own lambda expressions for further
+  # fine grain control.
+  # @example Define factories
+  #   factory = Bodhi::Factory.new(Drone)
+  # @example Default generators using {Bodhi::Type.properties} options
+  #   factory.add_generator(:motor_count, type: Integer, min: 1, max: 8 )
+  # @example Create custom generators using lambda syntax
+  #   factory.add_generator(:color, lambda { ["Red", "Green", "Blue", "Black"].sample } )
+  # @example Build a new record with randomly generated attributes
+  #   quad_copter = factory.build(motor_count: 4)
+  #   quad_copter # => #<Drone:0x007fbff403e808 @motor_count=4 @color="Red" >
+  # @example Build an array of random records
+  #   quad_copters = factory.build_list(10, motor_count: 4)
+  #   quad_copters # => [#<Drone:0x007fbff403e808 @motor_count=4 @color="Blue" >, ...]
+  # @example Build and save a randomly generated record
+  #   quad_copter = factory.create(bodhi_context: context, motor_count: 4)
+  #   quad_copter # => #<Drone:0x007fbff403e808 @motor_count=4 @color="Green" >
+  # @example Build and save an array of random records
+  #   quad_copters = factory.create_list(10, bodhi_context: context, motor_count: 4)
+  #   quad_copters # => [#<Drone:0x007fbff403e808 @motor_count=4 @color="Blue" >, ...]
   class Factory
+    # The class that will be used to generate random instances
     attr_reader :klass
+
+    # Hash of property names with lambda's to generate random values
     attr_accessor :generators
 
+    # Initialize a new Factory using the given base class
+    # @param base [Class] the class you want to generate random instances for
     def initialize(base)
       @klass = base
       @generators = Hash.new
     end
 
-    # Returns a new randomly generated resource.
-    # Accepts an options hash to override specified values.
-    # 
+    # Builds a new randomly generated resource
+    # and accepts a options hash to override specified properties.
+    #
+    # @param options [Hash] the properties and values that should +NOT+ be randomized
+    # @return [Bodhi::Resource] the randomly generated resource
+    # @example
     #   Resource.factory.build # => #<Resource:0x007fbff403e808 @name="2-3lmwp^oef@245">
     #   Resource.factory.build(name: "test") # => #<Resource:0x007fbff403e808 @name="test">
     def build(options={})
@@ -40,31 +80,43 @@ module Bodhi
       object
     end
 
-    # Returns an array of randomly generated resources
-    # 
+    # Builds an array of randomly generated resources
+    # and accepts a options hash to override specified properties.
+    #
+    # @param size [Integer] the amount of resources to generate
+    # @param options [Hash] the properties and values that should +NOT+ be randomized
+    # @return [Array<Bodhi::Resource>] An Array of randomly generated resources
+    # @example
     #   Resource.factory.build_list(10) # => [#<Resource:0x007fbff403e808 @name="2-3lmwp^oef@245">, #<Resource:0x007fbff403e808 @name="p7:n#$903<u1">, ...]
     #   Resource.factory.build_list(10, name: "test") # => [#<Resource:0x007fbff403e808 @name="test">, #<Resource:0x007fbff403e808 @name="test">, ...]
     def build_list(size, options={})
       size.times.collect{ build(options) }
     end
 
-    # Builds and saves a new resource to the given +context+
-    # Accepts an options hash to override specified values.
-    # 
-    #   context = Bodhi::Context.new
-    #   Resource.factory.create(context) # => #<Resource:0x007fbff403e808 @name="2-3lmwp^oef@245">
-    #   Resource.factory.create(context, name: "test") # => #<Resource:0x007fbff403e808 @name="test">
+    # Generates a random resource and saves it to the IoT Platform
+    # and accepts a options hash to override specified properties.
+    #
+    # @param options [Hash] the properties and values that should +NOT+ be randomized
+    # @return [Bodhi::Resource] the randomly generated resource
+    # @example
+    #   Resource.factory.create(bodhi_context: context) # => #<Resource:0x007fbff403e808 @name="2-3lmwp^oef@245">
+    #   Resource.factory.create(bodhi_context: context, name: "test") # => #<Resource:0x007fbff403e808 @name="test">
     def create(options={})
       object = build(options)
       object.save!
       object
     end
 
-    # Builds and saves a list of resources to the given +context+
-    # Accepts an options hash to override specified values.
-    # 
-    #   Resource.factory.create_list(10, context) # => [#<Resource:0x007fbff403e808 @name="2-3lmwp^oef@245">, #<Resource:0x007fbff403e808 @name="p7:n#$903<u1">, ...]
-    #   Resource.factory.create_list(10, context, name: "test") # => [#<Resource:0x007fbff403e808 @name="test">, #<Resource:0x007fbff403e808 @name="test">, ...]
+    # Generates an array of random resources and saves them to the IoT Platform
+    # and accepts a options hash to override specified properties.
+    #
+    # @param size [Integer] the amount of resources to generate
+    # @param options [Hash] the properties and values that should +NOT+ be randomized
+    # @return [Array<Bodhi::Resource>] An Array of randomly generated resources
+    # @raise [Bodhi::ApiErrors] if any resource failed to be saved
+    # @example
+    #   Resource.factory.create_list(10, bodhi_context: context) # => [#<Resource:0x007fbff403e808 @name="2-3lmwp^oef@245">, #<Resource:0x007fbff403e808 @name="p7:n#$903<u1">, ...]
+    #   Resource.factory.create_list(10, bodhi_context: context, name: "test") # => [#<Resource:0x007fbff403e808 @name="test">, #<Resource:0x007fbff403e808 @name="test">, ...]
     def create_list(size, options={})
       resources = build_list(size, options)
       resources.each{ |resource| resource.save! }
@@ -72,7 +124,11 @@ module Bodhi
     end
 
     # Adds a new generator to the class with the specified +name+ and +options+
-    # 
+    #
+    # @param name [String, Symbol] the name of the property
+    # @param options [Hash] the Bodhi::Properties options to generate
+    # @return [nil]
+    # @example
     #   Resource.factory.add_generator("name", type: "String")
     #   Resource.factory.add_generator("test", type: "Integer", multi: true, required: true)
     def add_generator(name, options)
@@ -81,11 +137,15 @@ module Bodhi
       else
         @generators[name.to_sym] = build_default_generator(options)
       end
+
+      return nil
     end
 
     private
+
+    # @todo clean up this nasty abomination of a method!
     def build_default_generator(options)
-      options = options.reduce({}) do |memo, (k, v)| 
+      options = options.reduce({}) do |memo, (k, v)|
         memo.merge({ Bodhi::Support.underscore(k.to_s).to_sym => v})
       end
 
@@ -181,7 +241,7 @@ module Bodhi
         # define max/min lattitude
         min_lat = -90.0
         max_lat = 90.0
-        
+
         if options[:multi]
           generator = lambda do
             [*0..5].sample.times.collect do
@@ -333,4 +393,4 @@ module Bodhi
     end
 
   end
-end
+end

data/lib/bodhi-slam/properties.rb

@@ -1,118 +1,164 @@
 module Bodhi
+  # This module helps turn a Ruby Object into a Form Object.
+  # It manages the objects properties as well as serialization to JSON
+  # @example
+  #   class MyNewClass
+  #     include Bodhi::properties
+  #
+  #     property :attribute_1, type: String
+  #     property :attribute_2, type: DateTime
+  #     ...
+  #   end
+  #
+  #   object = MyNewClass.new(attribute_1: "Foo", attribute_2: Time.now)
+  #   object.to_json #=> {"attribute_1":"Foo", "attribute_2": "2016-08-16T13:15:19-07:00"}
   module Properties
 
+    # Default properties for ALL records on the IoT Platform
     SYSTEM_PROPERTIES = [:sys_created_at, :sys_version, :sys_modified_at, :sys_modified_by,
       :sys_namespace, :sys_created_by, :sys_type_version, :sys_id, :sys_embeddedType]
     attr_accessor *SYSTEM_PROPERTIES
 
     module ClassMethods
+      # Retuns a Hash of the Classes properties
+      # @return [Hash] The classes properties and options
       def properties; @properties; end
+
+      # A list of all property names
+      # @return [Array<String>]
       def property_names; @properties.keys; end
+
+      # Set a new property with the given +name+ and +options+
+      # @param name [String, Symbol]
+      # @param options [Hash]
+      # @return [nil]
+      # @example
+      #   Resource.property("age", type: Integer, required: true, min: 18)
+      #   Resource.property("birthday", type: DateTime, required: true)
+      #   Resource.property(:tags, type: String, multi: true)
+      #   Resource.property(:dogs", type: "Dog", multi: true)
       def property(name, options)
         attr_accessor name.to_sym
         @properties[name.to_sym] = options.reduce({}) do |memo, (k, v)|
           memo.merge({ Bodhi::Support.reverse_camelize(k.to_s).to_sym => v})
         end
+
+        return nil
       end
     end
 
-    module InstanceMethods
-      def id; @sys_id; end
-      def persisted?; !@sys_id.nil?; end
-      def new_record?; @sys_id.nil?; end
-      def each; attributes.each{ |k, v| yield(k, v) }; end
-
-      # Initializes a new instance of the class.  Accepts a parameter Hash for mass assignment.
-      # If a parameter does not exist for the class, an UndefinedMethod error is raised.
-      #
-      #   klass = Class.new do
-      #     include Bodhi::Properties
-      #     property :name, :email
-      #   end
-      #
-      #   object = klass.new(name: "Bob", email: "some@email.com")
-      #   object.name #=> "Bob"
-      #   object.email #=> "some@email.com"
-      def initialize(options={})
-        if options.is_a?(String)
-          options = JSON.parse(options)
-        end
+    # Wraps the sys_id property into a more Rails friendly attribute
+    # @return [String]
+    def id; @sys_id; end
 
-        # Set properties defined by the +options+ parameter
-        options = Bodhi::Support.symbolize_keys(options)
-        options.each do |property, value|
-          property_options = self.class.properties[property]
-          if property_options.nil?
-            send("#{property}=", value)
-          else
-            send("#{property}=", Bodhi::Support.coerce(value, property_options))
-          end
-        end
+    # Returns +true+ if the record has been saved to the IoT Platform
+    # @return [Boolean]
+    def persisted?; !@sys_id.nil?; end
 
-        # Set any default values
-        self.class.properties.select{ |k,v| !v[:default].nil? }.each do |property, property_options|
-          send("#{property}=", property_options[:default]) if send("#{property}").nil?
-        end
+    # Returns +true+ if the record has +NOT+ been saved to the IoT Platform
+    # @return [Boolean]
+    def new_record?; @sys_id.nil?; end
+
+    # Initializes a new instance of the class.  Accepts a parameter Hash for mass assignment.
+    #
+    # @param options [Hash, JSON String]
+    # @example
+    #   klass = Class.new do
+    #     include Bodhi::Properties
+    #     property :name, :email
+    #   end
+    #
+    #   object = klass.new(name: "Bob", email: "some@email.com")
+    #   object.name #=> "Bob"
+    #   object.email #=> "some@email.com"
+    def initialize(options={})
+      if options.is_a?(String)
+        options = JSON.parse(options)
       end
 
-      # Returns a Hash of the class properties and their values.
-      # 
-      #   object = SomeResource.new(foo:"test", bar:12345)
-      #   object.attributes # => { foo: "test", bar: 12345 }
-      def attributes
-        attributes = Hash.new
-
-        self.class.property_names.each do |property|
-          value = send(property)
-          if value.respond_to?(:attributes)
-            attributes[property] = value.attributes.delete_if { |k, v| v.nil? }
-          elsif value.is_a?(Array) && value.first.respond_to?(:attributes)
-            attributes[property] = value.map(&:attributes).collect{ |item| item.delete_if { |k, v| v.nil? } }
-          elsif value.is_a?(Time)
-            attributes[property] = value.iso8601
-          else
-            attributes[property] = value
-          end
+      # Set properties defined by the +options+ parameter
+      #options = Bodhi::Support.symbolize_keys(options)
+      options.each do |property, value|
+        property_options = self.class.properties[property.to_sym]
+        if property_options.nil?
+          send("#{property}=", value)
+        else
+          send("#{property}=", Bodhi::Support.coerce(value, property_options))
         end
+      end
 
-        attributes.delete_if { |k, v| v.nil? }
-        attributes
+      # Set any default values
+      self.class.properties.select{ |k,v| !v[:default].nil? }.each do |property, property_options|
+        send("#{property}=", property_options[:default]) if send("#{property}").nil?
       end
+    end
+
+    # Returns a Hash of the class properties and their values.
+    #
+    # @return [Hash]
+    # @example
+    #   object = SomeResource.new(foo:"test", bar:12345)
+    #   object.attributes # => { foo: "test", bar: 12345 }
+    def attributes
+      attributes = Hash.new
 
-      # Updates the resource with the given attributes Hash
-      # 
-      #   s = SomeResource.factory.build(foo:"test", bar:12345)
-      #   s.attributes # => { foo: "test", bar: 12345 }
-      #   s.update_attributes(bar: 10)
-      #   s.attributes # => { foo: "test", bar: 10 }
-      def update_attributes(params)
-        params.each do |property, value|
-          property_options = self.class.properties[property.to_sym]
-          if property_options.nil?
-            send("#{property}=", value)
-          else
-            send("#{property}=", Bodhi::Support.coerce(value, property_options))
-          end
+      self.class.property_names.each do |property|
+        value = send(property)
+        if value.respond_to?(:attributes)
+          attributes[property] = value.attributes.delete_if { |k, v| v.nil? }
+        elsif value.is_a?(Array) && value.first.respond_to?(:attributes)
+          attributes[property] = value.map(&:attributes).collect{ |item| item.delete_if { |k, v| v.nil? } }
+        elsif value.is_a?(Time)
+          attributes[property] = value.iso8601
+        else
+          attributes[property] = value
         end
       end
 
-      # Returns all the classes properties as JSON.
-      # It converts any nested objects to JSON if they respond to +to_json+
-      # 
-      #   resource = SomeResource.new(foo:"test", bar:12345)
-      #   embedded_resources = AnotherResource.new( test: resource )
-      #   
-      #   resource.to_json # => "{ 'foo':'test', 'bar':12345 }"
-      #   embedded_resources.to_json # => "{ 'test': { 'foo':'test', 'bar':12345 } }"
-      def to_json(base=nil)
-        attributes.to_json
+      attributes.delete_if { |k, v| v.nil? }
+      attributes
+    end
+
+    # Updates the resource with the given attributes Hash
+    #
+    # @param properties [Hash] The properties to update
+    # @return [nil]
+    # @example
+    #   s = SomeResource.factory.build(foo:"test", bar:12345)
+    #   s.attributes # => { foo: "test", bar: 12345 }
+    #   s.update_attributes(bar: 10)
+    #   s.attributes # => { foo: "test", bar: 10 }
+    def update_attributes(properties)
+      properties.each do |property, value|
+        property_options = self.class.properties[property.to_sym]
+        if property_options.nil?
+          send("#{property}=", value)
+        else
+          send("#{property}=", Bodhi::Support.coerce(value, property_options))
+        end
       end
+
+      return nil
+    end
+
+    # Returns all the classes properties as JSON.
+    # It converts any nested objects to JSON if they respond to +to_json+
+    #
+    # @param options [Hash]
+    # @return [String] the JSON for all properties on the object
+    # @example
+    #   resource = SomeResource.new(foo:"test", bar:12345)
+    #   embedded_resources = AnotherResource.new( test: resource )
+    #
+    #   resource.to_json # => "{ 'foo':'test', 'bar':12345 }"
+    #   embedded_resources.to_json # => "{ 'test': { 'foo':'test', 'bar':12345 } }"
+    def to_json(options=nil)
+      attributes.to_json
     end
 
     def self.included(base)
       base.extend(ClassMethods)
-      base.include(InstanceMethods, Enumerable)
       base.instance_variable_set(:@properties, Hash.new)
     end
   end
-end
+end