user_management_api 0.0.16

data/spec/unit/client_methods/users_spec.rb

@@ -0,0 +1,149 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe UserManagementApi::ClientMethods::RegistrationGroups do
+
+  include_context 'client context'
+
+  describe '#user' do
+
+    it 'makes a GET request to the correct URL' do
+      stub = stub_request(:get, "#{base_uri}/users/#{unique_id}")
+      client.user(unique_id)
+
+      expect(stub).to have_been_requested.times(1)
+    end
+
+    it 'passes the auth header' do
+      stub = stub_request(:get, "#{base_uri}/users/#{unique_id}").with({headers: { 'Authorization' => "Token token=\"#{token}\""}})
+      client.user(unique_id)
+      expect(stub).to have_been_requested.times(1)
+    end
+
+    it 'returns nil when an invalid id is passed' do
+      stub = stub_request(:get, "#{base_uri}/users/#{unique_id}").to_return(:status => 404)
+
+      expect(client.user(unique_id)).to be_nil
+
+      expect(stub).to have_been_requested.times(1)
+    end
+
+    it 'raises an error when the remote server returns a 401' do
+      stub = stub_request(:get, "#{base_uri}/users/#{unique_id}").to_return(:status => 401)
+
+      expect { client.user(unique_id) }.to raise_error(UserManagementApi::TokenError)
+
+      expect(stub).to have_been_requested.times(1)
+    end
+
+    it 'raises an error when the remote server encounters an error' do
+      stub = stub_request(:get, "#{base_uri}/users/#{unique_id}").to_return(:status => 500)
+
+      expect { client.user(unique_id) }.to raise_error(UserManagementApi::ServerError)
+
+      expect(stub).to have_been_requested.times(1)
+    end
+
+    it 'returns a User object' do
+      stub = stub_request(:get, "#{base_uri}/users/#{unique_id}").to_return(body: MultiJson.dump(user_json))
+
+      user = client.user(unique_id)
+
+      expect(user).not_to be_nil
+      expect(user).to be_a(UserManagementApi::User)
+      expect(user.first_name).to eq 'Roland'
+
+      expect(stub).to have_been_requested.times(1)
+    end
+
+  end
+
+  describe '#users_by_email' do
+
+    let(:url) { "#{base_uri}/users/by_email" }
+
+    it 'makes a GET to the correct url' do
+      stub = stub_request(:get, url).with(query: {email: 'email@email.com'})
+      client.users_by_email('email@email.com')
+
+      expect(stub).to have_been_requested.times(1)
+    end
+
+    it 'returns an array of users' do
+      stub = stub_request(:get, url).
+          with(query: {email: 'email@email.com'}).
+          to_return(body: MultiJson.dump([user_json, user_json]))
+
+      users = client.users_by_email('email@email.com')
+
+      expect(users).to be_a Array
+      expect(users.length).to eq 2
+      expect(users.first).to be_a UserManagementApi::User
+
+      expect(stub).to have_been_requested.times(1)
+    end
+
+    it 'accepts arrays of emails' do
+      stub = stub_request(:get, url).with(query: {email: ['1@mail.com', '2@mail.com']})
+      client.users_by_email(['1@mail.com', '2@mail.com'])
+
+      expect(stub).to have_been_requested.times(1)
+    end
+  end
+
+  describe '#create_user' do
+    it 'makes a POST to the correct url' do
+      stub = stub_request(:post, "#{base_uri}/users")
+      client.create_user(UserManagementApi::User.new)
+
+      expect(stub).to have_been_requested.times(1)
+    end
+
+    it 'raises a UnprocessableEntityError on a 422' do
+      stub = stub_request(:post, "#{base_uri}/users").to_return(status: 422, body: MultiJson.dump({first_name: ['Cannot be blank']}))
+
+      expect { client.create_user(UserManagementApi::User.new) }.to raise_error(UserManagementApi::UnprocessableEntityError)
+
+      expect(stub).to have_been_requested.times(1)
+    end
+
+    it 'returns a User object' do
+      stub = stub_request(:post, "#{base_uri}/users").to_return(body: MultiJson.dump(user_json))
+
+      user = client.create_user(UserManagementApi::User.new)
+
+      expect(user).not_to be_nil
+      expect(user).to be_a(UserManagementApi::User)
+
+      expect(stub).to have_been_requested.times(1)
+    end
+  end
+
+  describe '#update_user' do
+    it 'makes a PUT to the correct url' do
+      stub = stub_request(:put, "#{base_uri}/users/#{unique_id}")
+      client.update_user(UserManagementApi::User.new(unique_id: unique_id))
+
+      expect(stub).to have_been_requested.times(1)
+    end
+
+    it 'raises a UnprocessableEntityError on a 422' do
+      stub = stub_request(:put, "#{base_uri}/users/#{unique_id}").to_return(status: 422, body: MultiJson.dump({first_name: ['Cannot be blank']}))
+
+      expect { client.update_user(UserManagementApi::User.new(unique_id: unique_id)) }.to raise_error(UserManagementApi::UnprocessableEntityError)
+
+      expect(stub).to have_been_requested.times(1)
+    end
+
+    it 'returns a User object' do
+      stub = stub_request(:put, "#{base_uri}/users/#{unique_id}").to_return(body: MultiJson.dump(user_json))
+
+      user = client.update_user(UserManagementApi::User.new(unique_id: unique_id))
+
+      expect(user).not_to be_nil
+      expect(user).to be_a(UserManagementApi::User)
+
+      expect(stub).to have_been_requested.times(1)
+    end
+  end
+
+end

data/spec/unit/client_spec.rb

@@ -0,0 +1,121 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe UserManagementApi::Client do
+
+  before(:each) do
+    UserManagementApi::Config.reset!
+  end
+
+  describe '#new' do
+    it 'rejects base_uri params with a path' do
+      expect { UserManagementApi::Client.new('http://example.com/path', 'token') }.to raise_error(UserManagementApi::ClientConfigurationError)
+    end
+
+    it 'creates a client with the given params' do
+      client = UserManagementApi::Client.new('http://example.com/', 'token')
+      expect(client).not_to be_nil
+      expect(client.token).to eq 'token'
+      expect(client.base_api_uri).to match /http:\/\/example.com\//
+    end
+
+    it 'appends the correct path to the given base_uri' do
+      client = UserManagementApi::Client.new('http://example.com/', 'token')
+      expect(client.base_api_uri).to eq 'http://example.com/api/v1'
+    end
+
+    it 'requires a uri and token' do
+      expect { UserManagementApi::Client.new(nil, 'token') }.to raise_error(UserManagementApi::ClientConfigurationError)
+      expect { UserManagementApi::Client.new('http://example.com', nil) }.to raise_error(UserManagementApi::ClientConfigurationError)
+    end
+
+    it 'uses configured values if available' do
+      UserManagementApi::Config.with_config(base_uri: 'http://configured.com', access_token: 'configured') do
+        client = UserManagementApi::Client.new
+        expect(client.token).to eq 'configured'
+        expect(client.base_api_uri).to match /http:\/\/configured.com\//
+      end
+    end
+
+    it 'allows configured values to be overridden' do
+      UserManagementApi::Config.with_config(base_uri: 'http://configured.com', access_token: 'configured') do
+        client = UserManagementApi::Client.new(nil, 'paramed')
+        expect(client.token).to eq 'paramed'
+        expect(client.base_api_uri).to match /http:\/\/configured.com\//
+      end
+    end
+  end
+
+  context 'valid client' do
+
+    include_context 'client context'
+
+    describe '#create_registration_url' do
+      it 'returns the right URL' do
+        expect(client.create_registration_url('ipumsi')).to eq "#{uri}/ipumsi/registration/new"
+      end
+
+      it 'appends the optional return_url' do
+        expect(client.create_registration_url('ipumsi', 'http://google.com')).to eq "#{uri}/ipumsi/registration/new?return_url=#{CGI.escape('http://google.com')}"
+      end
+
+      it 'appends any additional parameters' do
+        expect(client.create_registration_url('ipumsi', 'http://google.com', a: 1)).to eq "#{uri}/ipumsi/registration/new?return_url=#{CGI.escape('http://google.com')}&a=1"
+      end
+    end
+
+    describe '#create_account_url' do
+      it 'returns the right URL' do
+        expect(client.create_account_url('ipumsi')).to eq "#{uri}/ipumsi/user/new"
+      end
+
+      it 'appends the optional return_url' do
+        expect(client.create_account_url('ipumsi', 'http://google.com')).to eq "#{uri}/ipumsi/user/new?return_url=#{CGI.escape('http://google.com')}"
+      end
+
+      it 'appends any additional parameters' do
+        expect(client.create_account_url('ipumsi', 'http://google.com', a: 1)).to eq "#{uri}/ipumsi/user/new?return_url=#{CGI.escape('http://google.com')}&a=1"
+      end
+    end
+
+    describe '#edit_registration_url' do
+      it 'returns the right URL' do
+        expect(client.edit_registration_url('ipumsi')).to eq "#{uri}/ipumsi/registration/edit"
+      end
+
+      it 'appends the optional return_url' do
+        expect(client.edit_registration_url('ipumsi', 'http://google.com')).to eq "#{uri}/ipumsi/registration/edit?return_url=#{CGI.escape('http://google.com')}"
+      end
+    end
+
+    describe '#join_class_group_url' do
+      it 'returns the right URL' do
+        expect(client.join_class_group_url('ipumsi')).to eq "#{uri}/ipumsi/registration_groups/select"
+        expect(client.join_class_group_url).to eq "#{uri}/registration_groups/select"
+      end
+
+      it 'appends the optional return_url' do
+        expect(client.join_class_group_url('ipumsi', 'http://google.com')).to eq "#{uri}/ipumsi/registration_groups/select?return_url=#{CGI.escape('http://google.com')}"
+      end
+    end
+
+    describe '#admin_url' do
+      it 'returns the right URL' do
+        expect(client.admin_url).to eq "#{uri}/admin"
+      end
+    end
+
+    describe '#admin_pending_registration_url' do
+      it 'returns the right URL' do
+        expect(client.admin_pending_registration_url('ipumsi')).to eq "#{uri}/admin/registrations/pending/ipumsi"
+      end
+    end
+
+    describe '#admin_pending_registration_groups_url' do
+      it 'returns the right URL' do
+        expect(client.admin_pending_registration_groups_url('ipumsi')).to eq "#{uri}/admin/registration_groups/pending/ipumsi"
+      end
+    end
+
+  end
+
+end

data/spec/unit/connection_manager_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe UserManagementApi::ConnectionManager do
+
+  it 'should not allow creating instances' do
+    expect { UserManagementApi::ConnectionManager.new }.to raise_error(NoMethodError)
+  end
+
+  describe '.get_connection' do
+
+    let(:connection) { UserManagementApi::ConnectionManager.get_connection('http://example.com', 'token') }
+
+    it 'should set the base_uri' do
+      expect(connection.url_prefix.to_s).to eq 'http://example.com/'
+    end
+
+    it 'should set the authorization token header' do
+      expect(connection.headers['Authorization']).to eq "Token token=\"token\""
+    end
+
+  end
+
+end

data/spec/unit/entity_spec.rb

@@ -0,0 +1,93 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe UserManagementApi::Entity do
+
+  class TestEntity < UserManagementApi::Entity
+    attributes :name, :id
+    entity_attribute :field, UserManagementApi::Lookup
+  end
+
+  class ChildTestEntity < TestEntity
+    attribute :another_field
+    entity_attribute :how_did_you_hear, UserManagementApi::Lookup
+  end
+
+  class OtherTestEntity < UserManagementApi::Entity
+    entity_attribute :occupation, UserManagementApi::Lookup
+  end
+
+  before(:each) do
+    UserManagementApi::Config.reset!
+  end
+
+  describe '.entity_attribute' do
+
+    it 'should keep separate lists for each type' do
+      expect(TestEntity._entity_properties.keys).to contain_exactly :field
+      expect(ChildTestEntity._entity_properties.keys).to contain_exactly :field, :how_did_you_hear
+      expect(OtherTestEntity._entity_properties.keys).to contain_exactly :occupation
+
+      expect(TestEntity._properties).to contain_exactly :name, :id
+      expect(ChildTestEntity._properties).to contain_exactly :name, :id, :another_field
+      expect(OtherTestEntity._properties.length).to eq 0
+    end
+
+  end
+
+  describe 'serialization' do
+
+    it 'serializes entities' do
+      entity = TestEntity.new
+      entity.field = UserManagementApi::Lookup.new
+      entity.field.id = 5
+      entity.field.label = 'label'
+      entity.field.text = 'text'
+      entity.name = 'name'
+      entity.id = 1
+
+      json = entity.as_json
+      expect(json).to eq({ field: { id: 5, label: 'label', text: 'text'}, name: 'name', id: 1 })
+    end
+
+    it 'handles nil entity properties' do
+      entity = TestEntity.new
+      entity.field = nil
+      expect(entity.as_json[:field]).to be_nil
+    end
+
+  end
+
+  describe 'deserialization' do
+    it 'populates the objects' do
+      json = { field: { id: 5, label: 'label', text: 'text'}, name: 'name', id: 1 }
+      entity = TestEntity.new(json)
+      expect(entity.name).to eq 'name'
+      expect(entity.field).to be_a UserManagementApi::Lookup
+      expect(entity.field.label).to eq 'label'
+    end
+
+    it 'populates nil entities' do
+      json = { field: nil, name: 'name', id: 1 }
+      entity = TestEntity.new(json)
+      expect(entity.field).to be_nil
+    end
+  end
+
+  it 'treats equality correctly' do
+    a = TestEntity.new({ field: { id: 5, label: 'label', text: 'text'}, name: 'name', id: 1 })
+    b = TestEntity.new({ field: { id: 5, label: 'label', text: 'text'}, name: 'name', id: 1 })
+    c = TestEntity.new
+    d = ChildTestEntity.new({ field: { id: 5, label: 'label', text: 'text'}, name: 'name', id: 1 })
+
+    expect(a).to eq b
+    expect(a).not_to eq c
+    expect(a).not_to eq d
+
+    expect(a.equal? b).to be_falsey
+
+    b.field.id = 7
+    expect(a).not_to eq b
+
+  end
+
+end

data/spec/unit/registration_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe UserManagementApi::Registration do
+
+  describe 'Status methods' do
+
+    it 'returns true for the correct status' do
+      r = UserManagementApi::Registration.new
+
+      r.status = UserManagementApi::Registration::STATUS[:pending]
+      expect(r.is_pending?).to be_truthy
+      expect(r.is_denied?).to be_falsey
+
+      r.status = UserManagementApi::Registration::STATUS[:denied]
+      expect(r.is_pending?).to be_falsey
+      expect(r.is_denied?).to be_truthy
+
+      r.status = UserManagementApi::Registration::STATUS[:expired]
+      expect(r.is_email_pending?).to be_falsey
+      expect(r.is_expired?).to be_truthy
+    end
+
+  end
+
+end

data/user_management_api.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'user_management_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "user_management_api"
+  spec.version       = UserManagementApi::VERSION
+  spec.authors       = ["Dan Elbert"]
+  spec.email         = ["delbert@umn.edu"]
+  spec.homepage      = 'https://github.umn.edu/mpc/user_management_api'
+  spec.summary       = %q{Client library for the User Management App API}
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "multi_json", "~> 1.0"
+  spec.add_runtime_dependency "faraday", "~> 0.9.0"
+  spec.add_runtime_dependency "confiture", "~> 0.1.4"
+  spec.add_runtime_dependency "activesupport", ">= 3.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.4.0"
+  spec.add_development_dependency "ci_reporter_rspec", "~> 1.0.0"
+  spec.add_development_dependency "simplecov", "~> 0.9.0"
+  spec.add_development_dependency "simplecov-rcov", "~> 0.2.3"
+  spec.add_development_dependency "webmock", "~> 1.22.5"
+  spec.add_development_dependency "oj", "~> 2.10.2"
+end