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:

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.

keytech_kit = KeytechKit::KeytechKit.new(keytech_url, keytech_username, keytech_password)

# Perform a fulltext search (q), group results by its class, and sort by
# creation date
options = { q: params[:q],
                groupBy: 'classkey',
                classes: params[:classes],
                attributes: 'lister',
                sortBy: 'created_at' }

    @search_results = keytech_kit.search.query(options)

Full documentation with code samples will come in the next days. Latest gem documentation for keytechAPI gem is on rubydoc

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.

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.