arc_weld 0.2.5

data/lib/arc_weld/relationships/has_alternate_interface.rb

@@ -0,0 +1,27 @@
+module ArcWeld
+  module Relationships
+    module HasAlternateInterface
+      def add_interfaces(*assets)
+        assets.each do |asset|
+          unless has_alternate_interface.include?(asset)
+            has_alternate_interface << asset
+          end
+          unless asset.has_alternate_interface.include?(self)
+            asset.has_alternate_interface << self
+          end
+        end
+      end
+      def related_has_alternate_interface_references
+        (has_alternate_interface.map {|a| a.ref.render}).join
+      end
+      def has_alternate_interface_relationship
+        unless has_alternate_interface.empty?
+          { 'hasAlternateInterface' => {
+              'list!' => related_has_alternate_interface_references},
+            'alternateInterfaceOf' => {
+              'list!' => related_has_alternate_interface_references} }
+        end
+      end
+    end
+  end
+end

data/lib/arc_weld/relationships/has_child.rb

@@ -0,0 +1,42 @@
+module ArcWeld
+  module Relationships
+    module HasChild
+      def related_has_child_references
+        has_child.map {|res| res.ref.render }.join
+      end
+
+      def has_child_relationship
+        {'hasChild' => { 'list!' => related_has_child_references }}
+      end
+
+      def set_attributes_from(child)
+        self.containedResourceType=child.resource_class_id if containedResourceType.nil?
+        self.parent_ref=child.class.toplevel if parent_ref.nil?
+
+      end
+
+      def add_child(child)
+        unless has_child.include?(child)
+          if child.resource_type != 'Group'
+            set_attributes_from(child)
+            if (child.resource_class_id != self.containedResourceType)
+              fail RuntimeError, 'child resource does not match contained types'
+            end
+          end
+          self.has_child.push(child)
+          child.parent_ref=self.ref
+        end
+      end
+
+      def add_children(*resources)
+        resources.each {|res| add_child(res) }
+      end
+
+      def contains_resource_type
+        unless self.has_child.empty?
+          has_child.first.resource_type
+        end
+      end
+    end
+  end
+end

data/lib/arc_weld/relationships/has_customer.rb

@@ -0,0 +1,28 @@
+module ArcWeld
+  module Relationships
+    module HasCustomer
+      def add_customer(cust)
+        unless has_customer.include?(cust)
+          has_customer.push(cust)
+          cust.add_customer_resource(self)
+        end
+      end
+
+      def add_customers(*customers)
+        customers.each { |cust| add_customer(cust) }
+      end
+
+      def related_has_customer_references
+        (has_customer.map { |cust| cust.ref.render }).join
+      end
+
+      def has_customer_relationship
+        unless has_customer.empty?
+          { 'hasCustomer' => {
+              'list!' => related_has_customer_references
+          }}
+        end
+      end
+    end
+  end
+end

data/lib/arc_weld/relationships/has_location.rb

@@ -0,0 +1,16 @@
+module ArcWeld
+  module Relationships
+    module HasLocation
+      def has_location_relationship
+        unless has_location.nil?
+          { 'hasLocation' => { 'list!' => has_location.ref.render } }
+        end
+      end
+      def has_location=(location)
+        
+        location.add_location_resource(self) unless location.nil?
+        @has_location=location
+      end
+    end
+  end
+end

data/lib/arc_weld/relationships/in_category.rb

@@ -0,0 +1,26 @@
+module ArcWeld
+  module Relationships
+    module InCategory
+
+      def add_category(cat)
+        unless in_category.include?(cat.ref)
+          in_category << cat.ref
+        end
+      end
+
+      def add_categories(*cats)
+        cats.each { |cat| add_category(cat) }
+      end
+
+      def related_in_category_references
+        (in_category.map &:render).join
+      end
+
+      def in_category_relationship
+        unless in_category.empty?
+          { 'inCategory' => { 'list!' => related_in_category_references } }
+        end
+      end
+    end
+  end
+end

data/lib/arc_weld/relationships/in_network.rb

@@ -0,0 +1,26 @@
+module ArcWeld
+  module Relationships
+    module InNetwork
+
+      def related_in_network_references
+        (in_network.map { |net| net.ref.render }).join
+      end
+
+      def in_network_relationship
+        unless in_network.empty?
+          { 'inNetwork' => { 'list!' => related_in_network_references } }
+        end
+      end
+
+      def add_network(net)
+        unless in_network.include?(net)
+          in_network << net
+        end
+      end
+
+      def add_networks(*nets)
+        nets.each { |net| add_network(net) }
+      end
+    end
+  end
+end

data/lib/arc_weld/relationships/in_zone.rb

@@ -0,0 +1,41 @@
+module ArcWeld
+  module Relationships
+    module InZone
+      def in_zone_relationship
+        unless in_zone.nil?
+          { 'inZone' => { 'list!' => in_zone.ref.render } }
+        end
+      end
+
+      def auto_zone(*zones)
+        my_zone = zones.find {|z| z.contains?(self.address)}
+        self.set_zone(my_zone) unless my_zone.nil?
+      end
+
+      def parent_ref_from_zone(zone)
+        unless zone.parent_ref == ArcWeld::Zone.toplevel
+          asset_group_uri = zone.ref_uri.gsub('All Zones', 'All Assets')
+          ArcWeld::Reference.new(
+            uri: asset_group_uri,
+            externalID: OpenSSL::Digest::MD5.base64digest(asset_group_uri),
+            type: 'Group'
+          )
+        end
+      end
+      def set_zone(tgt_zone)
+        if tgt_zone.contains?(address)
+          self.staticAddressing = tgt_zone.staticAddressing
+          self.has_location = tgt_zone.has_location
+          self.in_network = tgt_zone.in_network
+          tgt_ref = parent_ref_from_zone(tgt_zone)
+          self.parent_ref =  tgt_ref unless tgt_ref.nil?
+          @in_zone = tgt_zone
+        end
+      end
+
+      def in_zone=(zone)
+        self.set_zone(zone)
+      end
+    end
+  end
+end

data/lib/arc_weld/relationships/location_of.rb

@@ -0,0 +1,28 @@
+module ArcWeld
+  module Relationships
+    module LocationOf
+      def add_location_resource(res)
+        unless location_of.include?(res)
+          location_of.push(res)
+          res.has_location=self unless res.has_location==self
+        end
+      end
+
+      def add_location_resources(*resources)
+        resources.each { |res| add_location_resource(res) }
+      end
+
+      def related_location_of_references
+        (location_of.map { |resource| resource.ref.render }).join
+      end
+
+      def location_of_relationship
+        unless location_of.empty?
+          { 'locationOf' => {
+              'list!' => related_location_of_references
+          }}
+        end
+      end
+    end
+  end
+end

data/lib/arc_weld/resource.rb

@@ -0,0 +1,149 @@
+module ArcWeld
+  module Resource
+    def self.included(klass)
+      klass.class_eval '@@RESOURCE_PROPERTIES = []'
+
+      klass.class_eval do
+        extend ClassMethods, ArcWeld::Helpers
+
+        attr_accessor :name, :id, :externalID, :action
+
+        def initialize(*args)
+          Hash[*args].each {|k,v| self.send("#{k}=",v)}
+          @action ||= 'insert'
+          yield self if block_given?
+          self
+        end
+
+      end
+    end
+
+    def resource_class_id
+      self.class.class_variable_get :@@CLASS_ID
+    end
+
+    def resource_type
+      self.class.send :resource_type
+    end
+
+    def parent_ref
+      @parent_ref ||= self.class.toplevel
+    end
+
+    def parent_ref=(containing_group)
+      @parent_ref = containing_group.ref
+    end
+
+    def identity_hash
+      if id.nil?
+        {'@externalID' => externalID}
+      else
+        {'@id' => id}
+      end
+    end
+
+    def identity
+      if id.nil?
+        {:externalID => externalID}
+      else
+        {:id => id}
+      end
+    end
+
+    def property_hash
+      self.class.class_properties.reduce({}) do |memo, key|
+        memo[key] = self.send(key) unless self.send(key).nil?
+        memo
+      end
+    end
+
+    def relationship_hash
+      {} # TODO: damn dirty hack
+    end
+
+    def ref_uri
+      self.class.uri_join(parent_ref.uri, name) unless parent_ref.nil?
+    end
+
+    def ref
+      ArcWeld::Reference.new({
+        type: resource_type,
+        uri:  ref_uri
+        }.merge(identity)
+      )
+    end
+
+    def to_h
+      resource_h = {
+        resource_type => {
+          'childOf' => { 'list!' => parent_ref.render },
+          '@name'   => name,
+          '@action' => action
+        }.merge(identity_hash)
+         .merge(property_hash)
+         .merge(relationship_hash)
+      }
+    end
+
+    def render
+      Gyoku.xml(to_h, key_converter: :none)
+    end
+
+    module ClassMethods
+      def resource_type
+        name.split('::')[-1]
+      end
+
+
+      def toplevel
+        @top ||= ArcWeld::Reference.new(
+          type: 'Group',
+          id:   format('01000100010001%03d', class_id),
+          uri:  class_root
+        )
+      end
+
+      def class_id
+        self.class_variable_get :@@CLASS_ID
+      end
+
+      def class_root
+        self.class_variable_get :@@RESOURCE_ROOT
+      end
+
+      def class_properties
+        self.class_variable_get :@@RESOURCE_PROPERTIES
+      end
+
+      def resource_root(str)
+        fail ArgumentError, 'resource root must be string' unless str.is_a?(String)
+        #puts format('setting resource_root %s on %s', str, self.name)
+        norm_str = (str.gsub(%r{\A/?},'').gsub(%r{/?\z},'').split(' ').map &:capitalize).join(' ')
+        self.class_eval "@@RESOURCE_ROOT = \"/#{norm_str}/\""
+        norm_str
+      end
+
+      def resource_class_id(num)
+        fail ArgumentError, 'class id must be Integer' unless num.is_a?(Integer)
+        #puts format('setting class id %d on %s', num, self.name)
+        self.class_eval "@@CLASS_ID = #{num}"
+        num
+      end
+
+      def resource_property(*syms)
+        syms.each do |sym|
+          #puts format('defining resource property %s on %s', sym.to_s, self.name)
+          register_property(sym)
+        end
+      end
+
+      def register_property(sym)
+        #puts format('registering property %s on %s', sym.to_s, self.name)
+        unless class_properties.include?(sym)
+          class_properties.push(sym)
+          self.class_eval "attr_accessor :#{sym}"
+        end
+      end
+    end
+  end
+end

data/lib/arc_weld/resource_definitions.rb

@@ -0,0 +1,7 @@
+require 'arc_weld/resources/asset'
+require 'arc_weld/resources/asset_category'
+require 'arc_weld/resources/customer'
+require 'arc_weld/resources/group'
+require 'arc_weld/resources/location'
+require 'arc_weld/resources/network'
+require 'arc_weld/resources/zone'

data/lib/arc_weld/resources/asset.rb

@@ -0,0 +1,33 @@
+module ArcWeld
+  class Asset
+    include ArcWeld::Resource
+    include ArcWeld::Relationship
+
+    resource_class_id 4
+    resource_root     '/All Assets/'
+    resource_property :description, :staticAddressing, :hostname, :macAddress, :address
+
+    has_relationship  :has_location, :in_zone
+    has_relationship  :in_category, :has_alternate_interface, :in_network, multiple: true
+
+    def safe_name_from(str)
+      str.split('.')[0].gsub(%r{[\/\*:\\]},'-').downcase
+    end
+
+    def generate_name
+      if staticAddressing=='false' && (hostname!=nil)
+        safe_name_from(hostname)
+      elsif (address!=nil) && (hostname!=nil)
+        format('%s - %s', address, safe_name_from(hostname))
+      elsif (address!=nil)
+        address
+      else
+        externalID
+      end
+    end
+
+    def name
+      @name ||= generate_name
+    end
+  end
+end

data/lib/arc_weld/resources/asset_category.rb

@@ -0,0 +1,40 @@
+module ArcWeld
+  class AssetCategory
+    include ArcWeld::Resource
+    include ArcWeld::Relationship
+
+    resource_class_id 31
+    resource_root     '/All Asset Categories/'
+    
+    resource_property :description, :containedResourceType, :memberReferencePage
+    
+    has_relationship  :has_child, multiple: true
+
+    # @OVERRIDE
+    def ref
+      ArcWeld::Reference.new({
+          type: 'Group',
+          uri:  ref_uri
+        }.merge(identity)
+      )
+    end
+    
+    # @OVERRIDE
+    def containedResourceType
+      resource_class_id
+    end
+
+    # @OVERRIDE
+    def to_h
+      resource_h = {
+        'Group' => {
+          'childOf' => { 'list!' => parent_ref.render },
+          '@name'   => name,
+          '@action' => action
+        }.merge(identity_hash)
+         .merge(property_hash)
+         .merge(relationship_hash)
+      }
+    end
+  end
+end

data/lib/arc_weld/resources/customer.rb

@@ -0,0 +1,16 @@
+module ArcWeld
+  class Customer
+    include ArcWeld::Resource
+    include ArcWeld::Relationship
+
+    resource_class_id 35
+    resource_root     '/All Customers/'
+    resource_property :description,
+                      :streetAddress1,
+                      :streetAddress2,
+                      :addressState,
+                      :country
+
+    has_relationship :customer_of, multiple: true
+  end
+end

data/lib/arc_weld/resources/group.rb

@@ -0,0 +1,29 @@
+module ArcWeld
+  class Group
+    include ArcWeld::Resource
+    include ArcWeld::Relationship
+
+    resource_property :containedResourceType, :description, :memberReferencePage
+    has_relationship  :has_child, :in_category, :in_network, :has_customer, multiple: true
+
+    def self.class_id
+      fail TypeError, 'no group resource class_id'
+    end
+
+    def self.class_root
+      fail TypeError, 'no group resource class_root'
+    end
+
+    def resource_class_id
+      fail TypeError, 'no group resource class_id'
+    end
+
+    def self.toplevel
+      fail TypeError, 'no top-level group resource reference'
+    end
+
+    def parent_ref
+      @parent_ref
+    end
+  end
+end

data/lib/arc_weld/resources/location.rb

@@ -0,0 +1,18 @@
+module ArcWeld
+  class Location
+    include ArcWeld::Resource
+    include ArcWeld::Relationship
+
+    resource_class_id 39
+    resource_root     '/All Locations/'
+    resource_property :countryCode,
+                      :city,
+                      :countryName,
+                      :description,
+                      :latitude,
+                      :longitude,
+                      :postalCode,
+                      :regionCode
+    has_relationship :location_of, multiple: true
+  end
+end

data/lib/arc_weld/resources/network.rb

@@ -0,0 +1,14 @@
+module ArcWeld
+  class Network
+    include ArcWeld::Resource
+    include ArcWeld::Relationship
+
+    resource_class_id 40
+    resource_root     '/All Networks/'
+    resource_property :description
+
+    has_relationship :has_customer, multiple: true
+    has_relationship :has_location
+
+  end
+end

data/lib/arc_weld/resources/zone.rb

@@ -0,0 +1,65 @@
+module ArcWeld
+  class Zone
+    include ArcWeld::Resource
+    include ArcWeld::Relationship
+
+    resource_class_id 29
+    resource_root     '/All Zones/'
+    resource_property :description, :dynamicAddressing, :startAddress, :endAddress
+
+    has_relationship  :has_location
+    has_relationship  :in_network, :in_category, multiple: true
+
+    attr_reader :cidr
+
+    def cidr=(addr)
+      @cidr = case addr
+        when String
+          IPAddr.new(addr)
+        when IPAddr
+          addr
+        else
+          fail ArgumentError, 'must call with either String or IPAddr'
+      end
+
+      @startAddress = cidr.to_range.to_a.first.to_s
+      @endAddress   = cidr.to_range.to_a.last.to_s
+      cidr
+    end
+
+    def start_ip
+      IPAddr.new(startAddress)
+    end
+
+    def end_ip
+      IPAddr.new(endAddress)
+    end
+
+    def contains?(addr)
+      comp = case addr
+        when String
+          IPAddr.new(addr)
+        when IPAddr
+          addr
+        else
+          nil
+      end
+      if ([comp, startAddress, endAddress].any? &:nil?)
+        false
+      else
+        start_ip <= comp && end_ip >= comp
+      end
+    end
+
+    def staticAddressing
+      case self.dynamicAddressing
+        when 'true', true
+          'false'
+        when 'false', false
+          'true'
+        else
+          nil
+      end
+    end
+  end
+end

data/lib/arc_weld/templates/project-csv/.gitignore.tt

@@ -0,0 +1,2 @@
+/tmp/
+/Gemfile.lock

data/lib/arc_weld/templates/project-csv/Gemfile.tt

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+# add local gems here

data/lib/arc_weld/templates/project-csv/Thorfile.tt

@@ -0,0 +1,9 @@
+require 'arc_weld'
+PROJECT_DIR  = File.expand_path(File.dirname(__FILE__))
+PROJECT_LIB  = File.join(PROJECT_DIR, 'lib')
+PROJECT_THOR = File.join(PROJECT_LIB, 'thor')
+$LOAD_PATH.push(PROJECT_LIB)
+
+Dir[File.join(PROJECT_THOR,'*.thor')].each do |tf|
+  Thor::Util.load_thorfile(tf) 
+end

data/lib/arc_weld/templates/project-csv/in/assets.csv.tt

@@ -0,0 +1,2 @@
+externalID,address,macAddress,hostname,description
+weld_asset_0001,192.168.0.10,be:ef:be:ef:00:10,asset0001,example asset

data/lib/arc_weld/templates/project-csv/in/categories.csv.tt

@@ -0,0 +1,3 @@
+name,externalID,memberReferencePage,description
+Welded Assets,weld_category_assets,,Assets Generated by ArcWeld
+Welded Zones,weld_category_zones,,Zone Resources Generated by ArcWeld

data/lib/arc_weld/templates/project-csv/in/customer_groups.csv.tt

@@ -0,0 +1,3 @@
+customer:externalID,group:ref_uri
+weld_customer_stage,/All Networks/ArcWeld
+weld_customer_stage,/All Zones/<%= @config[:name] %>

data/lib/arc_weld/templates/project-csv/in/customers.csv.tt

@@ -0,0 +1,3 @@
+name,externalID,streetAddress1,streetAddress2,description
+Staging,weld_customer_stage,,,Customer resource for staging asset model. You will want to reassign resources from here to your actual target customers, or set a different target customer in the project config.
+Decom,weld_customer_decom,,,Customer resource for decommissioning assets. You can use this resource to disassociate modeled resources from active customers/connectors.

data/lib/arc_weld/templates/project-csv/in/group_categories.csv.tt

@@ -0,0 +1,3 @@
+group:externalID,asset_category:externalID
+weld_asset_root,weld_category_assets
+weld_zone_root,weld_category_zones

data/lib/arc_weld/templates/project-csv/in/locations.csv.tt

@@ -0,0 +1,6 @@
+name,externalID,latitude,longitude,city,description
+cota,weld_location_001,30.3077609,-97.7534014,Elroy,Circuit of the Americas
+nurburgring,weld_location_002,50.3460423,6.9660294,Meuspath,Nürburgring Nordschleife
+laguna seca,weld_location_003,36.5842902,-121.7534634,Salinas,Mazda Raceway Laguna Seca
+driveway,weld_location_004,36.5842902,-121.7534634,Austin,Driveway Austin Motorsports
+harris hill,weld_location_005,29.9201124,-97.8744759,San Marcos,Harris Hill Raceway

data/lib/arc_weld/templates/project-csv/in/networks.csv.tt

@@ -0,0 +1,3 @@
+name,externalID,description
+Staging,weld_net_stage,Staging Network for Generated Resources. You will want to move your generated assets out of here to somewhere more useful. You can also retarget the base_model in the config to point to somewhere directly like Local.
+Decom,weld_net_decom,Decom Network for old resources. You will want to move old/unused resources here to disassociate them from active connectors & customers. This will make deleting them cleaner.

data/lib/arc_weld/templates/project-csv/in/zone_locations.csv.tt

@@ -0,0 +1,2 @@
+zone:externalID,location:externalID
+weld_zone_192168,weld_location_001