github_api 0.3.5 → 0.3.6

data/lib/github_api/issues/events.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+module Github
+  class Issues
+    module Events
+
+    # List events for an issue
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.issues.events 'user-name', 'repo-name', 'issue-id'
+    #
+    # List events for a repository
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.issues.events 'user-name', 'repo-name'
+    #
+    def events(user_name=nil, repo_name=nil, issue_id=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 issue_id
+        get("/repos/#{user}/#{repo}/issues/#{issue_id}/events", params)
+      else
+        get("/repos/#{user}/#{repo}/issues/events", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :list_events :events
+    alias :issue_events :events
+    alias :repo_events :events
+
+    # Get a single event
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.issues.event 'user-name', 'repo-name', 'event-id'
+    #
+    def event(user_name, repo_name, event_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of event_id
+      _normalize_params_keys(params)
+
+      get("/repos/#{user}/#{repo}/issues/events/#{event_id}")
+    end
+    alias :get_event :event
+
+    end # Events
+  end # Issues
+end # Github

data/lib/github_api/issues/labels.rb

@@ -0,0 +1,191 @@
+# encoding: utf-8
+
+module Github
+  class Issues
+    module Labels
+
+      VALID_LABEL_INPUTS = %w[ name color ]
+
+      # List all labels for a repository
+      #
+      # = Examples
+      #  @github = Github.new :user => 'user-name', :repo => 'repo-name'
+      #  @github.issues.labels
+      #  @github.issues.labels { |label| ... }
+      #
+      def labels(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}/labels", params)
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+
+      # Get a single label
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.label 'user-name', 'repo-name', 'label-id'
+      #
+      def label(user_name, repo_name, label_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _normalize_params_keys(params)
+
+        get("/repos/#{user}/#{repo}/labels/#{label_id}", params)
+      end
+
+      # Create a label
+      #
+      # = Inputs
+      #  <tt>:name</tt> - Required string
+      #  <tt>:color</tt> - Required string - 6 character hex code, without leading #
+      #
+      # = Examples
+      #  @github = Github.new :user => 'user-name', :repo => 'repo-name'
+      #  @github.issues.create_label :name => 'API', :color => 'FFFFFF'
+      #
+      def create_label(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_LABEL_INPUTS, params)
+
+        raise ArgumentError, "Required params are: :name, :color" unless _validate_inputs(VALID_LABEL_INPUTS, params)
+
+        post("/repos/#{user}/#{repo}/labels", params)
+      end
+
+      # Update a label
+      #
+      # = Inputs
+      #  <tt>:name</tt> - Required string
+      #  <tt>:color</tt> - Required string - 6 character hex code, without leading #
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.update_label 'user-name', 'repo-name', 'label-id', :name => 'API', :color => "FFFFFF"
+      #
+      def update_label(user_name, repo_name, label_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of label_id
+
+        _normalize_params_keys(params)
+        _filter_params_keys(VALID_LABEL_INPUTS, params)
+
+        raise ArgumentError, "Required params are: :name, :color" unless _validate_inputs(VALID_LABEL_INPUTS, params)
+
+        patch("/repos/#{user}/#{repo}/labels/#{label_id}", params)
+      end
+
+      # Delete a label
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.delete_label 'user-name', 'repo-name', 'label-id'
+      #
+      def delete_label(user_name, repo_name, label_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of milestone_id
+        _normalize_params_keys(params)
+
+        delete("/repos/#{user}/#{repo}/labels/#{label_id}", params)
+      end
+
+      # List labels on an issue
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.labels_for 'user-name', 'repo-name', 'issue-id'
+      #
+      def labels_for(user_name, repo_name, issue_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of(issue_id)
+        _normalize_params_keys(params)
+
+        get("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
+      end
+
+      # Add labels to an issue
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.add_labels 'user-name', 'repo-name', 'issue-id', 'label1', 'label2', ...
+      #
+      def add_labels(user_name, repo_name, issue_id, *args)
+        params = args.last.is_a?(Hash) ? args.pop : {}
+        params['data'] = [args].flatten unless args.nil?
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of(issue_id)
+        _normalize_params_keys(params)
+
+        post("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
+      end
+
+      # Remove a label from an issue
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.remove_label 'user-name', 'repo-name', 'issue-id', 'label-id'
+      #
+      # Remove all labels from an issue
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.remove_label 'user-name', 'repo-name', 'issue-id'
+      #
+      def remove_label(user_name, repo_name, issue_id, label_id=nil, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of(issue_id)
+        _normalize_params_keys(params)
+
+        if label_id
+          delete("/repos/#{user}/#{repo}/issues/#{issue_id}/labels/#{label_id}", params)
+        else
+          delete("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
+        end
+      end
+
+      # Replace all labels for an issue 
+      #
+      # Sending an empty array ([]) will remove all Labels from the Issue.
+      #
+      # = Examples
+      #  @github = Github.new 
+      #  @github.issues.replace_labels 'user-name', 'repo-name', 'issue-id', 'label1', 'label2', ...
+      #
+      def replace_labels(user_name, repo_name, issue_id, *args)
+        params = args.last.is_a?(Hash) ? args.pop : {}
+        params['data'] = [args].flatten unless args.nil?
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of(issue_id)
+        _normalize_params_keys(params)
+
+        put("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
+      end
+
+      # Get labels for every issue in a milestone
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.get_label 'user-name', 'repo-name', 'milestone-id'
+      #
+      def get_label(user_name, repo_name, milestone_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of(issue_id)
+
+        get("/repos/#{user}/#{repo}/milestones/#{milestone_id}/labels", params)
+      end
+
+    end # Labels
+  end # Issues
+end # Github

data/lib/github_api/issues/milestones.rb

@@ -0,0 +1,140 @@
+# encoding: utf-8
+
+module Github
+  class Issues
+    module Milestones
+
+      VALID_MILESTONE_OPTIONS = {
+       'state' => %w[ open closed ],
+       'sort'  => %w[ due_date completeness ],
+       'direction' => %w[ desc asc ]
+      }.freeze # :nodoc:
+
+      VALID_MILESTONE_INPUTS = %w[
+        title
+        state
+        description
+        due_on
+      ].freeze # :nodoc:
+
+      # List milestones for a repository
+      #
+      # = Parameters
+      # <tt>:state</tt> - <tt>open</tt>, <tt>closed</tt>, default: <tt>open</tt>
+      # <tt>:sort</tt> - <tt>due_date</tt>, <tt>completeness</tt>, default: <tt>due_date</tt>
+      # <tt>:direction</tt> - <tt>asc</tt>, <tt>desc</tt>, default: <tt>desc</tt>
+      #
+      # = Examples
+      #  @github = Github.new :user => 'user-name', :repo => 'repo-name'
+      #  @github.issues.milestones
+      #
+      #  or
+      #
+      #  @github.issues.milestones :state => 'open',
+      #     :sort => 'due_date',
+      #     :direction => 'asc'
+      #
+      def milestones(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_MILESTONE_OPTIONS.keys, params)
+        _validate_params_values(VALID_MILESTONE_OPTIONS, params)
+
+        response = get("/repos/#{user}/#{repo}/milestones", params)
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+      alias :list_milestones :milestones
+
+      # Get a single milestone
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.milestone 'user-name', 'repo-name', 'milestone-id'
+      #
+      def milestone(user_name, repo_name, milestone_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of milestone_id
+        _normalize_params_keys(params)
+
+        get("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
+      end
+      alias :get_milestone :milestone
+
+      # Create a milestone
+      #
+      # = Inputs
+      #  <tt>:title</tt> - Required string
+      #  <tt>:state</tt> - Optional string - <tt>open</tt> or <tt>closed</tt>
+      #  <tt>:description</tt> - Optional string
+      #  <tt>:due_on</tt> - Optional string - ISO 8601 time
+      #
+      # = Examples
+      #  @github = Github.new :user => 'user-name', :repo => 'repo-name'
+      #  @github.issues.create_milestone :title => 'hello-world',
+      #    :state => "open or closed",
+      #    :description => "String",
+      #    :due_on => "Time"
+      #
+      def create_milestone(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_MILESTONE_INPUTS, params)
+
+        raise ArgumentError, "Required params are: :title" unless _validate_inputs(%w[ title ], params)
+
+        post("/repos/#{user}/#{repo}/milestones", params)
+      end
+
+      # Update a milestone
+      #
+      # = Inputs
+      #  <tt>:title</tt> - Required string
+      #  <tt>:state</tt> - Optional string - <tt>open</tt> or <tt>closed</tt>
+      #  <tt>:description</tt> - Optional string
+      #  <tt>:due_on</tt> - Optional string - ISO 8601 time
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.update_milestone 'user-name', 'repo-name', 'milestone-id',
+      #    :title => 'hello-world',
+      #    :state => "open or closed",
+      #    :description => "String",
+      #    :due_on => "Time"
+      #
+      def update_milestone(user_name, repo_name, milestone_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of milestone_id
+
+        _normalize_params_keys(params)
+        _filter_params_keys(VALID_MILESTONE_INPUTS, params)
+
+        raise ArgumentError, "Required params are: :title" unless _validate_inputs(%w[ title ], params)
+
+        patch("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
+      end
+
+      # Delete a milestone
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.delete_milestone 'user-name', 'repo-name', 'milestone-id'
+      #
+      def delete_milestone(user_name, repo_name, milestone_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of milestone_id
+        _normalize_params_keys(params)
+
+        delete("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
+      end
+
+    end # Milestones
+  end # Issues
+end # Github

data/lib/github_api/mime_type.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+module Github
+  module MimeType
+
+    attr_accessor :accepts
+
+    RESOURCE_LOOKUP = {
+      :json           => 'json',
+      :issue          => 'vnd.github-issue.',
+      :issue_comment  => 'vnd.github-issuecomment.',
+      :commit_comment => 'vnd.github-commitcomment.',
+      :pull_request   => 'vnd.github-pull.',
+      :pull_comment   => 'vnd.github-pullcomment.',
+      :gist_comment   => 'vnd.github-gistcomment.',
+      :blob           => 'vnd.github-blob.'
+    }
+
+    MIME_LOOKUP = {
+      :json => 'json',
+      :blob => 'raw',
+      :raw  => 'raw+json',
+      :text => 'text+json',
+      :html => 'html+json',
+      :full => 'full+json'
+    }
+
+    def parse(resource = nil, mime_type = :json)
+      resource  = lookup_resource(resource) if resource
+      mime_type = lookup_mime(mime_type)
+      self.accepts = "application/#{resource || ''}#{mime_type}"
+    end
+
+    def lookup_resource(name)
+      RESOURCE_LOOKUP.fetch(name)
+    end
+
+    def lookup_mime(name)
+      MIME_LOOKUP.fetch(name)
+    end
+
+    def _normalize_name(name)
+      puts "NAME: #{name}"
+      case name
+      when String
+        name.strip.downcase.to_sym
+      when Symbol
+        name
+      else
+        raise ArgumentError, 'Provided MIME Type is not a valid or recognized entry'
+      end
+    end
+
+  end # MimeType
+end # Github

data/lib/github_api/orgs.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+
+module Github
+  class Orgs < API
+    extend AutoloadHelper
+
+    autoload_all 'github_api/orgs',
+      :Members => 'members',
+      :Teams   => 'teams'
+
+    include Github::Orgs::Members
+    include Github::Orgs::Teams
+
+    VALID_ORG_PARAM_NAMES = %w[
+      billing_email
+      company
+      email
+      location
+      name
+    ].freeze
+
+    # Creates new Orgs API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # List all public organizations for a user.
+    #
+    # = Examples
+    #  @github = Github.new :user => 'user-name'
+    #  @github.orgs.orgs
+    #
+    # List public and private organizations for the authenticated user.
+    #
+    #  @github = Github.new :oauth_token => '..'
+    #  @github.orgs.orgs 'github'
+    #
+    def orgs(user_name=nil, params={})
+      _update_user_repo_params(user_name)
+      _normalize_params_keys(params)
+
+      response = if user?
+        get("/users/#{user}/orgs", params)
+      else
+        get("/user/orgs", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :list_orgs :orgs
+    alias :list_organizations :orgs
+
+    # Get properties for a single organization
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.orgs.org 'github'
+    #
+    def org(org_name, params={})
+      _validate_presence_of org_name
+      get("/orgs/#{org_name}", params)
+    end
+    alias :get_org :org
+    alias :organisation :org
+
+    # Edit organization
+    #
+    # = Parameters
+    # <tt>:billing_email</tt> - Optional string - Billing email address. This address is not publicized.
+    # <tt>:company</tt> - Optional string
+    # <tt>:email</tt> - Optional string
+    # <tt>:location</tt> - Optional string
+    # <tt>:name</tt> - Optional string
+    #
+    # = Examples
+    #  @github = Github.new :oauth_token => '...'
+    #  @github.orgs.edit_org 'github',
+    #    "billing_email" => "support@github.com",
+    #    "blog" => "https://github.com/blog",
+    #    "company" => "GitHub",
+    #    "email" => "support@github.com",
+    #    "location" => "San Francisco",
+    #    "name" => "github"
+    #
+    def edit_org(org_name, params={})
+      _validate_presence_of org_name
+      _normalize_params_keys(params)
+      _filter_params_keys(VALID_ORG_PARAM_NAMES, params)
+
+      patch("/orgs/#{org_name}", params)
+    end
+    alias :edit_organization :edit_org
+
+  end # Orgs
+end # Github