freeagent_api 0.2.0 → 0.3.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Aaron Russell
+Copyright (c) 2009-2010 Aaron Russell
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -11,10 +11,10 @@ This supports all GET, POST, PUT and DELETE ActiveResource calls for the followi
 * Invoices
 * Invoice Items
 * Timeslips
+* Users
 
 At the moment, the following API resources are NOT supported (although is being worked on):
 
-* Users
 * Expenses
 * Attachments
 
@@ -229,10 +229,43 @@ Please note: version 0.2 is significantly different from 0.1 so if you are upgra
   # or
   @timeslip.destroy
 
-== Author
+=== Users
+
+<b>Find users</b>
+
+  @users = User.find :all       # returns all users
+  @user = User.find id          # returns specific user
+  @user = User.find_by_email email
+
+<b>Create user</b>
+
+  # Required attributes
+  #   :first_name
+  #   :last_name
+  #   :email
+  #   :role                     # must be Owner, Director, Partner, Company Secretary, Employee, Shareholder, or Accountant
+  #   :password
+  #   :password_confirmation
+  
+  @user = User.new params
+  @user.save
+
+<b>Update user</b>
+
+  @user.first_name = 'Joe Bloggs'
+  @user.save
+
+<b>Delete user</b>
+
+  User.delete id
+  # or
+  @user.destroy
+
+== Author & Contributors
  
 * Aaron Russell - (www.aaronrussell.co.uk)
+* Alex Comans - (www.alexcoomans.com)
 
 == Copyright
 
-Copyright (c) 2009 Aaron Russell. See LICENSE for details.
+Copyright (c) 2009-2010 Aaron Russell. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/freeagent_api.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{freeagent_api}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Russell"]
-  s.date = %q{2009-10-27}
+  s.date = %q{2010-05-25}
   s.description = %q{This is an ActiveResource Ruby wrapper for the Freeagent API. Currently supports the following API resources: Company, Contacts, Projects, Tasks, Invoices, Invoice Items, Timeslips (more will follow).}
   s.email = %q{aaron@gc4.co.uk}
   s.extra_rdoc_files = [
@@ -49,14 +49,17 @@ Gem::Specification.new do |s|
      "test/stubs/tasks/find_single",
      "test/stubs/timeslips/find_all",
      "test/stubs/timeslips/find_single",
+     "test/stubs/users/find_all",
+     "test/stubs/users/find_single",
      "test/task_test.rb",
      "test/test_helper.rb",
-     "test/timeslip_test.rb"
+     "test/timeslip_test.rb",
+     "test/user_test.rb"
   ]
   s.homepage = %q{http://github.com/aaronrussell/freeagent_api}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{ActiveResource Ruby wrapper for the Freeagent Central API.}
   s.test_files = [
     "test/authentication_test.rb",
@@ -67,7 +70,8 @@ Gem::Specification.new do |s|
      "test/project_test.rb",
      "test/task_test.rb",
      "test/test_helper.rb",
-     "test/timeslip_test.rb"
+     "test/timeslip_test.rb",
+     "test/user_test.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -89,3 +93,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<activeresource>, [">= 0"])
   end
 end
+

data/lib/freeagent_api.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require 'activeresource'
+require 'active_resource'
 
 module Freeagent
   
@@ -111,5 +111,18 @@ module Freeagent
       end
     end    
   end
-
+  
+  # Users
+  
+  class User < Base
+    self.prefix = '/company/'
+    def self.find_by_email(email)
+      users = User.find :all
+      users.each do |u|
+        u.email == email ? (return u) : next
+      end
+      raise Error, "No user matches that email!"
+    end
+  end
+  
 end

data/test/stubs/users/find_all

@@ -0,0 +1,33 @@
+HTTP/1.1 200 OK
+Status: 200
+Content-Type: application/xml; charset=utf-8
+
+<?xml version="1.0" encoding="UTF-8"?>
+<users type="array">
+	<user>
+	  <company-id type="integer">10</company-id>
+	  <email>olly@lylo.co.uk</email>
+	  <first-name>Olly</first-name>
+	  <id type="integer">11</id>
+	  <last-logged-in-at type="datetime">2008-03-03T21:16:09Z</last-logged-in-at>
+	  <last-name>Headey</last-name>
+	  <opening-director-loan-account-balance type="decimal">0.0</opening-director-loan-account-balance>
+	  <opening-expense-balance type="decimal">0.0</opening-expense-balance>
+	  <opening-salary-balance type="decimal">0.0</opening-salary-balance>
+	  <opening-share-or-capital-balance type="decimal">0.0</opening-share-or-capital-balance>
+	  <role>Director</role>
+	</user>
+	<user>
+	  <company-id type="integer">11</company-id>
+	  <email>olly@gmail.com</email>
+	  <first-name>Olly</first-name>
+	  <id type="integer">11</id>
+	  <last-logged-in-at type="datetime">2008-03-03T21:16:09Z</last-logged-in-at>
+	  <last-name>Headey</last-name>
+	  <opening-director-loan-account-balance type="decimal">0.0</opening-director-loan-account-balance>
+	  <opening-expense-balance type="decimal">0.0</opening-expense-balance>
+	  <opening-salary-balance type="decimal">0.0</opening-salary-balance>
+	  <opening-share-or-capital-balance type="decimal">0.0</opening-share-or-capital-balance>
+	  <role>Director</role>
+	</user>
+</users>

data/test/stubs/users/find_single

@@ -0,0 +1,18 @@
+HTTP/1.1 200 OK
+Status: 200
+Content-Type: application/xml; charset=utf-8
+
+<?xml version="1.0" encoding="UTF-8"?>
+<user>
+  <company-id type="integer">11</company-id>
+  <email>olly@gmail.com</email>
+  <first-name>Olly</first-name>
+  <id type="integer">11</id>
+  <last-logged-in-at type="datetime">2008-03-03T21:16:09Z</last-logged-in-at>
+  <last-name>Headey</last-name>
+  <opening-director-loan-account-balance type="decimal">0.0</opening-director-loan-account-balance>
+  <opening-expense-balance type="decimal">0.0</opening-expense-balance>
+  <opening-salary-balance type="decimal">0.0</opening-salary-balance>
+  <opening-share-or-capital-balance type="decimal">0.0</opening-share-or-capital-balance>
+  <role>Director</role>
+</user>

data/test/test_helper.rb

@@ -43,6 +43,8 @@ def fake_it_all
     '/timeslips.xml?view=2009-10-01_2009-10-10' => File.join('timeslips', 'find_all'),
     '/timeslips/84445.xml'                      => File.join('timeslips', 'find_single'),
     '/projects/17820/timeslips.xml'             => File.join('projects', 'timeslips'),
+    '/company/users.xml'                        => File.join('users', 'find_all'),
+    '/company/users/11.xml'                     => File.join('users', 'find_single')
   }.each do |path, stub|
     FakeWeb.register_uri(:get, site_url+path, :response => stub_file(stub))
   end
@@ -54,6 +56,7 @@ def fake_it_all
     '/invoices.xml'                     => File.join('http', '201'),
     '/invoices/73867/invoice_items.xml' => File.join('http', '201'),
     '/timeslips.xml'                    => File.join('http', '201'),
+    '/company/users.xml'                => File.join('http', '201')
   }.each do |path, stub|
     FakeWeb.register_uri(:post, site_url+path, :response => stub_file(stub))
   end
@@ -70,6 +73,7 @@ def fake_it_all
     '/invoices/73867/invoice_items/169399.xml'  => File.join('http', '200'),
     '/timeslips/84445.xml'                      => File.join('http', '200'),
     '/timeslips/74814.xml'                      => File.join('http', '200'),
+    '/company/users/11.xml'                     => File.join('http', '200')
   }.each do |path, stub|
     FakeWeb.register_uri(:put, site_url+path, :response => stub_file(stub))
   end
@@ -83,6 +87,7 @@ def fake_it_all
     '/invoices/73867/invoice_items/169399.xml'  => File.join('http', '200'),
     '/timeslips/84445.xml'                      => File.join('http', '200'),
     '/timeslips/74814.xml'                      => File.join('http', '200'),
+    '/company/users/11.xml'                     => File.join('http', '200')
   }.each do |path, stub|
     FakeWeb.register_uri(:delete, site_url+path, :response => stub_file(stub))
   end

data/test/user_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+class UserTest < Test::Unit::TestCase
+  
+  fake_it_all
+  
+  context "User class" do
+    should "have correct collection path" do
+      assert_equal '/company/users.xml', User.collection_path
+    end
+    should "have correct element path" do
+      assert_equal '/company/users/first.xml', User.element_path(:first)
+      assert_equal '/company/users/1000.xml', User.element_path(1000)
+    end
+  end
+  
+  context "Users" do
+    setup do
+      @users = User.find :all
+    end
+    should "return an array" do
+      assert @users.is_a? Array
+    end
+    should "return Users" do
+      assert_equal 2, @users.size
+      assert @users.first.is_a? User
+    end
+  end
+  
+  context "User" do
+    setup do
+      @user = User.find 11
+    end
+    should "return a User" do
+      assert @user.is_a? User
+    end
+    should "update and save" do
+      @user.email = 'olly@gmail.com'
+      assert @user.save
+    end
+    should "be destroyed" do
+      assert @user.destroy
+    end
+  end
+  
+  context "Finding User" do
+    setup do
+      @user = User.find_by_email('olly@gmail.com')
+    end
+    should "return a User" do
+      assert @user.is_a? User
+    end
+    should "return the correct User" do
+      assert_equal User.find(11), @user
+    end
+  end
+  
+  context "New User" do
+    setup do
+      params = {
+          :first_name => 'John',
+          :last_name  => 'Doe',
+          :email      => 'jdoe@example.com',
+          :role       => 'Owner',
+          :password   => 'password',
+          :password_confirmation => 'password'
+      }
+      @user = User.new params
+    end
+    should "validate and save" do
+      assert @user.save_with_validation
+    end
+  end
+    
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: freeagent_api
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Aaron Russell
@@ -9,39 +14,45 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-27 00:00:00 +00:00
+date: 2010-05-25 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: fakeweb
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: activeresource
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id003
 description: "This is an ActiveResource Ruby wrapper for the Freeagent API. Currently supports the following API resources: Company, Contacts, Projects, Tasks, Invoices, Invoice Items, Timeslips (more will follow)."
 email: aaron@gc4.co.uk
 executables: []
@@ -84,9 +95,12 @@ files:
 - test/stubs/tasks/find_single
 - test/stubs/timeslips/find_all
 - test/stubs/timeslips/find_single
+- test/stubs/users/find_all
+- test/stubs/users/find_single
 - test/task_test.rb
 - test/test_helper.rb
 - test/timeslip_test.rb
+- test/user_test.rb
 has_rdoc: true
 homepage: http://github.com/aaronrussell/freeagent_api
 licenses: []
@@ -100,18 +114,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: ActiveResource Ruby wrapper for the Freeagent Central API.
@@ -125,3 +141,4 @@ test_files:
 - test/task_test.rb
 - test/test_helper.rb
 - test/timeslip_test.rb
+- test/user_test.rb