Giter VIP home page Giter VIP logo

clj-slack's Introduction

clj-slack

clj-slack is a Clojure library to talk to the Slack REST API. It supports almost the entire Slack API.

Build Status

Documentation

Slack API methods are described here.

clj-slack documentation is available here.

Usage

This is on Clojars of course. Just add [org.julienxx/clj-slack "0.8.3"] to your :dependencies in your project.clj file.

Get your access token by creating a new app or here. If you create a new Slack app, don't forget to add the relevant scopes to your app.

Your need to create a connection map like {:api-url "https://slack.com/api" :token "YOUR TOKEN"} and pass it as the first argument of every functions in clj-slack. Of course you can change api-url for debugging or testing purposes.

You can pass clj-http options in the connection map if needed.

clj-slack will throw an Exception if the connection map you're trying to use is not valid.

Example:

(require 'clj-slack.users)
(def connection {:api-url "https://slack.com/api" :token "YOUR TOKEN"})
(clj-slack.users/list connection)

You can use optional params described in Slack API by passing them through a map.

(require 'clj-slack.stars)
(def connection {:api-url "https://slack.com/api" :token "YOUR TOKEN"})
(clj-slack.stars/list connection {:count "2" :page "3"})

Uploading a file:

(require 'clj-slack.files)
(def connection {:api-url "https://slack.com/api" :token "YOUR TOKEN"})
(clj-slack.files/upload connection (clojure.java.io/input-stream "/path/to/file/file.ext") {:channels "CHANNEL_ID", :title "This is a file.})

Testing

In order to run the tests, you have to set 3 environment variables:

  • TOKEN a legacy Slack token
  • CLIENT_ID a OAuth client id
  • CLIENT_SECRET a OAuth client secret then run lein test.

License

Copyright (C) 2014-2023 Julien Blanchard

Distributed under the Eclipse Public License, the same as Clojure.

clj-slack's People

Contributors

bago2k4 avatar bgruber avatar bitdeli-chef avatar bobics avatar brunomrp avatar casidiablo avatar cbui avatar danielcompton avatar devth avatar gonzih avatar jakedavis avatar jcpsantiago avatar julienxx avatar jumarko avatar m0cchi avatar noonian avatar sdorunga avatar tfoldi avatar thenonameguy avatar thomascarvalho avatar tmatias avatar yayitswei avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

clj-slack's Issues

Trying to send String's containing whitespace raises StringReader exception

Since everything is sent through URL params, trying to send String's containing spaces raises an not-so-related StringReader NullPointerException. This means to send strings, users need to UrlEncode them before sending.

I believe this should be handled by the library or mentioned in the doc(string)s.

file upload broken

The example of file upload using a clojure.java.io/input-stream from the readme is broken

Execution error at clojure.data.json/write-generic (json.clj:599).
Don't know how to write JSON of class java.io.BufferedInputStream

seems like it was caused by this commit: 739847b

CompilerException java.lang.IllegalArgumentException

While using [org.julienxx/clj-slack "0.5.2.1"] getting following compilation error:

(require 'clj-slack.users)

CompilerException java.lang.IllegalArgumentException: Can't define method not in interfaces: meta, compiling:(clj_http/headers.clj:105:1)

No configuration for timeouts.

I couldn't find anything related to timeouts and I think this is a huge opportunity for improvement.
It should be possible (and really encouraged) to specify reasonable timeouts for every slack operation.
Otherwise, the app can freeze indefinitely.

clj-http provides a couple of options for configuring timeouts: https://github.com/dakrone/clj-http#post

  • :conn-timeout
  • :socket-timeout

There's also :conn-request-timeout but I guess that's not that important since it's a timeout for requesting a connection from connection manager.

There could a default (e.g. 60 seconds) for both timeouts too.

Unit testing

It seems like that's what is next in your plate... let me know if you plan to start doing it anytime soon or if I should take a stab at it.

CI and testing against our own slack team would be great. What do you think? I already have one team setup for this project and it's the one I'm using to manually test the library.

missing_scope

Whatever i am trying to do i get an error:

(channels/list connection)
{:ok false, :error "missing_scope", :needed "channels:read", :provided "identify,incoming-webhook"}

rtm

I want to create a slack bot that listens to specific words in a channel and answers to those. From my understanding, I need to use the real-time-messaging API from slack. My problem is, other than creating a session I don't understand how to use it from the docs or the code.

[bug?] always post-message as a owner of the app

(chat/post-message connection "#logs" "" {
                                            :attachments [{"text" text
                                                           "color" color}]})

Posted as a user who created the app?!

(chat/post-message connection "#logs" "" {:username "Overseer"
                                            :attachments [{"text" text
                                                           "color" color}]})

The same.

(chat/post-message connection "#logs" "" {
                                            :as_username false/true
                                            :attachments [{"text" text
                                                           "color" color}]})

CompilerException java.lang.IllegalArgumentException: Body may not be null, compiling:(.../src/.../slack.clj:27:1)

(chat/post-message connection "#logs" "" {:as_username "Overseer"
                                            :attachments [{"text" text
                                                           "color" color}]})

No errors but posted as a user who created the app.

The goal: i want to post messages as a bot / another user. Whatever but not me :)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.