social_connections 0.0.4 → 0.0.5

data/README

@@ -0,0 +1,57 @@
+= SocialConnections
+
+Enables
+
+* Social connections between people and things: list of friends, things you like, stuff you recommend.
+* Activities on those things which are recorded for later processing
+* Digest mechanism to digest those activities, e.g. for daily digest emails.
+
+This gem is work in progress and my playground, and currently my playground, don't use it!
+
+
+== Setup
+
+Install as a gem
+
+  gem install social_connections
+
+or reference in your Gemfile
+
+  gem 'social_connections'
+
+and run
+
+  bundle install
+
+
+Next, you need to add the migration. This works currently by executing
+
+  rake db:migrate:social_connections
+
+which adds the required tables.
+
+Now, every model that is supposed to act as a connectable thing (so that friends can connect
+other friend or users can like books), add to all those models
+
+  acts_as_connectable :verbs => [ :likes, :recommends, :comments ]
+
+where the verbs specify what you want to allow those connectables to do to other connectables.
+See the example below, that may make it clearer.
+
+== Example
+
+TODO: Example goes here.
+
+
+== How to run the Tests (in the gem itself, not in your Rails app)
+
+Run test in ./test:
+
+  rake
+
+Run specs in ./spec:
+
+  rspec spec
+
+
+Copyright (c) 2011 Chris Oloff, released under the MIT license

data/lib/social_connections/acts_as_connectable.rb

@@ -5,6 +5,10 @@ module SocialConnections
   end
 
   module ClassMethods
+    # Enables an ActiveRecord model to act as a connectable.
+    # Recognized options:
+    # * :verbs - specify a list of constants recognized as verbs.
+    #   If none given, :likes is the only default verb.
     def acts_as_connectable(options = {})
       cattr_accessor :acts_as_connectable_options
       send :acts_as_connectable_options=, options

data/lib/social_connections/version.rb

@@ -1,3 +1,3 @@
 module SocialConnections
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -2,7 +2,7 @@
 name: social_connections
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Chris
@@ -28,7 +28,7 @@ files:
 - .yardopts
 - Gemfile
 - MIT-LICENSE
-- README.markdown
+- README
 - Rakefile
 - db/keep-this-dir.txt
 - init.rb

data/README.markdown

@@ -1,19 +0,0 @@
-# @markup markdown
-# @title Social Connections and Activity Feeds for Rails Applications
-
-# Social Connections #
-
-Is this proper markdown? Dunno whats going on.
-
-Can we
-
-* have
-* a list here?
-
-And is the following some example code?
-
-    rake db:migrate:social_connections
-    rails generate blablabla
-
-Still playing around with this...
-