github_api 0.3.4 → 0.3.5

data/lib/github_api/gists.rb

@@ -1,200 +0,0 @@
-# encoding: utf-8
-
-module Github
-  class Gists < API
-    extend AutoloadHelper
-
-    autoload_all 'github_api/gists',
-      :Comments => 'comments'
-
-    include Github::Gists::Comments
-
-    REQUIRED_GIST_INPUTS = %w[ description public files content ]
-
-    # Creates new Gists API
-    def initialize(options = {})
-      super(options)
-    end
-
-    # List a user's gists.
-    #
-    # = Examples
-    #  @github = Github.new :user => 'user-name'
-    #  @github.gists.gists
-    #
-    # 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
-    #
-    def gists(user_name=nil, params={})
-      _update_user_repo_params(user_name)
-      _normalize_params_keys(params)
-
-      response = if user
-        get("/users/#{user}/gists", params)
-      elsif oauth_token
-        get("/gists", params)
-      else
-        get("/gists/public", params)
-      end
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :list_gists :gists
-
-    # List the authenticated user's starred gists
-    #
-    # = Examples
-    #  @github = Github.new :oauth_token => '...'
-    #  @github.gists.starred
-    #
-    def starred(params={})
-      _normalize_params_keys(params)
-      get("/gists/starred", params)
-    end
-
-    # Get a single gist
-    #
-    # = Examples
-    #  @github = Github.new :oauth_token => '...'
-    #  @github.gists.get_gist 'gist-id'
-    #
-    def get_gist(gist_id, params={})
-      _normalize_params_keys(params)
-      get("/gists/#{gist_id}", params)
-    end
-
-    # Create a gist
-    #
-    # = Inputs
-    #  <tt>:description</tt> - Optional string
-    #  <tt>:public</tt>  - Required boolean
-    #  <tt>:files</tt> - Required hash - Files that make up this gist.
-    #     The key of which should be a required string filename and 
-    #     the value another required hash with parameters:
-    #        <tt>:content</tt> - Required string - File contents.
-    #
-    # = Examples
-    #  @github = Github.new :oauth_token => '...'
-    #  @github.gists.create_gist 
-    #    'description' => 'the description for this gist',
-    #    'public' => true,
-    #    'files' => {
-    #      'file1.txt' => {
-    #         'content' => 'String file contents'
-    #       }
-    #    }
-    #
-    def create_gist(params={})
-      _normalize_params_keys(params)
-      _filter_params_keys(REQUIRED_GIST_INPUTS, params)
-
-      post("/gists", params)
-    end
-
-    # Edit a gist
-    #
-    # = Inputs
-    #  <tt>:description</tt> - Optional string
-    #  <tt>:files</tt> - Optional hash - Files that make up this gist.
-    #     The key of which should be a optional string filename and 
-    #     the value another optional hash with parameters:
-    #        <tt>:content</tt> - Updated string - Update file contents.
-    #        <tt>:filename</tt> - Optional string - New name for this file.
-    #
-    # = Examples
-    #  @github = Github.new :oauth_token => '...'
-    #  @github.gists.edit_gist 'gist-id', 
-    #    'description' => 'the description for this gist',
-    #    'files' => {
-    #      'file1.txt' => {
-    #         'content' => 'Updated file contents'
-    #       },
-    #      'old_name.txt' => {
-    #         'filename' => 'new_name.txt',
-    #         'content' => 'modified contents'
-    #       },
-    #      'new_file.txt' => {
-    #         'content' => 'a new file contents'
-    #       },
-    #       'delete_the_file.txt' => nil
-    #    }
-    #
-    def edit_gist(gist_id, params={})
-      _validate_presence_of(gist_id)
-      _normalize_params_keys(params)
-      _filter_params_keys(REQUIRED_GIST_INPUTS, params)
-
-      patch("/gists/#{gist_id}", params)
-    end
-
-    # Star a gist
-    #
-    # = Examples
-    #  @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)
-    end
-
-    # Unstar a gist
-    #
-    # = Examples
-    #  @github = Github.new
-    #  @github.gists.unstar 'gist-id'
-    #
-    def unstar_gist(gist_id, params={})
-      _validate_presence_of(gist_id)
-      _normalize_params_keys(params)
-
-      delete("/gists/#{gist_id}/star", params)
-    end
-
-    # Check if a gist is starred 
-    #
-    # = Examples
-    #  @github = Github.new
-    #  @github.gists.unstar 'gist-id'
-    #
-    def starred?(gist_id, params={})
-      _validate_presence_of(gist_id)
-      _normalize_params_keys(params)
-
-      get("/gists/#{gist_id}/star", params)
-    end
-
-    # Fork a gist
-    #
-    # = Examples
-    #  @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)
-    end
-
-    # Delete a gist
-    #
-    # = Examples
-    #  @github = Github.new
-    #  @github.gists.delete_gist 'gist-id'
-    #
-    def delete_gist(gist_id, params={})
-      _validate_presence_of(gist_id)
-      _normalize_params_keys(params)
-
-      delete("/gists/#{gist_id}", params)
-    end
-
-  end # Gists
-end # Github

data/lib/github_api/gists/comments.rb

@@ -1,86 +0,0 @@
-# encoding: utf-8
-
-module Github
-  class Gists
-    module Comments
-
-      REQUIRED_GIST_COMMENT_INPUTS = %w[ 
-        body
-        mime_type
-        resource
-      ].freeze
-
-      # List comments on a gist
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.gists.gist_comments 'gist-id'
-      #
-      def gist_comments(gist_id, params={})
-        _normalize_params_keys(params)
-        _merge_mime_type(:gist_comment, params)
-
-        get("/gists/#{gist_id}/comments", params)
-      end
-
-      # Get a single comment
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.gists.gist_comment 'comment-id'
-      #
-      def gist_comment(comment_id, params={})
-        _normalize_params_keys(params)
-        _merge_mime_type(:gist_comment, params)
-
-        get("/gists/comments/#{comment_id}", params)
-      end
-
-      # Create a comment
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.gists.create_gist_comment 'gist-id'
-      #
-      def create_gist_comment(gist_id, params={})
-        _normalize_params_keys(params)
-        _merge_mime_type(:gist_comment, params)
-        _filter_params_keys(REQUIRED_GIST_COMMENT_INPUTS, params)
-
-        raise ArgumentError, "Required inputs are: :body" unless _validate_inputs(REQUIRED_GIST_COMMENT_INPUTS, params)
-
-        post("/gists/#{gist_id}/comments", params)
-      end
-
-      # Edit a comment
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.gists.edit_gist_comment 'comment-id'
-      #
-      def edit_gist_comment(comment_id, params={})
-        _normalize_params_keys(params)
-        _merge_mime_type(:gist_comment, params)
-        _filter_params_keys(REQUIRED_GIST_COMMENT_INPUTS, params)
-
-        raise ArgumentError, "Required inputs are: :body" unless _validate_inputs(REQUIRED_GIST_COMMENT_INPUTS, params)
-
-        patch("/gists/comments/#{comment_id}", params)
-      end
-
-      # Delete a comment
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.gists.delete_gist_comment 'comment-id'
-      #
-      def delete_gist_comment(comment_id, params={})
-        _normalize_params_keys(params)
-        _merge_mime_type(:gist_comment, params)
-
-        delete("/gists/comments/#{comment_id}", params)
-      end
-
-    end # Comments
-  end # Gists
-end # Github

data/lib/github_api/git_data.rb

@@ -1,26 +0,0 @@
-# encoding: utf-8
-
-module Github
-  class GitData < API
-    extend AutoloadHelper
-
-    autoload_all 'github_api/git_data',
-      :Blobs      => 'blobs',
-      :Commits    => 'commits',
-      :References => 'references',
-      :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
-
-  end # GitData
-end # Github

data/lib/github_api/git_data/blobs.rb

@@ -1,51 +0,0 @@
-# encoding: utf-8
-
-module Github
-  class GitData
-    # 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
-
-      # 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=nil, 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)
-
-        raise ArgumentError, "Required params are: #{VALID_BLOB_PARAM_NAMES.join(', ')}" unless _validate_inputs(VALID_BLOB_PARAM_NAMES, params)
-
-        post("/repos/#{user}/#{repo}/git/blobs", params)
-      end
-
-    end # Blobs
-  end # GitData
-end # Github

data/lib/github_api/git_data/commits.rb

@@ -1,78 +0,0 @@
-# encoding: utf-8
-
-module Github
-  class GitData
-    module Commits
-
-      VALID_COMMIT_PARAM_NAMES = %w[
-        message
-        tree
-        parents
-        author
-        committer
-        name
-        email
-        date
-      ].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)
-
-        get("/repos/#{user}/#{repo}/git/commits/#{sha}", 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_commit(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)
-        _filter_params_keys(VALID_COMMIT_PARAM_NAMES, params)
-
-        raise ArgumentError, "Required params are: message, tree, parents" unless _validate_inputs(%w[ message tree parents ], params)
-
-        post("/repos/#{user}/#{repo}/git/commits", params)
-      end
-
-    end # Commits
-  end # GitData
-end # Github

data/lib/github_api/git_data/references.rb

@@ -1,113 +0,0 @@
-# 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 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
-        _normalize_params_keys(params)
-
-        get("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
-      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 '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
-          get("/repos/#{user}/#{repo}/git/refs/#{ref}")
-        else
-          get("/repos/#{user}/#{repo}/git/refs")
-        end
-        return response unless block_given?
-        response.each { |el| yield el }
-      end
-
-      # 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)
-
-        raise ArgumentError, "Required params are: ref, sha" unless _validate_inputs(%w[ ref sha ], params)
-
-        _filter_params_keys(VALID_REF_PARAM_NAMES, params)
-        _validate_params_values(VALID_REF_PARAM_VALUES, params)
-
-        post("/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
-        _normalize_params_keys(params)
-
-        raise ArgumentError, "Required params are: sha" unless _validate_inputs(%w[ sha ], params)
-
-        _filter_params_keys(VALID_REF_PARAM_NAMES, params)
-        _validate_params_values(VALID_REF_PARAM_VALUES, params)
-
-        patch("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
-      end
-
-    end # References
-  end # GitData
-end # Github