ghee 0.7.0 → 0.7.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +3 -1
- data/README.md +54 -5
- data/ghee.gemspec +3 -3
- data/lib/ghee/version.rb +1 -1
- metadata +24 -23
data/.gitignore
CHANGED
data/README.md
CHANGED
@@ -6,10 +6,18 @@ This is an unofficial ruby client for the [GitHub API](http://developer.github.c
|
|
6
6
|
Usage
|
7
7
|
-----
|
8
8
|
|
9
|
-
Instantiate the client:
|
9
|
+
Instantiate the client with basic auth:
|
10
10
|
|
11
|
-
|
12
|
-
|
11
|
+
gh = Ghee.basic_auth("rauhryan","password")
|
12
|
+
|
13
|
+
Instantiate the client with auth token:
|
14
|
+
|
15
|
+
gh = Ghee.access_token("1234oijgakjioewj1o4oij")
|
16
|
+
|
17
|
+
Create an OAuth access token:
|
18
|
+
|
19
|
+
user_name, password, scopes = "rauhryan", "secret", "repos, user"
|
20
|
+
token = Ghee.create_token(user_name, password, scopes)
|
13
21
|
|
14
22
|
### Gists
|
15
23
|
|
@@ -314,6 +322,47 @@ List public events:
|
|
314
322
|
|
315
323
|
gh.events
|
316
324
|
|
325
|
+
### Pagination
|
326
|
+
|
327
|
+
Ghee fully supports pagination for anything that returns a list, for
|
328
|
+
example repo issues.
|
329
|
+
|
330
|
+
gh.repos("rauhryan","huboard").issues.paginate(:per_page => 30, :page => 1) #=> returns first page of issues
|
331
|
+
gh.repos("rauhryan","huboard").issues.paginate(:per_page => 30, :page => 2) #=> returns page two of issues
|
332
|
+
gh.repos("rauhryan","huboard").issues.paginate(:per_page => 30, :page => 2).first_page #=> 1
|
333
|
+
gh.repos("rauhryan","huboard").issues.paginate(:per_page => 30, :page => 2).last_page #=> 4
|
334
|
+
gh.repos("rauhryan","huboard").issues.paginate(:per_page => 30, :page => 2).next_page #=> 3
|
335
|
+
gh.repos("rauhryan","huboard").issues.paginate(:per_page => 30, :page => 2).prev_page #=> 1
|
336
|
+
|
337
|
+
Ghee also provides a convienence method for all the pages
|
338
|
+
|
339
|
+
gh.repos("rauhryan","huboard").issues.all #=> return all the pages
|
340
|
+
|
341
|
+
### Filtering parameters
|
342
|
+
|
343
|
+
Many of the api calls allow you to pass in additional paramters to
|
344
|
+
filter and sort your data, for example issues provide
|
345
|
+
|
346
|
+
* filter
|
347
|
+
* `assigned`
|
348
|
+
* `mentioned`
|
349
|
+
* `subscribed`
|
350
|
+
* `created`
|
351
|
+
* state
|
352
|
+
* `open` `closed` `default`
|
353
|
+
* labels
|
354
|
+
* list of labels comma delimited `herp,derp`
|
355
|
+
* direction
|
356
|
+
* `asc` or `desc`
|
357
|
+
|
358
|
+
These can all be passed into ghee through an options hash:
|
359
|
+
|
360
|
+
gh.repos("rauhryan", "huboard").issues(:state => "closed", :sort => "desc")
|
361
|
+
|
362
|
+
> Note you can also change parameters with pagination!
|
363
|
+
|
364
|
+
gh.repos("rauhryan", "huboard").issues(:state => "closed").all
|
365
|
+
|
317
366
|
Testing
|
318
367
|
-------
|
319
368
|
|
@@ -333,7 +382,7 @@ CONTRIBUTE
|
|
333
382
|
|
334
383
|
If you'd like to hack on Ghee, start by forking the repo on GitHub:
|
335
384
|
|
336
|
-
https://github.com/
|
385
|
+
https://github.com/rauhryan/ghee
|
337
386
|
|
338
387
|
The best way to get your changes merged back into core is as follows:
|
339
388
|
|
@@ -349,5 +398,5 @@ The best way to get your changes merged back into core is as follows:
|
|
349
398
|
|
350
399
|
Contributors
|
351
400
|
------------
|
352
|
-
* Jonathan Hoyt
|
401
|
+
* [Jonathan Hoyt](https://github.com/jonmagic)
|
353
402
|
* [Ryan Rauh](https://github.com/rauhryan)
|
data/ghee.gemspec
CHANGED
@@ -5,9 +5,9 @@ require "ghee/version"
|
|
5
5
|
Gem::Specification.new do |s|
|
6
6
|
s.name = "ghee"
|
7
7
|
s.version = Ghee::VERSION
|
8
|
-
s.authors = ["Jonathan Hoyt"]
|
9
|
-
s.email = ["
|
10
|
-
s.homepage = "http://github.com/
|
8
|
+
s.authors = ["Ryan Rauh","Jonathan Hoyt"]
|
9
|
+
s.email = ["rauh.ryan@gmail.com"]
|
10
|
+
s.homepage = "http://github.com/rauhryan/ghee"
|
11
11
|
s.summary = %q{Access Github in ruby.}
|
12
12
|
s.description = %q{A complete, simple, and intuitive ruby API for all things Github.}
|
13
13
|
|
data/lib/ghee/version.rb
CHANGED
metadata
CHANGED
@@ -1,10 +1,11 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: ghee
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.7.
|
4
|
+
version: 0.7.1
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
8
|
+
- Ryan Rauh
|
8
9
|
- Jonathan Hoyt
|
9
10
|
autorequire:
|
10
11
|
bindir: bin
|
@@ -13,7 +14,7 @@ date: 2012-04-05 00:00:00.000000000Z
|
|
13
14
|
dependencies:
|
14
15
|
- !ruby/object:Gem::Dependency
|
15
16
|
name: faraday
|
16
|
-
requirement: &
|
17
|
+
requirement: &70106718506800 !ruby/object:Gem::Requirement
|
17
18
|
none: false
|
18
19
|
requirements:
|
19
20
|
- - ! '>='
|
@@ -21,10 +22,10 @@ dependencies:
|
|
21
22
|
version: '0'
|
22
23
|
type: :runtime
|
23
24
|
prerelease: false
|
24
|
-
version_requirements: *
|
25
|
+
version_requirements: *70106718506800
|
25
26
|
- !ruby/object:Gem::Dependency
|
26
27
|
name: faraday_middleware
|
27
|
-
requirement: &
|
28
|
+
requirement: &70106718506220 !ruby/object:Gem::Requirement
|
28
29
|
none: false
|
29
30
|
requirements:
|
30
31
|
- - ! '>='
|
@@ -32,10 +33,10 @@ dependencies:
|
|
32
33
|
version: '0'
|
33
34
|
type: :runtime
|
34
35
|
prerelease: false
|
35
|
-
version_requirements: *
|
36
|
+
version_requirements: *70106718506220
|
36
37
|
- !ruby/object:Gem::Dependency
|
37
38
|
name: multi_json
|
38
|
-
requirement: &
|
39
|
+
requirement: &70106718505640 !ruby/object:Gem::Requirement
|
39
40
|
none: false
|
40
41
|
requirements:
|
41
42
|
- - ! '>='
|
@@ -43,10 +44,10 @@ dependencies:
|
|
43
44
|
version: '0'
|
44
45
|
type: :runtime
|
45
46
|
prerelease: false
|
46
|
-
version_requirements: *
|
47
|
+
version_requirements: *70106718505640
|
47
48
|
- !ruby/object:Gem::Dependency
|
48
49
|
name: yajl-ruby
|
49
|
-
requirement: &
|
50
|
+
requirement: &70106718505080 !ruby/object:Gem::Requirement
|
50
51
|
none: false
|
51
52
|
requirements:
|
52
53
|
- - ! '>='
|
@@ -54,10 +55,10 @@ dependencies:
|
|
54
55
|
version: '0'
|
55
56
|
type: :runtime
|
56
57
|
prerelease: false
|
57
|
-
version_requirements: *
|
58
|
+
version_requirements: *70106718505080
|
58
59
|
- !ruby/object:Gem::Dependency
|
59
60
|
name: rake
|
60
|
-
requirement: &
|
61
|
+
requirement: &70106718504580 !ruby/object:Gem::Requirement
|
61
62
|
none: false
|
62
63
|
requirements:
|
63
64
|
- - ! '>='
|
@@ -65,10 +66,10 @@ dependencies:
|
|
65
66
|
version: '0'
|
66
67
|
type: :development
|
67
68
|
prerelease: false
|
68
|
-
version_requirements: *
|
69
|
+
version_requirements: *70106718504580
|
69
70
|
- !ruby/object:Gem::Dependency
|
70
71
|
name: rspec
|
71
|
-
requirement: &
|
72
|
+
requirement: &70106718504080 !ruby/object:Gem::Requirement
|
72
73
|
none: false
|
73
74
|
requirements:
|
74
75
|
- - ~>
|
@@ -76,10 +77,10 @@ dependencies:
|
|
76
77
|
version: '2.0'
|
77
78
|
type: :development
|
78
79
|
prerelease: false
|
79
|
-
version_requirements: *
|
80
|
+
version_requirements: *70106718504080
|
80
81
|
- !ruby/object:Gem::Dependency
|
81
82
|
name: webmock
|
82
|
-
requirement: &
|
83
|
+
requirement: &70106718503600 !ruby/object:Gem::Requirement
|
83
84
|
none: false
|
84
85
|
requirements:
|
85
86
|
- - ! '>='
|
@@ -87,10 +88,10 @@ dependencies:
|
|
87
88
|
version: '0'
|
88
89
|
type: :development
|
89
90
|
prerelease: false
|
90
|
-
version_requirements: *
|
91
|
+
version_requirements: *70106718503600
|
91
92
|
- !ruby/object:Gem::Dependency
|
92
93
|
name: vcr
|
93
|
-
requirement: &
|
94
|
+
requirement: &70106718502960 !ruby/object:Gem::Requirement
|
94
95
|
none: false
|
95
96
|
requirements:
|
96
97
|
- - ! '>='
|
@@ -98,10 +99,10 @@ dependencies:
|
|
98
99
|
version: '0'
|
99
100
|
type: :development
|
100
101
|
prerelease: false
|
101
|
-
version_requirements: *
|
102
|
+
version_requirements: *70106718502960
|
102
103
|
- !ruby/object:Gem::Dependency
|
103
104
|
name: ZenTest
|
104
|
-
requirement: &
|
105
|
+
requirement: &70106718502280 !ruby/object:Gem::Requirement
|
105
106
|
none: false
|
106
107
|
requirements:
|
107
108
|
- - ! '>='
|
@@ -109,10 +110,10 @@ dependencies:
|
|
109
110
|
version: '0'
|
110
111
|
type: :development
|
111
112
|
prerelease: false
|
112
|
-
version_requirements: *
|
113
|
+
version_requirements: *70106718502280
|
113
114
|
- !ruby/object:Gem::Dependency
|
114
115
|
name: autotest-growl
|
115
|
-
requirement: &
|
116
|
+
requirement: &70106718501440 !ruby/object:Gem::Requirement
|
116
117
|
none: false
|
117
118
|
requirements:
|
118
119
|
- - ! '>='
|
@@ -120,10 +121,10 @@ dependencies:
|
|
120
121
|
version: '0'
|
121
122
|
type: :development
|
122
123
|
prerelease: false
|
123
|
-
version_requirements: *
|
124
|
+
version_requirements: *70106718501440
|
124
125
|
description: A complete, simple, and intuitive ruby API for all things Github.
|
125
126
|
email:
|
126
|
-
-
|
127
|
+
- rauh.ryan@gmail.com
|
127
128
|
executables: []
|
128
129
|
extensions: []
|
129
130
|
extra_rdoc_files: []
|
@@ -165,7 +166,7 @@ files:
|
|
165
166
|
- spec/settings.yml.sample
|
166
167
|
- spec/spec.opts
|
167
168
|
- spec/spec_helper.rb
|
168
|
-
homepage: http://github.com/
|
169
|
+
homepage: http://github.com/rauhryan/ghee
|
169
170
|
licenses: []
|
170
171
|
post_install_message:
|
171
172
|
rdoc_options: []
|