duckgo 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0d934faf234d88f43a383ecfa3e20dd1aa1e58f
+  data.tar.gz: 7314de47148059cd100b1b7ac61121213a490757
+SHA512:
+  metadata.gz: c81412466434d637c53743ca276415f49c0c4b0a6a4c55b0ae601fa55d7df053df4bae1a62827824138fdc6854f9719723ffc7e0f286aefd77b8f49ac5e53ac8
+  data.tar.gz: 53ca76ff164324590185fd019fd92771ba064cbf03f46031bda5164037bdaea1b7ac1be2775fc7e600acc881ab841126a07f59b4d8fbc1c210ca37ecdbf2d79f

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/.rake_tasks~

@@ -0,0 +1,6 @@
+build
+clean
+clobber
+install
+install:local
+release[remote]

data/.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug Ruby",
+      "type": "Ruby",
+      "request": "launch",
+      "program": "${file}"
+    }
+  ]
+}

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Daniel E
+
+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,37 @@
+# DuckGo - API wrapper for DuckDuckGo
+
+[![Gem Version](https://badge.fury.io/rb/duckgo.svg)](https://badge.fury.io/rb/duckgo)
+
+## What it does
+
+DuckGo is a RubyGem library and command line tool for searching with DuckDuckGo.
+By default, it puts out only the relevant information, but when told, it will dump
+all the data you could ask for. This tool aims to give access to most of the
+features from the official API.
+
+## Installation
+
+Install with RubyGems:
+
++ `sudo gem install duckgo`
+
+Then include this in your scripts:
+
+```ruby
+require 'duckgo'
+include DuckGo
+
+# Your stuff here
+```
+
+
+## API and Usage
+
+Check out the [documentation](https://github.com/wlib/duckgo/tree/master/docs)
+## Contribute
+
+If you use and enjoy DuckGo...
+
+[Fork the project](https://github.com/wlib/duckgo/fork)
+
+## [MIT License](https://github.com/wlib/duckgo/blob/master/LICENSE)

data/Rakefile

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

data/bin/duckgo

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# DuckGo is a RubyGem library and command line tool for searching with DuckDuckGo.
+# By default, it puts out only the relevant information, but when told, it will dump
+# all the data you could ask for. This tool aims to give access to most of the
+# features from the official API.
+# Daniel Ethridge
+
+require "duckgo"
+include DuckGo
+require "duckgo/version"
+
+# If there are no arguments...
+if ARGV.length == 0
+  puts "Hmm..."
+  exit
+end
+
+help = """DuckGo lets you search duckduckgo.com for instant answers
+
+duckgo [--help | -h]         :  Display this help
+duckgo [--version | -V]      :  Display version
+duckgo something searchable  :  Auto-handle the search
+duckgo \!gem duckgo          :  Use !bang syntax to search a specific site
+
+View docs and API on https://github.com/wlib/duckgo
+Made by Daniel Ethridge | git.io/de
+"""
+
+# Argument "parser" if you want to call it that
+case ARGV[0]
+  when "--help", "-h"
+    puts help
+    exit
+  when "--version", "-V"
+    puts "DuckGo v#{VERSION}"
+    exit
+  else
+    handle(ARGV[0..-1].join(" "))
+    exit
+end

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/docs/README.md

@@ -0,0 +1,42 @@
+# Basic API Usage and Quick Start
+
+## Example
+
+Here's the output of a topic summary request for ["unix"](http://api.duckduckgo.com/?q=unix&o=json&pretty=1), there is a huge amount of extra noise.
+
+Now with automatic relevant data handling with `handle()`, we can extract the information
+we want. Here's how:
+```Ruby
+require 'yaml'
+require 'duckgo'
+include DuckGo
+
+result = handle("unix")
+puts result.to_yaml
+```
+
+And this is the *now filtered* result:
+
+```YAML
+---
+Heading: Unix
+Entity: os
+Type: Article
+Description: Unix is a family of multitasking, multiuser computer operating systems
+  that derive from the original AT&T Unix, developed starting in the 1970s at the
+  Bell Labs research center by Ken Thompson, Dennis Ritchie, and others.
+Further Reading: https://en.wikipedia.org/wiki/Unix
+Related:
+- Unix Category
+- Market share of operating systems - The usage share of operating systems is the
+[...]
+
+Infobox:
+  Company / developer: Ken Thompson, Dennis Ritchie, Brian Kernighan, Douglas McIlroy,
+    and Joe Ossanna at Bell Labs
+  Written in: C and assembly language
+[...]
+
+Results:
+  Official site: http://unix.org
+```

data/docs/getting_data.md

@@ -0,0 +1,93 @@
+# Getting Data
+
+## get()
+
+`get()` is the function used to recieve data from any page with any paramaters on any site,
+but by default knows to just call duckduckgo's api with a paramater hash as the first argument.
+
+### Arguments
+
+`get(params, path="/", domain="https://api.duckduckgo.com")`
+
++ `params`
+  - A hash with query paramaters
++ `path`
+  - The endpoint path
++ `domain`
+  - The domain of the website called
+
+### Usage
+
+```Ruby
+duckduckgo = {
+  "q" => "search string",
+  "format" => "json"
+}
+
+wikipedia = {
+  "action" => "opensearch",
+  "search" => "wiki"
+}
+
+puts get(duckduckgo) #=> "{"DefinitionSource":..."
+puts get(wikipedia, "/w/api.php", "https://en.wikipedia.org") #=> "["wiki",["Wiki","Wikipedia","Wikimedia..."
+```
+
+## get_data()
+
+This is a wrapper around `get()` to recieve duckduckgo's instant answers data.
+
+### Arguments
+
+`get_data(keywords, format=0, skip_disambig=1, no_redirect=1, parse=true)`
+
++ `keywords`
+  - The keywords passed into the search
++ `format`
+  - The returned format
+    - 0 : json (default)
+    - 1 : xml
++ `skip_disambig`
+  - Whether or not to skip a disambiguation result
+    - 0 : don't skip
+    - 1 : skip (default)
++ `no_redirect`
+  - If this is a [!bang redirect](https://duckduckgo.com/bang), decide if we should follow the redirect
+    - 0 : follow redirect
+    - 1 : don't redirect (default)
++ `parse`
+  - Return a parsed hash instead of a string, only parses if format is json
+    - true : return a hash (default)
+    - false : return a string
+
+### Usage
+
+```Ruby
+require 'yaml'
+
+data = get_data("something")
+puts data.to_yaml
+#=> "---
+# DefinitionSource: ....
+```
+
+## get_favicon()
+
+Another wrapper that just gets a website's favicon
+
+### Arguments
+
+`get_favicon(page)`
+
++ `page`
+  - The webpage or site domain to get the favicon from
+
+### Usage
+
+```Ruby
+site = "google.com"
+file = File.open("#{site}-favicon.ico", "w")
+favicon = get_favicon(site)
+file.write(favicon)
+file.close
+```

data/duckgo.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'duckgo/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "duckgo"
+  gem.version       = DuckGo::VERSION
+  gem.authors       = ["Daniel Ethridge"]
+  gem.email         = ["danielethridge@icloud.com"]
+  gem.license = 'MIT'
+
+  gem.summary       = %q{DuckGo is a RubyGem library and command line tool for searching with DuckDuckGo.
+By default, it puts out only the relevant information, but when told, it will dump
+all the data you could ask for. This tool aims to give access to most of the
+features from the official API.}
+  gem.homepage      = "https://github.com/wlib/duckgo"
+
+  gem.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  gem.bindir        = "bin"
+  gem.executables   = ["duckgo"]
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "bundler", "~> 1.13"
+  gem.add_development_dependency "rake", "~> 10.0"
+end

data/lib/duckgo.rb

@@ -0,0 +1,176 @@
+#!/usr/bin/env ruby
+# Daniel Ethridge
+
+require 'uri'
+require 'open-uri'
+require 'json'
+require 'yaml'
+
+module DuckGo
+  # Do a raw api request based on paramaters
+  def get(params, path="/", domain="https://api.duckduckgo.com") # domain can also just be plain duckduckgo.com
+    if params.nil?
+      endpoint = "#{domain}/#{path}"
+    else
+      endpoint = "#{domain}/#{path}?#{URI.encode_www_form(params)}"
+    end
+    body = open(endpoint).read
+    return body
+  end
+
+  # Dump the useful data straight from DuckDuckGo's API
+  # If format is XML, return it as a string even if parse is true
+  def get_data(keywords, format=0, skip_disambig=1, no_redirect=1, parse=true)
+    params = {
+      "q" => keywords,
+      "format" => ["json", "xml"][format],
+      "skip_disambig" => [0, 1][skip_disambig],
+      "no_redirect" => [0, 1][no_redirect]
+    }
+    keywords.split(" ").each do |word|
+      if word.start_with?("!")
+        puts "Warning: '!x word' syntax results in a bang redirect"
+      end
+    end
+    body = get(params)
+    if parse
+      if format == 0
+        return JSON.parse(body)
+      else
+        return body
+      end
+    else
+      return body
+    end
+  end
+
+  # Get a website/page's favicon through duckduckgo's proxy
+  def get_favicon(page)
+    favicon = get(nil, "/i/#{page}.ico")
+    if favicon == "GIF89a\x01\x00\x01\x00\x80\x01\x00\x00\x00\x00\xFF\xFF\xFF!\xF9\x04\x01\x00\x00\x01\x00,\x00\x00\x00\x00\x01\x00\x01\x00\x00\x02\x02L\x01\x00;"
+      puts "Response is 200-OK, but content is a generic response"
+      return nil
+    else
+      return favicon
+    end
+  end
+
+  # Return data describing the extra info fields
+  def find_extras(data)
+    extras = {}
+    unless data["Infobox"].empty?
+      extras["Infobox"] = {
+        "Total" => data["Infobox"]["content"].length
+      }
+    end
+    unless data["Results"].empty?
+      extras["Results"] = {
+        "Total" => data["Results"].length
+      }
+    end
+    unless data["Answer"].empty?
+      extras["Answer"] = {
+        "Answer" => data["Answer"],
+        "Type" => data["AnswerType"]
+      }
+    end
+    unless data["Definition"].empty?
+      extras["Definition"] = {
+        "Definition" => data["Definition"],
+        "Source" => data["DefinitionSource"],
+        "URL" => data["DefinitionURL"]
+      }
+    end
+    unless data["Redirect"].empty?
+      extras["Bang Redirect"] = data["Redirect"]
+    end
+    return extras
+  end
+
+  # Extract extra info based on an input extras_data
+  def extract_extras(data, extras_data)
+    extras = {}
+    if extras_data["Infobox"]
+      extras["Infobox"] = extract_infobox(data)
+    end
+    if extras_data["Results"]
+      extras["Results"] = extract_results(data)
+    end
+    if extras_data["Answer"]
+      extras["Answer"] = extras_data["Answer"]
+    end
+    if extras_data["Definition"]
+      extras["Definition"] = extras_data["Definition"]
+    end
+    if extras_data["Bang Redirect"]
+      extras["Bang Redirect"] = extras_data["Bang Redirect"]
+    end
+    return extras
+  end
+
+  # Extract common info
+  def extract_common(data)
+    output = {
+      "Heading" => data["Heading"],
+      "Entity" => data["Entity"],
+      "Type" => "",
+      "Description" => data["AbstractText"],
+      "Further Reading" => data["AbstractURL"],
+      "Related" => []
+    }
+    case data["Type"]
+      when "A"
+        type = "Article"
+      when "C"
+        type = "Category"
+      when "D"
+        type = "Disambiguation"
+      when "E"
+        type = "Exclusive"
+      when "N"
+        type = "Name"
+      else
+        type = "Nothing or unknown"
+    end
+    output["Type"] = type
+    data["RelatedTopics"].each do |topic|
+      unless topic["Text"].nil?
+        output["Related"] << topic["Text"]
+      end
+    end
+    output.delete_if do |key, value|
+       value.empty?
+    end
+    return output
+  end
+
+  # Extract results from hash
+  def extract_results(data)
+    output = {}
+    data["Results"].each do |result|
+      output[result["Text"]] = result["FirstURL"]
+    end
+    return output
+  end
+
+  # Extract infobox from hash
+  # Official example : http://api.duckduckgo.com/?q=valley+forge+national+park&format=json&pretty=1
+  def extract_infobox(data)
+    output = {}
+    tsums = data["Infobox"]["content"]
+    tsums.each do |section|
+      output[ section["label"] ] = section["value"]
+    end
+    return output
+  end
+
+  # Handle a common search automatically
+  def handle(keywords)
+    data = get_data(keywords)
+    common = extract_common(data)
+    extras_data = find_extras(data)
+    extras = extract_extras(data, extras_data)
+    result = common.merge(extras)
+    puts result.to_yaml
+  end
+end

data/lib/duckgo/version.rb

@@ -0,0 +1,3 @@
+module DuckGo
+  VERSION = "1.1.0"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: duckgo
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Daniel Ethridge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-05 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'
+description: 
+email:
+- danielethridge@icloud.com
+executables:
+- duckgo
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rake_tasks~"
+- ".vscode/launch.json"
+- LICENSE
+- README.md
+- Rakefile
+- bin/duckgo
+- bin/setup
+- docs/README.md
+- docs/getting_data.md
+- duckgo.gemspec
+- lib/duckgo.rb
+- lib/duckgo/version.rb
+homepage: https://github.com/wlib/duckgo
+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.5.1
+signing_key: 
+specification_version: 4
+summary: DuckGo is a RubyGem library and command line tool for searching with DuckDuckGo.
+  By default, it puts out only the relevant information, but when told, it will dump
+  all the data you could ask for. This tool aims to give access to most of the features
+  from the official API.
+test_files: []