├── .gitignore ├── Dockerfile ├── LICENSE ├── Procfile ├── README.md ├── logs.txt ├── project.clj ├── resources └── public │ └── index.html ├── src └── falkor │ ├── main.clj │ ├── middleware.clj │ ├── parser.clj │ ├── server.clj │ └── util.clj ├── swagger.yml └── test └── falkor └── core_test.clj /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /classes 3 | /checkouts 4 | pom.xml 5 | pom.xml.asc 6 | *.jar 7 | *.class 8 | /.lein-* 9 | /.nrepl-port 10 | .hgignore 11 | .hg/ 12 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM java:8 2 | 3 | ADD target/falkor-api.jar . 4 | 5 | EXPOSE 5000 6 | 7 | CMD java -jar falkor-api.jar -m falkor.main 8 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC 2 | LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM 3 | CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. 4 | 5 | 1. DEFINITIONS 6 | 7 | "Contribution" means: 8 | 9 | a) in the case of the initial Contributor, the initial code and 10 | documentation distributed under this Agreement, and 11 | 12 | b) in the case of each subsequent Contributor: 13 | 14 | i) changes to the Program, and 15 | 16 | ii) additions to the Program; 17 | 18 | where such changes and/or additions to the Program originate from and are 19 | distributed by that particular Contributor. A Contribution 'originates' from 20 | a Contributor if it was added to the Program by such Contributor itself or 21 | anyone acting on such Contributor's behalf. Contributions do not include 22 | additions to the Program which: (i) are separate modules of software 23 | distributed in conjunction with the Program under their own license 24 | agreement, and (ii) are not derivative works of the Program. 25 | 26 | "Contributor" means any person or entity that distributes the Program. 27 | 28 | "Licensed Patents" mean patent claims licensable by a Contributor which are 29 | necessarily infringed by the use or sale of its Contribution alone or when 30 | combined with the Program. 31 | 32 | "Program" means the Contributions distributed in accordance with this 33 | Agreement. 34 | 35 | "Recipient" means anyone who receives the Program under this Agreement, 36 | including all Contributors. 37 | 38 | 2. GRANT OF RIGHTS 39 | 40 | a) Subject to the terms of this Agreement, each Contributor hereby grants 41 | Recipient a non-exclusive, worldwide, royalty-free copyright license to 42 | reproduce, prepare derivative works of, publicly display, publicly perform, 43 | distribute and sublicense the Contribution of such Contributor, if any, and 44 | such derivative works, in source code and object code form. 45 | 46 | b) Subject to the terms of this Agreement, each Contributor hereby grants 47 | Recipient a non-exclusive, worldwide, royalty-free patent license under 48 | Licensed Patents to make, use, sell, offer to sell, import and otherwise 49 | transfer the Contribution of such Contributor, if any, in source code and 50 | object code form. This patent license shall apply to the combination of the 51 | Contribution and the Program if, at the time the Contribution is added by the 52 | Contributor, such addition of the Contribution causes such combination to be 53 | covered by the Licensed Patents. The patent license shall not apply to any 54 | other combinations which include the Contribution. No hardware per se is 55 | licensed hereunder. 56 | 57 | c) Recipient understands that although each Contributor grants the licenses 58 | to its Contributions set forth herein, no assurances are provided by any 59 | Contributor that the Program does not infringe the patent or other 60 | intellectual property rights of any other entity. Each Contributor disclaims 61 | any liability to Recipient for claims brought by any other entity based on 62 | infringement of intellectual property rights or otherwise. As a condition to 63 | exercising the rights and licenses granted hereunder, each Recipient hereby 64 | assumes sole responsibility to secure any other intellectual property rights 65 | needed, if any. For example, if a third party patent license is required to 66 | allow Recipient to distribute the Program, it is Recipient's responsibility 67 | to acquire that license before distributing the Program. 68 | 69 | d) Each Contributor represents that to its knowledge it has sufficient 70 | copyright rights in its Contribution, if any, to grant the copyright license 71 | set forth in this Agreement. 72 | 73 | 3. REQUIREMENTS 74 | 75 | A Contributor may choose to distribute the Program in object code form under 76 | its own license agreement, provided that: 77 | 78 | a) it complies with the terms and conditions of this Agreement; and 79 | 80 | b) its license agreement: 81 | 82 | i) effectively disclaims on behalf of all Contributors all warranties and 83 | conditions, express and implied, including warranties or conditions of title 84 | and non-infringement, and implied warranties or conditions of merchantability 85 | and fitness for a particular purpose; 86 | 87 | ii) effectively excludes on behalf of all Contributors all liability for 88 | damages, including direct, indirect, special, incidental and consequential 89 | damages, such as lost profits; 90 | 91 | iii) states that any provisions which differ from this Agreement are offered 92 | by that Contributor alone and not by any other party; and 93 | 94 | iv) states that source code for the Program is available from such 95 | Contributor, and informs licensees how to obtain it in a reasonable manner on 96 | or through a medium customarily used for software exchange. 97 | 98 | When the Program is made available in source code form: 99 | 100 | a) it must be made available under this Agreement; and 101 | 102 | b) a copy of this Agreement must be included with each copy of the Program. 103 | 104 | Contributors may not remove or alter any copyright notices contained within 105 | the Program. 106 | 107 | Each Contributor must identify itself as the originator of its Contribution, 108 | if any, in a manner that reasonably allows subsequent Recipients to identify 109 | the originator of the Contribution. 110 | 111 | 4. COMMERCIAL DISTRIBUTION 112 | 113 | Commercial distributors of software may accept certain responsibilities with 114 | respect to end users, business partners and the like. While this license is 115 | intended to facilitate the commercial use of the Program, the Contributor who 116 | includes the Program in a commercial product offering should do so in a 117 | manner which does not create potential liability for other Contributors. 118 | Therefore, if a Contributor includes the Program in a commercial product 119 | offering, such Contributor ("Commercial Contributor") hereby agrees to defend 120 | and indemnify every other Contributor ("Indemnified Contributor") against any 121 | losses, damages and costs (collectively "Losses") arising from claims, 122 | lawsuits and other legal actions brought by a third party against the 123 | Indemnified Contributor to the extent caused by the acts or omissions of such 124 | Commercial Contributor in connection with its distribution of the Program in 125 | a commercial product offering. The obligations in this section do not apply 126 | to any claims or Losses relating to any actual or alleged intellectual 127 | property infringement. In order to qualify, an Indemnified Contributor must: 128 | a) promptly notify the Commercial Contributor in writing of such claim, and 129 | b) allow the Commercial Contributor tocontrol, and cooperate with the 130 | Commercial Contributor in, the defense and any related settlement 131 | negotiations. The Indemnified Contributor may participate in any such claim 132 | at its own expense. 133 | 134 | For example, a Contributor might include the Program in a commercial product 135 | offering, Product X. That Contributor is then a Commercial Contributor. If 136 | that Commercial Contributor then makes performance claims, or offers 137 | warranties related to Product X, those performance claims and warranties are 138 | such Commercial Contributor's responsibility alone. Under this section, the 139 | Commercial Contributor would have to defend claims against the other 140 | Contributors related to those performance claims and warranties, and if a 141 | court requires any other Contributor to pay any damages as a result, the 142 | Commercial Contributor must pay those damages. 143 | 144 | 5. NO WARRANTY 145 | 146 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON 147 | AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER 148 | EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR 149 | CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A 150 | PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the 151 | appropriateness of using and distributing the Program and assumes all risks 152 | associated with its exercise of rights under this Agreement , including but 153 | not limited to the risks and costs of program errors, compliance with 154 | applicable laws, damage to or loss of data, programs or equipment, and 155 | unavailability or interruption of operations. 156 | 157 | 6. DISCLAIMER OF LIABILITY 158 | 159 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY 160 | CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, 161 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION 162 | LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 163 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 164 | ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE 165 | EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY 166 | OF SUCH DAMAGES. 167 | 168 | 7. GENERAL 169 | 170 | If any provision of this Agreement is invalid or unenforceable under 171 | applicable law, it shall not affect the validity or enforceability of the 172 | remainder of the terms of this Agreement, and without further action by the 173 | parties hereto, such provision shall be reformed to the minimum extent 174 | necessary to make such provision valid and enforceable. 175 | 176 | If Recipient institutes patent litigation against any entity (including a 177 | cross-claim or counterclaim in a lawsuit) alleging that the Program itself 178 | (excluding combinations of the Program with other software or hardware) 179 | infringes such Recipient's patent(s), then such Recipient's rights granted 180 | under Section 2(b) shall terminate as of the date such litigation is filed. 181 | 182 | All Recipient's rights under this Agreement shall terminate if it fails to 183 | comply with any of the material terms or conditions of this Agreement and 184 | does not cure such failure in a reasonable period of time after becoming 185 | aware of such noncompliance. If all Recipient's rights under this Agreement 186 | terminate, Recipient agrees to cease use and distribution of the Program as 187 | soon as reasonably practicable. However, Recipient's obligations under this 188 | Agreement and any licenses granted by Recipient relating to the Program shall 189 | continue and survive. 190 | 191 | Everyone is permitted to copy and distribute copies of this Agreement, but in 192 | order to avoid inconsistency the Agreement is copyrighted and may only be 193 | modified in the following manner. The Agreement Steward reserves the right to 194 | publish new versions (including revisions) of this Agreement from time to 195 | time. No one other than the Agreement Steward has the right to modify this 196 | Agreement. The Eclipse Foundation is the initial Agreement Steward. The 197 | Eclipse Foundation may assign the responsibility to serve as the Agreement 198 | Steward to a suitable separate entity. Each new version of the Agreement will 199 | be given a distinguishing version number. The Program (including 200 | Contributions) may always be distributed subject to the version of the 201 | Agreement under which it was received. In addition, after a new version of 202 | the Agreement is published, Contributor may elect to distribute the Program 203 | (including its Contributions) under the new version. Except as expressly 204 | stated in Sections 2(a) and 2(b) above, Recipient receives no rights or 205 | licenses to the intellectual property of any Contributor under this 206 | Agreement, whether expressly, by implication, estoppel or otherwise. All 207 | rights in the Program not expressly granted under this Agreement are 208 | reserved. 209 | 210 | This Agreement is governed by the laws of the State of New York and the 211 | intellectual property laws of the United States of America. No party to this 212 | Agreement will bring a legal action under this Agreement more than one year 213 | after the cause of action arose. Each party waives its rights to a jury trial 214 | in any resulting litigation. 215 | -------------------------------------------------------------------------------- /Procfile: -------------------------------------------------------------------------------- 1 | web: java $JVM_OPTS -cp target/falkor-api.jar clojure.main -m falkor.main 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Falkor 2 | 3 | A web service for turning HTML pages into traversable JSON documents 4 | 5 | Very early stage development. If you have any feature requests just create an issue on the project 6 | 7 | ## Getting started 8 | 9 | Running the server locally 10 | 11 | ``` 12 | lein uberjar 13 | docker build -t falkor . 14 | docker run -t falkor 15 | 16 | # Visit http://localhost:5000 17 | ``` 18 | 19 | ## Comming soon 20 | 21 | + Better error handling 22 | + CORS 23 | + Query filtering (return only certain attributes) 24 | + Fetching multiple elements in a single request ( e.g [h1 > a, .subtitle] ) 25 | 26 | ## Usage 27 | 28 | Get all the title links from the Reddit.com home page 29 | 30 | https://falkor-api.herokuapp.com/api/query?url=http://reddit.com&query=a.title 31 | 32 | Grab all the news stories from Digg.com 33 | 34 | https://falkor-api.herokuapp.com/api/query?url=http://digg.com&query=.story-title%20a 35 | 36 | Extract all the images from Digg.com 37 | 38 | https://falkor-api.herokuapp.com/api/query?url=http://digg.com&query=img[src] 39 | 40 | ## TODO 41 | 42 | Filters to remove some of the attribute cruft 43 | 44 | For example if we just want to extract the text for an element and ignore the other attributes 45 | 46 | ``` 47 | &filter=[text] 48 | ``` 49 | 50 | ## License 51 | 52 | Copyright © 2015 Forward Digital Limited 53 | 54 | Distributed under the Eclipse Public License either version 1.0 or (at 55 | your option) any later version. 56 | -------------------------------------------------------------------------------- /logs.txt: -------------------------------------------------------------------------------- 1 | Request GET 2 | Request GET 3 | Request GET 4 | Request GET 5 | Request GET 6 | Request GET 7 | Request GET 8 | Request GET 9 | Request GET 10 | Request GET 11 | Request GET 12 | Request GET 13 | Request GET 14 | Request GET 15 | Request GET 16 | Request GET 17 | Request GET 18 | Request GET 19 | Request GET 20 | Request GET 21 | Request GET 22 | Request GET 23 | Request GET 24 | Request GET 25 | Request GET 26 | Request GET 27 | -------------------------------------------------------------------------------- /project.clj: -------------------------------------------------------------------------------- 1 | (defproject falkor "0.1.0-SNAPSHOT" 2 | :description "A web service that turns HTML pages into queryable JSON" 3 | :url "http://owainlewis.com" 4 | :license {:name "Eclipse Public License" 5 | :url "http://www.eclipse.org/legal/epl-v10.html"} 6 | :plugins [[lein-ring "0.9.5"]] 7 | :profiles {:uberjar {:aot :all}} 8 | :min-lein-version "2.0.0" 9 | :uberjar-name "falkor-api.jar" 10 | :ring {:handler falkor.server/handler} 11 | :dependencies [[org.clojure/clojure "1.6.0"] 12 | [compojure "1.3.4"] 13 | [environ "0.5.0"] 14 | [http-kit "2.1.18"] 15 | [ring/ring-core "1.3.2"] 16 | [ring/ring-jetty-adapter "1.2.2"] 17 | [ring/ring-json "0.3.1"] 18 | [ring/ring-defaults "0.1.4"] 19 | [org.jsoup/jsoup "1.8.2"] 20 | [cheshire "5.5.0"]]) 21 | -------------------------------------------------------------------------------- /resources/public/index.html: -------------------------------------------------------------------------------- 1 |

HELLO

2 | -------------------------------------------------------------------------------- /src/falkor/main.clj: -------------------------------------------------------------------------------- 1 | (ns falkor.main 2 | (:require 3 | [falkor.server :as fk] 4 | [environ.core :refer [env]] 5 | [ring.adapter.jetty :as jetty])) 6 | 7 | (defn -main 8 | "Run the server" 9 | [& [port]] 10 | (let [port (Integer. (or port (env :port) 5000))] 11 | (jetty/run-jetty fk/app {:port port :join? false}))) 12 | -------------------------------------------------------------------------------- /src/falkor/middleware.clj: -------------------------------------------------------------------------------- 1 | (ns falkor.middleware 2 | (:require [clojure.java.io :as io])) 3 | 4 | (defn format-request-method [method] 5 | (.toUpperCase (name method))) 6 | 7 | (defn format-log-message 8 | [req] 9 | (format "Request %s\n" 10 | (format-request-method (:request-method req)))) 11 | 12 | (defn wrap-logging [handler & opts] 13 | (fn [req] 14 | (with-open [wrtr (io/writer "logs.txt" :append true)] 15 | (println req) 16 | (.write wrtr (format-log-message req)) 17 | (handler req)))) 18 | -------------------------------------------------------------------------------- /src/falkor/parser.clj: -------------------------------------------------------------------------------- 1 | (ns falkor.parser 2 | (:import [org.jsoup.Jsoup] 3 | [org.jsoup.nodes Document Element])) 4 | 5 | (defn get-document 6 | "Retrieve a web page and cast it to a Document object. 7 | TODO: Replace the HTTP element with an async HTTP client eventually" 8 | [url] 9 | (.get (org.jsoup.Jsoup/connect url))) 10 | 11 | (defn extract-attributes-from-element 12 | "Given an HTML element := extract all the attributes into a map" 13 | [element] 14 | (let [attrs (.attributes element)] 15 | (reduce 16 | (fn [acc attr] 17 | (let [k (.getKey attr) 18 | v (.getValue attr)] 19 | (assoc acc (keyword k) v))) 20 | {} attrs))) 21 | 22 | (defrecord DOMElement [tag text attributes]) 23 | 24 | (defn element->map 25 | "Reduces a complex HTML element into a simple Clojure map. 26 | This abstracts away the need for complex rules around turning different element types 27 | into sensible representations" 28 | ([element render-children] 29 | (let [base-element { :tag (.tagName element) 30 | :text (.ownText element)} 31 | attributes (extract-attributes-from-element element)] 32 | (if render-children 33 | (merge (assoc base-element :children 34 | (map #(element->map % true) 35 | (.children element)))) 36 | (merge base-element {:attributes attributes})))) 37 | ([element] 38 | (element->map element false))) 39 | 40 | (def as-clojure (partial mapv element->map)) 41 | 42 | (defn ? 43 | "Select an element in a document by xpath selector" 44 | [^org.jsoup.nodes.Document doc xpath] 45 | (.select doc (name xpath))) 46 | 47 | (defn ?> 48 | "Query a URL for a given xpath selector" 49 | [url xpath] 50 | (? (get-document url) xpath)) 51 | 52 | (defn filter-by 53 | "Filter a sequence of results where k matches v 54 | For example we might want to filter a list of tags by class name like this 55 | (filter-by results [:attributes :class] \"foo\") 56 | " 57 | [xs k v] 58 | (filter 59 | (fn [m] 60 | (= (get-in m k) v)) xs)) 61 | 62 | (defn ??> 63 | "Given a document : run an xpath query and return the result 64 | transformed into an internal map" 65 | [doc xpath] 66 | (->> (? doc xpath) 67 | (map element->map))) 68 | 69 | (defn run-query [url xpath] 70 | (??> (get-document url) xpath)) 71 | 72 | (def first-selector (comp element->map first ?>)) 73 | 74 | (defn head [url] (first-selector url :head)) 75 | (defn body [url] (first-selector url :body)) 76 | 77 | (defn stylesheets [url] (?> url "link[rel=stylesheet]")) 78 | -------------------------------------------------------------------------------- /src/falkor/server.clj: -------------------------------------------------------------------------------- 1 | (ns falkor.server 2 | (:require [falkor.parser :as falkor] 3 | [falkor.util :refer [enforce-params json-handler wrap-as-result]] 4 | [falkor.middleware :as logging] 5 | [compojure.core :refer :all] 6 | [compojure.handler :as handler] 7 | [ring.middleware.json :as middleware] 8 | [ring.util.response :refer [resource-response response]] 9 | [ring.middleware.defaults :refer [wrap-defaults api-defaults]] 10 | [compojure.route :as route])) 11 | 12 | (defn query-handler 13 | "The query handler is used to render any xpath query" 14 | [params] 15 | (let [{:strs [url query] :as q} params] 16 | (enforce-params {:url url :query query} 17 | (try 18 | (let [result (falkor/run-query url query)] 19 | (json-handler 200 20 | (wrap-as-result result url query))) 21 | (catch Exception e 22 | (json-handler 500 23 | {:body "Request failed"})))))) 24 | 25 | (defn root-handler [] 26 | (json-handler 200 {:body "OK"})) 27 | 28 | (defroutes api-routes 29 | (GET "/api/query" {params :query-params} 30 | (query-handler params))) 31 | 32 | (defroutes base-routes 33 | (GET "/" [] 34 | (response "OK")) 35 | (route/resources "/") 36 | (route/not-found "

Page not found

")) 37 | 38 | (def all-routes (routes api-routes base-routes)) 39 | 40 | (def app 41 | (-> all-routes 42 | handler/api 43 | logging/wrap-logging 44 | (wrap-defaults api-defaults))) 45 | 46 | (def handler app) 47 | -------------------------------------------------------------------------------- /src/falkor/util.clj: -------------------------------------------------------------------------------- 1 | (ns falkor.util 2 | (:require [cheshire.core :as json])) 3 | 4 | (defn allow-cross-origin 5 | "Middleware function to allow crosss origin" 6 | [handler] 7 | (fn [request] 8 | (let [response (handler request)] 9 | (assoc-in response [:headers "Access-Control-Allow-Origin"] 10 | "*")))) 11 | 12 | (defmacro enforce-params 13 | "Checks is required parameters are present. If they are not 14 | return a 400 bad request" 15 | [m & body] 16 | `(let [missing# (for [[k# v#] ~m :when (nil? v#)] k#)] 17 | (if (empty? missing#) 18 | ~@body 19 | (let [msg# (str "The following params are missing: " 20 | (->> (identity missing#) 21 | (map name) 22 | (interpose " ") 23 | (apply str)))] 24 | (json-handler 400 25 | {:status 400 26 | :error msg#}))))) 27 | 28 | (defn json-handler [status body] 29 | {:status status 30 | :headers { 31 | "Content-Type" "application/json" 32 | "Access-Control-Allow-Methods" "GET" 33 | "Access-Control-Allow-Origin" "*" } 34 | :body (json/generate-string body {:pretty true})}) 35 | 36 | (defn wrap-as-result [m url query] 37 | {:url url 38 | :query query 39 | :results m}) 40 | -------------------------------------------------------------------------------- /swagger.yml: -------------------------------------------------------------------------------- 1 | swagger: '2.0' 2 | info: 3 | version: "0.1" 4 | title: Falkor API 5 | description: An API for web scrapping 6 | paths: 7 | /query: 8 | get: 9 | description: Execute a simple CSS selector query 10 | parameters: 11 | - 12 | name: url 13 | in: query 14 | description: A webpage URL to query 15 | required: true 16 | type: string 17 | - 18 | name: query 19 | in: query 20 | description: The CSS selector query to execute e.g a[href] 21 | required: true 22 | type: string 23 | responses: 24 | 200: 25 | description: Successful response 26 | 400: 27 | description: Bad request 28 | -------------------------------------------------------------------------------- /test/falkor/core_test.clj: -------------------------------------------------------------------------------- 1 | (ns falkor.core-test 2 | (:require [clojure.test :refer :all] 3 | [falkor.parser :refer :all])) 4 | 5 | (deftest test-compiles 6 | (testing "A OK" 7 | (is (= 1 1)))) 8 | --------------------------------------------------------------------------------