turingstudio-freshbooks-rb 3.0.2 → 3.0.3

data/History.txt

@@ -1,4 +1,10 @@
-== 0.0.1 2009-02-18
+* 3.0.3
+	* Merged with http://github.com/bcurren/freshbooks.rb
+  	* Create connection class
+  	* Convert xml to ruby type: date, date_time, boolean
+  	* Added links to objects
 
-* 1 major enhancement:
-  * Initial release
+* 3.0 major enhancement:
+  * Gemified
+	* Added specs
+  * Added methods to describe FreshBooks objects and actions

data/lib/freshbooks.rb

@@ -1,7 +1,7 @@
 #
 # Usage:
 #
-# FreshBooks::Base.setup('sample.freshbooks.com', 'mytoken')
+# FreshBooks::Base.establish_connection!('sample.freshbooks.com', 'mytoken')
 #
 # clients = FreshBooks::Client.list
 # client = clients[0]
@@ -21,6 +21,7 @@ $:.unshift(File.dirname(__FILE__))
 
 require 'net/https'
 require 'rexml/document'
+require 'logger'
 require 'activesupport'
 
 require 'freshbooks/version'
@@ -43,3 +44,4 @@ require 'freshbooks/staff'
 require 'freshbooks/task'
 require 'freshbooks/time_entry'
 require 'freshbooks/xml_serializer'
+require 'freshbooks/xml_serializer/serializers'

data/lib/freshbooks/base.rb

@@ -1,11 +1,11 @@
 module FreshBooks
-  class Base
-    class InternalError < Exception; end;
-    class AuthenticationError < Exception; end;
-    class UnknownSystemError < Exception; end;
-    class InvalidParameterError < Exception; end;
-    class InvalidAccountUrlError < Exception; end;
-    
+  class InternalError < Exception; end;
+  class AuthenticationError < Exception; end;
+  class UnknownSystemError < Exception; end;
+  class InvalidParameterError < Exception; end;
+  class InvalidAccountUrlError < Exception; end;
+  
+  class Base    
     def initialize(data = {})
       @changed_fields = []
       self.class.attributes.each do |name, options|
@@ -14,9 +14,8 @@ module FreshBooks
       data.each do |name, value|
         send("#{name}=", value) if self.class.attributes[name]
       end
-      #@changed_fields = [] # reset changed fields
     end
-        
+    
     def to_xml(elem_name = nil)
       root = REXML::Element.new(node_name)
       self.class.attributes.each do |name, options|
@@ -32,7 +31,7 @@ module FreshBooks
       end
       root
     end
-        
+    
     class << self
       attr_reader :connection
       
@@ -51,7 +50,7 @@ module FreshBooks
         end
         object
       end
-            
+      
       def node_name
         self.to_s.split('::').last.underscore
       end
@@ -129,13 +128,13 @@ module FreshBooks
       #
       def define_class_method(name, &block)
         self.class.send(:define_method, name, &block)
-      end            
-
+      end
+      
       def actions(*args)
         args.each do |action|
           method = action.to_s
           api_method = method.camelize(:lower)
-
+          
           case method
           when 'list'
             define_class_method(method) do |*args|
@@ -171,27 +170,38 @@ module FreshBooks
         end
         
         def api_list_action(method, options = {})
-          resp = Base.connection.call_api("#{node_name}.#{method}", options)
-          resp.success? ? ListProxy.new_from_xml(self, resp) : nil
-        end
+          list_page_proc = proc do |page|
+            options["page"] = page
+            response = FreshBooks::Base.connection.call_api("#{node_name}.#{method}", options)
+            raise FreshBooks::InternalError.new("Response was not successful. This should never happen.") unless response.success?
+
+            root = response.elements[1]
+            array = root.elements.map { |item| self.new_from_xml(item) }
+            current_page = Page.new(root.attributes['page'], root.attributes['per_page'], root.attributes['total'])
 
+            [array, current_page]
+          end
+          
+          ListProxy.new(list_page_proc)          
+        end
+        
         def api_get_action(method, id)
           resp = Base.connection.call_api("#{node_name}.#{method}", "#{node_name}_id" => id)
           resp.success? ? self.new_from_xml(resp.elements[1]) : nil
         end
-
+        
         def api_delete_action(method, id)
           resp = Base.connection.call_api("#{node_name}.#{method}", "#{node_name}_id" => id)
           resp.success?
         end
-
+        
         def api_action(method, id)
           resp = Base.connection.call_api("#{node_name}.#{method}", "#{node_name}_id" => id)
           resp.success?
         end
       end
     end
-        
+    
     protected
     
     def node_name
@@ -203,10 +213,10 @@ module FreshBooks
       self.send("#{node_name}_id=", resp.elements[1].text.to_i) if resp.success?
       resp.success?
     end
-
+    
     def api_update_action(method)
       resp = Base.connection.call_api("#{node_name}.#{method}", node_name => self)
       resp.success?
-    end    
+    end
   end
 end

data/lib/freshbooks/staff.rb

@@ -21,4 +21,4 @@ module FreshBooks
     has_many :expenses
     actions :list, :get
   end
-end
+end

data/lib/freshbooks/version.rb

@@ -1,5 +1,5 @@
 module FreshBooks
-  VERSION = '3.0.2'     # Gem version
+  VERSION = '3.0.3'     # Gem version
   API_VERSION = '2.1'   # FreshBooks API version
   
   SERVICE_URL = "/api/#{API_VERSION}/xml-in"

data/spec/lib/freshbooks/base_spec.rb

@@ -292,13 +292,13 @@ describe FreshBooks::Base do
     end
     
     it "should call api method" do
-      @connection.should_receive(:call_api).with('test.list', :name => 'value').and_return(@resp)
+      @connection.should_receive(:call_api).with('test.list', 'page' => 1, :name => 'value').and_return(@resp)
       Test.list(:name => 'value')
     end
     
     it "should return nil if request failed" do
       @resp.stub!(:success?).and_return(false)
-      Test.list.should be_nil
+      lambda { Test.list }.should raise_error
     end
 
     it "should create a list proxy if request succeeded" do

data/spec/lib/freshbooks/staff_spec.rb

@@ -6,7 +6,7 @@ describe FreshBooks::Staff do
   end
   
   it "should list all staffs" do
-    FreshBooks::Staff.list.size.should > 0
+    FreshBooks::Staff.list.should be_a(FreshBooks::ListProxy)
   end
     
   it "should find staff by id" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: turingstudio-freshbooks-rb
 version: !ruby/object:Gem::Version 
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors: 
 - The Turing Studio, Inc.
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-04 00:00:00 -08:00
+date: 2009-03-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency