bcl 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 310fa6cd807919ce71dd05ca1a6d94f9d0b5a745
-  data.tar.gz: 14ddfb96035844f235e012657bcf48c7d809f458
+  metadata.gz: 10d084384705465f95b8b328994161d836c98c83
+  data.tar.gz: ffdd20227e95f5b995f0c1bf0f228af53b287bc3
 SHA512:
-  metadata.gz: 58e402c26df46cd04242857ed248138d15b8e4f39f5b7806c7cd8ffadf9eda2036b87d5fdc81d74aa350a08f972796aeadec7dfe8863e9e6aab404539f495cb4
-  data.tar.gz: 2b6ce437ca4614ae28ad53655162aa243618967e5c5a6146fefca1e1914e7c35c7ccb81cc7129f6dae656fda18ba0877a725927e8b4f2fef5c8f3142d1a643f5
+  metadata.gz: 19cfe476429d53381ff893040138977fddd2a9a6aab330f965e012c7dc346ee61624fc522aa13c92e7dd9df1bd16ab5cb9b7cb278d9ef8c68e64ed5920a3f5e6
+  data.tar.gz: 55a8758853dd04845cfbcd9fce45187a63970d87c4f734bbca024322346d7ddc9b2051d80620e5a8d7b1448e9bdf369262e62967e2ea69150ea464bc7fdf7e86

data/lib/bcl/component_methods.rb

@@ -64,15 +64,13 @@ module BCL
     end
 
     def default_yaml
-      settings = { :server => { :url => "https://bcl.nrel.gov", :user => { :username => "ENTER_BCL_USERNAME", :password => "ENTER_BCL_PASSWORD"} } }
+      settings = {:server => {:url => "https://bcl.nrel.gov", :user => {:username => "ENTER_BCL_USERNAME", :password => "ENTER_BCL_PASSWORD"}}}
 
       settings
     end
-    
-    
-    def login(username=nil, password=nil, url=nil)
 
-	
+
+    def login(username=nil, password=nil, url=nil)
       #figure out what url to use
       if url.nil?
         url = @config[:server][:url]
@@ -103,7 +101,7 @@ module BCL
 
       data = %Q({"username":"#{username}","password":"#{password}"})
       #data = {"username" => username, "password" => password}
-      
+
       login_path = "/api/user/login.json"
       headers = {'Content-Type' => 'application/json'}
 
@@ -118,50 +116,19 @@ module BCL
       #res = RestClient.post "#{@config[:server][:url]}/api/user/login", data.to_json, :content_type => :json, :accept => :json
       if res.code == '200'
         puts "Login Successful"
-=begin
-		  #OLD RESTCLIENT CODE
-        #pull out the session key
-        res_j = JSON.parse(res.body)
-        sessid = res_j["sessid"]
-        session_name = res_j["session_name"]
-
-			puts "**** RETURNED COOKIES: #{res.cookies.inspect}"
-			#pull out the BNES key and BNI key
-			bnes_name = ""
-			bnesid = ""
-			bni_name = ""
-			bni_id = ""
-			junkout = res.cookies
-			junkout.each do |key, val|
-			  if key.include?("BNES_SESS")
-				 bnes_name = key.to_s
-				 bnesid = val.to_s
-			  end
-			end
-			junkout.each do |key, val|
-			  if key.include?("BNI_bcl")
-				bni_name = key.to_s
-				bni_id = val.to_s
-			  end
-			end
-			#@session = { session_name => sessid, bnes_name => bnesid }
-			#@session = {session_name => URI.unescape(sessid), bnes_name => URI.unescape(bnesid)}
-			@session = {session_name => sessid,bnes_name => bnesid,bni_name => bni_id}
-		
-=end
-    
+
         bnes = ""
         bni = ""
         junkout = res["set-cookie"].split(";")
         junkout.each do |line|
           if line =~ /BNES_SESS/
-           bnes = line.match(/(BNES_SESS.*)/)[0]
+            bnes = line.match(/(BNES_SESS.*)/)[0]
           end
         end
 
         junkout.each do |line|
           if line =~ /BNI/
-           bni = line.match(/(BNI.*)/)[0]
+            bni = line.match(/(BNI.*)/)[0]
           end
         end
 
@@ -169,7 +136,7 @@ module BCL
         session_name = ""
         sessid = ""
         json = JSON.parse(res.body)
-        json.each do |key, val| 
+        json.each do |key, val|
           if key == 'session_name'
             session_name = val
           elsif key == 'sessid'
@@ -177,13 +144,13 @@ module BCL
           end
         end
 
-        @session = session_name + '=' + sessid + ';' + bni + ";" + bnes 
-         
+        @session = session_name + '=' + sessid + ';' + bni + ";" + bnes
+
         #get access token
         token_path = "/services/session/token"
         token_headers = {'Content-Type' => 'application/json', 'Cookie' => @session}
         #puts "token_headers = #{token_headers.inspect}"
-        access_token = @http.post(token_path,"",token_headers)
+        access_token = @http.post(token_path, "", token_headers)
         if access_token.code == '200'
           @access_token = access_token.body
         else
@@ -191,16 +158,17 @@ module BCL
           puts "error code: #{access_token.code}"
           puts "error info: #{access_token.body}"
         end
-		
+
         #puts "access_token = *#{@access_token}*" 
         #puts "cookie = #{@session}"
-        
+
         res
       else
-      
+
         puts "error code: #{res.code}"
         puts "error info: #{res.body}"
-		
+        puts "continuing as unauthenticated sessions (you can still search and download)"
+
         res
       end
     end
@@ -219,37 +187,37 @@ module BCL
       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
-               },
-                "node" =>
-               {
-                "type" => "#{content_type}",
-                #"field_component_tags" =>  #TODO remove this field_component_tags once BCL is fixed
-                #  {
-                #    "und" => "1289"
-                #  },
-                "og_group_ref" =>
-                  {
-                    "und" =>
-                      ["target_id" => @group_id],
-
-                  },
-                "publish" => 1  #NOTE THIS ONLY WORKS IF YOU ARE A BCL SITE ADMIN
-                }
-
-              }    
+          "file" =>
+              {
+                  "file" => "#{file_b64}",
+                  "filesize" => "#{File.size(filename_and_path)}",
+                  "filename" => filename
+              },
+          "node" =>
+              {
+                  "type" => "#{content_type}",
+                  #"field_component_tags" =>  #TODO remove this field_component_tags once BCL is fixed
+                  #  {
+                  #    "und" => "1289"
+                  #  },
+                  "og_group_ref" =>
+                      {
+                          "und" =>
+                              ["target_id" => @group_id],
+
+                      },
+                  "publish" => 1 #NOTE THIS ONLY WORKS IF YOU ARE A BCL SITE ADMIN
+              }
+
+      }
       #restclient not working
       #res = RestClient.post "#{@config[:server][:url]}/api/content.json", @data.to_json, :content_type => :json, :cookies => @session
-	   
-      path = "/api/content.json"	 
-      headers = {'Content-Type' => 'application/json','X-CSRF-Token' => @access_token, 'Cookie' => @session}
+
+      path = "/api/content.json"
+      headers = {'Content-Type' => 'application/json', 'X-CSRF-Token' => @access_token, 'Cookie' => @session}
       #puts headers.inspect
       res = @http.post(path, @data.to_json, headers)
-		 
+
       res_j = "could not get json from http post response"
       if res.code == '200'
         res_j = JSON.parse(res.body)
@@ -260,14 +228,14 @@ module BCL
         puts "  404 - check these common causes first:"
         puts "    the filename contains periods (other than the ones before the file extension)"
         puts "    you are not an 'administrator member' of the group you're trying to upload to"
-        valid = false   
+        valid = false
       elsif res.code == '500'
         puts "  error code: #{res.code} - #{res.body}"
         raise "server exception"
         valid = false
       else
         puts "  error code: #{res.code} - #{res.body}"
-        valid = false        
+        valid = false
       end
 
       if valid
@@ -302,7 +270,7 @@ module BCL
 
       logs
     end
-	
+
     # pushes updated content to the bcl and publishes it (if logged-in as BCL Website Admin user).
     # username and password set in ~/.bcl/config.yml file
     def update_content(filename_and_path, write_receipt_file, uuid)
@@ -316,36 +284,36 @@ module BCL
       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
-               },
-               "node" =>
-               {
-                "uuid" => "#{uuid}",
-                #"field_component_tags" =>  #TODO remove this field_component_tags once BCL is fixed
-                #  {
-                #    "und" => "1289"
-                #  },
-                "og_group_ref" =>
-                  {
-                    "und" =>
-                      ["target_id" => @group_id],
-                  },
-                "publish" => 1  #NOTE THIS ONLY WORKS IF YOU ARE A BCL SITE ADMIN
-                }
+          "file" =>
+              {
+                  "file" => "#{file_b64}",
+                  "filesize" => "#{File.size(filename_and_path)}",
+                  "filename" => filename
+              },
+          "node" =>
+              {
+                  "uuid" => "#{uuid}",
+                  #"field_component_tags" =>  #TODO remove this field_component_tags once BCL is fixed
+                  #  {
+                  #    "und" => "1289"
+                  #  },
+                  "og_group_ref" =>
+                      {
+                          "und" =>
+                              ["target_id" => @group_id],
+                      },
+                  "publish" => 1 #NOTE THIS ONLY WORKS IF YOU ARE A BCL SITE ADMIN
               }
-                
-		#restclient not working
-		#res = RestClient.post "#{@config[:server][:url]}/api/content", @data.to_json, :content_type => :json, :cookies => @session, :accept => :json   
+      }
 
-		path = "/api/content.json"	 
-		headers = {'Content-Type' => 'application/json', 'Cookie' => @session, 'X-CSRF-Token' => @access_token}
+      #restclient not working
+      #res = RestClient.post "#{@config[:server][:url]}/api/content", @data.to_json, :content_type => :json, :cookies => @session, :accept => :json   
+
+      path = "/api/content.json"
+      headers = {'Content-Type' => 'application/json', 'Cookie' => @session, 'X-CSRF-Token' => @access_token}
+
+      res = @http.post(path, @data.to_json, headers)
 
-		res = @http.post(path, @data.to_json, headers)
-				
       res_j = "could not get json from http post response"
       if res.code == '200'
         res_j = JSON.parse(res.body)
@@ -356,15 +324,15 @@ module BCL
         puts "  404 - check these common causes first:"
         puts "    the filename contains periods (other than the ones before the file extension)"
         puts "    you are not an 'administrator member' of the group you're trying to upload to"
-        valid = false   
+        valid = false
       elsif res.code == '500'
         puts "  error code: #{res.code} - #{res.body}"
         raise "server exception"
         valid = false
       else
         puts "  error code: #{res.code} - #{res.body}"
-        valid = false        
-      end  
+        valid = false
+      end
 
       if valid
         #write out a receipt file into the same directory of the component with the same file name as
@@ -378,78 +346,93 @@ module BCL
 
       [valid, res_j]
     end
-	
-	def update_contents(array_of_components, skip_files_with_receipts)
-	  logs = []
-	  array_of_components.each do |comp|
-      receipt_file = File.dirname(comp) + "/" + File.basename(comp, '.tar.gz') + ".receipt"
-      log_message = ""
-      if skip_files_with_receipts && File.exists?(receipt_file)
-        log_message = "skipping update because found receipt #{File.basename(comp)}"
-        puts log_message
-      else
-        #extract uuid from the .tar.gz file
-        uuid = nil
-        tgz = Zlib::GzipReader.open(comp)
-        Archive::Tar::Minitar::Reader.open(tgz).each do |entry|
-          if entry.name == "component.xml" or entry.name == "measure.xml"
-            xml_file = LibXML::XML::Document.string(entry.read)
-            uid_node = xml_file.find('uid').first
-            uuid = uid_node.content
-            #vid_node = xml_file.find('version_id').first
-            #vid = vid_node.content
-            #puts "uuid = #{uuid}; vid = #{vid}"
-          end
-        end
-        if uuid == nil
-          log_message = "ERROR: uuid not found for #{File.basename(comp)}"
+
+    def update_contents(array_of_components, skip_files_with_receipts)
+      logs = []
+      array_of_components.each do |comp|
+        receipt_file = File.dirname(comp) + "/" + File.basename(comp, '.tar.gz') + ".receipt"
+        log_message = ""
+        if skip_files_with_receipts && File.exists?(receipt_file)
+          log_message = "skipping update because found receipt #{File.basename(comp)}"
           puts log_message
         else
-          log_message = "pushing updated content #{File.basename(comp)}"
-          puts log_message
-          valid, res = update_content(comp, true, uuid, @group_id)
-          log_message += " #{valid} #{res.inspect.chomp}"
+          #extract uuid from the .tar.gz file
+          uuid = nil
+          tgz = Zlib::GzipReader.open(comp)
+          Archive::Tar::Minitar::Reader.open(tgz).each do |entry|
+            if entry.name == "component.xml" or entry.name == "measure.xml"
+              xml_file = LibXML::XML::Document.string(entry.read)
+              uid_node = xml_file.find('uid').first
+              uuid = uid_node.content
+              #vid_node = xml_file.find('version_id').first
+              #vid = vid_node.content
+              #puts "uuid = #{uuid}; vid = #{vid}"
+            end
+          end
+          if uuid == nil
+            log_message = "ERROR: uuid not found for #{File.basename(comp)}"
+            puts log_message
+          else
+            log_message = "pushing updated content #{File.basename(comp)}"
+            puts log_message
+            valid, res = update_content(comp, true, uuid, @group_id)
+            log_message += " #{valid} #{res.inspect.chomp}"
+          end
         end
+        logs << log_message
       end
-      logs << log_message
-	  end
-    logs		
-	end
-
-  # Simple method to search bcl and return the result as an XML object
-  def search(search_str=nil, filter_str=nil)
-    full_url = "/api/search.json"
-
-    #add search term
-    if !search_str.nil?
-      full_url = full_url +  "/" + search_str
+      logs
     end
-    #add api_version
-    full_url = full_url + "?api_version=#{@api_version}"
-    #add filters
-    if !filter_str.nil?
-      full_url = full_url + "&" + filter_str
+
+    # Simple method to search bcl and return the result as an XML object
+    def search(search_str=nil, filter_str=nil)
+      full_url = "/api/search.json"
+
+      #add search term
+      if !search_str.nil?
+        full_url = full_url + "/" + search_str
+      end
+      #add api_version
+      full_url = full_url + "?api_version=#{@api_version}"
+      #add filters
+      if !filter_str.nil?
+        full_url = full_url + "&" + filter_str
+      end
+
+      res = @http.get(full_url)
+
+      #retrieve in json
+      res.body
     end
 
-    res = @http.get(full_url)
+    # Delete receipt files
+    def delete_receipts(array_of_components)
+      array_of_components.each do |comp|
+        receipt_file = File.dirname(comp) + "/" + File.basename(comp, '.tar.gz') + ".receipt"
+        if File.exists?(receipt_file)
+          FileUtils.remove_file(receipt_file)
+
+        end
+      end
+    end
 
-    #retrieve in json
-    res.body
-  end
-	
-	# Delete receipt files
-	def delete_receipts(array_of_components)
-	  array_of_components.each do |comp|
-      receipt_file = File.dirname(comp) + "/" + File.basename(comp, '.tar.gz') + ".receipt"
-      if File.exists?(receipt_file)
-        FileUtils.remove_file(receipt_file)
+    def list_all_measures()
+      json = JSON.parse(search(nil, "f[0]=bundle%3Anrel_measure&show_rows=100"), :symbolize_names => true)
       
-      end
-	  end
-	end
-  
+      json
+    end
+    
+    def download_component(uid)
+      result = @http.get("/api/component/download?uids=#{uid}")
+      
+      #https://bcl.nrel.gov/api/component/download?uids=a667a52f-aa04-4997-9292-c81671d75f84
+      result.body ? result.body : nil
+    end
+
   end #class ComponentMethods
 
+  
+
   # TODO make this extend the component_xml class (or create a super class around components)
 
   def BCL.gather_components(component_dir, chunk_size = 0, delete_previousgather = false, destination=nil)
@@ -492,7 +475,7 @@ module BCL
     #gather all the .tar.gz files into a single tar.gz
     (1..chunk_cnt).each do |cnt|
       currentdir = Dir.pwd
-      
+
       paths = []
       Pathname.glob("./gather/#{cnt}/*.tar.gz").each do |pt|
         paths << File.basename(pt.to_s)

data/lib/bcl/tar_ball.rb

@@ -19,40 +19,40 @@
 
 require 'rubygems'
 
-require 'zlib' #gem install zliby
+require 'zlib' #gem install zliby # need to convert this to another library (this is olllld)
 require 'archive/tar/minitar' #gem install archive-tar-minitar
 
 module BCL
 
-module_function
+  module_function
 
-def tarball(destination, paths)
-  
-  #check for filepath length limit
-  full_destination = File.expand_path(destination)
-  if full_destination.length > 259 #256 chars max; "C:\" doesn't count
-    puts "[TarBall] ERROR cannot generate #{destination} because path exceeds 256 char limit. shorten component name by at least by #{full_destination.length - 259} chars"
-    return
-  end
-  
-  Zlib::GzipWriter.open(destination) do |gzip|
-    out = Archive::Tar::Minitar::Output.new(gzip)
-    
-    paths.each do |fi|
-      if File.exists?(fi) 
-        Archive::Tar::Minitar.pack_file(fi, out)
-      else
-        puts "[TarBall] ERROR Could not file file: #{fi}"
+  def tarball(destination, paths)
+
+    #check for filepath length limit
+    full_destination = File.expand_path(destination)
+    if full_destination.length > 259 #256 chars max; "C:\" doesn't count
+      puts "[TarBall] ERROR cannot generate #{destination} because path exceeds 256 char limit. shorten component name by at least by #{full_destination.length - 259} chars"
+      return
+    end
+
+    Zlib::GzipWriter.open(destination) do |gzip|
+      out = Archive::Tar::Minitar::Output.new(gzip)
+
+      paths.each do |fi|
+        if File.exists?(fi)
+          Archive::Tar::Minitar.pack_file(fi, out)
+        else
+          puts "[TarBall] ERROR Could not file file: #{fi}"
+        end
       end
+      out.close
     end
-    out.close
   end
-end
 
-def extract_tarball(filename, destination)
-  Zlib::GzipReader.open(filename) {|gz|
+  def extract_tarball(filename, destination)
+    Zlib::GzipReader.open(filename) { |gz|
       Archive::Tar::Minitar.unpack(gz, destination)
-  }
-end
+    }
+  end
 
-end # module BCL
+end # module BCL

data/lib/bcl/version.rb

@@ -18,5 +18,5 @@
 ######################################################################
 
 module BCL
-  VERSION = "0.3.6"
+  VERSION = "0.3.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bcl
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Daniel Macumber
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2013-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -111,6 +111,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem contains helper methods for generating the Component XML file
   needed to upload files to the Building Component Library. It also contains the classes
   needed for logging in via the api and uploading generating components
@@ -151,9 +165,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: Classes for creating component XML files for the BCL
 test_files: []
-has_rdoc: