bcurren-rshoeboxed 0.0.1 → 0.0.3

data/Manifest.txt

@@ -6,6 +6,7 @@ lib/rshoeboxed.rb
 lib/rshoeboxed/category.rb
 lib/rshoeboxed/connection.rb
 lib/rshoeboxed/list_proxy.rb
+lib/rshoeboxed/parse_error.rb
 lib/rshoeboxed/receipt.rb
 script/console
 script/destroy

data/README.rdoc

@@ -15,7 +15,7 @@ AppName provided by shoeboxed. Shoeboxed will redirect back to the return url on
 authenticates. When the user is redirected back to the return_url, a token will be provided in the url
 for you to store for future API calls.
 
-RShoeboxed::Connection.authentication_url("Outright", "http://example.com")
+  RShoeboxed::Connection.authentication_url("Outright", "http://example.com")
 
 === Get a list of all receipts
 
@@ -23,18 +23,18 @@ The api_token is provided by shoeboxed when you setup your API account. The user
 sending a user to authentication_url so they can log in to shoeboxed. On success, they will be redirected
 to the return_url with the user_token.
 
-connection = RShoeboxed::Connection.new("api_token", "user_token")
-receipts = connection.get_receipt_call(Date.new(2008, 1, 1), Date.new(2008, 12, 29))
+   connection = RShoeboxed::Connection.new("api_token", "user_token")
+   receipts = connection.get_receipt_call(Date.new(2008, 1, 1), Date.new(2008, 12, 29))
 
 === Get a particular receipt
 
-connection = RShoeboxed::Connection.new("api_token", "user_token")
-receipt = connection.get_category_info_call("2342442424")
+  connection = RShoeboxed::Connection.new("api_token", "user_token")
+  receipt = connection.get_category_info_call("2342442424")
 
 === Get a list of all categories
 
-connection = RShoeboxed::Connection.new("api_token", "user_token")
-categories = connection.get_category_call
+  connection = RShoeboxed::Connection.new("api_token", "user_token")
+  categories = connection.get_category_call
 
 == INSTALL:
 

data/lib/rshoeboxed/category.rb

@@ -8,11 +8,19 @@ module RShoeboxed
       document = REXML::Document.new(xml)
       document.elements.collect("//Category") do |category_element|
         category = Category.new
-        category.id = category_element.attributes["id"]
-        category.name = category_element.attributes["name"]
+        begin
+          category.id = category_element.attributes["id"]
+          category.name = category_element.attributes["name"]
+        rescue => e
+          raise RShoeboxed::ParseError.new(e, category_element.to_s, "Error parsing category.")
+        end
         category
       end
     end
+    
+    def ==(category)
+      self.id == category.id && self.name == category.name
+    end
 
   end
 end

data/lib/rshoeboxed/parse_error.rb

@@ -0,0 +1,19 @@
+module RShoeboxed
+  class ParseError < StandardError
+    attr_accessor :original_error, :xml
+  
+    def initialize(original_error, xml, msg = nil)
+      @original_error = original_error
+      @xml = xml
+      super(msg)
+    end
+    
+    def to_s
+      message = super
+      
+      "Original Error: #{original_error.to_s}\n" +
+      "XML: #{xml.to_s}\n" +
+      "Message: #{message}\n"
+    end
+  end
+end

data/lib/rshoeboxed/receipt.rb

@@ -4,28 +4,32 @@ require 'rexml/document'
 
 module RShoeboxed
   class Receipt
-    attr_accessor :id, :store, :image_url, :category_id
-    attr_reader :date, :total
+    attr_accessor :id, :store, :image_url, :categories
+    attr_reader :sell_date, :created_date, :modified_date, :total
     
     def self.parse(xml)
       document = REXML::Document.new(xml)
       document.elements.collect("//Receipt") do |receipt_element|
         receipt = Receipt.new
-        
-        receipt.id = receipt_element.attributes["id"]
-        receipt.store = receipt_element.attributes["store"]
-        receipt.date = receipt_element.attributes["date"]
-        receipt.total = receipt_element.attributes["total"]
-        receipt.image_url = receipt_element.attributes["imgurl"]
-        receipt.category_id = receipt_element.attributes["category"]
-        
+        begin
+          receipt.id = receipt_element.attributes["id"]
+          receipt.store = receipt_element.attributes["store"]
+          receipt.sell_date = receipt_element.attributes["selldate"]
+          receipt.created_date = receipt_element.attributes["createdDate"]
+          receipt.modified_date = receipt_element.attributes["modifiedDate"]
+          receipt.total = receipt_element.attributes["total"]
+          receipt.image_url = receipt_element.attributes["imgurl"]
+          
+          # Get the categories elements and have Category parse them
+          category_element = receipt_element.elements["Categories"]
+          receipt.categories = category_element ? Category.parse(category_element.to_s) : []
+        rescue => e
+          raise RShoeboxed::ParseError.new(e, receipt_element.to_s, "Error parsing receipt.")
+        end
         receipt
       end
     end
     
-    def initialize
-    end
-    
     def total=(total)
       total.gsub!(/[^\d|.]/, "") if total.is_a?(String)
       total = BigDecimal.new(total) unless total.is_a?(BigDecimal)
@@ -33,9 +37,26 @@ module RShoeboxed
       @total = total
     end
     
-    def date=(date)
+    def sell_date=(date)
+      date = Date.parse(date) if date.is_a?(String)
+      @sell_date = date
+    end
+    
+    def created_date=(date)
       date = Date.parse(date) if date.is_a?(String)
-      @date = date
+      @created_date = date
+    end
+    
+    def modified_date=(date)
+      date = Date.parse(date) if date.is_a?(String)
+      @modified_date = date
+    end
+    
+    def ==(receipt)
+      self.id == receipt.id && self.store == receipt.store && self.image_url == receipt.image_url &&
+        self.categories == receipt.categories && self.sell_date == receipt.sell_date && 
+        self.modified_date == receipt.modified_date && self.created_date == receipt.created_date &&
+        self.total == receipt.total
     end
   end
 end

data/lib/rshoeboxed.rb

@@ -6,7 +6,8 @@ require 'rshoeboxed/receipt'
 require 'rshoeboxed/category'
 require 'rshoeboxed/connection'
 require 'rshoeboxed/list_proxy'
+require 'rshoeboxed/parse_error'
 
 module RShoeboxed
-  VERSION = '0.0.1'
-end
+  VERSION = '0.0.4'
+end

data/test/fixtures/receipt_info_response.xml

@@ -1 +1,5 @@
-<Receipt store="Morgan Imports" id="1" total="$1,929.00" date="5/12/2008" imgurl="http://www.shoeboxed.com/receipt.jpeg" category="1" />
+<Receipt store="Morgan Imports" id="1" total="$1,929.00" selldate="5/12/2008" createdDate="4/12/2008" modifiedDate="4/20/2008" imgurl="http://www.shoeboxed.com/receipt.jpeg">
+  <Categories>
+    <Category name="Category 1" id="1"/>
+  </Categories> 
+</Receipt>

data/test/fixtures/receipt_response.xml

@@ -1,6 +1,14 @@
 <GetReceiptCallResponse>
   <Receipts count="2">
-    <Receipt store="Great Plains Trust Company" id="23984923842" total="$3,378.30" date="5/12/2008" imgurl="http://www.shoeboxed.com/receipt1.jpeg" category="1"/>
-    <Receipt store="RadioShack" id="39239293" total="$3.51" date="5/12/2008" imgurl="http://www.shoeboxed.com/receipt2.jpeg" category="2"/>
+    <Receipt store="Great Plains Trust Company" id="23984923842" total="$3,378.30" selldate="5/12/2008" createdDate="4/12/2008" modifiedDate="4/20/2008" imgurl="http://www.shoeboxed.com/receipt1.jpeg">
+      <Categories>
+        <Category name="Category 1" id="1"/>
+      </Categories>
+    </Receipt>
+    <Receipt store="RadioShack" id="39239293" total="$3.51" selldate="5/12/2008" createdDate="4/12/2008" modifiedDate="4/20/2008" imgurl="http://www.shoeboxed.com/receipt2.jpeg">
+      <Categories>
+        <Category name="Category 2" id="2"/>
+      </Categories>
+    </Receipt>
   </Receipts>
 </GetReceiptCallResponse>

data/test/test_connection.rb

@@ -5,6 +5,14 @@ class TestConnection < Test::Unit::TestCase
   
   def setup
     @conn = Connection.new("api_key", "user_token")
+    
+    @category1 = Category.new
+    @category1.id = "1"
+    @category1.name = "Category 1"
+    
+    @category2 = Category.new
+    @category2.id = "2"
+    @category2.name = "Category 2"
   end
   
   def test_authenticate__connection_failures
@@ -39,10 +47,12 @@ class TestConnection < Test::Unit::TestCase
     assert_not_nil receipt
     assert_equal "1", receipt.id
     assert_equal "Morgan Imports", receipt.store
-    assert_equal Date.new(2008, 5, 12), receipt.date
+    assert_equal Date.new(2008, 5, 12), receipt.sell_date
+    assert_equal Date.new(2008, 4, 12), receipt.created_date
+    assert_equal Date.new(2008, 4, 20), receipt.modified_date
     assert_equal BigDecimal.new("1929.00"), receipt.total
     assert_equal "http://www.shoeboxed.com/receipt.jpeg", receipt.image_url
-    assert_equal "1", receipt.category_id
+    assert_equal [@category1], receipt.categories
   end
   
   def test_build_receipt_info_call_request
@@ -66,18 +76,22 @@ class TestConnection < Test::Unit::TestCase
     receipt = receipts[0]
     assert_equal "23984923842", receipt.id
     assert_equal "Great Plains Trust Company", receipt.store
-    assert_equal Date.new(2008, 5, 12), receipt.date
+    assert_equal Date.new(2008, 5, 12), receipt.sell_date
+    assert_equal Date.new(2008, 4, 12), receipt.created_date
+    assert_equal Date.new(2008, 4, 20), receipt.modified_date
     assert_equal BigDecimal.new("3378.30"), receipt.total
     assert_equal "http://www.shoeboxed.com/receipt1.jpeg", receipt.image_url
-    assert_equal "1", receipt.category_id
+    assert_equal [@category1], receipt.categories
     
     receipt = receipts[1]
     assert_equal "39239293", receipt.id
     assert_equal "RadioShack", receipt.store
-    assert_equal Date.new(2008, 5, 12), receipt.date
+    assert_equal Date.new(2008, 5, 12), receipt.sell_date
+    assert_equal Date.new(2008, 4, 12), receipt.created_date
+    assert_equal Date.new(2008, 4, 20), receipt.modified_date
     assert_equal BigDecimal.new("3.51"), receipt.total
     assert_equal "http://www.shoeboxed.com/receipt2.jpeg", receipt.image_url
-    assert_equal "2", receipt.category_id
+    assert_equal [@category2], receipt.categories
   end
   
   def test_build_receipt_request

data/test/test_receipt.rb

@@ -4,6 +4,9 @@ class TestReceipt < Test::Unit::TestCase
   include RShoeboxed
 
   def setup
+    @category1 = Category.new
+    @category1.id = "1"
+    @category1.name = "Category 1"
   end
   
   def test_initialize_parse_xml
@@ -14,10 +17,12 @@ class TestReceipt < Test::Unit::TestCase
     receipt = receipts.first
     assert_equal "1", receipt.id
     assert_equal "Morgan Imports", receipt.store
-    assert_equal Date.new(2008, 5, 12), receipt.date
+    assert_equal Date.new(2008, 5, 12), receipt.sell_date
+    assert_equal Date.new(2008, 4, 12), receipt.created_date
+    assert_equal Date.new(2008, 4, 20), receipt.modified_date
     assert_equal BigDecimal.new("1929.00"), receipt.total
     assert_equal "http://www.shoeboxed.com/receipt.jpeg", receipt.image_url
-    assert_equal "1", receipt.category_id
+    assert_equal [@category1], receipt.categories
   end
   
   def test_receipt__accessors
@@ -33,13 +38,21 @@ class TestReceipt < Test::Unit::TestCase
     receipt.total = '$1,000.19'
     assert_equal BigDecimal.new('1000.19'), receipt.total
     
-    receipt.date = '1/1/2001'
-    assert_equal Date.parse('1/1/2001'), receipt.date
+    receipt.created_date = '1/2/2001'
+    assert_equal Date.parse('1/2/2001'), receipt.created_date
+    
+    receipt.modified_date = '1/3/2001'
+    assert_equal Date.parse('1/3/2001'), receipt.modified_date
     
     receipt.image_url = "http://www.example.com/one.image"
     assert_equal "http://www.example.com/one.image", receipt.image_url
     
-    receipt.category_id = "2"
-    assert_equal "2", receipt.category_id
+    receipt.categories = [@category1]
+    assert_equal [@category1], receipt.categories
+  end
+  
+  def test_equal
+    # lame test but at least execute the code
+    assert_equal Receipt.new, Receipt.new
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bcurren-rshoeboxed
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors: 
 - Ben Curren
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-21 00:00:00 -08:00
+date: 2009-02-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,6 +68,7 @@ files:
 - lib/rshoeboxed/category.rb
 - lib/rshoeboxed/connection.rb
 - lib/rshoeboxed/list_proxy.rb
+- lib/rshoeboxed/parse_error.rb
 - lib/rshoeboxed/receipt.rb
 - script/console
 - script/destroy