Rfizzy 0.1.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,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "redis"
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.6.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "autotest"
+  gem "syntax"
+  gem "reek", "~> 1.2.8"
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.5.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    redis (2.2.1)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.6)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.5)
+    syntax (1.0.0)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  redis
+  reek (~> 1.2.8)
+  rspec (~> 2.6.0)
+  syntax
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright © 2011 Seifvan Heifdari af Awesomeness Von Cheeseburger
+
+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. By reading this fine print your soul is now the exclusive property of Seivan Heidari Productions and its Subsidiaries. Unauthorized use of seivan gems, images, materials, souls, odors and oxygen is strongly discouraged. We know where you sleep. Also, your mum & bring back prop8

data/README.rdoc

@@ -0,0 +1,75 @@
+= Rfizzy http://travis-ci.org/seivan/Rfizzy.png
+
+A ruby library utilizing Redis for; 
+* Full text search engine with Redis.
+* Taggingging library
+* Social Graph with friends, followers, followees and etc.  (not in 0.1.0, gotta pick your battles )
+
+### Key Features
+# * Very unobtrusiv
+# * Very easy to add to a project
+# * Very easy to remove from a project
+# * Small memory foot print, 
+# * very tiny code base compared to other libraries and in contrast to what it adds to a project
+# * Fast
+# * No learning curve
+# * Works with any ORMs out of the box...
+# * ... Since it's not attached to any of ORMs
+# ***
+
+
+
+Works in all Ruby projects, regardless of ORM as long as an attribute has a way to identify it (e.g ID column). 
+Very simple built, source code is < 100 loc and has full test coverage. 
+Easy to tap into any project without high learning curve or code breakage. Easy to remove as well.
+VERY unobtrusive.
+
+== Introduction
+class Tweet < ActiveRecord::Base 
+  after_create :create_search_index
+  before_destroy :destroy_search_index
+  
+  private
+  def create_search_index
+    FullTextSearch.create_index :attribute_namespace => :tweet_text_content,
+                                :document_id => id,
+                                :words => text_content
+                              
+  end
+  
+  def destroy_search_index
+    FullTextSearch.destroy_index  :attribute_namespace => :tweet_text_content,
+                                  :document_id => id,
+                                  :words => text_content
+    
+  end
+end
+
+
+set_of_ids = FullTextSearch.search_index :attribute_namespace => :article_text,
+                                         :search => text_content
+                                         
+Article.where(:id => set_of_ids)
+  
+== Contributing to Rfizzy
+ 
+* Make sure you got Redis running locally on standard port
+* Make sure you can have up to 10 databases with redis, since the test suite uses db 10
+* Check out the latest develop 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/my_feature or hotfix/ 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 © 2011 Seifvan Heifdari af Awesomeness Von Cheeseburger
+
+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 NON-INFRINGEMENT. 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. By not reading this fine print your soul is now the exclusive property of Seivan Heidari Productions and its Subsidiaries. Unauthorized use of Seivans code, images, materials, souls, odors and oxygen is strongly discouraged. We know where you sleep. Also, I might have banged your mums pool boy. Sorry about that.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# 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 = "Rfizzy"
+  gem.homepage = "http://github.com/seivan/Rfizzy"
+  gem.license = "MIT"
+  gem.summary = %Q{Full text search engine with Redis. Works in all Ruby projects}
+  gem.description = %Q{Full text search engine with Redis. Works in all Ruby projects. Very simple built, source code is < 300loc including tests. Was built because it's cheaper to go with the 20mb Redis solution with redis than using PostgreSQL's full text search. Also I needed background jobs and might as well use Resque for that.}
+  gem.email = "seivan@kth.se"
+  gem.authors = ["Seivan Heidari"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+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
+  spec.rspec_opts = ["--color", "--format", "documentation", "--tag"]
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/Rfizzy.gemspec

@@ -0,0 +1,92 @@
+# 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 = %q{Rfizzy}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Seivan Heidari"]
+  s.date = %q{2011-07-18}
+  s.description = %q{Full text search engine with Redis. Works in all Ruby projects. Very simple built, source code is < 300loc including tests. Was built because it's cheaper to go with the 20mb Redis solution with redis than using PostgreSQL's full text search. Also I needed background jobs and might as well use Resque for that.}
+  s.email = %q{seivan@kth.se}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "Rfizzy.gemspec",
+    "VERSION",
+    "docs/FullTextSearch.html",
+    "docs/Tagging.html",
+    "docs/docco.css",
+    "docs/installation_and_setup.html",
+    "example_usage/FullTextSearch.rb",
+    "example_usage/Tagging.rb",
+    "example_usage/installation_and_setup.rb",
+    "lib/Rfizzy.rb",
+    "spec/.DS_Store",
+    "spec/initialization/rfizzy_searching_initialize_spec.rb",
+    "spec/searching/.DS_Store",
+    "spec/searching/rfizzy_searching_create_spec.rb",
+    "spec/searching/rfizzy_searching_destroy_spec.rb",
+    "spec/searching/rfizzy_searching_search_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/.DS_Store",
+    "spec/support/Factories/search_factories.rb",
+    "spec/support/Factories/tagging_factories.rb",
+    "spec/tagging/rfizzy_tagging_create_spec.rb",
+    "spec/tagging/rfizzy_tagging_search_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/seivan/Rfizzy}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Full text search engine with Redis. Works in all Ruby projects}
+
+  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<redis>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<autotest>, [">= 0"])
+      s.add_development_dependency(%q<syntax>, [">= 0"])
+      s.add_development_dependency(%q<reek>, ["~> 1.2.8"])
+    else
+      s.add_dependency(%q<redis>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<autotest>, [">= 0"])
+      s.add_dependency(%q<syntax>, [">= 0"])
+      s.add_dependency(%q<reek>, ["~> 1.2.8"])
+    end
+  else
+    s.add_dependency(%q<redis>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<autotest>, [">= 0"])
+    s.add_dependency(%q<syntax>, [">= 0"])
+    s.add_dependency(%q<reek>, ["~> 1.2.8"])
+  end
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/docs/FullTextSearch.html

@@ -0,0 +1,48 @@
+<!DOCTYPE html>  <html> <head>   <title>FullTextSearch.rb</title>   <meta http-equiv="content-type" content="text/html; charset=UTF-8">   <link rel="stylesheet" media="all" href="docco.css" /> </head> <body>   <div id="container">     <div id="background"></div>            <div id="jump_to">         Jump To &hellip;         <div id="jump_wrapper">           <div id="jump_page">                                           <a class="source" href="FullTextSearch.html">                 FullTextSearch.rb               </a>                                           <a class="source" href="Tagging.html">                 Tagging.rb               </a>                                           <a class="source" href="installation_and_setup.html">                 installation_and_setup.rb               </a>                        </div>         </div>       </div>          <table cellpadding="0" cellspacing="0">       <thead>         <tr>           <th class="docs">             <h1>               FullTextSearch.rb             </h1>           </th>           <th class="code">           </th>         </tr>       </thead>       <tbody>                               <tr id="section-1">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-1">&#182;</a>               </div>               <h2>Full Text Searching</h2>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-2">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-2">&#182;</a>               </div>               <p>We are using an ActiveRecord model here.</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="k">class</span> <span class="nc">Tweet</span> <span class="o">&lt;</span> <span class="no">ActiveRecord</span><span class="o">::</span><span class="no">Base</span> 
+  </pre></div>             </td>           </tr>                               <tr id="section-3">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-3">&#182;</a>               </div>               <p>With it's complimentary callbacks</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="n">after_create</span> <span class="ss">:create_search_index</span>
+  <span class="n">before_destroy</span> <span class="ss">:destroy_search_index</span></pre></div>             </td>           </tr>                               <tr id="section-4">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-4">&#182;</a>               </div>               <p>But you can just as well use any other orm that gives it's documents/tables unique identifiers (id's)</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="kp">private</span>
+  <span class="k">def</span> <span class="nf">create_search_index</span></pre></div>             </td>           </tr>                               <tr id="section-5">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-5">&#182;</a>               </div>               <p>So we set the namespace we want the searching to be on by setting it's name :tweet<em>text</em>content
+We pass the tweets id to it so we can find it
+And we pass the tweets text_content, so we can match our search</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="no">FullTextSearch</span><span class="o">.</span><span class="n">create_index</span> <span class="ss">:attribute_namespace</span> <span class="o">=&gt;</span> <span class="ss">:tweet_text_content</span><span class="p">,</span>
+                                <span class="ss">:document_id</span> <span class="o">=&gt;</span> <span class="nb">id</span>
+                              
+  <span class="k">end</span>
+  
+  <span class="k">def</span> <span class="nf">destroy_search_index</span></pre></div>             </td>           </tr>                               <tr id="section-6">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-6">&#182;</a>               </div>               <p>Same applies here to as to create, except we are removing the records indices
+No need to pass the words here, just what records index to remove</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="no">FullTextSearch</span><span class="o">.</span><span class="n">destroy_index</span>  <span class="ss">:attribute_namespace</span> <span class="o">=&gt;</span> <span class="ss">:tweet_text_content</span><span class="p">,</span>
+                                  <span class="ss">:document_id</span> <span class="o">=&gt;</span> <span class="nb">id</span>
+    
+  <span class="k">end</span>
+<span class="k">end</span></pre></div>             </td>           </tr>                               <tr id="section-7">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-7">&#182;</a>               </div>               <p>Now you can search through your indices easily
+By passing what namespace you want to search on with the words you are searching with</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="n">set_of_ids</span> <span class="o">=</span> <span class="no">FullTextSearch</span><span class="o">.</span><span class="n">search_index</span> <span class="ss">:attribute_namespace</span> <span class="o">=&gt;</span> <span class="ss">:tweet_text_content</span><span class="p">,</span>
+                                         <span class="ss">:search</span> <span class="o">=&gt;</span> <span class="s2">&quot;jquery mobile&quot;</span>
+                                         </pre></div>             </td>           </tr>                               <tr id="section-8">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-8">&#182;</a>               </div>               <p>And no matter if you're using Mongoid, ActiveRecord or DataMapper, you can now query the ID's.</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="no">Article</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="ss">:id</span> <span class="o">=&gt;</span> <span class="n">set_of_ids</span><span class="p">)</span></pre></div>             </td>           </tr>                               <tr id="section-9">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-9">&#182;</a>               </div>               <hr />             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-10">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-10">&#182;</a>               </div>               <h2>Association</h2>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-11">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-11">&#182;</a>               </div>               <p>Now lets assume we want to limit to who can search what by setting an association</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="k">def</span> <span class="nf">create_search_index</span></pre></div>             </td>           </tr>                               <tr id="section-12">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-12">&#182;</a>               </div>               <p>Notice the assoction on the tweets user.id</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="no">FullTextSearch</span><span class="o">.</span><span class="n">create_index</span> <span class="ss">:attribute_namespace</span> <span class="o">=&gt;</span> <span class="ss">:tweet_text_content</span><span class="p">,</span>
+                                <span class="ss">:document_id</span> <span class="o">=&gt;</span> <span class="nb">id</span><span class="p">,</span>
+                                <span class="ss">:words</span> <span class="o">=&gt;</span> <span class="n">text_content</span><span class="p">,</span>
+                                <span class="ss">:association</span> <span class="o">=&gt;</span> <span class="n">user</span><span class="o">.</span><span class="n">id</span>
+                              
+  <span class="k">end</span>
+  
+  <span class="k">def</span> <span class="nf">destroy_search_index</span></pre></div>             </td>           </tr>                               <tr id="section-13">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-13">&#182;</a>               </div>               <p>Same concept applies here as well</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="no">FullTextSearch</span><span class="o">.</span><span class="n">destroy_index</span>  <span class="ss">:attribute_namespace</span> <span class="o">=&gt;</span> <span class="ss">:tweet_text_content</span><span class="p">,</span>
+                                  <span class="ss">:document_id</span> <span class="o">=&gt;</span> <span class="nb">id</span><span class="p">,</span>
+                                  <span class="ss">:association</span> <span class="o">=&gt;</span> <span class="n">user</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
+    
+  <span class="k">end</span></pre></div>             </td>           </tr>                               <tr id="section-14">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-14">&#182;</a>               </div>               <p>And when the current_user searches he will only find on his own associated tweets</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="n">set_of_ids</span> <span class="o">=</span> <span class="no">FullTextSearch</span><span class="o">.</span><span class="n">search_index</span> <span class="ss">:attribute_namespace</span> <span class="o">=&gt;</span> <span class="ss">:tweet_text_content</span><span class="p">,</span>
+                                         <span class="ss">:search</span> <span class="o">=&gt;</span> <span class="s2">&quot;jQuery map&quot;</span><span class="p">,</span>
+                                         <span class="ss">:association</span> <span class="o">=&gt;</span> <span class="n">current_user</span><span class="o">.</span><span class="n">id</span></pre></div>             </td>           </tr>                               <tr id="section-15">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-15">&#182;</a>               </div>               <hr />             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-16">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-16">&#182;</a>               </div>               <h2>But wait! ... there's more</h2>
+
+<h3>What can I do with this?</h3>
+
+<ul>
+<li><p><a href="https://github.com/fabrik42/acts_as_api/wiki/">Tagging - find posts through tagging, find tags through posts</a></p></li>
+<li><p><a href="https://github.com/fabrik42/acts_as_api/wiki/Calling-a-method-of-the-model">Full text search -through association or attributes</a></p></li>
+<li><p>Social Graph, friends, followers, followees</p></li>
+</ul>
+
+<p>You can find more advanced examples by using the "Jumper" placed at the upper right corner</p>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-17">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-17">&#182;</a>               </div>               <hr />             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-18">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-18">&#182;</a>               </div>               <h2>Links</h2>
+
+<ul>
+<li><a href="https://github.com/seivan/Rfizzy">Check out the source code on Github</a></li>
+<li><a href="https://github.com/seivan/Rfizzy/issues">Found a bug or do you have a feature request?</a></li>
+<li><a href="http://travis-ci.org/seivan/Rfizzy">Continues build and testing status</a></li>
+</ul>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                </tbody>     </table>   </div> </body> </html> 

data/docs/Tagging.html

@@ -0,0 +1,49 @@
+<!DOCTYPE html>  <html> <head>   <title>Tagging.rb</title>   <meta http-equiv="content-type" content="text/html; charset=UTF-8">   <link rel="stylesheet" media="all" href="docco.css" /> </head> <body>   <div id="container">     <div id="background"></div>            <div id="jump_to">         Jump To &hellip;         <div id="jump_wrapper">           <div id="jump_page">                                           <a class="source" href="FullTextSearch.html">                 FullTextSearch.rb               </a>                                           <a class="source" href="Tagging.html">                 Tagging.rb               </a>                                           <a class="source" href="installation_and_setup.html">                 installation_and_setup.rb               </a>                        </div>         </div>       </div>          <table cellpadding="0" cellspacing="0">       <thead>         <tr>           <th class="docs">             <h1>               Tagging.rb             </h1>           </th>           <th class="code">           </th>         </tr>       </thead>       <tbody>                               <tr id="section-1">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-1">&#182;</a>               </div>               <h2>Tagging</h2>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-2">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-2">&#182;</a>               </div>               <p>We are using an ActiveRecord model here.</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="k">class</span> <span class="nc">Article</span> <span class="o">&lt;</span> <span class="no">ActiveRecord</span><span class="o">::</span><span class="no">Base</span> 
+  </pre></div>             </td>           </tr>                               <tr id="section-3">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-3">&#182;</a>               </div>               <p>With it's complimentary callbacks</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="n">after_create</span> <span class="ss">:create_search_index</span>
+  <span class="n">before_destroy</span> <span class="ss">:destroy_search_index</span></pre></div>             </td>           </tr>                               <tr id="section-4">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-4">&#182;</a>               </div>               <p>But you can just as well use any other orm that gives it's documents/tables unique identifiers (id's)</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="kp">private</span>
+  <span class="k">def</span> <span class="nf">create_search_index</span></pre></div>             </td>           </tr>                               <tr id="section-5">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-5">&#182;</a>               </div>               <p>So we set the namespace we want the searching to be on by setting it's name :article_tags
+We pass the article's id to it so we can find it
+And we pass the articles tags as an array
+Naturally the tags can just be a virtual attribute as an array of tags when posting the article</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="no">TaggyMcFaggy</span><span class="o">.</span><span class="n">create_index</span> <span class="ss">:attribute_namespace</span> <span class="o">=&gt;</span> <span class="ss">:article_tags</span><span class="p">,</span>
+                                <span class="ss">:document_id</span> <span class="o">=&gt;</span> <span class="nb">id</span><span class="p">,</span>
+                                <span class="ss">:words</span> <span class="o">=&gt;</span> <span class="n">tags</span>
+                              
+  <span class="k">end</span>
+  
+  <span class="k">def</span> <span class="nf">destroy_search_index</span></pre></div>             </td>           </tr>                               <tr id="section-6">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-6">&#182;</a>               </div>               <p>Same concept applies here, except we don't care about the tags themselves.</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="no">TaggyMcFaggy</span><span class="o">.</span><span class="n">destroy_index</span>  <span class="ss">:attribute_namespace</span> <span class="o">=&gt;</span> <span class="ss">:article_text</span><span class="p">,</span>
+                                  <span class="ss">:document_id</span> <span class="o">=&gt;</span> <span class="nb">id</span>
+    
+  <span class="k">end</span>
+<span class="k">end</span></pre></div>             </td>           </tr>                               <tr id="section-7">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-7">&#182;</a>               </div>               <p>Pass in an array of tags, or a single tag as a text</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="n">set_of_ids</span> <span class="o">=</span> <span class="no">TaggyMcFaggy</span><span class="o">.</span><span class="n">search_index</span> <span class="ss">:attribute_namespace</span> <span class="o">=&gt;</span> <span class="ss">:article_text</span><span class="p">,</span>
+                                         <span class="ss">:search</span> <span class="o">=&gt;</span> <span class="s2">&quot;food&quot;</span>
+                                         </pre></div>             </td>           </tr>                               <tr id="section-8">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-8">&#182;</a>               </div>               <p>And no matter if you're using Mongoid, ActiveRecord or DataMapper, you can now query the ID's.</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="no">Article</span><span class="o">.</span><span class="n">where</span><span class="p">(</span><span class="ss">:id</span> <span class="o">=&gt;</span> <span class="n">set_of_ids</span><span class="p">)</span></pre></div>             </td>           </tr>                               <tr id="section-9">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-9">&#182;</a>               </div>               <p>Now lets assume we want to limit to who can search what by setting an association</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="k">def</span> <span class="nf">create_search_index</span></pre></div>             </td>           </tr>                               <tr id="section-10">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-10">&#182;</a>               </div>               <p>Notice the assoction on article.user.id</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="no">TaggyMcFaggy</span><span class="o">.</span><span class="n">create_index</span> <span class="ss">:attribute_namespace</span> <span class="o">=&gt;</span> <span class="ss">:article_text</span><span class="p">,</span>
+                                <span class="ss">:document_id</span> <span class="o">=&gt;</span> <span class="nb">id</span><span class="p">,</span>
+                                <span class="ss">:words</span> <span class="o">=&gt;</span> <span class="n">text_content</span><span class="p">,</span>
+                                <span class="ss">:association</span> <span class="o">=&gt;</span> <span class="n">user</span><span class="o">.</span><span class="n">id</span>
+                              
+  <span class="k">end</span>
+  
+  <span class="k">def</span> <span class="nf">destroy_search_index</span></pre></div>             </td>           </tr>                               <tr id="section-11">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-11">&#182;</a>               </div>               <p>Same concept applies here, except we really do not care about the tags when deleting</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="no">TaggyMcFaggy</span><span class="o">.</span><span class="n">destroy_index</span>  <span class="ss">:attribute_namespace</span> <span class="o">=&gt;</span> <span class="ss">:article_text</span><span class="p">,</span>
+                                  <span class="ss">:document_id</span> <span class="o">=&gt;</span> <span class="nb">id</span><span class="p">,</span>
+                                  <span class="ss">:association</span> <span class="o">=&gt;</span> <span class="n">user</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
+
+  <span class="k">end</span></pre></div>             </td>           </tr>                               <tr id="section-12">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-12">&#182;</a>               </div>               <p>And when the current_user searches he will only find on his own associated tweets</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="n">set_of_ids</span> <span class="o">=</span> <span class="no">TaggyMcFaggy</span><span class="o">.</span><span class="n">search_index</span>  <span class="ss">:attribute_namespace</span> <span class="o">=&gt;</span> <span class="ss">:article_text</span><span class="p">,</span>
+                                          <span class="ss">:association</span> <span class="o">=&gt;</span> <span class="n">current_user</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
+                                          <span class="ss">:search</span> <span class="o">=&gt;</span> <span class="o">[</span><span class="s2">&quot;Food&quot;</span><span class="p">,</span> <span class="s2">&quot;gaming&quot;</span><span class="p">,</span> <span class="s2">&quot;Balls&quot;</span><span class="o">]</span>
+  </pre></div>             </td>           </tr>                               <tr id="section-13">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-13">&#182;</a>               </div>               <hr />             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-14">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-14">&#182;</a>               </div>               <h2>But wait! ... there's more</h2>
+
+<h3>What can I do with this?</h3>
+
+<ul>
+<li><p><a href="https://github.com/fabrik42/acts_as_api/wiki/">Tagging - find posts through tagging, find tags through posts</a></p></li>
+<li><p><a href="https://github.com/fabrik42/acts_as_api/wiki/Calling-a-method-of-the-model">Full text search -through association or attributes</a></p></li>
+<li><p>Social Graph, friends, followers, followees</p></li>
+</ul>
+
+<p>You can find more advanced examples by using the "Jumper" placed at the upper right corner</p>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-15">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-15">&#182;</a>               </div>               <hr />             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-16">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-16">&#182;</a>               </div>               <h2>Links</h2>
+
+<ul>
+<li><a href="https://github.com/seivan/Rfizzy">Check out the source code on Github</a></li>
+<li><a href="https://github.com/seivan/Rfizzy/issues">Found a bug or do you have a feature request?</a></li>
+<li><a href="http://travis-ci.org/seivan/Rfizzy">Continues build and testing status</a></li>
+</ul>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                </tbody>     </table>   </div> </body> </html> 

data/docs/docco.css

@@ -0,0 +1,186 @@
+/*--------------------- Layout and Typography ----------------------------*/
+body {
+  font-family: 'Palatino Linotype', 'Book Antiqua', Palatino, FreeSerif, serif;
+  font-size: 15px;
+  line-height: 22px;
+  color: #252519;
+  margin: 0; padding: 0;
+}
+a {
+  color: #261a3b;
+}
+  a:visited {
+    color: #261a3b;
+  }
+p {
+  margin: 0 0 15px 0;
+}
+h1, h2, h3, h4, h5, h6 {
+  margin: 0px 0 15px 0;
+}
+  h1 {
+    margin-top: 40px;
+  }
+#container {
+  position: relative;
+}
+#background {
+  position: fixed;
+  top: 0; left: 525px; right: 0; bottom: 0;
+  background: #f5f5ff;
+  border-left: 1px solid #e5e5ee;
+  z-index: -1;
+}
+#jump_to, #jump_page {
+  background: white;
+  -webkit-box-shadow: 0 0 25px #777; -moz-box-shadow: 0 0 25px #777;
+  -webkit-border-bottom-left-radius: 5px; -moz-border-radius-bottomleft: 5px;
+  font: 10px Arial;
+  text-transform: uppercase;
+  cursor: pointer;
+  text-align: right;
+}
+#jump_to, #jump_wrapper {
+  position: fixed;
+  right: 0; top: 0;
+  padding: 5px 10px;
+}
+  #jump_wrapper {
+    padding: 0;
+    display: none;
+  }
+    #jump_to:hover #jump_wrapper {
+      display: block;
+    }
+    #jump_page {
+      padding: 5px 0 3px;
+      margin: 0 0 25px 25px;
+    }
+      #jump_page .source {
+        display: block;
+        padding: 5px 10px;
+        text-decoration: none;
+        border-top: 1px solid #eee;
+      }
+        #jump_page .source:hover {
+          background: #f5f5ff;
+        }
+        #jump_page .source:first-child {
+        }
+table td {
+  border: 0;
+  outline: 0;
+}
+  td.docs, th.docs {
+    max-width: 450px;
+    min-width: 450px;
+    min-height: 5px;
+    padding: 10px 25px 1px 50px;
+    overflow-x: hidden;
+    vertical-align: top;
+    text-align: left;
+  }
+    .docs pre {
+      margin: 15px 0 15px;
+      padding-left: 15px;
+    }
+    .docs p tt, .docs p code {
+      background: #f8f8ff;
+      border: 1px solid #dedede;
+      font-size: 12px;
+      padding: 0 0.2em;
+    }
+    .pilwrap {
+      position: relative;
+    }
+      .pilcrow {
+        font: 12px Arial;
+        text-decoration: none;
+        color: #454545;
+        position: absolute;
+        top: 3px; left: -20px;
+        padding: 1px 2px;
+        opacity: 0;
+        -webkit-transition: opacity 0.2s linear;
+      }
+        td.docs:hover .pilcrow {
+          opacity: 1;
+        }
+  td.code, th.code {
+    padding: 14px 15px 16px 25px;
+    width: 100%;
+    vertical-align: top;
+    background: #f5f5ff;
+    border-left: 1px solid #e5e5ee;
+  }
+    pre, tt, code {
+      font-size: 12px; line-height: 18px;
+      font-family: Monaco, Consolas, "Lucida Console", monospace;
+      margin: 0; padding: 0;
+    }
+
+
+/*---------------------- Syntax Highlighting -----------------------------*/
+td.linenos { background-color: #f0f0f0; padding-right: 10px; }
+span.lineno { background-color: #f0f0f0; padding: 0 5px 0 5px; }
+body .hll { background-color: #ffffcc }
+body .c { color: #408080; font-style: italic }  /* Comment */
+body .err { border: 1px solid #FF0000 }         /* Error */
+body .k { color: #954121 }                      /* Keyword */
+body .o { color: #666666 }                      /* Operator */
+body .cm { color: #408080; font-style: italic } /* Comment.Multiline */
+body .cp { color: #BC7A00 }                     /* Comment.Preproc */
+body .c1 { color: #408080; font-style: italic } /* Comment.Single */
+body .cs { color: #408080; font-style: italic } /* Comment.Special */
+body .gd { color: #A00000 }                     /* Generic.Deleted */
+body .ge { font-style: italic }                 /* Generic.Emph */
+body .gr { color: #FF0000 }                     /* Generic.Error */
+body .gh { color: #000080; font-weight: bold }  /* Generic.Heading */
+body .gi { color: #00A000 }                     /* Generic.Inserted */
+body .go { color: #808080 }                     /* Generic.Output */
+body .gp { color: #000080; font-weight: bold }  /* Generic.Prompt */
+body .gs { font-weight: bold }                  /* Generic.Strong */
+body .gu { color: #800080; font-weight: bold }  /* Generic.Subheading */
+body .gt { color: #0040D0 }                     /* Generic.Traceback */
+body .kc { color: #954121 }                     /* Keyword.Constant */
+body .kd { color: #954121; font-weight: bold }  /* Keyword.Declaration */
+body .kn { color: #954121; font-weight: bold }  /* Keyword.Namespace */
+body .kp { color: #954121 }                     /* Keyword.Pseudo */
+body .kr { color: #954121; font-weight: bold }  /* Keyword.Reserved */
+body .kt { color: #B00040 }                     /* Keyword.Type */
+body .m { color: #666666 }                      /* Literal.Number */
+body .s { color: #219161 }                      /* Literal.String */
+body .na { color: #7D9029 }                     /* Name.Attribute */
+body .nb { color: #954121 }                     /* Name.Builtin */
+body .nc { color: #0000FF; font-weight: bold }  /* Name.Class */
+body .no { color: #880000 }                     /* Name.Constant */
+body .nd { color: #AA22FF }                     /* Name.Decorator */
+body .ni { color: #999999; font-weight: bold }  /* Name.Entity */
+body .ne { color: #D2413A; font-weight: bold }  /* Name.Exception */
+body .nf { color: #0000FF }                     /* Name.Function */
+body .nl { color: #A0A000 }                     /* Name.Label */
+body .nn { color: #0000FF; font-weight: bold }  /* Name.Namespace */
+body .nt { color: #954121; font-weight: bold }  /* Name.Tag */
+body .nv { color: #19469D }                     /* Name.Variable */
+body .ow { color: #AA22FF; font-weight: bold }  /* Operator.Word */
+body .w { color: #bbbbbb }                      /* Text.Whitespace */
+body .mf { color: #666666 }                     /* Literal.Number.Float */
+body .mh { color: #666666 }                     /* Literal.Number.Hex */
+body .mi { color: #666666 }                     /* Literal.Number.Integer */
+body .mo { color: #666666 }                     /* Literal.Number.Oct */
+body .sb { color: #219161 }                     /* Literal.String.Backtick */
+body .sc { color: #219161 }                     /* Literal.String.Char */
+body .sd { color: #219161; font-style: italic } /* Literal.String.Doc */
+body .s2 { color: #219161 }                     /* Literal.String.Double */
+body .se { color: #BB6622; font-weight: bold }  /* Literal.String.Escape */
+body .sh { color: #219161 }                     /* Literal.String.Heredoc */
+body .si { color: #BB6688; font-weight: bold }  /* Literal.String.Interpol */
+body .sx { color: #954121 }                     /* Literal.String.Other */
+body .sr { color: #BB6688 }                     /* Literal.String.Regex */
+body .s1 { color: #219161 }                     /* Literal.String.Single */
+body .ss { color: #19469D }                     /* Literal.String.Symbol */
+body .bp { color: #954121 }                     /* Name.Builtin.Pseudo */
+body .vc { color: #19469D }                     /* Name.Variable.Class */
+body .vg { color: #19469D }                     /* Name.Variable.Global */
+body .vi { color: #19469D }                     /* Name.Variable.Instance */
+body .il { color: #666666 }                     /* Literal.Number.Integer.Long */