leadlight 0.0.2

data/spec/cassettes/Leadlight/tinted_GitHub_example/user_link/exists.yml

@@ -0,0 +1,32 @@
+--- 
+http_interactions: 
+- request: 
+    method: get
+    uri: https://api.github.com/
+    body: ""
+    headers: 
+      Accept: 
+      - application/json, text/x-yaml, application/xml, application/xhtml+xml, text/html, text/plain
+  response: 
+    status: 
+      code: 204
+      message: 
+    headers: 
+      server: 
+      - nginx/1.0.4
+      date: 
+      - Mon, 09 Jan 2012 02:31:45 GMT
+      connection: 
+      - close
+      status: 
+      - 204 No Content
+      x-ratelimit-limit: 
+      - "5000"
+      etag: 
+      - "\"d41d8cd98f00b204e9800998ecf8427e\""
+      x-ratelimit-remaining: 
+      - "4993"
+    body: ""
+    http_version: 
+  recorded_at: Mon, 09 Jan 2012 02:31:43 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/Leadlight/tinted_GitHub_example/user_link/links_to_the_expected_URL.yml

@@ -0,0 +1,32 @@
+--- 
+http_interactions: 
+- request: 
+    method: get
+    uri: https://api.github.com/
+    body: ""
+    headers: 
+      Accept: 
+      - application/json, text/x-yaml, application/xml, application/xhtml+xml, text/html, text/plain
+  response: 
+    status: 
+      code: 204
+      message: 
+    headers: 
+      server: 
+      - nginx/1.0.4
+      date: 
+      - Mon, 09 Jan 2012 02:31:45 GMT
+      connection: 
+      - close
+      status: 
+      - 204 No Content
+      x-ratelimit-limit: 
+      - "5000"
+      etag: 
+      - "\"d41d8cd98f00b204e9800998ecf8427e\""
+      x-ratelimit-remaining: 
+      - "4992"
+    body: ""
+    http_version: 
+  recorded_at: Mon, 09 Jan 2012 02:31:44 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/leadlight/codec_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper_lite'
+require 'leadlight/codec'
+
+module Leadlight
+  describe Codec do
+    let(:subject)        {
+      # Due to the static init in Codec, we need to reload the class
+      # after stubs/mocks are set up
+      load 'leadlight/codec.rb'
+      Codec.new
+    }
+    let(:representation) { stub(:representation)  }
+    let(:entity_body)    { stub(:entity_body)  }
+
+    it 'decodes JSON' do
+      MultiJson.should_receive(:decode).
+        with(entity_body, anything).
+        and_return(representation)
+      subject.decode('application/json', entity_body).
+        should equal(representation)
+    end
+
+    it 'decodes types ending in +json as JSON' do
+      MultiJson.should_receive(:decode).
+        with(entity_body, anything).
+        and_return(representation)
+      subject.decode('application/vnc.example.user+json foo=bar', entity_body).
+        should equal(representation)
+    end
+
+    it 'decodes text/plain as a string' do
+      subject.decode('text/plain', entity_body).should eq(entity_body)
+    end
+
+    it 'barfs on unrecognized content-type' do
+      expect{ subject.decode('xyzzy', entity_body) }.
+        to raise_error(ArgumentError)
+    end
+
+    it 'ignores junk after the content type' do
+      subject.decode('text/plain foo=bar', entity_body).should eq(entity_body)
+    end
+
+    it 'ignores whitespace in the content type' do
+      subject.decode('  text/plain foo=bar', entity_body).should eq(entity_body)
+    end
+
+    it 'passes options to the JSON decoder' do
+      MultiJson.should_receive(:decode).
+        with(anything, {foo: 42})
+      subject.decode('application/json', entity_body, foo: 42)
+    end
+
+    it 'decodes JSON with multi_json' do
+      MultiJson.should_receive(:decode).
+        with(entity_body, anything).
+        and_return(representation)
+      subject.decode('application/json', entity_body).
+        should equal(representation)
+    end
+
+    it 'encodes types ending in +json as JSON' do
+      MultiJson.should_receive(:encode).
+        with(representation, anything).
+        and_return(entity_body)
+      subject.encode('application/vnc.example.user+json foo=bar', representation).
+        should equal(entity_body)
+    end
+
+    it 'encodes text/plain as a string' do
+      subject.encode('text/plain', representation).should eq(representation.to_s)
+    end
+
+    it 'barfs on encoding unrecognized content-type' do
+      expect{ subject.encode('xyzzy', representation) }.
+        to raise_error(ArgumentError)
+    end
+
+    it 'ignores junk after the content type for encoding' do
+      subject.encode('text/plain foo=bar', representation).should eq(representation.to_s)
+    end
+
+    it 'ignores whitespace in the content type for encoding' do
+      subject.encode('  text/plain foo=bar', representation).should eq(representation.to_s)
+    end
+
+    it 'passes options to the JSON encoder' do
+      MultiJson.should_receive(:encode).
+        with(anything, {foo: 42})
+      subject.encode('application/json', representation, foo: 42)
+    end
+  end
+end

data/spec/leadlight/hyperlinkable_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper_lite'
+require 'leadlight/hyperlinkable'
+
+module Leadlight
+  describe Hyperlinkable do
+    subject { representation.extend(Hyperlinkable) }
+    let(:representation) { Object.new }
+    let(:response) { stub(:response, env: env) }
+    let(:response_url) { Addressable::URI.parse('/foo') }
+    let(:request) { stub(:request) }
+    let(:env) {
+      {
+        url: '/foo',
+        leadlight_service: service,
+        :response_headers => headers
+      }
+    }
+    let(:service) { stub(url: 'http://example.com') }
+    let(:headers) { {'Link' => links} }
+    let(:links) {
+      '<https://api.github.com/users/avdi/followers?page=2>; rel="next",'\
+      ' <https://api.github.com/users/avdi/followers?page=6>; rel="last"'
+    }
+
+    before do
+      representation.stub(__response__: response, __service__: service)
+    end
+
+    describe '.extend' do
+
+      it 'adds itself to the representation' do
+        subject.should be_a(Hyperlinkable)
+      end
+
+      it 'adds a self link' do
+        subject.link('self').should be_a(Link)
+        subject.link('self').href.to_s.should eq('/foo')
+        subject.link('self').rel.should eq('self')
+        subject.link('self').rev.should eq('self')
+        subject.link('self').title.should eq('self')
+      end
+
+      it 'adds links from Link header' do
+        subject.link('next').href.to_s.
+          should eq('https://api.github.com/users/avdi/followers?page=2')
+        subject.link('last').href.to_s.
+          should eq('https://api.github.com/users/avdi/followers?page=6')
+      end
+
+    end
+
+    describe '#add_link' do
+      it 'swells the links collection' do
+        expect { subject.add_link('/foo') }.to change{ subject.links.size }.by(1)
+      end
+
+      it 'expands links' do
+        subject.add_link('/parent', 'parent')
+        subject.link('parent').href.to_s.should eq('/parent')
+      end
+
+      it 'adds a Link' do
+        subject.add_link('/parent', 'parent')
+        subject.link('parent').should be_a(Link)
+      end
+
+      it 'adds a link helper' do
+        subject.add_link('/parent', 'parent')
+        service.should_receive(:get_representation!).
+          with(Addressable::URI.parse('/parent')).
+          and_return(request)
+        subject.parent
+      end
+    end
+
+    describe '#add_link_template' do
+      it 'adds a link' do
+        expect { subject.add_link_template('/foo/{id}') }.to change{ subject.links.size }.by(1)
+      end
+
+      it 'expands links' do
+        subject.add_link_template('/child/{index}', 'child')
+        href = subject.link('child').href
+        href.to_s.should eq('/child/{index}')
+      end
+
+      it 'adds a LinkTemplate' do
+        subject.add_link_template('/child/{index}', 'child')
+        subject.link('child').should be_a(LinkTemplate)
+      end
+
+      it 'adds a link helper' do
+        subject.add_link_template('/child/{index}', 'child')
+        service.should_receive(:get_representation!).
+          with('/child/23')
+        subject.child(23)
+      end
+
+    end
+
+    describe '#add_link_set' do
+      before do
+        subject.add_link_set('bourbon') do
+          [
+           {href: 'http://example.com/blantons',  title: 'Blantons'},
+           {href: 'http://example.com/bookers',   title: 'Bookers'},
+           {href: 'http://example.com/knobcreek', title: 'Knob Creek', aliases: ['KC']},
+          ]
+        end
+      end
+
+      it 'adds links for each member of the set' do
+        links = subject.links('bourbon').map(&:href).map(&:to_s)
+        links.should include('http://example.com/blantons')
+        links.should include('http://example.com/bookers')
+        links.should include('http://example.com/knobcreek')
+      end
+
+      it 'establishes a link helper that finds by title' do
+        result_stubs = [stub, stub, stub]
+        service.should_receive(:get_representation!).and_yield(result_stubs[0])
+        service.should_receive(:get_representation!).and_yield(result_stubs[1])
+        service.should_receive(:get_representation!).and_yield(result_stubs[2])
+        subject.bourbon('Blantons').should equal(result_stubs[0])
+        subject.bourbon('Bookers').should equal(result_stubs[1])
+        subject.bourbon('Knob Creek').should equal(result_stubs[2])
+      end
+
+      it 'sets up the link helper to handle aliases' do
+        result = stub
+        service.should_receive(:get_representation!).and_yield(result)
+        subject.bourbon('KC').should equal(result)
+      end
+    end
+  end
+end

data/spec/leadlight/link_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper_lite'
+require 'leadlight/link'
+
+module Leadlight
+  describe Link do
+    subject { Link.new(service, href, rel, title, options) }
+    let(:service) { stub(:service, get: nil) }
+    let(:href)    { '/TEST_PATH'   }
+    let(:rel)     { 'TEST_REL'     }
+    let(:title)   { 'TEST_TITLE'   }
+    let(:options) { {}             }
+
+    describe '#follow' do
+      it 'calls service.get with the href' do
+        service.should_receive(:get_representation!).with(Addressable::URI.parse(href))
+        subject.follow
+      end
+
+      it 'returns the result of the get' do
+        request = stub
+        result = stub
+        service.should_receive(:get_representation!).
+          and_yield(result).
+          and_return(request)
+        subject.follow.should equal(result)
+      end
+    end
+
+    def self.delegates_to_service(method_name)
+      it "delegates ##{method_name} to the service" do
+        yielded        = :nothing
+        args           = [:foo, :bar]
+        request        = stub(:request)
+        representation = stub(:representation)
+        service.should_receive(method_name).
+          with(subject.href, *args).
+          and_yield(representation).
+          and_return(request)
+        subject.public_send(method_name, *args) do |rep|
+          yielded = rep
+        end.should equal(request)
+      end
+    end
+
+    delegates_to_service :get
+    delegates_to_service :post
+    delegates_to_service :head
+    delegates_to_service :options
+    delegates_to_service :put
+    delegates_to_service :delete
+    delegates_to_service :patch
+  end
+end

data/spec/leadlight/link_template_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper_lite'
+require 'leadlight/link_template'
+
+module Leadlight
+  describe LinkTemplate do
+
+    # TODO: This setup is loony. Refactor.
+    subject { LinkTemplate.new(service, href, rel, title, options) }
+    let(:service) { stub(:service) }
+    let(:request) { stub(:request)               }
+    let(:result)  { stub(:result)                }
+    let(:href)    { '/TEST_PATH/{n}/{m}/'   }
+    let(:rel)     { 'TEST_REL'     }
+    let(:title)   { 'TEST_TITLE'   }
+    let(:options) { {}             }
+    let(:mapping) { {'n' => 'N_VALUE', 'm' => 'M_VALUE'} }
+    let(:values)  { mapping.values }
+
+    before do
+      request.stub(raise_on_error: request)
+      service.stub(:get_representation!).and_yield(result).and_return(request)
+    end
+
+    describe '#follow' do
+      it 'calls service.get with the expanded href' do
+        service.should_receive(:get_representation!).with('/TEST_PATH/23/42/')
+        subject.follow(23,42)
+      end
+
+      it 'can accept a hash for template parameters' do
+        service.should_receive(:get_representation!).with('/TEST_PATH/AA/BB/')
+        subject.follow(:n => 'AA', 'm' => 'BB')
+      end
+
+      it 'leaves unrecognized params in the params hash alone' do
+        service.should_receive(:get_representation!).with('/TEST_PATH/AA/BB/', {'other' => 'XX'})
+        subject.follow(:n => 'AA', 'm' => 'BB', :other => 'XX')
+      end
+
+      it 'returns the result of the get' do
+        subject.follow(23,42).should equal(result)
+      end
+    end
+  end
+end

data/spec/leadlight/representation_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper_lite'
+require 'leadlight/representation'
+
+module Leadlight
+  describe Representation do
+    module TintA; end
+    module TintB; end
+
+    subject { object }
+    let(:object)  { Object.new.extend(Representation) }
+    let(:service) { stub(:service, tints: [TintA, TintB]) }
+    let(:location) { stub(:location) }
+    let(:response) { stub(:response) }
+
+    it 'has a __service__ accessor' do
+      subject.__service__ = service
+      subject.__service__.should equal(service)
+    end
+
+    it 'has a __location__ accessor' do
+      subject.__location__ = location
+      subject.__location__.should equal(location)
+    end
+
+    it 'has a __response__ accessor' do
+      subject.__response__ = response
+      subject.__response__.should equal(response)
+    end
+
+    describe '#initialize_representation' do
+      it 'sets __service__, __location__, and __response__' do
+        subject.initialize_representation(service, location, response)
+        subject.__service__.should equal(service)
+        subject.__location__.should equal(location)
+        subject.__response__.should equal(response)
+      end
+
+      it 'returns self' do
+        result = subject.initialize_representation(service, location, response)
+        result.should equal(subject)
+      end
+
+    end
+    describe '#apply_all_tints' do
+      before do
+        subject.initialize_representation(service, location, response)
+      end
+
+      it 'extends object with tints from service' do
+        subject.apply_all_tints
+        subject.should be_a(TintA)
+        subject.should be_a(TintB)
+      end
+
+      it 'applies tints' do
+        object.should_receive(:__apply_tint__)
+        subject.apply_all_tints
+      end
+    end
+
+  end
+end