kelredd-wesabe 0.0.2

data/README.rdoc

@@ -0,0 +1,39 @@
+= Wesabe
+
+== Description
+
+A simplistic gem to assist in consuming the Wesabe API.
+
+== Installation
+
+    sudo gem install kelredd-wesabe --source http://gems.github.com
+
+== Usage
+
+    require 'wesabe'
+    # then include any wesabe helpers into your own models or scripts
+
+== License
+
+Copyright (c) 2009 Kelly Redding
+
+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,41 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/wesabe/version'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'wesabe'
+  s.version          = Wesabe::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "A simplistic gem to assist in consuming the Wesabe API."
+  s.author           = 'Kelly Redding'
+  s.email            = 'kelly@kelredd.com'
+  s.homepage         = ''
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,test}/**/*")
+  # s.executables    = ['wesabe']
+  
+  s.add_dependency('nokogiri', '> 1.2.3')
+  s.add_dependency('rest-client', '> 0.9.2')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end

data/lib/wesabe/configuration.rb

@@ -0,0 +1,5 @@
+module Wesabe
+  API_SITE = 'https://www.wesabe.com'
+  API_CONTENT_TYPES = ['application/xml']
+  API_DEFAULT_CONTENT_TYPE = API_CONTENT_TYPES.first
+end

data/lib/wesabe/exceptions.rb

@@ -0,0 +1,8 @@
+module Wesabe
+  class NotConfigured < StandardError
+  end
+  class ResourceAPIError < StandardError
+  end
+  class ResourceParseError < StandardError
+  end
+end

data/lib/wesabe/extensions.rb

@@ -0,0 +1,60 @@
+require 'cgi'
+
+module Wesabe
+  module Extensions   
+    module String
+      
+      module ClassMethods; end
+      def self.included(klass)
+        klass.extend(ClassMethods) if klass.kind_of?(Class)
+      end
+
+      module ClassMethods
+      end
+
+      def to_datetime
+        DateTime.strptime(self) rescue nil
+      end
+      def to_date
+        Date.strptime(self) rescue nil
+      end
+      
+    end
+  end
+end
+
+module Wesabe
+  module Extensions
+    module Hash
+
+      module ClassMethods; end
+      def self.included(klass)
+        klass.extend(ClassMethods) if klass.kind_of?(Class)
+      end
+
+      module ClassMethods
+      end
+
+      # Returns string formatted for HTTP URL encoded name-value pairs.
+      # For example,
+      #  {:id => 'thomas_hardy'}.to_http_str 
+      #  # => "id=thomas_hardy"
+      #  {:id => 23423, :since => Time.now}.to_http_str
+      #  # => "since=Thu,%2021%20Jun%202007%2012:10:05%20-0500&id=23423"
+      def to_http_query_str(opts = {})
+        opts[:prepend] ||= '?'
+        opts[:append] ||= ''
+        self.empty? ? '' : "#{opts[:prepend]}#{self.collect{|key, val| "#{key.to_s}=#{CGI.escape(val.to_s)}"}.join('&')}#{opts[:append]}"
+      end
+
+    end
+  end
+end
+
+class String
+  include Wesabe::Extensions::String
+end
+
+class Hash
+  include Wesabe::Extensions::Hash
+end

data/lib/wesabe/model/account.rb

@@ -0,0 +1,50 @@
+%w(base institution).each do |file|
+  require File.join(File.dirname(__FILE__), "#{file}.rb")
+end
+
+module Wesabe
+  module Model
+    class Account < Wesabe::Model::Base
+
+      def self.find(id)
+        case id
+        when :all
+          find_collection("/accounts", "//accounts/account")
+        else
+          super("/accounts/#{id}", "//account")
+        end
+      end
+      
+      attribute :id, :integer, :path => "id"
+      attribute :key, :string, :path => "guid"
+      attribute :number, :string, :path => "account-number"
+      attribute :name, :string, :path => "name"
+      attribute :account_type, :string, :path => "account-type"
+      attribute :balance, :float, :path => "current-balance"
+      attribute :last_uploaded_at, :datetime, :path => "last-uploaded-at"
+      attribute :oldest_transaction_on, :date, :path => "oldest-txaction"
+      attribute :newest_transaction_on, :date, :path => "newest-txaction"
+      
+      def institution
+        @institution ||= Wesabe::Model::Institution.new(get_node('./financial-institution'))
+      end
+      
+      def currency
+        node = get_node('./currency')
+        @currency ||= {
+          :symbol => node['symbol'],
+          :delimiter => node['delimiter'],
+          :separator => node['separator'],
+          :decimal_places => node['decimal_places'],
+          :type => node.content.to_s
+        }
+      end
+      
+      def to_s
+        self.id
+      end
+
+    end
+
+  end
+end

data/lib/wesabe/model/base.rb

@@ -0,0 +1,136 @@
+%w(rubygems rest_client nokogiri).each do |lib|
+  require lib
+end
+%w(configuration exceptions extensions).each do |file|
+  require File.join(File.dirname(__FILE__), "..", "#{file}.rb")
+end
+
+module Wesabe
+  module Model
+
+    class Base
+      @@user = nil
+      @@password = nil
+      @@content_type = Wesabe::API_DEFAULT_CONTENT_TYPE
+      
+      def self.resource
+        RestClient::Resource.new(Wesabe::API_SITE, :user => @@user, :password => @@password, :content_type => @@content_type)
+      end
+      @@api = resource
+      @@api_cache = {}
+      
+      attr_reader :xml
+
+      def self.configure(opts={})
+        @@user = opts[:user]
+        @@password = opts[:password]
+        @@content_type = opts[:content_type] if opts[:content_type] && Wesabe::API_CONTENT_TYPES.include?(opts[:content_type])
+        @@api = resource
+      end
+
+      def self.find(path, xpath)
+        new(get_xml(path).xpath(xpath))
+      end
+      def self.find_collection(path, xpath)
+        get_xml(path).xpath(xpath).collect{|item_xml| new(item_xml)}
+      end
+
+      def initialize(xml)
+        @xml = xml
+      end
+      
+      protected
+      
+      def self.get_xml(path)
+        self.resource_xml(:get, path)
+      end
+      def self.resource_xml(verb, path, force=false)
+        summary = "#{verb.to_s.upcase} #{@@api.url}#{path}"
+        key = cache_key(verb, path)
+        begin
+          resp = @@api_cache[key]
+          if resp.nil? || force
+            base_config_check
+            p "** Wesabe API: #{summary}"
+            resp = case verb.to_sym 
+            when :get
+              @@api["#{path}"].get
+            end
+            @@api_cache[key] = resp
+          else
+            p "** Wesabe API: [cache] #{summary}."
+          end
+        rescue Exception => err
+          raise Wesabe::ResourceAPIError, "error with API resource: #{summary}: #{err.message}"
+        end
+        begin
+          xml = Nokogiri::XML(resp.to_s)
+        rescue Exception => err
+          raise Wesabe::ResourceParseError, "error parsing API resource [#{@@content_type}]: #{summary}: #{err.message}: Response: #{resp.to_s}"
+        end
+        xml
+      end
+
+      def self.attribute(name, type, config)
+        raise Wesabe::NotConfigured, "no path provided for selecting the attribute '#{name}'." unless config[:path]
+        content_method = case type.to_sym
+        when :string
+          'to_s'
+        when :integer
+          'to_i'
+        when :float
+          'to_f'
+        when :date
+          'to_date'
+        when :datetime
+          'to_datetime'
+        else 
+          'to_s'
+        end
+        define_method(name) do
+          instance_variable_get("@#{name}") || instance_variable_set("@#{name}", get_node("./#{config[:path]}").content.send(content_method))
+        end
+      end
+      def self.get_node(xml, path)
+        xml.xpath(path.to_s).first
+      end
+      def get_node(path)
+        self.class.get_node(@xml, path)
+      end
+
+      def self.xml_root_name(xml)
+        xml.root.name
+      end
+      def xml_root_name
+        self.class.xml_root_name(@xml)
+      end
+
+      def self.cache_key(path, verb)
+        "#{verb}_#{path}"
+      end
+
+      def self.clear_cache
+        @@api_cache = {}
+      end
+      
+      def self.base_config_check
+        raise Wesabe::NotConfigured, "No user provided to access the Wesabe API" if blank?(@@user) 
+        raise Wesabe::NotConfigured, "No password provided to access the Wesabe API" if blank?(@@password) 
+        raise Wesabe::NotConfigured, "Wesabe not configured to access the API." if blank?(@@api) 
+      end
+      def base_config_check
+        self.class.base_config_check
+      end
+      
+      def self.blank?(value)
+        value.nil? || (value.respond_to?('empty?') ? value.empty? : false)
+      end
+      def blank?(value)
+        self.class.blank?(value)
+      end
+
+
+    end
+
+  end
+end

data/lib/wesabe/model/institution.rb

@@ -0,0 +1,16 @@
+%w(base).each do |file|
+  require File.join(File.dirname(__FILE__), "#{file}.rb")
+end
+
+module Wesabe
+  module Model
+
+    class Institution < Wesabe::Model::Base
+      
+      attribute :key, :string, :path => "id"
+      attribute :name, :string, :path => "name"
+     
+    end
+    
+  end
+end

data/lib/wesabe/model/merchant.rb

@@ -0,0 +1,16 @@
+%w(base).each do |file|
+  require File.join(File.dirname(__FILE__), "#{file}.rb")
+end
+
+module Wesabe
+  module Model
+
+    class Merchant < Wesabe::Model::Base
+      
+      attribute :key, :string, :path => "id"
+      attribute :name, :string, :path => "name"
+     
+    end
+    
+  end
+end

data/lib/wesabe/model/txaction.rb

@@ -0,0 +1,38 @@
+%w(base account merchant).each do |file|
+  require File.join(File.dirname(__FILE__), "#{file}.rb")
+end
+
+module Wesabe
+  module Model
+    class Txaction < Wesabe::Model::Base
+
+      def self.find(opts={})
+        acct = opts.delete(:account)
+        path = (acct ? "/accounts/#{acct.to_s}.xml" : "/transactions.xml")
+        path += opts.to_http_query_str if opts.respond_to?('to_http_query_str')
+        find_collection(path, "//txactions/txaction")
+      end
+      
+      attribute :key, :string, :path => "guid"
+      attribute :account_id, :string, :path => "account-id"
+      attribute :date, :date, :path => "date"
+      attribute :original_date, :date, :path => "original-date"
+      attribute :amount, :float, :path => "amount"
+      attribute :display_name, :string, :path => "display-name"
+      attribute :raw_name, :string, :path => "raw-name"
+      attribute :raw_type, :string, :path => "raw-txntype"
+      attribute :memo, :string, :path => "memo"
+      attribute :transfer_key, :string, :path => "transfer/guid"
+      
+      def account
+        @account ||= Wesabe::Model::Account.find(self.account_id)
+      end
+      
+      def merchant
+        @merchant ||= (get_node('./merchant') ? Wesabe::Model::Merchant.new(get_node('./merchant')) : nil)
+      end
+      
+    end
+
+  end
+end

data/lib/wesabe/model.rb

@@ -0,0 +1,3 @@
+Dir[File.join(File.dirname(__FILE__), "model" ,"*.rb")].each do |file|
+  require file
+end

data/lib/wesabe/version.rb

@@ -0,0 +1,13 @@
+module Wesabe
+  module Version
+    
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 2
+    
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

data/lib/wesabe.rb

@@ -0,0 +1,4 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'wesabe/model'
+

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+# http://sneaq.net/textmate-wtf
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+require 'test/unit'
+require 'matchy'
+require 'context'
+require 'mocha'
+
+require File.dirname(__FILE__) + '/../lib/wesabe'

data/test/unit/wesabe_test.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class WesabeTest < Test::Unit::TestCase
+
+  describe "An instance of the Wesabe class" do
+
+    it "should flunk" do
+      flunk "Please provide some tests"
+    end
+    
+  end
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: kelredd-wesabe
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Kelly Redding
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+description: 
+email: kelly@kelredd.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/wesabe
+- lib/wesabe/configuration.rb
+- lib/wesabe/exceptions.rb
+- lib/wesabe/extensions.rb
+- lib/wesabe/model
+- lib/wesabe/model/account.rb
+- lib/wesabe/model/base.rb
+- lib/wesabe/model/institution.rb
+- lib/wesabe/model/merchant.rb
+- lib/wesabe/model/txaction.rb
+- lib/wesabe/model.rb
+- lib/wesabe/version.rb
+- lib/wesabe.rb
+- test/test_helper.rb
+- test/unit
+- test/unit/wesabe_test.rb
+has_rdoc: true
+homepage: ""
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A simplistic gem to assist in consuming the Wesabe API.
+test_files: []
+