websolr-acts_as_solr 0.0.2 → 0.1.0

data/README.rdoc

@@ -0,0 +1,69 @@
+== About
+
+This is the gem to install for the supported version of acts_as_solr on websolr.
+
+== Installation
+
+  cd your_rails_app
+  sudo gem install websolr-acts_as_solr
+  config.gem "websolr-acts_as_solr"                 # into config.environment.rb
+  echo websolr-acts_as_solr >> .gems                # if using Heroku
+  acts_as_solr install                              # Installs config/solr.yml
+  echo "require 'aas_tasks'" >> Rakefile            # Installs local development tasks      
+
+== Usage
+
+=== Starting a local development server
+
+To start up a Solr instance for development, issue the following:
+
+  rake solr:start
+
+=== Using in production
+
+You need to make sure that the WEBSOLR_URL environment variable is set correctly.  
+
+If you're using Heroku, this should happen automatically.  You can verify by running <code>heroku config</code>.
+
+If you're running in your own environment, set the environment variable as you normally would on a *nix system.
+
+If you have to set the variable in Ruby, you should be able to put the following in an Rails initializer:
+
+  if RAILS_ENV == "production"
+    ENV["WEBSOLR_URL"] = "http://index.websolr.com/solr/[your-api-key]"
+    load "websolr-acts_as_solr.rb"
+  end
+
+== Requirements
+
+* Java Runtime Environment(JRE) 1.5 aka 5.0 [http://www.java.com/en/download/index.jsp](http://www.java.com/en/download/index.jsp)
+* If you have libxml-ruby installed, make sure it's at least version 0.7
+
+== Basic Usage
+
+# Just include the line below to any of your ActiveRecord models:
+  acts_as_solr
+
+# Or if you want, you can specify only the fields that should be indexed:
+  acts_as_solr :fields => [:name, :author]
+
+# Then to find instances of your model, just do:
+  Model.find_by_solr(query) #query is a string representing your query
+
+# Please see ActsAsSolr::ActsMethods for a complete info
+
+== acts_as_solr in your tests
+
+To test code that uses acts_as_solr you must start a Solr server for the test environment. You can do that with 
+
+    rake solr:start RAILS_ENV=test
+
+However, if you would like to mock out Solr calls so that a Solr server is not needed (and your tests will run much faster), just add this to your `test_helper.rb` or similar:
+
+    class ActsAsSolr::Post
+      def self.execute(request)
+        true
+      end
+    end
+
+(via[http://www.subelsky.com/2007/10/actsassolr-capistranhttpwwwbloggercomim.html#c1646308013209805416])

data/Rakefile

@@ -10,7 +10,7 @@ begin
     gem.email = "kyle@kylemaxwell.com"
     gem.homepage = "http://github.com/fizx/websolr-acts_as_solr"
     gem.authors = ["Kyle Maxwell"]
-    gem.add_dependency "acts_as_solr", "1.1.1"
+    gem.add_dependency "acts_as_solr", "1.2.0"
     gem.add_dependency "rest-client"
     gem.add_dependency "json"
     gem.add_development_dependency "rspec", ">= 0"

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

data/lib/websolr-acts_as_solr.rb

@@ -1,7 +1,7 @@
 # Post-require hooks for acts_as_solr and sunspot if this 
 # gem is loaded and WEBSOLR_URL is defined.
 
-gem "acts_as_solr", :version => "1.1.1"
+gem "acts_as_solr", :version => "1.1.3"
 require "acts_as_solr"
 
 if ENV["WEBSOLR_URL"]

data/websolr-acts_as_solr.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{websolr-acts_as_solr}
-  s.version = "0.0.2"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kyle Maxwell"]
@@ -14,13 +14,13 @@ Gem::Specification.new do |s|
   s.email = %q{kyle@kylemaxwell.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README"
+     "README.rdoc"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README",
+     "README.rdoc",
      "Rakefile",
      "VERSION",
      "lib/websolr-acts_as_solr.rb",
@@ -43,18 +43,18 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<acts_as_solr>, ["= 1.1.1"])
+      s.add_runtime_dependency(%q<acts_as_solr>, ["= 1.2.0"])
       s.add_runtime_dependency(%q<rest-client>, [">= 0"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
     else
-      s.add_dependency(%q<acts_as_solr>, ["= 1.1.1"])
+      s.add_dependency(%q<acts_as_solr>, ["= 1.2.0"])
       s.add_dependency(%q<rest-client>, [">= 0"])
       s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
-    s.add_dependency(%q<acts_as_solr>, ["= 1.1.1"])
+    s.add_dependency(%q<acts_as_solr>, ["= 1.2.0"])
     s.add_dependency(%q<rest-client>, [">= 0"])
     s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: websolr-acts_as_solr
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Kyle Maxwell
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 1.1.1
+        version: 1.2.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
@@ -60,12 +60,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README
+- README.rdoc
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README
+- README.rdoc
 - Rakefile
 - VERSION
 - lib/websolr-acts_as_solr.rb

data/README

@@ -1,17 +0,0 @@
-Changes:
-- Split the acts_as_solr, and websolr_rails versions of the gem.  This is acts_as_solr-only.
-- Lockdown the specific supported versions of acts_as_solr
-- Web service call on boot to enforce the correct schema.xml.
-
-Using the experimental websolr acts_as_solr client:
-
-sudo gem install websolr-acts_as_solr
-echo websolr-acts_as_solr >> .gems
-config.gem "websolr-acts_as_solr" # into config/environment.rb
-
-Edit config/solr.yml =>
-
-development:
-  url: http://127.0.0.1:8982/solr
-  
-Use acts_as_solr as usual.