github_api 0.12.0 → 0.12.1

data/lib/github_api.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+require 'faraday'
 require 'github_api/version'
 require 'github_api/configuration'
 require 'github_api/constants'
@@ -8,6 +9,7 @@ require 'github_api/connection'
 require 'github_api/deprecation'
 require 'github_api/core_ext/ordered_hash'
 require 'github_api/ext/faraday'
+require 'github_api/middleware'
 
 module Github
   LIBNAME = 'github_api'
@@ -28,7 +30,17 @@ module Github
     #
     # @api public
     def new(options = {}, &block)
-      Github::Client.new(options, &block)
+      Client.new(options, &block)
+    end
+
+    # Default middleware stack that uses default adapter as specified
+    # by configuration setup
+    #
+    # @return [Proc]
+    #
+    # @api private
+    def default_middleware(options = {})
+      Middleware.default(options)
     end
 
     # Delegate to Github::Client
@@ -52,7 +64,8 @@ module Github
   end
 
   module ClassMethods
-    # Requires internal github_api libraries
+
+    # Requires internal libraries
     #
     # @param [String] prefix
     #   the relative path prefix
@@ -66,9 +79,31 @@ module Github
       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
 

data/lib/github_api/api/actions.rb

@@ -1,48 +1,58 @@
 # encoding: utf-8
 
 module Github
-  # Core class responsible for api interface operations
+  # Responsible for providing inspection of api methods
   class API
     # Returns all API public methods for a given class.
+    #
+    # @return [nil]
+    #
+    # @api public
     def self.extend_with_actions(child_class)
       child_class.class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
         def self.actions
-          self.new.api_methods_in(#{child_class})
+          self.new.api_methods_in(#{child_class}) +
+          self.new.module_methods_in(#{child_class})
         end
+
         def actions
-          api_methods_in(#{child_class})
+          api_methods_in(#{child_class}) + module_methods_in(#{child_class})
         end
       RUBY_EVAL
     end
 
+    # Finds api methods in a class
+    #
+    # @param [Class] klass
+    #   The klass to inspect for methods.
+    #
+    # @api private
     def api_methods_in(klass)
-      puts "---"
-      (klass.send(:instance_methods, false) - ['actions']).sort.each do |method|
-        puts "|--> #{method}"
-      end
-      klass.included_modules.each do |mod|
-        if mod.to_s =~ /#{klass}/
-          puts "| \\ #{mod.to_s}"
-          mod.instance_methods(false).each do |met|
-            puts "|  |--> #{met}"
-          end
-          puts "| /"
+      methods = klass.send(:instance_methods, false) - [:actions]
+      methods.sort.each_with_object([]) do |method_name, accumulator|
+        unless method_name.to_s.include?('with') ||
+               method_name.to_s.include?('without')
+          accumulator << method_name
         end
+        accumulator
       end
-      puts "---"
-      nil
     end
 
-    def append_arguments(method)
-      _method = self.method(method)
-      if _method.arity == 0
-        args = "()"
-      elsif _method.arity > 0
-        args = "(few)"
-      else
-        args = "(else)"
+    # Finds methods included through class modules
+    #
+    # @param [Class] klass
+    #   The klass to inspect for methods.
+    #
+    # @api private
+    def module_methods_in(klass)
+      klass.included_modules.each_with_object([]) do |mod, accumulator|
+        if mod.to_s =~ /#{klass}/
+          mod.instance_methods(false).each do |method|
+            accumulator << method
+          end
+        end
+        accumulator
       end
-      args
     end
   end # API
 end # Github

data/lib/github_api/api/config/property_set.rb

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

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

@@ -13,6 +13,7 @@ module Github
     ]
 
     VALID_STATUS_OPTIONS = %w[
+      state
       target_url
       description
     ]

data/lib/github_api/configuration.rb

@@ -3,11 +3,18 @@
 require 'github_api/api/config'
 
 module Github
+  # Stores the configuration
   class Configuration < API::Config
 
     # Other adapters are :typhoeus, :patron, :em_synchrony, :excon, :test
     property :adapter, default: :net_http
 
+    # By default, don't traverse the page links
+    property :auto_pagination, default: false
+
+    # Basic authentication
+    property :basic_auth
+
     # By default, don't set an application key
     property :client_id
 
@@ -28,15 +35,16 @@ module Github
       :ca_file => File.expand_path('../ssl_certs/cacerts.pem', __FILE__)
     }
 
-    # By default the <tt>Accept</tt> header will make a request for <tt>JSON</tt>
+    # By default the Accept header will make a request for JSON
     property  :mime_type
 
     # The value sent in the http header for 'User-Agent' if none is set
-    property  :user_agent, default: "Github Ruby Gem #{Github::VERSION::STRING}".freeze
+    property  :user_agent, default: "Github API Ruby Gem #{Github::VERSION::STRING}".freeze
 
     # By default uses the Faraday connection options if none is set
     property  :connection_options, default: {}
 
+    # Global repository name
     property :repo
 
     property :user
@@ -47,10 +55,10 @@ module Github
 
     property :password
 
-    property :basic_auth
-
-    # By default, don't traverse the page links
-    property :auto_pagination, default: false
+    # By default display 30 resources
+    property :per_page, default: 30
 
+    # Add Faraday::RackBuilder to overwrite middleware
+    property :stack
   end # Configuration
 end # Github

data/lib/github_api/connection.rb

@@ -1,12 +1,5 @@
 # encoding: utf-8
 
-require 'faraday'
-require 'github_api/response'
-require 'github_api/response/mashify'
-require 'github_api/response/jsonize'
-require 'github_api/response/raise_error'
-require 'github_api/response/header'
-
 module Github
   # Specifies Http connection options
   module Connection
@@ -36,32 +29,6 @@ module Github
       }
     end
 
-    # Default middleware stack that uses default adapter as specified at
-    # configuration stage.
-    #
-    def default_middleware(options = {})
-      api = options[:api]
-      proc do |builder|
-        builder.use Github::Request::Jsonize
-        builder.use Faraday::Request::Multipart
-        builder.use Faraday::Request::UrlEncoded
-        builder.use Github::Request::OAuth2, api.oauth_token if api.oauth_token?
-        builder.use Github::Request::BasicAuth, api.authentication if api.basic_authed?
-
-        builder.use Faraday::Response::Logger if ENV['DEBUG']
-        unless options[:raw]
-          builder.use Github::Response::Mashify
-          builder.use Github::Response::Jsonize
-        end
-        builder.use Github::Response::RaiseError
-        builder.adapter options[:adapter]
-      end
-    end
-
-    @connection = nil
-
-    @stack = nil
-
     def clear_cache
       @connection = nil
     end
@@ -73,15 +40,11 @@ module Github
     # Exposes middleware builder to facilitate custom stacks and easy
     # addition of new extensions such as cache adapter.
     #
-    def stack(options = {}, &block)
+    # @api public
+    def stack(options = {})
       @stack ||= begin
         builder_class = defined?(Faraday::RackBuilder) ? Faraday::RackBuilder : Faraday::Builder
-
-        if block_given?
-          builder_class.new(&block)
-        else
-          builder_class.new(&default_middleware(options))
-        end
+        builder_class.new(&Github.default_middleware(options))
       end
     end
 
@@ -91,7 +54,8 @@ module Github
     def connection(api, options = {})
       connection_options = default_options(options)
       clear_cache unless options.empty?
-      connection_options.merge!(builder: stack(options.merge!(api: api)))
+      builder = api.stack ? api.stack : stack(options.merge!(api: api))
+      connection_options.merge!(builder: builder)
       if ENV['DEBUG']
         p "Connection options : \n"
         pp connection_options

data/lib/github_api/middleware.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'github_api/response'
+require 'github_api/response/mashify'
+require 'github_api/response/jsonize'
+require 'github_api/response/raise_error'
+require 'github_api/response/header'
+
+module Github
+  class Middleware
+    def self.default(options = {})
+      api = options[:api]
+      proc do |builder|
+        builder.use Github::Request::Jsonize
+        builder.use Faraday::Request::Multipart
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Github::Request::OAuth2, api.oauth_token if api.oauth_token?
+        builder.use Github::Request::BasicAuth, api.authentication if api.basic_authed?
+
+        builder.use Faraday::Response::Logger if ENV['DEBUG']
+        unless options[:raw]
+          builder.use Github::Response::Mashify
+          builder.use Github::Response::Jsonize
+        end
+        builder.use Github::Response::RaiseError
+        builder.adapter options[:adapter]
+      end
+    end
+  end # Middleware
+end # Github

data/lib/github_api/request/basic_auth.rb

@@ -9,7 +9,9 @@ module Github
       dependency 'base64'
 
       def call(env)
-        env[:request_headers].merge!('Authorization' => "Basic #{@auth}\"")
+        unless @auth.to_s.empty?
+          env[:request_headers].merge!('Authorization' => "Basic #{@auth}\"")
+        end
 
         @app.call env
       end

data/lib/github_api/request/jsonize.rb

@@ -16,7 +16,9 @@ module Github
         env[:body] = encode_body env[:body] unless env[:body].respond_to?(:to_str)
       else
         # Ensure valid body for put and post requests
-        env[:body] = encode_body({})
+        if [:put, :patch, :post].include? env[:method]
+          env[:body] = encode_body({})
+        end
       end
       @app.call env
     end

data/lib/github_api/version.rb

@@ -4,7 +4,7 @@ module Github
   module VERSION
     MAJOR = 0
     MINOR = 12
-    PATCH = 0
+    PATCH = 1
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/spec/github/api/actions_spec.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::API, '#actions' do
+  let(:api) { Github::Client::Repos::Contents }
+
+  context 'when class' do
+    it "lists all available actions for an api" do
+      expect(api.actions).to eq([:archive, :create, :delete, :find, :get, :readme, :update])
+    end
+  end
+
+  context 'when instance' do
+    it "lists all available actions for an api" do
+      expect(api.new.actions).to eq([:archive, :create, :delete, :find, :get, :readme, :update])
+    end
+  end
+end

data/spec/github/api/set_spec.rb

@@ -1,4 +1,4 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 require 'spec_helper'
 
@@ -11,7 +11,7 @@ describe Github::API, '#set' do
   end
 
   context 'accpets more than one option' do
-    before { subject.set :user => 'user-name', :repo => 'repo-name' }
+    before { subject.set user: 'user-name', repo: 'repo-name' }
 
     it 'sets user' do
       expect(subject.user).to eql('user-name')

data/spec/github/api/with_spec.rb

@@ -1,4 +1,4 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 require 'spec_helper'
 
@@ -9,7 +9,7 @@ describe Github::API, '#with' do
 
   context 'with hash' do
     it 'supports list of options' do
-      subject.with(:user => user, :repo => 'github')
+      subject.with(user: user, repo: 'github')
       subject.user.should == user
     end
   end
@@ -24,5 +24,4 @@ describe Github::API, '#with' do
       expect { subject.with('peter-murach') }.to raise_error(ArgumentError)
     end
   end
-
 end

data/spec/github/api_spec.rb

@@ -23,11 +23,7 @@ describe Github::API do
     it 'ensures output contains api methods' do
       methods = [ 'method_a', 'method_b']
       repos.stub(:instance_methods).and_return methods
-      output = capture(:stdout) { 
-        subject.api_methods_in(repos)
-      }
-      output.should =~ /.*method_a.*/
-      output.should =~ /.*method_b.*/
+      expect(subject.api_methods_in(repos)).to eq(['method_a', 'method_b'])
     end
   end
 

data/spec/github/client/repos/deployments/create_spec.rb

@@ -14,7 +14,7 @@ describe Github::Client::Repos::Deployments, '#create' do
   }
 
   before {
-    stub_post(request_path).with(params).
+    stub_post(request_path).with(:body => params).
       to_return(:body => body, :status => status,
       :headers => {:content_type => "application/json; charset=utf-8"})
   }
@@ -33,7 +33,7 @@ describe Github::Client::Repos::Deployments, '#create' do
 
     it "should create resource successfully" do
       subject.create user, repo, params
-      a_post(request_path).with(params).should have_been_made
+      a_post(request_path).with(:body => params).should have_been_made
     end
 
     it "should return the resource" do