surf

README

Surf

Surf is a Go (golang) library that implements a virtual web browser that you control programmatically. Surf isn't just another Go solution for downloading content from the web. Surf is designed to behave like web browser, and includes: cookie management, history, bookmarking, user agent spoofing (with a nifty user agent builder), submitting forms, DOM selection and traversal via jQuery style CSS selectors, scraping assets like images, stylesheets, and other features.

NOTE: DEVELOPMENT ON THIS PROJECT IS VERY SLOW!
I'm accepting pull requests and fixing bugs at a snail's pace right now. Partially because Surf has taken a backseat to projects which are more important to me, and the way Go handles vendoring makes me hesitant to make changes. Development will pick up again when I have more free time.

Work has started on v2.0 on the v2 branch.

• Installation
• General Usage
• Documentation
• Credits
• Contributing
• License

Installation

Download the library using go.
go get gopkg.in/headzoo/surf.v1

Import the library into your project.
import "gopkg.in/headzoo/surf.v1"

Quick Start

package main

import (
	"gopkg.in/headzoo/surf.v1"
	"fmt"
)

func main() {
	bow := surf.NewBrowser()
	err := bow.Open("http://golang.org")
	if err != nil {
		panic(err)
	}
	
	// Outputs: "The Go Programming Language"
	fmt.Println(bow.Title())
}

Documentation

Complete documentation is available on Read the Docs.

Credits

Surf was started by Sean Hickey (headzoo) to learn more about the Go programming language. The idea to create Surf was born in this Reddit thread.

Surf uses the awesome goquery by Martin Angers, and was written using Intellij and the golang plugin.

Contributions have been made to Surf by the following awesome developers:

• Haruyama Seigo
• Tatsushi Demachi
• Charl Matthee
• Matt Holt
• lalyos
• lestrrat
• Carl Henrik Lunde
• cornerot
• lennyxc
• tlianza
• joshuamorris3
• sqs
• nicot

Contributing

Issues and pull requests are always welcome. Code changes are made to the dev branch. Once a milestone has been reached the branch will be merged in with master, and a new version tag created. Do not make your changes against the master branch, or they will may be ignored.

See CONTRIBUTING.md for more information.

License

Surf is released open source software released under The MIT License (MIT). See LICENSE.md for more information.

Documentation

Overview

Package surf ensembles other packages into a usable browser.

Index

• Variables
• func NewBrowser() *browser.Browser

Variables

var (
	// DefaultUserAgent is the global user agent value.
	DefaultUserAgent = agent.Create()

	// DefaultSendReferer is the global value for the AttributeSendReferer attribute.
	DefaultSendReferer = true

	// DefaultMetaRefreshHandling is the global value for the AttributeHandleRefresh attribute.
	DefaultMetaRefreshHandling = true

	// DefaultFollowRedirects is the global value for the AttributeFollowRedirects attribute.
	DefaultFollowRedirects = true
)

Functions

func NewBrowser

func NewBrowser() *browser.Browser

NewBrowser creates and returns a *browser.Browser type.