ckan_cli 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6e9e4fe9afdc7e11b96c179e7eefe16b7c19247d4d1f08b029965688528bdf6
-  data.tar.gz: bd4ed9291ff176a1303f7ba30283070dd732ba30342347e60e25b856fdb33f16
+  metadata.gz: aae7a1a299b2acc616508accc17acfe671ccd039a1775e59982509f5df7a60d6
+  data.tar.gz: 635bd944a050cf905efc5f5368e43e6c83cc598e5a38e3813731dabd875a9424
 SHA512:
-  metadata.gz: 5cb9bbe079a905983d59158537b87ccc49901efa3e63b8ef9ca66a910224eba9b9cc7d253b864af9bd14bf1e152f828cd78ab0351a8a63767c8a93c2216b2c0f
-  data.tar.gz: 29f6dd5cf5a07bb95284dffe88529815544bb7fb95b0dc32b9ccf27542913bec7bd32307492060ead203b084fe4e49c0990be68f4591d26b72a106636dd2f4f3
+  metadata.gz: dcf056959aabfbc704a77afe4447202245efb63eaf17d44b81767a9325b90ec98dd6ccd8e6be6d43c23135f68594234398fa1be62ea34447b33b326e9daf84a5
+  data.tar.gz: 70c62017fe322b14df7fe7c98f43194799222b4acd2e22adf7f118f6c3aa1fe05b540091dd1cd8205f74cd78b4687d98e61b024ac8ef586becfb13fceb98f7c6

data/README.md

@@ -34,6 +34,66 @@ To see help do
 $ ckancli.rb help
 ```
 
+## Commands and options
+
+> All available commands and options are also described in command line help.
+
+### Basic usage
+
+Mandatory options for CSV upload are:
+- directory "-d". Local path to file/directory or URL to online resource (starting with http or https).
+- global configuration "-c". Path to global configuration file. Path should be absolute or relative to directory option. See configuration section for more information. 
+- resource configuration "-r". Path to resource metadata file. Path should be absolute or relative to directory option. See configuration section for more information. 
+
+```shell
+$ ckancli.rb upload -d C:\my_csv_collection\ -c config.json -r resource.json
+```
+
+### Validation
+
+To validate CSV resources before uploading, use validation schema option:
+- validation schema "-v". Path to JSON validation schema file. Path should be absolute or relative to directory option. See configuration section for more information.
+
+```shell
+$ ckancli.rb upload -d C:\my_csv_collection\ -c config.json -r resource.json -v schema.json
+```
+
+### Ignore file extensions
+
+By default, CKAN CLI processes only CSV files. To process all files in direcotry, ignoring extension, use ignore extension option:
+- ignore extension "-i". If set, all files in specified directory will be processed.
+
+```shell
+$ ckancli.rb upload -d C:\my_csv_collection\ -c config.json -r resource.json -i
+```
+
+### Overwriting existing resources
+
+By default, CKAN CLI will not overwrite resources if the same is found by resource identifier. To overwrite existing resource, use overwrite option:
+- overwrite "-w". If set, existing resource will be overwritten.
+
+```shell
+$ ckancli.rb upload -d C:\my_csv_collection\ -c config.json -r resource.json -w
+```
+
+### Updating modified date
+
+To automatically set resources modified date in CKAN, use update modified option:
+- update modified "-m". If set, resources metadata field "modified date" will be updated to current date.
+
+```shell
+$ ckancli.rb upload -d C:\my_csv_collection\ -c config.json -r resource.json -m
+```
+
+### Updating package metadata
+
+To also update package metadata, use dataset configuration option:
+- package configuration "-p". Path to package metadata file. Path should be absolute or relative to directory option. See configuration section for more information. 
+
+```shell
+$ ckancli.rb upload -d C:\my_csv_collection\ -c config.json -r resource.json -p package.json
+```
+
 ## Configuration
 
 > Example files including schemas and configurations are located in 'example_files' directory.
@@ -66,7 +126,9 @@ Contains configuration for CKAN API and e-mail notifications (sections "email_se
 
 ### Resource configuration
 
-Contains configuration for resource metadata (parameters as specified in CKAN API guidelines). If resource name is not specified, file name will be used. If resource identifier is not specified, new resource will be created.
+Contains configuration for resource metadata (parameters as specified in CKAN API guidelines). Specified parameters will be passed to CKAN API with resource file. 
+- If resource name is not specified, file name will be used. 
+- If resource identifier is not specified, new resource will be created.
 
 ```javascript
 {

data/lib/ckancli/commands/upload.rb

@@ -114,6 +114,7 @@ module Ckancli
                 :path => r,
                 :valid => true, 
                 :summary => nil, 
+                :error => nil,
                 :log_file => File.open(File.join(@dir, "#{File.basename(r)}.log"), "w"), 
                 :log => nil 
               } 
@@ -217,8 +218,10 @@ module Ckancli
 
               if !exception.nil?
                 res[:log].error msg, exception
+                res[:error] = msg
               elsif !msg.nil?
                 res[:log].info msg
+                res[:error] = msg
               else 
                 res[:log].info "OK - Validation successfull"
               end
@@ -256,8 +259,11 @@ module Ckancli
             # attachments
             @resources.each do |res|
               msg = "#{msg}\r\n-  #{File.basename(res[:path])}"
-              if !res[:summary].nil?
-                msg = "#{msg} (#{res[:summary][:errors].length} errors, #{res[:summary][:warnings].length} warnings)"
+              if !res[:error].nil?
+                msg = "#{msg} (#{res[:error]})"
+                has_errors = true
+              elsif !res[:summary].nil?
+                msg = "#{msg} (#{res[:summary][:errors].length} validation errors, #{res[:summary][:warnings].length} validation warnings)"
                 if res[:summary][:errors].length > 0
                   has_errors = true
                 end
@@ -319,6 +325,7 @@ module Ckancli
 
               if !ok
                 res[:log].error msg
+                res[:error] = msg
               else
                 res[:log].info "OK - upload successfull"
               end

data/lib/ckancli/version.rb

@@ -1,3 +1,3 @@
 module Ckancli
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ckan_cli
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - datagovlv
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-19 00:00:00.000000000 Z
+date: 2019-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-color