opensearchkick 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcc6e246526ed9d767bcf1c617c0d653554cd21b
+  data.tar.gz: 2df603d246a87eafde008b60730fe377277ebd58
+SHA512:
+  metadata.gz: 5e2f07c0265c3e1f5a8631a94360464e086c8acfb6f0cf7cc00bfc37feb58d6bb0c815bab6d4b5512ba271d1e995044bdee2f51fcca583d3f8ffe97bf6c692ff
+  data.tar.gz: 22dc3bda7db863a2fab204861ed610fcfb08427179219a74c10d9af3daa039af1e34661e8782f30378a7b590d7d404310b0a78b22abc7b0860e54a6a7029973d

data/.gitattributes

@@ -0,0 +1,17 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.idea/*

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Håkan Nylén
+
+MIT License
+
+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.md

@@ -0,0 +1,42 @@
+# Opensearchkick
+
+Adding opensearch fuinctionality to your Application. Right now untested opensearch-functionality. Soon with suggestion support.
+
+## Dependency
+
+opensearchkick will use `searchkick` for the suggestion functionality.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'opensearchkick'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install opensearchkick
+    
+
+## Usage
+
+You config everything with the initializer, create it by running the following command:
+
+    $ rails g opensearchkick:install
+
+And you will have opensearchkick.rb in your initializer directory. After that you just need to add following line to your header:
+
+    <link rel="search" type="application/opensearchdescription+xml" href="opensearch.xml" title="Your Application name" />
+
+## Contributing
+
+1. Fork it ( https://github.com/dirble/opensearchkick/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/controllers/opensearchkick/opensearch_controller.rb

@@ -0,0 +1,16 @@
+module Opensearchkick
+  class OpensearchController < ApplicationController
+    def opensearch
+      response.headers['Content-Type'] = 'application/opensearchdescription+xml; charset=utf-8'
+      @description = Configuration.description
+      @contact_email = Configuration.contact_email
+      @title = Configuration.default_title
+      @url = Configuration.search_url
+      @image_path = Configuration.image_path
+      respond_to :xml
+    end
+    def suggestions
+      # TODO: add suggestion support
+    end
+  end
+end

data/app/views/opensearchkick/opensearch/opensearch.xml.builder

@@ -0,0 +1,13 @@
+xml.instruct!
+xml.OpenSearchDescription(:xmlns => 'http://a9.com/-/spec/opensearch/1.1/', 'xmlns:moz' => 'http://www.mozilla.org/2006/browser/search/') do
+  xml.ShortName(@title)
+  xml.InputEncoding('UTF-8')
+  xml.Description(@description)
+  xml.Contact(@contact_email)
+  if @image_path.present?
+    xml.Image(@image_path, height: 16, width: 16, type: 'image/png')
+  end
+  # escape route helper or else it escapes the '{' '}' characters. then search doesn't work
+  xml.Url(type: 'text/html', method: 'get', template: CGI::unescape(@url))
+  xml.moz(:SearchForm, root_url)
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  get 'opensearch' => 'opensearchkick/opensearch#opensearch'
+  get 'opensearch/suggestions' => 'opensearchkick/opensearch#suggestions'
+end

data/lib/generators/opensearchkick/install_generator.rb

@@ -0,0 +1,14 @@
+module Opensearchkick
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates Opensearchkick initializer for your application"
+
+      def copy_initializer
+        template "opensearchkick_initializer.rb", "config/initializers/opensearchkick.rb"
+
+        puts "Install complete! Truly Outrageous!"
+      end
+    end
+  end
+end

data/lib/generators/templates/opensearchkick_initializer.rb

@@ -0,0 +1,16 @@
+Opensearchkick::Configuration.configure do |config|
+  # the most important thing, the url to the search, {searchTerms} is where the query will be.
+  config.search_url = 'http://localhost/search?q={searchTerms}'
+
+  # the title of the search
+  # config.default_title = 'Opensearch'
+
+  # The description shown in opensearch to describe your website/search
+  # config.description = 'Opensearch to search in your browser.'
+
+  # set contact email for people wanna contact you
+  # config.contact_email = 'opensearch@test.org'
+  
+  # set a image you want to show for opensearch (like a logo)
+  # config.image_path = '/public/logo.png'
+end

data/lib/opensearchkick.rb

@@ -0,0 +1,11 @@
+require "opensearchkick/version"
+require 'opensearchkick/engine'
+require "confiture"
+module Opensearchkick
+  class Configuration
+    include Confiture::Configuration
+
+    confiture_allowed_keys(:description, :contact_email, :default_title, :search_url, :image_path)
+    confiture_defaults(description: 'A opensearch', contact_email: 'opensearch@test.org', default_title:'Opensearch for your application', search_url: 'http://localhost/search?q={searchTerms}', image_path: nil)
+  end
+end

data/lib/opensearchkick/engine.rb

@@ -0,0 +1,3 @@
+module Opensearchkick
+  class Engine < Rails::Engine; end
+end

data/lib/opensearchkick/version.rb

@@ -0,0 +1,3 @@
+module Opensearchkick
+  VERSION = "0.0.1"
+end

data/opensearchkick.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opensearchkick/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "opensearchkick"
+  spec.version       = Opensearchkick::VERSION
+  spec.authors       = ["Håkan Nylén"]
+  spec.email         = ["hakan@dun.se"]
+  spec.summary       = %q{Opensearch for your Rails Application}
+  spec.description   = %q{adding opensearch functionality to your application with suggestions and more.}
+  spec.homepage      = "http://github.com/dirble/opensearchkick/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('confiture', '>= 0.1')
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: opensearchkick
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Håkan Nylén
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: confiture
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: adding opensearch functionality to your application with suggestions
+  and more.
+email:
+- hakan@dun.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitattributes
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/opensearchkick/opensearch_controller.rb
+- app/views/opensearchkick/opensearch/opensearch.xml.builder
+- config/routes.rb
+- lib/generators/opensearchkick/install_generator.rb
+- lib/generators/templates/opensearchkick_initializer.rb
+- lib/opensearchkick.rb
+- lib/opensearchkick/engine.rb
+- lib/opensearchkick/version.rb
+- opensearchkick.gemspec
+homepage: http://github.com/dirble/opensearchkick/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Opensearch for your Rails Application
+test_files: []