clio_client 0.0.1

data/lib/clio_client/models/group.rb

@@ -0,0 +1,18 @@
+module ClioClient
+  class Group < Resource
+
+    set_attributes(id:            {type: :int, readonly: true},
+                   created_at:    {type: :datetime, readonly: true},
+                   updated_at:    {type: :datetime, readonly: true},
+                   name:          {type: :string},
+                   )
+
+    has_many_association :users, ClioClient::User
+
+    private
+    def api
+      session.groups
+    end
+      
+  end
+end

data/lib/clio_client/models/matter.rb

@@ -0,0 +1,45 @@
+module ClioClient
+
+  class Matter < Resource
+    
+    set_attributes(id:                    {type: :int, readonly: true},
+                   created_at:            {type: :datetime, readonly: true},
+                   updated_at:            {type: :datetime, readonly: true},
+                   display_number:        {type: :string },
+                   status:                {type: :string, required: true},
+                   description:           {type: :string, required: true},
+                   client_reference:      {type: :string},
+                   location:              {type: :string},
+                   pending_date:          {type: :date},
+                   open_date:             {type: :date},
+                   close_date:            {type: :date},
+                   billable:              {type: :boolean},
+                   maildrop_address:      {type: :int, readonly: true},
+                   )
+
+    alias_method :name, :display_number
+    alias_method :name=, :display_number=
+
+    has_association(:client,            ClioClient::Contact, 
+                    :polymorphic => true, :accepted_types => %w(Person Company))
+    has_association :responsible_attorney, ClioClient::User
+    has_association :practice_area,        ClioClient::PracticeArea
+    has_many_association(:custom_field_values, ClioClient::CustomFieldValue, 
+        :polymorphic => true, 
+        :accepted_types => %w(CustomFieldCheckboxValue CustomFieldContactValue 
+        CustomFieldCurrencyValue CustomFieldDateValue CustomFieldTimeValue 
+        CustomFieldEmailValue CustomFieldMatterValue CustomFieldNumericValue 
+        CustomFieldPicklistValue CustomFieldTextAreaValue 
+        CustomFieldTextLineValue CustomFieldUrlValue))
+
+    has_association(:permission, ClioClient::Resource, 
+                    :polymorphic => true, 
+                    :accepted_types => %w(Group User))
+
+    has_many_association :activity_rates,      ClioClient::Rate
+    has_association :flat_rate_activity,       ClioClient::Rate
+    has_association :flat_rate_activity_description, ClioClient::ActivityDescription
+
+  end
+
+end

data/lib/clio_client/models/note.rb

@@ -0,0 +1,23 @@
+module ClioClient
+  
+  class Note < Resource
+    
+    set_attributes(id:                      {type: :int, readonly: true},
+                   created_at:              {type: :datetime, readonly: true},
+                   updated_at:              {type: :datetime, readonly: true},
+                   subject:                 {type: :string},
+                   detail:                  {type: :string},
+                   date:                    {type: :date}
+                   )
+
+    has_association(:regarding,            ClioClient::Resource, 
+                    :polymorphic => true, :accepted_types => %w(Contact Matter))
+
+    private
+    def api
+      session.notes
+    end
+
+  end
+
+end

data/lib/clio_client/models/person.rb

@@ -0,0 +1,9 @@
+module ClioClient
+  class Person < Contact
+
+    def type; 'Person'; end
+
+    has_association :company, ClioClient::Company
+
+  end
+end

data/lib/clio_client/models/phone_communication.rb

@@ -0,0 +1,8 @@
+module ClioClient
+  
+  class PhoneCommunication < Communication
+
+    def type; 'PhoneCommunication'; end
+
+  end
+end

data/lib/clio_client/models/practice_area.rb

@@ -0,0 +1,18 @@
+module ClioClient
+  
+  class PracticeArea < Resource
+    
+    set_attributes(id:                      {type: :int, readonly: true},
+                   created_at:              {type: :datetime, readonly: true},
+                   updated_at:              {type: :datetime, readonly: true},
+                   name:                    {type: :string}
+                   )
+
+    private
+    def api
+      session.practice_areas
+    end
+
+  end
+
+end

data/lib/clio_client/models/relationship.rb

@@ -0,0 +1,19 @@
+module ClioClient
+  class Relationship < Resource
+
+    set_attributes(id:            {type: :int, readonly: true},
+                   created_at:    {type: :datetime, readonly: true},
+                   updated_at:    {type: :datetime, readonly: true},
+                   description:   {type: :string},
+                   )
+
+    has_association :contact, ClioClient::Contact
+    has_association :matter, ClioClient::Matter
+
+    private
+    def api
+      session.relationships
+    end
+      
+  end
+end

data/lib/clio_client/models/task.rb

@@ -0,0 +1,29 @@
+module ClioClient
+  class Task < Resource
+
+    set_attributes(id:            {type: :int, readonly: true},
+                   created_at:    {type: :datetime, readonly: true},
+                   updated_at:    {type: :datetime, readonly: true},
+                   name:          {type: :string},
+                   description:   {type: :string},
+                   priority:      {type: :string},
+                   due_at:        {type: :date},
+                   complete:      {type: :boolean},
+                   complete_at:   {type: :date},
+                   is_private:    {type: :boolean},
+                   is_statute_of_limitations:   {type: :boolean}
+                   )
+
+    has_association :user, ClioClient::User
+    has_association :assigner, ClioClient::User
+    has_association :matter, ClioClient::Matter
+    has_many_association :reminders, ClioClient::Reminder
+    
+
+    private
+    def api
+      session.tasks
+    end
+      
+  end
+end

data/lib/clio_client/models/time_entry.rb

@@ -0,0 +1,9 @@
+module ClioClient
+    
+  class TimeEntry < Activity
+
+    def type; 'TimeEntry'; end
+
+  end
+
+end

data/lib/clio_client/models/timeline_event.rb

@@ -0,0 +1,25 @@
+module ClioClient
+  class TimelineEvent < Resource
+
+    set_attributes(id:            {type: :int, readonly: true},
+                   created_at:    {type: :datetime, readonly: true},
+                   updated_at:    {type: :datetime, readonly: true},
+                   event_type:    {type: :string},
+                   old_subject_name:   {type: :string},
+                   subject:       {type: :hash}
+                   )
+
+    has_association(:actor, ClioClient::Resource, 
+                    :polymorphic => true, 
+                    :accepted_types => %w(Contact User))
+
+    has_association :matter, ClioClient::Matter
+    
+
+    private
+    def api
+      session.timeline_events
+    end
+      
+  end
+end

data/lib/clio_client/models/timer.rb

@@ -0,0 +1,28 @@
+module ClioClient
+
+  class Timer < Resource
+    
+    set_attributes(id:                {type: :int, readonly: true},
+                   created_at:        {type: :datetime, readonly: true},
+                   updated_at:        {type: :datetime, readonly: true},
+                   start_time:        {type: :datetime},
+                   )
+
+    has_association :activity, ClioClient::TimeEntry
+
+    def start
+      api.start({activity_id: self.to_params[(:activity_id)]})
+    end
+
+    def stop
+      api.stop
+    end
+
+    private
+    def api
+      session.timer
+    end
+
+  end
+
+end

data/lib/clio_client/models/user.rb

@@ -0,0 +1,28 @@
+module ClioClient
+
+  class User < Resource
+    
+    set_attributes(id:                {type: :int, readonly: true},
+                   created_at:        {type: :datetime, readonly: true},
+                   updated_at:        {type: :datetime, readonly: true},
+                   subscription_plan: {type: :string, readonly: true},
+                   time_zone:         {type: :string, readonly: true},
+                   first_name:        {type: :string, readonly: true},
+                   last_name:         {type: :string, readonly: true}, 
+                   email:             {type: :string, readonly: true},
+                   enabled:           {type: :boolean, readonly: true},
+                   name:              {type: :string, readonly: true}
+                   )
+
+    def avatar
+      api.avatar(id)
+    end
+
+    private
+    def api
+      session.users
+    end
+
+  end
+
+end

data/lib/clio_client/resource.rb

@@ -0,0 +1,183 @@
+module ClioClient
+
+  class ResourceNotSaved < Exception; end
+  class AttributeReadOnly < Exception; end
+
+  class Resource
+
+    attr_accessor :session
+
+    def self.inspect
+      attr_list = attributes.inject([]) do |a, (attr, opts)|
+        a << "#{attr}: #{opts[:type]}"
+      end * ", "
+      "#{super}(#{attr_list})"
+    end
+    
+    def inspect
+      attr_list = self.class.attributes.inject([]) do |a, (attr, opts)|
+        if has_attribute?(attr)
+          a << "#{attr}: #{self[attr].inspect}"
+        else
+          a
+        end
+      end * ", "      
+      "#<#{self.class} #{attr_list}>"
+    end
+
+    def initialize(values = {}, session = nil)
+      self.session = session
+      values.each_pair do |k, v|
+        self.send("#{k}=", v) if respond_to?("#{k}=") && !v.nil?
+      end
+    end
+
+    def to_params
+      self.class.attributes.inject({}) do |h, (attr, opts)|
+        has_attribute?(attr) ? h.merge(attr => paramify(self[attr])) : h
+      end
+    end
+
+
+
+    class << self
+
+
+      attr_accessor :attributes
+      def set_attributes(attrs)
+        self.attributes = attrs
+        attrs.each_pair do |name, options|
+          attr_reader name
+          define_method "#{name}=" do |value|
+            if options[:readonly] && !instance_variable_get("@#{name}").nil?
+              raise AttributeReadOnly 
+            end
+            write_attribute("#{name}", convert_attribute(value, options))
+          end
+        end
+      end
+      
+      def inherited(subclass)
+        if !self.attributes.nil?
+          subclass.attributes = self.attributes
+        end
+      end
+
+      def has_association(name, klass, options = {})
+        attr_accessor "#{name}_id"
+        attr_reader name
+        self.attributes["#{name}_id".intern] = {type: :foreign_key}
+        define_method "#{name}=" do |attributes|
+          write_attribute("#{name}_id", attributes["id"])
+          if options[:polymorphic]
+            obj = polymorphic_object(attributes, options[:accepted_types])
+          else
+            obj = klass.new(attributes, session)
+          end
+          write_attribute("#{name}", obj)
+        end      
+      end
+
+      def has_many_association(name, klass, options = {})
+        attr_reader name
+        self.attributes[name.intern] = {type: :has_many_association}
+        define_method "#{name}=" do |arr|
+          many = arr.collect do |attributes| 
+            if options[:polymorphic]
+              polymorphic_object(attributes, options[:accepted_types])
+            else
+              klass.new(attributes, session)
+            end
+          end
+          write_attribute(name, many)
+        end      
+      end
+      
+    end
+      
+    def ==(o)
+      self.class == o.class && !self.id.nil? && self.id != "" && self.id == o.id
+    end
+    alias_method :eql?, :==
+
+    def [](val)
+      self.send(val)
+    end
+
+
+    def save
+      if self.id.nil?
+        saved_item = api.create(self.to_params)
+        self.id = saved_item && saved_item.id
+        self
+      else
+        api.update(self.id, self.to_params)
+        self
+      end
+    end
+
+    def reload
+      raise ResourceNotSaved if self.id.nil?      
+      api.find(self.id)
+    end
+
+    def destroy
+      raise ResourceNotSaved if self.id.nil?
+      api.destroy(self.id)
+    end
+
+    private
+    def polymorphic_object(attributes, accepted_types)
+      if accepted_types.include? attributes["type"]
+        klass = ClioClient.const_get attributes["type"].intern
+        klass.new(attributes, session)
+      end
+    end
+
+    def write_attribute(name, value)
+      instance_variable_set("@#{name}", value)
+    end
+
+    def api
+      raise NotImplementedError
+    end
+
+    def has_attribute?(attr)
+      instance_variable_defined?("@#{attr}")
+    end
+
+    def paramify(val)      
+      if val.kind_of? ClioClient::Resource
+        val.to_params
+      elsif val.kind_of? Array
+        val.collect{|v| paramify(v) }
+      else
+        val
+      end
+    end
+
+    def convert_attribute(val, options)
+      case options[:type]
+      when :int
+        val.to_i
+      when :string
+        val.to_s
+      when :date
+        val.kind_of?(Date) ? val : Date.parse(val)
+      when :decimal
+        val.to_f
+      when :boolean 
+        val == "true"
+      when :datetime 
+        val.kind_of?(DateTime) ? val : DateTime.parse(val)
+      when :datetime 
+        val.kind_of?(Time) ? val : Time.parse(val)
+      when :foreign_key 
+        (val == "" || val.nil?) ? nil : val.to_i
+      else 
+        val
+      end
+    end
+
+  end
+end

data/lib/clio_client/session.rb

@@ -0,0 +1,56 @@
+module ClioClient
+
+  class Session
+
+    include Http
+    include Authorization
+
+    attr_accessor :access_token, :client_id, :client_secret
+    attr_accessor :end_points
+
+    def initialize(credentials = {})
+      self.access_token = credentials[:access_token]
+      self.client_id = credentials[:client_id]
+      self.client_secret = credentials[:client_secret]
+      self.end_points = {}
+    end
+
+    { activities:            ClioClient::Api::Activity,
+      activity_descriptions: ClioClient::Api::ActivityDescription,
+      bills:                 ClioClient::Api::Bill,
+      calendar_entries:      ClioClient::Api::CalendarEntry,
+      calendars:             ClioClient::Api::Calendar,
+      communications:        ClioClient::Api::Communication,
+      contacts:              ClioClient::Api::Contact,
+      custom_field_sets:     ClioClient::Api::CustomFieldSet,
+      custom_fields:         ClioClient::Api::CustomField,
+      document_versions:     ClioClient::Api::DocumentVersion,
+      documents:             ClioClient::Api::Document,
+      groups:                ClioClient::Api::Group,
+      matters:               ClioClient::Api::Matter,
+      notes:                 ClioClient::Api::Note,
+      practice_areas:        ClioClient::Api::PracticeArea,
+      relationships:         ClioClient::Api::Relationship,
+      tasks:                 ClioClient::Api::Task,
+      timeline_events:       ClioClient::Api::TimelineEvent,
+      timer:                 ClioClient::Api::Timer,
+      users:                 ClioClient::Api::User
+    }.each_pair do |method, klass| 
+      define_method method do
+        end_points[method] ||= klass.new(self)
+      end
+    end    
+
+    def document_versions(document_id)
+      end_points[:document_versions] ||= {}
+      unless end_points[:document_versions][document_id]
+        e = ClioClient::Api::DocumentVersion.new(self)
+        e.document_id = document_id
+        end_points[:document_versions][document_id] = e
+      end
+      end_points[:document_versions][document_id]
+    end
+
+  end
+
+end

data/lib/clio_client/support/address.rb

@@ -0,0 +1,16 @@
+module ClioClient
+  class Address < Resource
+
+    set_attributes(id:                      {type: :int, readonly: true},
+                   created_at:              {type: :datetime, readonly: true},
+                   updated_at:              {type: :datetime, readonly: true},
+                   name:                    {type: :string},
+                   street:                  {type: :string},
+                   city:                    {type: :string},
+                   province:                {type: :string},
+                   postal_code:             {type: :string},
+                   country:                 {type: :string}
+                   )
+
+  end
+end

data/lib/clio_client/support/custom_field_checkbox_value.rb

@@ -0,0 +1,7 @@
+module ClioClient
+  class CustomFieldCheckboxValue < CustomFieldValue
+
+    self.attributes[:value] = {type: :boolean}
+
+  end
+end

data/lib/clio_client/support/custom_field_contact_value.rb

@@ -0,0 +1,10 @@
+module ClioClient
+  class CustomFieldContactValue < CustomFieldValue
+
+    self.attributes[:value] = {type: :int}
+    
+    has_association(:contact, ClioClient::Contact, :polymorphc => true, 
+                    :accepted_types => %w(Person Company))
+
+  end
+end

data/lib/clio_client/support/custom_field_currency_value.rb

@@ -0,0 +1,7 @@
+module ClioClient
+  class CustomFieldCurrencyValue < CustomFieldValue
+
+    self.attributes[:value] = {type: :decimal}
+    
+  end
+end

data/lib/clio_client/support/custom_field_date_value.rb

@@ -0,0 +1,7 @@
+module ClioClient
+  class CustomFieldDateValue < CustomFieldValue
+
+    self.attributes[:value] = {type: :date}
+    
+  end
+end

data/lib/clio_client/support/custom_field_email_value.rb

@@ -0,0 +1,7 @@
+module ClioClient
+  class CustomFieldEmailValue < CustomFieldValue
+
+    self.attributes[:value] = {type: :string}
+    
+  end
+end

data/lib/clio_client/support/custom_field_matter_value.rb

@@ -0,0 +1,9 @@
+module ClioClient
+  class CustomFieldMatterValue < CustomFieldValue
+
+    self.attributes[:value] = {type: :int}
+
+    has_association :matter, ClioClient::Matter
+    
+  end
+end

data/lib/clio_client/support/custom_field_numeric_value.rb

@@ -0,0 +1,7 @@
+module ClioClient
+  class CustomFieldNumericValue < CustomFieldValue
+
+    self.attributes[:value] = {type: :decimal}
+
+  end
+end

data/lib/clio_client/support/custom_field_picklist_option.rb

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

data/lib/clio_client/support/custom_field_picklist_value.rb

@@ -0,0 +1,9 @@
+module ClioClient
+  class CustomFieldPicklistValue < CustomFieldValue
+
+    self.attributes[:value] = {type: :int}
+
+    has_association :custom_field_picklist_option, ClioClient::CustomFieldPicklistOption
+
+  end
+end

data/lib/clio_client/support/custom_field_text_area_value.rb

@@ -0,0 +1,7 @@
+module ClioClient
+  class CustomFieldTextAreaValue < CustomFieldValue
+
+    self.attributes[:value] = {type: :string}
+
+  end
+end

data/lib/clio_client/support/custom_field_text_line_value.rb

@@ -0,0 +1,7 @@
+module ClioClient
+  class CustomFieldTextLineValue < CustomFieldValue
+
+    self.attributes[:value] = {type: :string}
+
+  end
+end

data/lib/clio_client/support/custom_field_time_value.rb

@@ -0,0 +1,7 @@
+module ClioClient
+  class CustomFieldTimeValue < CustomFieldValue
+
+    self.attributes[:value] = {type: :time}
+    
+  end
+end

data/lib/clio_client/support/custom_field_url_value.rb

@@ -0,0 +1,7 @@
+module ClioClient
+  class CustomFieldUrlValue < CustomFieldValue
+
+    self.attributes[:value] = {type: :string}
+
+  end
+end

data/lib/clio_client/support/custom_field_value.rb

@@ -0,0 +1,13 @@
+module ClioClient
+
+  class CustomFieldValue < Resource
+
+    set_attributes(id:                      {type: :int, readonly: true},
+                   type:                    {type: :string},
+                   created_at:              {type: :datetime, readonly: true},
+                   updated_at:              {type: :datetime, readonly: true},
+                   value:                   {type: :variable}
+                   )
+
+  end
+end