contextio 0.5.0 → 1.0.0

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+README.rdoc
+ChangeLog.rdoc
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,8 @@
+Gemfile.lock
+html/
+pkg/
+doc/
+.yardoc/
+vendor/cache/*.gem
+test_script.rb
+spec/config.yml

data/.rspec

@@ -0,0 +1 @@
+--format progress

data/.yardopts

@@ -0,0 +1 @@
+--no-private --markup markdown --no-cache - README.md LICENSE.md ChangeLog.md

data/ChangeLog.md

@@ -0,0 +1,5 @@
+# Changes
+
+## 0.5.0 / 2012-08-18
+
+* Major Refactor of all code.

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Context.IO
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, 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.

data/README.md

@@ -1,35 +1,75 @@
-Context.IO Gem Source
-=====================
+# Context.IO
 
-This repository contains the source for the Context.IO gem.
+* [Homepage](https://github.com/benhamill/contextio#readme)
+* [API Documentation](http://context.io/docs/2.0/)
+* [Sign Up](http://context.io)
 
-If all you want is to use the gem can install it with the following command:
+## Description
 
-    gem install contextio
+Provides a Ruby interface to [Context.IO](http://context.io). The general design
+was inspired by the wonderful [aws-sdk](https://github.com/aws/aws-sdk-ruby)
+gem. You start with an object that represents your account with Context.IO and
+then you deal with collections within that going forward. Check out the example.
 
-You can get more information at [http://context.io](http://context.io).  Complete API documentation is available at [http://context.io/docs/2.0/](http://context.io/docs/2.0/).
+If you're looking at the Context.IO docs, it is important to note that there are
+some attributes that've been renamed to be a bit more Ruby-friendly. In general,
+if the API returns a number meant to be seconds-from-epoch, then it's been
+converted to return a `Time` (e.g. `updated` has changed to `updated_at`) and a
+boolean has converted to something with a `?` at the end (e.g. `HasChildren` and
+`initial_import_finished` are `has_children?` and `initial_import_finished?`,
+respectively).
 
-An example
-----------
+## Example
 
-    require 'contextio'
-    require 'json'
+```ruby
+require 'contextio'
 
-    key     = 'the key you get in your developer console'
-    secret  = ' the secret you get in your developer console'
-    account = 'your account id'
+contextio = ContextIO.new('your_api_key', 'your_api_secret')
 
-    connection = ContextIO::Connection.new(key, secret)
-    messages = connection.list_messages(:account => account, :since => (Time.now - 24 * 60 * 60 * 5))
-    puts JSON.parse(messages.body).first['subject']
+account = contextio.accounts.where(email: 'some@email.com').first
 
-LICENSE
--------
+account.email_addresses # ['some@email.com', 'another@email.com']
+account.first_name # 'Bruno'
+account.suspended? # False
 
-Copyright (C) 2011 DokDok Inc.
+account.messages.where(folder: '\Drafts').each do |m|
+  puts m.subject
+end
+```
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+## Install
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+    $ gem install contextio
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 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.  
+Or, of course, put this in your Gemfile:
+
+    gem contextio
+
+## Version Numbers
+
+This gem adheres to [SemVer](http://semver.org/). So you should be pretty safe
+upgrading from 1.0.0 to 1.9.9. Whatever as long as the major version doesn't
+bump. When the major version bumps, be warned; upgrading will take some kind of
+effort.
+
+## Contributing
+
+Help is gladly welcomed. If you have a feature you'd like to add, it's much more
+likely to get in (or get in faster) the closer you stick to these steps:
+
+1. Open an Issue to talk about it. We can discuss whether it's the right
+  direction or maybe help track down a bug, etc.
+1. Fork the project, and make a branch to work on your feature/fix. Master is
+  where you'll want to start from.
+1. Turn the Issue into a Pull Request. There are several ways to do this, but
+  [hub](https://github.com/defunkt/hub) is probably the easiest.
+1. Make sure your Pull Request includes tests.
+
+If you don't know how to fix something, even just a Pull Request that includes a
+failing test can be helpful. If in doubt, make an Issue to discuss.
+
+## Copyright
+
+Copyright (c) 2012 Context.IO
+
+See LICENSE.md for details.

data/Rakefile

@@ -1,46 +1,56 @@
-require 'rubygems'
-require 'rubygems/specification'
-require 'rake'
-require 'rake/gempackagetask'
+# encoding: utf-8
 
-GEM = "contextio"
-GEM_VERSION = "0.4.0"
-SUMMARY = "Provides interface for Context.IO email"
-AUTHOR = "Dominik Gehl"
-EMAIL = "dominik@context.io"
-HOMEPAGE = "http://context.io/"
-
-task :default => [:test]
+require 'rubygems'
 
-task :test do
-  ruby "spec/contextio_spec.rb"
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit e.status_code
 end
 
-spec = Gem::Specification.new do |s|
-  s.name = GEM
-  s.version = GEM_VERSION
-  s.platform = Gem::Platform::RUBY
-  s.summary = SUMMARY
-  s.require_paths = ['lib']
-  s.files = FileList['app_generators/**/*', 'bin/*', 'lib/**/*.rb', '[A-Z]*'].to_a
-
-  s.author = AUTHOR
-  s.email = EMAIL
-  s.homepage = HOMEPAGE
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
 end
 
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-end
+require 'rake'
 
-desc "Install the gem locally"
-task :install => [:package] do
-  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
 
-desc "Create a gemspec file"
-task :make_spec do
-  File.open("#{GEM}.gemspec", "w") do |file|
-    file.puts spec.to_ruby
+task :test    => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new  
+task :doc => :yard
+
+desc "Fire up an interactive terminal to play with"
+task :console do
+  require 'pry'
+  require File.expand_path(File.dirname(__FILE__) + '/lib/contextio')
+
+  config = YAML.load_file File.expand_path(File.dirname(__FILE__) + '/spec/config.yml')
+  @api = ContextIO.new(config['key'], config['secret'])
+
+  # add ability to reload console
+  def reload
+    reload_msg = '# Reloading the console...'
+    puts CodeRay.scan(reload_msg, :ruby).term
+    Pry.save_history
+    exec('rake console')
   end
+
+  welcome = <<-EOS
+    Welcome to the Context.IO developer console. If you put your API credentials in
+    /spec/config.yml, you'll have a handle on the API named `@api` to play with.
+  EOS
+
+  puts welcome
+  Pry.start
 end

data/contextio.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/contextio/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "contextio"
+  gem.version       = ContextIO.version
+  gem.summary       = 'Provides interface to Context.IO'
+  gem.description   = 'Provides Ruby interface to Context.IO'
+  gem.license       = 'MIT'
+  gem.authors       = ['Ben Hamill']
+  gem.email         = %w(ben@benhamill.com)
+  gem.homepage      = 'https://github.com/contextio/contextio-ruby#readme'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'oauth', '~> 0.4.5'
+
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rubygems-tasks',  '~> 0.2'
+  gem.add_development_dependency 'rspec',           '~> 2.4'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'redcarpet'
+  gem.add_development_dependency 'pry-doc'
+  gem.add_development_dependency 'fakeweb'
+end

data/lib/contextio.rb

@@ -1,589 +1,75 @@
-require 'oauth'
-require 'net/http'
-
-warn("WARNING: You're using the contextio gem from the dev_2.0 in an old repository. As of the 18th of June, 2013 this repository may vanish. Please use a released version of the gem (this branch was released as-is as version 0.5.0).")
-
-module ContextIO
-  VERSION = "2.0"
-
-  class ContextIO::Connection
-    def initialize(key='', secret='', server='https://api.context.io')
-      @consumer = OAuth::Consumer.new(key, secret, {:site => server, :sheme => :header})
-      @token    = OAuth::AccessToken.new @consumer
-    end
-
-    def discovery(options)
-      get 'discovery', {:source_type => 'imap'}.merge(options)
-    end
-
-    def list_connect_tokens()
-      get 'connect_tokens'
-    end
-
-    def get_connect_token(options)
-      if ! options.has_key?(:token) then
-        raise ArgumentError, "missing required argument token", caller
-      end
-      get "connect_tokens/#{options[:token]}"
-    end
-
-    def add_connect_token(options)
-      if ! options.has_key?(:callback_url) then
-        raise ArgumentError, "missing required argument callback_url", caller
-      end
-      post "connect_tokens", options
-    end
-
-    def delete_connect_token(options)
-      if ! options.has_key?(:token) then
-        raise ArgumentError, "missing required argument token", caller
-      end
-      delete "connect_tokens/#{options[:token]}"
-    end
-
-    def list_oauth_providers
-      get 'oauth_providers'
-    end
-
-    def get_oauth_provider(options)
-      if ! options.has_key?(:provider_consumer_key) then
-        raise ArgumentError, "missing required argument provider_consumer_key", caller
-      end
-      get "oauth_providers/#{options[:provider_consumer_key]}"
-    end
-
-    def add_oauth_provider(options)
-      if ! options.has_key?(:provider_consumer_key) then
-        raise ArgumentError, "missing required argument provider_consumer_key", caller
-      end
-      if ! options.has_key?(:type) then
-        raise ArgumentError, "missing required argument type", caller
-      end
-      if ! options.has_key?(:provider_consumer_secret) then
-        raise ArgumentError, "missing required argument provider_consumer_secret", caller
-      end
-      post "oauth_providers/", options
-    end
-
-    def delete_oauth_provider(options)
-      if ! options.has_key?(:provider_consumer_key) then
-        raise ArgumentError, "missing required argument provider_consumer_key", caller
-      end
-      delete "oauth_providers/#{options[:provider_consumer_key]}"
-    end
-
-    def list_contacts(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      account = options.delete(:account)
-      get "accounts/#{account}/contacts", options
-    end
-
-    def get_contact(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:email) then
-        raise ArgumentError, "missing required argument email", caller
-      end
-      get "accounts/#{options[:account]}/contacts/#{URI.escape options[:email]}"
-    end
-
-    def list_contact_files(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:email) then
-        raise ArgumentError, "missing required argument email", caller
-      end
-      account = options.delete(:account)
-      email = URI.escape(options.delete(:email))
-      get "accounts/#{account}/contacts/#{email}/files", options
-    end
-
-    def list_contact_messages(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:email) then
-        raise ArgumentError, "missing required argument email", caller
-      end
-      account = options.delete(:account)
-      email = URI.escape(options.delete(:email))
-      get "accounts/#{account}/contacts/#{email}/messages", options
-    end
-
-    def list_contact_threads(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:email) then
-        raise ArgumentError, "missing required argument email", caller
-      end
-      account = options.delete(:account)
-      email = URI.escape(options.delete(:email))
-      get "accounts/#{account}/contacts/#{email}/threads", options
-    end
-
-    def list_files(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      account = options.delete(:account)
-      get "accounts/#{account}/files", options
-    end
-
-    def get_file(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:file_id) then
-        raise ArgumentError, "missing required argument file_id", caller
-      end
-      get "accounts/#{options[:account]}/files/#{options[:file_id]}"
-    end
-
-    def get_file_content(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:file_id) then
-        raise ArgumentError, "missing required argument file_id", caller
-      end
-      if ! options.has_key?(:as_link) then
-        get "accounts/#{options[:account]}/files/#{options[:file_id]}/content"
-      else
-        get "accounts/#{options[:account]}/files/#{options[:file_id]}/content?as_link=#{options[:as_link]}"
-      end
-    end
-
-    def get_file_changes(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:file_id) then
-        raise ArgumentError, "missing required argument file_id", caller
-      end
-      account = options.delete(:account)
-      file_id = options.delete(:file_id)
-      get "accounts/#{account}/files/#{file_id}/changes", options
-    end
-
-    def list_file_revisions(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:file_id) then
-        raise ArgumentError, "missing required argument file_id", caller
-      end
-      account = options.delete(:account)
-      file_id = options.delete(:file_id)
-      get "accounts/#{account}/files/#{file_id}/revisions", options
-    end
-
-    def list_file_related(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:file_id) then
-        raise ArgumentError, "missing required argument file_id", caller
-      end
-      account = options.delete(:account)
-      file_id = options.delete(:file_id)
-      get "accounts/#{account}/files/#{file_id}/related", options
-    end
-
-    def list_messages(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      account = options.delete(:account)
-      get "accounts/#{account}/messages", options
-    end
-
-    def get_message(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-
-      account = options.delete(:account)
-      if options.has_key?(:email_message_id) then
-        email_message_id = URI.escape(options.delete(:email_message_id))
-        get "accounts/#{account}/messages/#{email_message_id}"
-      elsif options.has_key?(:message_id) then
-        message_id = options.delete(:message_id)
-        get "accounts/#{account}/messages/#{message_id}"
-      elsif options.has_key?(:gmail_message_id) then
-        gmail_message_id = options.delete(:gmail_message_id)
-        if options[:gmail_message_id].start_with?('gm-') then
-          get "accounts/#{account}/messages/#{gmail_message_id}"
-        else
-          get "accounts/#{account}/messages/gm-#{gmail_message_id}"
-        end
-      end
-    end
-
-    def get_message_headers(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-
-      account = options.delete(:account)
-      if options.has_key?(:email_message_id) then
-        email_message_id = URI.escape(options.delete(:email_message_id))
-        get "accounts/#{account}/messages/#{email_message_id}/headers"
-      elsif options.has_key?(:message_id) then
-        message_id = options.delete(:message_id)
-        get "accounts/#{account}/messages/#{message_id}/headers"
-      elsif options.has_key?(:gmail_message_id) then
-        gmail_message_id = options.delete(:gmail_message_id)
-        if options[:gmail_message_id].start_with?('gm-') then
-          get "accounts/#{account}/messages/#{gmail_message_id}/headers"
-        else
-          get "accounts/#{account}/messages/gm-#{gmail_message_id}/headers"
-        end
-      end
-    end
-
-    def get_message_flags(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-
-      account = options.delete(:account)
-      if options.has_key?(:email_message_id) then
-        email_message_id = URI.escape(options.delete(:email_message_id))
-        get "accounts/#{account}/messages/#{email_message_id}/flags"
-      elsif options.has_key?(:message_id) then
-        message_id = options.delete(:message_id)
-        get "accounts/#{account}/messages/#{message_id}/flags"
-      elsif options.has_key?(:gmail_message_id) then
-        gmail_message_id = options.delete(:gmail_message_id)
-        if options[:gmail_message_id].start_with?('gm-') then
-          get "accounts/#{account}/messages/#{gmail_message_id}/flags"
-        else
-          get "accounts/#{account}/messages/gm-#{gmail_message_id}/flags"
-        end
-      end
-    end
-
-    def get_message_body(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-
-      account = options.delete(:account)
-      if options.has_key?(:email_message_id) then
-        email_message_id = URI.escape(options.delete(:email_message_id))
-        get "accounts/#{account}/messages/#{email_message_id}/body"
-      elsif options.has_key?(:message_id) then
-        message_id = options.delete(:message_id)
-        get "accounts/#{account}/messages/#{message_id}/body"
-      elsif options.has_key?(:gmail_message_id) then
-        gmail_message_id = options.delete(:gmail_message_id)
-        if options[:gmail_message_id].start_with?('gm-') then
-          get "accounts/#{account}/messages/#{gmail_message_id}/body"
-        else
-          get "accounts/#{account}/messages/gm-#{gmail_message_id}/body"
-        end
-      end
-    end
-
-    def get_message_thread(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-
-      if options.has_key?(:email_message_id) then
-        get "accounts/#{options[:account]}/messages/#{URI.escape options[:email_message_id]}/thread"
-      elsif options.has_key?(:message_id) then
-        get "accounts/#{options[:account]}/messages/#{options[:message_id]}/thread"
-      elsif options.has_key?(:gmail_message_id) then
-        if options[:gmail_message_id].start_with?('gm-') then
-          get "accounts/#{options[:account]}/messages/#{options[:gmail_message_id]}/thread"
-        else
-          get "accounts/#{options[:account]}/messages/gm-#{options[:gmail_message_id]}/thread"
-        end
-      end
-    end
-
-    def list_threads(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      account = options.delete(:account)
-      get "accounts/#{account}/threads", options
-    end
-
-    def get_thread(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-
-      if options.has_key?(:email_message_id) then
-        get "accounts/#{options[:account]}/messages/#{URI.escape options[:email_message_id]}/thread"
-      elsif options.has_key?(:message_id) then
-        get "accounts/#{options[:account]}/messages/#{options[:message_id]}/thread"
-      elsif options.has_key?(:gmail_message_id) then
-        if options[:gmail_message_id].start_with?('gm-') then
-          get "accounts/#{options[:account]}/messages/#{options[:gmail_message_id]}/thread"
-        else
-          get "accounts/#{options[:account]}/messages/gm-#{options[:gmail_message_id]}/thread"
-        end
-      elsif options.has_key?(:gmail_thread_id) then
-        if options[:gmail_thread_id].start_with?('gm-') then
-          get "accounts/#{options[:account]}/threads/#{options[:gmail_thread_id]}"
-        else
-          get "accounts/#{options[:account]}/threads/gm-#{options[:gmail_thread_id]}"
-        end
-      end
-    end
-
-    def add_account(options)
-      if ! options.has_key?(:email) then
-        raise ArgumentError, "missing required argument email", caller
-      end
-      post "accounts", options
-    end
-
-    def modify_account(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      account = options.delete(:account)
-      post "accounts/#{account}", options
-    end
-
-    def get_account(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      account = options.delete(:account)
-      get "accounts/#{account}"
-    end
-
-    def delete_account(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      account = options.delete(:account)
-      delete "accounts/#{account}"
-    end
-
-    def list_account_email_addresses(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      get "accounts/#{options[:account]}/email_addresses"
-    end
-
-    def delete_email_address_from_account(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:email_address) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      delete "accounts/#{account}/email_addresses/#{options[:email_address]}"
-    end
-
-    def set_primary_email_address_for_account(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:email_address) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      post "accounts/#{account}/email_addresses/#{options[:email_address]}", {:primary => 1}
-    end
-
-    def add_email_address_to_account(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:email_address) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      account = options.delete(:account)
-      post "accounts/#{account}/email_addresses", options
-    end
-
-    def list_accounts(options)
-      get "accounts", options
-    end
-
-    def modify_source(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:label) then
-        raise ArgumentError, "missing required argument label", caller
-      end
-      account = options.delete(:account)
-      label = URI.escape(options.delete(:label))
-      post "accounts/#{account}/sources/#{label}", options
-    end
-
-    def reset_source_status(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:label) then
-        raise ArgumentError, "missing required argument label", caller
-      end
-      post "accounts/#{options[:account]}/sources/#{URI.escape options[:label]}", { :status => 1 }
-    end
-
-    def list_sources(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      get "accounts/#{options[:account]}/sources"
-    end
-
-    def get_source(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:label) then
-        raise ArgumentError, "missing required argument label", caller
-      end
-      get "accounts/#{options[:account]}/sources/#{URI.escape options[:label]}"
-    end
-
-    def add_source(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:type) then
-        options[:type] = 'imap'
-      end
-      account = options.delete(:account)
-      post "accounts/#{account}/sources", options
-    end
-
-    def delete_source(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:label) then
-        raise ArgumentError, "missing required argument label", caller
-      end
-      delete "accounts/#{options[:account]}/sources/#{URI.escape options[:label]}"
-    end
-
-    def sync_source(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:label) then
-        post "accounts/#{options[:account]}/sync"
-      else
-        post "accounts/#{options[:account]}/sources/#{URI.escape options[:label]}/sync"
-      end
-    end
-
-    def get_sync(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:label) then
-        get "accounts/#{options[:account]}/sync"
-      else
-        get "accounts/#{options[:account]}/sources/#{URI.escape options[:label]}/sync"
-      end
-    end
-
-    def add_folder_to_source(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:label) then
-        raise ArgumentError, "missing required argument label", caller
-      end
-      put "accounts/#{options[:account]}/sources/#{URI.escape options[:label]}/folders/#{URI.escape options[:folder]}"
-    end
-
-    def list_source_folders(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:label) then
-        raise ArgumentError, "missing required argument label", caller
-      end
-      get "accounts/#{options[:account]}/sources/#{URI.escape options[:label]}/folders"
-    end
-
-    def list_webhooks(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      get "accounts/#{options[:account]}/webhooks"
-    end
-
-    def get_webhook(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:webhook_id) then
-        raise ArgumentError, "missing required argument webhook_id", caller
-      end
-      get "accounts/#{options[:account]}/webhooks/#{options[:webhook_id]}"
-    end
-
-    def add_webhook(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      account = options.delete(:account)
-      post "accounts/#{account}/webhooks", options
-    end
-
-    def delete_webhook(options)
-      if ! options.has_key?(:account) then
-        raise ArgumentError, "missing required argument account", caller
-      end
-      if ! options.has_key?(:webhook_id) then
-        raise ArgumentError, "missing required argument webhook_id", caller
-      end
-      delete "accounts/#{options[:account]}/webhooks/#{options[:webhook_id]}"
-    end
-
-    private
-
-    def url(*args)
-      if args.length == 1
-        "/#{ContextIO::VERSION}/#{args[0]}"
-      else
-        "/#{ContextIO::VERSION}/#{args.shift.to_s}?#{parametrize args.last}"
-      end
-    end
-
-    def get(*args)
-      @token.get(url(*args), { 'Accept' => 'application/json' })
-    end
+# Provides an object-oriented interface for the Context.IO API.
+#
+# To use it, you have to [sign up for an account](http://context.io).
+#
+# Once you have an account, you can create a new `ContextIO` object and interact
+# with the API using the methods on that object as a starting point.
+class ContextIO
+  # @private
+  # Handle for the `API` instance. For internal use only.
+  attr_reader :api
+
+  # Creates a new `ContextIO` instance and makes a new handle for the API.
+  # This is your entry point to your Context.IO account.  For a web app, you
+  # probably want to instantiate this in some kind of initializer and keep it
+  # around for the life of the process.
+  #
+  # @param [String] key Your OAuth consumer key for your Context.IO account
+  # @param [String] secret Your OAuth consumer secret for your Context.IO
+  #   account
+  def initialize(key, secret)
+    @api = API.new(key, secret)
+  end
 
-    def delete(*args)
-      @token.delete(url(*args), { 'Accept' => 'application/json' })
-    end
+  # Your entry point for dealing with oauth providers.
+  #
+  # @return [OAuthProviderCollection] Allows you to work with the providers for
+  #   your account as a group.
+  def oauth_providers
+    OAuthProviderCollection.new(api)
+  end
 
-    def put(action, args=nil)
-      @token.put(url(action), args, { 'Accept' => 'application/json' })
-    end
+  # Your entry point for dealing with connect tokens.
+  #
+  # @return [ConnectTokenCollection] Allows you to work with the tokens for
+  #   your account as a group.
+  def connect_tokens
+    ConnectTokenCollection.new(api)
+  end
 
-    def post(action, args=nil)
-      @token.post(url(action), args, { 'Accept' => 'application/json' })
-    end
+  # Your entry point for dealing with accounts.
+  #
+  # @return [AccountCollection] Allows you to work with the email accounts for
+  #   your account as a group.
+  def accounts
+    AccountCollection.new(api)
+  end
 
-    def parametrize(options)
-      URI.escape(options.collect do |k,v|
-        v = v.to_i if k == :since
-        v = v.join(',') if v.instance_of?(Array)
-        k = k.to_s
-        #k = k.to_s.gsub('_', '')
-        "#{k}=#{v}"
-      end.join('&'))
-    end
+  # Discover the IMAP settings for an email account.
+  #
+  # @param [String] email_address The email address in question.
+  # @param [String] source_type The only source type currently supported by the
+  #   API is 'IMAP'.
+  #
+  # @return [EmailSettings] Allows you to inspec the settings for an account's
+  #   IMAP server.
+  def email_settings_for(email_address, source_type = 'IMAP')
+    EmailSettings.new(api, email_address, source_type)
   end
 end
+
+require_relative 'contextio/version'
+
+require_relative 'contextio/api'
+
+require_relative 'contextio/oauth_provider_collection'
+require_relative 'contextio/email_settings'
+require_relative 'contextio/connect_token_collection'
+require_relative 'contextio/account_collection'
+require_relative 'contextio/source_collection'
+require_relative 'contextio/folder_collection'
+require_relative 'contextio/message_collection'
+require_relative 'contextio/body_part_collection'
+require_relative 'contextio/thread_collection'
+require_relative 'contextio/webhook_collection'
+require_relative 'contextio/contact_collection'