github_api 0.11.3 → 0.12.0

data/lib/github_api/git_data/blobs.rb

@@ -1,46 +0,0 @@
-# encoding: utf-8
-
-module Github
-
-  # 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.
-  class GitData::Blobs < API
-
-    VALID_BLOB_PARAM_NAMES = %w[ content encoding ].freeze
-
-    # Get a blob
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.git_data.blobs.get 'user-name', 'repo-name', 'sha'
-    #
-    def get(*args)
-      arguments(args, :required => [:user, :repo, :sha])
-
-      get_request("/repos/#{user}/#{repo}/git/blobs/#{sha}", arguments.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(*args)
-      arguments(args, :required => [:user, :repo]) do
-        sift VALID_BLOB_PARAM_NAMES
-        assert_required VALID_BLOB_PARAM_NAMES
-      end
-
-      post_request("/repos/#{user}/#{repo}/git/blobs", arguments.params)
-    end
-
-  end # GitData::Blobs
-end # Github

data/lib/github_api/git_data/commits.rb

@@ -1,83 +0,0 @@
-# encoding: utf-8
-
-module Github
-  class GitData::Commits < API
-
-    VALID_COMMIT_PARAM_NAMES = %w[
-      message
-      tree
-      parents
-      author
-      committer
-      name
-      email
-      date
-    ].freeze
-
-    REQUIRED_COMMIT_PARAMS = %w[
-      message
-      tree
-      parents
-    ].freeze
-
-    # Get a commit
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.git_data.commits.get 'user-name', 'repo-name', 'sha'
-    #
-    #  commits = Github::Commits.new user: 'user-name', repo: 'repo-name'
-    #  commits.get sha: '...'
-    #
-    def get(*args)
-      arguments(args, :required => [:user, :repo, :sha])
-      params = arguments.params
-
-      get_request("/repos/#{user}/#{repo}/git/commits/#{sha}", params)
-    end
-    alias :find :get
-
-    # 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.commits.create '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(*args)
-      arguments(args, :required => [:user, :repo]) do
-        sift VALID_COMMIT_PARAM_NAMES
-        assert_required REQUIRED_COMMIT_PARAMS
-      end
-      params = arguments.params
-
-      post_request("/repos/#{user}/#{repo}/git/commits", params)
-    end
-
-  end # GitData::Commits
-end # Github

data/lib/github_api/git_data/references.rb

@@ -1,133 +0,0 @@
-# encoding: utf-8
-
-module Github
-  class GitData::References < API
-
-    VALID_REF_PARAM_NAMES = %w[ ref sha force ].freeze
-
-    REQUIRED_REF_PARAMS = %w[ ref sha ].freeze
-
-    VALID_REF_PARAM_VALUES = {
-      'ref' => %r{^refs\/\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.list 'user-name', 'repo-name'
-    #
-    #  github.git_data.references.list 'user-name', 'repo-name', ref:'tags'
-    #
-    def list(*args)
-      arguments(args, :required => [:user, :repo])
-      params = arguments.params
-
-      response = if (ref = params.delete('ref'))
-        validate_reference ref
-        get_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
-      else
-        get_request("/repos/#{user}/#{repo}/git/refs", params)
-      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', 'heads/branch'
-    #
-    def get(*args)
-      arguments(args, :required => [:user, :repo, :ref])
-      validate_reference ref
-      params = arguments.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(*args)
-      arguments(args, :required => [:user, :repo]) do
-        sift VALID_REF_PARAM_NAMES
-        assert_required REQUIRED_REF_PARAMS
-      end
-      params = arguments.params
-      validate_reference params['ref']
-
-      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', 'heads/master',
-    #    "sha" =>  "827efc6d56897b048c772eb4087f854f46256132",
-    #    "force" => true
-    #
-    def update(*args)
-      arguments(args, :required => [:user, :repo, :ref]) do
-        sift VALID_REF_PARAM_NAMES
-        assert_required %w[ sha ]
-      end
-      params = arguments.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(*args)
-      arguments(args, :required => [:user, :repo, :ref])
-      params = arguments.params
-
-      delete_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
-    end
-    alias :remove :delete
-
-  private
-
-    def validate_reference(ref)
-      refs = (ref =~ (/^(\/)?refs.*/) ? ref : "refs/#{ref}").gsub(/(\/)+/, '/')
-      refs.gsub!(/^\//, '')
-      unless VALID_REF_PARAM_VALUES['ref'] =~ refs
-        raise ArgumentError, "Provided 'reference' is invalid"
-      end
-    end
-
-  end # GitData::References
-end # Github

data/lib/github_api/git_data/tags.rb

@@ -1,78 +0,0 @@
-# encoding: utf-8
-
-module Github
-  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_VALUES = {
-      'type' => %w[ blob tree commit ]
-    }
-
-    # Get a tag
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.git_data.tags.get 'user-name', 'repo-name', 'sha'
-    #
-    def get(*args)
-      arguments(args, :required => [:user, :repo, :sha])
-      params = arguments.params
-
-      get_request("/repos/#{user}/#{repo}/git/tags/#{sha}", params)
-    end
-    alias :find :get
-
-    # 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(*args)
-      arguments(args, :required => [:user, :repo]) do
-        sift VALID_TAG_PARAM_NAMES
-        assert_values VALID_TAG_PARAM_VALUES
-      end
-      params = arguments.params
-
-      post_request("/repos/#{user}/#{repo}/git/tags", params)
-    end
-
-  end # GitData::Tags
-end # Github

data/lib/github_api/git_data/trees.rb

@@ -1,92 +0,0 @@
-# encoding: utf-8
-
-module Github
-  class GitData::Trees < API
-
-    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 ]
-    }
-
-    # 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(*args)
-      arguments(args, :required => [:user, :repo, :sha])
-      params = arguments.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
-      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.trees.create 'user-name', 'repo-name',
-    #    "tree" => [
-    #      {
-    #        "path" => "file.rb",
-    #        "mode" => "100644",
-    #        "type" => "blob",
-    #        "sha" => "44b4fc6d56897b048c772eb4087f854f46256132"
-    #      },
-    #      ...
-    #    ]
-    #
-    def create(*args)
-      arguments(args, :required => [:user, :repo]) do
-        assert_required %w[ tree ]
-        sift VALID_TREE_PARAM_NAMES, 'tree', { recursive: true }
-        assert_values VALID_TREE_PARAM_VALUES, 'tree'
-      end
-
-      post_request("/repos/#{user}/#{repo}/git/trees", arguments.params)
-    end
-
-  end # GitData::Trees
-end # Github

data/lib/github_api/gitignore.rb

@@ -1,50 +0,0 @@
-# encoding: utf-8
-
-module Github
-
-  # When you create a new GitHub repository via the API, you can specify a
-  # .gitignore template to apply to the repository upon creation.
-  class Gitignore < API
-
-    # List all templates available to pass as an option when creating a repository.
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.gitignore.list
-    #  github.gitignore.list { |template| ... }
-    #
-    def list(*args)
-      arguments(args)
-
-      response = get_request("/gitignore/templates", arguments.params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :all :list
-
-    # Get a single template
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.gitignore.get "template-name"
-    #
-    # Use the raw media type to get the raw contents.
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.gitignore.get "template-name", accept: 'applicatin/vnd.github.raw'
-    #
-    def get(*args)
-      params = arguments(args, :required => [:name]).params
-
-      if (media = params.delete('accept'))
-        params['accept'] = media
-        params['raw'] = true
-      end
-
-      get_request("/gitignore/templates/#{name}", params)
-    end
-    alias :find :get
-
-  end # Gitignore
-end # Github