github_api 0.12.4 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cff15a176a3ab3a5fc89519f2fadd76cd7c3a334
-  data.tar.gz: d7e862b6cb3b09203d71a95ab43ae062183eb3fe
+  metadata.gz: a71c5d538e4a0188b7991e64d288552324618f74
+  data.tar.gz: 912f75917c8be1cbce0eec32496a6f15eca9c6c1
 SHA512:
-  metadata.gz: f39bd5c587a1e6db6c3f072f53ddbb682c7b34373217a9d72f050fa424bbb32805a8d4110daf375b10edeeda596feae8644aa86c15317844ad17369f5030f75d
-  data.tar.gz: 8e678463209d56ab1e5076a3bc54068624a96d9b931cb0fef40b8f04c01ad87e3e24c44783428de5350aa8475da9a9377b9a033aff56a1404638dd3c9929e218
+  metadata.gz: ddda23aac44bc2a628e0d100458f583615324c4fc7cab05da43ec886a9e087581a09faedbbcfef7c2db75fe2d8c4ea1dde3c1eadd2c5f2971bf2406d4829bf1e
+  data.tar.gz: e5f063e110e1f3b94b2e9d7fba6dae3cf6209c692b315cd2e33d992520d1d2dff70d35fbc4a388eab652d246ce17735b024366e4d873961bb3cd0ba99d028fb6

data/README.md

@@ -1,6 +1,7 @@
-[![Application icon](https://github.com/peter-murach/github/raw/master/icons/github_api.png)][icon]
-[icon]: https://github.com/peter-murach/github/raw/master/icons/github_api.png
-# github_api
+<div align="center">
+  <a href="http://peter-murach.github.io/github/"><img width="136" src="https://github.com/peter-murach/github/raw/master/icons/github_api.png" alt="github api logo" /></a>
+</div>
+# GithubAPI
 [![Gem Version](https://badge.fury.io/rb/github_api.svg)][gem]
 [![Build Status](https://secure.travis-ci.org/peter-murach/github.svg?branch=master)][travis]
 [![Code Climate](https://codeclimate.com/github/peter-murach/github/badges/gpa.svg)][codeclimate]
@@ -138,7 +139,7 @@ Github::Client::Repos::Contents.actions
 The code base is modular. This means that you can work specifically with a given part of GitHub API. If you want to only work with activity starring API do the following:
 
 ```ruby
-starring = Github::Client::Activity::Starring.new
+starring = Github::Client::Activity::Starring.new oauth_token: token
 starring.star 'peter-murach', 'github'
 ```
 
@@ -404,13 +405,13 @@ Though this method is convenient you should strongly consider using `OAuth` for
 
 ### 3.2 Authorizations API
 
-#### 3.2.1 For an User
+#### 3.2.1 For a User
 
-To create an access token through the GitHub Authrizations API, you are required to pass your basic credentials and scopes you wish to have for the authentication token.
+To create an access token through the GitHub Authorizations API, you are required to pass your basic credentials and scopes you wish to have for the authentication token.
 
 ```ruby
 github = Github.new basic_auth: 'login:password'
-github.oauth.create scopes: ['repo']
+github.oauth.create scopes: ['repo'], note: 'admin script'
 ```
 
 You can add more than one scope from the `user`, `public_repo`, `repo`, `gist` or leave the scopes parameter out, in which case, the default read-only access will be assumed (includes public user profile info, public repo info, and gists).
@@ -648,7 +649,7 @@ Then update the file just like you do with creating:
 contents.update 'username', 'repo_name', 'full_path_to/file.ext',
   path: 'full_path_to/file.ext'
   message: 'Your commit message',
-  content: 'The contens to be updated',
+  content: 'The contents to be updated',
   sha: file.sha
 ```
 

data/lib/github_api/api/arguments.rb

@@ -118,8 +118,8 @@ module Github
       # Check if required keys are present inside parameters hash.
       #
       # @api public
-      def assert_required(required)
-        assert_required_keys required, params
+      def assert_required(*required)
+        assert_required_keys(required, params)
         self
       end
 

data/lib/github_api/client/authorizations.rb

@@ -6,16 +6,6 @@ module Github
 
     require_all 'github_api/client/authorizations', 'app'
 
-    VALID_AUTH_PARAM_NAMES = %w[
-      scopes
-      add_scopes
-      remove_scopes
-      note
-      note_url
-      client_id
-      client_secret
-    ].freeze
-
     # Access to Authorizations::App API
     namespace :app
 
@@ -24,9 +14,9 @@ module Github
     # @see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations
     #
     # @example
-    #  github = Github.new basic_auth: 'login:password'
-    #  github.oauth.list
-    #  github.oauth.list { |auth| ... }
+    #   github = Github.new basic_auth: 'login:password'
+    #   github.oauth.list
+    #   github.oauth.list { |auth| ... }
     #
     # @api public
     def list(*args)
@@ -37,7 +27,7 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :all :list
+    alias_method :all, :list
 
     # Get a single authorization
     #
@@ -56,32 +46,36 @@ module Github
 
       get_request("/authorizations/#{arguments.id}", arguments.params)
     end
-    alias :find :get
+    alias_method :find, :get
 
     # Create a new authorization
     #
+    # @see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization
+    #
     # @param [Hash] params
     # @option params [Array[String]] :scopes
     #   A list of scopes that this authorization is in.
     # @option params [String] :note
-    #   A note to remind you what the OAuth token is for.
+    #   Required. A note to remind you what the OAuth token is for.
     # @option params [String] :note_url
     #   A URL to remind you what the OAuth token is for.
     # @option params [String] :client_id
     #   The 20 character OAuth app client key for which to create the token.
     # @option params [String] :client_secret
     #   The 40 character OAuth app client secret for which to create the token.
+    # @option params [String] :fingerprint
+    #   A unique string to distinguish an authorization from others
+    #   created for the same client ID and user.
     #
     # @example
-    #  github = Github.new basic_auth: 'login:password'
-    #  github.oauth.create
-    #    "scopes" => ["public_repo"]
+    #   github = Github.new basic_auth: 'login:password'
+    #   github.oauth.create scopes: ["public_repo"], note: 'amdmin script'
     #
     # @api public
     def create(*args)
       raise_authentication_error unless authenticated?
       arguments(args) do
-        permit VALID_AUTH_PARAM_NAMES
+        assert_required :note, :scopes
       end
 
       post_request('/authorizations', arguments.params)
@@ -89,6 +83,8 @@ module Github
 
     # Update an existing authorization
     #
+    # @see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization
+    #
     # @param [Hash] inputs
     # @option inputs [Array] :scopes
     #   Optional array - A list of scopes that this authorization is in.
@@ -100,28 +96,30 @@ module Github
     #   Optional string - A note to remind you what the OAuth token is for.
     # @optoin inputs [String] :note_url
     #   Optional string - A URL to remind you what the OAuth token is for.
+    # @option params [String] :fingerprint
+    #   A unique string to distinguish an authorization from others
+    #   created for the same client ID and user.
     #
     # @example
-    #  github = Github.new basic_auth: 'login:password'
-    #  github.oauth.update "authorization-id", add_scopes: ["repo"]
+    #   github = Github.new basic_auth: 'login:password'
+    #   github.oauth.update "authorization-id", add_scopes: ["repo"]
     #
     # @api public
     def update(*args)
       raise_authentication_error unless authenticated?
-      arguments(args, required: [:id]) do
-        permit VALID_AUTH_PARAM_NAMES
-      end
+      arguments(args, required: [:id])
 
       patch_request("/authorizations/#{arguments.id}", arguments.params)
     end
-    alias :edit :update
+    alias_method :edit, :update
 
     # Delete an authorization
     #
     # @see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization
     #
     # @example
-    #  github.oauth.delete 'authorization-id'
+    #   github = Github.new
+    #   github.oauth.delete 'authorization-id'
     #
     # @api public
     def delete(*args)
@@ -130,14 +128,13 @@ module Github
 
       delete_request("/authorizations/#{arguments.id}", arguments.params)
     end
-    alias :remove :delete
+    alias_method :remove, :delete
 
     protected
 
     def raise_authentication_error
-      raise ArgumentError, 'You can only access your own tokens' +
-        ' via Basic Authentication'
+      raise ArgumentError, 'You can only access your own tokens' \
+                           ' via Basic Authentication'
     end
-
   end # Client::Authorizations
 end # Github

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

@@ -24,9 +24,7 @@ module Github
     # @api public
     def create(*args)
       raise_authentication_error unless authenticated?
-      arguments(args, required: [:client_id]) do
-        permit VALID_AUTH_PARAM_NAMES
-      end
+      arguments(args, required: [:client_id])
 
       if arguments.client_id
         put_request("/authorizations/clients/#{arguments.client_id}", arguments.params)

data/lib/github_api/client/orgs.rb

@@ -1,28 +1,41 @@
 # encoding: utf-8
 
 module Github
+  # Organizations API
   class Client::Orgs < API
 
     require_all 'github_api/client/orgs',
-      'members',
-      'teams'
-
-    VALID_ORG_PARAM_NAMES = %w[
-      billing_email
-      company
-      email
-      location
-      name
-    ].freeze
+                'members',
+                'memberships',
+                'teams'
 
     # Access to Client::Orgs::Members API
     namespace :members
 
+    # Access to Client::Orgs::Memberships API
+    namespace :memberships
+
     # Access to Client::Orgs::Teams API
     namespace :teams
 
+    # List all organizations
+    #
+    # Lists all organizations, in the order that they were created on GitHub.
+    #
+    # @see https://developer.github.com/v3/orgs/#list-all-organizations
+    #
+    # @param [Hash] params
+    # @option params [String] :since
+    #   The integer ID of the last Organization that you've seen.
+    #
+    # @example
+    #   github = Github.new
+    #   github.orgs.list :every
+    #
     # List all public organizations for a user.
     #
+    # @see https://developer.github.com/v3/orgs/#list-user-organizations
+    #
     # @example
     #   github = Github.new
     #   github.orgs.list user: 'user-name'
@@ -37,19 +50,23 @@ module Github
     def list(*args)
       params = arguments(args).params
 
-      response = if (user_name = params.delete("user"))
-        get_request("/users/#{user_name}/orgs", params)
+      if (user_name = params.delete('user'))
+        response = get_request("/users/#{user_name}/orgs", params)
+      elsif args.map(&:to_s).include?('every')
+        response = get_request('/organizations', params)
       else
         # For the authenticated user
-        get_request("/user/orgs", params)
+        response = get_request('/user/orgs', params)
       end
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :all :list
+    alias_method :all, :list
 
     # Get properties for a single organization
     #
+    # @see https://developer.github.com/v3/orgs/#get-an-organization
+    #
     # @example
     #  github = Github.new
     #  github.orgs.get 'github'
@@ -60,21 +77,25 @@ module Github
 
       get_request("/orgs/#{arguments.org_name}", arguments.params)
     end
-    alias :find :get
+    alias_method :find, :get
 
     # Edit organization
     #
+    # @see https://developer.github.com/v3/orgs/#edit-an-organization
+    #
     # @param [Hash] params
-    # @input params [String] :billing_email
+    # @option params [String] :billing_email
     #   Billing email address. This address is not publicized.
-    # @input params [String] :company
+    # @option params [String] :company
     #   The company name
-    # @input params [String] :email
+    # @option params [String] :email
     #   The publicly visible email address
-    # @input params [String] :location
+    # @option params [String] :location
     #   The location
-    # @input params [String] :name
+    # @option params [String] :name
     #   The shorthand name of the company.
+    # @option params [String] :description
+    #   The description of the company.
     #
     # @example
     #  github = Github.new oauth_token: '...'
@@ -88,9 +109,7 @@ module Github
     #
     # @api public
     def edit(*args)
-      arguments(args, required: [:org_name]) do
-        permit VALID_ORG_PARAM_NAMES
-      end
+      arguments(args, required: [:org_name])
 
       patch_request("/orgs/#{arguments.org_name}", arguments.params)
     end

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

@@ -10,21 +10,30 @@ module Github
     # both concealed and public members will be returned.
     # Otherwise only public members are returned.
     #
+    # @see https://developer.github.com/v3/orgs/members/#members-list
+    #
     # @param [Hash] params
-    # @input params [String] :filter
+    # @option params [String] :filter
     #   Filter members returned in the list. Can be one of:
     #   * 2fa_disabled: Members without two-factor authentication enabled.
     #   Available for owners of organizations with private repositories.
     #   * all: All members the authenticated user can see.
     #   Default: all
+    # @option params [String] :role
+    #   Filter members returned by their role. Can be one of:
+    #     * all: All members of the organization, regardless of role.
+    #     * admin: Organization owners.
+    #     * member: Non-owner organization members.
     #
     # @example
-    #  github = Github.new
-    #  github.orgs.members.list 'org-name'
-    #  github.orgs.members.list 'org-name' { |memb| ... }
+    #   github = Github.new
+    #   github.orgs.members.list 'org-name'
+    #   github.orgs.members.list 'org-name' { |memb| ... }
     #
     # List public members
     #
+    # @see https://developer.github.com/v3/orgs/members/#public-members-list
+    #
     # Members of an organization can choose to have their
     # membership publicized or not.
     #
@@ -39,14 +48,14 @@ module Github
       org_name = arguments.org_name
 
       response = if params.delete('public')
-        get_request("/orgs/#{org_name}/public_members", params)
-      else
-        get_request("/orgs/#{org_name}/members", params)
-      end
+                   get_request("/orgs/#{org_name}/public_members", params)
+                 else
+                   get_request("/orgs/#{org_name}/members", params)
+                 end
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :all :list
+    alias_method :all, :list
 
     # Check if user is, publicly or privately, a member of an organization
     #
@@ -67,20 +76,22 @@ module Github
       user     = arguments.user
 
       response = if params.delete('public')
-        get_request("/orgs/#{org_name}/public_members/#{user}", params)
-      else
-        get_request("/orgs/#{org_name}/members/#{user}", params)
-      end
+                   get_request("/orgs/#{org_name}/public_members/#{user}", params)
+                 else
+                   get_request("/orgs/#{org_name}/members/#{user}", params)
+                 end
       response.status == 204
     rescue Github::Error::NotFound
       false
-    end
 
+    end
     # Remove a member
     #
     # Removing a user from this list will remove them from all teams and
     # they will no longer have any access to the organization’s repositories.
     #
+    # @see https://developer.github.com/v3/orgs/members/#remove-a-member
+    #
     # @example
     #   github = Github.new
     #   github.orgs.members.remove 'org-name', 'member-name'
@@ -89,11 +100,14 @@ module Github
     def delete(*args)
       arguments(args, required: [:org_name, :user])
 
-      delete_request("/orgs/#{arguments.org_name}/members/#{arguments.user}", arguments.params)
+      delete_request("/orgs/#{arguments.org_name}/members/#{arguments.user}",
+                     arguments.params)
     end
-    alias :remove :delete
+    alias_method :remove, :delete
 
-    # Publicize a user’s membership
+    # Publicize a user's membership
+    #
+    # @see https://developer.github.com/v3/orgs/members/#publicize-a-users-membership
     #
     # @example
     #   github = Github.new oauth_token: '...'
@@ -108,11 +122,13 @@ module Github
     alias :make_public :publicize
     alias :publicize_membership :publicize
 
-    # Conceal a user’s membership
+    # Conceal a user's membership
+    #
+    # @see https://developer.github.com/v3/orgs/members/#conceal-a-users-membership
     #
     # @example
-    #  github = Github.new oauth_token: '...'
-    #  github.orgs.members.conceal 'org-name', 'member-name'
+    #   github = Github.new oauth_token: '...'
+    #   github.orgs.members.conceal 'org-name', 'member-name'
     #
     # @api public
     def conceal(*args)
@@ -120,6 +136,6 @@ module Github
 
       delete_request("/orgs/#{arguments.org_name}/public_members/#{arguments.user}", arguments.params)
     end
-    alias :conceal_membership :conceal
+    alias_method :conceal_membership, :conceal
   end # Client::Orgs::Members
 end # Github