kataba 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd9fd6f5ee1170b5552d4345a4c23fab923efcaa
-  data.tar.gz: e78ca648b702ecd40a576263eb6aaab7d4fd4d13
+  metadata.gz: 91cf7e773f0cead00236519792f3b0b6bf888fb8
+  data.tar.gz: 2033b27334cefc6ad872c7084759e60da09edc19
 SHA512:
-  metadata.gz: 13ed9bbd4e28ee1e7e8e955f6ea9084b52e94da83458d395fb776a75b40094079e640bdb82c7424eca93dc27b1063968b3fb96791723d1a9d432a29837a18362
-  data.tar.gz: 46f8e1813d56ecdd4cd689bd5ee2354d250861f1b627cd0812fed4ed36b4ccab8aa8313a779416e0ee69e12fb08c048c7f4bd109d2f626af1e20ac49c426ac5c
+  metadata.gz: 0c2cf4238e8b166b3646427aeeb40ca80107e8a5b08f80eea2e02a8906a2fdeb94121d3465333ad4bff29ac766a7ce90187f84af84c9c5876c5aa5b727449eff
+  data.tar.gz: 38a54143ba8b1ac21f7c5da6b1556bfc810f2a9d2ceaf8bf7ff391b09cddb42f2f7f677e26a7a532e8074eace7538170d52b6d9202330286a3e5355571aabac3

data/lib/kataba.rb

@@ -6,9 +6,17 @@ require 'open-uri'
 module Kataba
 
   class << self
+    # Simple attribute for configuration
     attr_accessor :configuration
   end
 
+  # Allows for configuration by block
+  #
+  # Example:
+  #  MegaLotto.configure do |config|
+  #   config.drawing_count = 10
+  #  end
+
   def self.configure
     yield(configuration) if block_given?
   end
@@ -17,19 +25,45 @@ module Kataba
     @configuration ||=  Configuration.new
   end
 
+  # Undoes any configuration - this method was built for testing purposes
+  #
+  # Example:
+  #   Kataba.reset
+
   def self.reset
     @configuration = Configuration.new
   end
 
   class Configuration
+    # Offline storage is "#{Dir.tmpdir}/kataba" by default.
+    # This attribute allows the user to change that default value.
+    #
+    # Example:
+    #   Kataba.configuration.offline_storage = "/tmp/kataba"
     attr_accessor :offline_storage
+    # The user can optionally provide a mirror list to reduce stress on primary XSD providers.
+    # This attribute allows the user to configure Kataba to use a YAML file with key/value pairs of
+    # original/mirror values. Sample YAML file can be found at https://github.com/dgcliff/kataba/blob/master/test/fixtures/mirror.yml
+    #
+    # Example:
+    #   Kataba.configuration.mirror_list = File.join(Rails.root, 'config', 'mirror.yml')
     attr_accessor :mirror_list
 
+    # Default configuration values
     def initialize
       @offline_storage = "#{Dir.tmpdir}/kataba"
     end
   end
 
+  # If already downloaded, uses offline version. If not, downloads from the URI provided.
+  # If mirror list is configured, searches for mirrored URI instead.
+  #
+  # Example:
+  #   Kataba.fetch_schema("http://www.loc.gov/standards/mods/v3/mods-3-5.xsd")
+  #
+  # Arguments:
+  #   xsd_uri: (String)
+
   def self.fetch_schema(xsd_uri)
     uri_md5 = Digest::MD5.hexdigest(xsd_uri)
     dir_path = "#{self.configuration.offline_storage}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kataba
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - David Cliff
@@ -24,8 +24,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-description: A simple gem that allows for the functionality that an XML catalog would
-  provide
+description: Kataba allows for mirroring and offline storage of XSD files, to enhance
+  Nokogiri
 email: d.cliff@northeastern.edu
 executables: []
 extensions: []