otrs-sopm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78bda8a22d27837f5706a037bc78689de95df4ce
+  data.tar.gz: 1029dfe6aeeb0365b907d1d8e718e09e4c096647
+SHA512:
+  metadata.gz: d894536784216d54aed4390ba707de4b768c574f28b4e8a5e3679bee93e542b835e8bb9d9a168da19e421f763ecd4e34e1cdc6748f2b71816d5dea669b2a5cdb
+  data.tar.gz: bb44d77729b3e1d0d56e4646244f662fe09efcc4eaa8b4062c0f98601de76179685e3244c59173b002d608050ae398cda2f75387736bbfc08dc157b18c19701d

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,179 @@
+# Default enabled cops
+# https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
+
+Metrics/LineLength:
+  Description: 'Limit lines to 80 characters.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#80-character-limits'
+  Enabled: false
+
+Style/NegatedIf:
+  Description: >-
+                 Favor unless over if for negative conditions
+                 (or control flow or).
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#unless-for-negatives'
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Description: >-
+                 Favor modifier if/unless usage when you have a
+                 single-line body.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier'
+  Enabled: false
+
+Style/TrailingComma:
+  Description: 'Checks for trailing comma in parameter lists and literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: false
+
+Style/SpaceInsideParens:
+  Description: 'No spaces after ( or before ).'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-spaces-braces'
+  Enabled: false
+
+Style/SpaceAfterMethodName:
+  Description: >-
+                 Do not put a space between a method name and the opening
+                 parenthesis in a method definition.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-no-spaces'
+  Enabled: false
+
+Style/SingleSpaceBeforeFirstArg:
+  Description: >-
+                 Checks that exactly one space is used between a method name
+                 and the first argument for method calls without parentheses.
+  Enabled: false
+
+Style/LeadingCommentSpace:
+  Description: 'Comments should start with a space.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#hash-space'
+  Enabled: false
+
+Style/MethodCallParentheses:
+  Description: 'Do not use parentheses for method calls with no arguments.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-args-no-parens'
+  Enabled: false
+
+Style/SpaceInsideBrackets:
+  Description: 'No spaces after [ or before ].'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-spaces-braces'
+  Enabled: false
+
+Style/DefWithParentheses:
+  Description: 'Use def with parentheses when there are arguments.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#method-parens'
+  Enabled: false
+Style/MethodDefParentheses:
+  Description: >-
+                 Checks if the method definitions have or don't have
+                 parentheses.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#method-parens'
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Description: "Keeps track of empty lines around class bodies."
+  Enabled: false
+
+Style/EmptyLinesAroundMethodBody:
+  Description: "Keeps track of empty lines around method bodies."
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Description: "Keeps track of empty lines around block bodies."
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Description: "Keeps track of empty lines around module bodies."
+  Enabled: false
+
+Style/BlockDelimiters:
+  Description: >-
+                Avoid using {...} for multi-line blocks (multiline chaining is
+                always ugly).
+                Prefer {...} over do...end for single-line blocks.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#single-line-blocks'
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Description: 'Avoid multi-line chains of blocks.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#single-line-blocks'
+  Enabled: false
+
+Metrics/ClassLength:
+  Description: 'Avoid classes longer than 100 lines of code.'
+  Enabled: false
+
+Metrics/MethodLength:
+  Description: 'Avoid methods longer than 10 lines of code.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#short-methods'
+  Enabled: false
+
+Style/BlockComments:
+  Description: 'Do not use block comments.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-block-comments'
+  Enabled: false
+
+Style/PerlBackrefs:
+  Description: 'Avoid Perl-style regex back references.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers'
+  Enabled: false
+
+Style/SelfAssignment:
+  Description: >-
+                 Checks for places where self-assignment shorthand should have
+                 been used.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#self-assignment'
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Description: 'Enforce braces style around hash parameters.'
+  Enabled: false
+
+Rails/FindEach:
+  Description: 'Prefer all.find_each over all.find.'
+  Enabled: false
+
+Rails/HasAndBelongsToMany:
+  Description: 'Prefer has_many :through to has_and_belongs_to_many.'
+#  StyleGuide: 'https://github.com/bbatsov/rails-style-guide#has-many-through'
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Description: 'Checks style of children classes and modules.'
+  Enabled: false
+
+Style/FileName:
+  Description: 'Use snake_case for source file names.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#snake-case-files'
+  Enabled: true
+  Exclude:
+    - 'script/websocket-server.rb'
+
+
+# 2.0 - feel free :)
+
+Metrics/PerceivedComplexity:
+  Description: >-
+                 A complexity metric geared towards measuring complexity for a
+                 human reader.
+  Enabled: false
+
+Metrics/AbcSize:
+  Description: >-
+                 A calculated magnitude based on number of assignments,
+                 branches, and conditions.
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Description: >-
+                 A complexity metric that is strongly correlated to the number
+                 of test cases needed to validate a method.
+  Enabled: false
+
+Metrics/BlockNesting:
+  Description: 'Avoid excessive block nesting'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#three-is-the-number-thou-shalt-count'
+  Enabled: false
+
+Metrics/ModuleLength:
+  Description: 'Avoid modules longer than 100 lines of code.'
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at te@znuny.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in otrs-sopm.gemspec
+gemspec
+
+gem 'nokogiri'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Thorsten Eckel
+
+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,107 @@
+# OTRS::SOPM
+
+This gem provides a class to parse, manipulate and store SOPM files and create OPM strings from them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'otrs-sopm'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install otrs-sopm
+
+## Usage
+
+First create an instance via passing the location to the .sopm file.
+
+```ruby
+sopm = OTRS::SOPM.new 'path/to/Znuny4OTRS-Package.sopm'
+```
+
+### Create version
+
+A new version can be created via passing the wanted version number and a changelog:
+
+```ruby
+sopm_hash_structure = sopm.version('1.0.1', 'Created first bug fix.')
+```
+
+### Add build information
+
+It's recommended to add the build host and build date to the OPM file. Give the build host as a parameter with to add the build information via:
+
+```ruby
+sopm_hash_structure = sopm.add_build_information('http://build.host.tld')
+```
+
+### Add file
+
+To add additional files to the "FileList" structure of the (S)OPM file call this method with the path and an optional permission integer (default is 644):
+
+```ruby
+sopm_hash_structure = sopm.add_file('path/to/File.pm')
+
+# equals
+
+sopm_hash_structure = sopm.add_file('path/to/File.pm', 664)
+```
+
+### Store changes
+
+In case you want to store the changes you have made to the original SOPM file call this method:
+
+```ruby
+sopm_hash_structure = sopm.store
+```
+
+### Parse SOPM file
+
+In limited cases it might necessary to re-parse the SOPM file again. Do this with:
+
+```ruby
+sopm_hash_structure = sopm.parse
+```
+
+### Get OPM string
+
+After all changes are made you might want to create a OPM file. To receive the OPM XML string with Base64 encoded files call this method:
+
+```ruby
+opm_xml_string = sopm.opm
+```
+
+## Planned and wanted features
+
+Feel free to implement one of those or any other:
+
+* Accept filehandle as constructor parameter.
+* Accept SOPM content string as constructor parameter.
+* Write OPM file instead of only returning the string.
+* Manipulate all the other attributes.
+* Create SOPM file from a Hash structure.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Tests
+
+The tests are currently in an external project since there is business logic in them. In future releases this tests will be added to this gem repository as it should be.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/znuny/otrs-sopm. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'otrs/sopm'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.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/lib/otrs/sopm.rb

@@ -0,0 +1,379 @@
+require 'nokogiri'
+require 'base64'
+require 'otrs/sopm/version'
+
+# General OTRS class, for later/other purposes maybe. Should handle more OTRS related stuff
+class OTRS
+  # Handles all SOPM and OPM related stuff
+  class SOPM
+
+    attr_reader :sopm
+    attr_reader :structure
+
+    # Creates an instance based on a given SOPM file path.
+    #
+    # @param sopm_file [String] the path to the SOPM file.
+    # @return (see #parse)
+    def initialize(sopm_file)
+
+      @sopm_file = sopm_file
+
+      sopm_read_handle = File.open(@sopm_file)
+      @sopm            = Nokogiri::XML(sopm_read_handle)
+      sopm_read_handle.close
+
+      parse
+    end
+
+    # Adds a new version and the changelog to the SOPM file.
+    #
+    # @param version [String] the version number.
+    # @param change_log [String] the changelog.
+    # @return (see #parse)
+    def version(version, change_log)
+
+      # change Version
+      @sopm.xpath('/otrs_package/Version').children[0].content = version
+
+      # append ChangeLog
+      change_log_nodes = @sopm.xpath('/otrs_package/ChangeLog')
+      if change_log_nodes.length == 0
+        change_log_nodes = @sopm.xpath('/otrs_package/Framework')
+      end
+
+      # remove tabs from ChangeLog
+      change_log.gsub!(/\t/, '  ')
+
+      # strip whitespaces
+      change_log.strip!
+
+      new_change_log_entry            = Nokogiri::XML::Node.new 'ChangeLog', sopm
+      new_change_log_entry['Version'] = version
+      new_change_log_entry['Date']    = Time.zone.now
+      new_change_log_entry.content    = change_log
+
+      change_log_nodes.first.previous = new_change_log_entry.to_xml + "\n    "
+
+      store
+    end
+
+    # Adds the buildhost and builddate to the SOPM file.
+    #
+    # @param build_host [String] build host on which the OPM file was created.
+    # @return (see #parse)
+    def add_build_information(build_host)
+
+      # add BuildHost
+      if @sopm.xpath('/otrs_package/BuildHost').children.length == 0
+
+        new_build_host_entry                                 = Nokogiri::XML::Node.new 'BuildHost', sopm
+        new_build_host_entry.content                         = build_host
+        @sopm.xpath('/otrs_package/Filelist').first.previous = new_build_host_entry.to_xml + "\n    "
+      else
+        @sopm.xpath('/otrs_package/BuildHost').children[0].content = build_host
+      end
+
+      # add BuildDate
+      if @sopm.xpath('/otrs_package/BuildDate').children.length == 0
+
+        new_build_date_entry                                 = Nokogiri::XML::Node.new 'BuildDate', sopm
+        new_build_date_entry.content                         = Time.zone.now
+        @sopm.xpath('/otrs_package/Filelist').first.previous = new_build_date_entry.to_xml + "\n    "
+      else
+        @sopm.xpath('/otrs_package/BuildDate').children[0].content = Time.zone.now
+      end
+
+      store
+    end
+
+    # Adds a new file to the filelist of the SOPM file.
+    #
+    # @param location [String] the file location.
+    # @param permission [Integer] the permissions with which the files should get created.
+    # @return (see #parse)
+    def add_file( location, permission = 644 )
+
+      files_nodes = @sopm.xpath('/otrs_package/Filelist/File')
+
+      update = true
+      files_nodes.each { |files_node|
+
+        next if files_node['Location'] != location
+        next if files_node['Permission'] != permission
+
+        update = false
+
+        break
+      }
+
+      return if !update
+
+      # append Filelist/File
+      new_file_entry               = Nokogiri::XML::Node.new 'File', sopm
+      new_file_entry['Permission'] = permission
+      new_file_entry['Location']   = location
+
+      files_nodes.last.next = "\n        " + new_file_entry.to_xml
+
+      store
+    end
+
+    # Stores the changes to the SOPM file.
+    #
+    # @return (see #parse)
+    def store
+
+      File.open(@sopm_file, 'w') { |file|
+        file.write( @sopm.to_xml )
+      }
+
+      parse
+    end
+
+    # Parses the given SOPM file.
+    #
+    # @return [Hash] the parsed SOPM structure.
+    def parse
+
+      @structure = {}
+
+      # Name
+      @structure['name'] = @sopm.xpath('/otrs_package/Name').children[0].content
+
+      # Version
+      @structure['version'] = @sopm.xpath('/otrs_package/Version').children[0].content
+
+      # Vendor
+      @structure['vendor'] = @sopm.xpath('/otrs_package/Vendor').children[0].content
+
+      # License
+      @structure['license'] = @sopm.xpath('/otrs_package/License').children[0].content
+
+      # URL
+      # TODO: Remove! URL should be required
+      if @sopm.xpath('/otrs_package/URL').children.length > 0
+        @structure['url'] = @sopm.xpath('/otrs_package/URL').children[0].content
+      end
+
+      # BuildDate
+      if @sopm.xpath('/otrs_package/BuildDate').children.length > 0
+        @structure['build_date'] = @sopm.xpath('/otrs_package/BuildDate').children[0].content
+      end
+
+      # BuildHost
+      if @sopm.xpath('/otrs_package/BuildHost').children.length > 0
+        @structure['build_host'] = @sopm.xpath('/otrs_package/BuildHost').children[0].content
+      end
+
+      # PackageIs* blocks (optional)
+      %w(Visible Downloadable Removable).each { |is_type|
+
+        next if @sopm.xpath('/otrs_package/PackageIs' + is_type).children.length == 0
+
+        flag = @sopm.xpath('/otrs_package/PackageIs' + is_type).children[0].content
+
+        is_type.downcase!
+
+        @structure['package_is_' + is_type] = flag == '1' ? true : false
+      }
+
+      # ChangeLog (optional)
+      change_log_nodes = @sopm.xpath('/otrs_package/ChangeLog')
+      if change_log_nodes.length > 0
+        @structure['change_log'] = []
+        change_log_nodes.each { |change_log_node|
+
+          change_log_entry            = {}
+          change_log_entry['version'] = change_log_node['Version']
+          change_log_entry['date']    = change_log_node['Date']
+          change_log_entry['log']     = change_log_node.children[0].content
+
+          @structure['change_log'].push change_log_entry
+        }
+      end
+
+      # OS (optional)
+      os_nodes = @sopm.xpath('/otrs_package/OS')
+      if os_nodes.length > 0
+        @structure['os'] = []
+        os_nodes.each { |os_node|
+
+          @structure['os'].push os_node.children[0].content
+        }
+      end
+
+      # Framework
+      @structure['framework'] = []
+      framework_nodes = @sopm.xpath('/otrs_package/Framework')
+      framework_nodes.each { |framework_node|
+        @structure['framework'].push framework_node.children[0].content
+      }
+
+      # PackageRequired (optional)
+      package_required_nodes = @sopm.xpath('/otrs_package/PackageRequired')
+      if package_required_nodes.length > 0
+        @structure['package_required'] = []
+        package_required_nodes.each { |package_required_node|
+
+          package_required_entry            = {}
+          package_required_entry['version'] = package_required_node['Version']
+          package_required_entry['name']    = package_required_node.children[0].content
+
+          @structure['package_required'].push package_required_entry
+        }
+      end
+
+      # ModuleRequired (optional)
+      module_required_nodes = @sopm.xpath('/otrs_package/ModuleRequired')
+      if module_required_nodes.length > 0
+        @structure['module_required'] = []
+        module_required_nodes.each { |module_required_node|
+
+          module_required_entry            = {}
+          module_required_entry['version'] = module_required_node['Version']
+          module_required_entry['name']    = module_required_node.children[0].content
+
+          @structure['module_required'].push module_required_entry
+        }
+      end
+
+      # Description
+      @structure['description'] = []
+      description_nodes = @sopm.xpath('/otrs_package/Description')
+      description_nodes.each { |description_node|
+
+        description_entry             = {}
+        description_entry['language'] = description_node['Lang']
+        description_entry['text']     = description_node.children[0].content
+
+        @structure['description'].push description_entry
+      }
+
+      # Filelist/File
+      @structure['files'] = []
+      files_nodes = @sopm.xpath('/otrs_package/Filelist/File')
+      files_nodes.each { |files_node|
+
+        files_entry               = {}
+        files_entry['permission'] = files_node['Permission']
+        files_entry['location']   = files_node['Location']
+
+        if files_node['Encode'] == 'Base64'
+          files_entry['content'] = Base64.decode64( files_node.children[0].content )
+        end
+
+        @structure['files'].push files_entry
+      }
+
+      # Code blocks (optional)
+      %w(Install Upgrade Reinstall Uninstall).each { |block_type|
+
+        code_block_nodes = @sopm.xpath('/otrs_package/Code' + block_type)
+
+        next if code_block_nodes.length == 0
+
+        # convert to lowercase
+        block_type.downcase!
+
+        @structure[ 'code_' + block_type ] = []
+        code_block_nodes.each { |code_block_node|
+
+          code_block_entry         = {}
+          code_block_entry['type'] = code_block_node['Type']
+          code_block_entry['code'] = code_block_node.children[0].content
+
+          # optional
+          if code_block_node['Version']
+            code_block_entry['version'] = code_block_node['Version']
+          end
+          if code_block_node['IfPackage']
+            code_block_entry['if_package'] = code_block_node['IfPackage']
+          end
+          if code_block_node['IfNotPackage']
+            code_block_entry['if_not_package'] = code_block_node['IfNotPackage']
+          end
+
+          @structure[ 'code_' + block_type ].push code_block_entry
+        }
+      }
+
+      # Intro blocks (optional)
+      %w(Install Upgrade Reinstall Uninstall).each { |block_type|
+
+        intro_block_nodes = @sopm.xpath('/otrs_package/Intro' + block_type)
+
+        next if intro_block_nodes.length == 0
+
+        # convert to lowercase
+        block_type.downcase!
+
+        @structure[ 'code_' + block_type ] = []
+        intro_block_nodes.each { |intro_block_node|
+
+          intro_block_entry          = {}
+          intro_block_entry['type']  = intro_block_node['Type']
+          intro_block_entry['intro'] = intro_block_node.children[0].content
+
+          # optional
+          if intro_block_node['Version']
+            intro_block_entry['version'] = intro_block_node['Version']
+          end
+          if intro_block_node['Lang']
+            intro_block_entry['language'] = intro_block_node['Lang']
+          end
+          if intro_block_node['Title']
+            intro_block_entry['title'] = intro_block_node['Title']
+          end
+          if intro_block_node['Format']
+            intro_block_entry['format'] = intro_block_node['Format']
+          end
+
+          @structure[ 'code_' + block_type ].push intro_block_entry
+        }
+      }
+
+      # Database blocks (optional)
+      %w(Install Upgrade Reinstall Uninstall).each { |block_type|
+
+        intro_block_nodes = @sopm.xpath('/otrs_package/Database' + block_type)
+
+        next if intro_block_nodes.length == 0
+
+        # convert to lowercase
+        block_type.downcase!
+
+        @structure[ 'database_' + block_type ] = []
+        intro_block_nodes.each { |intro_block_node|
+
+          @structure[ 'database_' + block_type ].push intro_block_node.children[0].content
+        }
+      }
+
+      @structure
+    end
+
+    # Creates an OPM string out of the SOPM file.
+    #
+    # @return [String] OPM XML content with Base64 encoded files.
+    def opm
+
+      opm = @sopm
+
+      folder = File.dirname(@sopm_file)
+
+      files_nodes = opm.xpath('/otrs_package/Filelist/File')
+      files_nodes.each { |files_node|
+
+        file_location = files_node['Location']
+        file          = File.open("#{folder}/#{file_location}", 'r')
+        file_content  = file.read
+        file.close
+
+        files_node['Encode'] = 'Base64'
+        files_node.content   = Base64.strict_encode64( file_content )
+      }
+
+      opm.to_xml
+    end
+  end
+end

data/lib/otrs/sopm/version.rb

@@ -0,0 +1,7 @@
+# General OTRS class, for later/other purposes maybe. Should handle more OTRS related stuff
+class OTRS
+  # Contains just the version number, bundler / gem default design
+  class SOPM
+    VERSION = '0.1.0'
+  end
+end

data/otrs-sopm.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'otrs/sopm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'otrs-sopm'
+  spec.version       = OTRS::SOPM::VERSION
+  spec.authors       = ['Thorsten Eckel']
+  spec.email         = ['thorsten.eckel@znuny.com']
+
+  spec.summary       = 'This gem provides a class to parse, manipulate and store SOPM files and create OPM strings from them.'
+  spec.homepage      = 'https://github.com/znuny/otrs-sopm'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: otrs-sopm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thorsten Eckel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- thorsten.eckel@znuny.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/otrs/sopm.rb
+- lib/otrs/sopm/version.rb
+- otrs-sopm.gemspec
+homepage: https://github.com/znuny/otrs-sopm
+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.4.8
+signing_key: 
+specification_version: 4
+summary: This gem provides a class to parse, manipulate and store SOPM files and create
+  OPM strings from them.
+test_files: []