gooddata-ruby-examples

Examples of GoodData Ruby SDK Usage

Build Status

Prerequisites

• ruby - Modern programming Language
• rubygems
• bundler

Getting started

Getting started is few strokes far. Lets see.

# Clone repository
git clone https://github.com/korczis/gooddata-ruby-examples.git

# Enter the folder with cloned sources
cd gooddata-ruby-examples

# Install required dependencies using Bundle
bundle install

Done.

You are ready to run all stuff which is in.

Updating

If you want to update to latest version of gooddata-ruby-examples do following:

git pull

bundle update

Structure

• apps - Example Applications using gooddata ruby gem
  • goodproject - Command Line Interface for GoodData Platform
• snippets - Simple code pieces demonstrating just one functionality at time
  • 01_core - Core GoodData gem functionality
    • connect.rb - Connect using username and password
    • connect_env_vars.rb - Connect using username and password from environment variables
    • current_user.rb - Access current user
    • handling_errors.rb - Handle possible errors
    • logging.rb - Verbose logging output.
    • version.rb - Show GoodData Ruby gem version.
  • 02_resources - Examples for each resource - metric, project, report, schedule, user, ...
    • domain - Domain related examples.
      • domain_users.rb - Lists domain users.
    • invitation - Invitation related examples.
      • send_invitation.rb - Invites user to project
    • project - Project related examples.
      • project_list.rb - Project related examples.

Authors

Original authors in alphabetical order.

• baskoj - Jan Basko
• korczis - Tomas Korcak
• vpasler - Vojtech Pasler

License

Project gooddata-ruby-examples is released under the MIT License.