datagrepper 1.0.0 → 1.0.1

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. checksums.yaml +4 -4
  2. data/LICENSE +21 -0
  3. data/README.md +32 -0
  4. metadata +4 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: b972b89f8929758f0341ef5e1ad372920d5691dd
4
- data.tar.gz: 8da107d0a10160060a4373447fa03ee7f6555a22
3
+ metadata.gz: 64a823b4450ffe75810cc1029e84e6b4054917b8
4
+ data.tar.gz: 260173a953a7b62c620aedd98dd9f870b670e827
5
5
  SHA512:
6
- metadata.gz: 8bb5305dbf5aadd05adf1e49c1c2782504648122c83071f1f7b66b80dc4177b2059960abc7ed5f920b3b6f7307b817a483f78f5b3aebffe87e211b2a13f694f9
7
- data.tar.gz: 26619241d118231af04231a92e7fb46378c3e92f40a202d7c5e471426da3d34268863d592fc656d586cc9fdfaa293b9433afb71677ca8412eb6eeac744439cdc
6
+ metadata.gz: 39d1e972cc11aa18fc6674c43c49e8b4f27eb6323aa569165b45f52ad925cf84ad56116de914cd5782621a49ce3cdaf978119f0183beb1f368be86a88dd9f90b
7
+ data.tar.gz: 72d9ca75cb7ff6577d2cd48d9d2c68a280c957c2b1efa2bd1831b1aa5fa8a8dedd43241074a3dbe67ecf9e9b1edf0711075b4741054ff563595f20ba196eaca8
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2013 Red Hat, Inc.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,32 @@
1
+ # datagrepper-gem
2
+
3
+ A rubygem for interacting with the public Datagrepper API.
4
+
5
+ # Examples
6
+
7
+ datagrepper-gem provides a very simple syntax. In fact, currently, the entire
8
+ public-facing gem is just one method, `query`, which takes a hash.
9
+
10
+ ```ruby
11
+ dg = Datagrepper.new
12
+ dg.query :delta => 1.hour, :user => ['codeblock', 'toshio', 'ralph']
13
+ dg.query :delta => 3.weeks, :package => ['python-requests', 'httpie']
14
+ ```
15
+
16
+ As you can see, when you want to query with multiple parameters (for
17
+ [ORing filters](https://apps.fedoraproject.org/datagrepper/)), just pass an
18
+ `Array`.
19
+
20
+ We use the awesome [time-lord](https://github.com/krainboltgreene/time-lord)
21
+ gem to provide a nice time-period-based syntax for `delta` (e.g. `2.hours`
22
+ or `1.year`).
23
+
24
+ You can use something like the
25
+ [promise](https://github.com/bhuga/promising-future) gem to execute searches
26
+ and get a future back, because searches can take some time, and you might not
27
+ want to block.
28
+
29
+ # License
30
+
31
+ © 2013 Red Hat, Inc.
32
+ MIT License (see `LICENSE` for details).
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: datagrepper
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ricky Elrod
@@ -45,6 +45,8 @@ extensions: []
45
45
  extra_rdoc_files: []
46
46
  files:
47
47
  - lib/datagrepper.rb
48
+ - README.md
49
+ - LICENSE
48
50
  homepage: https://www.github.com/CodeBlock/datagrepper-gem
49
51
  licenses: []
50
52
  metadata: {}
@@ -69,3 +71,4 @@ signing_key:
69
71
  specification_version: 4
70
72
  summary: Ruby interface to Fedora's Datagrepper API.
71
73
  test_files: []
74
+ has_rdoc: