Module: ClubhouseRuby

Defined in:

lib/clubhouse_ruby.rb,
lib/clubhouse_ruby/request.rb,
lib/clubhouse_ruby/version.rb,
lib/clubhouse_ruby/constants.rb,
lib/clubhouse_ruby/path_builder.rb

Defined Under Namespace

Modules: PathBuilder Classes: Clubhouse, Request

Constant Summary

VERSION =

"0.5.0"

API_URL =

"https://api.clubhouse.io/api/v2/".freeze

FORMATS =

Response formats the clubhouse api knows about

{
  json: {
    headers: { header: 'Content-Type', content: 'application/json' },
    parser: JSON
  },
  csv: {
    headers: { header: 'Accept', content: 'text/csv' },
    parser: CSV
  }
}.freeze

ACTIONS =

Action words are nice for our internal api and match the api path too

{
  get: :Get,
  update: :Put,
  delete: :Delete,
  list: :Get,
  create: :Post
}.freeze

RESOURCES =

These are the resource for the clubhouse api and can form part of the path

[
  :categories,
  :epics,
  :files,
  :labels,
  :linked_files,
  :members,
  :milestones,
  :projects,
  :repositories,
  :stories,
  :story_links,
  :teams,
  :workflows,
  :tasks,
  :comments
].freeze

EXCEPTIONS =

These are the annoying edge cases in the clubhouse api that are don’t fit

{
  bulk_create: {
    path: :bulk,
    action: :Post
  },
  bulk_update: {
    path: :bulk,
    action: :Put
  },
  search_stories: {
    path: 'search/stories',
    action: :Get
  }
}.freeze