Deprecations of id and reference properties since they have been deprecated by Google

- See Readme -> Version history for more info

Author: Lukas Kukacka

FTGooglePlacesAPI/FTGooglePlacesAPIDetailRequest.h

@@ -37,12 +37,23 @@
  */
 @interface FTGooglePlacesAPIDetailRequest : NSObject <FTGooglePlacesAPIRequest>
 
+@property (nonatomic, strong, readonly) NSString *placeId;
+
+/**
+ *  Creates new request on a detail of place with given placeId
+ */
+- (instancetype)initWithPlaceId:(NSString *)placeId;
+
+/**
+ *  Deprecations
+ */
+
 /**
  *  Reference with which the request was initialized.
  *  This is a unique identifier for a place (itemId from the ResultItem)
  */
-@property (nonatomic, strong, readonly) NSString *reference;
+@property (nonatomic, strong, readonly) NSString *reference DEPRECATED_MSG_ATTRIBUTE("Deprecated in API by Google as of June 24, 2014. Use placeId instead. See https://developers.google.com/places/documentation/details#deprecation for more info.");
 
-- (instancetype)initWithReference:(NSString *)reference;
+- (instancetype)initWithReference:(NSString *)reference DEPRECATED_MSG_ATTRIBUTE("Uses deprecated property reference (see @reference)");
 
 @end

FTGooglePlacesAPI/FTGooglePlacesAPIDetailRequest.m

@@ -34,16 +34,16 @@ @implementation FTGooglePlacesAPIDetailRequest
 
 #pragma mark Lifecycle
 
-- (instancetype)initWithReference:(NSString *)reference
+- (instancetype)initWithPlaceId:(NSString *)placeId
 {
-    if ([reference length] == 0) {
-        NSLog(@"WARNING: Trying to create FTGooglePlacesAPIDetailRequest with empty reference. Returning nil");
+    if ([placeId length] == 0) {
+        NSLog(@"WARNING: Trying to create FTGooglePlacesAPIDetailRequest with empty placeId. Returning nil");
         return nil;
     }
 
     self = [super init];
     if (self) {
-        _reference = reference;
+        _placeId = placeId;
     }
     return self;
 }
@@ -52,7 +52,7 @@ - (instancetype)initWithReference:(NSString *)reference
 
 - (NSString *)description
 {
-    return [NSString stringWithFormat:@"<%@: %p> Reference: %@", [self class], self, _reference];
+    return [NSString stringWithFormat:@"<%@: %p> Place ID: %@", [self class], self, _placeId];
 }
 
 #pragma mark - FTGooglePlacesAPIRequest protocol
@@ -64,7 +64,29 @@ - (NSString *)placesAPIRequestMethod
 
 - (NSDictionary *)placesAPIRequestParams
 {
-    return @{@"reference": _reference};
+    if (_placeId) {
+        return @{@"placeid": _placeId};
+    }
+    else {
+        return @{@"reference": _reference};
+    }
+    
+}
+
+#pragma mark - Deprecations
+
+- (instancetype)initWithReference:(NSString *)reference
+{
+    if ([reference length] == 0) {
+        NSLog(@"WARNING: Trying to create FTGooglePlacesAPIDetailRequest with empty reference. Returning nil");
+        return nil;
+    }
+    
+    self = [super init];
+    if (self) {
+        _reference = reference;
+    }
+    return self;
 }
 
 @end

FTGooglePlacesAPI/FTGooglePlacesAPISearchResultItem.h

@@ -40,7 +40,7 @@ typedef NS_ENUM(NSUInteger, FTGooglePlacesAPISearchResultItemOpenedState) {
 
 @interface FTGooglePlacesAPISearchResultItem : NSObject
 
-@property (nonatomic, strong, readonly) NSString *itemId;   // Google's id for the item
+@property (nonatomic, strong, readonly) NSString *placeId;  // Google's id for the item
 @property (nonatomic, strong, readonly) NSString *name;
 
 /**
@@ -76,12 +76,18 @@ typedef NS_ENUM(NSUInteger, FTGooglePlacesAPISearchResultItemOpenedState) {
 
 /**
  *  Method for comparing equality of two result item objects.
- *  Objects are considered to be equal if their "itemId" equals.
+ *  Objects are considered to be equal if their "placeId" equals.
  *
  *  @param item Item to compare with
  *
  *  @return YES if both objects are considered to be equal
  */
 - (BOOL)isEqualToSearchResultItem:(FTGooglePlacesAPISearchResultItem *)item;
 
+
+/**
+ *  Deprecations
+ */
+@property (nonatomic, strong, readonly) NSString *itemId DEPRECATED_MSG_ATTRIBUTE("Deprecated in API by Google as of June 24, 2014. Use placeId instead. See https://developers.google.com/places/documentation/details#deprecation for more info.");
+
 @end

FTGooglePlacesAPI/FTGooglePlacesAPISearchResultItem.m

@@ -54,7 +54,7 @@ - (instancetype)initWithDictionary:(NSDictionary *)dictionary
         [self ftgpi_importDictionary:dictionary];
 
         //  Object cannot be valid with no id
-        if ([_itemId length] == 0) {
+        if ([_placeId length] == 0) {
             return nil;
         }
 
@@ -77,7 +77,7 @@ - (NSString *)debugDescription
 - (NSUInteger)hash
 {
     //  Google's ID is unique identifier of the item
-    return [_itemId hash];
+    return [_placeId hash];
 }
 
 - (BOOL)isEqual:(id)object
@@ -93,7 +93,7 @@ - (BOOL)isEqual:(id)object
 
 - (BOOL)isEqualToSearchResultItem:(FTGooglePlacesAPISearchResultItem *)item
 {
-    return [_itemId isEqualToString:item.itemId];
+    return [_placeId isEqualToString:item.placeId];
 }
 
 @end
@@ -108,7 +108,7 @@ - (void)ftgpi_importDictionary:(NSDictionary *)dictionary
 {
     _originalDictionaryRepresentation = dictionary;
 
-    _itemId = [dictionary ftgp_nilledObjectForKey:@"id"];
+    _placeId = [dictionary ftgp_nilledObjectForKey:@"place_id"];
     _name = [dictionary ftgp_nilledObjectForKey:@"name"];
 
 
@@ -148,6 +148,9 @@ - (void)ftgpi_importDictionary:(NSDictionary *)dictionary
     _rating = [[dictionary ftgp_nilledObjectForKey:@"rating"] floatValue];
     _reference = [dictionary ftgp_nilledObjectForKey:@"reference"];
     _types = [dictionary ftgp_nilledObjectForKey:@"types"];
+    
+    //  Deprecated, left for backwards compatibility
+    _itemId = [dictionary ftgp_nilledObjectForKey:@"id"];
 }
 
 @end

README.md

@@ -145,6 +145,9 @@ Pull requests are very welcome expecting you follow few rules:
 
 ##Version history
 
+#### 1.1
+ - Implemented deprecations for usage of `id` and `reference` properties as these has been deprecated by Google as of June 24, 2014. See [Deprecation notice in documentation](https://developers.google.com/places/documentation/details#deprecation) for more info.
+
 #### 1.0
  - First official public release
 

XcodeProject/FTGooglePlacesAPI/FTGooglePlacesAPIExampleResultsViewController.m

@@ -157,7 +157,7 @@ - (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath
         FTGooglePlacesAPISearchResultItem *resultItem = _results[indexPath.row];
 
         //  Create detail request
-        FTGooglePlacesAPIDetailRequest *request = [[FTGooglePlacesAPIDetailRequest alloc] initWithReference:resultItem.reference];
+        FTGooglePlacesAPIDetailRequest *request = [[FTGooglePlacesAPIDetailRequest alloc] initWithPlaceId:resultItem.placeId];
 
         //  Create detail controller
         FTGooglePlacesAPIExampleDetailViewController *detailController = [[FTGooglePlacesAPIExampleDetailViewController alloc] initWithRequest:request];

XcodeProject/FTGooglePlacesAPILogicTests/Source/FTGooglePlacesAPISearchResponseTests.m

@@ -118,7 +118,7 @@ - (void)testRequestAndNextPageRequestMethod
     XCTAssertNotNil(nextPageRequest, @"nextPageRequest should not be nil");
 
     XCTAssertEqualObjects([nextPageRequest placesAPIRequestMethod], @"testrequest", @"nextPageRequest requestTypeUrlString is wrong");
-    NSDictionary *expectedRequestParams = @{@"pagetoken": @"CmRbAAAAPRe43WuMoqKDiLcauzH5NR5Agm6U5pqiP5gPALHlvKSe89bdGpjNj7VCnHXn0-7gr1b2CeuZyJW0PvUultBCu8IAFOWINBvhQ2u_b1URH6Fs_MI_P6jN551VrBxSYjEKEhBf08hzwZ3fXu4zMRhhIpMfGhR75rfrvBBpTtlS9AwJ2JpIeCrMBA"};
+    NSDictionary *expectedRequestParams = @{@"pagetoken": @"CoQCAAEAACUEBVd58EGiJKFOe1KoEFks9jia46vhv6Bi4sR0ExZaFgvu6XqK2xgB6RXYqdWX1QP26UlcCR7DGiBwhH2-FN528X9J-CUH0JjUxauAzJjuxhyyxt946AW1ETRqecANfJdZ5_cjRwhR-0qQ13HeiQaB_riQPMG4SAqKcb8OMcHMtSJrJUacIIifXTNyxJpEbP8dvETT-pDM-0zl9qmTO0aqGdmz0EzyPAEuMCmZEMUI0gnZJvvDvaar_L4KCL6bhjGFqs5OrW-DIn1Vo5CI8bVD4VRINLdxAk7ovLOxT04p1M9qo6JNJ5ZZYntyX2MC64SvIe2RtFIGDGy046xJho4SECVEEiNhLUaQw1_2dUSO4zUaFKqr08lGcqbMqGhRJ9VG69t6YMgj"};
     XCTAssertEqualObjects([nextPageRequest placesAPIRequestParams], expectedRequestParams, @"pageToken returned by nextPageRequest: is wrong");
 }
 
@@ -132,7 +132,7 @@ - (void)testParsingRealResponseOK
 
     XCTAssertNotNil(response, @"response should not be nil");
     XCTAssertEqual(response.status, FTGooglePlacesAPIResponseStatusOK, @"status should be FTGooglePlacesAPIResponseStatusOK");
-    XCTAssertEqualObjects(response.nextPageToken, @"CmRbAAAAPRe43WuMoqKDiLcauzH5NR5Agm6U5pqiP5gPALHlvKSe89bdGpjNj7VCnHXn0-7gr1b2CeuZyJW0PvUultBCu8IAFOWINBvhQ2u_b1URH6Fs_MI_P6jN551VrBxSYjEKEhBf08hzwZ3fXu4zMRhhIpMfGhR75rfrvBBpTtlS9AwJ2JpIeCrMBA", @"nextPageToken is wrong");
+    XCTAssertEqualObjects(response.nextPageToken, @"CoQCAAEAACUEBVd58EGiJKFOe1KoEFks9jia46vhv6Bi4sR0ExZaFgvu6XqK2xgB6RXYqdWX1QP26UlcCR7DGiBwhH2-FN528X9J-CUH0JjUxauAzJjuxhyyxt946AW1ETRqecANfJdZ5_cjRwhR-0qQ13HeiQaB_riQPMG4SAqKcb8OMcHMtSJrJUacIIifXTNyxJpEbP8dvETT-pDM-0zl9qmTO0aqGdmz0EzyPAEuMCmZEMUI0gnZJvvDvaar_L4KCL6bhjGFqs5OrW-DIn1Vo5CI8bVD4VRINLdxAk7ovLOxT04p1M9qo6JNJ5ZZYntyX2MC64SvIe2RtFIGDGy046xJho4SECVEEiNhLUaQw1_2dUSO4zUaFKqr08lGcqbMqGhRJ9VG69t6YMgj", @"nextPageToken is wrong");
     XCTAssertNotNil([response nextPageRequest], @"nextPageRequest should not be nil");
 
     XCTAssertEqual([response.results count], (NSUInteger)20, @"response should have 20 results items");

XcodeProject/FTGooglePlacesAPILogicTests/Source/FTGooglePlacesAPISearchResultItemTests.m

@@ -43,6 +43,7 @@ - (void)testParsingFromManualDictionary
             }
         ],
         @"rating": @(3.6),
+        @"place_id": @"ChIJyWEHuEmuEmsRm9hTkapTCrk",
         @"reference": @"CoQBgAAAAFjx_1xLA2D3kuZ83rCChllMEaGrxSeoPh6",
         @"types": @[@"museum", @"establishment"],
         @"vicinity": @"1st Floor, Riverside Building, County Hall, London"
@@ -52,7 +53,7 @@ - (void)testParsingFromManualDictionary
     FTGooglePlacesAPISearchResultItem *item = [[FTGooglePlacesAPISearchResultItem alloc] initWithDictionary:dictionary];
     XCTAssertNotNil(item, @"Initialiazation should succeed");
 
-    XCTAssertEqualObjects(item.itemId, @"5139d09fbccf4c974fce66f7d88269c149bac0a5", @"itemId is wrong");
+    XCTAssertEqualObjects(item.placeId, @"ChIJyWEHuEmuEmsRm9hTkapTCrk", @"placeId is wrong");
     XCTAssertEqualObjects(item.name, @"London Film Museum South Bank", @"name is wrong");
 
     XCTAssertNotNil(item.location, @"location should be non-nil");
@@ -74,8 +75,8 @@ - (void)testParsingFromManualDictionary
 
 - (void)testVeryBasicObjectWithJustId
 {
-    FTGooglePlacesAPISearchResultItem *item = [[FTGooglePlacesAPISearchResultItem alloc] initWithDictionary:@{@"id": @"someValue"}];
-    XCTAssertNotNil(item, @"item should be valid once it has id");
+    FTGooglePlacesAPISearchResultItem *item = [[FTGooglePlacesAPISearchResultItem alloc] initWithDictionary:@{@"place_id": @"someValue"}];
+    XCTAssertNotNil(item, @"item should be valid once it has placeId");
 
     item = [[FTGooglePlacesAPISearchResultItem alloc] initWithDictionary:@{}];
     XCTAssertNil(item, @"item should be nil when no id is provided");
@@ -86,17 +87,17 @@ - (void)testVeryBasicObjectWithJustId
 
 - (void)testEqualityChecking
 {
-    NSDictionary *dictionary1a = @{@"id": @"5139d09fbccf4c974fce66f7d88269c149bac0a5"};
-    NSDictionary *dictionary1b = @{@"id": @"5139d09fbccf4c974fce66f7d88269c149bac0a5"};
+    NSDictionary *dictionary1a = @{@"place_id": @"5139d09fbccf4c974fce66f7d88269c149bac0a5"};
+    NSDictionary *dictionary1b = @{@"place_id": @"5139d09fbccf4c974fce66f7d88269c149bac0a5"};
 
     FTGooglePlacesAPISearchResultItem *item1a = [[FTGooglePlacesAPISearchResultItem alloc] initWithDictionary:dictionary1a];
     FTGooglePlacesAPISearchResultItem *item1b = [[FTGooglePlacesAPISearchResultItem alloc] initWithDictionary:dictionary1b];
 
     XCTAssertEqualObjects(item1a, item1b, @"object are not considered to be equal, but should be");
 
 
-    NSDictionary *dictionary2a = @{@"id": @"5139d09fbccf4c974fce66f7d88269c149bac0a5"};
-    NSDictionary *dictionary2b = @{@"id": @"XAXAGFKANGOKANOAOGNAOGOIANGOI AOAANGO"};
+    NSDictionary *dictionary2a = @{@"place_id": @"5139d09fbccf4c974fce66f7d88269c149bac0a5"};
+    NSDictionary *dictionary2b = @{@"place_id": @"XAXAGFKANGOKANOAOGNAOGOIANGOI AOAANGO"};
 
     FTGooglePlacesAPISearchResultItem *item2a = [[FTGooglePlacesAPISearchResultItem alloc] initWithDictionary:dictionary2a];
     FTGooglePlacesAPISearchResultItem *item2b = [[FTGooglePlacesAPISearchResultItem alloc] initWithDictionary:dictionary2b];
@@ -106,7 +107,7 @@ - (void)testEqualityChecking
 
 - (void)testEmptyValues
 {
-    NSDictionary *dictionary = @{@"id": @"5139d09fbccf4c974fce66f7d88269c149bac0a5"};
+    NSDictionary *dictionary = @{@"place_id": @"5139d09fbccf4c974fce66f7d88269c149bac0a5"};
 
     FTGooglePlacesAPISearchResultItem *item = [[FTGooglePlacesAPISearchResultItem alloc] initWithDictionary:dictionary];
 
@@ -119,7 +120,7 @@ - (void)testEmptyValues
     XCTAssertNil(item.reference, @"reference should be nil");
     XCTAssertNil(item.types, @"types should be nil");
 
-    XCTAssertEqualObjects(item.originalDictionaryRepresentation, @{@"id": @"5139d09fbccf4c974fce66f7d88269c149bac0a5"}, @"originalDictionaryRepresentation is wrong");
+    XCTAssertEqualObjects(item.originalDictionaryRepresentation, @{@"place_id": @"5139d09fbccf4c974fce66f7d88269c149bac0a5"}, @"originalDictionaryRepresentation is wrong");
 }
 
 @end