octopussy 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Wynn Netherland
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,64 @@
+
+# octopussy
+
+<img src='http://upload.wikimedia.org/wikipedia/en/b/bb/007Octopussyposter.jpg' style='float: right; margin: 0 0 10px 10px'/>
+
+Simple Ruby wrapper for the GitHub v2 API. 
+
+## Installation
+
+    sudo gem install octopussy
+    
+## Some examples
+
+### Show a user
+
+    Octopussy.user('pengwynn')
+    => <#Hashie::Mash blog="http://wynnnetherland.com" company="Orrka" created_at="2008/02/25 10:24:19 -0800" email="wynn.netherland@gmail.com" followers_count=21 following_count=55 id=865 location="Dallas, TX" login="pengwynn" name="Wynn Netherland" public_gist_count=4 public_repo_count=16>
+    
+### Show who a user follows
+
+    Octopussy.following('pengwynn')
+    => ["cglee", "bryansray", "rails", "zachinglis", "wycats", "obie", "mully", "squeejee", "jderrett", "Shopify", "ReinH", "technoweenie", "errfree", "defunkt", "joshsusser", "hashrocket", "newbamboo", "bigtiger", "github", "jamis", "jeresig", "thoughtbot", "therealadam", "jnunemaker", "seaofclouds", "choan", "llimllib", "kwhinnery", "marshall", "handcrafted", "adamstac", "jashkenas", "dan", "remy", "hayesdavis", "documentcloud", "imathis", "mdeiters", "njonsson", "asenchi", "mattsa", "marclove", "webiest", "brogers", "polomasta", "stephp", "mchelen", "piyush", "davidnorth", "rmetzler", "jferris", "madrobby", "zh", "erikvold", "desandro"]
+    
+## Working with repositories
+
+For convenience, methods that require a repo argument may be passed in any of the following forms
+
+* "pengwynn/linked"
+* {:username => 'pengwynn', :name => 'linkedin'}
+* {:username => 'pengwynn', :repo => 'linkedin'}
+* instance of Repo
+
+### Show a repo
+
+    Octopussy.repo("pengwynn/linkedin")
+    => <#Hashie::Mash description="Ruby wrapper for the LinkedIn API" fork=false forks=1 homepage="http://bit.ly/ruby-linkedin" name="linkedin" open_issues=2 owner="pengwynn" private=false url="http://github.com/pengwynn/linkedin" watchers=36>
+    
+## Authenticated requests
+
+Some methods require authentication so you'll need to pass a login and an api_token. You can find your GitHub API token on your [account page](https://github.com/account)
+
+    client = Octopussy::Client.new(:login => 'pengwynn', :token => 'OU812')
+    client.follow!('adamstac')
+
+Read the full [docs](http://rdoc.info/projects/pengwynn/octopussy) or check out the [examples](http://github.com/pengwynn/octopussy/tree/master/examples)
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Credits
+
+Octopussy is inspired by [Octopi](http://github.com/fcoury/octopi) and aims to be a lightweight, less active-resourcey alternative.
+
+## Copyright
+
+Copyright (c) 2009 [Wynn Netherland](http://wynnnetherland.com), [Adam Stacoviak](http://adamstacoviak.com/). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "octopussy"
+    gem.summary = %Q{Simple wrapper for the GitHub API}
+    gem.description = %Q{Simple wrapper for the GitHub API v2}
+    gem.email = "wynn.netherland@gmail.com"
+    gem.homepage = "http://github.com/pengwynn/octopussy"
+    gem.authors = ["Wynn Netherland", "Adam Stacoviak"]
+
+    gem.add_dependency('hashie', '~> 0.1.3')
+    gem.add_dependency('httparty', '~> 0.4.5')
+
+    gem.add_development_dependency('thoughtbot-shoulda', '>= 2.10.1')
+    gem.add_development_dependency('jnunemaker-matchy', '0.4.0')
+    gem.add_development_dependency('mocha', '0.9.4')
+    gem.add_development_dependency('fakeweb', '>= 1.2.5')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "octopussy #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/changelog.markdown

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.0.1 Initial version
+
+* GitHub v2 API complete

data/lib/octopussy.rb

@@ -0,0 +1,134 @@
+require 'rubygems'
+
+gem 'hashie', '~> 0.1.3'
+require 'hashie'
+
+gem 'httparty', '~> 0.4.5'
+require 'httparty'
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+Hash.send :include, Hashie::HashExtensions
+
+
+module Octopussy
+  class OctopussyError < StandardError
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+      super
+    end
+  end
+
+  class RateLimitExceeded < StandardError; end
+  class Unauthorized      < StandardError; end
+  class General           < OctopussyError; end
+
+  class Unavailable   < StandardError; end
+  class InformOctopussy < StandardError; end
+  class NotFound      < StandardError; end
+  
+  
+  def self.search_users(q)
+    Client.new.search_users(q)
+  end
+  
+  def self.user(login)
+    Client.new.user(login)
+  end
+  
+  def self.followers(login)
+    Client.new.followers(login)
+  end
+  
+  def self.following(login)
+    Client.new.following(login)
+  end
+  
+  def self.follows?(username, target)
+    Client.new.follows?(username, target)
+  end
+  
+  def self.watched(login)
+    Client.new.watched(login)
+  end
+  
+  # Issues
+  
+  def self.search_issues(repo, state, q)
+    Client.new.search_issues(repo, state, q)
+  end
+  
+  # repo, state
+  def self.issues(repo, state)
+    Client.new.issues(repo, state)
+  end
+  
+  # repo, id
+  def self.issue(repo, id)
+    Client.new.issue(repo, id)
+  end
+  
+  # Repos
+  
+  def self.search_repos(q)
+    Client.new.search_repos(q)
+  end
+  
+  def self.repo(repo)
+    Client.new.repo(repo)
+  end
+  
+  def self.list_repos(username)
+    Client.new.list_repos(username)
+  end
+  
+  def self.collaborators(repo)
+    Client.new.collaborators(repo)
+  end
+  
+  def self.network(repo)
+    Client.new.network(repo)
+  end
+  
+  def self.languages(repo)
+    Client.new.languages(repo)
+  end
+  
+  def self.tags(repo)
+    Client.new.tags(repo)
+  end
+  
+  def self.branches(repo)
+    Client.new.branches(repo)
+  end
+  
+  # Network Meta
+
+  def self.network_meta(repo)
+    Client.new.network_meta(repo)
+  end
+  
+  def self.network_data(repo, nethash)
+    Client.new.network_data(repo, nethash)
+  end
+  
+  # Trees
+
+  def self.tree(repo, sha)
+    Client.new.tree(repo, sha)
+  end
+
+  def self.blob(repo, sha, path)
+    Client.new.blob(repo, sha, path)
+  end
+  
+  def self.raw(repo, sha)
+    Client.new.raw(repo, sha)
+  end
+  
+end
+
+require File.join(directory, 'octopussy', 'repo')
+require File.join(directory, 'octopussy', 'client')

data/lib/octopussy/client.rb

@@ -0,0 +1,393 @@
+require 'cgi'
+module Octopussy
+  class Client
+    include HTTParty
+    format :json
+    base_uri "http://github.com/api/v2/json"
+    
+    attr_reader :login, :token
+    
+    # :login => 'pengwynn', :token => 'your_github_api_key'
+    def initialize(auth={})
+      @login = auth[:login]
+      @token = auth[:token]
+    end
+    
+    def search_users(q)
+      q = CGI.escape(q)
+      response = self.class.get("/user/search/#{q}")
+      handle_response(response)
+      Hashie::Mash.new(response).users
+    end
+    
+    def user(login=self.login)
+      response = self.class.get("/user/show/#{login}", :query => auth_params)
+      handle_response(response)
+      Hashie::Mash.new(response).user
+    end
+    
+
+    def update_user(values={})
+      response = self.class.post("/user/show/#{self.login}", :query => auth_params, :body => {:values => values})
+      handle_response(response)
+      Hashie::Mash.new(response).user
+    end
+    
+    def followers(login=self.login)
+      response = self.class.get("/user/show/#{login}/followers")
+      handle_response(response)
+      Hashie::Mash.new(response).users
+    end
+    
+    def following(login=self.login)
+      response = self.class.get("/user/show/#{login}/following")
+      handle_response(response)
+      Hashie::Mash.new(response).users
+    end
+    
+    def follow!(username)
+      response = self.class.post("/user/follow/#{username}", :query => auth_params)
+      handle_response(response)
+      Hashie::Mash.new(response).users
+    end
+    
+    def unfollow!(username)
+      response = self.class.post("/user/unfollow/#{username}", :query => auth_params)
+      handle_response(response)
+      Hashie::Mash.new(response).users
+    end
+    
+    def follows?(*args)
+      target = args.pop
+      username = args.first 
+      username ||= self.login
+      return if username.nil?
+      self.following(username).include?(target)
+    end
+    
+    def watched(login=self.login)
+      response = self.class.get("/repos/watched/#{login}")
+      handle_response(response)
+      Hashie::Mash.new(response).repositories
+    end
+    
+    def emails
+      response = self.class.get("/user/emails", :query => auth_params)
+      handle_response(response)
+      Hashie::Mash.new(response).emails
+    end
+    
+    def add_email(email)
+      response = self.class.post("/user/email/add", :query => auth_params, :body => {:email => email})
+      handle_response(response)
+      Hashie::Mash.new(response).emails
+    end
+    
+    def remove_email(email)
+      response = self.class.post("/user/email/remove", :query => auth_params, :body => {:email => email})
+      handle_response(response)
+      Hashie::Mash.new(response).emails
+    end
+    
+    def keys
+      response = self.class.get("/user/keys", :query => auth_params)
+      handle_response(response)
+      Hashie::Mash.new(response).public_keys
+    end
+    
+    def add_key(title, key)
+      response = self.class.post("/user/key/add", :query => auth_params, :body => {:title => title, :key => key})
+      handle_response(response)
+      Hashie::Mash.new(response).public_keys
+    end
+    
+    def remove_key(id)
+      response = self.class.post("/user/key/remove", :query => auth_params, :body => {:id => id})
+      handle_response(response)
+      Hashie::Mash.new(response).public_keys
+    end
+
+    # Issues
+    
+    def search_issues(repo, state, q)
+      repo = Repo.new(repo)
+      response = self.class.get("/issues/search/#{repo.username}/#{repo.name}/#{state}/#{q}")
+      handle_response(response)
+      Hashie::Mash.new(response).issues
+    end
+    
+    def issues(repo, state)
+      repo = Repo.new(repo)
+      response = self.class.get("/issues/list/#{repo.username}/#{repo.name}/#{state}")
+      handle_response(response)
+      Hashie::Mash.new(response).issues
+    end
+    
+    def issue(repo, id)
+      repo = Repo.new(repo)
+      response = self.class.get("/issues/show/#{repo.username}/#{repo.name}/#{id}")
+      handle_response(response)
+      Hashie::Mash.new(response).issue
+    end
+
+    def open_issue(repo, title, body)
+      repo = Repo.new(repo)
+      response = self.class.post("/issues/open/#{repo.username}/#{repo.name}", :body => {:title => title, :body => body})
+      handle_response(response)
+      Hashie::Mash.new(response).issue
+    end
+    
+    def close_issue(repo, number)
+      repo = Repo.new(repo)
+      response = self.class.post("/issues/close/#{repo.username}/#{repo.name}/#{number}")
+      handle_response(response)
+      Hashie::Mash.new(response).issue
+    end
+    
+    def reopen_issue(repo, number)
+      repo = Repo.new(repo)
+      response = self.class.post("/issues/reopen/#{repo.username}/#{repo.name}/#{number}")
+      handle_response(response)
+      Hashie::Mash.new(response).issue
+    end
+    
+    def update_issue(repo, number, title, body)
+      repo = Repo.new(repo)
+      response = self.class.post("/issues/edit/#{repo.username}/#{repo.name}/#{number}", :body => {:title => title, :body => body})
+      handle_response(response)
+      Hashie::Mash.new(response).issue
+    end
+    
+    def labels(repo)
+      repo = Repo.new(repo)
+      response = self.class.get("/issues/labels/#{repo.username}/#{repo.name}")
+      handle_response(response)
+      Hashie::Mash.new(response).labels
+    end
+    
+    def add_label(repo, number, label)
+      repo = Repo.new(repo)
+      response = self.class.post("/issues/label/add/#{repo.username}/#{repo.name}/#{label}/#{number}")
+      handle_response(response)
+      Hashie::Mash.new(response).labels
+    end
+    
+    def remove_label(repo, number, label)
+      repo = Repo.new(repo)
+      response = self.class.post("/issues/label/remove/#{repo.username}/#{repo.name}/#{label}/#{number}")
+      handle_response(response)
+      Hashie::Mash.new(response).labels
+    end
+
+    def add_comment(repo, number, comment)
+      repo = Repo.new(repo)
+      response = self.class.post("/issues/comment/#{repo.username}/#{repo.name}/#{number}", :body => {:comment => comment})
+      handle_response(response)
+      Hashie::Mash.new(response).comment
+    end
+    
+    # Repos
+    
+    def search_repos(q)
+      q = CGI.escape(q)
+      response = self.class.get("/repos/search/#{q}")
+      handle_response(response)
+      Hashie::Mash.new(response).repositories
+    end
+    
+    def watch(repo)
+      repo = Repo.new(repo)
+      response = self.class.post("/repos/watch/#{repo.username}/#{repo.name}", :query => auth_params)
+      handle_response(response)
+      Hashie::Mash.new(response).repository
+    end
+    
+    def unwatch(repo)
+      repo = Repo.new(repo)
+      response = self.class.post("/repos/unwatch/#{repo.username}/#{repo.name}", :query => auth_params)
+      handle_response(response)
+      Hashie::Mash.new(response).repository
+    end
+    
+    def fork(repo)
+      repo = Repo.new(repo)
+      response = self.class.post("/repos/fork/#{repo.username}/#{repo.name}", :query => auth_params)
+      handle_response(response)
+      Hashie::Mash.new(response).repository
+    end
+    
+    # :name, :description, :homepage, :public
+    def create(options)
+      response = self.class.post("/repos/create", :query => auth_params, :body => options)
+      handle_response(response)
+      Hashie::Mash.new(response).repository
+    end
+    
+    def delete(repo, delete_token={})
+      repo = Repo.new(repo)
+      response = self.class.post("/repos/delete/#{repo.name}", :query => auth_params, :body => {:delete_token => delete_token})
+      handle_response(response)
+      Hashie::Mash.new(response).repository
+    end
+    
+    def confirm_delete(repo, delete_token)
+      delete(repo, delete_token)
+    end
+    
+    def set_private(repo)
+      repo = Repo.new(repo)
+      response = self.class.post("/repos/set/private/#{repo.name}", :query => auth_params)
+      handle_response(response)
+      Hashie::Mash.new(response).repository
+    end
+    
+    def set_public(repo)
+      repo = Repo.new(repo)
+      response = self.class.post("/repos/set/public/#{repo.name}", :query => auth_params)
+      handle_response(response)
+      Hashie::Mash.new(response).repository
+    end
+    
+    def deploy_keys(repo)
+      repo = Repo.new(repo)
+      response = self.class.get("/repos/keys/#{repo.name}", :query => auth_params)
+      handle_response(response)
+      Hashie::Mash.new(response).public_keys
+    end
+    
+    def add_deploy_key(repo, key, title='')
+      repo = Repo.new(repo)
+      response = self.class.post("/repos/key/#{repo.name}/add", :query => auth_params, :body => {:title => title, :key => key})
+      handle_response(response)
+      Hashie::Mash.new(response).public_keys
+    end
+    
+    def remove_deploy_key(repo, id)
+      repo = Repo.new(repo)
+      response = self.class.post("/repos/key/#{repo.name}/remove", :query => auth_params, :body => {:id => id})
+      handle_response(response)
+      Hashie::Mash.new(response).public_keys
+    end
+    
+    def collaborators(repo)
+      repo = Repo.new(repo)
+      response = self.class.post("/repos/show/#{repo.username}/#{repo.name}/collaborators", :query => auth_params)
+      handle_response(response)
+      Hashie::Mash.new(response).collaborators
+    end
+    
+    def repo(repo)
+      repo = Repo.new(repo)
+      response = self.class.get("/repos/show/#{repo.username}/#{repo.name}")
+      handle_response(response)
+      Hashie::Mash.new(response).repository
+    end
+    
+    def list_repos(username)
+      response = self.class.get("/repos/show/#{username}")
+      handle_response(response)
+      Hashie::Mash.new(response).repositories
+    end
+    
+    def add_collaborator(repo, collaborator)
+      repo = Repo.new(repo)
+      response = self.class.post("/repos/collaborators/#{repo.name}/add/#{collaborator}", :query => auth_params)
+      handle_response(response)
+      Hashie::Mash.new(response).collaborators
+    end
+    
+    def remove_collaborator(repo, collaborator)
+      repo = Repo.new(repo)
+      response = self.class.post("/repos/collaborators/#{repo.name}/remove/#{collaborator}", :query => auth_params)
+      handle_response(response)
+      Hashie::Mash.new(response).collaborators
+    end
+    
+    def network(repo)
+      repo = Repo.new(repo)
+      response = self.class.get("/repos/show/#{repo.username}/#{repo.name}/network")
+      handle_response(response)
+      Hashie::Mash.new(response).network
+    end
+    
+    def languages(repo)
+      repo = Repo.new(repo)
+      response = self.class.get("/repos/show/#{repo.username}/#{repo.name}/languages")
+      handle_response(response)
+      Hashie::Mash.new(response).languages
+    end
+    
+    def tags(repo)
+      repo = Repo.new(repo)
+      response = self.class.get("/repos/show/#{repo.username}/#{repo.name}/tags")
+      handle_response(response)
+      Hashie::Mash.new(response).tags
+    end
+    
+    def branches(repo)
+      repo = Repo.new(repo)
+      response = self.class.get("/repos/show/#{repo.username}/#{repo.name}/branches")
+      handle_response(response)
+      Hashie::Mash.new(response).branches
+    end
+    
+    # Network
+    
+    def network_meta(repo)
+      repo = Repo.new(repo)
+      response = self.class.get("http://github.com/#{repo.username}/#{repo.name}/network_meta")
+      handle_response(response)
+      Hashie::Mash.new(response)
+    end
+    
+    def network_data(repo, nethash)
+      repo = Repo.new(repo)
+      response = self.class.get("http://github.com/#{repo.username}/#{repo.name}/network_data_chunk", :query => {:nethash => nethash})
+      handle_response(response)
+      Hashie::Mash.new(response).commits
+    end
+    
+    # Trees
+    
+    def tree(repo, sha)
+      repo = Repo.new(repo)
+      response = self.class.get("http://github.com/api/v2/json/tree/show/#{repo.username}/#{repo.name}/#{sha}")
+      handle_response(response)
+      Hashie::Mash.new(response).tree
+    end
+    
+    def blob(repo, sha, path)
+      repo = Repo.new(repo)
+      response = self.class.get("http://github.com/api/v2/json/blob/show/#{repo.username}/#{repo.name}/#{sha}/#{path}")
+      handle_response(response)
+      Hashie::Mash.new(response).blob
+    end
+
+    def raw(repo, sha)
+      repo = Repo.new(repo)
+      response = self.class.get("http://github.com/api/v2/yaml/blob/show/#{repo.username}/#{repo.name}/#{sha}")
+      handle_response(response)
+      response.body
+    end
+    
+    private
+    
+      def auth_params
+        @login.nil? ? {} : {:login => @login, :token => @token}
+      end
+    
+      def handle_response(response)
+        case response.code
+        when 403
+          raise RateLimitExceeded.new
+        when 401
+          raise Unauthorized.new
+        when 404
+          raise NotFound.new
+        when 500
+          raise OctopussyError.new(500)
+        end
+      end
+    
+  end
+end