mavenlink 0.0.1

data/spec/lib/mavenlink/post_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Mavenlink::Post, stub_requests: true do
+  it_should_behave_like 'model', 'posts'
+
+  describe 'validations' do
+    it { should validate_presence_of :message }
+    it { should validate_presence_of :workspace_id }
+  end
+
+  describe 'associations' do
+    it { should respond_to :subject }
+    it { should respond_to :user }
+    it { should respond_to :workspace }
+    it { should respond_to :story }
+    it { should respond_to :replies }
+    it { should respond_to :newest_reply }
+    it { should respond_to :newest_reply_user }
+    it { should respond_to :recipients }
+    it { should respond_to :google_documents }
+    it { should respond_to :attachments }
+  end
+end

data/spec/lib/mavenlink/rate_card_set_version_spec.rb

@@ -0,0 +1,119 @@
+require "spec_helper"
+
+describe Mavenlink::RateCardSetVersion, stub_requests: true do
+  subject { described_class.new(id: "7", rate_card_set_id: "1") }
+  let(:client) { double(Mavenlink::Client) }
+
+  describe "#publish" do
+    context "when the publish is successful" do
+      let(:publish_response) { { "activated" => true } }
+
+      before do
+        allow(subject).to receive(:persisted?) { true }
+        stub_request :put, "/api/v1/rate_card_set_versions/7/publish", publish_response
+      end
+
+      it "returns true" do
+        expect(subject.publish).to eq(true)
+      end
+    end
+
+    context "when the publish fails" do
+      before do
+        allow(subject).to receive(:client) { client }
+        allow(client).to receive(:put).and_raise(Faraday::Error)
+      end
+
+      it "returns false" do
+        expect(subject.publish).to eq(false)
+      end
+    end
+
+    context "when the record is not persisted" do
+      before do
+        allow(subject).to receive(:persisted?) { false }
+      end
+
+      it "returns false" do
+        expect(subject.publish).to eq(false)
+      end
+    end
+  end
+
+  describe "#clone" do
+    context "when `clone` is successful" do
+      let(:clone_response) { {
+        "count" => 1,
+        "results" => [
+          {
+            "key" => "rate_card_set_versions",
+            "id" => "8"
+          }
+        ],
+        "rate_card_set_versions" => {
+          "8" => {
+            "id" => "8",
+            "effective_date" => "2018-09-04",
+            "rate_card_set_id" => "1"
+          }
+        }
+      } }
+
+      before do
+        stub_request :post, "/api/v1/rate_card_set_versions", clone_response
+      end
+
+      it "returns the new rate card set version" do
+        expect_any_instance_of(Mavenlink::Client).to receive(:post).with("rate_card_set_versions",
+                                                                         clone_id: subject.id,
+                                                                         rate_card_set_version: {
+                                                                           rate_card_set_id: subject.rate_card_set_id,
+                                                                           effective_date: nil
+                                                                         }).and_call_original
+        expect(subject.clone_version).to eq(described_class.new(id: "8", effective_date: "2018-09-04", rate_card_set_id: "1"))
+      end
+
+      it "sends the effective_date parameter" do
+        date = Date.new(2018, 9, 5)
+        expect_any_instance_of(Mavenlink::Client).to receive(:post).with("rate_card_set_versions",
+                                                                         clone_id: subject.id,
+                                                                         rate_card_set_version: {
+                                                                           rate_card_set_id: subject.rate_card_set_id,
+                                                                           effective_date: date
+                                                                         }).and_call_original
+        subject.clone_version(date)
+      end
+    end
+
+    context "when `clone` is not successful" do
+      context "when the response is an error" do
+        let(:clone_response) { {
+          "errors" => [
+            {
+              "type" => "system",
+              "message" => "not found"
+            }
+          ],
+        } }
+
+        before do
+          stub_request :post, "/api/v1/rate_card_set_versions", clone_response
+        end
+
+        it "returns false" do
+          expect(subject.clone_version).to eq(false)
+        end
+      end
+
+      context "when the record is not persisted" do
+        before do
+          allow(subject).to receive(:persisted?) { false }
+        end
+
+        it "returns false" do
+          expect(subject.clone_version).to eq(false)
+        end
+      end
+    end
+  end
+end

data/spec/lib/mavenlink/record_invalid_error_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Mavenlink::RecordInvalidError do
+  let(:client) { Object.new }
+  let(:record) { Mavenlink::Workspace.new({ title: nil }, nil, client) }
+  before { record.valid? }
+
+  subject { described_class.new(record) }
+
+  its(:record) { should == record }
+  its(:message) { should == "Title can't be blank" }
+
+  specify do
+    expect { raise subject }.to raise_error described_class, /Title.*blank/
+  end
+end

data/spec/lib/mavenlink/record_not_found_error_spec.rb

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

data/spec/lib/mavenlink/request_spec.rb

@@ -0,0 +1,381 @@
+require 'spec_helper'
+
+describe Mavenlink::Request, stub_requests: true do
+  let(:collection_name) { 'workspaces' }
+  let(:client) { Mavenlink.client }
+
+  subject(:request) { described_class.new(collection_name, client) }
+
+  let(:response) {
+    {
+      'count' => 2,
+      'results' => [{'key' => 'workspaces', 'id' => '7'}, {'key' => 'workspaces', 'id' => '9'}],
+      'workspaces' => {
+        '7' => {'title' => 'My new project'},
+        '9' => {'title' => 'My second project'},
+      }
+    }
+  }
+
+  let(:one_record_response) {
+    {
+      'count' => 1,
+      'results' => [{'key' => 'workspaces', 'id' => '7'}],
+      'workspaces' => {
+        '7' => {'title' => 'My new project'}
+      }
+    }
+  }
+
+  let(:first_page) {
+    {
+      'count' => 3,
+      'results' => [{'key' => 'workspaces', 'id' => '7'}, {'key' => 'workspaces', 'id' => '9'}],
+      'workspaces' => {
+        '7' => {'title' => 'My new project!'},
+        '9' => {'title' => 'My second project!'},
+      }
+    }
+  }
+
+  let(:second_page) {
+    {
+      'count' => 3,
+      'results' => [{'key' => 'workspaces', 'id' => '10'}],
+      'workspaces' => {
+        '10' => {'title' => 'My last project!'}
+      }
+    }
+  }
+
+  let(:third_invalid_page) {
+    {
+      'count' => 3,
+      'results' => [{'key' => 'workspaces', 'id' => '11'}],
+      'workspaces' => {
+        '11' => {'title' => 'Not existed project'}
+      }
+    }
+  }
+
+  before do
+    stub_request :get,    '/api/v1/workspaces?page=1', first_page
+    stub_request :get,    '/api/v1/workspaces?page=2', second_page
+    stub_request :get,    '/api/v1/workspaces?page=3', third_invalid_page
+    stub_request :get,    '/api/v1/workspaces?only=7', one_record_response
+    stub_request :get,    '/api/v1/workspaces?only=8', { 'count' => 0, 'results' => [] }
+    stub_request :put,    '/api/v1/workspaces/7',      one_record_response
+    stub_request :delete, '/api/v1/workspaces/7',      {}
+    stub_request :get,    '/api/v1/workspaces',        response
+    stub_request :post,   '/api/v1/workspaces',        one_record_response
+  end
+
+  describe '#initialize' do
+    let(:client) { double('client') }
+
+    its(:collection_name) { should == 'workspaces' }
+    its(:client) { should == client }
+    its(:scope) { should == {} }
+
+    context 'no client specified' do
+      subject { described_class.new(collection_name) }
+      its(:client) { should == Mavenlink.client }
+    end
+  end
+
+  describe '#current_page' do
+    specify do
+      expect(request.current_page).to eq(1)
+    end
+
+    specify do
+      expect(request.page(2).current_page).to eq(2)
+    end
+  end
+
+  describe '#chain' do
+    specify do
+      expect(request.chain({})).to be_a described_class
+    end
+
+    specify do
+      expect(request.chain({})).not_to eq(request)
+    end
+
+    it 'does not change source scope' do
+      expect { request.chain({changed: true}) }.not_to change { request.scope }
+    end
+
+    it 'merges passed scope' do
+      expect(request.chain(changed: true).scope).to have_key(:changed)
+      expect(request.chain(changed: true).scope).to have_key('changed')
+    end
+
+    it 'assigns the same collection name' do
+      expect(request.chain({}).collection_name).to eq(request.collection_name)
+    end
+
+    it 'assigns the same client' do
+      expect(request.chain({}).client).to eq(request.client)
+    end
+  end
+
+  describe '#only' do
+    context 'empty input' do
+      it 'resets the scope' do
+        expect(request.only(1).only([]).scope).not_to have_key(:only)
+      end
+    end
+  end
+
+  describe '#without' do
+    it 'removes condition from the scope' do
+      expect(subject.only(1).without(:only).scope).not_to have_key(:only)
+    end
+  end
+
+  describe '#find' do
+    context 'existed record' do
+      it 'returns record wrapped in a model' do
+        expect(request.find(7)).to be_a Mavenlink::Workspace
+      end
+    end
+
+    context 'record does not exist' do
+      specify do
+        expect(request.find(8)).to be_nil
+      end
+    end
+  end
+
+  describe '#search' do
+    specify do
+      expect(request.search('text').scope).to include(search: 'text')
+    end
+  end
+
+  describe '#filter' do
+    specify do
+      expect(request.filter(recent: true).scope).to include(recent: true)
+    end
+  end
+
+  describe '#include' do
+    specify do
+      expect(request.include(:users).scope).to include(include: 'users')
+    end
+
+    specify do
+      expect(request.include('users').scope).to include(include: 'users')
+    end
+
+    specify do
+      expect(request.include(%w(users clients)).scope).to include(include: 'users,clients')
+    end
+
+    specify do
+      expect(request.include('users', 'clients').scope).to include(include: 'users,clients')
+    end
+  end
+
+  describe '#page' do
+    specify do
+      expect(request.page(5).scope).to include(page: 5)
+    end
+  end
+
+  describe '#per_page' do
+    specify do
+      expect(request.per_page(5).scope).to include(per_page: 5)
+    end
+  end
+
+  describe '#limit' do
+    specify do
+      expect(request.limit(5).scope).to include(limit: 5)
+    end
+  end
+
+  describe '#offset' do
+    specify do
+      expect(request.offset(5).scope).to include(offset: 5)
+    end
+  end
+
+  describe '#order' do
+    specify do
+      expect(request.order(:id, :desc).scope).to include(order: 'id:desc')
+    end
+
+    specify do
+      expect(request.order(:id, 'desc').scope).to include(order: 'id:desc')
+    end
+
+    specify do
+      expect(request.order(:id, 'DESC').scope).to include(order: 'id:desc')
+    end
+
+    specify do
+      expect(request.order(:id, true).scope).to include(order: 'id:desc')
+    end
+
+    specify do
+      expect(request.order(:id, false).scope).to include(order: 'id')
+    end
+
+    specify do
+      expect(request.order(:id, 'asc').scope).to include(order: 'id')
+    end
+
+    specify do
+      expect(request.order(:id, 'ASC').scope).to include(order: 'id')
+    end
+
+    specify do
+      expect(request.order(:id, :asc).scope).to include(order: 'id')
+    end
+  end
+
+  describe '#build' do
+    it 'returns a model object of the same type as the collection name' do
+      expect(request.build(title: 'New Workspace')).to be_a Mavenlink::Workspace
+    end
+  end
+
+  describe '#create' do
+    specify do
+      expect(request.create({})).to be_a Mavenlink::Response
+    end
+
+    specify do
+      expect(request.create({})).to eq(one_record_response)
+    end
+  end
+
+  describe '#update' do
+    specify do
+      expect(request.only(7).update(title: 'New title')).to be_a Mavenlink::Response
+    end
+
+    specify do
+      expect(request.only(7).update(title: 'New title')).to eq(one_record_response)
+    end
+
+    context 'no id specified' do
+      specify do
+        # NOTE(SZ): should we raise InvalidRequestError instead?
+        expect { request.update(title: 'New one') }.to raise_error ArgumentError, /route.*ID/
+      end
+    end
+  end
+
+  describe '#delete' do
+    specify do
+      expect(request.only(7).delete).to be_blank
+    end
+
+    context 'no id specified' do
+      specify do
+        # NOTE(SZ): should we raise InvalidRequestError instead?
+        expect { request.delete }.to raise_error ArgumentError, /route.*ID/
+      end
+    end
+  end
+
+  describe '#response' do
+    subject { request.response }
+
+    specify do
+      expect(subject).to be_a Mavenlink::Response
+    end
+
+    specify do
+      expect(subject).to eq(response)
+    end
+  end
+
+  describe '#perform' do
+    specify do
+      expect(request.perform).to be_a Mavenlink::Response
+    end
+
+    specify do
+      expect(request.perform).to eq(response)
+    end
+
+    specify do
+      expect(request.perform { one_record_response }).to be_a Mavenlink::Response
+    end
+
+    specify do
+      expect(request.perform { one_record_response }).to eq(one_record_response)
+    end
+  end
+
+  describe '#results' do
+    specify do
+      expect(request.results).to have(2).workspaces
+    end
+
+    # NOTE(SZ): missing specs
+  end
+
+  describe '#reload' do
+    specify do
+      expect(request.reload).to have(2).workspaces
+    end
+
+    # NOTE(SZ): missing specs
+  end
+
+  describe '#total_pages' do
+    specify do
+      expect(request.total_pages).to eq(1)
+    end
+
+    # NOTE(SZ): missing specs
+  end
+
+  describe '#limit_value' do
+    specify do
+      expect(request.limit_value).to eq(2)
+    end
+
+    specify do
+      expect(request.limit(5).limit_value).to eq(5)
+    end
+  end
+
+  describe '#scoped' do
+    specify do
+      expect(request.scoped).to eq(request)
+    end
+  end
+
+  describe '#to_hash' do
+    specify do
+      expect(request.to_hash).to eq(request.scope)
+    end
+  end
+
+  describe '#inspect' do
+    specify do
+      expect(request.inspect).to eq('#<Mavenlink::Request [<Mavenlink::Workspace:>, <Mavenlink::Workspace:>]>')
+    end
+  end
+
+  describe '#each_page' do
+    specify do
+      expect(subject.each_page.to_a).to eq [[{"title"=>"My new project!"}, {"title"=>"My second project!"}],
+                                            [{"title"=>"My last project!"}]]
+    end
+
+    specify do
+      subject.each_page.to_a.flatten.tap do |records|
+        expect(records[0]).to be_a Mavenlink::Model
+        expect(records[1]).to be_a Mavenlink::Model
+        expect(records[2]).to be_a Mavenlink::Model
+      end
+    end
+  end
+end