leadlight 0.0.2 → 0.0.3

data/spec/leadlight/tint_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper_lite'
+require 'leadlight/tint'
+
+module Leadlight
+  describe Tint do    
+    subject { target.extend(Tint.new(:test_tint, options, &definition)) }
+    let(:definition) {
+      ->(*args) do
+        self.tint_applied!
+      end
+    }
+    let(:target) { Target.new }
+    let(:status) { 200 }
+    let(:response) { stub(:status => status) }
+    let(:options) { {} }
+
+    class Target
+      def __apply_tint__
+      end
+    end
+
+    def apply
+      subject.__apply_tint__
+    end
+
+    before do
+      target.stub(:__response__ => response)
+    end
+
+    context "with a successful status" do
+      it "is applied" do
+        target.should_receive(:tint_applied!)
+        apply
+      end
+    end
+
+    context "with an unsuccessful status" do
+      let(:status) { 401 }
+
+      it "is not applied" do
+        target.should_not_receive(:tint_applied!)
+        apply
+      end
+    end
+
+    context "with a custom status guard" do
+      before do
+        options[:status] = 401
+      end
+
+      context "with a non-matching status" do
+        it "is not applied" do
+          target.should_not_receive(:tint_applied!)
+          apply
+        end
+      end
+
+      context "with an matching status" do
+        let(:status) { 401 }
+
+        it "is applied" do
+          target.should_receive(:tint_applied!)
+          apply
+        end
+      end
+
+    end
+  end
+end

data/spec/leadlight/type_map_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper_lite'
+require 'leadlight/type_map'
+
+module Leadlight
+  describe TypeMap do
+    subject { TypeMap.new(codec: codec) }
+    let(:codec) { stub(:codec) }
+    let(:options) { {foo: 23} }
+    let(:native_object) { stub(:native_object) }
+    let(:body) { stub(:body, size: 2) }
+
+    matcher :encode do |object|
+      define_method :expected_options do
+        @expected_options ||= anything
+      end
+
+      match{ |typemap|
+        result = stub(:encode_result)
+        @expected_type.should_receive(:encode).with(object, expected_options).
+          and_return(result)
+        typemap.to_entity_body(object).should equal(result)
+      }
+
+      chain :using do |expected_type|
+        @expected_type = expected_type
+      end
+
+      chain :with_options do |expected_options|
+        @expected_options = expected_options
+      end
+    end
+
+    matcher :decode do |enctype|
+      define_method :expected_options do
+        @expected_options ||= anything
+      end
+
+      match{ |typemap|
+        result = stub(:decode_result)
+        @expected_type.should_receive(:decode).with(enctype, body, expected_options).
+          and_return(result)
+        typemap.to_native(enctype, body, options).should equal(result)
+      }
+
+      chain :using do |expected_type|
+        @expected_type = expected_type
+      end
+
+      chain :with_options do |expected_options|
+        @expected_options = expected_options
+      end
+    end
+
+    describe "defaults" do
+      it "encodes arbitrary objects to JSON" do
+        codec.should_receive(:encode).
+          with("application/json", native_object, options).
+          and_return(body)
+        result = subject.to_entity_body(native_object, options)
+        result.content_type.should eq("application/json")
+        result.body.should equal(body)
+      end
+
+      it "encodes nils as nil body, nil content type" do
+        result = subject.to_entity_body(nil, options)
+        result.content_type.should be_nil
+        result.body.should be_nil
+      end
+
+      it "permits encode type to be overridden" do
+        codec.should_receive(:encode).
+          with("application/xml", native_object, {}).
+          and_return(body)
+        result = subject.to_entity_body(native_object, {content_type: 'application/xml'})
+        result.content_type.should eq("application/xml")
+        result.body.should equal(body)
+      end
+
+      it "decodes entity bodies using the codec" do
+        codec.should_receive(:decode).
+          with("application/foobaz", body, options).
+          and_return(native_object)
+        subject.to_native("application/foobaz", body, options)
+      end
+
+      it "decodes empty entity bodies as a Blank object" do
+        subject.to_native("application/json", "", options).should be_a(Blank)
+      end
+
+      it "handles missing content type" do
+        subject.to_native(nil, "", options).should be_a(Blank)
+      end
+
+    end
+
+    describe "with some types defined" do
+      let(:numeric_type) { stub(:numeric_type) }
+      let(:custom_json_type) { stub(:custom_json_type) }
+
+      before do
+        subject.add "application/vnd.numeric", [Integer, Float], numeric_type
+        subject.add ["application/json", /\+json/], Hash, custom_json_type
+      end      
+
+      it "encodes unmatched objects to JSON" do
+        codec.should_receive(:encode).
+          with("application/json", native_object, options).
+          and_return(body)
+        subject.to_entity_body(native_object, options)
+      end
+
+      it "decodes unmatched content types entity bodies using the codec" do
+        codec.should_receive(:decode).
+          with("application/foobaz", body, options).
+          and_return(native_object)
+        subject.to_native("application/foobaz", body,options)
+      end
+
+      it { should encode(123).using(numeric_type) }
+      it { should encode(12.5).using(numeric_type) }
+      it { should decode("application/vnd.numeric").using(numeric_type) }
+      it { should encode({}).using(custom_json_type) }
+      it { should decode("application/json").using(custom_json_type) }
+      it { should decode("application/xyzzy+json").using(custom_json_type) }
+    end
+  end
+end

data/spec/leadlight_spec.rb

@@ -116,7 +116,7 @@ describe Leadlight, vcr: true do
         subject.each do |f|
           followers << f
         end
-        followers.should have(178).items
+        followers.size.should be > 150
       end
 
       it 'should be enumerable over page boundaries' do
@@ -127,74 +127,114 @@ describe Leadlight, vcr: true do
   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'
+    AuthorizedGithubService ||= Leadlight.build_service do
+      url 'https://api.github.com'
+
+      # Tints will skip error responses by default
+      tint 'errors', :status => :error do
+        extend do
+          def exception_message
+            self['message'] || super
+          end
         end
+      end
 
-        tint 'auth_scopes' do
-          extend do
-            def oauth_scopes
-              __response__.headers['X-OAuth-Scopes'].to_s.strip.split(/\W+/)
-            end
+      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'
+      tint 'organization' do
+        match_path(%r{^/orgs/\w+$})
+        add_link "#{__location__}/teams", 'teams'
 
-          extend do
-            def team_for_name(name)
-              teams.get(name)
-            end
+        extend do
+          def team_for_name(name)
+            teams.get(name)
           end
+
+          def add_team(name, permission)
+            link('teams').post({}, 
+                               { 'name' => name,
+                                 'permission' => permission}).
+              raise_on_error.
+              submit_and_wait do |new_team|
+                return new_team
+              end
+          end
+
         end
+      end
 
-        tint 'teamlist' do
-          match_path(%r{^/orgs/\w+/teams$})
+      tint 'teamlist' do
+        match_path(%r{^/orgs/\w+/teams$})
 
-          add_link_set('child', :get) do
-            map{|team|
-              {href: team['url'], title: team['name']}
-            }
-          end
+        add_link_set('child', :get) do
+          map{|team|
+            {href: team['url'], title: team['name']}
+          }
         end
+      end
+
+      tint 'team' do
+        match_template('/teams/{id}')
+        
+        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
 
-        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
+          def destroy
+            link('self').delete.raise_on_error.submit_and_wait
           end
         end
+      end
+
+      class GithubRepresentation < SimpleDelegator
+        def github_type
+          self['type']
+        end
+      end
 
-        type :organization do
+      # Define a type-mapping which will override the default handling
+      # of application/json and instantiate GithubRepresentation
+      # objects
+      type_mapping "application/json", GithubRepresentation do
+        def encode(object, options={})
+          encode_with_type("application/json", object.__getobj__, options)
         end
 
-        type :team do
+        def decode(content_type, entity_body, options={})
+          object = decode_with_type(content_type, entity_body, options)
+          GithubRepresentation.new(object)
         end
       end
 
-      def prepare_request(request)
-        request.headers['Authorization'] = "Bearer #{service_options[:oauth2_token]}"
+      on_prepare_request do |event, request|
+        # 'request' is the Faraday request being prepared
+        #
+        # 'event.source' is the Leadlight request, which delegates
+        # #service_options to the service
+        request.headers['Authorization'] = 
+          "Bearer #{event.source.service_options[:oauth2_token]}"
       end
+
     end
 
     subject { session }
@@ -222,14 +262,25 @@ describe Leadlight, vcr: true do
       it { should be }
     end
 
+    specify "adding and removing teams" do
+      org = session.root.organization('shiprise')
+      team = org.add_team("Leadlight Ephemeral Team", "pull")
+      team["permission"].should eq("pull")
+      team.destroy
+    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')
+      org = session.root.organization('shiprise')
+      org.should be_a(GithubRepresentation)
+      org.github_type.should eq("Organization")
+      teams = org.teams
+      team = teams.get('Leadlight Test Team')
+      team.should be_a(GithubRepresentation)
       team.should_not be_empty
       team.add_member('leadlight-test')
-        team.members.map{|m| m['login']}.should include('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

data/spec/support/credentials.rb

@@ -3,9 +3,17 @@ require 'yaml'
 module CredentialsTestHelpers
   def credentials
     credentials_path = Pathname('../../credentials.yml').expand_path(__FILE__)
+    @loaded_credentials ||= if credentials_path.readable?
+                              YAML.load_file(credentials_path) || {}
+                            else
+                              {}
+                            end
     @credentials ||= Hash.new do |h,k|
-      pending "Missing key #{k.inspect} from #{credentials_path}"
-    end.merge!(YAML.load_file(credentials_path) || {})
+      h[k] = "MISSING_CREDENTIAL_KEY_#{k}"
+      unless ENV['TRAVIS']
+        warn "Missing key #{k.inspect} from #{credentials_path}"
+      end
+    end.merge!(@loaded_credentials)
   rescue LoadError, SystemCallError, KeyError => e
     pending e.message
   end

data/spec/support/vcr.rb

@@ -12,7 +12,7 @@ VCR.configure do |c|
   }
   c.default_cassette_options = {
     match_requests_on: [:method, :uri, :headers],
-    record: :new_episodes
+    record: ENV.fetch('VCR_RECORD'){ :new_episodes }.to_sym
   }
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leadlight
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-09 00:00:00.000000000Z
+date: 2012-02-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: &70280979493900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70280979493900
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70279914738300 !ruby/object:Gem::Requirement
+  requirement: &70280979493420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70279914738300
+  version_requirements: *70280979493420
 - !ruby/object:Gem::Dependency
   name: fattr
-  requirement: &70279914737840 !ruby/object:Gem::Requirement
+  requirement: &70280979493000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70279914737840
+  version_requirements: *70280979493000
 - !ruby/object:Gem::Dependency
   name: link_header
-  requirement: &70279914737420 !ruby/object:Gem::Requirement
+  requirement: &70280979492560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70279914737420
+  version_requirements: *70280979492560
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70279914737000 !ruby/object:Gem::Requirement
+  requirement: &70280979492100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70279914737000
+  version_requirements: *70280979492100
 - !ruby/object:Gem::Dependency
   name: mime-types
-  requirement: &70279914736540 !ruby/object:Gem::Requirement
+  requirement: &70280979491460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70279914736540
+  version_requirements: *70280979491460
 - !ruby/object:Gem::Dependency
   name: hookr
-  requirement: &70279914736100 !ruby/object:Gem::Requirement
+  requirement: &70280979490720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +87,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70279914736100
+  version_requirements: *70280979490720
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70280979489560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70280979489560
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70279914735580 !ruby/object:Gem::Requirement
+  requirement: &70280979488680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279914735580
+  version_requirements: *70280979488680
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70279914735040 !ruby/object:Gem::Requirement
+  requirement: &70280979487900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +120,10 @@ dependencies:
         version: 2.0.0.rc1
   type: :development
   prerelease: false
-  version_requirements: *70279914735040
+  version_requirements: *70280979487900
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70279914734400 !ruby/object:Gem::Requirement
+  requirement: &70280979487220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279914734400
+  version_requirements: *70280979487220
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70279914733320 !ruby/object:Gem::Requirement
+  requirement: &70280979486440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279914733320
+  version_requirements: *70280979486440
 - !ruby/object:Gem::Dependency
   name: guard-bundler
-  requirement: &70279914732860 !ruby/object:Gem::Requirement
+  requirement: &70280979485820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279914732860
+  version_requirements: *70280979485820
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70279914732440 !ruby/object:Gem::Requirement
+  requirement: &70280979485080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,8 +164,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279914732440
-description: Long description. Maybe copied from the README.
+  version_requirements: *70280979485080
+description: Rose colored stained glass windows for HTTP.
 email: avdi@avdi.org
 executables: []
 extensions: []
@@ -152,27 +174,33 @@ files:
 - Gemfile
 - Gemfile.lock
 - Guardfile
+- README.md
 - Rakefile
+- default.gems
 - leadlight.gemspec
 - lib/leadlight.rb
+- lib/leadlight/basic_converter.rb
 - lib/leadlight/blank.rb
 - lib/leadlight/codec.rb
+- lib/leadlight/entity.rb
 - lib/leadlight/enumerable_representation.rb
 - lib/leadlight/errors.rb
+- lib/leadlight/header_helpers.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_class_methods.rb
 - lib/leadlight/service_middleware.rb
 - lib/leadlight/tint.rb
 - lib/leadlight/tint_helper.rb
-- lib/leadlight/type.rb
+- lib/leadlight/type_map.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/adding_and_removing_teams.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
@@ -197,7 +225,8 @@ files:
 - spec/leadlight/service_middleware_spec.rb
 - spec/leadlight/service_spec.rb
 - spec/leadlight/tint_helper_spec.rb
-- spec/leadlight/type_spec.rb
+- spec/leadlight/tint_spec.rb
+- spec/leadlight/type_map_spec.rb
 - spec/leadlight_spec.rb
 - spec/spec_helper_lite.rb
 - spec/support/credentials.rb
@@ -222,8 +251,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: leadlight
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 2
-summary: Short description used in Gem listings.
+summary: Rose colored stained glass windows for HTTP.
 test_files: []