gh 0.8.0 → 0.9.0

data/lib/gh.rb

@@ -5,6 +5,7 @@ require 'forwardable'
 module GH
   autoload :Cache,            'gh/cache'
   autoload :Case,             'gh/case'
+  autoload :CustomLimit,      'gh/custom_limit'
   autoload :Error,            'gh/error'
   autoload :FaradayAdapter,   'gh/faraday_adapter'
   autoload :Instrumentation,  'gh/instrumentation'
@@ -38,6 +39,11 @@ module GH
     self.current = was if was
   end
 
+  def self.set(options)
+    Thread.current[:GH] = nil
+    DefaultStack.options.merge! options
+  end
+
   def self.current
     Thread.current[:GH] ||= DefaultStack.new
   end
@@ -47,7 +53,7 @@ module GH
   end
 
   extend SingleForwardable
-  def_delegators :current, :api_host, :[], :reset, :load, :post, :delete, :patch, :put, :in_parallel, :in_parallel?, :options
+  def_delegators :current, :api_host, :[], :reset, :load, :post, :delete, :patch, :put, :in_parallel, :in_parallel?, :options, :head
 
   DefaultStack = Stack.new do
     use Instrumentation
@@ -57,6 +63,7 @@ module GH
     use MergeCommit
     use LazyLoader
     use Normalizer
+    use CustomLimit
     use Remote
   end
 end

data/lib/gh/custom_limit.rb

@@ -0,0 +1,27 @@
+module GH
+  # Adds Client info so even unauthenticated requests can use a custom request limit
+  class CustomLimit < Wrapper
+    attr_accessor :client_id, :client_secret
+
+    def setup(backend, options)
+      @client_id     = options[:client_id]
+      @client_secret = options[:client_secret]
+      super
+    end
+
+    def fetch_resource(key)
+      return super unless client_id
+
+      url    = full_url(key)
+      params = url.query_values || {}
+
+      unless params.include? 'client_id'
+        params['client_id']     = client_id
+        params['client_secret'] = client_secret
+      end
+
+      url.query_values = params
+      super url.request_uri
+    end
+  end
+end

data/lib/gh/error.rb

@@ -2,26 +2,51 @@ require 'gh'
 
 module GH
   class Error < Exception
-    attr_reader :error, :payload
+    attr_reader :info
 
-    def self.new(error, *)
-      Error === error ? error : super
+    def initialize(error = nil, payload = nil, info = {})
+      info   = info.merge(error.info) if error.respond_to? :info and Hash === error.info
+      error  = error.error while error.respond_to? :error
+      @info  = info.merge(:error => error, :payload => payload)
+
+      if error
+        set_backtrace error.backtrace
+        if error.respond_to? :response and error.response
+          case response = error.response
+          when Hash
+            @info[:response_status]  = response[:status]
+            @info[:response_headers] = response[:headers]
+            @info[:response_body]    = response[:body]
+          when Faraday::Response
+            @info[:response_status]  = response.status
+            @info[:response_headers] = response.headers
+            @info[:response_body]    = response.body
+          else
+            @info[:response]         = response
+          end
+        end
+      end
+    end
+
+    def payload
+      info[:payload]
     end
 
-    def initialize(error = nil, payload = nil)
-      error = error.error while error.respond_to? :error
-      @error, @payload = error, payload
-      set_backtrace error.backtrace if error
+    def error
+      info[:error]
     end
 
     def message
-      "GH request failed (#{error.class}: #{error.message}) with payload: #{short(payload.inspect)}"
+      "GH request failed\n" + info.map { |k,v| entry(k,v) }.join("\n")
     end
 
     private
 
-    def short(string)
-      string.length < 101 ? string : string[0,97] + '...'
+    def entry(key, value)
+      value = "#{value.class}: #{value.message}" if Exception === value
+      value = value.inspect unless String === value
+      value = value.gsub(/[^\n]{80}/, "\\0\n").lines.map { |l| "\n    #{l}" }.join.gsub(/\n+/, "\n")
+      (key.to_s + ": ").ljust(12) + value
     end
   end
 end

data/lib/gh/merge_commit.rb

@@ -58,22 +58,25 @@ module GH
 
     def github_done_checking?(hash)
       case hash['mergeable_state']
-      when 'checking'       then false
-      when 'unknown'        then hash['merged']
-      when 'clean', 'dirty' then true
+      when 'checking'                               then false
+      when 'unknown'                                then hash['merged']
+      when 'clean', 'dirty', 'unstable', 'stable'   then true
       else fail "unknown mergeable_state #{hash['mergeable_state'].inspect} for #{url(hash)}"
       end
     end
 
     def force_merge_commit(hash)
-      Timeout.timeout(600) do
+      Timeout.timeout(180) do
         update(hash) until github_done_checking? hash
       end
+    rescue TimeoutError
+      status = hash['mergeable_state'].inspect
+      raise TimeoutError, "gave up waiting for github to check the merge status (current status is #{status})"
     end
 
     def update(hash)
       hash.merge! backend[url(hash)]
-      sleep 0.1
+      sleep 0.5
     end
 
     def url(hash)

data/lib/gh/remote.rb

@@ -26,7 +26,7 @@ module GH
       api_host  = api_host.api_host if api_host.respond_to? :api_host
       @api_host = Addressable::URI.parse(api_host)
       @headers  = options[:headers].try(:dup)  || {
-        "Origin"          => options[:origin] || "http://example.org",
+        #"Origin"          => options[:origin] || "http://example.org",
         "Accept"          => "application/vnd.github.v3.full+json," \
                              "application/vnd.github.beta.full+json;q=0.5," \
                              "application/json;q=0.1",
@@ -47,7 +47,8 @@ module GH
         builder.request(:basic_auth, username, password)  if username and password
         builder.request(:retry)
         builder.response(:raise_error)
-        builder.use(options[:adapter] || GH::FaradayAdapter)
+        #builder.use(options[:adapter] || GH::FaradayAdapter)
+        builder.adapter(:net_http)
       end
     end
 
@@ -72,6 +73,8 @@ module GH
     # Internal: ...
     def http(verb, url, headers = {}, &block)
       connection.run_request(verb, url, nil, headers, &block)
+    rescue Exception => error
+      raise Error.new(error, nil, :verb => verb, :url => url, :headers => headers)
     end
 
     # Internal: ...
@@ -92,6 +95,11 @@ module GH
       frontend.request(:delete, key)
     end
 
+    # Public: ...
+    def head(key)
+      frontend.request(:head, key)
+    end
+
     # Public: ...
     def patch(key, body)
       frontend.request(:patch, key, body)

data/lib/gh/version.rb

@@ -1,4 +1,4 @@
 module GH
   # Public: Library version.
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/lib/gh/wrapper.rb

@@ -45,6 +45,9 @@ module GH
     # Public: ...
     def_delegator :backend, :delete
 
+    # Public: ...
+    def_delegator :backend, :head
+
     # Public: ...
     def_delegator :backend, :patch
 

data/spec/custom_limit_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe GH::CustomLimit do
+  before do
+    subject.client_id     = 'foo'
+    subject.client_secret = 'bar'
+  end
+
+  it 'adds client_id and client_secret to a request' do
+    subject.backend.
+      should_receive(:fetch_resource).
+      with('/x?client_id=foo&client_secret=bar').
+      and_return(GH::Response.new)
+    subject['/x']
+  end
+end

data/spec/error_spec.rb

@@ -28,4 +28,9 @@ describe GH::Error do
   it 'keeps the payload around' do
     exception.payload.should be == {'foo' => 'bar'}
   end
+
+  it 'works for long content' do
+    error = GH::Error.new(nil, nil, 'foo' => 'a'*1000)
+    expect { error.message }.not_to raise_error
+  end
 end

data/spec/remote_spec.rb

@@ -13,7 +13,7 @@ describe GH::Remote do
 
   it 'raises an exception for missing resources' do
     stub_request(:get, "https://api.github.com/foo").to_return(:status => 404)
-    expect { subject['foo'] }.to raise_error(Faraday::Error::ResourceNotFound)
+    expect { subject['foo'] }.to raise_error(GH::Error)
   end
 
   it 'parses the body' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gh
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-09 00:00:00.000000000 Z
+date: 2012-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70202419542180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70202419542180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70202419541760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70202419541760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70202419541120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70202419541120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: backports
-  requirement: &70202419556580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: '2.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70202419556580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70202419555500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +85,15 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70202419555500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70202419554560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +101,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70202419554560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
-  requirement: &70202419553260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +117,15 @@ dependencies:
         version: '2.7'
   type: :runtime
   prerelease: false
-  version_requirements: *70202419553260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: net-http-pipeline
-  requirement: &70202419551820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +133,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70202419551820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: multi-layer client for the github api v3
 email:
 - konstantin.mailinglists@googlemail.com
@@ -115,6 +155,7 @@ files:
 - lib/gh.rb
 - lib/gh/cache.rb
 - lib/gh/case.rb
+- lib/gh/custom_limit.rb
 - lib/gh/error.rb
 - lib/gh/faraday_adapter.rb
 - lib/gh/instrumentation.rb
@@ -132,6 +173,7 @@ files:
 - lib/gh/version.rb
 - lib/gh/wrapper.rb
 - spec/cache_spec.rb
+- spec/custom_limit_spec.rb
 - spec/error_spec.rb
 - spec/gh_spec.rb
 - spec/instrumentation_spec.rb
@@ -189,12 +231,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: layered github client
 test_files:
 - spec/cache_spec.rb
+- spec/custom_limit_spec.rb
 - spec/error_spec.rb
 - spec/gh_spec.rb
 - spec/instrumentation_spec.rb