mwunsch-octocatnap 0.7.0

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/
+doc/

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mark Wunsch
+
+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.md

@@ -0,0 +1,59 @@
+# OctocatNap
+
+OctocatNap is a Ruby interface to the [GitHub API v2](http://develop.github.com/).
+
+The source of it's power is [Weary](http://github.com/mwunsch/weary/).
+
+## Install
+
+	sudo gem sources -a http://gems.github.com  # If you haven't done that already
+	sudo gem install mwunsch-octocatnap
+	
+_* Someday we can put this on Rubyforge_
+
+### Requires
+
++ Weary >= 0.4.1
+
+## Authenticating
+
+When you instantiate OctocatNap, you can pass different types of arguments to pass your credentials to the methods.
+
+#### Explicitly
+	
+	gh = OctocatNap.new("mwunsch", "my-super-secret-token")
+	
+or
+
+	gh = OctocatNap.new(["mwunsch","my-super-secret-token"])
+	
+or
+
+	gh = OctocatNap.new({:login => "mwunsch", :token => "my-super-secret-token"})
+	
+#### YAML
+
+If you provide just one string when you instantiate, OctocatNap thinks that's the path to a file.
+
+	gh = OctocatNap.new(File.join(File.dirname(__FILE__), '..', "config.yml"))
+	
+That file should look something like this:
+
+	login: mwunsch
+	token: my-super-secret-token
+	
+#### ~/.gitconfig
+
+You can also get credentials from the global .gitconfig, as long as that is set up with your [GitHub credentials](http://github.com/guides/tell-git-your-user-name-and-email-address)
+
+	gh = OctocatNap.new(true)
+	
+This assumes your gitconfig is in a standard place, as detailed here: http://github.com/blog/180-local-github-config
+
+## API and Documentation
+
+Coming soon. Keep an eye on the [Wiki](http://wiki.github.com/mwunsch/octocatnap).
+
+## License
+
+Copyright (c) 2009 Mark Wunsch. See LICENSE for details.	 

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'spec/rake/spectask'
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'octocatnap'
+  rdoc.main     = 'README.md'
+  rdoc.rdoc_files.include('README.*', 'lib/**/*.rb', 'LICENSE')
+  rdoc.options  << '--inline-source'
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--color','--format nested']
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "octocatnap"
+    gemspec.summary = "The GitHub API, wrapped in a Weary blanket"
+    gemspec.email = "mark@markwunsch.com"
+    gemspec.homepage = "http://github.com/mwunsch/octocatnap"
+    gemspec.description = "OctocatNap is a Ruby interface to the GitHub API v2. It is powered by Weary"
+    gemspec.authors = "Mark Wunsch"
+    gemspec.add_dependency('weary', '>= 0.4.0')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"  
+end

data/VERSION

@@ -0,0 +1 @@
+0.7.0

data/examples/user_show.rb

@@ -0,0 +1,6 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'octocatnap')
+require 'pp'
+
+github = OctocatNap.new(true)
+github.format = :yaml
+puts github.user("mwunsch").show.body if github.user("mwunsch").show.success?

data/examples/user_update.rb

@@ -0,0 +1,6 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'octocatnap')
+require 'pp'
+
+github = OctocatNap.new(true)
+post = github.user("mwunsch").update('values[blog]' => "http://markwunsch.com")
+puts post['user']['blog'] if post.success?

data/lib/octocatnap.rb

@@ -0,0 +1,15 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'weary'
+
+autoload :Yaml, 'yaml'
+
+require 'octocatnap/api'
+require 'octocatnap/base'
+
+module OctocatNap
+  def self.new(login=nil,token=nil)
+    OctocatNap::Base.new(login,token)
+  end
+end

data/lib/octocatnap/api.rb

@@ -0,0 +1,22 @@
+module OctocatNap
+  class Api
+    extend Weary
+        
+    attr_reader :credentials
+    
+    def initialize(credentials)
+      @credentials = credentials
+    end
+    
+  end
+  class User < Api; end
+  class Issues < Api; end
+  class Repository < Api; end
+  class Commit < Api; end
+  class Object < Api; end
+  class Network < Api
+    on_domain "http://github.com/"
+    as_format :json
+  end
+  
+end

data/lib/octocatnap/base.rb

@@ -0,0 +1,342 @@
+module OctocatNap
+  class Base
+    attr_accessor :format
+    attr_reader :login, :token, :credentials
+
+    def initialize(login=nil, token=nil)    
+      case
+        when (login.is_a?(TrueClass))
+          @login = `git config --global github.user`.strip
+          @token = `git config --global github.token`.strip
+          raise ArgumentError, "Missing GitHub credentials. See: 'http://github.com/guides/tell-git-your-user-name-and-email-address'" if @login.empty?
+        when (login.is_a?(String) && token.nil?)
+          raise ArgumentError, "A YAML file could not be found at '#{login}" unless File.exist?(login)
+          credentials = File.open(login) { |yml|
+            YAML::load yml
+          }
+          raise ArgumentError, "Missing credentials in '#{login}' (expected a YAML file)" unless credentials
+          @login = credentials["login"].to_s
+          @token = credentials["token"].to_s
+        when (login.is_a?(Hash) && token.nil?)
+          @login = login[:login].to_s
+          @token = login[:token].to_s
+        when (login.is_a?(Array) && token.nil?)
+          @login = login[0].to_s
+          @token = login[1].to_s
+        when (!login.nil? && !token.nil?)
+          @login = login.to_s
+          @token = token.to_s
+        else
+          @login = nil
+          @token = nil
+      end
+      @credentials = unless (@login.nil? && @token.nil?)
+        {:login => @login, :token => @token}
+      else
+        nil
+      end
+    end
+
+    def format
+      @format ||= :json
+    end
+
+    def format=(type)
+      type = type.downcase if type.is_a?(String)
+      @format = case type
+        when *Weary::ContentTypes[:json]
+          :json
+        when *Weary::ContentTypes[:xml]
+          :xml
+        when *Weary::ContentTypes[:html]
+          :html
+        when *Weary::ContentTypes[:yaml]
+          :yaml
+        when *Weary::ContentTypes[:plain]
+          :plain
+        else
+          raise ArgumentError, "#{type} is not a recognized format."
+      end
+    end
+    
+    # http://develop.github.com/p/users.html
+    def user(query) #query = search term or username
+      u = OctocatNap::User
+      u.always_with @credentials
+      u = set_defaults(u, "user")
+      
+      u.get "search" do |r|
+        r.url = "<domain>/<resource>/#{query}"
+      end
+
+      u.get "show" do |r|
+        r.url = "<domain>/<resource>/#{query}"
+      end
+
+      u.post "update" do |r|
+        raise "You need to authenticate to perform this method. Please enter your credentials." if @credentials.nil?
+        r.url = "<domain>/show/#{query}"
+        r.requires = [:login,:token]
+        r.with = @credentials.merge({"values[name]" => nil, "values[email]" => nil, "values[blog]" => nil, "values[company]" => nil, "values[location]" => nil})
+      end
+
+      u.get "followers" do |r|
+        r.url = "<domain>/show/#{query}/<resource>"
+      end
+
+      u.get "following" do |r|
+        r.url = "<domain>/show/#{query}/<resource>"
+      end
+
+      u.post "follow" do |r|  
+        r.url = "<domain>/<resource>/#{query}"
+        r.requires = [:login,:token]
+      end
+
+      u.post "unfollow" do |r|
+        r.url = "<domain>/<resource>/#{query}"
+        r.requires = [:login,:token]
+      end
+
+      u.get "keys" do |r|
+        r.url = "<domain>/keys"
+        r.requires = [:login,:token]
+      end
+
+      u.post "add_keys" do |r|
+        r.url = "<domain>/key/add"
+        r.requires = [:login, :token, :name, :key]
+      end
+
+      u.post "remove_keys" do |r|
+        r.url = "<domain>/key/remove"
+        r.requires = [:login, :token, :id]
+      end
+      return u.new(@credentials)
+    end
+    
+    # http://develop.github.com/p/issues.html
+    def issues(user,repo,state,search_term,label,number)
+      i = OctocatNap::Issues
+      i.always_with @credentials
+      i = set_defaults(i, "issues")
+      i.get "search" do |r|
+        r.url ="<domain>/<resource>/#{user}/#{repo}/#{state}/#{search_term}"
+      end
+      
+      i.get "list" do |r|
+        r.url = "<domain>/<resource>/#{user}/#{repo}/#{state}"
+      end
+      
+      i.get "show" do |r|
+        r.url = "<domain>/<resource>/#{user}/#{repo}/#{number}"
+      end
+      
+      i.post "open" do |r|
+        r.url = "<domain>/<resource>/#{user}/#{repo}"
+        r.requires = [:login, :token, :title, :body]
+      end
+      
+      i.post "close" do |r|
+        r.url = "<domain>/<resource>/#{user}/#{repo}/#{number}"
+        r.requires = [:login, :token]
+      end
+      
+      i.post "reopen" do |r|
+        r.url = "<domain>/<resource>/#{user}/#{repo}/#{number}"
+        r.requires = [:login, :token]
+      end
+      
+      i.post "edit" do |r|
+        raise "You need to authenticate to perform this method. Please enter your credentials." if @credentials.nil?
+        r.url = "<domain>/<resource>/#{user}/#{repo}/#{number}"
+        r.requires = [:login, :token]
+        r.with = @credentials.merge(:title => nil, :body => nil)
+      end
+      
+      i.post "add_label" do |r|
+        r.url = "<domain>/label/add/#{user}/#{repo}/#{label}/#{number}"
+        r.requires = [:login, :token]
+      end
+      
+      i.post "remove_label" do |r|
+        r.url = "<domain>/label/remove/#{user}/#{repo}/#{label}/#{number}"
+        r.requires = [:login, :token]
+      end
+      
+      i.post "comment" do |r|
+        r.url = "<domain>/<resource>/#{user}/#{repo}/#{number}"
+        r.requires = [:login, :token, :comment]
+      end
+      return i.new(@credentials)
+    end
+    
+    # the Network API is only available in JSON
+    # http://develop.github.com/p/network.html
+    def network(user,repo)
+      n = OctocatNap::Network
+      n.get "meta" do |r|
+        r.url = "<domain>#{user}/#{repo}/network_meta"
+      end
+      
+      n.get "data" do |r|
+        r.url = "<domain>#{user}/#{repo}/network_data_chunk"
+        r.requires = [:nethash]
+        r.with = [:start, :end]
+      end
+      
+      return n.new(@credentials)
+    end
+    
+    def repository(query, repo) #query = search term or user name
+      r = OctocatNap::Repository
+      r.always_with @credentials
+      r = set_defaults(r, "repos")
+      
+      r.get "search" do |x|
+        x.url = "<domain>/<resource>/#{query}"
+      end
+      
+      r.get "show" do |x|
+        x.url = "<domain>/<resource>/#{query}/#{repo}"
+      end
+      
+      r.get "list" do |x|
+        x.url = "<domain>/show/#{query}"
+      end
+      
+      r.get "unwatch" do |x|
+        x.requires = [:login, :token]
+        x.url = "<domain>/<resource>/#{query}/#{repo}"
+      end
+      
+      r.get "watch" do |x|
+        x.requires = [:login, :token]
+        x.url = "<domain>/<resource>/#{query}/#{repo}"
+      end
+      
+      r.get "fork" do |x|
+        x.requires = [:login, :token]
+        x.url = "<domain>/<resource>/#{query}/#{repo}"
+      end
+      
+      r.post "create" do |x|
+        raise "You need to authenticate to perform this method. Please enter your credentials." if @credentials.nil?
+        x.requires = [:login, :token, :name]
+        x.with = @credentials.merge({:description => nil, :homepage => nil, :public => nil})
+        x.url = "<domain>/<resource>"
+      end
+      
+      r.post "delete" do |x|
+        raise "You need to authenticate to perform this method. Please enter your credentials." if @credentials.nil?
+        x.requires = [:login, :token]
+        x.with = @credentials.merge({:delete_token => nil})
+        x.url = "<domain>/<resource>/#{repo}"
+      end
+      
+      r.post "set_private" do |x|
+        x.requires = [:login, :token]
+        x.url = "<domain>/set/private/#{repo}"
+      end
+      
+      r.post "set_public" do |x|
+        x.requires = [:login, :token]
+        x.url = "<domain>/set/public/#{repo}"
+      end
+      
+      r.get "keys" do |x|
+        x.requires = [:login, :token]
+        x.url = "<domain>/<resource>/#{repo}"
+      end
+      
+      r.post "add_key" do |x|
+        x.requires = [:login, :token, :title, :key]
+        x.url = "<domain>/key/#{repo}/add"
+      end
+      
+      r.post "remove_key" do |x|
+        x.requires = [:login, :token, :id]
+        x.url = "<domain>/key/#{repo}/remove"
+      end
+      
+      r.get "collaborators" do |x|
+        x.url = "<domain>/show/#{query}/#{repo}/<resource>"
+      end
+      
+      r.post "add_collaborators" do |x|
+        x.requires = [:login, :token]
+        x.url = "<domain>/collaborators/#{repo}/add/#{query}"
+      end
+      
+      r.post "remove_collaborators" do |x|
+        x.requires = [:login, :token]
+        x.url = "<domain>/collaborators/#{repo}/remove/#{query}"
+      end
+      
+      r.get "network" do |x|
+        x.url = "<domain>/show/#{query}/#{repo}/<resource>"
+      end
+      
+      r.get "tags" do |x|
+        x.url = "<domain>/show/#{query}/#{repo}/<resource>"
+      end
+      
+      r.get "branches" do |x|
+        x.url = "<domain>/show/#{query}/#{repo}/<resource>"
+      end
+      
+      return r.new(@credentials)
+    end
+
+    def commit(user,repo,branch,query) #query = path or sha
+      c = OctocatNap::Commit
+      c = set_defaults(c, "commits")
+      
+      c.get "list" do |r|
+        r.url = "<domain>/<resource>/#{user}/#{repo}/#{branch}"
+      end
+      
+      c.get "file" do |r|
+        r.url = "<domain>/list/#{user}/#{repo}/#{branch}/#{query}"
+      end
+      
+      c.get "show" do |r|
+        r.url = "<domain>/<resource>/#{user}/#{repo}/#{query}"
+      end
+      return c.new(@credentials)
+    end
+
+    def tree(user,repo,tree_sha)
+      t = OctocatNap::Object
+      t = set_defaults(t, "tree")
+      
+      t.get "show" do |r|
+        r.url = "<domain>/<resource>/#{user}/#{repo}/#{tree_sha}"
+      end
+      
+      return t.new(@credentials)
+    end
+
+    def blob(user,repo,sha,path)
+      b = OctocatNap::Object
+      b = set_defaults(t, "blob")
+      
+      b.get "raw" do |r|
+        r.url = "<domain>/show/#{user}/#{repo}/#{sha}"
+      end
+      
+      b.get "show" do |r|
+        r.url = "<domain>/<resource>/#{user}/#{repo}/#{sha}/#{path}"
+      end
+      
+      return b.new(@credentials)
+    end
+    
+    private
+      def set_defaults(klass, domain)
+        klass.as_format format
+        klass.on_domain "http://github.com/api/v2/#{format}/#{domain}"
+        klass
+      end
+  end
+end

data/spec/fixtures/config.yml

@@ -0,0 +1,3 @@
+# GitHub user login and token
+login: github_username
+token: github_token

data/spec/octocatnap/api_spec.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe OctocatNap::Api do
+  before do
+    @test = OctocatNap::Api.new({:login => "github_username", :token => "github_token"})
+  end
+  
+  it "should set credentials" do
+    @test.credentials.should == {:login => "github_username", :token => "github_token"}
+  end
+  
+  it "should set the Weary default format" do
+    @test.class.as_format :json
+    @test.class.instance_variable_get(:@default_format).should == :json
+  end
+  
+  it "should set the Weary domain" do
+    @test.class.on_domain "http://github.com/api/v2/"
+    @test.class.domain.should == "http://github.com/api/v2/"
+  end
+end

data/spec/octocatnap/base_spec.rb

@@ -0,0 +1,98 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe OctocatNap::Base do
+  describe "Authentication" do
+    it "should be instantiated with a user's login and token" do
+      test = OctocatNap.new("github_username",:github_token)
+      test.login.should == "github_username"
+      test.token.should == "github_token"
+    end
+    
+    it "credentials can be in an array" do
+      test = OctocatNap.new(["github_username",:github_token])
+      test.login.should == "github_username"
+      test.token.should == "github_token"
+    end
+    
+    it "credentials can also be in a hash" do
+      test = OctocatNap.new({:login => "github_username",:token => "github_token"})
+      test.login.should == "github_username"
+      test.token.should == "github_token"
+    end
+  
+    it "should look for a yaml file with login and token if a file name is passed" do
+      test = OctocatNap.new(File.join(File.dirname(__FILE__), '..', 'fixtures', "config.yml"))
+      test.login.should == "github_username"
+      test.token.should == "github_token"
+    end
+  
+    it "should look for login/token in git config" do
+      test = OctocatNap.new(true)
+      test.login.class.should == String
+      test.login.class.should == String
+    end
+  
+    it "should be quiet if no login and token are passed" do
+      test = OctocatNap.new
+      test.login.should == nil
+      test.token.should == nil
+    end
+    
+    it "should create a credentials hash" do
+      test = OctocatNap.new
+      test.credentials.should == nil
+      test = OctocatNap.new(true)
+      test.credentials.class.should == Hash
+      test.credentials.has_key?(:login).should == true
+      test.credentials.has_key?(:token).should == true
+    end
+  end
+  
+  describe "Default Format" do
+    before do
+      @test = OctocatNap.new
+    end
+    
+    it "should set a default format of JSON on initialization" do
+      @test.format.should == :json
+    end
+    
+    it "should be able to set another format using Weary's validation" do
+      @test.format = 'yaml'
+      @test.format.should == :yaml
+    end
+  end
+  
+  describe "An API" do
+    before do
+      @test = OctocatNap.new(true)
+    end
+    
+    it "should set the defaults" do
+      t = @test.user("markwunsch")
+      t.class.domain.should == "http://github.com/api/v2/json/user"
+      t.class.instance_variable_get(:@default_format).should == :json
+      t.credentials.class.should == Hash
+      t.credentials.has_key?(:login).should == true
+      t.credentials.has_key?(:token).should == true
+    end
+    
+    it "should produce a series of resources" do
+      @test.format = :yaml
+      t = @test.user("markwunsch")
+      t.class.resources.is_a?(Array).should == true
+    end
+    describe "Network API" do
+      it "should be on domain 'http://github.com/'" do
+        t = @test.network("mwunsch","octocatnap")
+        t.class.domain.should == "http://github.com/"
+      end
+      it "should be in JSON" do
+        @test.format = :yaml
+        t = @test.network("mwunsch","octocatnap")
+        t.class.instance_variable_get(:@default_format).should == :json
+      end
+    end
+    
+  end
+end

data/spec/octocatnap_spec.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe OctocatNap do
+ 
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'pp'
+require 'rubygems'
+gem 'rspec'
+require 'spec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'octocatnap')

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: mwunsch-octocatnap
+version: !ruby/object:Gem::Version 
+  version: 0.7.0
+platform: ruby
+authors: 
+- Mark Wunsch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: weary
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+    version: 
+description: OctocatNap is a Ruby interface to the GitHub API v2. It is powered by Weary
+email: mark@markwunsch.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- examples/user_show.rb
+- examples/user_update.rb
+- lib/octocatnap.rb
+- lib/octocatnap/api.rb
+- lib/octocatnap/base.rb
+- spec/fixtures/config.yml
+- spec/octocatnap/api_spec.rb
+- spec/octocatnap/base_spec.rb
+- spec/octocatnap_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mwunsch/octocatnap
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: The GitHub API, wrapped in a Weary blanket
+test_files: 
+- spec/octocatnap/api_spec.rb
+- spec/octocatnap/base_spec.rb
+- spec/octocatnap_spec.rb
+- spec/spec_helper.rb
+- examples/user_show.rb
+- examples/user_update.rb