camaraderie 0.1.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2013, Mirego
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+- Neither the name of the Mirego nor the names of its contributors may
+  be used to endorse or promote products derived from this software without
+  specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,68 @@
+# Camaraderie
+
+Camaraderie takes away the pain of managing membership stuff between users and organizations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'camaraderie'
+```
+
+Then run the task to generate the migration:
+
+```bash
+$ rails generate camaraderie:install
+```
+
+## Usage
+
+First, you have to configure which type of memberships you want. Usually, you’d do this in `./config/initializers/camaraderie.rb`:
+
+```ruby
+Camaraderie.configure do |config|
+  config.membership_types = %w(admin moderator member)
+end
+```
+
+Then, you can include the two provided modules into your `User`, `Organization` and `Membership` models:
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_user
+end
+
+class Organization < ActiveRecord::Base
+  acts_as_organization
+end
+
+class Membership < ActiveRecord::Base
+  acts_as_membership
+end
+```
+
+You’re pretty much done after that. You’re now able to do this:
+
+```ruby
+user = User.find(1)
+organization = Organization.find(1)
+
+# Add the user as an admin
+organization.admins.create(user: user)
+
+# Add the user as a regular member
+organization.members.create(user: user)
+
+# Check whether the user is an admin
+user.admin_of?(organization)
+# => true
+```
+
+## License
+
+`Camaraderie` is © 2013 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/camaraderie/blob/master/LICENSE.md) file.
+
+## About Mirego
+
+Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We proudly built mobile applications for [iPhone](http://mirego.com/en/iphone-app-development/ "iPhone application development"), [iPad](http://mirego.com/en/ipad-app-development/ "iPad application development"), [Android](http://mirego.com/en/android-app-development/ "Android application development"), [Blackberry](http://mirego.com/en/blackberry-app-development/ "Blackberry application development"), [Windows Phone](http://mirego.com/en/windows-phone-app-development/ "Windows Phone application development") and [Windows 8](http://mirego.com/en/windows-8-app-development/ "Windows 8 application development").

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/camaraderie.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'camaraderie/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'camaraderie'
+  spec.version       = Camaraderie::VERSION
+  spec.authors       = ['Rémi Prévost']
+  spec.email         = ['rprevost@mirego.com']
+  spec.description   = 'Camaraderie takes away the pain of managing membership stuff between users and organizations.'
+  spec.summary       = 'Camaraderie takes away the pain of managing membership stuff between users and organizations.'
+  spec.homepage      = 'https://github.com/mirego/camaraderie'
+  spec.license       = 'BSD 3-Clause'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'activerecord', '>= 3.0.0'
+  spec.add_dependency 'activesupport', '>= 3.0.0'
+end

data/lib/camaraderie/membership.rb

@@ -0,0 +1,24 @@
+module Camaraderie
+  module Membership
+    extend ActiveSupport::Concern
+    included do
+      # Associations
+      belongs_to :user, validate: true
+      belongs_to :organization
+
+      # Validations
+      validates :user, presence: true
+      validates :organization, presence: true
+      validates :membership_type, presence: true, inclusion: { in: Camaraderie.membership_types }, uniqueness: { scope: [:user_id, :organization_id] }
+
+      # Scopes
+      Camaraderie.membership_types.each do |type|
+        scope type.pluralize, lambda { where(membership_type: type) }
+      end
+
+      # Nested attributes
+      accepts_nested_attributes_for :user
+      accepts_nested_attributes_for :organization
+    end
+  end
+end

data/lib/camaraderie/organization.rb

@@ -0,0 +1,24 @@
+module Camaraderie
+  module Organization
+    extend ActiveSupport::Concern
+
+    included do
+      # Associations
+      has_many :memberships, dependent: :destroy
+      has_many :users, through: :memberships
+
+      # Define a method for each type of membership
+      #
+      # @example
+      #   user = User.new(email: 'foo@example.com')
+      #   Organization.first.admins.create(user: user)
+      Camaraderie.membership_types.each do |type|
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{type.pluralize}
+            memberships.#{type.pluralize}
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/camaraderie/railtie.rb

@@ -0,0 +1,10 @@
+require 'camaraderie'
+require 'rails'
+
+module Camaraderie
+  class Railtie < Rails::Railtie
+    initializer 'camaraderie.active_record' do |app|
+      ActiveSupport.on_load :active_record, {}, &Camaraderie.inject_into_active_record
+    end
+  end
+end

data/lib/camaraderie/user.rb

@@ -0,0 +1,19 @@
+module Camaraderie
+  module User
+    extend ActiveSupport::Concern
+
+    included do
+      # Associations
+      has_many :memberships, dependent: :destroy
+      has_many :organizations, through: :memberships
+
+      Camaraderie.membership_types.each do |type|
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{type}_of?(organization)
+            !!memberships.admins.where(organization: organization).exists?
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/camaraderie/version.rb

@@ -0,0 +1,3 @@
+module Camaraderie
+  VERSION = '0.1.2'
+end

data/lib/camaraderie.rb

@@ -0,0 +1,37 @@
+require 'camaraderie/version'
+
+require 'camaraderie/user'
+require 'camaraderie/organization'
+require 'camaraderie/membership'
+
+module Camaraderie
+  # Yield a block to edit the @configuration variable
+  def self.configure
+    @configuration = OpenStruct.new
+    yield(@configuration)
+  end
+
+  # Return the allowed membership types
+  def self.membership_types
+    @configuration.membership_types
+  end
+
+  # Return a block that can be injected into a class
+  def self.inject_into_active_record
+    @inject_into_active_record ||= Proc.new do
+      def self.acts_as_user
+        self.send :include, Camaraderie::User
+      end
+
+      def self.acts_as_organization
+        self.send :include, Camaraderie::Organization
+      end
+
+      def self.acts_as_membership
+        self.send :include, Camaraderie::Membership
+      end
+    end
+  end
+end
+
+require 'camaraderie/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3

data/lib/generators/camaraderie/USAGE

@@ -0,0 +1,4 @@
+Description:
+  The camaraderie:install generator generates a migration that will
+  create the `memberships` table in your database. It will also
+  create a blank `Membership` model file.

data/lib/generators/camaraderie/install_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Camaraderie
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime('%Y%m%d%H%M%S')
+        else
+         '%.3d' % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def create_migration_file
+        migration_template 'migration.rb', 'db/migrate/add_camaraderie.rb'
+      end
+
+      def create_model_file
+        template "model.rb", "app/models/membership.rb"
+      end
+    end
+  end
+end

data/lib/generators/camaraderie/templates/migration.rb

@@ -0,0 +1,20 @@
+class AddCamaraderie < ActiveRecord::Migration
+  def up
+    create_table :memberships do |t|
+      t.references :user
+      t.references :organization
+      t.string :membership_type
+
+      t.timestamps
+    end
+
+    add_index "memberships", ["organization_id", "membership_type"], name: "index_memberships_on_organization_id_and_membership_type"
+    add_index "memberships", ["organization_id", "user_id", "membership_type"], name: "index_memberships_on_everything", unique: true
+    add_index "memberships", ["organization_id"], name: "index_memberships_on_organization_id"
+    add_index "memberships", ["user_id"], name: "index_memberships_on_user_id"
+  end
+
+  def down
+    drop_table :memberships
+  end
+end

data/lib/generators/camaraderie/templates/model.rb

@@ -0,0 +1,3 @@
+class Membership < ActiveRecord::Base
+  acts_as_membership
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: camaraderie
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Rémi Prévost
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Camaraderie takes away the pain of managing membership stuff between
+  users and organizations.
+email:
+- rprevost@mirego.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- camaraderie.gemspec
+- lib/camaraderie.rb
+- lib/camaraderie/membership.rb
+- lib/camaraderie/organization.rb
+- lib/camaraderie/railtie.rb
+- lib/camaraderie/user.rb
+- lib/camaraderie/version.rb
+- lib/generators/camaraderie/USAGE
+- lib/generators/camaraderie/install_generator.rb
+- lib/generators/camaraderie/templates/migration.rb
+- lib/generators/camaraderie/templates/model.rb
+homepage: https://github.com/mirego/camaraderie
+licenses:
+- BSD 3-Clause
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4019266767070009919
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4019266767070009919
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Camaraderie takes away the pain of managing membership stuff between users
+  and organizations.
+test_files: []