peridot

by xeqi

xeqi /peridot

a basic api for interacting with ring apps

130 Stars 19 Forks Last release: 10 months ago (v0.5.2) 161 Commits 23 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

peridot Build Status Dependencies Status

peridot is an interaction library for ring apps. Its functionality is based on an partial port of Rack::Test's test suite.

Dependency Information

Clojars Project

peridot's latest version and information on how to install it is available from clojars.

Usage

The api namespace is

peridot.core
. If you are using peridot in tests you may want to have
(:use [peridot.core])
in your
ns
declaration. All examples below assume so.

peridot is designed to be used with ->, and maintains cookies across requests in the threading.

Initialization

You can create an initial state with

session
.
(session ring-app) ;Use your ring app

Navigation

You can use

request
to send a request to your ring app.
(-> (session ring-app) ;Use your ring app
    (request "/")
    (request "/search" :request-method :post
                       :params {:q "clojure"}))

It will use

:get
by default. Options should be from the request map portion of the ring spec.

:params
should not be nested. Most params will be sent as
(str value)
. If a value is a
java.io.File
then peridot will send the request as a multipart form using the contents of the file.

peridot will not follow redirects automatically. To follow a redirect use

follow-redirect
. This will throw an
IllegalArgumentException
when the last response was not a redirect.
(-> (session ring-app) ;Use your ring app
    (request "/login" :request-method :post
                      :params {:username "someone"
                               :password "password"})
    (follow-redirect))

By default, when

POST
ing data, params will be encoded as
application/x-www-form-urlencoded
. If you want to use an alternative encoding, you can pass
:content-type
as an option, and use
:body
instead of
:params
.
(-> (session ring-app) ;Use your ring app
    (request "/login" :request-method :post
                      :content-type "application/xml"
                      :body ""))

Cookies

peridot will manage cookies through the threading. This allows you to login and perform actions as that user.

(-> (session ring-app) ;Use your ring app
    (request "/login" :request-method :post
                      :params {:username "someone"
                               :password "password"})
    (follow-redirect)
    (request "/tasks")
    (request "/tasks/create" ...)
    (request "/tasks/1")

Persistent Information

It can be useful to set persistent information across requests.

header
will set a header.
authorize
will use basic authentication.
content-type
will set the content-type.
(-> (session ring-app) ;Use your ring app
    (header "User-Agent" "Firefox")
    (authorize "bryan" "secret")
    (content-type "application/json")
    (request "/tasks/create" :request-method :put
                             :body some-json))

Querying

The state information returned by each function has

:request
and
:response
for information from the last interaction with the ring app.

Transactions and database setup

peridot runs without an http server and, depending on your setup, transactions can be used to rollback and isolate tests. Some fixtures may be helpful:

(use-fixtures :once
              (fn [f]
                (clojure.java.jdbc/with-connection db (f))))
(use-fixtures :each
              (fn [f]
                (clojure.java.jdbc/transaction
                 (clojure.java.jdbc/set-rollback-only)
                 (f))))

Building

leiningen version 2 is used as the build tool.

lein2 all test
will run the test suite against clojure 1.3, 1.4 and 1.5.1.

License

Copyright (C) 2013 Nelson Morris and contributors

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.