crowd_rest 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 2011-05-18: v0.0.2
+
+* The returned user from CrowdRest::Session.find(token, :include => :user) is
+  now a CrowdRest::User object instead of a vanilla OpenStruct.
+
+# 2011-05-17: v0.0.1
+
+* Initial version. Supports login with CrowdRest::Session.create and finding
+  current user/session with CrowdRest::Session.find

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2011, Justin Blake
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+* Neither the name of Hentzia nor the names of its
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -32,4 +32,6 @@ A ruby client for [Atlassian's Crowd REST API](http://confluence.atlassian.com/d
     
     # get the user associated with a login session
     response = CrowdRest::Session.find(token, :include => :user)
-    response.user['name'] # => "gooduser"
+    response.user.name # => "gooduser"
+
+*We use [semantic versioning](http://semver.org/). You should too.*

data/lib/crowd_rest.rb

@@ -4,6 +4,8 @@ module CrowdRest
   include HTTParty
 
   autoload :Session, 'crowd_rest/session'
+  autoload :User,    'crowd_rest/user'
+  
   headers 'Content-type' => 'text/xml'
   
   class << self

data/lib/crowd_rest/session.rb

@@ -19,7 +19,8 @@ module CrowdRest
       path << "?expand=user" if request_user
       response = CrowdRest.get(path)
       normalize_response(response) do |successful_response|
-        successful_response.user = response['session']['user']
+        user = response['session']['user']
+        successful_response.user = CrowdRest::User.new(user)
       end
     end
     

data/lib/crowd_rest/user.rb

@@ -0,0 +1,6 @@
+require 'ostruct'
+
+module CrowdRest
+  class User < OpenStruct
+  end
+end

data/lib/crowd_rest/version.rb

@@ -1,4 +1,4 @@
 module CrowdRest
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
   CROWD_VERSION = "2.2"
 end

data/spec/crowd_rest/session_spec.rb

@@ -70,9 +70,9 @@ describe CrowdRest::Session do
       @response = CrowdRest::Session.find(login.token, :include => :user)
     end
     
-    it "includes the user in the response" do
+    it "includes a crowd user in the response" do
       @response.user.should_not be_nil
-      @response.user['name'].should == "crowduser"
+      @response.user.should be_a(CrowdRest::User)
     end
   end
 end

data/spec/crowd_rest/user_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe CrowdRest::User do
+  before do
+    login = CrowdRest::Session.create("crowduser", "crowdpass")
+    @user = CrowdRest::Session.find(login.token, :include => :user).user
+  end
+  
+  it "has the expected attributes for a user" do
+    @user.first_name.should == "Crowd"
+    @user.last_name.should == "Test"
+    @user.display_name.should == "Crowd Test"
+    @user.email.should == "crowduser@test.com"
+    @user.name.should == "crowduser"
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: crowd_rest
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Justin Blake
@@ -69,15 +69,19 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .rvmrc
+- CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - crowd_rest.gemspec
 - lib/crowd_rest.rb
 - lib/crowd_rest/session.rb
+- lib/crowd_rest/user.rb
 - lib/crowd_rest/version.rb
 - spec/cassette_library/test_data.yml
 - spec/crowd_rest/session_spec.rb
+- spec/crowd_rest/user_spec.rb
 - spec/crowd_rest_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -111,5 +115,6 @@ summary: Ruby client for Atlassian's Crowd REST API
 test_files: 
 - spec/cassette_library/test_data.yml
 - spec/crowd_rest/session_spec.rb
+- spec/crowd_rest/user_spec.rb
 - spec/crowd_rest_spec.rb
 - spec/spec_helper.rb