rgovdata 0.1.0

data/lib/rgovdata/catalog/dn.rb

@@ -0,0 +1,63 @@
+# This module defines the basic naming interface for catalog objects
+# Override these methods as required
+module RGovData::Dn
+  
+  # Returns the human-readable unique id
+  def id
+    nameparts = []
+    if defined? realm
+      nameparts.push('/')
+      nameparts.push(realm)
+    end
+    nameparts.push(service_key) if defined?(service_key) && service_key.present?
+    nameparts.push(dataset_key) if defined?(dataset_key) && dataset_key.present?
+    nameparts.join('/')
+  end
+
+  # Returns a rails-compatible ID
+  def to_param
+    id.gsub('/',':')
+  end
+
+  # Returns the human version of the object name/identification
+  def to_s
+    "#{id} [#{self.class.name}]"
+  end
+
+  # Returns array of attributes that describe the specific entity
+  # By default, guesses based on instance variables
+  def meta_attributes
+    a = [:id]
+    instance_variables.each do |v|
+      n = v.to_s.gsub('@','').to_sym
+      a << n if self.respond_to?(n)
+    end
+    a
+  end
+
+  # Returns a hash that fully describes this service and can be used as a parameter to +new+
+  # By default, returns a hash based on meta_attributes
+  def initialization_hash
+    h = {}
+    meta_attributes.each do |attribute|
+      h.merge!(attribute => self.send(attribute))
+    end
+    h
+  end
+
+  # Returns array of attributes that describe the records of the specific entity
+  # By default, it is nil (meaning indeterminate)
+  def attributes
+    @attributes
+  end
+
+  # Generic interface to return the currently applicable record set
+  def records
+    if defined? datasets
+      datasets
+    else
+      []
+    end
+  end
+
+end

data/lib/rgovdata/catalog/registry_strategy/internal_registry.rb

@@ -0,0 +1,12 @@
+class RGovData::InternalRegistry < RGovData::RegistryStrategy
+
+  # Returns the list of services for the realm
+  # based on internal yml file
+  def load_services
+    service_array = []
+    registry = RGovData::Template.get('registry.yml',realm)
+    YAML::load_documents( registry ) { |doc| service_array << doc }
+    service_array
+  end
+
+end

data/lib/rgovdata/catalog/registry_strategy/registry_strategy.rb

@@ -0,0 +1,26 @@
+class RGovData::RegistryStrategy
+  attr_accessor :realm
+
+  class << self
+    # Returns the appropriate RegistryStrategy for the given realm
+    # +realm+ is the required realm
+    def instance_for_realm(realm)
+      # TODO: this is where we can abstract different registry schemes
+      # e.g by default we will look for a class called Rgovdata::<realm>Registry (Rgovdata::ZhRegistry)
+      # else we take the default strategy
+      # Currently this just defaults to internal registry:
+      RGovData::InternalRegistry.new(realm)
+    end
+  end
+
+  # +new+ accepts realm parameter
+  def initialize(default_realm=nil)
+    @realm = default_realm
+  end
+
+  # Returns the list of services for the realm
+  def load_services
+    []
+  end
+
+end

data/lib/rgovdata/config.rb

@@ -0,0 +1,5 @@
+require 'rgovdata/config/config'
+require 'rgovdata/config/common_config'
+require 'rgovdata/data/template'
+require 'rgovdata/shell/shell'
+

data/lib/rgovdata/config/common_config.rb

@@ -0,0 +1,13 @@
+# This module is used to include basic support to access
+# the shared RGovData::Config instance
+module RGovData::CommonConfig
+  # Returns the current config instance
+  def config
+    RGovData::Config.instance
+  end
+  # Sets the requirement to have a config file
+  # Must be called before config is invoked
+  def require_config_file
+    RGovData::Config.require_config_file
+  end
+end

data/lib/rgovdata/config/config.rb

@@ -0,0 +1,133 @@
+require 'ostruct'
+require 'singleton'
+
+class RGovData::Config
+  include Singleton
+  BASE_NAME = 'rgovdata.conf'
+
+  class ConfigError < StandardError
+	end
+  class ConfigurationFileNotFound < ConfigError
+	end
+  class ConfigurationFileInitialized < ConfigError
+  end
+
+  attr_accessor :default_realm, :credentialsets
+
+  def initialize
+    load_default_config
+  end
+
+  # Reloads configuraiton from default config provider
+  # - rails config file (if used in Rails)
+  # - current directory
+  # - environment settings
+  def load_default_config
+    clear
+    # load default config
+    if rails_root
+      # if rails env, load from Rails.root.join('config',BASE_NAME)
+      load_config(rails_root.join('config',BASE_NAME),self.class.default_loader_options)
+    elsif
+      # else load from pwd
+      load_config(self.class.default_config_file,self.class.default_loader_options)
+    else
+      # else just refresh_from_env
+      refresh_from_env
+    end
+  end
+  # Returns the rails root, if the Rails environment is available
+  def rails_root
+    Rails.root if defined?(Rails)
+  end
+  protected :rails_root
+
+  def load_config(configfilepath, options = {})
+    options.reverse_merge!(:generate_default => true,:required => true)
+    unless File.exists?(configfilepath)
+      self.class.reset_configfile(configfilepath) if options[:generate_default]
+      if File.exists?(configfilepath)
+        raise ConfigurationFileInitialized.new("\n
+No configuration file found.
+A new file has been initialized at: #{configfilepath}
+Please review the configuration and retry..\n\n\n")
+      elsif options[:required]
+        raise ConfigurationFileNotFound.new("cannot load config file #{configfilepath}")
+      else
+        return
+      end
+    end
+    update_settings(OpenStruct.new(YAML::load(File.read(configfilepath))))
+  end
+
+  # Updates attributes from config, including env override
+  # +config+ OpenStruct structure
+  def update_settings(config)
+    @credentialsets.merge!(config.credentialsets||{})
+    @default_realm = config.default_realm.to_sym if config.default_realm
+    refresh_from_env
+  end
+  protected :update_settings
+
+  # Clears the current configuration
+  def clear
+    @credentialsets = {}
+    @default_realm = nil
+  end
+
+  # Prints current status
+  def show_status
+    if credentialsets
+      puts "credential sets available: #{credentialsets.keys.join(',')}"
+      puts credentialsets.inspect
+    else
+      puts "credential sets available: none"
+    end
+  end
+  
+  # Sets environment overrides for supported settings
+  def refresh_from_env
+    if ENV['projectnimbus_account_key'] || ENV['projectnimbus_unique_user_id']
+      @credentialsets['projectnimbus'] ||= {}
+      @credentialsets['projectnimbus'].merge!({'AccountKey'=> ENV['projectnimbus_account_key']}) if ENV['projectnimbus_account_key']
+      @credentialsets['projectnimbus'].merge!({'UniqueUserID'=> ENV['projectnimbus_unique_user_id']}) if ENV['projectnimbus_unique_user_id']
+    end
+    if ENV['rgovdata_username'] || ENV['rgovdata_password']
+      @credentialsets['basic'] ||= {}
+      @credentialsets['basic'].merge!({'username'=> ENV['rgovdata_username']}) if ENV['rgovdata_username']
+      @credentialsets['basic'].merge!({'password'=> ENV['rgovdata_password']}) if ENV['rgovdata_password']
+    end
+  end
+  protected :refresh_from_env
+  
+  class << self
+    def reset_configfile(configfilepath)
+      file = File.new(configfilepath,'w')
+      template.each_line do | line|
+        file.puts line
+      end
+      file.close
+    end
+
+    def default_config_file(override = nil)
+      File.expand_path(override || BASE_NAME)
+    end
+    
+    def template
+      RGovData::Template.get('config_template.yml')
+    end
+
+    def template_path
+      RGovData::Template.path('config_template.yml')
+    end
+
+    def default_loader_options
+      @@default_loader_options ||= {:generate_default => false,:required => false}
+    end
+    
+    def require_config_file
+      @@default_loader_options = {:generate_default => true,:required => true}
+    end
+  end
+  
+end

data/lib/rgovdata/data/config_template.yml

@@ -0,0 +1,19 @@
+
+# Defines the default realm (country)
+default_realm: sg
+
+# Define the various credential sets that may be required
+credentialsets:
+  # Basic authentication credentials
+  basic:
+    # ENV['rgovdata_username'] will override username if present
+    username: "_insert_your_username_here_"
+    # ENV['rgovdata_password'] will override password if present
+    password: "your_password"
+  # OData credentials for http://projectnimbus.org - APIs for Singapore Government Data
+  projectnimbus:
+    # ENV['projectnimbus_account_key'] will override AccountKey if present
+    AccountKey: "_insert_your_key_here_"
+    # ENV['projectnimbus_unique_user_id'] will override UniqueUserID if present
+    UniqueUserID: "00000000000000000000000000000001"
+

data/lib/rgovdata/data/sg/registry.yml

@@ -0,0 +1,147 @@
+--- !ruby/object:RGovData::ServiceListing
+realm: :sg
+key: chlkboard
+name: Chlkboard
+description: Information and promotion of local businesses
+keywords: "F&B, retail"
+publisher: Chlkboard
+info_uri: http://projectnimbus.org/2010/07/17/datasets-chlkboard/
+license:
+uri: https://api.projectnimbus.org/chlkboardodataservice.svc
+type: :odata
+credentialset: projectnimbus
+--- !ruby/object:RGovData::ServiceListing
+realm: :sg
+key: co
+name: Cinema Online
+description: Movie times and locations in Singapore
+keywords: movie, cinema
+publisher: Cinema Online
+info_uri: http://projectnimbus.org/2010/04/12/datasets-cinema-online-co/
+license:
+uri: https://api.projectnimbus.org/coodataservice.svc
+type: :odata
+credentialset: projectnimbus
+--- !ruby/object:RGovData::ServiceListing
+realm: :sg
+key: hgw
+name: HungryGoWhere
+description: Best food, restaurants, bars, and pubs in Singapore, Kuala Lumpur and Hong Kong
+keywords: food, makan
+publisher: HungryGoWhere
+info_uri: http://projectnimbus.org/2010/04/11/datasets-hungrygowhere-hgw/
+license:
+uri: https://api.projectnimbus.org/hgwodataservice.svc
+type: :odata
+credentialset: projectnimbus
+--- !ruby/object:RGovData::ServiceListing
+realm: :sg
+key: lta
+name: Traffic and Road Conditions
+description: Traffic and Road Conditions in Singapore
+keywords: road, traffic, incidents, parking
+publisher: Singapore Land Transport Authority
+info_uri: http://projectnimbus.org/2010/04/05/datasets-singapore-land-transport-authority-lta/
+license:
+uri: https://api.projectnimbus.org/ltaodataservice.svc
+type: :odata
+credentialset: projectnimbus
+--- !ruby/object:RGovData::ServiceListing
+realm: :sg
+key: nea
+name: Meteorological services
+description: Meteorological services in Singapore
+keywords: weather
+publisher: Singapore National Environment Agency
+info_uri: http://projectnimbus.org/2010/04/11/datasets-singapore-national-environment-agency-nea/
+license:
+uri: https://api.projectnimbus.org/neaodataservice.svc
+type: :odata
+credentialset: projectnimbus
+--- !ruby/object:RGovData::ServiceListing
+realm: :sg
+key: nlb
+name: Libraries
+description: Information about the Public Libraries in Singapore and their collections
+keywords: library, book
+publisher: National Library Board Singapore (NLB)
+info_uri: http://projectnimbus.org/2010/04/11/datasets-national-library-board-nlb/
+license:
+uri: https://api.projectnimbus.org/nlbodataservice.svc
+type: :odata
+credentialset: projectnimbus
+--- !ruby/object:RGovData::ServiceListing
+realm: :sg
+key: snb
+name: ShowNearBy
+description: locations of persons, points-of-interest, and activities
+keywords: location, bus stop, ATM, clinic, shops, AED
+publisher: ShowNearBy
+info_uri: http://projectnimbus.org/2010/04/12/datasets-shownearby-snb/
+license:
+uri: https://api.projectnimbus.org/snbodataservice.svc
+type: :odata
+credentialset: projectnimbus
+--- !ruby/object:RGovData::ServiceListing
+realm: :sg
+key: stb
+name: Events and Places
+description: Tourism related events and places
+keywords: event, hotel, places of interest
+publisher: Singapore Tourism Board
+info_uri: http://projectnimbus.org/2010/04/12/datasets-singapore-tourism-board-stb/
+license:
+uri: https://api.projectnimbus.org/stbodataservice.svc
+type: :odata
+credentialset: projectnimbus
+--- !ruby/object:RGovData::ServiceListing
+realm: :sg
+key: sp
+name: Singapore Post
+description: Post Office and SAM locations
+keywords: post, location
+publisher: Singapore Post
+info_uri: http://projectnimbus.org/2010/04/12/datasets-singapore-post-sp/
+license:
+uri: https://api.projectnimbus.org/spodataservice.svc
+type: :odata
+credentialset: projectnimbus
+--- !ruby/object:RGovData::ServiceListing
+realm: :sg
+key: usr
+name: User Contributed Content
+description: User Contributed Datasets is part of the community driven efforts to provide interesting datasets
+keywords: location
+publisher: ProjectNimbus
+info_uri: http://projectnimbus.org/2010/10/04/datasets-user-contributed-content-usr/
+license:
+uri: https://api.projectnimbus.org/usrodataservice.svc
+type: :odata
+credentialset: projectnimbus
+# --- !ruby/object:RGovData::ServiceListing
+## Places currently excluded wince the metadata doesn't fully describe the mandatory parameters required
+## for the Detail and Search collections. Leaving places out of the registry until this is sorted.
+# realm: :sg
+# key: places
+# name: Places
+# description: Places.sg aggregates the flow of your information to multiple web and mobile sites, so that when you upload your information and/or promotions in one place, it gets quickly syndicated to many digital properties
+# keywords: location
+# publisher:  Places.sg
+# info_uri: http://projectnimbus.org/2010/10/18/datasets-places-sg/
+# license:
+# uri: https://api.projectnimbus.org/placesodataservice.svc
+# type: :odata
+# credentialset: projectnimbus
+--- !ruby/object:RGovData::ServiceListing
+realm: :sg
+key: caas_air_cargo_discharged
+name: Air Cargo Discharged
+description: Air Cargo Discharged - Total by Region and Selected Country of Origin
+keywords: Transportation and Storage
+publisher: Civil Aviation Authority of Singapore
+info_uri:
+license:
+uri: http://data.gov.sg/common/download.aspx?id=13008&rid=1805010000000004396B&filetype=csv
+type: :file
+
+

data/lib/rgovdata/data/template.rb

@@ -0,0 +1,27 @@
+require 'pathname'
+
+# This is a convenience class for accessing disk-based template files
+# It avoids pathname processing from being required where template are used
+class RGovData::Template
+  
+  class << self
+    # Returns the template file path
+    # +name+ is the filename
+    # +realm+ if specified is the subdirectory
+    def path(name, realm = nil)
+      extra_path = [realm,name].compact.map(&:to_s)
+      Pathname.new(File.dirname(__FILE__)).join(*extra_path).to_s
+    rescue
+      nil
+    end
+
+    # Returns the template file content
+    # +name+ is the filename
+    # +realm+ if specified is the subdirectory
+    def get(name, realm = nil)
+      IO.read(path(name, realm))
+    rescue
+      nil
+    end
+  end
+end