ghee 0.7.0 → 0.7.1

data/.gitignore

@@ -2,4 +2,6 @@ README (Autosaved)
 Gemfile.lock
 spec/.access_token
 spec/responses/
-spec/settings.yml
+spec/settings.yml
+pkg/
+

data/README.md

@@ -6,10 +6,18 @@ This is an unofficial ruby client for the [GitHub API](http://developer.github.c
 Usage
 -----
 
-Instantiate the client:
+Instantiate the client with basic auth:
 
-    access_token = "abcd1234"
-    gh = Ghee.new(access_token)
+    gh = Ghee.basic_auth("rauhryan","password")
+
+Instantiate the client with auth token:
+
+    gh = Ghee.access_token("1234oijgakjioewj1o4oij")
+
+Create an OAuth access token:
+
+    user_name, password, scopes = "rauhryan", "secret", "repos, user"
+    token = Ghee.create_token(user_name, password, scopes)
 
 ### Gists
 
@@ -314,6 +322,47 @@ List public events:
 
     gh.events
 
+### Pagination
+
+Ghee fully supports pagination for anything that returns a list, for
+example repo issues.
+
+    gh.repos("rauhryan","huboard").issues.paginate(:per_page => 30, :page => 1) #=> returns first page of issues
+    gh.repos("rauhryan","huboard").issues.paginate(:per_page => 30, :page => 2) #=> returns page two of issues
+    gh.repos("rauhryan","huboard").issues.paginate(:per_page => 30, :page => 2).first_page #=> 1
+    gh.repos("rauhryan","huboard").issues.paginate(:per_page => 30, :page => 2).last_page #=> 4
+    gh.repos("rauhryan","huboard").issues.paginate(:per_page => 30, :page => 2).next_page #=> 3
+    gh.repos("rauhryan","huboard").issues.paginate(:per_page => 30, :page => 2).prev_page #=> 1
+
+Ghee also provides a convienence method for all the pages
+
+    gh.repos("rauhryan","huboard").issues.all #=> return all the pages
+
+### Filtering parameters
+
+Many of the api calls allow you to pass in additional paramters to
+filter and sort your data, for example issues provide
+
+ * filter
+    * `assigned`
+    * `mentioned`
+    * `subscribed`
+    * `created`
+ * state
+    * `open` `closed` `default`
+ * labels
+    * list of labels comma delimited `herp,derp`
+ * direction
+    * `asc` or `desc`
+
+These can all be passed into ghee through an options hash:
+
+    gh.repos("rauhryan", "huboard").issues(:state => "closed", :sort => "desc")
+
+> Note you can also change parameters with pagination!
+    
+    gh.repos("rauhryan", "huboard").issues(:state => "closed").all
+
 Testing
 -------
 
@@ -333,7 +382,7 @@ CONTRIBUTE
 
 If you'd like to hack on Ghee, start by forking the repo on GitHub:
 
-https://github.com/jonmagic/ghee
+https://github.com/rauhryan/ghee
 
 The best way to get your changes merged back into core is as follows:
 
@@ -349,5 +398,5 @@ The best way to get your changes merged back into core is as follows:
 
 Contributors
 ------------
-* Jonathan Hoyt
+* [Jonathan Hoyt](https://github.com/jonmagic)
 * [Ryan Rauh](https://github.com/rauhryan)

data/ghee.gemspec

@@ -5,9 +5,9 @@ require "ghee/version"
 Gem::Specification.new do |s|
   s.name        = "ghee"
   s.version     = Ghee::VERSION
-  s.authors     = ["Jonathan Hoyt"]
-  s.email       = ["jonmagic@gmail.com"]
-  s.homepage    = "http://github.com/jonmagic/ghee"
+  s.authors     = ["Ryan Rauh","Jonathan Hoyt"]
+  s.email       = ["rauh.ryan@gmail.com"]
+  s.homepage    = "http://github.com/rauhryan/ghee"
   s.summary     = %q{Access Github in ruby.}
   s.description = %q{A complete, simple, and intuitive ruby API for all things Github.}
 

data/lib/ghee/version.rb

@@ -1,4 +1,4 @@
 # encoding: UTF-8
 class Ghee
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: ghee
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
+- Ryan Rauh
 - Jonathan Hoyt
 autorequire: 
 bindir: bin
@@ -13,7 +14,7 @@ date: 2012-04-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70299849813760 !ruby/object:Gem::Requirement
+  requirement: &70106718506800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70299849813760
+  version_requirements: *70106718506800
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70299849813020 !ruby/object:Gem::Requirement
+  requirement: &70106718506220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70299849813020
+  version_requirements: *70106718506220
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70299849812320 !ruby/object:Gem::Requirement
+  requirement: &70106718505640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70299849812320
+  version_requirements: *70106718505640
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70299849811540 !ruby/object:Gem::Requirement
+  requirement: &70106718505080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70299849811540
+  version_requirements: *70106718505080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70299849810740 !ruby/object:Gem::Requirement
+  requirement: &70106718504580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70299849810740
+  version_requirements: *70106718504580
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70299849809960 !ruby/object:Gem::Requirement
+  requirement: &70106718504080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +77,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70299849809960
+  version_requirements: *70106718504080
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70299849794480 !ruby/object:Gem::Requirement
+  requirement: &70106718503600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70299849794480
+  version_requirements: *70106718503600
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70299849793740 !ruby/object:Gem::Requirement
+  requirement: &70106718502960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70299849793740
+  version_requirements: *70106718502960
 - !ruby/object:Gem::Dependency
   name: ZenTest
-  requirement: &70299849792880 !ruby/object:Gem::Requirement
+  requirement: &70106718502280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +110,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70299849792880
+  version_requirements: *70106718502280
 - !ruby/object:Gem::Dependency
   name: autotest-growl
-  requirement: &70299849792200 !ruby/object:Gem::Requirement
+  requirement: &70106718501440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +121,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70299849792200
+  version_requirements: *70106718501440
 description: A complete, simple, and intuitive ruby API for all things Github.
 email:
-- jonmagic@gmail.com
+- rauh.ryan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -165,7 +166,7 @@ files:
 - spec/settings.yml.sample
 - spec/spec.opts
 - spec/spec_helper.rb
-homepage: http://github.com/jonmagic/ghee
+homepage: http://github.com/rauhryan/ghee
 licenses: []
 post_install_message: 
 rdoc_options: []