octokit 4.4.1 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6aa10939cffe82d296241156f5a525af0248781
-  data.tar.gz: 4aa903146125181a74a3ef1a7bff17e8f10bb94f
+  metadata.gz: 3e102d4ef66b25de05af28e8b5567425ae621968
+  data.tar.gz: 4d2c7a2aebf56bca3e81d51ffcbc8f0ee4b23790
 SHA512:
-  metadata.gz: efb02836832726725a220c404a755029fc97e9291b8d2c352c5efa0005641e1b0cb7a28d943f3e2b2b995e2b28d91a97351f2677a0c2fd3cfb2e60d035a0e4ac
-  data.tar.gz: e7c3d74b3c5ddb82614a22109ce5fdb0bcf93698995e1ee5047ecc68326e606c94c709c5a0d160625889743f6cf295c68e88bc31f32d080dfa81b693be05d710
+  metadata.gz: cd6383e5f75b45f5f8d216a0e95cc19569306b10962016d186a4638509e3d3eea31dfff33e2b380c8fe88f683bfe67f21ea60d6f68481cc1933567de508cf0a3
+  data.tar.gz: ed9dae41551580e6f60ee0fc0c03da83d5e85b8d3e81282c1155a859b2c2be19d8a14c33004a431f123a4a2c17a0992106b9a1052867b80a4dbda4485f375a00

data/lib/octokit/client.rb

@@ -33,6 +33,7 @@ require 'octokit/client/notifications'
 require 'octokit/client/objects'
 require 'octokit/client/organizations'
 require 'octokit/client/pages'
+require 'octokit/client/projects'
 require 'octokit/client/pub_sub_hubbub'
 require 'octokit/client/pull_requests'
 require 'octokit/client/rate_limit'
@@ -47,6 +48,7 @@ require 'octokit/client/service_status'
 require 'octokit/client/source_import'
 require 'octokit/client/stats'
 require 'octokit/client/statuses'
+require 'octokit/client/traffic'
 require 'octokit/client/users'
 
 module Octokit
@@ -84,6 +86,7 @@ module Octokit
     include Octokit::Client::Objects
     include Octokit::Client::Organizations
     include Octokit::Client::Pages
+    include Octokit::Client::Projects
     include Octokit::Client::PubSubHubbub
     include Octokit::Client::PullRequests
     include Octokit::Client::RateLimit
@@ -98,6 +101,7 @@ module Octokit
     include Octokit::Client::SourceImport
     include Octokit::Client::Stats
     include Octokit::Client::Statuses
+    include Octokit::Client::Traffic
     include Octokit::Client::Users
 
     # Header keys that can be passed in options hash to {#get},{#head}

data/lib/octokit/client/projects.rb

@@ -0,0 +1,314 @@
+module Octokit
+  class Client
+
+    # Methods for Projects API
+    #
+    # @see https://developer.github.com/v3/repos/projects
+    module Projects
+
+      # List projects for a repository
+      #
+      # Requires authenticated client
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @return [Array<Sawyer::Resource>] Repository projects
+      # @see https://developer.github.com/v3/projects/#list-repository-projects 
+      # @example
+      #   @client.projects('octokit/octokit.rb')
+      def projects(repo, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        paginate "#{Repository.path repo}/projects", opts
+      end
+
+      # Create a project
+      #
+      # Requires authenticated client
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param name [String] Project name
+      # @option options [String] :body Body of the project
+      # @return [Sawyer::Resource] Fresh new project
+      # @see https://developer.github.com/v3/projects/#create-a-repository-project 
+      # @example Create project with only a name
+      #   @client.create_project('octokit/octokit.rb', 'implement new APIs')
+      #
+      # @example Create project with name and body
+      #   @client.create_project('octokit/octokit.rb', 'bugs be gone', body: 'Fix all the bugs @joeyw creates')
+      def create_project(repo, name, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        opts[:name] = name
+        post "#{Repository.path repo}/projects", opts
+      end
+
+      # List organization projects
+      #
+      # Requires authenticated client
+      #
+      # @param org [String] A GitHub organization
+      # @return [Array<Sawyer::Resource>] Organization projects
+      # @see https://developer.github.com/v3/projects/#list-organization-projects
+      # @example
+      #   @client.org_projects("octokit")
+      def org_projects(org, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        get "orgs/#{org}/projects", opts
+      end
+      alias :organization_projects :org_projects
+
+      # Create organization project
+      #
+      # Requires authenticated client
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Project name
+      # @option options [String] :body Project body
+      # @return [Sawyer::Resource] Organization project
+      # @see https://developer.github.com/v3/projects/#create-an-organization-project
+      # @example Create with only a name
+      #   @client.create_org_project("octocat", "make more octocats")
+      # @example Create a project with name and body
+      #   @client.create_org_project("octokit", "octocan", body: 'Improve clients')
+      def create_org_project(org, name, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        opts[:name] = name
+        post "orgs/#{org}/projects", opts
+      end
+      alias :create_organization_project :create_org_project
+
+      # Get a project by id 
+      #
+      # @param id [Integer] Project id
+      # @return [Sawyer::Resource] Project
+      # @see https://developer.github.com/v3/projects/#get-a-project 
+      # @example
+      #   Octokit.project("octokit/octokit.rb", 1)
+      def project(id, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        get "projects/#{id}", opts
+      end
+
+      # Update a project
+      #
+      # Requires authenticated client
+      #
+      # @param id [Integer] Project id
+      # @option options [String] :name Project name
+      # @option options [String] :body Project body
+      # @return [Sawyer::Resource] Project
+      # @see https://developer.github.com/v3/projects/#update-a-project 
+      # @example Update project name
+      #   @client.update_project(123942, name: 'New name')
+      def update_project(id, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        patch "projects/#{id}", opts
+      end
+
+      # Delete a project
+      #
+      # Requires authenticated client
+      #
+      # @param id [Integer] Project id
+      # @return [Boolean] Result of deletion
+      # @see https://developer.github.com/v3/projects/#delete-a-project 
+      # @example
+      #   @client.delete_project(123942)
+      def delete_project(id, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        boolean_from_response :delete, "projects/#{id}", opts
+      end
+
+      # List project columns
+      #
+      # @param id [Integer] Project id 
+      # @return [Array<Sawyer::Resource>] List of project columns
+      # @see https://developer.github.com/v3/projects/columns/#list-project-columns 
+      # @example
+      #   @client.project_columns("octokit/octokit.rb", 1)
+      def project_columns(id, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        paginate "projects/#{id}/columns", opts
+      end
+
+      # Create a project column
+      #
+      # Requires authenticated client
+      #
+      # @param id [Integer] Project column id
+      # @param name [String] New column name
+      # @return [Sawyer::Resource] Newly created column
+      # @see https://developer.github.com/v3/projects/columns/#create-a-project-column 
+      # @example
+      #   @client.create_project_column("octokit/octokit.rb", 1, "To Dones")
+      def create_project_column(id, name, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        opts[:name] = name
+        post "projects/#{id}/columns", opts
+      end
+
+      # Get a project column by ID
+      #
+      # @param id [Integer] Project column id
+      # @return [Sawyer::Resource] Project column
+      # @see https://developer.github.com/v3/projects/columns/#get-a-project-column 
+      # @example
+      #   Octokit.project_column(123940, 30)
+      def project_column(id, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        get "projects/columns/#{id}", opts
+      end
+
+      # Update a project column
+      #
+      # Requires authenticated client
+      #
+      # @param id [Integer] Project column id
+      # @param name [String] New column name
+      # @return [Sawyer::Resource] Updated column
+      # @see https://developer.github.com/v3/projects/columns/#update-a-project-column 
+      # @example
+      #   @client.update_project_column(30294, "new column name")
+      def update_project_column(id, name, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        opts[:name] = name
+        patch "projects/columns/#{id}", opts
+      end
+
+      # Delete a project column
+      #
+      # Requires authenticated client
+      #
+      # @param id [Integer] Project column id
+      # @return [Boolean] Result of deletion request, true when deleted
+      # @see https://developer.github.com/v3/projects/columns/#delete-a-project-column 
+      # @example
+      #   @client.delete_project_column(30294)
+      def delete_project_column(id, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        boolean_from_response :delete, "projects/columns/#{id}", opts
+      end
+
+      # Move a project column
+      #
+      # Requires authenticated client
+      #
+      # @param id [Integer] Project column id
+      # @param position [String] New position for the column. Can be one of 
+      #   <tt>first</tt>, <tt>last</tt>, or <tt>after:<column-id></tt>, where
+      #   <tt><column-id></tt> is the id value of a column in the same project.
+      # @return [Sawyer::Resource] Result
+      # @see https://developer.github.com/v3/projects/columns/#move-a-project-column
+      # @example
+      #   @client.move_project_column(3049, "last")
+      def move_project_column(id, position, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        opts[:position] = position
+        post "projects/columns/#{id}/moves", opts
+      end
+
+      # List columns cards
+      #
+      # Requires authenticated client
+      #
+      # @param id [Integer] Project column id
+      # @return [Array<Sawyer::Resource>] Cards in the column
+      # @see https://developer.github.com/v3/projects/cards/#list-project-cards
+      # @example
+      #   @client.column_cards(123847)
+      def column_cards(id, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        paginate "projects/columns/#{id}/cards", opts
+      end
+
+      # Create project card
+      #
+      # Requires authenticated client
+      #
+      # @param id [Integer] Project column id
+      # @option options [String] :note Card contents for a note type
+      # @option options [Integer] :content_id Issue ID for the card contents
+      # @option options [String] :content_type Type of content to associate
+      #   with the card. <tt>Issue</tt> is presently the only avaiable value
+      # @note If :note is supplied, :content_id and :content_type must be
+      #   excluded. Similarly, if :content_id is supplied, :content_type must
+      #   be set and :note must not be included.
+      # @return [Sawyer::Resource] Newly created card
+      # @see https://developer.github.com/v3/projects/cards/#create-a-project-card
+      # @example Create a project card with a note
+      #   @client.create_project_card(123495, note: 'New note card')
+      # @example Create a project card for an repository issue
+      #   @client.create_project_card(123495, content_id: 1, content_type: 'Issue')
+      def create_project_card(id, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        post "projects/columns/#{id}/cards", opts
+      end
+
+      # Get a project card
+      #
+      # Requires authenticated client
+      #
+      # @param id [Integer] Project card id
+      # @return [Sawyer::Resource] Project card
+      # @see https://developer.github.com/v3/projects/cards/#get-a-project-card
+      # @example
+      #   @client.project_card(123495)
+      def project_card(id, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        get "projects/columns/cards/#{id}", opts
+      end
+
+      # Update a project card
+      #
+      # Requires authenticated client
+      #
+      # @param id [Integer] Project card id
+      # @option options [String] :note The card's note content. Only valid for
+      #   cards without another type of content, so this cannot be specified if
+      #   the card already has a content_id and content_type.
+      # @return [Sawyer::Resource] Updated project card
+      # @see https://developer.github.com/v3/projects/cards/#update-a-project-card
+      # @example
+      #   @client.update_project_card(12345, note: 'new note')
+      def update_project_card(id, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        patch "projects/columns/cards/#{id}", opts
+      end
+
+      # Move a project card
+      #
+      # Requires authenticated client
+      #
+      # @param id [Integer] Project card id
+      # @param position [String] Can be one of <tt>top</tt>, <tt>bottom</tt>,
+      #   or <tt>after:<card-id></tt>, where <card-id> is the id value of a
+      #   card in the same column, or in the new column specified by column_id.
+      # @option options [Integer] :column_id The column id to move the card to,
+      #   must be column in same project
+      # @return [Sawyer::Resource] Empty sawyer resource
+      # @see https://developer.github.com/v3/projects/cards/#move-a-project-card
+      # @example Move a card to the bottom of the same column
+      #   @client.move_project_card(123495, 'bottom')
+      # @example Move a card to the top of another column
+      #   @client.move_project_card(123495, 'top', column_id: 59402)
+      def move_project_card(id, position, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        opts[:position] = position
+        post "projects/columns/cards/#{id}/moves", opts
+      end
+
+      # Delete a project card
+      # 
+      # Requires authenticated client
+      #
+      # @param id [Integer] Project card id
+      # @return [Boolean] True of deleted, false otherwise
+      # @see https://developer.github.com/v3/projects/cards/#delete-a-project-card
+      # @example
+      #   @client.delete_project_card(123495)
+      def delete_project_card(id, options = {})
+        opts = ensure_api_media_type(:projects, options)
+        boolean_from_response :delete, "projects/columns/cards/#{id}", opts
+      end
+
+    end # Projects
+  end
+end

data/lib/octokit/client/repositories.rb

@@ -499,17 +499,25 @@ module Octokit
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository.
       # @param branch [String] Branch name
-      # @param required_status_checks [Hash]
+      # @option options [Hash] :required_status_checks If not null, the following keys are required:  
+      #   <tt>:include_admins [boolean] Enforce required status checks for repository administrators.</tt>  
+      #   <tt>:strict [boolean] Require branches to be up to date before merging.</tt>  
+      #   <tt>:contexts [Array] The list of status checks to require in order to merge into this branch</tt>  
+      #
+      # @option options [Hash] :restrictions If not null, the following keys are required:
+      #   <tt>:users [Array] The list of user logins with push access</tt>  
+      #   <tt>:teams [Array] The list of team slugs with push access</tt>.  
+      #
+      #   Teams and users restrictions are only available for organization-owned repositories.
       # @return [Sawyer::Resource] The protected branch
       # @see https://developer.github.com/v3/repos/#enabling-and-disabling-branch-protection
       # @example
       #   @client.protect_branch('octokit/octokit.rb', 'master', foo)
-      def protect_branch(repo, branch, required_status_checks = {}, options = {})
-        required_status_checks[:restrictions] ||= nil
-        required_status_checks[:required_status_checks] ||= nil
-
-        options = ensure_api_media_type(:branch_protection, options.merge(required_status_checks))
-        put "#{Repository.path repo}/branches/#{branch}/protection", options
+      def protect_branch(repo, branch, options = {})
+        opts = ensure_api_media_type(:branch_protection, options)
+        opts[:restrictions] ||= nil
+        opts[:required_status_checks] ||= nil
+        put "#{Repository.path repo}/branches/#{branch}/protection", opts
       end
 
       # Get branch protection summary
@@ -541,8 +549,8 @@ module Octokit
       # @example
       #   @client.unprotect_branch('octokit/octokit.rb', 'master')
       def unprotect_branch(repo, branch, options = {})
-        options = ensure_api_media_type(:branch_protection, options)
-        delete "#{Repository.path repo}/branches/#{branch}/protection", options
+        opts = ensure_api_media_type(:branch_protection, options)
+        boolean_from_response :delete, "#{Repository.path repo}/branches/#{branch}/protection", opts
       end
 
       # List users available for assigning to issues.

data/lib/octokit/client/traffic.rb

@@ -0,0 +1,69 @@
+module Octokit
+  class Client
+
+    # Methods for the Traffic API
+    #
+    # @see https://developer.github.com/v3/repos/traffic/
+    module Traffic
+
+      # Get the top 10 referrers over the last 14 days
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @return [Array<Sawyer::Resource>] List of referrers and stats
+      # @see https://developer.github.com/v3/repos/traffic/#list-referrers
+      # @example
+      #   @client.top_referrers('octokit/octokit.rb')
+      def top_referrers(repo, options = {})
+        opts = ensure_api_media_type(:traffic, options)
+        get "#{Repository.path repo}/traffic/popular/referrers", opts
+      end
+
+      # Get the top 10 popular contents over the last 14 days
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @return [Array<Sawyer::Resource>] List of popular contents
+      # @see https://developer.github.com/v3/repos/traffic/#list-paths
+      # @example
+      #   @client.top_paths('octokit/octokit.rb')
+      def top_paths(repo, options = {})
+        opts = ensure_api_media_type(:traffic, options)
+        get "#{Repository.path repo}/traffic/popular/paths", opts
+      end
+
+      # Get the total number of views and breakdown per day or week for the
+      # last 14 days
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub Repository
+      # @option options [String] :per ('day') Views per. <tt>day</tt> or
+      #   <tt>week</tt>
+      # @return [Sawyer::Resource] Breakdown of view stats
+      # @see https://developer.github.com/v3/repos/traffic/#views
+      # @example Views per day
+      #   @client.views('octokit/octokit.rb')
+      # @example Views per week
+      #   @client.views('octokit/octokit.rb', per: 'week')
+      def views(repo, options = {})
+        opts = ensure_api_media_type(:traffic, options)
+        get "#{Repository.path repo}/traffic/views", opts
+      end
+
+      # Get the total number of clones and breakdown per day or week for the
+      # last 14 days
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub Repository
+      # @option options [String] :per ('day') Views per. <tt>day</tt> or
+      #   <tt>week</tt>
+      # @return [Sawyer::Resource] Breakdown of clone stats
+      # @see https://developer.github.com/v3/repos/traffic/#clones
+      # @example Clones per day
+      #   @client.clones('octokit/octokit.rb')
+      # @example Clones per week
+      #   @client.clones('octokit/octokit.rb', per: 'week')
+      def clones(repo, options = {})
+        opts = ensure_api_media_type(:traffic, options)
+        get "#{Repository.path repo}/traffic/clones", opts
+      end
+
+    end
+  end
+end

data/lib/octokit/preview.rb

@@ -11,7 +11,9 @@ module Octokit
       :reactions              => 'application/vnd.github.squirrel-girl-preview'.freeze,
       :repository_invitations => 'application/vnd.github.swamp-thing-preview+json'.freeze,
       :issue_timelines        => 'application/vnd.github.mockingbird-preview+json'.freeze,
-      :pages                  => 'application/vnd.github.mister-fantastic-preview+json'.freeze
+      :pages                  => 'application/vnd.github.mister-fantastic-preview+json'.freeze,
+      :projects               => 'application/vnd.github.inertia-preview+json'.freeze,
+      :traffic                => 'application/vnd.github.spiderman-preview'.freeze
     }
 
     def ensure_api_media_type(type, options)

data/lib/octokit/version.rb

@@ -5,11 +5,11 @@ module Octokit
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 4
+  MINOR = 6
 
   # Current patch level.
   # @return [Integer]
-  PATCH = 1
+  PATCH = 0
 
   # Full release version.
   # @return [String]

data/octokit.gemspec

@@ -5,7 +5,7 @@ require 'octokit/version'
 
 Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.0'
-  spec.add_dependency 'sawyer', '>= 0.5.3', '~> 0.7.0'
+  spec.add_dependency 'sawyer', '>= 0.5.3', '~> 0.8.0'
   spec.authors = ["Wynn Netherland", "Erik Michaels-Ober", "Clint Shryock"]
   spec.description = %q{Simple wrapper for the GitHub API}
   spec.email = ['wynn.netherland@gmail.com', 'sferik@gmail.com', 'clint@ctshryock.com']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 4.4.1
+  version: 4.6.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-25 00:00:00.000000000 Z
+date: 2016-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -35,7 +35,7 @@ dependencies:
         version: 0.5.3
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -45,7 +45,7 @@ dependencies:
         version: 0.5.3
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
 description: Simple wrapper for the GitHub API
 email:
 - wynn.netherland@gmail.com
@@ -87,6 +87,7 @@ files:
 - lib/octokit/client/objects.rb
 - lib/octokit/client/organizations.rb
 - lib/octokit/client/pages.rb
+- lib/octokit/client/projects.rb
 - lib/octokit/client/pub_sub_hubbub.rb
 - lib/octokit/client/pull_requests.rb
 - lib/octokit/client/rate_limit.rb
@@ -101,6 +102,7 @@ files:
 - lib/octokit/client/source_import.rb
 - lib/octokit/client/stats.rb
 - lib/octokit/client/statuses.rb
+- lib/octokit/client/traffic.rb
 - lib/octokit/client/users.rb
 - lib/octokit/configurable.rb
 - lib/octokit/connection.rb