helios 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb508f39436880b9f51516b84b09bf0b205871bd
-  data.tar.gz: 294a16abea5d1312b99a4148b55168adcf786ea7
+  metadata.gz: 542d4bf39d51733c585843526ac03d025fde4e62
+  data.tar.gz: 97a855428917028f33235877b5b128508ec14dd3
 SHA512:
-  metadata.gz: 11bda259eaba6e64174186bee37ca6a536fedb2fdd83242b4ba3b4731658fd673e007b7b5679a00b3acc88e0d14bd979918acc13c30a41de9d0aef0c4a14f634
-  data.tar.gz: 64f82a250be27b0f94a39db8783934db90e5a4e201de5a8ece8de34425f96d154d9a3c2e1374e15ad6ccfdd4e3195334b278e40e977f16f9cfe78ec4d2560b57
+  metadata.gz: b2351f4ac3eb166c14c5f6573a55510a47c3a799701801990fea73955c05e1c3819f10050451b7a54f1de389c28b81a59a3571d0c7e1fad3210023e437ce5253
+  data.tar.gz: d75fe05ef0a3218eb950dbfeb5ef8e2de7257b70de7abeb7455a335c4d86acd0f4eee1c8823b7d3800572e278a299203f5c269a03c26cc20836e6ceb830d6d1f

data/Gemfile.lock

@@ -1,22 +1,23 @@
 PATH
   remote: .
   specs:
-    helios (0.3.0)
+    helios (0.4.0)
       coffee-script (~> 2.2)
       commander (~> 4.1)
       compass (~> 0.12)
-      core_data
+      core_data (~> 0.1)
       fog (~> 1.10)
       foreman (~> 0.63)
       haml (>= 3.1)
-      houston (~> 0.2)
+      houston (~> 2.2)
       json (~> 1.7)
+      pg (~> 0.17)
       rack-contrib (~> 1.1)
       rack-in-app-purchase (~> 0.1)
       rack-newsstand (~> 0.1)
       rack-passbook (~> 0.1)
       rack-push-notification (~> 0.4)
-      rack-scaffold (>= 0.0.3)
+      rack-scaffold (~> 0.2)
       rails-database-url (~> 1.0)
       sinatra (~> 1.3)
       sinatra-assetpack (= 0.2.3)
@@ -29,114 +30,135 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.0.0)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
       thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    atomic (1.1.10)
-    backports (3.3.3)
+      tzinfo (~> 1.1)
+    backports (3.6.0)
     builder (3.2.2)
-    chunky_png (1.2.8)
-    coffee-script (2.2.0)
+    chunky_png (1.3.1)
+    coffee-script (2.3.0)
       coffee-script-source
       execjs
-    coffee-script-source (1.6.3)
-    commander (4.1.3)
+    coffee-script-source (1.8.0)
+    commander (4.2.0)
       highline (~> 1.6.11)
-    compass (0.12.2)
+    compass (0.12.7)
       chunky_png (~> 1.2)
       fssm (>= 0.2.7)
-      sass (~> 3.1)
+      sass (~> 3.2.19)
     core_data (0.1.1)
       nokogiri (~> 1.4)
-    diff-lcs (1.2.4)
-    dotenv (0.8.0)
-    eventmachine (1.0.3)
-    excon (0.23.0)
-    execjs (1.4.0)
-      multi_json (~> 1.0)
-    fog (1.12.1)
+    diff-lcs (1.2.5)
+    dotenv (0.11.1)
+      dotenv-deployment (~> 0.0.2)
+    dotenv-deployment (0.0.2)
+    excon (0.39.5)
+    execjs (2.2.1)
+    fog (1.23.0)
+      fog-brightbox
+      fog-core (~> 1.23)
+      fog-json
+      fog-softlayer
+      ipaddress (~> 0.5)
+      nokogiri (~> 1.5, >= 1.5.11)
+    fog-brightbox (0.4.1)
+      fog-core (~> 1.22)
+      fog-json
+      inflecto
+    fog-core (1.24.0)
       builder
-      excon (~> 0.23.0)
-      formatador (~> 0.2.0)
+      excon (~> 0.38)
+      formatador (~> 0.2)
       mime-types
-      multi_json (~> 1.0)
       net-scp (~> 1.1)
       net-ssh (>= 2.1.3)
-      nokogiri (~> 1.5.0)
-      ruby-hmac
-    foreman (0.63.0)
-      dotenv (>= 0.7)
-      thor (>= 0.13.6)
-    formatador (0.2.4)
+    fog-json (1.0.0)
+      multi_json (~> 1.0)
+    fog-softlayer (0.3.15)
+      fog-core
+      fog-json
+    foreman (0.75.0)
+      dotenv (~> 0.11.1)
+      thor (~> 0.19.1)
+    formatador (0.2.5)
     fssm (0.2.10)
-    haml (4.0.3)
+    haml (4.0.5)
       tilt
-    highline (1.6.19)
-    houston (0.2.4)
+    highline (1.6.21)
+    houston (2.2.1)
       commander (~> 4.1)
       json
-    i18n (0.6.4)
+    i18n (0.6.11)
+    inflecto (0.0.2)
+    ipaddress (0.8.0)
     jsmin (1.0.1)
-    json (1.8.0)
-    mime-types (1.23)
-    minitest (4.7.5)
-    multi_json (1.7.7)
-    net-scp (1.1.2)
+    json (1.8.1)
+    mime-types (2.3)
+    mini_portile (0.6.0)
+    minitest (5.4.0)
+    multi_json (1.10.1)
+    net-scp (1.2.1)
       net-ssh (>= 2.6.5)
-    net-ssh (2.6.8)
-    nokogiri (1.5.10)
+    net-ssh (2.9.1)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    pg (0.17.1)
     plist (3.1.0)
     rack (1.5.2)
     rack-contrib (1.1.0)
       rack (>= 0.9.1)
-    rack-in-app-purchase (0.1.0)
+    rack-in-app-purchase (0.1.1)
       rack (~> 1.4)
       sequel (~> 3.37)
       sinatra (~> 1.3)
       venice
-    rack-newsstand (0.1.1)
+    rack-newsstand (0.1.2)
       builder (>= 3.0)
       plist (~> 3.1)
       rack (~> 1.4)
       sequel (~> 3.37)
       sinatra (~> 1.3)
-    rack-passbook (0.1.1)
+    rack-passbook (0.2.0)
       rack (~> 1.4)
       sequel (~> 3.37)
       sinatra (~> 1.3)
-    rack-protection (1.5.0)
+    rack-protection (1.5.3)
       rack
-    rack-push-notification (0.4.1)
+    rack-push-notification (0.5.0)
       rack (~> 1.4)
       rack-contrib (~> 1.1)
-      sequel (~> 3.37)
+      sequel (>= 3.0)
       sinatra (~> 1.3)
       sinatra-param (~> 0.1)
-    rack-scaffold (0.0.3)
+    rack-scaffold (0.2.0)
       activesupport (>= 3.0)
       rack (~> 1.4)
       rack-contrib (~> 1.1)
-      sinatra (~> 1.3)
+      sinatra (~> 1.4)
+      sinatra-contrib (~> 1.4)
       sinatra-param (~> 0.1)
     rack-test (0.6.2)
       rack (>= 1.0)
     rails-database-url (1.0.0)
-    rake (10.0.4)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
-    ruby-hmac (0.4.0)
-    sass (3.2.9)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    sass (3.2.19)
     sequel (3.48.0)
-    sinatra (1.4.3)
+    sinatra (1.4.5)
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
@@ -148,23 +170,23 @@ GEM
       tilt (>= 1.3.0)
     sinatra-backbone (0.1.1)
       sinatra
-    sinatra-contrib (1.4.0)
+    sinatra-contrib (1.4.2)
       backports (>= 2.0)
-      eventmachine
+      multi_json
       rack-protection
       rack-test
-      sinatra (~> 1.4.2)
+      sinatra (~> 1.4.0)
       tilt (~> 1.3)
     sinatra-param (0.1.3)
       sinatra (~> 1.3)
     sinatra-support (1.2.2)
       sinatra (>= 1.0)
     terminal-table (1.4.5)
-    thor (0.18.1)
-    thread_safe (0.1.0)
-      atomic
+    thor (0.19.1)
+    thread_safe (0.3.4)
     tilt (1.4.1)
-    tzinfo (0.3.37)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
     venice (0.2.0)
       commander (~> 4.1)
       json

data/README.md

@@ -14,38 +14,48 @@ Helios also comes with a Web UI. Browse and search through all of your database
 
 ## Requirements
 
-- Ruby 1.9
-- PostgreSQL 9.1 _([Postgres.app](http://postgresapp.com) is the easiest way to get a Postgres server running on your Mac)_
+- Ruby 2.0+ with [Bundler](http://bundler.io) installed
+- PostgreSQL 9.2+ _([Postgres.app](http://postgresapp.com) is the easiest way to get a Postgres server running on your Mac)_
 
 ## Getting Started on OS X
 
 1. Verify Ruby Installation:
 
-    `$ ruby -v`
-
-> If you do not see `ruby 1.9.x` printed, we suggest installing [RVM](http://rvm.io) to manage Ruby versions.
+```
+$ ruby -v
+```
 
-2. Install Helios at the command prompt:
+2. Install Helios, Bundler, and  at the command prompt:
 
-    `$ gem install helios`
+```
+$ gem install helios
+```
 
 3. Create a new Helios application:
 
-    `$ helios new myapp`
+```
+$ helios new myapp
+```
 
 3. Create a Postgres database at the command prompt:
 
-    `$ createdb -h localhost myapp`
+```
+$ createdb -h localhost myapp
+```
 
 > Database credentials are read from the `.env` file generated by Helios, as the variable `DATABASE_URL`. By default, this will point to a database with the name of the generated app.
 
 4. Change directory to `myapp`
 
-    `$ cd myapp`
+```
+$ cd myapp
+```
 
 5. Start the web server:
 
-    `$ helios server`
+```
+$ helios server
+```
 
 6. Go to [http://localhost:5000/admin](http://localhost:5000/admin) and you’ll see your app's Web UI
 
@@ -86,14 +96,18 @@ end
 
 To create a Rails app that uses Postgres as its database, pass the `-d postgresql` argument to the `rails new` command:
 
-    $ rails new APP_PATH -d postgresql
+```
+$ rails new APP_PATH -d postgresql
+```
 
 If you're adding Helios to an existing Rails project, be sure to specify a PostgreSQL database in `config/database.yml` and check that the `pg` gem is included in your `Gemfile`:
 
 #### Gemfile
 
-    gem 'helios'
-    gem 'pg'
+```ruby
+gem 'helios'
+gem 'pg'
+```
 
 Helios can be run as Rails middleware by adding this to the configuration block in `config/application.rb`
 
@@ -122,29 +136,13 @@ Each service in Helios can be enabled and configured separately:
 
 Each entity in the specified data model will have a `Sequel::Model` subclass created for it under the `Rack::CoreData::Models` namespace.
 
-<table>
-  <caption>Endpoints</caption>
-  <tr>
-    <td><tt>GET /:resources</tt></td>
-    <td>Get list of all of the specified resources</td>
-  </tr>
-  <tr>
-    <td><tt>POST /:resources</tt></td>
-    <td>Create a new instance of the specified resource</td>
-  </tr>
-  <tr>
-    <td><tt>GET /:resources/:id</tt></td>
-    <td>Get the specified resource instance</td>
-  </tr>
-  <tr>
-    <td><tt>PUT /:resources/:id</tt></td>
-    <td>Update the specified resource instance</td>
-  </tr>
-  <tr>
-    <td><tt>DELETE /:resources/:id</tt></td>
-    <td>Delete the specified resource instance</td>
-  </tr>
-</table>
+|                           |                                                    |
+|---------------------------|----------------------------------------------------|
+| `GET /:resources`         | Get list of all of the specified resources         |
+| `POST /:resources`        | Create a new instance of the specified resource    |
+| `GET /:resources/:id`     | Get the specified resource instance                |
+| `PUT /:resources/:id`     | Update the specified resource instance             |
+| `DELETE /:resources/:id`  | Delete the specified resource instance             |
 
 ---
 
@@ -154,21 +152,11 @@ Each entity in the specified data model will have a `Sequel::Model` subclass cre
 
 - `Rack::PushNotification::Device`
 
-<table>
-  <caption>Endpoints</caption>
-  <tr>
-    <td><tt>PUT /devices/:token</tt></td>
-    <td>Register or update existing device for push notifications</td>
-  </tr>
-  <tr>
-    <td><tt>DELETE /devices/:token</tt></td>
-    <td>Unregister a device from receiving push notifications</td>
-  </tr>
-  <tr>
-    <td><tt>POST /message</tt></td>
-    <td>Send out a push notification to some devices</td>
-  </tr>
-</table>
+|                           |                                                           |
+|---------------------------|-----------------------------------------------------------|
+| `PUT /push_notification/devices/:token`     | Register or update existing device for push notifications |
+| `DELETE /push_notification/devices/:token`  | Unregister a device from receiving push notifications     |
+| `POST /push_notification/message`           | Send out a push notification to some devices              |
 
 ---
 
@@ -179,17 +167,10 @@ Each entity in the specified data model will have a `Sequel::Model` subclass cre
 - `Rack::InAppPurchase::Receipt`
 - `Rack::InAppPurchase::Product`
 
-<table>
-  <caption>Endpoints</caption>
-  <tr>
-    <td><tt>POST /receipts/verify</tt></td>
-    <td>Decode the associated Base64-encoded <tt>receipt-data</tt>, recording the receipt data and verifying the information with Apple</td>
-  </tr>
-  <tr>
-    <td><tt>GET /products/identifiers</tt></td>
-    <td>Return an array of valid product identifiers</td>
-  </tr>
-</table>
+|                              |                                                           |
+|------------------------------|-----------------------------------------------------------|
+| `POST /in_app_purchase/receipts/verify`      | Decode the associated Base64-encoded `receipt-data`, recording the receipt data and verifying the information with Apple |
+| `GET /in_app_purchase/products/identifiers`  | Get an array of valid product identifiers                 |
 
 ---
 
@@ -200,91 +181,141 @@ Each entity in the specified data model will have a `Sequel::Model` subclass cre
 - `Rack::Passbook::Pass`
 - `Rack::Passbook::Registration`
 
-<table>
-  <caption>Endpoints</caption>
-  <tr>
-    <td><tt>GET /v1/passes/:passTypeIdentifier/:serialNumber</tt></td>
-    <td>Get the Latest Version of a Pass</td>
-  </tr>
-  <tr>
-    <td><tt>GET /v1/devices/:deviceLibraryIdentifier/registrations/:passTypeIdentifier[?passesUpdatedSince=tag]</tt></td>
-    <td>Get the Serial Numbers for Passes Associated with a Device</td>
-  </tr>
-  <tr>
-    <td><tt>POST /v1/devices/:deviceLibraryIdentifier/registrations/:passTypeIdentifier/:serialNumber</tt></td>
-    <td>Register a Device to Receive Push Notifications for a Pass</td>
-  </tr>
-  <tr>
-    <td><tt>DELETE /v1/devices/:deviceLibraryIdentifier/registrations/:passTypeIdentifier/:serialNumber</tt></td>
-    <td>Unregister a Device</td>
-  </tr>
-</table>
+|                           |                                                    |
+|---------------------------|----------------------------------------------------|
+| `GET /passbook/v1/passes/:passTypeIdentifier/:serialNumber` | Get the Latest Version of a Pass |
+| `GET /passbook/v1/devices/:deviceLibraryIdentifier/registrations/:passTypeIdentifier[?passesUpdatedSince=tag]` | Get the Serial Numbers for Passes Associated with a Device |
+| `POST /passbook/v1/devices/:deviceLibraryIdentifier/registrations/:passTypeIdentifier/:serialNumber` | Register a Device to Receive Push Notifications for a Pass |
+| `DELETE /passbook/v1/devices/:deviceLibraryIdentifier/registrations/:passTypeIdentifier/:serialNumber` | Unregister a Device |
+
+---
+
+`newsstand`: Adds endpoints for Newsstand. Offers complete management of issues, covers, and assets, with plist-based web services and Atom feeds.
+
+**Associated Classes**
+
+- `Rack::Newsstand::Issue`
+
+|                               |                         |
+|-------------------------------|-------------------------|
+| `GET /newsstand/issues`       | Get list of all issues  |
+| `GET /newsstand/issues/:name` | Get a specific issue    |
+| `POST /newsstand/issues`      | Add a new issue         |
 
 ## Command-Line Interface
 
 Helios comes with a CLI to help create and manage your application. After you `$ gem install helios`, you'll have the `helios` binary available.
 
-    $ helios --help
-    helios
+```
+$ helios --help
+helios
 
-    A command-line interface for building mobile infrastructures
+A command-line interface for building mobile infrastructures
 
-    Commands:
-      console              Open IRB session with Helios environment
-      help                 Display global or [command] help documentation.
-      link                 Links a Core Data model
-      new                  Creates a new Helios project
-      server               Start running Helios locally
+Commands:
+  console              Open IRB session with Helios environment
+  help                 Display global or [command] help documentation.
+  link                 Links a Core Data model
+  new                  Creates a new Helios project
+  server               Start running Helios locally
+```
 
 ### Creating an Application
 
 The first step to using Helios is to create a new application. This can be done with the `$ helios new` command, which should be familiar if you've ever used Rails.
 
-    $ helios new --help
+```
+$ helios new --help
 
-    Usage: helios new path/to/app
+Usage: helios new path/to/app
 
-      The `helios new` command creates a new Helios application with a default
-    directory structure and configuration at the path you specify.
+  The `helios new` command creates a new Helios application with a default
+directory structure and configuration at the path you specify.
 
-    Options:
-      --skip-gemfile       Don't create a Gemfile
-      -B, --skip-bundle    Don't run bundle install
-      -G, --skip-git       Don't create a git repository
-      --edge               Setup the application with Gemfile pointing to Helios repository
-      -f, --force          Overwrite files that already exist
-      -p, --pretend        Run but do not make any changes
-      -s, --skip           Skip files that already exist
+Options:
+  --skip-gemfile       Don't create a Gemfile
+  -B, --skip-bundle    Don't run bundle install
+  -G, --skip-git       Don't create a git repository
+  --edge               Setup the application with Gemfile pointing to Helios repository
+  -f, --force          Overwrite files that already exist
+  -p, --pretend        Run but do not make any changes
+  -s, --skip           Skip files that already exist
+```
 
 ### Linking a Core Data Model
 
 In order to keep your data model and REST webservices in sync, you can link it to your helios application:
 
-    $ helios link path/to/DataModel.xcdatamodel
+```
+$ helios link path/to/DataModel.xcdatamodel
+```
 
 This creates a hard link between the data model file in your Xcode and Helios projects—any changes made to either file will affect both. The next time you start the server, Helios will automatically migrate the database to create tables and insert columns to accomodate any new entities or attributes.
 
+> If you are using OS X, do not attempt to delete your Helios application directory using `rm -r` if you have linked a Core Data model. Doing so will result in the removal of the Xcode data model itself. Instead use the finder to move the Helios application directory to trash.
+
 ### Starting the Application Locally
 
 To run Helios in development mode on `localhost`, run the `server` command:
 
-    $ helios server
+```
+$ helios server
+```
 
 ### Testing Push Notifications
 
 Once you have registered a device and set up your certificate, try this:
 
-    $ curl -X POST -d 'payload={"aps": {"alert":"Blastoff!"}}' http://localhost:5000/message
+```
+$ curl -X POST -d 'payload={"aps": {"alert":"Blastoff!"}}' http://localhost:5000/push_notification/message
+```
+
+### Setting Up Storage for Newsstand
+
+In order to set up storage for Newsstand, you will need an account with one of the following cloud storage providers:
+
+- [Amazon AWS S3](http://aws.amazon.com/s3/)
+- [Google Cloud Storage](https://cloud.google.com/products/cloud-storage/)
+- [Rackspace Cloud Files](http://www.rackspace.com/cloud/files/)
+
+In your application directory, edit the `config.ru` with your credentials for the cloud storage provider of your choice. Here is an example configuration using AWS.
+
+```ruby
+require 'bundler'
+Bundler.require
+
+app = Helios::Application.new {
+    service :data, model: Dir['*.xcdatamodel*'].first if Dir['*.xcdatamodel*'].any?
+    service :push_notification
+    service :in_app_purchase
+    service :passbook
+    service :newsstand, {
+        storage: {
+            provider: 'AWS',
+            aws_access_key_id: 'YOUR_ACCESS_KEY_ID',
+            aws_secret_access_key: 'YOUR_SECRET_ACCESS_KEY'
+        }
+    }
+}
+
+run app
+```
+
+For other configuration options, see [fog.io](http://fog.io/storage/).
 
 ### Running the Helios Console
 
 You can start an IRB session with the runtime environment of the Helios application with the `console` command:
 
-    $ helios console
+```
+$ helios console
+```
 
 This command activates the services as configured by your Helios application, including any generated Core Data models. The `rack` module is automatically included on launch, allowing you to access everything more directly:
 
-    > Passbook::Passes.all # => [...]
+```ruby
+> Passbook::Passes.all # => [...]
+```
 
 ## Deploying to Heroku
 
@@ -292,8 +323,11 @@ This command activates the services as configured by your Helios application, in
 
 Once you've installed the [Heroku Toolbelt](https://toolbelt.heroku.com), and have a Heroku account, enter the following commands from the project directory:
 
-    $ heroku create
-    $ git push heroku master
+```
+$ heroku create
+$ git add .
+$ git push heroku master
+```
 
 ## Integrating with an iOS Application
 
@@ -328,25 +362,15 @@ didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
 Once you have the certificate from Apple for your application, export your key
 and the apple certificate as p12 files. Here is a quick walkthrough on how to do this:
 
-1. Click the disclosure arrow next to your certificate in Keychain Access and select the certificate and the key. 
-2. Right click and choose `Export 2 items…`. 
+1. Click the disclosure arrow next to your certificate in Keychain Access and select the certificate and the key.
+2. Right click and choose `Export 2 items…`.
 3. Choose the p12 format from the drop down and name it `cert.p12`.
 
 Now covert the p12 file to a pem file:
 
-    $ openssl pkcs12 -in cert.p12 -out apple_push_notification.pem -nodes -clcerts
-
-## Coming Attractions
-
-There's still a lot to do to make Helios even better. Here are some ideas that are at the top of the list:
-
-- Test coverage
-- More documentation
-- More example projects
-- Better RubyMotion integration
-- Support for multiple schema definitions (not just Core Data)
-- Send push notifications from the UI
-- Support for additional platforms (Android, WP7)
+```
+$ openssl pkcs12 -in cert.p12 -out apple_push_notification.pem -nodes -clcerts
+```
 
 ---
 
@@ -356,8 +380,7 @@ Mattt Thompson
 
 - http://github.com/mattt
 - http://twitter.com/mattt
-- <mattt@heroku.com>
 
 ## License
 
-Helios is released under the [MIT](http://opensource.org/licenses/MIT) license.
+Helios is released under the [MIT License](http://opensource.org/licenses/MIT).