github_api 0.4.11 → 0.5.0.rc1

data/lib/github_api/git_data/references.rb

@@ -1,126 +1,145 @@
 # encoding: utf-8
 
 module Github
-  class GitData
-    module References
-
-      VALID_REF_PARAM_NAMES = %w[ ref sha force ].freeze
-
-      VALID_REF_PARAM_VALUES = {
-        'ref' => %r{^refs\/\w+\/\w+(\/\w+)*} # test fully qualified reference
-      }
-
-      # Get all references
-      #
-      # This will return an array of all the references on the system,
-      # including things like notes and stashes if they exist on the server.
-      # Anything in the namespace, not just <tt>heads</tt> and <tt>tags</tt>,
-      # though that would be the most common.
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.git_data.references 'user-name', 'repo-name'
-      #
-      #  @github.git_data.references 'user-name', 'repo-name', 'tags'
-      #
-      def references(user_name, repo_name, ref=nil, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _normalize_params_keys(params)
-
-        response = if ref
-          _validate_reference ref
-          get("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
-        else
-          get("/repos/#{user}/#{repo}/git/refs", params)
-        end
-        return response unless block_given?
-        response.each { |el| yield el }
-      end
-      alias :list_references :references
-      alias :get_all_references :references
-
-      # Get a reference
-      #
-      # The ref in the URL must be formatted as <tt>heads/branch</tt>,
-      # not just branch. For example, the call to get the data for a
-      # branch named <tt>sc/featureA</tt> would be formatted as
-      # <tt>heads/sc/featureA</tt>
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.git_data.reference 'user-name', 'repo-name', 'reference'
-      #
-      def reference(user_name, repo_name, ref, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-
-        _validate_presence_of ref
+  class GitData::References < API
+
+    VALID_REF_PARAM_NAMES = %w[ ref sha force ].freeze
+
+    VALID_REF_PARAM_VALUES = {
+      'ref' => %r{^refs\/\w+\/\w+(\/\w+)*} # test fully qualified reference
+    }
+
+    # Creates new GitData::References API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # Get all references
+    #
+    # This will return an array of all the references on the system,
+    # including things like notes and stashes if they exist on the server.
+    # Anything in the namespace, not just <tt>heads</tt> and <tt>tags</tt>,
+    # though that would be the most common.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.git_data.references.list 'user-name', 'repo-name'
+    #
+    #  github.git_data.references.list 'user-name', 'repo-name', 'tags'
+    #
+    def list(user_name, repo_name, ref=nil, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _normalize_params_keys(params)
+
+      response = if ref
         _validate_reference ref
-        _normalize_params_keys params
-
-        get("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
-      end
-      alias :get_reference :reference
-
-
-      # Create a reference
-      #
-      # = Inputs
-      # * <tt>:ref</tt> - String of the name of the fully qualified reference (ie: refs/heads/master). If it doesn’t start with ‘refs’ and have at least two slashes, it will be rejected.
-      # * <tt>:sha</tt> - String of the SHA1 value to set this reference to
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.git_data.create_reference 'user-name', 'repo-name',
-      #    "ref" => "refs/heads/master",
-      #    "sha" =>  "827efc6d56897b048c772eb4087f854f46256132"
-      #
-      def create_reference(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_REF_PARAM_NAMES, params
-        _validate_reference params['ref']
-        _validate_inputs(%w[ ref sha ], params)
-
-        post("/repos/#{user}/#{repo}/git/refs", params)
+        get_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
+      else
+        get_request("/repos/#{user}/#{repo}/git/refs", params)
       end
-
-      # Update a reference
-      #
-      # = Inputs
-      # * <tt>:sha</tt> - String of the SHA1 value to set this reference to
-      # * <tt>:force</tt> - Boolean indicating whether to force the update or to make sure the update is a fast-forward update. The default is <tt>false</tt>, so leaving this out or setting it to false will make sure you’re not overwriting work.
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.git_data.create_reference 'user-name', 'repo-name',
-      #    "sha" =>  "827efc6d56897b048c772eb4087f854f46256132",
-      #    "force" => true
-      #
-      def update_reference(user_name, repo_name, ref, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-
-        _validate_presence_of ref
-        _validate_reference ref
-        _normalize_params_keys(params)
-        _filter_params_keys(VALID_REF_PARAM_NAMES, params)
-        _validate_inputs(%w[ sha ], params)
-
-        patch("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
-      end
-
-    private
-
-      def _validate_reference ref
-        unless VALID_REF_PARAM_VALUES['ref'] =~ "refs/#{ref}"
-          raise ArgumentError, "Provided 'reference' is invalid"
-        end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a reference
+    #
+    # The ref in the URL must be formatted as <tt>heads/branch</tt>,
+    # not just branch. For example, the call to get the data for a
+    # branch named <tt>sc/featureA</tt> would be formatted as
+    # <tt>heads/sc/featureA</tt>
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.git_data.references.get 'user-name', 'repo-name', 'reference'
+    #
+    def get(user_name, repo_name, ref, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+
+      _validate_presence_of ref
+      _validate_reference ref
+      _normalize_params_keys params
+
+      get_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
+    end
+    alias :find :get
+
+
+    # Create a reference
+    #
+    # = Inputs
+    # * <tt>:ref</tt> - String of the name of the fully qualified reference (ie: refs/heads/master). If it doesn’t start with ‘refs’ and have at least two slashes, it will be rejected.
+    # * <tt>:sha</tt> - String of the SHA1 value to set this reference to
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.git_data.references.create 'user-name', 'repo-name',
+    #    "ref" => "refs/heads/master",
+    #    "sha" =>  "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_REF_PARAM_NAMES, params
+      _validate_reference params['ref']
+      _validate_inputs(%w[ ref sha ], params)
+
+      post_request("/repos/#{user}/#{repo}/git/refs", params)
+    end
+
+    # Update a reference
+    #
+    # = Inputs
+    # * <tt>:sha</tt> - String of the SHA1 value to set this reference to
+    # * <tt>:force</tt> - Boolean indicating whether to force the update or to make sure the update is a fast-forward update. The default is <tt>false</tt>, so leaving this out or setting it to false will make sure you’re not overwriting work.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.git_data.references.update 'user-name', 'repo-name',
+    #    "sha" =>  "827efc6d56897b048c772eb4087f854f46256132",
+    #    "force" => true
+    #
+    def update(user_name, repo_name, ref, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+
+      _validate_presence_of ref
+      _validate_reference ref
+      _normalize_params_keys(params)
+      _filter_params_keys(VALID_REF_PARAM_NAMES, params)
+      _validate_inputs(%w[ sha ], params)
+
+      patch_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
+    end
+
+    # Delete a reference
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.git_data.references.delete 'user-name', 'repo-name',
+    #    "ref" => "refs/heads/master",
+    #
+    def delete(user_name, repo_name, ref, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _normalize_params_keys params
+      _validate_presence_of ref
+
+      delete_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
+    end
+    alias :remove :delete
+
+  private
+
+    def _validate_reference ref
+      unless VALID_REF_PARAM_VALUES['ref'] =~ "refs/#{ref}"
+        raise ArgumentError, "Provided 'reference' is invalid"
       end
+    end
 
-    end # References
-  end # GitData
+  end # GitData::References
 end # Github

data/lib/github_api/git_data/tags.rb

@@ -1,82 +1,86 @@
 # encoding: utf-8
 
 module Github
-  class GitData
-    # This tags api only deals with tag objects - so only annotated tags, not lightweight tags.
-    module Tags
+  class GitData::Tags < API
+    # This tags api only deals with tag objects -
+    # so only annotated tags, not lightweight tags.
 
-      VALID_TAG_PARAM_NAMES = %w[
-        tag
-        message
-        object
-        type
-        name
-        email
-        date
-        sha
-        url
-        tagger
-      ].freeze
+    VALID_TAG_PARAM_NAMES = %w[
+      tag
+      message
+      object
+      type
+      name
+      email
+      date
+      sha
+      url
+      tagger
+    ].freeze
 
-      VALID_TAG_PARAM_VALUES = {
-        'type' => %w[ blob tree commit ]
-      }
+    VALID_TAG_PARAM_VALUES = {
+      'type' => %w[ blob tree commit ]
+    }
 
-      # Get a tag
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.git_data.tag 'user-name', 'repo-name', 'sha'
-      #
-      def tag(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::Tags API
+    def initialize(options = {})
+      super(options)
+    end
 
-        get("/repos/#{user}/#{repo}/git/tags/#{sha}", params)
-      end
-      alias :get_tag :tag
+    # Get a tag
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.git_data.tags.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)
 
-      # Create a tag object
-      # Note that creating a tag object does not create the reference that
-      # makes a tag in Git. If you want to create an annotated tag in Git,
-      # you have to do this call to create the tag object, and then create
-      # the <tt>refs/tags/[tag]</tt> reference. If you want to create a lightweight tag, you simply have to create the reference - this call would be unnecessary.
-      #
-      # = Parameters
-      # * <tt>:tag</tt> - String of the tag
-      # * <tt>:message</tt> - String of the tag message
-      # * <tt>:object</tt> - String of the SHA of the git object this is tagging
-      # * <tt>:type</tt> - String of the type of the object we're tagging. Normally this is a <tt>commit</tt> but it can also be a <tt>tree</tt> or a <tt>blob</tt>
-      # * tagger.name:: String of the name of the author of the tag
-      # * tagger.email:: String of the email of the author of the tag
-      # * tagger.date:: Timestamp of when this object was tagged
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.git_data.create_tag 'user-name', 'repo-name',
-      #    "tag" =>  "v0.0.1",
-      #    "message" => "initial version\n",
-      #    "type": "commit",
-      #    "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
-      #    "tagger" => {
-      #      "name" =>  "Scott Chacon",
-      #      "email" => "schacon@gmail.com",
-      #      "date" => "2011-06-17T14:53:3"
-      #    }
-      #
-      def create_tag(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)
+      get_request("/repos/#{user}/#{repo}/git/tags/#{sha}", params)
+    end
+    alias :find :get
 
-        _filter_params_keys(VALID_TAG_PARAM_NAMES, params)
-        _validate_params_values(VALID_TAG_PARAM_VALUES, params)
+    # Create a tag object
+    # Note that creating a tag object does not create the reference that
+    # makes a tag in Git. If you want to create an annotated tag in Git,
+    # you have to do this call to create the tag object, and then create
+    # the <tt>refs/tags/[tag]</tt> reference. If you want to create a lightweight tag, you simply have to create the reference - this call would be unnecessary.
+    #
+    # = Parameters
+    # * <tt>:tag</tt> - String of the tag
+    # * <tt>:message</tt> - String of the tag message
+    # * <tt>:object</tt> - String of the SHA of the git object this is tagging
+    # * <tt>:type</tt> - String of the type of the object we're tagging. Normally this is a <tt>commit</tt> but it can also be a <tt>tree</tt> or a <tt>blob</tt>
+    # * tagger.name:: String of the name of the author of the tag
+    # * tagger.email:: String of the email of the author of the tag
+    # * tagger.date:: Timestamp of when this object was tagged
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.git_data.tags.create 'user-name', 'repo-name',
+    #    "tag" =>  "v0.0.1",
+    #    "message" => "initial version\n",
+    #    "type": "commit",
+    #    "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+    #    "tagger" => {
+    #      "name" =>  "Scott Chacon",
+    #      "email" => "schacon@gmail.com",
+    #      "date" => "2011-06-17T14:53:3"
+    #    }
+    #
+    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)
 
-        post("/repos/#{user}/#{repo}/git/tags", params)
-      end
+      _filter_params_keys(VALID_TAG_PARAM_NAMES, params)
+      _validate_params_values(VALID_TAG_PARAM_VALUES, params)
 
-    end # Tags
-  end # GitData
+      post_request("/repos/#{user}/#{repo}/git/tags", params)
+    end
+
+  end # GitData::Tags
 end # Github

data/lib/github_api/git_data/trees.rb

@@ -1,99 +1,102 @@
 # encoding: utf-8
 
 module Github
-  class GitData
-    module Trees
+  class GitData::Trees < API
 
-      VALID_TREE_PARAM_NAMES = %w[
-        base_tree
-        tree
-        path
-        mode
-        type
-        sha
-        content
-        url
-      ].freeze
+    VALID_TREE_PARAM_NAMES = %w[
+      base_tree
+      tree
+      path
+      mode
+      type
+      sha
+      content
+      url
+    ].freeze
 
-      VALID_TREE_PARAM_VALUES = {
-        'mode' => %w[ 100644 100755 040000 160000 120000 ],
-        'type' => %w[ blob tree commit ]
-      }
+    VALID_TREE_PARAM_VALUES = {
+      'mode' => %w[ 100644 100755 040000 160000 120000 ],
+      'type' => %w[ blob tree commit ]
+    }
 
-      # Get a tree
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.git_data.tree 'user-name', 'repo-name', 'sha'
-      #  @github.git_data.tree 'user-name', 'repo-name', 'sha' do |file|
-      #    file.path
-      #  end
-      #
-      # Get a tree recursively
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.git_data.tree 'user-name', 'repo-name', 'sha', 'recursive' => true
-      #
-      def tree(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::Trees API
+    def initialize(options = {})
+      super(options)
+    end
 
-        response = if params['recursive']
-          params['recursive'] = 1
-          get("/repos/#{user}/#{repo}/git/trees/#{sha}", params)
-        else
-          get("/repos/#{user}/#{repo}/git/trees/#{sha.to_s}", params)
-        end
-        return response unless block_given?
-        response.tree.each { |el| yield el }
+    # Get a tree
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.git_data.trees.get 'user-name', 'repo-name', 'sha'
+    #  github.git_data.trees.get 'user-name', 'repo-name', 'sha' do |file|
+    #    file.path
+    #  end
+    #
+    # Get a tree recursively
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.git_data.trees.get 'user-name', 'repo-name', 'sha', 'recursive' => true
+    #
+    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)
+
+      response = if params['recursive']
+        params['recursive'] = 1
+        get_request("/repos/#{user}/#{repo}/git/trees/#{sha}", params)
+      else
+        get_request("/repos/#{user}/#{repo}/git/trees/#{sha.to_s}", params)
       end
-      alias :get_tree :tree
+      return response unless block_given?
+      response.tree.each { |el| yield el }
+    end
+    alias :find :get
 
-      # Create a tree
-      #
-      # The tree creation API will take nested entries as well.
-      # If both a tree and a nested path modifying that tree are specified,
-      # it will overwrite the contents of that tree with the new path contents
-      # and write a new tree out.
-      #
-      # = Parameters
-      # * <tt>:base_tree</tt> - optional string of the SHA1 of the tree you want to update with new data
-      # * <tt>:tree</tt> - array of hash objects(of <tt>:path</tt>, <tt>:mode</tt>, <tt>:type</tt> and <tt>sha</tt>)
-      # * tree.path:: String of the file referenced in the tree
-      # * tree.mode:: String of the file mode - one of <tt>100644</tt> for file(blob), <tt>100755</tt> for executable (blob), <tt>040000</tt> for subdirectory (tree), <tt>160000</tt> for submodule (commit) or <tt>120000</tt> for a blob that specifies the path of a symlink
-      # * tree.type:: String of <tt>blob</tt>, <tt>tree</tt>, <tt>commit</tt>
-      # * tree.sha:: String of SHA1 checksum ID of the object in the tree
-      # * tree.content:: String of content you want this file to have - GitHub will write this blob out and use the SHA for this entry. Use either this or <tt>tree.sha</tt>
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.git_data.create_tree 'user-name', 'repo-name',
-      #    "tree" => [
-      #      {
-      #        "path" => "file.rb",
-      #        "mode" => "100644",
-      #        "type" => "blob",
-      #        "sha" => "44b4fc6d56897b048c772eb4087f854f46256132"
-      #      },
-      #      ...
-      #    ]
-      #
-      def create_tree(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)
+    # Create a tree
+    #
+    # The tree creation API will take nested entries as well.
+    # If both a tree and a nested path modifying that tree are specified,
+    # it will overwrite the contents of that tree with the new path contents
+    # and write a new tree out.
+    #
+    # = Parameters
+    # * <tt>:base_tree</tt> - optional string of the SHA1 of the tree you want to update with new data
+    # * <tt>:tree</tt> - array of hash objects(of <tt>:path</tt>, <tt>:mode</tt>, <tt>:type</tt> and <tt>sha</tt>)
+    # * tree.path:: String of the file referenced in the tree
+    # * tree.mode:: String of the file mode - one of <tt>100644</tt> for file(blob), <tt>100755</tt> for executable (blob), <tt>040000</tt> for subdirectory (tree), <tt>160000</tt> for submodule (commit) or <tt>120000</tt> for a blob that specifies the path of a symlink
+    # * tree.type:: String of <tt>blob</tt>, <tt>tree</tt>, <tt>commit</tt>
+    # * tree.sha:: String of SHA1 checksum ID of the object in the tree
+    # * tree.content:: String of content you want this file to have - GitHub will write this blob out and use the SHA for this entry. Use either this or <tt>tree.sha</tt>
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.git_data.trees.create 'user-name', 'repo-name',
+    #    "tree" => [
+    #      {
+    #        "path" => "file.rb",
+    #        "mode" => "100644",
+    #        "type" => "blob",
+    #        "sha" => "44b4fc6d56897b048c772eb4087f854f46256132"
+    #      },
+    #      ...
+    #    ]
+    #
+    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)
 
-        _validate_inputs(%w[ tree ], params)
+      _validate_inputs(%w[ tree ], params)
 
-        _filter_params_keys(VALID_TREE_PARAM_NAMES, params['tree'])
-        _validate_params_values(VALID_TREE_PARAM_VALUES, params['tree'])
+      _filter_params_keys(VALID_TREE_PARAM_NAMES, params['tree'])
+      _validate_params_values(VALID_TREE_PARAM_VALUES, params['tree'])
 
-        post("/repos/#{user}/#{repo}/git/trees", params)
-      end
+      post_request("/repos/#{user}/#{repo}/git/trees", params)
+    end
 
-    end # Trees
-  end # GitData
+  end # GitData::Trees
 end # Github