intel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b03f995035ea2892df23d4d49479c10d8e2e6fe5
+  data.tar.gz: 1770eb2f64a96b5751fbafcfce6c87aab2f31225
+SHA512:
+  metadata.gz: 8827a71c28cba3c68a2b76dea14573cd8f7420ee4239dc55f8cbc087943153315b2efe8be03b99c647250ed6677e8bcbb72119e0653561b1be92254f082ed9b2
+  data.tar.gz: 08955ef22b11378624daffc0fec7291cd4778881d2e84daf68b43c9cb6fc793db4eff29ca9461a59869e6536cedd2b5c27e6e39b0c81f19c7ae4843992272d3b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Kane
+
+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,56 @@
+# Intel
+
+Search analytics made easy
+
+- track searches and conversions
+- watch searches in real-time [coming soon]
+- view searches with low conversions or no results [coming soon]
+
+## Get Started
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem "intel"
+```
+
+Create a table to keep track of searches.
+
+```sh
+rails generate intel:install
+rake db:migrate
+```
+
+Use the `track` option to track searches.
+
+```ruby
+Item.search "apple", track: true
+```
+
+Want to track more attributes?  Just add them to the `searches` table with migrations and pass the values to the `track` option.
+
+```ruby
+Item.search "apple", track: {user_id: true, source: "web"}
+```
+
+It’s that easy!
+
+## View the Data [coming soon]
+
+Add the dashboards to your `config/routes.rb`.
+
+```ruby
+mount Intel::Engine => "searches"
+```
+
+Be sure to protect the endpoint in production.
+
+[show example]
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/intel.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'intel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "intel"
+  spec.version       = Intel::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+  spec.description   = %q{Search analytics made easy}
+  spec.summary       = %q{Search analytics made easy}
+  spec.homepage      = "https://github.com/ankane/intel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "searchkick"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/generators/intel/install_generator.rb

@@ -0,0 +1,29 @@
+# taken from https://github.com/collectiveidea/audited/blob/master/lib/generators/audited/install_generator.rb
+require "rails/generators"
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+
+module Intel
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      def copy_migration
+        migration_template "install.rb", "db/migrate/install_intel.rb"
+      end
+    end
+  end
+end

data/lib/generators/intel/templates/install.rb

@@ -0,0 +1,10 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :searches do |t|
+      t.string :searchable_type
+      t.string :query
+      t.integer :results_count
+      t.timestamp :created_at
+    end
+  end
+end

data/lib/intel.rb

@@ -0,0 +1,14 @@
+require "searchkick"
+require "intel/search"
+require "intel/track"
+require "intel/engine"
+require "intel/version"
+
+module Searchkick
+  module Search
+    include Intel::Track
+
+    alias_method :search_without_track, :search
+    alias_method :search, :search_with_track
+  end
+end

data/lib/intel/engine.rb

@@ -0,0 +1,4 @@
+module Intel
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/intel/search.rb

@@ -0,0 +1,4 @@
+module Intel
+  class Search < ActiveRecord::Base
+  end
+end

data/lib/intel/track.rb

@@ -0,0 +1,16 @@
+module Intel
+  module Track
+
+    def search_with_track(term, options = {})
+      results = search_without_track(term, options)
+
+      if options[:track]
+        attributes = options[:track] == true ? {} : options[:track]
+        Intel::Search.create({searchable_type: self.name, query: term, results_count: results.total_count}.merge(attributes))
+      end
+
+      results
+    end
+
+  end
+end

data/lib/intel/version.rb

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

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: intel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: searchkick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Search analytics made easy
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- intel.gemspec
+- lib/generators/intel/install_generator.rb
+- lib/generators/intel/templates/install.rb
+- lib/intel.rb
+- lib/intel/engine.rb
+- lib/intel/search.rb
+- lib/intel/track.rb
+- lib/intel/version.rb
+homepage: https://github.com/ankane/intel
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Search analytics made easy
+test_files: []