ghee 0.8.0 → 0.9.0

data/README.md

@@ -20,6 +20,8 @@ Create an OAuth access token:
 
 ## Gists
 
+### Usage
+
 List a user's gists:
 
     gh.user('jonmagic').gists
@@ -85,6 +87,119 @@ Get a single repo:
 
     gh.repos("rauhryan", "ghee")
 
+### Commits
+
+List commits on a repo:
+
+    gh.repos("rauhryan", "ghee").commits
+
+    gh.repos("rauhryan", "ghee").commits({
+      :sha => "awesome_branch" # optional
+    })
+
+    gh.repos("rauhryan", "ghee").commits( {
+      :path => "/path/to/file" # only commits containing this path
+    })
+
+Get a single commit:
+
+    gh.repos("rauhryan", "ghee").commits("sha")
+
+List commit comments for a repo:
+
+    gh.repos("rauhryan", "ghee").comments
+
+List comments for a single commit:
+
+    gh.repos("rauhryan", "ghee").commits("sha").comments
+
+Create a commit comment:
+
+    gh.repos("rauhryan", "ghee").commits("sha").comments.create({
+      :body => "sweet codez yo!", #required
+      :commit_id => "sha", #required
+      :line => 123, #required
+      :path => "/path/to/file", #required
+      :position => 4 #required
+    })
+
+Get a single commit comment:
+
+    gh.repos("rauhryan", "ghee").comments(123)
+
+Update a commit comment:
+
+    gh.repos("rauhryan", "ghee").comments(123).patch(:body => "new text")
+
+Destroy a commit comment: 
+
+    gh.repos("rauhryan", "ghee").comments(123).destroy
+
+Compare two commits:
+
+    gh.repos("rauhryan", "ghee").compare("basesha","headsha")
+
+### Collaborators
+
+List a repos collaborators:
+
+    gh.repos("rauhryan", "ghee").collaborators
+    
+Get a single collaborator:
+
+    gh.repos("rauhryan", "ghee").collaborators("herp") # => false
+
+    gh.repos("rauhryan", "ghee").collaborators("jonmagic") # => true
+
+Add a collaborator:
+
+    gh.repos("rauhryan", "ghee").collaborators.add("herp") # => true
+    
+Remove a collaborator:
+
+    gh.repos("rauhryan", "ghee").collaborators.remove("herp") # => true
+
+### Forks
+
+List the hooks for a repo:
+
+    gh.repos("rauhryan", "ghee").forks
+
+    gh.repos("rauhryan", "ghee").forks(:sort => "newest") # => `newest`, `oldest`, `watchers`
+
+Create a fork:
+
+    gh.repos("rauhryan", "ghee").forks.create # => forks the repo to the authenticated user
+
+### Keys
+
+List the keys for a repo:
+
+    gh.repos("rauhryan", "ghee").keys
+  
+Get a single key for a repo:
+
+    gh.repos("rauhryan", "ghee").keys(123)
+
+Create a key for a repo: 
+  
+    gh.repos("rauhryan", "ghee").keys.create({
+      :title => "customer deploy key",
+      :key => "ssh-rsa AAA ..."
+    })
+
+Update a key for a repo: 
+  
+    gh.repos("rauhryan", "ghee").keys.patch({
+      :title => "customer deploy key",
+      :key => "ssh-rsa AAA ..."
+    })
+
+Destroy a key for a repo: 
+
+    gh.repos("rauhryan", "ghee").keys(123).destroy # => true
+
+
 ### Hooks
 
 Get the hooks for a repo:
@@ -129,7 +244,31 @@ Create a download for a repo:
 
 Destroy a download for a repo: 
 
-    gh.repos("rauhryan", "ghee").downloads.destroy
+    gh.repos("rauhryan", "ghee").downloads(12).destroy
+
+### Watchers
+
+List watchers for a repo:
+
+    gh.repos("rauhryan", "ghee").watchers
+
+List repos being watched:
+
+    gh.user.watched
+    
+    gh.users("jonmagic").watched
+
+Check if you are watching a repo:
+
+    gh.user.watching? "rauhryan", "huboard"
+
+Watch a repo:
+
+    gh.user.watch "rauhryan", "huboard"
+
+Unwatch a repo: 
+
+    gh.user.watch! "rauhryan", "huboard"
 
 ### Milestones
 
@@ -214,6 +353,8 @@ Destroy a comment for an issue
 
 ## Orgs
 
+### Usage
+
 Get a list of orgs for the current user:
 
     gh.orgs
@@ -226,12 +367,16 @@ Patch an organization:([see docs for all possible params](http://developer.githu
 
     gh.orgs("huboard").patch({ :company => "awesome company" })
 
+### Repos
+
 Get a list of repos for an org:
 
     gh.orgs("huboard").repos
 
 > Notes: see above for all the available api methods for repos
 
+### Teams
+
 Get a list of teams for an org:
 
     gh.orgs("huboard").teams
@@ -252,6 +397,8 @@ Delete a team for an org:
 
     gh.orgs("huboard").teams(110234).delete
 
+### Members
+
 Get a list of members for a team:
 
     gh.orgs("huboard").teams(110234).members
@@ -266,6 +413,8 @@ Remove a member from a team:
 
 ## Teams
 
+### Usage
+
 Get a single team:
 
     gh.team(110234)
@@ -282,6 +431,8 @@ Delete a team:
 
     gh.team(110234).delete
 
+### Members
+
 Get a list of members for a team:
 
     gh.team(110234).members
@@ -296,6 +447,8 @@ Remove a member from a team:
 
 ## Users
 
+### Usage
+
 Get a single user:
 
     gh.users('jonmagic')
@@ -313,6 +466,36 @@ Update authenticated user ([see docs for all possible params](http://developer.g
       # …etc
     })
 
+### Keys
+
+List the keys for a user:
+
+    gh.user.keys
+  
+Get a single key for a user:
+
+    gh.user.keys(123)
+
+Create a key for a user: 
+  
+    gh.user.keys.create({
+      :title => "customer deploy key",
+      :key => "ssh-rsa AAA ..."
+    })
+
+Update a key for a user: 
+  
+    gh.user.keys.patch({
+      :title => "customer deploy key",
+      :key => "ssh-rsa AAA ..."
+    })
+
+Destroy a key for a user: 
+
+    gh.user.keys(123).destroy # => true
+
+### Repos
+
 Get a list of repos for the current user:
 
     gh.user.repos
@@ -341,14 +524,152 @@ Get a list of orgs for a specific user:
 
 > Notes: see above for all the available api methods for orgs
 
+### Followers
+
+Get the followers for a user:
+
+    gh.user.followers
+
+    gh.users("rauhryan").followers
+
+Get users following another user:
+
+    gh.users("rauhryan").following
+
+    gh.user.following
+
+Check if you are following a user:
+
+    gh.user.following? "rauhryan"
+
+Follow a user:
+
+    gh.user.follow "rauhryan"
+
+Unfollow a user:
+
+    gh.user.follow! "rauhryan"
+
+## Git Data
+
+### Blobs
+
+Get a blob:
+
+    gh.repos("rauhryan","huboard").git.blobs("sha")
+
+Create a blob:
+
+    gh.repos("rauhryan","huboard").git.blobs.create({
+      :content => "Contents of blob",
+      :encoding => "utf-8"
+    })
+
+
+### Commit
+
+Get a commit:
+
+    gh.repos("rauhryan","huboard").git.commits("sha")
+
+Create a commit:
+
+    gh.repos("rauhryan","huboard").git.commits.create({
+      :message => "message of commit",
+      :tree => "sha",
+      :parents => ["sha","sha"]
+    })
+
+### References
+
+Get a reference:
+
+    gh.repos("rauhryan","huboard").git.refs("heads/master")
+
+Get all references:
+
+    gh.repos("rauhryan","huboard").git.refs
+
+    gh.repos("rauhryan","huboard").git.refs("tags")
+
+    gh.repos("rauhryan","huboard").git.refs("heads")
+
+Create a reference:
+
+    gh.repos("rauhryan","huboard").git.refs.create({
+        :ref => "refs/heads/master",
+        :sha => "287efc2351325e215j235f25215el1"
+      })
+
+Update a reference:
+
+    gh.repos("rauhryan","huboard").git.refs("heads/master").patch({
+        :sha => "287efc2351325e215j235f25215el1",
+        :force => true
+      })
+
+Delete a reference:
+
+    gh.repos("rauhryan","huboard").git.refs("tags/v1.0").destroy
+    
+### Tags
+
+Get a tag:
+
+    gh.repos("rauhryan","huboard").git.tags("sha")
+
+Create a tag:
+
+    gh.repos("rauhryan","huboard").git.tags.create({
+        :tag => "v1.0",
+        :message => "tag message",
+        :object => "sha", #sha of the object you are tagging, usually a commit
+        :type => "commit", #the type of object you are tagging
+        :tagger => {
+           :name => "Ryan Rauh",
+           :email => "rauh.ryan@gmail.com",
+           :date => "2011-06-17T14:53:35-07:00"
+        }
+      })
+
+### Trees
+
+Get a tree:
+
+    gh.repos("rauhryan","huboard").git.trees("sha")
+
+Get a tree recursively:
+
+    gh.repos("rauhryan","huboard").git.trees("sha",{:recursive => 1})
+
+Create a tree:
+
+    gh.repos("rauhryan","huboard").git.trees.create({
+        :base_tree => "sha", #optional
+        :tree => [
+          {
+            :path => "/path/to/thing",
+            :mode => 100644,
+            :type => "blob",
+            :sha => "sha"
+            # :content => "" # can use this instead of sha
+          }
+        ]
+    })
+    
+
 ## Events
 
+### Usage
+
 List public events:
 
     gh.events
 
 ## Pagination
 
+### Usage
+
 Ghee fully supports pagination for anything that returns a list, for
 example repo issues.
 
@@ -365,6 +686,8 @@ Ghee also provides a convienence method for all the pages
 
 ## Filtering parameters
 
+### Usage
+
 Many of the api calls allow you to pass in additional paramters to
 filter and sort your data, for example issues provide
 

data/lib/ghee.rb

@@ -13,6 +13,15 @@ require 'ghee/api/milestones'
 require 'ghee/api/orgs'
 require 'ghee/api/git_data'
 require 'ghee/api/downloads'
+require 'ghee/api/labels'
+require 'ghee/api/hooks'
+require 'ghee/api/collaborators'
+require 'ghee/api/forks'
+require 'ghee/api/commits'
+require 'ghee/api/keys'
+require 'ghee/api/watchers'
+require 'ghee/api/emails'
+require 'ghee/api/followers'
 
 class Ghee
   attr_reader :connection
@@ -22,8 +31,6 @@ class Ghee
   include Ghee::API::Users
   include Ghee::API::Events
   include Ghee::API::Repos
-  include Ghee::API::Issues
-  include Ghee::API::Milestones
   include Ghee::API::Orgs
 
   # Instantiates Ghee, accepts an access_token

data/lib/ghee/api/collaborators.rb

@@ -0,0 +1,37 @@
+class Ghee
+
+  # API module encapsulates all of API endpoints
+  # implemented thus far
+  #
+  module API
+
+    # The Repos module handles all of the Github Repo
+    # API endpoints
+    #
+    module Repos
+
+      module Collaborators
+        class Proxy < ::Ghee::ResourceProxy
+          def add(member)
+            connection.put("#{path_prefix}/#{member}").status == 204
+          end
+
+          def remove(member)
+            connection.delete("#{path_prefix}/#{member}").status == 204
+          end
+        end
+      end
+
+      # Gists::Proxy inherits from Ghee::Proxy and
+      # enables defining methods on the proxy object
+      #
+      class Proxy < ::Ghee::ResourceProxy
+        def collaborators(user=nil)
+          prefix = user ? "#{path_prefix}/collaborators/#{user}" : "#{path_prefix}/collaborators"
+          return user ?  connection.get(prefix).status == 204 : Ghee::API::Repos::Collaborators::Proxy.new(connection, prefix)
+        end
+      end
+
+    end
+  end
+end