clio_client 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*~

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clio_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kyle d'Oliveira
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,169 @@
+# ClioClient
+
+This is an API client for Clio V2.
+
+As we are all aware, the importance of API-level developments is paramount in the cloud-based software industry. Clio’s open API allows you to create valuable add-ons for your clients, and in turn, construct profitable revenue streams for your business.
+
+Please direct any inquiries to the appropriate channel:
+
+    For technical inquiries: api@goclio.com
+    For business and partnership inquiries: api.partnerships@goclio.com
+    A community driven Clio Developers Google Group also exists where you can connect and ask questions from other Clio API users. For more information visit https://groups.google.com/forum/?fromgroups=#!forum/clio-developers.
+
+We look forward to seeing your developments and creating successful relationships!
+
+More information about the API can be found at http://api-docs.goclio.com/v2/index.html
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clio_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clio_client
+
+## Usage
+
+You will need to do a few things before you can get started with Clio and the API. For convience, this information is pulled directly from Clio's API documentation at the top.
+
+
+### Create a Clio Account
+
+1. Visit http://www.goclio.com/signup/ and create an account.
+2. If you are only using your account to develop and test applications, contact api@goclio.com with your login email and we’ll set your account as a developer.
+
+### Create a Clio Application
+
+1. Login to your new Clio account at https://app.goclio.com/session/new
+2. Visit our developer portal at https://app.goclio.com/settings/developer_applications
+3. Click the Add button to create a new application. Enter details about your application here - these details will be shown to Clio users when they’re asked to authorize your application
+4. Make note of the key and the secret, as these will be used to authorize your application with Clio
+
+Now that you have the your key and secret we can begin working. The Key will correspond to `client_id` and the secret will correspond to `client_secret`
+
+To get the access token, you can use the client to generate the authorize url to redirect the user. 
+
+```
+client = ClioClient::Session.new({client_id: client_id, client_secret: client_secret})
+client.authorize_url("http://mysite.com")
+ => https://app.goclio.com/oauth/authorize?response_type=code&client_id=xxxxxxxx&redirect_uri=http%3A%2F%2Fmysite.com
+```
+Once the authorization has been granted Clio will redirect back to, in this example, `http://mysite.com` with the authorization code in a params `code`
+
+```
+client.authorize_with_code "http://mysite.com", code
+ => {"access_token"=>"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "token_type"=>"bearer"} 
+client.authorized?
+ => true
+```
+
+At this point the client is ready to use. You will need to save the `access_token` for future use. 
+
+There are many different end points you can now interact with. They all act mostly the same. 
+
+The end points available are on the ClioClient::Session
+```
+      activities
+      activity_descriptions
+      bills
+      calendar_entries
+      calendars
+      communications
+      contacts
+      custom_field_sets
+      custom_fields
+      document_versions
+      documents
+      groups
+      matters
+      notes
+      practice_areas
+      relationships
+      tasks
+      timeline_events
+      timer
+      users
+```
+
+
+
+#### For endpoints that can "Get all X" 
+
+```
+time_entry = client.activities.first(type: 'TimeEntry')
+ => #<ClioClient::TimeEntry id: 12059966, created_at: #<DateTime: 2012-04-25T16:16:31+00:00 ((2456043j,58591s,0n),+0s,2299161j)>, updated_at: #<DateTime: 2013-12-14T18:52:45+00:00 ((2456641j,67965s,0n),+0s,2299161j)>, type: "TimeEntry", date: #<Date: 2012-04-25 ((2456043j,0s,0n),+0s,2299161j)>, quantity: 3600.0, price: 10.0, total: "10.0", note: "Do something", billed: false, user_id: 344053630> 
+client.activities.list(type: 'TimeEntry').first == time_entry
+ => true
+
+```
+
+The amount of data returned is limited, so we can iterate over all of the results. The last query is saved and the next page of results can be accessed like this
+```
+time_entries = client.activities.list(type: 'TimeEntry')
+begin
+  do_stuff(time_entries)
+  time_entries = client.activities.next_page
+end while time_entries.count > 0
+```
+
+#### For endpoints that can 'Get a X' there is a `find` method
+```
+time_entry = client.activities.find(12059966)
+ => #<ClioClient::TimeEntry id: 12059966, created_at: #<DateTime: 2012-04-25T16:16:31+00:00 ((2456043j,58591s,0n),+0s,2299161j)>, updated_at: #<DateTime: 2013-12-14T18:52:45+00:00 ((2456641j,67965s,0n),+0s,2299161j)>, type: "TimeEntry", date: #<Date: 2012-04-25 ((2456043j,0s,0n),+0s,2299161j)>, quantity: 3600.0, price: 10.0, total: "10.0", note: "Do something", billed: false, user_id: 344053630> 
+```
+
+If we can find an object we can also reload an object to get the current state of the object. This is useful for association on object that return a minimum amount of information
+```
+time_entry = client.activities.find(12059966)
+time_entry.user
+ => #<ClioClient::User id: 344053630, name: "Foo Bar"> 
+
+time_entry.user.reload
+ => #<ClioClient::User id: 344053630, created_at: #<DateTime: 2012-04-25T15:33:34+00:00 ((2456043j,56014s,0n),+0s,2299161j)>, updated_at: #<DateTime: 2014-01-14T00:30:14+00:00 ((2456672j,1814s,0n),+0s,2299161j)>, subscription_plan: "Attorneys", time_zone: "Indiana (East)", first_name: "Foo", last_name: "Bar", email: "foo@bar.com", enabled: false> 
+
+```
+
+#### For endpoints that have CRUD actions
+
+We can create a new object via
+```
+time_entry = client.activities.new('type' => 'TimeEntry', 'date' => Date.today)
+ => #<ClioClient::TimeEntry type: "TimeEntry", date: #<Date: 2014-01-21 ((2456679j,0s,0n),+0s,2299161j)>> 
+```
+
+You can save it with
+```
+time_entry = client.activities.new('type' => 'TimeEntry', 'date' => Date.today)
+ => #<ClioClient::TimeEntry type: "TimeEntry", date: #<Date: 2014-01-21 ((2456679j,0s,0n),+0s,2299161j)>> 
+time_entry.save
+ => #<ClioClient::TimeEntry id: 51171062, type: "TimeEntry", date: #<Date: 2014-01-21 ((2456679j,0s,0n),+0s,2299161j)>> 
+
+```
+
+To update, you can use the same `save` method. 
+
+To destroy an object you can do
+```
+time_entry = client.activities.find(51171062)
+ => #<ClioClient::TimeEntry id: 51171062, created_at: #<DateTime: 2014-01-22T05:10:50+00:00 ((2456680j,18650s,0n),+0s,2299161j)>, updated_at: #<DateTime: 2014-01-22T05:10:50+00:00 ((2456680j,18650s,0n),+0s,2299161j)>, type: "TimeEntry", date: #<Date: 2014-01-21 ((2456679j,0s,0n),+0s,2299161j)>, quantity: 0.0, price: 0.0, total: "0.0", billed: false, user_id: 344053630> 
+time_entry.destroy
+ => nil
+```
+
+
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r clio_client.rb"
+end

data/clio_client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clio_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clio_client"
+  spec.version       = ClioClient::VERSION
+  spec.authors       = ["Kyle d'Oliveira"]
+  spec.email         = ["kyle@goclio.com"]
+  spec.description   = "Api client for Clio"
+  spec.summary       = "A simple ruby library to interact with Clio's Api"
+  spec.homepage      = "https://github.com/doliveirakn/clio_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "debugger"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "rspec"
+
+end

data/lib/clio_client/api/activity.rb

@@ -0,0 +1,23 @@
+module ClioClient
+  module Api
+    class Activity < Base
+
+      include ClioClient::Api::Crudable
+      include ClioClient::Api::Listable
+      include ClioClient::Api::Findable
+
+      private
+      def data_klass(attributes)
+        accepted_types = %w(TimeEntry ExpenseEntry)
+        if accepted_types.include? attributes["type"]
+          ClioClient.const_get attributes["type"].intern
+        end
+      end
+
+      def end_point_url;     'activities';  end
+      def plural_resource;   'activities';  end
+      def singular_resource; 'activity';    end
+
+    end
+  end
+end

data/lib/clio_client/api/activity_description.rb

@@ -0,0 +1,17 @@
+module ClioClient
+  module Api
+    class ActivityDescription < Base
+
+      include ClioClient::Api::Listable
+
+      private
+      def data_klass(*args)
+        ClioClient::ActivityDescription
+      end
+
+      def end_point_url; 'activity_descriptions'; end
+      def plural_resource; 'activity_descriptions'; end
+
+    end
+  end
+end

data/lib/clio_client/api/base.rb

@@ -0,0 +1,18 @@
+module ClioClient
+  module Api
+    class Base
+
+      attr_accessor :session
+
+      def initialize(session)
+        self.session = session
+      end
+
+      private
+      def data_item(params)
+        data_klass(params).new(params, session)
+      end
+
+    end
+  end
+end

data/lib/clio_client/api/bill.rb

@@ -0,0 +1,23 @@
+module ClioClient
+  module Api
+    class Bill < Base
+
+      include ClioClient::Api::Listable
+      include ClioClient::Api::Findable
+      
+      def download(id)        
+        session.get("#{end_point_url}/#{id}.pdf", {}, false)
+      end
+      
+      private
+      def data_klass(*args)
+        ClioClient::Bill
+      end
+
+      def end_point_url;     'bills'; end
+      def plural_resource;   'bills'; end
+      def singular_resource; 'bill';  end
+
+    end
+  end
+end

data/lib/clio_client/api/calendar.rb

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

data/lib/clio_client/api/calendar_entry.rb

@@ -0,0 +1,20 @@
+module ClioClient
+  module Api
+    class CalendarEntry < Base
+
+      include ClioClient::Api::Crudable
+      include ClioClient::Api::Listable
+      include ClioClient::Api::Findable
+      
+      private
+      def data_klass(*args)
+        ClioClient::CalendarEntry
+      end
+
+      def end_point_url;     'calendar_entries'; end
+      def plural_resource;   'calendar_entries'; end
+      def singular_resource; 'calendar_entry';  end
+
+    end
+  end
+end

data/lib/clio_client/api/communication.rb

@@ -0,0 +1,25 @@
+module ClioClient
+  module Api
+    class Communication < Base
+
+      include ClioClient::Api::Crudable
+      include ClioClient::Api::Listable
+      include ClioClient::Api::Findable
+
+      private
+      def data_klass(params)
+        if params['type'] == 'PhoneCommunication'
+          ClioClient::PhoneCommunication
+        elsif params['type'] == 'EmailCommunication'
+          ClioClient::EmailCommunication
+        end
+      end
+
+      def end_point_url;     'communications';  end
+      def plural_resource;   'communications';  end
+      def singular_resource; 'communication';    end
+
+
+    end
+  end
+end

data/lib/clio_client/api/contact.rb

@@ -0,0 +1,23 @@
+module ClioClient
+  module Api
+    class Contact < Base
+
+      include ClioClient::Api::Listable
+      include ClioClient::Api::Findable
+      include ClioClient::Api::Crudable
+
+      private
+      def data_klass(attributes)
+        accepted_types = %w(Person Company)
+        if accepted_types.include? attributes["type"]
+          ClioClient.const_get attributes["type"].intern
+        end
+      end
+
+      def end_point_url;     'contacts';  end
+      def plural_resource;   'contacts';   end
+      def singular_resource; 'contact';  end
+
+    end
+  end
+end

data/lib/clio_client/api/crudable.rb

@@ -0,0 +1,25 @@
+module ClioClient
+  module Api
+    module Crudable
+
+      def new(params = {})
+        data_item(params)
+      end
+
+      def create(params = {})
+        response = session.post(end_point_url, {singular_resource => params}.to_json)
+        data_item(response[singular_resource])        
+      end
+
+      def update(id, params = {})
+        response = session.put("#{end_point_url}/#{id}", {singular_resource => params}.to_json)
+        data_item(response[singular_resource])        
+      end
+
+      def destroy(id)
+        session.delete("#{end_point_url}/#{id}", false)
+      end
+
+    end
+  end
+end

data/lib/clio_client/api/custom_field.rb

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

data/lib/clio_client/api/custom_field_set.rb

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

data/lib/clio_client/api/document.rb

@@ -0,0 +1,20 @@
+module ClioClient
+  module Api
+    class Document < Base
+
+      include ClioClient::Api::Listable
+      include ClioClient::Api::Findable
+      include ClioClient::Api::Crudable
+
+      private
+      def data_klass(*args)
+        ClioClient::Document
+      end
+
+      def end_point_url;     'documents';  end
+      def plural_resource;   'documents';  end
+      def singular_resource; 'document';   end
+
+    end
+  end
+end

data/lib/clio_client/api/document_version.rb

@@ -0,0 +1,29 @@
+module ClioClient
+  module Api
+    class DocumentVersion < Base
+
+      attr_accessor :document_id
+
+      include ClioClient::Api::Crudable
+
+      def download(id)
+        session.get("#{end_point_url}/#{id}/download")
+      end
+
+      private
+      def data_item(params)
+        params["document_id"] = document_id
+        super(params)
+      end
+
+      def data_klass(*args)
+        ClioClient::DocumentVersion
+      end
+
+      def end_point_url;     "documents/#{document_id}/document_versions";  end
+      def plural_resource;   'document_versions';  end
+      def singular_resource; 'document_version';   end
+
+    end
+  end
+end

data/lib/clio_client/api/findable.rb

@@ -0,0 +1,16 @@
+module ClioClient
+  module Api
+    module Findable
+      
+      def find(id)
+        begin
+          response = session.get("#{end_point_url}/#{id}")
+          data_item(response[singular_resource])
+        rescue ClioClient::ResourceNotFound
+          nil
+        end
+      end
+
+    end
+  end
+end

data/lib/clio_client/api/group.rb

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

data/lib/clio_client/api/listable.rb

@@ -0,0 +1,44 @@
+module ClioClient
+  module Api
+
+    module Listable
+
+      def first(params = {})
+        params[:limit] = 1
+        list(params).first
+      end
+
+      def list(params = {})
+        response = session.get(end_point_url, params)
+        @pagination_details = {last_query: params, records: 0, next_offset: response["next_offset"], 
+          total_records: response["total_records"]
+        }
+        @pagination_details[:records] += response["records"] || 0
+        response[plural_resource].collect{ |r| data_item(r) }
+      end
+      
+      def next_page
+        if more_pages?
+          params = @pagination_details[:last_query].merge(:offset => @pagination_details[:next_offset])
+          response = session.get(end_point_url, params)
+          @pagination_details[:next_offset] = response["next_offset"]
+          @pagination_details[:records] += response["records"] || 0
+          response[plural_resource].collect{ |r| data_item(r) }
+        else
+          @pagination_details = nil
+          []
+        end
+      end
+
+      private
+      def more_pages?
+        if @pagination_details         
+          @pagination_details[:records] < @pagination_details[:total_records]
+        end
+      end
+
+
+    end
+
+  end
+end

data/lib/clio_client/api/matter.rb

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

data/lib/clio_client/api/note.rb

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