bcl 0.5.9 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e73294b8462def2d2ff8831ec1b3e334efcf47e4
-  data.tar.gz: 535c60ceb7b0095ec0fe6952d3b4ef0788c9b5d9
+SHA256:
+  metadata.gz: 6a9c714a1d731180ba6a697a3f945d0269ea258d381b31d83c91752415e60603
+  data.tar.gz: f86719936cbb27b79dd812174d5dc1707fa4426439879a16cfc78f9cb8f2666b
 SHA512:
-  metadata.gz: 8ebe642bcbf101803db171a0af1916a8bb9b4b883924bc07fd30c25c16614f34ef75733d333607eb1a511a1a70fcf5a8ec8ebae63c0893184f84d0059a54f1fd
-  data.tar.gz: 7f61168eb018bd9db461ecbd8f96fd0b17d86fe600deaa908e88a1b6675101fb21901322bed63e81710d469bd9df3d51e668a7f2e2f7552385eb5958e0049828
+  metadata.gz: 9d0fa86c270c26fd224153d5a8179ff24c46b9f27373879c7a1c140279100098da8c83167345f5518c72f14fd6a7c5c22e50506d9fec8ed258f74afa72dfaade
+  data.tar.gz: 713bfd1a0e94a4a4c7b5cdd702ab250c82cd64e1b8188d810a0879fc9b513ec138c8168988cb0242fedfc9deb1d0e58e61a6e5154fea159c88439d9e2eae1743

data/.gitignore

@@ -0,0 +1,21 @@
+.DS_Store
+.bundle
+.idea
+.ruby-version
+.Rhistory
+faraday.log
+gems/
+*.swp
+*.gem
+tmp/*
+rubocop-results.xml
+.rubocop-http*
+Gemfile.lock
+/spec/bcl/output
+/spec/reports
+/spec/api/resources/*.receipt
+measures/
+staged/
+lib/files/staged/
+lib/files/downloads/
+.rubocop-https*

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  Exclude:
+    - 'measures/**/*'
+    - 'spec/api/resources/measure_example/**/*'
+    - 'gems/**/*'
+
+inherit_from:
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v3.yml

data/CHANGELOG.md

@@ -0,0 +1,79 @@
+# Change Log
+
+## Version 0.7.1
+* Update license to standard OpenStudio 4-clause BSD license
+* Upgrade dependencies for security
+
+## Version 0.7.0
+* Support Ruby > 2.7
+* Minimum version of OpenStudio Measure Tester Gem to 0.3.0
+* Update copyrights
+
+## Version 0.6.1
+* Remove dependency for winole (`require 'win32ole'`). This affects the reading of the component spreadsheets and the 
+the master taxomony.
+* Use new rubocop (v3) from s3 openstudio-resources
+
+## Version 0.6.0
+* Support Ruby > 2.5
+* Update dependencies
+
+## Version 0.5.9
+* Update copyrights
+* Update rubocop version (security)
+* Updates to support OpenStudio Extension gem
+
+## Version 0.5.8 
+* Cleanup code (rubocop)
+
+## Version 0.5.7
+* Update to_underscore method to not break apart EnergyPlus nor OpenStudio
+
+## Version 0.5.6
+* Allow no display name when parsing measure arguments (measure argument does not have setDisplayName)
+* Parse measure display name, description, modeler description, and argument units
+* Add basic validation that prints to the terminal
+* Upgrade spec and ci reporter
+* New branch for development (develop)
+
+## Version 0.5.5
+* Read as binary for .tar.gz
+* When downloading and parsing measures, skip instance where the measure class name is already the directory name.
+
+## Version 0.5.2-4
+* Remove libxml dependency
+* Add OpenStudio static measure parsing method
+* Add translate to CSV from static measures to support OpenStudio-analysis spreadsheet
+* Fix Group ID
+* Pull UUID out of tar.gz files
+* More testing around measures and components API
+* Rubocop
+
+## Version 0.5.1
+* Fix bug when parsing BCL measures and nil arguments
+
+## Version 0.5.0
+* Remove support for Ruby 1.8.7.  Only supporting > 1.9.2
+* Remove JSON gem. Using multi_json
+* Removed obsolete tests
+* Removed RestClient in favor of Faraday (used for testing)
+
+## Version 0.4.1
+* Several fixes to previous gem
+* Put required gems into the gemspec
+
+### New Features
+* Able to specify the group_id when you create the component methods
+* Added parsing of BCL measures for extracting arguments
+
+## Version 0.3.7
+
+### New Features
+* Added a search for measures that returns the JSON
+* Added the ability to download a component (measure or component). Result returns the file data that needes to be persisted.
+
+## Version 0.1.7
+
+### New Features
+* Added rspec for testing
+* Made a datatype method in BCL class to resolve the appropriate values per BCL convention (i.e. int, float, string)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,27 @@
+OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted 
+provided that the following conditions are met:
+
+(1) Redistributions of source code must retain the above copyright notice, this list of conditions 
+and the following disclaimer.
+
+(2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions
+and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+(3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse 
+or promote products derived from this software without specific prior written permission from the 
+respective party.
+
+(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other 
+derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar 
+designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED 
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES GOVERNMENT, 
+OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
+OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,40 @@
+# BCL Gem
+
+All the methods to build, test, and release the gem available as rake tasks via bundler/gem_tasks. Note that you can see all the rake tasks by calling `rake -T` at the command line.
+
+## Building BCL Gem
+
+If this is a new version that will be release first edit the ./lib/bcl/version.rb file and increment the version number.  This will automatically propagate through the build process.
+
+`rake build`
+
+To install:
+
+`rake install`
+
+## Releasing Gem
+
+Note: Releasing the gem will call the build command, tag it in Git, and push to rubygems.
+
+run `rake release`
+
+## Testing
+
+`rake spec`
+
+## Uninstall
+
+run `gem uninstall bcl -a`
+
+## Workflow for pushing content to BCL
+
+run `rake bcl:stage_and_upload[/path/to/content, resetFlag]`
+
+where `path/to/content` is a path to the directory of measures or components to upload and `resetFlag` is a boolean flag indicating whether to clear already staged content and receipt files (true), or to keep the staged content and receipt files (false).
+
+Staging and Uploading tasks can be called separately: 
+
+`rake bcl:stage_content[/path/to/content, resetFlag]`
+
+`rake bcl:upload_content[resetFlag]`
+

data/Rakefile

@@ -0,0 +1,347 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+require 'bundler'
+Bundler.setup
+
+require 'rake'
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+require 'pathname'
+
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
+require 'bcl'
+require 'bcl/version'
+
+RSpec::Core::RakeTask.new('spec') do |spec|
+  puts 'running tests...'
+  spec.rspec_opts = ['--format', 'progress']
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+namespace :test do
+  desc 'test search all functionality'
+  task :search_all do
+    # search with all=true
+    # ensure that a) results are returned (> 0) and b) [:measure][:name] is a string
+    # search with all=false
+    # ensure the same a) and b) as above
+    bcl = BCL::ComponentMethods.new
+    bcl.login
+    results = bcl.search('Add', 'show_rows=10', false)
+    puts "there are #{results[:result].count} results"
+    results[:result].each do |res|
+      puts (res[:measure][:name]).to_s
+    end
+  end
+
+  desc 'test measure upload'
+  task :measure_upload do
+    bcl = BCL::ComponentMethods.new
+    bcl.login
+    filename = "#{File.dirname(__FILE__)}/spec/api/resources/measure_original.tar.gz"
+    valid, res = bcl.push_content(filename, false, 'nrel_measure')
+  end
+
+  desc 'test the BCL login credentials defined in .bcl/config.yml'
+  task :bcl_login do
+    bcl = BCL::ComponentMethods.new
+    bcl.login
+  end
+
+  desc 'test component spreadsheet'
+  task :spreadsheet do
+    bclcomponents = BCL::ComponentFromSpreadsheet.new(File.expand_path('lib/files/Components.xls', __dir__), ['Roofing'])
+    bclcomponents.save(File.expand_path('lib/files/staged', __dir__))
+  end
+
+  desc 'test measure download'
+  task :measure_download do
+    # find a component with keyword 'Ashrae'
+    query = 'ashrae'
+    filter = 'fq[]=bundle:nrel_component&show_rows=3'
+
+    bcl = BCL::ComponentMethods.new
+    bcl.login
+
+    results = bcl.search(query, filter)
+    uids = []
+    results[:result].each do |result|
+      uids << result[:component][:uuid]
+    end
+
+    content = bcl.download_component(uids[0])
+
+    # save as tar.gz
+    download_path = File.expand_path('lib/files/downloads', __dir__)
+    FileUtils.mkdir(download_path) if !File.exist? download_path
+    f = File.open("#{download_path}/#{uids[0]}.tar.gz", 'wb')
+    f.write(content)
+  end
+end
+
+namespace :bcl do
+  STAGED_PATH = Pathname.new(Dir.pwd + '/staged')
+
+  # initialize BCL and login
+  bcl = BCL::ComponentMethods.new
+  bcl.login
+
+  # to call: rake "bcl:stage_and_upload[/path/to/your/content/directory, true]"
+  # content_path arg: path to components or measures to upload
+  # reset flag:
+  # If TRUE: content in the staged directory will be re-generated and receipt files will be deleted.
+  # If FALSE, content that already exists in the staged directory will remain and content with receipt files will not be re-uploaded.
+  desc 'stage and push/update all content in a repo'
+  task :stage_and_upload, [:content_path, :reset] do |t, args|
+    options = { reset: false }
+    options[:content_path] = Pathname.new args[:content_path]
+    if args[:reset].to_s == 'true'
+      options[:reset] = true
+    end
+
+    current_dir = Dir.pwd
+
+    # stage content
+    Rake.application.invoke_task("bcl:stage_content[#{options[:content_path]}, #{options[:reset]}]")
+    Dir.chdir(current_dir)
+
+    # upload (new and updated). pass in skip flag
+    Rake.application.invoke_task("bcl:upload_content[#{options[:reset]}]")
+  end
+
+  # to call: rake "bcl:upload_content[true]"
+  # TODO: catch errors and continue
+  desc 'upload/update BCL content'
+  task :upload_content, [:reset] do |t, args|
+    # process options
+    options = { reset: false }
+    if args[:reset].to_s == 'true'
+      options[:reset] = true
+    end
+
+    total_count = 0
+    successes = 0
+    errors = 0
+    skipped = 0
+
+    # grab all the new measure and component tar files and push to bcl
+    ['measure', 'component'].each do |content_type|
+      items = []
+      paths = Pathname.glob(STAGED_PATH.to_s + "/push/#{content_type}/*.tar.gz")
+      paths.each do |path|
+        # puts path
+        items << path.to_s
+      end
+
+      items.each do |item|
+        puts item.split('/').last
+        total_count += 1
+
+        receipt_file = File.dirname(item) + '/' + File.basename(item, '.tar.gz') + '.receipt'
+        if !options[:reset] && File.exist?(receipt_file)
+          skipped += 1
+          puts 'SKIP: receipt file found'
+          next
+        end
+
+        valid, res = bcl.push_content(item, true, "nrel_#{content_type}")
+        if valid
+          successes += 1
+        else
+          errors += 1
+          if res.key?(:error)
+            puts "  ERROR MESSAGE: #{res[:error]}"
+          else
+            puts "ERROR: #{res.inspect.chomp}"
+          end
+        end
+        puts '', '---'
+      end
+    end
+
+    # grab all the updated content (measures and components) tar files and push to bcl
+    items = []
+    paths = Pathname.glob(STAGED_PATH.to_s + '/update/*.tar.gz')
+    paths.each do |path|
+      # puts path
+      items << path.to_s
+    end
+    items.each do |item|
+      puts item.split('/').last
+      total_count += 1
+
+      receipt_file = File.dirname(item) + '/' + File.basename(item, '.tar.gz') + '.receipt'
+      if !options[:reset] && File.exist?(receipt_file)
+        skipped += 1
+        puts 'SKIP: receipt file found'
+        next
+      end
+
+      valid, res = bcl.update_content(item, true)
+      if valid
+        successes += 1
+      else
+        errors += 1
+        if res.key?(:error)
+          puts "  ERROR MESSAGE: #{res[:error]}"
+        else
+          puts "ERROR MESSAGE: #{res.inspect.chomp}"
+        end
+      end
+      puts '', '---'
+    end
+
+    puts "****UPLOAD DONE**** #{total_count} total, #{successes} success, #{errors} failures, #{skipped} skipped"
+  end
+
+  # to call: rake "bcl:stage_content[/path/to/your/content/directory, true]"
+  desc 'stage content for BCL'
+  task :stage_content, [:content_path, :reset] do |t, args|
+    # process options
+    options = { reset: false }
+    options[:content_path] = Pathname.new args[:content_path]
+    if args[:reset].to_s == 'true'
+      options[:reset] = true
+    end
+    puts "OPTIONS -- content_path: #{options[:content_path]}, reset: #{options[:reset]}"
+
+    FileUtils.mkdir_p(STAGED_PATH)
+
+    # delete existing tarballs if reset is true
+    if options[:reset]
+      FileUtils.rm_rf(Dir.glob("#{STAGED_PATH}/*"))
+    end
+
+    # create new and existing directories
+    FileUtils.mkdir_p(STAGED_PATH.to_s + '/update')
+    FileUtils.mkdir_p(STAGED_PATH.to_s + '/push/component')
+    FileUtils.mkdir_p(STAGED_PATH.to_s + '/push/measure')
+
+    # keep track of noop, update, push
+    noops = 0
+    new_ones = 0
+    updates = 0
+
+    # get all content directories to process
+    dirs = Dir.glob("#{options[:content_path]}/*")
+
+    dirs.each do |dir|
+      next if dir.include?('Rakefile')
+
+      current_d = Dir.pwd
+      content_name = File.basename(dir)
+      puts '', '---'
+      puts "Generating #{content_name}"
+
+      Dir.chdir(dir)
+
+      # figure out whether to upload new or update existing
+      files = Pathname.glob('**/*')
+      uuid = nil
+      vid = nil
+      content_type = 'measure'
+
+      paths = []
+      files.each do |file|
+        # don't tar tests/outputs directory
+        next if file.to_s.start_with?('tests/output') # From measure testing process
+        next if file.to_s.start_with?('tests/test') # From openstudio-measure-tester-gem
+        next if file.to_s.start_with?('tests/coverage') # From openstudio-measure-tester-gem
+        next if file.to_s.start_with?('test_results') # From openstudio-measure-tester-gem
+
+        paths << file.to_s
+        if file.to_s =~ /^.{0,2}component.xml$/ || file.to_s =~ /^.{0,2}measure.xml$/
+          if file.to_s.match?(/^.{0,2}component.xml$/)
+            content_type = 'component'
+          end
+          # extract uuid  and vid
+          uuid, vid = bcl.uuid_vid_from_xml(file)
+        end
+      end
+      puts "UUID: #{uuid}, VID: #{vid}"
+
+      # note: if uuid is missing, will assume new content
+      action = bcl.search_by_uuid(uuid, vid)
+      puts "#{content_name} ACTION TO TAKE: #{action}"
+      # new content functionality needs to know if measure or component.  update is agnostic.
+      if action == 'noop' # ignore up-to-date content
+        puts "  - WARNING: local #{content_name} uuid and vid match BCL... no update will be performed"
+        noops += 1
+        next
+      elsif action == 'update'
+        # puts "#{content_name} labeled as update for BCL"
+        destination = STAGED_PATH.join(action, "#{content_name}.tar.gz")
+        updates += 1
+      elsif action == 'push'
+        # puts "#{content_name} labeled as new content for BCL"
+        destination = STAGED_PATH.join(action, content_type, "#{content_name}.tar.gz")
+        new_ones += 1
+      end
+
+      puts "destination: #{destination}"
+
+      # copy over only if 'reset_receipts' is set to TRUE. otherwise ignore if file exists already
+      if File.exist?(destination)
+        if options[:reset]
+          FileUtils.rm(destination)
+          BCL.tarball(destination, paths)
+        else
+          puts "*** WARNING: File #{content_name}.tar.gz already exists in staged directory... keeping existing file. To overwrite, set reset_receipts arg to true ***"
+        end
+      else
+        BCL.tarball(destination, paths)
+      end
+      Dir.chdir(current_d)
+    end
+    puts '', "****STAGING DONE**** #{new_ones} new content, #{updates} updates, #{noops} skipped (already up-to-date on BCL)", ''
+  end
+end
+
+require 'rubocop/rake_task'
+desc 'Run RuboCop on the lib directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  # only show the files with failures
+  task.options = ['--no-color', '--out=rubocop-results.xml']
+  task.formatters = ['RuboCop::Formatter::CheckstyleFormatter']
+  task.requires = ['rubocop/formatter/checkstyle_formatter']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end
+
+desc 'Default task run rspec tests'
+task test: :spec
+task default: :spec