github_api 0.18.2 → 0.19.0

data/README.md

@@ -6,18 +6,16 @@
 
 [![Gem Version](https://badge.fury.io/rb/github_api.svg)][gem]
 [![Build Status](https://secure.travis-ci.org/piotrmurach/github.svg?branch=master)][travis]
-[![Code Climate](https://codeclimate.com/github/piotrmurach/github/badges/gpa.svg)][codeclimate]
+[![Maintainability](https://api.codeclimate.com/v1/badges/7dc798db81a62774f99b/maintainability)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/piotrmurach/github/badge.svg?branch=master)][coverage]
 [![Inline docs](http://inch-ci.org/github/piotrmurach/github.svg)][inchpages]
-[![Dependency Status](https://gemnasium.com/piotrmurach/github.svg?travis)][gemnasium]
 
 [gitter]: https://gitter.im/piotrmurach/github_api
 [gem]: http://badge.fury.io/rb/github_api
 [travis]: http://travis-ci.org/piotrmurach/github
-[codeclimate]: https://codeclimate.com/github/piotrmurach/github
+[codeclimate]: https://codeclimate.com/github/piotrmurach/github/maintainability
 [coverage]: https://coveralls.io/r/piotrmurach/github
 [inchpages]: http://inch-ci.org/github/piotrmurach/github
-[gemnasium]: https://gemnasium.com/piotrmurach/github
 
 [Website](http://piotrmurach.github.io/github/) | [Wiki](https://github.com/piotrmurach/github/wiki) | [RDocs](http://rubydoc.info/github/piotrmurach/github/master/frames)
 
@@ -738,4 +736,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/piotrm
 
 ## Copyright
 
-Copyright (c) 2011-2017 Piotr Murach. See LICENSE.txt for further details.
+Copyright (c) 2011 Piotr Murach. See LICENSE.txt for further details.

data/lib/github_api.rb

@@ -88,6 +88,5 @@ require_relative 'github_api/configuration'
 require_relative 'github_api/deprecation'
 require_relative 'github_api/core_ext/array'
 require_relative 'github_api/core_ext/hash'
-require_relative 'github_api/core_ext/ordered_hash'
 require_relative 'github_api/middleware'
 require_relative 'github_api/version'

data/lib/github_api/api.rb

@@ -229,7 +229,7 @@ module Github
 
     # Run all callbacks associated with this action
     #
-    # @apram [Symbol] action_name
+    # @param [Symbol] action_name
     #
     # @api private
     def run_callbacks(action_name, &block)

data/lib/github_api/api/arguments.rb

@@ -7,7 +7,7 @@ require_relative '../validations'
 
 module Github
   class API
-    # A class responsible for handilng request arguments
+    # A class responsible for handling request arguments
     class Arguments
       include Normalizer
       include ParameterFilter

data/lib/github_api/api/config.rb

@@ -73,7 +73,7 @@ module Github
         property_set.properties.map(&:name)
       end
 
-      # Fetach all the properties and their values
+      # Fetch all the properties and their values
       #
       # @return [Hash[Symbol]]
       #

data/lib/github_api/client/activity/starring.rb

@@ -118,7 +118,7 @@ module Github
     #   github.activity.starring.unstar 'user-name', 'repo-name'
     #
     # @example
-    #   github.activit.starring.unstar user: 'user-name', repo: 'repo-name'
+    #   github.activity.starring.unstar user: 'user-name', repo: 'repo-name'
     #
     # @api public
     def unstar(*args)

data/lib/github_api/client/activity/watching.rb

@@ -13,7 +13,7 @@ module Github
     # @example
     #   github = Github.new
     #   github.activity.watching.list user: 'user-name', repo: 'repo-name'
-    #   github.activity.watching.list user: 'user-naem', repo: 'repo-name' { |watcher| ... }
+    #   github.activity.watching.list user: 'user-name', repo: 'repo-name' { |watcher| ... }
     #
     # @api public
     def list(*args)

data/lib/github_api/client/gists.rb

@@ -143,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.
@@ -213,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

@@ -85,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/references.rb

@@ -35,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
@@ -143,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/markdown.rb

@@ -5,7 +5,7 @@ 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

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

@@ -79,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
@@ -125,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/cards.rb

@@ -66,8 +66,8 @@ module Github
     #  github.projects.cards.create :column_id, note: 'Card Note'
     #
     # @example
-    # github = Github.new
-    # github.projects.cards.create :column_id, content_id: <content-id>, content_type: 'content-type'
+    #   github = Github.new
+    #   github.projects.cards.create :column_id, content_id: <content-id>, content_type: 'content-type'
     #
     # @see https://developer.github.com/v3/projects/cards/#create-a-project-card
     #

data/lib/github_api/client/repos.rb

@@ -15,6 +15,7 @@ module Github
       'downloads',
       'forks',
       'hooks',
+      'invitations',
       'keys',
       'merging',
       'pages',
@@ -32,6 +33,7 @@ module Github
       homepage
       private
       has_issues
+      has_projects
       has_wiki
       has_downloads
       team_id
@@ -66,6 +68,9 @@ module Github
     # Access to Repos::Hooks API
     namespace :hooks
 
+    # Access to Repos::Invitations API
+    namespace :invitations
+
     # Access to Repos::Keys API
     namespace :keys
 
@@ -183,7 +188,7 @@ module Github
     end
     alias :find_by_id :get_by_id
 
-    # Create a new repository for the autheticated user.
+    # Create a new repository for the authenticated user.
     #
     # @param [Hash] params
     # @option params [String] :name

data/lib/github_api/client/repos/branches/protections.rb

@@ -40,7 +40,7 @@ module Github
     #   Required.
     # @input params [String] :required_pull_request_reviews
     #   Required.
-    # Look to the branch protection API t see how to use these
+    # Look to the branch protection API to see how to use these
     # https://developer.github.com/v3/repos/branches/#update-branch-protection
     #
     # @example

data/lib/github_api/client/repos/contents.rb

@@ -33,6 +33,23 @@ module Github
       get_request("/repos/#{arguments.user}/#{arguments.repo}/readme", arguments.params)
     end
 
+    # Get the LICENSE
+    #
+    # This method returns the contents of the repository's license file, if one is detected.
+    #
+    # @param [Hash] params
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.contents.license 'user-name', 'repo-name'
+    #
+    # @api public
+    def license(*args)
+      arguments(args, required: [:user, :repo])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/license", arguments.params)
+    end
+    
     # Get contents
     #
     # This method returns the contents of any file or directory in a repository.
@@ -66,12 +83,12 @@ module Github
     #
     # @param [Hash] params
     # @option params [String] :path
-    #   Requried string. The content path
+    #   Required string. The content path
     # @option params [String]
     # @option params [String] :message
-    #   Requried string. The commit message.
+    #   Required string. The commit message.
     # @option params [String] :content
-    #   Requried string. The new file content, which will be Base64 encoded
+    #   Required string. The new file content, which will be Base64 encoded
     # @option params [String] :branch
     #   The branch name. If not provided, uses the repository’s
     #   default branch (usually master)

data/lib/github_api/client/repos/deployments.rb

@@ -24,7 +24,7 @@ module Github
 
     # List deployments on a repository
     #
-    # @xample
+    # @example
     #  github = Github.new
     #  github.repos.deployments.list 'user-name', 'repo-name'
     #  github.repos.deployments.list 'user-name', 'repo-name' { |deployment| ... }

data/lib/github_api/client/repos/forks.rb

@@ -13,8 +13,10 @@ module Github
     #
     # @example
     #   github = Github.new
-    #   github.repos.forks.list 'user-name', 'repo-name'
-    #   github.repos.forks.list 'user-name', 'repo-name' { |fork| ... }
+    #   github.repos.forks.list('user-name', 'repo-name')
+    #   github.repos.forks.list('user-name', 'repo-name') { |fork|
+    #     #...
+    #   }
     #
     # @api public
     def list(*args)

data/lib/github_api/client/repos/invitations.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Repos::Invitations < API
+    # List repo invitations
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.invitations.list 'user-name', 'repo-name'
+    #
+    # @example
+    #  github.repos.invitations.list 'user-name', 'repo-name' { |cbr| .. }
+    #
+    # @return [Array]
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/invitations", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Deletes a repo invitation
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.invitations.delete 'user-name', 'repo-name', 'invitation-id'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :id])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/invitations/#{arguments.id}", arguments.params)
+    end
+  end
+end

data/lib/github_api/connection.rb

@@ -65,7 +65,7 @@ module Github
 
     # Creates http connection
     #
-    # Returns a Fraday::Connection object
+    # Returns a Faraday::Connection object
     def connection(api, options = {})
       connection_options = default_options(options)
       connection_options.merge!(builder: stack(options.merge!(api: api)))

data/lib/github_api/error/service_error.rb

@@ -33,7 +33,7 @@ module Github
 
       MIN_BODY_LENGTH = 2
 
-      # Crate a ServiceError
+      # Create a ServiceError
       #
       # @param [Hash[Symbol]] response
       #

data/lib/github_api/ext/faraday.rb

@@ -17,6 +17,8 @@ module Faraday
       end
     end
 
+    module_function
+
     def build_nested_query(value, prefix = nil, encoder = nil)
       case value
       when Array

data/lib/github_api/pagination.rb

@@ -14,7 +14,7 @@ module Github
       @links = Github::PageLinks.new(env[:response_headers])
     end
 
-    # Retrive number of total pages base on current :per_page parameter
+    # Retrieve number of total pages base on current :per_page parameter
     def count_pages
       page_iterator.count.to_i
     end
@@ -43,7 +43,7 @@ module Github
       end
     end
 
-    # Retrives the result of the first page. Returns <tt>nil</tt> if there is
+    # Retrieves the result of the first page. Returns <tt>nil</tt> if there is
     # no first page - either because you are already on the first page
     # or there are no pages at all in the result.
     def first_page
@@ -52,7 +52,7 @@ module Github
       first_request
     end
 
-    # Retrives the result of the next page. Returns <tt>nil</tt> if there is
+    # Retrieves the result of the next page. Returns <tt>nil</tt> if there is
     # no next page or no pages at all.
     def next_page
       next_request = page_iterator.next
@@ -60,7 +60,7 @@ module Github
       next_request
     end
 
-    # Retrives the result of the previous page. Returns <tt>nil</tt> if there is
+    # Retrieves the result of the previous page. Returns <tt>nil</tt> if there is
     # no previous page or no pages at all.
     def prev_page
       prev_request = page_iterator.prev
@@ -69,7 +69,7 @@ module Github
     end
     alias :previous_page :prev_page
 
-    # Retrives the result of the last page. Returns <tt>nil</tt> if there is
+    # Retrieves the result of the last page. Returns <tt>nil</tt> if there is
     # no last page - either because you are already on the last page,
     # there is only one page or there are no pages at all in the result.
     def last_page
@@ -78,7 +78,7 @@ module Github
       last_request
     end
 
-    # Retrives a specific result for a page given page number.
+    # Retrieves a specific result for a page given page number.
     # The <tt>page_number</tt> parameter is not validate, hitting a page
     # that does not exist will return Github API error. Consequently, if
     # there is only one page, this method returns nil

data/lib/github_api/request.rb

@@ -43,8 +43,7 @@ module Github
 
     # Performs a request
     #
-    # @param [Symbol] method - The Symbol the HTTP verb
-    # @param [String] path   - String relative URL to access
+    # @param current_options [Hash]
     # @param [ParamsHash] params - ParamsHash to configure the request API
     #
     # @return [Github::ResponseWrapper]
@@ -52,7 +51,7 @@ module Github
     # @api private
     def call(current_options, params)
       unless HTTP_METHODS.include?(action)
-        raise ArgumentError, "unknown http method: #{method}"
+        raise ArgumentError, "unknown http method: #{action}"
       end
 
       puts "EXECUTED: #{action} - #{path} with PARAMS: #{params.request_params}" if ENV['DEBUG']

data/lib/github_api/response/follow_redirects.rb

@@ -8,7 +8,7 @@ require 'set'
 
 module Github
   # Public: Exception thrown when the maximum amount of requests is exceeded.
-  class RedirectLimitReached < Faraday::Error::ClientError
+  class RedirectLimitReached < Faraday::ClientError
     attr_reader :response
 
     def initialize(response)

data/lib/github_api/validations/presence.rb

@@ -7,7 +7,7 @@ module Github
     # A mixin to help validate presence of non-empty values
     module Presence
 
-      # Ensure that esential arguments are present before request is made.
+      # Ensure that essential arguments are present before request is made.
       #
       # == Parameters
       #  Hash/Array of arguments to be checked against nil and empty string