github_api 0.4.11 → 0.5.0.rc1

data/lib/github_api/api_factory.rb

@@ -7,18 +7,24 @@ module Github
 
     # Instantiates a new github api object
     def self.new(klass, options={})
-      return _create_instance(klass, options) if klass
+      return create_instance(klass, options) if klass
       raise ArgumentError, 'must provied klass to be instantiated'
     end
 
-  private
-
     # Passes configuration options to instantiated class
-    def self._create_instance(klass, options)
+    def self.create_instance(klass, options)
       options.symbolize_keys!
-      instance = Github.const_get(klass.to_sym).new options
+      instance = convert_to_constant(klass.to_s).new options
       Github.api_client = instance
       instance
     end
+
+    def self.convert_to_constant(classes)
+      constant = Github
+      classes.split('::').each do |klass|
+        constant = constant.const_get klass
+      end
+      return constant
+    end
   end
 end # Github

data/lib/github_api/authorizations.rb

@@ -17,56 +17,51 @@ module Github
     # List authorizations
     #
     # = Examples
-    #  @github = Github.new :basic_auth => 'login:password'
-    #  @github.oauth.authorizations
-    #  @github.oauth.authorizations { |auth| ... }
+    #  github = Github.new :basic_auth => 'login:password'
+    #  github.oauth.list
+    #  github.oauth.list { |auth| ... }
     #
-    def authorizations(params={})
+    def list(params={})
       _check_if_authenticated
       _normalize_params_keys(params)
 
-      response = get("/authorizations", params)
+      response = get_request("/authorizations", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :auths :authorizations
-    alias :list_auths :authorizations
-    alias :list_authorizations :authorizations
+    alias :all :list
 
     # Get a single authorization
     #
     # = Examples
-    #  @github = Github.new :basic_auth => 'login:password'
-    #  @github.oauth.authorization 'authorization-id'
+    #  github = Github.new :basic_auth => 'login:password'
+    #  github.oauth.get 'authorization-id'
     #
-    def authorization(authorization_id, params={})
+    def get(authorization_id, params={})
       _validate_presence_of(authorization_id)
       _check_if_authenticated
       _normalize_params_keys params
 
-      get "/authorizations/#{authorization_id}", params
+      get_request("/authorizations/#{authorization_id}", params)
     end
-    alias :auth :authorization
-    alias :get_auth :authorization
-    alias :get_authorization :authorization
+    alias :find :get
 
     # Create a new authorization
     #
     # = Inputs
     # * <tt>:scopes</tt> - Optional array - A list of scopes that this authorization is in.
     # = Examples
-    #  @github = Github.new :basic_auth => 'login:password'
-    #  @github.oauth.create_authorization
+    #  github = Github.new :basic_auth => 'login:password'
+    #  github.oauth.create
     #    "scopes" => ["public_repo"]
     #
-    def create_authorization(params={})
+    def create(params={})
       _check_if_authenticated
       _normalize_params_keys(params)
       _filter_params_keys(VALID_AUTH_PARAM_NAMES, params)
 
-      post("/authorizations", params)
+      post_request("/authorizations", params)
     end
-    alias :create_auth :create_authorization
 
     # Update an existing authorization
     #
@@ -76,38 +71,34 @@ module Github
     # * <tt>:remove_scopes</tt> - Optional array - A list of scopes to remove from this authorization.
     #
     # = Examples
-    #  @github = Github.new :basic_auth => 'login:password'
-    #  @github.oauth.update_authorization
-    #    "add_scopes" => ["repo"],
+    #  github = Github.new :basic_auth => 'login:password'
+    #  github.oauth.update "authorization-id", "add_scopes" => ["repo"],
     #
-    def update_authorization(authorization_id, params={})
+    def update(authorization_id, params={})
       _check_if_authenticated
       _validate_presence_of(authorization_id)
 
       _normalize_params_keys(params)
       _filter_params_keys(VALID_AUTH_PARAM_NAMES, params)
 
-      patch("/authorizations/#{authorization_id}", params)
+      patch_request("/authorizations/#{authorization_id}", params)
     end
-    alias :update_auth :update_authorization
 
     # Delete an authorization
     #
     # = Examples
-    #  @github.oauth.delete_authorization 'authorization-id'
+    #  github.oauth.delete 'authorization-id'
     #
-    def delete_authorization(authorization_id, params={})
+    def delete(authorization_id, params={})
       _check_if_authenticated
       _validate_presence_of(authorization_id)
 
       _normalize_params_keys(params)
       _filter_params_keys(VALID_AUTH_PARAM_NAMES, params)
 
-      delete("/authorizations/#{authorization_id}", params)
+      delete_request("/authorizations/#{authorization_id}", params)
     end
-    alias :delete_auth :delete_authorization
-    alias :remove_auth :delete_authorization
-    alias :remove_authorization :delete_authorization
+    alias :remove :delete
 
     private
 

data/lib/github_api/client.rb

@@ -50,6 +50,7 @@ module Github
     def oauth(options = {})
       @oauth ||= ApiFactory.new 'Authorizations', options
     end
+    alias :authorizations :oauth
 
   end # Client
 end # Github

data/lib/github_api/events.rb

@@ -11,14 +11,14 @@ module Github
     # List all public events
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.events.public
-    #  @github.events.public { |event| ... }
+    #  github = Github.new
+    #  github.events.public
+    #  github.events.public { |event| ... }
     #
     def public(params={})
       _normalize_params_keys(params)
 
-      response = get("/events", params)
+      response = get_request("/events", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -29,16 +29,16 @@ module Github
     # 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| ... }
+    #  github = Github.new
+    #  github.events.repository 'user-name', 'repo-name'
+    #  github.events.repository '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)
+      response = get_request("/repos/#{user}/#{repo}/events", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -50,16 +50,16 @@ module Github
     # 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| ... }
+    #  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)
+      response = get_request("/repos/#{user}/#{repo}/issues/events", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -70,16 +70,16 @@ module Github
     # 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| ... }
+    #  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)
+      response = get_request("/networks/#{user}/#{repo}/events", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -91,15 +91,15 @@ module Github
     # List all public events for an organization
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.events.org 'org-name'
-    #  @github.events.org 'org-name' { |event| ... }
+    #  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)
+      response = get_request("/orgs/#{org_name}/events", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -115,16 +115,16 @@ module Github
     # Otherwise, you’ll only see public events.
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.events.received 'user-name'
-    #  @github.events.received 'user-name' { |event| ... }
+    #  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| ... }
+    #  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
@@ -135,7 +135,7 @@ module Github
         '/public'
       end
 
-      response = get("/users/#{user_name}/received_events#{public_events}", params)
+      response = get_request("/users/#{user_name}/received_events#{public_events}", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -148,16 +148,16 @@ module Github
     # events. Otherwise, you’ll only see public events.
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.events.performed 'user-name'
-    #  @github.events.performed 'user-name' { |event| ... }
+    #  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| ... }
+    #  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
@@ -168,7 +168,7 @@ module Github
         '/public'
       end
 
-      response = get("/users/#{user_name}/events#{public_events}", params)
+      response = get_request("/users/#{user_name}/events#{public_events}", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -181,15 +181,15 @@ module Github
     # 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| ... }
+    #  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)
+      response = get_request("/users/#{user_name}/events/orgs/#{org_name}", params)
       return response unless block_given?
       response.each { |el| yield el }
     end

data/lib/github_api/filter.rb

@@ -36,7 +36,7 @@ module Github
       case params
       when Hash
         params.keys.each do |k, v|
-          unless (keys.include?(k) or Github::Validation::VALID_API_KEYS.include?(k))
+          unless (keys.include?(k) or Github::Validations::VALID_API_KEYS.include?(k))
             params.delete(k)
           else
             _filter_params_keys(keys, params[k]) if options[:recursive]

data/lib/github_api/gists.rb

@@ -7,7 +7,7 @@ module Github
     autoload_all 'github_api/gists',
       :Comments => 'comments'
 
-    include Github::Gists::Comments
+    # include Github::Gists::Comments
 
     REQUIRED_GIST_INPUTS = %w[
       description
@@ -21,49 +21,54 @@ module Github
       super(options)
     end
 
+    # Access to Gists::Comments API
+    def comments
+      @comments ||= ApiFactory.new 'Gists::Comments'
+    end
+
     # List a user's gists.
     #
     # = Examples
-    #  @github = Github.new :user => 'user-name'
-    #  @github.gists.gists
+    #  github = Github.new :user => 'user-name'
+    #  github.gists.list
     #
     # List the authenticated user’s gists or if called anonymously,
     # this will returns all public gists
     #
     # = Examples
-    #  @github = Github.new :oauth_token => '...'
-    #  @github.gists.gists
+    #  github = Github.new :oauth_token => '...'
+    #  github.gists.list
     #
-    def gists(user_name=nil, params={})
+    def list(user_name=nil, params={})
       _update_user_repo_params(user_name)
       process_params do
         normalize params
       end
 
       response = if user
-        get("/users/#{user}/gists", params)
+        get_request("/users/#{user}/gists", params)
       elsif oauth_token
-        get("/gists", params)
+        get_request("/gists", params)
       else
-        get("/gists/public", params)
+        get_request("/gists/public", params)
       end
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :list_gists :gists
+    alias :all :list
 
     # List the authenticated user's starred gists
     #
     # = Examples
-    #  @github = Github.new :oauth_token => '...'
-    #  @github.gists.starred
+    #  github = Github.new :oauth_token => '...'
+    #  github.gists.starred
     #
     def starred(params={})
       process_params do
         normalize params
       end
 
-      response = get("/gists/starred", params)
+      response = get_request("/gists/starred", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -71,16 +76,16 @@ module Github
     # Get a single gist
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.gists.get_gist 'gist-id'
+    #  github = Github.new
+    #  github.gists.get 'gist-id'
     #
-    def gist(gist_id, params={})
+    def get(gist_id, params={})
       _normalize_params_keys(params)
       _validate_presence_of(gist_id)
 
-      get("/gists/#{gist_id}", params)
+      get_request("/gists/#{gist_id}", params)
     end
-    alias :get_gist :gist
+    alias :find :get
 
     # Create a gist
     #
@@ -93,8 +98,8 @@ module Github
     #        <tt>:content</tt> - Required string - File contents.
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.gists.create_gist
+    #  github = Github.new
+    #  github.gists.create
     #    'description' => 'the description for this gist',
     #    'public' => true,
     #    'files' => {
@@ -103,11 +108,11 @@ module Github
     #       }
     #    }
     #
-    def create_gist(params={})
+    def create(params={})
       _normalize_params_keys(params)
       _validate_inputs(REQUIRED_GIST_INPUTS, params)
 
-      post("/gists", params)
+      post_request("/gists", params)
     end
 
     # Edit a gist
@@ -121,8 +126,8 @@ module Github
     #        <tt>:filename</tt> - Optional string - New name for this file.
     #
     # = Examples
-    #  @github = Github.new :oauth_token => '...'
-    #  @github.gists.edit_gist 'gist-id', 
+    #  github = Github.new :oauth_token => '...'
+    #  github.gists.edit 'gist-id',
     #    'description' => 'the description for this gist',
     #    'files' => {
     #      'file1.txt' => {
@@ -138,50 +143,50 @@ module Github
     #       'delete_the_file.txt' => nil
     #    }
     #
-    def edit_gist(gist_id, params={})
+    def edit(gist_id, params={})
       _validate_presence_of(gist_id)
       _normalize_params_keys(params)
 
-      patch("/gists/#{gist_id}", params)
+      patch_request("/gists/#{gist_id}", params)
     end
 
     # Star a gist
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.gists.star 'gist-id'
+    #  github = Github.new
+    #  github.gists.star 'gist-id'
     #
     def star(gist_id, params={})
       _validate_presence_of(gist_id)
       _normalize_params_keys(params)
 
-      put("/gists/#{gist_id}/star", params)
+      put_request("/gists/#{gist_id}/star", params)
     end
 
     # Unstar a gist
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.gists.unstar 'gist-id'
+    #  github = Github.new
+    #  github.gists.unstar 'gist-id'
     #
     def unstar(gist_id, params={})
       _validate_presence_of(gist_id)
       _normalize_params_keys(params)
 
-      delete("/gists/#{gist_id}/star", params)
+      delete_request("/gists/#{gist_id}/star", params)
     end
 
     # Check if a gist is starred
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.gists.unstar 'gist-id'
+    #  github = Github.new
+    #  github.gists.starred? 'gist-id'
     #
     def starred?(gist_id, params={})
       _validate_presence_of(gist_id)
       _normalize_params_keys(params)
 
-      get("/gists/#{gist_id}/star", params)
+      get_request("/gists/#{gist_id}/star", params)
       true
     rescue Github::Error::NotFound
       false
@@ -190,27 +195,27 @@ module Github
     # Fork a gist
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.gists.fork 'gist-id'
+    #  github = Github.new
+    #  github.gists.fork 'gist-id'
     #
     def fork(gist_id, params={})
       _validate_presence_of(gist_id)
       _normalize_params_keys(params)
 
-      post("/gists/#{gist_id}/fork", params)
+      post_request("/gists/#{gist_id}/fork", params)
     end
 
     # Delete a gist
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.gists.delete_gist 'gist-id'
+    #  github = Github.new
+    #  github.gists.delete 'gist-id'
     #
-    def delete_gist(gist_id, params={})
+    def delete(gist_id, params={})
       _validate_presence_of(gist_id)
       _normalize_params_keys(params)
 
-      delete("/gists/#{gist_id}", params)
+      delete_request("/gists/#{gist_id}", params)
     end
 
   end # Gists