github_api 0.4.11 → 0.5.0.rc1

data/lib/github_api/repos/pub_sub_hubbub.rb

@@ -1,102 +1,114 @@
 # encoding: utf-8
 
 module Github
-  class Repos
-    module PubSubHubbub
+  class Repos::PubSubHubbub < API
 
-      # Subscribe to existing topic through pubsubhubbub
-      #
-      # = Parameters
-      # * topic - Required string - The URI of the GitHub repository to subscribe to. The path must be in the format of /:user/:repo/events/:event.
-      # * callback - Required string - The URI to receive the updates to the topic.
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.subscribe 'https://github.com/:user/:repo/events/push',
-      #    'github://Email?address=peter-murach@gmail.com',
-      #    :verify => 'sync',
-      #    :secret => '...'
-      #
-      def subscribe(topic, callback, params={})
-        _validate_presence_of topic, callback
-        _normalize_params_keys(params)
-        _merge_action!("subscribe", topic, callback, params)
+    # Subscribe to existing topic/event through pubsubhubbub
+    #
+    # = Parameters
+    # * topic - Required string - The URI of the GitHub repository to subscribe to. The path must be in the format of /:user/:repo/events/:event.
+    # * callback - Required string - The URI to receive the updates to the topic.
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.repos.pubsubhubbub.subscribe
+    #    'https://github.com/:user/:repo/events/push',
+    #    'github://Email?address=peter-murach@gmail.com',
+    #    :verify => 'sync',
+    #    :secret => '...'
+    #
+    def subscribe(topic, callback, params={})
+      _validate_presence_of topic, callback
+      _normalize_params_keys(params)
+      _merge_action!("subscribe", topic, callback, params)
 
-        post("/hub", params)
-      end
+      post_request("/hub", params)
+    end
 
-      # Unsubscribe from existing topic though pubsubhubbub
-      #
-      #
-      def unsubscribe(topic, callback, params={})
-        _validate_presence_of topic, callback
-        _normalize_params_keys(params)
-        _merge_action!("unsubscribe", topic, callback, params)
+    # Unsubscribe from existing topic/event through pubsubhubbub
+    #
+    # = Parameters
+    # * topic - Required string - The URI of the GitHub repository to unsubscribe from. The path must be in the format of /:user/:repo/events/:event.
+    # * callback - Required string - The URI to unsubscribe the topic from.
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.repos.pubsubhubbub.unsubscribe
+    #    'https://github.com/:user/:repo/events/push',
+    #    'github://Email?address=peter-murach@gmail.com',
+    #    :verify => 'sync',
+    #    :secret => '...'
+    #
+    def unsubscribe(topic, callback, params={})
+      _validate_presence_of topic, callback
+      _normalize_params_keys(params)
+      _merge_action!("unsubscribe", topic, callback, params)
 
-        post("/hub", params)
-      end
+      post_request("/hub", params)
+    end
 
-      # Subscribe repository to service hook through pubsubhubbub
-      #
-      # = Parameters
-      # * repo-name - Required string,
-      # * service-name - Required string
-      # * <tt>:event</tt> - Required hash key for the type of event. The default event is <tt>push</tt>
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.repos.subscribe_service 'user-name', 'repo-name', 'campfire',
-      #    :subdomain => 'github',
-      #    :room => 'Commits',
-      #    :token => 'abc123',
-      #    :event => 'watch'
-      #
-      def subscribe_service(user_name, repo_name, service_name, params={})
-        _validate_presence_of user_name, repo_name, service_name
-        _normalize_params_keys(params)
-        event = params.delete('event') || 'push'
-        topic = "https://github.com/#{user_name}/#{repo_name}/events/#{event}"
-        callback = "github://#{service_name}?#{params.serialize}"
+    # Subscribe repository to service hook through pubsubhubbub
+    #
+    # = Parameters
+    # * repo-name - Required string,
+    # * service-name - Required string
+    # * <tt>:event</tt> - Required hash key for the type of event. The default event is <tt>push</tt>
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.repos.pubsubhubbub.subscribe_service 'user-name', 'repo-name', 'campfire',
+    #    :subdomain => 'github',
+    #    :room => 'Commits',
+    #    :token => 'abc123',
+    #    :event => 'watch'
+    #
+    def subscribe_service(user_name, repo_name, service_name, params={})
+      _validate_presence_of user_name, repo_name, service_name
+      _normalize_params_keys(params)
+      event = params.delete('event') || 'push'
+      topic = "https://github.com/#{user_name}/#{repo_name}/events/#{event}"
+      callback = "github://#{service_name}?#{params.serialize}"
 
-        subscribe(topic, callback)
-      end
-      alias :subscribe_repository :subscribe_service
+      subscribe(topic, callback)
+    end
+    alias :subscribe_repository :subscribe_service
+    alias :subscribe_repo :subscribe_service
 
-      # Subscribe repository to service hook through pubsubhubbub
-      #
-      # = Parameters
-      # * repo-name - Required string,
-      # * service-name - Required string
-      # * <tt>:event</tt> - Optional hash key for the type of event. The default event is <tt>push</tt>
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.repos.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
-        _normalize_params_keys(params)
-        event = params.delete('event') || 'push'
-        topic = "https://github.com/#{user_name}/#{repo_name}/events/#{event}"
-        callback = "github://#{service_name}"
+    # Subscribe repository to service hook through pubsubhubbub
+    #
+    # = Parameters
+    # * repo-name - Required string,
+    # * service-name - Required string
+    # * <tt>:event</tt> - Optional hash key for the type of event. The default event is <tt>push</tt>
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  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
+      _normalize_params_keys(params)
+      event = params.delete('event') || 'push'
+      topic = "https://github.com/#{user_name}/#{repo_name}/events/#{event}"
+      callback = "github://#{service_name}"
 
-        unsubscribe(topic, callback)
-      end
-      alias :unsubscribe_repository :unsubscribe_service
+      unsubscribe(topic, callback)
+    end
+    alias :unsubscribe_repository :unsubscribe_service
+    alias :unsubscribe_repo :unsubscribe_service
 
-    private
+  private
 
-      def _merge_action!(action, topic, callback, params) # :nodoc:
-        options = {
-          "hub.mode"     => action.to_s,
-          "hub.topic"    => topic.to_s,
-          "hub.callback" => callback,
-          "hub.verify"   => params.delete('verify') || 'sync',
-          "hub.secret"   => params.delete('secret') || ''
-        }
-        params.merge! options
-      end
+    def _merge_action!(action, topic, callback, params) # :nodoc:
+      options = {
+        "hub.mode"     => action.to_s,
+        "hub.topic"    => topic.to_s,
+        "hub.callback" => callback,
+        "hub.verify"   => params.delete('verify') || 'sync',
+        "hub.secret"   => params.delete('secret') || ''
+      }
+      params.merge! options
+    end
 
-    end # PubSubHubbub
-  end # Repos
+  end # Repos::PubSubHubbub
 end # Github

data/lib/github_api/repos/watching.rb

@@ -1,95 +1,93 @@
 # encoding: utf-8
 
 module Github
-  class Repos
-    module Watching
+  class Repos::Watching < API
 
-      # List repo watchers
-      #
-      # = Examples
-      #  @github = Github.new :user => 'user-name', :repo => 'repo-name'
-      #  @github.repos.watchers
-      #  @github.repos.watchers { |watcher| ... }
-      #
-      def watchers(user_name, repo_name, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _normalize_params_keys(params)
+    # List repo watchers
+    #
+    # = Examples
+    #  github = Github.new :user => 'user-name', :repo => 'repo-name'
+    #  github.repos.watching.watchers
+    #  github.repos.watching.watchers { |watcher| ... }
+    #
+    def watchers(user_name, repo_name, 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}/watchers", params)
-        return response unless block_given?
-        response.each { |el| yield el }
-      end
+      response = get_request("/repos/#{user}/#{repo}/watchers", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
 
-      # List repos being watched by a user
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.repos.watched :user => 'user-name'
-      #
-      # List repos being watched by the authenticated user
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.repos.watched
-      #
-      def watched(*args)
-        params = args.last.is_a?(Hash) ? args.pop : {}
-        _normalize_params_keys(params)
-        _merge_user_into_params!(params) unless params.has_key?('user')
+    # List repos being watched by a user
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.watching.watched :user => 'user-name'
+    #
+    # List repos being watched by the authenticated user
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.repos.watching.watched
+    #
+    def watched(*args)
+      params = args.last.is_a?(Hash) ? args.pop : {}
+      _normalize_params_keys(params)
+      _merge_user_into_params!(params) unless params.has_key?('user')
 
-        response = if (user_name = params.delete('user'))
-          get("/users/#{user_name}/watched", params)
-        else
-          get("/user/watched", params)
-        end
-        return response unless block_given?
-        response.each { |el| yield el }
+      response = if (user_name = params.delete('user'))
+        get_request("/users/#{user_name}/watched", params)
+      else
+        get_request("/user/watched", params)
       end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
 
-      # Check if you are watching a repository
-      #
-      # Returns <tt>true</tt> if this repo is watched by you, <tt>false</tt> otherwise
-      # = Examples
-      #  @github = Github.new
-      #  @github.repos.watching? 'user-name', 'repo-name'
-      #
-      def watching?(user_name, repo_name, params={})
-        _validate_presence_of user_name, repo_name
-        _normalize_params_keys(params)
-        get("/user/watched/#{user_name}/#{repo_name}", params)
-        true
-      rescue Github::Error::NotFound
-        false
-      end
+    # Check if you are watching a repository
+    #
+    # Returns <tt>true</tt> if this repo is watched by you, <tt>false</tt> otherwise
+    # = Examples
+    #  github = Github.new
+    #  github.repos.watching.watching? 'user-name', 'repo-name'
+    #
+    def watching?(user_name, repo_name, params={})
+      _validate_presence_of user_name, repo_name
+      _normalize_params_keys(params)
+      get_request("/user/watched/#{user_name}/#{repo_name}", params)
+      true
+    rescue Github::Error::NotFound
+      false
+    end
 
-      # Watch a repository
-      #
-      # You need to be authenticated to watch a repository
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.repos.start_watching 'user-name', 'repo-name'
-      #
-      def start_watching(user_name, repo_name, params={})
-        _validate_presence_of user_name, repo_name
-        _normalize_params_keys(params)
-        put("/user/watched/#{user_name}/#{repo_name}", params)
-      end
+    # Watch a repository
+    #
+    # You need to be authenticated to watch a repository
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.watching.start_watching 'user-name', 'repo-name'
+    #
+    def start_watching(user_name, repo_name, params={})
+      _validate_presence_of user_name, repo_name
+      _normalize_params_keys(params)
+      put_request("/user/watched/#{user_name}/#{repo_name}", params)
+    end
 
-      # Stop watching a repository
-      #
-      # You need to be authenticated to stop watching a repository.
-      # = Examples
-      #  @github = Github.new
-      #  @github.repos.start_watching 'user-name', 'repo-name'
-      #
-      def stop_watching(user_name, repo_name, params={})
-        _validate_presence_of user_name, repo_name
-        _normalize_params_keys(params)
-        delete("/user/watched/#{user_name}/#{repo_name}", params)
-      end
+    # Stop watching a repository
+    #
+    # You need to be authenticated to stop watching a repository.
+    # = Examples
+    #  github = Github.new
+    #  github.repos.watching.start_watching 'user-name', 'repo-name'
+    #
+    def stop_watching(user_name, repo_name, params={})
+      _validate_presence_of user_name, repo_name
+      _normalize_params_keys(params)
+      delete_request("/user/watched/#{user_name}/#{repo_name}", params)
+    end
 
-    end # Watching
-  end # Repos
+  end # Repos::Watching
 end # Github

data/lib/github_api/request.rb

@@ -11,27 +11,23 @@ module Github
     METHODS = [:get, :post, :put, :delete, :patch]
     METHODS_WITH_BODIES = [ :post, :put, :patch ]
 
-    TOKEN_REQUIRED_REGEXP = [
-      /repos\/.*\/.*\/comments/,
-    ]
-
-    def get(path, params={}, options={})
+    def get_request(path, params={}, options={})
       request(:get, path, params, options)
     end
 
-    def patch(path, params={}, options={})
+    def patch_request(path, params={}, options={})
       request(:patch, path, params, options)
     end
 
-    def post(path, params={}, options={})
+    def post_request(path, params={}, options={})
       request(:post, path, params, options)
     end
 
-    def put(path, params={}, options={})
+    def put_request(path, params={}, options={})
       request(:put, path, params, options)
     end
 
-    def delete(path, params={}, options={})
+    def delete_request(path, params={}, options={})
       request(:delete, path, params, options)
     end
 

data/lib/github_api/users.rb

@@ -10,10 +10,6 @@ module Github
       :Followers => 'followers',
       :Keys      => 'keys'
 
-    include Github::Users::Emails
-    include Github::Users::Followers
-    include Github::Users::Keys
-
     VALID_USER_PARAMS_NAMES = %w[
       name
       email
@@ -29,27 +25,42 @@ module Github
       super(options)
     end
 
+    # Access to Users::Emails API
+    def emails
+      @emails ||= ApiFactory.new 'Users::Emails'
+    end
+
+    # Access to Users::Followers API
+    def followers
+      @followers ||= ApiFactory.new 'Users::Followers'
+    end
+
+    # Access to Users::Keys API
+    def keys
+      @keys ||= ApiFactory.new 'Users::Keys'
+    end
+
     # Get a single unauthenticated user
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.users.get_user 'user-name'
+    #  github = Github.new
+    #  github.users.get 'user-name'
     #
     # Get the authenticated user
     #
     # = Examples
     #  @github = Github.new :oauth_token => '...'
-    #  @github.users.get_user
+    #  @github.users.get
     #
-    def get_user(user_name=nil, params={})
+    def get(user_name=nil, params={})
       _normalize_params_keys(params)
       if user_name
-        get("/users/#{user_name}", params)
+        get_request("/users/#{user_name}", params)
       else
-        get("/user", params)
+        get_request("/user", params)
       end
     end
-    alias :get_auth_user :get_user
+    alias :find :get
 
     # Update the authenticated user
     #
@@ -63,8 +74,8 @@ module Github
     # * <tt>:bio</tt> - Optional string
     #
     # = Examples
-    #  @github = Github.new :oauth_token => '..'
-    #  @github.users.update_user
+    #  github = Github.new :oauth_token => '..'
+    #  github.users.update
     #    "name" => "monalisa octocat",
     #    "email" => "octocat@github.com",
     #    "blog" => "https://github.com/blog",
@@ -73,12 +84,11 @@ module Github
     #    "hireable" => true,
     #    "bio" => "There once..."
     #
-    def update_user(params={})
+    def update(params={})
       _normalize_params_keys(params)
       _filter_params_keys(VALID_USER_PARAMS_NAMES, params)
-      patch("/user", params)
+      patch_request("/user", params)
     end
-    alias :update_authenticated_user :update_user
 
   end # Users
 end # Github