clio_client 0.0.1

data/spec/models/group_spec.rb

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

data/spec/models/matter_spec.rb

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

data/spec/models/note_spec.rb

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

data/spec/models/person_spec.rb

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

data/spec/models/phone_communication_spec.rb

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

data/spec/models/practice_area_spec.rb

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

data/spec/models/relationship_spec.rb

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

data/spec/models/resource_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe ClioClient::Resource do
+
+  subject { TestResource.new(params, session) }
+  let(:params) { {"id" => 1} }
+  let(:session) { double("ClioClient::Session") }
+  let(:api) { double("ClioClient::Api::Base") }
+  before { subject.stub(:api).and_return(api) }
+  
+  describe "an integer field" do
+    let(:params) { {"int" => "1"} }
+
+    it "is converted to an integer on creation" do
+      expect(subject.int).to be_kind_of Fixnum
+    end
+
+  end
+
+  describe "a date field" do
+    let(:params) { {"date" => "2013-12-01"} }
+
+    it "is converted to an date on creation" do
+      expect(subject.date).to be_kind_of Date
+    end
+
+  end
+
+  describe "a datetime field" do
+    let(:params) { {"datetime" => "2013-12-01 00:00:00"} }
+
+    it "is converted to an datetime on creation" do
+      expect(subject.datetime).to be_kind_of DateTime
+    end
+
+  end
+  describe "a string field" do
+    let(:params) { {"string" => "Hello"} }
+
+    it "is converted to an string on creation" do
+      expect(subject.string).to be_kind_of String
+    end
+
+  end
+
+  describe "a boolean field" do
+    let(:params) { {"boolean" => "true"} }
+
+    it "is converted to an boolean on creation" do
+      expect(subject.boolean).to be_kind_of TrueClass
+    end
+
+  end
+
+  describe ".attributes" do
+    context "for an inherited record" do
+      it "is the same as the parent class" do
+        expect(InheritedResource.attributes).to eql TestResource.attributes
+      end
+    end
+  end
+
+  describe "#save" do
+    let(:to_params) { {"special" => :params} }
+    before { subject.stub(:to_params).and_return(to_params) }
+    context "when the record is new" do
+      let(:params) { {} }
+      it "makes a create call" do
+        api.should_receive(:create).with(to_params)
+        subject.save
+      end
+    end
+    context "when the record has an id" do
+      it "makes a update call" do
+        api.should_receive(:update).with(subject.id, to_params)
+        subject.save
+      end
+    end
+
+  end
+
+  describe "#reload" do
+
+    context "when the record is not saved" do
+      let(:params) { {} }
+      it "raises an exception" do
+        expect{subject.reload}.to raise_error ClioClient::ResourceNotSaved
+      end
+    end
+    context "when the record is saved" do
+      it "should make a find call" do
+        api.should_receive(:find).with(subject.id)
+        subject.reload
+      end
+    end
+
+  end
+
+  describe "#destroy" do
+
+    context "when the record is not saved" do
+      let(:params) { {} }
+      it "raises an exception" do
+        expect{subject.destroy}.to raise_error ClioClient::ResourceNotSaved
+      end
+    end
+    context "when the record is saved" do
+      it "should make a destroy call" do
+        api.should_receive(:destroy).with(subject.id)
+        subject.destroy
+      end
+    end
+
+  end
+
+end

data/spec/models/task_spec.rb

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

data/spec/models/time_entry_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe ClioClient::TimeEntry do
+
+  context "when initialized with the example attributes" do
+    let(:params) do
+      {
+        "id" => "20",
+        "type" => "TimeEntry",
+        "user" => {
+          "id" => "1",
+          "url" => "/api/v2/users/1",
+          "name" => "Demo User"
+        },
+        "matter" => {
+          "id" => "8",
+          "url" => "/api/v2/matters/8",
+          "name" => "00008-Koch, Prosacco and Stroman"
+        },
+        "activity_description" => {
+          "id" => "4",
+          "url" => "/api/v2/activity_descriptions/4",
+          "name" => "Discovery"
+        },
+        "communication" => nil,
+        "date" => "2013-01-26",
+        "note" => "Ea sunt quo dolorum dolore corporis ipsam culpa quis.",
+        "price" => "100.0",
+        "quantity" => "19944.0",
+        "total" => "554.0",
+        "billed" => "false",
+        "created_at" => "2013-12-03T23:35:37+00:00",
+        "updated_at" => "2013-12-03T23:35:37+00:00"
+      }
+    end
+
+    include_examples "model initialization"
+
+  end
+
+end

data/spec/models/timeline_event_spec.rb

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

data/spec/models/timer_spec.rb

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

data/spec/models/user_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'clio_client'
+require 'debugger'
+
+require 'support/associated_resource'
+require 'support/test_resource'
+require 'support/inherited_resource'
+require 'support/dummy_endpoint'
+require 'support/resource_examples'
+
+require 'rspec'
+require 'rspec/core/shared_context'
+
+module CommonLetHelpers
+  extend RSpec::Core::SharedContext
+  let(:session) { double("ClioClient::Session") }
+  let(:params) { {} }
+  let(:association_params) { {} }
+  let(:model) { described_class.new(params, session) }
+end
+
+
+RSpec.configure do |config|
+  config.filter_run_excluding :external => true
+  config.include CommonLetHelpers
+end

data/spec/support/associated_resource.rb

@@ -0,0 +1,6 @@
+class AssociatedResource < ClioClient::Resource
+
+  set_attributes(id: {type: :int}
+                 )
+
+end

data/spec/support/dummy_endpoint.rb

@@ -0,0 +1,11 @@
+class DummyEndpoint < ClioClient::Api::Base
+  include ClioClient::Api::Findable
+
+  def data_klass(params)
+    TestResource
+  end
+  
+  def singular_resource; 'dummy'; end
+  def plural_resource; 'dummies'; end
+  def end_point_url; 'test'; end
+end

data/spec/support/inherited_resource.rb

@@ -0,0 +1,2 @@
+class InheritedResource < TestResource
+end

data/spec/support/resource_examples.rb

@@ -0,0 +1,82 @@
+shared_examples "association" do
+  
+  let(:nested_params) do
+    {"id" => 1, "name" => "name" }.merge(association_params)
+  end
+  let(:params) do
+    { attribute => nested_params }
+  end
+
+  it "should convert attributes to a clio object" do
+    obj = model[attribute]
+    expect(obj).to be_kind_of klass
+    nested_params.each_pair do |k, v|
+      expect(obj[k]).to eql v if v && k != "type"
+    end
+  end
+
+  describe "#to_params" do
+    it "should include the association" do
+      p = model.to_params
+      expect(p["#{attribute}_id".intern]).to eql 1
+    end
+  end
+
+end
+
+shared_examples "has many association" do
+  let(:nested_params) do
+    {"id" => 1, "name" => "name" }.merge(association_params)
+  end
+  let(:params) do
+    { attribute => [nested_params] }
+  end
+
+  it "should convert attributes to a clio object" do
+    obj = model[attribute].first
+    expect(obj).to be_kind_of klass
+    nested_params.each_pair do |k, v|
+      expect(obj[k]).to eql v if v && k != "type"
+    end
+  end
+
+  describe "#to_params" do
+    it "should include the associations" do
+      obj = model[attribute].first
+      p = obj.to_params
+      expect(model.to_params[attribute]).to eql [p]
+    end
+  end
+
+end
+
+shared_examples "model initialization" do
+
+  def check_attributes(model, attributes)
+    attributes.each_pair do |key, actual_value|
+      next if key == "url"
+      expected_value = model[key]
+      if expected_value.kind_of? ClioClient::Resource
+        check_attributes(expected_value, actual_value)
+      elsif expected_value.kind_of? Array
+        expected_value.zip(actual_value).each do |m, attr|
+          check_attributes(m, attr)
+        end
+      else
+        expect(expected_value.to_s).to eql(actual_value.to_s), custom_failure_message(key, expected_value, actual_value)
+      end
+    end
+  end
+
+  def custom_failure_message(key, e, a)
+    ["", "    key: #{key.inspect}",
+     "expected: #{e.to_s.inspect}",
+     "     got: #{a.to_s.inspect}", ""].join("\n")
+  end
+
+  it "should record all of the attributes and values" do
+    check_attributes(model, params)
+  end
+
+end
+

data/spec/support/test_resource.rb

@@ -0,0 +1,11 @@
+class TestResource < ClioClient::Resource
+  
+  set_attributes(id:       {type: :int},
+                 int:      {type: :int},
+                 date:     {type: :date},
+                 datetime: {type: :datetime},
+                 string:   {type: :string},
+                 boolean:  {type: :boolean}
+                 )
+
+end

metadata

@@ -0,0 +1,286 @@
+--- !ruby/object:Gem::Specification
+name: clio_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kyle d'Oliveira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Api client for Clio
+email:
+- kyle@goclio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- clio_client.gemspec
+- lib/clio_client.rb
+- lib/clio_client/api/activity.rb
+- lib/clio_client/api/activity_description.rb
+- lib/clio_client/api/base.rb
+- lib/clio_client/api/bill.rb
+- lib/clio_client/api/calendar.rb
+- lib/clio_client/api/calendar_entry.rb
+- lib/clio_client/api/communication.rb
+- lib/clio_client/api/contact.rb
+- lib/clio_client/api/crudable.rb
+- lib/clio_client/api/custom_field.rb
+- lib/clio_client/api/custom_field_set.rb
+- lib/clio_client/api/document.rb
+- lib/clio_client/api/document_version.rb
+- lib/clio_client/api/findable.rb
+- lib/clio_client/api/group.rb
+- lib/clio_client/api/listable.rb
+- lib/clio_client/api/matter.rb
+- lib/clio_client/api/note.rb
+- lib/clio_client/api/practice_area.rb
+- lib/clio_client/api/relationship.rb
+- lib/clio_client/api/task.rb
+- lib/clio_client/api/timeline_event.rb
+- lib/clio_client/api/timer.rb
+- lib/clio_client/api/user.rb
+- lib/clio_client/authorization.rb
+- lib/clio_client/http.rb
+- lib/clio_client/models/account.rb
+- lib/clio_client/models/activity.rb
+- lib/clio_client/models/activity_description.rb
+- lib/clio_client/models/bill.rb
+- lib/clio_client/models/calendar.rb
+- lib/clio_client/models/calendar_entry.rb
+- lib/clio_client/models/communication.rb
+- lib/clio_client/models/company.rb
+- lib/clio_client/models/contact.rb
+- lib/clio_client/models/custom_field.rb
+- lib/clio_client/models/custom_field_set.rb
+- lib/clio_client/models/document.rb
+- lib/clio_client/models/document_version.rb
+- lib/clio_client/models/email_communication.rb
+- lib/clio_client/models/expense_entry.rb
+- lib/clio_client/models/group.rb
+- lib/clio_client/models/matter.rb
+- lib/clio_client/models/note.rb
+- lib/clio_client/models/person.rb
+- lib/clio_client/models/phone_communication.rb
+- lib/clio_client/models/practice_area.rb
+- lib/clio_client/models/relationship.rb
+- lib/clio_client/models/task.rb
+- lib/clio_client/models/time_entry.rb
+- lib/clio_client/models/timeline_event.rb
+- lib/clio_client/models/timer.rb
+- lib/clio_client/models/user.rb
+- lib/clio_client/resource.rb
+- lib/clio_client/session.rb
+- lib/clio_client/support/address.rb
+- lib/clio_client/support/custom_field_checkbox_value.rb
+- lib/clio_client/support/custom_field_contact_value.rb
+- lib/clio_client/support/custom_field_currency_value.rb
+- lib/clio_client/support/custom_field_date_value.rb
+- lib/clio_client/support/custom_field_email_value.rb
+- lib/clio_client/support/custom_field_matter_value.rb
+- lib/clio_client/support/custom_field_numeric_value.rb
+- lib/clio_client/support/custom_field_picklist_option.rb
+- lib/clio_client/support/custom_field_picklist_value.rb
+- lib/clio_client/support/custom_field_text_area_value.rb
+- lib/clio_client/support/custom_field_text_line_value.rb
+- lib/clio_client/support/custom_field_time_value.rb
+- lib/clio_client/support/custom_field_url_value.rb
+- lib/clio_client/support/custom_field_value.rb
+- lib/clio_client/support/email_address.rb
+- lib/clio_client/support/instant_messenger.rb
+- lib/clio_client/support/phone_number.rb
+- lib/clio_client/support/rate.rb
+- lib/clio_client/support/reminder.rb
+- lib/clio_client/support/web_site.rb
+- lib/clio_client/version.rb
+- spec/api/crudable_spec.rb
+- spec/api/findable_spec.rb
+- spec/api/listable_spec.rb
+- spec/features/activities_spec.rb
+- spec/models/account_spec.rb
+- spec/models/activity_description_spec.rb
+- spec/models/activity_spec.rb
+- spec/models/bill_spec.rb
+- spec/models/calendar_entry_spec.rb
+- spec/models/calendar_spec.rb
+- spec/models/communication_spec.rb
+- spec/models/company_spec.rb
+- spec/models/contact_spec.rb
+- spec/models/custom_field_set_spec.rb
+- spec/models/custom_field_spec.rb
+- spec/models/document_spec.rb
+- spec/models/document_version_spec.rb
+- spec/models/email_communication_spec.rb
+- spec/models/expense_entry_spec.rb
+- spec/models/group_spec.rb
+- spec/models/matter_spec.rb
+- spec/models/note_spec.rb
+- spec/models/person_spec.rb
+- spec/models/phone_communication_spec.rb
+- spec/models/practice_area_spec.rb
+- spec/models/relationship_spec.rb
+- spec/models/resource_spec.rb
+- spec/models/task_spec.rb
+- spec/models/time_entry_spec.rb
+- spec/models/timeline_event_spec.rb
+- spec/models/timer_spec.rb
+- spec/models/user_spec.rb
+- spec/spec_helper.rb
+- spec/support/associated_resource.rb
+- spec/support/dummy_endpoint.rb
+- spec/support/inherited_resource.rb
+- spec/support/resource_examples.rb
+- spec/support/test_resource.rb
+homepage: https://github.com/doliveirakn/clio_client
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A simple ruby library to interact with Clio's Api
+test_files:
+- spec/api/crudable_spec.rb
+- spec/api/findable_spec.rb
+- spec/api/listable_spec.rb
+- spec/features/activities_spec.rb
+- spec/models/account_spec.rb
+- spec/models/activity_description_spec.rb
+- spec/models/activity_spec.rb
+- spec/models/bill_spec.rb
+- spec/models/calendar_entry_spec.rb
+- spec/models/calendar_spec.rb
+- spec/models/communication_spec.rb
+- spec/models/company_spec.rb
+- spec/models/contact_spec.rb
+- spec/models/custom_field_set_spec.rb
+- spec/models/custom_field_spec.rb
+- spec/models/document_spec.rb
+- spec/models/document_version_spec.rb
+- spec/models/email_communication_spec.rb
+- spec/models/expense_entry_spec.rb
+- spec/models/group_spec.rb
+- spec/models/matter_spec.rb
+- spec/models/note_spec.rb
+- spec/models/person_spec.rb
+- spec/models/phone_communication_spec.rb
+- spec/models/practice_area_spec.rb
+- spec/models/relationship_spec.rb
+- spec/models/resource_spec.rb
+- spec/models/task_spec.rb
+- spec/models/time_entry_spec.rb
+- spec/models/timeline_event_spec.rb
+- spec/models/timer_spec.rb
+- spec/models/user_spec.rb
+- spec/spec_helper.rb
+- spec/support/associated_resource.rb
+- spec/support/dummy_endpoint.rb
+- spec/support/inherited_resource.rb
+- spec/support/resource_examples.rb
+- spec/support/test_resource.rb