rooftop-algolia_search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2352190bf7c0ae24a264a77bb4a15cacc26fbad2
+  data.tar.gz: 169bbb5a16326e5f45c116691730beacf206f34b
+SHA512:
+  metadata.gz: b23dcb04f5a86076523e92f3226c7647e99c23b901817d351884db536759c207ef93b5063e2e83b83c2875b171e22155d91ae0e270a09e4387e14f80bb284dd1
+  data.tar.gz: 921ef5793173242b07ae075b3745f22333dfd5e2b2c6d5519bdfa446c601377a9f9efcba08c9ad7114f0c1e8be592369d6919783954df102c9dea6a0bda9daa7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+rooftop-algolia_search

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ed@errorstudio.co.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ed Jones
+
+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,21 @@
+# Rooftop::AlgoliaSearch
+Index and search your Rooftop post types in Algolia.
+
+## Setup
+To set up, you need:
+
+* an [algolia.com](https://www.algolia.com) account
+* an API key with permissions to write, update and delete items in the index - note that this [should not be your admin key](https://www.algolia.com/doc/guides/security/api-keys/?language=php#admin-api-key)
+* an API key with permissions only to search
+* your application ID
+ 
+ ```ruby
+    Rooftop::AlgoliaSearch.configure do |config|
+      config.index_api_key = "your index api key"
+      config.search_api_key = "your search api key"
+      config.application_id = "your application id"
+    end
+```
+
+## Use
+Include `Rooftop::AlgoliaSearch` in your Rooftop models.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/app/helpers/rooftop/algolia_search/facet_helper.rb

@@ -0,0 +1,25 @@
+module Rooftop
+  module AlgoliaSearch
+    module FacetHelper
+
+      def build_facet_query(hash)
+      #   takes a hash like this:
+      #   {
+      #     foo: ['bar', 'baz'],
+      #     qux: ['boo']
+      #
+      #   }
+
+        # returns this
+        # [["foo:bar", "foo:baz"],"qux:boo"]
+        hash.collect do |k,v|
+          if v.is_a?(Array)
+            v.collect {|val| "#{k}:#{val}"}
+          elsif v.is_a?(String) || v.is_a?(Symbol)
+            "#{k}:#{v}"
+          end
+        end
+      end
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rooftop/algoliasearch"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rooftop/algolia_search/engine.rb

@@ -0,0 +1,21 @@
+module Rooftop
+  module AlgoliaSearch
+    class Engine < ::Rails::Engine
+
+      isolate_namespace Rooftop::AlgoliaSearch
+
+      initializer "add_helpers" do
+        ActiveSupport.on_load(:action_controller) do
+          include Rooftop::AlgoliaSearch::FacetHelper
+        end
+      end
+
+      rake_tasks do
+        Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+      end
+
+
+
+    end
+  end
+end

data/lib/rooftop/algolia_search/post_indexing.rb

@@ -0,0 +1,119 @@
+module Rooftop
+  module AlgoliaSearch
+    module PostIndexing
+
+      def self.included(base)
+        base.extend ClassMethods
+
+        base.send :setup_index_name!
+
+        base.send :after_save, :reindex!
+        base.send :after_destroy, :deindex!
+
+      end
+
+      module ClassMethods
+        attr_reader :search_index_name, :search_index_settings, :search_fields
+
+        def search_index_name=(name)
+          @search_index_name = name
+          setup_index_name!
+        end
+
+        def search_index_settings=(settings)
+          @search_index_settings ||= settings
+        end
+
+        def setup_index_settings!
+          search_index.set_settings(@search_index_settings) unless @search_index_settings.nil?
+        end
+
+        def setup_index_name!
+          @search_index_name ||= self.to_s.underscore
+        end
+
+
+        def add_search_fields(*fields)
+          @search_fields ||= []
+          fields.each {|f| @search_fields << f}
+        end
+
+        def add_search_field(field, options = nil)
+          @search_fields ||= []
+
+          @search_fields << [field, options].compact
+        end
+
+        def search_fields
+          @search_fields ||= []
+        end
+
+        def reindex_all
+          reindex_entities(all.to_a)
+        end
+
+        def reindex_entities(entities)
+          entities = Array.wrap(entities)
+          search_index.add_objects(entities.collect(&:to_search_index_parameters))
+        end
+
+        alias_method :reindex_entity, :reindex_entities
+
+        def deindex_entities(entities)
+          entities = Array.wrap(entities)
+          search_index.delete_objects(entities.collect(&:id))
+        end
+
+        alias_method :deindex_entity, :deindex_entities
+
+        def clear_index!
+          search_index.clear_index
+        end
+
+
+        def search_index
+          @search_index ||= Algolia::Index.new(@search_index_name)
+        end
+
+      end
+
+      # Reindex an instance
+      def reindex!
+        # only reindex things which are published
+        if status == 'publish'
+          self.class.reindex_entity(self)
+        else
+          deindex!
+        end
+      end
+
+      alias :index! :reindex!
+
+      def deindex!
+        self.class.deindex_entity(self)
+      end
+
+      def to_search_index_parameters
+        self.class.search_fields.inject({}) do |hash, fields|
+          hash[:objectID] = self.id
+
+          if fields.last.is_a? Proc
+            hash[fields.first] = fields.last.call(self)
+          else
+            fields.each do |field|
+              begin
+                hash[field] = self.send(field)
+              rescue NoMethodError
+                if self.has_field?(field)
+                  hash[field] = self.fields.send(field)
+                end
+              end
+            end
+          end
+
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/rooftop/algolia_search/post_searching.rb

@@ -0,0 +1,20 @@
+module Rooftop
+  module AlgoliaSearch
+    module PostSearching
+
+      def self.included(base)
+        base.extend ClassMethods
+
+      end
+
+      module ClassMethods
+
+        def search(query, opts = {})
+          opts = opts.with_indifferent_access
+          search_index.search(query, opts).with_indifferent_access
+        end
+      end
+
+    end
+  end
+end

data/lib/rooftop/algolia_search/tasks/algolia_search.rake

@@ -0,0 +1,49 @@
+namespace :rooftop do
+  namespace :algolia_search do
+
+    desc "Initialise index settings for all models which include Rooftop::AlgoliaSearch"
+    task initialize_indexes: :environment do
+      puts "Resetting index settings, which might have been overwritten in the Algolia UI - are you sure?"
+      puts "Please enter Y, y, N or n"
+      STDOUT.flush
+      input = STDIN.gets.chomp
+      case input.upcase
+        when "Y"
+          puts "Continuing"
+        else
+          puts "Cancelled"
+          next
+      end
+      ::Rails.application.eager_load!
+      Rooftop::AlgoliaSearch.included_classes.each do |klass|
+        puts "Setting index settings for #{klass}"
+        klass.setup_index_settings!
+      end
+    end
+
+    desc "Index all searchable entities"
+    task reindex: :environment do
+      puts "Reindexing all - are you sure?"
+      puts "Please enter Y, y, N or n"
+      STDOUT.flush
+      input = STDIN.gets.chomp
+      case input.upcase
+        when "Y"
+          puts "Continuing"
+        else
+          puts "Cancelled"
+          next
+      end
+
+      ::Rails.application.eager_load!
+      Rooftop::AlgoliaSearch.included_classes.each do |klass|
+        puts "Reindexing #{klass}"
+        klass.search_index.clear
+        klass.reindex_entities(klass.all)
+        puts "Done\n"
+      end
+    end
+  end
+end
+
+

data/lib/rooftop/algolia_search/version.rb

@@ -0,0 +1,5 @@
+module Rooftop
+  module AlgoliaSearch
+    VERSION = "0.1.0"
+  end
+end

data/lib/rooftop/algolia_search.rb

@@ -0,0 +1,49 @@
+require 'algoliasearch'
+require "rooftop/algolia_search/version"
+require "rooftop/algolia_search/post_indexing"
+require "rooftop/algolia_search/post_searching"
+if defined?(Rails)
+  require "rooftop/algolia_search/engine"
+end
+
+module Rooftop
+  module AlgoliaSearch
+    class << self
+      attr_accessor :configuration
+      def configure
+        self.configuration ||= Configuration.new
+        yield(configuration)
+        self.configuration.configure_connection
+      end
+    end
+
+    def self.included(base)
+      @included_classes ||= []
+      @included_classes << base unless @included_classes.include?(base)
+      base.include PostIndexing
+      base.include PostSearching
+    end
+
+    class Configuration
+      attr_accessor :index_api_key,
+                    :search_api_key,
+                    :application_id,
+                    :settings
+
+      attr_reader :index_connection, :search_connection
+
+      def configure_connection
+        ::Algolia.init( application_id: @application_id,
+                      api_key: @index_api_key)
+      end
+    end
+
+    class Error < StandardError
+
+    end
+
+    def self.included_classes
+      @included_classes
+    end
+  end
+end

data/rooftop-algolia_search.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rooftop/algolia_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rooftop-algolia_search"
+  spec.version       = Rooftop::AlgoliaSearch::VERSION
+  spec.authors       = ["Ed Jones", "Paul Hendrick"]
+  spec.email         = ["ed@error.agency", "paul@error.agency"]
+
+  spec.summary       = %q{Search your Rooftop models using Algolia from your Ruby applications}
+  spec.homepage      = "https://github.com/rooftopcms/rooftop-ruby-algolia_search"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "algoliasearch", "~> 1"
+  spec.add_dependency "rooftop", "~> 0.1"
+  spec.add_dependency "activesupport", ">= 4.2", "< 6"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: rooftop-algolia_search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ed Jones
+- Paul Hendrick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: algoliasearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rooftop
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+description: 
+email:
+- ed@error.agency
+- paul@error.agency
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/helpers/rooftop/algolia_search/facet_helper.rb
+- bin/console
+- bin/setup
+- lib/rooftop/algolia_search.rb
+- lib/rooftop/algolia_search/engine.rb
+- lib/rooftop/algolia_search/post_indexing.rb
+- lib/rooftop/algolia_search/post_searching.rb
+- lib/rooftop/algolia_search/tasks/algolia_search.rake
+- lib/rooftop/algolia_search/version.rb
+- rooftop-algolia_search.gemspec
+homepage: https://github.com/rooftopcms/rooftop-ruby-algolia_search
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Search your Rooftop models using Algolia from your Ruby applications
+test_files: []