metacpan

README

go-metacpan

go-metacpan is library for go language to use metacpan API.

Example

See example directory.

Installation

go get github.com/handlename/go-metacpan

Usage

Licence

MIT

Author

handlename

Documentation

Index

• Constants
• type AutocompleteFields
• type AutocompleteHit
  • func SearchAutocomplete(q string) ([]AutocompleteHit, error)
  • func (a AutocompleteHit) URL() string
• type AutocompleteHits
• type AutocompleteResult
• type Distribution
  • func SearchDistribution(q string) ([]Distribution, error)
  • func (d Distribution) Name() string
  • func (d Distribution) URL() string
• type DistributionHits
• type SearchDistributionResult

Constants

const (
	APISearchAutocomplete = "/v1/search/autocomplete"
	APISearchDistribution = "/v1/distribution/_search"
)

APIs

Types

type AutocompleteFields

type AutocompleteFields struct {
	Author        string `json:"author"`
	Release       string `json:"release"`
	Documentation string `json:"documentation"`
	Distribution  string `json:"distribution"`
}

The AutocompleteFields defines fields in search result of autocomplete API.

type AutocompleteHit

type AutocompleteHit struct {
	Fields AutocompleteFields `json:"fields"`
}

The AutocompleteHit defines one of search result of autocomplete API.

func SearchAutocomplete

func SearchAutocomplete(q string) ([]AutocompleteHit, error)

SearchAutocomplete search autocomplete by query and returns hits.

func (AutocompleteHit) URL

func (a AutocompleteHit) URL() string

URL returns url on metacpan.

type AutocompleteHits

type AutocompleteHits struct {
	Hits []AutocompleteHit `json:"hits"`
}

The AutocompleteHits defines hits in search result of autocomplete API.

type AutocompleteResult

type AutocompleteResult struct {
	Hits AutocompleteHits `json:"hits"`
}

The AutocompleteResult defines search result of autocomplete API.

type Distribution

type Distribution struct {
	ID string `json:"_id"`
}

The Distribution defines type of a distribution.

func SearchDistribution

func SearchDistribution(q string) ([]Distribution, error)

SearchDistribution search distribution by query and returns hits.

func (Distribution) Name

func (d Distribution) Name() string

Name returns module name.

func (Distribution) URL

func (d Distribution) URL() string

URL returns url on metacpan.

type DistributionHits

type DistributionHits struct {
	Hits []Distribution `json:"hits"`
}

The DistributionHits defines search results.

type SearchDistributionResult

type SearchDistributionResult struct {
	Hits DistributionHits `json:"hits"`
}

The SearchDistributionResult defines result of search distribution.