rammer 1.1.2 → 2.0.0

data/test/test_viber_module_unplug.rb

@@ -0,0 +1,87 @@
+=begin
+**************************************************************************
+* The MIT License (MIT)
+
+* Copyright (c) 2013-2014 QBurst Technologies 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.
+
+**************************************************************************
+=end
+
+require_relative './helper'
+
+$test_file = "dummy"
+$test_file_root = "#{Dir.pwd}/test"
+
+class TestViberModuleUnmplug < Test::Unit::TestCase
+
+  AUTHENTICATE_MODULE_FILES  =     ["app/apis/#{$test_file}/modules/authentication_apis.rb"]
+  AUTHORIZE_MODULE_FILES     =     ["app/apis/#{$test_file}/modules/authorization_apis.rb"]
+  OAUTH_MODULE_FILES         =     ["app/apis/#{$test_file}/modules/oauth_apis.rb"]
+  MODULE_CLASS               =     $test_file.split('_').map(&:capitalize)*''
+
+  def test_generator_root_module_unmount_authenticate
+    dir_path = Dir.pwd
+    module_class = "::#{MODULE_CLASS}::AuthenticationApis"
+    options = { :project_name => "#{$test_file}", :module_class => module_class, 
+                :module_name => "authentication", :action => "-u"}
+    generator = Rammer::ModuleGenerator.new(options)
+    generator.run 
+    AUTHENTICATE_MODULE_FILES.each do |file|
+      assert_equal(false, File.file?("#{dir_path}/#{file}"))
+    end
+  end
+
+  def test_generator_root_module_unmount_authorize
+    dir_path = Dir.pwd
+    module_class = "::#{MODULE_CLASS}::AuthorizationApis"
+    options = { :project_name => "#{$test_file}", :module_class => module_class, 
+                :module_name => "authorization", :action => "-u"}
+    generator = Rammer::ModuleGenerator.new(options)
+    generator.run 
+    AUTHORIZE_MODULE_FILES.each do |file|
+      assert_equal(false, File.file?("#{dir_path}/#{file}"))
+    end
+  end
+
+  def test_generator_root_module_unmount_oauth
+    dir_path = Dir.pwd
+    module_class = "::#{MODULE_CLASS}::OauthApis"
+    options = { :project_name => "#{$test_file}", :module_class => module_class, 
+                :module_name => "oauth", :action => "-u"}
+    generator = Rammer::ModuleGenerator.new(options)
+    generator.run 
+    OAUTH_MODULE_FILES.each do |file|
+      assert_equal(false, File.file?("#{dir_path}/#{file}"))
+    end
+  end
+
+  def test_generator_root_unmouting_executed
+    dir_path = Dir.pwd
+    module_class = "::#{MODULE_CLASS}::AuthenticationApis"
+    options = { :project_name => "#{$test_file}", :module_class => module_class, 
+                :module_name => "authentication", :action => "-u"}
+    generator = Rammer::ModuleGenerator.new(options)
+    generator.run 
+    AUTHENTICATE_MODULE_FILES.each do |file|
+      assert_equal(false, File.file?("#{dir_path}/#{file}"))
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rammer
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-12 00:00:00.000000000 Z
+date: 2013-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.4.0.rc.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.4.0.rc.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -43,6 +43,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rammer is a framework dedicated to build high performance Async API servers
   on top of non-blocking (asynchronous) Ruby web server called Goliath. Rammer APIs
   are designed on top of REST-like API micro-framework Grape. Rammer is modular and
@@ -55,34 +87,41 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rammer.rb
-- lib/rammer/version.rb
-- lib/template/01_create_users.rb
-- lib/template/02_create_sessions.rb
-- lib/template/03_create_owners.rb
-- lib/template/04_create_oauth2_authorizations.rb
-- lib/template/05_create_oauth2_clients.rb
-- lib/template/Gemfile
-- lib/template/Gemfile.lock
-- lib/template/Procfile
-- lib/template/Rakefile
-- lib/template/application.rb
-- lib/template/authentication_apis.rb
-- lib/template/authorization_apis.rb
-- lib/template/database.yml
-- lib/template/oauth2_authorization.rb
-- lib/template/oauth2_client.rb
-- lib/template/oauth_apis.rb
-- lib/template/owner.rb
-- lib/template/server.rb
-- lib/template/session.rb
-- lib/template/tree.rb
-- lib/template/user.rb
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- MODULE_FILES
 - rammer.gemspec
+- lib/rammer.rb
+- lib/rammer/version.rb
+- lib/rammer/rammer_generator.rb
+- lib/rammer/module_generator.rb
+- lib/modules/migrations/01_create_users.rb
+- lib/modules/migrations/02_create_sessions.rb
+- lib/modules/migrations/03_create_owners.rb
+- lib/modules/migrations/04_create_oauth2_authorizations.rb
+- lib/modules/migrations/05_create_oauth2_clients.rb
+- lib/modules/common/Gemfile
+- lib/modules/common/Gemfile.lock
+- lib/modules/common/Procfile
+- lib/modules/common/Rakefile
+- lib/modules/common/application.rb
+- lib/modules/authentication/authentication_apis.rb
+- lib/modules/authorization/authorization_apis.rb
+- lib/modules/common/database.yml
+- lib/modules/models/oauth2_authorization.rb
+- lib/modules/models/oauth2_client.rb
+- lib/modules/oauth/oauth_apis.rb
+- lib/modules/models/owner.rb
+- lib/modules/common/server.rb
+- lib/modules/models/session.rb
+- lib/modules/common/tree.rb
+- lib/modules/models/user.rb
+- test/helper.rb
+- test/test_rammer_root_structure.rb
+- test/test_viber_module_plugin.rb
+- test/test_viber_module_unplug.rb
 - bin/rammer
 - bin/viber
 homepage: http://github.com/qburstruby/rammer
@@ -98,12 +137,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2624680165410903349
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2624680165410903349
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -111,5 +156,8 @@ signing_key:
 specification_version: 3
 summary: Rammer is a framework dedicated to build high performance Async API servers
   on top of non-blocking (asynchronous) Ruby web server called Goliath.
-test_files: []
-has_rdoc: 
+test_files:
+- test/helper.rb
+- test/test_rammer_root_structure.rb
+- test/test_viber_module_plugin.rb
+- test/test_viber_module_unplug.rb

data/lib/template/02_create_sessions.rb

@@ -1,9 +0,0 @@
-class CreateSessions < ActiveRecord::Migration
-	def change
-    	create_table(:sessions) do |t|
-    		t.string :user_id
-    		t.string :session_token
-    	end
-    	add_index  :sessions, :session_token, :unique => true
-	end
-end

data/lib/template/03_create_owners.rb

@@ -1,13 +0,0 @@
-class CreateOwner < ActiveRecord::Migration
-	def self.up
-	    create_table :owners do |t|
-	      t.timestamps
-	      t.string     :username
-	     end
-		add_index :owners, [:username]
- 	end
-
- 	def self.down
-	    drop_table :owners
-  	end
-end

data/lib/template/04_create_oauth2_authorizations.rb

@@ -1,23 +0,0 @@
-class CreateOauth2Authorizations < ActiveRecord::Migration
-  def self.up
-    create_table :oauth2_authorizations do |t|
-      t.timestamps
-      t.string     :oauth2_resource_owner_type
-      t.integer    :oauth2_resource_owner_id
-      t.belongs_to :oauth2_client
-      t.string     :scope
-      t.string     :code,               :limit => 40
-      t.string     :access_token,  :limit => 40
-      t.string     :refresh_token, :limit => 40
-      t.datetime   :expires_at
-    end
-    add_index :oauth2_authorizations, [:oauth2_client_id, :code]
-    add_index :oauth2_authorizations, [:access_token]
-    add_index :oauth2_authorizations, [:oauth2_client_id, :access_token], :name => 'access_token_index'
-    add_index :oauth2_authorizations, [:oauth2_client_id, :refresh_token], :name => 'refresh_token_index'
-  end
-
-  def self.down
-    drop_table :oauth2_authorizations
-  end
-end

data/lib/template/05_create_oauth2_clients.rb

@@ -1,18 +0,0 @@
-class CreateOauth2Clients < ActiveRecord::Migration
-  def self.up
-    create_table :oauth2_clients do |t|
-      t.string     :name
-      t.string     :client_id
-      t.string     :client_secret_hash
-      t.string     :redirect_uri
-      t.string     :basic_code
-      t.timestamps
-    end
-    add_index :oauth2_clients, :client_id, :unique => true
-  end
-
-  def self.down
-    drop_table :oauth2_clients
-  end
-
-end

data/lib/template/Gemfile

@@ -1,16 +0,0 @@
-source "http://rubygems.org"
-
-
-gem 'pg'
-gem 'em-postgresql-adapter', :git => 'git://github.com/leftbee/em-postgresql-adapter.git'
-gem 'rack-fiber_pool',  :require => 'rack/fiber_pool'
-gem 'em-synchrony', :git => 'git://github.com/igrigorik/em-synchrony.git',
-                    :require => ['em-synchrony', 'em-synchrony/activerecord', 'em-synchrony/mysql2']
-                            
-gem 'grape'
-gem 'goliath'
-
-gem "activerecord", "~> 3.1.1"
-gem 'rack-fiber_pool',  :require => 'rack/fiber_pool'
-gem "mysql2"                    
-

data/lib/template/application.rb

@@ -1,21 +0,0 @@
-require 'uri'
-require 'em-synchrony/activerecord'
-require 'yaml'
-require 'erb'
-
-# Sets up database configuration
-db = URI.parse(ENV['DATABASE_URL'] || 'http://localhost')
-if db.scheme == 'postgres' # Heroku environment
-  ActiveRecord::Base.establish_connection(
-    :adapter  => db.scheme == 'postgres' ? 'em_postgresql' : db.scheme,
-    :host     => db.host,
-    :username => db.user,
-    :password => db.password,
-    :database => db.path[1..-1],
-    :encoding => 'utf8'
-  )
-else # local environment
-  environment = ENV['DATABASE_URL'] ? 'production' : 'development'
-  db = YAML.load(ERB.new(File.read('config/database.yml')).result)[environment]
-  ActiveRecord::Base.establish_connection(db)
-end

data/lib/template/authentication_apis.rb

@@ -1,35 +0,0 @@
-require 'oauth2'
-require 'songkick/oauth2/provider'
-require 'ruby_regex'
-module Rammer
-
-    class AuthenticationApis < Grape::API
-    	Songkick::OAuth2::Provider.realm = 'PocketAPI Oauth Server'
-        version 'v1', :using => :path
-        format :json
-=begin
-This web service enables pockit server user sign up process with request parameters:
-{"email"=> User email,
-"password" => MD5 hash encrypted password,
-"redirect_uri" => Callback url for this api call.	
-}
-=end
-    [:get, :post].each do |method|
-  		  	__send__ method, '/authentication/sign_up' do
-  		  		if User.validate_params?(params,"sign_up")
-  		  			@existing_user = User.find_by_email(params.email)
-  		  			unless @existing_user  		  				
-  		  				@user, @session = User.sign_up(params)
-						redirect @user.redirect_url(params,@session)
-  		  			else
-  		  				error = "User already exists."
-						Oauth2Authorization.error_response(error)
-					end
-  		  		else
-  		  			error = "Parameters missing or invalid."
-					Oauth2Authorization.error_response(error)
-				end
-			end
-		end
-	end
-end

data/lib/template/authorization_apis.rb

@@ -1,59 +0,0 @@
-require 'oauth2'
-require 'songkick/oauth2/provider'
-require 'ruby_regex'
-module Rammer
-    
-    class AuthorizationApis < Grape::API
-    	Songkick::OAuth2::Provider.realm = 'PocketAPI Oauth Server'
-        version 'v1', :using => :path
-        format :json
-=begin
-This web service enables pockit server user sign up process with request parameters:
-{"email"=> User email,
-"password" => MD5 hash encrypted password,
-"redirect_uri" => Callback url for this api call.	
-}	
-=end
-		[:get, :post].each do |method|
-  		  	__send__ method, '/authorization/sign_in' do
-  		  		if User.validate_params?(params,"sign_in")
-					@authroized_user = User.find_by_email_and_encrypted_password(params.email,params.password)
-					if @authroized_user
-						@session = @authroized_user.sign_in(params)						
-						redirect @authroized_user.redirect_url(params,@session)
-					else
-						error = "Not a registered user."
-						Oauth2Authorization.error_response(error)
-					end
-				else
-  		  			error = "Parameters missing or invalid."
-					Oauth2Authorization.error_response(error)
-				end
-			end
-		end
-=begin
-This web service enables pockit server user sign up process with request parameters:
-{"email"=> User email,
-"session_token" => Session token obtained during sign in,
-"redirect_uri" => Callback url for this api call.	
-}	
-=end
-		[:get, :post].each do |method|
-  		  	__send__ method, '/authorization/sign_out' do
-  		  		if User.validate_params?(params,"sign_out")
-					@authroized_user = User.find_by_email(params.email)
-					if @authroized_user &&  @authroized_user.signed_in?(params)
-						@authroized_user.sign_out(params)
-						redirect params.redirect_uri
-					else
-						error = "Invalid user or already signed out."
-						Oauth2Authorization.error_response(error)
-					end
-				else
-  		  			error = "Parameters missing or invalid."
-					Oauth2Authorization.error_response(error)
-				end
-			end
-		end
-	end
-end

data/lib/template/oauth2_authorization.rb

@@ -1,113 +0,0 @@
-class Oauth2Authorization < ActiveRecord::Base
-  belongs_to :client, :class_name => 'Oauth2Client'
-
-  def get_token(owner,client, attributes = {})
-    return nil unless owner and client
-        @instance = owner.oauth2_authorization(client,owner) ||
-            Oauth2Authorization.new do |authorization|
-                authorization.oauth2_resource_owner_id  = owner.id
-                authorization.oauth2_client_id = client.id
-            end
-        case attributes[:response_type]
-            when 'code'
-              @instance.code ||= create_code(client)
-            when 'token'
-              @instance.access_token  ||= create_access_token
-              @instance.refresh_token ||= create_refresh_token(client)
-              @instance.code ||= create_code(client)
-        end
-
-        if @instance.expires_at.nil?        
-            @instance.expires_at = attributes[:duration].present? ? Time.now + attributes[:duration].to_i : nil         
-        elsif attributes[:invalidate]
-            @instance.expires_at = Time.now
-        end
-
-        if @instance.scope.nil?
-          @instance.scope = attributes[:scope].present? ? attributes[:scope] : nil        
-        elsif attributes[:scope].present?
-          @instance.scope += "," + attributes[:scope] unless @instance.scope.include? attributes[:scope]
-        end
-
-        @instance.save
-        return @instance
-
-        rescue Object => error
-            raise error
-  end
-
-  def refresh_access_token
-    self.expires_at = Time.now + 3600   
-    save
-  end
-
-  def create_code(client)
-    Songkick::OAuth2.generate_id do |code|
-        return code
-    end
-  end
-
-  def create_access_token
-    hash = nil
-    Songkick::OAuth2.generate_id do |token|
-      hash = Songkick::OAuth2.hashify(token)         
-    end
-    return hash
-  end
-
-  def create_refresh_token(client)
-    Songkick::OAuth2.generate_id do |refresh_token|
-      hash = Songkick::OAuth2.hashify(refresh_token)
-    end
-      return hash
-  end
-
-  def scopes
-    scopes = scope ? scope.split(/\s+/) : []
-    scopes = attributes[:scope]
-    Set.new(scopes).to_s
-  end
-
-  def in_scope?(request_scope)
-    [*request_scope].all?(&scopes.method(:include?))
-  end
-
-  def expired?
-    return false unless expires_at
-    expires_at < Time.now
-  end
-
-  def generate_access_token
-    self.access_token ||= self.create_access_token
-    save && access_token
-  end
-
-  def generate_code
-    self.code ||= self.create_code(client)
-    save && code
-  end
-
-  def self.error_response(error)
-    error_response = {
-      :error => "Unauthorized access",
-      :description => error,
-      :status => 401
-    }
-  end
-
-  def build_url(redirect_uri)
-    if redirect_uri.include? "#access_token" 
-        redirect_url = redirect_uri.gsub!('#','?')
-    elsif redirect_uri.include? "#"
-        redirect_url = redirect_uri.gsub!('#','?')
-        return redirect_uri + "access_token=#{self.access_token}"
-    elsif redirect_uri.include? "access_token"
-        return redirect_uri + "?access_token=#{self.access_token}"
-    end  
-  end
-
-  def redirect(auth)
-    return auth.redirect_uri.split('#',2).first
-  end
-
-end

data/lib/template/oauth2_client.rb

@@ -1,100 +0,0 @@
-class Oauth2Client < ActiveRecord::Base
-	has_many :oauth2_authorizations
-  attr_accessible :name, :client_id, :client_secret_hash, :redirect_uri
-  validates_presence_of :name, :client_id, :client_secret_hash, :redirect_uri
-  validates_uniqueness_of :client_id
-
-  before_validation :generate_keys, :on => :create
-
-  def self.register(params)
-    if @client = Oauth2Client.find_by_name(params.name)
-      error = "Client already exists."
-      error_message = Oauth2Authorization.error_response(error)
-      return error_message, false
-    else
-      @oauth2_client = Oauth2Client.create!(params)          
-      string = "#{@oauth2_client.client_id}:#{@oauth2_client.client_secret_hash}"
-      @oauth2_client.update_attribute(:basic_code, Base64.encode64(string))
-      redirect_url = @oauth2_client.redirect_to_url
-      return redirect_url, true
-    end
-  end
-
-	def self.valid_authorization?(params)
-		authorization_decoded = Base64.decode64(params.authorization)  	
-		@client = Oauth2Client.find_by_client_id(params.client_id)
-    if @client
-		  return authorization_decoded.eql?("#{@client.client_id}:#{@client.client_secret_hash}")? true : false  
-    end		
-	end
-
-	def self.grant_access(params,env,request_type)
-    if request_type == "user"
-      @owner  = Owner.find_by_username(params.username)
-      @owner = Owner.create(:username => params.username) if @owner.nil?
-    else
-      @owner  = Owner.find_by_username(params.host_name+"_bearer")
-      @owner = Owner.create(:username => params.host_name+"_bearer") if @owner.nil?
-    end
-
-    @oauth2 = Songkick::OAuth2::Provider.parse(@owner, env)  
-    if @oauth2.valid?    
-        @auth = Songkick::OAuth2::Provider::Authorization.new(@owner, params)
-        @authenticated_owner = Oauth2Authorization.find_by_oauth2_resource_owner_id_and_oauth2_client_id(@owner.id,@auth.client.id)
-        unless @authenticated_owner
-          @oauth2_authorization_instance = Oauth2Authorization.new()
-          @instance = @oauth2_authorization_instance.get_token(@auth.owner, @auth.client,
-                    :response_type => "token",
-                    :scope => params["scope"].present? ? params["scope"] : nil,
-                    :duration => params["duration"].present? ? params["duration"] : 3600)   
-        else
-          @instance = @authenticated_owner
-        end
-        if @instance.access_token.nil?                
-          error_message = Oauth2Authorization.error_response(@oauth2.error_description)
-          return error_message, false   
-        else
-          redirect_to_url = @instance.build_url(@auth.redirect_uri) 
-          @instance.refresh_access_token if @instance.expired?  
-          return redirect_to_url, true                      
-        end  
-    else
-      error_message = Oauth2Authorization.error_response(@oauth2.error_description) 
-      return error_message, false  
-    end
-  end
-
-  def self.invalidate_token(params,env)
-    @owner  = Owner.find_by_username(params.host_name+"_bearer")            
-    if @owner.nil?
-      error = "No Bearer token issued to this client."
-      error_message = Oauth2Authorization.error_response(error)
-      return error_message, false 
-    else
-      @oauth2 = Songkick::OAuth2::Provider.parse(@owner, env)
-      if @oauth2.valid? 
-        @auth = Songkick::OAuth2::Provider::Authorization.new(@owner, params)                 
-        @oauth2_authorization_instance = Oauth2Authorization.new()
-        @instance = @oauth2_authorization_instance.get_token(@auth.owner,@auth.client,
-                  :response_type => "token",
-                  :invalidate => true)                                                  
-        return @instance.redirect(@auth), true                   
-      else
-        error_message = Oauth2Authorization.error_response(@oauth2.error_description) 
-        return error_message, false  
-      end
-    end
-  end
-
-  def redirect_to_url
-    return self.redirect_uri + "?client_id=#{self.client_id}&client_secret_hash=#{self.client_secret_hash}
-          &redirect_uri=#{self.redirect_uri}&authorization=#{self.basic_code}"
-  end
-
-  protected
-
-  def generate_keys
-    self.client_id = OAuth::Helper.generate_key(40)[0,40]
-    self.client_secret_hash = OAuth::Helper.generate_key(40)[0,40]
-  end
-end