board-client 0.3.0 → 0.99.0

data/spec/integration/candidates/find_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe 'Candidate Find' do
+
+  context 'by id' do
+    context 'when the candidate exists' do
+      use_vcr_cassette 'candidate exists with id'
+
+      it 'returns a user with the correct attributes' do
+        candidate = board.candidates.find(100)
+
+        candidate.id.should == 100
+        candidate.email.should == 'candidate@recruitmilitary.com'
+      end
+    end
+
+    context 'when the candidate does not exist' do
+      use_vcr_cassette 'candidate id does not exist'
+
+      it 'raises a not found exception' do
+        expect {
+          board.candidates.find(42)
+        }.to raise_error(Board::Client::NotFound)
+      end
+    end
+  end
+
+end

data/spec/integration/candidates/invite_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe 'Candidate Invite' do
+
+  def create_invitation(attributes = {})
+    attributes = {
+      :email      => "makers@mark.com",
+      :first_name => "Maker's",
+      :last_name  => "Mark"
+    }.merge(attributes)
+
+    board.candidates.invite(attributes)
+  end
+
+  context 'when the email is not already registered' do
+    context 'and the invitation is valid' do
+      use_vcr_cassette 'candidate invite when valid'
+
+      it 'returns an invitation with the correct attributes' do
+        invitation = create_invitation
+
+        invitation.email.should == "makers@mark.com"
+      end
+    end
+
+    context 'and the invitation is not valid' do
+      use_vcr_cassette 'candidate invite when invalid'
+
+      it 'raises an error' do
+        expect {
+          create_invitation(:email => nil)
+        }.to raise_error
+      end
+    end
+  end
+
+  # TODO: should this be considered when the invitation is not valid?
+  context 'when the email belongs to an existing user' do
+    use_vcr_cassette 'candidate invite email exists'
+
+    it 'raises a conflict error' do
+      expect {
+        create_invitation(:email => "candidate@recruitmilitary.com")
+      }.to raise_error(Board::Client::Conflict)
+    end
+  end
+
+end

data/spec/integration/organizations/add_user_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe 'Organization Add User' do
+
+  context 'when the user and organization exist' do
+    use_vcr_cassette "organization add user"
+
+    it 'responds with an empty success' do
+      response = board.user_organizations.create(:user_id => 1, :organization_id => 3)
+      response.should be_true
+    end
+  end
+
+  context 'when the user does not exist' do
+    use_vcr_cassette "organization add user - user does not exist"
+
+    it 'raises a not found error' do
+      expect {
+        board.user_organizations.create(:user_id => 100_000, :organization_id => 1)
+      }.to raise_error(Board::Client::NotFound)
+    end
+  end
+
+  context 'when the organization does not exist' do
+    use_vcr_cassette "organization add user - organization does not exist"
+
+    it 'raises a not found error' do
+      expect {
+        board.user_organizations.create(:user_id => 1, :organization_id => 100_000)
+      }.to raise_error(Board::Client::NotFound)
+    end
+  end
+
+end

data/spec/integration/organizations/create_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe 'Organization Create' do
+
+  def create_organization(attributes = {})
+    attributes = {
+      :name        => "Nike",
+      :description => "<h1>Nike Shoes</h1>",
+      :website     => "http://nike.com",
+    }.merge(attributes)
+
+    board.organizations.create(attributes)
+  end
+
+  context 'when valid' do
+    use_vcr_cassette "organization create is valid"
+
+    it 'creates the organization' do
+      organization = create_organization
+
+      organization.id.should_not be_blank
+      organization.name.should == "Nike"
+      organization.description.should == "<h1>Nike Shoes</h1>"
+      organization.website.should == "http://nike.com"
+    end
+  end
+
+  context 'when invalid' do
+    use_vcr_cassette "organization create is invalid"
+
+    it 'raises an error' do
+      expect {
+        create_organization(:name => nil)
+      }.to raise_error
+    end
+  end
+
+end

data/spec/integration/organizations/find_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe 'Organization Find' do
+
+  context 'by id' do
+    context 'when the organization exists' do
+      use_vcr_cassette 'organization exists with id'
+
+      it 'returns an organization with the correct attributes' do
+        organization = board.organizations.find(1)
+
+        organization.id.should == 1
+        organization.name.should == "RecruitMilitary"
+      end
+    end
+
+    context 'when the organization does not exist' do
+      use_vcr_cassette 'organization id does not exist'
+
+      it 'raises a not found error' do
+        expect {
+          board.organizations.find(100_000)
+        }.to raise_error(Board::Client::NotFound)
+      end
+    end
+  end
+
+  context 'by name' do
+    context 'when the organization exists' do
+      use_vcr_cassette 'organization exists with email'
+
+      it 'returns an organization with the correct attributes' do
+        organization = board.organizations.find(:name => "RecruitMilitary")
+
+        organization.name.should == "RecruitMilitary"
+      end
+    end
+
+    context 'when the organization does not exist' do
+      use_vcr_cassette 'organization name does not exist'
+
+      it 'raises a not found error' do
+        expect {
+          board.organizations.find(:name => "Blah Blah")
+        }.to raise_error(Board::Client::NotFound)
+      end
+    end
+  end
+
+end

data/spec/integration/users/create_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe 'User Create' do
+
+  def create_user(attributes = {})
+    attributes = {
+      :email           => "steve@apple.com",
+      :first_name      => "Steve",
+      :last_name       => "Jobs",
+      :primary_role_id => 1,
+      :password              => "password",
+      :password_confirmation => "password"
+    }.merge(attributes)
+
+    board.users.create(attributes)
+  end
+
+  context 'when no user with the email exists' do
+    use_vcr_cassette "user does not exist"
+
+    it 'creates the user' do
+      user = create_user
+
+      user.email.should == "steve@apple.com"
+      user.first_name.should == "Steve"
+      user.last_name.should == "Jobs"
+    end
+  end
+
+  context 'when a user with the email exists' do
+    use_vcr_cassette "user does exist"
+
+    it 'raises an error' do
+      begin
+        create_user
+      rescue Board::Client::Error => e
+      end
+
+      e.response.body.should =~ /is already taken/
+    end
+  end
+
+  context 'when missing required attributes' do
+    use_vcr_cassette "user missing attributes"
+
+    it 'raises an error' do
+      expect {
+        create_user(:email => nil)
+      }.to raise_error
+    end
+  end
+
+
+end

data/spec/integration/users/find_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe 'User Find' do
+
+  context 'by id' do
+    context 'when the user exists' do
+      use_vcr_cassette 'user exists with id'
+
+      it 'returns a user with the correct attributes' do
+        user = board.users.find(1)
+
+        user.id.should == 1
+        user.email.should == 'staff@recruitmilitary.com'
+        user.first_name.should == 'Staff'
+        user.last_name.should == 'McStafforson'
+      end
+    end
+
+    context 'when the user does not exist' do
+      use_vcr_cassette 'user id does not exist'
+
+      it 'raises a not found exception' do
+        expect {
+          board.users.find(42)
+        }.to raise_error(Board::Client::NotFound)
+      end
+    end
+  end
+
+  context 'by email' do
+    context 'when the user exists' do
+      use_vcr_cassette 'user exists with email'
+
+      it 'returns a user with the correct attributes' do
+        user = board.users.find(:email => 'candidate@recruitmilitary.com')
+
+        user.email.should == 'candidate@recruitmilitary.com'
+      end
+    end
+
+    context 'when the user does not exist' do
+      use_vcr_cassette 'user email does not exist'
+
+      it 'raises a not found exception' do
+        expect {
+          board.users.find(:email => 'michael@jordan.com')
+        }.to raise_error(Board::Client::NotFound)
+      end
+    end
+  end
+
+  context 'by email_md5' do
+    context 'when the user exists' do
+      use_vcr_cassette 'user exists with email md5'
+
+      it 'returns a user with the correct attributes' do
+        user = board.users.find(:email_md5 => '3e67fa7c8045d085e66a51deee26cbc4')
+
+        user.email.should == 'staff@recruitmilitary.com'
+      end
+    end
+
+    context 'when the user does not exist' do
+      use_vcr_cassette 'user email md5 does not exist'
+
+      it 'raises a not found exception' do
+        expect {
+          board.users.find(:email_md5 => '93e8d736de5088cb392465e024b69eef')
+        }.to raise_error(Board::Client::NotFound)
+      end
+    end
+  end
+end

data/spec/integration/users/list_organizations_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe 'List User Organizations' do
+
+  context 'with a valid user id' do
+    use_vcr_cassette "list user organizations with valid id"
+
+    it 'returns a list of organizations that the user belong to' do
+      organizations = board.user_organizations.list(:user_id => 1)
+
+      organizations.size.should == 2
+      organization = organizations.first
+
+      organization.name.should == "Local Organization"
+    end
+  end
+
+  context 'without a user id' do
+    it 'raises an error' do
+      expect {
+        board.user_organizations.list(:foo => :bar)
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'with an invalid user id' do
+    use_vcr_cassette "list user organizations with invalid id"
+
+    it 'raises an error' do
+      expect {
+        board.user_organizations.list(:user_id => 1_000_000)
+      }.to raise_error(Board::Client::NotFound)
+    end
+  end
+
+end

data/spec/integration/users/unsubscribe_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe 'User Unsubscribe' do
+
+  context 'by email' do
+    context 'when the user exists' do
+      use_vcr_cassette 'unsubscribe email exists'
+
+      it 'returns true' do
+        response = board.users.unsubscribe("candidate@recruitmilitary.com")
+
+        response.should be_true
+      end
+    end
+
+    context 'when the user does not exist' do
+      use_vcr_cassette 'unsubscribe email does not exist'
+
+      it 'raises a not found error' do
+        expect {
+          board.users.unsubscribe("michael@jordan.com")
+        }.to raise_error(Board::Client::NotFound)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,12 +1,13 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'board-client'
-require 'spec'
-require 'spec/autorun'
-require 'webmock/rspec'
+require 'rspec'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
-require 'yajl/json_gem' # required for webmock
+Board::Client.default_endpoint = 'http://localhost:3000/api/v1'
 
-Spec::Runner.configure do |config|
+require 'webmock/rspec'
+RSpec.configure do |config|
   config.include WebMock::API
 end

data/spec/support/integration_helpers.rb

@@ -0,0 +1,17 @@
+module IntegrationHelpers
+
+  def board
+    @board ||= Board::Client.new('Bdrc3t1LaiWtygbJ4jD6')
+  end
+
+end
+
+RSpec.configure do |config|
+  def config.escaped_path(*parts)
+    Regexp.compile(parts.join('[\\\/]'))
+  end
+
+  config.include IntegrationHelpers, :type => :integration, :example_group => {
+    :file_path => config.escaped_path(%w[spec integration])
+  }
+end

data/spec/support/vcr.rb

@@ -0,0 +1,11 @@
+require 'vcr'
+
+VCR.config do |c|
+  c.cassette_library_dir     = 'spec/cassettes'
+  c.stub_with                :webmock
+  c.default_cassette_options = { :record => :new_episodes }
+end
+
+RSpec.configure do |c|
+  c.extend VCR::RSpec::Macros
+end