Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/uasi/ruboty-jobcan

Ruboty plug-in for punching the clock on JOBCAN.
https://github.com/uasi/ruboty-jobcan

Last synced: 2 months ago
JSON representation

Ruboty plug-in for punching the clock on JOBCAN.

Awesome Lists containing this project

README

        

# Ruboty::Jobcan

## Usage

To use JOBCAN API, you have to teach Ruboty either your code or login info.

### Teach JOBCAN code

```
ruboty remember my jobcan code
```

`` is the text attached to your mobile login URL,
e.g. `http://jobcan.jp/m?code=YOUR_CODE_GOES_HERE`.
Check out the invitation email from JOBCAN for the URL.

### Teach client ID, email, and password

Alternatively, you can use these environment variables to provide your credentials.

```
RUBOTY_JOBCAN_CLIENT_ID
RUBOTY_JOBCAN_EMAIL
RUBOTY_JOBCAN_PASSWORD
```

### Set group ID

Then set your default group ID.

```
ruboty remember my jobcan group id
```

`` is the numeric ID of your group;
ask your manager or check out the source code of https://ssl.jobcan.jp/employee for it.

![group ID](img/group_id.png)

You can also use group name aliases.

```
ruboty register my jobcan group alias ->
```

### Clock in/out

```
ruboty clock in
ruboty clock out
ruboty clock in at
ruboty clock out at
```

## Installation

```ruby
gem 'ruboty-jobcan'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install ruboty-jobcan

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/uasi/ruboty-jobcan.