octokit 1.0.5 → 1.0.6

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 (5) hide show
  1. data/CHANGELOG.md +1 -0
  2. data/README.md +27 -23
  3. data/Rakefile +0 -2
  4. data/lib/octokit/version.rb +1 -1
  5. metadata +26 -26
data/CHANGELOG.md CHANGED
@@ -1,5 +1,6 @@
1
1
  # CHANGELOG
2
2
 
3
+ * [1.0.6 - May 11, 2012](https://github.com/pengwynn/octokit/compare/v1.0.5...v1.0.6)
3
4
  * [1.0.5 - May 2, 2012](https://github.com/pengwynn/octokit/compare/v1.0.4...v1.0.5)
4
5
  * [1.0.4 - April 24, 2012](https://github.com/pengwynn/octokit/compare/v1.0.3...v1.0.4)
5
6
  * [1.0.3 - April 18, 2012](https://github.com/pengwynn/octokit/compare/v1.0.2...v1.0.3)
data/README.md CHANGED
@@ -4,15 +4,15 @@ Simple Ruby wrapper for the GitHub v2 & v3 API.
4
4
  [travis]: http://travis-ci.org/pengwynn/octokit
5
5
  [gemnasium]: https://gemnasium.com/pengwynn/octokit
6
6
 
7
- ## <a name="installation"></a>Installation
7
+ ## Installation
8
8
  gem install octokit
9
9
 
10
- ## <a name="documentation"></a>Documentation
10
+ ## Documentation
11
11
  [http://rdoc.info/gems/octokit][documentation]
12
12
 
13
13
  [documentation]: http://rdoc.info/gems/octokit
14
14
 
15
- ## <a name="examples"></a>Examples
15
+ ## Examples
16
16
  ### Show a user
17
17
  ```ruby
18
18
  Octokit.user("sferik")
@@ -26,7 +26,7 @@ Octokit.following("sferik")
26
26
  ```
27
27
 
28
28
  ### Repositories
29
- For convenience, methods that require a repoistory argument may be passed in any of the following forms:
29
+ For convenience, methods that require a repository argument may be passed in any of the following forms:
30
30
 
31
31
  * `"pengwynn/octokit"`
32
32
  * `{:username => "pengwynn", :name => "octokit"}`
@@ -38,7 +38,7 @@ Octokit.repo("pengwynn/octokit")
38
38
  => <#Hashie::Rash created_at="2009/12/10 13:41:49 -0800" description="Simple Ruby wrapper for the GitHub v2 API and feeds" fork=false forks=25 has_downloads=true has_issues=true has_wiki=true homepage="http://wynnnetherland.com/projects/octokit" integrate_branch="master" language="Ruby" name="octokit" open_issues=8 owner="pengwynn" private=false pushed_at="2011/05/05 10:48:57 -0700" size=1804 url="https://github.com/pengwynn/octokit" watchers=92>
39
39
  ```
40
40
 
41
- ## <a name="authenticated_requests"></a>Authenticated Requests
41
+ ## Authenticated Requests
42
42
  For methods that require authentication, you'll need to setup a client with
43
43
  your login and password.
44
44
 
@@ -56,22 +56,26 @@ client = Octokit::Client.new(:login => "me", :oauth_token => "oauth2token")
56
56
  client.follow!("sferik")
57
57
  ```
58
58
 
59
- ## <a name="pulls"></a>Submitting a Pull Request
60
- 1. Fork the project.
61
- 2. Create a topic branch.
62
- 3. Implement your feature or bug fix.
63
- 4. Add documentation for your feature or bug fix.
64
- 5. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go
65
- back to step 4.
66
- 6. Add specs for your feature or bug fix.
67
- 7. Run `bundle exec rake spec`. If your changes are not 100% covered, go back
68
- to step 6.
69
- 8. Commit and push your changes.
70
- 9. Submit a pull request. Please do not include changes to the version or
71
- gemspec. (If you want to create your own version for some reason, please do
72
- so in a separate commit.)
73
-
74
- ## <a name="versions"></a>Supported Ruby Versions
59
+ ## Submitting a Pull Request
60
+ 1. [Fork the repository.][fork]
61
+ 2. [Create a topic branch.][branch]
62
+ 3. Add specs for your unimplemented feature or bug fix.
63
+ 4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
64
+ 5. Implement your feature or bug fix.
65
+ 6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
66
+ 7. Run `open coverage/index.html`. If your changes are not completely covered
67
+ by your tests, return to step 3.
68
+ 8. Add documentation for your feature or bug fix.
69
+ 9. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go
70
+ back to step 8.
71
+ 10. Add, commit, and push your changes.
72
+ 11. [Submit a pull request.][pr]
73
+
74
+ [fork]: http://help.github.com/fork-a-repo/
75
+ [branch]: http://learn.github.com/p/branching.html
76
+ [pr]: http://help.github.com/send-pull-requests/
77
+
78
+ ## Supported Ruby Versions
75
79
  This library aims to support and is [tested against][travis] the following Ruby
76
80
  implementations:
77
81
 
@@ -98,13 +102,13 @@ implementation, you will be personally responsible for providing patches in a
98
102
  timely fashion. If critical issues for a particular implementation exist at the
99
103
  time of a major release, support for that Ruby version may be dropped.
100
104
 
101
- ## <a name="inspiration"></a>Inspiration
105
+ ## Inspiration
102
106
  Octokit was inspired by [Octopi][] and aims to be a lightweight,
103
107
  less-ActiveResourcey alternative.
104
108
 
105
109
  [octopi]: https://github.com/fcoury/octopi
106
110
 
107
- ## <a name="copyright"></a>Copyright
111
+ ## Copyright
108
112
  Copyright (c) 2011 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober. See
109
113
  [LICENSE][] for details.
110
114
 
data/Rakefile CHANGED
@@ -1,5 +1,3 @@
1
- #!/usr/bin/env rake
2
-
3
1
  require 'bundler'
4
2
  Bundler::GemHelper.install_tasks
5
3
 
@@ -1,3 +1,3 @@
1
1
  module Octokit
2
- VERSION = "1.0.5".freeze unless defined?(Octokit::VERSION)
2
+ VERSION = "1.0.6".freeze unless defined?(Octokit::VERSION)
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: octokit
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.5
4
+ version: 1.0.6
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -11,11 +11,11 @@ authors:
11
11
  autorequire:
12
12
  bindir: bin
13
13
  cert_chain: []
14
- date: 2012-05-02 00:00:00.000000000 Z
14
+ date: 2012-05-11 00:00:00.000000000 Z
15
15
  dependencies:
16
16
  - !ruby/object:Gem::Dependency
17
17
  name: addressable
18
- requirement: &70212265941400 !ruby/object:Gem::Requirement
18
+ requirement: &70196526523460 !ruby/object:Gem::Requirement
19
19
  none: false
20
20
  requirements:
21
21
  - - ~>
@@ -23,10 +23,10 @@ dependencies:
23
23
  version: '2.2'
24
24
  type: :runtime
25
25
  prerelease: false
26
- version_requirements: *70212265941400
26
+ version_requirements: *70196526523460
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: faraday
29
- requirement: &70212265939680 !ruby/object:Gem::Requirement
29
+ requirement: &70196526522860 !ruby/object:Gem::Requirement
30
30
  none: false
31
31
  requirements:
32
32
  - - ~>
@@ -34,10 +34,10 @@ dependencies:
34
34
  version: '0.8'
35
35
  type: :runtime
36
36
  prerelease: false
37
- version_requirements: *70212265939680
37
+ version_requirements: *70196526522860
38
38
  - !ruby/object:Gem::Dependency
39
39
  name: faraday_middleware
40
- requirement: &70212265938860 !ruby/object:Gem::Requirement
40
+ requirement: &70196526522400 !ruby/object:Gem::Requirement
41
41
  none: false
42
42
  requirements:
43
43
  - - ~>
@@ -45,10 +45,10 @@ dependencies:
45
45
  version: '0.8'
46
46
  type: :runtime
47
47
  prerelease: false
48
- version_requirements: *70212265938860
48
+ version_requirements: *70196526522400
49
49
  - !ruby/object:Gem::Dependency
50
50
  name: hashie
51
- requirement: &70212265938080 !ruby/object:Gem::Requirement
51
+ requirement: &70196526521880 !ruby/object:Gem::Requirement
52
52
  none: false
53
53
  requirements:
54
54
  - - ~>
@@ -56,10 +56,10 @@ dependencies:
56
56
  version: '1.2'
57
57
  type: :runtime
58
58
  prerelease: false
59
- version_requirements: *70212265938080
59
+ version_requirements: *70196526521880
60
60
  - !ruby/object:Gem::Dependency
61
61
  name: multi_json
62
- requirement: &70212265937340 !ruby/object:Gem::Requirement
62
+ requirement: &70196526521340 !ruby/object:Gem::Requirement
63
63
  none: false
64
64
  requirements:
65
65
  - - ~>
@@ -67,10 +67,10 @@ dependencies:
67
67
  version: '1.3'
68
68
  type: :runtime
69
69
  prerelease: false
70
- version_requirements: *70212265937340
70
+ version_requirements: *70196526521340
71
71
  - !ruby/object:Gem::Dependency
72
72
  name: json
73
- requirement: &70212265936780 !ruby/object:Gem::Requirement
73
+ requirement: &70196526520940 !ruby/object:Gem::Requirement
74
74
  none: false
75
75
  requirements:
76
76
  - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
78
78
  version: '0'
79
79
  type: :development
80
80
  prerelease: false
81
- version_requirements: *70212265936780
81
+ version_requirements: *70196526520940
82
82
  - !ruby/object:Gem::Dependency
83
83
  name: maruku
84
- requirement: &70212265936040 !ruby/object:Gem::Requirement
84
+ requirement: &70196526520380 !ruby/object:Gem::Requirement
85
85
  none: false
86
86
  requirements:
87
87
  - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
89
89
  version: '0'
90
90
  type: :development
91
91
  prerelease: false
92
- version_requirements: *70212265936040
92
+ version_requirements: *70196526520380
93
93
  - !ruby/object:Gem::Dependency
94
94
  name: rake
95
- requirement: &70212265935540 !ruby/object:Gem::Requirement
95
+ requirement: &70196526519860 !ruby/object:Gem::Requirement
96
96
  none: false
97
97
  requirements:
98
98
  - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
100
100
  version: '0'
101
101
  type: :development
102
102
  prerelease: false
103
- version_requirements: *70212265935540
103
+ version_requirements: *70196526519860
104
104
  - !ruby/object:Gem::Dependency
105
105
  name: rspec
106
- requirement: &70212265935120 !ruby/object:Gem::Requirement
106
+ requirement: &70196526519220 !ruby/object:Gem::Requirement
107
107
  none: false
108
108
  requirements:
109
109
  - - ! '>='
@@ -111,10 +111,10 @@ dependencies:
111
111
  version: '0'
112
112
  type: :development
113
113
  prerelease: false
114
- version_requirements: *70212265935120
114
+ version_requirements: *70196526519220
115
115
  - !ruby/object:Gem::Dependency
116
116
  name: simplecov
117
- requirement: &70212265934680 !ruby/object:Gem::Requirement
117
+ requirement: &70196526511900 !ruby/object:Gem::Requirement
118
118
  none: false
119
119
  requirements:
120
120
  - - ! '>='
@@ -122,10 +122,10 @@ dependencies:
122
122
  version: '0'
123
123
  type: :development
124
124
  prerelease: false
125
- version_requirements: *70212265934680
125
+ version_requirements: *70196526511900
126
126
  - !ruby/object:Gem::Dependency
127
127
  name: webmock
128
- requirement: &70212265934040 !ruby/object:Gem::Requirement
128
+ requirement: &70196526510940 !ruby/object:Gem::Requirement
129
129
  none: false
130
130
  requirements:
131
131
  - - ! '>='
@@ -133,10 +133,10 @@ dependencies:
133
133
  version: '0'
134
134
  type: :development
135
135
  prerelease: false
136
- version_requirements: *70212265934040
136
+ version_requirements: *70196526510940
137
137
  - !ruby/object:Gem::Dependency
138
138
  name: yard
139
- requirement: &70212265960620 !ruby/object:Gem::Requirement
139
+ requirement: &70196526509900 !ruby/object:Gem::Requirement
140
140
  none: false
141
141
  requirements:
142
142
  - - ! '>='
@@ -144,7 +144,7 @@ dependencies:
144
144
  version: '0'
145
145
  type: :development
146
146
  prerelease: false
147
- version_requirements: *70212265960620
147
+ version_requirements: *70196526509900
148
148
  description: Simple wrapper for the GitHub API (v2 and v3)
149
149
  email:
150
150
  - wynn.netherland@gmail.com