Skip to content
This repository has been archived by the owner on Apr 20, 2018. It is now read-only.

Cognician/clj-flowdock

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status

clj-flowdock

Clojure Library for interacting with flowdock The api is pretty straight forward and implements most of the public facing end points that flowdock uses.

Leiningen

https://clojars.org/com.rallydev/clj-flowdock

[com.rallydev/clj-flowdock "0.2.0"]

Maven

<dependency>
  <groupId>com.rallydev</groupId>
  <artifactId>clj-flowdock</artifactId>
  <version>0.2.0</version>
</dependency>

Environment Variables

export FLOWDOCK_TOKEN=<user flowdock token>

API

Organizations

(clj-flowdock.api.organization/list)

Returns all organizations that the flowdock user belongs to.

(clj-flowdock.api.organization/id)

Returns the org-id of the first org the user belongs to (I am unaware if a user can belong to multiple orgs). The org id is used when building a flow-id.

(clj-flowdock.api.organization/get-users)

Returns all users for the first org the user belongs to.

Users

(clj-flowdock.api.user/find [key value])

This function will find a user (using clj-flowdock.api.organization/get-users) where the values are equal.

(clj-flowdock.api.user/get [id]

Returns a user from their id.

Flows

(clj-flowdock.api.flow/list)

Returns all flows where the joined attribute is set to true.

(clj-flowdock.api.flow/list-all)

Returns all flows where organization is the access_mode and even includes flows where joined is set to false.

(clj-flowdock.api.flow/find [key value])

Return all flows where the values are equal for a given key.

(clj-flowdock.api.flow/get [id])

Returns a flow for a given id. Flow ids are given in the format -- org-id/flow-id.

(clj-flowdock.api.flow/add-user [flow-id user-id])

This sets the joined flag for a user on a specific flow to true.

(clj-flowdock.api.flow/block-user [flow-id user-id])

This sets the disabled flag to true for a user on a given flow. This blocks all access to a flow, you need to reinvite the user to unblock them. This is not a mechanism for leaving a flow.

(clj-flowdock.api.flow/create [org-id name])

Allows you to create a flow in a given org with the specified name.

(clj-flowdock.api.flow/update [flow-id attributes])

Update the attributes (specified as a map) for the given flow.

Dependencies

[org.clojure/clojure "1.5.0"]
[clj-http "0.6.3"]
[org.clojure/tools.logging "0.2.6"]

License

Copyright (c) Rally Software Development Corp. 2013
Distributed under the MIT License.

About

Clojure Library for interacting with flowdock

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published