clio_client 0.0.1

data/lib/clio_client/api/practice_area.rb

@@ -0,0 +1,22 @@
+module ClioClient
+  module Api
+    class PracticeArea < Base
+
+      include ClioClient::Api::Listable
+      include ClioClient::Api::Findable
+      include ClioClient::Api::Crudable
+
+
+      private
+
+      def data_klass(*args)
+        ClioClient::PracticeArea
+      end
+
+      def end_point_url;     'practice_areas';  end
+      def plural_resource;   'practice_areas';  end
+      def singular_resource; 'practice_area';   end
+
+    end
+  end
+end

data/lib/clio_client/api/relationship.rb

@@ -0,0 +1,22 @@
+module ClioClient
+  module Api
+    class Relationship < Base
+
+      include ClioClient::Api::Listable
+      include ClioClient::Api::Findable
+      include ClioClient::Api::Crudable
+
+
+      private
+
+      def data_klass(*args)
+        ClioClient::Relationship
+      end
+
+      def end_point_url;     'relationships';  end
+      def plural_resource;   'relationships';  end
+      def singular_resource; 'relationship';   end
+
+    end
+  end
+end

data/lib/clio_client/api/task.rb

@@ -0,0 +1,22 @@
+module ClioClient
+  module Api
+    class Task < Base
+
+      include ClioClient::Api::Listable
+      include ClioClient::Api::Findable
+      include ClioClient::Api::Crudable
+
+
+      private
+
+      def data_klass(*args)
+        ClioClient::Task
+      end
+
+      def end_point_url;     'tasks';  end
+      def plural_resource;   'tasks';  end
+      def singular_resource; 'task';   end
+
+    end
+  end
+end

data/lib/clio_client/api/timeline_event.rb

@@ -0,0 +1,19 @@
+module ClioClient
+  module Api
+    class TimelineEvent < Base
+
+      include ClioClient::Api::Listable
+
+      private
+
+      def data_klass(*args)
+        ClioClient::TimelineEvent
+      end
+
+      def end_point_url;     'timeline_events';  end
+      def plural_resource;   'timeline_events';  end
+      def singular_resource; 'timeline_event';   end
+
+    end
+  end
+end

data/lib/clio_client/api/timer.rb

@@ -0,0 +1,31 @@
+module ClioClient
+  module Api
+    class Timer < Base
+
+      def find
+        response = session.get("#{end_point_url}")
+        data_item(response[singular_resource])
+      end
+
+      def start(params = {})
+        response = session.post(end_point_url, {singular_resource => params}.to_json)
+        data_item(response[singular_resource])        
+      end
+
+      def stop
+        session.delete("#{end_point_url}", false)
+      end
+
+      private
+
+      def data_klass(*args)
+        ClioClient::Timer
+      end
+
+      def end_point_url;     'timer';  end
+      def plural_resource;   'timer';  end
+      def singular_resource; 'timer';   end
+
+    end
+  end
+end

data/lib/clio_client/api/user.rb

@@ -0,0 +1,31 @@
+module ClioClient
+  module Api
+    class User < Base
+
+      include ClioClient::Api::Listable
+      include ClioClient::Api::Findable
+
+      def avatar(id)
+        session.get("#{end_point_url}/#{id}/avatar")
+      end
+
+      def who_am_i
+        resp = session.get("#{end_point_url}/who_am_i")
+        [ClioClient::Account.new(resp["account"], session), 
+         ClioClient::User.new(resp["user"], session)]
+      end
+      
+
+      private
+
+      def data_klass(*args)
+        ClioClient::User
+      end
+
+      def end_point_url;     'users';  end
+      def plural_resource;   'users';  end
+      def singular_resource; 'user';   end
+
+    end
+  end
+end

data/lib/clio_client/authorization.rb

@@ -0,0 +1,41 @@
+module ClioClient
+
+  module Authorization
+
+
+    def authorize_url(redirect_uri, state = nil)
+      params = { response_type: :code, 
+        client_id: self.client_id,
+        redirect_uri: redirect_uri
+      }
+      params[:state] = state if state
+      base_uri("/oauth/authorize", params).to_s
+    end
+
+    def authorize_with_code(redirect_uri, code)
+      params = { code: code,
+        grant_type: "authorization_code",
+        client_id: self.client_id,
+        client_secret: self.client_secret,
+        redirect_uri: redirect_uri
+      }
+      uri = base_uri("/oauth/token")
+      req = Net::HTTP::Post.new(uri.request_uri)
+      req.set_form_data params
+      credentials = make_request(req, uri)
+      self.access_token = credentials["access_token"]
+      credentials
+    end
+
+    def authorized?
+      begin
+        get("/users/who_am_i")
+        true
+      rescue ClioClient::Unauthorized
+        false
+      end
+    end
+
+    
+  end
+end

data/lib/clio_client/http.rb

@@ -0,0 +1,92 @@
+module ClioClient
+
+  class Unauthorized < Exception; end 
+  class ResourceNotFound < Exception; end
+  class BadRequest < Exception; end
+  
+  module Http
+
+    def base_uri(path, params = {})
+      uri = URI.parse("https://app.goclio.com")
+      uri.path = path
+      uri.query = URI.encode_www_form(params) if params.any?
+      uri
+    end
+
+    def get(path, params ={}, parse=true)
+      uri = base_uri("#{api_prefix}/#{path}", params)
+      req = Net::HTTP::Get.new(uri.to_s)
+      make_api_request(req, uri, parse)
+    end
+
+    def put(path, body = "", parse=true)
+      uri = base_uri("#{api_prefix}/#{path}")        
+      req = Net::HTTP::Put.new(uri.request_uri)
+      req.body = body
+      req.add_field("Content-Type", "application/json")
+      make_api_request(req, uri, parse)
+    end
+
+    def multipart_post(path, params, parse = true)
+      uri = base_uri("#{api_prefix}/#{path}")        
+      req = Net::HTTP::Post::Multipart.new(uri.request_uri, params)
+      make_api_request(req, uri, parse)
+    end
+
+    def post(path, body ="", parse = true)
+      uri = base_uri("#{api_prefix}/#{path}")        
+      req = Net::HTTP::Post.new(uri.request_uri)
+      req.body = body
+      req.add_field("Content-Type", "application/json")
+      make_api_request(req, uri, parse)
+    end
+
+    def delete(path, parse=true)
+      uri = base_uri("#{api_prefix}/#{path}")
+      req = Net::HTTP::Delete.new(uri.request_uri)
+      make_api_request(req, uri, parse)
+    end
+
+    def make_api_request(req, uri, parse = true)
+      return nil if self.access_token.nil? || self.access_token.empty?
+      req.add_field("Authorization", "Bearer #{self.access_token}")
+      make_request(req, uri, parse)
+    end
+
+    def make_request(req, uri, parse = true)
+      req.add_field("Accept", "text/json")
+      n = Net::HTTP.new(uri.host, uri.port)
+      n.use_ssl = true
+      res = n.start do |http|
+        http.request(req)
+      end
+      parse_response(res, parse)
+    end
+
+    def parse_response(res, parse)
+      if res.body !~ /^\s*$/ && !res.body.nil?
+        body = parse ? JSON.parse(res.body) : res.body
+      end
+
+      case res
+      when Net::HTTPNotFound
+        raise ClioClient::ResourceNotFound.new(body["message"])
+      when Net::HTTPSuccess
+        body
+      when Net::HTTPUnauthorized
+        raise ClioClient::Unauthorized.new(body["message"])
+      when Net::HTTPBadRequest
+        raise ClioClient::BadRequest.new(body["message"])        
+      when Net::HTTPSeeOther
+        res["Location"]
+      else
+        raise "Unknown #{res.class} response. #{body["message"]}"
+      end
+    end
+
+    private
+    def api_prefix; "/api/v2"; end
+
+  end
+  
+end

data/lib/clio_client/models/account.rb

@@ -0,0 +1,16 @@
+module ClioClient
+
+  class Account < Resource
+    
+    set_attributes(id:                {type: :int, readonly: true},
+                   created_at:        {type: :datetime, readonly: true},
+                   updated_at:        {type: :datetime, readonly: true},
+                   maildrop_address:  {type: :string},
+                   name:              {type: :string, readonly: true}
+                   )
+    
+    has_association :owner, ClioClient::User
+
+  end
+
+end

data/lib/clio_client/models/activity.rb

@@ -0,0 +1,31 @@
+module ClioClient
+
+  class Activity < Resource
+
+    set_attributes(id:           {type: :int,      readonly: true},
+                   created_at:   {type: :datetime, readonly: true}, 
+                   updated_at:   {type: :datetime, readonly: true}, 
+                   type:         {type: :string,   required: true}, 
+                   date:         {type: :date                    },
+                   quantity:     {type: :decimal,  required: true},
+                   price:        {type: :decimal,  required: true},
+                   total:        {type: :string,   readonly: true}, 
+                   note:         {type: :string                  },
+                   billed:       {type: :boolean,  readonly: true}
+                   )
+
+    
+
+    has_association :user,                 ClioClient::User
+    has_association :matter,               ClioClient::Matter
+    has_association :activity_description, ClioClient::ActivityDescription
+    has_association :communication,        ClioClient::Communication
+
+    private
+    def api
+      session.activities
+    end
+    
+  end
+
+end

data/lib/clio_client/models/activity_description.rb

@@ -0,0 +1,21 @@
+module ClioClient
+  
+  class ActivityDescription < Resource
+    
+    set_attributes(id:                      {type: :int, readonly: true},
+                   name:                    {type: :string},
+                   created_at:              {type: :datetime, readonly: true},
+                   updated_at:              {type: :datetime, readonly: true},
+                   activity_rate_default:   {type: :rate}
+                   )
+
+    has_many_association :rates,           ClioClient::Rate
+
+    private
+    def api
+      session.activity_descriptions
+    end
+
+  end
+
+end

data/lib/clio_client/models/bill.rb

@@ -0,0 +1,45 @@
+module ClioClient
+  class Bill < Resource
+    
+    set_attributes(
+                   id:                  {type: :int,      readonly: true},
+                   type:                {type: :string,   readonly: true},
+                   original_bill_id:    {type: :int,      readonly: true},
+                   created_at:          {type: :datetime, readonly: true},
+                   updated_at:          {type: :datetime, readonly: true},
+                   pdf_url:             {type: :string,   readonly: true},
+                   number:              {type: :string                  },
+                   subject:             {type: :string                  },
+                   currency:            {type: :string                  },
+                   purchase_order:      {type: :string                  },
+                   memo:                {type: :string                  },
+                   start_at:            {type: :datetime                },
+                   end_at:              {type: :datetime                },
+                   issued_at:           {type: :date                    },
+                   due_at:              {type: :date                    },
+                   tax_rate:            {type: :decimal                 },
+                   secondary_tax_rate:  {type: :decimal                 },
+                   discount:            {type: :decimal                 },
+                   discount_type:       {type: :string                  },
+                   discount_note:       {type: :note                    },
+                   balance:             {type: :decimal                 },
+                   total:               {type: :decimal                 },
+                   status:              {type: :string, readonly: true  },
+                   )
+
+    has_association :client,            ClioClient::Contact
+    has_many_association :matters,           ClioClient::Matter
+
+    def pdf
+      unless self.id.nil?
+        api.download(self.id)
+      end
+    end
+
+    private
+    def api
+      session.bills
+    end
+
+  end
+end

data/lib/clio_client/models/calendar.rb

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

data/lib/clio_client/models/calendar_entry.rb

@@ -0,0 +1,32 @@
+module ClioClient
+  class CalendarEntry < Resource
+    
+    set_attributes(
+                   id:                       {type: :int,      readonly: true},
+                   created_at:               {type: :datetime, readonly: true},
+                   updated_at:               {type: :datetime, readonly: true},
+                   start_date_time:          {type: :datetime                },
+                   end_date_time:            {type: :datetime                },
+                   start_date:               {type: :date,     readonly: true},
+                   end_date:                 {type: :date                    },
+                   summary:                  {type: :string                  },
+                   description:              {type: :string                  },
+                   location:                 {type: :string                  },
+                   permission:               {type: :string,   readonly: true},
+                   recurrence_rule:          {type: :string                  },
+                   parent_calendar_entry_id: {type: :int                     },
+                   original_event_start_date: {type: :datetime                },
+                   )
+
+    has_association      :matter,              ClioClient::Matter
+    has_association      :calendar,            ClioClient::Calendar
+    has_many_association :attending_calendars, ClioClient::Calendar
+    has_many_association :reminders,           ClioClient::Reminder
+
+    private
+    def api
+      session.calendar_entries
+    end
+
+  end
+end

data/lib/clio_client/models/communication.rb

@@ -0,0 +1,34 @@
+module ClioClient
+  
+  class Communication < Resource
+
+    set_attributes(id:          {type: :int, readonly: true},
+                   type:        {type: :string, readonly: true},
+                   created_at:  {type: :datetime, readonly: true},
+                   updated_at:  {type: :datetime, readonly: true},
+                   subject:     {type: :string},
+                   body:        {type: :string},
+                   date:        {type: :date},
+                   )
+
+    alias_method :name, :subject
+    alias_method :name=, :subject=
+
+    has_association :matter,         ClioClient::Matter
+    has_many_association(:senders,   ClioClient::Resource, 
+                         :polymorphic => true, 
+                         :accepted_types => %w(Contact User))
+
+    has_many_association(:receivers, ClioClient::Resource, 
+                         :polymorphic => true, 
+                         :accepted_types => %w(Contact User))
+    
+    private
+    def api
+      session.communications
+    end
+      
+
+  end
+
+end

data/lib/clio_client/models/company.rb

@@ -0,0 +1,7 @@
+module ClioClient
+  class Company < Contact
+
+    def type; 'Company'; end;
+
+  end
+end

data/lib/clio_client/models/contact.rb

@@ -0,0 +1,38 @@
+module ClioClient
+  class Contact < Resource
+
+    set_attributes(id:                   {type: :int,      readonly: true},
+                   type:                 {type: :string,   readonly: true},
+                   created_at:           {type: :datetime, readonly: true},
+                   updated_at:           {type: :datetime, readonly: true},
+                   name:                 {type: :string                  },
+                   prefix:               {type: :string                  },
+                   first_name:           {type: :string                  },
+                   last_name:            {type: :string                  }, 
+                   title:                {type: :string                  }
+                   )
+
+    has_many_association :phone_numbers,       ClioClient::PhoneNumber
+    has_many_association :email_addresses,     ClioClient::EmailAddress
+    has_many_association :addresses,           ClioClient::Address
+    has_many_association :web_sites,           ClioClient::WebSite
+    has_many_association :instant_messengers,  ClioClient::InstantMessenger
+    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_many_association :activity_rates,      ClioClient::Rate
+
+
+    private
+    def api
+      session.contacts
+    end
+      
+
+
+  end
+end

data/lib/clio_client/models/custom_field.rb

@@ -0,0 +1,21 @@
+module ClioClient
+  class CustomField < Resource
+
+    set_attributes(id:          {type: :int, readonly: true},
+                   created_at:  {type: :datetime, readonly: true},
+                   updated_at:  {type: :datetime, readonly: true},
+                   name:        {type: :string},
+                   parent_type: {type: :string},
+                   field_type:  {type: :string},
+                   displayed:   {type: :boolean},
+                   )
+
+    has_many_association :custom_field_picklist_options, ClioClient::CustomFieldPicklistOption
+
+    private
+    def api
+      session.custom_fields
+    end
+      
+  end
+end

data/lib/clio_client/models/custom_field_set.rb

@@ -0,0 +1,21 @@
+module ClioClient
+  class CustomFieldSet < Resource
+
+    set_attributes(id:          {type: :int, readonly: true},
+                   created_at:  {type: :datetime, readonly: true},
+                   updated_at:  {type: :datetime, readonly: true},
+                   name:        {type: :string},
+                   parent_type: {type: :string},
+                   displayed:   {type: :boolean},
+                   )
+
+    has_many_association :members, ClioClient::CustomField
+
+
+    private
+    def api
+      session.custom_field_sets
+    end
+      
+  end
+end

data/lib/clio_client/models/document.rb

@@ -0,0 +1,33 @@
+module ClioClient
+  class Document < Resource
+
+    set_attributes(id:            {type: :int, readonly: true},
+                   created_at:    {type: :datetime, readonly: true},
+                   updated_at:    {type: :datetime, readonly: true},
+                   description:   {type: :string, readonly: true},
+                   category:      {type: :string, readonly: true},
+                   content_type:  {type: :string, readonly: true},
+                   filename:      {type: :string, readonly: true},
+                   size:          {type: :int, readonly: true},
+                   last_modified: {type: :datetime},
+                   )
+
+    has_association :matter, ClioClient::Matter
+    has_association :user,   ClioClient::User
+    has_many_association :document_versions, ClioClient::DocumentVersion
+
+    def document_versions=(arr)
+      many = arr.collect do |attributes|
+        merged_attrs = attributes.merge("document_id" => id)
+        ClioClient::DocumentVersion.new(merged_attrs, session)
+      end
+      write_attribute("document_versions", many)
+    end
+    
+    private
+    def api
+      session.documents
+    end
+      
+  end
+end

data/lib/clio_client/models/document_version.rb

@@ -0,0 +1,26 @@
+module ClioClient
+  class DocumentVersion < Resource
+
+    set_attributes(id:            {type: :int, readonly: true},
+                   document_id:   {type: :int, readonly: true},
+                   version:       {type: :int, readonly: true},
+                   created_at:    {type: :datetime, readonly: true},
+                   updated_at:    {type: :datetime, readonly: true},
+                   size:          {type: :int, readonly: true},
+                   content_type:  {type: :string, readonly: true},
+                   last_modified: {type: :datetime},
+                   filename:      {type: :string}
+                   )
+
+    def download
+      api.download(id)
+    end
+
+
+    private
+    def api
+      session.document_versions(document_id)
+    end
+      
+  end
+end

data/lib/clio_client/models/email_communication.rb

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

data/lib/clio_client/models/expense_entry.rb

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