github_api 0.4.2 → 0.4.3

data/lib/github_api/page_uri_processor.rb

@@ -11,11 +11,15 @@ module Github
     end
 
     def resource_link
-      query_string
+      link
     end
 
     def query_hash
-      
+      parsed_query = parse_query(query_string)
+      params = {}
+      if parsed_query.include? :last_sha
+        params[:sha] = parsed_query[:last_sha]
+
     end
   end
 end

data/lib/github_api/response/raise_error.rb

@@ -18,7 +18,7 @@ module Github
         raise Github::ResourceNotFound.new(response_message(env), env[:response_headers])
 
       when 422
-        raise Github::UnprocessableEntitty.new(response_message(env), env[:response_headers])
+        raise Github::UnprocessableEntity.new(response_message(env), env[:response_headers])
       when 500
         raise Github::InternalServerError.new(response_message(env), env[:response_headers])
       when 503

data/lib/github_api/result.rb

@@ -56,8 +56,9 @@ module Github
     # Iterator like each for response pages. If there are no pages to
     # iterate over this method will return nothing.
     def each_page
+      yield self.body
       while page_iterator.has_next?
-        yield next_page #page_iterator.next
+        yield next_page
       end
     end
 

data/lib/github_api/version.rb

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

data/spec/fixtures/gists/gist.json

@@ -0,0 +1,58 @@
+{
+  "url": "https://api.github.com/gists/1",
+  "id": "1",
+  "description": "description of gist",
+  "public": true,
+  "user": {
+    "login": "octocat",
+    "id": 1,
+    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+    "gravatar_id": "somehexcode",
+    "url": "https://api.github.com/users/octocat"
+  },
+  "files": {
+    "ring.erl": {
+      "size": 932,
+      "filename": "ring.erl",
+      "raw_url": "https://gist.github.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl",
+      "content": "contents of gist"
+    }
+  },
+  "comments": 0,
+  "html_url": "https://gist.github.com/1",
+  "git_pull_url": "git://gist.github.com/1.git",
+  "git_push_url": "git@gist.github.com:1.git",
+  "created_at": "2010-04-14T02:15:15Z",
+  "forks": [
+    {
+      "user": {
+        "login": "octocat",
+        "id": 1,
+        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+        "gravatar_id": "somehexcode",
+        "url": "https://api.github.com/users/octocat"
+      },
+      "url": "https://api.github.com/gists/5",
+      "created_at": "2011-04-14T16:00:49Z"
+    }
+  ],
+  "history": [
+    {
+      "url": "https://api.github.com/gists/1/57a7f021a713b1c5a6a199b54cc514735d2d462f",
+      "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f",
+      "user": {
+        "login": "octocat",
+        "id": 1,
+        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+        "gravatar_id": "somehexcode",
+        "url": "https://api.github.com/users/octocat"
+      },
+      "change_status": {
+        "deletions": 0,
+        "additions": 180,
+        "total": 180
+      },
+      "committed_at": "2010-04-14T02:15:15Z"
+    }
+  ]
+}

data/spec/fixtures/gists/gists.json

@@ -0,0 +1,28 @@
+[
+  {
+    "url": "https://api.github.com/gists/1",
+    "id": "1",
+    "description": "description of gist",
+    "public": true,
+    "user": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "gravatar_id": "somehexcode",
+      "url": "https://api.github.com/users/octocat"
+    },
+    "files": {
+      "ring.erl": {
+        "size": 932,
+        "filename": "ring.erl",
+        "raw_url": "https://gist.github.com/raw/365370/8c4d2d43d178df44f4c03a7f2ac0ff512853564e/ring.erl",
+        "content": "contents of gist"
+      }
+    },
+    "comments": 0,
+    "html_url": "https://gist.github.com/1",
+    "git_pull_url": "git://gist.github.com/1.git",
+    "git_push_url": "git@gist.github.com:1.git",
+    "created_at": "2010-04-14T02:15:15Z"
+  }
+]

data/spec/github/api_spec.rb

@@ -29,6 +29,21 @@ describe Github::API do
     end
   end
 
+  context '_process_basic_auth' do
+    it 'should parse authentication params' do
+      github = Github.new :basic_auth => 'login:password'
+      github.login.should eq 'login'
+      github.password.should eq 'password'
+    end
+  end
+
+  context '_set_api_client' do
+    it 'should set instantiated api class as main api client' do
+      repos_instance = repos.new
+      Github.api_client.should eq repos_instance
+    end
+  end
+
   context '_normalize_params_keys' do
     before do
       @params = { 'a' => { :b => { 'c' => 1 }, 'd' => [ 'a', { :e => 2 }] } }

data/spec/github/authorization_spec.rb

@@ -125,6 +125,10 @@ describe Github::Authorization do
   end
 
   context ".basic_authed?" do
+    before do
+      github.stub(:basic_auth?).and_return false
+    end
+
     it { github.should respond_to :basic_authed? }
 
     it "should return false if login is missing" do
@@ -164,6 +168,7 @@ describe Github::Authorization do
     context 'login & password' do
       before do
         github = Github.new :login => 'github', :password => 'pass'
+        github.basic_auth = nil
       end
 
       it "should return hash with login & password params" do

data/spec/github/client_spec.rb

@@ -32,6 +32,10 @@ describe Github::Client do
     github.users.should be_a Github::Users
   end
 
+  it "should return Github::Authorizations instance" do
+    github.oauth.should be_a Github::Authorizations
+  end
+
   it "should respond to repos" do
     github.should respond_to :repos
   end

data/spec/github/core_ext/hash_spec.rb

@@ -10,35 +10,62 @@ describe Hash do
     @symbols = { :a => { :b => { :c => 1 } } }
   end
 
-  it "should respond to except" do
-    @nested_hash.should respond_to :except
+  context '#except!' do
+    it "should respond to except!" do
+      @nested_hash.should respond_to :except!
+    end
   end
 
-  it "should respond to except!" do
-    @nested_hash.should respond_to :except!
-  end
+  context '#except' do
+    it "should respond to except" do
+      @nested_hash.should respond_to :except
+    end
 
-  it "should respond to symbolize_keys!" do
-    @nested_hash.should respond_to :symbolize_keys!
+    it "should remove key from the hash" do
+      @nested_hash.except('a').should be_empty
+    end
   end
 
-  it "should respond to symbolize_keys" do
-    @nested_hash.should respond_to :symbolize_keys
+  context '#symbolize_keys' do
+    it "should respond to symbolize_keys" do
+      @nested_hash.should respond_to :symbolize_keys
+    end
   end
 
-  it "should respond to serialize" do
-    @nested_hash.should respond_to :serialize
+  context '#symbolize_keys!' do
+    it "should respond to symbolize_keys!" do
+      @nested_hash.should respond_to :symbolize_keys!
+    end
+
+    it "should convert nested keys to symbols" do
+      @nested_hash.symbolize_keys!.should == @symbols
+    end
   end
 
-  it "should remove key from the hash" do
-    @nested_hash.except('a').should be_empty
+  context '#serialize' do
+    it "should respond to serialize" do
+      @nested_hash.should respond_to :serialize
+    end
+
+    it "should serialize hash" do
+      @hash.serialize.should == @serialized
+    end
   end
 
-  it "should convert nested keys to symbols" do
-    @nested_hash.symbolize_keys!.should == @symbols
+  context '#all_keys' do
+    it "should respond to all_keys" do
+      @nested_hash.should respond_to :all_keys
+    end
+
+    it "should return all keys for nested hash" do
+      @nested_hash.all_keys.should eq ['a', 'b', 'c']
+    end
   end
 
-  it "should serialize hash" do
-    @hash.serialize.should == @serialized
+  context '#has_deep_key?' do
+    it 'should find key inside nested hash' do
+      @nested_hash.has_deep_key?('c').should be_true
+    end
   end
-end
+
+end # Hash

data/spec/github/deprecation_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Github do
+
+  let(:method) { 'create_repos'}
+  let(:alt_method) { 'repos.create'}
+
+  it { described_class.constants.should include :DEPRECATION_PREFIX }
+
+  context '.deprecate' do
+    before do
+      Github.deprecation_tracker = []
+    end
+
+    it 'tracks messages' do
+      Github.should_receive(:warn).once()
+      Github.deprecate(method)
+      Github.deprecate(method)
+    end
+
+    it 'prints the message through Kernel' do
+      Github.should_receive(:warn).once()
+      Github.deprecate method
+    end
+  end
+
+  it 'prints the message through Kernel' do
+    Github.should_receive(:warn)
+    Github.warn_deprecation method
+  end
+end # Github

data/spec/github/gists_spec.rb

@@ -1,5 +1,463 @@
 require 'spec_helper'
 
-describe Github::Gists do
-  pending
-end
+describe Github::Gists, :type => :base do
+
+  let(:gist_id) { '1' }
+
+  describe "#gists" do
+    context 'check aliases' do
+      it { github.gists.should respond_to :gists }
+      it { github.gists.should respond_to :list_gists }
+    end
+
+    context "- unauthenticated user" do
+      context "resource found" do
+        before do
+          stub_get("/users/#{user}/gists").
+            to_return(:body => fixture('gists/gists.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+        end
+
+        it "should get the resources" do
+          github.gists.gists user
+          a_get("/users/#{user}/gists").should have_been_made
+        end
+
+        it "should return array of resources" do
+          gists = github.gists.gists user
+          gists.should be_an Array
+          gists.should have(1).items
+        end
+
+        it "should be a mash type" do
+          gists = github.gists.gists user
+          gists.first.should be_a Hashie::Mash
+        end
+
+        it "should get gist information" do
+          gists = github.gists.gists user
+          gists.first.user.login.should == 'octocat'
+        end
+
+        it "should yield to a block" do
+          github.gists.should_receive(:gists).with(user).and_yield('web')
+          github.gists.gists(user) { |param| 'web' }
+        end
+      end
+
+      context "resource not found" do
+        before do
+          stub_get("/users/#{user}/gists").
+            to_return(:body => "", :status => [404, "Not Found"])
+        end
+
+        it "should return 404 with a message 'Not Found'" do
+          expect {
+            github.gists.gists user
+          }.to raise_error(Github::ResourceNotFound)
+        end
+      end
+    end # unauthenticated user
+
+    context '- public' do
+      before do
+        github.user = nil
+        stub_get("/gists/public").
+          to_return(:body => fixture('gists/gists.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should get the resources" do
+        github.gists.gists
+        a_get("/gists/public").should have_been_made
+      end
+    end
+
+    context '- authenticated user' do
+      before do
+        github.user = nil
+        github.oauth_token = OAUTH_TOKEN
+        stub_get("/gists").
+          with(:query => {:access_token => OAUTH_TOKEN}).
+          to_return(:body => fixture('gists/gists.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+      after do
+        github.oauth_token = nil
+      end
+
+      it "should get the resources" do
+        github.gists.gists
+        a_get("/gists").with(:query => {:access_token => OAUTH_TOKEN}).
+          should have_been_made
+      end
+    end
+  end # gists
+
+  describe "#starred" do
+    context "resource found" do
+      before do
+        stub_get("/gists/starred").
+          to_return(:body => fixture('gists/gists.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should get the resources" do
+        github.gists.starred
+        a_get("/gists/starred").should have_been_made
+      end
+
+      it "should return array of resources" do
+        gists = github.gists.starred
+        gists.should be_an Array
+        gists.should have(1).items
+      end
+
+      it "should be a mash type" do
+        gists = github.gists.starred
+        gists.first.should be_a Hashie::Mash
+      end
+
+      it "should get gist information" do
+        gists = github.gists.starred
+        gists.first.user.login.should == 'octocat'
+      end
+
+      it "should yield to a block" do
+        github.gists.should_receive(:starred).and_yield('web')
+        github.gists.starred() { |param| 'web' }
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/gists/starred").
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.gists.starred
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+
+  end # starred
+
+  describe "#gist" do
+    let(:gist_id) { '1' }
+
+    context 'check aliases' do
+      it { github.gists.should respond_to :gist }
+      it { github.gists.should respond_to :get_gist }
+    end
+
+    context "resource found" do
+      before do
+        stub_get("/gists/#{gist_id}").
+          to_return(:body => fixture('gists/gist.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to get resource without gist id" do
+        expect { github.gists.gist(nil)}.to raise_error(ArgumentError)
+      end
+
+      it "should get the resource" do
+        github.gists.gist gist_id
+        a_get("/gists/#{gist_id}").should have_been_made
+      end
+
+      it "should get gist information" do
+        gist = github.gists.gist gist_id
+        gist.id.should eq gist_id
+        gist.user.login.should == 'octocat'
+      end
+
+      it "should return mash" do
+        gist = github.gists.gist gist_id
+        gist.should be_a Hashie::Mash
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/gists/#{gist_id}").
+          to_return(:body => fixture('gists/gist.json'), :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to retrive resource" do
+        expect {
+          github.gists.gist gist_id
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # gist
+
+  describe "#create_gist" do
+    let(:inputs) {
+      {
+        "description" => "the description for this gist",
+        "public" => true,
+        "files" => {
+          "file1.txt" => {
+            "content" => "String file contents"
+          }
+        },
+      }
+    }
+
+    context "resouce created" do
+      before do
+        stub_post("/gists").
+          with(:body => JSON.generate(inputs)).
+          to_return(:body => fixture('gists/gist.json'),
+                :status => 201,
+                :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to create resource if 'content' input is missing" do
+        expect {
+          github.gists.create_gist inputs.except('files')
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should fail to create resource if 'encoding' input is missing" do
+        expect {
+          github.gists.create_gist inputs.except('public')
+        }.to raise_error(ArgumentError)
+      end
+
+      it "should create resource successfully" do
+        github.gists.create_gist inputs
+        a_post("/gists").with(inputs).should have_been_made
+      end
+
+      it "should return the resource" do
+        gist = github.gists.create_gist inputs
+        gist.should be_a Hashie::Mash
+      end
+
+      it "should get the gist information" do
+        gist = github.gists.create_gist inputs
+        gist.user.login.should == 'octocat'
+      end
+    end
+
+    context "failed to create resource" do
+      before do
+        stub_post("/gists").with(inputs).
+          to_return(:body => fixture('gists/gist.json'),
+            :status => 404,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should faile to retrieve resource" do
+        expect {
+          github.gists.create_gist inputs
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # create_gist
+
+  describe "#edit_gist" do
+    let(:inputs) {
+      {
+        "description" => "the description for this gist",
+        "files" => {
+          "file1.txt" => {
+            "content" => "updated file contents"
+          },
+          "old_name.txt" => {
+            "filename" => "new_name.txt",
+            "content" => "modified contents"
+          },
+          "new_file.txt" => {
+            "content" => "a new file"
+          },
+          "delete_this_file.txt" => nil
+        }
+      }
+    }
+
+    context "resouce edited" do
+      before do
+        stub_patch("/gists/#{gist_id}").
+          with(:body => JSON.generate(inputs)).
+          to_return(:body => fixture('gists/gist.json'),
+                :status => 200,
+                :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should edit resource successfully" do
+        github.gists.edit_gist gist_id, inputs
+        a_patch("/gists/#{gist_id}").with(inputs).should have_been_made
+      end
+
+      it "should return the resource" do
+        gist = github.gists.edit_gist gist_id, inputs
+        gist.should be_a Hashie::Mash
+      end
+
+      it "should get the gist information" do
+        gist = github.gists.edit_gist gist_id, inputs
+        gist.user.login.should == 'octocat'
+      end
+    end
+
+    context "failed to edit resource" do
+      before do
+        stub_patch("/gists/#{gist_id}").with(inputs).
+          to_return(:body => fixture('gists/gist.json'),
+            :status => 404,
+            :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.gists.edit_gist gist_id, inputs
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # edit_gist
+
+  context '#star' do
+    before do
+      stub_put("/gists/#{gist_id}/star").
+        to_return(:body => '',
+              :status => 204,
+              :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should raise error if gist id not present" do
+      expect {
+        github.gists.star nil
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'successfully stars a gist' do
+      github.gists.star(gist_id)
+      a_put("/gists/#{gist_id}/star").should have_been_made
+    end
+
+    it "should return 204 with a message 'Not Found'" do
+      github.gists.star(gist_id).status.should be 204
+    end
+  end # star
+
+  context '#unstar' do
+    before do
+      stub_delete("/gists/#{gist_id}/star").
+        to_return(:body => '',
+              :status => 204,
+              :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "should raise error if gist id not present" do
+      expect {
+        github.gists.unstar nil
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'successfully stars a gist' do
+      github.gists.unstar(gist_id)
+      a_delete("/gists/#{gist_id}/star").should have_been_made
+    end
+
+    it "should return 204 with a message 'Not Found'" do
+      github.gists.unstar(gist_id).status.should be 204
+    end
+  end # unstar
+
+  context '#starred?' do
+    before do
+      stub_get("/gists/#{gist_id}/star").
+        to_return(:body => '',
+              :status => 204,
+              :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it 'should raise error if gist id not present' do
+      expect {
+        github.gists.starred? nil
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'should return true if gist is already starred' do
+      github.gists.starred?(gist_id).should be_true
+    end
+
+    it 'should return false if gist is not starred' do
+      stub_get("/gists/#{gist_id}/star").
+        to_return(:body => '',
+              :status => 404,
+              :headers => {:content_type => "application/json; charset=utf-8"})
+      github.gists.starred?(gist_id).should be_false
+    end
+  end # starred?
+
+  context '#fork' do
+    before do
+      stub_post("/gists/#{gist_id}/fork").
+        to_return(:body => fixture('gists/gist.json'),
+              :status => 201,
+              :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+
+    it "should fail to fork gist without gist id" do
+      expect { github.gists.fork(nil) }.to raise_error(ArgumentError)
+    end
+
+    it "should fork resource successfully" do
+      github.gists.fork gist_id
+      a_post("/gists/#{gist_id}/fork").should have_been_made
+    end
+
+    it "should return the resource" do
+      gist = github.gists.fork gist_id
+      gist.should be_a Hashie::Mash
+    end
+
+    it "should get the gist information" do
+      gist = github.gists.fork gist_id
+      gist.user.login.should == 'octocat'
+    end
+
+    it 'fails to retrieve resource' do
+      stub_post("/gists/#{gist_id}/fork").
+        to_return(:body => '',
+          :status => 404,
+          :headers => {:content_type => "application/json; charset=utf-8"})
+      expect {
+        github.gists.fork gist_id
+      }.to raise_error(Github::ResourceNotFound)
+    end
+  end # fork
+
+  context "#delete_gist" do
+    before do
+      stub_delete("/gists/#{gist_id}").
+        to_return(:body => fixture('gists/gist.json'),
+              :status => 204,
+              :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it 'should raise error if gist id not present' do
+      expect {
+        github.gists.delete_gist nil
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should remove resource successfully" do
+      github.gists.delete_gist gist_id
+      a_delete("/gists/#{gist_id}").should have_been_made
+    end
+
+    it "fails to delete resource" do
+      stub_delete("/gists/#{gist_id}").
+        to_return(:body => '',
+          :status => 404,
+          :headers => {:content_type => "application/json; charset=utf-8"})
+      expect {
+        github.gists.delete_gist gist_id
+      }.to raise_error(Github::ResourceNotFound)
+    end
+  end # delete_gist
+
+end # Github::Gists