Merge pull request #4 from studyplus/refactor_sdk

Refactor SDK

Author: masashi-sutou

StudyplusSDK/SPLStopwatch.m

@@ -35,7 +35,7 @@ @interface SPLStopwatch()
 
 @implementation SPLStopwatch
 
--(id)init
+-(instancetype)init
 {
     if (self = [super init]) {
         self.elapsedSeconds = 0;

StudyplusSDK/SPLStudyplus.h

@@ -25,6 +25,8 @@
 #import "SPLStudyplusRecordAmount.h"
 #import "SPLStopwatch.h"
 
+NS_ASSUME_NONNULL_BEGIN
+
 /**
  The class for using Studyplus.<br>
  For example, you can authenticate in Studyplus account, de-authentication, and post study record.
@@ -67,7 +69,7 @@
 /**
  @see SPLStudyplusDelegate protocol
  */
-@property (nonatomic, weak) id<SPLStudyplusDelegate> delegate;
+@property (nonatomic, weak, nullable) id<SPLStudyplusDelegate> delegate;
 
 /**
  When set to YES, if Studyplus is not installed, AppStore application starts when auth/login methods are called. Default value is YES.<br>
@@ -79,18 +81,18 @@
  Username of Studyplus account. It is set when the auth or login is successful. Default value is nil.<br>
  Studyplusアカウントのユーザ名です。login または authが成功したとき設定されます。設定されるまではnilです。
  */
-@property (nonatomic, copy, readonly) NSString *username;
+@property (nonatomic, copy, readonly, nullable) NSString *username;
 
 /**
  Access token of Studyplus API. It is set when the auth or login is successful. Default value is nil.<br>
  StudyplusAPIのアクセストークンです。login または authが成功したとき設定されます。設定されるまではnilです。
  */
-@property (nonatomic, copy, readonly) NSString *accessToken;
+@property (nonatomic, copy, readonly, nullable) NSString *accessToken;
 
 /**
  @see SPLStopwatch class
  */
-@property (nonatomic, readonly) SPLStopwatch *stopwatch;
+@property (nonatomic, readonly, nullable) SPLStopwatch *stopwatch;
 
 /**
  The convenience constructor of SPLStudyplus class.
@@ -106,8 +108,8 @@
  @return SPLStudyplus object. <br>
  SPLStudyplusオブジェクト。
  */
-+ (SPLStudyplus*)studyplusWithConsumerKey:(NSString*)consumerKey
-                        andConsumerSecret:(NSString*)consumerSecret;
++ (instancetype)studyplusWithConsumerKey:(NSString*)consumerKey
+                       andConsumerSecret:(NSString*)consumerSecret;
 
 /**
  Opens the auth screen by invoking the Studyplus application.
@@ -182,4 +184,6 @@
  */
 - (BOOL)openURL:(NSURL*)url;
 
+NS_ASSUME_NONNULL_END
+
 @end

StudyplusSDK/SPLStudyplus.m

@@ -42,15 +42,16 @@ @interface SPLStudyplus()
 
 @implementation SPLStudyplus
 
-+ (SPLStudyplus*)studyplusWithConsumerKey:(NSString*)consumerKey
-                        andConsumerSecret:(NSString*)consumerSecret
++ (instancetype)studyplusWithConsumerKey:(NSString*)consumerKey
+                       andConsumerSecret:(NSString*)consumerSecret
 {
     return [[SPLStudyplus alloc] __initWithConsumerKey:consumerKey
                                      andConsumerSecret:consumerSecret];
 }
 
-- (id)__initWithConsumerKey:(NSString*)consumerKey
-          andConsumerSecret:(NSString*)consumerSecret {
+- (instancetype)__initWithConsumerKey:(NSString*)consumerKey
+                    andConsumerSecret:(NSString*)consumerSecret
+{
 
     if (self = [super init]) {
         self.consumerKey = consumerKey;
@@ -113,6 +114,14 @@ - (void)postStudyRecord:(SPLStudyplusRecord *)studyplusRecord
         return;
     }
 
+    if (![self isConnected]) {
+        if ([self.delegate respondsToSelector:@selector(studyplusDidFailToPostStudyRecord:withError:)]) {
+            [self.delegate studyplusDidFailToPostStudyRecord:self withError:[SPLStudyplusError errorFromStudyplusErrorCode:SPLErrorCodeNotConnected]];
+        }
+        
+        return;
+    }
+    
     SPLStudyplusAPIRequest *request = [SPLStudyplusAPIRequest
                                        newRequestWithAccessToken:self.accessToken
                                        options:@{
@@ -141,8 +150,8 @@ - (BOOL)openURL:(NSURL*)url
     }
 
     if ([url.pathComponents[1] isEqualToString:@"success"]) {
-        NSString *accessToken = url.pathComponents[2];
-        NSString *username = url.pathComponents[3];
+        NSString *accessToken = [url.pathComponents[2] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
+        NSString *username = [url.pathComponents[3] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
         [self saveAccessToken:accessToken andUsername:username];
         [self.delegate studyplusDidConnect:self];
     } else if ([url.pathComponents[1] isEqualToString:@"fail"]) {
@@ -164,7 +173,8 @@ - (BOOL)openURL:(NSURL*)url
 
 #pragma mark - privates
 
-- (id)init {
+- (id)init
+{
     @throw [NSException exceptionWithName:NSInternalInconsistencyException
                                    reason:@"-init method is not available."
                                  userInfo:nil];

StudyplusSDK/SPLStudyplusAPIRequest.h

@@ -22,14 +22,18 @@
 
 #import <Foundation/Foundation.h>
 
+NS_ASSUME_NONNULL_BEGIN
+
 @interface SPLStudyplusAPIRequest : NSObject
 
-+ (SPLStudyplusAPIRequest*)newRequestWithAccessToken:(NSString*)accessToken
-                                             options:(NSDictionary*)options;
++ (instancetype)newRequestWithAccessToken:(NSString*)accessToken
+                                  options:(NSDictionary*)options;
 
 - (void)postRequestWithPath:(NSString *)path
            requestParameter:(NSDictionary *)requestParameter
-                  completed:(void(^)(NSDictionary *response))completed
+                  completed:(void(^)(NSDictionary * _Nullable response))completed
                      failed:(void(^)(NSError *error))failed;
 
+NS_ASSUME_NONNULL_END
+
 @end

StudyplusSDK/SPLStudyplusAPIRequest.m

@@ -35,23 +35,23 @@ @interface SPLStudyplusAPIRequest()
 
 @implementation SPLStudyplusAPIRequest
 
-- (id)init
+- (instancetype)init
 {
     if (self = [super init]) {
         _accessToken = nil;
     }
     return self;
 }
 
-+ (SPLStudyplusAPIRequest*)newRequestWithAccessToken:(NSString*)accessToken
-                                             options:(NSDictionary*)options
++ (instancetype)newRequestWithAccessToken:(NSString*)accessToken
+                                  options:(NSDictionary*)options
 {
     return [[SPLStudyplusAPIRequest alloc] initWithAccessToken:accessToken
                                                        options:options];
 }
 
-- (id)initWithAccessToken:(NSString*)accessToken
-                  options:(NSDictionary*)options
+- (instancetype)initWithAccessToken:(NSString*)accessToken
+                            options:(NSDictionary*)options
 {
     if (self = [super init]) {
         _accessToken = accessToken;
@@ -64,7 +64,7 @@ - (void)postRequestWithPath:(NSString *)path
            requestParameter:(NSDictionary *)requestParameter
                   completed:(void(^)(NSDictionary *response))completed
                      failed:(void(^)(NSError *error))failed
-{
+{    
     [self sendRequestWithPath:path
                 requestParams:requestParameter
                     completed:completed
@@ -83,7 +83,7 @@ - (void)sendRequestWithPath:(NSString*)path
                      failed:(void(^)(NSInteger httpStatusCode, NSError *error))failed
 {
     AFHTTPResponseSerializer *responseSerializer = [AFHTTPResponseSerializer serializer];
-    AFJSONRequestSerializer * requestSerializer = [AFJSONRequestSerializer serializer];
+    AFJSONRequestSerializer *requestSerializer = [AFJSONRequestSerializer serializer];
     [requestSerializer setValue:[NSString stringWithFormat:@"OAuth %@", self.accessToken]
              forHTTPHeaderField:@"HTTP_AUTHORIZATION"];
 
@@ -119,14 +119,4 @@ - (NSString *)buildUrlFromPath:(NSString *)path
     return [NSString stringWithFormat:@"%@v%ld/%@", [self apiBaseURL], (long)self.apiVersion, path];
 }
 
-+ (NSOperationQueue *)sharedQueue
-{
-    static NSOperationQueue *queue;
-    static dispatch_once_t onceToken;
-    dispatch_once(&onceToken, ^{
-        queue = [NSOperationQueue new];
-    });
-    return queue;
-}
-
 @end

StudyplusSDK/SPLStudyplusError.h

@@ -31,6 +31,7 @@ typedef NS_ENUM(NSInteger, SPLErrorCode) {
     SPLErrorCodeNetworkUnavailable = 6000,
     SPLErrorCodeServerError = 7000,
     SPLErrorCodePostRecordFailed = 8000,
+    SPLErrorCodeNotConnected = 9000,
     SPLErrorCodeUnknown = 90000
 };
 

StudyplusSDK/SPLStudyplusError.m

@@ -71,6 +71,11 @@ + (NSError*)errorFromStudyplusErrorCode:(SPLErrorCode)studyplusErrorCode
                          localizedDescription:@"Failed to post study record. (400 bad request)"];
             break;
 
+        case SPLErrorCodeNotConnected:
+            error = [SPLStudyplusError errorWithCode:studyplusErrorCode
+                                localizedDescription:@"Not Connected"];
+            break;
+            
         case SPLErrorCodeUnknown:
             error = [SPLStudyplusError errorWithCode:SPLErrorCodeUnknown
                          localizedDescription:@"Unknown Error."];

StudyplusSDK/SPLStudyplusRecord.h

@@ -22,6 +22,8 @@
 
 #import <Foundation/Foundation.h>
 
+NS_ASSUME_NONNULL_BEGIN
+
 @class SPLStudyplusRecordAmount;
 
 /**
@@ -54,7 +56,7 @@
  The comment of learning.<br>
  勉強に関するコメントです。
  */
-@property (nonatomic, readonly) NSString *comment;
+@property (nonatomic, readonly, nullable) NSString *comment;
 
 /**
  Creates and returns StudyplusRecord object that has number of seconds, no amount, and empty comment.<br>
@@ -65,7 +67,7 @@
 
  @result StudyplusRecord object.
  */
-+ (SPLStudyplusRecord*)recordWithDuration:(NSTimeInterval)duration;
++ (instancetype)recordWithDuration:(NSTimeInterval)duration;
 
 /**
  Creates and returns StudyplusRecord object that has number of seconds and other attributes.
@@ -87,11 +89,13 @@
  
  @result StudyplusRecord object.
  */
-+ (SPLStudyplusRecord*)recordWithDuration:(NSTimeInterval)duration options:(NSDictionary*)options;
++ (instancetype)recordWithDuration:(NSTimeInterval)duration options:(NSDictionary* _Nullable)options;
 
 /**
  @result Returns the parameters of the study record for posting API
  */
 - (NSDictionary*)toRequestParam;
 
+NS_ASSUME_NONNULL_END
+
 @end

StudyplusSDK/SPLStudyplusRecord.m

@@ -33,25 +33,26 @@ - (id)getKey:(NSString*)key orElse:(id)elseValue;
 
 @implementation SPLStudyplusRecord
 
-+ (SPLStudyplusRecord*)recordWithDuration:(NSTimeInterval)duration
++ (instancetype)recordWithDuration:(NSTimeInterval)duration
 {
     return [self recordWithDuration:duration options:@{}];
 }
 
-+ (SPLStudyplusRecord*)recordWithDuration: (NSTimeInterval)duration options:(NSDictionary*)options
++ (instancetype)recordWithDuration: (NSTimeInterval)duration options:(NSDictionary*)options
 {
     return [[[self class] alloc] initWithDuration:duration options:options];
 }
 
-- (id)getKey:(NSString *)key from:(NSDictionary *)dict orElse:(id)elseValue {
+- (id)getKey:(NSString *)key from:(NSDictionary *)dict orElse:(id)elseValue
+{
     id value = dict[key];
     if (value == [NSNull null] || value == nil) {
         value = elseValue;
     }
     return value;
 }
 
-- (id)initWithDuration:(NSTimeInterval)duration options:(NSDictionary*)options
+- (instancetype)initWithDuration:(NSTimeInterval)duration options:(NSDictionary*)options
 {
     if (self = [super init]) {
         _duration = duration;

StudyplusSDK/SPLStudyplusRecordAmount.h

@@ -22,6 +22,8 @@
 
 #import <Foundation/Foundation.h>
 
+NS_ASSUME_NONNULL_BEGIN
+
 /**
  The class that represents the amount of learning. <br>
  学習量を表すクラスです。
@@ -35,7 +37,7 @@
  @param amount 学習量。
  @result SPLStudyplusRecordAmount* 生成したAmountオブジェクトです。
  */
-+ (SPLStudyplusRecordAmount*)amount:(NSUInteger)amount;
++ (instancetype)amount:(NSUInteger)amount;
 
 /**
  Creates and returns the Amount object with a range of learning amount.<br>
@@ -45,18 +47,20 @@
  @param to 学習量の終点。
  @result SPLStudyplusRecordAmount* 生成したAmountオブジェクトです。
  */
-+ (SPLStudyplusRecordAmount*)amountAsRangeWithFrom:(NSUInteger)from to:(NSUInteger)to;
++ (instancetype)amountAsRangeWithFrom:(NSUInteger)from to:(NSUInteger)to;
 
 /**
  Creates and returns the Amount object that has no learning amount.<br>
  学習量を持たないAmountオブジェクトを生成して返します。
  @result SPLStudyplusRecordAmount* 生成したAmountオブジェクトです。
  */
-+ (SPLStudyplusRecordAmount*)amountAsNone;
++ (instancetype)amountAsNone;
 
 /**
  @result Returns the parameters of the study record for posting API
  */
 - (NSDictionary*)toRequestParameter;
 
+NS_ASSUME_NONNULL_END
+
 @end