cantango-api 0.0.0 → 0.1.0

data/Gemfile

@@ -1,12 +1,13 @@
 source :rubygems
 
 group :default do
-  gem 'rails', '>= 3.1'
-  gem 'sugar-high',       '>= 0.6.0'
-  gem 'sweetloader',      '~> 0.1.0'
-  gem 'hashie'
+  gem 'rails',            '>= 3.1'
+  gem 'sugar-high',       '~> 0.6.2'
+  gem 'sweetloader',      '~> 0.1.6'
+  gem 'hashie',           '~> 1.2'
   
-  gem 'cantango-config',  :git => 'git://github.com/kristianmandrup/cantango-config.git'
+  gem 'cantango-config',  '>= 0.1.8.1'
+  gem 'cantango-core',    '>= 0.1.9.1'
 end
 
 group :development do
@@ -18,6 +19,8 @@ end
 group :test do
   gem 'require_all', '~> 1.2.0'
 
+  # gem 'cantango-masquerade', :git => 'git://github.com/kristianmandrup/cantango-masquerade.git'
+
   gem 'forgery'
   gem 'sqlite3'
   # Data

data/Gemfile.lock

@@ -1,14 +1,3 @@
-GIT
-  remote: git://github.com/kristianmandrup/cantango-config.git
-  revision: 852141acab7fec0eb61930bdda07c16461140a7e
-  specs:
-    cantango-config (0.1.0)
-      cantango-core
-      hashie
-      rails (>= 3.1)
-      sugar-high (>= 0.6.0)
-      sweetloader (~> 0.1.0)
-
 GEM
   remote: http://rubygems.org/
   specs:
@@ -43,12 +32,18 @@ GEM
     arel (2.2.1)
     builder (3.0.0)
     cancan (1.6.7)
-    cantango-core (0.1.0)
+    cantango-config (0.1.9.2)
+      cantango-core (~> 0.1.9)
+      hashie (~> 1.2)
+      rails (>= 3.1)
+      sugar-high (>= 0.6.1)
+      sweetloader (~> 0.1.6)
+    cantango-core (0.1.9.2)
       cancan (>= 1.4)
-      hashie
+      hashie (~> 1.2)
       rails (>= 3.0.1)
       sugar-high (>= 0.6.0)
-      sweetloader (~> 0.1.0)
+      sweetloader (~> 0.1.5)
     colorize (0.5.8)
     cutter (0.8.2)
       activesupport (>= 2.3.5)
@@ -56,7 +51,7 @@ GEM
     database_cleaner (0.7.0)
     diff-lcs (1.1.3)
     erubis (2.7.0)
-    factory_girl (2.3.1)
+    factory_girl (2.3.2)
       activesupport
     forgery (0.5.0)
     git (1.2.5)
@@ -67,13 +62,13 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    json (1.6.1)
+    json (1.6.3)
     mail (2.3.0)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.17.2)
-    multi_json (1.0.3)
+    multi_json (1.0.4)
     polyglot (0.3.3)
     rack (1.3.5)
     rack-cache (1.1)
@@ -117,10 +112,10 @@ GEM
       hike (~> 1.2)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.4)
-    sugar-high (0.6.0)
+    sqlite3 (1.3.5)
+    sugar-high (0.6.2.1)
       activesupport (>= 3.0.1)
-    sweetloader (0.1.1)
+    sweetloader (0.1.6)
       activesupport (>= 3.0.1)
       i18n
     thor (0.14.6)
@@ -135,12 +130,13 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (>= 1.1.rc)
-  cantango-config!
+  cantango-config (>= 0.1.8.1)
+  cantango-core (>= 0.1.9.1)
   cutter
   database_cleaner
   factory_girl
   forgery
-  hashie
+  hashie (~> 1.2)
   jeweler (>= 1.6.4)
   rails (>= 3.1)
   rcov
@@ -148,5 +144,5 @@ DEPENDENCIES
   rspec (>= 2.6.0)
   spork
   sqlite3
-  sugar-high (>= 0.6.0)
-  sweetloader (~> 0.1.0)
+  sugar-high (~> 0.6.2)
+  sweetloader (~> 0.1.6)

data/README.mdown

@@ -2,6 +2,79 @@
 
 The main API for [CanTango](https://github.com/kristianmandrup/cantango)
 
+## Status: Dec 1 2011
+
+The API is being spec'ed...
+
+## Dependencies
+
+This extension depends on the CanTango [core](https://github.com/kristianmandrup/cantango-core) and follows the extension conventions as described there.
+
+## Core extensions
+
+* Macros
+  * User
+  * Account
+
+These macros allow registration os CanTango User and Account models.
+
+Usage example:
+
+```ruby
+class User
+	tango_user 
+end
+
+class Admin
+	tango_user 
+end
+
+class UserAccount
+	tango_account
+end
+
+class AdminAccount
+	tango_account
+end
+```
+
+## Main APIs
+
+The main API consists of the following:
+
+* Ability
+* Can
+* Model
+* Scope
+* Session
+
+Each of these have a specific variant for both `Account` and `User`.
+
+### Can API
+
+* Dsl
+  * Relation
+  * Scope
+
+The Dsl API extends the CanCan Ability API with Relation and Scope APIs.
+
+## Model APIs
+
+* Account
+* User
+
+Use by including the `All` module
+
+Usage example: 
+
+```ruby
+class User
+  include Cantango::Api::User::All
+end
+```
+
+Note: The `tango_user` and `tango_account` macros should include the relevant All module.
+
 ## Contributing to cantango-api
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/cantango-api.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = "cantango-api"
-  s.version = "0.0.0"
+  s.name = %q{cantango-api}
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Kristian Mandrup"]
-  s.date = "2011-11-25"
-  s.description = "Ability, Can, Scope, Session, User, Account and more APIs for CanTango"
-  s.email = "kristian@unity3d.com"
+  s.authors = [%q{Kristian Mandrup}]
+  s.date = %q{2011-12-08}
+  s.description = %q{Ability, Can, Scope, Session, User, Account and more APIs for CanTango}
+  s.email = %q{kristian@unity3d.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.mdown"
@@ -34,6 +34,9 @@ Gem::Specification.new do |s|
     "lib/cantango/api/attributes.rb",
     "lib/cantango/api/can.rb",
     "lib/cantango/api/can/account.rb",
+    "lib/cantango/api/can/dsl.rb",
+    "lib/cantango/api/can/dsl/relation.rb",
+    "lib/cantango/api/can/dsl/scope.rb",
     "lib/cantango/api/can/user.rb",
     "lib/cantango/api/common.rb",
     "lib/cantango/api/model.rb",
@@ -47,16 +50,29 @@ Gem::Specification.new do |s|
     "lib/cantango/api/session/account.rb",
     "lib/cantango/api/session/user.rb",
     "lib/cantango/api/user.rb",
+    "lib/cantango/api_ext.rb",
+    "lib/cantango/api_ext/macros.rb",
+    "lib/cantango/api_ext/macros/account.rb",
+    "lib/cantango/api_ext/macros/clazz.rb",
+    "lib/cantango/api_ext/macros/user.rb",
     "spec/cantango/api/ability/account_spec.rb",
     "spec/cantango/api/ability/user_spec.rb",
     "spec/cantango/api/account_spec.rb",
     "spec/cantango/api/attributes_spec.rb",
     "spec/cantango/api/can/account_spec.rb",
     "spec/cantango/api/can/user_spec.rb",
+    "spec/cantango/api/common_spec.rb",
+    "spec/cantango/api/model/account_spec.rb",
+    "spec/cantango/api/model/user_spec.rb",
     "spec/cantango/api/options_spec.rb",
     "spec/cantango/api/scope/account_spec.rb",
     "spec/cantango/api/scope/user_spec.rb",
+    "spec/cantango/api/session/account_spec.rb",
+    "spec/cantango/api/session/user_spec.rb",
     "spec/cantango/api/user_spec.rb",
+    "spec/cantango/api_ext/macros/account_spec.rb",
+    "spec/cantango/api_ext/macros/clazz_spec.rb",
+    "spec/cantango/api_ext/macros/user_spec.rb",
     "spec/cantango/api_spec.rb",
     "spec/cantango_api_spec.rb",
     "spec/fixtures/models.rb",
@@ -72,31 +88,33 @@ Gem::Specification.new do |s|
     "spec/helpers/current_users.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = "http://github.com/kristianmandrup/cantango-api"
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
-  s.summary = "The main API for CanTango"
+  s.homepage = %q{http://github.com/kristianmandrup/cantango-api}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{The main API for CanTango}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rails>, [">= 3.1"])
-      s.add_runtime_dependency(%q<sugar-high>, [">= 0.6.0"])
-      s.add_runtime_dependency(%q<sweetloader>, ["~> 0.1.0"])
-      s.add_runtime_dependency(%q<hashie>, [">= 0"])
-      s.add_runtime_dependency(%q<cantango-config>, [">= 0"])
+      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.6.2"])
+      s.add_runtime_dependency(%q<sweetloader>, ["~> 0.1.6"])
+      s.add_runtime_dependency(%q<hashie>, ["~> 1.2"])
+      s.add_runtime_dependency(%q<cantango-config>, [">= 0.1.8.1"])
+      s.add_runtime_dependency(%q<cantango-core>, [">= 0.1.9.1"])
       s.add_development_dependency(%q<bundler>, [">= 1.1.rc"])
       s.add_development_dependency(%q<jeweler>, [">= 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 2.6.0"])
     else
       s.add_dependency(%q<rails>, [">= 3.1"])
-      s.add_dependency(%q<sugar-high>, [">= 0.6.0"])
-      s.add_dependency(%q<sweetloader>, ["~> 0.1.0"])
-      s.add_dependency(%q<hashie>, [">= 0"])
-      s.add_dependency(%q<cantango-config>, [">= 0"])
+      s.add_dependency(%q<sugar-high>, ["~> 0.6.2"])
+      s.add_dependency(%q<sweetloader>, ["~> 0.1.6"])
+      s.add_dependency(%q<hashie>, ["~> 1.2"])
+      s.add_dependency(%q<cantango-config>, [">= 0.1.8.1"])
+      s.add_dependency(%q<cantango-core>, [">= 0.1.9.1"])
       s.add_dependency(%q<bundler>, [">= 1.1.rc"])
       s.add_dependency(%q<jeweler>, [">= 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
@@ -104,10 +122,11 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<rails>, [">= 3.1"])
-    s.add_dependency(%q<sugar-high>, [">= 0.6.0"])
-    s.add_dependency(%q<sweetloader>, ["~> 0.1.0"])
-    s.add_dependency(%q<hashie>, [">= 0"])
-    s.add_dependency(%q<cantango-config>, [">= 0"])
+    s.add_dependency(%q<sugar-high>, ["~> 0.6.2"])
+    s.add_dependency(%q<sweetloader>, ["~> 0.1.6"])
+    s.add_dependency(%q<hashie>, ["~> 1.2"])
+    s.add_dependency(%q<cantango-config>, [">= 0.1.8.1"])
+    s.add_dependency(%q<cantango-core>, [">= 0.1.9.1"])
     s.add_dependency(%q<bundler>, [">= 1.1.rc"])
     s.add_dependency(%q<jeweler>, [">= 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])

data/lib/cantango/api/ability/account.rb

@@ -1,21 +1,21 @@
 module CanTango::Api
   module Ability
     module Account
-      def user_account_ability user_account, options = {}
-        @account_ability ||= create_ability(user_account, ability_options.merge(options))
+      def account_ability account, options = {}
+        @account_ability ||= create_ability(account, ability_options.merge(options))
       end
-      alias_method :account_ability, :user_account_ability
 
       def current_account_ability user_type = :user
-        user_account_ability get_ability_user_account
+        account_ability(get_ability_account user_type)
       end
 
       protected
 
       include CanTango::Api::Common
+      include CanTango::Api::Attributes
       include CanTango::Api::Options
 
-      def get_ability_user_account user_type = :user
+      def get_ability_account user_type = :user
         account_meth = :"current_#{user_type}_account"
         return AbilityAccount.guest if !respond_to?(account_meth)
         AbilityAccount.resolve_account(send account_meth)
@@ -31,7 +31,7 @@ module CanTango::Api
         end
 
         def self.is_account? account
-          ::CanTango.config.user_accounts.registered_class? account.class
+          ::CanTango.config.accounts.registered_class? account.class
         end
 
         def self.guest

data/lib/cantango/api/ability/user.rb

@@ -12,6 +12,7 @@ module CanTango::Api
       protected
 
       include CanTango::Api::Common
+      include CanTango::Api::Attributes
       include CanTango::Api::Options
 
       def get_ability_user user_type

data/lib/cantango/api/account.rb

@@ -1,19 +1,17 @@
 module CanTango::Api
   module Account
-    module All
-      def self.included base
-        apis.each do |api|
-          base.send :include, clazz(api)
-        end
+    def self.included base
+      apis.each do |api|
+        base.send :include, clazz(api)
       end
+    end
 
-      def self.apis
-        [:ability, :can, :scope, :session]
-      end
+    def self.apis
+      [:ability, :can, :scope, :session]
+    end
 
-      def clazz api
-        "CanTango::Api::#{api.to_s.camelize}::UserAccount".constantize
-      end
+    def self.clazz api
+      "CanTango::Api::#{api.to_s.camelize}::Account".constantize
     end
   end
 end

data/lib/cantango/api/attributes.rb

@@ -2,7 +2,7 @@ module CanTango::Api
   module Attributes
     [:read, :edit].each do |action|
       define_method :"#{action}_attribute" do |name|
-        :"#{action}_attr_\#{name}"
+        :"#{action}_attr_#{name}"
       end
 
       define_method :"#{action}_attributes" do |*names|

data/lib/cantango/api/can/account.rb

@@ -1,13 +1,13 @@
 module CanTango::Api
   module Can
     module Account
-      include Ability
+      include CanTango::Api::Ability::Account
       # Example: generated from types of accounts! (see below)
       # def admin_account_can?(*args)
       #   current_account_ability(:admin).can?(*args)
       # end
       def self.included(base)
-        ::CanTango.config.user_accounts.registered.each do |account|
+        ::CanTango.config.accounts.registered.each do |account|
 
           # by default alias call to current_xxx_account to current_xxx (devise user method) unless already defined!
           unless base.methods.include? :"current_#{account}_account"

data/lib/cantango/api/can/dsl/relation.rb

@@ -0,0 +1,67 @@
+require 'active_support/inflector'
+
+module CanTango
+  module Dsl
+    class Relation
+      attr_reader :attribute, :permit, :scope, :models
+
+      include CanTango::Adaptor
+      include CanTango::CanCan::RuleClass
+
+      def initialize attribute, permit, scope, *models, &block
+        @attribute = attribute
+        @scope = scope
+        @permit = permit
+        @models = models
+
+        check_models
+        use_adaptor! self, user_scope
+      end
+
+      def can(action)
+        models.each do |model|
+          rules << rule_class.new(true, action, model, nil, condition_block(model))
+        end
+      end
+
+      def cannot(action)
+        models.each do |model|
+          rules << rule_class.new(false, action, model, nil, condition_block(model))
+        end
+      end
+
+      protected
+
+      def condition_block model
+        return attribute_condition(attribute, user_scope) if model.new.respond_to?(attribute)
+        return include_condition(plural_attribute, user_scope) if model.new.respond_to?(plural_attribute)
+      end
+
+      def user_scope
+        @user_scope ||= (scope == :account) ? permit.user_account : permit.user
+      end
+
+      def scope_key
+        @scope_key ||= (scope == :account) ? :user_account : :user
+      end
+
+      def ability
+        permit.ability
+      end
+
+      def rules
+        ability.send :rules
+      end
+
+      def plural_attribute
+        :"#{attribute.to_s.pluralize}"
+      end
+
+      def check_models
+        models.each do |model|
+          raise "#{model} has no :#{attribute} or :#{plural_attribute} defined" if !model.new.respond_to?(attribute) && !model.new.respond_to?(plural_attribute)
+        end
+      end
+    end
+  end
+end

data/lib/cantango/api/can/dsl/scope.rb

@@ -0,0 +1,24 @@
+module CanTango
+  module Dsl
+    class Scope
+      attr_reader :name, :permit
+
+      def initialize name, permit, &block
+        @name = name.to_sym
+        @permit = permit
+      end
+
+      ::CanTango.config.user.relations.each do |relationship|
+        class_eval %{
+          def #{relationship}_of *models, &block
+            options = models.extract_options!
+            scope = options[:scope] || name
+            relation = UserRelation.new :#{relationship}, permit, scope, models, &block
+            yield relation if block
+            relation
+          end
+        }
+      end
+    end
+  end
+end

data/lib/cantango/api/can/dsl.rb

@@ -0,0 +1,26 @@
+module CanTango::Api
+  module Can
+    module Dsl
+      autoload_modules :Relation, :Scope
+      
+      def self.included(base)
+        ::CanTango.config.user.relations.each do |relationship|
+          base.class_eval %{
+            def #{relationship}_of *models, &block
+              options = models.extract_options!
+              scope = options[:scope] || :user_account
+              relation = Relation.new :#{relationship}, self, scope, *models, &block
+              yield relation if block
+              relation
+            end
+          }
+        end
+      end
+
+      # creates a scope that enforces either using the user or user_account for determining relationship matches on the models
+      def scope name, &block
+        yield Scope.new name, self, &block
+      end
+    end
+  end
+end

data/lib/cantango/api/can/user.rb

@@ -2,7 +2,7 @@ module CanTango
   module Api
     module Can
       module User
-        include Ability
+        include CanTango::Api::Ability::User
         # Example: generated from types of accounts! (see below)
         # def admin_can?(*args)
         #   current_user_ability(:admin).can?(*args)

data/lib/cantango/api/can.rb

@@ -1,5 +1,5 @@
 module CanTango::Api
   module Can
-    autoload_modules :User, :Account
+    autoload_modules :User, :Account, :Dsl
   end
 end

data/lib/cantango/api/common.rb

@@ -1,14 +1,27 @@
 module CanTango::Api
   module Common
-    include CanTango::Api::Attributes
-
     def create_ability candidate, opts = {}
-      CanTango.config.ability.factory_build candidate, opts
+      ability = default_ability_class.new candidate, opts
+      config.ability.factory_build ability, opts.merge(:modes => execution_modes)
     end
 
     def category label
       config.models.by_category label
     end
+    
+    protected
+
+    def default_ability_class
+      CanTango.config.ability.default_class
+    end
+
+    def execution_modes
+      CanTango.config.ability.modes || [:no_cache]
+    end
+    
+    def config
+      CanTango.config
+    end
   end
 end
 

data/lib/cantango/api/model/account.rb

@@ -3,8 +3,8 @@ module CanTango::Api
     module Account
       attr_writer :active_user, :active_account, :ability_class
 
-      def self.included(base)
-        CanTango.config.users.register base
+      def self.included(clazz)
+        CanTango.config.accounts.register_account clazz
       end
 
       def active_user
@@ -17,23 +17,16 @@ module CanTango::Api
         @active_account || self
       end
 
-      def can? *args
-        ability.can?(*args)
-      end
-
-      def cannot? *args
-        ability.cannot?(*args)
-      end
+      # from sugar-high or Active Support
+      delegate :can?, :cannot?, :to => :ability
 
       protected
     
-      def ability
-        ability_class.new(active_account)
-      end
-    
-      def ability_class
-        CanTango::Ability::Executor::Modes
-      end
+      include CanTango::Api::Common
+
+      def ability opts = {}
+        create_ability active_account, opts = {}
+      end  
     end
   end
 end