Suger cipher v2.4

.gitignore

@@ -1,6 +1,45 @@
-library/bin
-library/gen
-library/.project
-library/.classpath
+.DS_Store
+
+# built application files
+*.apk
+*.ap_
+
+# files for the dex VM
+*.dex
+
+# Java class files
 *.class
+
+# generated files
+bin/
+gen/
+
+# Local configuration file (sdk path, etc)
+local.properties
+
+# Eclipse project files
+.classpath
+.project
+
+*.a
+*.dylib
+*.log
+*.o
+*.pot
+*.pyc
+*.pydevproject
+*.so
+*.suo
+*.xcworkspace
+*_ReSharper*
+
 .DS_Store
+._.DS_Store
+
+project.properties
+
+.settings
+build/
+.gradle/
+.idea
+*.iml

.travis.yml

@@ -0,0 +1,31 @@
+language: android
+jdk: oraclejdk7
+
+env:
+  global:
+    - TERM=dumb
+android:
+  components:
+    - sys-img-armeabi-v7a-android-23
+    - tools
+    - build-tools-23.0.3
+    - android-23
+    - extra-android-m2repository
+before_script:
+  - sudo service postgresql stop || true
+  - sudo service mysql stop || true
+  - sudo service memcached stop || true
+  - sudo service bootlogd stop || true
+  - sudo service elasticsearch stop || true
+  - sudo service mongodb stop || true
+  - sudo service neo4j stop || true
+  - sudo service cassandra stop || true
+  - sudo service riak stop || true
+  - sudo service rsync stop || true
+  - sudo service x11-common stop || true
+script:
+  - ./gradlew clean build connectedCheck coveralls
+
+cache:
+  directories:
+    - $HOME/.m2

CHANGELOG.md

@@ -0,0 +1,94 @@
+# Sugar Releases
+
+## [Unreleased]
+
+
+## v1.5
+### Added
+* [#328](https://github.com/satyan/sugar/pull/328) @jedid auto add new columns during database upgrade, fix [#299](https://github.com/satyan/sugar/issues/299) and [#151](https://github.com/satyan/sugar/issues/151)
+* [#389](https://github.com/satyan/sugar/pull/389) @alfmatos MultiUnique DSL to handle MultiColumn Unique Table constraint
+* @sibeliusseraphini update, updateInTx methods based on Unique values of SugarRecord
+* [#155](https://github.com/satyan/sugar/issues/155) @benohalloran adding Cursors for Cursor Adapters [Pull 312](https://github.com/satyan/sugar/pull/312)
+* [#430](https://github.com/satyan/sugar/pull/430) @sibeliusseraphini update to roboelectric 3.0 and target android-32
+
+### Changed
+* [#437](https://github.com/satyan/sugar/pull/437) @dnalves removing guava dependency, using synchronized WeakHashMap instead
+* [#423](https://github.com/satyan/sugar/pull/423) @sibeliusseraphini moving changelog of README.md to CHANGELOG.md
+
+### Fixed
+* [#362](https://github.com/satyan/sugar/pull/362) @mitchyboy9 fixed NoClassDefFoundError
+* [#455](https://github.com/satyan/sugar/pull/455) @nurolopher fixed travis and coveralls config 
+* [#434](https://github.com/satyan/sugar/pull/434) @bendaniel10 fix multi-dex
+* [#410](https://github.com/satyan/sugar/pull/410) [#408](https://github.com/satyan/sugar/pull/408) @RoyMontoya simplify code
+* [#327](https://github.com/satyan/sugar/pull/327) @tracytheron support multi-dex
+* [#373](https://github.com/satyan/sugar/pull/373) @salimkamboh use existing tables
+
+## v1.4
+### Added
+* [#306](https://github.com/satyan/sugar/pull/306) @Shyish return boolean/integer on delete methods
+* [#304](https://github.com/satyan/sugar/pull/304) @benohalloran add support to enum type
+* [#197](https://github.com/satyan/sugar/pull/197) @andresteves add suport for bytes[]
+* [#293](https://github.com/satyan/sugar/pull/293) @neilw4 support NULL in queries
+* [#273](https://github.com/satyan/sugar/pull/273) @dominicwong617 findById support an array of ids
+* [#246](https://github.com/satyan/sugar/pull/246) @kwf2030 use sqlite\_master to check whether table already exist
+* [#253](https://github.com/satyan/sugar/pull/202) @JeroenMols add bulk delete
+* [#285](https://github.com/satyan/sugar/pull/202) @Shyish add listAll with orderBy param
+* No need to extend SugarApp - just call SugarContext.init(Context) instead
+* [#129](https://github.com/satyan/sugar/pull/129) @satyan support sugar entities using @Table annotations
+
+### Fixed
+* [#314](https://github.com/satyan/sugar/pull/314) @abscondment fix StrictMode DexFile
+* [#303](https://github.com/satyan/sugar/pull/303) @RossinesP fixed saving row string bug
+* [#258](https://github.com/satyan/sugar/pull/258) @nosrak113 change SugarRecord ID to private to not conflit with other libraries
+* [#254](https://github.com/satyan/sugar/pull/254) @jivimberg use weak keys to keep track of annotated entities
+* [#215](https://github.com/satyan/sugar/issues/215) @jivimberg fix bug persisting relationship
+* [#185](https://github.com/satyan/sugar/issues/185) [#243](https://github.com/satyan/sugar/issues/243) @whoshuu fix save and update method
+* [#202](https://github.com/satyan/sugar/pull/202) @allieus improve getDomainsClass()
+* [#104](https://github.com/satyan/sugar/issues/104) @whoshuu fix nesting "and" and "or"
+
+## v1.4 Beta [[jar](https://github.com/satyan/sugar/releases/download/v1.4_beta/sugar-1.4_beta.jar)]
+### Added
+* [#112](https://github.com/satyan/sugar/pull/112) @androdevcafe added Unique and NotNull annotations
+* [#78](https://github.com/satyan/sugar/pull/78) @HiddenCleverde capability to specify primary key
+
+### Fixed
+* [#113](https://github.com/satyan/sugar/pull/113) @whoshuu override findById to support int
+* [#106](https://github.com/satyan/sugar/issues/106) @whoshuu add documentation to onTerminate
+* [#54](https://github.com/satyan/sugar/issues/54) @whoshuu simplify count interface
+* [#43](https://github.com/satyan/sugar/issues/43) @whoshuu return id on save
+* [#72](https://github.com/satyan/sugar/issues/72) @whoshuu allow null values to Date and Calendar objects
+* [#96](https://github.com/satyan/sugar/issues/96) @whoshuu roboeletric fallback
+
+## v1.3 [[jar](https://github.com/satyan/sugar/releases/download/v1.3/sugar-1.3.jar)]
+
+- Transaction Support
+- Bulk Insert of records 
+- Encrypted datastore (branch : sugar-cipher using sqlcipher)
+- Removed Constructor with context parameter. Needs default constructor now.
+- Enhancements to QueryBuilder
+- Bug fixes and other improvements.
+
+## v1.2 [[jar](https://github.com/satyan/sugar/releases/download/v1.2/sugar-1.2.jar)]
+
+- package restriction for domain classes.
+- metadata caching
+- QueryBuilder v1
+- Database Migrations
+- Provision for Raw queries
+- Better and more organized api guide and usage instructions.
+
+## v1.1 [[jar](https://github.com/satyan/sugar/releases/download/v1.1/sugar-1.1.jar)]
+
+- Static api doesn't take context anymore. Hence
+
+```java
+Book.findById(context, Book.class, 1);
+```
+
+becomes
+
+```java
+Book.findById(Book.class, 1);
+```
+
+- Some cleanup in the code.

README.md

@@ -1,34 +1,160 @@
-Please follow the documentation at
-http://satyan.github.io/sugar
+#Sugar Cipher using Sugar ORM v2.4
+ by Ethan Tam(sbhkin)
 
-The example application is provided in the "example" folder in the source.
 
+- Extract the libs and assets into your application. This dependency is not included in the sugar library.
+- Clone this branch to you Project root folder
+- Follow [How to use master version](#usemasterv)
+- Add a meta property named DB_PASSWORD in your manifest file along with other Sugar configuration as follows:
+```
+          <meta-data
+           android:name="DB_PASSWORD"
+           android:value="your_DB_ENCRYPTION_KEY_here"/>
+```
 
-# Getting Started:
+You're good to go. Use Sugar as usual and your database is encrypted now.
 
-Sugar is now available as a library project also. Add it to your project and utilize the latest changes.
-The project is available in the folder "library"
-http://developer.android.com/tools/projects/index.html#LibraryProjects
+# Sugar ORM
 
-# New in version 1.2
+###  <a link = "usemasterv"></a>How to use master version
+First, download sugar repository
+```
+git clone git@github.com:satyan/sugar.git
+```
 
-1. package restriction for domain classes.
-2. metadata caching
-3. QueryBuilder v1
-4. Database Migrations
-5. Provision for Raw queries
-6. Better and more organized api guide and usage instructions.
+include this in your **settings.gradle**
+```gradle
+include ':app' // your module app
+include ':sugar'
 
-# What's new in 1.1:
+def getLocalProperty(prop) {
+	Properties properties = new Properties()
+	properties.load(new File(rootDir.absolutePath + '/local.properties').newDataInputStream())
+	return properties.getProperty(prop, '')
+}
 
-1. Static api doesn't take context anymore. Hence
+project(':sugar').projectDir = new File(getLocalProperty('sugar.dir'))
 
-        Book.findById(context, Book.class, 1);
+```
 
-        becomes
+include this in your **local.properties**
+```
+sugar.dir=/path/to/sugar/library
+```
 
-        Book.findById(Book.class, 1);
+add sugar project to the dependencies of your main project (build.gradle)
+```gradle
+dependencies {
+    compile project(':sugar')
+}
+```
 
+You should also comment this line just comment this line (library/build.gradle): https://github.com/satyan/sugar/blob/master/library%2Fbuild.gradle#L2
 
-2. Some cleanup in the code.
+```gradle
+// apply from: '../maven_push.gradle'
+```
+===================
 
+After installing, check out how to set up your first database and models [here](http://satyan.github.io/sugar/getting-started.html) **Outdated**. Check examples of 1.4 and master below:
+
+## Examples
+### SugarRecord
+```java
+public class Book extends SugarRecord {
+  @Unique
+  String isbn;
+  String title;
+  String edition;
+
+  // Default constructor is necessary for SugarRecord
+  public Book() {
+
+  }
+
+  public Book(String isbn, String title, String edition) {
+    this.isbn = isbn;
+    this.title = title;
+    this.edition = edition;
+  }
+}
+```
+or
+```java
+@Table
+public class Book { ... }
+```
+
+### Save Entity
+```java
+Book book = new Book("isbn123", "Title here", "2nd edition")
+book.save();
+```
+
+or
+```java
+SugarRecord.save(book); // if using the @Table annotation
+```
+
+### Load Entity
+```java
+Book book = Book.findById(Book.class, 1);
+```
+
+### Update Entity
+```java
+Book book = Book.findById(Book.class, 1);
+book.title = "updated title here"; // modify the values
+book.edition = "3rd edition";
+book.save(); // updates the previous entry with new values.
+```
+
+
+### Delete Entity
+```java
+Book book = Book.findById(Book.class, 1);
+book.delete();
+```
+
+or
+```java
+SugarRecord.delete(book); // if using the @Table annotation
+```
+
+### Update Entity based on Unique values
+```java
+Book book = new Book("isbn123", "Title here", "2nd edition")
+book.save();
+
+// Update book with isbn123
+Book sameBook = new Book("isbn123", "New Title", "5th edition")
+sameBook.update();
+
+book.getId() == sameBook.getId(); // true
+```
+
+or
+```java
+SugarRecord.update(sameBook); // if using the @Table annotation
+```
+
+### Bulk Insert
+```java
+List<Book> books = new ArrayList<>();
+books.add(new Book("isbn123", "Title here", "2nd edition"))
+books.add(new Book("isbn456", "Title here 2", "3nd edition"))
+books.add(new Book("isbn789", "Title here 3", "4nd edition"))
+SugarRecord.saveInTx(books);
+```
+
+### When using ProGuard
+```java
+# Ensures entities remain un-obfuscated so table and columns are named correctly
+-keep class com.yourpackage.yourapp.domainclasspackage.** { *; }
+```
+
+## [CHANGELOG](https://github.com/satyan/sugar/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Please fork this repository and contribute back using [pull requests](https://github.com/satyan/sugar/pulls). Features can be requested using [issues](https://github.com/satyan/sugar/issues). All code, comments, and critiques are greatly appreciated.