helios 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 402e29639eacaa1ba54ba2f4eccefb1ac228be91
-  data.tar.gz: c2f8542dd3218c7a2b97c75aeea6a0cec5c57f76
+  metadata.gz: 804589d0f2e0ada259f0b9fed0746db10843ef8c
+  data.tar.gz: 05599e5a5f8d21b616dd6ae7e0cfdfd2cf33e34b
 SHA512:
-  metadata.gz: 4bfd61221daf7968ccba1a273930dfc0787610ce175e2d2cc0fab8e30fa7828b27c30810d8acf0597e9f5d09239b9ca6d974ad46c3017eb76b758bc214bae877
-  data.tar.gz: 2f8bb05d75f2bef9f6b4fb1f308aa7741bba846a6292aeb6be94b2c58e60d9e1199d919dc8afc838d68e179af1ad39795d60ea370c3daf3bd09376e68750a8d5
+  metadata.gz: 12d3ceb7bf25ea1040f3ecb0faffbe2dd433a4733c407cb4f86ccb43db471d623759a678089f10f4f45740ec1dc1d9f3e90b1b07dd393aaae684da4944632053
+  data.tar.gz: 58e382a519b93419ee86cb8a195c80fed29693bbe2ae0f588355dab9e7f22629be19b6fb1f870b45ca711fc72a7355900951a59b593e357aefb1967084ae976f

data/Gemfile.lock

@@ -1,22 +1,26 @@
 PATH
   remote: .
   specs:
-    helios (0.2.1)
+    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-core-data (~> 0.3)
       rack-in-app-purchase (~> 0.1)
+      rack-newsstand (~> 0.1)
       rack-passbook (~> 0.1)
       rack-push-notification (~> 0.4)
+      rack-scaffold
       rails-database-url (~> 1.0)
       sinatra (~> 1.3)
-      sinatra-assetpack (~> 0.1.7)
-      sinatra-backbone (~> 0.1.0.rc2)
+      sinatra-assetpack (~> 0.2.2)
+      sinatra-backbone (~> 0.1.1)
       sinatra-contrib (~> 1.3)
       sinatra-param (~> 0.1)
       sinatra-support (~> 1.2)
@@ -29,6 +33,7 @@ GEM
       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
@@ -40,55 +45,77 @@ GEM
       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.1.1)
-      commander (~> 4.1.2)
-      json (~> 1.7.3)
+    houston (0.2.2)
+      commander (~> 4.1)
+      json
     i18n (0.6.1)
     jsmin (1.0.1)
     json (1.7.7)
-    multi_json (1.7.2)
+    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-core-data (0.3.1)
-      activesupport (>= 3.0)
-      nokogiri (~> 1.4)
+    rack-in-app-purchase (0.1.0)
       rack (~> 1.4)
-      rack-contrib (~> 1.1)
       sequel (~> 3.37)
       sinatra (~> 1.3)
-      sinatra-param (~> 0.1)
-    rack-in-app-purchase (0.1.0)
+      venice
+    rack-newsstand (0.1.1)
+      builder (>= 3.0)
+      plist (~> 3.1)
       rack (~> 1.4)
       sequel (~> 3.37)
       sinatra (~> 1.3)
-      venice
     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.0)
-      houston (~> 0.1.1)
+    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 (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)
@@ -101,13 +128,15 @@ GEM
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.13.1)
-    sass (3.2.8)
-    sequel (3.46.0)
+    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.1.7)
+    sinatra-assetpack (0.2.2)
+      backports
       jsmin
       rack-test
       sinatra
@@ -127,7 +156,7 @@ GEM
       sinatra (>= 1.0)
     terminal-table (1.4.5)
     thor (0.18.1)
-    tilt (1.3.7)
+    tilt (1.4.1)
     venice (0.1.0)
       commander (~> 4.1)
       json

data/README.md

@@ -76,7 +76,7 @@ Bundler.require
 
 run Helios::Application.new do
   service :data, model: 'path/to/DataModel.xcdatamodel'
-  service :push_notification
+  service :push_notification, apn_certificate: 'path/to/apple_push_notification.pem', apn_environment: 'development'
   service :in_app_purchase
   service :passbook
 end
@@ -102,7 +102,7 @@ Helios can be run as Rails middleware by adding this to the configuration block
 ```ruby
 config.middleware.use Helios::Application do
   service :data, model: 'path/to/DataModel.xcdatamodel'
-  service :push_notification
+  service :push_notification, apn_certificate: 'path/to/apple_push_notification.pem', apn_environment: 'development'
   service :in_app_purchase
   service :passbook
 end
@@ -164,6 +164,10 @@ Each entity in the specified data model will have a `Sequel::Model` subclass cre
     <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>
 
 ---
@@ -266,6 +270,12 @@ 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:
@@ -311,6 +321,21 @@ didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
 }
 ```
 
+### 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:

data/helios.gemspec

@@ -16,27 +16,31 @@ Gem::Specification.new do |s|
   s.add_dependency "commander", "~> 4.1"
   s.add_dependency "foreman", "~> 0.63"
   s.add_dependency "rack-contrib", "~> 1.1"
-  s.add_dependency "rack-core-data", "~> 0.3"
   s.add_dependency "rack-push-notification", "~> 0.4"
   s.add_dependency "rack-in-app-purchase", "~> 0.1"
   s.add_dependency "rack-passbook", "~> 0.1"
+  s.add_dependency "rack-newsstand", "~> 0.1"
+  s.add_dependency "rack-scaffold"
+  s.add_dependency "core_data"
   s.add_dependency "json", "~> 1.7"
   s.add_dependency "coffee-script", "~> 2.2"
   s.add_dependency "sinatra", "~> 1.3"
   s.add_dependency "sinatra-contrib", "~> 1.3"
-  s.add_dependency "sinatra-assetpack", "~> 0.1.7"
-  s.add_dependency "sinatra-backbone", "~> 0.1.0.rc2"
+  s.add_dependency "sinatra-assetpack", "~> 0.2.2"
+  s.add_dependency "sinatra-backbone", "~> 0.1.1"
   s.add_dependency "sinatra-param", "~> 0.1"
   s.add_dependency "sinatra-support", "~> 1.2"
   s.add_dependency "haml", ">= 3.1"
   s.add_dependency "compass", "~> 0.12"
   s.add_dependency "zurb-foundation", "4.1.2"
   s.add_dependency "rails-database-url", "~> 1.0"
+  s.add_dependency "fog", "~> 1.10"
+  s.add_dependency "houston", "~> 0.2"
 
-  s.add_development_dependency "rake",  ">= 0"
-  s.add_development_dependency "rspec",  ">= 0"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
 
-  s.files         = Dir["./**/*"].reject{|file| file =~ /\.\/(bin|example|log|pkg|script|spec|test|vendor)/} + Dir.glob("./lib/helios/templates", File::FNM_DOTMATCH)
+  s.files         = Dir["./**/*"].reject{|file| file =~ /\.\/(bin|example|log|pkg|script|spec|test|vendor)/} + Dir.glob("./lib/helios/templates/*", File::FNM_DOTMATCH)
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]

data/lib/helios.rb

@@ -3,11 +3,17 @@ require 'rack'
 module Helios
   class Application
     def initialize(app = nil, options = {}, &block)
-      map = {}
-      map['/'] = Rack::Cascade.new([app, Helios::Backend.new(&block)].compact)
-      map['/admin'] = Helios::Frontend.new if options.fetch(:frontend, true)
+      @app = Rack::Builder.new do
+        map '/admin' do
+          use Rack::Auth::Basic, "Restricted Area" do |username, password|
+            username == (ENV['HELIOS_ADMIN_USERNAME'] || "") and password == (ENV['HELIOS_ADMIN_PASSWORD'] || "")
+          end if ENV['HELIOS_ADMIN_USERNAME'] or ENV['HELIOS_ADMIN_PASSWORD']
 
-      @app = Rack::URLMap.new(map)
+          run Helios::Frontend.new
+        end
+
+        run Helios::Backend.new(&block)
+      end
     end
 
     def call(env)

data/lib/helios/backend.rb

@@ -1,22 +1,31 @@
 require 'rack'
 
 module Helios
-  class Backend < Rack::Cascade
+  class Backend < Rack::Builder
+    DEFAULT_PATHS = {
+      data: '/'
+    }
+
     require 'rails-database-url' if const_defined?(:Rails)
 
-    def initialize(&block)
-      @services = []
+    def initialize(*args, &block)
+      raise ArgumentError, "Missing block" unless block_given?
+      super(&nil)
 
-      block = lambda { |app|
-        service :data, model: Dir['**/*.xcdatamodeld'].first rescue false
-        service :push_notification
-        service :in_app_purchase
-        service :passbook
-      } unless block_given?
+      @services = {}
 
       instance_eval(&block)
+    end
 
-      super(@services)
+    def call(env)
+      return super(env) unless env["REQUEST_METHOD"] == "OPTIONS" and env["REQUEST_PATH"] == "/"
+
+      links = []
+      @services.each do |path, middleware|
+        links << %{<#{path}>; rel="#{middleware}"}
+      end
+
+      [206, {"Link" => links.join("\n")}, []]
     end
 
     private
@@ -28,30 +37,28 @@ module Helios
         begin
           middleware = Helios::Backend.const_get(constantize(identifier))
         rescue NameError
-          raise LoadError, "Could not find matching service for #{identifier.inspect}. You may need to install an additional gem (such as helios-#{identifier})."
+          raise LoadError, "Could not find matching service for #{identifier.inspect} (Helios::Backend::#{constantize(identifier)}). You may need to install an additional gem (such as helios-#{identifier})."
         end
       end
 
-      middleware.instance_eval{ include Helios::Administerable } if options.fetch(:frontend, true)
+      path = "/#{(options.delete(:root) || DEFAULT_PATHS[identifier] || identifier)}".squeeze("/")
+
+      map path do
+        instance_eval(&block) if block_given?
+        run middleware.new(self, options)
+      end
 
-      @services << middleware.new(self, options, &block) if middleware
+      @services[path] = middleware
     end
 
     def constantize(identifier)
       identifier.to_s.split(/([[:alpha:]]*)/).select{|c| /[[:alpha:]]/ === c}.map(&:capitalize).join("")
     end
   end
-
-  module Administerable
-    attr_accessor :admin
-
-    def admin?
-      !!@admin
-    end
-  end
 end
 
 require 'helios/backend/data'
-require 'helios/backend/push-notification'
 require 'helios/backend/in-app-purchase'
 require 'helios/backend/passbook'
+require 'helios/backend/push-notification'
+require 'helios/backend/newsstand'

data/lib/helios/backend/data.rb

@@ -1,21 +1,26 @@
-require 'rack/core-data'
+require 'core_data'
+require 'sequel'
+
+require 'rack/scaffold'
+
+require 'sinatra/base'
 require 'sinatra/param'
 
+
 class Helios::Backend::Data < Sinatra::Base
   helpers Sinatra::Param
 
   def initialize(app, options = {})
-    super(Rack::CoreData(options[:model]))
+    super(Rack::Scaffold.new(options))
 
-    @model = Rack::CoreData::DataModel.new(options[:model])
+    @model = CoreData::DataModel.new(options[:model]) rescue nil
   end
 
   before do
     content_type :json
   end
 
-  options '/' do
-    pass unless self.class < Helios::Administerable
+  options '/resources' do
 
     links = []
     @model.entities.each do |entity|

data/lib/helios/backend/in-app-purchase.rb

@@ -1,13 +1,15 @@
 require 'rack/in-app-purchase'
+
+require 'sinatra/base'
 require 'sinatra/param'
 
 class Helios::Backend::InAppPurchase < Sinatra::Base
   helpers Sinatra::Param
 
-  def initialize(app, options = {})
+  def initialize(app, options = {}, &block)
     super(Rack::InAppPurchase.new)
   end
-  
+
   before do
     content_type :json
   end

data/lib/helios/backend/newsstand.rb

@@ -0,0 +1,97 @@
+require 'rack/newsstand'
+
+require 'sinatra/base'
+require 'sinatra/param'
+
+require 'fog'
+
+class Helios::Backend::Newsstand < Sinatra::Base
+  helpers Sinatra::Param
+
+  def initialize(app, options = {}, &block)
+    super(Rack::Newsstand.new)
+
+    @storage = Fog::Storage.new(options[:storage]) if options[:storage]
+  end
+
+  before do
+    content_type :json
+  end
+
+  get '/issues/?' do
+    pass unless request.accept? 'application/json'
+
+    param :q, String
+
+    issues = Rack::Newsstand::Issue.dataset
+    issues = issues.filter("tsv @@ to_tsquery('english', ?)", "#{params[:q]}:*") if params[:q] and not params[:q].empty?
+
+    if params[:page] or params[:per_page]
+      param :page, Integer, default: 1, min: 1
+      param :per_page, Integer, default: 100, in: (1..100)
+
+      {
+        issues: issues.limit(params[:per_page], (params[:page] - 1) * params[:per_page]).naked.all,
+        page: params[:page],
+        total: issues.count
+      }.to_json
+    else
+      param :limit, Integer, default: 100, in: (1..100)
+      param :offset, Integer, default: 0, min: 0
+
+      {
+        issues: issues.limit(params[:limit], params[:offset]).naked.all
+      }.to_json
+    end
+  end
+
+  head '/issues/new?' do
+    status 503 and return unless @storage
+
+    status 204
+  end
+
+  post '/issues/?' do
+    status 503 and return unless @storage
+
+    param :name, String, empty: false
+    param :summary, String
+
+    issue = Rack::Newsstand::Issue.new(params)
+
+    if issue.valid?
+      directory = @storage.directories.create(key: "newsstand-issue-#{issue.name}-#{Time.now.to_i}", public: true)
+
+      covers, assets = {}, []
+      [:covers, :assets].each do |attribute|
+        (params[attribute] || []).each do |f|
+          file = directory.files.create(
+            key: File.basename(f[:filename]),
+            body: File.open(f[:tempfile]),
+            public: true
+          )
+
+          case attribute
+          when :covers
+            covers["SOURCE"] = file.public_url
+          when :assets
+            assets << file.public_url
+          end
+        end
+      end
+
+      issue.set(cover_urls: covers, asset_urls: assets)
+
+      if issue.save
+        status 201
+        issue.to_json
+      else
+        status 400
+        {errors: issue.errors}.to_json
+      end
+    else
+      status 400
+      {errors: issue.errors}.to_json
+    end
+  end
+end