locomotive_google_search 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7dfb734c0125e4af3747ce178eb49e2e2e3797b1
+  data.tar.gz: 5adabe83589a8a465cd3df1a35b9e8c5874ddfae
+SHA512:
+  metadata.gz: a40734cd899868e36a1bc95d9e2ae2770d4a7420d6c093cb413aba1574018d7b0412fd4db728c773c16a51679647c4a343dff1cb305f4ef26bf7024adaaeb133
+  data.tar.gz: 880b5f4aaab35747e91fa652d21f8634883be5313efc88602ab5c2009518c0271f59c5b573b01e35169cb94f78f8a73fac7407f5c1e0df45db99cdd06fecf381

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,36 @@
+# LocomotiveGoogleSearch
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/locomotive_google_search`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'locomotive_google_search'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install locomotive_google_search
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/locomotive_google_search.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "locomotive_google_search"
+
+# 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/locomotive_google_search.rb

@@ -0,0 +1,6 @@
+require 'locomotive_google_search/middlewares/custom_drops'
+require 'locomotive/steam'
+
+Locomotive::Steam.configure_extension do |config|
+  config.middleware.insert_after Locomotive::Steam::Middlewares::Page, LocomotiveGoogleSearch::Middlewares::CustomDrops
+end

data/lib/locomotive_google_search/google_search/query.rb

@@ -0,0 +1,64 @@
+require 'open-uri'
+
+class GoogleSearch::Query
+
+  attr_reader :term, :start, :data, :results
+
+  def initialize(args = {})
+    @term = args[:term]
+    @start = args[:start].try(:to_s) || "1"
+    pull_data
+    build_results
+  end
+
+  private
+
+    def build_results
+      @results = data["items"].map do |item_hash|
+        GoogleSearch::Result.new(item_hash)
+      end
+      return @results
+    end
+
+    def pull_data
+      @data = Rails.env.development? ? stubbed_json : JSON.parse(open(generate_url).read)
+    end
+
+    def start_hash
+      return {} unless start.present?
+      return { start: start }
+    end
+
+    def options
+      @options ||= { key: ENV["GOOGLE_API_KEY"], cx: ENV["GOOGLE_SEARCH_ENGINE_ID"], q: term }.merge(start_hash)
+    end
+
+    def base_url
+      "https://www.googleapis.com/customsearch/v1?"
+    end
+
+    def generate_url(args = {})
+      path = args[:path]
+      url = base_url
+      return url unless options.present?
+      options_string = ""
+      option_to_string = Proc.new {|k, v, index| "#{'&' unless index == 0}#{k.to_s}=#{v.to_s}"}
+      options.each_with_index do |(key, value), index|
+        if value.is_a?(String)
+          options_string << option_to_string.call(key, value, index)
+        elsif value.is_a?(Array)
+          value.each do |val|
+            options_string << option_to_string.call(key, val, index)
+          end
+        else
+          raise "Currently only string and array values are supported. You tried a #{value.class} value."
+        end
+      end
+      URI.encode("#{url}#{options_string}")
+    end
+
+    def stubbed_json
+      JsonData.new(file_name: "google_search").gather
+    end
+
+end

data/lib/locomotive_google_search/google_search/result.rb

@@ -0,0 +1,15 @@
+class GoogleSearch::Result
+
+  attr_reader :title, :link, :snippet
+
+  def initialize(args = {})
+    @title = args["title"]
+    @link = args["link"]
+    @snippet = args["snippet"]
+  end
+
+  def to_liquid
+    Shop::Liquid::Drops::Result.new(self)
+  end
+
+end

data/lib/locomotive_google_search/google_search/search.rb

@@ -0,0 +1,43 @@
+class GoogleSearch::Search
+
+  attr_reader :term, :page, :results, :options, :query
+
+  def initialize(args = {})
+    @term = args[:term]
+    @page = args[:page].try(:to_i) || 1
+    start = ((@page - 1) * 10) + 1
+    @options = { term: term, start: start }
+    search_and_return_one_page
+  end
+
+  def search_and_return_all_results
+    @results = []
+
+    more_pages = true
+    while more_pages
+      search = GoogleSearch::Query.new(options)
+      @results << search.results
+      more_pages = search.data["queries"]["nextPage"].present? ? true : false
+      options[:start] += 10
+    end
+    @results.flatten!
+  end
+
+  def search_and_return_one_page
+    @query = GoogleSearch::Query.new(options)
+    @results = @query.results
+  end
+
+  def has_next_page?
+    query.data["queries"]["nextPage"].present?
+  end
+
+  def next_page
+    ((query.data["queries"]["nextPage"].first["startIndex"].to_i - 1) / 10) + 1
+  end
+
+  def previous_page
+    page - 1
+  end
+
+end

data/lib/locomotive_google_search/liquid/drops/result.rb

@@ -0,0 +1,11 @@
+module LocomotiveGoogleSearch
+  module Liquid
+    module Drops
+      class Result < ::Locomotive::Liquid::Drops::Base
+
+        delegate :title, :link, :snippet, :to => :@_source
+
+      end
+    end
+  end
+end

data/lib/locomotive_google_search/liquid/drops/search.rb

@@ -0,0 +1,64 @@
+module LocomotiveGoogleSearch
+  module Liquid
+    module Drops
+      class Search < ::Liquid::Drop
+
+        def first
+          self.collection.first
+        end
+
+        def refresh
+          @search_object = nil
+        end
+
+        def last
+          self.collection.last
+        end
+
+        def each(&block)
+          self.collection.each(&block)
+        end
+
+        def each_with_index(&block)
+          self.collection.each_with_index(&block)
+        end
+
+        def page
+          @context.registers[:controller].params[:page] || 1
+        end
+
+        def options
+          text = @context.registers[:controller].params[:query]
+          { term: text, page: page }
+        end
+
+        def search_object
+          return @search_object if @search_object.present?
+          @search_object = ::GoogleSearch::Search.new(options)
+        end
+
+        def collection
+          @search_object = nil # @collection is cached across requests
+          @collection = search_object.results
+        end
+
+        def next_page
+          search_object.next_page
+        end
+
+        def next_page?
+          search_object.has_next_page?
+        end
+
+        def previous_page?
+          page != 1
+        end
+
+        def previous_page
+          search_object.previous_page
+        end
+
+      end
+    end
+  end
+end

data/lib/locomotive_google_search/middlewares/custom_drops.rb

@@ -0,0 +1,22 @@
+require 'locomotive_google_search/google_search/query'
+require 'locomotive_google_search/google_search/result'
+require 'locomotive_google_search/google_search/search'
+require 'locomotive_google_search/liquid/drops/results'
+require 'locomotive_google_search/liquid/drops/search'
+
+module LocomotiveGoogleSearch
+  module Middlewares
+    class CustomDrops
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        (env['steam.liquid_assigns'] ||= {}).tap do |assigns|
+          assigns['google_search'] = LocomotiveGoogleSearch::Liquid::Drops::Search.new
+        end
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/locomotive_google_search/version.rb

@@ -0,0 +1,3 @@
+module LocomotiveGoogleSearch
+  VERSION = "0.1.1"
+end

data/locomotive_google_search.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'locomotive_google_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "locomotive_google_search"
+  spec.version       = LocomotiveGoogleSearch::VERSION
+  spec.authors       = ["Ryan Francis"]
+  spec.email         = ["ryan.p.francis@gmail.com"]
+
+  spec.summary       = %q{A gem for implementing Google Search in LocomotiveCMS}
+  spec.homepage      = "https://github.com/LaunchPadLab/locomotive_google_search"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: locomotive_google_search
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ryan Francis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- ryan.p.francis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/locomotive_google_search.rb
+- lib/locomotive_google_search/google_search/query.rb
+- lib/locomotive_google_search/google_search/result.rb
+- lib/locomotive_google_search/google_search/search.rb
+- lib/locomotive_google_search/liquid/drops/result.rb
+- lib/locomotive_google_search/liquid/drops/search.rb
+- lib/locomotive_google_search/middlewares/custom_drops.rb
+- lib/locomotive_google_search/version.rb
+- locomotive_google_search-0.1.0.gem
+- locomotive_google_search.gemspec
+homepage: https://github.com/LaunchPadLab/locomotive_google_search
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A gem for implementing Google Search in LocomotiveCMS
+test_files: []