mavenlink 0.0.1

data/lib/mavenlink/status_report.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class StatusReport < Model
+  end
+end

data/lib/mavenlink/story.rb

@@ -0,0 +1,8 @@
+module Mavenlink
+  class Story < Model
+    include Concerns::CustomFieldable
+
+    validates :title, :story_type, :workspace_id, presence: true
+    validates :story_type, inclusion: {in: %w(task deliverable milestone issue)}
+  end
+end

data/lib/mavenlink/story_allocation_day.rb

@@ -0,0 +1,5 @@
+module Mavenlink
+  class StoryAllocationDay < Model
+    validates :assignment_id, :date, :minutes, presence: true
+  end
+end

data/lib/mavenlink/story_dependency.rb

@@ -0,0 +1,5 @@
+module Mavenlink
+  class StoryDependency < Model
+    validates :workspace_id, presence: true, on: :create
+  end
+end

data/lib/mavenlink/story_task.rb

@@ -0,0 +1,5 @@
+module Mavenlink
+  class StoryTask < Model
+    # include Concerns::Indestructible
+  end
+end

data/lib/mavenlink/tag.rb

@@ -0,0 +1,5 @@
+module Mavenlink
+  class Tag < Model
+    # include Concerns::Indestructible
+  end
+end

data/lib/mavenlink/time_adjustment.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class TimeAdjustment < Model
+  end
+end

data/lib/mavenlink/time_entry.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class TimeEntry < Model
+  end
+end

data/lib/mavenlink/time_off_entry.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class TimeOffEntry < Model
+  end
+end

data/lib/mavenlink/timesheet_submission.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class TimesheetSubmission < Model
+  end
+end

data/lib/mavenlink/user.rb

@@ -0,0 +1,5 @@
+module Mavenlink
+  class User < Model
+    include Concerns::CustomFieldable
+  end
+end

data/lib/mavenlink/vendor.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class Vendor < Model
+  end
+end

data/lib/mavenlink/workspace.rb

@@ -0,0 +1,21 @@
+module Mavenlink
+  class Workspace < Model
+    include Mavenlink::Concerns::CustomFieldable
+    include Mavenlink::Concerns::Indestructible
+
+    # validates :due_date, format: 'YYYY-MM-DD'
+    # ...
+
+    # @todo Raise argument errors...
+    # @todo Return invitation model?
+    # @param invitation [Hash]
+    # @option invitation [String] :full_name (required) the full name of the person being invited
+    # @option invitation [String] :email_address (required) the email address of the person being invited
+    # @option invitation [String] :invitee_role (required) the role for the invited user, either __maven__ (consultant role) or __buyer__ (client role)
+    # @option invitation [String] :subject (optional) the subject message of the invitation email
+    # @option invitation [String] :message (optional) the text content of the invitation email; if you don't provide this, your default will be used
+    def invite(invitation)
+      client.post("workspaces/#@id/invite", invitation: invitation) if persisted?
+    end
+  end
+end

data/lib/mavenlink/workspace_group.rb

@@ -0,0 +1,5 @@
+module Mavenlink
+  class WorkspaceGroup < Model
+    include Mavenlink::Concerns::CustomFieldable
+  end
+end

data/lib/mavenlink/workspace_invoice_preference.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class WorkspaceInvoicePreference < Model
+  end
+end

data/lib/mavenlink/workweek.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class Workweek < Model
+  end
+end

data/lib/mavenlink/workweek_membership.rb

@@ -0,0 +1,4 @@
+module Mavenlink
+  class WorkweekMembership < Model
+  end
+end

data/mavenlink.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mavenlink}
+  s.version = "0.0.1"
+
+  s.date = %q{2014-04-01}
+  s.authors = ["Mavenlink"]
+  s.email = %q{opensource@mavenlink.com}
+  s.homepage = %q{http://github.com/mavenlink/mavenlink_gem}
+
+  s.licenses = ["MIT"]
+
+  s.files = `git ls-files`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.extra_rdoc_files = ["README.md"]
+
+  s.description = %q{Simple Ruby API for the Mavenlink API}
+  s.summary = %q{Mavenlink API Ruby Wrapper}
+
+  s.add_runtime_dependency 'activesupport', ">= 4.0.4"
+  s.add_runtime_dependency 'activemodel', ">= 4.0.4"
+  s.add_runtime_dependency 'brainstem-adaptor', ">= 0.0.3"
+  s.add_runtime_dependency 'faraday', ">= 0.9.0"
+  s.add_development_dependency 'rspec', "2.14.1"
+  s.add_development_dependency 'shoulda-matchers', "2.5.0"
+  s.add_development_dependency 'awesome_print'
+end

data/spec/lib/mavenlink/account_membership_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+
+describe Mavenlink::AccountMembership, stub_requests: true do
+  describe "associations" do
+    it { should respond_to "cost_rates" }
+    it { should respond_to "backup_approver_associations" }
+  end
+end

data/spec/lib/mavenlink/assignment_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Mavenlink::Assignment, stub_requests: true do
+  it_should_behave_like 'model', 'assignments'
+
+  it { should be_a Mavenlink::Concerns::Indestructible }
+
+  describe 'associations' do
+    it { should respond_to :story }
+    it { should respond_to :assignee }
+    it { should respond_to :story_allocation_days }
+  end
+
+  describe '#destroy' do
+    specify { expect { subject.destroy }.to raise_error Mavenlink::RecordLockedError }
+  end
+end

data/spec/lib/mavenlink/attachment_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Mavenlink::Attachment, stub_requests: true do
+  it_should_behave_like 'model', 'attachments'
+
+  describe 'validations' do
+    it { should validate_presence_of :data }
+    it { should validate_presence_of :type }
+    it { should ensure_inclusion_of(:type).in_array(%w[receipt post_attachment]) }
+    it { should_not allow_value(nil).for(:type) }
+  end
+
+  describe '#save' do
+    context 'persisted record' do
+      subject { described_class.new(id: 1, data: 'some data', type: 'receipt') }
+
+      it { should be_persisted }
+
+      specify do
+        expect { subject.save }.to raise_error Mavenlink::RecordLockedError
+      end
+    end
+
+    context 'new record' do
+      specify do
+        expect { subject.save }.not_to raise_error
+      end
+    end
+  end
+end

data/spec/lib/mavenlink/backup_approver_association_spec.rb

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

data/spec/lib/mavenlink/client_spec.rb

@@ -0,0 +1,187 @@
+require 'spec_helper'
+
+describe Mavenlink::Client, stub_requests: true do
+  it { should respond_to :assignments }
+  it { should respond_to :expense_categories }
+  it { should respond_to :stories }
+  it { should respond_to :story_allocation_days }
+  it { should respond_to :users }
+  it { should respond_to :workspaces }
+
+  context 'oauth token is not set' do
+    specify do
+      expect { described_class.new({}) }.to raise_error ArgumentError, /token/
+    end
+  end
+
+  context 'overriding the enpoint URL' do
+    specify do
+      endpoint = "http://api.mavenlink.test/api/v1"
+      client = described_class.new(oauth_token: '12345', endpoint: endpoint)
+
+      expect(client.send(:endpoint)).to eq endpoint
+    end
+  end
+
+  describe 'association calls' do
+    subject(:client) { described_class.new(oauth_token: '12345') }
+    let(:record) { client.workspaces.find(7) }
+    let(:response) {
+      {
+        'count' => 1,
+        'results' => [{'key' => 'workspaces', 'id' => '7'}, {'key' => 'users', 'id' => '2'}],
+        'users' => {
+          '2' => {
+            'id' => 2,
+            'full_name' => 'John Doe'
+          }
+        },
+        'workspaces' => {
+          '7' => {
+            'title' => 'My new project', 'id' => '7',
+            'participant_ids' => ['2'],
+          }
+        }
+      }
+    }
+
+    before do
+      stub_request :get, '/api/v1/workspaces?only=7', response
+    end
+
+    specify do
+      expect(record.participants.count).to eq(1)
+    end
+
+    specify do
+      expect(record.participants.first).to be_a(Mavenlink::User)
+    end
+
+    it 'saves the client scope' do
+      expect(record.participants.first.client).to eq(client)
+    end
+  end
+
+  describe '#assignments' do
+    let(:response) { { 'count' => 0, 'results' => [], 'assignments' => {} } }
+
+    before do
+      stub_request :get, '/api/v1/assignments', response
+    end
+
+    specify do
+      expect(subject.assignments).to be_a(Mavenlink::Request)
+    end
+
+    specify do
+      expect(subject.assignments.collection_name).to eq('assignments')
+    end
+  end
+
+  describe '#stories' do
+    let(:response) { { 'count' => 0, 'results' => [], 'stories' => {} } }
+
+    before do
+      stub_request :get, '/api/v1/stories', response
+    end
+
+    specify do
+      expect(subject.stories).to be_a(Mavenlink::Request)
+    end
+
+    specify do
+      expect(subject.stories.collection_name).to eq('stories')
+    end
+  end
+
+  describe '#story_allocation_days' do
+    let(:response) { { 'count' => 0, 'results' => [], 'story_allocation_days' => {} } }
+
+    before do
+      stub_request :get, '/api/v1/story_allocation_days', response
+    end
+
+    specify do
+      expect(subject.story_allocation_days).to be_a(Mavenlink::Request)
+    end
+
+    specify do
+      expect(subject.story_allocation_days.collection_name).to eq('story_allocation_days')
+    end
+  end
+
+  describe '#users' do
+    let(:response) { { 'count' => 0, 'results' => [], 'users' => {} } }
+
+    before do
+      stub_request :get, '/api/v1/users', response
+    end
+
+    specify do
+      expect(subject.users).to be_a(Mavenlink::Request)
+    end
+
+    specify do
+      expect(subject.users.collection_name).to eq('users')
+    end
+  end
+
+  describe '#workspaces' do
+    let(:response) { { 'count' => 0, 'results' => [], 'workspaces' => {} } }
+
+    before do
+      stub_request :get, '/api/v1/workspaces', response
+    end
+
+    specify do
+      expect(subject.workspaces).to be_a(Mavenlink::Request)
+    end
+
+    specify do
+      expect(subject.workspaces.collection_name).to eq('workspaces')
+    end
+  end
+
+  describe 'plain requests' do
+    let(:get_path)    { '/get_something' }
+    let(:post_path)   { '/post_something' }
+    let(:put_path)    { '/put_something' }
+    let(:delete_path) { '/delete_something' }
+
+    let(:get_response)    { {'get'    => true} }
+    let(:post_response)   { {'post'   => true} }
+    let(:put_response)    { {'put'    => true} }
+    let(:delete_response) { {'delete' => true} }
+
+    before do
+      stub_request :get,    get_path,    get_response
+      stub_request :post,   post_path,   post_response
+      stub_request :put,    put_path,    put_response
+      stub_request :delete, delete_path, delete_response
+    end
+
+    describe '#get' do
+      specify do
+        expect(subject.get(get_path)).to eq(get_response)
+      end
+    end
+
+    describe '#post' do
+      specify do
+        expect(subject.post(post_path)).to eq(post_response)
+      end
+    end
+
+    describe '#put' do
+      specify do
+        expect(subject.put(put_path)).to eq(put_response)
+      end
+    end
+
+    describe '#delete' do
+      specify do
+        expect(subject.delete(delete_path)).to eq(delete_response)
+      end
+    end
+  end
+end

data/spec/lib/mavenlink/concerns/indestructible_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Mavenlink::Concerns::Indestructible do
+  subject do
+    Class.new do
+      include Mavenlink::Concerns::Indestructible
+    end
+  end
+
+  specify do
+    expect { subject.send(:new).destroy }.to raise_error Mavenlink::RecordLockedError, /locked.*deleted/
+  end
+end

data/spec/lib/mavenlink/concerns/locked_record_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Mavenlink::Concerns::LockedRecord do
+  subject do
+    Class.new do
+      def self.create
+      end
+
+      include Mavenlink::Concerns::LockedRecord
+    end
+  end
+
+  specify do
+    expect { subject.send(:new).save }.to raise_error Mavenlink::RecordLockedError, /locked.*changed/
+  end
+
+  specify do
+    expect { subject.send(:new).destroy }.to raise_error Mavenlink::RecordLockedError, /locked.*deleted/
+  end
+
+  specify do
+    expect { subject.new }.to raise_error NameError, /method.*new/
+  end
+
+  specify do
+    expect { subject.create }.to raise_error NameError, /method.*create/
+  end
+end