github_api 0.4.11 → 0.5.0.rc1

data/lib/github_api/gists/comments.rb

@@ -1,101 +1,94 @@
 # encoding: utf-8
 
 module Github
-  class Gists
-    module Comments
+  class Gists::Comments < API
 
-      REQUIRED_GIST_COMMENT_INPUTS = %w[
-        body
-      ].freeze
+    REQUIRED_GIST_COMMENT_INPUTS = %w[
+      body
+    ].freeze
 
-      ALLOWED_GIST_COMMENT_INPUTS = %w[
-        body
-        mime_type
-        resource
-      ].freeze
+    ALLOWED_GIST_COMMENT_INPUTS = %w[
+      body
+      mime_type
+      resource
+    ].freeze
 
-      # List comments on a gist
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.gists.comments 'gist-id'
-      #
-      def comments(gist_id, params={})
-        _normalize_params_keys(params)
-        _validate_presence_of(gist_id)
-        # _merge_mime_type(:gist_comment, params)
+    # List comments on a gist
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.gists.comments.list 'gist-id'
+    #
+    def list(gist_id, params={})
+      _normalize_params_keys(params)
+      _validate_presence_of(gist_id)
+      # _merge_mime_type(:gist_comment, params)
 
-        response = get("/gists/#{gist_id}/comments", params)
-        return response unless block_given?
-        response.each { |el| yield el }
-      end
-      alias :list_comments :comments
-      alias :gist_comments :comments
+      response = get_request("/gists/#{gist_id}/comments", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
 
-      # Get a single comment
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.gists.comment 'comment-id'
-      #
-      def comment(comment_id, params={})
-        _normalize_params_keys(params)
-        _validate_presence_of(comment_id)
-        # _merge_mime_type(:gist_comment, params)
+    # Get a single comment
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.gists.comments.get 'comment-id'
+    #
+    def get(comment_id, params={})
+      _normalize_params_keys(params)
+      _validate_presence_of(comment_id)
+      # _merge_mime_type(:gist_comment, params)
 
-        get("/gists/comments/#{comment_id}", params)
-      end
-      alias :gist_comment :comment
-      alias :get_comment  :comment
+      get_request("/gists/comments/#{comment_id}", params)
+    end
+    alias :find :get
 
-      # Create a comment
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.gists.create_comment 'gist-id'
-      #
-      def create_comment(gist_id, params={})
-        _normalize_params_keys(params)
-        # _merge_mime_type(:gist_comment, params)
-        _filter_params_keys(ALLOWED_GIST_COMMENT_INPUTS, params)
-        _validate_inputs(REQUIRED_GIST_COMMENT_INPUTS, params)
+    # Create a comment
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.gists.comments.create 'gist-id'
+    #
+    def create(gist_id, params={})
+      _normalize_params_keys(params)
+      # _merge_mime_type(:gist_comment, params)
+      _filter_params_keys(ALLOWED_GIST_COMMENT_INPUTS, params)
+      _validate_inputs(REQUIRED_GIST_COMMENT_INPUTS, params)
 
-        post("/gists/#{gist_id}/comments", params)
-      end
-      alias :create_gist_comment :create_comment
+      post_request("/gists/#{gist_id}/comments", params)
+    end
 
-      # Edit a comment
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.gists.edit_comment 'comment-id'
-      #
-      def edit_comment(comment_id, params={})
-        _normalize_params_keys(params)
-        _validate_presence_of(comment_id)
-        # _merge_mime_type(:gist_comment, params)
-        _filter_params_keys(ALLOWED_GIST_COMMENT_INPUTS, params)
-        _validate_inputs(REQUIRED_GIST_COMMENT_INPUTS, params)
+    # Edit a comment
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.gists.comments.edit 'comment-id'
+    #
+    def edit(comment_id, params={})
+      _normalize_params_keys(params)
+      _validate_presence_of(comment_id)
+      # _merge_mime_type(:gist_comment, params)
+      _filter_params_keys(ALLOWED_GIST_COMMENT_INPUTS, params)
+      _validate_inputs(REQUIRED_GIST_COMMENT_INPUTS, params)
 
-        patch("/gists/comments/#{comment_id}", params)
-      end
-      alias :edit_gist_comment :edit_comment
+      patch_request("/gists/comments/#{comment_id}", params)
+    end
 
-      # Delete a comment
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.gists.delete_comment 'comment-id'
-      #
-      def delete_comment(comment_id, params={})
-        _normalize_params_keys(params)
-        _validate_presence_of(comment_id)
-        # _merge_mime_type(:gist_comment, params)
+    # Delete a comment
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.gists.comments.delete 'comment-id'
+    #
+    def delete(comment_id, params={})
+      _normalize_params_keys(params)
+      _validate_presence_of(comment_id)
+      # _merge_mime_type(:gist_comment, params)
 
-        delete("/gists/comments/#{comment_id}", params)
-      end
-      alias :delete_gist_comment :delete_comment
+      delete_request("/gists/comments/#{comment_id}", params)
+    end
 
-    end # Comments
-  end # Gists
+  end # Gists::Comments
 end # Github

data/lib/github_api/git_data.rb

@@ -11,16 +11,35 @@ module Github
       :Tags       => 'tags',
       :Trees      => 'trees'
 
-    include Github::GitData::Blobs
-    include Github::GitData::Commits
-    include Github::GitData::References
-    include Github::GitData::Tags
-    include Github::GitData::Trees
-
     # Creates new GitData API
     def initialize(options = {})
       super(options)
     end
 
+    # Access to GitData::Blobs API
+    def blobs
+      @blobs ||= ApiFactory.new 'GitData::Blobs'
+    end
+
+    # Access to GitData::Commits API
+    def commits
+      @commits ||= ApiFactory.new 'GitData::Commits'
+    end
+
+    # Access to GitData::References API
+    def references
+      @references ||= ApiFactory.new 'GitData::References'
+    end
+
+    # Access to GitData::Tags API
+    def tags
+      @tags ||= ApiFactory.new 'GitData::Tags'
+    end
+
+    # Access to GitData::Tags API
+    def trees
+      @trees ||= ApiFactory.new 'GitData::Trees'
+    end
+
   end # GitData
 end # Github

data/lib/github_api/git_data/blobs.rb

@@ -1,52 +1,55 @@
 # encoding: utf-8
 
 module Github
-  class GitData
+  class GitData::Blobs < API
     # Since blobs can be any arbitrary binary data, the input and responses for
     # the blob api takes an encoding parameter that can be either utf-8 or base64.
     # If your data cannot be losslessly sent as a UTF-8 string, you can base64 encode it.
-    module Blobs
-
-      VALID_BLOB_PARAM_NAMES = %w[ content encoding ].freeze
-
-      # Get a blob
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.git_data.blob 'user-name', 'repo-name', 'sha'
-      #
-      def blob(user_name, repo_name, sha, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of sha
-        _normalize_params_keys params
-
-        get("/repos/#{user}/#{repo}/git/blobs/#{sha}", params)
-      end
-      alias :get_blob :blob
-
-      # Create a blob
-      #
-      # = Inputs
-      # * <tt>:content</tt> - String of content
-      # * <tt>:encoding</tt> - String containing encoding<tt>utf-8</tt> or <tt>base64</tt>
-      # = Examples
-      #  @github = Github.new
-      #  @github.git_data.create_blob 'user-name', 'repo-name',
-      #    "content" => "Content of the blob",
-      #    "encoding" => "utf-8"
-      #
-      def create_blob(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)
-        _filter_params_keys(VALID_BLOB_PARAM_NAMES, params)
-        _validate_inputs(VALID_BLOB_PARAM_NAMES, params)
-
-        post("/repos/#{user}/#{repo}/git/blobs", params)
-      end
-
-    end # Blobs
-  end # GitData
+
+    VALID_BLOB_PARAM_NAMES = %w[ content encoding ].freeze
+
+    # Creates new GitData::Blobs API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # Get a blob
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.git_data.blobs.get 'user-name', 'repo-name', 'sha'
+    #
+    def get(user_name, repo_name, sha, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of sha
+      _normalize_params_keys params
+
+      get_request("/repos/#{user}/#{repo}/git/blobs/#{sha}", params)
+    end
+    alias :find :get
+
+    # Create a blob
+    #
+    # = Inputs
+    # * <tt>:content</tt> - String of content
+    # * <tt>:encoding</tt> - String containing encoding<tt>utf-8</tt> or <tt>base64</tt>
+    # = Examples
+    #  github = Github.new
+    #  github.git_data.blobs.create 'user-name', 'repo-name',
+    #    "content" => "Content of the blob",
+    #    "encoding" => "utf-8"
+    #
+    def create(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)
+      _filter_params_keys(VALID_BLOB_PARAM_NAMES, params)
+      _validate_inputs(VALID_BLOB_PARAM_NAMES, params)
+
+      post_request("/repos/#{user}/#{repo}/git/blobs", params)
+    end
+
+  end # GitData::Blobs
 end # Github

data/lib/github_api/git_data/commits.rb

@@ -1,84 +1,87 @@
 # encoding: utf-8
 
 module Github
-  class GitData
-    module Commits
+  class GitData::Commits < API
 
-      VALID_COMMIT_PARAM_NAMES = %w[
-        message
-        tree
-        parents
-        author
-        committer
-        name
-        email
-        date
-      ].freeze
+    VALID_COMMIT_PARAM_NAMES = %w[
+      message
+      tree
+      parents
+      author
+      committer
+      name
+      email
+      date
+    ].freeze
 
-      REQUIRED_COMMIT_PARAMS = %w[
-        message
-        tree
-        parents
-      ].freeze
+    REQUIRED_COMMIT_PARAMS = %w[
+      message
+      tree
+      parents
+    ].freeze
 
-      # Get a commit
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.git_data.commit 'user-name', 'repo-name', 'sha'
-      #
-      def commit(user_name, repo_name, sha, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of sha
-        _normalize_params_keys(params)
+    # Creates new GitData::Commits API
+    def initialize(options = {})
+      super(options)
+    end
 
-        get("/repos/#{user}/#{repo}/git/commits/#{sha}", params)
-      end
-      alias :get_commit :commit
+    # Get a commit
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.git_data.commit 'user-name', 'repo-name', 'sha'
+    #
+    def get(user_name, repo_name, sha, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of sha
+      _normalize_params_keys(params)
 
-      # Create a commit
-      #
-      # = Parameters
-      # * <tt>message</tt> - String of the commit message
-      # * <tt>tree</tt> - String of the SHA of the tree object this commit points to
-      # * <tt>parents</tt> - Array of the SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided, for a merge commit, an array of more than one should be provided.
-      #
-      # = Optional Parameters
-      #
-      # The committer section is optional and will be filled with the author data if omitted. If the author section is omitted, it will be filled in with the authenticated users information and the current date.
-      #
-      # * author.name:: String of the name of the author of the commit
-      # * author.email:: String of the email of the author of the commit
-      # * author.date:: Timestamp of when this commit was authored
-      # * committer.name:: String of the name of the committer of the commit
-      # * committer.email:: String of the email of the committer of the commit
-      # * committer.date:: Timestamp of when this commit was committed
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.git_data.create_commit 'user-name', 'repo-name',
-      #    "message": "my commit message",
-      #    "author": {
-      #      "name": "Scott Chacon",
-      #      "email": "schacon@gmail.com",
-      #      "date": "2008-07-09T16:13:30+12:00"
-      #    },
-      #   "parents": [
-      #      "7d1b31e74ee336d15cbd21741bc88a537ed063a0"
-      #    ],
-      #    "tree": "827efc6d56897b048c772eb4087f854f46256132"]
-      #
-      def create_commit(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)
-        _filter_params_keys(VALID_COMMIT_PARAM_NAMES, params)
-        _validate_inputs(REQUIRED_COMMIT_PARAMS, params)
+      get_request("/repos/#{user}/#{repo}/git/commits/#{sha}", params)
+    end
+    alias :find :get
 
-        post("/repos/#{user}/#{repo}/git/commits", params)
-      end
+    # Create a commit
+    #
+    # = Parameters
+    # * <tt>message</tt> - String of the commit message
+    # * <tt>tree</tt> - String of the SHA of the tree object this commit points to
+    # * <tt>parents</tt> - Array of the SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided, for a merge commit, an array of more than one should be provided.
+    #
+    # = Optional Parameters
+    #
+    # The committer section is optional and will be filled with the author data if omitted. If the author section is omitted, it will be filled in with the authenticated users information and the current date.
+    #
+    # * author.name:: String of the name of the author of the commit
+    # * author.email:: String of the email of the author of the commit
+    # * author.date:: Timestamp of when this commit was authored
+    # * committer.name:: String of the name of the committer of the commit
+    # * committer.email:: String of the email of the committer of the commit
+    # * committer.date:: Timestamp of when this commit was committed
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.git_data.create_commit 'user-name', 'repo-name',
+    #    "message": "my commit message",
+    #    "author": {
+    #      "name": "Scott Chacon",
+    #      "email": "schacon@gmail.com",
+    #      "date": "2008-07-09T16:13:30+12:00"
+    #    },
+    #   "parents": [
+    #      "7d1b31e74ee336d15cbd21741bc88a537ed063a0"
+    #    ],
+    #    "tree": "827efc6d56897b048c772eb4087f854f46256132"]
+    #
+    def create(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)
+      _filter_params_keys(VALID_COMMIT_PARAM_NAMES, params)
+      _validate_inputs(REQUIRED_COMMIT_PARAMS, params)
 
-    end # Commits
-  end # GitData
+      post_request("/repos/#{user}/#{repo}/git/commits", params)
+    end
+
+  end # GitData::Commits
 end # Github