helios 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f49d72eae50b9d0f7b0fcd955286e930c6a008b
-  data.tar.gz: 7a81dbf2013d8fbfd94f2f7a883c6c8d9144f43d
+  metadata.gz: ec8e7e4600d587e9ffb3c1c96a93e371c9000126
+  data.tar.gz: 6062579b3e86cdf248881d5785ac9679c240285f
 SHA512:
-  metadata.gz: 9e3f0a41f0a7f4e4a514936ae48fee5cee7ddd216298a6d6dd8fd3f77fe37136bc3147f3d92ca5b699a593498746633741cbba3f77f6b341243248c4b034e04b
-  data.tar.gz: 054897badfddb7935d3a88568f3059606e9b944414a0965c0d25ff9be24f5bb5e18440dedff336ae1cb05a9ee04bc5c7c9ff8a4b14a0cd31d7f33015dadd54ab
+  metadata.gz: 493b0388cfaa239908e63bfd07b8ec900c89ecd463f59382f7e83a93cd17f78bc970cd204f0beee710649a17da0fc986bf2491997ba1dc1ae7b1ad52a558ebad
+  data.tar.gz: debfe1d63f7497d469afc5ae59cc8a4ad9ec9eea26c150c4f1bc31ad410c2a10a11cbb19d3032e26b268c46dc181c2d53f628d2f96645b7662d166c811746a62

data/Gemfile

@@ -1,5 +1,3 @@
 source "https://rubygems.org"
 
-gem 'pg'
-
 gemspec

data/Gemfile.lock

@@ -1,18 +1,19 @@
 PATH
   remote: .
   specs:
-    helios (0.1.1)
+    helios (0.2.0)
       coffee-script (~> 2.2)
-      commander (~> 4.1.2)
+      commander (~> 4.1)
       compass (~> 0.12)
+      foreman (~> 0.60)
       haml (~> 3.1)
       json (~> 1.7)
-      omniauth (~> 1.0)
-      rack-core-data (~> 0.2)
+      rack-contrib (~> 1.1)
+      rack-core-data (~> 0.3)
       rack-in-app-purchase (~> 0.1)
       rack-passbook (~> 0.1)
       rack-push-notification (~> 0.4)
-      rack-smart-app-banner (~> 0.0.1)
+      rails-database-url (~> 1.0)
       sinatra (~> 1.3)
       sinatra-assetpack (~> 0.1)
       sinatra-backbone (~> 0.1.0.rc2)
@@ -28,7 +29,7 @@ GEM
       i18n (= 0.6.1)
       multi_json (~> 1.0)
     backports (3.1.1)
-    chunky_png (1.2.7)
+    chunky_png (1.2.8)
     coffee-script (2.2.0)
       coffee-script-source
       execjs
@@ -39,13 +40,15 @@ GEM
       chunky_png (~> 1.2)
       fssm (>= 0.2.7)
       sass (~> 3.1)
+    diff-lcs (1.2.2)
     eventmachine (1.0.3)
     excon (0.17.0)
     execjs (1.4.0)
       multi_json (~> 1.0)
+    foreman (0.62.0)
+      thor (>= 0.13.6)
     fssm (0.2.10)
     haml (3.1.8)
-    hashie (1.2.0)
     highline (1.6.16)
     houston (0.1.1)
       commander (~> 4.1.2)
@@ -53,23 +56,19 @@ GEM
     i18n (0.6.1)
     jsmin (1.0.1)
     json (1.7.7)
-    multi_json (1.7.1)
+    multi_json (1.7.2)
     nokogiri (1.5.9)
-    omniauth (1.1.3)
-      hashie (~> 1.2)
-      rack
-    pg (0.14.1)
     rack (1.5.2)
     rack-contrib (1.1.0)
       rack (>= 0.9.1)
-    rack-core-data (0.2.0)
-      activesupport (~> 3.2.6)
+    rack-core-data (0.3.1)
+      activesupport (>= 3.0)
       nokogiri (~> 1.4)
       rack (~> 1.4)
-      rack-contrib (~> 1.1.0)
-      sequel (~> 3.37.0)
-      sinatra (~> 1.3.2)
-      sinatra-param (~> 0.1.1)
+      rack-contrib (~> 1.1)
+      sequel (~> 3.37)
+      sinatra (~> 1.3)
+      sinatra-param (~> 0.1)
     rack-in-app-purchase (0.1.0)
       rack (~> 1.4)
       sequel (~> 3.37)
@@ -88,14 +87,20 @@ GEM
       sequel (~> 3.37)
       sinatra (~> 1.3)
       sinatra-param (~> 0.1)
-    rack-smart-app-banner (0.0.1)
-      rack (>= 1.2.0, <= 2.0.0)
     rack-test (0.6.2)
       rack (>= 1.0)
-    rake (0.9.6)
-    rspec (0.9.4)
+    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.0)
     sass (3.2.7)
-    sequel (3.37.0)
+    sequel (3.45.0)
     sinatra (1.3.6)
       rack (~> 1.4)
       rack-protection (~> 1.3)
@@ -119,6 +124,7 @@ GEM
     sinatra-support (1.2.2)
       sinatra (>= 1.0)
     terminal-table (1.4.5)
+    thor (0.18.1)
     tilt (1.3.6)
     venice (0.0.1)
       commander (~> 4.1.2)
@@ -133,6 +139,5 @@ PLATFORMS
 
 DEPENDENCIES
   helios!
-  pg
-  rake (~> 0.9)
-  rspec (~> 0.6)
+  rake
+  rspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Mattt Thompson (http://mattt.me/)
+Copyright (c) 2013 Heroku (http://heroku.com/)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,23 +1,299 @@
-# Helios
-**Coming Soon**
+![Helios - an extensible open source mobile backend framework](https://raw.github.com/helios-framework/helios.io/assets/helios-banner.png)
+
+Helios is an open-source framework that provides essential backend services for iOS apps, from data synchronization and user accounts to push notifications, in-app purchases, and passbook integration. It allows developers to get a client-server app up-and-running in just a few minutes, and seamlessly incorporate functionality as necessary.
+
+Helios is designed for "mobile first" development. Build out great features on the device, and implement the server-side components as necessary. Pour all of your energy into crafting a great user experience, rather than getting mired down with the backend.
+
+One great example of this philosophy in Helios is Core Data Synchronization. This allows you to use your existing Core Data model definition to automatically generate a REST webservice, which can be used to shuttle data between the server and client. No iCloud, _no problem_.
+
+![Helios Web UI Screenshot](https://raw.github.com/helios-framework/helios.io/assets/helios-screenshot.png)
+
+Helios also comes with a Web UI. Browse and search through all of your database records, push notification registrations, in-app purchases, and passbook passes. You can even send targeted push notifications right from the browser.
 
 ---
 
-// TODO
+## 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)_
+
+## Getting Started
+
+1. Install Helios at the command prompt:
+
+    $ gem install helios
+
+2. Create a new Helios application:
+
+    $ helios new myapp
+
+3. Change directory to `myapp` and start the web server:
+
+    $ cd myapp; helios server
+
+4. Go to http://localhost:5000/admin and you’ll see your app's Web UI
+
+Read on for instructions on the following:
+
+- Linking a Core Data model
+- Integrating Helios into your mobile client
+
+## Usage
+
+Built on the Rack webserver interface, Helios can be easily added into any existing Rails or Sinatra application as middleware. Or, if you're starting with a Helios application, you can build a new Rails or Sinatra application on top of it.
+
+This means that you can develop your application using the tools and frameworks you love, and maintain flexibility with your architecture as your needs evolve.
+
+### Sinatra / Rack
+
+#### Gemfile
+
+```ruby
+gem 'helios'
+```
+
+#### config.ru
+
+```ruby
+require 'bundler'
+Bundler.require
+
+run Helios::Application.new do
+      service :data, model: 'path/to/DataModel.xcdatamodel'
+      service :push_notification
+      service :in_app_purchase
+      service :passbook
+    end
+```
+
+### Rails
+
+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
+
+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'
+
+Helios can be run as Rails middleware by adding this to the configuration block in `config/application.rb`
+
+#### config/application.rb
+
+```ruby
+config.middleware.use Helios::Application do
+  service :data, model: 'path/to/DataModel.xcdatamodel'
+  service :push_notification
+  service :in_app_purchase
+  service :passbook
+end
+```
+
+## Available Services
+
+Each service in Helios can be enabled and configured separately:
+
+`data`: Generates a REST webservice from a schema definition. Currently supports Core Data (`.xcdatamodel`) files.
+
+**Parameters**
+
+- `model`: Path to the data model file
+
+**Associated Classes**
+
+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>Delege the specified resource instance</td>
+  </tr>
+</table>
+
+---
+
+`push_notification`: Adds iOS push notification registration / unregistration endpoints.
+
+**Associated Classes**
+
+- `Rack::PushNotification::Device`
 
-- Usage
-  - By itself / Rack / Sinatra
-  - With Rails
-- Explicitly documenting formats of models, what tables they reside in / depend on, how to override them, etc.
-- Deploying Helios to Heroku
-- When and How to migrate off of Helios
-- Who is Helios for
-- How to install helios
-  - gem install
-  - Gemfile
-- CLI usage
-- How to incorporate it into your iOS project
+<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>
+</table>
 
+---
+
+`in_app_purchase`: Adds an endpoint for iOS in-app purchase receipt verification endpoints, as well one for returning product identifiers.
+
+**Associated Classes**
+
+- `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>
+
+---
+
+`passbook`: Adds endpoints for the [web service protocol](https://developer.apple.com/library/prerelease/ios/#documentation/PassKit/Reference/PassKit_WebService/WebService.html) for communicating with Passbook
+
+**Associated Classes**
+
+- `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>
+
+## 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
+
+    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
+
+### 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
+
+    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.
+
+    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
+
+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.
+
+### Starting the Application Locally
+
+To run Helios in development mode on `localhost`, run the `server` command:
+
+    $ helios server
+
+### Running the Helios Console
+
+You can start an IRB session with the runtime environment of the Helios application with the `console` command:
+
+    $ 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 # => [...]
+
+## Deploying to Heroku
+
+[Heroku](http://www.heroku.com) is the easiest way to get your app up and running. For full instructions on how to get started, check out ["Getting Started with Ruby on Heroku"](https://devcenter.heroku.com/articles/ruby).
+
+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
+
+## Integrating with iOS Application
+
+### Core Data Synchronization
+
+With [AFIncrementalStore](https://github.com/AFNetworking/AFIncrementalStore), you can integrate your Helios app directly into the Core Data stack. Whether it’s a fetch or save changes request, or fulfilling an attribute or relation fault, AFIncrementalStore handles all of the networking needed to read and write to and from the server.
+
+See ["Building an iOS App with AFIncrementalStore and the Core Data Buildpack"](https://devcenter.heroku.com/articles/ios-core-data-buildpack-app) on the Heroku Dev Center for a comprehensive guide on how to use AFIncrementalStore with the Core Data buildpack. An article for Helios is forthcoming, but aside from deployment, the instructions are essentially unchanged.
+
+### Push Notification Registration
+
+```objective-c
+- (void)application:(UIApplication *)application
+didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
+{
+    NSURL *serverURL = [NSURL URLWithString:@"http://raging-notification-3556.herokuapp.com/"];
+    Orbiter *orbiter = [[Orbiter alloc] initWithBaseURL:serverURL credential:nil];
+    [orbiter registerDeviceToken:deviceToken withAlias:nil success:^(id responseObject) {
+        NSLog(@"Registration Success: %@", responseObject);
+    } failure:^(NSError *error) {
+        NSLog(@"Registration Error: %@", error);
+    }];
+}
+```
+
+---
 
 ## Contact
 
@@ -25,8 +301,8 @@ Mattt Thompson
 
 - http://github.com/mattt
 - http://twitter.com/mattt
-- m@mattt.me
+- <mattt@heroku.com>
 
 ## License
 
-Helios is available under the MIT license. See the LICENSE file for more info.
+Helios is released under the [MIT](http://opensource.org/licenses/MIT) license.