pure-extractor 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40f1c2344052bbe0bb2dd38b51ae78e0edca2138
-  data.tar.gz: b5f685c5147b0ae84e6aa7b71b73c1658df6a42b
+  metadata.gz: f051ced414012b5cd2c63d8a83bd34ea7f47efef
+  data.tar.gz: 31e00c0c123684966bc71f5f6ecc572df34ecdd6
 SHA512:
-  metadata.gz: 72cdca316a23fe256800d219e4e5e168f8fcb0f332967c6c23f6a6f5689e0607fe67c2e9f7b9830ea98bc3a8508c3e4e58b065886f0e2baa554fdd014d4d5554
-  data.tar.gz: 18c0a8c121a20cbb5fafbe0ee9c5a3ce60449e0b15fa600c19bb9d86a6869897b1741532ad5476d35e98d9cbad3cf6b7b6f36cd1217bfdc2a6b9ff20b73e3b87
+  metadata.gz: 11580f6872db2bd4051a05a45a50a978287bd0b8cb39462405066aeebbcb4ac5be68a2a52926124d066f0915726cba22def420f6a8e253b32f2bc19bfdd5dd83
+  data.tar.gz: 7e2e8c1c01b1339e0d3912e6ed60b04ab1d3cada58e9226cf85cd6cc4e38a1915ce4c1906162d95a219ae251994689f85af9fa1f80e9b3f1053fddd132c99dab

data/README.md

@@ -1,28 +1,48 @@
 # Pure::Extractor
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pure/extractor`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Gem providing a command line utility for extracting information from the Pure CRIS System to JSON files ready for importing into DMA Online.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install the gem from rubygems:
+
+    $ gem install pure-extractor
+
+## Usage
+
+Provides an executable called `pure-extractor` to extract information from Pure using the Pure WS Rest APIs via [puree](https://github.com/lulibrary/puree).
+
+### Example Usage
+
+With authenticated Pure server
 
-```ruby
-gem 'pure-extractor'
+```
+pure-extractor -s "http://pure.lancs.ac.uk/ws/rest" -u "username", -p "password" -o "/home/users/output-folder/organisation.json" organisation
 ```
 
-And then execute:
+With unauthenticated Pure server
 
-    $ bundle
+```
+pure-extractor -s "http://pure.lancs.ac.uk/ws/rest" -o "/home/users/output-folder/organisation.json" organisation
+```
 
-Or install it yourself as:
+### Command Line Arguements
 
-    $ gem install pure-extractor
+In order to support both unauthenticated and authenticated pure servers the username and password arguments are not required.
 
-## Usage
+Generic usage
+
+```
+pure-extractor -s SERVER_URL -u USERNAME -p PASSWORD -o OUTPUT_FILE EXTRACT_AREA
+```
 
-TODO: Write usage instructions here
+| Option | Description |
+| --- | --- |
+| -h, --help | Display the help text explaining how to use the command line utility |
+| -o, --output-file | File to output the retrieved data to, when specifying "all" as what to extract this is the directory to place the output files in |
+| -s, --server | The URL for the Pure WS Rest service including protocol eg. `http://pure.lancs.ac.uk/ws/rest` |
+| -u, --username | Username for the Pure WS Rest service, not required if Pure WS requests are unauthenticated |
+| -p, --password | Password for the Pure WS Rest service, not required if Pure WS requests are unauthenticated |
 
 ## Development
 
@@ -32,5 +52,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pure-extractor.
+Bug reports and pull requests are welcome on GitHub at https://github.com/lulibrary/dmao-pure-extractor.
 

data/lib/pure/extractor/version.rb

@@ -1,5 +1,5 @@
 module Pure
   module Extractor
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/pure/extractor.rb

@@ -1,6 +1,7 @@
 require "pure/extractor/version"
 require "pure/extractor/configure_puree"
 require "pure/extractor/commands/pure_extractor"
+require 'ruby-progressbar'
 
 module Pure
   module Extractor

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pure-extractor
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Stephen Robinson