@@ -9,30 +9,29 @@ import (
99 "encoding/json"
1010 "fmt"
1111 "io"
12- "io/ioutil"
1312 "net/http"
1413 "os"
1514 "strings"
1615 "time"
1716)
1817
19- // IntelOwlError represents an error that has occurred when communicating with IntelOwl.
20- type IntelOwlError struct {
18+ // Error represents an error that has occurred when communicating with IntelOwl.
19+ type Error struct {
2120 StatusCode int
2221 Message string
2322 Response * http.Response
2423}
2524
2625// Error lets you implement the error interface.
2726// This is used for making custom go errors.
28- func (intelOwlError * IntelOwlError ) Error () string {
27+ func (intelOwlError * Error ) Error () string {
2928 errorMessage := fmt .Sprintf ("Status Code: %d \n Error: %s" , intelOwlError .StatusCode , intelOwlError .Message )
3029 return errorMessage
3130}
3231
33- // newIntelOwlError lets you easily create new IntelOwlErrors .
34- func newIntelOwlError (statusCode int , message string , response * http.Response ) * IntelOwlError {
35- return & IntelOwlError {
32+ // newError lets you easily create new Errors .
33+ func newError (statusCode int , message string , response * http.Response ) * Error {
34+ return & Error {
3635 StatusCode : statusCode ,
3736 Message : message ,
3837 Response : response ,
@@ -44,8 +43,8 @@ type successResponse struct {
4443 Data []byte
4544}
4645
47- // IntelOwlClientOptions represents the fields needed to configure and use the IntelOwlClient
48- type IntelOwlClientOptions struct {
46+ // ClientOptions represents the fields needed to configure and use the Client
47+ type ClientOptions struct {
4948 Url string `json:"url"`
5049 Token string `json:"token"`
5150 // Certificate represents your SSL cert: path to the cert file!
@@ -54,16 +53,16 @@ type IntelOwlClientOptions struct {
5453 Timeout uint64 `json:"timeout"`
5554}
5655
57- // IntelOwlClient handles all the communication with your IntelOwl instance.
58- type IntelOwlClient struct {
59- options * IntelOwlClientOptions
56+ // Client handles all the communication with your IntelOwl instance.
57+ type Client struct {
58+ options * ClientOptions
6059 client * http.Client
6160 TagService * TagService
6261 JobService * JobService
6362 AnalyzerService * AnalyzerService
6463 ConnectorService * ConnectorService
6564 UserService * UserService
66- Logger * IntelOwlLogger
65+ Logger * Logger
6766}
6867
6968// TLP represents an enum for the TLP attribute used in IntelOwl's REST API.
@@ -113,7 +112,7 @@ func ParseTLP(s string) TLP {
113112}
114113
115114// Implementing the MarshalJSON interface to make our custom Marshal for the enum
116- func (tlp TLP ) MarshalJSON () ([]byte , error ) {
115+ func (tlp * TLP ) MarshalJSON () ([]byte , error ) {
117116 return json .Marshal (tlp .String ())
118117}
119118
@@ -129,8 +128,8 @@ func (tlp *TLP) UnmarshalJSON(data []byte) (err error) {
129128 return nil
130129}
131130
132- // NewIntelOwlClient lets you easily create a new IntelOwlClient by providing IntelOwlClientOptions , http.Clients, and LoggerParams.
133- func NewIntelOwlClient (options * IntelOwlClientOptions , httpClient * http.Client , loggerParams * LoggerParams ) IntelOwlClient {
131+ // NewClient lets you easily create a new Client by providing ClientOptions , http.Clients, and LoggerParams.
132+ func NewClient (options * ClientOptions , httpClient * http.Client , loggerParams * LoggerParams ) Client {
134133
135134 var timeout time.Duration
136135
@@ -148,7 +147,7 @@ func NewIntelOwlClient(options *IntelOwlClientOptions, httpClient *http.Client,
148147 }
149148
150149 // configuring the client
151- client := IntelOwlClient {
150+ client := Client {
152151 options : options ,
153152 client : httpClient ,
154153 }
@@ -171,33 +170,33 @@ func NewIntelOwlClient(options *IntelOwlClientOptions, httpClient *http.Client,
171170 }
172171
173172 // configuring the logger!
174- client .Logger = & IntelOwlLogger {}
173+ client .Logger = & Logger {}
175174 client .Logger .Init (loggerParams )
176175
177176 return client
178177}
179178
180- // NewIntelOwlClientThroughJsonFile lets you create a new IntelOwlClient through a JSON file that contains your IntelOwlClientOptions
181- func NewIntelOwlClientThroughJsonFile (filePath string , httpClient * http.Client , loggerParams * LoggerParams ) (* IntelOwlClient , error ) {
179+ // NewClientFromJsonFile lets you create a new Client through a JSON file that contains your ClientOptions
180+ func NewClientFromJsonFile (filePath string , httpClient * http.Client , loggerParams * LoggerParams ) (* Client , error ) {
182181 optionsBytes , err := os .ReadFile (filePath )
183182 if err != nil {
184183 errorMessage := fmt .Sprintf ("Could not read %s" , filePath )
185- intelOwlError := newIntelOwlError (400 , errorMessage , nil )
184+ intelOwlError := newError (400 , errorMessage , nil )
186185 return nil , intelOwlError
187186 }
188187
189- intelOwlClientOptions := & IntelOwlClientOptions {}
188+ intelOwlClientOptions := & ClientOptions {}
190189 if unmarshalError := json .Unmarshal (optionsBytes , & intelOwlClientOptions ); unmarshalError != nil {
191190 return nil , unmarshalError
192191 }
193192
194- intelOwlClient := NewIntelOwlClient (intelOwlClientOptions , httpClient , loggerParams )
193+ intelOwlClient := NewClient (intelOwlClientOptions , httpClient , loggerParams )
195194
196195 return & intelOwlClient , nil
197196}
198197
199198// buildRequest is used for building requests.
200- func (client * IntelOwlClient ) buildRequest (ctx context.Context , method string , contentType string , body io.Reader , url string ) (* http.Request , error ) {
199+ func (client * Client ) buildRequest (ctx context.Context , method string , contentType string , body io.Reader , url string ) (* http.Request , error ) {
201200 request , err := http .NewRequestWithContext (ctx , method , url , body )
202201 if err != nil {
203202 return nil , err
@@ -211,7 +210,7 @@ func (client *IntelOwlClient) buildRequest(ctx context.Context, method string, c
211210}
212211
213212// newRequest is used for making requests.
214- func (client * IntelOwlClient ) newRequest (ctx context.Context , request * http.Request ) (* successResponse , error ) {
213+ func (client * Client ) newRequest (ctx context.Context , request * http.Request ) (* successResponse , error ) {
215214 response , err := client .client .Do (request )
216215
217216 // Checking for context errors such as reaching the deadline and/or Timeout
@@ -226,17 +225,17 @@ func (client *IntelOwlClient) newRequest(ctx context.Context, request *http.Requ
226225
227226 defer response .Body .Close ()
228227
229- msgBytes , err := ioutil .ReadAll (response .Body )
228+ msgBytes , err := io .ReadAll (response .Body )
230229 statusCode := response .StatusCode
231230 if err != nil {
232231 errorMessage := fmt .Sprintf ("Could not convert JSON response. Status code: %d" , statusCode )
233- intelOwlError := newIntelOwlError (statusCode , errorMessage , response )
232+ intelOwlError := newError (statusCode , errorMessage , response )
234233 return nil , intelOwlError
235234 }
236235
237236 if statusCode < http .StatusOK || statusCode >= http .StatusBadRequest {
238237 errorMessage := string (msgBytes )
239- intelOwlError := newIntelOwlError (statusCode , errorMessage , response )
238+ intelOwlError := newError (statusCode , errorMessage , response )
240239 return nil , intelOwlError
241240 }
242241
0 commit comments