kashflow 0.0.1

data/kashflow.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{kashflow}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Pogodan"]
+  s.date = %q{2010-12-31}
+  s.description = %q{A Ruby wrapper for the Kashflow Accouting SOAP API}
+  s.email = %q{paul@pogodan.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.mkd"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.mkd",
+    "Rakefile",
+    "VERSION",
+    "config/kf_api_methods.yml",
+    "kashflow.gemspec",
+    "lib/kashflow.rb",
+    "lib/kashflow/api.rb",
+    "lib/kashflow/api_method.rb",
+    "lib/kashflow/client.rb",
+    "test/helper.rb",
+    "test/test_kashflow.rb"
+  ]
+  s.homepage = %q{https://github.com/pogodan/kashflow}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Ruby wrapper for the Kashflow SOAP API}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_kashflow.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<savon>, ["~> 0.7.9"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<i18n>, [">= 0"])
+      s.add_development_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<savon>, ["~> 0.7.9"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<savon>, ["~> 0.7.9"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end
+

data/lib/kashflow/api.rb

@@ -0,0 +1,64 @@
+require 'open-uri'
+require 'nokogiri'
+require 'active_support/core_ext/object'
+require 'active_support/core_ext/hash'
+
+## Kashflow.export_yaml will scrape the public API site for methods and 
+## dump them into the YAML config we use. we probably can/should just get this
+## from the WSDL directly, but Savon wasn't working right, so this is the stopgap measure
+module Kashflow
+  class Api
+    class << self
+      
+      def api_page(path)
+        cache_path = File.join(Kashflow.root, 'tmp', 'kf_api_pages', path)
+        
+        unless File.exists?(cache_path)
+          File.open(cache_path, 'w'){ |f| f << open("http://accountingapi.com/#{path}").read }
+        end
+      
+        Nokogiri::HTML(open(cache_path))
+      end
+      
+      def apis_from_web
+        main_page = api_page('manual_class_customer.asp')
+        
+        main_page.search('#mr_manual_inner a').select do |node|
+          node['href'] =~ /manual_methods/ and
+          node['href'] != 'manual_methods_overview.asp'
+      
+        end.map{|n| new(n.content, n['href']) }
+      end
+      
+      def export_yaml
+        api_methods = apis_from_web.map { |a| ApiMethod.new(a.name, a.import) }
+        
+        File.open(Client.yaml_path, 'w') do |f|
+          YAML.dump(api_methods, f)
+        end
+      end
+    
+    end
+  
+    attr_reader :name, :page
+    def initialize(name, page)
+      @name = name
+      @page = page
+    end
+  
+    def api_page
+      @api_page ||= self.class.api_page(page)
+    end
+  
+    def import
+      @fields ||= api_page.search('.mnl_tbl1 tr').map do |row|
+        {
+          :name       => row.search('span.mnl_varName').first.try(:content),
+          :type       => row.search('span.mnl_varType').first.try(:content),
+          :direction  => row.search('td strong').first.try(:content),
+          :desc       => row.search('td').last.try(:content)
+        }
+      end
+    end
+  end
+end

data/lib/kashflow/api_method.rb

@@ -0,0 +1,19 @@
+module Kashflow
+  class ApiMethod
+    attr_accessor :name, :request_attrs, :response_attrs
+  
+    def initialize(name, fields)
+      @name = name
+    
+      # split into request/response attrs
+      @request_attrs, @response_attrs = fields.partition{|f| f[:direction] == 'IN' }.map do |arr| 
+        arr.map do |fields| 
+          # get rid of the :direction and cleanup the description text
+          fields.slice!(:type, :desc, :name)
+          fields[:desc].try(:strip!)
+          fields
+        end
+      end
+    end
+  end
+end

data/lib/kashflow/client.rb

@@ -0,0 +1,97 @@
+module Kashflow
+  class Client
+    attr_reader :service
+  
+    def self.yaml_path
+      File.join(Kashflow.root, 'config', 'kf_api_methods.yml')
+    end
+  
+    def self.api_methods
+      @@api_methods ||= YAML.load_file(yaml_path)
+    end
+  
+    def initialize(login, password)
+      raise "missing login/password" unless login and password
+    
+      @login, @password = login, password
+      @service = Savon::Client.new "https://securedwebapp.com/api/service.asmx?wsdl"
+    end
+  
+    def lookup_api_method(name)
+      self.class.api_methods.detect{ |api_method| api_method.name.underscore == name.to_s }
+    end
+  
+    def method_missing(m, *args, &block) 
+      api_method = lookup_api_method(m)
+    
+      if api_method
+        #puts "found api_method #{api_method.name} for #{m}: #{api_method.request_attrs.inspect}"
+        #puts "you're calling with #{args.inspect}"
+        
+        api_call(m, api_method.name, args)
+      else
+        raise "method_missing: No method for #{m}"
+      end
+    end
+  
+    def api_call(name, method, args)
+      soap_return = soap_call(name, method, args)
+      response = soap_return["#{name}_response".to_sym]
+      #puts "got response: " + response.inspect
+    
+      raise "API call failed: [#{response[:status_detail]}]\n\n #{response.inspect}" unless response[:status] == 'OK'
+    
+      r = response["#{name}_result".to_sym]
+    
+      if r.is_a?(Enumerable)
+        if r.values.all?{|v| v.is_a?(Array) }# || r.keys.size == 1
+          object_type, attrs = r.first
+        else
+          #puts "arrayifying #{r.inspect}"
+          object_type = lookup_api_method(name).response_attrs.first[:type]
+          attrs = r.first.last.is_a?(Hash) ? [r.first.last] : [r]
+        end
+      
+        #puts "it's an enumerable... #{object_type} | #{attrs.inspect}"
+      
+        ostructs = attrs.map do |record_attrs|
+          #puts "making new ostruct with #{record_attrs.inspect}"
+          OpenStruct.new(record_attrs.merge(:object_type => object_type.to_s))
+        end
+        #r.first.last
+      else
+        #puts "it's a #{r.class}"
+        r
+      end
+    end
+  
+    # called with CamelCase version of method name
+    def soap_call(name, method, params = {})
+      begin
+        result = @service.send(name) do |soap|
+          soap.action = "KashFlow/#{method}"
+        
+          params = params.pop if params.is_a?(Array)
+          params_xml = params.map do |field, value|
+            xml_tag = field.to_s.camelize
+            "<#{xml_tag}>#{value}</#{xml_tag}>"
+          end.join("\n") unless params.blank?
+        
+          soap.xml = %[<?xml version="1.0" encoding="utf-8"?>
+          <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+            <soap:Body>
+              <#{method} xmlns="KashFlow">
+                <UserName>#{@login}</UserName>
+                <Password>#{@password}</Password>
+                #{params_xml}
+              </#{method}>
+            </soap:Body>
+          </soap:Envelope>]
+        end.to_hash
+      rescue Savon::SOAPFault => e
+        puts "soap fault:" + e.inspect
+        return false
+      end
+    end
+  end
+end

data/lib/kashflow.rb

@@ -0,0 +1,21 @@
+require 'ostruct'
+require 'savon'
+
+require File.expand_path('../kashflow/client', __FILE__)
+require File.expand_path('../kashflow/api_method', __FILE__)
+require File.expand_path('../kashflow/api', __FILE__)
+
+module Kashflow
+  def self.client(login, password)
+    @client ||= Kashflow::Client.new(login, password)
+  end
+  
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+  
+  def self.root
+    File.dirname(File.expand_path('..', __FILE__))
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'kashflow'
+
+class Test::Unit::TestCase
+end

data/test/test_kashflow.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestKashflow < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification 
+name: kashflow
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Pogodan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-31 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: savon
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 7
+        - 9
+        version: 0.7.9
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: shoulda
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rcov
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: nokogiri
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: i18n
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: activesupport
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id008
+description: A Ruby wrapper for the Kashflow Accouting SOAP API
+email: paul@pogodan.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.mkd
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.mkd
+- Rakefile
+- VERSION
+- config/kf_api_methods.yml
+- kashflow.gemspec
+- lib/kashflow.rb
+- lib/kashflow/api.rb
+- lib/kashflow/api_method.rb
+- lib/kashflow/client.rb
+- test/helper.rb
+- test/test_kashflow.rb
+has_rdoc: true
+homepage: https://github.com/pogodan/kashflow
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the Kashflow SOAP API
+test_files: 
+- test/helper.rb
+- test/test_kashflow.rb