├── .travis.yml ├── .gitignore ├── src └── de │ └── otto │ └── tesla │ ├── util │ └── config_parser.clj │ └── jsonhome.clj ├── project.clj ├── test └── de │ └── otto │ └── tesla │ ├── util │ ├── test_utils.clj │ └── config_parser_test.clj │ └── jsonhome_test.clj ├── README.md └── LICENSE /.travis.yml: -------------------------------------------------------------------------------- 1 | language: clojure 2 | jdk: 3 | - oraclejdk8 -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /classes 3 | /checkouts 4 | pom.xml 5 | pom.xml.asc 6 | *.jar 7 | *.class 8 | *.out 9 | /.lein-* 10 | /.nrepl-port 11 | /.idea 12 | *iml 13 | log_location_IS_UNDEFINED/ 14 | -------------------------------------------------------------------------------- /src/de/otto/tesla/util/config_parser.clj: -------------------------------------------------------------------------------- 1 | (ns de.otto.tesla.util.config-parser) 2 | 3 | (defn deep-merge 4 | "Recursively merges maps. If keys are not maps, the last value wins." 5 | [& vals] 6 | (if (every? map? vals) 7 | (apply merge-with deep-merge vals) 8 | (last vals))) 9 | 10 | (declare nest-single-tuple) 11 | 12 | (defn prop->nested-hash [prop-hash] 13 | (apply deep-merge (map nest-single-tuple prop-hash))) 14 | 15 | (defn nest-single-tuple [[key value]] 16 | (let [[head tail] (clojure.string/split (name key) #"-" 2) 17 | new-value (if tail 18 | (prop->nested-hash {(keyword tail) value}) 19 | value)] 20 | {(keyword head) new-value})) -------------------------------------------------------------------------------- /project.clj: -------------------------------------------------------------------------------- 1 | (defproject de.otto/tesla-jsonhome "0.2.2-SNAPSHOT" 2 | :description "Addon to https://github.com/otto-de/tesla-microservice to render a JSON-HOME document." 3 | :url "https://github.com/otto-de/tesla-jsonhome" 4 | :license {:name "Apache License 2.0" 5 | :url "http://www.apache.org/license/LICENSE-2.0.html"} 6 | :scm {:name "git" 7 | :url "https://github.com/otto-de/tesla-jsonhome"} 8 | :dependencies [[org.clojure/clojure "1.8.0"] 9 | [org.clojure/data.json "0.2.6"]] 10 | :lein-release {:deploy-via :clojars} 11 | :profiles {:provided {:dependencies [[de.otto/tesla-microservice "0.3.36"] 12 | [com.stuartsierra/component "0.3.1"]]} 13 | :dev {:dependencies [[ring-mock "0.1.5"]] 14 | :plugins [[lein-ancient "0.6.10"] [lein-release/lein-release "1.0.9"]]}}) 15 | -------------------------------------------------------------------------------- /test/de/otto/tesla/util/test_utils.clj: -------------------------------------------------------------------------------- 1 | (ns de.otto.tesla.util.test-utils 2 | (:require [com.stuartsierra.component :as comp])) 3 | 4 | (defmacro with-started 5 | "bindings => [name init ...] 6 | 7 | Evaluates body in a try expression with names bound to the values 8 | of the inits after (.start init) has been called on them. Finally 9 | a clause calls (.stop name) on each name in reverse order." 10 | [bindings & body] 11 | (if (and 12 | (vector? bindings) "a vector for its binding" 13 | (even? (count bindings)) "an even number of forms in binding vector") 14 | (cond 15 | (= (count bindings) 0) `(do ~@body) 16 | (symbol? (bindings 0)) `(let [~(bindings 0) (comp/start ~(bindings 1))] 17 | (try 18 | (with-started ~(subvec bindings 2) ~@body) 19 | (finally 20 | (comp/stop ~(bindings 0))))) 21 | :else (throw (IllegalArgumentException. 22 | "with-started-system only allows Symbols in bindings"))) 23 | (throw (IllegalArgumentException. 24 | "not a vector or bindings-count is not even")))) -------------------------------------------------------------------------------- /test/de/otto/tesla/util/config_parser_test.clj: -------------------------------------------------------------------------------- 1 | (ns de.otto.tesla.util.config-parser-test 2 | (:require [clojure.test :refer :all] 3 | [de.otto.tesla.util.config-parser :as config])) 4 | 5 | (deftest prop->nested-hash-test 6 | (testing "it " 7 | (is (= nil 8 | (config/prop->nested-hash {}))) 9 | (is (= {:foo "bar"} 10 | (config/prop->nested-hash {:foo "bar"}))) 11 | (is (= {:foo {:bar "xyz"}} 12 | (config/prop->nested-hash {:foo-bar "xyz"}))) 13 | (is (= {:foo {:bar {:baz "xyz"}}} 14 | (config/prop->nested-hash {:foo-bar-baz "xyz"}))) 15 | (is (= {:foo {:bar "xyz" 16 | :baz "abc"} 17 | :foz "def"} 18 | (config/prop->nested-hash {:foo-bar "xyz" 19 | :foo-baz "abc" 20 | :foz "def"}))) 21 | (is (= {:foo {:foz {:bar "xyz" 22 | :baz "abc"}} 23 | :foz {:foo "123"}} 24 | (config/prop->nested-hash {:foo-foz-bar "xyz" 25 | :foo-foz-baz "abc" 26 | :foz-foo "123"}))))) -------------------------------------------------------------------------------- /src/de/otto/tesla/jsonhome.clj: -------------------------------------------------------------------------------- 1 | (ns de.otto.tesla.jsonhome 2 | (:require [clojure.tools.logging :as log] 3 | [de.otto.tesla.stateful.handler :as handler] 4 | [de.otto.tesla.util.config-parser :as parser] 5 | [com.stuartsierra.component :as component] 6 | [compojure.core :as c] 7 | [clojure.data.json :as json])) 8 | 9 | (defn prefix-keys [prefix [k v]] 10 | [(str prefix (name k)) v]) 11 | 12 | (defn json-response-body [configuration] 13 | (let [resources (get-in (parser/prop->nested-hash configuration) [:jsonhome :resources]) 14 | prefix (:jsonhome-link-rel-prefix configuration "")] 15 | {:resources (into {} (map (partial prefix-keys prefix) resources))})) 16 | 17 | (defn json-home-response [configuration] 18 | (let [response-body (json-response-body configuration)] 19 | {:status 200 20 | :headers {"Content-Type" "application/json-home"} 21 | :body (json/write-str response-body :escape-slash false)})) 22 | 23 | (defn routes [configuration url] 24 | (c/routes 25 | (c/GET url [] (json-home-response configuration)))) 26 | 27 | (defrecord JsonHome [config route-to handler] 28 | component/Lifecycle 29 | (start [self] 30 | (log/info "-> Starting JsonHome.") 31 | (let [configuration (:config config) 32 | url (or route-to (:jsonhome-url configuration))] 33 | (handler/register-handler handler (routes configuration url))) 34 | self) 35 | 36 | (stop [self] 37 | (log/info "<- Stopping JsonHome") 38 | self)) 39 | 40 | (defn new-jsonhome 41 | ([] 42 | (new-jsonhome nil)) 43 | ([route-to] 44 | (map->JsonHome {:route-to route-to}))) 45 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # tesla-jsonhome 2 | 3 | This library provides a component, that adds an http endpoint 4 | to [tesla-microservice](https://github.com/otto-de/tesla-microservice) 5 | that will produce a [json-home](http://tools.ietf.org/html/draft-nottingham-json-home-02) document 6 | with links to resources of your microservice. 7 | 8 | [![Clojars Project](http://clojars.org/de.otto/tesla-jsonhome/latest-version.svg)](http://clojars.org/de.otto/tesla-jsonhome) 9 | 10 | [![Build Status](https://travis-ci.org/otto-de/tesla-jsonhome.svg?branch=master)](https://travis-ci.org/otto-de/tesla-jsonhome) 11 | [![Dependencies Status](http://jarkeeper.com/otto-de/tesla-jsonhome/status.svg)](http://jarkeeper.com/otto-de/tesla-jsonhome) 12 | 13 | ## Usage 14 | 15 | Because tesla-microservice is a provided dependency, you must always specify two dependencies in your project clj: 16 | 17 | ```clojure 18 | :dependencies [[de.otto/tesla-microservice "0.3.36"] 19 | [de.otto/tesla-jsonhome "0.2.1"]] 20 | ``` 21 | 22 | Add the `jsonhome`component to the base-system before starting it. 23 | ```clojure 24 | (assoc (system/base-system runtime-config) 25 | :jsonhome (component/using (jsonhome/new-jsonhome "/jsonhome/") [:config :handler])) 26 | ``` 27 | ### Adding Resources to the JSON-Home document 28 | 29 | Resources have to be added via the config of your tesla-microservice. 30 | 31 | If you have a config like that: 32 | 33 | ```INI 34 | jsonhome.resources.status.href=/your-status 35 | jsonhome.resources.health.href=/your-health 36 | jsonhome.resources.health.title=Health Check 37 | ``` 38 | 39 | This Json-Home document would be rendered: 40 | 41 | ```JSON 42 | { 43 | "resources": { 44 | "health": { 45 | "href": "/your-health", 46 | "title": "Health Check" 47 | }, 48 | "status": { 49 | "href": "/your-status" 50 | } 51 | } 52 | } 53 | ``` 54 | 55 | ### Using Link-Relation prefixes 56 | 57 | It is common practice to use full-qualified names as keys in the resources hash. 58 | To prefix every resource, you can set `jsonhome.link-rel-prefix` in your config. 59 | 60 | For Example this config: 61 | 62 | ```INI 63 | jsonhome.link-rel-prefix=http://spec.example.com/link-rel/ 64 | ``` 65 | 66 | will produce this Json-Home document like this: 67 | 68 | ```JSON 69 | { 70 | "resources": { 71 | "http://spec.example.com/link-rel/health": { 72 | "href": "/health" 73 | }, 74 | "http://spec.example.com/link-rel/status": { 75 | "href": "/status" 76 | } 77 | } 78 | } 79 | ``` 80 | 81 | ## Initial Contributors 82 | 83 | Torsten Mangner, Tobias Radtke, Kai Brandes 84 | 85 | ## Compatibility 86 | Versions `0.1.0` and above of tesla-jsonhome are compatible with versions `0.1.15` and above of tesla-microservice. 87 | 88 | ## License 89 | Apache License 90 | -------------------------------------------------------------------------------- /test/de/otto/tesla/jsonhome_test.clj: -------------------------------------------------------------------------------- 1 | (ns de.otto.tesla.jsonhome-test 2 | (:require [clojure.test :refer :all] 3 | [com.stuartsierra.component :as c] 4 | [de.otto.tesla.system :as system] 5 | [de.otto.tesla.stateful.handler :as handler] 6 | [de.otto.tesla.jsonhome :as jsonhome] 7 | [de.otto.tesla.util.test-utils :as u] 8 | [clojure.data.json :as json] 9 | [ring.mock.request :as mock])) 10 | 11 | (defn- serverless-system 12 | ([runtime-config] 13 | (serverless-system nil runtime-config)) 14 | ([url runtime-config] 15 | (-> (system/base-system runtime-config) 16 | (assoc :jsonhome (c/using (jsonhome/new-jsonhome url) [:config :handler])) 17 | (dissoc :server)))) 18 | 19 | (deftest ^:unit json-home-response-test 20 | (testing "without link-rel-prefix" 21 | (u/with-started [started (serverless-system {:jsonhome-resources-status-href "/my-status" 22 | :jsonhome-resources-health-href "/my-health"})] 23 | (let [configuration (get-in started [:config :config]) 24 | page (jsonhome/json-home-response configuration) 25 | body (json/read-str (:body page) :key-fn keyword)] 26 | (testing "it shows the configured resources" 27 | (is (= (keys (:resources body)) 28 | [:status 29 | :health])) 30 | (is (= (get-in body [:resources :status]) 31 | {:href "/my-status"})) 32 | (is (= (get-in body [:resources :health]) 33 | {:href "/my-health"})))))) 34 | (testing "with link-rel-prefix" 35 | (u/with-started [started (serverless-system {:jsonhome-resources-status-href "/my-status" 36 | :jsonhome-resources-health-href "/my-health" 37 | :jsonhome-link-rel-prefix "http://spec.example.com/link-rel/"})] 38 | (let [configuration (get-in started [:config :config]) 39 | page (jsonhome/json-home-response configuration) 40 | body (json/read-str (:body page) :key-fn keyword)] 41 | (testing "all resources have a prefix" 42 | (is (= (keys (:resources body)) 43 | [:http://spec.example.com/link-rel/status 44 | :http://spec.example.com/link-rel/health]))))))) 45 | 46 | (deftest ^:integration should-serve-jsonhome-under-given-url 47 | (testing "prefer the passed url over the configured url" 48 | (u/with-started [started (serverless-system "/jsonhome/" {:jsonhome-url "/some-other/jsonhome/"})] 49 | (let [handlers (handler/handler (:handler started))] 50 | (is (= (:status (handlers (mock/request :get "/jsonhome/"))) 51 | 200))))) 52 | (testing "use the configured url in case no url is passed" 53 | (u/with-started [started (serverless-system nil {:jsonhome-url "/some-other/jsonhome/"})] 54 | (let [handlers (handler/handler (:handler started))] 55 | (is (= (:status (handlers (mock/request :get "/some-other/jsonhome/"))) 56 | 200)))))) 57 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------