mavenlink 0.0.1

data/spec/lib/mavenlink/cost_rate_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe Mavenlink::CostRate, stub_requests: true do
+  it_should_behave_like "model", "cost_rates"
+
+  describe "association" do
+    it { should respond_to :account_membership }
+  end
+end

data/spec/lib/mavenlink/custom_field_value_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Mavenlink::CustomFieldValue, stub_requests: true do
+  it_should_behave_like 'model', 'custom_field_values'
+
+  describe 'associations' do
+    it { should respond_to :setter }
+    it { should respond_to :custom_field }
+  end
+end

data/spec/lib/mavenlink/expense_report_submission_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Mavenlink::ExpenseReportSubmission, stub_requests: true do
+  let(:report) { described_class.new(id: 4) }
+
+  describe "#reject_submission" do
+    before do
+      allow(report.client).to receive(:put)
+      report.reject_submission
+    end
+
+    it "uses a put method with the correct api endpoint and id" do
+      expect(report.client).to have_received(:put).with("expense_report_submissions/4/reject")
+    end
+  end
+end

data/spec/lib/mavenlink/expense_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Mavenlink::Expense, stub_requests: true do
+  it_should_behave_like 'model', 'expenses'
+
+  describe 'validations' do
+    it { should validate_presence_of :workspace_id }
+    it { should validate_presence_of :date }
+    it { should validate_presence_of :category }
+    it { should validate_presence_of :amount_in_cents }
+  end
+
+  describe 'associations' do
+    it { should respond_to :expense_category }
+    it { should respond_to :workspace }
+    it { should respond_to :user }
+    it { should respond_to :receipt }
+    it { should respond_to :external_references }
+    it { should respond_to :active_submission }
+    it { should respond_to :role }
+    it { should respond_to :vendor }
+  end
+end

data/spec/lib/mavenlink/external_references_spec.rb

@@ -0,0 +1,144 @@
+require "spec_helper"
+
+describe Mavenlink::ExternalReference, stub_requests: true do
+  let(:model) { described_class }
+  let(:external_reference) { model.new(attributes) }
+  let(:uri) { "external_references/create_or_update" }
+  let(:attributes) {
+    {
+      "subject_type" => "TimeEntry",
+      "subject_id" => 1,
+      "service_name" => "Netsuite",
+      "service_model_ref" => "1",
+      "service_model" => "TimeBill"
+    }.merge(attribute_options)
+  }
+  let(:attribute_options) { {} }
+  let(:response) do
+    {
+      "count" => 1,
+      "results" => [{"key" => "external_references", "id" => "7"}],
+      "external_references" => {
+        "7" => {
+          "id" => "7",
+          "subject_id" => "1",
+          "subject_type" => "TimeEntry",
+          "service_model_ref" => "1",
+          "service_name" => "Netsuite",
+          "service_model" => "TimeBill"
+        }
+      }
+    }
+  end
+
+  describe "validations" do
+    it { should validate_presence_of :service_model_ref }
+    it { should validate_presence_of :service_name }
+    it { should validate_presence_of :service_model }
+    it { should validate_presence_of :subject_id }
+    it { should validate_presence_of :subject_type }
+  end
+
+  describe "#save" do
+    before do
+      allow(external_reference.client).to receive(:post).and_call_original
+      stub_request :post, "/api/v1/external_references/create_or_update", response
+    end
+
+    context "when the model is valid" do
+      it "the record is valid" do
+        external_reference.save
+        expect(external_reference).to be_a model
+        expect(external_reference).to be_valid
+        expect(external_reference).to be_persisted
+      end
+
+      it "makes the request with the correct params" do
+        external_reference.save
+        expect(external_reference.client).to have_received(:post).with(uri, { external_reference: attributes })
+      end
+
+      it "returns true" do
+        expect(external_reference.save).to be_true
+      end
+
+      it "loads the response attributes into the integrated resource model" do
+        external_reference.save
+        expect(external_reference).to eq(response["external_references"]["7"])
+      end
+    end
+
+    context "when an invalid attribute is set on the model" do
+        let(:attribute_options) { { foo: 666 } }
+
+        it "the record is valid" do
+          external_reference.save
+          expect(external_reference).to be_a model
+          expect(external_reference).to be_valid
+          expect(external_reference).to be_persisted
+        end
+
+        it "ignores invalid attributes when making the request" do
+          external_reference.save
+          expect(external_reference.client).to have_received(:post).with(uri, { external_reference: attributes.except(:foo)})
+        end
+
+        it "returns true" do
+          expect(external_reference.save).to be_true
+        end
+
+        it "loads the response attributes into the integrated resource model" do
+          external_reference.save
+          expect(external_reference).to include(response["external_references"]["7"])
+        end
+      end
+
+    context "when required attributes are missing" do
+      let(:attribute_options) { { subject_type: nil } }
+
+      it "the record is not valid" do
+        external_reference.save
+        expect(external_reference).to be_a model
+        expect(external_reference).to_not be_valid
+        expect(external_reference).to_not be_persisted
+      end
+
+      it "does not make the request" do
+        external_reference.save
+        expect(external_reference.client).to_not have_received(:post)
+      end
+
+      it "returns false" do
+        expect(external_reference.save).to be_false
+      end
+
+      it "logs an error on the modal" do
+        external_reference.save
+        expect(external_reference.errors.full_messages).to eq(["Subject type can't be blank"])
+      end
+    end
+
+    context "when the server responds with error" do
+      let(:response) do
+        {
+          "errors" => [
+            {
+              "type" => "syntax",
+              "message" => "Missing required parameters. Please see our documentation at http://developer.mavenlink.com"
+            }
+          ]
+        }
+      end
+
+      after do
+        expect(external_reference).to be_a model
+        expect(external_reference).to be_valid
+        expect(external_reference).to_not be_persisted
+      end
+
+      it "raise a Mavenlink InvalidRequestError" do
+        expect { external_reference.save }.to raise_error Mavenlink::InvalidRequestError, /Missing required parameters/
+      end
+    end
+  end
+end

data/spec/lib/mavenlink/holiday_calendar_association_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+
+describe Mavenlink::HolidayCalendarAssociation do
+  describe "associations" do
+    it { should respond_to :holiday }
+    it { should respond_to :holiday_calendar }
+  end
+end

data/spec/lib/mavenlink/holiday_calendar_membership_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+
+describe Mavenlink::HolidayCalendarMembership do
+  describe "associations" do
+    it { should respond_to :holiday_calendar }
+    it { should respond_to :user }
+  end
+end

data/spec/lib/mavenlink/holiday_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe Mavenlink::Holiday do
+  describe "associations" do
+    it { should respond_to :holiday_calendar_associations }
+  end
+end

data/spec/lib/mavenlink/invalid_request_error_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Mavenlink::InvalidRequestError do
+  subject { described_class.new({response: :data}) }
+
+  specify do
+    expect { raise subject }.to raise_error Mavenlink::InvalidRequestError, /response.*data/
+  end
+end

data/spec/lib/mavenlink/invoice_spec.rb

@@ -0,0 +1,176 @@
+require 'spec_helper'
+
+describe Mavenlink::Invoice, stub_requests: true do
+  subject { described_class.send(:new) }
+
+  describe 'associations' do
+    it { should respond_to :workspaces }
+    it { should respond_to :user }
+    it { should respond_to :recipient }
+    it { should respond_to :time_entries }
+    it { should respond_to :expenses }
+    it { should respond_to :fixed_fee_items }
+    it { should respond_to :additional_items }
+  end
+
+  let(:collection_name) { 'invoices' }
+
+  let(:model) { described_class }
+
+  let(:response) {
+    {
+      'count' => 1,
+      'results' => [{'key' => collection_name, 'id' => '7'}],
+      collection_name => {
+        '7' => {'title' => 'My new record', 'id' => '7'}
+      }
+    }
+  }
+
+  before do
+    stub_request :get,    "/api/v1/#{collection_name}?only=7", response
+    stub_request :get,    "/api/v1/#{collection_name}?only=8", {'count' => 0, 'results' => []}
+    stub_request :post,   "/api/v1/#{collection_name}", response
+    stub_request :delete, "/api/v1/#{collection_name}/4", {}
+  end
+
+  describe 'class methods' do
+    subject { model }
+    its(:collection_name) { should == collection_name }
+
+    describe '.scoped' do
+      subject { model.scoped }
+
+      it { should be_a Mavenlink::Request }
+      its(:collection_name) { should == collection_name }
+    end
+
+    describe '.find' do
+      specify do
+        expect(model.find(7)).to be_a model
+      end
+
+      specify do
+        expect(model.find(7).id).to eq('7')
+      end
+
+      specify do
+        expect(model.find(8)).to be_nil
+      end
+    end
+
+    describe '.models' do
+      specify do
+        expect(model.models).to be_empty
+      end
+
+      specify do
+        expect(Mavenlink::Model.models).to include({collection_name => model})
+      end
+    end
+
+    describe '.specification' do
+      specify do
+        expect(model.specification).to be_a Hash
+      end
+
+      specify do
+        expect(model.specification).not_to be_empty
+      end
+    end
+
+    describe '.attributes' do
+      specify do
+        expect(model.attributes).to be_an Array
+      end
+
+      specify do
+        expect(model.attributes).not_to be_empty
+      end
+    end
+
+    describe '.available_attributes' do
+      specify do
+        expect(model.available_attributes).to be_an Array
+      end
+
+      specify do
+        expect(model.available_attributes).not_to be_empty
+      end
+    end
+
+    describe '.wrap' do
+      context 'existing record' do
+        let(:brainstem_record) do
+          BrainstemAdaptor::Record.new(collection_name, '7', Mavenlink::Response.new(response))
+        end
+
+        specify do
+          expect(model.wrap(brainstem_record)).not_to be_a_new_record
+        end
+
+        specify do
+          expect(model.wrap(brainstem_record)).to be_a model
+        end
+      end
+    end
+  end
+
+  describe '#initialize' do
+    it 'accepts attributes' do
+      expect(model.send(:new, any_custom_key: 'value set')).to include(any_custom_key: 'value set')
+    end
+  end
+
+  describe '#persisted?' do
+    before do
+      @instance = model.new
+    end
+
+    context 'when the model does not have an ID' do
+      before do
+        expect(@instance.id).to be_nil
+      end
+
+      it 'is false' do
+        expect(@instance).to_not be_persisted
+      end
+    end
+
+    context 'when the model has an ID' do
+      before do
+        @instance.id = 5
+      end
+
+      it 'is true' do
+        expect(@instance).to be_persisted
+      end
+    end
+  end
+
+  describe '#new_record?' do
+    before do
+      @instance = model.new
+    end
+
+    context 'when the model does not have an ID' do
+      before do
+        expect(@instance.id).to be_nil
+      end
+
+      it 'is true' do
+        expect(@instance).to be_new_record
+      end
+    end
+
+    context 'when the model has an ID' do
+      before do
+        @instance.id = 5
+      end
+
+      it 'is false' do
+        expect(@instance).to_not be_new_record
+      end
+    end
+  end
+end

data/spec/lib/mavenlink/model_spec.rb

@@ -0,0 +1,439 @@
+require 'spec_helper'
+
+describe Mavenlink::Model, stub_requests: true do
+  # see workspace_model_spec.rb
+
+  before do
+    Mavenlink.stub(:specification).and_return({ 'monkeys' => {'validations' => {'name' => {'presence' => true}},
+                                                              'attributes'        => ['name'],
+                                                              'create_attributes' => ['name'],
+                                                              'update_attributes' => ['name', 'age']} })
+  end
+
+  subject :model do
+    class Monkey < Mavenlink::Model
+      def self.name
+        'Mavenlink::Monkey'
+      end
+    end
+    Monkey
+  end
+
+  its(:collection_name) { should == 'monkeys'}
+
+  let(:response) {
+    {
+      'count' => 1,
+      'results' => [{'key' => 'monkeys', 'id' => '7'}],
+      'monkeys' => {
+        '7' => {'name' => 'Masha', 'id' => '7'}
+      }
+    }
+  }
+
+  let(:updated_response) {
+    {
+      'count' => 1,
+      'results' => [{'key' => 'monkeys', 'id' => '7'}],
+      'monkeys' => {
+        '7' => {'name' => 'Mashka', 'id' => '7'}
+      }
+    }
+  }
+
+  before do
+    stub_request :get,    '/api/v1/monkeys?only=7', response
+    stub_request :get,    '/api/v1/monkeys?only=8', {'count' => 0, 'results' => []}
+    stub_request :post,   '/api/v1/monkeys', response
+    stub_request :put,    '/api/v1/monkeys/7', updated_response
+    stub_request :delete, '/api/v1/monkeys/7', {}
+  end
+
+  describe '.find' do
+    specify do
+      expect(model.find(7)).to be_a model
+    end
+
+    specify do
+      expect(model.find(7).id).to eq('7')
+    end
+
+    specify do
+      expect(model.find(8)).to be_nil
+    end
+  end
+
+  describe '.create' do
+    context 'valid record' do
+      specify do
+        expect(model.create(name: 'Masha')).to be_a model
+      end
+
+      specify do
+        expect(model.create(name: 'Masha')).to be_valid
+      end
+
+      specify do
+        expect(model.create(name: 'Masha')).to be_persisted
+      end
+    end
+
+    context 'invalid record' do
+      specify do
+        expect(model.create(name: '')).to be_a model
+      end
+
+      specify do
+        expect(model.create(name: '')).not_to be_valid
+      end
+
+      specify do
+        expect(model.create(name: '')).to be_a_new_record
+      end
+    end
+  end
+
+  describe '.create!' do
+    context 'valid record' do
+      specify do
+        expect { model.create!(name: 'Masha') }.not_to raise_error
+      end
+    end
+
+    context 'invalid record' do
+      specify do
+        expect { model.create!(name: '') }.to raise_error Mavenlink::RecordInvalidError, /Name.*blank/
+      end
+    end
+  end
+
+  describe '.models' do
+    specify do
+      expect(model.models).to be_empty
+    end
+
+    specify do
+      expect(Mavenlink::Model.models).to include({'monkeys' => Monkey})
+    end
+  end
+
+  describe '.specification' do
+    specify do
+      expect(model.specification).to be_a Hash
+    end
+
+    specify do
+      expect(model.specification).not_to be_empty
+    end
+  end
+
+  describe '.attributes' do
+    specify do
+      expect(model.attributes).to eq(['name'])
+    end
+  end
+
+  describe '.available_attributes' do
+    specify do
+      expect(model.available_attributes).to eq(['name', 'age'])
+    end
+  end
+
+  describe '.create_attributes' do
+    specify do
+      expect(model.create_attributes).to eq(['name'])
+    end
+  end
+
+  describe '.update_attributes' do
+    specify do
+      expect(model.update_attributes).to eq(['name', 'age'])
+    end
+  end
+
+  describe '.wrap' do
+    specify do
+      expect(model.wrap(nil)).to be_a_new_record
+    end
+
+    context 'existing record' do
+      let(:brainstem_record) do
+        BrainstemAdaptor::Record.new('monkeys', '7', Mavenlink::Response.new(response))
+      end
+
+      specify do
+        expect(model.wrap(brainstem_record)).not_to be_a_new_record
+      end
+
+      specify do
+        expect(model.wrap(brainstem_record)).to be_a Monkey
+      end
+    end
+  end
+
+  describe '#initialize' do
+    it 'accepts attributes' do
+      expect(model.new(any_custom_key: 'value set')).to include(any_custom_key: 'value set')
+    end
+
+    it 'checks for client' do
+      expect(model.new).to respond_to (:client)
+      expect(model.new.client).to be_a Mavenlink::Client
+    end
+  end
+
+  describe '#client' do
+    specify 'default client' do
+      expect(model.new.client).to be_a Mavenlink::Client
+    end
+
+    context 'custom client set' do
+      let(:client) { Mavenlink::Client.new(oauth_token: 'new one') }
+      subject { described_class.new({test: 'set'}, nil, client) }
+
+      its(:client) { should eq(client) }
+    end
+  end
+
+  describe '#persisted?' do
+    specify do
+      expect(model.new).not_to be_persisted
+    end
+
+    specify do
+      expect(model.new(id: 1)).to be_persisted
+    end
+  end
+
+  describe '#new_record?' do
+    specify do
+      expect(model.new).to be_new_record
+    end
+
+    specify do
+      expect(model.new(id: 1)).not_to be_new_record
+    end
+  end
+
+  describe 'attributes' do
+    specify do
+      expect(model.new).to respond_to :name
+    end
+
+    specify do
+      expect(model.new).to respond_to :age
+    end
+  end
+
+  describe '#attributes=' do
+    subject { model.new(name: 'old') }
+
+    specify do
+      expect { subject.attributes = {name: 'new'} }.to change { subject['name'] }.from('old').to('new')
+    end
+  end
+
+  describe '#to_param' do
+    specify do
+      expect(model.new(id: 1).to_param).to eq('1')
+    end
+
+    specify do
+      expect(model.new(id: nil).to_param).to eq(nil)
+    end
+  end
+
+  describe '#save' do
+    context 'valid record' do
+      context 'new record' do
+        subject { model.new(name: 'Maria') }
+
+        specify do
+          expect(subject.save).to eq(true)
+        end
+
+        specify do
+          expect { subject.save }.to change(subject, :persisted?).from(false).to(true)
+        end
+
+        it 'reloads record fields taking it from response' do
+          expect { subject.save }.to change { subject.name }.from('Maria').to('Masha')
+        end
+      end
+
+      context 'persisted record' do
+        subject { model.create(name: 'Maria') }
+
+        it { should be_persisted }
+
+        specify do
+          expect(subject.save).to eq(true)
+        end
+
+        specify do
+          expect { subject.save }.not_to change(subject, :persisted?)
+        end
+
+        it 'reloads record fields taking it from response' do
+          expect { subject.save }.to change { subject.name }.from('Masha').to('Mashka')
+        end
+      end
+    end
+
+    context 'invalid record' do
+      context 'new record' do
+        subject { model.new(name: '') }
+
+        specify do
+          expect(subject.save).to eq(false)
+        end
+
+        specify do
+          expect { subject.save }.not_to change(subject, :persisted?)
+        end
+
+        it 'does not perform any requests' do
+          expect { subject.save }.not_to change { subject.name }
+        end
+      end
+
+      context 'persisted record' do
+        subject { model.create(name: 'Maria') }
+        before { subject.name = '' }
+
+        it { should be_persisted }
+
+        specify do
+          expect(subject.save).to eq(false)
+        end
+
+        specify do
+          expect { subject.save }.not_to change(subject, :persisted?)
+        end
+
+        it 'does not change anything' do
+          expect { subject.save }.not_to change { subject.name }
+        end
+      end
+    end
+  end
+
+  describe '#save!' do
+    context 'valid record' do
+      context 'new record' do
+        subject { model.new(name: 'Maria') }
+
+        specify do
+          expect(subject.save!).to eq(true)
+        end
+
+        specify do
+          expect { subject.save! }.to change(subject, :persisted?).from(false).to(true)
+        end
+
+        it 'reloads record fields taking it from response' do
+          expect { subject.save! }.to change { subject.name }.from('Maria').to('Masha')
+        end
+      end
+
+      context 'persisted record' do
+        subject { model.create(name: 'Maria') }
+
+        it { should be_persisted }
+
+        specify do
+          expect(subject.save!).to eq(true)
+        end
+
+        specify do
+          expect { subject.save! }.not_to change(subject, :persisted?)
+        end
+
+        it 'reloads record fields taking it from response' do
+          expect { subject.save! }.to change { subject.name }.from('Masha').to('Mashka')
+        end
+      end
+    end
+
+    context 'invalid record' do
+      context 'new record' do
+        subject { model.new(name: '') }
+
+        specify do
+          expect { subject.save! }.to raise_error Mavenlink::RecordInvalidError, /Name.*blank/
+        end
+
+        specify do
+          expect { subject.save! rescue nil }.not_to change(subject, :persisted?)
+        end
+
+        it 'does not perform any requests' do
+          expect { subject.save! rescue nil }.not_to change { subject.name }
+        end
+      end
+
+      context 'persisted record' do
+        subject { model.create(name: 'Maria') }
+        before { subject.name = '' }
+
+        it { should be_persisted }
+
+        specify do
+          expect { subject.save! }.to raise_error Mavenlink::RecordInvalidError, /Name.*blank/
+        end
+
+        specify do
+          expect { subject.save! rescue nil }.not_to change(subject, :persisted?)
+        end
+
+        it 'does not change anything' do
+          expect { subject.save! rescue nil }.not_to change { subject.name }
+        end
+      end
+    end
+  end
+
+  describe '#update_attributes' do
+    context 'valid record' do
+      context 'new record' do
+        subject { model.new }
+
+        specify do
+          expect(subject.update_attributes(name: 'Maria')).to eq(true)
+        end
+
+        specify do
+          expect { subject.update_attributes(name: 'Maria') }.to change(subject, :persisted?).from(false).to(true)
+        end
+      end
+
+      context 'persisted record' do
+        subject { model.create(name: 'Maria') }
+
+        it { should be_persisted }
+
+        specify do
+          expect(subject.update_attributes(name: 'mashka')).to eq(true)
+        end
+
+        specify do
+          expect { subject.update_attributes(name: 'test') }.not_to change(subject, :persisted?)
+        end
+
+        it 'reloads record fields taking it from response' do
+          expect { subject.update_attributes(name: 'test') }.to change { subject.name }.from('Masha').to('Mashka')
+        end
+      end
+    end
+
+    # TODO: invalid record, update_attributes!
+  end
+
+  describe '#destroy' do
+    subject { model.create(name: 'Maria') }
+
+    specify do
+      expect { subject.destroy }.not_to raise_error
+    end
+  end
+end