Version 1.0.6 - BREKAING FIX - changed query names

Author: phillwiggins

.idea/libraries/Dart_Packages.xml

@@ -1,3 +1,9 @@
+## 1.0.6
+
+BREAK FIX - Fixed ParseUser return type so now returns ParseResponse
+BREAK FIX - Changed query names to make more human readable
+Fixed pinning and unpinning
+
 ## 1.0.5
 
 Corrected save. Now formatted items correctly for saving on server

.idea/libraries/Flutter_Plugins.xml

@@ -122,8 +122,7 @@ class _MyAppState extends State<MyApp> {
 
   void query() async {
     var queryBuilder = QueryBuilder<DietPlan>(DietPlan())
-      ..greaterThan(DietPlan.keyFat, 20)
-      ..descending(DietPlan.keyFat);
+      ..whereContains(DietPlan.keyName, "eto");
 
     var apiResponse = await queryBuilder.query();
 
@@ -170,7 +169,7 @@ class _MyAppState extends State<MyApp> {
     if (response.success) user = response.result;
 
     var queryBuilder = QueryBuilder<ParseUser>(ParseUser.forQuery())
-      ..startsWith(ParseUser.keyUsername, 'phillw');;
+      ..whereStartsWith(ParseUser.keyUsername, 'phillw');;
 
     var apiResponse = await queryBuilder.query();
     if (apiResponse.success) user = response.result;

.idea/workspace.xml

@@ -4,6 +4,8 @@ import 'dart:async';
 import 'dart:convert';
 import 'dart:io';
 
+import 'dart:typed_data';
+import 'package:path/path.dart' as path;
 import 'package:http/http.dart';
 import 'package:meta/meta.dart';
 import 'package:shared_preferences/shared_preferences.dart';
@@ -37,6 +39,8 @@ part 'src/objects/parse_response.dart';
 
 part 'src/objects/parse_user.dart';
 
+part 'src/objects/parse_file.dart';
+
 part 'src/utils/parse_decoder.dart';
 
 part 'src/utils/parse_encoder.dart';
@@ -45,6 +49,8 @@ part 'src/utils/parse_logger.dart';
 
 part 'src/utils/parse_utils.dart';
 
+part 'src/utils/parse_file_extensions.dart';
+
 class Parse {
   ParseCoreData data;
   final ParseHTTPClient client = new ParseHTTPClient();

CHANGELOG.md

@@ -25,6 +25,8 @@ const String keyVarAcl = 'ACL';
 // Classes
 const String keyClassMain = 'ParseMain';
 const String keyClassUser = '_User';
+const String keyGeoPoint = 'GeoPoint';
+const String keyFile = 'File';
 
 // Headers
 const String keyHeaderSessionToken = 'X-Parse-Session-Token';

example/lib/main.dart

@@ -16,5 +16,13 @@ enum ParseApiRQ {
   requestPasswordReset,
   destroy,
   all,
-  execute
+  execute,
+  upload,
+  add,
+  addAll,
+  addUnique,
+  remove,
+  removeAll,
+  increment,
+  decrement
 }

lib/parse.dart

@@ -4,6 +4,7 @@ part of flutter_parse_sdk;
 class QueryBuilder<T extends ParseObject> {
 
   static const String _NO_OPERATOR_NEEDED = "NO_OP";
+  static const String _SINGLE_QUERY = "SINGLE_QUERY";
 
   T object;
   var queries = List<MapEntry>();
@@ -13,137 +14,151 @@ class QueryBuilder<T extends ParseObject> {
   QueryBuilder(this.object) : super();
 
   /// Adds a limit to amount of results return from Parse
-  void limit(int limit){
+  void setLimit(int limit){
     limiters["limit"] = limit;
   }
 
   /// Useful for pagination, skips [int] amount of results
-  void skip(int skip){
+  void setAmountToSkip(int skip){
     limiters["skip"] = skip;
   }
 
   /// Creates a query based on where
-  void where(String where){
+  void whereEquals(String where){
     limiters['where'] = where;
   }
 
   /// Orders the results ascedingly.
   ///
   /// [String] order will be the column of the table that the results are
   /// ordered by
-  void ascending(String order){
+  void orderByAscending(String order){
     limiters["order"] = order;
   }
 
   /// Orders the results descendingly.
   ///
   /// [String] order will be the column of the table that the results are
   /// ordered by
-  void descending(String order){
+  void orderByDescending(String order){
     limiters["order"] = "-$order";
   }
 
   /// Define which keys in an object to return.
   ///
   /// [String] keys will only return the columns of a result you want the data for,
   /// this is useful for large objects
-  void keys(String keys){
-    limiters["keys"] = keys;
+  void keysToReturn(List<String> keys){
+    limiters["keys"] = keys.toString();
   }
 
   /// Includes other ParseObjects stored as a Pointer
-  void include(String include){
-    limiters["include"] = include;
+  void includeObject(String objectType){
+    limiters["include"] = objectType;
   }
 
   /// Returns an object where the [String] column starts with [value]
-  void startsWith(String column, dynamic value) {
-    queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, "^$value"), "\$regex"));
+  void whereStartsWith(String column, String query, {bool caseSensitive: false}) {
+    if (caseSensitive) {
+      queries.add(MapEntry(_SINGLE_QUERY, '\"$column\":{\"\$regex\": \"^$query\"}'));
+    } else {
+      queries.add(MapEntry(_SINGLE_QUERY, '\"$column\":{\"\$regex\": \"^$query\", \"\$options\": \"i\"}'));
+    }
   }
 
   /// Returns an object where the [String] column ends with [value]
-  void endsWith(String column, dynamic value) {
-    queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, "$value^"), "\$regex"));
+  void whereEndsWith(String column, String query, {bool caseSensitive: false}) {
+    if (caseSensitive) {
+      queries.add(MapEntry(_SINGLE_QUERY, '\"$column\":{\"\$regex\": \"$query^\"}'));
+    } else {
+      queries.add(MapEntry(_SINGLE_QUERY, '\"$column\":{\"\$regex\": \"$query^\", \"\$options\": \"i\"}'));
+    }
   }
 
   /// Returns an object where the [String] column equals [value]
-  void equals(String column, dynamic value) {
+  void whereEqualTo(String column, dynamic value) {
     queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value), _NO_OPERATOR_NEEDED));
   }
 
   /// Returns an object where the [String] column contains a value less than
   /// value
-  void lessThan(String column, dynamic value) {
+  void whereLessThan(String column, dynamic value) {
     queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value), "\$lt"));
   }
 
   /// Returns an object where the [String] column contains a value less or equal
   /// to than value
-  void lessThanOrEqualTo(String column, dynamic value) {
+  void whereLessThanOrEqualTo(String column, dynamic value) {
     queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value), "\$lte"));
   }
 
   /// Returns an object where the [String] column contains a value greater
   /// than value
-  void greaterThan(String column, dynamic value) {
+  void whereGreaterThan(String column, dynamic value) {
     queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value), "\$gt"));
   }
 
   /// Returns an object where the [String] column contains a value greater
   /// than equal to value
-  void greaterThanOrEqualsTo(String column, dynamic value) {
+  void whereGreaterThanOrEqualsTo(String column, dynamic value) {
     queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value), "\$gte"));
   }
 
   /// Returns an object where the [String] column is not equal to value
-  void notEqualTo(String column, dynamic value) {
+  void whereNotEqualTo(String column, dynamic value) {
     queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value), "\$ne"));
   }
 
-  /// Returns an object where the [String] column contains value
-  void contains(String column, dynamic value) {
-    queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value), "\$term"));
-  }
-
   /// Returns an object where the [String] column is containedIn
-  void containedIn(String column, dynamic value) {
+  void whereContainedIn(String column, List value) {
     queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value), "\$in"));
   }
 
   /// Returns an object where the [String] column is notContainedIn
-  void notContainedIn(String column, dynamic value) {
+  void whereNotContainedIn(String column, List value) {
     queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value), "\$nin"));
   }
 
-  /// Returns an object where the [String] column is exists
-  void exists(String column, dynamic value) {
+  /// Returns an object where the [String] column for the object has data correctley entered/saved
+  void whereValueExists(String column, bool value) {
     queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value), "\$exists"));
   }
 
   /// Returns an object where the [String] column contains select
-  void select(String column, dynamic value) {
+  void selectKeys(String column, dynamic value) {
     queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value), "\$select"));
   }
 
   /// Returns an object where the [String] column doesn't select
-  void dontSelect(String column, dynamic value) {
+  void dontSelectKeys(String column, dynamic value) {
     queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value), "\$dontSelect"));
   }
 
   /// Returns an object where the [String] column contains all
-  void all(String column, dynamic value) {
-    queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value), "\$all"));
+  void whereArrayContainsAll(String column, List value) {
+    queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value.toString()), "\$all"));
   }
 
   /// Returns an object where the [String] column has a regEx performed on,
-  /// this can include ^StringsWith, or ^EndsWith
-  void regEx(String column, dynamic value) {
+  /// this can include ^StringsWith, or ^EndsWith. This can be manipulated to the users desire
+  void regEx(String column, String value) {
     queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value), "\$regex"));
   }
 
-  /// Returns an object where the [String] column contains the text
-  void text(String column, dynamic value) {
-    queries.add(_buildQueryWithColumnValueAndOperator(MapEntry(column, value), "\$text"));
+  /// Performs a search to see if [String] contains other string
+  void whereContains(String column, String value, {bool caseSensitive: false}) {
+    if (caseSensitive) {
+      queries.add(MapEntry(_SINGLE_QUERY, '\"$column\":{\"\$regex\": \"$query\"}'));
+        } else {
+      queries.add(MapEntry(_SINGLE_QUERY, '\"$column\":{\"\$regex\": \"$query\", \"\$options\": \"i\"}'));
+    }
+  }
+
+  /// Powerful search for containing whole words. This search is much quicker than regex and can search for whole words including wether they are case sensitive or not.
+  /// This search can also order by the score of the search
+  void textContainsWholeWord(String column, String query, {bool caseSensitive: false, bool orderByScore: true}){
+    queries.add(MapEntry(_SINGLE_QUERY, '\"$column\":{\"\$text\":{\"\$search\":{\"\$term\": \"$query\", \"\$caseSensitive\": $caseSensitive }}}'));
+    if (orderByScore) orderByDescending('score');
   }
 
   /// Finishes the query and calls the server
@@ -208,12 +223,12 @@ class QueryBuilder<T extends ParseObject> {
     for (var query in queries){
 
       // Add queries that don't need sanitising
-      if (query.key == _NO_OPERATOR_NEEDED) {
+      if (query.key == _NO_OPERATOR_NEEDED || query.key == _SINGLE_QUERY) {
         sanitisedQueries.add(MapEntry(_NO_OPERATOR_NEEDED, query.value));
       }
 
       // Check if query with same column name has been sanitised
-      if (!keysAlreadyCompacted.contains(query.key) && query.key != _NO_OPERATOR_NEEDED) {
+      if (!keysAlreadyCompacted.contains(query.key) && query.key != _NO_OPERATOR_NEEDED && query.key != _SINGLE_QUERY) {
 
         // If not, check that it now has
         keysAlreadyCompacted.add(query.key);

lib/src/base/parse_constants.dart

@@ -0,0 +1,51 @@
+part of flutter_parse_sdk;
+
+class ParseFile extends ParseObject {
+
+  File _file;
+  String _fileName;
+  String _fileUrl;
+
+  @override
+  String _path;
+
+  String get name => _fileName;
+
+  String get url => _fileUrl;
+
+  bool get saved => url != null;
+
+  @override
+  toJson({bool forApiRQ: false}) => <String, String>{'__type': keyFile, 'name': _fileName, 'url': _fileUrl};
+
+  @override
+  String toString() => json.encode(toString());
+
+  /// Creates a new file
+  ///
+  /// {https://docs.parseplatform.org/rest/guide/#files/}
+  ParseFile(this._file, {bool debug, ParseHTTPClient client}) : super (keyFile){
+    client == null ? _client = ParseHTTPClient() : _client = client;
+    _debug = isDebugEnabled(objectLevelDebug: debug);
+
+    this._fileName = path.basename(_file.path);
+    this._path = 'files/$_fileName';
+  }
+
+  /// Uploads a file to Parse Server
+  upload() async {
+    if (saved) {
+      return this;
+    }
+
+    final ext = path.extension(_file.path).replaceAll('.', '');
+    final headers = <String, String>{
+      HttpHeaders.contentTypeHeader: getContentType(ext)
+    };
+
+    var uri = _client.data.serverUrl + "$_path";
+    final body = await _file.readAsBytes();
+    final response = await _client.post(uri, headers: headers, body: body);
+    return super.handleResponse<ParseFile>(response, ParseApiRQ.upload);
+  }
+}