kashflow_api 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80713598b9cc6087bc6f5c8fb1e8dddbc08b8638
-  data.tar.gz: 6028013836e547246697247fc46c2158c6f285af
+  metadata.gz: 83aa2d3d9328488253625f5a8c757a8c15f284b2
+  data.tar.gz: 8165b45aeac0f6c38dde74a7000032ba4efb8dcb
 SHA512:
-  metadata.gz: 444553516b639eb4b7b8df00a8bdedc21c27f53361c03f1c9ca2f4c9ca3a78f5230665e35f7baf651d57e4dca2cf2d3dffb0ecba5962bbc6887b3d40963c4443
-  data.tar.gz: 91b2b8e5790b87199677dfe67b5b436a8424d591995917f8538c93f7d8fa70a3976d35dddf04ca27b355dd5a4b6abd1d4d0624d33d93aa8476023da41b4b6fd4
+  metadata.gz: f387a0516f4edd4600f49da3d8cdbd5dfbbaebffcb597a0f49e0d50c32fbcd254af25b951e55258303f63e0d468678a322737bd1a286ab2f8f81c981f475015a
+  data.tar.gz: 3a2fc5bad8acdcc8494fea8587002b8bae8b90ccdd2c0cf55da4fafe90d71d10a68f18093ab8b123a329a686134b8d3b68c14b42486e77b7526a5d065bff80ac

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 spec/test_data.yml
 coverage/*
+spec-old/test_data.yml

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+ - 1.9.3
+ - 2.0.0
+ - rbx-19mode
+ - ruby-head
+env:
+ - "rake=0.9"
+script: "bundle exec rspec -c"
+notifications:
+  email: false
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -1,4 +1,6 @@
 source "http://rubygems.org"
 
+gem 'coveralls', require: false
+
 # Specify your gem's dependencies in kashflow_api.gemspec
 gemspec

data/README.markdown

@@ -1,23 +1,45 @@
 # KashflowApi
 
+[![Build Status](https://travis-ci.org/Ed-ITSolutions/KashflowAPI.png?branch=master)](https://travis-ci.org/Ed-ITSolutions/KashflowAPI) [![Code Climate](https://codeclimate.com/github/Ed-ITSolutions/KashflowAPI.png)](https://codeclimate.com/github/Ed-ITSolutions/KashflowAPI) [![Coverage Status](https://coveralls.io/repos/Ed-ITSolutions/KashflowAPI/badge.png)](https://coveralls.io/r/Ed-ITSolutions/KashflowAPI)
+
 KashflowApi provides an Active Record like interface to the Kashflow API.
 
+# Install
+
+You can install KashflowApi by adding it yo your `Gemfile` like this:
+
+```ruby
+gem 'kashflow_api'
+```
+
+and running `bundle install`
+
 # Usage
 
 At the beginning of your program, or in an rails initializer call the configure block like so:
 
-    KashflowApi.configure do |c|
-        c.username = "Username"
-		c.password = "Password"
-		c.loggers = false
-	end
+``` ruby
+KashflowApi.configure do |c|
+  c.username = "Username"
+  c.password = "Password"
+  c.loggers = false
+end
+```
 	
 I recommend settings loggers to false so that you don't get all the soap exchanges echoed out.
 
 You can now call methods on the models e.g.
 
-	KashflowApi::Customer.all
+``` ruby
+KashflowApi::Customer.all
+KashflowApi::Customer.find("Cust01")
+KashflowApi::Customer.find_by_email("customer@domain.tld")
+```
+
+## Saving
+
+All the Kashflow objects in the gem have a `.save` method which will either insert a new record or update the current one.
 
 # More Info
 
-For more info head over to the [wiki][https://github.com/Ed-ITSolutions/KashflowAPI/wiki]
+For more info head over to the [wiki](https://github.com/Ed-ITSolutions/KashflowAPI/wiki)

data/kashflow_api.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |s|
   
   # Development Dependencies
   s.add_development_dependency "rspec"
-  s.add_development_dependency "simplecov"
   
   # Runtime Dependencies
   s.add_runtime_dependency "savon", "~> 2.3"
+  s.add_runtime_dependency "expects", "~> 0.0.3"
 end

data/lib/kashflow_api.rb

@@ -1,5 +1,40 @@
 # Gems
+require 'expects'
 require "savon"
+
+module KashflowApi
+  def self.configure
+    @config = Config.new
+    yield @config
+    @api = Api.new
+  end
+  
+  def self.config
+    @config
+  end
+    
+  def self.api
+    @api
+  end
+  
+  def self.api_methods
+    @api_methods ||= Api.method_list
+  end
+  
+  def self.client
+    @client ||= Client.new(@config)
+  end
+  
+  def self.soap_objects
+    @soap_objects ||= []
+  end
+  
+  def self.add_soap_object(klass)
+    @soap_objects ||= []
+    @soap_objects.push klass
+  end
+end
+
 # Kashflow Main Clases
 require "kashflow_api/soap_object"      # Soap Object Class
 require "kashflow_api/config"           # Config Class
@@ -18,27 +53,3 @@ require "kashflow_api/models/receipt"   # Receipt Class
 require "kashflow_api/models/supplier"  # Supplier
 # Version
 require "kashflow_api/version"
-
-module KashflowApi
-    def self.configure
-        @config = Config.new
-        yield @config
-        @api = Api.new
-    end
-    
-    def self.config
-        @config
-    end
-    
-    def self.api
-        @api
-    end
-    
-    def self.api_methods
-        @api_methods ||= Api.methods
-    end
-    
-    def self.client
-        @client ||= Client.new(@config)
-    end
-end

data/lib/kashflow_api/api.rb

@@ -1,29 +1,29 @@
 module KashflowApi
-    class Api        
-        def initialize
-            unless KashflowApi.config.username && KashflowApi.config.password
-               raise "Username and Password required" 
-            end
-        end
-        
-        def self.methods
-            @methods ||= generate_method_list
-        end
-        
-        # Main Handler
-        def method_missing(method, argument = nil)
-            methods = KashflowApi.api_methods
-            if methods.include?(method)
-                KashflowApi::ApiCall.new(method, argument).result
-            else
-                super
-            end
-        end
-        
-        private
-        
-        def self.generate_method_list
-            KashflowApi.client.client.operations
+  class Api        
+    def initialize
+      unless KashflowApi.config.username && KashflowApi.config.password
+        raise "Username and Password required" 
+      end
+      
+      init_class
+    end
+    
+    def self.method_list
+      @methods ||= generate_method_list
+    end
+    
+    private
+    
+    def init_class
+      KashflowApi.api_methods.each do |method|
+        self.class.send(:define_method, method) do |argument = nil| 
+          KashflowApi::ApiCall.new(method, argument).make_call
         end
+      end
+    end
+    
+    def self.generate_method_list
+      KashflowApi.client.client.operations
     end
+  end
 end

data/lib/kashflow_api/api_call.rb

@@ -6,8 +6,11 @@ module KashflowApi
             @method_sym = method.to_sym
             set_method(method)
             build_xml(argument)
-            raise xml if @raise
-            @result = make_call
+            return self
+        end
+        
+        def make_call
+            KashflowApi.client.call(self)
         end
         
         private
@@ -48,60 +51,21 @@ module KashflowApi
             <Password>#{KashflowApi.config.password}</Password>\n"
         end
         
-        def make_call
-            KashflowApi.client.call(self)
-        end
-        
         def argument_xml(argument)
-            out = ""
-            if argument
-                if @action == "get"
-                    if @object == "customer" 
-                        out = "<Customer#{@field}>#{argument}</Customer#{@field}>"
-                    elsif @object == "customers"
-                        out = "<#{@field}>#{argument}</#{@field}>"
-                    elsif @object == "quote"
-                        out = "<Quote#{@field}>#{argument}</Quote#{@field}>"
-                    elsif @object == "supplier"
-                        out = "<Supplier#{@field}>#{argument}</Supplier#{@field}>"
-                    elsif @object == "receipt"
-                        out = "<ReceiptNumber>#{argument}</ReceiptNumber>"
-                    elsif @object == "invoice"
-                        out = "<InvoiceNumber>#{argument}</InvoiceNumber>"
-                    end
-                elsif @action == "update" || @action == "insert"
-                    if @object == "customer"
-                        out = "<custr>#{argument.to_xml}</custr>"
-                    elsif @object == "supplier"
-                        if @action == "insert"
-                            out = "<supl>#{argument.to_xml}</supl>"
-                        else
-                            out = "<sup>#{argument.to_xml}</sup>"
-                        end
-                    elsif @object == "receipt"
-                        if @field == "Line"
-                            out = "<ReceiptID>#{argument.receiptid}</ReceiptID><InvLine>#{argument.to_xml}</InvLine>"
-                        elsif @field == "Number"
-                            out = "<ReceiptNumber>#{argument.receiptnumber}</ReceiptNumber><InvLine>#{argument.to_xml}</InvLine>"
-                        else
-                            out = "<Inv>#{argument.to_xml}</Inv>"
-                        end
-                    elsif @object == "invoice"
-                        if @field == "Line"
-                            out = "<InvoiceID>#{argument.invoiceid}</InvoiceID><InvLine>#{argument.to_xml}</InvLine>"
-                        elsif @field == "Number"
-                            out = "<InvoiceNumber>#{argument.invoicenumber}</InvoiceNumber><InvLine>#{argument.to_xml}</InvLine>"
-                        else
-                            out = "<Inv>#{argument.to_xml}</Inv>"
-                        end
-                    end
-                elsif @action == "delete"
-                    if @object == "customer"
-                        out = "<CustomerID>#{argument}</CustomerID>"
-                    end
-                end
-            end
-            out
+          case @object
+          when "customer" || "customers"
+            return KashflowApi::Customer.build_arguments(@action, @object, @field, argument)
+          when "invoice"
+            return KashflowApi::Invoice.build_arguments(@action, @object, @field, argument)
+          when "quote"
+            return KashflowApi::Quote.build_arguments(@action, @object, @field, argument)
+          when "receipt"
+            return KashflowApi::Receipt.build_arguments(@action, @object, @field, argument)
+          when "supplier"
+            return KashflowApi::Supplier.build_arguments(@action, @object, @field, argument)
+          else
+            return ""
+          end
         end
     end
 end

data/lib/kashflow_api/client.rb

@@ -1,25 +1,27 @@
 module KashflowApi
-    class Client
-        def initialize(config)
-            @config = config
-            @url = "https://securedwebapp.com/api/service.asmx?WSDL"
-       
-            @client = Savon.client(wsdl: @url, log: @config.loggers)
-        end
-        
-        def call(api_call)
-          #"KashFlow/#{api_call.method}"
-            #result = @client.xml_call(api_call.method_sym, api_call)
-            result = @client.call(api_call.method_sym, xml: api_call.xml)
-            raise "Incorrect username or password" if result.to_hash.first.last[:status_detail] == "Incorrect username or password"
-            raise "Your IP Address is not in the access list!" if result.to_hash.first.last[:status_detail] =~ /The IP address of .*? is not in the access list/
-            #raise api_call.xml if result.to_hash.first.last[:status] == "NO"
-            raise "Kashflow Error: #{result.to_hash.first.last[:status_detail]}" if result.to_hash.first.last[:status] == "NO"
-            return result
-        end
-        
-        def client
-            @client
-        end
+  class Client
+    include Expects
+    
+    attr_reader :client
+    
+    def initialize(config)
+      expects config, KashflowApi::Config
+      
+      @config = config
+      @url = "https://securedwebapp.com/api/service.asmx?WSDL"
+      @client = Savon.client(wsdl: @url, log: @config.loggers)
     end
+    
+    def call(api_call)
+      result = @client.call(api_call.method_sym, xml: api_call.xml)
+      handle_errors(result.to_hash)
+      return result
+    end
+    
+    def handle_errors(hash)
+      raise "Incorrect username or password" if hash.first.last[:status_detail] == "Incorrect username or password"
+      raise "Your IP Address is not in the access list!" if hash.first.last[:status_detail] =~ /The IP address of .*? is not in the access list/
+      raise "Kashflow Error: #{result.to_hash.first.last[:status_detail]}" if hash.first.last[:status] == "NO"
+    end
+  end
 end

data/lib/kashflow_api/models/customer.rb

@@ -1,86 +1,43 @@
 module KashflowApi
-    class Customer < KashflowApi::SoapObject    
-        def self.find(search)
-            self.find_by_customer_code(search)
-        end
-        
-        def self.find_by_customer_code(search)
-            result = KashflowApi.api.get_customer(search)
-            self.build_from_soap(result.hash[:envelope][:body][:get_customer_response][:get_customer_result])
-        end
-        
-        def self.find_by_customer_id(search)
-            result = KashflowApi.api.get_customer_by_id(search)
-            self.build_from_soap(result.hash[:envelope][:body][:get_customer_by_id_response][:get_customer_by_id_result])
-        end
-        
-        def self.find_by_customer_email(search)
-            result = KashflowApi.api.get_customer_by_email(search)
-            self.build_from_soap(result.hash[:envelope][:body][:get_customer_by_email_response][:get_customer_by_email_result])
-        end
-        
-        def self.find_by_postcode(search)
-            result = KashflowApi.api.get_customers_by_postcode(search)
-            self.build_from_soap(result.hash[:envelope][:body][:get_customers_by_postcode_response][:get_customers_by_postcode])
-        end
-        
-        def self.all
-            result = KashflowApi.api.get_customers
-            customers = []
-            result.hash[:envelope][:body][:get_customers_response][:get_customers_result][:customer].each do |customer|
-                customers.push self.build_from_soap customer
-            end
-            customers
-        end
-        
-        def save
-           if @hash[:customer_id] == "0"
-               insert_customer
-           else
-               update_customer
-           end 
-        end
-        
-        def destroy
-            KashflowApi.api.delete_customer(self.customer_id)
-        end
-        
-        def balance
-            KashflowApi::CustomerBalance.new(self)
-        end
-        
-        def to_xml
-            xml = []
-            id_line = ""
-            @hash.keys.each do |key|
-                if key == :customer_id
-                    id_line = "<CustomerID>#{@hash[key]}</CustomerID>" unless @hash[key] == "0"
-                else
-                  key_name = key.to_s.split('_').map{|e| e.capitalize}.join
-                    xml.push("<#{key_name}>#{@hash[key]}</#{key_name}>")
-                end
-            end
-            [id_line, xml.join].join
-        end
-        
-        private
-        
-        def blank_object_hash
-            {"Code" => "", "Name" => "", "Contact" => "", "Telephone" => "", "Mobile" => "", "Fax" => "", "Email" => "", "Address1" => "", "Address2" => "",
-                "Address3" => "", "Address4" => "", "Postcode" => "", "Website" => "", "Notes" => "", "ExtraText1" => "", "ExtraText2" => "",
-                "ExtraText3"  => "", "ExtraText4" => "", "ExtraText5" => "", "ExtraText6" => "", "ExtraText7" => "", "ExtraText8" => "", "ExtraText9"  => "",
-                "ExtraText10" => "", "ExtraText11" => "", "ExtraText12" => "", "ExtraText13" => "", "ExtraText14" => "", "ExtraText15" => "",
-                "ExtraText16" => "", "ExtraText17" => "", "ExtraText18" => "", "ExtraText19" => "", "ExtraText20" => "", "ContactTitle" => "",
-                "ContactFirstName" => "", "ContactLastName" => "", "CustHasDeliveryAddress" => "0", "DeliveryAddress1" => "",
-                "DeliveryAddress2" => "", "DeliveryAddress3" => "", "DeliveryAddress4" => "", "DeliveryPostcode"  => ""}.merge(KashflowApi::Customer.find("").hash)
-        end
-        
-        def update_customer
-            KashflowApi.api.update_customer(self)
-        end
-        
-        def insert_customer
-            KashflowApi.api.insert_customer(self)
-        end
+  class Customer < KashflowApi::SoapObject
+    
+    Keys = [
+      "Code", "Name", "Contact", "Telephone", "Mobile", "Fax", "Email", "Address1", "Address2", "Address3", "Address4", "Postcode",
+      "Website", "Notes", "ExtraText1", "ExtraText2", "ExtraText3", "ExtraText4", "ExtraText5", "ExtraText6", "ExtraText7", "ExtraText8",
+      "ExtraText9", "ExtraText10", "ExtraText11", "ExtraText12", "ExtraText13", "ExtraText14", "ExtraText15", "ExtraText16", "ExtraText17",
+      "ExtraText18", "ExtraText19", "ExtraText20", "ContactTitle", "ContactFirstName", "ContactLastName", ["CustHasDeliveryAddresss", "0"],
+      "DeliveryAddress1", "DeliveryAddress2", "DeliveryAddress3", "DeliveryAddress4", "DeliveryPostcode"
+    ]
+        
+    Finds = [ "code", "id", "email", "postcode" ]
+    
+    KFObject = { singular: "customer", plural: "customers" }
+    
+    XMLKey = "CustomerID"
+    
+    define_methods
+    
+    def self.build_arguments(action, object, field, argument)
+      if action == "get"
+        expects argument, String
+        return "<Customer#{field}>#{argument}</Customer#{field}>" if object == "customer"
+        return "<#{field}>#{argument}</#{field}>" if object == "customers"
+      elsif action == "update" || action == "insert"
+        expects argument, KashflowApi::Customer
+        return "<custr>#{argument.to_xml}</custr>" if object == "customer"
+      end
+    end
+    
+    def save
+      if @hash[:customer_id] == "0"
+        insert_customer
+      else
+        update_customer
+      end 
+    end
+    
+    def balance
+      KashflowApi::CustomerBalance.new(self)
     end
-end
+  end
+end