leadlight 0.0.2

data/spec/leadlight/type_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper_lite'
+require 'leadlight/type'
+
+module Leadlight
+  describe Type do
+    let(:service) { stub(:service) }
+    let(:name)    { "test_type" }
+    let(:type)    { Type.new(name, service, &body) }
+    let(:body)    { Proc.new{} }
+    let(:instance){ stub(:instance) }
+    let(:object)  { instance.extend(type) }
+    let(:encoder) { stub(:encoder) }
+    
+    subject { type }
+
+    its(:name) { should eq(name) }
+    its(:service) { should equal(service) }
+    its(:inspect) { should eq("#<Leadlight::Type:#{name}>") }
+    its(:to_s)    { should eq("Type(#{name})") }
+
+    describe '#build' do
+      let(:body) {  
+        my_builder = stub_builder
+        proc do |*args|
+          builder &my_builder
+        end
+      }
+      let(:stub_builder) { proc{|*args| instance} }
+      it 'uses the specified builder block' do
+        type.build.should eq(instance)
+      end
+
+      it 'passes params to the builder' do
+        stub_builder.should_receive(:call).with(1,2,3)
+        type.build(1,2,3)
+      end
+
+      it 'yields the built object' do
+        yielded = :not_set
+        type.build do |obj|
+          yielded = obj
+        end
+        yielded.should equal(instance)
+      end
+
+      it 'includes itself into the built object' do
+        type.build.should be_a(type)
+      end
+      
+      context 'with no builder specified' do
+        let(:body) { proc{} }
+        it 'defaults to Object.new' do
+          type.build.class.should == Object
+        end
+      end
+    end
+
+    describe 'when included' do
+      subject { object }
+      it 'adds a __type__ to the extended object, referencing itself' do
+        subject.__type__.should equal(type)
+      end
+    end
+
+    describe '#enctype' do
+      context 'when unspecified' do
+        its(:enctype) { should eq('application/json') }
+
+        it 'is used when encoding' do
+          body        = stub
+          entity_body = stub
+          options     = {encoder: encoder}
+          encoder.should_receive(:encode).
+            with('application/json', body, options).
+            and_return(entity_body)
+          type.encode(body, options).should equal(entity_body)
+        end
+      end
+
+      context 'when explicitly specified' do
+        let(:body) { proc{ enctype 'text/plain' } }
+
+        it 'is changed' do
+          type.enctype.should eq('text/plain')
+        end
+
+        it 'is used when encoding' do
+          body        = stub
+          entity_body = stub
+          options     = {encoder: encoder}
+          encoder.should_receive(:encode).
+            with('text/plain', body, options).
+            and_return(entity_body)
+          type.encode(body, options).should equal(entity_body)
+        end
+      end
+    end
+
+    describe 'link_to_create' do
+      let(:body) { 
+        the_link = link
+        proc {
+          link_to_create(the_link)
+        }
+      }
+      let(:link) { '/foo/{x}/bar' }
+
+      it 'is saved' do
+        type.link_to_create.should eq(link)
+      end
+
+      it 'adds a link to the representation' do
+        instance.should_receive(:add_link).with(link, 'create', "Create a new #{name}")
+        object
+      end
+
+    end
+
+    describe '#tint' do
+      subject { type.tint }
+
+      it { should be_a(Tint) }
+      its(:name) { should eq("type:#{name}") }
+    end
+
+    describe '#encode' do
+      it 'defaults to using the representation service as encoder' do
+        representation = stub(__service__: service)
+        entity = stub
+        service.should_receive(:encode).
+          with('application/json', representation, {}).
+          and_return(entity)
+        type.encode(representation).should equal(entity)
+      end
+    end
+  end
+end

data/spec/leadlight_spec.rb

@@ -0,0 +1,237 @@
+require 'spec_helper_lite'
+require 'leadlight'
+
+describe Leadlight, vcr: true do
+  def uri(uri_string)
+    Addressable::URI.parse(uri_string)
+  end
+
+  def urit(pattern)
+    Addressable::Template.new(pattern)
+  end
+
+  let(:logger)  { 
+    logfile = Pathname('../../log/test.log').expand_path(__FILE__)
+    logfile.dirname.mkpath
+    Logger.new(logfile) 
+  }
+
+  describe 'basic GitHub example' do
+    class BasicGithubService
+      Leadlight.build_service(self) do
+        url 'https://api.github.com'
+      end
+    end
+
+    subject { session }
+    let(:session) { BasicGithubService.session(options) }
+    let(:options) { {logger: logger} }
+
+    describe '.root' do
+      subject{ session.root }
+
+      it { should be_blank }
+
+      its(:__location__) { should eq(uri('https://api.github.com')) }
+
+      it "should be a 204  no content" do
+       subject.__response__.status.should eq(204)
+      end
+
+    end
+  end
+
+  describe 'tinted GitHub example' do
+    class TintedGithubService
+      Leadlight.build_service(self) do
+        url 'https://api.github.com'
+
+        tint 'root' do
+          match_path('/')
+          add_link_template '/users/{login}', 'user', 'Find user by login'
+        end
+
+        tint 'user' do
+          match_content_type('application/json')
+          match_class(Hash)
+          match{self['type'] == 'User'}
+          add_link "#{__location__}/followers", 'followers', 'List followers'
+        end
+      end
+    end
+
+    subject { session }
+    let(:session) { TintedGithubService.session(options) }
+    let(:options) { {logger: logger} }
+
+    describe '.root' do
+      subject{ session.root }
+
+      it { should be_blank }
+
+      its(:__location__) { should eq(uri('https://api.github.com')) }
+
+      it "should be a 204  no content" do
+       subject.__response__.status.should eq(204)
+      end
+    end
+
+    describe 'user link' do
+      it 'exists' do
+        subject.root.link('user').should be_a(Leadlight::Link)
+      end
+
+      it 'links to the expected URL' do
+        subject.root.link('user').href.should eq(uri('/users/{login}'))
+      end
+    end
+
+    describe '#user' do
+      it 'has the expected content' do
+        user = subject.root.user('avdi')
+        user['type'].should eq('User')
+        user['location'].should eq('Pennsylvania, USA')
+        user['company'].should eq('ShipRise')
+        user['name'].should eq('Avdi Grimm')
+      end
+    end
+
+    describe 'user followers' do
+      subject { session.root.user('avdi').followers }
+
+      it { should_not be_empty }
+
+      it 'should have "next" and "last" links' do
+        subject.link('next').should be_a(Leadlight::Link)
+        subject.link('last').should be_a(Leadlight::Link)
+      end
+
+      it 'should be able to follow "next" link' do
+        page2 = subject.next
+        page2.link('prev').href.path.should eq(subject.__location__.path)
+      end
+
+      it 'should be enumerable' do
+        followers = []
+        subject.each do |f|
+          followers << f
+        end
+        followers.should have(178).items
+      end
+
+      it 'should be enumerable over page boundaries' do
+        followers = subject.to_enum.take(61)
+        followers.should have(61).items
+      end
+    end
+  end
+
+  describe 'authorized GitHub example', vcr: { match_requests_on: [:method, :uri]}do
+    class AuthorizedGithubService
+      Leadlight.build_service(self) do
+        url 'https://api.github.com'
+
+        tint 'root' do
+          match_path('/')
+          add_link_template '/users/{login}', 'user', 'Find user by login'
+          add_link_template '/orgs/{name}',   'organization'
+        end
+
+        tint 'auth_scopes' do
+          extend do
+            def oauth_scopes
+              __response__.headers['X-OAuth-Scopes'].to_s.strip.split(/\W+/)
+            end
+          end
+        end
+
+        tint 'organization' do
+          match_path(%r{^/orgs/\w+$})
+          type :organization
+          add_link "#{__location__}/teams", 'teams'
+
+          extend do
+            def team_for_name(name)
+              teams.get(name)
+            end
+          end
+        end
+
+        tint 'teamlist' do
+          match_path(%r{^/orgs/\w+/teams$})
+
+          add_link_set('child', :get) do
+            map{|team|
+              {href: team['url'], title: team['name']}
+            }
+          end
+        end
+
+        tint 'team' do
+          match_template('/teams/{id}')
+          type :team
+          
+          add_link "#{__location__}/members", 'members'
+          add_link_template "#{__location__}/members/{id}", 'member'
+
+          extend do
+            def add_member(member_name)
+              link('member').put(member_name).submit_and_wait.raise_on_error
+            end
+
+            def remove_member(member_name)
+              link('member').delete(member_name).submit_and_wait.raise_on_error
+            end
+          end
+        end
+
+        type :organization do
+        end
+
+        type :team do
+        end
+      end
+
+      def prepare_request(request)
+        request.headers['Authorization'] = "Bearer #{service_options[:oauth2_token]}"
+      end
+    end
+
+    subject { session }
+    let(:session) { AuthorizedGithubService.session(service_options) }
+    let(:service_options) { {logger: logger, oauth2_token: test_user_token} }
+    let(:test_user_token) { credentials[:github_test_user_token] }
+
+    describe '#user' do
+      it 'has the expected content' do
+        user = subject.root.user('avdi')
+        user['type'].should eq('User')
+        user['location'].should eq('Pennsylvania, USA')
+        user['company'].should eq('ShipRise')
+        user['name'].should eq('Avdi Grimm')
+      end
+
+      it 'indicates the expected oath scopes' do
+        subject.root.user('avdi').oauth_scopes.should eq(['repo'])
+      end
+    end
+
+    describe 'test team' do
+      subject { session.root.organization('shiprise').team_for_name('Leadlight Test Team') }
+      
+      it { should be }
+    end
+
+    specify "adding and removing team members" do
+      user = session.root.user("leadlight-test")
+      user.should_not be_empty
+      team = session.root.organization('shiprise').
+        teams.get('Leadlight Test Team')
+      team.should_not be_empty
+      team.add_member('leadlight-test')
+        team.members.map{|m| m['login']}.should include('leadlight-test')
+      team.remove_member('leadlight-test')
+      team.members.map{|m| m['login']}.should_not include('leadlight-test')
+    end
+  end
+end

data/spec/spec_helper_lite.rb

@@ -0,0 +1,6 @@
+ENV["RAILS_ENV"] ||= 'test'
+require 'rspec/autorun'
+require 'English'
+ROOT = File.expand_path('../..', __FILE__)
+Dir[File.join(ROOT, "spec/support/**/*.rb")].each {|f| require f}
+$LOAD_PATH.unshift(File.expand_path('lib', ROOT))

data/spec/support/credentials.rb

@@ -0,0 +1,16 @@
+require 'yaml'
+
+module CredentialsTestHelpers
+  def credentials
+    credentials_path = Pathname('../../credentials.yml').expand_path(__FILE__)
+    @credentials ||= Hash.new do |h,k|
+      pending "Missing key #{k.inspect} from #{credentials_path}"
+    end.merge!(YAML.load_file(credentials_path) || {})
+  rescue LoadError, SystemCallError, KeyError => e
+    pending e.message
+  end
+end
+
+RSpec.configure do |config|
+  config.include(CredentialsTestHelpers)
+end

data/spec/support/vcr.rb

@@ -0,0 +1,18 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.hook_into :faraday
+  c.cassette_library_dir     = 'spec/cassettes'
+  c.filter_sensitive_data('<AUTH FILTERED>') {|interaction|
+    Array(interaction.request.headers['Authorization']).first
+  }
+  c.configure_rspec_metadata!
+  c.ignore_request {|req|
+    Addressable::URI.parse(req.uri).host == 'example.com'
+  }
+  c.default_cassette_options = {
+    match_requests_on: [:method, :uri, :headers],
+    record: :new_episodes
+  }
+end
+

metadata

@@ -0,0 +1,229 @@
+--- !ruby/object:Gem::Specification
+name: leadlight
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Avdi Grimm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70279914738300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70279914738300
+- !ruby/object:Gem::Dependency
+  name: fattr
+  requirement: &70279914737840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70279914737840
+- !ruby/object:Gem::Dependency
+  name: link_header
+  requirement: &70279914737420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70279914737420
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70279914737000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70279914737000
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: &70279914736540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70279914736540
+- !ruby/object:Gem::Dependency
+  name: hookr
+  requirement: &70279914736100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70279914736100
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70279914735580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70279914735580
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &70279914735040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: *70279914735040
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70279914734400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70279914734400
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70279914733320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70279914733320
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: &70279914732860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70279914732860
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70279914732440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70279914732440
+description: Long description. Maybe copied from the README.
+email: avdi@avdi.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- Rakefile
+- leadlight.gemspec
+- lib/leadlight.rb
+- lib/leadlight/blank.rb
+- lib/leadlight/codec.rb
+- lib/leadlight/enumerable_representation.rb
+- lib/leadlight/errors.rb
+- lib/leadlight/hyperlinkable.rb
+- lib/leadlight/link.rb
+- lib/leadlight/link_template.rb
+- lib/leadlight/representation.rb
+- lib/leadlight/request.rb
+- lib/leadlight/service.rb
+- lib/leadlight/service_middleware.rb
+- lib/leadlight/tint.rb
+- lib/leadlight/tint_helper.rb
+- lib/leadlight/type.rb
+- spec/cassettes/Leadlight/authorized_GitHub_example/_user/has_the_expected_content.yml
+- spec/cassettes/Leadlight/authorized_GitHub_example/_user/indicates_the_expected_oath_scopes.yml
+- spec/cassettes/Leadlight/authorized_GitHub_example/adding_and_removing_team_members.yml
+- spec/cassettes/Leadlight/authorized_GitHub_example/adding_and_removing_team_members/.yml
+- spec/cassettes/Leadlight/authorized_GitHub_example/test_team/.yml
+- spec/cassettes/Leadlight/basic_GitHub_example/_root/.yml
+- spec/cassettes/Leadlight/basic_GitHub_example/_root/__location__/.yml
+- spec/cassettes/Leadlight/basic_GitHub_example/_root/should_be_a_204_no_content.yml
+- spec/cassettes/Leadlight/tinted_GitHub_example/_root/.yml
+- spec/cassettes/Leadlight/tinted_GitHub_example/_root/__location__/.yml
+- spec/cassettes/Leadlight/tinted_GitHub_example/_root/should_be_a_204_no_content.yml
+- spec/cassettes/Leadlight/tinted_GitHub_example/_user/has_the_expected_content.yml
+- spec/cassettes/Leadlight/tinted_GitHub_example/user_followers/.yml
+- spec/cassettes/Leadlight/tinted_GitHub_example/user_followers/should_be_able_to_follow_next_link.yml
+- spec/cassettes/Leadlight/tinted_GitHub_example/user_followers/should_be_enumerable.yml
+- spec/cassettes/Leadlight/tinted_GitHub_example/user_followers/should_be_enumerable_over_page_boundaries.yml
+- spec/cassettes/Leadlight/tinted_GitHub_example/user_followers/should_have_next_and_last_links.yml
+- spec/cassettes/Leadlight/tinted_GitHub_example/user_link/exists.yml
+- spec/cassettes/Leadlight/tinted_GitHub_example/user_link/links_to_the_expected_URL.yml
+- spec/leadlight/codec_spec.rb
+- spec/leadlight/hyperlinkable_spec.rb
+- spec/leadlight/link_spec.rb
+- spec/leadlight/link_template_spec.rb
+- spec/leadlight/representation_spec.rb
+- spec/leadlight/request_spec.rb
+- spec/leadlight/service_middleware_spec.rb
+- spec/leadlight/service_spec.rb
+- spec/leadlight/tint_helper_spec.rb
+- spec/leadlight/type_spec.rb
+- spec/leadlight_spec.rb
+- spec/spec_helper_lite.rb
+- spec/support/credentials.rb
+- spec/support/vcr.rb
+homepage: https://github.com/avdi/leadlight
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: leadlight
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 2
+summary: Short description used in Gem listings.
+test_files: []