esmdl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef6848bd1b390edc24b2fb8fe9d9ede3b53750f3
+  data.tar.gz: 8e2a91d269e4cb268e6470be2e7acf733d446496
+SHA512:
+  metadata.gz: 8312249a1952205d8b4cf77da5c182d1b7d97924c03873a114dfa0340bcc837c0d39464f7052fda08de5a81f3340411ad46d3e451719ced6ca72f95a91805be9
+  data.tar.gz: 7d8807c8f082470454f9037d91986486ca3bbf6b8d25b1af97cfe761f4de728b991583840532276626e6e873e28effb8227d6ee454fd24cf6197fae741fc6660

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in esmdl.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# esmdl
+
+esmdl is a Ruby gem that provides a command line interface that replicates (some of) the release download functionality of Ellucian Solutions Manager. It is not authored or supported by Ellucian and does not provide any of the installation of provisioning functionality of ESM.
+
+It is intended to be used by licensed ellucian customers to download available releases without requiring the installation of ESM.
+
+## Installation
+
+Install is simply:    
+
+```
+$ gem install esmdl
+```
+
+## Configuration
+
+The only required configuration parameters are the `username` and `password` of an Ellucian Download Center account. This can either be supplied in the file `~/.esmdl`:
+```yaml
+username: "myusername"
+password: "!s3cr3t*"
+```
+or via the command line arguments `--username` and `--password`. The other available configuration values are `esmversion` (defaults to 1.7), `stage_dir` (defaults to './'), and `base_url`. Command line parameters override any parameters from `~/.esmdl`.
+
+## Usage
+Downloading a release, associated documentation, and ESM installation metadata:
+```
+$ esmdl get --name=general-admin-9020020u.trz --docs --metadata
+Starting download of general-admin-9020020u.trz...done! (201.44 MiB)
+Starting download of general-admin-9020020d.trz...done! (1.35 MiB)
+Starting download of general-admin-9020020u.zip...done! (2.66 KiB)
+```
+
+Finding available releases is done through the `list` subcommand.
+
+Listing available licensed products:
+```
+$ esmdl list products
+BMUI: BMUI Banner Multi Upgrade Installer
+BNR_ADMCOM: Banner Admin Common
+BNR_ADV: Banner Advancement
+...
+```
+
+Filtering that list:
+```
+$ esmdl list products --filter=student
+BNR_STU: Banner Student
+BNR_STUSS: Banner Student Self-Service
+BXE_ETRANS: Banner Student eTranscript
+...
+```
+
+Listing available releases for a given product:
+```
+$ esmdl list releases --product=BNR_STU
+Banner Student Upgrade 8.5.5 (stu80505u.trz) - BNR_STU -2012-11-15
+Banner Student Upgrade 8.5.6 (stu80506u.trz) - BNR_STU -2013-02-15
+Banner Student Upgrade 8.5.7 (stu80507u.trz) - BNR_STU -2013-05-31
+...
+```
+
+Or by filter:
+```
+$ esmdl list releases --filter=admin
+Banner Admin Document Management 9.2.0.18 (extsol-admin-9020018u.trz) - BNR_DMS -2016-03-14
+Banner Admin Finance 9.2.0.18 (finance-admin-9020018u.trz) - BNR_FIN -2016-03-14
+Banner Admin Position Control 9.2.0.18 (posnctl-admin-9020018u.trz) - BNR_POSCTL -2016-03-14
+Banner Admin Human Resources 9.2.0.18 (payroll-admin-9020018u.trz) - BNR_HRPAY -2016-03-15
+...
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ian-d/esmdl.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "esmdl"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+ESMDl.config
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/esmdl

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+require 'thor'
+require 'esmdl'
+require 'date'
+require 'yaml'
+
+module ESMRunner
+  class << self
+    def configure(options)
+      if File.exists?("#{Dir.home}/.esmdl") then
+        options = YAML.load(IO.read("#{Dir.home}/.esmdl")).merge options
+      end
+
+      options = options.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      unless options[:password] && options[:username]
+        puts "ERROR: Couldn't find .esmdl file and --username/--password not passed."
+        exit
+      end
+
+      ESMDl.configure do |config|
+        config.username = options[:username]
+        config.password = options[:password]
+        config.stage_dir = options[:stage_dir]
+        config.base_url = options[:base_url]
+        config.esmversion = options[:esmversion]
+      end
+
+      begin
+        ESMDl.fetch_metadata
+      rescue Exception => e
+        puts "There was an error fetching the ESM metadata. Double check your username and password?"
+        puts e.message
+        exit
+      end
+    end
+  end
+
+  class List < Thor
+    desc 'products', 'List licensed products and categories.'
+    option :filter, default: '.*', desc: 'A regex to apply to product names.'
+    def products
+      ESMRunner.configure parent_options
+      ESMDl.products.each do |k, v|
+        puts "#{k}: #{v}" if v =~ /#{options[:filter]}/i
+      end
+    end
+
+    desc 'releases', 'List available releases.'
+    option :product, desc: 'The product name (BNR_ADVSS, BXE_STUAPI, etc) to list.'
+    option :filter, default: '.', desc: 'A regex to apply to release names.'
+    def releases
+      ESMRunner.configure parent_options
+      rel_list = []
+      ESMDl.releases.each do |r|
+        rel_list << r if r['productId'] == options[:product] || options[:product].nil?
+      end
+      rel_list.keep_if{ |x| x['name'] =~ /#{options[:filter]}/i || x['rlsArtifactsFile'] =~ /#{options[:filter]}/i}
+      rel_list.sort! { |l, r| DateTime.parse(l['rlsDate']) <=> DateTime.parse(r['rlsDate']) }
+      rel_list.each do |r|
+        puts "#{r['name']} (#{r['rlsArtifactsFile']}) - #{r['productId']} -#{DateTime.parse(r['rlsDate']).to_date}"
+      end
+    end
+
+    desc 'info', 'List information about a single release.'
+    option :name, required: true, desc: 'The patch archive name (ex: twb80600u.trz, student-overall-90400u.trz).'
+    def info
+      ESMRunner.configure parent_options
+      rel = ESMDl.releases.find { |x| x['rlsArtifactsFile'] == options[:name] }
+      if !rel.nil?
+        say rel['name'], :green
+        puts "Product: #{rel['productId']}"
+        puts "Version: #{rel['version']}"
+        puts "Status: #{rel['status']}"
+        puts "Release Date: #{DateTime.parse(rel['rlsDate']).to_date}"
+        puts "Has Docs: #{rel['rlsDocFile'] != ''}"
+      else
+        say 'Could not find a release by that name.', :yellow
+      end
+    end
+  end
+
+  class ESMCli < Thor
+    default_task :help
+
+    class_option :username, type: :string
+    class_option :password, type: :string
+    class_option :stage_dir, type: :string, default: './'
+    class_option :base_url, type: :string, default: 'https://esmsvc.ellucian.com:8443'
+    class_option :esmversion, type: :string, default: '1.7'
+    #class_option :verbose, type: :boolean, default: false
+
+    desc 'list [products, releases, info]', 'list products, releases, or single release info'
+    subcommand 'list', List
+
+    desc 'get', 'Download patches, documentation, and release artifacts.'
+    option :name, required: true, desc: 'The patch archive name to download (ex: twb80600u.trz, student-overall-90400u.trz).'
+    option :docs, type: :boolean, default: true, desc: 'Download documentation if available.'
+    option :metadata, type: :boolean, default: false, desc: 'Download ESM installation metadata.'
+    def get
+      ESMRunner.configure options
+      rel = ESMDl.releases.find { |x| x['rlsArtifactsFile'] == options[:name] }
+      if !rel.nil? then
+        ESMDl::Download.new(rel, options[:docs], options[:metadata])
+      else
+        say 'Could not find a release by that name.', :yellow
+      end
+    end
+  end
+end
+
+ESMRunner::ESMCli.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/esmdl.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'esmdl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "esmdl"
+  spec.version       = Esmdl::VERSION
+  spec.authors       = ["Ian Dillon"]
+  spec.email         = ["dillon@etsu.edu"]
+
+  spec.description   = %q{A simplified CLI interface for the download functionality of Ellucian Solution Manager}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/ian-d/esmdl"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = ["esmdl"]
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor", ">= 0.19.1"
+  spec.add_runtime_dependency "ruby-progressbar", ">= 1.8.1"
+  spec.add_runtime_dependency "filesize", ">= 0.1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/esmdl/configuration.rb

@@ -0,0 +1,18 @@
+module ESMDl
+  class Configuration
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :stage_dir
+    attr_accessor :base_url
+    attr_accessor :verbosity
+    attr_accessor :esmversion
+
+    def initialize
+      @verbosity = :normal
+    end
+
+    def stage_dir=(dir)
+      @stage_dir = "#{dir}/" unless dir.end_with? '/'
+    end
+  end
+end

data/lib/esmdl/download.rb

@@ -0,0 +1,43 @@
+require 'net/http'
+require 'uri'
+require 'filesize'
+
+module ESMDl
+  class Download
+    def initialize(release, with_doc = true, with_metadata = false)
+      @release = release
+      fetch download_url(@release['rlsArtifactsPath'], @release['rlsArtifactsFile']), @release['rlsArtifactsFile']
+      fetch download_url(@release['rlsDocPath'], @release['rlsDocFile']), @release['rlsDocFile'] if with_doc
+      fetch download_url(@release['rlsMetadataPath'], @release['rlsMetadataFile']), @release['rlsMetadataFile'] if with_metadata
+    end
+
+    def download_url(filepath, filename)
+      url = "#{ESMDl.config.base_url}/releaseservices/Release?"
+      url << "login=#{ESMDl.config.username}&"
+      url << "productid=#{@release['productId']}&"
+      url << "rlsversion=#{@release['version']}&"
+      url << "esmversion=#{ESMDl.config.esmversion}&"
+      url << "filepath=#{URI.encode(filepath)}&"
+      url << "filename=#{filename}&"
+    end
+
+    def fetch(url, filename)
+      uri = URI(url)
+      full_path = "#{ESMDl.config.stage_dir}#{filename}"
+      print "Starting download of #{full_path}..."
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        request = Net::HTTP::Get.new uri.request_uri
+        request.basic_auth ESMDl.config.username, ESMDl.config.password
+        http.request request do |response|
+          open full_path, 'w' do |io|
+            response.read_body do |chunk|
+              io.write chunk
+            end
+          end
+        end
+      end
+      filesize = File::size(full_path)
+      puts "done! (#{ Filesize.from("#{filesize} B").pretty})"
+    end
+  end
+end

data/lib/esmdl/version.rb

@@ -0,0 +1,3 @@
+module Esmdl
+  VERSION = "0.1.0"
+end

data/lib/esmdl.rb

@@ -0,0 +1,50 @@
+require 'json'
+require 'net/http'
+require 'esmdl/version'
+require 'esmdl/configuration'
+require 'esmdl/download'
+
+module ESMDl
+  class << self
+    attr_accessor :config
+    attr_accessor :products
+    attr_accessor :releases
+    attr_accessor :prodmap
+    attr_accessor :esmversion
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+
+  def self.fetch_metadata
+    uri = URI(config.base_url + "/releaseservices/AvailableReleases?esmversion=#{config.esmversion}")
+    r = nil
+
+    Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+      request = Net::HTTP::Get.new uri.request_uri
+      request.basic_auth config.username, config.password
+      response = http.request request
+      if response.code != '200'
+        raise "Problem fetching ESM metadata: #{response.body}"
+      end
+      r = JSON.parse(response.body)
+    end
+    @products = {}
+    @codemap = {}
+    r['prodCodeMap'].split("\n").each do |line|
+      a = line.split(',')
+      @codemap[a[1]] = a[2]
+    end
+
+    r['clientLicensedProducts'].sort.each do |p|
+      @products[p] = @codemap[p]
+    end
+
+    @releases = r['available']
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: esmdl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ian Dillon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: filesize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A simplified CLI interface for the download functionality of Ellucian
+  Solution Manager
+email:
+- dillon@etsu.edu
+executables:
+- esmdl
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/esmdl
+- bin/setup
+- esmdl.gemspec
+- lib/esmdl.rb
+- lib/esmdl/configuration.rb
+- lib/esmdl/download.rb
+- lib/esmdl/version.rb
+homepage: https://github.com/ian-d/esmdl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A simplified CLI interface for the download functionality of Ellucian Solution
+  Manager
+test_files: []