digitsend 0.0.9 → 0.0.10

data/README.md

@@ -1,29 +1,94 @@
-# Digitsend
+# DigitSend
 
-TODO: Write a gem description
+DigitSend is a secure email and file sharing service with a streamlined
+two-factor registration process.  This gem allows you to send email and upload
+files to share programmatically.
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+### 1. API Key
 
-    gem 'digitsend'
+You must set the API key before performing any operations.  API keys are
+granted on a per-user basis using the administration portal.  All operations
+are done on behalf of the user to which the API key belongs.
 
-And then execute:
+```ruby
+DigitSend::Config.api_token = 'bdf6a88dcb7e3ff3df18afda99591360'
+```
+ 
+### 2. Sending Messages
 
-    $ bundle
+The general approach:
 
-Or install it yourself as:
+```ruby
+DigitSend::Message.send do |m|
+  m.to "bob@example.com", "3125551234"
+  m.to "tom@example.com", "7731112222"
+  m.cc "fred@example.com"
+  m.subject "Hello Bob, Tom, and Fred"
+  m.body "Here's a message, hope you enjoy!"
+  m.attach "report.xls"
+  m.attach "notes.txt", "here's the contents of notes.txt"
+end
+```
 
-    $ gem install digitsend
+A few things to note:
 
-## Usage
+* Call to or cc multiple times to add multiple recipients.
+* The second (optional) argument to the to and cc methods is that user's phone
+  number.  The phone number is required if this is the first message being sent
+  to the user.
+
+### 3. DigitSend::MissingPhoneNumbers
+
+This exception is thrown whenever an attempt is made to send a message to a new
+user without providing a phone number:
+
+```ruby
+begin
+  DigitSend::Message.send do |m|
+    m.to "bob@example.com"
+    m.subject "Testing"
+    m.body "Here's a test mesage"
+  end
+rescue DigitSend::MissingPhoneNumbers => ex
+  puts "need phone numbers for: #{ex.email_addresses}"
+end
+```
+
+### 4. Message File Attachments
+
+The attach method can be called a number of ways:
+
+```ruby
+DigitSend::Message.send do |m|
+  m.to "bob@example.com"
+  m.subject "Here's some attachments"
+
+  # Attach the report.xls file on disk.
+  m.attach "/path/to/report.xls"
+
+  # Attach a file with its contents specified as a string.
+  m.attach "reports.txt", "contents of the file"
+
+  # Attach a file with its contents specified as any object
+  # that can be passed to UploadIO.new. 
+  m.attach "picture.jpg", File.open("picture.jpg")
+end
+```
+
+### 5. Uploading Files to Repositories
 
-TODO: Write usage instructions here
+Repositories are referenced by name and must be created in using the admin
+portal.
 
-## Contributing
+```ruby
+DigitSend::Repository.upload "Reports", "/Internal/#{Date.today}", "activity.csv"
+```
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+* The first parameter is the name of the repository.
+* The second parameter identifies the folder to which the file should belong.  Folders are created on the fly, mkdir_p style.
+* The third parameter is the name of the file.
+* The optional fourth parameter can can be the string contents of the file or
+  an object; it has the same behavior as with message attachments described
+  above.

data/lib/digitsend/repository.rb

@@ -1,6 +1,6 @@
 module DigitSend
   class Repository
-    def self.upload(repo_name, path, filename, data)
+    def self.upload(repo_name, path, filename, data = nil)
       uuid = Client.upload_s3_file(filename, data)
 
       Client.call '/files/versions',

data/lib/digitsend/version.rb

@@ -1,3 +1,3 @@
 module DigitSend
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: digitsend
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors: