keytechkit 0.3.16

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57f8b73f659fce78a663b2a6ce59c8e622a6a7044e9dd1cdbb322b9c5240788b
+  data.tar.gz: 96beee9a69d2aaa78730bf5a261ae2a6ef51902a4e2c90b7d79f791490626d86
+SHA512:
+  metadata.gz: 135869814f45a8cde8609cea21fa625896419e8815babce9e007e2193ad678bc3aa5d8683dd7fd2b721a8a4b169428c0da510be6f3c240d5718f4782709a8598
+  data.tar.gz: ce9812073272c2be48c19b0ea757ae91229ca9800c9263a58676d727013b1c0b5e81b5d67f9b5452cd95b83b19b12cdc2c45ff503a04ac7e4512884c129cc03b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,9 @@
+
+Rails:
+  Enabled: true
+
+Style/Encoding:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 99

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+bundler_args: --without deployment
+before_install: gem install bundler
+before_install: gem install rake

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in keytechKit.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,146 @@
+PATH
+  remote: .
+  specs:
+    keytechkit (0.3.15)
+      httparty (~> 0.16)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.1)
+      actionpack (= 5.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.1)
+      activesupport (= 5.2.1)
+      globalid (>= 0.3.6)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activestorage (5.2.1)
+      actionpack (= 5.2.1)
+      activerecord (= 5.2.1)
+      marcel (~> 0.3.1)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.2)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.1)
+    mimemagic (0.3.2)
+    mini_mime (1.0.1)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    nio4r (2.3.1)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.6)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.1)
+      actioncable (= 5.2.1)
+      actionmailer (= 5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      activemodel (= 5.2.1)
+      activerecord (= 5.2.1)
+      activestorage (= 5.2.1)
+      activesupport (= 5.2.1)
+      bundler (>= 1.3.0)
+      railties (= 5.2.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  keytechkit!
+  rails (~> 5.2)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Thorsten Claus
+
+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,60 @@
+
+[![Build Status](https://travis-ci.com/tclaus/keytechkit.gem.svg?branch=master)](https://travis-ci.com/tclaus/keytechkit.gem)
+
+
+# KeytechKit.gem
+
+This gem provides access to keytech Web API. keytech is the PLM / PDM Software from keytech Software GmbH. This gem is not supported by keytech Software GmbH.
+Reference implementation can be found on https://plmweb.de
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keytechKit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keytechKit
+
+## Use
+This gem is currently still under development. New functions will come up every week.
+Refactors will be also made on any time even on minor version change.
+To use this gem have a look in the /spec folder. Every function should be tested.
+You can grab code here and add this to you own projects.
+
+Documentation with code samples will come in the next days. 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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).
+
+## Test
+To start a test, run
+    $ bundle exec rspec spec
+
+Test often, let tests fail fast.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tclaus/keytechkit.gem.
+
+* Fork the project
+* run 'bundle'
+* run 'bundle exec rspec spec' for tests
+* make your changes
+* make tests
+* make a pull request
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "keytechKit"
+
+# 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(__FILE__)

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/keytechKit.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "keytechKit/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "keytechkit"
+  spec.version       = KeytechKit::VERSION
+  spec.author        = "Thorsten Claus"
+  spec.email         = ["thorstenclaus@web.de"]
+  spec.summary       = "keytechkit is a ruby gem to connect to the keytech Web API"
+  spec.homepage      = "https://claus-software.de"
+  spec.license       = "MIT"
+  spec.metadata      = { "source_code_uri" => "https://github.com/tclaus/keytechkit.gem" }
+  spec.required_ruby_version     = ">= 2.4.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rails", "~> 5.2"
+       
+  spec.add_dependency "httparty", "~> 0.16"
+end

data/lib/keytechKit/classes/classdefinition.rb

@@ -0,0 +1,38 @@
+require 'keytechKit/classes/subarea'
+
+module KeytechKit
+
+  class ClassDefinition
+    attr_accessor :classKey
+    attr_accessor :attributesList
+    attr_accessor :displayname
+    attr_accessor :availableSubareas
+    attr_accessor :hasNumberGenerator
+    attr_accessor :isActive
+    attr_accessor :Listers
+
+    def initialize(classData)
+      self.classKey = classData["ClassKey"]
+      self.displayname = classData["Displayname"]
+      self.attributesList = classData["AttributesList"]
+      self.availableSubareas = loadSubAreas(classData["AvailableSubAreas"])
+      self.attributesList = classData["AttributesList"]
+      self.hasNumberGenerator = classData["HasNumberGenerator"]
+      self.isActive = classData["IsActive"]
+      
+      # TODO: Attributeslist parsing
+
+    end
+
+private
+  def loadSubAreas(subareasResult)
+    subAreas  = Array.new
+    subareasResult.each do |subareaResult|
+      subArea = Subarea.new(subareaResult)
+      subAreas.push subArea
+    end
+    subAreas
+  end
+
+  end
+end

data/lib/keytechKit/classes/classes.rb

@@ -0,0 +1,47 @@
+require 'keytechKit/classes/classdefinition'
+
+module KeytechKit
+  class Classes
+    include HTTParty
+
+    def initialize(base_url, username, password)
+      self.class.base_uri(base_url)
+      @auth = { username: username, password: password }
+    end
+
+    def load(class_key, options = {})
+      # Returns a classclasses
+      parameter = { query: options }
+      parameter.merge!({ basic_auth: @auth })
+
+      response = self.class.get("/classes/#{class_key}", parameter)
+
+      if response.success?
+        # create a class
+        ClassDefinition.new(response)
+       else
+         raise response.response
+      end
+    end
+
+    def loadAllClasses
+      # Returns a classclasses
+      parameter = { basic_auth: @auth }
+
+      response = self.class.get("/classes", parameter)
+
+      if response.success?
+        # create a class
+        classListData = response["ClassConfigurationList"]
+        classDefinitions = Array.new
+        classListData.each do |classData|
+          classDefinitions.push ClassDefinition.new(classData)
+        end
+        classDefinitions
+       else
+         puts "Could not load a classlist #{response.response}"
+      end
+    end
+
+  end
+end

data/lib/keytechKit/classes/layout/control.rb

@@ -0,0 +1,35 @@
+module KeytechKit
+  class Control
+    attr_accessor :attributeAlignment
+    attr_accessor :attributeName
+    attr_accessor :controlType
+    attr_accessor :dataDictionaryID
+    attr_accessor :dataDictionaryType
+    attr_accessor :defaultValue
+    attr_accessor :displayname
+    attr_accessor :font
+    attr_accessor :isEditable
+    attr_accessor :isNullable
+    attr_accessor :name
+    attr_accessor :position
+    attr_accessor :sequence
+    attr_accessor :size
+
+    def initialize(data)
+      self.attributeAlignment = data["AttributeAlignment"]
+      self.attributeName = data["AttributeName"]
+      self.controlType = data["ControlType"]
+      self.dataDictionaryID = data["DataDictionaryID"]
+      self.dataDictionaryType = data["DataDictionaryType"]
+      self.defaultValue = data["DefaultValue"]
+      self.displayname = data["Displayname"]
+      self.font = data["Font"]
+      self.isEditable = data["IsEditable"]
+      self.isNullable = data["IsNullable"]
+      self.name = data["Name"]
+      self.position = data["Position"]
+      self.sequence = data["Sequence"]
+      self.size = data["Size"]
+    end
+  end
+end

data/lib/keytechKit/classes/layout/layout.rb

@@ -0,0 +1,22 @@
+
+require 'keytechKit/classes/layout/control'
+
+module KeytechKit
+  class Layout
+    attr_accessor :controls
+
+    def initialize(data)
+      parseControls(data["DesignerControls"])
+    end
+
+    private
+
+    def parseControls(data)
+      self.controls = Array.new
+      data.each do |controlData|
+        control = Control.new(controlData)
+        self.controls.push control
+      end
+    end
+  end
+end

data/lib/keytechKit/classes/layouts.rb

@@ -0,0 +1,78 @@
+require 'keytechKit/classes/layout/layout'
+
+
+module KeytechKit
+  class Layouts
+    include HTTParty
+
+    def initialize(base_url, username, password)
+      self.class.base_uri(base_url)
+      @auth = { username: username, password: password }
+    end
+
+    def header_layout(classkey)
+        # Ab keytedch 14!
+        load_layout(classkey, {"layoutType": "HeaderLayout"})
+    end
+
+    def main_layout(classkey)
+        load_layout(classkey, {"layoutType": "DefaultLayout"})
+    end
+
+    def explorer_layout(classkey)
+        load_layout(classkey, {"layoutType": "ExplorerLayout"})
+    end
+
+    def lister_layout(classkey)
+        load_lister_layout(classkey)
+    end
+
+    # Loads the bom lister layout
+    def bom_lister_layout
+      # /bom/listerlayout
+      load_lister_layout("bom")
+    end
+
+    def global_lister_layout
+      # type, displaytext, name, status, created_at, created_by
+      Layout.new('DesignerControls' => [
+                   { 'AttributeName' => 'classname',
+                     'Displayname' => 'Klasse' },
+                   { 'AttributeName' => 'displayname',
+                     'Displayname' => 'Bezeichnung' },
+                   { 'AttributeName' => 'status',
+                     'Displayname' => 'Status' },
+                   { 'AttributeName' => 'created_by',
+                     'Displayname' => 'Angelegt von' },
+                   { 'AttributeName' => 'created_at',
+                     'Displayname' => 'Angelegt am' }
+                 ])
+    end
+
+    private
+
+    def load_lister_layout(classKey)
+      parameter = { basic_auth: @auth }
+
+      response = self.class.get("/classes/#{classKey}/listerlayout", parameter)
+      if response.success?
+         Layout.new(response)
+       else
+         raise response.response
+      end
+    end
+
+      def load_layout(classKey, options = {})
+        parameter = {query: options}
+        parameter.merge!({ basic_auth: @auth })
+
+        response = self.class.get("/classes/#{classKey}/editorlayout", parameter)
+        if response.success?
+          # create a class
+           Layout.new(response)
+         else
+           raise response.response
+        end
+      end
+  end
+end

data/lib/keytechKit/classes/subarea.rb

@@ -0,0 +1,12 @@
+module KeytechKit
+  class Subarea
+    attr_accessor :displayname
+    attr_accessor :key
+
+    def initialize(data)
+      self.displayname = data["DisplayText"]
+      self.key = data["Key"]
+    end
+
+  end
+end

data/lib/keytechKit/elements/bom/bom_element.rb

@@ -0,0 +1,42 @@
+module KeytechKit
+  ##
+  # A single article of a bill of material list
+  class BomElement
+    attr_accessor :key
+    attr_accessor :elementKey
+    attr_accessor :keyValueList
+    attr_accessor :cadCount
+    attr_accessor :cadDriven
+    attr_accessor :changedBy
+    attr_accessor :changedByLong
+    attr_accessor :count
+    attr_accessor :createdBy
+    attr_accessor :createdByLong
+    attr_accessor :displayName
+    attr_accessor :element
+
+    def initialize(data)
+      self.key = data['Key']
+      self.elementKey = data['Element']['Key']
+      self.cadCount = data['CadCount']
+      self.cadDriven = data['CadDriven']
+      self.changedBy = data['ChangedBy']
+      self.changedByLong = data['ChangedByLong']
+      self.count = data['Count']
+      self.createdBy = data['CreatedBy']
+      self.createdByLong = data['CreatedByLong']
+      self.displayName = data['DisplayName']
+      # self.element = data["Element"]
+      set_key_value_list(data['KeyValueList'])
+    end
+
+    private
+
+    def set_key_value_list(kvData)
+      self.keyValueList = ({})
+      kvData.each do |kvPair|
+        keyValueList[kvPair['Key'].to_s] = kvPair['Value']
+      end
+    end
+  end
+end

data/lib/keytechKit/elements/bom/bom_element_list.rb

@@ -0,0 +1,29 @@
+require 'keytechKit/elements/bom/bom_element'
+
+module KeytechKit
+  ##
+  # List of bill of material articles
+  class BomElementList
+    attr_accessor :bomElementList
+    attr_accessor :pageNumber
+    attr_accessor :pageSize
+    attr_accessor :totalRecords
+
+    def initialize(data)
+      parseBomData(data)
+    end
+
+    private
+
+    def parseBomData(data)
+      self.pageNumber = data['PageNumber']
+      self.pageSize = data['PageSize']
+      self.totalRecords = data['TotalRecords']
+
+      self.bomElementList = []
+      data['BomElementList'].each do |bom_data|
+        bomElementList.push BomElement.new(bom_data)
+      end
+    end
+  end
+end

data/lib/keytechKit/elements/data_dictionary/data_dictionary_definition.rb

@@ -0,0 +1,23 @@
+
+module KeytechKit
+  ##
+  # Represents a single attribute - target attribute relationship
+  #
+  class DataDictionaryDefinition
+
+    # Data dictionray attribute
+    attr_accessor :attribute
+
+    # target attribute to map to
+    attr_accessor :toTargetAttribute
+
+    # Localized displaytext
+    attr_accessor :displayText
+
+    def initialize(data)
+      self.attribute = data['Attribute']
+      self.toTargetAttribute = data['ToTargetAttribute']
+      self.displayText = data['Displaytext']
+    end
+  end
+end