Skip to content
Browse files

Release 1.0.0. Move ns to clojure-http.client!

Add rebindable *buffer-size* for copying request bodies.
  • Loading branch information...
1 parent 67b4e08 commit 79ca335d3b5d94e818711e170130f2963611f610 @technomancy technomancy committed May 18, 2010
View
1 .gitignore
@@ -4,3 +4,4 @@ lib
classes
*.jar
Manifest.txt
+autodoc
View
227 COPYING
@@ -0,0 +1,227 @@
+Eclipse Public License - v 1.0
+
+THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
+PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF
+THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
+
+1. DEFINITIONS
+
+"Contribution" means:
+
+a) in the case of the initial Contributor, the initial code and
+documentation distributed under this Agreement, and
+
+b) in the case of each subsequent Contributor:
+
+i) changes to the Program, and
+
+ii) additions to the Program;
+
+where such changes and/or additions to the Program originate from and
+are distributed by that particular Contributor. A Contribution
+'originates' from a Contributor if it was added to the Program by such
+Contributor itself or anyone acting on such Contributor's
+behalf. Contributions do not include additions to the Program which:
+(i) are separate modules of software distributed in conjunction with
+the Program under their own license agreement, and (ii) are not
+derivative works of the Program.
+
+"Contributor" means any person or entity that distributes the Program.
+
+"Licensed Patents" mean patent claims licensable by a Contributor
+which are necessarily infringed by the use or sale of its Contribution
+alone or when combined with the Program.
+
+"Program" means the Contributions distributed in accordance with this
+Agreement.
+
+"Recipient" means anyone who receives the Program under this
+Agreement, including all Contributors.
+
+2. GRANT OF RIGHTS
+
+a) Subject to the terms of this Agreement, each Contributor hereby
+grants Recipient a non-exclusive, worldwide, royalty-free copyright
+license to reproduce, prepare derivative works of, publicly display,
+publicly perform, distribute and sublicense the Contribution of such
+Contributor, if any, and such derivative works, in source code and
+object code form.
+
+b) Subject to the terms of this Agreement, each Contributor hereby
+grants Recipient a non-exclusive, worldwide, royalty-free patent
+license under Licensed Patents to make, use, sell, offer to sell,
+import and otherwise transfer the Contribution of such Contributor, if
+any, in source code and object code form. This patent license shall
+apply to the combination of the Contribution and the Program if, at
+the time the Contribution is added by the Contributor, such addition
+of the Contribution causes such combination to be covered by the
+Licensed Patents. The patent license shall not apply to any other
+combinations which include the Contribution. No hardware per se is
+licensed hereunder.
+
+c) Recipient understands that although each Contributor grants the
+licenses to its Contributions set forth herein, no assurances are
+provided by any Contributor that the Program does not infringe the
+patent or other intellectual property rights of any other entity. Each
+Contributor disclaims any liability to Recipient for claims brought by
+any other entity based on infringement of intellectual property rights
+or otherwise. As a condition to exercising the rights and licenses
+granted hereunder, each Recipient hereby assumes sole responsibility
+to secure any other intellectual property rights needed, if any. For
+example, if a third party patent license is required to allow
+Recipient to distribute the Program, it is Recipient's responsibility
+to acquire that license before distributing the Program.
+
+d) Each Contributor represents that to its knowledge it has sufficient
+copyright rights in its Contribution, if any, to grant the copyright
+license set forth in this Agreement.
+
+3. REQUIREMENTS
+
+A Contributor may choose to distribute the Program in object code form
+under its own license agreement, provided that:
+
+a) it complies with the terms and conditions of this Agreement; and
+
+b) its license agreement:
+
+i) effectively disclaims on behalf of all Contributors all warranties
+and conditions, express and implied, including warranties or
+conditions of title and non-infringement, and implied warranties or
+conditions of merchantability and fitness for a particular purpose;
+
+ii) effectively excludes on behalf of all Contributors all liability
+for damages, including direct, indirect, special, incidental and
+consequential damages, such as lost profits;
+
+iii) states that any provisions which differ from this Agreement are
+offered by that Contributor alone and not by any other party; and
+
+iv) states that source code for the Program is available from such
+Contributor, and informs licensees how to obtain it in a reasonable
+manner on or through a medium customarily used for software exchange.
+
+When the Program is made available in source code form:
+
+a) it must be made available under this Agreement; and
+
+b) a copy of this Agreement must be included with each copy of the Program.
+
+Contributors may not remove or alter any copyright notices contained
+within the Program.
+
+Each Contributor must identify itself as the originator of its
+Contribution, if any, in a manner that reasonably allows subsequent
+Recipients to identify the originator of the Contribution.
+
+4. COMMERCIAL DISTRIBUTION
+
+Commercial distributors of software may accept certain
+responsibilities with respect to end users, business partners and the
+like. While this license is intended to facilitate the commercial use
+of the Program, the Contributor who includes the Program in a
+commercial product offering should do so in a manner which does not
+create potential liability for other Contributors. Therefore, if a
+Contributor includes the Program in a commercial product offering,
+such Contributor ("Commercial Contributor") hereby agrees to defend
+and indemnify every other Contributor ("Indemnified Contributor")
+against any losses, damages and costs (collectively "Losses") arising
+from claims, lawsuits and other legal actions brought by a third party
+against the Indemnified Contributor to the extent caused by the acts
+or omissions of such Commercial Contributor in connection with its
+distribution of the Program in a commercial product offering. The
+obligations in this section do not apply to any claims or Losses
+relating to any actual or alleged intellectual property
+infringement. In order to qualify, an Indemnified Contributor must: a)
+promptly notify the Commercial Contributor in writing of such claim,
+and b) allow the Commercial Contributor tocontrol, and cooperate with
+the Commercial Contributor in, the defense and any related settlement
+negotiations. The Indemnified Contributor may participate in any such
+claim at its own expense.
+
+For example, a Contributor might include the Program in a commercial
+product offering, Product X. That Contributor is then a Commercial
+Contributor. If that Commercial Contributor then makes performance
+claims, or offers warranties related to Product X, those performance
+claims and warranties are such Commercial Contributor's responsibility
+alone. Under this section, the Commercial Contributor would have to
+defend claims against the other Contributors related to those
+performance claims and warranties, and if a court requires any other
+Contributor to pay any damages as a result, the Commercial Contributor
+must pay those damages.
+
+5. NO WARRANTY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS
+PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY
+WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY
+OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely
+responsible for determining the appropriateness of using and
+distributing the Program and assumes all risks associated with its
+exercise of rights under this Agreement , including but not limited to
+the risks and costs of program errors, compliance with applicable
+laws, damage to or loss of data, programs or equipment, and
+unavailability or interruption of operations.
+
+6. DISCLAIMER OF LIABILITY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR
+ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING
+WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR
+DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
+HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+7. GENERAL
+
+If any provision of this Agreement is invalid or unenforceable under
+applicable law, it shall not affect the validity or enforceability of
+the remainder of the terms of this Agreement, and without further
+action by the parties hereto, such provision shall be reformed to the
+minimum extent necessary to make such provision valid and enforceable.
+
+If Recipient institutes patent litigation against any entity
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+the Program itself (excluding combinations of the Program with other
+software or hardware) infringes such Recipient's patent(s), then such
+Recipient's rights granted under Section 2(b) shall terminate as of
+the date such litigation is filed.
+
+All Recipient's rights under this Agreement shall terminate if it
+fails to comply with any of the material terms or conditions of this
+Agreement and does not cure such failure in a reasonable period of
+time after becoming aware of such noncompliance. If all Recipient's
+rights under this Agreement terminate, Recipient agrees to cease use
+and distribution of the Program as soon as reasonably
+practicable. However, Recipient's obligations under this Agreement and
+any licenses granted by Recipient relating to the Program shall
+continue and survive.
+
+Everyone is permitted to copy and distribute copies of this Agreement,
+but in order to avoid inconsistency the Agreement is copyrighted and
+may only be modified in the following manner. The Agreement Steward
+reserves the right to publish new versions (including revisions) of
+this Agreement from time to time. No one other than the Agreement
+Steward has the right to modify this Agreement. The Eclipse Foundation
+is the initial Agreement Steward. The Eclipse Foundation may assign
+the responsibility to serve as the Agreement Steward to a suitable
+separate entity. Each new version of the Agreement will be given a
+distinguishing version number. The Program (including Contributions)
+may always be distributed subject to the version of the Agreement
+under which it was received. In addition, after a new version of the
+Agreement is published, Contributor may elect to distribute the
+Program (including its Contributions) under the new version. Except as
+expressly stated in Sections 2(a) and 2(b) above, Recipient receives
+no rights or licenses to the intellectual property of any Contributor
+under this Agreement, whether expressly, by implication, estoppel or
+otherwise. All rights in the Program not expressly granted under this
+Agreement are reserved.
+
+This Agreement is governed by the laws of the State of Washington and
+the intellectual property laws of the United States of America. No
+party to this Agreement will bring a legal action under this Agreement
+more than one year after the cause of action arose. Each party waives
+its rights to a jury trial in any resulting litigation.
View
57 README.markdown
@@ -2,29 +2,32 @@
by Dan Larkin and Phil Hagelberg
-A work in progress.
+Note: In the 1.0.0 release the namespace changed from clojure.http to
+clojure-http; please update your require clauses accordingly.
-There are two namespaces, clojure.http.client, which provides a simple
-"request" function, and clojure.http.resourcefully, which is targeted
+## Example
+
+There are two namespaces, clojure-http.client, which provides a simple
+"request" function, and clojure-http.resourcefully, which is targeted
more towards interactions with REST-based APIs.
- (ns clojure.http.example
- (:use [clojure.http.client]
+ (ns clojure-http.example
+ (:use [clojure-http.client]
[clojure.contrib.json.write])
- (:require [clojure.http.resourcefully :as resourcefully]))
+ (:require [clojure-http.resourcefully :as res]))
(let [response (request "http://google.com")]
(:code response) ;; 200
(:msg response) ;; "OK"
(:body-seq response)) ;; ("<html><head><meta[...]" ...
- (resourcefully/put "http://localhost:5984/my-db/doc1"
- {} (json-str {:hello "world"}))
+ (resurcefully/put "http://localhost:5984/my-db/doc1"
+ {} (json-str {:hello "world"}))
- (resourcefully/with-cookies {}
- (resourcefully/post "http://localhost:3000/login"
- {} {"user" user "password" password})
- (resourcefully/get "http://localhost:3000/my-secret-page))
+ (res/with-cookies {}
+ (res/post "http://localhost:3000/login"
+ {} {"user" user "password" password})
+ (res/get "http://localhost:3000/my-secret-page))
The request function requires a URL and optionally accepts a method
(GET by default), a map of headers, a map of cookies, and a request
@@ -33,19 +36,25 @@ and an optional body.
Request bodies may be strings, maps, or InputStreams. Strings get sent
verbatim. Maps get sent as application/x-www-form-urlencoded, and
-InputStreams get streamed to the server 1000 bytes at a time.
+InputStreams get streamed to the server 1024 bytes at a time, though
+this can be changed by rebinding \*buffer-size\*.
+
+## Usage
The functions in resourcefully are named after the HTTP verbs. Note
-that resourcefully must be required :as something since it defines a
-"get" function, which would interfere with core if it were fully
-referred. Exceptions will be raised for status codes that indicate
-problems, so you don't have to check return codes manually. If you use
-resourcefully inside a "with-cookies" block, cookies will
-automatically be saved in a *cookies* ref and sent out with each
-request.
-
-TODO:
+that resourcefully must be required with the :as option since it
+defines a "get" function, which would interfere with clojure.core if
+it were fully referred. Exceptions will be raised for status codes
+that indicate problems, so you don't have to check return codes
+manually. If you use resourcefully inside a "with-cookies" block,
+cookies will automatically be saved in a *cookies* ref and sent out
+with each request.
+
+## TODO
+
* Connection pooling/keep-alive?
-* Anything else? Send a message via github or the Clojure mailing list.
+* Anything else? Send a message via Github or the Clojure mailing list.
+
+Copyright (c) 2009-2010 Dan Larkin and Phil Hagelberg
-Licensed under the same terms as Clojure.
+Licensed under the same terms as Clojure. See COPYING
View
46 pom.xml
@@ -1,46 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project>
- <modelVersion>4.0.0</modelVersion>
- <groupId>clojure-http-client</groupId>
- <artifactId>clojure-http-client</artifactId>
- <version>1.0.0-SNAPSHOT</version>
- <name>clojure-http-client</name>
- <description>An HTTP client for Clojure.</description>
- <scm>
- <connection>scm:git:git://github.com/technomancy/clojure-http-client.git</connection>
- <developerConnection>scm:git:ssh://git@github.com/technomancy/clojure-http-client.git</developerConnection>
- <tag>6254aa2f28cc9567ab54e898a653c3c23e786544</tag>
- <url>http://github.com/technomancy/clojure-http-client</url>
- </scm>
- <repositories>
- <repository>
- <id>central</id>
- <url>http://repo1.maven.org/maven2</url>
- </repository>
- <repository>
- <id>clojure-snapshots</id>
- <url>http://build.clojure.org/snapshots</url>
- </repository>
- <repository>
- <id>clojars</id>
- <url>http://clojars.org/repo/</url>
- </repository>
- </repositories>
- <dependencies>
- <dependency>
- <groupId>org.clojure</groupId>
- <artifactId>clojure</artifactId>
- <version>1.1.0-master-SNAPSHOT</version>
- </dependency>
- <dependency>
- <groupId>org.clojure</groupId>
- <artifactId>clojure-contrib</artifactId>
- <version>1.0-SNAPSHOT</version>
- </dependency>
- </dependencies>
-</project>
-
-<!-- This file was autogenerated by the Leiningen build tool.
- Please do not edit it directly; instead edit project.clj and regenerate it.
- It should not be considered canonical data. For more information see
- http://github.com/technomancy/leiningen -->
View
9 project.clj
@@ -1,5 +1,6 @@
-(defproject clojure-http-client "1.0.0-SNAPSHOT"
+(defproject clojure-http-client "1.0.0"
:description "An HTTP client for Clojure."
- :dependencies [[org.clojure/clojure "1.2.0-master-SNAPSHOT"]
- [org.clojure/clojure-contrib "1.2.0-SNAPSHOT"]]
- :dev-dependencies [[swank-clojure "1.1.0"]])
+ :dev-dependencies [[org.clojure/clojure "1.2.0-master-SNAPSHOT"]
+ [org.clojure/clojure-contrib "1.2.0-SNAPSHOT"]
+ [swank-clojure "1.2.1"]
+ [autodoc "0.7.0"]])
View
8 src/clojure/http/client.clj → src/clojure_http/client.clj
@@ -1,4 +1,4 @@
-(ns clojure.http.client
+(ns clojure-http.client
(:use [clojure.contrib.java-utils :only [as-str]]
[clojure.contrib.duck-streams :only [read-lines spit]]
[clojure.contrib.str-utils :only [str-join]]
@@ -8,13 +8,15 @@
HttpURLConnection)
(java.io StringReader InputStream)))
-(def default-headers {"User-Agent" (str "Clojure/" *clojure-version*
+(def default-headers {"User-Agent" (str "Clojure/" (clojure-version)
" (+http://clojure.org)"),
"Accept" "*/*",
"Connection" "close"})
(def *connect-timeout* 0)
+(def *buffer-size* 1024)
+
(defn set-system-proxy!
"Java's HttpURLConnection cannot do per-request proxying. Instead,
system properties are used. This function mutates the global setting.
@@ -51,7 +53,7 @@ representation of argument, either a string or map."
(string? body) (spit out body)
(map? body) (spit out (url-encode body))
(instance? InputStream body)
- (let [bytes (make-array Byte/TYPE 1000)]
+ (let [bytes (make-array Byte/TYPE *buffer-size*)]
(loop [#^InputStream stream body
bytes-read (.read stream bytes)]
(when (pos? bytes-read)
View
34 src/clojure/http/resourcefully.clj → src/clojure_http/resourcefully.clj
@@ -1,24 +1,20 @@
-;;; resourcefully.clj
-;;
-;; A wrapper around client.clj that's designed for accessing RESTful
-;; APIs pleasantly.
-;;
-;; Since resourcefully defines a get function, you'll need to :use it
-;; :as resourcefully rather than in an unqualified way.
-;;
-;; (ns your-ns
-;; (:use [clojure.http.resourcefully :as resourcefully]))
-;;
-;; (resourcefully/get "http://clojure.org")
-;; (with-cookies
-;; (resourcefully/post "https://www.google.com/accounts/LoginAuth" {}
-;; {"Email" "clojure@gmail.com" "Passwd" "conj"})
-;; (resourcefully/get "http://www.google.com/reader"))
-;;
+(ns clojure-http.resourcefully
+ "A wrapper around client.clj that's designed for accessing RESTful
+ APIs pleasantly.
-(ns clojure.http.resourcefully
+ Since resourcefully defines a get function, you'll need to :use it
+ :as resourcefully rather than in an unqualified way.
+
+ (ns your-ns
+ (:use [clojure.http.resourcefully :as resourcefully]))
+
+ (resourcefully/get \"http://clojure.org\")
+ (with-cookies
+ (resourcefully/post \"https://www.google.com/accounts/LoginAuth\" {}
+ {\"Email\" \"clojure@gmail.com\" \"Passwd\" \"conj\"})
+ (resourcefully/get \"http://www.google.com/reader\"))"
(:use [clojure.contrib.str-utils :only [str-join]])
- (:use [clojure.http.client :as client])
+ (:use [clojure-http.client :as client])
(:refer-clojure :exclude [get]))
(def *cookies* nil)
View
16 test/clojure/http/test/client.clj → test/clojure_http/test/client.clj
@@ -1,11 +1,9 @@
-;; (add-classpath "file:///home/phil/src/clojure-http-client/src/")
-
-(ns clojure.http.test.client
- (:use [clojure.http.client] :reload)
- (:use [clojure.contrib.test-is]
- [clojure.contrib.duck-streams]
- [clojure.contrib.str-utils]
- [clojure.contrib.server-socket]))
+(ns clojure-http.test.client
+ (:use [clojure-http.client] :reload)
+ (:use [clojure.test]
+ [clojure.contrib.duck-streams :only [reader writer]]
+ [clojure.contrib.str-utils :only [str-join]]
+ [clojure.contrib.server-socket :only [create-server]]))
(def test-port 8239)
@@ -52,4 +50,4 @@
;; (deftest request-body
;; (let [response (request (str "http://localhost:" test-port)
;; :get {} {} {"hey" "düde"})]
-;; (is (some #{"o=hai+dere&hey=d%C3%B6od"} (:body-seq response)))))
+;; (is (some #{"o=hai+dere&hey=d%C3%B6od"} (:body-seq response)))))

0 comments on commit 79ca335

Please sign in to comment.
Something went wrong with that request. Please try again.