factbook 0.1.0 → 0.1.1

data/README.md

@@ -10,7 +10,7 @@
 
 ## What's the World Factbook?
 
-The World Factbook published by the Central Intelligence Agency (CIA)
+The World Factbook [1][2] published by the Central Intelligence Agency (CIA)
 offers free country profiles in the public domain (that is, no copyright(s), no rights reserved).
 
 - [1] [The World Factbook](https://www.cia.gov/library/publications/the-world-factbook/)
@@ -19,7 +19,7 @@ offers free country profiles in the public domain (that is, no copyright(s), no
 
 ## Usage
 
-### Get page as a hash (that is, structured data e.g. nested key/values)
+### Get country profile page as a hash (that is, structured data e.g. nested key/values)
 
     page = Factbook::Page.new( 'br' )
     pp page.data                      # pretty print hash
@@ -28,7 +28,7 @@ offers free country profiles in the public domain (that is, no copyright(s), no
 
     page = Factbook::Page.new( 'br' )
     File.open( 'br.json', 'w') do |f|
-      f.write( JSON.pretty_generate( page.data ) )
+      f.write page.to_json( pretty: true )
     end
 
 
@@ -39,11 +39,24 @@ Just install the gem:
     $ gem install factbook
 
 
+## Ready-To-Use Public Domain Datasets (Generated by `factbook`)
 
-## Alternatives
+[openmundi/factbook.json](https://github.com/openmundi/factbook.json) - open (public domain)
+factbook country profiles in JSON for all the world's countries (using internet domain names
+for country codes e.g. Austria is `at.json` not `au.json`, Germany is `de.json` not `gm.json` and so on)
+
+
+
+## Alternatives Libraries and Gems
+
+Ruby
 
 - [worldfactbook gem](https://github.com/sayem/worldfactbook) by sayem (aka Sayem Khan); fetches data from its own mirror, that is, rubyworldfactbook.com (last updated 2011?)
 
+Others
+
+TBD
+
 
 ## License
 

data/Rakefile

@@ -30,3 +30,51 @@ Hoe.spec 'factbook' do
   }
 
 end
+
+
+
+desc 'generate json for factbook.json repo'
+task :genjson do
+  require 'factbook'
+
+  countries = [
+    'au',
+    'be',
+    'br',
+    'mx',
+    'us'
+  ]
+
+  countries.each do |country|
+     gen_json_for( country )
+  end
+end
+
+
+def gen_json_for( code )
+  Dir.mkdir( 'tmp' )       unless Dir.exists?( 'tmp' )
+  Dir.mkdir( 'tmp/html' )  unless Dir.exists?( 'tmp/html' )
+  Dir.mkdir( 'tmp/json' )  unless Dir.exists?( 'tmp/json' )
+
+  page = Factbook::Page.new( code )    
+
+  ## print first 600 chars
+  pp page.html[0..600]
+
+  ## save for debuging
+    
+  puts "saving a copy to #{code}.html for debugging"
+  File.open( "tmp/html/#{code}.html", 'w') do |f|
+      f.write( page.html )
+  end
+
+  h = page.data
+  pp h
+    
+  ### save to json
+  puts "saving a copy to #{code}.json for debugging"
+  File.open( "tmp/json/#{code}.json", 'w') do |f|
+    f.write( JSON.pretty_generate( h ) )
+  end
+end
+

data/lib/factbook/page.rb

@@ -21,6 +21,15 @@ module Factbook
       @doc ||= Nokogiri::HTML( html )
     end
 
+    def to_json( opts={} )
+      ## convenience helper for data.to_json
+      if opts[:pretty] || opts[:pp]
+        JSON.pretty_generate( data )
+      else
+        data.to_json
+      end
+    end
+
     def data
       if @data.nil?
         titles = [
@@ -263,7 +272,7 @@ module Factbook
     key = key.gsub( '(s)', 's' )
     key = key.gsub( ':', '' )    # trailing :
     ## remove special chars ()-/,'
-    key = key.gsub( /[()\-\/,]'/, ' ')
+    key = key.gsub( /['()\-\/,]/, ' ' )
     key = key.strip
     key = key.gsub( /[ ]+/, '_' )
     key

data/lib/factbook/version.rb

@@ -1,5 +1,5 @@
 
 module Factbook
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: factbook
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2014-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
-  requirement: &74284670 !ruby/object:Gem::Requirement
+  requirement: &73732120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *74284670
+  version_requirements: *73732120
 - !ruby/object:Gem::Dependency
   name: fetcher
-  requirement: &74284270 !ruby/object:Gem::Requirement
+  requirement: &73731730 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *74284270
+  version_requirements: *73731730
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &74283870 !ruby/object:Gem::Requirement
+  requirement: &73731340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *74283870
+  version_requirements: *73731340
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &74283450 !ruby/object:Gem::Requirement
+  requirement: &73730940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '4.0'
   type: :development
   prerelease: false
-  version_requirements: *74283450
+  version_requirements: *73730940
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &74283000 !ruby/object:Gem::Requirement
+  requirement: &73730530 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: '3.11'
   type: :development
   prerelease: false
-  version_requirements: *74283000
+  version_requirements: *73730530
 description: factbook - scripts for the world factbook (get open structured data e.g
   JSON etc.)
 email: openmundi@googlegroups.com