platform 3.1.1

data/lib/platform/random_password_generator.rb

@@ -0,0 +1,76 @@
+#--
+# Copyright (c) 2011 Michael Berkovich, Geni Inc
+#
+# 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.
+#++
+
+module Platform
+  module RandomPasswordGenerator
+  
+    VOWELS = ['a', 'e', 'i', 'u'] unless defined?(VOWELS)
+    CONSONANTS =  ['b', 'c', 'd', 'f', 'g', 'h', 'j', 'k', 'm', 'n', 'p', 'q', 'r', 's', 't', 'v', 'w', 'x', 'y', 'z'] unless defined?(CONSONANTS)
+    DIGITS = ['2', '3', '4', '5', '6', '7', '8', '9'] unless defined?(DIGITS)
+  
+    def random_password(alpha=6, numeric=2)
+      RandomPasswordGenerator.random_password(alpha, numeric)
+    end
+    
+    def self.a_part(slen)
+      ret = ''
+      for i in 0...slen
+        if i % 2 == 0
+          randid = rand(CONSONANTS.length)
+          ret = ret + CONSONANTS[randid]
+        else
+          randid = rand(VOWELS.length)
+          ret = ret + VOWELS[randid]
+        end
+      end # for
+      return ret
+    end # def a_part
+  
+    def self.n_part(slen)
+      ret = ''
+      for i in 0...slen
+        randid = rand(DIGITS.length)
+        ret = ret + DIGITS[randid]
+      end # for
+      return ret
+    end # def n_part
+    
+    def self.random_password(alpha=6, numeric=2)
+    
+      fpl = alpha / 2
+      if alpha % 2 != 0
+        fpl = int(alpha / 2) + 1
+      end
+      lpl = alpha - fpl
+    
+      start = a_part(fpl)
+      mid = n_part(numeric)
+      tail = a_part(lpl)
+    
+      result = "%s%s%s" % [start, mid, tail]
+      return result
+    
+    end
+    
+  end
+end

data/lib/platform/simple_string_permissions.rb

@@ -0,0 +1,40 @@
+#--
+# Copyright (c) 2011 Michael Berkovich, Geni Inc
+#
+# 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.
+#++
+
+module Platform
+  module SimpleStringPermissions
+
+    def set_permission(key, value)
+      self.permissions = if value
+        (permissions.to_s.split(',').to_set + key.to_s)
+      else
+        (permissions.to_s.split(',').to_set - key.to_s)
+      end.join(',')
+    end
+
+    def has_permission?(key)
+      permissions.to_s.split(',').include?(key.to_s)
+    end
+
+  end
+end

data/lib/platform/version.rb

@@ -0,0 +1,3 @@
+module Platform
+  VERSION = "3.1.1"
+end

data/lib/tasks/platform.rake

@@ -0,0 +1,119 @@
+#--
+# Copyright (c) 2011 Michael Berkovich, Geni Inc
+#
+# 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.
+#++
+
+namespace :platform do
+  
+  desc "Initializes all of the tables with default data"
+  task :init => :environment do
+    raise "This action is prohibited in this environment" if ['production', 'stage', 'staging'].include?(Rails.env) and env('force') != 'true'
+    Platform::Config.reset_all!
+  end
+  
+  task :rollup_metrics => :environment do
+    # for debugging purposes
+#    Platform::RollupLog.delete_all
+#    Platform::ApplicationMetric.delete_all
+#    Platform::ApplicationUsageMetric.delete_all
+    
+    # when we bootstrap the process, we should havesome set date/time from where to start
+    default_start_time = Time.parse("07/10/2011 12:00:00")
+    
+    if Platform::RollupLog.first == nil
+      # running the rollup for the first time
+      interval = interval_time_for(default_start_time)
+    else
+      last_rollup = Platform::RollupLog.last
+      interval = interval_time_for(last_rollup.interval - 15.minutes) # always do the last interval and the current interval
+    end
+    
+    rollup_interval(interval)
+  end
+
+  task :rollup_daily_metrics => :environment do
+    start_date = ENV['since'] || Date.today.to_s
+    start_date = Date.parse(start_date)
+    end_date = Date.today
+    
+    while start_date <= end_date do
+      log_msg("Rolling up daily metrics for #{start_date}...")
+      
+      Platform::Application.all.each do |app|
+        Platform::DailyApplicationMetric.calculate_metric(app, start_date - 1.day)
+        Platform::WeeklyApplicationMetric.calculate_metric(app, start_date - 1.week)
+        Platform::MonthlyApplicationMetric.calculate_metric(app, start_date - 1.month)
+        Platform::TotalApplicationMetric.calculate_metric(app, start_date)
+      end
+      
+      start_date += 1.day
+    end
+    
+    log_msg("Done.")
+  end
+
+private  
+  
+  def rollup_interval(interval)
+    interval_start = interval
+    interval_end = interval_start + Platform::ApplicationUsageMetric.interval_duration
+    
+    log_msg("Rolling up interval: #{interval_start} - #{interval_end}...")
+
+    rollup_log = Platform::RollupLog.create(:interval => interval, :started_at => Time.now)  
+
+    # figure out which apps to calculates stats for. there is no point for having empty records.
+    app_ids = Platform::Application.connection.select_values("select distinct application_id from platform_application_users where created_at >= '#{interval_start}' and created_at < '#{interval_end}'")
+    app_ids += Platform::Application.connection.select_values("select distinct application_id from platform_application_logs where created_at >= '#{interval_start}' and created_at < '#{interval_end}'")
+    
+    log_msg("No applications to rollup") if app_ids.empty?
+    
+    # for each application
+    app_ids.uniq.each do |app_id|
+      app = Platform::Application.find_by_id(app_id)
+      next unless app
+      
+      # process application metrics
+      Platform::ApplicationMetric.calculate_metric(app, interval)
+  
+      # process application usage metrics - in 15 min chunks only - since it is summable
+      Platform::ApplicationUsageMetric.calculate_metric(app, interval)
+    end
+  
+    rollup_log.update_attributes(:finished_at => Time.now)
+    
+    now = Time.now
+    if now >= interval_start && now < interval_end
+      log_msg("Rolled up current interval. Going to sleep...")
+    else  
+      rollup_interval(interval + 15.minutes)
+    end
+  end
+  
+  def interval_time_for(time)
+    Time.parse("#{time.year}-#{time.month}-#{time.day} #{time.hour}:#{((time.min / 15) * 15) }")
+  end
+  
+  def log_msg(msg)
+    pp "#{Time.now.strftime('%m/%d/%Y %H:%M:%S')}: #{msg}"    
+  end
+  
+end

data/platform.gemspec

@@ -0,0 +1,45 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "platform/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "platform"
+  s.version     = Platform::VERSION
+  s.authors     = ["Michael Berkovich"]
+  s.email       = ["theiceberk@gmail.com"]
+  s.homepage    = "https://github.com/berk/platform"
+  s.summary     = "Application Developer platform for extanding Rails applications by 3rd party developers."
+  s.description = "This gem provides all necessary tools to make a Rails application into a platform with third party applications."
+
+  s.rubyforge_project = 'platform'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,local,spec,features}/*`.split("\n")
+  s.extra_rdoc_files = ['README.rdoc']
+  s.require_paths = ['lib']
+
+  s.licenses = ['MIT']
+
+  s.add_dependency 'rails', ['>= 3.1.0']
+  s.add_dependency 'will_filter', ['>= 3.1.2']
+  s.add_dependency 'tr8n', ['>= 3.1.1']
+  s.add_dependency 'kaminari', ['>= 0']
+  s.add_dependency 'sass', ['>= 0']
+  s.add_dependency 'coffee-script', ['>= 0']
+  s.add_dependency 'acts_as_tree', ['>= 0']
+  s.add_dependency 'acts_as_state_machine', ['>= 0']
+  s.add_dependency 'rmagick', ['>= 0']
+  s.add_development_dependency 'pry', ['>= 0']
+  s.add_development_dependency 'bundler', ['>= 1.0.0']
+  s.add_development_dependency 'sqlite3', ['>= 0']
+  s.add_development_dependency 'rspec', ['>= 0']
+  s.add_development_dependency 'rspec-rails', ['>= 0']
+  s.add_development_dependency 'factory_girl', ['>= 0']
+  s.add_development_dependency 'rr', ['>= 0']
+  s.add_development_dependency 'steak', ['>= 0']
+  s.add_development_dependency 'capybara', ['>= 0']
+  s.add_development_dependency 'database_cleaner', ['>= 0']
+  s.add_development_dependency 'memcache-client', ['>= 1.8.5']
+end

data/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_PATH = File.expand_path('../..',  __FILE__)
+load File.expand_path('../../test/dummy/script/rails',  __FILE__)

data/spec/config/config_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+
+describe Platform::Config do
+  subject { Platform::Config }
+  describe 'configuration' do
+    context 'by default' do
+      its(:current_user) {should be(nil)}
+    end
+  end
+end

data/spec/dummy_app.rb

@@ -0,0 +1,52 @@
+require 'active_record'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+ENV['RAILS_ENV'] = 'test'
+
+require ::File.expand_path("#{File.dirname(__FILE__)}/../test/dummy/config/environment")
+
+# # database
+# ActiveRecord::Base.configurations = {'test' => {:adapter => 'sqlite3', :database => ':memory:'}}
+# ActiveRecord::Base.establish_connection('test')
+# 
+# # config
+# app = Class.new(Rails::Application)
+# app.config.secret_token = "3b7cd727ee24e8444053437c36cc66c4"
+# app.config.session_store :cookie_store, :key => "_myapp_session"
+# app.config.active_support.deprecation = :log
+# app.initialize!
+# 
+# # routes
+# require "#{File.dirname(__FILE__)}/../test/dummy/config/routes.rb"
+# 
+# # app.routes.draw do
+# #   resources :users
+# # end
+# 
+# # models
+# Dir["#{File.dirname(__FILE__)}/../test/dummy/app/models/*.rb"].each do |f| 
+#   if [:user, :admin].include?(f.split("/").last.gsub('.rb', '').to_sym)
+#     require f 
+#   end  
+# end  
+# 
+# # controllers
+# Dir["#{File.dirname(__FILE__)}/../test/dummy/app/controllers/*.rb"].each do |f| 
+#   if [:user, :admin].include?(f.split("/").last.gsub('.rb', '').to_sym)
+#     require f 
+#   end  
+# end  
+# 
+# # helpers
+# Object.const_set(:ApplicationHelper, Module.new)
+
+#migrations
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    Dir["#{File.dirname(__FILE__)}/../test/dummy/db/migrate/*.rb"].each do |f| 
+      require f 
+      f.split("/").last.gsub('.rb', '').split('_')[1..-1].join('_').camelcase.constantize.up
+    end  
+  end
+end

data/spec/models/application_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+
+describe Platform::Application do
+  describe '#creation' do
+
+    before :all do 
+      @user = User.create!(:first_name => "Mike")
+      Platform::Config.init(@user)
+    end
+    
+    context "creating new application" do
+      it "should create unique hash key and secret" do
+        app = Platform::Application.create(:name => 'Sample app')
+        app.key.should_not be(nil)
+        app.secret.should_not be(nil)
+      end
+      it "should be retriavable by id" do
+        app1 = Platform::Application.create(:name => 'Sample app')
+        app2 = Platform::Application.for(app1.id)
+        app1.should == app2
+      end
+      it "should be retriavable by key" do
+        app1 = Platform::Application.create(:name => 'Sample app')
+        app2 = Platform::Application.for(app1.key)
+        app1.should == app2
+      end
+      it "should be in a new state" do
+        app1 = Platform::Application.create(:name => 'Sample app')
+        app1.state.should == "new"
+      end
+    end
+
+    context "changing application states" do
+      it "should change states according to the state machine" do
+        app = Platform::Application.create(:name => 'Sample app')
+        app.submit!
+        app.state.should == "submitted"
+        app.approve!
+        app.state.should == "approved"
+        app.block!
+        app.state.should == "blocked"
+      end
+      it "should fail if incorrect states are requested" do
+        app = Platform::Application.create(:name => 'Sample app')
+        app.submit!
+        app.state.should == "submitted"
+        app.deprecate!
+        app.state.should == "submitted"
+      end
+    end
+    
+  end  
+end

data/spec/models/developer_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+
+describe Platform::Developer do
+  describe '#creation' do
+
+    before :all do 
+      @user = User.create!(:first_name => "Mike")
+      Platform::Config.init(@user)
+    end
+    
+    context "find_or_create developer" do
+      it "should create a developer first and then return the same developer" do
+        developer1 = Platform::Developer.find_or_create(@user)
+        developer1.should_not be(nil)
+        developer2 = Platform::Developer.find_or_create(@user)
+        developer1.should == developer2
+        developer3 = Platform::Developer.for(@user)
+        developer3.should == developer2
+      end
+    end
+    
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rails'
+require 'kaminari'
+require 'database_cleaner'
+require 'will_filter'
+require 'tr8n'
+
+# Ensure we use 'syck' instead of 'psych' in 1.9.2
+# RubyGems >= 1.5.0 uses 'psych' on 1.9.2, but
+# Psych does not yet support YAML 1.1 merge keys.
+# Merge keys is often used in mongoid.yml
+# See: http://redmine.ruby-lang.org/issues/show/4300
+if RUBY_VERSION >= '1.9.2'
+  YAML::ENGINE.yamler = 'syck'
+end
+require File.join(File.dirname(__FILE__), 'dummy_app')
+
+require 'rspec/rails'
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :rr
+  config.before :all do
+    CreateAllTables.up unless ActiveRecord::Base.connection.table_exists? 'users'
+  end
+end