datahunter 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e49d1f617fcbb9d2374ca33fa8c23e37628406dd
-  data.tar.gz: 6d6c00bc69b7bb30d1eea9030cfbc433357b0639
+  metadata.gz: c8bba1b0aa033c04e07c0e27279df43485da2013
+  data.tar.gz: 01688fd2862ff969dae99fabfccce51f3a3c4064
 SHA512:
-  metadata.gz: ce5b6e7e68543ef2e5a47730960dc32ef81d050b885627c2e60d48aeb2ce65a9da6d4317a593c9f156caf3da79ebca17b9cf671b889b09a603dac4e90a54cf1b
-  data.tar.gz: 14052b66fddb63d34582015f9301e69c9a6e20c94933357ea764e7dadc0f7983917319108c1ddf2fd5ea57294bf58b15719279bd1a9975901f26eb332ad0c7fd
+  metadata.gz: fccec23786af7fb1fa4e5dd2de142f8b7c70e5fcaa7fc35a9585bee0197ce99369159730a80a54811f99011fd6ffd3e67711621642cfd7dad8b16ca50771bc59
+  data.tar.gz: ff5d6fb9d643d993252bed1d251d10f44b196dbe2379b48dfa31cbd9331beb5ebd60ba1a44d00b186c2b89b37050773b102344313fda3cddca38e621fa28927e

data/.gitignore

@@ -11,4 +11,5 @@
 *.so
 *.o
 *.a
+*.gem
 mkmf.log

data/README.md

@@ -1,26 +1,16 @@
 # Datahunter
 
-TODO: Write a gem description
+![screenshot](./logo.png)
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'datahunter'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
     $ gem install datahunter
 
 ## Usage
 
-TODO: Write usage instructions here
+    $ hunter find population france
+
+![usage](./hunter.gif)
 
 ## Contributing
 

data/bin/hunter

@@ -8,131 +8,67 @@ require 'rest_client'
 require 'launchy'
 require 'colorize'
 
-program :version, '0.0.3'
+program :version, Datahunter::VERSION
 program :description, 'Find open data easily and quicker than ever'
 
-feedback_url = "https://docs.google.com/forms/d/1yNzZjCCXvWHQCbWz4sx-nui3LafeeLcT7FF9T-vbKvw/viewform"
-
 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 = 'Returns the 3 most popular (most reused, viewed, etc) datasets corresponding '\
+              'to the triple keyword, spatial-coverage and temporal-coverage'
   c.description = c.summary
   c.example 'Find open data for the U.S. population', 'hunter find population us'
   c.action do |args, options|
-    tag = args[0]
-    geo = args[1]
-    temp = args[2]
 
-    tag = tag.downcase.split.first if tag
-    geo = geo.downcase if geo
-    
     start_time = Time.now
 
-    if geo.nil? and temp.nil?
-      url = "http://shrouded-harbor-5877.herokuapp.com/api/datasets/?tags=#{tag}"
-    elsif temp.nil?
-      url = "http://shrouded-harbor-5877.herokuapp.com/api/datasets/?tags=#{tag}&spatial=#{geo}"
-    elsif geo.nil?
-      url = "http://shrouded-harbor-5877.herokuapp.com/api/datasets/?tags=#{tag}&temporal=#{temp}"
-    else
-      url = "http://shrouded-harbor-5877.herokuapp.com/api/datasets/?tags=#{tag}&spatial=#{geo}&temporal=#{temp}"
-    end
-
-    response = RestClient.get(url, :content_type => :json){ |response, request, result, &block|
-      elapsed_time = Time.now - start_time
-      case response.code
-      when 200
-        ds = JSON.parse(response.body).reverse
-        puts "### Response in #{elapsed_time} seconds".colorize(:blue)
-        puts "### Looks like we've got something for you!".colorize(:blue)
-        puts
-        puts ("title: ".colorize(:green) + "#{ds[0]["title"]}") 
-        puts ("description: ".colorize(:green) + "#{ds[0]["description"]}") 
-        puts ("publisher: ".colorize(:green) + "#{ds[0]["publisher"]}") 
-        puts ("temporal: ".colorize(:green) + "#{ds[0]["temporal"]}") 
-        puts ("spatial: ".colorize(:green) + "#{ds[0]["spatial"]}") 
-        puts ("created: ".colorize(:green) + "#{ds[0]["created"]}") 
-        puts ("updated: ".colorize(:green) + "#{ds[0]["updated"]}")
-        puts ("score: ".colorize(:green) + "#{ds[0]["huntscore"]}")
-        puts
-        case ask "### get the data? (y/n)".colorize(:yellow)
-        when 'y'
-          Launchy.open(ds[0]["uri"], options = {})
-        when 'n'
-          if ds[1].nil?
-            puts ("Remember, this is a first prototype, there will surely be a lot more 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))
-            case ask "### give feedback? (y/n)".colorize(:yellow)
-            when 'y'
-              Launchy.open(feedback_url, options = {})
-            when 'n'
-              puts "Bye for now!"
-            end
-          else
-            puts "### And this one?".colorize(:blue)
-            puts
-            puts ("title: ".colorize(:green) + "#{ds[1]["title"]}") 
-            puts ("description: ".colorize(:green) + "#{ds[1]["description"]}") 
-            puts ("publisher: ".colorize(:green) + "#{ds[1]["publisher"]}") 
-            puts ("temporal: ".colorize(:green) + "#{ds[1]["temporal"]}") 
-            puts ("spatial: ".colorize(:green) + "#{ds[1]["spatial"]}") 
-            puts ("created: ".colorize(:green) + "#{ds[1]["created"]}") 
-            puts ("updated: ".colorize(:green) + "#{ds[1]["updated"]}")
-            puts ("score: ".colorize(:green) + "#{ds[1]["huntscore"]}")
+    if args[0].nil?
+      puts "usage: $ hunter find keyword [geo] [temp]"
+    elsif
+      url = Datahunter.datasets_url(args[0], args[1], args[2])
+
+      response = RestClient.get(url, :content_type => :json) do |response, request, result, &block|
+        elapsed_time = Time.now - start_time
+
+        case response.code
+        when 200
+          datasets = JSON.parse(response.body).reverse
+          puts "### Response in #{elapsed_time} seconds".colorize(:blue)
+          
+          messages = [
+            "### Looks like we've got something for you!".colorize(:blue),
+            "### And this one?".colorize(:blue),
+            "### Last try...".colorize(:blue)
+          ]
+          
+          3.times do |index|
+            puts messages[index]
             puts
+            Datahunter.print_dataset_info datasets[index]
+            
             case ask "### get the data? (y/n)".colorize(:yellow)
             when 'y'
-              Launchy.open(ds[1]["uri"], options = {})
-            when 'n'
-              if ds[2].nil?
-                puts ("Remember, this is a first prototype, there will surely be a lot more 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))
-                case ask "### give feedback? (y/n)".colorize(:yellow)
-                when 'y'
-                  Launchy.open(feedback_url, options = {})
-                when 'n'
-                  puts "Bye for now!"
-                end
-              else
-                puts "### Last try...".colorize(:blue)
-                puts
-                puts ("title: ".colorize(:green) + "#{ds[2]["title"]}") 
-                puts ("description: ".colorize(:green) + "#{ds[2]["description"]}") 
-                puts ("publisher: ".colorize(:green) + "#{ds[2]["publisher"]}") 
-                puts ("temporal: ".colorize(:green) + "#{ds[2]["temporal"]}") 
-                puts ("spatial: ".colorize(:green) + "#{ds[2]["spatial"]}") 
-                puts ("created: ".colorize(:green) + "#{ds[2]["created"]}") 
-                puts ("updated: ".colorize(:green) + "#{ds[2]["updated"]}")
-                puts ("score: ".colorize(:green) + "#{ds[2]["huntscore"]}")
-                puts
-                case ask "### get the data? (y/n)".colorize(:yellow)
-                when 'y'
-                  Launchy.open(ds[2]["uri"], options = {})
-                when 'n'
-                  puts ("You may want to try: ".colorize(:red) + "'$ hunter search #{tag}'".colorize(:blue))
-                  puts ("Remember, this is a first prototype, there will surely be a lot more 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))
-                  case ask "### give feedback? (y/n)".colorize(:yellow)
-                  when 'y'
-                    Launchy.open(feedback_url, options = {})
-                  when 'n'
-                    puts "Bye for now!"
-                  end
-                end
+              Launchy.open(datasets[index]["uri"], options = {})
+              break
+            else # When no
+              if index == 2
+                puts ("You may want to try: ".colorize(:red) + "'$ hunter search #{args[0].downcase}'".colorize(:blue))
+              end
+              if index >= 2 or datasets[index+1].nil?
+                Datahunter.print_excuse_message
+                Datahunter.print_feedback_request
+                break
               end
             end
           end
+        when 500
+          puts "We've found nothing for your query: as every good hunter... we are still learning".colorize(:red)
+          Datahunter.print_excuse_message
+          Datahunter.print_feedback_request
+        else
+          response.return!(request, result, &block)
         end
-      when 500
-        puts "We've found nothing for your query: as every good hunter... we are still learning".colorize(:red)
-        puts ("Remember, this is a first prototype, there will surely be a lot more 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))
-        case ask "### give feedback? (y/n)".colorize(:yellow)
-        when 'y'
-          Launchy.open(feedback_url, options = {})
-        when 'n'
-          puts "Bye for now!"
-        end
-      else
-        response.return!(request, result, &block)
       end
-    }
+    end
   end
 end
 
@@ -142,64 +78,44 @@ command :search do |c|
   c.description = c.summary
   c.example 'Search open data for population', 'hunter search population'
   c.action do |args, options|
-    tag = args[0]
-    geo = args[1]
-    temp = args[2]
-
-    tag = tag.downcase.split.first if tag
-    geo = geo.downcase if geo
 
     start_time = Time.now
 
-    if geo.nil? and temp.nil?
-      url = "http://shrouded-harbor-5877.herokuapp.com/api/datasets/?tags=#{tag}"
-    elsif temp.nil?
-      url = "http://shrouded-harbor-5877.herokuapp.com/api/datasets/?tags=#{tag}&spatial=#{geo}"
-    elsif geo.nil?
-      url = "http://shrouded-harbor-5877.herokuapp.com/api/datasets/?tags=#{tag}&temporal=#{temp}"
-    else
-      url = "http://shrouded-harbor-5877.herokuapp.com/api/datasets/?tags=#{tag}&spatial=#{geo}&temporal=#{temp}"
-    end
+    url = Datahunter.datasets_url(args[0], args[1], args[2])
 
-    response = RestClient.get(url, :content_type => :json){ |response, request, result, &block|
+    response = RestClient.get(url, :content_type => :json) do |response, request, result, &block|
 
       elapsed_time = Time.now - start_time
 
       case response.code
       when 200
-        ds = JSON.parse(response.body).reverse
+        datasets = JSON.parse(response.body).reverse
         puts "### Response in #{elapsed_time} seconds".colorize(:blue)
-        puts "### We've found #{ds.size} datasets corresponding to your query #{tag}:".colorize(:blue)
+        puts "### We've found #{datasets.size} datasets corresponding to your query #{args[0].downcase}:".colorize(:blue)
         puts
-        ds.each do |result|
+        datasets.each do |result|
           puts ("#{result["title"]}".colorize(:green) + " (#{result["uri"]})")
         end
-
       when 500
-        puts "We've found nothing for your query: as every good hunter... we are still learning".colorize(:red)
-        puts ("Remember, this is a first prototype, there will surely be a lot more 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))
-        case ask "### give feedback? (y/n)".colorize(:yellow)
-        when 'y'
-          Launchy.open(feedback_url, options = {})
-        when 'n'
-          puts "Bye for now!"
-        end
+        puts "We found nothing for your query: as every good hunter... we are still learning".colorize(:red)
+        Datahunter.print_excuse_message
+        Datahunter.print_feedback_request
       else
         response.return!(request, result, &block)
       end
-    }
+    end
   end
 end
 
-command :hunter do |c|
-  c.syntax = 'hunter hunter'
+command :about do |c|
+  c.syntax = 'hunter about'
   c.summary = 'About Hunter'
   c.description = c.summary
   c.action do |args, options|
     puts "
-...........888888888888888..............     
+...........888888888888888..............
 ........8888888888888888888888..........
-.....88888888888888888888888888888......     
+.....88888888888888888888888888888......
 ....8888888888888888888888888888888.....
 ...888888888888888888888888888~88888?...
 ..88888...888888888888888888..+888888...
@@ -221,11 +137,6 @@ $.........:8...............888888888888.
 ....  .....................:88..........
 .....      ...............8.............".colorize(:red)
     puts "### Hunter is still a prototype, please don't hesitate to help us make open datasets research better!".colorize(:blue)
-    case ask "### give feedback? (y/n)".colorize(:yellow)
-    when 'y'
-      Launchy.open(feedback_url, options = {})
-    when 'n'
-      puts "Bye for now!"
-    end
+    Datahunter.print_feedback_request
   end
 end

data/lib/datahunter.rb

@@ -1,5 +1,5 @@
+require "datahunter/base"
 require "datahunter/version"
 
 module Datahunter
-  # Your code goes here...
 end

data/lib/datahunter/base.rb

@@ -0,0 +1,49 @@
+require 'colorize'
+require 'launchy'
+
+module Datahunter
+  DATASETS_URL = "http://shrouded-harbor-5877.herokuapp.com/api/datasets/"
+  FEEDBACK_URL = "https://docs.google.com/forms/d/1yNzZjCCXvWHQCbWz4sx-nui3LafeeLcT7FF9T-vbKvw/viewform"
+
+  def self.datasets_url tag, geo=nil, temp=nil
+    tag = tag.downcase.split.first if tag
+    geo = geo.downcase if geo
+
+    if geo.nil? and temp.nil?
+      "#{DATASETS_URL}?tags=#{tag}"
+    elsif temp.nil?
+      "#{DATASETS_URL}?tags=#{tag}&spatial=#{geo}"
+    elsif geo.nil?
+      "#{DATASETS_URL}?tags=#{tag}&temporal=#{temp}"
+    else
+      "#{DATASETS_URL}?tags=#{tag}&spatial=#{geo}&temporal=#{temp}"
+    end
+  end
+
+  def self.print_dataset_info dataset
+    puts ("title: ".colorize(:green) + "#{dataset["title"]}")
+    puts ("description: ".colorize(:green) + "#{dataset["description"]}")
+    puts ("publisher: ".colorize(:green) + "#{dataset["publisher"]}")
+    puts ("temporal: ".colorize(:green) + "#{dataset["temporal"]}")
+    puts ("spatial: ".colorize(:green) + "#{dataset["spatial"]}")
+    puts ("created: ".colorize(:green) + "#{dataset["created"]}")
+    puts ("updated: ".colorize(:green) + "#{dataset["updated"]}")
+    puts ("score: ".colorize(:green) + "#{dataset["huntscore"]}")
+    puts
+  end
+
+  def self.print_feedback_request
+    case ask "### give feedback? (y/n)".colorize(:yellow)
+    when 'y'
+      Launchy.open(FEEDBACK_URL, options = {})
+    else
+      puts "Bye for now!"
+    end
+  end
+
+  def self.print_excuse_message
+    puts "Remember, this is a first prototype, there will surely be a lot more "\
+         "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
+end

data/lib/datahunter/version.rb

@@ -1,3 +1,3 @@
 module Datahunter
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datahunter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Terpo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-30 00:00:00.000000000 Z
+date: 2014-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,8 +123,11 @@ files:
 - Rakefile
 - bin/hunter
 - datahunter.gemspec
+- hunter.gif
 - lib/datahunter.rb
+- lib/datahunter/base.rb
 - lib/datahunter/version.rb
+- logo.png
 homepage: ''
 licenses:
 - MIT