vNext

.gitignore

@@ -1 +1,5 @@
 .DS_Store
+chrome/lib/bootstrap.js
+chrome/lib/gmailr.js
+bower_components
+node_modules

.travis.yml

@@ -0,0 +1,6 @@
+language: node_js
+node_js:
+- '0.11'
+before_install:
+- npm install -g grunt-cli
+- npm install -g bower

Gruntfile.js

@@ -0,0 +1,62 @@
+module.exports = function(grunt) {
+
+  grunt.initConfig({
+    pkg: grunt.file.readJSON('package.json'),
+    uglify: {
+      options: {
+        banner: '/*! <%= pkg.name %> <%= pkg.version %> - <%= grunt.template.today("yyyy-mm-dd") %> */\n',
+        sourceMap: true,
+        sourceMapIncludeSources: true,
+        sourceMapIn: 'build/<%= pkg.name %>.js.map',
+      },
+      build: {
+        src: 'build/<%= pkg.name %>.js',
+        dest: 'build/<%= pkg.name %>.min.js'
+      }
+    },
+
+    coffee: {
+      compile: {
+        options: {
+          sourceMap: true
+        },
+        files: {
+          'build/<%= pkg.name %>.js': 'src/index.coffee'
+        }
+      }
+    },
+
+    bump: {
+      options: {
+        files: ['package.json', 'bower.json'],
+        updateConfigs: ['pkg'],
+        commit: true,
+        commitMessage: 'Release v%VERSION%',
+        commitFiles: ['package.json', 'bower.json', 'build/**'],
+        createTag: true,
+        tagName: 'v%VERSION%',
+        tagMessage: 'Version %VERSION%',
+        push: true,
+        pushTo: 'origin',
+        gitDescribeOptions: '--tags --always --abbrev=1 --dirty=-d',
+        globalReplace: false
+      }
+    }
+  });
+
+  grunt.loadNpmTasks('grunt-contrib-uglify');
+  grunt.loadNpmTasks('grunt-contrib-coffee');
+  grunt.loadNpmTasks('grunt-bump');
+
+  grunt.registerTask('build', ['coffee:compile', 'uglify']);
+  grunt.registerTask('default', 'build');
+  grunt.registerTask('travis', 'build');
+
+  grunt.registerTask('release', 'Bump, build and release.', function(type) {
+    grunt.task.run([
+      'bump-only:' + (type || 'patch'),
+      'build',
+      'bump-commit'
+      ]);
+  });
+};

LICENSE → LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2011 James Yu
+Copyright (c) 2011 James Yu, 2014 Joscha Feth
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

readme.markdown → README.md

@@ -1,4 +1,4 @@
-Gmailr: A Gmail Javascript API
+[![Build Status](https://travis-ci.org/joscha/gmailr.svg)](https://travis-ci.org/joscha/gmailr) Gmailr: A Gmail Javascript API
 ==============================
 
 Gmailr is a javascript library that lets you interact and get data from the Gmail interface. It is meant to be injected into the Gmail DOM directly, usually through a browser plugin.
@@ -12,19 +12,22 @@ The library is packaged here as a Chrome extension that presents some status inf
 
 To install the extension, clone the repo and:
 
-1. Open Chrome and go to chrome://extensions
-2. If the Developer Mode toggle is set to "-", click it to go into Developer Mode.
-3. Click "Load unpacked extension..."
-4. Choose the `chrome` directory in this repo.
-5. Enable the newly added extension.
-6. Head to your Gmail account, and you should now see a blue Gmailr bar above the top bar.
+
+- Run an `npm install`, then an `npm install bower -g` and then an `npm run quickstart`.
+- Open Chrome and go to chrome://extensions
+- If the Developer Mode toggle is set to "-", click it to go into Developer Mode.
+- Click "Load unpacked extension..."
+- Choose the `chrome` directory in this repo.
+- Enable the newly added extension.
+- Head to your Gmail account, and you should now see a blue Gmailr bar above the top bar.
 
 Try archiving or deleting an email, and you'll see the status bar display the action.
 
 Creating Your Own Extension
 ===========================
 
 To create your own extension using Gmailr, simply change main.js to implement your functionality.
+You can add more resources to load in init.coffee - simply add files to the array - if they are local files coming from the extension, you need to make them web-accessible in the `manifest.json`
 
 Extension Architecture
 ----------------------
@@ -33,7 +36,8 @@ You'll notice that the extension does a lot of roundabout loading of the js file
 
 Thus, we have to manually inject the scripts into the head of the Gmail DOM.
 
-`bootstrap.js` is first loaded like a normal content script, and it injects `lab.js` and `init.js`. Then, `init.js` loads the rest of the js files using LAB, and finally `main.js` is loaded with access to the Gmailr API.
+`bootstrap.js` is first loaded like a normal content script, and it loads all other files needed for Gmailr.
+Finally `main.js` is loaded with access to the Gmailr API.
 
 Development Notes
 -----------------
@@ -62,14 +66,44 @@ The elements hash holds some interesting elements inside Gmail. Currently, there
 
 This method will observe to various actions that the user does in Gmail, and will call a callback based on those actions. The available types are (with the callback arguments):
 
-* 'archive'         - callback(count)
-* 'numUnreadChange' - callback(currentVal, previousVal)
-* 'delete'          - callback(count)
-* 'spam'            - callback(count)
-* 'compose'         - no args
-* 'viewChanged'     - no args
+* `EVENT_LOADED`:
+* `EVENT_VIEW_THREAD`: threadId
+* `EVENT_ARCHIVE`: count, [messageId,  ...]
+* `EVENT_APPLY_LABEL`: label, count, [messageId,  ...]
+* `EVENT_DELETE`: count, [messageId,  ...]
+* `EVENT_COMPOSE`: emailProperties
+* `EVENT_REPLY`: emailProperties
+* `EVENT_SPAM`: count, [messageId,  ...]
+* `EVENT_DRAFT_DISCARD`: 
+* `EVENT_DRAFT_SAVE`: emailProperties
+* `EVENT_MARK_UNREAD`: count, [messageId,  ...]
+
+* `EVENT_MARK_READ`: count, [messageId,  ...]* `EVENT_STAR`: count, [messageId,  ...]
+* `EVENT_UNSTAR`: count, [messageId,  ...]
+* `EVENT_UNREAD_CHANGE`: current, previous
+* `EVENT_INBOX_COUNT_CHANGE`: current, previous
+* `EVENT_REFRESH_INBOX`: 
+* `EVENT_VIEW_CHANGED`: type (either `VIEW_THREADED` or `VIEW_CONVERSATION`)
+* `EVENT_ANY`: type, arguments - this meta event gets fired on any of the events above with `type` being one of `Gmailr.EVENT_*` and the second argument an array of parameters
+
+If `count` is `-1` that means the user made a bulk event which affects more than only the visible emails on the current page.
+
+Contents of the `emailProperties` object are:
+
+* `inReplyTo`: (message id of the email that this is in reply to, or `null` if not in reply to anything)
+* `body`: String (or `null` if not defined)
+* `subject`: String (or `null` if not defined)
+* `bcc`: Array
+* `to`: Array
+* `from`: String (the email address you are sending from)
+* `isHTML`: (boolean)
+* `cc`: Array
+* `fromDraft`: (message id of the draft or `null` if there was no draft)
+
+`to`, `cc` and `bcc` are Arrays of name, email tuple objects, e.g. `{name: 'Name', email: '[email protected]' }`
+
+---
 
-Currently, you won't get any information about the contents of the email messages.
 
     G.insertTop(el)
 
@@ -79,10 +113,6 @@ Inserts a DOM element on the top of Gmail's interface.
 
 Provides a jQuery selector so you can select elements in the Gmail interface.
 
-    G.insertCss(path)
-
-Inserts a CSS file into the Gmail DOM.
-
     G.numUnread()
 
 Number of unread emails.
@@ -94,13 +124,3 @@ The email address of the current Gmail user.
     G.currentView()
 
 Returns whether the current view is a threaded or conversation view.
-
-
-TODOs
-=====
-
-There are much more TODOs than I have time for :) 
-
-* More stability and accuracy for various events.
-* Ability to add DOM elements in various places in Gmail, like the sidebar, etc.
-* Ability to get more information about emails that are archived, composed, etc.

bower.json

@@ -0,0 +1,37 @@
+{
+  "name": "gmailr",
+  "version": "0.0.9",
+  "homepage": "https://github.com/joscha/gmailr",
+  "authors": [
+    "Joscha Feth <[email protected]>",
+    "James Yu"
+  ],
+  "description": "A Gmail Javascript API",
+  "main": "build/gmailr.min.js",
+  "moduleType": [
+    "globals"
+  ],
+  "keywords": [
+    "gmail",
+    "api",
+    "javascript",
+    "google",
+    "mail"
+  ],
+  "license": "MIT",
+  "ignore": [
+    "**/.*",
+    "node_modules",
+    "bower_components",
+    "test",
+    "tests",
+    "chrome",
+    "src",
+    "Gruntfile.js",
+    "*.md"
+  ],
+  "dependencies": {
+    "jquery-deparam": "https://gist.github.com/1025817.git",
+    "jquery": "~1.11.1"
+  }
+}