gh 0.6.1 → 0.7.1

data/.travis.yml

@@ -7,10 +7,10 @@ rvm:
   - jruby-19mode
   - rbx-18mode
   - rbx-19mode
-  - ruby-head
   - jruby-head
   - ree
 matrix:
   allow_failures:
+    - rvm: jruby-18mode
+    - rvm: jruby-19mode
     - rvm: jruby-head
-    - rvm: ruby-head

data/README.md

@@ -13,13 +13,16 @@ This will by default use all the middleware that ships with GH, in the following
 
 * `GH::Remote` - sends HTTP requests to GitHub and parses the response
 * `GH::Normalizer` - renames fields consistenly, adds hypermedia links if possible
-* `GH::Cache` - caches the responses (will use Rails cache if in Rails, in-memory cache otherwise)
 * `GH::LazyLoader` - will load missing fields when accessed (handy for dealing with incomplete data without sending to many requests)
 * `GH::MergeCommit` - adds infos about merge commits to pull request payloads
 * `GH::LinkFollower` - will add content of hypermedia links as fields (lazyly), allows you to traverse relations
 * `GH::Pagination` - adds support for transparent pagination
 * `GH::Instrumentation` - let's you instrument `gh`
 
+The following middleware is not included by default:
+
+* `GH::Cache` - caches the responses (will use Rails cache if in Rails, in-memory cache otherwise)
+
 ## Main Entry Points
 
 Every layer has two main entry points:

data/gh.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'backports',   '~> 2.3'
   s.add_runtime_dependency 'multi_json',  '~> 1.0'
   s.add_runtime_dependency 'addressable'
-  s.add_runtime_dependency 'net-http-persistent'
+  s.add_runtime_dependency 'net-http-persistent', '>= 2.7'
   s.add_runtime_dependency 'net-http-pipeline'
 end

data/lib/gh.rb

@@ -21,11 +21,20 @@ module GH
   autoload :Wrapper,          'gh/wrapper'
 
   def self.with(backend)
-    backend = DefaultStack.build(backend) if Hash === backend
-    return backend unless block_given?
-    was, self.current = current, backend
-    yield
+    if Hash === backend
+      @options ||= {}
+      @options, options = @options.merge(backend), @options
+      backend = DefaultStack.build(@options)
+    end
+
+    if block_given?
+      was, self.current = current, backend
+      yield
+    else
+      backend
+    end
   ensure
+    @options = options if options
     self.current = was if was
   end
 
@@ -38,7 +47,7 @@ module GH
   end
 
   extend SingleForwardable
-  def_delegators :current, :api_host, :[], :reset, :load, :post, :delete, :patch, :put, :in_parallel, :in_parallel?
+  def_delegators :current, :api_host, :[], :reset, :load, :post, :delete, :patch, :put, :in_parallel, :in_parallel?, :options
 
   DefaultStack = Stack.new do
     use Instrumentation
@@ -47,7 +56,6 @@ module GH
     use LinkFollower
     use MergeCommit
     use LazyLoader
-    use Cache
     use Normalizer
     use Remote
   end

data/lib/gh/cache.rb

@@ -31,8 +31,8 @@ module GH
 
     # Internal: Initializes a new Cache instance.
     def setup(*)
-      self.cache ||= Rails.cache if defined? Rails.cache and defined? RAILS_CACHE
-      self.cache ||= ActiveSupport::Cache.lookup_store if defined? ActiveSupport::Cache.lookup_store
+      #self.cache ||= Rails.cache if defined? Rails.cache and defined? RAILS_CACHE
+      #self.cache ||= ActiveSupport::Cache.lookup_store if defined? ActiveSupport::Cache.lookup_store
       self.cache ||= SimpleCache.new
       super
     end

data/lib/gh/error.rb

@@ -4,6 +4,10 @@ module GH
   class Error < Exception
     attr_reader :error, :payload
 
+    def self.new(error, *)
+      Error === error ? error : super
+    end
+
     def initialize(error = nil, payload = nil)
       error = error.error while error.respond_to? :error
       @error, @payload = error, payload
@@ -11,7 +15,13 @@ module GH
     end
 
     def message
-      "GH request failed (#{error.message}) with payload: #{payload.inspect}"
+      "GH request failed (#{error.class}: #{error.message}) with payload: #{short(payload.inspect)}"
+    end
+
+    private
+
+    def short(string)
+      string.length < 101 ? string : string[0,97] + '...'
     end
   end
 end

data/lib/gh/merge_commit.rb

@@ -52,7 +52,7 @@ module GH
     end
 
     def force_merge_commit(hash)
-      Timeout.timeout(10) do # MAGIC NUMBERS FTW
+      Timeout.timeout(600) do # MAGIC NUMBERS FTW
         # FIXME: Rick said "this will become part of the API"
         # until then, please look the other way
         while hash['mergeable'].nil?

data/lib/gh/parallel.rb

@@ -5,6 +5,8 @@ require 'backports/basic_object' unless defined? BasicObject
 module GH
   # Public: ...
   class Parallel < Wrapper
+    attr_accessor :parallelize
+
     class Dummy < BasicObject
       attr_accessor :__delegate__
       def method_missing(*args)
@@ -14,6 +16,7 @@ module GH
     end
 
     def setup(*)
+      @parallelize = true if @parallelize.nil?
       @in_parallel = false
       @mutex       = Mutex.new
       @queue       = []
@@ -28,7 +31,7 @@ module GH
     end
 
     def in_parallel
-      return yield if in_parallel?
+      return yield if in_parallel? or not @parallelize
       was, @in_parallel = @in_parallel, true
       result = nil
       connection.in_parallel { result = yield }

data/lib/gh/remote.rb

@@ -42,16 +42,12 @@ module GH
       faraday_options[:ssl] = options[:ssl] if options[:ssl]
       faraday_options.merge! options[:faraday_options] if options[:faraday_options]
 
-      adapter = options[:adapter]
-      adapter ||= Faraday::Adapter::NetHttp if defined? RUBY_ENGINE and RUBY_ENGINE == 'jruby'
-      adapter ||= GH::FaradayAdapter
-
       @connection = Faraday.new(faraday_options) do |builder|
         builder.request(:authorization, :token, token) if token
         builder.request(:basic_auth, username, password)  if username and password
         builder.request(:retry)
         builder.response(:raise_error)
-        builder.use(adapter)
+        builder.use(options[:adapter] || GH::FaradayAdapter)
       end
     end
 
@@ -67,7 +63,10 @@ module GH
 
     # Internal: ...
     def generate_response(key, response)
-      modify(response.body, response.headers)
+      body, headers = response.body, response.headers
+      url = response.respond_to?(:url) ? response.url : response.env.try(:[], :url)
+      url = full_url(key) if url.to_s.empty?
+      modify(body, headers, url)
     end
 
     # Internal: ...
@@ -78,7 +77,7 @@ module GH
     # Internal: ...
     def request(verb, key, body = nil)
       response = frontend.http(verb, path_for(key), headers) do |req|
-        req.body = Response.new({}, body).to_s if body
+        req.body = Response.new(body).to_s if body
       end
       frontend.generate_response(key, response)
     end
@@ -123,9 +122,9 @@ module GH
       path_for(key)
     end
 
-    def modify(body, headers = {})
+    def modify(body, headers = {}, url = nil)
       return body if body.is_a? Response
-      Response.new(headers, body)
+      Response.new(body, headers, url)
     end
   end
 end

data/lib/gh/response.rb

@@ -12,7 +12,7 @@ module GH
     CONTENT_TYPE = "application/json; charset=utf-8"
 
     include Enumerable
-    attr_accessor :headers, :data, :body
+    attr_accessor :headers, :data, :body, :url
 
     # subset of safe methods that both Array and Hash implement
     extend Forwardable
@@ -23,8 +23,10 @@ module GH
     #
     # headers - HTTP headers as a Hash
     # body    - HTTP body as a String
-    def initialize(headers = {}, body = "{}")
+    def initialize(body = "{}", headers = {}, url = nil)
+      @url     = url
       @headers = Hash[headers.map { |k,v| [k.downcase, v] }]
+
       raise ArgumentError, "unexpected Content-Type #{content_type}" if content_type and content_type != CONTENT_TYPE
 
       case body
@@ -38,6 +40,8 @@ module GH
       @body.force_encoding("utf-8") if @body.respond_to? :force_encoding
       @body ||= MultiJson.encode(@data)
       @data ||= MultiJson.decode(@body)
+    rescue EncodingError => error
+      fail "Invalid encoding in #{url.to_s}, please contact github."
     end
 
     # Public: Duplicates the instance. Will also duplicate some instance variables to behave as expected.

data/lib/gh/version.rb

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

data/lib/gh/wrapper.rb

@@ -27,6 +27,9 @@ module GH
     # Public: Get wrapped layer.
     attr_reader :backend
 
+    # Public: ...
+    attr_reader :options
+
     # Public: Returns the URI used for sending out web request.
     def_delegator :backend, :api_host
 
@@ -86,8 +89,9 @@ module GH
     # backend - layer to be wrapped
     # options - config options
     def initialize(backend = nil, options = {})
-      setup(*normalize_options(backend, options))
-      options.each_pair { |key, value| public_send("#{key}=", value) if respond_to? "#{key}=" }
+      backend, @options = normalize_options(backend, options)
+      @options.each_pair { |key, value| public_send("#{key}=", value) if respond_to? "#{key}=" }
+      setup(backend, @options)
     end
 
     # Public: Set wrapped layer.
@@ -156,7 +160,7 @@ module GH
 
     def modify_response(response)
       result = double_dispatch response.data
-      result.respond_to?(:to_gh) ? result.to_gh : Response.new(response.headers, result)
+      result.respond_to?(:to_gh) ? result.to_gh : Response.new(result, response.headers, response.url)
     end
 
     def modify(data, *)

data/spec/gh_spec.rb

@@ -20,5 +20,13 @@ describe GH do
     it 'returns the block value if block is given' do
       GH.with(:token => "...") { 42 }.should be == 42
     end
+
+    it 'propagates options' do
+      GH.with(:a => :b) do
+        GH.with(:b => :c) do
+          GH.options.should be == {:a => :b, :b => :c}
+        end
+      end
+    end
   end
 end

data/spec/normalizer_spec.rb

@@ -8,7 +8,7 @@ describe GH::Normalizer do
   end
 
   def with_headers(headers = {})
-    response = GH::Response.new(headers)
+    response = GH::Response.new("{}", headers)
     data['/payload'], response.data = response, data['/payload']
   end
 

data/spec/parallel_spec.rb

@@ -44,6 +44,30 @@ describe GH::Parallel do
     GH.should_not be_in_parallel
   end
 
+  it 'runs requests right away if parallelize is set to false' do
+    WebMock.allow_net_connect!
+    GH::DefaultStack.replace GH::MockBackend, GH::Remote
+    GH.with :parallelize => false do
+      GH.should_not be_in_parallel
+
+      a = b = nil
+      GH.in_parallel do
+        GH.should_not be_in_parallel
+
+        a = GH['users/rkh']
+        b = GH['users/svenfuchs']
+
+        a['name'].should be == "Konstantin Haase"
+        b['name'].should be == "Sven Fuchs"
+      end
+
+      a['name'].should be == "Konstantin Haase"
+      b['name'].should be == "Sven Fuchs"
+
+      GH.should_not be_in_parallel
+    end
+  end
+
   it 'returns the block value' do
     GH.in_parallel { 42 }.should be == 42
   end

data/spec/response_spec.rb

@@ -5,12 +5,11 @@ describe GH::Response do
   it 'handles UTF-8 properly, even if encoded binary' do
     raw = '{"foo":"über cool sista året"}'
     raw.force_encoding 'binary' if raw.respond_to? :force_encoding
-    response = GH::Response.new({}, raw)
+    response = GH::Response.new(raw)
     response['foo'].should be == 'über cool sista året'
   end
 
   it 'handles broken encodings properly' do
-    pending if RUBY_ENGINE == 'jruby' # see https://github.com/flori/json/issues/138
-    GH::Response.new({}, "{\"foo\":\"\xC3\"}")["foo"].should be == "\xC3"
+    GH::Response.new("{\"foo\":\"\xC3\"}")["foo"].should be == "\xC3"
   end
 end

data/spec/spec_helper.rb

@@ -51,10 +51,11 @@ module GH
           File.write file, [res.headers, res.body].to_yaml
         end
 
-        Response.new(*YAML.load_file(file))
+        headers, body = YAML.load_file(file)
+        Response.new(body, headers, full_url(key))
       end
 
-      result = Response.new({}, result) unless result.is_a? Response
+      result = Response.new(result) unless result.is_a? Response
       result
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gh
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-06 00:00:00.000000000 Z
+date: 2012-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70100388987640 !ruby/object:Gem::Requirement
+  requirement: &70105565578080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70100388987640
+  version_requirements: *70105565578080
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70100388987220 !ruby/object:Gem::Requirement
+  requirement: &70105565576840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70100388987220
+  version_requirements: *70105565576840
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70100388986720 !ruby/object:Gem::Requirement
+  requirement: &70105565576200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70100388986720
+  version_requirements: *70105565576200
 - !ruby/object:Gem::Dependency
   name: backports
-  requirement: &70100388986220 !ruby/object:Gem::Requirement
+  requirement: &70105565586200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '2.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70100388986220
+  version_requirements: *70105565586200
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70100386169740 !ruby/object:Gem::Requirement
+  requirement: &70105565583400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70100386169740
+  version_requirements: *70105565583400
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70100386169360 !ruby/object:Gem::Requirement
+  requirement: &70105565597220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,21 +76,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70100386169360
+  version_requirements: *70105565597220
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
-  requirement: &70100386168900 !ruby/object:Gem::Requirement
+  requirement: &70105565595200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.7'
   type: :runtime
   prerelease: false
-  version_requirements: *70100386168900
+  version_requirements: *70105565595200
 - !ruby/object:Gem::Dependency
   name: net-http-pipeline
-  requirement: &70100386168480 !ruby/object:Gem::Requirement
+  requirement: &70105565593540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70100386168480
+  version_requirements: *70105565593540
 description: multi-layer client for the github api v3
 email:
 - konstantin.mailinglists@googlemail.com
@@ -230,3 +230,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/stack_spec.rb
 - spec/wrapper_spec.rb
+has_rdoc: