github_api 0.3.1 → 0.3.2

data/README.rdoc

@@ -12,7 +12,7 @@ Grab the gem by issuing
 
 or in your Gemfile
 
-  gem "github_api", "~> 0.3.0"
+  gem "github_api", "~> 0.3.2"
 
 == Usage
 
@@ -67,6 +67,7 @@ Main API methods are grouped into the following classes that can be instantiated
   Github::PullRequests
   Github::Repos
   Github::Users
+  Github::Events
   Github::Authorizations
 
 Some parts of GitHub API v3 require you to be autheticated, for instance the following are examples of APIs only for the authenticated user

data/lib/github_api.rb

@@ -23,7 +23,7 @@ module Github
     end
 
     def respond_to?(method, include_private = false)
-      new.respond_to?(method, include_private) || super(method, include_private) 
+      new.respond_to?(method, include_private) || super(method, include_private)
     end
   end
 
@@ -51,6 +51,7 @@ module Github
     :Orgs         => 'orgs',
     :PullRequests => 'pull_requests',
     :Users        => 'users',
+    :Events       => 'events',
     :CoreExt      => 'core_ext',
     :MimeType     => 'mime_type',
     :Authorization => 'authorization',

data/lib/github_api/client.rb

@@ -39,6 +39,12 @@ module Github
       @users ||= _create_instance Github::Users, options
     end
 
+    # This is a read-only API to the GitHub events.
+    # These events power the various activity streams on the site.
+    def events(options = {})
+      @events ||= _create_instance Github::Events, options
+    end
+
     # An API for users to manage their own tokens. You can only access your own
     # tokens, and only through Basic Authentication.
     def oauth(options = {})

data/lib/github_api/events.rb

@@ -0,0 +1,202 @@
+# encoding: utf-8
+
+module Github
+  class Events < API
+
+    # Creates new Gists API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # List all public events
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.events.public
+    #  @github.events.public { |event| ... }
+    #
+    def public(params={})
+      _normalize_params_keys(params)
+
+      response = get("/events", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :public_events :public
+    alias :list_public :public
+    alias :list_public_events :public
+
+    # List all repository events for a given user
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.events.repository_events 'user-name', 'repo-name'
+    #  @github.events.repository_events 'user-name', 'repo-name' { |event| ... }
+    #
+    def repository(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}/events", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :repos :repository
+    alias :repo_events :repository
+    alias :repository_events :repository
+    alias :list_repository_events :repository
+
+    # List all issue events for a given repository
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.events.issue 'user-name', 'repo-name'
+    #  @github.events.issue 'user-name', 'repo-name' { |event| ... }
+    #
+    def issue(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}/issues/events", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :issues :issue
+    alias :issue_events :issue
+    alias :list_issue_events :issue
+
+    # List all public events for a network of repositories
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.events.network 'user-name', 'repo-name'
+    #  @github.events.network 'user-name', 'repo-name' { |event| ... }
+    #
+    def network(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("/networks/#{user}/#{repo}/events", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :repo_network :network
+    alias :repository_network :network
+    alias :list_repo_network_events :network
+    alias :list_repository_network_events :network
+
+    # List all public events for an organization
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.events.org 'org-name'
+    #  @github.events.org 'org-name' { |event| ... }
+    #
+    def org(org_name, params={})
+      _validate_presence_of org_name
+      _normalize_params_keys(params)
+
+      response = get("/orgs/#{org_name}/events", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :organization :org
+    alias :list_orgs :org
+    alias :list_org_events :org
+    alias :list_organization_events :org
+
+    # List all events that a user has received
+    #
+    # These are events that you’ve received by watching repos and following users.
+    # If you are authenticated as the given user, you will see private events. 
+    # Otherwise, you’ll only see public events.
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.events.received 'user-name'
+    #  @github.events.received 'user-name' { |event| ... }
+    #
+    # List all public events that a user has received
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.events.received 'user-name', :public => true
+    #  @github.events.received 'user-name', :public => true { |event| ... }
+    #
+    def received(user_name, params={})
+      _validate_presence_of user_name
+      _normalize_params_keys(params)
+
+      public_events = if params['public']
+        params.delete('public')
+        '/public'
+      end
+
+      response = get("/users/#{user_name}/received_events#{public_events}", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :user_received :received
+    alias :list_user_received :received
+
+    # List all events that a user has performed
+    #
+    # If you are authenticated as the given user, you will see your private
+    # events. Otherwise, you’ll only see public events.
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.events.performed 'user-name'
+    #  @github.events.performed 'user-name' { |event| ... }
+    #
+    # List all public events that a user has performed
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.events.performed 'user-name', :public => true
+    #  @github.events.performed 'user-name', :public => true { |event| ... }
+    #
+    def performed(user_name, params={})
+      _validate_presence_of user_name
+      _normalize_params_keys(params)
+
+      public_events = if params['public']
+        params.delete('public')
+        '/public'
+      end
+
+      response = get("/users/#{user_name}/events#{public_events}", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :user_performed :performed
+    alias :list_user_performed :performed
+
+    # List all events for an organization
+    #
+    # This is the user’s organization dashboard. You must be authenticated
+    # as the user to view this.
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.events.user_org 'user-name', 'org-name'
+    #  @github.events.user_org 'user-name', 'org-name' { |event| ... }
+    #
+    def user_org(user_name, org_name, params={})
+      _validate_presence_of user_name, org_name
+      _normalize_params_keys(params)
+
+      response = get("/users/#{user_name}/events/orgs/#{org_name}", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :user_organization :user_org
+    alias :list_user_org :user_org
+    alias :list_user_org_events :user_org
+    alias :list_user_organization_events :user_org
+
+  end # Events
+end # Github

data/lib/github_api/gists.rb

@@ -43,6 +43,7 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
+    alias :list_gists :gists
 
     # List the authenticated user's starred gists
     #

data/lib/github_api/version.rb

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

data/spec/fixtures/events/events.json

@@ -0,0 +1,29 @@
+[
+  {
+    "type": "Event",
+    "public": true,
+    "payload": {
+
+    },
+    "repo": {
+      "id": 3,
+      "name": "octocat/Hello-World",
+      "url": "https://api.github.com/repos/octocat/Hello-World"
+    },
+    "actor": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "gravatar_id": "somehexcode",
+      "url": "https://api.github.com/users/octocat"
+    },
+    "org": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "gravatar_id": "somehexcode",
+      "url": "https://api.github.com/users/octocat"
+    },
+    "created_at": "2011-09-06T17:26:27Z"
+  }
+]

data/spec/github/events_spec.rb

@@ -0,0 +1,491 @@
+require 'spec_helper'
+
+describe Github::Events do
+
+  let(:github) { Github.new }
+  let(:user)   { 'peter-murach' }
+  let(:repo)   { 'github' }
+
+  describe "public" do
+    context "resource found" do
+      before do
+        stub_get("/events").
+          to_return(:body => fixture('events/events.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should get the resources" do
+        github.events.public
+        a_get("/events").should have_been_made
+      end
+
+      it "should return array of resources" do
+        events = github.events.public
+        events.should be_an Array
+        events.should have(1).items
+      end
+
+      it "should be a mash type" do
+        events = github.events.public
+        events.first.should be_a Hashie::Mash
+      end
+
+      it "should get event information" do
+        events = github.events.public
+        events.first.type.should == 'Event'
+      end
+
+      it "should yield to a block" do
+        github.events.should_receive(:public).and_yield('web')
+        github.events.public { |param| 'web' }
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/events").to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.events.public
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # public_events
+
+  describe "repository" do
+    context "resource found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/events").
+          to_return(:body => fixture('events/events.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      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
+
+      it "should get the resources" do
+        github.events.repository user, repo
+        a_get("/repos/#{user}/#{repo}/events").should have_been_made
+      end
+
+      it "should return array of resources" do
+        events = github.events.repository user, repo
+        events.should be_an Array
+        events.should have(1).items
+      end
+
+      it "should be a mash type" do
+        events = github.events.repository user, repo
+        events.first.should be_a Hashie::Mash
+      end
+
+      it "should get event information" do
+        events = github.events.repository user, repo
+        events.first.type.should == 'Event'
+      end
+
+      it "should yield to a block" do
+        github.events.should_receive(:repository).with(user, repo).and_yield('web')
+        github.events.repository(user, repo) { |param| 'web' }
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/events").
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.events.repository user, repo
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # repository
+
+  describe "issue" do
+    context "resource found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/issues/events").
+          to_return(:body => fixture('events/events.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      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
+
+      it "should get the resources" do
+        github.events.issue user, repo
+        a_get("/repos/#{user}/#{repo}/issues/events").should have_been_made
+      end
+
+      it "should return array of resources" do
+        events = github.events.issue user, repo
+        events.should be_an Array
+        events.should have(1).items
+      end
+
+      it "should be a mash type" do
+        events = github.events.issue user, repo
+        events.first.should be_a Hashie::Mash
+      end
+
+      it "should get event information" do
+        events = github.events.issue user, repo
+        events.first.type.should == 'Event'
+      end
+
+      it "should yield to a block" do
+        github.events.should_receive(:issue).with(user, repo).and_yield('web')
+        github.events.issue(user, repo) { |param| 'web' }
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/repos/#{user}/#{repo}/issues/events").
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.events.issue user, repo
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # repository
+
+  describe "network" do
+    context "resource found" do
+      before do
+        stub_get("/networks/#{user}/#{repo}/events").
+          to_return(:body => fixture('events/events.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      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
+
+      it "should get the resources" do
+        github.events.network user, repo
+        a_get("/networks/#{user}/#{repo}/events").should have_been_made
+      end
+
+      it "should return array of resources" do
+        events = github.events.network user, repo
+        events.should be_an Array
+        events.should have(1).items
+      end
+
+      it "should be a mash type" do
+        events = github.events.network user, repo
+        events.first.should be_a Hashie::Mash
+      end
+
+      it "should get event information" do
+        events = github.events.network user, repo
+        events.first.type.should == 'Event'
+      end
+
+      it "should yield to a block" do
+        github.events.should_receive(:network).with(user, repo).and_yield('web')
+        github.events.network(user, repo) { |param| 'web' }
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/networks/#{user}/#{repo}/events").
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.events.network user, repo
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # network
+
+  describe "org" do
+    let(:org) { 'github' }
+    context "resource found" do
+      before do
+        stub_get("/orgs/#{org}/events").
+          to_return(:body => fixture('events/events.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to get resource without orgname" do
+        expect { github.events.org nil }.to raise_error(ArgumentError)
+      end
+
+      it "should get the resources" do
+        github.events.org org
+        a_get("/orgs/#{org}/events").should have_been_made
+      end
+
+      it "should return array of resources" do
+        events = github.events.org org
+        events.should be_an Array
+        events.should have(1).items
+      end
+
+      it "should be a mash type" do
+        events = github.events.org org
+        events.first.should be_a Hashie::Mash
+      end
+
+      it "should get event information" do
+        events = github.events.org org
+        events.first.type.should == 'Event'
+      end
+
+      it "should yield to a block" do
+        github.events.should_receive(:org).with(org).and_yield('web')
+        github.events.org(org) { |param| 'web' }
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/orgs/#{org}/events").
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.events.org org
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # org
+
+  describe "received" do
+    context "resource found" do
+      before do
+        stub_get("/users/#{user}/received_events").
+          to_return(:body => fixture('events/events.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to get resource without username" do
+        expect { github.events.received nil }.to raise_error(ArgumentError)
+      end
+
+      it "should get the resources" do
+        github.events.received user
+        a_get("/users/#{user}/received_events").should have_been_made
+      end
+
+      it "should return array of resources" do
+        events = github.events.received user
+        events.should be_an Array
+        events.should have(1).items
+      end
+
+      it "should be a mash type" do
+        events = github.events.received user
+        events.first.should be_a Hashie::Mash
+      end
+
+      it "should get event information" do
+        events = github.events.received user
+        events.first.type.should == 'Event'
+      end
+
+      it "should yield to a block" do
+        github.events.should_receive(:received).with(user).and_yield('web')
+        github.events.received(user) { |param| 'web' }
+      end
+    end
+
+    context "all public resources found" do
+      before do
+        stub_get("/users/#{user}/received_events/public").
+          to_return(:body => fixture('events/events.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should get the resources" do
+        github.events.received user, :public => true
+        a_get("/users/#{user}/received_events/public").should have_been_made
+      end
+
+      it "should return array of resources" do
+        events = github.events.received user, :public => true
+        events.should be_an Array
+        events.should have(1).items
+      end
+
+      it "should be a mash type" do
+        events = github.events.received user, :public => true
+        events.first.should be_a Hashie::Mash
+      end
+
+      it "should get event information" do
+        events = github.events.received user, :public => true
+        events.first.type.should == 'Event'
+      end
+
+      it "should yield to a block" do
+        github.events.should_receive(:received).with(user).and_yield('web')
+        github.events.received(user) { |param| 'web' }
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/users/#{user}/received_events").
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.events.received user
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # received
+
+  describe "performed" do
+    context "resource found" do
+      before do
+        stub_get("/users/#{user}/events").
+          to_return(:body => fixture('events/events.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to get resource without username" do
+        expect { github.events.performed nil }.to raise_error(ArgumentError)
+      end
+
+      it "should get the resources" do
+        github.events.performed user
+        a_get("/users/#{user}/events").should have_been_made
+      end
+
+      it "should return array of resources" do
+        events = github.events.performed user
+        events.should be_an Array
+        events.should have(1).items
+      end
+
+      it "should be a mash type" do
+        events = github.events.performed user
+        events.first.should be_a Hashie::Mash
+      end
+
+      it "should get event information" do
+        events = github.events.performed user
+        events.first.type.should == 'Event'
+      end
+
+      it "should yield to a block" do
+        github.events.should_receive(:performed).with(user).and_yield('web')
+        github.events.performed(user) { |param| 'web' }
+      end
+    end
+
+    context "all public resources found" do
+      before do
+        stub_get("/users/#{user}/events/public").
+          to_return(:body => fixture('events/events.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should get the resources" do
+        github.events.performed user, :public => true
+        a_get("/users/#{user}/events/public").should have_been_made
+      end
+
+      it "should return array of resources" do
+        events = github.events.performed user, :public => true
+        events.should be_an Array
+        events.should have(1).items
+      end
+
+      it "should be a mash type" do
+        events = github.events.performed user, :public => true
+        events.first.should be_a Hashie::Mash
+      end
+
+      it "should get event information" do
+        events = github.events.performed user, :public => true
+        events.first.type.should == 'Event'
+      end
+
+      it "should yield to a block" do
+        github.events.should_receive(:performed).with(user).and_yield('web')
+        github.events.performed(user) { |param| 'web' }
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/users/#{user}/events").
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.events.performed user
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # performed
+
+  describe "user_org" do
+    let(:org) { 'github' }
+    context "resource found" do
+      before do
+        stub_get("/users/#{user}/events/orgs/#{org}").
+          to_return(:body => fixture('events/events.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to get resource without orgname" do
+        expect { github.events.user_org user, nil }.to raise_error(ArgumentError)
+      end
+
+      it "should get the resources" do
+        github.events.user_org user, org
+        a_get("/users/#{user}/events/orgs/#{org}").should have_been_made
+      end
+
+      it "should return array of resources" do
+        events = github.events.user_org user, org
+        events.should be_an Array
+        events.should have(1).items
+      end
+
+      it "should be a mash type" do
+        events = github.events.user_org user, org
+        events.first.should be_a Hashie::Mash
+      end
+
+      it "should get event information" do
+        events = github.events.user_org user, org
+        events.first.type.should == 'Event'
+      end
+
+      it "should yield to a block" do
+        github.events.should_receive(:user_org).with(user, org).and_yield('web')
+        github.events.user_org(user, org) { |param| 'web' }
+      end
+    end
+
+    context "resource not found" do
+      before do
+        stub_get("/users/#{user}/events/orgs/#{org}").
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.events.user_org user, org
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # user_org
+
+end # Github::Events

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Piotr Murach
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-27 00:00:00 +00:00
+date: 2011-12-03 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -205,6 +205,7 @@ files:
 - lib/github_api/core_ext/array.rb
 - lib/github_api/core_ext/hash.rb
 - lib/github_api/error.rb
+- lib/github_api/events.rb
 - lib/github_api/gists/comments.rb
 - lib/github_api/gists.rb
 - lib/github_api/git_data/blobs.rb
@@ -249,6 +250,7 @@ files:
 - lib/github_api.rb
 - spec/fixtures/auths/authorization.json
 - spec/fixtures/auths/authorizations.json
+- spec/fixtures/events/events.json
 - spec/fixtures/orgs/members.json
 - spec/fixtures/orgs/org.json
 - spec/fixtures/orgs/orgs.json
@@ -284,6 +286,7 @@ files:
 - spec/github/authorizations_spec.rb
 - spec/github/client_spec.rb
 - spec/github/core_ext/hash_spec.rb
+- spec/github/events_spec.rb
 - spec/github/gists/comments_spec.rb
 - spec/github/gists_spec.rb
 - spec/github/git_data/blobs_spec.rb