railstank 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,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end
+
+gem "indextank", ">= 1.0.9.1"

data/Gemfile.lock

@@ -0,0 +1,42 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.5)
+    diff-lcs (1.1.2)
+    faraday (0.6.1)
+      addressable (~> 2.2.4)
+      multipart-post (~> 1.1.0)
+      rack (>= 1.1.0, < 2)
+    faraday-stack (0.1.0)
+      faraday (~> 0.6)
+    git (1.2.5)
+    indextank (1.0.9.1)
+      faraday-stack
+      yajl-ruby (>= 0.7.7)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    multipart-post (1.1.0)
+    rack (1.2.2)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    yajl-ruby (0.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  indextank (>= 1.0.9.1)
+  jeweler (~> 1.5.2)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

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

@@ -0,0 +1,44 @@
+h1. Railstank
+
+Rails plugin for IndexTank
+
+h2. Install
+
+<pre><code>gem install railstank</code></pre>
+
+h2. Example
+
+1. Run generator
+<pre><code>rails g railstank </code></pre>
+
+It will automate generate indextank.yml to your config/ directory. Please fill up your information.*
+
+*2. Include Railstank::Search in your model
+
+<pre>
+<code>
+class Topic < ActiveRecord::Base
+  include Railstank::Search
+  has_indextank :forum_topic_index, :index_class_name => "Topic"
+end
+</code>
+</pre>
+
+* If you don't choose index_class_name, it will auto fetch your current class_name.
+* Use :index_class_name, you can avoid STI class problem
+
+h2. Contributing to Railstank
+ 
+* 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.
+
+h2. Copyright
+
+Copyright (c) 2011 xdite(xuite.joke@gmail.com) See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+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 = "railstank"
+  gem.homepage = "http://github.com/xdite/railstank"
+  gem.license = "MIT"
+  gem.summary = %Q{indextank rails plugin}
+  gem.description = %Q{indextank rails plugin}
+  gem.email = "xuite.joke@gmail.com"
+  gem.authors = ["xdite"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_runtime_dependency 'indextank'
+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 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "railstank #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/generators/railstank/railstank_generator.rb

@@ -0,0 +1,11 @@
+require 'rails/generators/base'
+
+class RailstankGenerator < Rails::Generators::Base
+  def self.source_root
+    @source_root ||= File.expand_path('../templates', __FILE__)
+  end
+
+  def copy_config_file
+    copy_file "indextank.yml.example", "config/indextank.yml.example"
+  end
+end

data/lib/generators/railstank/templates/indextank.yml.example

@@ -0,0 +1,12 @@
+development: &DEV
+  api_url: "your api key"
+  
+test:
+  <<: *DEV
+
+staging:
+  api_url: "your api key"
+
+production:
+  api_url: "your api key"
+

data/lib/generators/railstank/templates/load_indextank.rb

@@ -0,0 +1,3 @@
+SEARCH_API = IndexTank::Client.new Railstank.config["api_url"]
+SEARCH_TOPIC_INDEX = SEARCH_API.indexes 'forum_topic_index'
+SEARCH_USER_INDEX = SEARCH_API.indexes 'forum_user_index'

data/lib/railstank.rb

@@ -0,0 +1,60 @@
+module Railstank
+  
+  class Error < StandardError; end
+  
+  def self.config(environment=RAILS_ENV)
+    @config ||= {}
+    @config[environment] ||= YAML.load(File.open(RAILS_ROOT + '/config/indextank.yml').read)[environment]
+  end
+  
+  def self.client
+    @client = IndexTank::Client.new config["api_url"]
+  end
+  
+  module Search
+    extend ActiveSupport::Concern
+    included do
+
+    end
+      
+    module ClassMethods
+      attr_accessor :index_name, :search_index
+      
+      def has_indextank(class_index_name,options={})
+        indextank_index_name = class_index_name.to_s
+        
+        define_method "index_name" do
+          indextank_index_name
+        end  
+        define_method "search_index" do
+          Railstank.client.indexes indextank_index_name
+        end
+        
+        define_method "index_class_name" do
+          options[:index_class_name].present? ? options[:index_class_name].to_s.underscore : self.class.name.underscore
+        end
+        
+        @index_name = indextank_index_name
+        @search_index = Railstank.client.indexes indextank_index_name
+      end
+      
+      def isearch(field,options={})
+        fetch_id_type = options[:fetch]
+        results = search_index.search(field,options)["results"]
+        result_ids = results.map{ |result| result[fetch_id_type] }.uniq
+      end
+    end
+
+    module InstanceMethods
+      def add_to_search_index(content_hash)
+        search_index.document("#{index_class_name}_#{self.id}").add(content_hash)
+      end
+      
+      def delete_index
+        search_index.document("#{index_class_name}_#{self.id}").delete
+      end
+      
+      protected
+    end
+  end
+end

data/railstank.gemspec

@@ -0,0 +1,74 @@
+# 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{railstank}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["xdite"]
+  s.date = %q{2011-04-28}
+  s.description = %q{indextank rails plugin}
+  s.email = %q{xuite.joke@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.textile"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.textile",
+    "Rakefile",
+    "VERSION",
+    "lib/generators/railstank/USAGE",
+    "lib/generators/railstank/railstank_generator.rb",
+    "lib/generators/railstank/templates/indextank.yml.example",
+    "lib/generators/railstank/templates/load_indextank.rb",
+    "lib/railstank.rb",
+    "railstank.gemspec",
+    "spec/railstank_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/xdite/railstank}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{indextank rails plugin}
+  s.test_files = [
+    "spec/railstank_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  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<indextank>, [">= 1.0.9.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<indextank>, [">= 0"])
+    else
+      s.add_dependency(%q<indextank>, [">= 1.0.9.1"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<indextank>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<indextank>, [">= 1.0.9.1"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<indextank>, [">= 0"])
+  end
+end
+

data/spec/railstank_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Railstank" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'railstank'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification 
+name: railstank
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- xdite
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-28 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: indextank
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 121
+        segments: 
+        - 1
+        - 0
+        - 9
+        - 1
+        version: 1.0.9.1
+  prerelease: false
+  type: :runtime
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  prerelease: false
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  prerelease: false
+  type: :development
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  name: indextank
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :runtime
+  requirement: *id006
+description: indextank rails plugin
+email: xuite.joke@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.textile
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.textile
+- Rakefile
+- VERSION
+- lib/generators/railstank/USAGE
+- lib/generators/railstank/railstank_generator.rb
+- lib/generators/railstank/templates/indextank.yml.example
+- lib/generators/railstank/templates/load_indextank.rb
+- lib/railstank.rb
+- railstank.gemspec
+- spec/railstank_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/xdite/railstank
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: indextank rails plugin
+test_files: 
+- spec/railstank_spec.rb
+- spec/spec_helper.rb