newsapi

README

NewsAPI Client

This package provides a client for the NewsAPI API, which is used to interact with the NewsAPI service.

References:

• API https://newsapi.org/docs
• Package https://pkg.go.dev/github.com/mutablelogic/go-client/pkg/newsapi

Documentation

Overview

newsapi implements an API client for NewsAPI (https://newsapi.org/docs)

Index

• type Article
• type Client
  • func New(ApiKey string, opts ...client.ClientOpt) (*Client, error)
  • func (c *Client) Articles(opt ...Opt) ([]Article, error)
  • func (c *Client) Headlines(opt ...Opt) ([]Article, error)
  • func (c *Client) Sources(opt ...Opt) ([]Source, error)
  • func (c *Client) Tools() []agent.Tool
• type Opt
  • func OptCategory(v string) Opt
  • func OptCountry(v string) Opt
  • func OptLanguage(v string) Opt
  • func OptLimit(v int) Opt
  • func OptQuery(v string) Opt
  • func OptSortByDate() Opt
  • func OptSortByPopularity() Opt
  • func OptSortByRelevancy() Opt
• type Source

Types

type Article

type Article struct {
	Source      Source    `json:"source"`
	Title       string    `json:"title"`
	Author      string    `json:"author,omitempty"`
	Description string    `json:"description,omitempty"`
	Url         string    `json:"url,omitempty"`
	ImageUrl    string    `json:"urlToImage,omitempty"`
	PublishedAt time.Time `json:"publishedAt,omitempty"`
	Content     string    `json:"content,omitempty"`
}

type Client

type Client struct {
	*client.Client
}

func New

func New(ApiKey string, opts ...client.ClientOpt) (*Client, error)

func (*Client) Articles

func (c *Client) Articles(opt ...Opt) ([]Article, error)

Returns articles

func (*Client) Headlines

func (c *Client) Headlines(opt ...Opt) ([]Article, error)

Returns headlines

func (*Client) Sources

func (c *Client) Sources(opt ...Opt) ([]Source, error)

Sources returns all the models. The options which can be passed are:

  OptCategory: The category you would like to get sources for. Possible
			  options are business, entertainment, general, health, science, sports,
			  technology.

  OptLanguage: The language you would like to get sources for

  OptCountry: The country you would like to get sources for

func (*Client) Tools

func (c *Client) Tools() []agent.Tool

Return all the agent tools for the weatherapi

type Opt

type Opt func(*opts) error

Opt is a function which can be used to set options on a request

func OptCategory

func OptCategory(v string) Opt

Set the category

func OptCountry

func OptCountry(v string) Opt

Set the country

func OptLanguage

func OptLanguage(v string) Opt

Set the language

func OptLimit

func OptLimit(v int) Opt

Set the number of results

func OptQuery

func OptQuery(v string) Opt

Set the query

func OptSortByDate

func OptSortByDate() Opt

Sort for articles by date

func OptSortByPopularity

func OptSortByPopularity() Opt

Sort for articles by popularity

func OptSortByRelevancy

func OptSortByRelevancy() Opt

Sort for articles by relevancy

type Source

type Source struct {
	Id          string `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
	Url         string `json:"url,omitempty"`
	Category    string `json:"category,omitempty"`
	Language    string `json:"language,omitempty"`
	Country     string `json:"country,omitempty"`
}