rubhub 0.0.3 → 0.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +124 -0
  3. metadata +36 -21
  4. data/test/test.rb +0 -9
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 3f2e1422df2e24b4607033dc67d95e8bda5270e9
4
+ data.tar.gz: d948e92b6718fbf8af00ed519c8e3f5d468b8eb3
5
+ SHA512:
6
+ metadata.gz: 42d3a1159de5cb94185481adef849e84c2af98c137395051fbfc80f8203f38fe78ef2307b66e50731763e43afbe7a5541a961f6f3399846112331650417f6fa6
7
+ data.tar.gz: 79614f4f66e18f46f86c67ff12b1467a06a67c8e5ea7c8212e6ad6627c7b732e35801fd0997b425a7e3a3d37fcfcdc6314c75b69a2595d58a6807357eb7cbfd8
data/README.md CHANGED
@@ -0,0 +1,124 @@
1
+ *rubhub - Ruby Gem for the Github API*
2
+ =================================================
3
+ -------------------------------------------------
4
+ A minimal Ruby Gem created for making interaction with the Github API(v3) easy and predictable.
5
+
6
+ http://developer.github.com/v3/
7
+
8
+ *Installation*
9
+ -------------------------------------------------
10
+ <pre>
11
+ gem install rubhub
12
+ </pre>
13
+
14
+ *Basic Authentication*
15
+ -------------------------------------------------
16
+ Use a username and password associated with a Github account.
17
+
18
+ Example:
19
+ <pre>
20
+ require 'rubhub'
21
+ g = Github.new( username, password )
22
+ </pre>
23
+
24
+ *Making Requests*
25
+ =================================================
26
+ -------------------------------------------------
27
+ Use the API documentation as a reference. The library is structured exactly like the API v3 documentation.
28
+
29
+ *Example Request for Authenticated User's Data*
30
+ -------------------------------------------------
31
+ <pre>
32
+ response = g.users.getUser()
33
+ </pre>
34
+ <h4>The response...</h4>
35
+ <pre>
36
+ {
37
+ "type": "User",
38
+ "url": "https://api.github.com/users/username",
39
+ "private_gists": 2,
40
+ "created_at": "2011-07-07T22:20:48Z",
41
+ "email": "example@gmail.com",
42
+ "html_url": "https://github.com/username",
43
+ "gravatar_id": "123123123123123123123123123",
44
+ "collaborators": 1,
45
+ "hireable": false,
46
+ "disk_usage": 13348,
47
+ "total_private_repos": 3,
48
+ "following": 4,
49
+ "blog": "http://www.yoursitename.com/",
50
+ "bio": null,
51
+ "avatar_url": "https://www.avatar.com/pathtoyouravatar.png",
52
+ "login": "username",
53
+ "owned_private_repos": 3,
54
+ "followers": 1,
55
+ "name": "Your Name",
56
+ "plan": {
57
+ "private_repos": 10,
58
+ "collaborators": 3,
59
+ "space": 614400,
60
+ "name": "micro"
61
+ },
62
+ "location": "Your City, NY",
63
+ "id": 902312,
64
+ "public_repos": 0,
65
+ "public_gists": 17,
66
+ "company": "Your Company Name, LLC"
67
+ }
68
+ </pre>
69
+
70
+
71
+ *Example Request Creating a New Repository*
72
+ -------------------------------------------------
73
+ <pre>
74
+ # Using just the new Repo name
75
+ response = g.repos.createUserRepo( "MyNewRepo" )
76
+
77
+ # Using some other parameters
78
+ name = 'MyNewRepo'
79
+ desc = 'Some description.'
80
+ page = 'www.homepage.com'
81
+ private = TRUE
82
+ has_issues = TRUE
83
+ has_wiki = TRUE
84
+ has_downloads = TRUE
85
+ response = g.repos.createUserRepo( name, desc, page, private, has_issues, has_wiki, has_downloads )
86
+ </pre>
87
+
88
+ <h4>The response...</h4>
89
+ <pre>
90
+ {
91
+ "url": "https://api.github.com/repos/username/MyNewRepo",
92
+ "watchers": 1,
93
+ "has_issues": true,
94
+ "created_at": "2012-02-14T03:40:49Z",
95
+ "html_url": "https://github.com/username/MyNewRepo",
96
+ "has_downloads": true,
97
+ "ssh_url": "git@github.com:username/MyNewRepo.git",
98
+ "svn_url": "https://github.com/username/MyNewRepo",
99
+ "description": "Some description.",
100
+ "mirror_url": null,
101
+ "clone_url": "https://github.com/username/MyNewRepo.git",
102
+ "forks": 1,
103
+ "fork": false,
104
+ "has_wiki": true,
105
+ "private": True,
106
+ "homepage": "www.homepage.com",
107
+ "size": 0,
108
+ "updated_at": "2012-02-14T03:40:49Z",
109
+ "owner": {
110
+ "url": "https://api.github.com/users/username",
111
+ "avatar_url": "https://secure.gravatar.com/avatar/someimage.png",
112
+ "gravatar_id": "948f18791231231231231231231",
113
+ "login": "username",
114
+ "id": 901650
115
+ },
116
+ "name": "MyNewRepo",
117
+ "open_issues": 0,
118
+ "master_branch": null,
119
+ "pushed_at": null,
120
+ "id": 3436770,
121
+ "git_url": "git://github.com/username/MyNewRepo.git",
122
+ "language": null
123
+ }
124
+ </pre>
metadata CHANGED
@@ -1,38 +1,55 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rubhub
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.3
5
- prerelease:
4
+ version: 0.0.4
6
5
  platform: ruby
7
6
  authors:
8
7
  - Sean Kennedy
9
8
  autorequire:
10
9
  bindir: bin
11
10
  cert_chain: []
12
- date: 2012-03-08 00:00:00.000000000 Z
11
+ date: 2012-02-12 00:00:00.000000000 Z
13
12
  dependencies:
14
13
  - !ruby/object:Gem::Dependency
15
14
  name: json
16
- requirement: &22155984 !ruby/object:Gem::Requirement
17
- none: false
15
+ requirement: !ruby/object:Gem::Requirement
18
16
  requirements:
19
- - - ~>
17
+ - - "~>"
20
18
  - !ruby/object:Gem::Version
21
- version: 1.5.4
19
+ version: '1.7'
20
+ - - ">="
21
+ - !ruby/object:Gem::Version
22
+ version: 1.7.7
22
23
  type: :runtime
23
24
  prerelease: false
24
- version_requirements: *22155984
25
+ version_requirements: !ruby/object:Gem::Requirement
26
+ requirements:
27
+ - - "~>"
28
+ - !ruby/object:Gem::Version
29
+ version: '1.7'
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: 1.7.7
25
33
  - !ruby/object:Gem::Dependency
26
34
  name: rest-client
27
- requirement: &22155660 !ruby/object:Gem::Requirement
28
- none: false
35
+ requirement: !ruby/object:Gem::Requirement
29
36
  requirements:
30
- - - ~>
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '1.6'
40
+ - - ">="
31
41
  - !ruby/object:Gem::Version
32
42
  version: 1.6.7
33
43
  type: :runtime
34
44
  prerelease: false
35
- version_requirements: *22155660
45
+ version_requirements: !ruby/object:Gem::Requirement
46
+ requirements:
47
+ - - "~>"
48
+ - !ruby/object:Gem::Version
49
+ version: '1.6'
50
+ - - ">="
51
+ - !ruby/object:Gem::Version
52
+ version: 1.6.7
36
53
  description: An intuitive wrapper for the Github Api v3.
37
54
  email: cspheregreen@gmail.com
38
55
  executables: []
@@ -40,8 +57,6 @@ extensions: []
40
57
  extra_rdoc_files: []
41
58
  files:
42
59
  - README.md
43
- - lib/rubhub.rb
44
- - lib/github/github.rb
45
60
  - lib/github/events/events.rb
46
61
  - lib/github/gists/gists.rb
47
62
  - lib/github/gists/gists_comments.rb
@@ -51,6 +66,7 @@ files:
51
66
  - lib/github/gitdata/gitdata_references.rb
52
67
  - lib/github/gitdata/gitdata_tags.rb
53
68
  - lib/github/gitdata/gitdata_trees.rb
69
+ - lib/github/github.rb
54
70
  - lib/github/issues/issues.rb
55
71
  - lib/github/issues/issues_comments.rb
56
72
  - lib/github/issues/issues_events.rb
@@ -73,29 +89,28 @@ files:
73
89
  - lib/github/users/users_emails.rb
74
90
  - lib/github/users/users_followers.rb
75
91
  - lib/github/users/users_keys.rb
76
- - test/test.rb
92
+ - lib/rubhub.rb
77
93
  homepage: http://rubygems.org/gems/rubhub
78
94
  licenses: []
95
+ metadata: {}
79
96
  post_install_message:
80
97
  rdoc_options: []
81
98
  require_paths:
82
99
  - lib
83
100
  required_ruby_version: !ruby/object:Gem::Requirement
84
- none: false
85
101
  requirements:
86
- - - ! '>='
102
+ - - ">="
87
103
  - !ruby/object:Gem::Version
88
104
  version: '0'
89
105
  required_rubygems_version: !ruby/object:Gem::Requirement
90
- none: false
91
106
  requirements:
92
- - - ! '>='
107
+ - - ">="
93
108
  - !ruby/object:Gem::Version
94
109
  version: '0'
95
110
  requirements: []
96
111
  rubyforge_project:
97
- rubygems_version: 1.8.17
112
+ rubygems_version: 2.4.1
98
113
  signing_key:
99
- specification_version: 3
114
+ specification_version: 4
100
115
  summary: Intuitive wrapper for the Github Api v3.
101
116
  test_files: []
data/test/test.rb DELETED
@@ -1,9 +0,0 @@
1
- $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
2
- require 'rubhub'
3
-
4
- username = 'csphere'
5
- password = 'Asdf1597531`1'
6
-
7
- g = Github.new(username, password)
8
-
9
- #puts g.users.getUser()