gh 0.0.1 → 0.1.0

data/.travis.yml

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

data/README.md

@@ -22,4 +22,17 @@ api = GH::Stack.build do
   use GH::Normalizer
   use GH::Remote, username: "admin", password: "admin"
 end
-```
+```
+
+Usage example:
+
+``` ruby
+GH.with username: 'rkh' password: 'abc123' do
+  sven = GH['users/svenfuchs']
+
+  if sven['hireable']
+    # recruiter has to be provided by some different library
+    Recruiter.contact sven['email']
+  end
+end
+```

data/lib/gh.rb

@@ -5,26 +5,34 @@ require 'forwardable'
 module GH
   autoload :Cache,      'gh/cache'
   autoload :Case,       'gh/case'
+  autoload :LazyLoader, 'gh/lazy_loader'
   autoload :Normalizer, 'gh/normalizer'
   autoload :Remote,     'gh/remote'
   autoload :Response,   'gh/response'
   autoload :Stack,      'gh/stack'
   autoload :Wrapper,    'gh/wrapper'
 
-  def self.[](key)
-    backend = Thread.current[:GH] ||= DefaultStack.build
-    backend[key]
-  end
-
   def self.with(backend)
     backend = DefaultStack.build(backend) if Hash === backend
-    was, Thread.current[:GH] = Thread.current[:GH], backend
+    was, self.current = current, backend
     yield
   ensure
-    Thread.current[:GH] = was
+    self.current = was
+  end
+
+  def self.current
+    Thread.current[:GH] ||= DefaultStack.new
   end
 
+  def self.current=(backend)
+    Thread.current[:GH] = backend
+  end
+
+  extend SingleForwardable
+  def_delegators :current, :api_host, :[], :reset
+
   DefaultStack = Stack.new do
+    use LazyLoader
     use Cache
     use Normalizer
     use Remote

data/lib/gh/cache.rb

@@ -2,8 +2,7 @@ require 'gh'
 require 'thread'
 
 module GH
-  # Public: This class deals with HTTP requests to Github. It is the base Wrapper you always want to use.
-  # Note that it is usually used implicitely by other wrapper classes if not specified.
+  # Public: This class caches responses.
   class Cache < Wrapper
     # Public: Get/set cache to use. Compatible with Rails/ActiveSupport cache.
     attr_accessor :cache
@@ -20,9 +19,14 @@ module GH
       # Internal: Tries to fetch a value from the cache and if it doesn't exist, generates it from the
       # block given.
       def fetch(key)
-        @mutex.lock { @old, @new = @new, {} if @new.size > @size } if @new.size > @size
+        @mutex.synchronize { @old, @new = @new, {} if @new.size > @size } if @new.size > @size
         @new[key] ||= @old[key] || yield
       end
+
+      # Internal: ...
+      def clear
+        @mutex.synchronize { @old, @new = {}, {} }
+      end
     end
 
     # Internal: Initializes a new Cache instance.
@@ -33,6 +37,12 @@ module GH
       super
     end
 
+    # Public: ...
+    def reset
+      super
+      clear_partial or clear_all
+    end
+
     # Public: Retrieves resources from Github and caches response for future access.
     #
     # Examples
@@ -41,7 +51,22 @@ module GH
     #
     # Returns the Response.
     def [](key)
-      cache.fetch(path_for(key)) { super }
+      cache.fetch(prefixed(key)) { super }
+    end
+
+    private
+
+    def clear_partial
+      return false unless cache.respond_to? :delete_matched
+      pattern = "^" << Regexp.escape(prefixed(""))
+      cache.delete_matched Regexp.new(pattern)
+      true
+    rescue NotImplementedError
+      false
+    end
+
+    def clear_all
+      cache.clear
     end
   end
 end

data/lib/gh/lazy_loader.rb

@@ -0,0 +1,21 @@
+require 'gh'
+
+module GH
+  # Public: ...
+  class LazyLoader < Wrapper
+    double_dispatch
+
+    def modify_hash(hash)
+      hash = super
+      link = hash['_links'].try(:[], 'self')
+      setup_lazy_loading(hash, link['href']) if link
+      hash
+    end
+
+    private
+
+    def lazy_load(hash, key, link)
+      backend[link]
+    end
+  end
+end

data/lib/gh/normalizer.rb

@@ -9,15 +9,13 @@ module GH
     # Returns normalized Response.
     def [](key)
       result = super
-      links(result)['self'] ||= { 'href' => full_url(key).to_s } if result.hash?
+      links(result)['self'] ||= { 'href' => full_url(key).to_s } if result.respond_to? :to_hash
       result
     end
 
     private
 
-    def modify(*)
-      normalize super
-    end
+    double_dispatch
 
     def links(hash)
       hash = hash.data if hash.respond_to? :data
@@ -28,32 +26,32 @@ module GH
       links(hash)[type] = {"href" => href}
     end
 
-    def normalize_response(response)
+    def modify_response(response)
       response      = response.dup
-      response.data = normalize response.data
+      response.data = modify response.data
       response
     end
 
-    def normalize_hash(hash)
+    def modify_hash(hash)
       corrected = {}
       corrected.default_proc = hash.default_proc if hash.default_proc
 
       hash.each_pair do |key, value|
-        key = normalize_key(key, value)
-        next if normalize_url(corrected, key, value)
-        next if normalize_time(corrected, key, value)
-        corrected[key] = normalize(value)
+        key = modify_key(key, value)
+        next if modify_url(corrected, key, value)
+        next if modify_time(corrected, key, value)
+        corrected[key] = modify(value)
       end
 
-      normalize_user(corrected)
+      modify_user(corrected)
       corrected
     end
 
-    def normalize_time(hash, key, value)
+    def modify_time(hash, key, value)
       hash['date'] = Time.at(value).xmlschema if key == 'timestamp'
     end
 
-    def normalize_user(hash)
+    def modify_user(hash)
       hash['owner']  ||= hash.delete('user') if hash['created_at']   and hash['user']
       hash['author'] ||= hash.delete('user') if hash['committed_at'] and hash['user']
 
@@ -61,7 +59,7 @@ module GH
       hash['author']    ||= hash['committer'] if hash['committer']
     end
 
-    def normalize_url(hash, key, value)
+    def modify_url(hash, key, value)
       case key
       when "blog"
         set_link(hash, key, value)
@@ -73,14 +71,14 @@ module GH
       end
     end
 
-    def normalize_key(key, value = nil)
+    def modify_key(key, value = nil)
       case key
       when 'gravatar_url'         then 'avatar_url'
       when 'org'                  then 'organization'
       when 'orgs'                 then 'organizations'
       when 'username'             then 'login'
       when 'repo'                 then 'repository'
-      when 'repos'                then normalize_key('repositories', value)
+      when 'repos'                then modify_key('repositories', value)
       when /^repos?_(.*)$/        then "repository_#{$1}"
       when /^(.*)_repo$/          then "#{$1}_repository"
       when /^(.*)_repos$/         then "#{$1}_repositories"
@@ -92,18 +90,5 @@ module GH
       else key
       end
     end
-
-    def normalize_array(array)
-      array.map { |e| normalize(e) }
-    end
-
-    def normalize(object)
-      case object
-      when Hash     then normalize_hash(object)
-      when Array    then normalize_array(object)
-      when Response then normalize_response(object)
-      else object
-      end
-    end
   end
 end

data/lib/gh/remote.rb

@@ -5,7 +5,7 @@ module GH
   # Public: This class deals with HTTP requests to Github. It is the base Wrapper you always want to use.
   # Note that it is usually used implicitely by other wrapper classes if not specified.
   class Remote < Wrapper
-    attr_reader :api_host, :connection, :headers
+    attr_reader :api_host, :connection, :headers, :prefix
 
     # Public: Generates a new Rempte instance.
     #
@@ -33,6 +33,11 @@ module GH
         "Accept-Charset"  => "utf-8"
       }
 
+      @prefix = ""
+      @prefix << "#{token}@" if token
+      @prefix << "#{username}:#{password}@" if username and password
+      @prefix << @api_host.host
+
       @connection = Faraday.new(:url => api_host) do |builder|
         builder.request(:token_auth, token)               if token
         builder.request(:basic_auth, username, password)  if username and password
@@ -61,8 +66,21 @@ module GH
       modify(response.body, response.headers)
     end
 
+    # Public: ...
+    def reset
+    end
+
+    # Public: ...
+    def load(data)
+      modify(data)
+    end
+
     private
 
+    def identifier(key)
+      path_for(key)
+    end
+
     def modify(body, headers = {})
       return body if body.is_a? Response
       Response.new(headers, body)

data/lib/gh/response.rb

@@ -69,8 +69,9 @@ module GH
       @data.dup.to_ary
     end
 
-    def hash?
-      respond_to? :to_hash
+    # Public: ...
+    def to_gh
+      self
     end
 
     protected

data/lib/gh/stack.rb

@@ -48,5 +48,12 @@ module GH
         klass.new backend, @options.merge(opts).merge(options)
       end
     end
+
+    # Public: ...
+    def replace(old_class, new_class)
+      @stack.map! { |klass, options| [old_class == klass ? new_class : klass, options] }
+    end
+
+    alias_method :new, :build
   end
 end

data/lib/gh/version.rb

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

data/lib/gh/wrapper.rb

@@ -22,6 +22,7 @@ module GH
   #   end
   class Wrapper
     extend Forwardable
+    include Case
 
     # Public: Get wrapped layer.
     attr_reader :backend
@@ -29,6 +30,11 @@ module GH
     # Public: Returns the URI used for sending out web request.
     def_delegator :backend, :api_host
 
+    # Public: Retrieves resources from Github.
+    def self.[](key)
+      new[key]
+    end
+
     # Public: Retrieves resources from Github.
     #
     # By default, this method is delegated to the next layer on the stack
@@ -40,7 +46,7 @@ module GH
     # Internal: Get/set default layer to wrap when creating a new instance.
     def self.wraps(klass = nil)
       @wraps = klass if klass
-      @wraps || Remote
+      @wraps ||= Remote
     end
 
     # Public: Initialize a new Wrapper.
@@ -54,6 +60,7 @@ module GH
 
     # Public: Set wrapped layer.
     def backend=(layer)
+      reset
       layer.frontend = self
       @backend = layer
     end
@@ -68,16 +75,75 @@ module GH
       @frontend ? @frontend.frontend : self
     end
 
+    # Public: ...
     def inspect
       "#<#{self.class}: #{backend.inspect}>"
     end
 
+    # Internal: ...
+    def prefixed(key)
+      prefix + "#" + identifier(key)
+    end
+
+    # Public: ...
+    def reset
+      backend.reset if backend
+    end
+
+    # Public: ...
+    def load(data)
+      modify backend.load(data)
+    end
+
     private
 
-    def modify(data)
+    def identifier(key)
+      backend.prefixed(key)
+    end
+
+    def prefix
+      self.class.name
+    end
+
+    def self.double_dispatch
+      define_method(:modify) { |data| double_dispatch(data) }
+    end
+
+    def double_dispatch(data)
+      case data
+      when respond_to(:to_gh)   then modify_response(data)
+      when respond_to(:to_hash) then modify_hash(data)
+      when respond_to(:to_ary)  then modify_array(data)
+      when respond_to(:to_str)  then modify_string(data)
+      when respond_to(:to_int)  then modify_integer(data)
+      else modify_unkown data
+      end
+    end
+
+    def modify_response(response)
+      result = double_dispatch response.data
+      result.respond_to?(:to_gh) ? result.to_gh : Response.new({}, result)
+    end
+
+    def modify(data, *)
       data
     end
 
+    def modify_array(array)
+      array.map { |e| modify(e) }
+    end
+
+    def modify_hash(hash, &block)
+      corrected = {}
+      hash.each_pair { |k,v| corrected[k] = modify(v) }
+      corrected.default_proc = hash.default_proc if hash.default_proc
+      corrected
+    end
+
+    alias modify_string   modify
+    alias modify_integer  modify
+    alias modify_unkown   modify
+
     def setup(backend, options)
       self.backend = Wrapper === backend ? backend : self.class.wraps.new(backend, options)
     end
@@ -90,13 +156,33 @@ module GH
     end
 
     def full_url(key)
-      api_host + path_for(key)
+      uri = api_host + Addressable::URI.parse(key)
+      raise ArgumentError, "URI out of scope: #{key}" if uri.host != api_host.host
+      uri
+    end
+
+    def setup_default_proc(hash, &block)
+      old_proc = hash.default_proc
+      hash.default_proc = proc do |hash, key|
+        value = old_proc.call(hash, key) if old_proc
+        value = block[hash, key] if value.nil?
+        value
+      end
+    end
+
+    def setup_lazy_loading(hash, *args)
+      loaded = false
+      setup_default_proc hash do |hash, key|
+        next if loaded
+        fields = lazy_load(hash, key, *args)
+        hash.merge! fields
+        loaded = true
+        fields[key]
+      end
     end
 
     def path_for(key)
-      uri = Addressable::URI.parse(key)
-      raise ArgumentError, "URI out of scope: #{key}" if uri.host and uri.host != api_host.host
-      uri.request_uri
+      full_url(key).request_uri
     end
   end
 end

data/spec/cache_spec.rb

@@ -14,4 +14,15 @@ describe GH::Cache do
     subject['users/rkh']['name'].should be == "Konstantin Haase"
     requests.count.should be == 2
   end
+
+  it 'cache is resettable' do
+    subject['users/rkh']['name'].should be == "Konstantin Haase"
+    subject['users/rkh']['name'].should be == "Konstantin Haase"
+    requests.count.should be == 1
+
+    subject.reset
+    requests.count.should be == 0
+    subject['users/rkh']['name'].should be == "Konstantin Haase"
+    requests.count.should be == 1
+  end
 end

data/spec/gh_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe GH do
+  it 'allows doing requests right from the GH object' do
+    GH['users/rkh']['name'].should be == "Konstantin Haase"
+  end
+end

data/spec/lazy_loader_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe GH::LazyLoader do
+  before { subject.backend = GH::Normalizer.new(GH::MockBackend.new) }
+
+  let! :raw do
+    hash = subject.backend['users/rkh'].to_hash
+    hash.delete 'name'
+    hash
+  end
+
+  let :rkh do
+    subject.load(raw)
+  end
+
+  it 'send http requests for missing fields' do
+    should_request(1) { rkh['name'].should be == 'Konstantin Haase' }
+  end
+
+  it 'does not send http requests for existing fields' do
+    should_not_request { rkh['login'].should be == 'rkh' }
+  end
+
+  it 'allows traversing into nested structures' do
+    sven = subject.backend['users/svenfuchs'].to_hash
+    sven['friends'] = [raw]
+    sven.delete 'name'
+
+    sven = subject.load(sven)
+    should_request(1) { sven['friends'][0]['name'].should be == 'Konstantin Haase' }
+  end
+
+  it 'does not request twice if the field does not exist upstream' do
+    should_request(1) { 2.times { rkh['foo'] } }
+  end
+
+  it 'does not skip an already existing default proc' do
+    count = 0
+    raw.default_proc = proc { |hash, key| count += 1 if key == 'foo' }
+    rkh = subject.load(raw)
+
+    should_not_request do
+      rkh['foo'].should be == 1
+      rkh['foo'].should be == 2
+    end
+  end
+
+  it 'is still loading missing fields, even if a default proc is set' do
+    count = 0
+    raw.default_proc = proc { |hash, key| count += 1 if key == 'foo' }
+    rkh = subject.load(raw)
+
+    should_request 1 do
+      rkh['foo'].should be == 1
+      rkh['name'].should be == 'Konstantin Haase' 
+      rkh['foo'].should be == 2
+    end
+  end
+end

data/spec/normalizer_spec.rb

@@ -4,16 +4,16 @@ describe GH::Normalizer do
   before { subject.backend = GH::MockBackend.new }
 
   def normalize(payload)
-    data['payload'] = payload
+    data['/payload'] = payload
   end
 
   def with_headers(headers = {})
     response = GH::Response.new(headers)
-    data['payload'], response.data = response, data['payload']
+    data['/payload'], response.data = response, data['/payload']
   end
 
   def normalized
-    subject['payload']
+    subject['/payload']
   end
 
   it 'is set up properly' do
@@ -25,6 +25,12 @@ describe GH::Normalizer do
     normalized['foo'].should be == 'bar'
   end
 
+  it 'allows normalization with #load' do
+    result = subject.load("org" => "foo")
+    result.should_not include("org")
+    result["organization"].should be == "foo"
+  end
+
   it 'works for deeply nested fields'
   it 'works for lists'
 
@@ -256,5 +262,10 @@ describe GH::Normalizer do
       normalized['_links'].should_not include('html')
       normalized['_links']['self']['href'].should be == 'http://api.github.com/foo'
     end
+
+    it 'passes through true' do
+      normalize 'foo' => true
+      normalized['foo'].should be == true
+    end
   end
 end

data/spec/spec_helper.rb

@@ -5,8 +5,9 @@ require 'fileutils'
 
 module GH
   module TestHelpers
-    def backend
-      subject.backend
+    def backend(layer = subject)
+      return layer if layer.backend.nil? or layer.is_a? MockBackend
+      backend layer.backend
     end
 
     def requests
@@ -16,6 +17,16 @@ module GH
     def data
       backend.data
     end
+
+    def should_request(num = 1, &block)
+      was = requests.count
+      yield
+      (requests.count - was).should be == num
+    end
+
+    def should_not_request(&block)
+      should_request(0, &block)
+    end
   end
 
   class MockBackend < Wrapper
@@ -45,6 +56,12 @@ module GH
       result
     end
 
+    def reset
+      super
+      @data.clear
+      @requests.clear
+    end
+
     private
 
     def allow_http
@@ -59,4 +76,6 @@ end
 
 RSpec.configure do |c|
   c.include GH::TestHelpers
+  c.before { GH::DefaultStack.replace GH::Remote, GH::MockBackend }
+  c.after { GH.reset }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gh
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-22 00:00:00.000000000 Z
+date: 2012-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70328844248000 !ruby/object:Gem::Requirement
+  requirement: &70185635369900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70328844248000
+  version_requirements: *70185635369900
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70328844247440 !ruby/object:Gem::Requirement
+  requirement: &70185635369280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70328844247440
+  version_requirements: *70185635369280
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70328844262860 !ruby/object:Gem::Requirement
+  requirement: &70185635368560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.7'
   type: :runtime
   prerelease: false
-  version_requirements: *70328844262860
+  version_requirements: *70185635368560
 - !ruby/object:Gem::Dependency
   name: backports
-  requirement: &70328844262340 !ruby/object:Gem::Requirement
+  requirement: &70185635367800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '2.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70328844262340
+  version_requirements: *70185635367800
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70328844261880 !ruby/object:Gem::Requirement
+  requirement: &70185635367120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70328844261880
+  version_requirements: *70185635367120
 description: multi-layer client for the github api v3
 email:
 - konstantin.mailinglists@googlemail.com
@@ -83,6 +83,7 @@ files:
 - lib/gh/cache.rb
 - lib/gh/case.rb
 - lib/gh/faraday.rb
+- lib/gh/lazy_loader.rb
 - lib/gh/normalizer.rb
 - lib/gh/remote.rb
 - lib/gh/response.rb
@@ -90,6 +91,8 @@ files:
 - lib/gh/version.rb
 - lib/gh/wrapper.rb
 - spec/cache_spec.rb
+- spec/gh_spec.rb
+- spec/lazy_loader_spec.rb
 - spec/normalizer_spec.rb
 - spec/payloads/users/rkh.yml
 - spec/payloads/users/svenfuchs.yml
@@ -124,6 +127,8 @@ specification_version: 3
 summary: layered github client
 test_files:
 - spec/cache_spec.rb
+- spec/gh_spec.rb
+- spec/lazy_loader_spec.rb
 - spec/normalizer_spec.rb
 - spec/payloads/users/rkh.yml
 - spec/payloads/users/svenfuchs.yml