github_api 0.7.0 → 0.7.1

data/lib/github_api/repos/pub_sub_hubbub.rb

@@ -18,7 +18,7 @@ module Github
     #    :secret => '...'
     #
     def subscribe(topic, callback, params={})
-      _validate_presence_of topic, callback
+      assert_presence_of topic, callback
       normalize! params
       _merge_action!("subscribe", topic, callback, params)
 
@@ -40,7 +40,7 @@ module Github
     #    :secret => '...'
     #
     def unsubscribe(topic, callback, params={})
-      _validate_presence_of topic, callback
+      assert_presence_of topic, callback
       normalize! params
       _merge_action!("unsubscribe", topic, callback, params)
 
@@ -63,7 +63,7 @@ module Github
     #    :event => 'watch'
     #
     def subscribe_service(user_name, repo_name, service_name, params={})
-      _validate_presence_of user_name, repo_name, service_name
+      assert_presence_of user_name, repo_name, service_name
       normalize! params
       event = params.delete('event') || 'push'
       topic = "https://github.com/#{user_name}/#{repo_name}/events/#{event}"
@@ -86,7 +86,7 @@ module Github
     #  github.repos.pubsubhubbub.unsubscribe_service 'user-name', 'repo-name', 'campfire'
     #
     def unsubscribe_service(user_name, repo_name, service_name, params={})
-      _validate_presence_of user_name, repo_name, service_name
+      assert_presence_of user_name, repo_name, service_name
       normalize! params
       event = params.delete('event') || 'push'
       topic = "https://github.com/#{user_name}/#{repo_name}/events/#{event}"

data/lib/github_api/repos/starring.rb

@@ -14,7 +14,7 @@ module Github
     #
     def list(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/stargazers", params)
@@ -57,7 +57,7 @@ module Github
     #  github.repos.starring.starring? 'user-name', 'repo-name'
     #
     def starring?(user_name, repo_name, params={})
-      _validate_presence_of user_name, repo_name
+      assert_presence_of user_name, repo_name
       normalize! params
       get_request("/user/starred/#{user_name}/#{repo_name}", params)
       true
@@ -74,7 +74,7 @@ module Github
     #  github.repos.starring.star 'user-name', 'repo-name'
     #
     def star(user_name, repo_name, params={})
-      _validate_presence_of user_name, repo_name
+      assert_presence_of user_name, repo_name
       normalize! params
       put_request("/user/starred/#{user_name}/#{repo_name}", params)
     end
@@ -88,7 +88,7 @@ module Github
     #  github.repos.starring.unstar 'user-name', 'repo-name'
     #
     def unstar(user_name, repo_name, params={})
-      _validate_presence_of user_name, repo_name
+      assert_presence_of user_name, repo_name
       normalize! params
       delete_request("/user/starred/#{user_name}/#{repo_name}", params)
     end

data/lib/github_api/repos/statuses.rb

@@ -23,7 +23,7 @@ module Github
     #
     def list(user_name, repo_name, sha, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/statuses/#{sha}", params)
@@ -51,7 +51,7 @@ module Github
     #
     def create(user_name, repo_name, sha, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
 
       normalize! params
       filter! VALID_STATUS_PARAM_NAMES, params, :recursive => false

data/lib/github_api/repos/watching.rb

@@ -14,7 +14,7 @@ module Github
     #
     def list(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/subscribers", params)
@@ -56,7 +56,7 @@ module Github
     #  github.repos.watching.watching? 'user-name', 'repo-name'
     #
     def watching?(user_name, repo_name, params={})
-      _validate_presence_of user_name, repo_name
+      assert_presence_of user_name, repo_name
       normalize! params
       get_request("/user/subscriptions/#{user_name}/#{repo_name}", params)
       true
@@ -73,7 +73,7 @@ module Github
     #  github.repos.watching.watch 'user-name', 'repo-name'
     #
     def watch(user_name, repo_name, params={})
-      _validate_presence_of user_name, repo_name
+      assert_presence_of user_name, repo_name
       normalize! params
       put_request("/user/subscriptions/#{user_name}/#{repo_name}", params)
     end
@@ -86,7 +86,7 @@ module Github
     #  github.repos.watching.unwatch 'user-name', 'repo-name'
     #
     def unwatch(user_name, repo_name, params={})
-      _validate_presence_of user_name, repo_name
+      assert_presence_of user_name, repo_name
       normalize! params
       delete_request("/user/subscriptions/#{user_name}/#{repo_name}", params)
     end

data/lib/github_api/users/followers.rb

@@ -61,7 +61,7 @@ module Github
     #  github.users.followers.following? 'user-name'
     #
     def following?(user_name, params={})
-      _validate_presence_of user_name
+      assert_presence_of user_name
       normalize! params
       get_request("/user/following/#{user_name}", params)
       true
@@ -76,7 +76,7 @@ module Github
     #  github.users.followers.follow 'user-name'
     #
     def follow(user_name, params={})
-      _validate_presence_of user_name
+      assert_presence_of user_name
       normalize! params
       put_request("/user/following/#{user_name}", params)
     end
@@ -88,7 +88,7 @@ module Github
     #  github.users.followers.unfollow 'user-name'
     #
     def unfollow(user_name, params={})
-      _validate_presence_of user_name
+      assert_presence_of user_name
       normalize! params
       delete_request("/user/following/#{user_name}", params)
     end

data/lib/github_api/users/keys.rb

@@ -27,7 +27,7 @@ module Github
     #  github.users.followers.get 'key-id'
     #
     def get(key_id, params={})
-      _validate_presence_of key_id
+      assert_presence_of key_id
       normalize! params
       get_request("/user/keys/#{key_id}", params)
     end
@@ -62,7 +62,7 @@ module Github
     #    "key" => "ssh-rsa AAA..."
     #
     def update(key_id, params={})
-      _validate_presence_of key_id
+      assert_presence_of key_id
       normalize! params
       filter! VALID_KEY_PARAM_NAMES, params
       patch_request("/user/keys/#{key_id}", params)
@@ -75,7 +75,7 @@ module Github
     #  github.users.followers.delete 'key-id'
     #
     def delete(key_id, params={})
-      _validate_presence_of key_id
+      assert_presence_of key_id
       normalize! params
       delete_request("/user/keys/#{key_id}", params)
     end

data/lib/github_api/validations/presence.rb

@@ -2,28 +2,27 @@
 
 module Github
   module Validations
+    # A mixin to help validate presence of non-empty values
     module Presence
 
-      # TODO: Rename this
-      # Ensures that esential arguments are present before request is made
+      # Ensure that esential arguments are present before request is made.
       #
-      def _validate_presence_of(*params)
-        case params
-        when Hash
-          raise Github::Error::Validations.new(params)
-        when Array
-          params.each do |param|
-            raise ArgumentError, "parameter cannot be nil" if param.nil?
-          end
-        end
-      end
+      # == Parameters
+      #  Hash/Array of arguments to be checked against nil and empty string
+      #
+      # == Example
+      #  assert_presence_of user: '...', repo: '...'
+      #  assert_presence_of user, repo
+      #
+      def assert_presence_of(*args)
+        hash = args.last.is_a?(::Hash) ? args.pop : {}
 
+        errors = hash.select { |key, val| val.to_s.empty? }
+        raise Github::Error::Validations.new(errors) unless errors.empty?
 
-      # Check if user or repository parameters are passed
-      #
-      def _validate_user_repo_params(user_name, repo_name)
-        raise ArgumentError, "[user] parameter cannot be nil" if user_name.nil?
-        raise ArgumentError, "[repo] parameter cannot be nil" if repo_name.nil?
+        args.each do |arg|
+          raise ArgumentError, "parameter cannot be nil" if arg.nil?
+        end
       end
 
     end # Presence

data/lib/github_api/version.rb

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

data/spec/fixtures/repos/repos_sorted_by_pushed.json

@@ -0,0 +1,56 @@
+[
+  {
+    "url": "https://api.github.com/repos/octocat/Hello-World-2",
+    "html_url": "https://github.com/octocat/Hello-World-2",
+    "clone_url": "https://github.com/octocat/Hello-World-2.git",
+    "git_url": "git://github.com/octocat/Hello-World-2.git",
+    "ssh_url": "git@github.com:octocat/Hello-World-2.git",
+    "svn_url": "https://svn.github.com/octocat/Hello-World-2",
+    "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-2",
+    "description": "This your second 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-02-26T19:06:43Z",
+    "created_at": "2011-02-26T19:01:12Z"
+  },
+  {
+    "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/github/git_data_spec.rb

@@ -2,12 +2,10 @@ require 'spec_helper'
 
 describe Github::GitData do
 
-  context 'access to apis' do
-    it { subject.blobs.should be_a Github::GitData::Blobs }
-    it { subject.commits.should be_a Github::GitData::Commits }
-    it { subject.references.should be_a Github::GitData::References }
-    it { subject.tags.should be_a Github::GitData::Tags }
-    it { subject.trees.should be_a Github::GitData::Trees }
-  end
+  its(:blobs)   { should be_a Github::GitData::Blobs }
+  its(:commits) { should be_a Github::GitData::Commits }
+  its(:references) { should be_a Github::GitData::References }
+  its(:tags)  { should be_a Github::GitData::Tags }
+  its(:trees) { should be_a Github::GitData::Trees }
 
 end # Github::GitData

data/spec/github/issues_spec.rb

@@ -11,20 +11,19 @@ describe Github::Issues do
 
   after { reset_authentication_for github }
 
-  context 'access to apis' do
-    it { subject.comments.should be_a Github::Issues::Comments }
-    it { subject.events.should be_a Github::Issues::Events }
-    it { subject.labels.should be_a Github::Issues::Labels }
-    it { subject.milestones.should be_a Github::Issues::Milestones }
-  end
+  its(:comments) { should be_a Github::Issues::Comments }
+  its(:events)   { should be_a Github::Issues::Events }
+  its(:labels)   { should be_a Github::Issues::Labels }
+  its(:milestones) { should be_a Github::Issues::Milestones }
 
   context '#list' do
-    it { github.issues.should respond_to(:all) }
+    it { should respond_to(:all) }
 
     context "resource found" do
       before do
         stub_get("/issues").
-          to_return(:body => fixture('issues/issues.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+          to_return(:body => fixture('issues/issues.json'), :status => 200,
+            :headers => {:content_type => "application/json; charset=utf-8"})
       end
 
       it "should get the resources" do
@@ -67,12 +66,13 @@ describe Github::Issues do
   end # list
 
   describe '#list_repo' do
-    it { github.issues.should respond_to :list_repository }
+    it { should respond_to :list_repository }
 
     context "resource found" do
       before do
         stub_get("/repos/#{user}/#{repo}/issues").
-          to_return(:body => fixture('issues/issues.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+          to_return(:body => fixture('issues/issues.json'), :status => 200,
+           :headers => {:content_type => "application/json; charset=utf-8"})
       end
 
       it "should raise error if user-name empty" do
@@ -123,7 +123,7 @@ describe Github::Issues do
   end # list_repo
 
   describe "#get" do
-    it { github.issues.should respond_to :find }
+    it { should respond_to :find }
 
     context "resource found" do
       before do
@@ -279,6 +279,6 @@ describe Github::Issues do
         }.to raise_error(Github::Error::NotFound)
       end
     end
-  end # edit_issue
+  end # edit
 
 end # Github::Issues

data/spec/github/orgs_spec.rb

@@ -10,10 +10,8 @@ describe Github::Orgs do
 
   after { reset_authentication_for github }
 
-  context 'access to apis' do
-    it { subject.members.should be_a Github::Orgs::Members }
-    it { subject.teams.should be_a Github::Orgs::Teams }
-  end
+  its(:members) { should be_a Github::Orgs::Members }
+  its(:teams)   { should be_a Github::Orgs::Teams }
 
   describe "#list" do
     context "resource found for a user" do

data/spec/github/pull_requests_spec.rb

@@ -9,7 +9,7 @@ describe Github::PullRequests do
   after { reset_authentication_for github }
 
   describe "#list" do
-    it { github.pull_requests.should respond_to :all }
+    it { should respond_to :all }
 
     context 'resource found' do
       let(:inputs) { { 'state'=> 'closed', 'unrelated' => true } }

data/spec/github/repos/branch_spec.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Repos, '#branch' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:request_path) { "/repos/#{user}/#{repo}/branches/#{branch}" }
+  let(:branch) { 'master' }
+
+  after { reset_authentication_for subject }
+
+  before {
+    stub_get(request_path).to_return(:body => body, :status => status,
+      :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  context "resource found" do
+    let(:body)   { fixture('repos/branch.json') }
+    let(:status) { 200 }
+
+    it "should find resources" do
+      subject.branch user, repo, branch
+      a_get(request_path).should have_been_made
+    end
+
+    it "should return repository mash" do
+      repo_branch = subject.branch user, repo, branch
+      repo_branch.should be_a Hashie::Mash
+    end
+
+    it "should get repository branch information" do
+      repo_branch = subject.branch user, repo, branch
+      repo_branch.name.should == 'master'
+    end
+  end
+
+  context "resource not found" do
+    let(:body)   { '' }
+    let(:status) { 404 }
+
+    it "should fail to get resource" do
+      expect {
+        subject.branch user, repo, branch
+      }.to raise_error(Github::Error::NotFound)
+    end
+  end
+end # branch

data/spec/github/repos/branches_spec.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Repos, '#branches' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:request_path) { "/repos/#{user}/#{repo}/branches" }
+
+  after { reset_authentication_for subject }
+
+  before {
+    stub_get(request_path).to_return(:body => body, :status => status,
+      :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  context "resource found" do
+    let(:body)   { fixture('repos/branches.json') }
+    let(:status) { 200 }
+
+    it "should raise error when no user/repo parameters" do
+      expect { subject.branches nil, repo }.to raise_error(ArgumentError)
+    end
+
+    it "should raise error when no repository" do
+      expect { subject.branches user, nil }.to raise_error(ArgumentError)
+    end
+
+    it "should find resources" do
+      subject.branches user, repo
+      a_get(request_path).should have_been_made
+    end
+
+    it "should return array of resources" do
+      branches = subject.branches user, repo
+      branches.should be_an Array
+      branches.should have(1).items
+    end
+
+    it "should get branch information" do
+      branches = subject.branches user, repo
+      branches.first.name.should == 'master'
+    end
+
+    it "should yield to a block" do
+      block = lambda { |el| repo }
+      subject.should_receive(:branches).with(user, repo).and_yield repo
+      subject.branches(user, repo, &block)
+    end
+  end
+
+  context "resource not found" do
+    let(:body)   { '' }
+    let(:status) { 404 }
+
+    it "should fail to get resource" do
+      expect {
+        subject.branches user, repo
+      }.to raise_error(Github::Error::NotFound)
+    end
+  end
+end # branches