helios_aim 0.2.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2QyM2QxMGE3Y2VmMWJkZjUzZThmZGY4YzMzNjEzMjNmNTBhNDU2YQ==
+  data.tar.gz: !binary |-
+    Y2Q4NDAxYmJlNDg5ZjRjOTRkMDYzNjk1MjBkZDk5MWUxMzcyOGFjNg==
+SHA512:
+  metadata.gz: !binary |-
+    OGQ2YTg3YzAyMmU0ZGY4MDVmZWJhYTZlMWJlZmIzYTNiODdiMTVmYjcyYmZl
+    NDZkY2QzMDRmNDEyMWY1OTA5OGZlNmI3NjJiMjViMzA0YjI1NzdlYWE3ODRj
+    OTEzYTIzZjMxNWUyOGU3YjQ2NzUzNTc0ZDg1NGI4N2NiYzg1YTQ=
+  data.tar.gz: !binary |-
+    Y2Y3NzYzNzk3MzY2ZmFkYWFlMmZhNjI4ZjhhMjE4Yjk0OTBkYjRhZmUxMmZj
+    YmY2ZGVjNDc4MTY0MTE2NmU5ZWMyN2JmZjMxNzc1NmIwODU4MjlkNTcwMjZi
+    ZTE1YzcyMzUzNGFhMzE3ZjBjYjUyNmMwOGVjMTg0YzQ2MjJiMzY=

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,173 @@
+PATH
+  remote: .
+  specs:
+    helios (0.2.2)
+      coffee-script (~> 2.2)
+      commander (~> 4.1)
+      compass (~> 0.12)
+      core_data
+      fog (~> 1.10)
+      foreman (~> 0.63)
+      haml (>= 3.1)
+      houston (~> 0.2)
+      json (~> 1.7)
+      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_aim
+      rails-database-url (~> 1.0)
+      sinatra (~> 1.3)
+      sinatra-assetpack (~> 0.2.2)
+      sinatra-backbone (~> 0.1.1)
+      sinatra-contrib (~> 1.3)
+      sinatra-param (~> 0.1)
+      sinatra-support (~> 1.2)
+      zurb-foundation (= 4.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    backports (3.3.0)
+    builder (3.2.0)
+    chunky_png (1.2.8)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.6.2)
+    commander (4.1.3)
+      highline (~> 1.6.11)
+    compass (0.12.2)
+      chunky_png (~> 1.2)
+      fssm (>= 0.2.7)
+      sass (~> 3.1)
+    core_data (0.1.1)
+      nokogiri (~> 1.4)
+    diff-lcs (1.2.4)
+    dotenv (0.7.0)
+    eventmachine (1.0.3)
+    excon (0.21.0)
+    execjs (1.4.0)
+      multi_json (~> 1.0)
+    fog (1.11.1)
+      builder
+      excon (~> 0.20)
+      formatador (~> 0.2.0)
+      json (~> 1.7)
+      mime-types
+      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)
+    fssm (0.2.10)
+    haml (4.0.2)
+      tilt
+    highline (1.6.18)
+    houston (0.2.2)
+      commander (~> 4.1)
+      json
+    i18n (0.6.1)
+    jsmin (1.0.1)
+    json (1.7.7)
+    mime-types (1.23)
+    multi_json (1.7.3)
+    net-scp (1.1.0)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.6.7)
+    nokogiri (1.5.9)
+    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 (~> 1.4)
+      sequel (~> 3.37)
+      sinatra (~> 1.3)
+      venice
+    rack-newsstand (0.1.1)
+      builder (>= 3.0)
+      plist (~> 3.1)
+      rack (~> 1.4)
+      sequel (~> 3.37)
+      sinatra (~> 1.3)
+    rack-passbook (0.1.1)
+      rack (~> 1.4)
+      sequel (~> 3.37)
+      sinatra (~> 1.3)
+    rack-protection (1.5.0)
+      rack
+    rack-push-notification (0.4.1)
+      rack (~> 1.4)
+      rack-contrib (~> 1.1)
+      sequel (~> 3.37)
+      sinatra (~> 1.3)
+      sinatra-param (~> 0.1)
+    rack-scaffold_aim (>= 0.0.1)
+      activesupport (>= 3.0)
+      rack (~> 1.4)
+      rack-contrib (~> 1.1)
+      sinatra (~> 1.3)
+      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)
+    sequel (3.47.0)
+    sinatra (1.4.2)
+      rack (~> 1.5, >= 1.5.2)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    sinatra-assetpack (0.2.2)
+      backports
+      jsmin
+      rack-test
+      sinatra
+      tilt (>= 1.3.0)
+    sinatra-backbone (0.1.1)
+      sinatra
+    sinatra-contrib (1.4.0)
+      backports (>= 2.0)
+      eventmachine
+      rack-protection
+      rack-test
+      sinatra (~> 1.4.2)
+      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)
+    tilt (1.4.1)
+    venice (0.1.0)
+      commander (~> 4.1)
+      json
+      terminal-table (~> 1.4)
+    zurb-foundation (4.1.2)
+      sass (>= 3.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  helios!
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,19 @@
+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
+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

@@ -0,0 +1,363 @@
+![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.
+
+---
+
+## 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 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.
+
+2. Install Helios at the command prompt:
+
+    `$ gem install helios`
+
+3. Create a new Helios application:
+
+    `$ helios new myapp`
+
+3. Create a Postgres database at the command prompt:
+
+    `$ 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`
+
+5. Start the web server:
+
+    `$ helios server`
+
+6. Go to [http://localhost:5000/admin](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, apn_certificate: 'path/to/apple_push_notification.pem', apn_environment: 'development'
+  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, apn_certificate: 'path/to/apple_push_notification.pem', apn_environment: 'development'
+  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>Delete the specified resource instance</td>
+  </tr>
+</table>
+
+---
+
+`push_notification`: Adds iOS push notification registration / unregistration endpoints.
+
+**Associated Classes**
+
+- `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>
+
+---
+
+`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
+
+### 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
+
+### 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 an 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
+
+With [Orbiter](https://github.com/mattt/Orbiter) you can integrate Push Notifications into your app easily.
+
+```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);
+    }];
+}
+```
+
+### Converting Your Push Notification Certificate
+
+> These instructions come from the [APN on Rails](https://github.com/PRX/apn_on_rails) project.
+
+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…`. 
+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)
+
+---
+
+## Contact
+
+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.