|
| 1 | +// Package newsbox provides a client for accessing newsbox services. |
| 2 | +package newsbox |
| 3 | + |
| 4 | +import ( |
| 5 | + "encoding/json" |
| 6 | + "net/http" |
| 7 | + "net/url" |
| 8 | + "strings" |
| 9 | + "time" |
| 10 | + |
| 11 | + "github.com/machinebox/sdk-go/x/boxutil" |
| 12 | + "github.com/pkg/errors" |
| 13 | +) |
| 14 | + |
| 15 | +// Analysis represents an analysis of title, content and domain. |
| 16 | +type Analysis struct { |
| 17 | + // Title is the response object for the title analysis |
| 18 | + Title Title `json:"title"` |
| 19 | + // Content is the response object for the content analysis |
| 20 | + Content Content `json:"content"` |
| 21 | + // Domain is the response object for the domain analysis |
| 22 | + Domain Domain `json:"domain"` |
| 23 | +} |
| 24 | + |
| 25 | +type Title struct { |
| 26 | + // Decision is the string representing the decision could be bias/unsure/impartial |
| 27 | + Decision string `json:"decision,omitempty"` |
| 28 | + // Score is the numeric score of the decision is between 0.00 (bias) and 1.00 (impartial) |
| 29 | + Score float64 `json:"score,omitempty"` |
| 30 | + // Entities represents entities discovered in the text. |
| 31 | + Entities []Entity `json:"entities,omitempty"` |
| 32 | +} |
| 33 | + |
| 34 | +type Content struct { |
| 35 | + // Decision is the string representing the decision could be bias/unsure/impartial |
| 36 | + Decision string `json:"decision,omitempty"` |
| 37 | + // Score is the numeric score of the decision is between 0.00 (bias) and 1.00 (impartial) |
| 38 | + Score float64 `json:"score,omitempty"` |
| 39 | + // Entities represents entities discovered in the text. |
| 40 | + Entities []Entity `json:"entities,omitempty"` |
| 41 | + // Keywords are the most relevant keywords extracted from the text |
| 42 | + Keywords []Keyword `json:"keywords"` |
| 43 | +} |
| 44 | + |
| 45 | +type Domain struct { |
| 46 | + // Domain is the domain extracted from the URL |
| 47 | + Domain string `json:"domain,omitempty"` |
| 48 | + // Category is one of the listed on the API docs |
| 49 | + Category string `json:"category,omitempty"` |
| 50 | +} |
| 51 | + |
| 52 | +// Entity represents an entity discovered in the text. |
| 53 | +type Entity struct { |
| 54 | + // Type is a string describing the kind of entity. |
| 55 | + Type string `json:"type"` |
| 56 | + // Text is the text of the entity. |
| 57 | + Text string `json:"text"` |
| 58 | + // Start is the absolute start position of the entity (in the original text). |
| 59 | + Start int `json:"start"` |
| 60 | + // Start is the absolute end position of the entity (in the original text). |
| 61 | + End int `json:"end"` |
| 62 | +} |
| 63 | + |
| 64 | +// Keyword represents a key word. |
| 65 | +type Keyword struct { |
| 66 | + Keyword string `json:"keyword"` |
| 67 | +} |
| 68 | + |
| 69 | +// Client is an HTTP client that can make requests to the box. |
| 70 | +type Client struct { |
| 71 | + addr string |
| 72 | + |
| 73 | + // HTTPClient is the http.Client that will be used to |
| 74 | + // make requests. |
| 75 | + HTTPClient *http.Client |
| 76 | +} |
| 77 | + |
| 78 | +// New makes a new Client. |
| 79 | +func New(addr string) *Client { |
| 80 | + return &Client{ |
| 81 | + addr: addr, |
| 82 | + HTTPClient: &http.Client{ |
| 83 | + Timeout: 10 * time.Second, |
| 84 | + }, |
| 85 | + } |
| 86 | +} |
| 87 | + |
| 88 | +// Info gets the details about the box. |
| 89 | +func (c *Client) Info() (*boxutil.Info, error) { |
| 90 | + var info boxutil.Info |
| 91 | + u, err := url.Parse(c.addr + "/info") |
| 92 | + if err != nil { |
| 93 | + return nil, err |
| 94 | + } |
| 95 | + if !u.IsAbs() { |
| 96 | + return nil, errors.New("box address must be absolute") |
| 97 | + } |
| 98 | + req, err := http.NewRequest("GET", u.String(), nil) |
| 99 | + if err != nil { |
| 100 | + return nil, err |
| 101 | + } |
| 102 | + req.Header.Set("Accept", "application/json; charset=utf-8") |
| 103 | + resp, err := c.HTTPClient.Do(req) |
| 104 | + if err != nil { |
| 105 | + return nil, err |
| 106 | + } |
| 107 | + defer resp.Body.Close() |
| 108 | + if err := json.NewDecoder(resp.Body).Decode(&info); err != nil { |
| 109 | + return nil, err |
| 110 | + } |
| 111 | + return &info, nil |
| 112 | +} |
| 113 | + |
| 114 | +// Check passes the text from the Reader to newsbox for analysis. |
| 115 | +func (c *Client) Check(title string, content string, u *url.URL) (*Analysis, error) { |
| 116 | + uu, err := url.Parse(c.addr + "/newsbox/check") |
| 117 | + if err != nil { |
| 118 | + return nil, err |
| 119 | + } |
| 120 | + if !u.IsAbs() { |
| 121 | + return nil, errors.New("box address must be absolute") |
| 122 | + } |
| 123 | + vals := url.Values{} |
| 124 | + vals.Set("title", title) |
| 125 | + vals.Set("content", content) |
| 126 | + vals.Set("url", u.String()) |
| 127 | + |
| 128 | + req, err := http.NewRequest("POST", uu.String(), strings.NewReader(vals.Encode())) |
| 129 | + if err != nil { |
| 130 | + return nil, err |
| 131 | + } |
| 132 | + req.Header.Set("Content-Type", "application/x-www-form-urlencoded") |
| 133 | + req.Header.Set("Accept", "application/json; charset=utf-8") |
| 134 | + resp, err := c.HTTPClient.Do(req) |
| 135 | + if err != nil { |
| 136 | + return nil, err |
| 137 | + } |
| 138 | + defer resp.Body.Close() |
| 139 | + var response struct { |
| 140 | + Success bool |
| 141 | + Error string |
| 142 | + |
| 143 | + Title Title `json:"title"` |
| 144 | + Content Content `json:"content"` |
| 145 | + Domain Domain `json:"domain"` |
| 146 | + } |
| 147 | + if err := json.NewDecoder(resp.Body).Decode(&response); err != nil { |
| 148 | + return nil, errors.Wrap(err, "decoding response") |
| 149 | + } |
| 150 | + if !response.Success { |
| 151 | + return nil, ErrNewsbox(response.Error) |
| 152 | + } |
| 153 | + return &Analysis{ |
| 154 | + Title: response.Title, |
| 155 | + Content: response.Content, |
| 156 | + Domain: response.Domain, |
| 157 | + }, nil |
| 158 | +} |
| 159 | + |
| 160 | +// ErrNewsbox represents an error from newsbox. |
| 161 | +type ErrNewsbox string |
| 162 | + |
| 163 | +func (e ErrNewsbox) Error() string { |
| 164 | + return "newsbox: " + string(e) |
| 165 | +} |
0 commit comments