datahunter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f72e1cf6090108c35f52ab1fea70c16ba583824a
-  data.tar.gz: e102154ee89785deb91b5cd9416c36d51a1d59fc
+  metadata.gz: 2272bbb42482362c6e4abd579c13850e3e123278
+  data.tar.gz: eab3bb95e222811d5748f0b303d56bd52c5b93c6
 SHA512:
-  metadata.gz: 491133c7dcb9baa827491874484f7754f2c497a9d3c51a23175141cc9eac80de756d11f3254db33442ac25c81630754c51b32a8d360150e400552b71b830777b
-  data.tar.gz: c9bf04c8859e107656f2b3071961f527b27ee99e7eccbb9977209a2e36b1537e44f955f77cb44f461c8f35117adecf7cb15e20fa371534f36e401fe9ab404f76
+  metadata.gz: cead404cb7ea2fb67c964b8af49e65241511e4c23ebc483056980d8bd9cb8ef06ea6ba95eaf8eae2cfbeeeefcd9ce39eebe9cf655cdfdd9df59c921b9e5ff54b
+  data.tar.gz: 0b742fb32ef46f83d91a1bb78ccdd7b0bcbfd3f50b8321f26b6f015932e086ddd4b0e2681b5440595acabee55b314647d991b2af5daa5ec58228ac8083846ba2

data/README.md

@@ -14,7 +14,43 @@ We believe there will be more and more data available on the web and the main is
     $ gem install datahunter
 
 ## Usage
-### $ hunter find
+
+### Example1. $ hunter find ~> download
+
+    $ hunter find alimentaires
+    ### Response in 0.430501 seconds
+    ### Looks like we've got something for you!
+
+    title: Produits alimentaires : ingrédients, nutrition, labels
+
+    description: [Open Food Facts](http://fr.openfoodfacts.org/) répertorie les informations sur les produits alimentaires : ingrédients, informations nutritionnelles, labels etc. Les données proviennent majoritairement de la collecte citoyenne (crowdsourcing) des informations.
+
+    publisher: Open Food Facts
+
+    temporal: all
+
+    spatial: ["france", "fr", "europe", "schengen", "eu", "ue", "countries", "world", "all"]
+
+    created: 2014-05-07T02:44:58.119Z
+
+    updated: 2014-12-13T16:40:14.136Z
+    
+    score: 13.427
+
+    ### get the data? (y/n)
+    y
+
+    0. Ingrédients, informations nutritionnelles et données sur les produits alimentaires - CSV
+    1. Ingrédients, informations nutritionnelles et données sur les produits alimentaires - RDF
+    2. Description des données, exports et API de la base de produits Open Food Facts - HTML
+
+    ### which one? (0/1/...)
+    0
+
+    Start downloading...
+    Your file has been downloaded, try to $ ls ;D
+
+### Example2. $ hunter find ~> open browser
     $ hunter find population france
     ### Response in 0.569162 seconds
     ### Looks like we've got something for you!
@@ -64,7 +100,7 @@ Don't hesitate to [give us any feedback about you experience with Hunter!](https
 ## Roadmap
 
 * more datasets
-* download datasets from the terminal (very soon :) )
+* improve the download of datasets
 * more generic lib to make the API more easy to reuse
 
 ## Contributing

data/bin/hunter

@@ -10,12 +10,17 @@ require 'colorize'
 require 'downloadr'
 
 program :version, Datahunter::VERSION
-program :description, 'Find Open Data directly from your terminal'
+program :description, 'Find and download Open Datasets directly from your terminal'
+program :help_formatter, :compact
 
 command :find do |c|
   c.syntax = 'hunter find keyword [spatial-coverage] [temporal-coverage]'
-  c.summary = 'Returns the 3 most popular (most reused, viewed, etc) datasets corresponding '\
-              'to the triple keyword, spatial-coverage and temporal-coverage'
+  c.summary = '$ hunter find <keyword> <geo-coverage> <temporal-coverage>
+                             * Returns the 3 most popular (most reused, viewed, etc)
+                               datasets corresponding to the triple keyword,
+                               spatial-coverage and temporal-coverage
+                             * Allow you to either download the dataset or to open
+                               your favorite browser directly at the good page'.colorize(:blue)
   c.description = c.summary
   c.example 'Find open data for the U.S. population', 'hunter find population us'
   c.action do |args, options|
@@ -81,7 +86,10 @@ end
 
 command :search do |c|
   c.syntax = 'hunter search keyword [spatial-coverage] [temporal-coverage]'
-  c.summary = 'Returns all the datasets corresponding to the query, sorted by popularity'
+  c.summary = '$ hunter search <keyword> <geo-coverage> <temporal-coverage>
+                             * Returns all the datasets corresponding to
+                               the query, sorted by popularity.
+                             * WARNING: this command is going to be modified soon!'.colorize(:blue)
   c.description = c.summary
   c.example 'Search open data for population', 'hunter search population'
   c.action do |args, options|
@@ -116,12 +124,14 @@ end
 
 command :about do |c|
   c.syntax = 'hunter about'
-  c.summary = 'About Hunter'
+  c.summary = 'About Hunter
+                             * Vision
+                             * Value Proposition
+                             * Stats
+                             * Last datasets indexed'.colorize(:blue)
   c.description = c.summary
   c.action do |args, options|
-    puts "
-...........888888888888888..............
-........8888888888888888888888..........
+    puts "........8888888888888888888888..........
 .....88888888888888888888888888888......
 ....8888888888888888888888888888888.....
 ...888888888888888888888888888~88888?...
@@ -143,7 +153,36 @@ $.........:8...............888888888888.
 ... .........................888........
 ....  .....................:88..........
 .....      ...............8.............".colorize(:red)
-    puts "### Hunter is still a prototype, please don't hesitate to help us make open datasets research better!".colorize(:blue)
+    puts
+    puts 'Find and download Open Datasets directly from the terminal!'.colorize(:red)
+    puts 
+    puts 'We believe there will be more and more data available on the web and the main issue will be to find them and to manage each sources. So we try to do it for you: not by pre-processing them but by orienting you.'.colorize(:red)
+    puts
+    puts 'Number of datasets currently indexed: 1920'  
+    puts
+    puts 'Last dataset indexed: "India Power Sector Review"'
+    puts
+    puts "### Hunter is still a prototype, please don't hesitate to help us make open datasets workflow better!".colorize(:blue)
     Datahunter.print_feedback_request
   end
 end
+
+command :guide do |c|
+  c.action {puts ('$ hunter find <keyword> <geo-coverage> <temporal-coverage> '.colorize(:blue) +
+                  '
+* Returns the 3 most popular (most reused, viewed, etc) datasets corresponding to the query
+* Allow you to either download the dataset or to open your favorite browser directly at the good page')
+
+puts ('$ hunter search <keyword> <geo-coverage> <temporal-coverage>'.colorize(:blue) +
+      '
+* Returns all the datasets corresponding to the query, sorted by popularity.
+* WARNING: this command is going to be modified soon!')
+
+puts ('$ hunter about'.colorize(:blue) +
+'
+* Vision
+* Value Proposition
+* Stats
+* Last datasets indexed')}
+end
+default_command :guide

data/lib/datahunter/base.rb

@@ -35,32 +35,24 @@ module Datahunter
     puts ("score: ".colorize(:green) + "#{dataset["huntscore"]}")
     puts
   end
-  
-  def self.print_downloadable_links dataset
-    dataset["resources"].each_with_index do |dl, i|
-      puts ("#{i}. ".colorize(:yellow) +
-            "#{dl["title"]} - ".colorize(:blue) + 
-            "#{dl["format"]}".colorize(:green))
-    end
-  end
-
-  def self.download_file url
-    puts "Start downloading..."
-    Downloadr::HTTP.download(url)
-    puts "Your file has been downloaded, try to $ ls ;D".colorize(:green)
-  end
-
+ 
   def self.download_the_data dataset
-    print_downloadable_links dataset
-    dl = ask "### which one? (0/1/...)".colorize(:yellow)
-    dl = dl.to_i
-    if dataset["resources"][dl]["format"] == "HTML"
-      Launchy.open(dataset["resources"][dl]["url"], options = {})
+    resources = dataset["resources"]
+    number_of_downloadable_links = resources.size
+
+    if number_of_downloadable_links == 1
+      dl = 0
     else
-      download_file dataset["resources"][dl]["url"]
+      Datahunter.print_downloadable_links resources
+      dl = ask("### which one? (0/1/...)".colorize(:yellow), Integer) {|i| i.in = 0..(number_of_downloadable_links - 1)}
     end
+
+    dl = dl.to_i
+    Datahunter.download_file(resources[dl]["url"], resources[dl]["format"])
   end
 
+## Messages: feedback and excuses
+
   def self.print_feedback_request
     case ask "### give feedback? (y/n)".colorize(:yellow)
     when 'y'
@@ -75,4 +67,24 @@ module Datahunter
          "datasets indexed soon. If you want us to find a dataset for you, or "\
          "if you just want to give us a feedback, don't hesitate!".colorize(:red)
   end
+
+  private
+  
+  def self.print_downloadable_links resources
+    resources.each_with_index do |dl, i|
+      puts ("#{i}. ".colorize(:yellow) +
+            "#{dl["title"]} - ".colorize(:blue) + 
+            "#{dl["format"]}".colorize(:green))
+    end
+  end
+  
+  def self.download_file url, format=""
+    if format == "HTML"
+      Launchy.open(url, options = {})
+    else
+      puts "Start downloading..."
+      Downloadr::HTTP.download(url)
+      puts "Your file has been downloaded, try to $ ls ;D".colorize(:green)
+    end
+  end
 end

data/lib/datahunter/version.rb

@@ -1,3 +1,3 @@
 module Datahunter
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datahunter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Terpo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-14 00:00:00.000000000 Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler