ruby-freshbooks 0.2.0 → 0.3.0

data/CHANGELOG

@@ -1,3 +1,6 @@
+== 0.3.0
+ * added LoggingClient example, pretty printing for generated xml, terrible hack to cover weird response FreshBooks' API gives instead of 404s
+
 == 0.2.0
  * added support for OAuth authentication
 

data/VERSION

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

data/lib/freshbooks.rb

@@ -71,7 +71,8 @@ module FreshBooks
     # takes nested Hash/Array combos and generates isomorphic
     # XML bodies to be POSTed to FreshBooks API
     def self.xml_body(method, params)
-      xml = Builder::XmlMarkup.new
+      xml = Builder::XmlMarkup.new(:indent => 2)
+      xml.instruct! :xml, :version=>"1.0", :encoding=>"utf-8"
       xml.tag!("request", :method => method) do
         build_xml(params, xml)
       end
@@ -79,8 +80,7 @@ module FreshBooks
     end
 
     # helper method to xml_body
-    def self.build_xml(obj, target='')
-      xml = Builder::XmlMarkup.new(:target => target)
+    def self.build_xml(obj, xml=Builder::XmlMarkup.new)
       # ZOMG! haven't you ever heard of polymorphism?!?
       # of course. I'm simply electing not to pollute the
       # method space of two of the most common Ruby classes.
@@ -88,9 +88,15 @@ module FreshBooks
       # be used in a context where some other library hasn't
       # already defined #to_xml on Hash...
       case obj
-      when Hash  then obj.each { |k,v| xml.tag!(k) { build_xml(v, xml) } }
-      when Array then obj.each { |e| build_xml(e ,xml) }
-      else xml.text! obj.to_s
+      when Hash
+        obj.each do |k,v|
+          if [Hash, Array].include?(v.class)
+            xml.tag!(k) { build_xml(v, xml) }
+          else
+            xml.__send__(k, v)
+          end
+        end
+      when Array then obj.each { |e| build_xml(e, xml) }
       end
       xml.target!
     end
@@ -110,6 +116,39 @@ module FreshBooks
         client.post "#{namespace}.#{sym}", *args
       end
     end
+
+    class FreshBooksAPIRequest < HTTParty::Request
+      private
+      # HACK
+      # FreshBooks' API unfortunately redirects to a login search
+      # html page if you specify an endpoint that doesn't exist
+      # (i.e. typo in subdomain) instead of returning a 404
+      def handle_response
+        if loc = last_response['location'] and loc.match /loginSearch\.php$/
+          resp = Net::HTTPNotFound.new(1.1, 404, "Not Found")
+          resp.instance_variable_set :@read, true
+          resp.instance_variable_set :@body, <<EOS
+<?xml version="1.0" encoding="utf-8"?>
+<response xmlns="http://www.freshbooks.com/api/" status="fail">
+  <error>Not Found. Verify FreshBooks API endpoint</error>
+</response>
+EOS
+          self.last_response = resp
+        end
+        super
+      end
+    end
+
+    def self.post(path, options={}) # :nodoc:
+      perform_freshbooks_api_request Net::HTTP::Post, path, options
+    end
+
+    private
+    def self.perform_freshbooks_api_request(http_method, path, options) #:nodoc:
+      options = default_options.dup.merge(options)
+      process_cookies(options)
+      FreshBooksAPIRequest.new(http_method, path, options).perform
+    end
   end
 
   # Basic Auth client. uses an account's API token.

data/ruby-freshbooks.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin Giancola"]
-  s.date = %q{2010-04-25}
+  s.date = Date.today.to_s
   s.description = %q{simple FreshBooks API wrapper. supports both OAuth and API token authentication}
   s.email = %q{elucid@gmail.com}
   s.files = ["README.md", "LICENSE", "VERSION", "CHANGELOG", "ruby-freshbooks.gemspec", "lib/freshbooks.rb", "lib/ruby-freshbooks.rb", "spec/freshbooks_spec.rb"]

data/spec/freshbooks_spec.rb

@@ -1,56 +1,56 @@
-require 'freshbooks'
+require 'lib/ruby-freshbooks'
 
 def build_xml(data)
-  FreshBooks::Client.build_xml data
+  FreshBooks::Client.build_xml data, Builder::XmlMarkup.new(:indent => 2)
 end
 
 describe "XML generation:" do
   describe "simple hash" do
     it "should serialize correctly" do
       data = {"foo" => "bar"}
-      build_xml(data).should == "<foo>bar</foo>"
+      build_xml(data).should == "<foo>bar</foo>\n"
     end
   end
 
   describe "simple hash with Fixnum value" do
     it "should serialize correctly, coercing to string" do
       data = {"foo" => 1}
-      build_xml(data).should == "<foo>1</foo>"
+      build_xml(data).should == "<foo>1</foo>\n"
     end
   end
 
   describe "simple hash value containing entity" do
     it "should serialize correctly, escaping entity" do
       data = {"foo" => "b&r"}
-      build_xml(data).should == "<foo>b&amp;r</foo>"
+      build_xml(data).should == "<foo>b&amp;r</foo>\n"
     end
   end
 
   describe "nested hash" do
     it "should serialize correctly" do
       data = {"foo" => {"bar" => "baz"}}
-      build_xml(data).should == "<foo><bar>baz</bar></foo>"
+      build_xml(data).should == "<foo>\n  <bar>baz</bar>\n</foo>\n"
     end
   end
 
   describe "deeply nested hash" do
     it "should serialize correctly" do
       data = {"foo" => {"bar" => {"baz" => "bat"}}}
-      build_xml(data).should == "<foo><bar><baz>bat</baz></bar></foo>"
+      build_xml(data).should == "<foo>\n  <bar>\n    <baz>bat</baz>\n  </bar>\n</foo>\n"
     end
   end
 
   describe "array" do
     it "should serialize correctly" do
       data = [{"bar" => "baz"}, {"bar" => "baz"}]
-      build_xml(data).should == "<bar>baz</bar><bar>baz</bar>"
+      build_xml(data).should == "<bar>baz</bar>\n<bar>baz</bar>\n"
     end
   end
 
   describe "hash with array" do
     it "should serialize correctly" do
       data = {"foo" => [{"bar" => "baz"}, {"bar" => "baz"}]}
-      build_xml(data).should == "<foo><bar>baz</bar><bar>baz</bar></foo>"
+      build_xml(data).should == "<foo>\n  <bar>baz</bar>\n  <bar>baz</bar>\n</foo>\n"
     end
   end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-freshbooks
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Justin Giancola
@@ -9,39 +14,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-25 00:00:00 -04:00
+date: 2010-05-26 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 0
         version: 0.5.0
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: builder
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 2
         version: 2.1.2
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
         version: 1.3.0
-    version: 
+  type: :development
+  version_requirements: *id003
 description: simple FreshBooks API wrapper. supports both OAuth and API token authentication
 email: elucid@gmail.com
 executables: []
@@ -72,18 +89,21 @@ 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: 
+      - 1
+      - 2
       version: "1.2"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: simple FreshBooks API wrapper. supports both OAuth and API token authentication