github_api 0.2.0 → 0.2.1

data/lib/github_api/repos/forks.rb

@@ -3,27 +3,46 @@
 module Github
   class Repos
     module Forks
-      
-      # List forks 
-      #
-      # GET /repos/:user/:repo/forks
+
+      # List repository forks
       #
-      # Examples
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.forks 'user-name', 'repo-name'
+      #  @github.repos.forks 'user-name', 'repo-name' { |hook| ... }
       #
-      def forks(user, repo)
-        get("/repos/#{user}/#{repo}/forks")
+      def forks(user_name=nil, repo_name=nil, params = {})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _normalize_params_keys(params)
+
+        response = get("/repos/#{user}/#{repo}/forks")
+        return response unless block_given?
+        response.each { |el| yield el }
       end
-      
+      alias :repo_forks :forks
+      alias :repository_forks :forks
+
       # Create a fork for the authenticated user
-      # 
-      # POST /repos/:user/:repo/forks
       #
-      def create_fork(user, repo, params={})
+      # = Inputs
+      # * <tt>:org</tt> - Optional string - the name of the service that is being called.
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.create_fork 'user-name', 'repo-name',
+      #    "org" =>  "github"
+      #
+      def create_fork(user_name=nil, repo_name=nil, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+
         _normalize_params_keys(params)
         _filter_params_keys(%w[ org ], params)
 
         post("/repos/#{user}/#{repo}/forks", params)
       end
-    end
-  end
+
+    end # Forks
+  end # Repos
 end # Github

data/lib/github_api/request.rb

@@ -7,7 +7,7 @@ require 'set'
 module Github
   # Defines HTTP verbs
   module Request
-    
+
     METHODS = [:get, :post, :put, :delete, :patch]
     METHODS_WITH_BODIES = [ :post, :put, :patch ]
 
@@ -39,6 +39,7 @@ module Github
       if !METHODS.include?(method)
         raise ArgumentError, "unkown http method: #{method}"
       end
+      _extract_mime_type(params, options)
 
       puts "EXECUTED: #{method} - #{path} with #{params} and #{options}"
 
@@ -54,16 +55,24 @@ module Github
       response.body
     end
 
-    def _process_params(params)
+    private
+
+    def _process_params(params) # :nodoc:
       return params['data'] if params.has_key?('data')
       return params
     end
+
+    def _extract_mime_type(params, options) # :nodoc:
+      options['resource']  = params.delete('resource') || ''
+      options['mime_type'] = params.delete('mime_type')
+    end
+
     # no need for this smizzle
     def formatted_path(path, options={})
       [ path, options.fetch(:format, format) ].compact.join('.')
     end
 
-    def basic_auth(login, password)
+    def basic_auth(login, password) # :nodoc:
       auth = Base64.encode("#{login}:#{password}")
       auth.gsub!("\n", "")
     end

data/lib/github_api/request/caching.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Github
+  module Request
+    class Caching < Faraday::Middleware
+      attr_reader :cache
+
+      def initialize(app, cache = nil, options={})
+        super(app)
+        @cache = cache || Proc.new{}.call
+      end
+
+      def call(env)
+        if env[:method] == :get
+          # TODO choose cache method
+          # file_store
+          # mem_cache_store
+          # memory_store
+        else
+          @app.call(env)
+        end
+      end
+
+      def cache_key
+        url = env[:url].dup
+        if url.query
+        end
+      end
+    end
+  end # Request
+end # Github

data/lib/github_api/version.rb

@@ -4,7 +4,7 @@ module Github
   module VERSION
     MAJOR = 0
     MINOR = 2
-    PATCH = 0
+    PATCH = 1
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/spec/fixtures/repos/collaborators.json

@@ -0,0 +1,8 @@
+[
+  {
+    "login": "octocat",
+    "id": 1,
+    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+    "url": "https://api.github.com/users/octocat"
+  }
+]

data/spec/fixtures/repos/commit.json

@@ -0,0 +1,53 @@
+{
+  "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+  "commit": {
+    "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+    "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+    "author": {
+      "name": "Monalisa Octocat",
+      "email": "support@github.com",
+      "date": "2011-04-14T16:00:49Z"
+    },
+    "committer": {
+      "name": "Monalisa Octocat",
+      "email": "support@github.com",
+      "date": "2011-04-14T16:00:49Z"
+    },
+    "message": "Fix all the bugs",
+    "tree": {
+      "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+      "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+    }
+  },
+  "author": {
+    "login": "octocat",
+    "id": 1,
+    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+    "url": "https://api.github.com/users/octocat"
+  },
+  "committer": {
+    "login": "octocat",
+    "id": 1,
+    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+    "url": "https://api.github.com/users/octocat"
+  },
+  "parents": [
+    {
+      "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
+      "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
+    }
+  ],
+  "stats": {
+    "additions": 104,
+    "deletions": 4,
+    "total": 108
+  },
+  "files": [
+    {
+      "filename": "file1.txt",
+      "additions": 10,
+      "deletions": 2,
+      "total": 12
+    }
+  ]
+}

data/spec/fixtures/repos/commit_comment.json

@@ -0,0 +1,16 @@
+{
+  "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1",
+  "id": 1,
+  "body": "Great stuff",
+  "path": "file1.txt",
+  "position": 4,
+  "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+  "user": {
+    "login": "octocat",
+    "id": 1,
+    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+    "url": "https://api.github.com/users/octocat"
+  },
+  "created_at": "2011-04-14T16:00:49Z",
+  "updated_at": "2011-04-14T16:00:49Z"
+}

data/spec/fixtures/repos/commit_comments.json

@@ -0,0 +1,18 @@
+[
+  {
+    "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1",
+    "id": 1,
+    "body": "Great stuff",
+    "path": "file1.txt",
+    "position": 4,
+    "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+    "user": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "url": "https://api.github.com/users/octocat"
+    },
+    "created_at": "2011-04-14T16:00:49Z",
+    "updated_at": "2011-04-14T16:00:49Z"
+  }
+]

data/spec/fixtures/repos/commits.json

@@ -0,0 +1,27 @@
+[
+  {
+    "sha": "7638417db6d59f3c431d3e1f261cc637155684cd",
+    "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
+    "author": {
+      "date": "2010-04-10T14:10:01-07:00",
+      "name": "Scott Chacon",
+      "email": "schacon@gmail.com"
+    },
+    "committer": {
+      "date": "2010-04-10T14:10:01-07:00",
+      "name": "Scott Chacon",
+      "email": "schacon@gmail.com"
+    },
+    "message": "added readme, because im a good github citizen\n",
+    "tree": {
+      "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb",
+      "sha": "691272480426f78a0138979dd3ce63b77f706feb"
+    },
+    "parents": [
+      {
+        "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5",
+        "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5"
+      }
+    ]
+  }
+]

data/spec/fixtures/repos/forks.json

@@ -0,0 +1,29 @@
+[
+  {
+    "url": "https://api.github.com/repos/octocat/Hello-World",
+    "html_url": "https://github.com/octocat/Hello-World",
+    "clone_url": "https://github.com/octocat/Hello-World.git",
+    "git_url": "git://github.com/octocat/Hello-World.git",
+    "ssh_url": "git@github.com:octocat/Hello-World.git",
+    "svn_url": "https://svn.github.com/octocat/Hello-World",
+    "owner": {
+       "login": "octocat",
+       "id": 1,
+       "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+       "url": "https://api.github.com/users/octocat"
+    },
+    "name": "Hello-World",
+    "description": "This your first repo!",
+    "homepage": "https://github.com",
+    "language": null,
+    "private": false,
+    "fork": false,
+    "forks": 9,
+    "watchers": 80,
+    "size": 108,
+    "master_branch": "master",
+    "open_issues": 0,
+    "pushed_at": "2011-01-26T19:06:43Z",
+    "created_at": "2011-01-26T19:01:12Z"
+  }
+]

data/spec/fixtures/repos/repo_comments.json

@@ -0,0 +1,18 @@
+[
+  {
+    "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1",
+    "id": 1,
+    "body": "Great stuff",
+    "path": "file1.txt",
+    "position": 4,
+    "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+    "user": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "url": "https://api.github.com/users/octocat"
+    },
+    "created_at": "2011-04-14T16:00:49Z",
+    "updated_at": "2011-04-14T16:00:49Z"
+  }
+]

data/spec/github/authorization_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Github::Authorization do
+
+  let(:client_id) { '234jl23j4l23j4l' }
+  let(:client_secret) { 'asasd79sdf9a7asfd7sfd97s' }
+  let(:code) { 'c9798sdf97df98ds'}
+  let(:github) { Github.new }
+
+  it "should instantiate oauth2 instance" do
+    github.client.should be_a OAuth2::Client
+  end
+
+  it "should assign site from the options hash" do
+    github.client.site.should == 'https://github.com'
+  end
+
+  it "should assign 'authorize_url" do
+    github.client.authorize_url.should == 'https://github.com/login/oauth/authorize'
+  end
+
+  it "should assign 'token_url" do
+    github.client.token_url.should == 'https://github.com/login/oauth/access_token'
+  end
+
+  context "authorize_url" do
+    before do
+      github = Github.new :client_id => client_id, :client_secret => client_secret
+    end
+
+    it "should respond to 'authorize_url' " do
+      github.should respond_to :authorize_url
+    end
+
+    it "should return address containing client_id" do
+      github.authorize_url.should =~ /client_id=#{client_id}/
+    end
+
+    it "should return address containing scopes" do
+      github.authorize_url(:scope => 'user').should =~ /scope=user/
+    end
+
+    it "should return address containing redirect_uri" do
+      github.authorize_url(:redirect_uri => 'http://localhost').should =~ /redirect_uri/
+    end
+  end
+
+  context "get_token" do
+    before do
+      github = Github.new :client_id => client_id, :client_secret => client_secret
+      stub_request(:post, 'https://github.com/login/oauth/access_token').
+        to_return(:body => '', :status => 200, :headers => {})
+    end
+
+    it "should respond to 'get_token' " do
+      github.should respond_to :get_token
+    end
+
+    it "should make the authorization request" do
+      expect {
+        github.get_token code
+        a_request(:post, "https://github.com/login/oauth/access_token").should have_been_made
+      }.to raise_error(OAuth2::Error)
+    end
+
+    it "should fail to get_token without authorization code" do
+      expect { github.get_token }.to raise_error(ArgumentError)
+    end
+  end
+
+end # Github::Authorization

data/spec/github/mime_type_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Github::MimeType do
+
+  let(:github) { Github.new }
+
+  it "should lookup mime type for :full" do
+    github.lookup_mime(:full).should == 'full+json'
+  end
+
+  it "should lookup mime type for :html" do
+    github.lookup_mime(:html).should == 'html+json'
+  end
+
+  it "should lookup mime type for :html" do
+    github.lookup_mime(:text).should == 'text+json'
+  end
+
+  it "should lookup mime type for :raw" do
+    github.lookup_mime(:raw).should == 'raw+json'
+  end
+
+  it "should default to json if no parameters given" do
+    Github.should_receive(:parse).and_return 'application/json'
+    Github.parse.should == 'application/json'
+  end
+
+  it "should accept header for 'issue' request" do
+    Github.should_receive(:parse).with(:issue, :full).
+      and_return 'application/vnd.github-issue.full+json'
+    Github.parse(:issue, :full).should == 'application/vnd.github-issue.full+json'
+  end
+
+  it "should accept header for 'isssue comment' request" do
+    Github.should_receive(:parse).with(:issue_comment, :full).
+      and_return 'application/vnd.github-issuecomment.full+json'
+    Github.parse(:issue_comment, :full).should == 'application/vnd.github-issuecomment.full+json'
+  end
+
+  it "should accept header for 'commit comment' request" do
+    Github.should_receive(:parse).with(:commit_comment, :full).
+      and_return 'application/vnd.github-commitcomment.full+json'
+    Github.parse(:commit_comment, :full).should == 'application/vnd.github-commitcomment.full+json'
+  end
+
+  it "should accept header for 'pull requst' request" do
+    Github.should_receive(:parse).with(:pull_request, :full).
+      and_return 'application/vnd.github-pull.full+json'
+    Github.parse(:pull_request, :full).should == 'application/vnd.github-pull.full+json'
+  end
+
+  it "should accept header for 'pull comment' request" do
+    Github.should_receive(:parse).with(:pull_comment, :full).
+      and_return 'application/vnd.github-pullcomment.full+json'
+    Github.parse(:pull_comment, :full).should == 'application/vnd.github-pullcomment.full+json'
+  end
+
+  it "should accept header for 'gist comment' request" do
+    Github.should_receive(:parse).with(:gist_comment, :full).
+      and_return 'application/vnd.github-gistcomment.full+json'
+    Github.parse(:gist_comment, :full).should == 'application/vnd.github-gistcomment.full+json'
+  end
+
+  it "should accept header for 'blog' request" do
+    Github.should_receive(:parse).with(:blob, :blob).
+      and_return 'application/vnd.github-blob.raw'
+    Github.parse(:blob, :blob).should == 'application/vnd.github-blob.raw'
+  end
+
+end # Github::MimeType