keytechkit 0.3.16

data/lib/keytechKit/serverinfo.rb

@@ -0,0 +1,33 @@
+
+module KeytechKit
+  ##
+  # Provides information about current keytech server
+  # Read the full response for raw server data or use the well named accessors
+  class Serverinfo
+    attr_accessor :response
+
+    attr_accessor :database_version
+    attr_accessor :api_version
+    attr_accessor :server_description
+    # Unique ServerID this ID is unique for every installation
+    attr_accessor :server_id
+
+    def initialize(result_data)
+      parse_response(result_data)
+    end
+
+    def parse_response(result_data)
+      result = result_data
+      result.each do |kv|
+        puts "Key: #{kv['Key']}, #{kv['Value']}"
+
+        case kv['Key']
+        when 'keytech database version' then self.database_version = kv['Value']
+        when 'API version' then self.api_version = kv['Value']
+          # More fields
+        end
+      end
+    end
+
+  end
+end

data/lib/keytechKit/serverinfo_handler.rb

@@ -0,0 +1,23 @@
+require 'keytechKit/serverinfo'
+
+module KeytechKit
+  ##
+  # Serverinfo Handler
+  class ServerInfoHandler
+    include HTTParty
+
+    def initialize(keytechkit, base_url)
+      self.class.base_uri(base_url)
+      @keytechkit = keytechkit
+    end
+
+    def load
+      response = self.class.get('/serverinfo')
+      if response.success?
+        Serverinfo.new(response['ServerInfoResult'])
+      else
+        raise response.response
+      end
+    end
+  end
+end

data/lib/keytechKit/targetlink.rb

@@ -0,0 +1,26 @@
+module KeytechKit
+  ##
+  # This links two keytech objects regarding of a context
+  # Can represent a favorite to element link
+  # Can represent a name to a stored query
+  # Can link to a parent link object
+  class Targetlink
+    attr_accessor :entryName
+    attr_accessor :linkID
+    attr_accessor :parentID
+    attr_accessor :targetElementKey
+
+    def initialize(result)
+      parse_result(result)
+    end
+
+    private
+
+    def parse_result(result)
+      self.entryName = result['EntryName']
+      self.linkID = result['LinkID']
+      self.parentID = result['ParentID']
+      self.targetElementKey = result['TargetElementKey']
+    end
+  end
+end

data/lib/keytechKit/tools.rb

@@ -0,0 +1,14 @@
+class Tools
+  # Returns a classkey (MISC_FILE) from a elementkey (MISC_FILE:1234)
+  def self.classKey(element_key)
+    element_key.split(':').first
+  end
+
+  # Return a classkey (MI, FD, DO) from a elementkey (MISC_FILE:!234)
+  def self.classType(element_key)
+    classKey = self.classKey(element_key)
+    return 'MI' if classKey.upcase.end_with?('_MI')
+    return 'FD' if classKey.end_with?('_FD', '_WF')
+    'DO'
+  end
+end

data/lib/keytechKit/user.rb

@@ -0,0 +1,79 @@
+require 'keytechKit/targetlink'
+module KeytechKit
+  ##
+  # The user Object
+  # This represents a keytech user.
+  class User
+    include HTTParty
+    default_timeout 10
+
+    attr_accessor :response
+
+    attr_accessor :isActive
+    attr_accessor :isAdmin
+    attr_accessor :isSuperuser
+    attr_accessor :name
+    attr_accessor :languageID
+    attr_accessor :longName
+    attr_accessor :mail
+
+    def initialize(base_url, username, password)
+      self.class.base_uri(base_url)
+      @auth = { username: username, password: password }
+    end
+
+    # Returns a updated user object
+    # username = key of user
+    def load(username)
+      options = {}
+      options[:basic_auth] = @auth
+      response = self.class.get("/user/#{username}", options)
+      if response.success?
+        self.response = response
+        parse_response
+        self
+      else
+        raise response.response
+      end
+    end
+
+    def queries(options = {})
+      load_target_links('queries', options)
+    end
+
+    def favorites
+      load_target_links('favorites')
+    end
+
+    private
+
+    def load_target_links(linkType, options = {})
+      parameter = { query: options }
+      parameter[:basic_auth] = @auth
+      response = self.class.get("/user/#{name}/#{linkType}", parameter)
+      if response.success?
+        targetLinks_response = response['TargetLinks']
+        targetLinks = []
+        targetLinks_response.each do |link_response|
+          targetLinks.push Targetlink.new(link_response)
+        end
+        targetLinks
+      else
+        raise response.response
+      end
+    end
+
+    def parse_response
+      # Only one user should be returns every time
+      user_data = response['MembersList'][0]
+
+      self.isActive = user_data['IsActive']
+      self.isAdmin = user_data['IsAdmin']
+      self.isSuperuser = user_data['IsSuperuser']
+      self.name = user_data['KeyName']
+      self.languageID = user_data['LanguageID']
+      self.longName = user_data['Longname']
+      self.mail = user_data['MailAddress']
+    end
+  end
+end

data/lib/keytechKit/version.rb

@@ -0,0 +1,15 @@
+module KeytechKit
+  VERSION = '0.3.16'
+
+  # Public available Demo URL for testing and dsevelopment
+  DEMO_URL = 'https://demo.keytech.de'
+
+  # username to access public web API
+  DEMO_USER = 'jgrant'
+
+  # No password for public web API
+  DEMO_PASSWORD = ''
+
+  DEMO_ARTICLE = 'DEFAULT_MI:500228' # Dampfwalze / Steamroller
+
+end

data/lib/keytechKit.rb

@@ -0,0 +1,98 @@
+require 'httparty'
+require 'keytechKit/version'
+require 'keytechKit/serverinfo_handler'
+require 'keytechKit/search'
+require 'keytechKit/user'
+require 'keytechKit/elements/element_handler'
+require 'keytechKit/elements/notes/note_handler'
+require 'keytechKit/classes/classes'
+require 'keytechKit/classes/layouts'
+require 'keytechKit/classes/layout/layout'
+require 'keytechKit/elements/element_files/element_file_handler'
+require 'keytechKit/elements/data_dictionary/data_dictionary_handler'
+
+module KeytechKit
+  ##
+  # This class is the interface controller to the keytech Web API
+  # Use the helper functions to access various resources from the API
+  #
+  class KeytechKit
+    attr_reader :base_url
+    attr_reader :username
+    attr_reader :password
+
+    # Initializes this class
+    # user +baseurl+, +username+ and +password+ to start accessing all other
+    # keytech API resources
+    #
+    def initialize(baseurl, username = '', password = '')
+      @base_url = baseurl
+      @username = username
+      @password = password
+    end
+
+    # Returns the Serverinfo @see +ServerInfo+ for details
+    # This should be always the first call whenever starting with keytech API.
+    # ServerInfo will give valuable information about server access, version
+    # number and functions
+    #
+    def serverinfo
+      @serverinfo_handler = ServerInfoHandler.new(self, @base_url) if @serverinfo_handler.nil?
+      @serverinfo_handler.load
+    end
+
+    # Returns the login in user.
+    # This is always the user with which you Initialized this classes
+    # Check this object to see if the user is active and have API access.
+    def current_user
+      if @_curent_user.nil?
+        user = User.new(@base_url, @username, @password)
+        @_curent_user = user.load(@username)
+      end
+      @_curent_user
+    end
+
+    # Returns the Elements resource. You will need to specify alwys the concrete
+    # Element you want to access. keytech API does not support to return bulk
+    # Lists of Elements
+    #
+    def element_handler
+      @_element_handler = ElementHandler.new(self, @base_url, @username, @password) if @_element_handler.nil?
+      @_element_handler
+    end
+
+    # Returns the Data Dictionaries. Data Dictionary (DD) will give lookup tables
+    # you will need to fill various element fields.
+    def data_dictionary_handler
+      @data_dictionary_handler = DataDictionaryHandler.new(self, @base_url, @username, @password) if @data_dictionary_handler.nil?
+      @data_dictionary_handler
+    end
+
+    # Returns the classes object.
+    # A class in terms of keytech describes a type of elements.
+    # A class describes the attributes, its types and it supported layouts to make
+    # certain elements visible for a user.
+    def classes
+      @classes = Classes.new(@base_url, @username, @password) if @classes.nil?
+      @classes
+    end
+
+    # TODO: Move Laoyuts under classes
+    # returns the layout class. Eveny class can have a layout which describes
+    # the attribues with its type, acccess, datadictionary and if it is
+    # visible to the user.
+    def layouts
+      @_layouts = Layouts.new(@base_url, @username, @password) if @_layouts.nil?
+      @_layouts
+    end
+
+    # Returns the Search Object
+    # With the search you can start a fulltextsearch, search by field, type or
+    # access a predefined search on the server side for elements
+    #
+    def search
+      @_search = Search.new(@base_url, @username, @password) if @_search.nil?
+      @_search
+    end
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: keytechkit
+version: !ruby/object:Gem::Version
+  version: 0.3.16
+platform: ruby
+authors:
+- Thorsten Claus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: 
+email:
+- thorstenclaus@web.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- keytechKit.gemspec
+- lib/keytechKit.rb
+- lib/keytechKit/classes/classdefinition.rb
+- lib/keytechKit/classes/classes.rb
+- lib/keytechKit/classes/layout/control.rb
+- lib/keytechKit/classes/layout/layout.rb
+- lib/keytechKit/classes/layouts.rb
+- lib/keytechKit/classes/subarea.rb
+- lib/keytechKit/elements/bom/bom_element.rb
+- lib/keytechKit/elements/bom/bom_element_list.rb
+- lib/keytechKit/elements/data_dictionary/data_dictionary_definition.rb
+- lib/keytechKit/elements/data_dictionary/data_dictionary_handler.rb
+- lib/keytechKit/elements/element.rb
+- lib/keytechKit/elements/element_files/element_file.rb
+- lib/keytechKit/elements/element_files/element_file_handler.rb
+- lib/keytechKit/elements/element_handler.rb
+- lib/keytechKit/elements/group_by.rb
+- lib/keytechKit/elements/notes/note.rb
+- lib/keytechKit/elements/notes/note_handler.rb
+- lib/keytechKit/elements/search_response_header.rb
+- lib/keytechKit/search.rb
+- lib/keytechKit/serverinfo.rb
+- lib/keytechKit/serverinfo_handler.rb
+- lib/keytechKit/targetlink.rb
+- lib/keytechKit/tools.rb
+- lib/keytechKit/user.rb
+- lib/keytechKit/version.rb
+homepage: https://claus-software.de
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/tclaus/keytechkit.gem
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: keytechkit is a ruby gem to connect to the keytech Web API
+test_files: []