sinatra-indextank 1.0.0

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/README.textile

@@ -0,0 +1,26 @@
+h1. sinatra-indextank
+
+Extends Sinatra with an extension method for dealing with IndexTank.
+
+h2. Installation
+
+Install it with gem:
+
+@$ gem install sinatra-indextank@
+
+Now we can use it an example application.
+
+<pre><code>require 'sinatra'
+require 'sinatra/indextank'
+
+# Obtain an IndexTank client using your private api url
+# Or, specify the INDEXTANK_API_URL as an environment variable
+set :indextank, 'http://_your_private_api_url@api.indextank.com'
+
+# At this point, you can access the IndexTank::Client object using the 'indextank' helper:
+
+get '/search' do
+  @results = indextank.indexes('idx').search(params[:q])
+end
+  </code>
+</pre>

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run the specs"
+RSpec::Core::RakeTask.new do |r|
+  r.verbose = false
+end
+
+task :default => :spec
+

data/lib/sinatra/indextank.rb

@@ -0,0 +1,30 @@
+require 'sinatra/base'
+require 'indextank'
+
+module Sinatra
+  module IndexTankHelper
+    def indextank
+      options.indextank
+    end
+  end
+
+  module IndexTankExtension
+    def indextank=(url)
+      @indextank = nil
+      set :indextank_url, url
+      indextank
+    end
+
+    def indextank
+      synchronize { @indextank ||= IndexTank::Client.new(indextank_url) }
+    end
+
+    protected
+    def self.registered(app)
+      app.set :indextank_url, ENV['INDEXTANK_API_URL']
+      app.helpers IndexTankHelper
+    end
+  end
+
+  register IndexTankExtension
+end

data/sinatra-indextank.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "sinatra-indextank"
+  s.version     = "1.0.0"
+  s.authors     = ["Brian Ryckbost"]
+  s.email       = ["brian@collectiveidea.com"]
+  s.homepage    = ""
+  s.summary     = %q{A simple extension to sinatra for using IndexTank}
+  s.description = %q{A simple extension to sinatra for using IndexTank}
+
+  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"]
+
+  s.add_runtime_dependency "sinatra"
+  s.add_runtime_dependency "indextank"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rack-test"
+end

data/spec/sinatra-indextank_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Sinatra::IndexTankExtension" do
+  before(:each) do
+    @app = Sinatra.new
+    @app.register Sinatra::IndexTankExtension
+  end
+
+  describe "#indextank" do
+    before do
+      @app.indextank = "http://:private_api@private.api.indextank.com"
+    end
+
+    it "returns an IndexTank client" do
+      @app.indextank.should be_kind_of(IndexTank::Client)
+    end
+
+    it "sets the indextank_url" do
+      @app.indextank_url.should == "http://:private_api@private.api.indextank.com"
+    end
+  end
+
+  describe "#indextank=" do
+    before(:each) do
+      @indextank_url = "http://:public_api@public.api.indextank.com"
+      @app.stub!(:indextank).and_return(mock('indextank'))
+    end
+
+    it "sets indextank_url" do
+      @app.indextank = @indextank_url
+      @app.indextank_url.should == @indextank_url
+    end
+
+    it "calls #indextank to instantiate an IndexTank::Client" do
+      @app.should_receive(:indextank)
+      @app.indextank = @indextank_url
+    end
+  end
+end
+
+describe "register the extension" do
+  before do
+    @app = Sinatra.new
+  end
+
+  it "sets indextank_url from the environment variable" do
+    @indextank_url = "http://:public_api@public.api.indextank.com"
+    ENV['INDEXTANK_API_URL'] = @indextank_url
+    @app.register(Sinatra::IndexTankExtension)
+
+    @app.indextank_url.should == @indextank_url
+  end
+end
+
+describe "Sinatra::IndexTankHelper" do
+  before do
+    @app = Sinatra.new
+  end
+
+  it "registers the helpers" do
+    @app.should_receive(:helpers).with(Sinatra::IndexTankHelper)
+    @app.register(Sinatra::IndexTankExtension)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'sinatra/indextank'
+require 'rspec'

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-indextank
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Brian Ryckbost
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70229850385780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70229850385780
+- !ruby/object:Gem::Dependency
+  name: indextank
+  requirement: &70229850385320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70229850385320
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70229850384800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70229850384800
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70229850384260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70229850384260
+description: A simple extension to sinatra for using IndexTank
+email:
+- brian@collectiveidea.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.textile
+- Rakefile
+- lib/sinatra/indextank.rb
+- sinatra-indextank.gemspec
+- spec/sinatra-indextank_spec.rb
+- spec/spec_helper.rb
+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: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A simple extension to sinatra for using IndexTank
+test_files:
+- spec/sinatra-indextank_spec.rb
+- spec/spec_helper.rb