ffmike-rshoeboxed 0.0.6

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-01-12
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,30 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+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
+script/generate
+test/fixtures/category_request.xml
+test/fixtures/category_response.xml
+test/fixtures/receipt_info_request.xml
+test/fixtures/receipt_info_response.xml
+test/fixtures/receipt_request.xml
+test/fixtures/receipt_response.xml
+test/fixtures/receipt_response_bad_credentials.xml
+test/fixtures/receipt_response_internal_error.xml
+test/fixtures/receipt_response_restricted_ip.xml
+test/fixtures/receipt_response_unknown_api_call.xml
+test/fixtures/receipt_response_xml_validation.xml
+test/fixtures/receipt_with_category_id_request.xml
+test/test_category.rb
+test/test_connection.rb
+test/test_helper.rb
+test/test_list_proxy.rb
+test/test_receipt.rb

data/README.rdoc

@@ -0,0 +1,74 @@
+= rshoeboxed
+
+Master repo:
+
+* http://github.com/bcurren/rshoeboxed
+
+== DESCRIPTION:
+
+Ruby wrapper for the Shoeboxed API.
+
+== SYNOPSIS:
+
+=== Generate authentication url
+
+Use the following code to generate a url to send a user to to authenticate. The first parameter is the
+AppName provided by Shoeboxed. Shoeboxed will redirect back to the return url once a user successfully
+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")
+
+=== Get a list of all receipts
+
+The api_token is provided by Shoeboxed when you setup your API account. The user_token is retrieved by
+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))
+
+=== Get a particular receipt
+
+  connection = RShoeboxed::Connection.new("api_token", "user_token")
+  receipt = connection.get_receipt_info_call("2342442424")
+
+=== Get a list of all categories
+
+  connection = RShoeboxed::Connection.new("api_token", "user_token")
+  categories = connection.get_category_call  
+
+=== Get a list of all business cards
+
+   connection = RShoeboxed::Connection.new("api_token", "user_token")
+   cards = connection.get_business_card_call(200,1)
+
+
+== INSTALL:
+
+* sudo gem install bcurren_rshoeboxed
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Ben Curren
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/rshoeboxed'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('rshoeboxed', RShoeboxed::VERSION) do |p|
+  p.developer('Ben Curren', 'ben@gobootstrap.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+    ['builder','>= 2.1.2'],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"],
+    ['mocha', ">= 0.9.4"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/rshoeboxed/category.rb

@@ -0,0 +1,26 @@
+require 'rexml/document'
+
+module RShoeboxed
+  class Category
+    attr_accessor :id, :name
+
+    def self.parse(xml)
+      document = REXML::Document.new(xml)
+      document.elements.collect("//Category") do |category_element|
+        category = Category.new
+        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/connection.rb

@@ -0,0 +1,234 @@
+gem "builder"
+require "builder"
+require "cgi"
+require "net/https"
+require 'rexml/document'
+require 'logger'
+require 'iconv'
+
+module RShoeboxed
+  class Error < StandardError; end;
+  class UnknownAPICallError < Error; end;
+  class InternalError < Error; end;
+  class AuthenticationError < Error; end;
+  class RestrictedIPError < Error; end;
+  class XMLValidationError < Error; end;
+  
+  class Connection
+    attr_accessor :api_key, :user_token
+    
+    API_SERVER = "app.shoeboxed.com"
+    API_PATH = "/ws/api.htm"
+    API_URL = "https://" + API_SERVER + API_PATH
+    
+    @@logger = Logger.new(STDOUT)
+    def logger
+      @@logger
+    end
+    
+    def self.log_level=(level)
+      @@logger.level = level
+    end
+    self.log_level = Logger::WARN
+    
+    # Generates a url for you to obtain the user token. This url with take the user to the Shoeboxed authentication
+    # page. After the user successfully authenticates, they will be redirected to the app_url with the token and uname
+    # as parameters.
+    # 
+    # app_name - string that contains the name of the app that is calling the API 
+    # app_url - url that Shoeboxed will redirect to after a successful authentication
+    # app_params - option hash or array of strings containing params that will be passed back to app_url
+    def self.authentication_url(app_name, app_url, app_params={})
+      API_URL + "?" + encode_params(
+      [[:appname, app_name],
+      [:appurl, app_url],
+      [:apparams, encode_params(app_params)],
+      [:SignIn, 1]]
+      )
+    end
+    
+    
+    # The initialization method takes in two params:
+    # api_key - 
+    # user_token (generated after validating from the authentication url)
+    def initialize(api_key, user_token)
+      @api_key = api_key
+      @user_token = user_token
+    end
+    
+    def get_receipt_info_call(id)
+      request = build_receipt_info_request(id)
+      response = post_xml(request)
+      
+      receipts = Receipt.parse(response)
+      receipts ? receipts.first : nil
+    end
+    
+    # Note: the result_count can only be 50, 100, or 200
+    def get_receipt_call(start_date, end_date, options = {})
+      options = {
+        :use_sell_date => false,
+        :per_page => 50,
+        :current_page => 1
+      }.merge(options)
+      
+      request = build_receipt_request(start_date, end_date, options)
+      response = post_xml(request)
+      
+      receipts = Receipt.parse(response)
+      wrap_array_with_pagination(receipts, response, options[:current_page], options[:per_page])
+    end
+    
+    def get_category_call
+      request = build_category_request
+      response = post_xml(request)
+      
+      Category.parse(response)
+    end 
+    
+    def get_business_card_call(options = {})
+      request = build_business_card_request(options)
+      response = post_xml(request)
+
+      BusinessCard.parse(response)
+    end
+    
+  private
+    
+    def wrap_array_with_pagination(receipts, response, current_page, per_page)
+      document = REXML::Document.new(response)
+      counts = document.elements.collect("//Receipts") { |element| element.attributes["count"] || 0 }
+      
+      ListProxy.new(receipts, counts.first, current_page, per_page)
+    end
+    
+    def date_to_s(date)
+      my_date = date
+      if !date.kind_of?(String)
+        my_date = date.strftime("%Y-%m-%dT%H:%M:%S")
+      end
+      my_date
+    end
+    
+    def self.encode_params(params)
+      # If hash, turn to array and give it alpha ordering
+      if params.kind_of? Hash
+        params = params.to_a
+      end
+      
+      encoded_params = params.collect do |name, value|
+        "#{CGI.escape(name.to_s)}=#{CGI.escape(value.to_s)}"
+      end
+      encoded_params.join("&")
+    end
+    
+
+    def post_xml(body)
+      connection = Net::HTTP.new(API_SERVER, 443)
+      connection.use_ssl = true
+      connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      request = Net::HTTP::Post.new(API_PATH)
+      request.set_form_data({'xml'=>body})
+
+      result = connection.start  { |http| http.request(request) }
+
+      # Convert to UTF-8, shoeboxed encodes with ISO-8859-1
+      result_body = Iconv.conv('UTF-8', 'ISO-8859-1', result.body)
+
+      if logger.debug?
+        logger.debug "Request:"
+        logger.debug body
+        logger.debug "Response:"
+        logger.debug result_body
+      end
+
+      check_for_api_error(result_body)
+    end
+    
+    def check_for_api_error(body)
+      document = REXML::Document.new(body)
+      root = document.root
+      puts root.inspect
+      if root && root.name == "Error"
+        description = root.attributes["description"]
+        
+        case root.attributes["code"]
+        when "1"
+          raise AuthenticationError.new(description)
+        when "2"
+          raise UnknownAPICallError.new(description)
+        when "3"
+          raise RestrictedIPError.new(description)
+        when "4"
+          raise XMLValidationError.new(description)
+        when "5"
+          raise InternalError.new(description)
+        end
+      end
+      
+      body
+    end
+    
+    def build_receipt_request(start_date, end_date, options)
+      xml = Builder::XmlMarkup.new
+      xml.instruct!
+      xml.Request(:xmlns => "urn:sbx:apis:SbxBaseComponents") do |xml|
+        append_credentials(xml)
+        xml.GetReceiptCall do |xml|
+          xml.ReceiptFilter do |xml|
+            xml.Results(options[:per_page])
+            xml.PageNo(options[:current_page])
+            xml.DateStart(date_to_s(start_date))
+            xml.DateEnd(date_to_s(end_date))
+            xml.UseSellDate(options[:use_sell_date])
+            xml.Category(options[:category_id]) if options[:category_id]
+          end
+        end
+      end
+    end
+    
+    def build_category_request
+      xml = Builder::XmlMarkup.new
+      xml.instruct!
+      xml.Request(:xmlns => "urn:sbx:apis:SbxBaseComponents") do |xml|
+        append_credentials(xml)
+        xml.GetCategoryCall
+      end
+    end
+    
+    def build_business_card_request(options)
+      xml = Builder::XmlMarkup.new
+      xml.instruct!
+      xml.Request(:xmlns => "urn:sbx:apis:SbxBaseComponents") do |xml|
+        append_credentials(xml)
+        xml.GetBusinessCardCall do |xml|
+          xml.BusinessCardFilter do |xml|
+            xml.Results(options[:per_page])
+            xml.PageNo(options[:current_page])   
+          end
+        end
+      end
+    end        
+
+    def build_receipt_info_request(id)
+      xml = Builder::XmlMarkup.new
+      xml.instruct!
+      xml.Request(:xmlns => "urn:sbx:apis:SbxBaseComponents") do |xml|
+        append_credentials(xml)
+        xml.GetReceiptInfoCall do |xml|
+          xml.ReceiptFilter do |xml|
+            xml.ReceiptId(id)
+          end
+        end
+      end
+    end
+    
+    def append_credentials(xml)
+      xml.RequesterCredentials do |xml|
+        xml.ApiUserToken(@api_key)
+        xml.SbxUserToken(@user_token)
+      end
+    end
+  end
+end

data/lib/rshoeboxed/list_proxy.rb

@@ -0,0 +1,25 @@
+module RShoeboxed
+  class ListProxy
+    attr_reader :current_page, :per_page, :total
+  
+    def initialize(array, total, current_page, per_page)
+      @array = array
+    
+      @total = total.to_i
+      @current_page = current_page.to_i
+      @per_page = per_page.to_i
+    end
+  
+    def pages
+      pages = total / per_page
+      if total % per_page != 0
+        pages += 1
+      end
+      pages
+    end
+  
+    def method_missing(method, *args, &block)
+      @array.send(method, *args, &block)
+    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

@@ -0,0 +1,62 @@
+require 'bigdecimal'
+require 'date'
+require 'rexml/document'
+
+module RShoeboxed
+  class Receipt
+    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
+        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 total=(total)
+      total.gsub!(/[^\d|.]/, "") if total.is_a?(String)
+      total = BigDecimal.new(total) unless total.is_a?(BigDecimal)
+      
+      @total = total
+    end
+    
+    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)
+      @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

@@ -0,0 +1,14 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'rshoeboxed/receipt'
+require 'rshoeboxed/category'
+require 'rshoeboxed/business_card' 
+require 'rshoeboxed/connection'
+require 'rshoeboxed/list_proxy'
+require 'rshoeboxed/parse_error'
+
+module RShoeboxed
+  VERSION = '0.0.6'
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/rshoeboxed.rb'}"
+puts "Loading rshoeboxed gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/fixtures/category_request.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Request xmlns="urn:sbx:apis:SbxBaseComponents">
+  <RequesterCredentials>
+    <ApiUserToken>api_key</ApiUserToken>
+    <SbxUserToken>user_token</SbxUserToken>
+  </RequesterCredentials>
+  <GetCategoryCall/>
+</Request>

data/test/fixtures/category_response.xml

@@ -0,0 +1,7 @@
+<GetCategoryCallResponse>
+  <Categories>
+    <Category id="1" name="Category 1"/>
+    <Category id="2" name="Category 2"/>
+    <Category id="3" name="Category 3"/>
+  </Categories>
+</GetCategoryCallResponse>

data/test/fixtures/receipt_info_request.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Request xmlns="urn:sbx:apis:SbxBaseComponents">
+  <RequesterCredentials>
+    <ApiUserToken>api_key</ApiUserToken>
+    <SbxUserToken>user_token</SbxUserToken>
+  </RequesterCredentials>
+  <GetReceiptInfoCall>
+    <ReceiptFilter>
+      <ReceiptId>1</ReceiptId>
+    </ReceiptFilter>
+  </GetReceiptInfoCall>
+</Request>

data/test/fixtures/receipt_info_response.xml

@@ -0,0 +1,5 @@
+<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_request.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Request xmlns="urn:sbx:apis:SbxBaseComponents">
+  <RequesterCredentials>
+    <ApiUserToken>api_key</ApiUserToken>
+    <SbxUserToken>user_token</SbxUserToken>
+  </RequesterCredentials>
+  <GetReceiptCall>
+    <ReceiptFilter>
+      <Results>50</Results>
+      <PageNo>1</PageNo>
+      <DateStart>2008-01-01T00:00:00</DateStart>
+      <DateEnd>2009-01-01T00:00:00</DateEnd>
+      <UseSellDate>false</UseSellDate>
+    </ReceiptFilter>
+  </GetReceiptCall>
+</Request>

data/test/fixtures/receipt_response.xml

@@ -0,0 +1,14 @@
+<GetReceiptCallResponse>
+  <Receipts count="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/fixtures/receipt_response_bad_credentials.xml

@@ -0,0 +1 @@
+<Error code="1" description="Bad credentials" />

data/test/fixtures/receipt_response_internal_error.xml

@@ -0,0 +1 @@
+<Error code="5" description="Internal Error" /> 

data/test/fixtures/receipt_response_restricted_ip.xml

@@ -0,0 +1 @@
+<Error code="3" description="Restricted IP" />

data/test/fixtures/receipt_response_unknown_api_call.xml

@@ -0,0 +1 @@
+<Error code="2" description="Unknown API Call" />

data/test/fixtures/receipt_response_xml_validation.xml

@@ -0,0 +1 @@
+<Error code="4" description="XML Validation" /> 

data/test/fixtures/receipt_with_category_id_request.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Request xmlns="urn:sbx:apis:SbxBaseComponents">
+  <RequesterCredentials>
+    <ApiUserToken>api_key</ApiUserToken>
+    <SbxUserToken>user_token</SbxUserToken>
+  </RequesterCredentials>
+  <GetReceiptCall>
+    <ReceiptFilter>
+      <Results>50</Results>
+      <PageNo>1</PageNo>
+      <DateStart>2008-01-01T00:00:00</DateStart>
+      <DateEnd>2009-01-01T00:00:00</DateEnd>
+      <UseSellDate>true</UseSellDate>
+      <Category>10</Category>
+    </ReceiptFilter>
+  </GetReceiptCall>
+</Request>

data/test/test_category.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestCategory < Test::Unit::TestCase
+  include RShoeboxed
+
+  def setup
+  end
+  
+  def test_initialize_parse_xml
+     response = fixture_xml_content("category_response")
+     categories = Category.parse(response)
+     assert_equal 3, categories.size
+     
+     categories.each_with_index do |category, i|
+       category_id = (i+1).to_s
+       assert_equal category_id, category.id
+       assert_equal "Category #{category_id}", category.name
+     end
+   end
+  
+  def test_category__accessors
+    category = Category.new
+    assert category
+    
+    category.name = "Category 1"
+    assert_equal "Category 1", category.name
+    
+    category.id = "1"
+    assert_equal "1", category.id    
+  end
+end

data/test/test_connection.rb

@@ -0,0 +1,177 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestConnection < Test::Unit::TestCase
+  include RShoeboxed
+  
+  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
+    assert true
+  end
+  
+  def test_authentication_url__success_with_options
+    assert_equal "https://app.shoeboxed.com/ws/api.htm?appname=Bootstrap&appurl=http%3A%2F%2Fexample.com&apparams=test%3D1%26test2%3D1&SignIn=1", 
+      Connection.authentication_url("Bootstrap", "http://example.com", [[:test, 1], [:test2, 1]])
+  end
+  
+  
+  def test_authentication_url__success_no_options
+    assert_equal "https://app.shoeboxed.com/ws/api.htm?appname=Bootstrap&appurl=http%3A%2F%2Fexample.com&apparams=&SignIn=1", 
+      Connection.authentication_url("Bootstrap", "http://example.com")
+  end
+  
+  def test_connection__instantiate_object
+    assert_equal "api_key", @conn.api_key
+    assert_equal "user_token", @conn.user_token
+  end
+  
+  
+  def test_get_receipt_info_call__success_getting_one_receipt
+    request = fixture_xml_content("receipt_info_request")
+    response = fixture_xml_content("receipt_info_response")
+    
+    conn = Connection.new("api_key", "user_token")
+    conn.expects(:post_xml).with(request).returns(response)
+    
+    receipt = conn.get_receipt_info_call('1')
+    assert_not_nil receipt
+    assert_equal "1", receipt.id
+    assert_equal "Morgan Imports", receipt.store
+    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 [@category1], receipt.categories
+  end
+  
+  def test_build_receipt_info_call_request
+    assert_equal fixture_xml_content("receipt_info_request"), @conn.send(:build_receipt_info_request, "1")
+  end
+    
+  def test_get_receipt_call__success_getting_two_receipt
+    request = fixture_xml_content("receipt_request")
+    response = fixture_xml_content("receipt_response")
+    
+    conn = Connection.new("api_key", "user_token")
+    conn.expects(:post_xml).with(request).returns(response)
+    
+    receipts = conn.get_receipt_call(Date.new(2008, 1, 1), Date.new(2009, 1, 1))
+    assert_equal 2, receipts.total
+    assert_equal 1, receipts.current_page
+    assert_equal 50, receipts.per_page
+    assert_equal 1, receipts.pages
+    assert_equal 2, receipts.size
+    
+    receipt = receipts[0]
+    assert_equal "23984923842", receipt.id
+    assert_equal "Great Plains Trust Company", receipt.store
+    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 [@category1], receipt.categories
+    
+    receipt = receipts[1]
+    assert_equal "39239293", receipt.id
+    assert_equal "RadioShack", receipt.store
+    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 [@category2], receipt.categories
+  end
+  
+  def test_build_receipt_request
+    options = {
+      :per_page => 50,
+      :current_page => 1,
+      :use_sell_date => false
+    }
+    assert_equal fixture_xml_content("receipt_request"), 
+      @conn.send(:build_receipt_request, Date.new(2008, 1, 1), Date.new(2009, 1, 1), options)
+  end
+  
+  def test_build_receipt_request__category_filter
+    options = {
+      :per_page => 50,
+      :current_page => 1,
+      :use_sell_date => true,
+      :category_id => 10
+    }
+    assert_equal fixture_xml_content("receipt_with_category_id_request"), 
+      @conn.send(:build_receipt_request, Date.new(2008, 1, 1), Date.new(2009, 1, 1), options)
+  end
+  
+  def test_check_for_api_error__all_error_codes
+    assert_api_error_raised("receipt_response_bad_credentials", AuthenticationError, "Bad credentials")
+    assert_api_error_raised("receipt_response_unknown_api_call", UnknownAPICallError, "Unknown API Call")
+    assert_api_error_raised("receipt_response_restricted_ip", RestrictedIPError, "Restricted IP")
+    assert_api_error_raised("receipt_response_xml_validation", XMLValidationError, "XML Validation")
+    assert_api_error_raised("receipt_response_unknown_api_call", UnknownAPICallError, "Unknown API Call")
+  end
+  
+  def test_check_for_api_error__no_error
+    assert_nothing_raised do
+      assert_equal "", @conn.send(:check_for_api_error, "")
+    end
+    
+    response = fixture_xml_content("receipt_info_response")
+    assert_nothing_raised do
+      assert_equal response, @conn.send(:check_for_api_error, response)
+    end
+  end
+  
+  def test_date_to_s
+    assert_equal "2009-01-15T00:00:00", @conn.send(:date_to_s, Date.new(2009, 1, 15))
+    assert_equal "2010-02-13T05:10:23", @conn.send(:date_to_s, DateTime.new(2010, 2, 13, 5, 10, 23))
+    assert_equal "2008-03-14T12:13:14", @conn.send(:date_to_s, Time.utc(2008, 3, 14, 12, 13, 14))
+    assert_equal "2008-03-14T12:13:14", @conn.send(:date_to_s, "2008-03-14T12:13:14")
+  end
+  
+  def test_build_category_request
+    assert_equal fixture_xml_content("category_request"), @conn.send(:build_category_request)
+  end
+  
+  
+  def test_get_category_call
+    request = fixture_xml_content("category_request")
+    response = fixture_xml_content("category_response")
+
+    conn = Connection.new("api_key", "user_token")
+    conn.expects(:post_xml).with(request).returns(response)
+
+    categories = conn.get_category_call
+    assert_equal 3, categories.size
+
+    categories.each_with_index do |category, i|
+      category_id = (i + 1).to_s
+      assert_equal category_id, category.id
+      assert_equal "Category #{category_id}", category.name
+    end
+  end
+  
+private
+
+  def assert_api_error_raised(response_fixture, error_type, error_message)
+    response = fixture_xml_content(response_fixture)
+    begin
+      @conn.send(:check_for_api_error, response)
+      fail "#{error_type.to_s} was not thrown"
+    rescue error_type => e
+      assert_equal error_message, e.message
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../lib/rshoeboxed'
+
+require 'stringio'
+require 'test/unit'
+
+gem 'mocha'
+require 'mocha'
+
+class Test::Unit::TestCase
+  def fixture_xml_content(file_name)
+    # Quick way to remove white space and newlines from xml. Makes it easier to compare in tests
+    open(File.join(fixture_dir, "#{file_name}.xml"), "r").readlines.inject("") do |contents, line|
+      contents + line.strip
+    end
+  end
+  
+  def fixture_dir
+    File.join(File.dirname(__FILE__), "fixtures")
+  end
+end

data/test/test_list_proxy.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestConnection < Test::Unit::TestCase
+  include RShoeboxed
+  
+  def test_pages
+    proxy = ListProxy.new([], 39, 2, 20)
+    assert_equal 39, proxy.total
+    assert_equal 2, proxy.current_page
+    assert_equal 20, proxy.per_page
+    assert_equal 2, proxy.pages
+    
+    proxy = ListProxy.new([], 40, 2, 20)
+    assert_equal 2, proxy.pages
+    
+    proxy = ListProxy.new([], 0, 1, 20)
+    assert_equal 0, proxy.pages
+  end
+end

data/test/test_receipt.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+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
+    response = fixture_xml_content("receipt_info_response")
+    receipts = Receipt.parse(response)
+    assert_equal 1, receipts.size
+    
+    receipt = receipts.first
+    assert_equal "1", receipt.id
+    assert_equal "Morgan Imports", receipt.store
+    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 [@category1], receipt.categories
+  end
+  
+  def test_receipt__accessors
+    receipt = Receipt.new
+    assert receipt
+    
+    receipt.store = "Macy's"
+    assert_equal "Macy's", receipt.store
+    
+    receipt.id = "1"
+    assert_equal "1", receipt.id
+    
+    receipt.total = '$1,000.19'
+    assert_equal BigDecimal.new('1000.19'), receipt.total
+    
+    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.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

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: ffmike-rshoeboxed
+version: !ruby/object:Gem::Version 
+  version: 0.0.6
+platform: ruby
+authors: 
+- Ben Curren
+- William Chow
+- Mike Gunderloy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-13 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Ruby wrapper for the Shoeboxed API.
+email: 
+- ben@outright.com
+- will@outright.com
+- MikeG1@larkfarm.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- 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
+- script/generate
+- test/fixtures/category_request.xml
+- test/fixtures/category_response.xml
+- test/fixtures/receipt_info_request.xml
+- test/fixtures/receipt_info_response.xml
+- test/fixtures/receipt_request.xml
+- test/fixtures/receipt_response.xml
+- test/fixtures/receipt_response_bad_credentials.xml
+- test/fixtures/receipt_response_internal_error.xml
+- test/fixtures/receipt_response_restricted_ip.xml
+- test/fixtures/receipt_response_unknown_api_call.xml
+- test/fixtures/receipt_response_xml_validation.xml
+- test/fixtures/receipt_with_category_id_request.xml
+- test/test_category.rb
+- test/test_connection.rb
+- test/test_helper.rb
+- test/test_list_proxy.rb
+- test/test_receipt.rb
+has_rdoc: true
+homepage: http://github.com/bcurren/rshoeboxed
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rshoeboxed
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby wrapper for the Shoeboxed API.
+test_files: 
+- test/test_category.rb
+- test/test_connection.rb
+- test/test_helper.rb
+- test/test_list_proxy.rb
+- test/test_receipt.rb