fetch

Documentation

Overview

Copyright 2016-2019 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• type Fetcher
  • func NewFetcher(at string, pm map[string]bool, rt http.RoundTripper) (*Fetcher, error)
  • func (f *Fetcher) SlurpCodelab(src string, output string) (*codelab, error)
  • func (f *Fetcher) SlurpImages(src, dir string, n []nodes.Node, images map[string]string) error
• type MemoryFetcher
  • func NewMemoryFetcher(pm map[string]bool) *MemoryFetcher
  • func (m *MemoryFetcher) SlurpCodelab(rc io.ReadCloser) (*codelab, error)

Constants

const (
	// supported codelab source types must be registered parsers
	// TODO: define these in claat/parser/..., e.g. in parser/gdoc
	// alternate TODO: make this an iota-based enum?
	SrcInvalid   srcType = ""
	SrcGoogleDoc srcType = "gdoc" // Google Docs doc
	SrcMarkdown  srcType = "md"   // Markdown text

)

Types

type Fetcher

type Fetcher struct {
	// contains filtered or unexported fields
}

func NewFetcher

func NewFetcher(at string, pm map[string]bool, rt http.RoundTripper) (*Fetcher, error)

NewFetcher creates an instance of Fetcher.

func (*Fetcher) SlurpCodelab

func (f *Fetcher) SlurpCodelab(src string, output string) (*codelab, error)

SlurpCodelab retrieves and parses codelab source. It takes the source, plus an auth token and a set of extra metadata to pass along. It returns parsed codelab and its source type.

The function will also fetch and parse fragments included with nodes.ImportNode.

func (*Fetcher) SlurpImages

func (f *Fetcher) SlurpImages(src, dir string, n []nodes.Node, images map[string]string) error

type MemoryFetcher

type MemoryFetcher struct {
	// contains filtered or unexported fields
}

func NewMemoryFetcher

func NewMemoryFetcher(pm map[string]bool) *MemoryFetcher

func (*MemoryFetcher) SlurpCodelab

func (m *MemoryFetcher) SlurpCodelab(rc io.ReadCloser) (*codelab, error)