gugl 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fccdc086bbec504323e41dc2f940dc9a49c7781e
+  data.tar.gz: 9cb928ffc3da6cf87be2f09981cd057dd67594dc
+SHA512:
+  metadata.gz: 511e8836e260f17864ca9974c2f0c3dae0d1bee3ab7cbbf7942b3c158852580a3a96811d6881a37af6805c79fe4f14fc417f67a2c29bdb7446f88e9b6239d0cb
+  data.tar.gz: ee3166ad00044285d8e605ab883d0e0488c4c124558b20a68e8ac84717bbcc283ef0396a293511c5e4ae9501d0999262b777a76b1bb55673e0ba59d0546ffe9d

data/bin/gugl

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+# Usage:
+# 
+# gugl "word"
+# gugl "word" -l 2
+# 
+
+require_relative "../lib/gugl"
+
+# the easy way
+
+query = ARGV[0]
+limit = ARGV[2]
+
+searcher = Gugl.searcher.new
+
+searcher.authorize do |auth|
+  auth.key  = ENV["GOOGLE_CUSTOM_SEARCH_KEY"]
+  auth.cx   = ENV["GOOGLE_CUSTOM_SEARCH_CX"]
+end
+
+if limit
+  searcher.limit = limit
+end
+
+searcher.query = query
+
+searcher.search_and_display

data/lib/gugl.rb

@@ -0,0 +1,9 @@
+require_relative 'search/searcher'
+
+module Gugl
+  extend self
+  
+  def searcher
+    Search::Searcher
+  end
+end

data/lib/search/api_credentials.rb

@@ -0,0 +1,11 @@
+module Gugl
+  module Search
+    class ApiCredentials
+      attr_accessor :key, :cx
+      
+      def to_h
+        { key: key,  cx: cx }
+      end
+    end
+  end
+end

data/lib/search/data_getter.rb

@@ -0,0 +1,26 @@
+require_relative './remote_searcher'
+require_relative './result_item'
+
+module Gugl
+  module Search
+    class DataGetter
+      attr_accessor :query, :limit
+  
+      def get
+        searcher.search(query, limit) do |items|
+          items.map(&method(:build_item))
+        end
+      end
+  
+      def searcher
+        @searcher ||= RemoteSearcher.new
+      end
+  
+      private
+  
+      def build_item(item)
+        ResultItem.new(item)
+      end
+    end
+  end
+end

data/lib/search/displayers/displayer_mapper.rb

@@ -0,0 +1,27 @@
+require_relative './terminal_result_displayer'
+require_relative './mini_terminal_result_displayer'
+
+module Gugl
+  module Search
+    module Displayers
+      module DisplayerMapper
+        extend self
+  
+        DISPLAYERS = {
+          term: ->{ Displayers::TerminalResultDisplayer.new },
+          mini_term: ->{ Displayers::MiniTerminalResultDisplayer.new },
+        }
+        
+        DEFAULT_DISPLAYER = :term
+  
+        def [](key)
+          if key == :default
+            DISPLAYERS[DEFAULT_DISPLAYER].call
+          else
+            DISPLAYERS[key].call
+          end
+        end
+      end
+    end
+  end
+end

data/lib/search/displayers/mini_terminal_result_displayer.rb

@@ -0,0 +1,17 @@
+require 'term/ansicolor'
+
+module Gugl
+  module Search
+    module Displayers
+      class MiniTerminalResultDisplayer
+        include Term::ANSIColor
+  
+        def display(result, index)
+          # title => link
+          print magenta, result.title, reset, "  => "
+          print blue, result.link, reset, "\n"
+        end
+      end
+    end
+  end
+end

data/lib/search/displayers/terminal_result_displayer.rb

@@ -0,0 +1,24 @@
+require 'term/ansicolor'
+
+module Gugl
+  module Search
+    module Displayers
+      class TerminalResultDisplayer
+        include Term::ANSIColor
+        
+        ENDING_LINES = 50
+  
+        def display(result, index)
+          # title
+          print magenta, index.next, ".", result.title, reset, "\n\n"
+          # snippet
+          print white, result.snippet, "\n\n", reset
+          # link
+          print white, "Link: ", blue, result.link, reset, "\n\n"
+    
+          print ("-" * ENDING_LINES), "\n\n"
+        end
+      end
+    end
+  end
+end

data/lib/search/remote_searcher.rb

@@ -0,0 +1,50 @@
+require_relative './api_credentials'
+require 'httparty'
+require 'json'
+
+module Gugl
+  module Search
+    class RemoteSearcher
+      attr_accessor :credentials
+      
+      ITEMS_RESPONSE_NODE = 'items'
+      ERROR_RESPONSE_NODE = 'error'
+      
+      def search(query, limit)
+        data = fetch_and_parse(query, limit)
+        if results = data[ITEMS_RESPONSE_NODE]
+          yield results
+        else
+          raise "Error: #{data[ERROR_RESPONSE_NODE]}"
+        end
+      end
+      
+      def authorize
+        self.credentials = ApiCredentials.new
+        yield credentials
+      end
+  
+      private
+      
+      def fetch_and_parse(query, limit)
+        response = fetch(query, limit)
+        parse_response(response)
+      end
+      
+      def fetch(query, limit)
+        HTTParty.get(base_url, query: {
+          num: limit,
+          q: query
+        }.merge(credentials.to_h))
+      end
+  
+      def base_url
+        "https://www.googleapis.com/customsearch/v1"
+      end
+      
+      def parse_response(response)
+        JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/search/result_item.rb

@@ -0,0 +1,13 @@
+module Gugl
+  module Search
+    class ResultItem
+      attr_reader :title, :snippet, :link
+  
+      def initialize(plain_item)
+        @title = plain_item['title']
+        @snippet = plain_item['snippet'].gsub(/\s{2,}/, ' ')
+        @link = plain_item['link']
+      end
+    end
+  end
+end

data/lib/search/searcher.rb

@@ -0,0 +1,65 @@
+require_relative './data_getter'
+require_relative './displayers/displayer_mapper'
+
+module Gugl
+  module Search
+    class Searcher
+      attr_reader :results
+      attr_accessor :limit, :query
+  
+      DEFAULT_LIMIT = 5
+  
+      def search
+        configure_getter
+        @results = getter.get
+      end
+  
+      def display
+        results.each_with_index.map do |result, index|
+          displayer.display result, index
+        end
+      end
+      
+      def authorize(&blk)
+        getter.searcher.authorize(&blk)
+      end
+      
+      def search_and_display
+        search
+        display
+      end
+      
+      def displayer=(displayer)
+        @displayer = if displayer.is_a?(Symbol)
+          mapped_displayer(displayer)
+        else
+          displayer
+        end
+      end
+      
+      def displayer
+        @displayer ||= mapped_displayer(:default)
+      end
+      
+      def limit
+        @limit ||= DEFAULT_LIMIT
+      end
+  
+      private
+      
+      def mapped_displayer(key)
+        Displayers::DisplayerMapper[key]
+      end
+      
+      def getter
+        @getter ||= DataGetter.new
+      end
+  
+      def configure_getter
+        getter.query = query
+        getter.limit = limit
+      end
+      
+    end
+  end
+end

data/version.rb

@@ -0,0 +1,3 @@
+module Gugl
+  VERSION = '0.1'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: gugl
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Julio García
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: term-ansicolor
+  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'
+description: A wrapper to use google services programmatically, using your google
+  crdedentials, starting with Search.
+email:
+- julioggonz@gmail.com
+executables:
+- gugl
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gugl.rb
+- lib/search/api_credentials.rb
+- lib/search/data_getter.rb
+- lib/search/displayers/displayer_mapper.rb
+- lib/search/displayers/mini_terminal_result_displayer.rb
+- lib/search/displayers/terminal_result_displayer.rb
+- lib/search/remote_searcher.rb
+- lib/search/result_item.rb
+- lib/search/searcher.rb
+- bin/gugl
+- version.rb
+homepage: https://github.com/juliogarciag/gugl
+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.3
+signing_key: 
+specification_version: 4
+summary: A wrapper to use google services programmatically
+test_files: []