github_api 0.4.6 → 0.4.7

data/lib/github_api/version.rb

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

data/spec/github/api_factory_spec.rb

@@ -1,7 +1,8 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe Github::ApiFactory, :type => :base do
-
   context '#new' do
     it 'throws error if klass type is ommitted' do
       expect { described_class.new nil }.to raise_error(ArgumentError)

data/spec/github/api_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Github::API do
-
   let(:api) { Github::API.new }
   let(:repos) { Github::Repos }
 
@@ -30,8 +29,11 @@ describe Github::API do
   end
 
   context '_process_basic_auth' do
+    let(:github) { Github.new :basic_auth => 'login:password' }
+
+    after { reset_authentication_for github }
+
     it 'should parse authentication params' do
-      github = Github.new :basic_auth => 'login:password'
       github.login.should eq 'login'
       github.password.should eq 'password'
     end

data/spec/github/authorization_spec.rb

@@ -1,26 +1,18 @@
+# encoding: utf-8
+
 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
+  let(:github) {
+    Github.new :client_id => client_id, :client_secret => client_secret
+  }
 
-  it "should assign 'token_url" do
-    github.client.token_url.should == 'https://github.com/login/oauth/access_token'
+  after do
+    github.client_id, github.client_secret = nil, nil
+    reset_authentication_for github
   end
 
   context '.client' do
@@ -29,18 +21,22 @@ describe Github::Authorization do
     it "should return OAuth2::Client instance" do
       github.client.should be_a OAuth2::Client
     end
-  end
 
-  context '.auth_code' do
-    let(:oauth) { OAuth2::Client.new(client_id, client_secret) }
+    it "should assign site from the options hash" do
+      github.client.site.should == 'https://github.com'
+    end
 
-    before do
-      github = Github.new :client_id => client_id, :client_secret => client_secret
+    it "should assign 'authorize_url" do
+      github.client.authorize_url.should == 'https://github.com/login/oauth/authorize'
     end
 
-    after do
-      github.client_id, github.client_secret = nil, nil
+    it "should assign 'token_url" do
+      github.client.token_url.should == 'https://github.com/login/oauth/access_token'
     end
+  end
+
+  context '.auth_code' do
+    let(:oauth) { OAuth2::Client.new(client_id, client_secret) }
 
     it "should throw an error if no client_id" do
       github.client_id = nil
@@ -61,10 +57,6 @@ describe Github::Authorization do
   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
@@ -84,7 +76,6 @@ describe Github::Authorization do
 
   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

data/spec/github/authorizations_spec.rb

@@ -1,7 +1,8 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe Github::Authorizations do
-
   let(:github) { Github.new }
   let(:basic_auth) { 'login:password' }
 

data/spec/github/client_spec.rb

@@ -1,9 +1,12 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe Github::Client do
-
   let(:github) { Github.new }
 
+  after { reset_authentication_for github }
+
   it "should return Github::Gists instance" do
     github.gists.should be_a Github::Gists
   end

data/spec/github/deprecation_spec.rb

@@ -1,7 +1,8 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe Github do
-
   let(:method) { 'create_repos'}
   let(:alt_method) { 'repos.create'}
 

data/spec/github/error/client_error_spec.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Error::ClientError do
+  describe '#generate_message' do
+    let(:error) { described_class.new('message') }
+    let(:attributes) do
+      {
+        :problem => 'Oh no!',
+        :summary => 'Fix this!',
+        :resolution => 'Glue it!'
+      }
+    end
+
+    it 'generates problem line' do
+      error.generate_message(attributes).should include "Problem:\n Oh no!"
+    end
+
+    it 'generates summary line' do
+      error.generate_message(attributes).should include "Summary:\n Fix this!"
+    end
+
+    it 'generates resolution line' do
+      error.generate_message(attributes).should include "Resolution:\n Glue it!"
+    end
+  end
+end # Github::Error::ClientError

data/spec/github/error/invalid_options_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Error::InvalidOptions do
+  describe '#message' do
+    let(:error) { described_class.new({:invalid => true}, [:valid]) }
+
+    it 'contains the problem in the message' do
+      error.message.should include "Invalid option invalid provided for this request."
+    end
+
+    it 'contains the summary in the message' do
+      error.message.should include "Github gem checks the request parameters passed to ensure that github api is not hit unnecessairly and to fail fast."
+    end
+
+    it 'contains the resolution in the message' do
+      error.message.should include "Valid options are: valid, make sure these are the ones you are using"
+    end
+  end
+end # Github::Error::InvalidOptions

data/spec/github/error/required_params_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Error::RequiredParams do
+  describe '#message' do
+    let(:error) { described_class.new({:extra => true}, [:required]) }
+
+    it 'contains the problem in the message' do
+      error.message.should include "Missing required parameters: extra provided for this request."
+    end
+
+    it 'contains the summary in the message' do
+      error.message.should include "Github gem checks the request parameters passed to ensure that github api is not hit unnecessairly and to fail fast."
+    end
+
+    it 'contains the resolution in the message' do
+      error.message.should include "Required parameters are: required, make sure these are the ones you are using"
+    end
+  end
+end # Github::Error::RequiredParams

data/spec/github/events_spec.rb

@@ -1,11 +1,14 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe Github::Events do
-
   let(:github) { Github.new }
   let(:user)   { 'peter-murach' }
   let(:repo)   { 'github' }
 
+  after { github.user, github.repo, github.oauth_token = nil, nil, nil }
+
   describe "public" do
     context "resource found" do
       before do
@@ -61,7 +64,6 @@ describe Github::Events do
       end
 
       it "should fail to get resource without username" do
-        github.user, github.repo = nil, nil
         expect { github.events.repository nil, repo }.to raise_error(ArgumentError)
       end
 
@@ -114,7 +116,6 @@ describe Github::Events do
       end
 
       it "should fail to get resource without username" do
-        github.user, github.repo = nil, nil
         expect { github.events.issue nil, repo }.to raise_error(ArgumentError)
       end
 
@@ -167,7 +168,6 @@ describe Github::Events do
       end
 
       it "should fail to get resource without username" do
-        github.user, github.repo = nil, nil
         expect { github.events.network nil, repo }.to raise_error(ArgumentError)
       end
 

data/spec/github/filter_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 require 'github_api/core_ext/hash'
 
-describe Github::Filter, :type => :base do
-
+describe Github::Filter do
+  let(:github) { Github.new }
   let(:repos_instance) { Github::Repos.new }
   let(:block) {
     Proc.new do |repo|

data/spec/github/gists/comments_spec.rb

@@ -1,10 +1,14 @@
-require 'spec_helper'
+# encoding: utf-8
 
-describe Github::Gists::Comments, :type => :base do
+require 'spec_helper'
 
+describe Github::Gists::Comments do
+  let(:github) { Github.new }
   let(:gist_id)    { '1' }
   let(:comment_id) { 1 }
 
+  after { github.user, github.repo, github.oauth_token = nil, nil, nil }
+
   describe "#comments" do
     context 'check aliases' do
       it { github.gists.should respond_to :comments }
@@ -132,7 +136,7 @@ describe Github::Gists::Comments, :type => :base do
       it "should fail to create resource if 'content' input is missing" do
         expect {
           github.gists.create_comment gist_id, inputs.except('body')
-        }.to raise_error(ArgumentError)
+        }.to raise_error(Github::Error::RequiredParams)
       end
 
       it "should create resource successfully" do
@@ -184,7 +188,7 @@ describe Github::Gists::Comments, :type => :base do
       it "should fail to create resource if 'content' input is missing" do
         expect {
           github.gists.edit_comment comment_id, inputs.except('body')
-        }.to raise_error(ArgumentError)
+        }.to raise_error(Github::Error::RequiredParams)
       end
 
       it "should create resource successfully" do

data/spec/github/gists_spec.rb

@@ -1,9 +1,14 @@
-require 'spec_helper'
+# encoding: utf-8
 
-describe Github::Gists, :type => :base do
+require 'spec_helper'
 
+describe Github::Gists do
+  let(:github) { Github.new }
+  let(:user) { 'peter-murach' }
   let(:gist_id) { '1' }
 
+  after { github.user, github.repo, github.oauth_token = nil, nil, nil }
+
   describe "#gists" do
     context 'check aliases' do
       it { github.gists.should respond_to :gists }
@@ -60,7 +65,6 @@ describe Github::Gists, :type => :base do
 
     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
@@ -73,15 +77,12 @@ describe Github::Gists, :type => :base do
 
     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
+      after { github.oauth_token = nil }
 
       it "should get the resources" do
         github.gists.gists
@@ -137,12 +138,9 @@ describe Github::Gists, :type => :base do
         }.to raise_error(Github::Error::NotFound)
       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 }
@@ -211,16 +209,23 @@ describe Github::Gists, :type => :base do
                 :headers => {:content_type => "application/json; charset=utf-8"})
       end
 
-      it "should fail to create resource if 'content' input is missing" do
+      it "should fail to create resource if 'files' input is missing" do
         expect {
           github.gists.create_gist inputs.except('files')
-        }.to raise_error(ArgumentError)
+        }.to raise_error(Github::Error::RequiredParams)
+      end
+
+      it "should fail to create resource if 'content' input is missing" do
+        pending 'add validation for nested attributes'
+        expect {
+          github.gists.create_gist inputs.except('content')
+        }.to raise_error(Github::Error::RequiredParams)
       end
 
-      it "should fail to create resource if 'encoding' input is missing" do
+      it "should fail to create resource if 'public' input is missing" do
         expect {
           github.gists.create_gist inputs.except('public')
-        }.to raise_error(ArgumentError)
+        }.to raise_error(Github::Error::RequiredParams)
       end
 
       it "should create resource successfully" do

data/spec/github/git_data/blobs_spec.rb

@@ -1,9 +1,15 @@
-require 'spec_helper'
+# encoding: utf-8
 
-describe Github::GitData::Blobs, :type => :base do
+require 'spec_helper'
 
+describe Github::GitData::Blobs do
+  let(:github) { Github.new }
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
   let(:sha) { "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" }
 
+  after { github.user, github.repo, github.oauth_token = nil, nil, nil }
+
   it { described_class::VALID_BLOB_PARAM_NAMES.should_not be_nil }
 
   describe "blob" do
@@ -69,13 +75,13 @@ describe Github::GitData::Blobs, :type => :base do
       it "should fail to create resource if 'content' input is missing" do
         expect {
           github.git_data.create_blob user, repo, inputs.except('content')
-        }.to raise_error(ArgumentError)
+        }.to raise_error(Github::Error::RequiredParams)
       end
 
       it "should fail to create resource if 'encoding' input is missing" do
         expect {
           github.git_data.create_blob user, repo, inputs.except('encoding')
-        }.to raise_error(ArgumentError)
+        }.to raise_error(Github::Error::RequiredParams)
       end
 
       it "should create resource successfully" do

data/spec/github/git_data/commits_spec.rb

@@ -1,9 +1,15 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe Github::GitData::Commits, :type => :base do
-
+  let(:github) { Github.new }
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
   let(:sha) { "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" }
 
+  after { github.user, github.repo, github.oauth_token = nil, nil, nil }
+
   it { described_class::VALID_COMMIT_PARAM_NAMES.should_not be_nil }
 
   describe "commit" do
@@ -17,7 +23,9 @@ describe Github::GitData::Commits, :type => :base do
       end
 
       it "should fail to get resource without sha" do
-        expect { github.git_data.commit(user, repo, nil)}.to raise_error(ArgumentError)
+        expect {
+          github.git_data.commit(user, repo, nil)
+        }.to raise_error(ArgumentError)
       end
 
       it "should get the resource" do
@@ -77,19 +85,19 @@ describe Github::GitData::Commits, :type => :base do
       it "should fail to create resource if 'message' input is missing" do
         expect {
           github.git_data.create_commit user, repo, inputs.except('message')
-        }.to raise_error(ArgumentError)
+        }.to raise_error(Github::Error::RequiredParams)
       end
 
       it "should fail to create resource if 'tree' input is missing" do
         expect {
           github.git_data.create_commit user, repo, inputs.except('tree')
-        }.to raise_error(ArgumentError)
+        }.to raise_error(Github::Error::RequiredParams)
       end
 
       it "should fail to create resource if 'parents' input is missing" do
         expect {
           github.git_data.create_commit user, repo, inputs.except('parents')
-        }.to raise_error(ArgumentError)
+        }.to raise_error(Github::Error::RequiredParams)
       end
 
       it "should create resource successfully" do
@@ -112,7 +120,6 @@ describe Github::GitData::Commits, :type => :base do
       before do
         stub_post("/repos/#{user}/#{repo}/git/commits").with(inputs).
           to_return(:body => fixture('git_data/commit.json'), :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
-
       end
 
       it "should faile to retrieve resource" do