README.md

Bambooing

Welcome to bambooing, a gem to track bamboo time hassle free! This gem is addressed to people who forgets to clock-(in|out) during work hours.

Usage

If you have docker installed on your machine, please run the following command:

make create_current_weekdays

This will add entries in Bamboo for the current week. These entries will consist of 8 hours per day with 2 breaks of 0-30 minutes, summing a total of 40 weekly hours.

Note, it is needed to pass valid values for the configuration.env file (e.g. csrf_token, session_id or employee_id)

If you are ever lazier, you can add entries in Bamboo for the current month, based on the same strategy that for the current week. Please run the following command:

make create_current_month_weekdays

Getting your credentials

You will need to open your bamboo account on a browser and navigate to My Info tab. Execute the following commands to read your CSRF Token and Employee ID:

console.log('Employee id:', currentlyEditingEmployeeId);
console.log('CSRF token:', CSRF_TOKEN);

For the Session ID, you will have to use the browser's develpoment tools to find the value for the cookie named 'PHPSESSID'

Notice that if BAMBOOING_DRY_RUN_MODE is enabled, the times will be generated but will not be uploaded to bamboo, you have to disable it if you want to upload the times.

Test

make test

Development

make devel

This will create an image and run a container to play/develop further features in bambooing. Then, run bundle exec rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Installation

Add this line to your application's Gemfile:

gem 'bambooing'

And then execute:

$ bundle

Or install it yourself as:

$ gem install bambooing

Code status

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jollopre/bambooing. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Bambooing project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.