rptman 0.0.1

data/CHANGELOG

@@ -0,0 +1,2 @@
+0.0.1 (Pending)
+* Initial Release

data/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.rdoc

@@ -0,0 +1,105 @@
+= rptman
+
+This is a command line tool and suite of rake tasks for uploading SSRS
+reports to a server. The tool can also generate project files for
+the "SQL Server Business Intelligence Development Studio". 
+
+== Installation
+
+The extension is packaged as a jruby gem named "rptman", consult the ruby
+gems installation steps but typically it is
+
+  jgem install rptman
+
+== Basic Overview
+
+Reports are stored in sub-directories of a <report-dir>. The filename
+of the report must end with ".rdl". The directory hierarchy on the local
+file system is mirrored on the SSRS server during an upload. So if a file
+exists with the name
+
+  <report-dir>/IRIS/Coordination/Tour Of Duty Report.rdl
+
+It will be uploaded to the SSRS server with the path
+
+  /IRIS/Coordination/Tour Of Duty Report
+
+Every top level directory on the local filesystem that includes a report
+file is deleted when it during the upload process. So in the above scenario
+the /IRIS directory on SSRS server is delted prior to uploading the
+directory. It is assumed that every report in a particular hierarhcy is
+stored in one location.
+
+The tool can also create data source definitions and these are placed in a
+directory named "/DataSources".
+
+The gem supports prefixing all paths with when uploading to the SSRS server.
+It is possible to prefix all reports managed by this tool with /Auto so as
+to distinguish them from reports uploaded through other means. If multiple
+people are working of the same SSRS instance it is also possible to decorate
+the prefix with a username or environment. (i.e. /Auto/PD42/DEV)
+
+The configuration data for determing which SSRS instance and prefix to use
+is in a yaml file with a format described below. The easiest way to use the
+tool is to create a ruby script such as the following;
+
+  gem 'rptman'
+
+  # The configuration file
+  SSRS::Config.config_filename = "database.yml"
+
+  # The directory in which the reports are stored
+  SSRS::Config.reports_dir = "reports"
+
+  # Define a data source named IRIS_CENTRAL that has
+  # configration data stored under the key 'central'
+  SSRS::Config.define_datasource('IRIS_CENTRAL','central')
+
+  # actually run the tool
+  SSRS::Shell.run
+
+The script can then be run with a -h parameter to see the various options. 
+
+== Configuration Format
+
+The configuration is stored in a yaml file. The configuration file format
+allows for multiple "environments" (a.k.a. configuration) in one file. Most
+configuration files will have "development" and "production" envioronments.
+There must be one section for each SQL Server or SSRS instance. Each section
+is named "<key>_<environment>" where the key for SSRS servers is "ssrs". The
+key for SQL Server instances must correspond to the key specified in the
+invocation of "SSRS::Config.define_datasource(<name>,<key>)" above.
+
+The SSRS server must specify the report_target and prefix keys. The SQL Server
+instances must specify the database and host keys and may optionally specify
+the username, password and isntance keys. If username and password are not
+specified then integrated security is used.
+
+Here is an example configuration file:
+
+  ssrs_development:
+    report_target: http://ssrs-dev.example.com/SSRS01_WS
+    prefix: /Auto/PD42/DEV
+
+  central_development:
+    database: PD42_IRIS_CENTRAL_DEV
+    username: MyUsername
+    password: MyPassword
+    host: sqlserver-dev.example.com
+    instance: myinstance
+
+  ssrs_production:
+    report_target: http://ssrs.example.com/SSRS01_WS
+    prefix: /Auto
+
+  central_production:
+    database: IRIS_CENTRAL
+    username: MyUsername
+    password: MyPassword
+    host: sqlserver.example.com
+    instance: myinstance
+
+== Credit
+
+The gem was initially developed as by StockSoftware for use in the Department
+of Sustainability and Environment, Victoria, Australia.

data/lib/rptman.rb

@@ -0,0 +1,14 @@
+require 'erb'
+require 'yaml'
+require 'optparse'
+
+require "#{File.dirname(__FILE__)}/ssrs/ssrs-api.jar"
+require "#{File.dirname(__FILE__)}/ssrs/UUID.rb"
+require "#{File.dirname(__FILE__)}/ssrs/config.rb"
+require "#{File.dirname(__FILE__)}/ssrs/ssrs.rb"
+require "#{File.dirname(__FILE__)}/ssrs/datasource.rb"
+require "#{File.dirname(__FILE__)}/ssrs/report_project.rb"
+require "#{File.dirname(__FILE__)}/ssrs/report.rb"
+require "#{File.dirname(__FILE__)}/ssrs/uploader.rb"
+require "#{File.dirname(__FILE__)}/ssrs/bids.rb"
+require "#{File.dirname(__FILE__)}/ssrs/shell.rb"

data/lib/ssrs/UUID.rb

@@ -0,0 +1,326 @@
+#!/usr/bin/env ruby
+# Copyright(c) 2005 URABE, Shyouhei.
+#
+# Permission is hereby granted, free of  charge, to any person obtaining a copy
+# of  this code, to  deal in  the code  without restriction,  including without
+# limitation  the rights  to  use, copy,  modify,  merge, publish,  distribute,
+# sublicense, and/or sell copies of the code, and to permit persons to whom the
+# code 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 code.
+#
+# THE  CODE 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
+# AUTHOR  OR  COPYRIGHT  HOLDER 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 CODE OR THE  USE OR OTHER  DEALINGS IN THE
+# CODE.
+
+%w[
+	digest/md5
+	digest/sha1
+	socket
+	tmpdir
+].each do |f|
+	require f
+end
+
+module SSRS
+# Pure ruby UUID generator, which is compatible with RFC4122
+UUID = Struct.new "UUID", :raw_bytes
+class UUID
+	private_class_method :new
+
+	class << self
+		def mask str # :nodoc
+			v = str[7]
+			v = v & 0b00001111
+			v = v | 0b01010000
+			str[7] = v
+			r = str[8]
+			r = r & 0b00111111
+			r = r | 0b10000000
+			str[8] = r
+			str
+		end
+		private :mask
+
+		# UUID generation using SHA1. Recommended over create_md5.
+		# Namespace object is another UUID, some of them are pre-defined below.
+		def create_sha1 str, namespace
+			sha1 = Digest::SHA1.new
+			sha1.update namespace.raw_bytes
+			sha1.update str
+			sum = sha1.digest
+			raw = mask sum[0..15]
+			ret = new raw
+			ret.raw_bytes.freeze
+			ret.freeze
+			ret
+		end
+
+		# UUID generation using MD5 (for backward compat.)
+		def create_md5 str, namespace
+			md5 = Digest::MD5.new
+			md5.update namespace.raw_bytes
+			md5.update str
+			sum = md5.digest
+			raw = mask sum[0..16]
+			ret = new raw
+			ret.raw_bytes.freeze
+			ret.freeze
+			ret
+		end
+
+		# UUID  generation  using  random-number  generator.   From  it's  random
+		# nature, there's  no warranty that  the created ID is  really universaly
+		# unique.
+		def create_random
+			rnd = [
+				rand(0x100000000),
+				rand(0x100000000),
+				rand(0x100000000),
+				rand(0x100000000),
+			].pack "N4"
+			raw = mask rnd
+			ret = new raw
+			ret.raw_bytes.freeze
+			ret.freeze
+			ret
+		end
+
+		def read_state fp			  # :nodoc:
+			fp.rewind
+			Marshal.load fp.read
+		end
+
+		def write_state fp, c, m  # :nodoc:
+			fp.rewind
+			str = Marshal.dump [c, m]
+			fp.write str
+		end
+
+		private :read_state, :write_state
+		STATE_FILE = 'ruby-uuid'
+
+		# create  the "version  1" UUID  with current  system clock,  current UTC
+		# timestamp, and the IEEE 802 address (so-called MAC address).
+		#
+		# Speed notice: it's slow.  It writes  some data into hard drive on every
+		# invokation. If you want to speed  this up, try remounting tmpdir with a
+		# memory based filesystem  (such as tmpfs).  STILL slow?  then no way but
+		# rewrite it with c :)
+		def create( clock=nil, time=nil, mac_addr=nil )
+			c = t = m = nil
+			Dir.chdir Dir.tmpdir do
+				unless FileTest.exist? STATE_FILE then
+					# Generate a pseudo MAC address because we have no pure-ruby way
+					# to know  the MAC  address of the  NIC this system  uses.  Note
+					# that cheating  with pseudo arresses here  is completely legal:
+					# see Section 4.5 of RFC4122 for details.
+					sha1 = Digest::SHA1.new
+					256.times do
+						r = [rand(0x100000000)].pack "N"
+						sha1.update r
+					end
+					str = sha1.digest
+					r = rand 34 # 40-6
+					node = str[r, 6] || str
+					node[0] |= 0x01 # multicast bit
+					k = rand 0x40000
+					open STATE_FILE, 'wb' do |fp|
+						fp.flock IO::LOCK_EX
+						write_state fp, k, node
+						fp.chmod 0o777 # must be world writable
+					end
+				end
+				open STATE_FILE, 'r+b' do |fp|
+					fp.flock IO::LOCK_EX
+					c, m = read_state fp
+					c = clock % 0x4000 if clock
+					m = mac_addr if mac_addr
+					t = time
+					if t.nil? then
+						# UUID epoch is 1582/Oct/15
+						tt = Time.now
+						t = tt.to_i*10000000 + tt.tv_usec*10 + 0x01B21DD213814000
+					end
+					c = c.succ # important; increment here
+					write_state fp, c, m
+				end
+			end
+
+			tl = t & 0xFFFF_FFFF
+			tm = t >> 32
+			tm = tm & 0xFFFF
+			th = t >> 48
+			th = th & 0x0FFF
+			th = th | 0x1000
+			cl = c & 0xFF
+			ch = c & 0x3F00
+			ch = ch >> 8
+			ch = ch | 0x80
+			pack tl, tm, th, cl, ch, m
+		end
+
+		# A  simple GUID  parser:  just ignores  unknown  characters and  convert
+		# hexadecimal dump into 16-octet object.
+		def parse obj
+			str = obj.to_s.sub %r/\Aurn:uuid:/, ''
+			str.gsub! %r/[^0-9A-Fa-f]/, ''
+			raw = str[0..31].to_a.pack 'H*'
+			ret = new raw
+			ret.raw_bytes.freeze
+			ret.freeze
+			ret
+		end
+
+		# The 'primitive constructor' of this class
+		# Note UUID.pack(uuid.unpack) == uuid
+		def pack tl, tm, th, ch, cl, n
+			raw = [tl, tm, th, ch, cl, n].pack "NnnCCa6"
+			ret = new raw
+			ret.raw_bytes.freeze
+			ret.freeze
+			ret
+		end
+	end
+
+	# The 'primitive deconstructor', or the dual to pack.
+	# Note UUID.pack(uuid.unpack) == uuid
+	def unpack
+		raw_bytes.unpack "NnnCCa6"
+	end
+
+	# Generate the string representation (a.k.a GUID) of this UUID
+	def to_s
+		a = unpack
+		tmp = a[-1].unpack 'C*'
+		a[-1] = sprintf '%02x%02x%02x%02x%02x%02x', *tmp
+		"%08x-%04x-%04x-%02x%02x-%s" % a
+	end
+	alias guid to_s
+
+	# Convert into a RFC4122-comforming URN representation
+	def to_uri
+		"urn:uuid:" + self.to_s
+	end
+	alias urn to_uri
+
+	# Convert into 128-bit unsigned integer
+	# Typically a Bignum instance, but can be a Fixnum.
+	def to_int
+		tmp = self.raw_bytes.unpack "C*"
+		tmp.inject do |r, i|
+			r * 256 | i
+		end
+	end
+	alias to_i to_int
+
+	# Two  UUIDs  are  said  to  be  equal if  and  only  if  their  (byte-order
+	# canonicalized) integer representations are equivallent.  Refer RFC4122 for
+	# details.
+	def == other
+		to_i == other.to_i
+	end
+
+	include Comparable
+	# UUIDs are comparable (don't know what benefits are there, though).
+	def <=> other
+		to_s <=> other.to_s
+	end
+
+	# Pre-defined UUID Namespaces described in RFC4122 Appendix C.
+	NameSpace_DNS = parse "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
+	NameSpace_URL = parse "6ba7b811-9dad-11d1-80b4-00c04fd430c8"
+	NameSpace_OID = parse "6ba7b812-9dad-11d1-80b4-00c04fd430c8"
+	NameSpace_X500 = parse "6ba7b814-9dad-11d1-80b4-00c04fd430c8"
+
+	# The Nil UUID in RFC4122 Section 4.1.7
+	Nil = parse "00000000-0000-0000-0000-000000000000"
+end
+
+if __FILE__ == $0 then
+	require 'test/unit'
+
+	class TC_UUID < Test::Unit::TestCase
+		def test_v1
+			u1 = UUID.create
+			u2 = UUID.create
+			assert_not_equal u1, u2
+		end
+
+		def test_v1_repeatability
+			u1 = UUID.create 1, 2, "345678"
+			u2 = UUID.create 1, 2, "345678"
+			assert_equal u1, u2
+		end
+
+		def test_v3
+			u1 = UUID.create_md5 "foo", UUID::NameSpace_DNS
+			u2 = UUID.create_md5 "foo", UUID::NameSpace_DNS
+			u3 = UUID.create_md5 "foo", UUID::NameSpace_URL
+			assert_equal u1, u2
+			assert_not_equal u1, u3
+		end
+
+		def test_v5
+			u1 = UUID.create_sha1 "foo", UUID::NameSpace_DNS
+			u2 = UUID.create_sha1 "foo", UUID::NameSpace_DNS
+			u3 = UUID.create_sha1 "foo", UUID::NameSpace_URL
+			assert_equal u1, u2
+			assert_not_equal u1, u3
+		end
+
+		def test_v4
+			# This test  is not  perfect, because the  random nature of  version 4
+			# UUID  it is  not always  true that  the three  objects  below really
+			# differ.  But  in real  life it's  enough to say  we're OK  when this
+			# passes.
+			u1 = UUID.create_random
+			u2 = UUID.create_random
+			u3 = UUID.create_random
+			assert_not_equal u1.raw_bytes, u2.raw_bytes
+			assert_not_equal u1.raw_bytes, u3.raw_bytes
+			assert_not_equal u2.raw_bytes, u3.raw_bytes
+		end
+
+		def test_pack
+			u1 = UUID.pack 0x6ba7b810, 0x9dad, 0x11d1, 0x80, 0xb4,
+			               "\000\300O\3240\310"
+			assert_equal UUID::NameSpace_DNS, u1
+		end
+
+		def test_unpack
+			tl, tm, th, cl, ch, m = UUID::NameSpace_DNS.unpack
+			assert_equal 0x6ba7b810, tl
+			assert_equal 0x9dad, tm
+			assert_equal 0x11d1, th
+			assert_equal 0x80, cl
+			assert_equal 0xb4, ch
+			assert_equal "\000\300O\3240\310", m
+		end
+
+		def test_parse
+			u1 = UUID.pack 0x6ba7b810, 0x9dad, 0x11d1, 0x80, 0xb4,
+			               "\000\300O\3240\310"
+			u2 = UUID.parse "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
+			u3 = UUID.parse "urn:uuid:6ba7b810-9dad-11d1-80b4-00c04fd430c8"
+			assert_equal u1, u2
+			assert_equal u1, u3
+		end
+
+		def test_to_s
+			u1 = UUID.parse "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
+			assert_equal "6ba7b810-9dad-11d1-80b4-00c04fd430c8", u1.to_s
+		end
+
+		def test_to_i
+			u1 = UUID.parse "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
+			assert_equal 0x6ba7b8109dad11d180b400c04fd430c8, u1.to_i
+		end
+	end
+end
+end

data/lib/ssrs/bids.rb

@@ -0,0 +1,35 @@
+module SSRS
+  # Generator for "SQL Server Business Intelligence Development Studio" projects
+  class BIDS
+    def self.generate
+      self.generate_data_sources
+      self.generate_project_files
+    end
+
+    private
+    
+    def self.generate_project_files
+      SSRS::Config.upload_dirs.each do |upload_dir|
+        SSRS.info("Generating Project for #{upload_dir}")
+        actual_dir = File.expand_path("#{SSRS::Config.reports_dir}/#{upload_dir}")
+        filename = File.expand_path("#{SSRS::Config.projects_dir}/#{upload_dir[1,upload_dir.size].gsub('/', '_')}.rptproj")
+        project = SSRS::ReportProject.new(upload_dir, filename, actual_dir)
+        File.open(filename, 'w') do |f|
+          project.write(f)
+        end
+      end
+    end
+
+    def self.generate_data_sources
+      FileUtils.rm_rf SSRS::Config.projects_dir
+      FileUtils.mkdir_p SSRS::Config.projects_dir
+      SSRS::Config.datasources.each do |ds|
+        filename = "#{SSRS::Config.projects_dir}/#{ds.name}.rds"
+        SSRS.info("Generating DataSource #{ds.name}")
+        File.open(filename, 'w') do |f|
+          ds.write(f)
+        end
+      end
+    end
+  end
+end

data/lib/ssrs/config.rb

@@ -0,0 +1,139 @@
+module SSRS
+  class Config
+    class Server
+      attr_reader :report_target
+      attr_reader :upload_prefix
+
+      def initialize(report_target, upload_prefix)
+        @report_target = report_target
+        @upload_prefix = upload_prefix
+      end
+    end
+
+    class << self
+      attr_writer :environment
+
+      def environment
+        return 'development' unless @environment
+        @environment
+      end
+
+      # config_file is where the yaml config file is located
+      attr_writer :config_filename
+
+      def config_filename
+        raise "config_filename not specified" unless @config_filename
+        @config_filename
+      end
+
+      # reports_dir is where the report hierarchy is located
+      attr_writer :reports_dir
+
+      def reports_dir
+        raise "reports_dir not specified" unless @reports_dir
+        @reports_dir
+      end
+
+      # projects_dir is where the VS projects are generated
+      attr_writer :projects_dir
+
+      def projects_dir
+        return "#{self.reports_dir}/projects" unless @projects_dir
+        return @projects_dir
+      end
+
+      def datasources
+        datasources_map.values
+      end
+
+      def define_datasource(name, database_key)
+        data_source = SSRS::DataSource.new(name)
+        configure_datasource(data_source, database_key)
+        datasources_map[name] = data_source
+      end
+
+      def reports
+        unless @reports
+          @reports = Dir.glob("#{self.reports_dir}/**/*.rdl").collect do |filename|
+            SSRS::Report.new(upload_path(filename), filename)
+          end
+        end
+        return @reports
+      end
+
+      # Return list of dirs uploaded
+      def upload_dirs
+        self.reports.collect {|report| File.dirname(report.name)}.sort.uniq
+      end
+
+      def upload_prefix
+        current_ssrs_config.upload_prefix
+      end
+
+      def wsdl_path
+        "#{report_target}/ReportService2005.asmx"
+      end
+
+      def report_target
+        current_ssrs_config.report_target
+      end
+
+      def server_config(env_key)
+        load_ssrs_config(env_key)
+      end
+
+      private
+      
+      def upload_path(filename)
+        symbolic_path = filename.gsub(Regexp.escape(reports_dir), '')
+        return "#{File.dirname(symbolic_path)}/#{File.basename(symbolic_path,'.rdl')}"
+      end
+
+      def current_ssrs_config
+        @server ||= load_ssrs_config(environment)
+      end
+
+      def load_ssrs_config(env_key)
+        config_key = "ssrs_#{env_key}"
+        config = config_for_key(config_key)
+        report_target = expect_config_element(config_key, config, 'report_target').to_s
+        upload_prefix = expect_config_element(config_key, config, 'prefix').to_s
+        SSRS::Config::Server.new(report_target, upload_prefix)
+      end
+
+      def configure_datasource(data_source, database_key)
+        config_key = "#{database_key}_#{environment}"
+        config = config_for_key(config_key)
+
+        data_source.host = expect_config_element(config_key, config, 'host')
+        data_source.database = expect_config_element(config_key, config, 'database')
+        data_source.instance = config['instance']
+        data_source.username = config['username']
+        data_source.password = config['password']
+      end
+
+      def expect_config_element(config_key, config, element_key)
+        raise "Missing #{element_key} for #{config_key} database config" unless config[element_key]
+        config[element_key]
+      end
+
+      def config_for_key(config_key)
+        c = config_data[config_key]
+        raise "Missing configuration #{config_key} in #{self.config_filename}" unless c
+        c
+      end
+
+      def config_data
+        unless @config_data
+          raise "Unable to locate config file #{self.config_filename}" unless File.exist?(self.config_filename)
+          @config_data = ::YAML::load(ERB.new(IO.read(self.config_filename)).result)
+        end
+        @config_data
+      end
+
+      def datasources_map
+        @datasources ||= {}
+      end
+    end
+  end
+end

data/lib/ssrs/datasource.rb

@@ -0,0 +1,41 @@
+module SSRS
+  class DataSource
+    BASE_PATH = 'DataSources'
+    attr_accessor :name, :host, :instance, :database, :datasource_id, :username, :password
+
+    def initialize(name)
+      self.name = name
+      self.datasource_id = SSRS::UUID.create.to_s
+    end
+
+    def host_spec
+      "#{self.host}#{self.instance.nil? ? '' : '\\'}#{self.instance}"
+    end
+
+    def symbolic_name
+      "#{DataSource::BASE_PATH}/#{self.name}"
+    end
+
+    def connection_string
+      auth_details = unless ( self.username || self.password )
+        'Integrated Security=SSPI'
+      else
+        "User Id=#{self.username};Password=#{self.password}"
+      end
+      "Data Source=#{self.host_spec};Initial Catalog=#{self.database};#{auth_details};"
+    end
+
+    def write(file)
+      file.write <<XML
+<RptDataSource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <Name>#{self.name}</Name>
+  <ConnectionProperties>
+    <Extension>SQL</Extension>
+    <ConnectString>#{connection_string}</ConnectString>
+  </ConnectionProperties>
+  <DataSourceID>#{self.datasource_id}</DataSourceID>
+</RptDataSource>
+XML
+    end
+  end  
+end

data/lib/ssrs/report.rb

@@ -0,0 +1,35 @@
+module SSRS
+  class Report
+    attr_reader :name
+    attr_reader :filename
+
+    def initialize(name, filename)
+      @name, @filename = name, filename
+    end
+
+    def generate_upload_version
+      require 'tempfile'
+      file = Tempfile.new("ssrs_report")
+      xformed_document.write file
+      xformed_filename = file.path
+      file.close
+      xformed_filename
+    end
+
+    protected
+
+    def xformed_document
+      document = self.document
+      REXML::XPath.each(document.root, "//Report/DataSources/DataSource/DataSourceReference") do |element|
+        text_node = element.get_text
+        text_node.value = "#{SSRS::Config.upload_prefix}/#{DataSource::BASE_PATH}/#{text_node.value}"
+      end
+      document
+    end
+
+    def document
+      require 'rexml/document'
+      REXML::Document.new(File.read(self.filename))
+    end
+  end
+end

data/lib/ssrs/report_project.rb

@@ -0,0 +1,83 @@
+module SSRS
+  class ReportProject
+    attr_reader :name
+    attr_accessor :project_filename
+    attr_accessor :dir
+
+    def initialize(name, project_filename, dir)
+      @name, @project_filename, @dir = name, project_filename, dir
+    end
+
+    def write(file)
+      file.write <<XML
+<?xml version="1.0" encoding="utf-8"?>
+<Project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <State>$base64$PFNvdXJjZUNvbnRyb2xJbmZvIHhtbG5zOnhzZD0iaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEiIHhtbG5zOnhzaT0iaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEtaW5zdGFuY2UiIHhtbG5zOmRkbDI9Imh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vYW5hbHlzaXNzZXJ2aWNlcy8yMDAzL2VuZ2luZS8yIiB4bWxuczpkZGwyXzI9Imh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vYW5hbHlzaXNzZXJ2aWNlcy8yMDAzL2VuZ2luZS8yLzIiIHhtbG5zOmRkbDEwMF8xMDA9Imh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vYW5hbHlzaXNzZXJ2aWNlcy8yMDA4L2VuZ2luZS8xMDAvMTAwIiB4bWxuczpkd2Q9Imh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vRGF0YVdhcmVob3VzZS9EZXNpZ25lci8xLjAiPg0KICA8RW5hYmxlZD5mYWxzZTwvRW5hYmxlZD4NCiAgPFByb2plY3ROYW1lPjwvUHJvamVjdE5hbWU+DQogIDxBdXhQYXRoPjwvQXV4UGF0aD4NCiAgPExvY2FsUGF0aD48L0xvY2FsUGF0aD4NCiAgPFByb3ZpZGVyPjwvUHJvdmlkZXI+DQo8L1NvdXJjZUNvbnRyb2xJbmZvPg==</State>
+  <DataSources>
+XML
+      SSRS::Config.datasources.each do |ds|
+        file.write <<XML
+    <ProjectItem>
+      <Name>#{ds.name}.rds</Name>
+      <FullPath>#{ds.name}.rds</FullPath>
+    </ProjectItem>
+XML
+      end
+      file.write <<XML
+  </DataSources>
+  <Reports>
+XML
+
+      Dir["#{self.dir}/*.rdl"].each do |f|
+        file.write <<XML
+    <ProjectItem>
+      <Name>#{File.basename(f)}</Name>
+      <FullPath>#{relativepath(File.expand_path(f), project_filename)}</FullPath>
+    </ProjectItem>
+XML
+      end
+
+      file.write <<XML
+  </Reports>
+  <Configurations>
+XML
+      development = SSRS::Config.server_config("development")
+      file.write gen_configuration("Debug", development)
+      file.write gen_configuration("DebugLocal", development)
+      production = SSRS::Config.server_config("production") rescue nil
+      file.write gen_configuration("Release", production) if production
+      file.write <<XML
+  </Configurations>
+</Project>
+XML
+    end
+
+    private
+
+    def gen_configuration(name, server_config)
+      <<XML
+    <Configuration>
+      <Name>#{name}</Name>
+      <Platform>Win32</Platform>
+      <Options>
+        <TargetServerURL>#{server_config.report_target}</TargetServerURL>
+        <TargetFolder>#{server_config.upload_prefix}#{self.name}</TargetFolder>
+        <TargetDataSourceFolder>#{server_config.upload_prefix}/#{DataSource::BASE_PATH}</TargetDataSourceFolder>
+      </Options>
+    </Configuration>
+XML
+    end
+
+    # Convert the given absolute path into a path
+    # relative to the second given absolute path.
+    def relativepath(abspath, relativeto)
+      path = abspath.split(File::SEPARATOR)
+      rel = relativeto.split(File::SEPARATOR)
+      while (path.length > 0) && (path.first == rel.first)
+        path.shift
+        rel.shift
+      end
+      ('..' + File::SEPARATOR) * (rel.length - 1) + path.join(File::SEPARATOR)
+    end
+  end
+end

data/lib/ssrs/shell.rb

@@ -0,0 +1,77 @@
+module SSRS
+  # Generator for "SQL Server Business Intelligence Development Studio" projects
+  class Shell
+    class << self
+      attr_writer :generate_projects
+
+      def generate_projects?
+        @generate_projects ||= false
+      end
+
+      attr_writer :upload_reports
+
+      def upload_reports?
+        @upload_reports ||= false
+      end
+    end
+
+    def self.run
+      parse_args
+      banner
+      SSRS::BIDS.generate if generate_projects?
+      SSRS::Uploader.upload if upload_reports?
+    end
+
+    private
+
+    def self.banner
+      SSRS.info("Rptman:")
+      SSRS.info("\tEnvironment: #{SSRS::Config.environment}")
+      SSRS.info("\tDataSource Count: #{SSRS::Config.datasources.size}")
+      SSRS.info("\tReport Count: #{SSRS::Config.reports.size}")
+      SSRS.info("\tReport Dir Count: #{SSRS::Config.upload_dirs.size}")
+      SSRS.info("\tUpload Prefix: #{SSRS::Config.upload_prefix}")
+      SSRS.info("\tReport Target: #{SSRS::Config.report_target}")
+      SSRS.info("")
+      if !generate_projects? && !upload_reports?
+        SSRS.info("Run with -h for help")
+      end
+    end
+
+    def self.parse_args
+      SSRS::Config.environment = "development"
+
+      optparse = OptionParser.new do |opts|
+        opts.on('-v', '--verbose', 'Output more information') do
+          Java::IrisSSRS::SSRS.setupLogger(true)
+        end
+
+        opts.on('-e', '--environment environment', 'Database environment to use') do |environment|
+          SSRS::Config.environment = environment
+        end
+
+        opts.on('-u', '--upload', 'Upload the reports') do
+          SSRS::Shell.upload_reports = true
+        end
+
+        opts.on('-p', '--generate-projects', 'Generate the Buisness Intelligence Studio projects') do
+          SSRS::Shell.generate_projects = true
+        end
+
+        # This displays the help screen, all programs are
+        # assumed to have this option.
+        opts.on('-h', '--help', 'Display this screen') do
+          puts opts
+          exit
+        end
+      end
+
+      # Parse the command-line. Remember there are two forms
+      # of the parse method. The 'parse' method simply parses
+      # ARGV, while the 'parse!' method parses ARGV and removes
+      # any options found there, as well as any parameters for
+      # the options. What's left is the list of files to resize.
+      optparse.parse!
+    end
+  end
+end

data/lib/ssrs/ssrs.rb

@@ -0,0 +1,6 @@
+module SSRS
+  def self.info(message)
+    Java::IrisSSRS::SSRS.info(message)
+  end
+end
+Java::IrisSSRS::SSRS.setupLogger(false)

data/lib/ssrs/uploader.rb

@@ -0,0 +1,32 @@
+module SSRS
+  class Uploader
+    def self.upload
+      ssrs_soap_port = Java::IrisSSRS::SSRS.new(Java::JavaNet.URL.new(SSRS::Config.wsdl_path),
+                                                SSRS::Config.upload_prefix)
+      self.upload_datasources(ssrs_soap_port)
+      self.upload_reports(ssrs_soap_port)
+    end
+
+    private
+
+    def self.upload_datasources(ssrs_soap_port)
+      ssrs_soap_port.mkdir(SSRS::DataSource::BASE_PATH)
+      SSRS::Config.datasources.each do |ds|
+        ssrs_soap_port.delete(ds.symbolic_name)
+        ssrs_soap_port.createSQLDataSource(ds.symbolic_name, ds.connection_string)
+      end
+    end
+
+    def self.upload_reports(ssrs_soap_port)
+      top_level_upload_dirs =
+        SSRS::Config.upload_dirs.collect { |d| d.split('/').delete_if { |p| p == "" }.first }.sort.uniq
+      top_level_upload_dirs.each do |upload_dir|
+        ssrs_soap_port.delete(upload_dir)
+      end
+      SSRS::Config.reports.each do |report|
+        ssrs_soap_port.mkdir(File.dirname(report.name))
+        ssrs_soap_port.createReport(report.name, Java::JavaIo.File.new(report.generate_upload_version))
+      end
+    end
+  end
+end

data/lib/tasks/rptman.rake

@@ -0,0 +1,20 @@
+namespace :rptman do
+  namespace :vs_projects do
+    desc "Generate MS VS projects for each report dir"
+    task :generate do
+      SSRS::BIDS.generate
+    end
+
+    desc "Clean generated projects"
+    task :clean do
+      rm_rf SSRS::Config.projects_dir
+    end
+  end
+
+  namespace :ssrs do
+    desc "Upload reports to SSRS server"
+    task :upload do
+      SSRS::Uploader.upload
+    end
+  end
+end

data/rptman.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |spec|
+  spec.name           = 'rptman'
+  spec.version        = `git describe`.strip.split('-').first
+  spec.authors        = ['Peter Donald']
+  spec.email          = ["peter@realityforge.org"]
+
+  spec.homepage       = "http://github.com/stocksoftware/rptman"
+  spec.summary        = "Tool for managing SSRS reports"
+  spec.description    = <<-TEXT
+This is a command line tool and suite of rake tasks for uploading SSRS
+reports to a server. The tool can also generate project files for
+the "SQL Server Business Intelligence Development Studio".
+  TEXT
+  spec.files          = Dir['{lib}/**/*', '*.gemspec'] +
+                        ['lib/ssrs/ssrs-api.jar','LICENSE', 'README.rdoc', 'CHANGELOG']
+  spec.require_paths  = ['lib']
+  spec.platform       = RUBY_PLATFORM[/java/]
+
+  spec.has_rdoc         = false
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: rptman
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Peter Donald
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-26 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: |
+  This is a command line tool and suite of rake tasks for uploading SSRS
+  reports to a server. The tool can also generate project files for
+  the "SQL Server Business Intelligence Development Studio".
+
+email: 
+- peter@realityforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ssrs/shell.rb
+- lib/ssrs/UUID.rb
+- lib/ssrs/uploader.rb
+- lib/ssrs/report.rb
+- lib/ssrs/config.rb
+- lib/ssrs/bids.rb
+- lib/ssrs/ssrs.rb
+- lib/ssrs/datasource.rb
+- lib/ssrs/report_project.rb
+- lib/tasks/rptman.rake
+- lib/rptman.rb
+- rptman.gemspec
+- lib/ssrs/ssrs-api.jar
+- LICENSE
+- README.rdoc
+- CHANGELOG
+has_rdoc: true
+homepage: http://github.com/stocksoftware/rptman
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Tool for managing SSRS reports
+test_files: []
+