sfctl 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '01538701ef7e4ff9999297400cb4853751ad2b45485f18524e9545416e34e1a7'
+  data.tar.gz: 1ac3e8c834236ceb56556770057e99e5644c7e2b4a86e63daa8078239cca37de
+SHA512:
+  metadata.gz: fccda9b85147a7373c83426de924435d56221fb350547b6957b8f760f3669ec529d21f04c10c9dbb566c35586be35c97788d2e0b28f236e7a00a50b2c7efeccb
+  data.tar.gz: 4567297fec6b1a36896c2322ffec80ead48b532d558b2804c4c7859dfe67fbc5ecb00eafc84854e3bec965fc1f6118bfdde08df35d8c0a637d3f2489d388f686

data/.buildkite/hooks/pre-command

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+source ~/.bashrc
+asdf install
+asdf current

data/.buildkite/pipeline.yml

@@ -0,0 +1,9 @@
+steps:
+  - label: "Rubocop"
+    commands:
+      - bundle
+      - bundle exec rubocop
+  - label: "RSpec"
+    commands:
+      - bundle
+      - bundle exec rspec

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format Fuubar
+--color

data/.rubocop.yml

@@ -0,0 +1,76 @@
+inherit_mode:
+  merge:
+    - Include
+
+AllCops:
+  Include:
+    - "**/*.gemspec"
+    - "**/*.rake"
+    - "**/Gemfile"
+    - "**/Rakefile"
+  Exclude:
+    - "bin/**/*"
+    - "exe/**/*"
+    - "sfctl.gemspec"
+  CacheRootDirectory: tmp/cache/rubocop_cache/
+  TargetRubyVersion: 2.7.1
+
+Style/Documentation:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 2
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Layout/TrailingWhitespace:
+  Exclude:
+    - "spec/sfctl_spec.rb"
+    - "spec/integration/**/*"
+
+Layout/ClosingHeredocIndentation:
+  Exclude:
+    - "spec/sfctl_spec.rb"
+    - "spec/integration/**/*"
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at vilatti@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,40 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sfctl.gemspec
+gemspec
+
+gem 'faraday'
+gem 'pastel'
+gem 'rake', '~> 12.0'
+gem 'thor'
+gem 'tty-box'
+gem 'tty-color'
+gem 'tty-command'
+gem 'tty-config'
+gem 'tty-cursor'
+gem 'tty-editor'
+gem 'tty-file'
+gem 'tty-font'
+gem 'tty-link'
+gem 'tty-logger'
+gem 'tty-markdown'
+gem 'tty-pager'
+gem 'tty-pie'
+gem 'tty-platform'
+gem 'tty-progressbar'
+gem 'tty-prompt'
+gem 'tty-reader'
+gem 'tty-screen'
+gem 'tty-spinner'
+gem 'tty-table'
+gem 'tty-tree'
+gem 'tty-which'
+
+group :development, :test do
+  gem 'fuubar'
+  gem 'pry-byebug'
+  gem 'rspec'
+  gem 'rubocop'
+  gem 'simplecov'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,186 @@
+PATH
+  remote: .
+  specs:
+    sfctl (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    byebug (11.1.1)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    equatable (0.6.1)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    fuubar (2.5.0)
+      rspec-core (~> 3.0)
+      ruby-progressbar (~> 1.4)
+    hashdiff (1.0.1)
+    jaro_winkler (1.5.4)
+    kramdown (1.16.2)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    necromancer (0.5.1)
+    parallel (1.19.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
+    pastel (0.7.3)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.3)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rouge (3.17.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.81.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    strings (0.1.8)
+      strings-ansi (~> 0.1)
+      unicode-display_width (~> 1.5)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.1.0)
+    thor (1.0.1)
+    tty-box (0.5.0)
+      pastel (~> 0.7.2)
+      strings (~> 0.1.6)
+      tty-cursor (~> 0.7)
+    tty-color (0.5.1)
+    tty-command (0.9.0)
+      pastel (~> 0.7.0)
+    tty-config (0.4.0)
+    tty-cursor (0.7.1)
+    tty-editor (0.5.1)
+      tty-prompt (~> 0.19)
+      tty-which (~> 0.4)
+    tty-file (0.8.0)
+      diff-lcs (~> 1.3)
+      pastel (~> 0.7.2)
+      tty-prompt (~> 0.18)
+    tty-font (0.5.0)
+    tty-link (0.1.1)
+    tty-logger (0.3.0)
+      pastel (~> 0.7.0)
+    tty-markdown (0.6.0)
+      kramdown (~> 1.16.2)
+      pastel (~> 0.7.2)
+      rouge (~> 3.3)
+      strings (~> 0.1.4)
+      tty-color (~> 0.4)
+      tty-screen (~> 0.6)
+    tty-pager (0.12.1)
+      strings (~> 0.1.4)
+      tty-screen (~> 0.6)
+      tty-which (~> 0.4)
+    tty-pie (0.3.0)
+      pastel (~> 0.7.3)
+      tty-cursor (~> 0.7)
+    tty-platform (0.3.0)
+    tty-progressbar (0.17.0)
+      strings-ansi (~> 0.1.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.7)
+      unicode-display_width (~> 1.6)
+    tty-prompt (0.21.0)
+      necromancer (~> 0.5.0)
+      pastel (~> 0.7.0)
+      tty-reader (~> 0.7.0)
+    tty-reader (0.7.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.7)
+      wisper (~> 2.0.0)
+    tty-screen (0.7.1)
+    tty-spinner (0.9.3)
+      tty-cursor (~> 0.7)
+    tty-table (0.11.0)
+      equatable (~> 0.6)
+      necromancer (~> 0.5)
+      pastel (~> 0.7.2)
+      strings (~> 0.1.5)
+      tty-screen (~> 0.7)
+    tty-tree (0.4.0)
+    tty-which (0.4.2)
+    unicode-display_width (1.7.0)
+    unicode_utils (1.4.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday
+  fuubar
+  pastel
+  pry-byebug
+  rake (~> 12.0)
+  rspec
+  rubocop
+  sfctl!
+  simplecov
+  thor
+  tty-box
+  tty-color
+  tty-command
+  tty-config
+  tty-cursor
+  tty-editor
+  tty-file
+  tty-font
+  tty-link
+  tty-logger
+  tty-markdown
+  tty-pager
+  tty-pie
+  tty-platform
+  tty-progressbar
+  tty-prompt
+  tty-reader
+  tty-screen
+  tty-spinner
+  tty-table
+  tty-tree
+  tty-which
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,276 @@
+# sfctl [![Build status](https://badge.buildkite.com/22ecc67f358163f4714383ff0fde8e847d1e3ae488fc10312f.svg)](https://buildkite.com/starfish/sf-control)
+
+```
+sfctl is a command line interface for the Starfish API.
+
+Usage:
+  sfctl [command]
+
+Available Commands:
+  account     account commands
+  auth        auth commands
+  time        time reporting commands
+  version     show the current version
+
+Flags:
+  -a, --all         don't filter data
+  -d, --dry-run     just execute the command - no writes to starfish.team
+  -h, --help        help for fsctl
+  -t, --touchy      no data will be overwritten in starfish.team
+```
+
+## Installing `sfctl`
+
+### Using a Package Manager (Preferred)
+
+More to come.
+
+### Git
+
+More to come.
+
+## Authentication
+
+Before you can use `sfctl`, you need to authenticate with Starfish.team by providing an access token, which can be created on the profile page of your account.
+
+```
+sfctl auth init
+```
+
+You wil be promted to enter your access token that you've generated on the profile page.
+
+```
+Starfish.team access token: YOUR_TOKEN
+```
+
+After entering your token, you will receive confirmation that the credentials were accepted. In case your token is not accepted, please make sure you copy and paste it correctly.
+
+```
+Your token is valid 👍
+```
+
+As a consequece a `.sfctl` directory will be created in your `$HOME` and all data is stored for further use. You can safely copy this folder to other machines to replicate the access. Just be aware this is giving the user controlling the directory access to your starfish account.
+
+You can log out by either removing the config directory or by executing the following command:
+
+```
+sfctl auth bye
+```
+
+## Account Details
+
+You can access your account details directly from the command line.
+
+### Account Info
+
+```
+sfctl account info
+```
+
+This will read your profile data and give you an overview of your account.
+
+```
+Hi [FULL NAME]
+
+we have stored this information for you.
+
+Username            Email
+---------------------------
+[USERNAME]          [EMAIL]
+```
+
+### Assignments
+
+```
+sfctl account assignments
+```
+
+This command will list all of your assignments that are currently active. If you want to read all assignments you have to provide the flag `-a`.
+
+```
+Assignment [NAME]
+-------------------------
+  Service: [SERVICE NAME]
+  Start:   [START DATE]
+  End:     [END DATE]
+  Budget:  [AMOUNT] [UNIT]
+
+[MORE ASSIGNMENTS]
+```
+
+## Time Reports
+
+Time reports and consolidation are an essential part of Starfish.team. You are able to configure on a project level which assignments you want to charge with time report data you have. The time report data will come from standard time tracking tools and will be loaded to starfish using commands in this section.
+
+The key consideration for the approach to support this with a command line interface is to prevent you from storing your personal secrets (like the accesstoken to your lovely time-reporting tool) on our system.
+
+We will provide a couple of integrations but also open up for plugins later on to extend to what's out there.
+
+As of today we support:
+
+- Toggl
+- Harvest
+- Clockify
+
+Another advantage of this approach is, that you think of any automation ⚒ you like to support your processes.
+
+### Initialize a Project
+
+In your project's root directory you can use the following command to create a `.sflink` file that will store your project configuration. Although sensitive data is stored in the main `.sfctl` directory we'd like to recommend to not add the `.sflink` file to your version control system.
+
+```
+sfctl time init
+```
+
+### Get Current Providers
+
+```
+sfctl time providers get
+```
+
+This command will read which providers are configured on your system. These configurations include sensitve information (e.g. access-tokens etc.) and will be read from the `.sfct` main directory.
+
+```
+Provider: [harvest|toggl|clockify]
+  ACCESS_TOKEN: [TOKEN]
+  ACCOUNT_ID: [ACCOUNT_ID]
+  ...
+
+[More Providers]
+```
+
+The information stored is specific for each provider and contains the basic data that is required to authenticate on the API level.
+
+### Set A Provider
+
+```
+sfctl time providers set [harvest|toggl|clockify]
+```
+
+With this command you set the configuration required for the provider to authenticate a call to their API.
+As stated already, the required information depends on the API of the provider.
+
+The system will prompt you for the data.
+
+```
+Setting up [harvest|toggl|clockify]
+Your access token at [harvest|toggl|clockify]: ACCESS_TOKEN
+...
+Is that information correct? (Y/n)
+```
+
+In case there is already a configuration for the provider, you will if you want to overwrite that information.
+
+```
+Setting up [harvest|toggl|clockify]
+You already have a configuration for this provider.
+
+Do you want to replace it? (Y/n)
+...
+```
+
+### Unset A Provider
+
+```
+sfctl time providers unset [harvest|toggl|clockify]
+```
+
+With this command you can unset the configuration of a provider.
+
+```
+Unsetting [harvest|toggl|clockify]
+
+Do you want to remove the delete the configuration? (Y/n)
+...
+```
+
+### Get Current Connections
+
+Connections are the project specific link of a time-reporting tool and respective reporting setup there with an assignment at Starfish.team.
+
+```
+sfctl time connections get
+```
+
+This will list all known connections in that project. The data is read from the `.sflink` file.
+
+```
+Connection: [ASSIGNMENT NAME]
+  provider: toggl
+  workspace_id: 54321
+  project_ids: 123, 324,23, 333
+  task_ids:
+  billable: both
+  rounding: off
+
+[MORE CONNECTIONS]
+```
+
+### Add a Connection
+
+```
+sfctl time connections add [harvest|toggl|clockify]
+```
+
+This command will add a connection between a provider and an assignment. In each project configuration you can have only one connection per assignment.
+
+The system will therefore prompt you to select one of the not yet connected assignments.
+
+```
+Select on assignment first:
+
+1. [ASSIGNMENT NAME] / [SERVICE]
+2. [ASSIGNMENT NAME] / [SERVICE]
+...
+```
+
+After selecting the assignment the command will prompt you to enter the provider specific data.
+See an example for toggl below:
+
+```
+Workspace ID                  (required): [WORKSPACE_ID]
+Project IDs (required / comma separated): [LIST OF PROJECT IDS]
+Task IDs    (optional / comma separated): [LIST OF TASK IDS]
+Billable?                     (required): [BILLED|UNBILLED|BOTH]
+Rounding?                     (required): [ON|OFF]
+```
+
+### Synchronize Data
+
+This command is the essential part of the whole CLI. It will gets for each assignment the next reporting segment from starfish.team and loads the corresponding time reports from the provider.
+
+This command supports the `--dry-run` and the `--touchy` flag, such that you could check the data first respectively prevent data from being overwritten.
+
+```
+sfctl time sync
+```
+
+It will ask you if you want to sync all assignments or only a single one.
+
+```
+Which assignment do you want to sync?
+1. [ASSIGNMENT NAME] / [SERVICE]
+2. [ASSIGNMENT NAME] / [SERVICE]
+N. [ALL]
+```
+
+In case there is no next reporting segment on starfish that accepts time report data, the synchronization will be skipped. All others are synchronized in sequence.
+
+If the `--touchy` flag was used, the synchronizsation will be skipped if there is preexisting data.
+
+```
+Synchronizing:                              [ASSIGNMENT NAME] / [SERVICE]
+Next Report:                                [2020-03]
+Loaded data from [harvest|toggl|clockify]:  [IN PROGRESS|DONE]
+
+Date          Comment                 Time
+-------------------------------------------
+2020.03.01    Work Work               7.75h
+...
+
+Total:                              150.00h
+
+Uploading to starfish.team:                 [IN PROGRESS|DONE]
+
+[NEXT CONNECTION]
+```