cantango-api 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,36 @@
+source :rubygems
+
+group :default do
+  gem 'rails', '>= 3.1'
+  gem 'sugar-high',       '>= 0.6.0'
+  gem 'sweetloader',      '~> 0.1.0'
+  gem 'hashie'
+  
+  gem 'cantango-config',  :git => 'git://github.com/kristianmandrup/cantango-config.git'
+end
+
+group :development do
+  gem "bundler",  ">= 1.1.rc"
+  gem "jeweler",  ">= 1.6.4"
+  gem "rcov", ">= 0"
+end
+
+group :test do
+  gem 'require_all', '~> 1.2.0'
+
+  gem 'forgery'
+  gem 'sqlite3'
+  # Data
+  gem 'database_cleaner'
+  gem 'factory_girl'
+
+  # Specs
+  gem 'spork'
+
+  # Debug and performance tests
+  gem 'cutter'
+end
+
+group :test, :development do
+  gem "rspec",    ">= 2.6.0"
+end

data/Gemfile.lock

@@ -0,0 +1,152 @@
+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:
+    actionmailer (3.1.3)
+      actionpack (= 3.1.3)
+      mail (~> 2.3.0)
+    actionpack (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.5)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.3)
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    builder (3.0.0)
+    cancan (1.6.7)
+    cantango-core (0.1.0)
+      cancan (>= 1.4)
+      hashie
+      rails (>= 3.0.1)
+      sugar-high (>= 0.6.0)
+      sweetloader (~> 0.1.0)
+    colorize (0.5.8)
+    cutter (0.8.2)
+      activesupport (>= 2.3.5)
+      colorize (>= 0.5)
+    database_cleaner (0.7.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    factory_girl (2.3.1)
+      activesupport
+    forgery (0.5.0)
+    git (1.2.5)
+    hashie (1.2.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.1)
+    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)
+    polyglot (0.3.3)
+    rack (1.3.5)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.3)
+      actionmailer (= 3.1.3)
+      actionpack (= 3.1.3)
+      activerecord (= 3.1.3)
+      activeresource (= 3.1.3)
+      activesupport (= 3.1.3)
+      bundler (~> 1.0)
+      railties (= 3.1.3)
+    railties (3.1.3)
+      actionpack (= 3.1.3)
+      activesupport (= 3.1.3)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rdoc (3.11)
+      json (~> 1.4)
+    require_all (1.2.0)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    spork (0.8.5)
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.4)
+    sugar-high (0.6.0)
+      activesupport (>= 3.0.1)
+    sweetloader (0.1.1)
+      activesupport (>= 3.0.1)
+      i18n
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.1.rc)
+  cantango-config!
+  cutter
+  database_cleaner
+  factory_girl
+  forgery
+  hashie
+  jeweler (>= 1.6.4)
+  rails (>= 3.1)
+  rcov
+  require_all (~> 1.2.0)
+  rspec (>= 2.6.0)
+  spork
+  sqlite3
+  sugar-high (>= 0.6.0)
+  sweetloader (~> 0.1.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kristian Mandrup
+
+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.

data/README.mdown

@@ -0,0 +1,19 @@
+# CanTango Api
+
+The main API for [CanTango](https://github.com/kristianmandrup/cantango)
+
+## 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
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Kristian Mandrup. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "cantango-api"
+  gem.homepage = "http://github.com/kristianmandrup/cantango-api"
+  gem.license = "MIT"
+  gem.summary = %Q{The main API for CanTango}
+  gem.description = %Q{Ability, Can, Scope, Session, User, Account and more APIs for CanTango}
+  gem.email = "kristian@unity3d.com"
+  gem.authors = ["Kristian Mandrup"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cantango-api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/cantango-api.gemspec

@@ -0,0 +1,117 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "cantango-api"
+  s.version = "0.0.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.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.mdown"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.mdown",
+    "Rakefile",
+    "VERSION",
+    "cantango-api.gemspec",
+    "lib/cantango/api.rb",
+    "lib/cantango/api/ability.rb",
+    "lib/cantango/api/ability/account.rb",
+    "lib/cantango/api/ability/user.rb",
+    "lib/cantango/api/account.rb",
+    "lib/cantango/api/attributes.rb",
+    "lib/cantango/api/can.rb",
+    "lib/cantango/api/can/account.rb",
+    "lib/cantango/api/can/user.rb",
+    "lib/cantango/api/common.rb",
+    "lib/cantango/api/model.rb",
+    "lib/cantango/api/model/account.rb",
+    "lib/cantango/api/model/user.rb",
+    "lib/cantango/api/options.rb",
+    "lib/cantango/api/scope.rb",
+    "lib/cantango/api/scope/account.rb",
+    "lib/cantango/api/scope/user.rb",
+    "lib/cantango/api/session.rb",
+    "lib/cantango/api/session/account.rb",
+    "lib/cantango/api/session/user.rb",
+    "lib/cantango/api/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/options_spec.rb",
+    "spec/cantango/api/scope/account_spec.rb",
+    "spec/cantango/api/scope/user_spec.rb",
+    "spec/cantango/api/user_spec.rb",
+    "spec/cantango/api_spec.rb",
+    "spec/cantango_api_spec.rb",
+    "spec/fixtures/models.rb",
+    "spec/fixtures/models/admin.rb",
+    "spec/fixtures/models/admin_account.rb",
+    "spec/fixtures/models/items.rb",
+    "spec/fixtures/models/permission.rb",
+    "spec/fixtures/models/project.rb",
+    "spec/fixtures/models/simple_roles.rb",
+    "spec/fixtures/models/user.rb",
+    "spec/fixtures/models/user_account.rb",
+    "spec/helpers/current_user_accounts.rb",
+    "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"
+
+  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_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<bundler>, [">= 1.1.rc"])
+      s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.6.0"])
+    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<bundler>, [">= 1.1.rc"])
+    s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.6.0"])
+  end
+end
+

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

@@ -0,0 +1,46 @@
+module CanTango::Api
+  module Ability
+    module Account
+      def user_account_ability user_account, options = {}
+        @account_ability ||= create_ability(user_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
+      end
+
+      protected
+
+      include CanTango::Api::Common
+      include CanTango::Api::Options
+
+      def get_ability_user_account user_type = :user
+        account_meth = :"current_#{user_type}_account"
+        return AbilityAccount.guest if !respond_to?(account_meth)
+        AbilityAccount.resolve_account(send account_meth)
+     end
+
+      module AbilityAccount
+        # test if current_xxx actually returns an account and not a user instance!
+        # if so call the #account method on the user
+        def self.resolve_account obj
+          return obj if AbilityAccount.is_account?(obj)
+          return resolve_account(obj.send(:account)) if obj.respond_to?(:account)
+          guest
+        end
+
+        def self.is_account? account
+          ::CanTango.config.user_accounts.registered_class? account.class
+        end
+
+        def self.guest
+          account = CanTango.config.guest.account
+
+          raise "You must set the guest_account to a Proc or lambda in CanTango.config" if !account
+          account.respond_to?(:call) ? account.call : account
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module CanTango::Api
+  module Ability
+    module User
+      def user_ability user, options = {}
+        create_ability(user, ability_options.merge(options))
+      end
+
+      def current_user_ability user_type = :user
+        user_ability get_ability_user(user_type)
+      end
+
+      protected
+
+      include CanTango::Api::Common
+      include CanTango::Api::Options
+
+      def get_ability_user user_type
+        user_meth = :"current_#{user_type}"
+        return AbilityUser.guest if !respond_to?(user_meth)
+        AbilityUser.resolve_user(send user_meth)
+     end
+
+      module AbilityUser
+        # test if current_xxx actually returns an account and not a user instance!
+        # if so call the #user method on the account
+        def self.resolve_user obj
+          return obj if is_user?(obj)
+          return resolve_user(obj.send(:user)) if obj.respond_to? :user
+          guest
+        end
+
+        def self.is_user? user
+          ::CanTango.config.users.registered_class? user.class
+        end
+
+        def self.guest
+          user = CanTango.config.guest.user
+
+          raise "You must set the guest_user to a Proc or lambda in CanTango.config" if !user
+          user.respond_to?(:call) ? user.call : user
+        end
+      end
+    end
+  end
+end

data/lib/cantango/api/ability.rb

@@ -0,0 +1,5 @@
+module CanTango::Api
+  module Ability
+    autoload_modules :User, :Account
+  end
+end

data/lib/cantango/api/account.rb

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

data/lib/cantango/api/attributes.rb

@@ -0,0 +1,15 @@
+module CanTango::Api
+  module Attributes
+    [:read, :edit].each do |action|
+      define_method :"#{action}_attribute" do |name|
+        :"#{action}_attr_\#{name}"
+      end
+
+      define_method :"#{action}_attributes" do |*names|
+        names.select_symbols.map { |name| send("#{action}_attribute", name) }
+      end
+    end
+  end
+end
+
+

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

@@ -0,0 +1,32 @@
+module CanTango::Api
+  module Can
+    module Account
+      include Ability
+      # 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|
+
+          # by default alias call to current_xxx_account to current_xxx (devise user method) unless already defined!
+          unless base.methods.include? :"current_#{account}_account"
+            define_method :"current_#{account}_account" do
+              send :"current_#{account}"
+            end
+          end
+
+          base.class_eval %{
+            def #{account}_account_can? *args
+              current_account_ability(:#{account}).can?(*args)
+            end
+
+            def #{account}_account_cannot? *args
+              current_account_ability(:#{account}).cannot?(*args)
+            end
+           }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module CanTango
+  module Api
+    module Can
+      module User
+        include Ability
+        # Example: generated from types of accounts! (see below)
+        # def admin_can?(*args)
+        #   current_user_ability(:admin).can?(*args)
+        # end
+        def self.included(base)
+          ::CanTango.config.users.registered.each do |user|
+            base.class_eval %{
+              def #{user}_can? *args
+                current_user_ability(:#{user}).can?(*args)
+              end
+
+              def #{user}_cannot? *args
+                current_user_ability(:#{user}).cannot?(*args)
+              end
+             }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cantango/api/can.rb

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

data/lib/cantango/api/common.rb

@@ -0,0 +1,14 @@
+module CanTango::Api
+  module Common
+    include CanTango::Api::Attributes
+
+    def create_ability candidate, opts = {}
+      CanTango.config.ability.factory_build candidate, opts
+    end
+
+    def category label
+      config.models.by_category label
+    end
+  end
+end
+

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

@@ -0,0 +1,39 @@
+module CanTango::Api
+  module Model
+    module Account
+      attr_writer :active_user, :active_account, :ability_class
+
+      def self.included(base)
+        CanTango.config.users.register base
+      end
+
+      def active_user
+        return @active_user if  @active_user
+        return send(:user) if respond_to? :user
+        raise "No user could be found for account: #{self}"
+      end
+
+      def active_account
+        @active_account || self
+      end
+
+      def can? *args
+        ability.can?(*args)
+      end
+
+      def cannot? *args
+        ability.cannot?(*args)
+      end
+
+      protected
+    
+      def ability
+        ability_class.new(active_account)
+      end
+    
+      def ability_class
+        CanTango::Ability::Executor::Modes
+      end
+    end
+  end
+end