github_api 0.7.2 → 0.8.0

data/README.md

@@ -16,11 +16,12 @@ Supports all the API methods(nearly 200). It's build in a modular way, that is,
 * Intuitive GitHub API interface navigation.
 * Modular design allows for working with parts of API.
 * Fully customizable including advanced middleware stack construction.
+* Its comprehensive, you can request all GitHub API resources.
 * Requests pagination.
 * Easy error handling.
-* Custom Mime Types specification (TODO)
-* Flexible arguments parsing (In progress).
-* Full tested with test coverage above 90%.
+* Custom mime types specification (Status: TODO)
+* Flexible arguments parsing (Status: In progress).
+* Fully tested with test coverage above 90% with over 1,200 specs and 500 features.
 
 ## Installation
 
@@ -160,7 +161,7 @@ Github         - full API access
 
 Github::Gists           Github::GitData    Github::Repos             Github::Search
 Github::Orgs            Github::Issues     Github::Authorizations
-Github::PullRequests    Github::Users      Github::Events
+Github::PullRequests    Github::Users      Github::Activity
 ```
 
 Some parts of GitHub API v3 require you to be autheticated, for instance the following are examples of APIs only for the authenticated user
@@ -367,7 +368,7 @@ users.emails.add 'email1', 'email2', ..., 'emailn' # => Adds emails to the authe
 If a method returns a collection, you can iterator over it by supplying a block parameter,
 
 ```ruby
-events = Github::Events.new
+events = Github::Activity::Events.new
 events.public do |event|
   puts event.actor.login
 end

data/features/{events.feature → activity/events.feature}

@@ -1,12 +1,12 @@
 Feature: Events API
 
   Background:
-    Given I have "Github::Events" instance
+    Given I have "Github::Activity::Events" instance
 
   Scenario: Public
 
     Given I want public resources
-    When I make request within a cassette named "events/public"
+    When I make request within a cassette named "activity/events/public"
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
@@ -16,7 +16,7 @@ Feature: Events API
     Given I want repository resources with the following params:
       | user   | repo |
       | wycats | thor |
-    When I make request within a cassette named "events/repo"
+    When I make request within a cassette named "activity/events/repo"
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
@@ -26,7 +26,7 @@ Feature: Events API
     Given I want issue resources with the following params:
       | user   | repo |
       | wycats | thor |
-    When I make request within a cassette named "events/issue"
+    When I make request within a cassette named "activity/events/issue"
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
@@ -36,7 +36,7 @@ Feature: Events API
     Given I want network resources with the following params:
       | user   | repo |
       | wycats | thor |
-    When I make request within a cassette named "events/network"
+    When I make request within a cassette named "activity/events/network"
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
@@ -46,7 +46,7 @@ Feature: Events API
     Given I want org resources with the following params:
       | org   |
       | rails |
-    When I make request within a cassette named "events/org"
+    When I make request within a cassette named "activity/events/org"
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
@@ -56,7 +56,7 @@ Feature: Events API
     Given I want received resources with the following params:
       | user      |
       | josevalim |
-    When I make request within a cassette named "events/received"
+    When I make request within a cassette named "activity/events/received"
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
@@ -66,7 +66,7 @@ Feature: Events API
     Given I want performed resources with the following params:
       | user      |
       | josevalim |
-    When I make request within a cassette named "events/performed"
+    When I make request within a cassette named "activity/events/performed"
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty

data/features/{repos → activity}/starring.feature

@@ -1,14 +1,14 @@
 Feature: Starring API
 
   Background:
-    Given I have "Github::Repos::Starring" instance
+    Given I have "Github::Activity::Starring" instance
 
   Scenario: List
 
     Given I want to list resources with the following params:
       | user         | repo   |
       | peter-murach | github |
-    When I make request within a cassette named "repos/starring/list"
+    When I make request within a cassette named "activity/starring/list"
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
@@ -19,7 +19,7 @@ Feature: Starring API
       And I pass the following request options:
       | user   |
       | wycats |
-    When I make request within a cassette named "repos/starring/starred"
+    When I make request within a cassette named "activity/starring/starred"
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
@@ -29,7 +29,7 @@ Feature: Starring API
     Given I want to starring? resource with the following params:
       | user         | repo   |
       | peter-murach | github |
-    When I make request within a cassette named "repos/starring/starring"
+    When I make request within a cassette named "activity/starring/starring"
     Then the response should be false
 
   Scenario: Star
@@ -37,7 +37,7 @@ Feature: Starring API
     Given I want to star resource with the following params:
       | user         | repo   |
       | peter-murach | github |
-    When I make request within a cassette named "repos/starring/star"
+    When I make request within a cassette named "activity/starring/star"
     Then the response status should be 204
 
   Scenario: Unstar
@@ -45,6 +45,6 @@ Feature: Starring API
     Given I want to unstar resource with the following params:
       | user         | repo   |
       | peter-murach | github |
-    When I make request within a cassette named "repos/starring/unstar"
+    When I make request within a cassette named "activity/starring/unstar"
     Then the response status should be 204
 

data/features/{repos → activity}/watching.feature

@@ -1,14 +1,14 @@
 Feature: Watching API
 
   Background:
-    Given I have "Github::Repos::Watching" instance
+    Given I have "Github::Activity::Watching" instance
 
   Scenario: List
 
     Given I want to list resources with the following params:
       | user         | repo   |
       | peter-murach | github |
-    When I make request within a cassette named "repos/watching/list"
+    When I make request within a cassette named "activity/watching/list"
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
@@ -19,7 +19,7 @@ Feature: Watching API
       And I pass the following request options:
       | user   |
       | wycats |
-    When I make request within a cassette named "repos/watching/watched"
+    When I make request within a cassette named "activity/watching/watched"
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
@@ -29,7 +29,7 @@ Feature: Watching API
     Given I want to watching? resource with the following params:
       | user         | repo   |
       | peter-murach | github |
-    When I make request within a cassette named "repos/watching/watching"
+    When I make request within a cassette named "activity/watching/watching"
     Then the response should be false
 
   Scenario: Watch
@@ -37,7 +37,7 @@ Feature: Watching API
     Given I want to watch resource with the following params:
       | user         | repo   |
       | peter-murach | github |
-    When I make request within a cassette named "repos/watching/watch"
+    When I make request within a cassette named "activity/watching/watch"
     Then the response status should be 204
 
   Scenario: Unwatch
@@ -45,6 +45,6 @@ Feature: Watching API
     Given I want to unwatch resource with the following params:
       | user         | repo   |
       | peter-murach | github |
-    When I make request within a cassette named "repos/watching/unwatch"
+    When I make request within a cassette named "activity/watching/unwatch"
     Then the response status should be 204
 

data/features/github_api.feature

@@ -49,10 +49,10 @@ Feature: Github API components
     When  I fetch "users"
     Then  I will have access to "Github::Users" API
 
-  Scenario: Accessing users API
+  Scenario: Accessing activity API
     Given I have github instance
-    When  I fetch "events"
-    Then  I will have access to "Github::Events" API
+    When  I fetch "activity"
+    Then  I will have access to "Github::Activity" API
 
   Scenario: Accessing authorizations API
     Given I have github instance

data/lib/github_api.rb

@@ -60,6 +60,7 @@ module Github
 
   autoload_all 'github_api',
     :API             => 'api',
+    :Activity        => 'activity',
     :ApiFactory      => 'api_factory',
     :Client          => 'client',
     :Repos           => 'repos',
@@ -73,7 +74,6 @@ module Github
     :Orgs            => 'orgs',
     :PullRequests    => 'pull_requests',
     :Users           => 'users',
-    :Events          => 'events',
     :Emojis          => 'emojis',
     :Search          => 'search',
     :Markdown        => 'markdown',

data/lib/github_api/activity.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+module Github
+  class Activity < API
+    extend AutoloadHelper
+
+    autoload_all 'github_api/activity',
+      :Events        => 'events',
+      :Notifications => 'notifications',
+      :Starring      => 'starring',
+      :Watching      => 'watching'
+
+    # Create new Activity API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # Access to Activity::Events API
+    def events(options = {})
+      @events ||= ApiFactory.new 'Activity::Events', options
+    end
+
+    # Access to Activity::Notifications API
+    def notifications
+      @notifications ||= ApiFactory.new 'Activity::Notifications'
+    end
+
+    # Access to Activity::Starring API
+    def starring
+      @starring ||= ApiFactory.new 'Activity::Starring'
+    end
+
+    # Access to Activity::Watching API
+    def watching
+      @watching ||= ApiFactory.new 'Activity::Watching'
+    end
+
+  end # Activity
+end # Github

data/lib/github_api/{events.rb → activity/events.rb}

@@ -1,9 +1,9 @@
 # encoding: utf-8
 
 module Github
-  class Events < API
+  class Activity::Events < API
 
-    # Creates new Gists API
+    # Creates new Activity::Events API
     def initialize(options = {})
       super(options)
     end
@@ -12,8 +12,8 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.events.public
-    #  github.events.public { |event| ... }
+    #  github.activity.events.public
+    #  github.activity.events.public { |event| ... }
     #
     def public(params={})
       normalize! params
@@ -198,5 +198,5 @@ module Github
     alias :list_user_org_events :user_org
     alias :list_user_organization_events :user_org
 
-  end # Events
+  end # Activity::Events
 end # Github

data/lib/github_api/activity/notifications.rb

@@ -0,0 +1,162 @@
+# encoding: utf-8
+
+module Github
+  class Activity::Notifications < API
+
+    # Creates new Activity::Notifications API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # List your notifications
+    #
+    # List all notifications for the current user, grouped by repository.
+    #
+    # = Parameters
+    # * <tt>:all</tt> - Optional boolean - true to show notifications marked as read.
+    # * <tt>:participating</tt> - Optional boolean - true to show only
+    #                             notifications in which the user is directly
+    #                             participating or mentioned.
+    # * <tt>:since</tt> - Optional string - filters out any notifications updated
+    #                     before the given time. The time should be passed in as
+    #                     UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
+    #                     Example: “2012-10-09T23:39:01Z”.
+    #
+    # = Examples
+    #  github = Github.new oauth_token: 'token'
+    #  github.activity.notifications.list
+    #
+    # List your notifications in a repository
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.activity.notifications.list user: 'user-name', repo: 'repo-name'
+    #
+    def list(*args)
+      params = args.extract_options!
+      normalize! params
+      filter! %w[ all participating since user repo], params
+
+      response = if ( (user_name = params.delete("user")) &&
+                      (repo_name = params.delete("repo")) )
+        get_request("/repos/#{user_name}/#{repo_name}/notifications", params)
+      else
+        get_request("/notifications", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # View a single thread
+    #
+    # = Examples
+    #  github = Github.new oauth_token: 'token'
+    #  github.activity.notifications.get 'thread_id'
+    #  github.activity.notifications.get 'thread_id' { |thread| ... }
+    #
+    def get(thread_id, params={})
+      assert_presence_of thread_id
+      normalize! params
+      response = get_request("/notifications/threads/#{thread_id}", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :find :get
+
+    # Mark as read
+    #
+    # Marking a notification as “read” removes it from the default view on GitHub.com.
+    #
+    # = Parameters
+    #
+    # * <tt>:unread</tt> - boolean - Changes the unread status of the threads.
+    # * <tt>:read</tt> - boolean - Inverse of "unread"
+    # * <tt>:last_read_at</tt> - optional string time - describes the last point 
+    #                            that notifications were checked. Anything updated 
+    #                            since this time will not be updated. Default: Now.
+    #                            Expected in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
+    #                            Example: “2012-10-09T23:39:01Z”.
+    #
+    # = Examples
+    #  github = Github.new oauth_token: 'token'
+    #  github.activity.notifications.mark read: true
+    #
+    # Mark notifications as read in a repository
+    #
+    # = Examples
+    #  github.activity.notifications.mark user: 'user-name', repo: 'repo-name',
+    #    read: true
+    #
+    # Mark a thread as read
+    #
+    # = Examples
+    #  github.activity.notifications.mark thread_id: 'id', read: true
+    #
+    def mark(*args)
+      params = args.extract_options!
+      normalize! params
+      filter! %w[ unread read last_read_at user repo thread_id], params
+
+      if ( (user_name = params.delete("user")) &&
+           (repo_name = params.delete("repo")) )
+
+        put_request("/repos/#{user_name}/#{repo_name}/notifications", params)
+      elsif (thread_id = params.delete("thread_id"))
+        patch_request("/notifications/threads/#{thread_id}", params)
+      else
+        put_request("/notifications", params)
+      end
+    end
+
+    # Check to see if the current user is subscribed to a thread.
+    #
+    # = Examples
+    #  github = Github.new oauth_token: 'token'
+    #  github.activity.notifications.subscribed? 'thread-id'
+    #
+    def subscribed?(thread_id, params={})
+      assert_presence_of thread_id
+      normalize! params
+      get_request("/notifications/threads/#{thread_id}/subscription", params)
+    end
+
+    # Create a thread subscription
+    #
+    # This lets you subscribe to a thread, or ignore it. Subscribing to a thread
+    # is unnecessary if the user is already subscribed to the repository. Ignoring
+    # a thread will mute all future notifications (until you comment or get
+    # @mentioned).
+    #
+    # = Parameters
+    # * <tt>:subscribed</tt> - boolean - determines if notifications should be
+    #                          received from this thread.
+    # * <tt>:ignored</tt> - boolean - deterimines if all notifications should be
+    #                       blocked from this thread.
+    # = Examples
+    #  github = Github.new oauth_token: 'token'
+    #  github.activity.notifications.create 'thread-id',
+    #    'subscribed': true
+    #    'ignored': false
+    #
+    def create(thread_id, params={})
+      assert_presence_of thread_id
+      normalize! params
+      put_request("/notifications/threads/#{thread_id}/subscription", params)
+    end
+
+    # Delete a thread subscription
+    #
+    # = Examples
+    #  github = Github.new oauth_token: 'token'
+    #  github.activity.notifications.delete 'thread_id'
+    #
+    def delete(thread_id, params={})
+      assert_presence_of thread_id
+      normalize! params
+      delete_request("/notifications/threads/#{thread_id}/subscription", params)
+    end
+    alias :remove :delete
+
+  end # Activity::Notifications
+end # Github