duckgo 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db9f873a22d18a71f87ef838a110ecb668304e04
-  data.tar.gz: 5be7c578227e2dacb4f623e43a0f1e3f350b21fc
+  metadata.gz: 1bc99459451547866cbe6143bae74a256ae367ee
+  data.tar.gz: b38dda87d89a65bea18c3fe59aa3a7373c09c0d9
 SHA512:
-  metadata.gz: e53046fc36a7723941ed1fe8b67073e57069b9a773cdcd7bf0257dbca68fef1e4ffe564a9c279e22706311cc082904202996abe4fcb4036c29f02c4c099748bc
-  data.tar.gz: 8a6cd711c2a08d2214ba2f9d650a538c80eeae8aae631abd84f7b9c35d8f02ece6ec02a43087aa1bff40403abba17f5911cf564f03373869439c18e5c33e0588
+  metadata.gz: 7b3f498a3275210e586205c101fcac4d914e5e32ebd9acf1509bdb78c248f3178fe5103d6e7fa4c75c49daf0941fe89448c145e9c504b26b9bbc130fc59fcf8e
+  data.tar.gz: 55c352ffce08ba453f1c82af2db897d8a635f7808ef31b4b657afde44da71b25ceb3a4730d5463e7e21252791c532bcf6e4ecba15633df7996b2560ae2942864

data/bin/duckgo

@@ -23,6 +23,11 @@ duckgo [--version | -V]             :  Display version
 duckgo [--favicon | -f] google.com  :  Get google's favicon
 duckgo \\!gem duckgo                 :  Use !bang syntax to search a specific site
 
+If you do not see an answer, please shorten the search string.
+e.g. 'something with tons of extra information' => 'something'
+This is an aspect of DuckGo I can control, because the official API does not
+allow a full search. More information - https://duckduckgo.com/api
+
 View docs and API on https://github.com/wlib/duckgo
 Made by Daniel Ethridge | git.io/de
 """
@@ -43,6 +48,16 @@ case ARGV[0]
     puts "Queried favicon from #{site}."
     file.close
     exit
+  when "--infobox", "-i"
+    data = get_data(ARGV[1..-1].join(" "))
+    extras_data = find_extras(data)
+    if extras_data["Infobox"]
+      puts extract_infobox(data).to_yaml
+      exit
+    else
+      puts "No infobox retrieved, try more clear search keywords or remove 'the --infobox|-i flag'"
+      exit
+    end
   else
     handle(ARGV[0..-1].join(" "))
     exit

data/docs/extracting_relevant_info.md

@@ -0,0 +1,63 @@
+# Extracting Relevant Information
+
+Once you get the data and parse it to a hash, you need to filter for the relevant information, here's how.
+
+## extract_common()
+
+Extract common occurring relevant information
+
+### Arguments
+
+`extract_common(data)`
+
++ `data`
+  - A hash with the data retrieved from the api (with `get_data()`)
+
+### Usage
+
+```Ruby
+data = get_data("Hello World")
+common = extract_common(data)
+puts common #=> {"Heading"=>"Hello World", "Type"=>"Disambiguation"....
+```
+
+## find_extras()
+
+This is an optional step to extract a deeper understanding of the data received.
+
+### Arguments
+
+`find_extras(data)`
+
++ `data`
+  - A hash with the data retrieved from the api (with `get_data()`)
+
+### Usage
+
+```Ruby
+data = get_data("Mark Zuckerburg")
+extras_data = find_extras(data)
+puts extras_data #=> {"Infobox"=>{"Total"=>13}, "Results"=>{"Total"=>1}}
+```
+
+## extract_extras()
+
+This is how we auomatically handle extracting extra data, based off of the output of `find_extras()`
+
+### Arguments
+
+`extract_extras(data, extras_data)`
+
++ `data`
+  - A hash with the data retrieved from the api (with `get_data()`)
++ `extras_data`
+  - The hash we got from `find_extras()`
+
+### Usage
+
+```Ruby
+data = get_data("Apple Inc.")
+extras_data = find_extras(data)
+extras = extract_extras(data, extras_data)
+puts extras #=> {"Infobox"=>{"Traded as"=>"NASDAQ: aapl AAPl...}, "Results"=>{"Official Site"...
+```

data/lib/duckgo/version.rb

@@ -1,3 +1,3 @@
 module DuckGo
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: duckgo
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Daniel Ethridge
@@ -54,11 +54,10 @@ files:
 - Rakefile
 - bin/duckgo
 - bin/setup
-- de.surge.sh-favicon.ico
 - docs/README.md
+- docs/extracting_relevant_info.md
 - docs/getting_data.md
 - duckgo.gemspec
-- due.s-favicon.ico
 - lib/duckgo.rb
 - lib/duckgo/version.rb
 homepage: https://github.com/wlib/duckgo