bcl 0.1.9 → 0.2.2

data/lib/bcl.rb

@@ -1,6 +1,8 @@
 require 'bcl/component_spreadsheet'
 require 'bcl/component_xml'
 require 'bcl/component_methods'
+require 'bcl/measure_xml'
+require 'bcl/bcl_xml'
 require 'bcl/tar_ball'
 require 'bcl/master_taxonomy'
 require 'bcl/mongo_to_component'

data/lib/bcl/bcl_xml.rb

@@ -0,0 +1,130 @@
+require 'uuid' # gem install uuid
+
+module BCL
+  ProvStruct = Struct.new(:author, :datetime, :comment)
+  TagsStruct = Struct.new(:descriptor)
+  AttrStruct = Struct.new(:name, :value, :datatype, :units)
+  FileStruct = Struct.new(:version_software_program, :version_id, :fqp_file, :filename, :filetype, :usage_type, :checksum)
+  CostStruct = Struct.new(:cost_name, :cost_type, :category, :value, :interval,
+                          :interval_units, :year, :location, :units, :currency, :source,
+                          :reference_component_name, :reference_component_id)
+
+  ObjectStruct = Struct.new(:obj_type, :obj_instance)
+
+  class BaseXml
+    attr_accessor :name
+    attr_accessor :description
+    attr_accessor :uuid
+    attr_accessor :vuid
+
+    attr_accessor :attributes
+    attr_accessor :files
+    attr_accessor :costs
+    attr_accessor :tags
+    attr_accessor :provenances
+
+    def initialize(save_path)
+      @name = ""  #this is also a unique identifier to the component...
+      @description = ""
+
+      @provenances = []
+      @tags = []
+      @attributes = []
+      @files = []
+
+      @schema_url = "schema.xsd"
+    end
+
+    def generate_uuid()
+      @uuid = UUID.new.generate
+    end
+
+    def generate_vuid()
+      @vuid = UUID.new.generate
+    end
+
+
+    def add_provenance(author, datetime, comment)
+      prov = ProvStruct.new
+      prov.author = author
+      prov.datetime = datetime
+      prov.comment = comment
+
+      @provenances << prov
+    end
+
+    def add_tag(tag_name)
+      tag = TagsStruct.new
+      tag.descriptor = tag_name
+
+      @tags << tag
+    end
+
+    def add_attribute(name, value, units, datatype = nil)
+      attr = AttrStruct.new
+      attr.name = name
+      attr.value = value
+
+      if !datatype.nil?
+        attr.datatype = datatype
+      else
+        attr.datatype = get_datatype(value)
+      end
+      attr.units = units
+
+      @attributes << attr
+    end
+
+    def add_file(version_sp, version_id, fqp_file, filename, filetype, usage_type = nil, checksum = nil)
+      fs = FileStruct.new
+      fs.version_software_program = version_sp
+      fs.version_id = version_id
+      fs.fqp_file = fqp_file
+      fs.filename = filename
+      fs.filetype = filetype
+      fs.usage_type = usage_type if usage_type != nil
+      fs.checksum = checksum if checksum != nil
+
+      @files << fs
+    end
+
+    #return the title case of the string
+    def tc(input)
+      val = input.gsub(/\b\w/){$&.upcase}
+      if val.downcase == "energyplus"
+        val = "EnergyPlus"
+      end
+      return val
+    end
+
+    def get_attribute(attribute_name)
+      result = nil
+      @attributes.each do |attr|
+        if attr.name == attribute_name
+          result = attr
+        end
+      end
+
+      result
+    end
+
+    def get_datatype(input_value)
+      dt = 'undefined'
+
+      # simple method to test if the input_value is a string, float, or integer.
+      # First convert the value back to a string for testing (in case it was passed as a float/integer)
+      test = input_value.to_s
+      input_value = test.match('\.').nil? ? Integer(test) : Float(test) rescue test.to_s
+
+      if input_value.is_a?(Fixnum) || input_value.is_a?(Bignum)
+        dt = "int"
+      elsif input_value.is_a?(Float)
+        dt = "float"
+      else
+        dt = "string"
+      end
+
+      dt
+    end
+  end
+end

data/lib/bcl/component_methods.rb

@@ -39,6 +39,7 @@ module BCL
     def initialize()
       @config = nil
       @session = nil
+      @api_version = 2.0
       config_path = File.expand_path('~') + '/.bcl'
       config_name = 'config.yml'
       if File.exists?(config_path + "/" + config_name)
@@ -79,6 +80,7 @@ module BCL
         session_name = res_j["session_name"]
 
         @session = { session_name => sessid }
+
       end
 
       res
@@ -88,7 +90,7 @@ module BCL
     # pushes component to the bcl and sets to published (for now). Username and password and
     # set in ~/.bcl/config.yml file which determines the permissions and the group to which
     # the component will be uploaded
-    def push_component(filename_and_path, write_receipt_file)
+    def push_content(filename_and_path, write_receipt_file, content_type)
       raise "Please login before pushing components" if @session.nil?
 
       valid = false
@@ -96,36 +98,24 @@ module BCL
       filename = File.basename(filename_and_path)
       filepath = File.dirname(filename_and_path) + "/"
 
-      # TODO: BCL will be moving over to single endpoint to manage the file upload and node creation (update eventually)
-      file = File.open(filename_and_path, 'r')
+      file = File.open(filename_and_path, 'rb')
       file_b64 = Base64.encode64(file.read)
       @data = {"file" =>
                    {
                        "file" => "#{file_b64}",
                        "filesize" => "#{File.size(filename_and_path)}",
                        "filename" => filename
-                   }
-      }
-
-      res = RestClient.post "http://#{@config[:server][:url]}/api/file", @data.to_json, :content_type => :json, :cookies => @session, :accept => :json
-
-      if res.code == 200
-        fid = JSON.parse(res.body)["fid"]
-
-        #post the node now with reference to this fid
-        @data = {"node" =>
-                     {"type" => "nrel_component",
-                      "status" => 1,  #NOTE THIS ONLY WORKS IF YOU ARE ADMIN
-                      "field_tar_file" =>
-                          {"und" => [
-                              {"fid" => fid}
-                          ]
-                          }
+                   },
+               "node" =>
+                     {
+                        "type" => "#{content_type}"#,
+                        #"status" => 1  #NOTE THIS ONLY WORKS IF YOU ARE ADMIN
                      }
-        }
-
-        res = RestClient.post "http://#{@config[:server][:url]}/api/node", @data.to_json, :content_type => :json, :cookies => @session, :accept => :json
+                }
 
+      res = RestClient.post "http://#{@config[:server][:url]}/api/content", @data.to_json, :content_type => :json, :cookies => @session, :accept => :json
+	    
+      if res.code == 200
         res_j = JSON.parse(res.body)
 
         if res.code == 200
@@ -153,7 +143,7 @@ module BCL
       [valid, res_j]
     end
 
-    def push_components(array_of_components, skip_files_with_receipts)
+    def push_contents(array_of_components, skip_files_with_receipts, content_type)
       logs = []
       array_of_components.each do |comp|
         receipt_file = File.dirname(comp) + "/" + File.basename(comp, '.tar.gz') + ".receipt"
@@ -163,23 +153,29 @@ module BCL
         else
           log_message = "pushing component #{comp}: "
           puts log_message
-          valid, res = push_component(comp, true)
+          valid, res = push_content(comp, true, content_type)
           log_message += " #{valid} #{res.inspect.chomp}"
         end
-        puts log_message
         logs << log_message
       end
 
       logs
     end
 
+    # Simple method to search bcl and return the result as an XML object
+    def search(search_str)
+      full_url = "http://#{@config[:server][:url]}/api/search/#{search_str}&api_version=#{@api_version}"
+      res = RestClient.get "#{full_url}"
+      xml = LibXML::XML::Document.string(res.body)
+
+      xml
+    end
+
   end
 
   # TODO make this extend the component_xml class (or create a super class around components)
 
-  module_function
-
-  def gather_components(component_dir, chunk_size = 0, delete_previous_gather = false)
+  def BCL.gather_components(component_dir, chunk_size = 0, delete_previous_gather = false)
     @dest_filename = "components"
     @dest_file_ext = "tar.gz"
 

data/lib/bcl/component_spreadsheet.rb

@@ -178,6 +178,13 @@ end # if $have_win32ole
             filename = values.delete_at(0)
             filetype = values.delete_at(0)
             filepath = values.delete_at(0)
+            #not all components(rows) have all files; skip if filename "" or nil
+            next if filename == "" or filename == nil
+            #skip the file if it doesn't exist at the specified location
+            if not File.exists?(filepath)
+              puts "[ComponentSpreadsheet] ERROR #{filepath} -> File does not exist, will not be included in component xml"
+              next #go to the next file
+            end
             component_xml.add_file(software_program, version, filepath, filename, filetype)
             
           else
@@ -270,7 +277,8 @@ end # if $have_win32ole
       component.uid = xlsx_worksheet.Range("B#{i}").value
       if component.uid.nil? or component.uid.empty?
         component.uid = UUID.new.generate
-        xlsx_worksheet.Range("B#{i}").value = component.uid      
+        xlsx_worksheet.Range("B#{i}").value = component.uid     
+        exit
       end
       
       # always write new version id

data/lib/bcl/component_xml.rb

@@ -28,51 +28,25 @@ require 'csv'
 
 # required gems
 require 'builder'  #gem install builder (creates xml files)
-require 'uuid' # gem install uuid
+
 require 'bcl/tar_ball'
+require 'bcl/bcl_xml'
 
 
 module BCL
-
-  SCHEMA_LOCATION = "component.xsd"
-
-  ProvStruct = Struct.new(:author, :datetime, :comment)
-  TagsStruct = Struct.new(:descriptor)
-  AttrStruct = Struct.new(:name, :value, :datatype, :units)
-  FileStruct = Struct.new(:version_software_program, :version_id, :fqp_file, :filename, :filetype)
-  #cost_type is an enumeration (not enforced) of installation, material, operations and maintenance,
-  #variable operations and maintenance, salvage
-  CostStruct = Struct.new(:cost_name, :cost_type, :category, :value, :interval,
-         :interval_units, :year, :location, :units, :currency, :source,
-         :reference_component_name, :reference_component_id)
-  ObjectStruct = Struct.new(:obj_type, :obj_instance)
-
-  class Component
-    attr_accessor :name
-    attr_accessor :uid
-    attr_accessor :comp_version_id
-    attr_accessor :description
+  class Component < BaseXml
     attr_accessor :comment
     attr_accessor :source_manufacturer
     attr_accessor :source_model
     attr_accessor :source_serial_no
     attr_accessor :source_year
     attr_accessor :source_url
-    attr_accessor :tags
-    attr_accessor :provenance
-    attr_accessor :attributes
-    attr_accessor :files
-    attr_accessor :costs
     attr_accessor :objects
 
-    public
-
     #the save path is where the component will be saved
     def initialize(save_path)
-      @name = ""  #this is also a unique identifier to the component...
-      @uid = UUID.new.generate
-      @comp_version_id = UUID.new.generate
-      @description = ""
+      super(save_path)
+
       @comment = ""
       @source_manufacturer = ""
       @source_model = ""
@@ -81,23 +55,17 @@ module BCL
       @source_url = ""
 
       #these items have multiple instances
-      @provenance = []
-      @tags = []
-      @attributes = []
-      @files = []
+
       @costs = []
       @objects = [] #container for saving the idf/osm snippets
 
       @path = save_path
 
-      #puts "[ComponentXml] " + @path
-      #need to hit a webservice to validate which tags and attributes are
-      #available (including units?)
-
       #todo: validate against master taxonomy
     end
 
-    def open_component(filename)
+    # TODO This isn't implemented at the moment
+    def open_component_xml(filename)
       read_component_xml(filename)
     end
 
@@ -152,49 +120,6 @@ module BCL
       #puts "[ComponentXml] " + Dir.pwd
     end
 
-    def add_provenance(author, datetime, comment)
-      prov = ProvStruct.new
-      prov.author = author
-      prov.datetime = datetime
-      prov.comment = comment
-
-      @provenance << prov
-    end
-
-    def add_tag(tag_name)
-      tag = TagsStruct.new
-      tag.descriptor = tag_name
-
-      @tags << tag
-    end
-
-    def add_attribute(name, value, units, datatype = nil)
-      attr = AttrStruct.new
-      attr.name = name
-      attr.value = value
-
-      if !datatype.nil?
-        attr.datatype = datatype
-      else
-        attr.datatype = get_datatype(value)
-      end
-      attr.units = units
-
-      @attributes << attr
-    end
-
-    def add_file(version_sp, version_id, fqp_file, filename, filetype)
-      fs = FileStruct.new
-      fs.version_software_program = version_sp
-      fs.version_id = version_id
-      fs.fqp_file = fqp_file
-      fs.filename = filename
-      fs.filetype = filetype
-
-      @files << fs
-    end
-
-
     def add_cost(cost_name, cost_type, category, value, units, interval, interval_units, year, location, currency,
              source, reference_component_name, reference_component_id)
       cs = CostStruct.new
@@ -325,21 +250,26 @@ module BCL
     end
 
     def save_component_xml(dir_path = resolve_path)
+      FileUtils.mkpath(dir_path) if !File.exists?(dir_path)
+
+      generate_uuid() if @uuid.nil?
+      generate_vuid() if @vuid.nil?
+
       xmlfile = File.new(dir_path + '/component.xml', 'w')
       comp_xml = Builder::XmlMarkup.new(:target => xmlfile, :indent=>2)
 
       #setup the xml file
       comp_xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
       comp_xml.component("xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
-                 "xsi:noNamespaceSchemaLocation"=>"#{SCHEMA_LOCATION}") {
+                 "xsi:noNamespaceSchemaLocation"=>"#{@schema_url}") {
         comp_xml.name @name
-        comp_xml.uid @uid
-        comp_xml.version_id @comp_version_id
+        comp_xml.uid @uuid
+        comp_xml.version_id @vuid
         comp_xml.description @description if @description != ""
         comp_xml.comment @comment if @comment != ""
 
         comp_xml.provenances {
-          @provenance.each do |prov|
+          @provenances.each do |prov|
             comp_xml.provenance {
               comp_xml.author prov.author
               comp_xml.datetime prov.datetime
@@ -428,49 +358,6 @@ module BCL
 
       xmlfile.close
     end
-
-    def get_attribute(attribute_name)
-      result = nil
-      @attributes.each do |attr|
-        if attr.name == attribute_name
-          result = attr
-        end
-      end
-
-      result
-
-    end
-
-    #return the title case of the string
-    def tc(input)
-      val = input.gsub(/\b\w/){$&.upcase}
-      if val.downcase == "energyplus"
-        val = "EnergyPlus"
-      end
-      return val
-    end
-
-    private
-
-    def get_datatype(input_value)
-      dt = 'undefined'
-
-      # simple method to test if the input_value is a string, float, or integer.
-      # First convert the value back to a string for testing (in case it was passed as a float/integer)
-      test = input_value.to_s
-      input_value = test.match('\.').nil? ? Integer(test) : Float(test) rescue test.to_s
-
-      if input_value.is_a?(Fixnum) || input_value.is_a?(Bignum)
-        dt = "int"
-      elsif input_value.is_a?(Float)
-        dt = "float"
-      else
-        dt = "string"
-      end
-
-      dt
-    end
-
   end
 
 end # module BCL