1  // Copyright 2020 Google LLC
 2  //
 3  // Redistribution and use in source and binary forms, with or without
 4  // modification, are permitted provided that the following conditions are
 5  // met:
 6  //
 7  //     * Redistributions of source code must retain the above copyright
 8  // notice, this list of conditions and the following disclaimer.
 9  //     * Redistributions in binary form must reproduce the above
10  // copyright notice, this list of conditions and the following disclaimer
11  // in the documentation and/or other materials provided with the
12  // distribution.
13  //     * Neither the name of Google LLC nor the names of its
14  // contributors may be used to endorse or promote products derived from
15  // this software without specific prior written permission.
16  //
17  // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20  // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21  // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27  // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  
29  #import <Foundation/Foundation.h>
30  
31  NS_ASSUME_NONNULL_BEGIN
32  /**
33   Represents a single HTTP request. Sending the request is synchronous.
34   Once the send is complete, the response will be set.
35  
36   This is a base interface that specific HTTP requests derive from.
37   It is not intended to be instantiated directly.
38   */
39  @interface HTTPRequest : NSObject {
40   @protected
41    NSURL* URL_;                   // The destination URL (STRONG)
42    NSHTTPURLResponse* response_;  // The response from the send (STRONG)
43  }
44  
45  /**
46   Initializes the HTTPRequest and sets its URL.
47   */
48  - (id)initWithURL:(NSURL*)URL;
49  
50  - (NSURL*)URL;
51  
52  - (NSHTTPURLResponse*)response;
53  
54  - (NSString*)HTTPMethod;  // Internal, don't call outside class hierarchy.
55  
56  - (NSString*)contentType;  // Internal, don't call outside class hierarchy.
57  
58  - (NSData*)bodyData;  // Internal, don't call outside class hierarchy.
59  
60  - (NSData*)send:(NSError**)error;
61  
62  /**
63   Appends a file to the HTTP request, either by filename or by file content
64   (in the form of NSData).
65   */
66  + (void)appendFileToBodyData:(NSMutableData*)data
67                      withName:(NSString*)name
68                withFileOrData:(id)fileOrData;
69  
70  @end
71  
72  NS_ASSUME_NONNULL_END