github_api 0.15.0 → 0.19.0

data/lib/github_api/client/authorizations.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../api'
+
 module Github
   # OAuth Authorizations API
   class Client::Authorizations < API

data/lib/github_api/client/authorizations/app.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Authorizations::App < Client::Authorizations
     # Get-or-create an authorization for a specific app
@@ -47,7 +49,7 @@ module Github
       if arguments.client_id
         begin
           get_request("/applications/#{arguments.client_id}/tokens/#{arguments.access_token}", params)
-        rescue Github::Error::NotFound => e
+        rescue Github::Error::NotFound
           nil
         end
       else

data/lib/github_api/client/emojis.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../api'
+
 module Github
   class Client::Emojis < API
     # Lists all the emojis.

data/lib/github_api/client/gists.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../api'
+
 module Github
   class Client::Gists < API
 
@@ -141,7 +143,7 @@ module Github
     #   Optional string
     # @option [Hash] :files
     #   Optional hash - Files that make up this gist.
-    #   The key of which should be a optional string filename and 
+    #   The key of which should be a optional string filename and
     #   the value another optional hash with parameters:
     #     @option [String] :content
     #       Updated string - Update file contents.
@@ -211,7 +213,7 @@ module Github
     #
     # @see https://developer.github.com/v3/gists/#unstar-a-gist
     #
-    # @xample
+    # @example
     #  github = Github.new
     #  github.gists.unstar 'gist-id'
     #

data/lib/github_api/client/gists/comments.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Gists::Comments < API
     # List comments on a gist
@@ -83,7 +85,7 @@ module Github
     #
     # @see https://developer.github.com/v3/gists/comments/#delete-a-comment
     #
-    # @xample
+    # @example
     #   github = Github.new
     #   github.gists.comments.delete 'gist-id', 'comment-id'
     #

data/lib/github_api/client/git_data.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../api'
+
 module Github
   class Client::GitData < API
 

data/lib/github_api/client/git_data/blobs.rb

@@ -1,7 +1,8 @@
 # encoding: utf-8
 
-module Github
+require_relative '../../api'
 
+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.

data/lib/github_api/client/git_data/commits.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::GitData::Commits < API
 

data/lib/github_api/client/git_data/references.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::GitData::References < API
 
@@ -33,8 +35,8 @@ module Github
       repo = arguments.repo
 
       response = if (ref = params.delete('ref'))
-        validate_reference ref
-        get_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
+        formatted_ref = validate_reference ref
+        get_request("/repos/#{user}/#{repo}/git/#{formatted_ref}", params)
       else
         get_request("/repos/#{user}/#{repo}/git/refs", params)
       end
@@ -141,6 +143,8 @@ module Github
       unless VALID_REF_PARAM_VALUES['ref'] =~ refs
         raise ArgumentError, "Provided 'reference' is invalid"
       end
+
+      refs
     end
   end # GitData::References
 end # Github

data/lib/github_api/client/git_data/tags.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::GitData::Tags < API
     # This tags api only deals with tag objects -

data/lib/github_api/client/git_data/trees.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::GitData::Trees < API
 

data/lib/github_api/client/gitignore.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../api'
+
 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.

data/lib/github_api/client/issues.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../api'
+
 module Github
   class Client::Issues < API
 

data/lib/github_api/client/issues/assignees.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Issues::Assignees < API
     # Lists all the available assignees (owner + collaborators)
@@ -38,5 +40,38 @@ module Github
     rescue Github::Error::NotFound
       false
     end
+
+    # Add assignees to an issue
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.assignees.add 'user', 'repo', 'issue-number',
+    #     'hubot', 'other_assignee', ...
+    #
+    # @api public
+    def add(*args)
+      arguments(args, required: [:user, :repo, :number])
+      params = arguments.params
+      params['data'] = { 'assignees' => arguments.remaining } unless arguments.remaining.empty?
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/issues/#{arguments.number}/assignees", params)
+    end
+    alias :<< :add
+
+    # Remove a assignees from an issue
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.assignees.remove 'user', 'repo', 'issue-number',
+    #     'hubot', 'other_assignee'
+    #
+    # @api public
+    def remove(*args)
+      arguments(args, required: [:user, :repo, :number])
+      params = arguments.params
+      params['data'] = { 'assignees' => arguments.remaining } unless arguments.remaining.empty?
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/issues/#{arguments.number}/assignees", params)
+    end
   end # Issues::Assignees
 end # Github

data/lib/github_api/client/issues/comments.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Issues::Comments < API
 

data/lib/github_api/client/issues/events.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Issues::Events < API
     # List events for an issue

data/lib/github_api/client/issues/labels.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Issues::Labels < API
 

data/lib/github_api/client/issues/milestones.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Issues::Milestones < API
 

data/lib/github_api/client/markdown.rb

@@ -1,9 +1,11 @@
 # encoding: utf-8
 
+require_relative '../api'
+
 module Github
   class Client::Markdown < API
 
-    # Render an arbritrary Markdown document
+    # Render an arbitrary Markdown document
     #
     # = Parameters
     #  <tt>:text</tt> - Required string - The Markdown text to render
@@ -49,7 +51,7 @@ module Github
     #
     def render_raw(*args)
       params = arguments(args).params
-      mime_type, params['data'] = params['mime'], args.shift
+      params['data'] = args.shift
       params['raw'] = true
       params['accept'] = params.fetch('accept') { 'text/plain' }
 

data/lib/github_api/client/meta.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../api'
+
 module Github
   class Client::Meta < API
     # Get meta information about GitHub.com, the service.

data/lib/github_api/client/orgs.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../api'
+
 module Github
   # Organizations API
   class Client::Orgs < API
@@ -8,6 +10,7 @@ module Github
                 'hooks',
                 'members',
                 'memberships',
+                'projects',
                 'teams'
 
     # Access to Client::Orgs::Hooks API
@@ -19,6 +22,9 @@ module Github
     # Access to Client::Orgs::Memberships API
     namespace :memberships
 
+    # Access to Client::Orgs::Projects API
+    namespace :projects
+
     # Access to Client::Orgs::Teams API
     namespace :teams
 

data/lib/github_api/client/orgs/hooks.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   # The Organizations Hooks API manages the post-receive web and
   # service hooks for an organization.

data/lib/github_api/client/orgs/members.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Orgs::Members < API
     # List members

data/lib/github_api/client/orgs/memberships.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Orgs::Memberships < API
     # List your organization memberships

data/lib/github_api/client/orgs/projects.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative '../../api'
+
+module Github
+  class Client::Orgs::Projects < API
+    PREVIEW_MEDIA = "application/vnd.github.inertia-preview+json".freeze # :nodoc:
+
+    # List your organization projects
+    #
+    # @see List your organization projects
+    #
+    # @example
+    #   github = Github.new 'org-name'
+    #   github.orgs.projects.list 'org-name' { |project| ... }
+    #
+    # @example
+    #  github = Github.new
+    #  github.orgs.projects.list 'org-name', state: 'closed'
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:org_name])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      response = get_request("/orgs/#{arguments.org_name}/projects", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # Create a new project for the specified repo
+    #
+    # @param [Hash] params
+    # @option params [String] :name
+    #   Required string - The name of the project.
+    # @option params [String] :body
+    #   Optional string - The body of the project.
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.create 'owner-name', 'repo-name', name: 'project-name'
+    #  github.repos.create name: 'project-name', body: 'project-body', owner: 'owner-name', repo: 'repo-name'
+    def create(*args)
+      arguments(args, required: [:org_name]) do
+        assert_required %w[ name ]
+      end
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      post_request("/orgs/#{arguments.org_name}/projects", params)
+    end
+  end # Projects
+end # Github

data/lib/github_api/client/orgs/teams.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   # All actions against teams require at a minimum an authenticated user
   # who is a member of the owner's team in the :org being managed.
@@ -77,7 +79,7 @@ module Github
     #    * pull - team members can pull, but not push or
     #             administor this repositories.
     #    * push - team members can pull and push,
-    #             but not administor this repositores.
+    #             but not administer this repositores.
     #    * admin - team members can pull, push and
     #              administor these repositories.
     #   Default: pull
@@ -123,9 +125,9 @@ module Github
     #    * pull - team members can pull, but not push or
     #             administor this repositories.
     #    * push - team members can pull and push,
-    #             but not administor this repositores.
+    #             but not administer this repositores.
     #    * admin - team members can pull, push and
-    #              administor these repositories.
+    #              administer these repositories.
     #   Default: pull
     #
     # @example

data/lib/github_api/client/projects.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require_relative '../api'
+
+module Github
+  # Projects API
+  class Client::Projects < API
+    PREVIEW_MEDIA = "application/vnd.github.inertia-preview+json" # :nodoc:
+
+    require_all 'github_api/client/projects',
+                'columns',
+                'cards'
+
+    # Access to Projects::Columns API
+    namespace :columns
+
+    # Access to Projects::Cards API
+    namespace :cards
+
+    # Get properties for a single project
+    #
+    # @see https://developer.github.com/v3/projects/#get-a-project
+    #
+    # @example
+    #  github = Github.new
+    #  github.projects.get 1002604
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:id])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      get_request("/projects/#{arguments.id}", params)
+    end
+    alias find get
+
+    # Edit a project
+    #
+    # @param [Hash] params
+    # @option params [String] :name
+    #   Optional string
+    # @option params [String] :body
+    #   Optional string
+    # @option params [String] :state
+    #   Optional string
+    #
+    # @example
+    #  github = Github.new
+    #  github.projects.edit 1002604,
+    #    name: "Outcomes Tracker",
+    #    body: "The board to track work for the Outcomes application."
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:id])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      patch_request("/projects/#{arguments.id}", params)
+    end
+
+    # Delete a project
+    #
+    # @example
+    #  github = Github.new
+    #  github.projects.delete 1002604
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:id])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      delete_request("/projects/#{arguments.id}", arguments.params)
+    end
+    alias remove delete
+  end # Projects
+end # Github