github_api 0.14.1 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b428d8782ec8d52580f70a96939c878db0cdf4ec
-  data.tar.gz: 578c3e1c036ec22952d056349972057d5518a48a
+  metadata.gz: c509b47b9406a28c186ff6f1a0f9634b20a4ce35
+  data.tar.gz: c4a47665d1ab2f0170afd089cbf2b6e4612eb18e
 SHA512:
-  metadata.gz: 57cd89c6a9f21ffbbb1e036894de9ac9a43fb7d1eb33a9bee31e27c9b5c6a956b6d9591cf0a15fde0fcb219f730b8ab0608b867f4d7d18066ecff6e7d2c2bd9d
-  data.tar.gz: 606683bd7c29321ece30e435c84720d3d426f53c1116bb510c171f1683a3f48f7aebb4aeb3ff32e4ed86c4e003d3ce1025c314f9d82911ebcafd911c1b33c9dc
+  metadata.gz: 5e20bca947fe37fc506743485b515e35dbcb7e6fddce356492549729055da1420a9a8f538f55bced926eed2d0bb60a0575e47f029eb974fbcd0903d5fb717768
+  data.tar.gz: 3cf563db4fe0944d9768ebb063e12b3b18d64797cc687e0fe53bf5c58b24cc70ed477db2840e3ca6968e936ce7211f6955f1f38967d224feb35f374a7ca1ab5f

data/README.md

@@ -412,7 +412,7 @@ To create an access token through the GitHub Authorizations API, you are require
 
 ```ruby
 github = Github.new basic_auth: 'login:password'
-github.oauth.create scopes: ['repo'], note: 'admin script'
+github.auth.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).
@@ -423,20 +423,20 @@ Furthermore, to create auth token for an application you need to pass `:app` arg
 
 ```ruby
 github = Github.new basic_auth: 'login:password'
-github.oauth.app.create 'client-id', scopes: ['repo']
+github.auth.app.create 'client-id', scopes: ['repo']
 ```
 
 In order to revoke auth token(s) for an application you must use basic authentication with `client_id` as login and `client_secret` as password.
 
 ```ruby
 github = Github.new basic_auth: "client_id:client_secret"
-github.oauth.app.delete 'client-id'
+github.auth.app.delete 'client-id'
 ```
 
 Revoke a specific app token.
 
 ```ruby
-github.oauth.app.delete 'client-id', 'access-token'
+github.auth.app.delete 'client-id', 'access-token'
 ```
 
 ### 3.3 Scopes
@@ -448,6 +448,13 @@ github = Github.new oauth_token: 'token'
 github.scopes.list    # => ['repo']
 ```
 
+or inidividually for a given user:
+
+```ruby
+github = Github.new
+github.scopes.list 'token'
+```
+
 To list the scopes that the particular GitHub API action checks for do:
 
 ```ruby

data/lib/github_api/api.rb

@@ -255,20 +255,6 @@ module Github
       end
     end
 
-    # Scope for passing request required arguments.
-    #
-    def with(args)
-      case args
-      when Hash
-        set args
-      when /.*\/.*/i
-        user, repo = args.split('/')
-        set :user => user, :repo => repo
-      else
-        ::Kernel.raise ArgumentError, 'This api does not support passed in arguments'
-      end
-    end
-
     # Set a configuration option for a given namespace
     #
     # @param [String] option
@@ -300,6 +286,9 @@ module Github
     # @param [Array[Symbol]] names
     #   the name for the scope
     #
+    # @example
+    #   namespace :scopes
+    #
     # @return [self]
     #
     # @api public
@@ -307,14 +296,17 @@ module Github
       options = names.last.is_a?(Hash) ? names.pop : {}
       names   = names.map(&:to_sym)
       name    = names.pop
-      return if public_method_defined?(name)
+
+      if public_method_defined?(name)
+        raise ArgumentError, "namespace '#{name}' is already defined"
+      end
 
       class_name = extract_class_name(name, options)
+
       define_method(name) do |*args, &block|
         options = args.last.is_a?(Hash) ? args.pop : {}
         API::Factory.new(class_name, current_options.merge(options), &block)
       end
-      self
     end
 
     # Extracts class name from options
@@ -325,6 +317,9 @@ module Github
     # @option options [Boolean] :root
     #   if the class is at the root or not
     #
+    # @example
+    #   extract_class_name(:stats, class_name: :statistics)
+    #
     # @return [String]
     #
     # @api private

data/lib/github_api/api/actions.rb

@@ -9,10 +9,12 @@ module Github
     #
     # @api public
     def self.extend_with_actions(child_class)
+      return unless child_class.is_a?(Class)
+      return if child_class.name.nil? # Skip anonymous classes
+
       child_class.class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
         def self.actions
-          self.new.api_methods_in(#{child_class}) +
-          self.new.module_methods_in(#{child_class})
+          self.new.actions
         end
 
         def actions

data/lib/github_api/authorization.rb

@@ -3,8 +3,6 @@
 module Github
   module Authorization
 
-    attr_accessor :scopes
-
     # Setup OAuth2 instance
     def client
       @client ||= ::OAuth2::Client.new(client_id, client_secret,

data/lib/github_api/client.rb

@@ -2,26 +2,25 @@
 
 module Github
   class Client < API
-
     require_all 'github_api/client',
-      'activity',
-      'authorizations',
-      'emojis',
-      'gists',
-      'gitignore',
-      'git_data',
-      'issues',
-      'markdown',
-      'meta',
-      'orgs',
-      'pull_requests',
-      'repos',
-      'say',
-      'scopes',
-      'search',
-      'users'
-
-    # Serving up the ‘social’ in Social Coding™, the Activity APIs
+                'activity',
+                'authorizations',
+                'emojis',
+                'gists',
+                'gitignore',
+                'git_data',
+                'issues',
+                'markdown',
+                'meta',
+                'orgs',
+                'pull_requests',
+                'repos',
+                'say',
+                'scopes',
+                'search',
+                'users'
+
+    # Serving up the 'social' in Social Coding, the Activity APIs
     # provide access to notifications, subscriptions, and timelines.
     namespace :activity
 
@@ -48,6 +47,7 @@ module Github
     # tokens, and only through Basic Authentication.
     namespace :authorizations
     alias :oauth :authorizations
+    alias :auth :authorizations
 
     namespace :orgs
     alias :organizations :orgs

data/lib/github_api/client/authorizations.rb

@@ -15,8 +15,8 @@ module Github
     #
     # @example
     #   github = Github.new basic_auth: 'login:password'
-    #   github.oauth.list
-    #   github.oauth.list { |auth| ... }
+    #   github.auth.list
+    #   github.auth.list { |auth| ... }
     #
     # @api public
     def list(*args)

data/lib/github_api/client/orgs.rb

@@ -10,6 +10,9 @@ module Github
                 'memberships',
                 'teams'
 
+    # Access to Client::Orgs::Hooks API
+    namespace :hooks
+
     # Access to Client::Orgs::Members API
     namespace :members
 

data/lib/github_api/client/scopes.rb

@@ -4,15 +4,41 @@ module Github
   class Client::Scopes < API
     # Check what OAuth scopes you have.
     #
-    # = Examples
-    #  github = Github.new :oauth_token => 'token'
-    #  github.scopes.all
+    # @see https://developer.github.com/v3/oauth/#scopes
     #
+    # @example
+    #   github = Github.new oauth_token: 'e72e16c7e42f292c6912e7710c838347ae17'
+    #   github.scopes.all
+    #
+    # @example
+    #   github = Github.new
+    #   github.scopes.list 'e72e16c7e42f292c6912e7710c838347ae17'
+    #
+    # @example
+    #   github = Github.new
+    #   github.scopes.list token: 'e72e16c7e42f292c6912e7710c838347ae17'
+    #
+    # @api public
     def list(*args)
       arguments(args)
-      response = get_request("/user", arguments.params)
-      response.headers.oauth_scopes ? response.headers.oauth_scopes.split(',') : response
+      params = arguments.params
+      token = args.shift
+
+      if token.is_a?(Hash) && !params['token'].nil?
+        token = params.delete('token')
+      elsif token.nil?
+        token = oauth_token
+      end
+
+      if token.nil?
+        raise ArgumentError, 'Access token required'
+      end
+
+      headers = { 'Authorization' => "token #{token}" }
+      params['headers'] = headers
+      response = get_request("/user", params)
+      response.headers.oauth_scopes.split(',').map(&:strip)
     end
-    alias :all :list
-  end
+    alias all list
+  end # Client::Scopes
 end # Github

data/lib/github_api/connection.rb

@@ -14,32 +14,34 @@ module Github
       :ssl
     ].freeze
 
+    # Default requets header information
+    #
+    # @return [Hash[String]]
+    #
+    # @api private
+    def default_headers
+      {
+        ACCEPT         => 'application/vnd.github.v3+json,' \
+                          'application/vnd.github.beta+json;q=0.5,' \
+                          'application/json;q=0.1',
+        ACCEPT_CHARSET => 'utf-8'
+      }
+    end
+
+    # Create default connection options
+    #
+    # @return [Hash[Symbol]]
+    #   the default options
+    #
+    # @api private
     def default_options(options = {})
-      accept = options[:headers] && options[:headers][:accept]
+      headers = default_headers.merge(options[:headers] || {})
+      headers.merge!({USER_AGENT => options[:user_agent]})
       {
-        headers: {
-          ACCEPT         =>  accept || 'application/vnd.github.v3+json,' \
-                            'application/vnd.github.beta+json;q=0.5,' \
-                            'application/json;q=0.1',
-          ACCEPT_CHARSET => 'utf-8',
-          USER_AGENT     => options[:user_agent]
-        },
+        headers: headers,
         ssl: options[:ssl],
         url: options[:endpoint]
-      }.tap do |h|
-        if type = options[:headers] && options[:headers][CONTENT_TYPE]
-          h[:headers][CONTENT_TYPE] = type
-        end
-        h
-      end
-    end
-
-    def clear_cache
-      @connection = nil
-    end
-
-    def caching?
-      !@connection.nil?
+      }
     end
 
     # Exposes middleware builder to facilitate custom stacks and easy
@@ -48,7 +50,11 @@ module Github
     # @api public
     def stack(options = {})
       @stack ||= begin
-        builder_class = defined?(Faraday::RackBuilder) ? Faraday::RackBuilder : Faraday::Builder
+        builder_class = if defined?(Faraday::RackBuilder)
+                          Faraday::RackBuilder
+                        else
+                          Faraday::Builder
+                        end
         builder_class.new(&Github.default_middleware(options))
       end
     end
@@ -58,14 +64,15 @@ module Github
     # Returns a Fraday::Connection object
     def connection(api, options = {})
       connection_options = default_options(options)
-      clear_cache unless options.empty?
       connection_options.merge!(builder: stack(options.merge!(api: api)))
-      connection_options.deep_merge!(options[:connection_options]) if options[:connection_options]
+      if options[:connection_options]
+        connection_options.deep_merge!(options[:connection_options])
+      end
       if ENV['DEBUG']
         p "Connection options : \n"
         pp connection_options
       end
-      @connection ||= Faraday.new(connection_options)
+      Faraday.new(connection_options)
     end
   end # Connection
 end # Github

data/lib/github_api/constants.rb

@@ -29,7 +29,7 @@ module Github
 
     ACCEPT_CHARSET = 'Accept-Charset'.freeze
 
-    OAUTH_SCOPES = 'X-Oauth-Scopes'.freeze
+    OAUTH_SCOPES = 'X-OAuth-Scopes'.freeze
 
     ACCEPTED_OAUTH_SCOPES = 'X-Accepted-Oauth-Scopes'.freeze
 

data/lib/github_api/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Github
-  VERSION = "0.14.1"
+  VERSION = "0.14.2"
 end # Github

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_api
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.14.2
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-21 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable