cmd

Documentation

Index

• Constants
• Variables
• func CheckCurrentProjectFolder() (*brute.Config, error)
• func CheckExistingValidProject(files []os.FileInfo) (*brute.Config, error)
• func ConfigRoutes(config *brute.Config)
• func CreateNewProject() (*brute.Config, error)
• func CreateProjectFiles(config *brute.Config)
• func DeployAsLive(args ...string) error
• func Libraries() []string
• func ModifyProjectConfig(config *brute.Config)
• func ProcessArgument(args ...string) error
• func ProcessLegalMenu(args ...string) error
• func ProcessTypeForAdd(args ...string) error
• func ProcessTypeForRemove(args ...string) error
• func ProcessTypeForUpdate(args ...string) error
• func RunService() net.Listener
• func SetNameOfRoute() string
• func SetPathOfRoute() string
• func Summary(library string) string
• type Dependency
  • func RetrieveLibrary(library string) Dependency
• type EmptyGoTemplate
• type License
• type ServiceMessage
  • func (msg *ServiceMessage) Execute()

Constants

const (
	ServiceHost = "localhost"
	ServicePort = "11792"
	ServiceType = "tcp"
)

Variables

var Licenses = []Dependency{
	{
		Name:                   "go-bindata-assetfs",
		ReasonsWhyBruteLovesIt: "Brute uses this library to explicitly embed binary information of the file rather than using file handling at runtime.",
		Link:                   "https://github.com/elazarl/go-bindata-assetfs",
		License: License{
			Name: `BSD 2-clause "Simplified" License`,
			Notice: `
Copyright (c) 2014, Elazar Leibovich
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 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
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
`,
		},
	},
	{
		Name:                   "notify",
		ReasonsWhyBruteLovesIt: "Every time you save your endpoints, Brute automatically refreshes your endpoint on the go without restarting Brute. Source code changes are detected by the help of this library.",
		Link:                   "https://github.com/rjeczalik/notify",
		License: License{
			Name: "MIT License",
			Notice: `
The MIT License (MIT)

Copyright (c) 2014-2015 The Notify Authors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
`,
		},
	},
	{
		Name:                   "mux",
		ReasonsWhyBruteLovesIt: "Why reinvent the wheel when there's an existing library that does more than pattern matching. When you access a Brute endpoint with parameterized URIs, this library checks the endpoint and routes it to your endpoint source code.",
		Link:                   "https://github.com/gorilla/mux",
		License: License{
			Name: `BSD 3-clause "New" or "Revised" License`,
			Notice: `
Copyright (c) 2012 Rodrigo Moraes. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

	 * Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
	 * Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
	 * Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 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
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
`,
		},
	},
}

Functions

func CheckCurrentProjectFolder

func CheckCurrentProjectFolder() (*brute.Config, error)

func CheckExistingValidProject

func CheckExistingValidProject(files []os.FileInfo) (*brute.Config, error)

func ConfigRoutes

func ConfigRoutes(config *brute.Config)

func CreateNewProject

func CreateNewProject() (*brute.Config, error)

func CreateProjectFiles

func CreateProjectFiles(config *brute.Config)

func DeployAsLive

func DeployAsLive(args ...string) error

func Libraries

func Libraries() []string

func ModifyProjectConfig

func ModifyProjectConfig(config *brute.Config)

func ProcessArgument

func ProcessArgument(args ...string) error

func ProcessLegalMenu

func ProcessLegalMenu(args ...string) error

func ProcessTypeForAdd

func ProcessTypeForAdd(args ...string) error

func ProcessTypeForRemove

func ProcessTypeForRemove(args ...string) error

func ProcessTypeForUpdate

func ProcessTypeForUpdate(args ...string) error

func RunService

func RunService() net.Listener

func SetNameOfRoute

func SetNameOfRoute() string

func SetPathOfRoute

func SetPathOfRoute() string

func Summary

func Summary(library string) string

Types

type Dependency

type Dependency struct {
	Name                   string
	ReasonsWhyBruteLovesIt string
	Link                   string
	License
}

func RetrieveLibrary

func RetrieveLibrary(library string) Dependency

type EmptyGoTemplate

type EmptyGoTemplate struct {
	Path string
}

type License

type License struct {
	Name   string
	Notice string
}

type ServiceMessage

type ServiceMessage struct {
	Command string
}

func (*ServiceMessage) Execute

func (msg *ServiceMessage) Execute()