narrator 0.0.1.alpha

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/.rspec

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

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  #- jruby-18mode # JRuby in 1.8 mode
+  #- jruby-19mode # JRuby in 1.9 mode
+  #- rbx-18mode
+  #- rbx-19mode
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec
+
+# whitelist
+branches:
+  only:
+    - master

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1alpha
+
+* pre-release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in narrator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Joe Weakley
+
+MIT License
+
+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.rdoc

@@ -0,0 +1,32 @@
+= Narrator {<img src="https://secure.travis-ci.org/jweakley/narrator.png?branch=master" />}[http://travis-ci.org/jweakley/narrator]
+
+Narrator is an activity library for Ruby on Rails that allow you to track what is happening on models and later use to build an activity or news stream. Tracking is done at the controller level with a simple narrate_resource command (which was inspired by the simplicity of Ryan Bates' CanCan gem).
+
+== Installation
+
+In <b> Rails 3 </b> add this line to your application's Gemfile and run the +bundle+ command.
+
+    gem "narrator"
+
+== Getting Started
+
+* Coming Soon
+
+== Wiki Docs
+
+* Coming Soon
+
+== Questions or Problems?
+
+If you have any issues with Narrator which you cannot find the answer in the documentation[https://github.com/jweakley/narrator/wiki], please add an {issue on GitHub}[https://github.com/jweakley/narrator/issues]. Alternatively you can fork the project and send a pull request (limit one high five and/or fist bump per contribution).
+
+Please ensure the tests are passing by running `bundle` and `rake`.
+
+== Special Thanks
+
+Narrator was inspired in part by Ryan Bates railcasts and CanCan[https://github.com/ryanb/cancan].
+
+Internet high fives and/or fist bumps to the Narrator contributors[https://github.com/jweakley/narrator/contributors].
+
+
+This gem is created by Joe Weakley and is under the MIT License.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/generators/narrator/activity/USAGE

@@ -0,0 +1,4 @@
+Description:
+  The narrator:activity generator creates an Activity class in the models
+  directory. You can move this file anywhere you want as long as it
+  is in the load path.

data/lib/generators/narrator/activity/activity_generator.rb

@@ -0,0 +1,11 @@
+module Narrator
+  module Generators
+    class ActivityGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_ability
+        copy_file "activity.rb", "app/models/activity.rb"
+      end
+    end
+  end
+end

data/lib/generators/narrator/activity/templates/activity.rb

@@ -0,0 +1,30 @@
+class Activity
+    include Narrator::Activity
+    ###
+    # Attribute accessible
+    ###
+      attr_accessible :owner, :subject, :actor, :target, :target_id, :target_type, :verb, :context, :has_seen
+
+    ###
+    # Associations
+    ###
+      belongs_to :owner, class_name: 'UserProfile'
+      belongs_to :actor, class_name: 'UserProfile'
+      belongs_to :subject, polymorphic: true
+      belongs_to :target, polymorphic: true
+
+    ###
+    # Validate
+    ###
+      validates :owner, presence: true
+      validates :subject, presence: true
+      validates :verb, presence: true
+
+    ###
+    # Scopes
+    ###
+      scope :unseen, where{has_seen.eq false}
+      scope :seen, where{has_seen.eq true}
+      scope :recent, order('created_at DESC')
+
+end

data/lib/narrator/activity.rb

@@ -0,0 +1,4 @@
+module Narrator
+  module Activity
+  end
+end

data/lib/narrator/controller_additions.rb

@@ -0,0 +1,31 @@
+module Narrator
+  module ControllerAdditions
+    module ClassMethods
+
+      def narrate_resource(*args)
+        narrator_resource_class.add_before_filter(self, :narrate_resource, *args)
+      end
+
+      def narrate(subject, target = nil, verb = params[:action], actor_id = current_user.user_profile_id)
+        if user_signed_in?
+          subject.class.delay.track_user_activity(subject.id, actor_id, target.class.to_s, (target.blank? ? nil : target.id), verb.to_s)
+        end
+      end
+
+      def narrator_resource_class
+          ControllerResource
+      end
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+    end
+  end
+end
+
+if defined? ActionController::Base
+  ActionController::Base.class_eval do
+    include Narrator::ControllerAdditions
+  end
+end

data/lib/narrator/controller_resource.rb

@@ -0,0 +1,30 @@
+module Narrator
+  class ControllerResource
+
+    def initialize(controller, *args)
+      @controller = controller
+      @params = controller.params
+      @options = args.extract_options!
+      @name = args.first
+    end
+
+    def narrate_resource
+      # TODO Add skipper for this method
+      @controller.narrate(subject, nil, params[:action], current_user)
+    end
+
+    protected
+
+    def current_user
+      @controller.send(:current_user)
+    end
+
+    def resource_class
+      case @options[:class]
+      when String then @options[:class].constantize
+      else @options[:class]
+      end
+    end
+
+  end
+end

data/lib/narrator/version.rb

@@ -0,0 +1,3 @@
+module Narrator
+  VERSION = "0.0.1.alpha"
+end

data/lib/narrator.rb

@@ -0,0 +1,9 @@
+require 'narrator/ability'
+require 'narrator/controller_resource'
+require 'narrator/controller_additions'
+
+require "narrator/version"
+
+module Narrator
+  # Your code goes here...
+end

data/narrator.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'narrator/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "narrator"
+  gem.version       = Narrator::VERSION
+  gem.authors       = ["Joe Weakley"]
+  gem.email         = ["joe.weakley@digitalaugment.com"]
+  gem.description   = %q{Straightforward and flexable activity tracking for rails that is designed to be fast and scalable.}
+  gem.summary       = %q{Straightforward and flexable activity tracking for rails.}
+  gem.homepage      = "https://github.com/jweakley/narrator"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"
+end

data/spec/narrator/narrator_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Narrator do
+  pending "Add moar tests!"
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "narrator"

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: narrator
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- Joe Weakley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Straightforward and flexable activity tracking for rails that is designed
+  to be fast and scalable.
+email:
+- joe.weakley@digitalaugment.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/generators/narrator/activity/USAGE
+- lib/generators/narrator/activity/activity_generator.rb
+- lib/generators/narrator/activity/templates/activity.rb
+- lib/narrator.rb
+- lib/narrator/activity.rb
+- lib/narrator/controller_additions.rb
+- lib/narrator/controller_resource.rb
+- lib/narrator/version.rb
+- narrator.gemspec
+- spec/narrator/narrator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jweakley/narrator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Straightforward and flexable activity tracking for rails.
+test_files:
+- spec/narrator/narrator_spec.rb
+- spec/spec_helper.rb