pure-extractor 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 40f1c2344052bbe0bb2dd38b51ae78e0edca2138
4
- data.tar.gz: b5f685c5147b0ae84e6aa7b71b73c1658df6a42b
3
+ metadata.gz: f051ced414012b5cd2c63d8a83bd34ea7f47efef
4
+ data.tar.gz: 31e00c0c123684966bc71f5f6ecc572df34ecdd6
5
5
  SHA512:
6
- metadata.gz: 72cdca316a23fe256800d219e4e5e168f8fcb0f332967c6c23f6a6f5689e0607fe67c2e9f7b9830ea98bc3a8508c3e4e58b065886f0e2baa554fdd014d4d5554
7
- data.tar.gz: 18c0a8c121a20cbb5fafbe0ee9c5a3ce60449e0b15fa600c19bb9d86a6869897b1741532ad5476d35e98d9cbad3cf6b7b6f36cd1217bfdc2a6b9ff20b73e3b87
6
+ metadata.gz: 11580f6872db2bd4051a05a45a50a978287bd0b8cb39462405066aeebbcb4ac5be68a2a52926124d066f0915726cba22def420f6a8e253b32f2bc19bfdd5dd83
7
+ data.tar.gz: 7e2e8c1c01b1339e0d3912e6ed60b04ab1d3cada58e9226cf85cd6cc4e38a1915ce4c1906162d95a219ae251994689f85af9fa1f80e9b3f1053fddd132c99dab
data/README.md CHANGED
@@ -1,28 +1,48 @@
1
1
  # Pure::Extractor
2
2
 
3
- 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.
4
-
5
- TODO: Delete this and the text above, and describe your gem
3
+ Gem providing a command line utility for extracting information from the Pure CRIS System to JSON files ready for importing into DMA Online.
6
4
 
7
5
  ## Installation
8
6
 
9
- Add this line to your application's Gemfile:
7
+ Install the gem from rubygems:
8
+
9
+ $ gem install pure-extractor
10
+
11
+ ## Usage
12
+
13
+ Provides an executable called `pure-extractor` to extract information from Pure using the Pure WS Rest APIs via [puree](https://github.com/lulibrary/puree).
14
+
15
+ ### Example Usage
16
+
17
+ With authenticated Pure server
10
18
 
11
- ```ruby
12
- gem 'pure-extractor'
19
+ ```
20
+ pure-extractor -s "http://pure.lancs.ac.uk/ws/rest" -u "username", -p "password" -o "/home/users/output-folder/organisation.json" organisation
13
21
  ```
14
22
 
15
- And then execute:
23
+ With unauthenticated Pure server
16
24
 
17
- $ bundle
25
+ ```
26
+ pure-extractor -s "http://pure.lancs.ac.uk/ws/rest" -o "/home/users/output-folder/organisation.json" organisation
27
+ ```
18
28
 
19
- Or install it yourself as:
29
+ ### Command Line Arguements
20
30
 
21
- $ gem install pure-extractor
31
+ In order to support both unauthenticated and authenticated pure servers the username and password arguments are not required.
22
32
 
23
- ## Usage
33
+ Generic usage
34
+
35
+ ```
36
+ pure-extractor -s SERVER_URL -u USERNAME -p PASSWORD -o OUTPUT_FILE EXTRACT_AREA
37
+ ```
24
38
 
25
- TODO: Write usage instructions here
39
+ | Option | Description |
40
+ | --- | --- |
41
+ | -h, --help | Display the help text explaining how to use the command line utility |
42
+ | -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 |
43
+ | -s, --server | The URL for the Pure WS Rest service including protocol eg. `http://pure.lancs.ac.uk/ws/rest` |
44
+ | -u, --username | Username for the Pure WS Rest service, not required if Pure WS requests are unauthenticated |
45
+ | -p, --password | Password for the Pure WS Rest service, not required if Pure WS requests are unauthenticated |
26
46
 
27
47
  ## Development
28
48
 
@@ -32,5 +52,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
32
52
 
33
53
  ## Contributing
34
54
 
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pure-extractor.
55
+ Bug reports and pull requests are welcome on GitHub at https://github.com/lulibrary/dmao-pure-extractor.
36
56
 
@@ -1,5 +1,5 @@
1
1
  module Pure
2
2
  module Extractor
3
- VERSION = "0.3.0"
3
+ VERSION = "0.4.0"
4
4
  end
5
5
  end
@@ -1,6 +1,7 @@
1
1
  require "pure/extractor/version"
2
2
  require "pure/extractor/configure_puree"
3
3
  require "pure/extractor/commands/pure_extractor"
4
+ require 'ruby-progressbar'
4
5
 
5
6
  module Pure
6
7
  module Extractor
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: pure-extractor
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Stephen Robinson