platform 3.1.1 → 3.1.2

data/Gemfile.lock

@@ -1,13 +1,12 @@
 PATH
   remote: .
   specs:
-    platform (3.1.1)
+    platform (3.1.2)
       acts_as_state_machine
       acts_as_tree
       coffee-script
       kaminari
       rails (>= 3.1.0)
-      rmagick
       sass
       tr8n (>= 3.1.1)
       will_filter (>= 3.1.2)
@@ -119,7 +118,6 @@ GEM
       thor (~> 0.14.6)
     rake (0.9.2)
     rdoc (3.9.4)
-    rmagick (2.13.1)
     rr (1.0.4)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)

data/README.rdoc

@@ -1,5 +1,142 @@
-= Platform
+= Welcome to the Rails Platform Engine
+
+Platform is a Rails Engine Plugin/Gem that provides a framework for extending any Rails application with 3rd party applications. 
+
+As web applications become more and more social, and new devices, such as iPhone and Android, become the new web interface standard for consuming web services data, 
+it is crucial to ensure that 3rd party developers can access your API and extend your application functionality as well as provide 
+new access points to your application through "Connect with" functionality. This engine comes loaded with features that make it easy to provide 3rd party developers with tools, 
+SDKs and documentation to extend your application and consume/contribute to your service data. And for you, the platform makes it easy to develop, deploy, test and document your APIs.
+You can use the platform for your internal applications or you can expose it to the 3rd party developers. It is your call.
+
+Here are some of the main features:
+
+* Full support for OAuth 2.0 spec, which allows 3rd party applications to be authorized by your users or allows your own applications to authorize themselves and get access tokens.
+* API core classes that support OAuth and Cookie based authentication and authorization.
+* API documentation tools that allow you to easily generated API docs for your API.
+* API versioning mechanism that allows you to version your API and support multiple versions of the API and documentation at the same time.
+* Platform developer tools that allow your 3rd party developers to register multiple applications with your web site, monitor their activity, participate in discussions and explore your API.
+* Application directory, where your developers submit their applications and your users discover apps, rate them, discuss them and launch them.
+* Administrative tools that allow you to closely monitor developers activity, API calls, manage Application Directory and much more.
+* The platform comes with Tr8n engine, which makes it international out of the box - with hundreds of languages. (Actual translations will be available in the near future.)
+
+= Installation Instructions
+
+Add the following gems to your Gemfile: 
+
+  gem 'kaminari'
+  gem 'will_filter', "~> 3.1.2" 
+  gem 'tr8n', "~> 3.1.1" 
+  gem 'platform', "~> 3.1.1" 
+  gem 'sass'
+  gem 'coffee-script'
+  gem 'acts_as_tree'
+  gem 'acts_as_state_machine'
+  gem 'rmagick'
+
+And run:
+
+  $ bundle install
+
+At the top of your routes.rb file, add the following lines:
+
+  mount WillFilter::Engine => "/will_filter"
+  mount Tr8n::Engine => "/tr8n"
+  mount Platform::Engine => "/platform"
+
+To configure and initialize Platform engine, run the following commands: 
+
+  $ rails generate will_filter
+  $ rails generate tr8n
+  $ rails generate platform
+  $ rake db:migrate
+  $ rake tr8n:init
+  $ rake platform:init
+  $ rails s
+
+Open your browser and point to:
+
+  http://localhost:3000
+
+
+= Integration Instructions
+
+The best way to get going with Platform is to run the gem as a stand-alone application and follow the instructions and documentation in the app:
+
+  $ git clone git://github.com/berk/platform.git
+  $ cd platform/test/dummy
+  $ rake db:migrate
+  $ rake tr8n:init
+  $ rake platform:init
+  $ rails s
+
+Open your browser and point to:
+
+  http://localhost:3000
+
+
+= Platform Screenshots
+
+Below are a few screenshots of what the Platform looks like inside a sample test application:
+
+http://wiki.tr8n.org/images/0/0c/Platform_Welcome.png
+
+= Developer Tools
+
+http://wiki.tr8n.org/images/8/8a/Developer_Applications.png
+
+== Developer Dashboard
+
+http://wiki.tr8n.org/images/e/eb/Developer_Dashboard.png
+
+== API Explorer
+
+http://wiki.tr8n.org/images/b/b3/API_Explorer_Results.png
+
+== API Explorer with OAuth Authorization Window
+
+http://wiki.tr8n.org/images/3/34/Oauth_Authorization_Popup.png
+
+== API Explorer Method Hints
+
+http://wiki.tr8n.org/images/b/bf/API_Explorer_Methods.png
+
+== OAuth Help
+
+http://wiki.tr8n.org/images/4/42/Oauth_Help.png
+
+== API Generated Help
+
+http://wiki.tr8n.org/images/6/67/API_Help.png
+
+= Application Directory
+
+== Applications by Category with Featured Applications
+
+http://wiki.tr8n.org/images/0/01/Application_Directory.png
+
+== Application Search Results
+
+http://wiki.tr8n.org/images/6/61/Application_Search.png
+
+== Application Details
+
+http://wiki.tr8n.org/images/4/40/Application_Details2.png
+
+== Application Authorization Screen for Web or Embedded Applications
+
+http://wiki.tr8n.org/images/a/af/Oauth_Authorization_Request.png
+
+== Embedded Application Launched in an iFrame
+
+http://wiki.tr8n.org/images/a/a1/Embedded_App.png
+
+== User Authorized Applications 
+
+http://wiki.tr8n.org/images/0/06/My_Applications.png
+
+= Administrative Tools
+
+http://wiki.tr8n.org/images/2/28/Admin_Tools.png
+
 
-This project rocks and uses MIT-LICENSE.
 
-Instructions are coming soon... Stay tuned.

data/app/assets/javascripts/platform/platform.js

@@ -1,5 +1,5 @@
 /****************************************************************************
-  Copyright (c) 2011 Michael Berkovich, Ian McDaniel, Geni Inc
+  Copyright (c) 2011 Michael Berkovich, Ian McDaniel
 
   Permission is hereby granted, free of charge, to any person obtaining
   a copy of this software and associated documentation files (the

data/app/controllers/platform/api/base_controller.rb

@@ -182,13 +182,17 @@ module Platform
       ############################################################################
       def render_response(obj, opts={})
         to_opts = params.merge(:max_models => limit, :viewer => current_user, :api_version => api_version)
-
+          
         if obj.is_a?(Array)
-          hash = {'results' => obj.collect{|o| o.to_api_hash(to_opts)}}
-          hash['page']          = page if page > 1 || limit == obj.size
-          hash['previous_page'] = prev_page if page > 1
-          hash['next_page']     = next_page if limit == obj.size
-          obj = hash
+          if obj.size == 1 and not only_list?
+            obj = obj.first
+          else
+            hash = {'results' => obj.collect{|o| o.to_api_hash(to_opts)}}
+            hash['page']          = page if page > 1 || limit == obj.size
+            hash['previous_page'] = prev_page if page > 1
+            hash['next_page']     = next_page if limit == obj.size
+            obj = hash
+          end
         end
     
         respond_to do |format|
@@ -258,7 +262,7 @@ module Platform
       end
   
       def page_models
-        @page_models ||= model_class.where(page_model_conditions).limit(limit).offset(offset).order('id ASC')
+        @page_models ||= model_class.where(page_model_conditions).limit(limit).offset(offset).order('id ASC').all
       end
 
       def page_model
@@ -267,7 +271,9 @@ module Platform
   
       def page_model_conditions(id_fields=nil)
         id_fields ||= self.class.id_fields
-        {:id => ids(id_fields)}
+        page_ids = ids(id_fields)
+        return nil if page_ids.empty?
+        {:id => page_ids}
       end
   
       # default id fields
@@ -288,11 +294,7 @@ module Platform
       end
   
       def default_model_ids
-        default_models.ids
-      end
-
-      def default_models
-        raise Exception.new("must be implemented in the extanding class")
+        []
       end
     
       def success_message
@@ -365,6 +367,10 @@ module Platform
         end
       end
 
+      def only_list?
+        params[:only_list] || false
+      end
+      
       def request_limit
         @request_limit ||= Platform::Config.api_request_limit
       end
@@ -421,9 +427,13 @@ module Platform
       end
   
       def ensure_logged_in
-        raise LoginError unless logged_in?
+        raise LoginError.new("You must be logged in to use this API") unless logged_in?
       end
 
+      def ensure_ids_provided
+        raise ApiError.new("Provide an id or ids for the object") if ids.empty?
+      end
+      
       # should be overwritten by the implementing class - this is cutsom stuff for some apps
       def ensure_ownership(user=current_user, models=page_models)
         raise ForbiddenError.new('Permission denied') unless models.all? { |ii| ii.user == current_user }

data/app/controllers/platform/apps_controller.rb

@@ -93,6 +93,22 @@ class Platform::AppsController < Platform::BaseController
     render :layout => false
   end
   
+  def settings
+    @app_users = Platform::ApplicationUser.where("user_id = ?", current_user.id).order("updated_at desc")
+  end
+  
+  def remove
+    if request.post?
+      app_user = Platform::ApplicationUser.find_by_id(params[:app_user_id])
+      if app_user
+        app_user.destroy 
+        trfn("{app} has been removed from your account and will no longer have access to your account information.", "", :app => app_user.application.name)
+      end
+    end
+    
+    redirect_to :action => :settings  
+  end
+  
   def run
     @app = Platform::Application.find_by_canvas_name(params[:canvas_name])
     return render(:action => :canvas_app) unless @app

data/app/controllers/platform/developer/help_controller.rb

@@ -84,25 +84,12 @@ class Platform::Developer::HelpController < Platform::Developer::BaseController
       trfe("API path must be provided")
       return redirect_to(:action => :index, :version => @version)
     end
-    
-    parts = params[:path].split("/")
-    parts.delete(parts.first) if [''].include?(parts.first)
-    
-    @api = ref[parts.first]
+
+    @api = Platform::Config.api_reference_by_path(@version, params[:path])
     unless @api
       trfe("Unsupported API path")
       return redirect_to(:action => :index, :version => @version)
     end
-    
-    if parts.size > 1 
-      if @api[:actions] and @api[:actions][parts.last]
-        action_api = @api[:actions][parts.last]
-        action_api[:parent] = @api
-        @api = action_api
-      else  
-        trfe("Unsupported API path")
-      end
-    end
   end
 
 private

data/app/controllers/platform/oauth_controller.rb

@@ -153,8 +153,8 @@ class Platform::OauthController < Platform::BaseController
     # implement authorized user
     if client_application.authorized_user?
       # add access token to the redirect
-      access_token = client_application.create_access_token(:user=>Geni.current_user, :scope=>scope)
-      refresh_token = client_application.create_refresh_token(:user=>Geni.current_user, :scope=>scope)
+      access_token = client_application.create_access_token(:user=>Platform.current_user, :scope=>scope)
+      refresh_token = client_application.create_refresh_token(:user=>Platform.current_user, :scope=>scope)
       return redirect_with_response(:status => "authorized", :access_token => access_token.token, :refresh_token => refresh_token.token, :expires_in => (access_token.valid_to.to_i - Time.now.to_i))
     end
     
@@ -346,7 +346,7 @@ private
   end
 
   def redirect_url_valid?(url)
-    return true if xd?
+    return true if xd? or mobile?
     
     begin
       URI.parse(url)

data/app/helpers/platform/admin/categories_helper.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2011 Michael Berkovich, Geni Inc
+# Copyright (c) 2011 Michael Berkovich
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/app/helpers/platform/developer/help_helper.rb

@@ -33,7 +33,8 @@ module Platform::Developer::HelpHelper
   end
   
   def documentation_field_link_tag(name, type)
-    link_to(name, :controller => "/platform/developer/help", :action => :api, :path => type.underscore)
+    path = Platform::Config.api_reference(params[:version] || Platform::Config.api_default_version)[type.underscore]["path"]
+    link_to(name, :controller => "/platform/developer/help", :action => :api, :path => path)
   end
   
 private

data/app/models/platform/application.rb

@@ -23,6 +23,8 @@
 
 class Platform::Application < ActiveRecord::Base
   set_table_name :platform_applications
+
+  has_platform_api_proxy
   
   # useful methods - should be public
   include Platform::SimpleStringPermissions

data/app/models/platform/developer.rb

@@ -24,6 +24,8 @@
 class Platform::Developer < ActiveRecord::Base
   set_table_name :platform_developers
 
+  has_platform_api_proxy
+
   belongs_to :user, :class_name => Platform::Config.user_class_name, :foreign_key => :user_id
   
   has_many :applications, :class_name => "Platform::Application"

data/app/models/platform/logged_exception.rb

@@ -278,7 +278,7 @@ class Platform::LoggedException < ActiveRecord::Base
       message = []
 
       message << "Subject: #{log.exception_class}: #{log.message}\n"
-      message << "Exception URL: http://stage.geni.com/admin/exceptions/show/#{log.id}"
+      message << "Exception URL: #{Platform.site_url}/admin/exceptions/show/#{log.id}"
       message << "Backtrace:\n#{log.backtrace.join("\n")}" if log.backtrace
 
       Net::SMTP.start(LOCAL_SMTP_SETTINGS[:address], LOCAL_SMTP_SETTINGS[:port]) do |smtp|

data/app/views/platform/admin/clientsdk/index.html.erb

@@ -2,11 +2,11 @@
 <%= render :partial => "tabs" %>
 
 <%=javascript_include_tag("https://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js")%>
-<%=javascript_include_tag("/public/javascripts/geni_connect.js")%>
+<%=javascript_include_tag("https://raw.github.com/berk/platform_js_clientsdk/master/jsdk.js")%>
 
 <ul id="debug" style="font-family:arial;font-size:11px;position:absolute;right:0;top:0;background:lightyellow;padding:10px;margin:0;list-style-type:none;white-space:nowrap"></ul>
 
-<h1>Geni Connect</h1>
+<h1>Platform Connect</h1>
 <p>Authorization not working right now :(</p>
 
 <button id="connect_btn">Connect</button>
@@ -18,16 +18,16 @@
 <pre style="font-size:11px;background:#f5f5f5;padding:10px;width:500px">
 
 // Authorize App
-Geni.Auth.connect();
+Platform.Auth.connect();
 
 // Revoke Application Authorization
-Geni.Auth.disconnect();
+Platform.Auth.disconnect();
 
-// Logout of Geni
-Geni.Auth.logout();
+// Logout of Platform
+Platform.Auth.logout();
 
 // Make API Call
-Geni.api('/profile',function(r) {
+Platform.api('/profile',function(r) {
   var html = '&lt;table&gt;';
   for (var key in r) {
     html += (
@@ -49,20 +49,20 @@ Geni.api('/profile',function(r) {
 
 
 $('#connect_btn').click(function(){
-  Geni.Auth.connect();
+  Platform.Auth.connect();
 })
 
 $('#disconnect_btn').click(function(){
-  Geni.Auth.disconnect();
+  Platform.Auth.disconnect();
 })
 
 $('#logout_btn').click(function(){
-  Geni.Auth.logout();
+  Platform.Auth.logout();
 })
 
 $('#user_btn').click(function(){
   var div = document.getElementById('profile_data');
-  Geni.api('/profile',function(r) {
+  Platform.api('/profile',function(r) {
     var html = '<table>';
     for (var key in r) {
       html += (
@@ -78,7 +78,7 @@ $('#user_btn').click(function(){
 
 
 
-Geni.Event.bind('log',function(args) {
+Platform.Event.bind('log',function(args) {
   $('#debug')[0].innerHTML += "<li>" + args + "</li>";