github_api 0.4.11 → 0.5.0.rc1

data/lib/github_api/users/emails.rb

@@ -1,55 +1,55 @@
 # encoding: utf-8
 
 module Github
-  class Users
-    module Emails
+  class Users::Emails < API
 
-      # List email addresses for the authenticated user
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.users.emails
-      #  @github.users.emails { |email| ... }
-      #
-      def emails(params={})
-        _normalize_params_keys(params)
-        response = get("/user/emails", params)
-        return response unless block_given?
-        response.each { |el| yield el }
-      end
+    # List email addresses for the authenticated user
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.users.emails.list
+    #  github.users.emails.list { |email| ... }
+    #
+    def list(params={})
+      _normalize_params_keys(params)
+      response = get_request("/user/emails", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
 
-      # Add email address(es) for the authenticated user
-      #
-      # = Inputs
-      # You can include a single email address or an array of addresses
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.users.add_email "octocat@github.com", "support@github.com"
-      #
-      def add_email(*args)
-        params = _extract_parameters(args)
-        _normalize_params_keys(params)
-        params['data'] = [args].flatten if args
-        post("/user/emails", params)
-      end
+    # Add email address(es) for the authenticated user
+    #
+    # = Inputs
+    # You can include a single email address or an array of addresses
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.users.emails.add "octocat@github.com", "support@github.com"
+    #
+    def add(*args)
+      params = _extract_parameters(args)
+      _normalize_params_keys(params)
+      params['data'] = [args].flatten if args
+      post_request("/user/emails", params)
+    end
+    alias :<< :add
 
-      # Delete email address(es) for the authenticated user
-      #
-      # = Inputs
-      # You can include a single email address or an array of addresses
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.users.delete_email "octocat@github.com", "support@github.com"
-      #
-      def delete_email(*args)
-        params = _extract_parameters(args)
-        _normalize_params_keys(params)
-        params['data'] = [args].flatten
-        delete("/user/emails", params)
-      end
+    # Delete email address(es) for the authenticated user
+    #
+    # = Inputs
+    # You can include a single email address or an array of addresses
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.users.emails.delete "octocat@github.com", "support@github.com"
+    #
+    def delete(*args)
+      params = _extract_parameters(args)
+      _normalize_params_keys(params)
+      params['data'] = [args].flatten
+      delete_request("/user/emails", params)
+    end
 
-    end # Emails
-  end # Users
+  end # Users::Emails
 end # Github

data/lib/github_api/users/followers.rb

@@ -1,98 +1,97 @@
 # encoding: utf-8
 
 module Github
-  class Users
-    module Followers
+  class Users::Followers < API
 
-      # List a user's followers
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.users.followers 'user-name'
-      #  @github.users.followers 'user-name' { |user| ... }
-      #
-      # List the authenticated user's followers
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.users.followers
-      #  @github.users.followers { |user| ... }
-      #
-      def followers(user_name=nil, params={})
-        _normalize_params_keys(params)
-        response = if user_name
-          get("/users/#{user_name}/followers", params)
-        else
-          get("/user/followers", params)
-        end
-        return response unless block_given?
-        response.each { |el| yield el }
+    # List a user's followers
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.users.followers.list 'user-name'
+    #  github.users.followers.list 'user-name' { |user| ... }
+    #
+    # List the authenticated user's followers
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.users.followers
+    #  github.users.followers { |user| ... }
+    #
+    def list(user_name=nil, params={})
+      _normalize_params_keys(params)
+      response = if user_name
+        get_request("/users/#{user_name}/followers", params)
+      else
+        get_request("/user/followers", params)
       end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
 
-      # List who a user is following
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.users.following 'user-name'
-      #  @github.users.following 'user-name' { |user| ... }
-      #
-      # List who the authenicated user is following
-      #
-      # = Examples
-      #
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.users.following
-      #
-      def following(user_name=nil, params={})
-        _normalize_params_keys(params)
-        response = if user_name
-          get("/users/#{user_name}/following", params)
-        else
-          get("/user/following", params)
-        end
-        return response unless block_given?
-        response.each { |el| yield el }
+    # List who a user is following
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.users.followers.following 'user-name'
+    #  github.users.followers.following 'user-name' { |user| ... }
+    #
+    # List who the authenicated user is following
+    #
+    # = Examples
+    #
+    #  github = Github.new :oauth_token => '...'
+    #  github.users.followers.following
+    #
+    def following(user_name=nil, params={})
+      _normalize_params_keys(params)
+      response = if user_name
+        get_request("/users/#{user_name}/following", params)
+      else
+        get_request("/user/following", params)
       end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
 
-      # Check if you are following a user
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.users.following? 'user-name'
-      #
-      def following?(user_name, params={})
-        _validate_presence_of user_name
-        _normalize_params_keys(params)
-        get("/user/following/#{user_name}", params)
-        true
-      rescue Github::Error::NotFound
-        false
-      end
+    # Check if you are following a user
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.users.followers.following? 'user-name'
+    #
+    def following?(user_name, params={})
+      _validate_presence_of user_name
+      _normalize_params_keys(params)
+      get_request("/user/following/#{user_name}", params)
+      true
+    rescue Github::Error::NotFound
+      false
+    end
 
-      # Follow a user
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.users.follow 'user-name'
-      #
-      def follow(user_name, params={})
-        _validate_presence_of user_name
-        _normalize_params_keys(params)
-        put("/user/following/#{user_name}", params)
-      end
+    # Follow a user
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.users.followers.follow 'user-name'
+    #
+    def follow(user_name, params={})
+      _validate_presence_of user_name
+      _normalize_params_keys(params)
+      put_request("/user/following/#{user_name}", params)
+    end
 
-      # Unfollow a user
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.users.unfollow 'user-name'
-      #
-      def unfollow(user_name, params={})
-        _validate_presence_of user_name
-        _normalize_params_keys(params)
-        delete("/user/following/#{user_name}", params)
-      end
+    # Unfollow a user
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.users.followers.unfollow 'user-name'
+    #
+    def unfollow(user_name, params={})
+      _validate_presence_of user_name
+      _normalize_params_keys(params)
+      delete_request("/user/following/#{user_name}", params)
+    end
 
-    end # Followers
-  end # Users
+  end # Users::Followers
 end # Github

data/lib/github_api/users/keys.rb

@@ -1,86 +1,84 @@
 # encoding: utf-8
 
 module Github
-  class Users
-    module Keys
+  class Users::Keys < API
 
-      VALID_KEY_PARAM_NAMES = %w[ title key ].freeze
+    VALID_KEY_PARAM_NAMES = %w[ title key ].freeze
 
-      # List public keys for the authenticated user
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.users.public_keys
-      #  @github.users.public_keys { |key| ... }
-      #
-      def keys(params={})
-        _normalize_params_keys(params)
-        response = get("/user/keys", params)
-        return response unless block_given?
-        response.each { |el| yield el }
-      end
-      alias :public_keys :keys
+    # List public keys for the authenticated user
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.users.followers.list
+    #  github.users.followers.list { |key| ... }
+    #
+    def list(params={})
+      _normalize_params_keys(params)
+      response = get_request("/user/keys", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
 
-      # Get a single pulic key for the authenticated user
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.users.public_key 'key-id'
-      #
-      def key(key_id, params={})
-        _validate_presence_of key_id
-        _normalize_params_keys(params)
-        get("/user/keys/#{key_id}", params)
-      end
-      alias :public_key :key
+    # Get a single pulic key for the authenticated user
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.users.followers.get 'key-id'
+    #
+    def get(key_id, params={})
+      _validate_presence_of key_id
+      _normalize_params_keys(params)
+      get_request("/user/keys/#{key_id}", params)
+    end
+    alias :find :get
 
-      # Create a public key for the authenticated user
-      #
-      # = Inputs
-      # * <tt>:title</tt> - Required string
-      # * <tt>:key</tt> - Required string. sha key
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.users.create_key "title" => "octocat@octomac",
-      #    "key" => "ssh-rsa AAA..."
-      #
-      def create_key(params={})
-        _normalize_params_keys(params)
-        _filter_params_keys(VALID_KEY_PARAM_NAMES, params)
-        post("/user/keys", params)
-      end
+    # Create a public key for the authenticated user
+    #
+    # = Inputs
+    # * <tt>:title</tt> - Required string
+    # * <tt>:key</tt> - Required string. sha key
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.users.followers.create "title" => "octocat@octomac",
+    #    "key" => "ssh-rsa AAA..."
+    #
+    def create(params={})
+      _normalize_params_keys(params)
+      _filter_params_keys(VALID_KEY_PARAM_NAMES, params)
+      post_request("/user/keys", params)
+    end
 
-      # Update a public key for the authenticated user
-      #
-      # = Inputs
-      # * <tt>:title</tt> - Required string
-      # * <tt>:key</tt> - Required string. sha key
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.users.update_key 'key-id', "title" => "octocat@octomac",
-      #    "key" => "ssh-rsa AAA..."
-      #
-      def update_key(key_id, params={})
-        _validate_presence_of key_id
-        _normalize_params_keys(params)
-        _filter_params_keys(VALID_KEY_PARAM_NAMES, params)
-        patch("/user/keys/#{key_id}", params)
-      end
+    # Update a public key for the authenticated user
+    #
+    # = Inputs
+    # * <tt>:title</tt> - Required string
+    # * <tt>:key</tt> - Required string. sha key
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.users.followers.update 'key-id', "title" => "octocat@octomac",
+    #    "key" => "ssh-rsa AAA..."
+    #
+    def update(key_id, params={})
+      _validate_presence_of key_id
+      _normalize_params_keys(params)
+      _filter_params_keys(VALID_KEY_PARAM_NAMES, params)
+      patch_request("/user/keys/#{key_id}", params)
+    end
 
-      # Delete a public key for the authenticated user
-      #
-      # = Examples
-      #  @github = Github.new :oauth_token => '...'
-      #  @github.users.delete_key 'key-id'
-      #
-      def delete_key(key_id, params={})
-        _validate_presence_of key_id
-        _normalize_params_keys(params)
-        delete("/user/keys/#{key_id}", params)
-      end
+    # Delete a public key for the authenticated user
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.users.followers.delete 'key-id'
+    #
+    def delete(key_id, params={})
+      _validate_presence_of key_id
+      _normalize_params_keys(params)
+      delete_request("/user/keys/#{key_id}", params)
+    end
 
-    end # Keys
-  end # Users
+  end # Users::Keys
 end # Github

data/lib/github_api/validations.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Github
+  module Validations
+    extend AutoloadHelper
+
+    autoload_all 'github_api/validations',
+      :Presence => 'presence',
+      :Token    => 'token',
+      :Format   => 'format',
+      :Required => 'required'
+
+    include Presence
+    include Format
+    include Token
+    include Required
+
+    VALID_API_KEYS = [
+      'page',
+      'per_page',
+      'jsonp_callback'
+    ]
+
+  end # Validation
+end # Github