Giter VIP home page Giter VIP logo

clj-symphony's Introduction

Build Status Open Issues Average time to resolve an issue License Dependencies Status CII Best Practices FINOS - Released

clj-symphony

This library is an idiomatic Clojure wrapper for the symphony-java-client library, a client binding and SDK for the Symphony chat platform's REST API.

Installation

clj-symphony is available as a Maven artifact from Clojars. The latest released version is:

Clojars Project

Trying it Out

If you prefer to kick the library's tyres without creating a project, you can use the lein try plugin:

$ lein try org.symphonyoss/clj-symphony

or (as of v0.10.0), if you have installed the Clojure CLI tools:

$ clj -Sdeps '{:deps {org.symphonyoss/clj-symphony {:mvn/version "#.#.#"}}}'  # Where #.#.# is replaced with an actual version number >= 0.10.0

Either way, you will be dropped in a REPL with the library downloaded and ready for use.

Usage

The functionality is provided by several clj-symphony._____ namespaces.

Require them in the REPL:

(require '[clj-symphony.connect         :as syc]  :reload-all)
(require '[clj-symphony.user            :as syu]  :reload-all)
(require '[clj-symphony.stream          :as sys]  :reload-all)
(require '[clj-symphony.chat            :as sych] :reload-all)
(require '[clj-symphony.room            :as syrm] :reload-all)
(require '[clj-symphony.message         :as sym]  :reload-all)
(require '[clj-symphony.user-connection :as syuc] :reload-all)

Require them in your project:

(ns my-app.core
  (:require [clj-symphony.connect         :as syc]
            [clj-symphony.user            :as syu]
            [clj-symphony.stream          :as sys]
            [clj-symphony.chat            :as sych]
            [clj-symphony.room            :as syrm]
            [clj-symphony.message         :as sym]
            [clj-symphony.user-connection :as syuc]))

Detailed API documentation is published here.

Roadmap

This project's roadmap is managed exclusively via milestones in the project's GitHub issue tracker. Typically there will be two milestones that are being tracked at most points in time:

  1. The next maintenance (patch) release.
  2. The next feature (minor or major) release.

This project strictly follows semantic versioning rules for determining how issues are assigned to each of these milestones, and what impact that will have on the release's version number (including whether a feature release is major or minor, depending on whether backwards compatibility is broken or not).

Tested Versions

clj-symphony is tested on:

JVM v1.7 JVM v1.8 (LTS) JVM v9 & v10 (FR) JVM v11 (LTS) JVM v12 & v13 (FR) JVM v14 (FR)
Clojure 1.7.0 1,2 1 1,3 1 1,4 1
Clojure 1.8.0 2 3 4
Clojure 1.9.0 2 3 4
Clojure 1.10.1 2,5 3 4

1 clj-symphony only supports Clojure 1.8 and up

2 symphony-java-client only supports JVM v1.8 and up

3 Java FRs 9 & 10 have been superceded by the latest Java LTS (v11), and are no longer supported by Oracle

4 Java FRs 12 & 13 have been superceded by the latest Java FR (v14), and are no longer supported by Oracle

5 Clojure v1.10 only supports JVM v1.8 and up

Contributor Information

Contributing Guidelines

GitHub project

Bug Tracker

License

Copyright 2016 Fintech Open Source Foundation

Distributed under the Apache License, Version 2.0.

3rd Party Licenses

To see the full list of licenses of all third party libraries used by this project, please run:

$ lein licenses :csv | cut -d , -f3 | sort | uniq

To see the dependencies and licenses in detail, run:

$ lein licenses

clj-symphony's People

Contributors

finos-admin avatar maoo avatar pmonks avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

clj-symphony's Issues

Continuous artifact deployment in clojars

Following the same approach used for Java, it would be great to enhance the Travis CI build process with a SNAPSHOT deployment on clojars (or Maven Central).

I'm looking for:

  • Guidance to understand if clojars or Maven Central is the best option; for the latter, we have the advantage of having already a workflow defined and fully working
  • Code changes that are needed for the integration
  • Existing integrations (including clojure tools) that provide the same end goal and can be easily reused

Add NOTICE entries for category B licenses

The following items should be added to NOTICE file

"org.clojure/tools.namespace","0.2.10","Eclipse Public License 1.0"
"org.clojure/clojure","1.8.0","Eclipse Public License 1.0"
"org.glassfish.hk2.external/javax.inject","2.4.0-b34","CDDL"
"marick/suchwow","4.4.3","The Unlicense"
"com.rpl/specter","0.9.0","unknown"
"javax.ws.rs/javax.ws.rs-api","2.0.1","CDDL 1.1"
"javax.annotation/javax.annotation-api","1.2","CDDL"
"org.clojure/math.combinatorics","0.1.1","Eclipse Public License 1.0"
"org.clojars.brenton/google-diff-match-patch","0.1","unknown"
"org.clojure/tools.macro","0.1.5","Eclipse Public License 1.0"
"org.clojure/tools.nrepl","0.2.12","Eclipse Public License 1.0"
"org.glassfish.jersey.core/jersey-client","2.23.1","CDDL"
"clojure-complete","0.2.4","Eclipse Public License"
"swiss-arrows","1.0.0","Eclipse Public License"
"slingshot","0.12.2","Eclipse Public License 1.0"
"junit","4.12","Eclipse Public License 1.0"
"org.glassfish.jersey.bundles.repackaged/jersey-guava","2.23.1","CDDL"
"org.glassfish.jersey.core/jersey-common","2.23.1","CDDL"
"org.glassfish.jersey.media/jersey-media-multipart","2.23.1","CDDL"
"org.glassfish.hk2/hk2-api","2.4.0-b34","CDDL"
"org.tcrawley/dynapath","0.2.3","Eclipse Public License"
"org.glassfish.hk2/osgi-resource-locator","1.0.1","CDDL"
"org.glassfish.hk2/hk2-locator","2.4.0-b34","CDDL"
"colorize","0.1.1","unknown"
"org.jvnet.mimepull/mimepull","1.9.6","CDDL 1.1"
"org.glassfish.hk2.external/aopalliance-repackaged","2.4.0-b34","CDDL"
"environ","1.0.1","Eclipse Public License"
"ordered","1.2.0","Eclipse Public License - v 1.0"
"flare","0.2.9","Eclipse Public License"
"org.clojure/core.unify","0.5.2","Eclipse Public License 1.0"
"org.glassfish.jersey.media/jersey-media-json-jackson","2.23.1","CDDL"
"org.javassist/javassist","3.18.1-GA","MPL 1.1"
"org.glassfish.hk2/hk2-utils","2.4.0-b34","CDDL"
"org.glassfish.jersey.ext/jersey-entity-filtering","2.23.1","CDDL"

Please check the license manually for the 3 unknown items.

Check symphonyoss/symphony-java-client#29 for reference

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.