crowd-client 0.0.5 → 0.1.0

data/crowd-client.gemspec

@@ -19,11 +19,13 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rspec"
-  s.add_development_dependency "vcr"
+  s.add_development_dependency "vcr", "~> 2.0.0.rc1"
   s.add_development_dependency "webmock"
+  s.add_development_dependency "ruby-debug19"
 
   s.add_runtime_dependency "faraday", "~> 0.7.5"
   s.add_runtime_dependency "faraday_middleware", "~> 0.7.0"
   s.add_runtime_dependency "patron", "~> 0.4.16"
   s.add_runtime_dependency "json", "~> 1.6.1"
+  s.add_runtime_dependency "activesupport", "~> 3.1.0"
 end

data/lib/crowd-client.rb

@@ -25,7 +25,7 @@ module Crowd
 
       raise Exception::AuthenticationFailed.new if response.status == 400 && response.body['reason'] == 'INVALID_USER_AUTHENTICATION'
       raise Exception::InactiveAccount.new if response.status == 400 && response.body['reason'] == 'INACTIVE_ACCOUNT'
-      raise Exception::UnkownError if response.status != 201
+      raise Exception::UnknownError.new(response.body.to_s) if response.status != 201
       return response.body['token']
     end
 
@@ -36,7 +36,7 @@ module Crowd
 
     def logout(token)
       response = connection.delete("session/#{token}", {})
-      raise Exception::UnkownError if response.status != 204
+      raise Exception::UnknownError.new(response.body.to_s) if response.status != 204
     end
 
     def user(token)

data/lib/crowd-client/exceptions.rb

@@ -1,8 +1,9 @@
 module Crowd::Client
   class Exception < RuntimeError; end
-  class Exception::UnkownError < Crowd::Client::Exception; end
+  class Exception::UnknownError < Crowd::Client::Exception; end
   class Exception::InactiveAccount < Crowd::Client::Exception; end
   class Exception::AuthenticationFailed < Crowd::Client::Exception; end
+  class Exception::NotFound < Crowd::Client::Exception; end
 end
 
 

data/lib/crowd-client/group.rb

@@ -0,0 +1,42 @@
+require 'crowd-client'
+
+class Crowd::Client::Group
+  attr_accessor :groupname
+
+  def initialize(groupname)
+    self.groupname = groupname
+  end
+
+  def users
+    response = connection.get('group/user/nested') do |request|
+      request.params[:groupname] = groupname
+    end
+    raise ::Crowd::Client::Exception::NotFound.new("Group '#{groupname}' was not found") if response.status == 404
+    response.body['users'].collect do |user|
+      ::Crowd::Client::User.new(user['name'])
+    end
+  end
+
+  def add_user(user)
+    response = connection.post('group/user/direct', :name => user.username) do |request|
+      request.params[:groupname] = groupname
+    end
+    raise ::Crowd::Client::Exception::NotFound.new("Group '#{groupname}' was not found") if response.status == 404
+    raise ::Crowd::Client::Exception::NotFound.new("User '#{user.username}' was not found") if response.status == 400
+    raise ::Crowd::Client::Exception::UnknownError.new(response.body.to_s) if response.status != 201
+  end
+
+  def remove_user(user)
+    response = connection.delete("group/user/direct") do |request|
+      request.params[:groupname] = groupname
+      request.params[:username] = user.username
+    end
+    raise ::Crowd::Client::Exception::NotFound.new("User '#{user.username}' was not found") if response.status == 404
+    raise ::Crowd::Client::Exception::UnknownError.new(response.body.to_s) if response.status != 204
+  end
+
+  private
+    def connection
+      ::Crowd::Client.connection
+    end
+end

data/lib/crowd-client/user.rb

@@ -0,0 +1,121 @@
+require 'crowd-client'
+
+class Crowd::Client::User
+  attr_accessor :username, :new_record
+
+  def initialize(username, attributes=nil)
+    self.username = username
+    self.new_record = true
+    assign_attributes attributes, true
+  end
+
+  def self.create(attributes)
+    new('', attributes).tap {|user| user.save }
+  end
+
+  def ==(other)
+    username == (other && other.username)
+  end
+
+  def first_name
+    user_attributes['first-name']
+  end
+
+  def last_name
+    user_attributes['last-name']
+  end
+
+  def display_name
+    user_attributes['display-name']
+  end
+
+  def email
+    user_attributes['email']
+  end
+
+  def groups(reload=false)
+    return @groups if @groups && !reload
+    response = connection.get("user/group/nested") do |request|
+      request.params[:username] = username
+    end
+    raise ::Crowd::Client::Exception::NotFound.new("User '#{user.username}' was not found") if response.status == 404
+    @groups = response.body['groups'].collect do |group|
+      ::Crowd::Client::Group.new(group['name'])
+    end
+  end
+
+  def reload!
+    @groups = nil
+    user_attributes(true)
+  end
+
+  def update_attibutes(attributes)
+    assign_attributes attributes
+    save
+  end
+
+  def save
+    if new_record
+      response = connection.post('user', {'name' => username, 'active' => true}.merge(@attributes))
+      self.new_record = false
+      raise ::Crowd::Client::Exception::UnknownError.new(response.body.to_s) if response.status != 201
+    else
+      response = connection.put('user', {'name' => username}.merge(@attributes)) do |request|
+        request.params[:username] = username
+      end
+      raise ::Crowd::Client::Exception::NotFound.new("User with username '#{username}' was not found.") if response.status == 404
+      raise ::Crowd::Client::Exception::UnknownError.new(response.body) if response.status != 204
+    end
+  end
+
+  def destroy
+    response = connection.delete('user') do |request|
+      request.params[:username] = username
+    end
+    raise ::Crowd::Client::Exception::NotFound.new("User '#{user.username}' was not found") if response.status == 404
+    raise ::Crowd::Client::Exception::UnknownError.new(response.body.to_s) if response.status != 204
+  end
+
+  def authenticate?(password)
+    response = connection.post('authentication', :value => password) do |request|
+      request.params[:username] = username
+    end
+    response.status == 200
+  end
+
+  def change_password(password)
+    response = connection.put('user/password', :value => password) do |request|
+      request.params[:username] = username
+    end
+    raise ::Crowd::Client::Exception::NotFound.new("User '#{user.username}' was not found") if response.status == 404
+    raise ::Crowd::Client::Exception::UnknownError.new(response.body.to_s) if response.status != 204
+  end
+
+  private
+    def connection
+      ::Crowd::Client.connection
+    end
+
+    def password=(password)
+      write_attribute :password, {:value => password }
+    end
+
+    def assign_attributes(attributes, include_private=false)
+      attributes && attributes.each do |k,v|
+        respond_to?(:"#{k}=", include_private) ? send(:"#{k}=", v) : write_attribute(k.to_s.gsub(/[_ ]/, '-'), v)
+      end
+    end
+
+    def write_attribute(attribute, value)
+      @attributes ||= {}
+      @attributes[attribute.to_s] = value
+    end
+
+    def user_attributes(reload=false)
+      return @attributes if @attributes && !reload
+      response = connection.get("user?username=#{username}")
+      raise ::Crowd::Client::Exception::NotFound.new("User with username '#{username}' was not found.") if response.status == 404
+      self.new_record = false
+      @attributes = response.body
+    end
+end

data/lib/crowd-client/version.rb

@@ -1,5 +1,5 @@
 module Crowd
   module Client
-    VERSION = "0.0.5"
+    VERSION = "0.1.0"
   end
 end

data/spec/cassettes/Crowd_Client/_in_group_/should_confirm_users_are_in_groups.yml

@@ -0,0 +1,69 @@
+--- 
+http_interactions: 
+- request: 
+    method: get
+    uri: http://127.0.0.1:8095/crowd/rest/usermanagement/1/user/group/nested?groupname=MyGroup&username=user@example.com
+    body: ""
+    headers: 
+      Accept: 
+      - application/json
+      Authorization: 
+      - Basic YXBwbGljYXRpb246cGFzc3dvcmQ=
+      Expect: 
+      - ""
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      Server: 
+      - Apache-Coyote/1.1
+      X-Embedded-Crowd-Version: 
+      - Crowd/2.3.3
+      X-Crowd-User-Management-Version: 
+      - "1.1"
+      Set-Cookie: 
+      - JSESSIONID=FCB1D9B970C02C9494B00569525DB4E4; Path=/crowd
+      Content-Type: 
+      - application/json
+      Transfer-Encoding: 
+      - chunked
+      Date: 
+      - Wed, 21 Dec 2011 20:57:00 GMT
+    body: "{\"link\":{\"href\":\"http://127.0.0.1:8095/crowd/rest/usermanagement/1/group?groupname=MyGroup\",\"rel\":\"self\"},\"name\":\"MyGroup\"}"
+    http_version: 
+  recorded_at: Wed, 21 Dec 2011 20:57:01 GMT
+- request: 
+    method: get
+    uri: http://127.0.0.1:8095/crowd/rest/usermanagement/1/user/group/nested?groupname=OtherGroup&username=user@example.com
+    body: ""
+    headers: 
+      Accept: 
+      - application/json
+      Authorization: 
+      - Basic YXBwbGljYXRpb246cGFzc3dvcmQ=
+      Expect: 
+      - ""
+  response: 
+    status: 
+      code: 404
+      message: Not Found
+    headers: 
+      Server: 
+      - Apache-Coyote/1.1
+      X-Embedded-Crowd-Version: 
+      - Crowd/2.3.3
+      X-Crowd-User-Management-Version: 
+      - "1.1"
+      Set-Cookie: 
+      - JSESSIONID=45B66E5CEDDE4E9E277EE77751E4A460; Path=/crowd
+      Content-Type: 
+      - application/json
+      Transfer-Encoding: 
+      - chunked
+      Date: 
+      - Wed, 21 Dec 2011 20:57:00 GMT
+    body: "{\"reason\":\"MEMBERSHIP_NOT_FOUND\",\"message\":\"The child entity <user@example.com> is not a member of the parent <OtherGroup>\"}"
+    http_version: 
+  recorded_at: Wed, 21 Dec 2011 20:57:01 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/Crowd_Client/_login/should_authenticate_and_return_a_session_token.yml

@@ -0,0 +1,42 @@
+--- 
+http_interactions: 
+- request: 
+    method: post
+    uri: http://127.0.0.1:8095/crowd/rest/usermanagement/1/session
+    body: "{\"username\":\"user@example.com\",\"password\":\"password\"}"
+    headers: 
+      Accept: 
+      - application/json
+      Authorization: 
+      - Basic YXBwbGljYXRpb246cGFzc3dvcmQ=
+      Content-Type: 
+      - application/json
+      Expect: 
+      - ""
+  response: 
+    status: 
+      code: 201
+      message: Created
+    headers: 
+      Server: 
+      - Apache-Coyote/1.1
+      X-Embedded-Crowd-Version: 
+      - Crowd/2.3.3
+      X-Crowd-User-Management-Version: 
+      - "1.1"
+      Set-Cookie: 
+      - JSESSIONID=0A0D1DC5127E712AAA7765BBEA011013; Path=/crowd
+      Cache-Control: 
+      - no-cache, no-store, no-transform
+      Location: 
+      - http://127.0.0.1:8095/crowd/rest/usermanagement/1/session/XgeHSuCFniINHWnVaH5aDA00
+      Content-Type: 
+      - application/json
+      Transfer-Encoding: 
+      - chunked
+      Date: 
+      - Wed, 21 Dec 2011 20:57:00 GMT
+    body: "{\"expand\":\"user\",\"token\":\"XgeHSuCFniINHWnVaH5aDA00\",\"user\":{\"link\":{\"href\":\"http://127.0.0.1:8095/crowd/rest/usermanagement/1/user?username=user@example.com\",\"rel\":\"self\"},\"name\":\"user@example.com\"},\"link\":{\"href\":\"http://127.0.0.1:8095/crowd/rest/usermanagement/1/session/XgeHSuCFniINHWnVaH5aDA00\",\"rel\":\"self\"}}"
+    http_version: 
+  recorded_at: Wed, 21 Dec 2011 20:57:00 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/Crowd_Client/_login/should_raise_Crowd_Client_Exception_AuthenticationFailed_if_authentication_fails.yml

@@ -0,0 +1,40 @@
+--- 
+http_interactions: 
+- request: 
+    method: post
+    uri: http://127.0.0.1:8095/crowd/rest/usermanagement/1/session
+    body: "{\"username\":\"user@example.com\",\"password\":\"wrong_password\"}"
+    headers: 
+      Accept: 
+      - application/json
+      Authorization: 
+      - Basic YXBwbGljYXRpb246cGFzc3dvcmQ=
+      Content-Type: 
+      - application/json
+      Expect: 
+      - ""
+  response: 
+    status: 
+      code: 400
+      message: Bad Request
+    headers: 
+      Server: 
+      - Apache-Coyote/1.1
+      X-Embedded-Crowd-Version: 
+      - Crowd/2.3.3
+      X-Crowd-User-Management-Version: 
+      - "1.1"
+      Set-Cookie: 
+      - JSESSIONID=8EF3BF87966D0AAD2A59EBBD027C6BBA; Path=/crowd
+      Content-Type: 
+      - application/json
+      Transfer-Encoding: 
+      - chunked
+      Date: 
+      - Wed, 21 Dec 2011 20:57:00 GMT
+      Connection: 
+      - close
+    body: "{\"reason\":\"INVALID_USER_AUTHENTICATION\",\"message\":\"Failed to authenticate principal, password was invalid\"}"
+    http_version: 
+  recorded_at: Wed, 21 Dec 2011 20:57:00 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/Crowd_Client/_login/should_raise_Crowd_Client_Exception_InactiveAccount_if_an_account_is_inactive.yml

@@ -0,0 +1,40 @@
+--- 
+http_interactions: 
+- request: 
+    method: post
+    uri: http://127.0.0.1:8095/crowd/rest/usermanagement/1/session
+    body: "{\"username\":\"inactive_user@example.com\",\"password\":\"password\"}"
+    headers: 
+      Accept: 
+      - application/json
+      Authorization: 
+      - Basic YXBwbGljYXRpb246cGFzc3dvcmQ=
+      Content-Type: 
+      - application/json
+      Expect: 
+      - ""
+  response: 
+    status: 
+      code: 400
+      message: Bad Request
+    headers: 
+      Server: 
+      - Apache-Coyote/1.1
+      X-Embedded-Crowd-Version: 
+      - Crowd/2.3.3
+      X-Crowd-User-Management-Version: 
+      - "1.1"
+      Set-Cookie: 
+      - JSESSIONID=3AACFC8B062C5E0FA551BF080E4F78B0; Path=/crowd
+      Content-Type: 
+      - application/json
+      Transfer-Encoding: 
+      - chunked
+      Date: 
+      - Wed, 21 Dec 2011 20:57:00 GMT
+      Connection: 
+      - close
+    body: "{\"reason\":\"INACTIVE_ACCOUNT\",\"message\":\"Account with name <inactive_user@example.com> is inactive\"}"
+    http_version: 
+  recorded_at: Wed, 21 Dec 2011 20:57:00 GMT
+recorded_with: VCR 2.0.0.rc1

data/spec/cassettes/Crowd_Client/_logout/should_logout_the_current_session.yml

@@ -0,0 +1,143 @@
+--- 
+http_interactions: 
+- request: 
+    method: post
+    uri: http://127.0.0.1:8095/crowd/rest/usermanagement/1/session
+    body: "{\"username\":\"user@example.com\",\"password\":\"password\"}"
+    headers: 
+      Accept: 
+      - application/json
+      Authorization: 
+      - Basic YXBwbGljYXRpb246cGFzc3dvcmQ=
+      Content-Type: 
+      - application/json
+      Expect: 
+      - ""
+  response: 
+    status: 
+      code: 201
+      message: Created
+    headers: 
+      Server: 
+      - Apache-Coyote/1.1
+      X-Embedded-Crowd-Version: 
+      - Crowd/2.3.3
+      X-Crowd-User-Management-Version: 
+      - "1.1"
+      Set-Cookie: 
+      - JSESSIONID=1BBB2D13C278D5DAD979913D2AA7AA3A; Path=/crowd
+      Cache-Control: 
+      - no-cache, no-store, no-transform
+      Location: 
+      - http://127.0.0.1:8095/crowd/rest/usermanagement/1/session/XgeHSuCFniINHWnVaH5aDA00
+      Content-Type: 
+      - application/json
+      Transfer-Encoding: 
+      - chunked
+      Date: 
+      - Wed, 21 Dec 2011 20:57:00 GMT
+    body: "{\"expand\":\"user\",\"token\":\"XgeHSuCFniINHWnVaH5aDA00\",\"user\":{\"link\":{\"href\":\"http://127.0.0.1:8095/crowd/rest/usermanagement/1/user?username=user@example.com\",\"rel\":\"self\"},\"name\":\"user@example.com\"},\"link\":{\"href\":\"http://127.0.0.1:8095/crowd/rest/usermanagement/1/session/XgeHSuCFniINHWnVaH5aDA00\",\"rel\":\"self\"}}"
+    http_version: 
+  recorded_at: Wed, 21 Dec 2011 20:57:01 GMT
+- request: 
+    method: post
+    uri: http://127.0.0.1:8095/crowd/rest/usermanagement/1/session/XgeHSuCFniINHWnVaH5aDA00
+    body: "{}"
+    headers: 
+      Accept: 
+      - application/json
+      Authorization: 
+      - Basic YXBwbGljYXRpb246cGFzc3dvcmQ=
+      Content-Type: 
+      - application/json
+      Expect: 
+      - ""
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      Server: 
+      - Apache-Coyote/1.1
+      X-Embedded-Crowd-Version: 
+      - Crowd/2.3.3
+      X-Crowd-User-Management-Version: 
+      - "1.1"
+      Set-Cookie: 
+      - JSESSIONID=4B3B482D00F3E769097B6587CB68C19C; Path=/crowd
+      Cache-Control: 
+      - no-cache, no-store, no-transform
+      Content-Type: 
+      - application/json
+      Transfer-Encoding: 
+      - chunked
+      Date: 
+      - Wed, 21 Dec 2011 20:57:00 GMT
+    body: "{\"expand\":\"user\",\"token\":\"XgeHSuCFniINHWnVaH5aDA00\",\"user\":{\"link\":{\"href\":\"http://127.0.0.1:8095/crowd/rest/usermanagement/1/user?username=user@example.com\",\"rel\":\"self\"},\"name\":\"user@example.com\"},\"link\":{\"href\":\"http://127.0.0.1:8095/crowd/rest/usermanagement/1/session/XgeHSuCFniINHWnVaH5aDA00\",\"rel\":\"self\"}}"
+    http_version: 
+  recorded_at: Wed, 21 Dec 2011 20:57:01 GMT
+- request: 
+    method: delete
+    uri: http://127.0.0.1:8095/crowd/rest/usermanagement/1/session/XgeHSuCFniINHWnVaH5aDA00
+    body: ""
+    headers: 
+      Accept: 
+      - application/json
+      Authorization: 
+      - Basic YXBwbGljYXRpb246cGFzc3dvcmQ=
+      Expect: 
+      - ""
+  response: 
+    status: 
+      code: 204
+      message: No Content
+    headers: 
+      Server: 
+      - Apache-Coyote/1.1
+      X-Embedded-Crowd-Version: 
+      - Crowd/2.3.3
+      X-Crowd-User-Management-Version: 
+      - "1.1"
+      Set-Cookie: 
+      - JSESSIONID=D585C5539158CEACF9F39F3ACD626A53; Path=/crowd
+      Date: 
+      - Wed, 21 Dec 2011 20:57:00 GMT
+    body: ""
+    http_version: 
+  recorded_at: Wed, 21 Dec 2011 20:57:01 GMT
+- request: 
+    method: post
+    uri: http://127.0.0.1:8095/crowd/rest/usermanagement/1/session/XgeHSuCFniINHWnVaH5aDA00
+    body: "{}"
+    headers: 
+      Accept: 
+      - application/json
+      Authorization: 
+      - Basic YXBwbGljYXRpb246cGFzc3dvcmQ=
+      Content-Type: 
+      - application/json
+      Expect: 
+      - ""
+  response: 
+    status: 
+      code: 404
+      message: Not Found
+    headers: 
+      Server: 
+      - Apache-Coyote/1.1
+      X-Embedded-Crowd-Version: 
+      - Crowd/2.3.3
+      X-Crowd-User-Management-Version: 
+      - "1.1"
+      Set-Cookie: 
+      - JSESSIONID=EF70FD12EB04501AAE32D69037F59983; Path=/crowd
+      Content-Type: 
+      - application/json
+      Transfer-Encoding: 
+      - chunked
+      Date: 
+      - Wed, 21 Dec 2011 20:57:01 GMT
+    body: "{\"reason\":\"INVALID_SSO_TOKEN\",\"message\":\"Token does not validate.\"}"
+    http_version: 
+  recorded_at: Wed, 21 Dec 2011 20:57:01 GMT
+recorded_with: VCR 2.0.0.rc1