github_api 0.4.11 → 0.5.0.rc1

data/spec/github/users_spec.rb

@@ -1,129 +1,128 @@
 require 'spec_helper'
 
-describe Github::Users, :type => :base do
-
-#   before do
-#     reset_authentication_for github
-#   end
-# 
-#   after do
-#     reset_authentication_for github
-#   end
-# 
-#   describe "get_user" do
-#     context "resource found for a user" do
-#       before do
-#         stub_get("/users/#{user}").
-#           to_return(:body => fixture('users/user.json'),
-#             :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
-#       end
-# 
-#       it "should get the resources" do
-#         github.users.get_user user
-#         a_get("/users/#{user}").should have_been_made
-#       end
-# 
-#       it "should return resource" do
-#         user_resource = github.users.get_user user
-#         user_resource.should be_a Hash
-#       end
-# 
-#       it "should be a mash type" do
-#         user_resource = github.users.get_user user
-#         user_resource.should be_a Hashie::Mash
-#       end
-# 
-#       it "should get org information" do
-#         user_resource = github.users.get_user user
-#         user_resource.login.should == 'octocat'
-#       end
-# 
-#       it "should yield to a block" do
-#         github.users.should_receive(:get_user).with(user).and_yield('web')
-#         github.users.get_user(user) { |param| 'web' }
-#       end
-#     end
-# 
-#     context "resource found for an authenticated user" do
-#       before do
-#         github.oauth_token = OAUTH_TOKEN
-#         stub_get("/user").
-#           with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
-#           to_return(:body => fixture('users/user.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
-#       end
-# 
-#       it "should get the resources" do
-#         github.users.get_user
-#         a_get("/user").with(:query => {:access_token => "#{OAUTH_TOKEN}"}).
-#           should have_been_made
-#       end
-#     end
-# 
-#     context "resource not found for a user" do
-#       before do
-#         stub_get("/users/#{user}").
-#           to_return(:body => "", :status => [404, "Not Found"])
-#       end
-# 
-#       it "should return 404 with a message 'Not Found'" do
-#         expect {
-#           github.users.get_user user
-#         }.to raise_error(Github::Error::NotFound)
-#       end
-#     end
-#   end # get_user
-# 
-#   describe "update_user" do
-#     let(:user_params) {
-#       {
-#         "name" => "monalisa octocat",
-#         "email" => "octocat@github.com",
-#         "blog" => "https://github.com/blog",
-#         "company" => "GitHub",
-#         "location" => "San Francisco",
-#         "hireable" => true,
-#         "bio" => "There once..."
-#       }
-#     }
-# 
-#     context "resouce updated" do
-#       before do
-#         github.oauth_token = OAUTH_TOKEN
-#         stub_patch("/user?access_token=#{OAUTH_TOKEN}").with(user_params).
-#           to_return(:body => fixture('users/user.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
-# 
-#       end
-# 
-#       it "should create resource successfully" do
-#         github.users.update_user
-#         a_patch("/user?access_token=#{OAUTH_TOKEN}").with(user_params).should have_been_made
-#       end
-# 
-#       it "should return the resource" do
-#         user_resource = github.users.update_user
-#         user_resource.should be_a Hashie::Mash
-#       end
-# 
-#       it "should get the resource information" do
-#         user_resource = github.users.update_user
-#         user_resource.login.should == 'octocat'
-#       end
-#     end
-# 
-#     context "failed to update resource" do
-#       before do
-#         github.oauth_token = OAUTH_TOKEN
-#         stub_patch("/user?access_token=#{OAUTH_TOKEN}").with(user_params).
-#           to_return(:body => fixture('users/user.json'), :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
-# 
-#       end
-# 
-#       it "should fail to retrieve resource" do
-#         expect {
-#           github.users.update_user
-#         }.to raise_error(Github::Error::NotFound)
-#       end
-#     end
-#   end # update_comment
+describe Github::Users do
+  let(:github) { Github.new }
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+
+  after { reset_authentication_for github }
+
+  describe "#get" do
+    it { github.users.should respond_to :find }
+
+    context "resource found for a user" do
+      before do
+        stub_get("/users/#{user}").
+          to_return(:body => fixture('users/user.json'),
+            :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should get the resources" do
+        github.users.get user
+        a_get("/users/#{user}").should have_been_made
+      end
+
+      it "should return resource" do
+        user_resource = github.users.get user
+        user_resource.should be_a Hash
+      end
+
+      it "should be a mash type" do
+        user_resource = github.users.get user
+        user_resource.should be_a Hashie::Mash
+      end
+
+      it "should get org information" do
+        user_resource = github.users.get user
+        user_resource.login.should == 'octocat'
+      end
+
+      it "should yield to a block" do
+        github.users.should_receive(:get).with(user).and_yield('web')
+        github.users.get(user) { |param| 'web' }
+      end
+    end
+
+    context "resource found for an authenticated user" do
+      before do
+        github.oauth_token = OAUTH_TOKEN
+        stub_get("/user").
+          with(:query => { :access_token => "#{OAUTH_TOKEN}"}).
+          to_return(:body => fixture('users/user.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should get the resources" do
+        github.users.get
+        a_get("/user").with(:query => {:access_token => "#{OAUTH_TOKEN}"}).
+          should have_been_made
+      end
+    end
+
+    context "resource not found for a user" do
+      before do
+        stub_get("/users/#{user}").
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.users.get user
+        }.to raise_error(Github::Error::NotFound)
+      end
+    end
+  end # get
+
+  describe "#update" do
+    let(:user_params) {
+      {
+        "name" => "monalisa octocat",
+        "email" => "octocat@github.com",
+        "blog" => "https://github.com/blog",
+        "company" => "GitHub",
+        "location" => "San Francisco",
+        "hireable" => true,
+        "bio" => "There once..."
+      }
+    }
+
+    context "resouce updated" do
+      before do
+        github.oauth_token = OAUTH_TOKEN
+        stub_patch("/user?access_token=#{OAUTH_TOKEN}").with(user_params).
+          to_return(:body => fixture('users/user.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+
+      end
+
+      it "should create resource successfully" do
+        github.users.update
+        a_patch("/user?access_token=#{OAUTH_TOKEN}").with(user_params).should have_been_made
+      end
+
+      it "should return the resource" do
+        user_resource = github.users.update
+        user_resource.should be_a Hashie::Mash
+      end
+
+      it "should get the resource information" do
+        user_resource = github.users.update
+        user_resource.login.should == 'octocat'
+      end
+    end
+
+    context "failed to update resource" do
+      before do
+        github.oauth_token = OAUTH_TOKEN
+        stub_patch("/user?access_token=#{OAUTH_TOKEN}").with(user_params).
+          to_return(:body => fixture('users/user.json'), :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.users.update
+        }.to raise_error(Github::Error::NotFound)
+      end
+    end
+  end # update
 
 end # Github::Users

data/spec/github/validations/format_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Validations::Format do
+
+  let(:validator) { Class.new.extend(described_class) }
+
+  context '#_validate_params_values' do
+    let(:permitted) {
+      {
+        'param_a' => ['a', 'b'],
+        'param_b' => /^github$/
+      }
+    }
+
+    it 'fails to accept unkown value for a given parameter key' do
+      actual = { 'param_a' => 'x' }
+      expect {
+        validator._validate_params_values(permitted, actual)
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'accepts known value for a given parameter key' do
+      actual = { 'param_a' => 'a'}
+      validator._validate_params_values(permitted, actual)
+    end
+
+    it 'fails to match regex value for a given parameter key' do
+      actual = { 'param_b' => 'xgithub' }
+      expect {
+        validator._validate_params_values(permitted, actual)
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'matches regex value for a given parameter key' do
+      actual = { 'param_b' => 'github'}
+      validator._validate_params_values(permitted, actual)
+    end
+  end
+
+end # Github::Validations::Format

data/spec/github/validations/presence_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Validations::Presence do
+
+  let(:validator) { Class.new.extend(described_class) }
+
+  context '#_validate_presence_of' do
+    it 'throws error if passed param is nil' do
+      gist_id = nil
+      expect {
+        validator._validate_presence_of gist_id
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+end # Github::Validations::Presence

data/spec/github/validations/required_spec.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'github_api/core_ext/hash'
+
+describe Github::Validations::Required do
+
+  let(:validator) {
+    klaz = Class.new.extend(described_class)
+  }
+
+  context '#_validate_inputs' do
+    let(:required) { ['param_a', 'param_c'] }
+    let(:provided) { { 'param_a' => true, 'param_c' => true } }
+
+    it 'detect missing parameter' do
+      expect {
+        validator._validate_inputs(required, provided.except('param_c')).
+          should be_false
+      }.to raise_error(Github::Error::RequiredParams)
+    end
+
+    it 'asserts correct required parameters' do
+      validator._validate_inputs(required, provided).should be_true
+    end
+  end
+
+end # Github::Validations::Required

data/spec/github/validations/token_spec.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Validations::Token do
+
+  let(:validator) { Class.new.extend(described_class) }
+
+  context '#validates_token_for' do
+    it 'does not require authentication token' do
+      validator.validates_token_for(:get, '/octocat/emails').should be_false
+    end
+
+    it 'requires authentication token' do
+      validator.validates_token_for(:get, '/user/emails').should be_true
+    end
+  end
+
+end # Github::Validations::Token

data/spec/github/validations_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Github::Validations do
+
+  let(:validator) { Class.new.send(:include, described_class) }
+
+  it 'includes parameters presence validations' do
+    validator.included_modules.should include Github::Validations::Presence
+  end
+
+  it 'includes authentication token validations' do
+    validator.included_modules.should include Github::Validations::Token
+  end
+
+  it 'includes parameters values format validations' do
+    validator.included_modules.should include Github::Validations::Format
+  end
+
+  it 'includes required parameters presence validations' do
+    validator.included_modules.should include Github::Validations::Required
+  end
+
+end # Github::Validations

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: github_api
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.4.11
+  prerelease: 6
+  version: 0.5.0.rc1
 platform: ruby
 authors: 
 - Piotr Murach
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-22 00:00:00 +01:00
+date: 2012-04-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -206,17 +206,20 @@ files:
 - features/cassettes/gists/gist.yml
 - features/cassettes/gists/gists/public_all.yml
 - features/cassettes/gists/gists/user_all.yml
+- features/cassettes/gists/starred.yml
+- features/cassettes/pagination/repos/commits/list.yml
 - features/cassettes/pagination/repos/commits/next.yml
 - features/cassettes/pagination/repos/commits/sha/next.yml
 - features/cassettes/pagination/repos/commits/sha.yml
 - features/cassettes/pagination/repos/commits.yml
 - features/cassettes/pagination/repos/diff/next.yml
 - features/cassettes/pagination/repos/diff.yml
-- features/cassettes/pagination/repos/next.yml
+- features/cassettes/pagination/repos/list/next.yml
+- features/cassettes/pagination/repos/list.yml
 - features/cassettes/pagination/repos/per_page/each_page.yml
 - features/cassettes/pagination/repos/per_page/first.yml
-- features/cassettes/pagination/repos.yml
 - features/cassettes/repos/branches.yml
+- features/cassettes/repos/list.yml
 - features/cassettes/repos/tags.yml
 - features/error_codes.feature
 - features/gists/comments.feature
@@ -309,7 +312,11 @@ files:
 - lib/github_api/users/keys.rb
 - lib/github_api/users.rb
 - lib/github_api/utils/url.rb
-- lib/github_api/validation.rb
+- lib/github_api/validations/format.rb
+- lib/github_api/validations/presence.rb
+- lib/github_api/validations/required.rb
+- lib/github_api/validations/token.rb
+- lib/github_api/validations.rb
 - lib/github_api/version.rb
 - lib/github_api.rb
 - spec/coverage_adapter.rb
@@ -356,6 +363,7 @@ files:
 - spec/fixtures/repos/commit.json
 - spec/fixtures/repos/commit_comment.json
 - spec/fixtures/repos/commit_comments.json
+- spec/fixtures/repos/commit_comparison.json
 - spec/fixtures/repos/commits.json
 - spec/fixtures/repos/contributors.json
 - spec/fixtures/repos/download.json
@@ -432,7 +440,11 @@ files:
 - spec/github/users/keys_spec.rb
 - spec/github/users_spec.rb
 - spec/github/utils/url_spec.rb
-- spec/github/validation_spec.rb
+- spec/github/validations/format_spec.rb
+- spec/github/validations/presence_spec.rb
+- spec/github/validations/required_spec.rb
+- spec/github/validations/token_spec.rb
+- spec/github/validations_spec.rb
 - spec/github_spec.rb
 - spec/README.rdoc
 - spec/spec_helper.rb
@@ -445,7 +457,18 @@ has_rdoc: true
 homepage: https://github.com/peter-murach/github
 licenses: []
 
-post_install_message: 
+post_install_message: "\n\
+  --------------------------------------------------------------------------------\n\
+  Thank you for installing github_api-0.5.0.rc1.\n\n\
+  *NOTE*: Version 0.5.0 introduces breaking changes to the way github api is queried.\n\
+  The interface has been rewritten to be more consistent with REST verbs that\n\
+  interact with GitHub hypermedia resources. Thus, to list resources 'list' or 'all'\n\
+  verb is used, to retrieve individual resource 'get' or 'find' verbs are used.\n\
+  Further CRUDE operations on all resources use preditable verbs as well.\n\n\
+  Again sorry for inconvenience but I trust that this will help in easier access to\n\
+  the GitHub API.\n\n\
+  For more information: http://rubydoc.info/github/peter-murach/github/master/frames\n\n\
+  --------------------------------------------------------------------------------\n  "
 rdoc_options: []
 
 require_paths: 
@@ -459,9 +482,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: