gi_cat_driver 0.0.8 → 0.1.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.
Files changed (4) hide show
  1. data/README.md +58 -14
  2. data/gi_cat_driver.gemspec +2 -2
  3. data/lib/gi_cat_driver/version.rb +1 -1
  4. metadata +40 -13
data/README.md CHANGED
@@ -1,6 +1,12 @@
1
1
  # GI-Cat Driver
2
2
 
3
- The GI-Cat driver is a ruby wrapper for GI-Cat services. Remotely configure administration options for a GI-Cat instance.
3
+ The GI-Cat driver is a ruby API wrapper for GI-Cat services. Remotely configure administration options for a GI-Cat instance.
4
+
5
+ ## Requirements
6
+
7
+ * Ruby 1.9.3
8
+ * rest-client
9
+ * nokogiri
4
10
 
5
11
  ## Installation
6
12
 
@@ -16,25 +22,62 @@ Or install it yourself as:
16
22
 
17
23
  $ gem install gi_cat_driver
18
24
 
19
- ## Usage
25
+ ## Quick Start Guide
20
26
 
21
- Assuming you have a GI-Cat application running at http://www.company.com/api/gi-cat/
22
- and an administrative login of username='admin', password='password' create a new GiCat
23
- to start using the gem.
27
+ Connect to an existing GI-Cat instance using the following code:
24
28
 
25
- ```ruby
26
- gi_cat = GiCatDriver::GiCat.new('http://www.company.com/api/gi-cat', 'admin', 'password')
29
+ ```Ruby
30
+ gi_cat = GiCatDriver::GiCat.new("http://www.mycompany.com/api/gi-cat/", ADMIN_USERNAME, ADMIN_PASSWORD)
27
31
  ```
28
- Note you must provide a URL to a running GI-Cat instance as well as the administrator username and password.
29
32
 
30
- ## API Documentation
33
+ The gi_cat variable can now be used to access various methods to control GI-Cat:
31
34
 
32
- Main API methods are
33
-
34
- ```ruby
35
- GiCatDriver
35
+ ```Ruby
36
+ gi_cat.enable_profile "MY_PROFILE_NAME"
36
37
  ```
37
38
 
39
+ ## Documentation
40
+
41
+ Annotated source code documentation is available at http://nsidc.github.com/gi_cat_driver/
42
+
43
+ Rubydoc API documentation is available at http://rubydoc.info/gems/gi_cat_driver/
44
+
45
+ ## Version History
46
+
47
+ * 0.1.0
48
+ * Release stable version of gem features that invoke GI-Cat
49
+ * 0.0.8
50
+ * Minor refactoring
51
+ * 0.0.7
52
+ * Code documentation
53
+ * 0.0.6
54
+ * Dropped ruby version to 1.9.3-p194
55
+ * 0.0.5
56
+ * Added methods to initiate and monitor harvesting with GI-Cat
57
+ * 0.0.4
58
+ * 0.0.2
59
+ * Added code documentation
60
+ * Removed functionality dependent on NSIDC internal systems
61
+ * 0.0.1
62
+ * Initial release
63
+
64
+ ## Versioning
65
+
66
+ This gem follows the principles of [Semantic Versioning 2.0.0](http://semver.org/)
67
+
68
+ ## Releasing
69
+
70
+ 1. Make sure to increment the version number (See the section about versioning above) and append a description of your changes to the Version History section above.
71
+ 2. Commit changes into the master branch of the repo on sourcecontrol.nsidc.org
72
+ 3. The commit will trigger a Jenkins job to run the tests
73
+ 4. When the changes are ready to be released, you can either push the gem manually or run a job in Jenkins
74
+ 4a. To push manually: You must have permissions on the GitHub repository through the NSIDC organization and you must be an owner of the 'gi_cat_driver'a gem on RubyGems.
75
+ Once you have the credentials, run the command 'rake release' to tag the version number in the Git revision history and publish on RubyGems.
76
+ To push to GitHub make sure you have the remotes configured (run 'git remote -v' to list available remotes. To add the GitHub repository to your remotes, run 'git remote add github https://github.com/nsidc/gi_cat_driver.git')
77
+ 4b: Using Jenkins: Run the job named 'GI-Cat_(gem)_Deploy_gi_cat_driver'
78
+
79
+ NOTE: RubyGems will not allow you to release the same version of a gem more than once.
80
+
38
81
  ## Contributing
39
82
 
40
83
  1. Fork it
@@ -51,4 +94,5 @@ GI-Cat Driver is licensed under the MIT license. See [LICENSE.txt][license].
51
94
 
52
95
  ## Credit
53
96
 
54
- This software was developed by the National Snow and Ice Data Center, sponsored by the National Science Foundation grant number OPP-10-16048.
97
+ This software was developed by the National Snow and Ice Data Center,
98
+ sponsored by the National Science Foundation grant number OPP-10-16048.
data/gi_cat_driver.gemspec CHANGED
@@ -6,8 +6,8 @@ require 'gi_cat_driver/version'
6
6
  Gem::Specification.new do |spec|
7
7
  spec.name = "gi_cat_driver"
8
8
  spec.version = GiCatDriver::VERSION
9
- spec.authors = ["Stuart Reed"]
10
- spec.email = ["stuart.reed@nsidc.org"]
9
+ spec.authors = ["Stuart Reed", "Miao Liu"]
10
+ spec.email = ["stuart.reed@nsidc.org", "miao.liu@nsidc.org"]
11
11
  spec.description = %q{Configure and control deployed instances of GI-Cat.}
12
12
  spec.summary = %q{Configure and control deployed instances of GI-Cat.}
13
13
  spec.homepage = ""
data/lib/gi_cat_driver/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module GiCatDriver
2
- VERSION = "0.0.8"
2
+ VERSION = "0.1.0"
3
3
  end
metadata CHANGED
@@ -1,19 +1,20 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gi_cat_driver
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.8
4
+ version: 0.1.0
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
8
8
  - Stuart Reed
9
+ - Miao Liu
9
10
  autorequire:
10
11
  bindir: bin
11
12
  cert_chain: []
12
- date: 2013-03-15 00:00:00.000000000 Z
13
+ date: 2013-03-20 00:00:00.000000000 Z
13
14
  dependencies:
14
15
  - !ruby/object:Gem::Dependency
15
16
  name: rest-client
16
- requirement: &70096194507620 !ruby/object:Gem::Requirement
17
+ requirement: !ruby/object:Gem::Requirement
17
18
  none: false
18
19
  requirements:
19
20
  - - ~>
@@ -21,10 +22,15 @@ dependencies:
21
22
  version: 1.6.7
22
23
  type: :runtime
23
24
  prerelease: false
24
- version_requirements: *70096194507620
25
+ version_requirements: !ruby/object:Gem::Requirement
26
+ none: false
27
+ requirements:
28
+ - - ~>
29
+ - !ruby/object:Gem::Version
30
+ version: 1.6.7
25
31
  - !ruby/object:Gem::Dependency
26
32
  name: nokogiri
27
- requirement: &70096194507020 !ruby/object:Gem::Requirement
33
+ requirement: !ruby/object:Gem::Requirement
28
34
  none: false
29
35
  requirements:
30
36
  - - ~>
@@ -32,10 +38,15 @@ dependencies:
32
38
  version: 1.5.6
33
39
  type: :runtime
34
40
  prerelease: false
35
- version_requirements: *70096194507020
41
+ version_requirements: !ruby/object:Gem::Requirement
42
+ none: false
43
+ requirements:
44
+ - - ~>
45
+ - !ruby/object:Gem::Version
46
+ version: 1.5.6
36
47
  - !ruby/object:Gem::Dependency
37
48
  name: bundler
38
- requirement: &70096194506540 !ruby/object:Gem::Requirement
49
+ requirement: !ruby/object:Gem::Requirement
39
50
  none: false
40
51
  requirements:
41
52
  - - ~>
@@ -43,10 +54,15 @@ dependencies:
43
54
  version: '1.3'
44
55
  type: :development
45
56
  prerelease: false
46
- version_requirements: *70096194506540
57
+ version_requirements: !ruby/object:Gem::Requirement
58
+ none: false
59
+ requirements:
60
+ - - ~>
61
+ - !ruby/object:Gem::Version
62
+ version: '1.3'
47
63
  - !ruby/object:Gem::Dependency
48
64
  name: rake
49
- requirement: &70096194506020 !ruby/object:Gem::Requirement
65
+ requirement: !ruby/object:Gem::Requirement
50
66
  none: false
51
67
  requirements:
52
68
  - - ~>
@@ -54,10 +70,15 @@ dependencies:
54
70
  version: 10.0.3
55
71
  type: :development
56
72
  prerelease: false
57
- version_requirements: *70096194506020
73
+ version_requirements: !ruby/object:Gem::Requirement
74
+ none: false
75
+ requirements:
76
+ - - ~>
77
+ - !ruby/object:Gem::Version
78
+ version: 10.0.3
58
79
  - !ruby/object:Gem::Dependency
59
80
  name: rspec
60
- requirement: &70096194505540 !ruby/object:Gem::Requirement
81
+ requirement: !ruby/object:Gem::Requirement
61
82
  none: false
62
83
  requirements:
63
84
  - - ~>
@@ -65,10 +86,16 @@ dependencies:
65
86
  version: 2.13.0
66
87
  type: :development
67
88
  prerelease: false
68
- version_requirements: *70096194505540
89
+ version_requirements: !ruby/object:Gem::Requirement
90
+ none: false
91
+ requirements:
92
+ - - ~>
93
+ - !ruby/object:Gem::Version
94
+ version: 2.13.0
69
95
  description: Configure and control deployed instances of GI-Cat.
70
96
  email:
71
97
  - stuart.reed@nsidc.org
98
+ - miao.liu@nsidc.org
72
99
  executables: []
73
100
  extensions: []
74
101
  extra_rdoc_files: []
@@ -108,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
108
135
  version: '0'
109
136
  requirements: []
110
137
  rubyforge_project:
111
- rubygems_version: 1.8.15
138
+ rubygems_version: 1.8.23
112
139
  signing_key:
113
140
  specification_version: 3
114
141
  summary: Configure and control deployed instances of GI-Cat.