JRank 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/JRank.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "JRank/version"
+
+Gem::Specification.new do |s|
+  s.name        = "JRank"
+  s.version     = Jrank::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Paul Ketelle & Dave Almond"]
+  s.email       = ["paul@ketelle.com"]
+  s.homepage    = ""
+  s.summary     = %q{JRank search gem for rails}
+  s.description = %q{Adds easy to use JRank search to any website}
+
+  s.rubyforge_project = "Jrank"
+
+  s.add_dependency 'xml-object'
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/README.rdoc

@@ -0,0 +1,40 @@
+= JRank
+
+JRank.org search engine plugin
+
+== Install
+
+=== JRank.org
+
+Go to Jrank.org and create an account and setup your site. Making note of the sites apikey.
+
+=== Rails 3
+
+You can let bundler install JRank by adding this line to your application's Gemfile:
+
+  gem 'jrank'
+
+And then execute:
+
+  bundle install
+
+Or install it yourself as:
+
+  gem install jrank
+
+Then run jrank install
+
+  rails g jrank:install
+
+== Usage
+
+Edit the file config/jrank.yml:
+
+  development:
+    jrank_apikey: apikey_here
+
+  test:
+    ...
+
+  production:
+    ...

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/app/controllers/jrank/search_controller.rb

@@ -0,0 +1,11 @@
+
+class Jrank::SearchController < ApplicationController
+
+	unloadable
+
+	def index
+		if !params[:query].blank?
+			@jrank = Jrank::Search.new.find(params[:query], params[:start] ||= "0", params[:limit] ||= "10")
+		end
+	end
+end

data/app/helpers/jrank/search_helper.rb

@@ -0,0 +1,5 @@
+module Jrank::SearchHelper
+	def html_render(str)
+		str.gsub('&amp;', '&').gsub('&lt;', '<').gsub('&gt;', '>').html_safe
+	end
+end

data/app/views/jrank/search/_form.html.erb

@@ -0,0 +1,7 @@
+<form method="get" action="<%= jrank_search_path %>" class="jrank_form">
+	<%= field_set_tag "Search Form" do %>
+		<%= label_tag "query", "Search" %>
+		<%= search_field_tag "query" %>
+		<input type="submit" value="Submit" />
+	<% end %>
+</form>

data/app/views/jrank/search/_paging.html.erb

@@ -0,0 +1,16 @@
+<% if total_pages.to_i > 1 %>
+	<ul class="jrank_paging">
+	<% pages.each do |page| %>
+		<li>
+			<% unless page.number == current_page or html_render(page.number) == "&hellip;" %>
+				<%= link_to (page.number.to_i+1), params.merge( :start => page.start ) %>
+			<% else %>
+				<span>
+					<%= page.number.to_i+1 if html_render(page.number) != "&hellip;" && page.number == current_page%>
+					<%= html_render(page.number) if html_render(page.number) == "&hellip;" %>
+				</span>
+			<% end %>
+		</li>
+	<% end %>
+	</ul>
+<% end %>

data/app/views/jrank/search/_result.html.erb

@@ -0,0 +1,5 @@
+<li>
+	<h3><%= html_render(entry.title) %></h3>
+	<p><%= html_render(entry.content) %></p>
+	<p><%= link_to entry.url, entry.url %></p>
+</li>

data/app/views/jrank/search/_results.html.erb

@@ -0,0 +1,9 @@
+	<ul class="jrank_entries">
+		<% if total > "0" %>
+			<% entries.each do |entry| %>
+				<%= render "result", :entry => entry %>
+			<% end %>
+		<% else %>
+			<li>No results found for <%= query %></li>
+		<% end %>
+	</ul>

data/app/views/jrank/search/index.html.erb

@@ -0,0 +1,15 @@
+<h1>JRank Site Search</h1>
+
+<%= render "form" %>
+
+<% unless @jrank.nil? %>
+	<h2>Results for "<%= @jrank.meta.query %>"</h2>
+	<%= render "results", :entries => @jrank.entries, :total => @jrank.meta.total, :query => @jrank.meta.query %>
+
+	<%= render "paging", :pages => @jrank.pages, :current_page => @jrank.meta.current_page, :total_pages => @jrank.meta.total_pages %>
+<% end %>
+<p>
+	<a style="display:inline-block" href="http://www.jrank.org/">
+		<img alt="Site Search" src="http://www.jrank.org/images/jrank_88_31-fs8.png" title="JRank Site Search">
+	</a>
+</p>

data/config/routes.rb

@@ -0,0 +1,3 @@
+ Rails.application.routes.draw do |map|
+	match "search", :controller => 'jrank/search', :action => "index", :as => "jrank_search"
+ end

data/features/jrank_submits_search.feature

@@ -0,0 +1,33 @@
+Feature: JRank submits a search
+
+	In Order to Receive JRank.org XML-Object
+	As a User
+	I want to submit search parameters
+
+	Scenario: submit search
+		Given I have a query of "swift"
+		When I submit a search
+		Then I should have an xml object
+	
+	Scenario: no results returned
+		Given I have a query of ""
+		When I submit a search
+		Then I should have an xml object
+		And the xml has no results
+
+	Scenario: goto page 3
+		Given I have a query of "swift"
+		And I have a start value of "20"
+		When I submit a search
+		Then I should have an xml object
+		And the xml current page is "2"
+
+	Scenario: return 50 results per page
+		Given I have a query of "swift"
+		And I have a limit value of "50"
+		When I submit a search
+		Then I should have an xml object
+		And the xml page limit is "50"
+
+		
+	

data/features/step_definitions/rails_steps.rb

@@ -0,0 +1,64 @@
+Given "I have a rails application" do
+  steps %{
+    Given I generate a rails application
+    And this plugin is available
+    And I turn off class caching
+    And the rails application is prepped and running
+  }
+end
+
+Given %r{I generate a rails application} do
+  FileUtils.rm_rf TEMP_ROOT
+  FileUtils.mkdir_p TEMP_ROOT
+  Dir.chdir(TEMP_ROOT) do
+    `rails _3.0.9_ #{APP_NAME}`
+  end
+end
+
+When %r{I save the following as "([^"]*)"} do |path, string|
+  FileUtils.mkdir_p(File.join(CUC_RAILS_ROOT, File.dirname(path)))
+  File.open(File.join(CUC_RAILS_ROOT, path), 'w') { |file| file.write(string) }
+end
+
+When %r{I turn off class caching} do
+  Dir.chdir(CUC_RAILS_ROOT) do
+    file = "config/environments/test.rb"
+    config = IO.read(file)
+    config.gsub!(%r{^\s*config.cache_classes.*$},
+                 "config.cache_classes = false")
+    File.open(file, "w"){|f| f.write(config) }
+  end
+end
+
+When %r{the rails application is prepped and running$} do
+  When "I reset the database"
+  When "the rails application is running"
+end
+
+When %r{I reset the database} do
+  When %{I run "rake db:drop db:create db:migrate"}
+end
+
+When %r{the rails application is running} do
+  Dir.chdir(CUC_RAILS_ROOT) do
+    require "config/environment"
+    require "capybara/rails"
+  end
+end
+
+When %r{this plugin is available} do
+  $LOAD_PATH << "#{PROJECT_ROOT}/lib"
+  require 'jrank'
+  When %{I save the following as "vendor/plugins/jrank/rails/init.rb"},
+       IO.read("#{PROJECT_ROOT}/rails/init.rb") 
+end
+
+When %r{I run "([^"]*)"} do |command|
+  Dir.chdir(CUC_RAILS_ROOT) do
+    `#{command}`
+  end
+end
+
+When %r{I have a "([^"]*)" resource with "([^"]*)"} do |resource, fields|
+  When %{I run "script/generate scaffold #{resource} #{fields}"}
+end

data/features/step_definitions/search_steps.rb

@@ -0,0 +1,41 @@
+
+def limit
+	@limit ||= 10
+end
+
+def start
+	@start ||= 0
+end
+
+Given /^I have a query of "([^"]*)"$/ do |query|
+  @query = query
+end
+
+Given /^I have a start value of "([^"]*)"$/ do |start|
+  @start = start
+end
+
+Given /^I have a limit value of "([^"]*)"$/ do |limit|
+  @limit = limit
+end
+
+When /^I submit a search$/ do
+	jrank_search = Jrank::Search.new
+	@search_results = jrank_search.find(@query, start, limit)
+end
+
+Then /^I should have an xml object$/ do
+	@search_results.meta.total != nil
+end
+
+Then /^the xml has no results$/ do
+	@search_results.entries.should == ""
+end
+
+Then /^the xml current page is "([^"]*)"$/ do |current_page|
+  @search_results.meta.current_page.should == current_page
+end
+
+Then /^the xml page limit is "([^"]*)"$/ do |limit|
+  @search_results.meta.limit.should == limit
+end

data/features/support/env.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH << File.expand_path('../../../lib', __FILE__)
+require 'Jrank'

data/lib/JRank.rb

@@ -0,0 +1 @@
+require 'jrank/engine' if defined?(Rails)

data/lib/JRank/engine.rb

@@ -0,0 +1,12 @@
+
+require 'rails'
+require 'jrank/search'
+
+module Jrank
+	class Engine < Rails::Engine
+		initializer "add stylesheet" do |app|
+			app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+			ActionView::Helpers::AssetTagHelper.register_stylesheet_expansion :jrank => ["_jrank"]
+		end
+	end
+end

data/lib/JRank/search.rb

@@ -0,0 +1,21 @@
+require 'xml-object'
+require 'open-uri'
+module Jrank
+  class Search
+	
+	def initialize
+		
+	end
+	
+	def find(query, start = "0", limit = "10")
+		XMLObject.new(open("http://www.jrank.org/api/search/v2.xml?key=#{apikey}&q=#{URI.encode(query)}&start=#{URI.encode(start)}&limit=#{URI.encode(limit)}"))
+	end
+
+	def apikey
+		if File.exists?("#{Rails.root}/config/jrank.yml")
+			@apikey = (YAML.load_file("#{Rails.root}/config/jrank.yml")[Rails.env].symbolize_keys)[:jrank_apikey]
+		end
+		@apikey ||= ''
+	end
+  end
+end

data/lib/JRank/version.rb

@@ -0,0 +1,3 @@
+module Jrank
+  VERSION = "0.1.0"
+end

data/lib/generators/jrank/install_generator.rb

@@ -0,0 +1,19 @@
+ require 'rails/generators'
+module Jrank
+	module Generators
+		class InstallGenerator < Rails::Generators::Base
+			source_root File.expand_path("../../templates", __FILE__)
+			
+			desc "Copies locale files to your application."
+			
+			def copy_stylesheet
+				template "jrank.css", "public/stylesheets/jrank.css"
+			end
+
+			def copy_config
+				template "jrank.yml", "config/jrank.yml"
+			end
+			
+		end
+	end
+ end

data/lib/generators/templates/jrank.css

@@ -0,0 +1,27 @@
+.jrank_entries {
+	list-style:none;
+}
+.jrank_paging {
+	margin-bottom:20px;
+	overflow:hidden;
+}
+.jrank_paging li{
+	float:left;
+	display:inline-block;
+	margin: 0 5px;
+}
+
+.jrank_paging li a, .jrank_paging li span {
+	display:block;
+	width:25px;
+	height:22px;
+	padding-top:3px;
+	border:1px solid #ccc;
+	text-align:center;
+}
+.jrank_form fieldset{
+	border:none;
+}
+.jrank_form legend {
+	display:none;
+}

data/lib/generators/templates/jrank.yml

@@ -0,0 +1,8 @@
+development:
+  jrank_apikey: [enter Jrank Api Key Here]
+
+test:
+  jrank_apikey: [enter Jrank Api Key Here]
+
+production:
+  jrank_apikey: [enter Jrank Api Key Here]

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: JRank
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Paul Ketelle & Dave Almond
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xml-object
+  requirement: &9739836 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *9739836
+description: Adds easy to use JRank search to any website
+email:
+- paul@ketelle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- JRank.gemspec
+- README.rdoc
+- Rakefile
+- app/controllers/jrank/search_controller.rb
+- app/helpers/jrank/search_helper.rb
+- app/views/jrank/search/_form.html.erb
+- app/views/jrank/search/_paging.html.erb
+- app/views/jrank/search/_result.html.erb
+- app/views/jrank/search/_results.html.erb
+- app/views/jrank/search/index.html.erb
+- config/routes.rb
+- features/jrank_submits_search.feature
+- features/step_definitions/rails_steps.rb
+- features/step_definitions/search_steps.rb
+- features/support/env.rb
+- lib/JRank.rb
+- lib/JRank/engine.rb
+- lib/JRank/search.rb
+- lib/JRank/version.rb
+- lib/generators/jrank/install_generator.rb
+- lib/generators/templates/jrank.css
+- lib/generators/templates/jrank.yml
+homepage: ''
+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: '0'
+requirements: []
+rubyforge_project: Jrank
+rubygems_version: 1.8.1
+signing_key: 
+specification_version: 3
+summary: JRank search gem for rails
+test_files: []