Add ability to explicitly configure.

piotrmurach · piotrmurach · commit d2ccaaa20ccb · 2014-07-30T21:59:36.000+01:00
diff --git a/lib/github_api.rb b/lib/github_api.rb
@@ -28,7 +28,7 @@ def included(base)
     #
     # @api public
     def new(options = {}, &block)
-      Github::Client.new(options, &block)
+      Client.new(options, &block)
     end
 
     # Delegate to Github::Client
@@ -52,7 +52,8 @@ def respond_to?(method_name, include_private = false)
   end
 
   module ClassMethods
-    # Requires internal github_api libraries
+
+    # Requires internal libraries
     #
     # @param [String] prefix
     #   the relative path prefix
@@ -66,9 +67,31 @@ def require_all(prefix, *libs)
       end
     end
 
-    # Main client global configuration
+    # The client configuration
+    #
+    # @return [Configuration]
+    #
+    # @api public
     def configuration
-      @configuration ||= Github::Configuration.new
+      @configuration ||= Configuration.new
+    end
+
+    # 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
 
diff --git a/spec/github/configure_spec.rb b/spec/github/configure_spec.rb
@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github, '#configure' do
+  subject { described_class }
+
+  it "allows to configure settings" do
+    yielded = nil
+    Github.configure do |config|
+      yielded = config
+    end
+    expect(yielded).to be_a(Github::Configuration)
+  end
+end
