github_api 0.15.0 → 0.19.0

data/README.md

@@ -2,21 +2,20 @@
   <a href="http://piotrmurach.github.io/github/"><img width="136" src="https://github.com/piotrmurach/github/raw/master/icons/github_api.png" alt="github api logo" /></a>
 </div>
 
-# GithubAPI
+# GithubAPI [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 
 [![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)
 
@@ -705,9 +704,27 @@ github.delete 'username', 'tome-of-knowledge', 'full_path_to/file.ext',
 
 The test suite is split into two groups, `live` and `mock`.
 
-The `live` tests are the ones in `features` folder and they simply exercise the GitHub API by making live requests and then being cached with VCR in directory named `features\cassettes`. For details on how to get set up, please navigate to the `features` folder.
+The `live` tests are in the `features` folder and exercise the GitHub API directly by making live requests and then caching responses with VCR in directory named `features\cassettes`. For details on how to get set up, please navigate to the `features` folder.
 
-The `mock` tests are in the `spec` directory and their primary concern is to test the gem internals without the hindrance of external calls.
+To run all feature tests do:
+
+```ruby
+bundle exec rake features
+```
+
+The `mock` tests are in the `spec` folder and their primary concern is to test the gem internals without the hindrance of external calls.
+
+To run all specs do:
+
+```ruby
+bundle exec rake spec
+```
+
+Finally to run all tests do:
+
+```ruby
+bundle exec rake
+```
 
 ## Development
 
@@ -719,4 +736,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/piotrm
 
 ## Copyright
 
-Copyright (c) 2011-2016 Piotr Murach. See LICENSE.txt for further details.
+Copyright (c) 2011 Piotr Murach. See LICENSE.txt for further details.

data/lib/github_api.rb

@@ -1,16 +1,9 @@
 # encoding: utf-8
 
 require 'pp' if ENV['DEBUG']
+
 require 'faraday'
-require 'github_api/version'
-require 'github_api/configuration'
-require 'github_api/constants'
-require 'github_api/utils/url'
-require 'github_api/connection'
-require 'github_api/deprecation'
-require 'github_api/core_ext/ordered_hash'
-require 'github_api/ext/faraday'
-require 'github_api/middleware'
+require_relative 'github_api/ext/faraday'
 
 module Github
   LIBNAME = 'github_api'
@@ -18,8 +11,32 @@ module Github
   LIBDIR = File.expand_path("../#{LIBNAME}", __FILE__)
 
   class << self
-    def included(base)
-      base.extend ClassMethods
+    # The client configuration
+    #
+    # @return [Configuration]
+    #
+    # @api public
+    def configuration
+      @configuration ||= Configuration.new
+    end
+    alias_method :config, :configuration
+
+    # Configure options
+    #
+    # @example
+    #   Github.configure do |c|
+    #     c.some_option = true
+    #   end
+    #
+    # @yield the configuration block
+    # @yieldparam configuration [Github::Configuration]
+    #   the configuration instance
+    #
+    # @return [nil]
+    #
+    # @api public
+    def configure
+      yield configuration
     end
 
     # Alias for Github::Client.new
@@ -63,69 +80,13 @@ module Github
       super(method_name, include_private)
     end
   end
-
-  module ClassMethods
-    # Requires internal libraries
-    #
-    # @param [String] prefix
-    #   the relative path prefix
-    # @param [Array[String]] libs
-    #   the array of libraries to require
-    #
-    # @return [self]
-    def require_all(prefix, *libs)
-      libs.each do |lib|
-        require "#{File.join(prefix, lib)}"
-      end
-    end
-
-    # The client configuration
-    #
-    # @return [Configuration]
-    #
-    # @api public
-    def configuration
-      @configuration ||= Configuration.new
-    end
-    alias_method :config, :configuration
-
-    # Configure options
-    #
-    # @example
-    #   Github.configure do |c|
-    #     c.some_option = true
-    #   end
-    #
-    # @yield the configuration block
-    # @yieldparam configuration [Github::Configuration]
-    #   the configuration instance
-    #
-    # @return [nil]
-    #
-    # @api public
-    def configure
-      yield configuration
-    end
-  end
-
-  extend ClassMethods
-
-  require_all LIBDIR,
-    'authorization',
-    'validations',
-    'normalizer',
-    'parameter_filter',
-    'api',
-    'client',
-    'pagination',
-    'request',
-    'response',
-    'response_wrapper',
-    'error',
-    'mime_type',
-    'page_links',
-    'paged_request',
-    'page_iterator',
-    'params_hash'
-
 end # Github
+
+require_relative 'github_api/api'
+require_relative 'github_api/client'
+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/middleware'
+require_relative 'github_api/version'

data/lib/github_api/api.rb

@@ -1,32 +1,29 @@
 # encoding: utf-8
 
-require 'github_api/configuration'
-require 'github_api/mime_type'
-require 'github_api/rate_limit'
-require 'github_api/core_ext/hash'
-require 'github_api/core_ext/array'
-require 'github_api/null_encoder'
-
-require 'github_api/request/verbs'
-
-require 'github_api/api/actions'
-require 'github_api/api/factory'
-require 'github_api/api/arguments'
+require_relative 'authorization'
+require_relative 'api/actions'
+require_relative 'api/factory'
+require_relative 'api/arguments'
+require_relative 'configuration'
+require_relative 'constants'
+require_relative 'mime_type'
+require_relative 'null_encoder'
+require_relative 'rate_limit'
+require_relative 'request/verbs'
+require_relative 'validations'
 
 module Github
   # Core class responsible for api interface operations
   class API
-    extend Github::ClassMethods
-
     include Constants
     include Authorization
     include MimeType
-    include Request::Verbs
     include RateLimit
+    include Request::Verbs
 
-    attr_reader *Github.configuration.property_names
+    attr_reader(*Github.configuration.property_names)
 
-    attr_accessor *Validations::VALID_API_KEYS
+    attr_accessor(*Validations::VALID_API_KEYS)
 
     attr_accessor :current_options
 
@@ -40,6 +37,22 @@ module Github
        end
      end
 
+    # Requires internal libraries
+    #
+    # @param [String] prefix
+    #   the relative path prefix
+    # @param [Array[String]] libs
+    #   the array of libraries to require
+    #
+    # @return [self]
+    #
+    # @api public
+    def self.require_all(prefix, *libs)
+      libs.each do |lib|
+        require "#{File.join(prefix, lib)}"
+      end
+    end
+
     # Create new API
     #
     # @api public
@@ -79,6 +92,16 @@ module Github
       end
     end
 
+    # Disable following redirects inside a block
+    #
+    # @api public
+    def disable_redirects
+      self.follow_redirects = false
+      yield
+    ensure
+      self.follow_redirects = true
+    end
+
     # List of before callbacks
     #
     # @api public
@@ -199,14 +222,14 @@ module Github
     #
     # @api private
     def filter_callbacks(kind, action_name)
-      matched_callbacks = self.class.send("#{kind}_callbacks").select do |callback|
+      self.class.send("#{kind}_callbacks").select do |callback|
         callback[:only].nil? || callback[:only].include?(action_name)
       end
     end
 
     # Run all callbacks associated with this action
     #
-    # @apram [Symbol] action_name
+    # @param [Symbol] action_name
     #
     # @api private
     def run_callbacks(action_name, &block)
@@ -243,6 +266,10 @@ module Github
       end
     end
 
+    def respond_to?(method_name, include_private = false)
+      method_name.to_s.start_with?('clear_') || super
+    end
+
     # Acts as setter and getter for api requests arguments parsing.
     #
     # Returns Arguments instance.

data/lib/github_api/api/arguments.rb

@@ -1,8 +1,13 @@
 # encoding: utf-8
 
+require_relative '../normalizer'
+require_relative '../parameter_filter'
+require_relative '../params_hash'
+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

@@ -1,14 +1,12 @@
 # encoding: utf-8
 
-require 'github_api/api/config/property'
-require 'github_api/api/config/property_set'
+require_relative 'config/property'
+require_relative 'config/property_set'
 
 module Github
-
   class API
     # A base class for constructing api configuration
     class Config
-
       # Defines a property on an object's class or instance
       #
       # @example
@@ -75,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/api/config/property_set.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+
 require 'set'
 
 module Github

data/lib/github_api/authorization.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'oauth2'
+
 module Github
   module Authorization
 

data/lib/github_api/client.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative 'api'
+
 module Github
   class Client < API
     require_all 'github_api/client',
@@ -13,6 +15,7 @@ module Github
                 'markdown',
                 'meta',
                 'orgs',
+                'projects',
                 'pull_requests',
                 'repos',
                 'say',
@@ -52,6 +55,8 @@ module Github
     namespace :orgs
     alias :organizations :orgs
 
+    namespace :projects
+
     namespace :pull_requests
     alias :pulls :pull_requests
 

data/lib/github_api/client/activity.rb

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

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

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Activity::Events < API
     # List all public events

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

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Activity::Feeds < API
     # List all the feeds available to the authenticated user.

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

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   class Client::Activity::Notifications < API
     # List your notifications

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

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   # Repository Starring is a feature that lets users bookmark repositories.
   # Stars are shown next to repositories to show an approximate level of interest.
@@ -116,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

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require_relative '../../api'
+
 module Github
   # Watching a Repository registers the user to receive notificactions on new
   # discussions, as well as events in the user's activity feed.
@@ -11,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)