inbox 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abe056c1b96943e3cddcb3b5ec95094ad07088f8
+  data.tar.gz: 71e10c1505539c294f862265799608ec30b839aa
+SHA512:
+  metadata.gz: 36b4a7954a470d684038e56992795608fa244ca9a121b07b7d064aa60e76e689970ef270b34c7357a1c1bb21fb1aaeeb53ce5700dbfecd7bfd4e973c0b519a82
+  data.tar.gz: 42224c275e7beff0a84543729f49c82b102728599c5660a6132b91af541e4f0a78884dd286b55b98ccf1bde40156a39ca511ea62a5ed0d16df94b4e2fad3a300

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'rest-client', '~> 1.6.8'
+gem 'activesupport', '~> 4.1.4'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development, :test do
+  gem 'rspec'
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.3.5"
+  gem "jeweler", "~> 1.8.4"
+  gem 'pry'
+  gem 'pry-nav'
+  gem 'pry-stack_explorer'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+----
+
+Copyright (c) 2014 InboxApp, Inc. and Contributors
+
+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,126 +1,214 @@
-Inbox
-=====
+# Inbox Ruby bindings
 
+## Installation
 
-Description
------------
+Add this line to your application's Gemfile:
 
-* Preview send emails in development and test mode.
+    gem 'inbox'
 
-* Test them using your standard Capybara matchers or
-any other testing framework that you prefer.
+And then execute:
 
+    bundle
 
-Installation
-------------
+You don't need to use this repo unless you're planning to modify the gem. If you just want to use the Inbox SDK with Ruby bindings, you should run:
 
-In your `Gemfile` add:
+    gem install inbox
 
-```ruby
-gem 'inbox'
-```
 
-And run:
+##Requirements
 
-```
-bundle install
-```
+- Ruby 1.8.7 or above. (Ruby 1.8.6 may work if you load ActiveSupport.)
+
+- rest-client, json
+
+
+## Example
+
+A small example Rails app is included in the `example` directory. You can run the sample app to see how an authentication flow might be implemented. 
+
+`cd example`
 
+`RESTCLIENT_LOG=stdout rails s`
 
-Setup
------
+*Note that you will need to replace the Inbox App ID and Secret in `config/environments/development.rb` to use the sample app.*
 
-Mount engine in `config/routes.rb`
+## Usage
 
-```ruby
-Rails.application.routes.draw do
-  mount Inbox::Engine => "/inbox"
+### App ID and Secret
+
+Before you can interact with the Inbox API, you need to register for the Inbox developer program at [http://www.inboxapp.com/](http://www.inboxapp.com/). After you've created a developer account, you can create a new application to generate an App ID / Secret pair.
+
+### Authentication
+
+The Inbox API uses server-side (three-legged) OAuth, and the Ruby gem provides a convenience methods that simplify the OAuth process. For more information about authenticating with Inbox, visit the [Developer Documentation](https://www.inboxapp.com/docs/gettingstarted-hosted#authenticating).
+
+**Step 1: Redirect the user to Inbox:**
+
+```
+:::ruby
+require 'inbox'
+
+def login
+    inbox = Inbox::API.new(config.inbox_app_id, config.inbox_app_secret,         nil)
+    # The email address of the user you want to authenticate
+    user_email = 'ben@inboxapp.com'
+
+    # This URL must be registered with your application in the developer portal
+    callback_url = url_for(:action => 'login_callback')
+    
+    redirect_to inbox.url_for_authentication(callback_url, user_email)
 end
 ```
 
-Feel free to mount it under different route
-if this one is already taken in your application
+**Step 2: Handle the Authentication Response:**
 
-```ruby
-  mount Inbox::Engine => "/mailer"
 ```
+:::ruby
+def login_callback 
+    inbox = Inbox::API.new(config.inbox_app_id, config.inbox_app_secret, nil)
+    inbox_token = inbox.auth_token_for_code(params[:code])
 
+    # Save the inbox_token to the current session, save it to the user model, etc.
+end
+```
 
-Usage
------
+### Fetching Namespaces
 
-### Manual
+```
+:::ruby
+inbox = Inbox::API.new(config.inbox_app_id, config.inbox_app_secret, inbox_token)
 
-Navigate to `/inbox/<email>/emails` ex.: `/inbox/robert.pankowecki@gmail.com/emails`
-to see a list of emails that would have been delivered to the user.
+# Get the first namespace
+namespace = inbox.namespaces.first
 
-Click subject of the email to see its content
+# Print out the email address and provider (Gmail, Exchange)
+puts namespace.email_address
+puts namespace.provider
+```
 
-### Testing framework
 
-In [capybara](https://github.com/jnicklas/capybara/) or [bbq](https://github.com/drugpl/bbq)
+### Fetching Threads
 
-```ruby
-visit("/inbox/robert.pankowecki@gmail.com/emails")
-click_link("Subject of the email")
-has_content?("This should be in email")
-click_link("Some link in the email ex. account activation link")
 ```
+:::ruby
+# Fetch the first thread
+thread = namespace.threads.first
+
+# Fetch a specific thread
+thread = namespace.threads.find('ac123acd123ef123')
+
+# List all threads tagged `inbox`
+# (paginating 50 at a time until no more are returned.)
+namespace.threads.where(:tag => 'inbox').each do |thread|
+  puts thread.subject
+end    
+
+# List the 5 most recent unread threads
+namespace.threads.where(:tag => 'unread').range(0,4).each do |thread|
+  puts thread.subject
+end    
+
+# List all threads with 'ben@inboxapp.com'
+namespace.threads.where(:any_email => 'ben@inboxapp.com').each do |thread|
+  puts thread.subject
+end    
+
+# Collect all threads with 'ben@inboxapp.com' into an array.
+# Note: for large numbers of threads, this is not advised.
+threads = namespace.threads.where(:any_email => 'ben@inboxapp.com').all
+```
+
 
-The nice thing is that this is just HTML page displaying email content so you can use
-your favorite testing framework (`BBQ`, `Capybara`, `Test::Unit`, `Spinach`, `Cucumber`, `RSpec`, whatever)
-for checking the content of page. And you can reuse your matchers.
+### Working with Threads
 
+```
+:::ruby
+# List thread participants
+thread.participants.each do |participant|
+    puts participant['email']
+end
 
-### Sending
+# Mark as read
+thread.mark_as_read!
 
-Navigate to `/inbox/<email>/emails/new` ex.: `/inbox/robert.pankowecki@gmail.com/emails/new`
-to see an ugly form for sending emails that you can use to play around and see if everything
-works fine.
+# Archive
+thread.archive!
 
-### Clear send emails
+# Add or remove arbitrary tags
+tagsToAdd = ['inbox', 'cfa1233ef123acd12']
+tagsToRemove = []
+thread.update_tags!(tagsToAd, tagsToRemove)
 
-```ruby
-  ActionMailer::Base.deliveries.clear # in :test mode
-  Inbox::FileDelivery.new(ActionMailer::Base.inbox_settings).clear # in :inbox mode
+# List messages
+thread.messages.each do |message|
+    puts message.subject
+end
 ```
 
-Async (distributed / queue)
----------------------------
 
-In case you want to have acceptance tests of emails that are
-sent using external process (`resque`, `sidekiq`, ...) just set
+### Working with Files
+
+```
+:::ruby
+# List files
+namespace.files.each do |file|
+    puts file.filename
+end
 
-```ruby
-config.action_mailer.delivery_method = :inbox
+# Create a new file
+file = namespace.files.build(:file => File.new("./public/favicon.ico", 'rb'))
+file.save!
 ```
 
-in `config/environments/test.rb` and create `tmp/mails` directory.
+### Working with Messages, Contacts, etc.
+
+Each of the primary collections (contacts, messages, etc.) behave the same way as `threads`. For example, finding messages with a filter is similar to finding threads:
+
+```
+:::ruby
+messages = namespace.messages.where(:to => 'ben@inboxapp.com`).all
+```
 
+The `where` method accepts a hash of filters, as documented in the [Inbox Filters Documentation](https://www.inboxapp.com/docs/api#filters). 
 
-If you send emails from your Rails models, controllers, services or use-cases you can stick with:
+### Creating and Sending Drafts
 
-```ruby
-config.action_mailer.delivery_method = :test
 ```
+:::ruby
+# Create a new draft
+draft = namespace.drafts.build(
+  :to => [{:name => 'Ben Gotow', :email => 'ben@inboxapp.com'}],
+  :subject => "Sent by Ruby",
+  :body => "Hi there!<strong>This is HTML</strong>"
+)
+
+# Modify attributes as necessary
+draft.cc = [{:name => 'Michael', :email => 'mg@inboxapp.com'}]
+
+# Add the file we uploaded as an attachment
+draft.attach(file)
+
+# Save the draft
+draft.save!
+
+# Send the draft. This method returns immediately and queues the message
+# with Inbox for delivery through the user's SMTP gateway.
+draft.send!
+```
+
 
+## Contributing
 
-Look & Feel
------------
+We'd love your help making the Inbox ruby gem better. Join the Google Group for project updates and feature discussion. We also hang out in `##inbox` on [irc.freenode.net](http://irc.freenode.net), or you can email [help@inboxapp.com](mailto:help@inboxapp.com).
 
-![Inbox gem look and feel](http://img832.imageshack.us/img832/1333/screenshotinboxgooglech.png)
+Please sign the Contributor License Agreement before submitting pull requests. (It's similar to other projects, like NodeJS or Meteor.)
 
+The Inbox ruby gem uses [Jeweler](https://github.com/technicalpickles/jeweler) for release management. When you're ready to release a new version, do something like this:
 
-Inspirations
-------------
+    rake version:bump:minor
+    rake release
 
-* [https://github.com/37signals/mail_view](https://github.com/37signals/mail_view)
-* [https://github.com/ryanb/letter_opener](https://github.com/ryanb/letter_opener)
-* [https://github.com/suhrawardi/capybara_email/](https://github.com/suhrawardi/capybara_email/)
-* [https://github.com/pawelpacana/mail_inbox/](https://github.com/pawelpacana/mail_inbox/)
-* [http://api.rubyonrails.org/](http://api.rubyonrails.org/)
+Tests can be run with:
 
-License
--------
+    rspec spec
 
-MIT-LICENSE

data/Rakefile

@@ -1,39 +1,44 @@
-#!/usr/bin/env rake
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
 begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
 end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "inbox"
+  gem.homepage = "http://github.com/inboxapp/inbox-ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{Gem for interacting with the Inbox API}
+  gem.description = %Q{Gem for interacting with the Inbox API that allows you to create and publish one-page websites, subscribe to web hooks and receive events when those pages are interacted with. Visit http://www.populr.me/ for more information. }
+  gem.email = "ben@inboxapp.com"
+  gem.authors = ["Ben Gotow"]
+  # dependencies defined in Gemfile
 end
+Jeweler::RubygemsDotOrgTasks.new
 
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Inbox'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
 
-Bundler::GemHelper.install_tasks
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "inbox #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
-
-
-task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/example/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/example/Gemfile

@@ -0,0 +1,39 @@
+source 'https://rubygems.org'
+
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.1.4'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 4.0.3'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+# Use CoffeeScript for .js.coffee assets and views
+gem 'coffee-rails', '~> 4.0.0'
+# See https://github.com/sstephenson/execjs#readme for more supported runtimes
+# gem 'therubyracer',  platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.0'
+# bundle exec rake doc:rails generates the API under doc/api.
+gem 'sdoc', '~> 0.4.0',          group: :doc
+
+gem 'inbox',  :path => '../../'
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+# Use debugger
+# gem 'debugger', group: [:development, :test]
+