clio_client 0.0.1

data/lib/clio_client/support/email_address.rb

@@ -0,0 +1,12 @@
+module ClioClient
+  class EmailAddress < Resource
+
+    set_attributes(id:                      {type: :int, readonly: true},
+                   created_at:              {type: :datetime, readonly: true},
+                   updated_at:              {type: :datetime, readonly: true},
+                   name:                    {type: :string},
+                   address:                 {type: :string}
+                   )
+
+  end
+end

data/lib/clio_client/support/instant_messenger.rb

@@ -0,0 +1,12 @@
+module ClioClient
+  class InstantMessenger < Resource
+
+    set_attributes(id:                      {type: :int, readonly: true},
+                   created_at:              {type: :datetime, readonly: true},
+                   updated_at:              {type: :datetime, readonly: true},
+                   name:                    {type: :string},
+                   address:                 {type: :string},
+                   )
+
+  end
+end

data/lib/clio_client/support/phone_number.rb

@@ -0,0 +1,13 @@
+module ClioClient
+  class PhoneNumber < Resource
+
+    set_attributes(id:                      {type: :int, readonly: true},
+                   created_at:              {type: :datetime, readonly: true},
+                   updated_at:              {type: :datetime, readonly: true},
+                   name:                    {type: :string},
+                   number:                  {type: :string},
+                   default_number:          {type: :boolean},
+                   )
+
+  end
+end

data/lib/clio_client/support/rate.rb

@@ -0,0 +1,16 @@
+module ClioClient
+
+  class Rate < Resource
+    set_attributes(id:                      {type: :int, readonly: true},
+                   created_at:              {type: :datetime, readonly: true},
+                   updated_at:              {type: :datetime, readonly: true},
+                   rate:                    {type: :decimal},
+                   source:                  {type: :string   }, 
+                   flat_rate:               {type: :boolean},
+                   user_id:                 {type: :int},
+                   )
+
+
+  end
+
+end

data/lib/clio_client/support/reminder.rb

@@ -0,0 +1,11 @@
+module ClioClient
+
+  class Reminder < Resource
+
+    set_attributes(minutes:  {type: :int     },
+                   method:   {type: :string  }
+                   )
+
+  end
+
+end

data/lib/clio_client/support/web_site.rb

@@ -0,0 +1,12 @@
+module ClioClient
+  class WebSite < Resource
+
+    set_attributes(id:                      {type: :int, readonly: true},
+                   created_at:              {type: :datetime, readonly: true},
+                   updated_at:              {type: :datetime, readonly: true},
+                   name:                    {type: :string},
+                   address:                 {type: :string},
+                   )
+
+  end
+end

data/lib/clio_client/version.rb

@@ -0,0 +1,3 @@
+module ClioClient
+  VERSION = "0.0.1"
+end

data/lib/clio_client.rb

@@ -0,0 +1,107 @@
+require 'net/http'
+require 'json'
+
+module ClioClient
+  
+  { :Session =>       'session',
+    :Base =>          'base',
+    :Resource =>      'resource',
+    :Http =>          'http',
+    :Authorization => 'authorization'
+  }.each_pair do |klass, file| 
+    autoload klass, "clio_client/#{file}"
+  end
+
+  # Models
+  {
+    :Account =>             'account',
+    :Activity =>            'activity',
+    :ActivityDescription => 'activity_description',
+    :Bill =>                'bill',
+    :CalendarEntry =>       'calendar_entry',
+    :Calendar =>            'calendar',
+    :Communication =>       'communication',
+    :Company =>             'company',
+    :Contact =>             'contact',
+    :CustomFieldSet =>      'custom_field_set',
+    :CustomField =>         'custom_field',
+    :DocumentVersion =>     'document_version',
+    :Document =>            'document',
+    :ExpenseEntry =>        'expense_entry',
+    :EmailCommunication =>  'email_communication',
+    :Group =>               'group',
+    :Matter =>              'matter',
+    :Note =>                'note',
+    :Person =>              'person',
+    :PhoneCommunication =>  'phone_communication',
+    :PracticeArea =>        'practice_area',
+    :TimeEntry =>           'time_entry',
+    :Relationship =>        'relationship',
+    :Task =>                'task',
+    :TimelineEvent =>       'timeline_event',
+    :Timer =>               'timer',
+    :User =>                'user'
+  }.each_pair do |klass, file| 
+    autoload klass, "clio_client/models/#{file}"
+  end
+
+  {
+    :PhoneNumber =>              'phone_number',
+    :EmailAddress =>             'email_address',
+    :Address =>                  'address',
+    :WebSite =>                  'web_site',
+    :InstantMessenger =>         'instant_messenger',
+    :CustomFieldValue =>         'custom_field_value',
+    :CustomFieldCheckboxValue => 'custom_field_checkbox_value',
+    :CustomFieldContactValue =>  'custom_field_contact_value',
+    :CustomFieldCurrencyValue => 'custom_field_currency_value',
+    :CustomFieldDateValue =>     'custom_field_date_value',
+    :CustomFieldTimeValue =>     'custom_field_time_value',
+    :CustomFieldEmailValue =>    'custom_field_email_value',
+    :CustomFieldMatterValue =>   'custom_field_matter_value',
+    :CustomFieldNumericValue =>  'custom_field_numeric_value',
+    :CustomFieldPicklistValue => 'custom_field_picklist_value',
+    :CustomFieldPicklistOption =>'custom_field_picklist_option',
+    :CustomFieldTextAreaValue => 'custom_field_text_area_value',
+    :CustomFieldTextLineValue => 'custom_field_text_line_value',
+    :CustomFieldUrlValue =>      'custom_field_url_value',
+    :Rate =>                     'rate',
+    :Reminder =>                 'reminder'
+  }.each_pair do |klass, file| 
+    autoload klass, "clio_client/support/#{file}"
+  end
+
+  module Api
+    {
+      :Base =>              'base',
+      :Activity =>           'activity',
+      :ActivityDescription =>'activity_description',
+      :Bill =>               'bill',
+      :CalendarEntry =>      'calendar_entry',
+      :Calendar =>           'calendar',
+      :Communication =>      'communication',
+      :Contact =>            'contact',
+      :CustomFieldSet =>     'custom_field_set',    
+      :CustomField =>        'custom_field',
+      :DocumentVersion =>    'document_version',
+      :Document =>           'document',
+      :Group =>              'group',
+      :Matter =>             'matter',
+      :Note =>               'note',
+      :PracticeArea =>       'practice_area',
+      :Relationship =>       'relationship',
+      :Task =>               'task',
+      :TimelineEvent =>     'timeline_event',
+      :Timer =>              'timer',
+      :User =>               'user',
+
+      :Crudable =>          'crudable',
+      :Findable =>          'findable',
+      :Listable =>          'listable'
+    }.each_pair do |klass, file| 
+      autoload klass, "clio_client/api/#{file}"
+    end
+
+  end
+
+end

data/spec/api/crudable_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe ClioClient::Api::Crudable do
+  let(:session) { double("ClioClient::Api::Session") }
+  subject { 
+    d = DummyEndpoint.new(session)
+    d.extend(ClioClient::Api::Crudable)
+    d
+  }
+
+  describe "#new" do    
+    it "returns the correct data items" do
+      record = subject.new({ int: "1" })
+      expect(record).to be_kind_of TestResource
+      expect(record.int).to eql 1
+    end
+  end
+
+  describe "#create" do
+    let(:params) { { string: "1" } }
+    let(:response) do
+      { "dummy" => { string: "1" } }
+    end
+
+    it "issues with create request" do
+      session.stub(:post).with("test", {"dummy" => params}.to_json).and_return(response)
+      record = subject.create(params)
+      expect(record).to be_kind_of TestResource
+      expect(record.string).to eql "1"
+    end
+  end
+
+  describe "#update" do
+    let(:params) { { id: 1, string: "1" } }
+    let(:response) do
+      { "dummy" => { id: 1, string: "1" } }
+    end
+
+    it "issues with update request" do
+      record = session.stub(:put).with("test/1", {"dummy" => params}.to_json).and_return(response)
+      record = subject.update("1", params)
+      expect(record).to be_kind_of TestResource
+      expect(record.string).to eql "1"
+    end
+  end
+
+  describe "#destroy" do
+    it "issues a delete request" do
+      session.should_receive(:delete)
+      subject.destroy(1)
+    end
+  end
+
+end

data/spec/api/findable_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe ClioClient::Api::Findable do
+  let(:session) { double("ClioClient::Api::Session") }
+  subject { 
+    d = DummyEndpoint.new(session)
+    d.extend(ClioClient::Api::Findable)
+    d
+  }
+
+  describe "#find" do
+    let(:response) do
+      { "dummy" => { "id" => 1 }}
+    end
+    
+    it "should return the correct data item" do
+      session.stub(:get).and_return(response)
+      dummy = subject.find(1)
+      expect(dummy).to be_kind_of TestResource
+      expect(dummy.id).to eql 1
+    end
+
+  end
+
+end

data/spec/api/listable_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe ClioClient::Api::Listable do
+  let(:session) { double("ClioClient::Api::Session") }
+  subject { 
+    d = DummyEndpoint.new(session)
+    d.extend(ClioClient::Api::Listable)
+    d
+  }
+
+  describe "#find" do
+    let(:response) do
+      { "dummies" => [{ id: 1 }, { id: 2} ]}
+    end
+    
+    it "should return the correct data items" do
+      session.stub(:get).and_return(response)
+      records = subject.list
+      expect(records.count).to eql 2
+      expect(records.first).to be_kind_of TestResource
+      expect(records.first.id).to eql 1
+      expect(records.last.id).to eql 2
+    end
+
+  end
+
+end

data/spec/features/activities_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe ClioClient::Api::Activity, :external => true do
+
+  let(:session) { ClioClient::Session.new(:access_token => ENV['ACCESS_TOKEN']) }
+  let(:api) { session.activities }
+  
+  let(:params) do
+    {
+      type: "TimeEntry",
+      quantity: 3600,
+      price: 10.0,
+      date: '2013-01-01'
+    }
+  end
+
+  let(:changed_field) { :note }
+  let(:changed_value) { "Magic Value" }
+
+  it "is crudable" do
+    item = api.create(params)    
+    stored_item = api.find(item.id)
+    expect(item).to eql stored_item
+
+    item = api.update(item.id, {changed_field => changed_value})
+    expect(item[changed_field]).to eql changed_value
+
+    api.destroy(item.id)
+    
+    expect(api.find(item.id)).to be_nil
+  end
+
+  
+
+end

data/spec/models/account_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe ClioClient::Account do
+
+  context "owner association" do
+    let(:attribute) { :owner }
+    let(:klass) { ClioClient::User }    
+    include_examples "association"
+  end
+
+
+end

data/spec/models/activity_description_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe ClioClient::ActivityDescription do
+
+  context "when initialized with the example attributes" do
+    let(:params) do
+      {
+        "id" => "1",
+        "name" => "Phone Call",
+        "created_at" => "2013-12-03T23:35:36+00:00",
+        "updated_at" => "2013-12-03T23:35:36+00:00",
+        "activity_rate_default" => nil,
+        "rates" => [
+                  {
+                    "user_id" => "1",
+                    "rate" => "700.0",
+                    "source" => "user",
+                    "flat_rate" => "false"
+                  },
+                  {
+                    "user_id" => "2",
+                    "rate" => "650.0",
+                    "source" => "user",
+                    "flat_rate" => "false"
+                  },
+                  {
+                    "user_id" => "3",
+                    "rate" => "600.0",
+                    "source" => "user",
+                    "flat_rate" => "false"
+                  }
+                 ]
+      }
+      
+    end
+    include_examples "model initialization"
+    
+  end
+
+  context "rates association" do
+    let(:association_params) { {"name" => nil, "rate" => 1.0, "source" => "a" }}
+    let(:attribute) { :rates }
+    let(:klass) { ClioClient::Rate }    
+    include_examples "has many association"
+  end
+
+end

data/spec/models/activity_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe ClioClient::Activity do
+
+  context "user association" do
+    let(:attribute) { :user }
+    let(:klass) { ClioClient::User }    
+    include_examples "association"
+  end
+
+  context "matter association" do
+    let(:attribute) { :matter }
+    let(:klass) { ClioClient::Matter }    
+    include_examples "association"
+  end
+
+  context "activity description association" do
+    let(:attribute) { :activity_description }
+    let(:klass) { ClioClient::ActivityDescription }
+    include_examples "association"
+  end
+
+  context "communication association" do
+    let(:attribute) { :communication }
+    let(:klass) { ClioClient::Communication }
+    include_examples "association"
+  end
+
+end

data/spec/models/bill_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe ClioClient::Bill do
+
+  context "when initialized with the example attributes" do
+    let(:params) do
+    {
+      "id" => "1",
+      "pdf_url" => "/api/v2/bills/1.pdf",
+      "number" => "1148",
+      "subject" => nil,
+      "currency" => "USD",
+      "purchase_order" => nil,
+      "memo" => nil,
+      "start_at" => nil,
+      "end_at" => nil,
+      "issued_at" => "2013-07-27",
+      "due_at" => "2013-08-26",
+      "type" => "Bill",
+      "original_bill_id" => nil,
+      "tax_rate" => "0.0",
+      "secondary_tax_rate" => "0.0",
+      "discount" => "0.0",
+      "discount_type" => nil,
+      "discount_note" => nil,
+      "balance" => "1075.0",
+      "total" => "1075.0",
+      "status" => "Past Due",
+      "matters" => [
+        {
+          "id" => "5",
+          "url" => "/api/v2/matters/5",
+          "name" => "00005-Marvin, Rohan and Block"
+        }
+      ],
+      "client" => {
+        "id" => "1",
+        "url" => "/api/v2/contacts/1",
+        "name" => "Pacocha-Bode"
+      },
+      "created_at" => "2013-12-03T23:35:39+00:00",
+      "updated_at" => "2013-12-03T23:35:41+00:00"
+    }
+
+    end
+    include_examples "model initialization"
+    
+  end
+
+  context "client association" do
+    let(:attribute) { :client }
+    let(:klass) { ClioClient::Contact }    
+    include_examples "association"
+  end
+
+
+  context "matters association" do
+    let(:attribute) { :matters }
+    let(:klass) { ClioClient::Matter }
+    include_examples "has many association"
+  end
+
+end

data/spec/models/calendar_entry_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe ClioClient::CalendarEntry do
+
+  context "when initialized with the example attributes" do
+    let(:params) do
+      {
+        "id" => "5",
+        "recurrence_rule" => nil,
+        "parent_calendar_entry_id" => nil,
+        "created_at" => "2013-12-03T23:35:34+00:00",
+        "updated_at" => "2013-12-03T23:35:34+00:00",
+        "calendar" => {
+          "id" => "1",
+          "url" => "/api/v2/calendars/1",
+          "name" => "Firm"
+        },
+        "attending_calendars" => [
+
+                               ],
+        "start_date" => "2014-03-05",
+        "end_date" => "2014-03-06",
+        "original_event_start_date" => nil,
+        "permission" => "owner",
+        "summary" => "Tenetur adipisci dolorem unde suscipit at qui nam.",
+        "description" => "Aut laborum nihil. Necessitatibus quae voluptatem quia velit et. Illo asperiores et. Nostrum deserunt veritatis qui hic ut.",
+        "location" => nil,
+        "matter" => nil,
+        "reminders" => [
+
+                     ]
+      }
+    end
+    include_examples "model initialization"
+
+  end
+
+
+  context "matter association" do
+    let(:attribute) { :matter }
+    let(:klass) { ClioClient::Matter }    
+    include_examples "association"
+  end
+  context "matter association" do
+    let(:attribute) { :calendar }
+    let(:klass) { ClioClient::Calendar }    
+    include_examples "association"
+  end
+  context "matter association" do
+    let(:attribute) { :attending_calendars }
+    let(:klass) { ClioClient::Calendar }    
+    include_examples "has many association"
+  end
+  context "matter association" do
+    let(:attribute) { :reminders }
+    let(:klass) { ClioClient::Reminder }
+    let(:association_params) { {"id" => nil, "name" => nil, "minutes" => 1, "method" => "popup" }}
+    include_examples "has many association"
+  end
+
+
+end

data/spec/models/calendar_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe ClioClient::Calendar do
+  context "when initialized with the example attributes" do
+    let(:params) do
+      {
+        "id" => "1",
+        "name" => "Firm",
+        "type" => "AccountCalendar",
+        "created_at" => "2013-12-03T23:35:26+00:00",
+        "updated_at" => "2013-12-03T23:35:36+00:00",
+        "permission" => "owner",
+        "color" => "#da6666"
+      }
+    end
+
+    include_examples "model initialization"
+
+  end
+end

data/spec/models/communication_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe ClioClient::Communication do
+
+  context "matter association" do
+    let(:attribute) { :matter }
+    let(:klass) { ClioClient::Matter }    
+    include_examples "association"
+  end
+
+  context "senders association with a contact" do
+    let(:attribute) { :senders }
+    let(:klass) { ClioClient::Contact }    
+    let(:association_params) { {"type" => "Contact" }}
+    include_examples "has many association"
+  end
+
+  context "senders association with a user" do
+    let(:attribute) { :senders }
+    let(:klass) { ClioClient::User }
+    let(:association_params) { {"type" => "User" }}
+    include_examples "has many association"
+  end
+
+  context "receivers association with a contact" do
+    let(:attribute) { :receivers }
+    let(:klass) { ClioClient::Contact }    
+    let(:association_params) { {"type" => "Contact" }}
+    include_examples "has many association"
+  end
+
+  context "receivers association with a user" do
+    let(:attribute) { :receivers }
+    let(:klass) { ClioClient::User }
+    let(:association_params) { {"type" => "User" }}
+    include_examples "has many association"
+  end
+
+end

data/spec/models/company_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe ClioClient::Company do
+
+end

data/spec/models/contact_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe ClioClient::Contact do
+
+end

data/spec/models/custom_field_set_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe ClioClient::CustomFieldSet do
+
+end

data/spec/models/custom_field_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe ClioClient::CustomField do
+
+end

data/spec/models/document_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe ClioClient::Document do
+
+end

data/spec/models/document_version_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe ClioClient::DocumentVersion do
+
+
+end

data/spec/models/email_communication_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe ClioClient::EmailCommunication do
+
+
+end

data/spec/models/expense_entry_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe ClioClient::ExpenseEntry do
+
+end