kashflow_api 0.0.3 → 0.1.0

data/lib/kashflow_api/version.rb

@@ -1,3 +1,3 @@
 module KashflowApi
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/spec-old/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'yaml'
+require './lib/kashflow_api'
+
+def default_config
+    KashflowApi.configure do |c|
+        c.username = yaml["username"]
+        c.password = yaml["password"]
+        c.loggers = false
+    end
+end
+
+def yaml
+    @yaml ||= YAML::load(File.open('spec/test_data.yml'))
+end
+
+def test_data(field)
+    @yaml[field]
+end

data/spec/core/api_call_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe KashflowApi::ApiCall do
+  let(:config) do
+    KashflowApi.configure do |c|
+      c.username = "Foo"
+      c.password = "bar"
+      c.loggers = false
+    end
+  end
+  
+  let(:example_customer) do
+    hash = {}
+    KashflowApi::Customer::Keys.each do |key|
+      hash[[*key].first] = "foo"
+    end
+    KashflowApi::Customer.new(hash)
+  end
+  
+  it "should take a method and an argument" do
+    config
+    
+    KashflowApi::ApiCall.new("foo_bar", "bar")
+  end
+end

data/spec/core/api_spec.rb

@@ -0,0 +1,31 @@
+describe KashflowApi::Api do
+  let(:config) do
+    KashflowApi.blank
+    
+    KashflowApi.configure do |c|
+      c.username = "foo"
+      c.password = "bar"
+      c.loggers = false
+    end
+  end
+  
+  it "should require configuring" do
+    KashflowApi.blank
+    
+    KashflowApi.api.should be_nil
+  end
+  
+  it "should have a methods list" do
+    config
+    
+    KashflowApi.api_methods.should be_a Array
+    KashflowApi::Api.methods.should be_a Array
+    KashflowApi::Api.methods.length.should >= 10
+  end
+  
+  it "should define the methods on itself" do
+    a_method = KashflowApi.api_methods[10]
+    
+    KashflowApi::Api.new().methods.include?(a_method).should be_true
+  end
+end

data/spec/core/client_spec.rb

@@ -0,0 +1,23 @@
+describe KashflowApi::Client do
+  let(:config_object) do
+    config = KashflowApi::Config.new
+    config.username = "foo"
+    config.password = "foo"
+    config
+  end
+  
+  let(:instance) do
+    KashflowApi::Client.new(config_object)
+  end
+  
+  it "should take a config object" do
+    lambda { KashflowApi::Client.new("foo") }.should raise_exception
+    lambda { KashflowApi::Client.new(config_object) }.should_not raise_exception
+  end
+  
+  it "should raise errors" do
+    lambda { instance.handle_errors([{stauts_detail: "Incorrect username or password"}]) }.should raise_exception
+    lambda { instance.handle_errors([{stauts_detail: "The IP address of 127.0.0.1 is not in the access list"}]) }.should raise_exception
+    lambda { instance.handle_errors([{status: "NO", stauts_detail: "There was a problem"}]) }.should raise_exception
+  end
+end

data/spec/core/kashflow_api_spec.rb

@@ -0,0 +1,14 @@
+#require 'spec_helper'
+
+describe KashflowApi do
+  it "should accept a config block" do
+    KashflowApi.configure do |c|
+      c.username = "foo"
+      c.password = "bar"
+    end
+  end
+  
+  it "should raise an exception if you don't provide a username and password" do
+    lambda { KashflowApi.configure do |c| end }.should raise_exception
+  end
+end

data/spec/core/soap_object_spec.rb

@@ -0,0 +1,25 @@
+describe KashflowApi::SoapObject do
+
+  let(:test_hash) do
+    { "CustomerID" => 1234, "Code" => "CUST01" }
+  end
+  
+  let(:instance) do
+    KashflowApi::SoapObject.new(test_hash)
+  end
+  
+  it "should take a hash" do
+    lambda { instance }.should_not raise_exception
+    lambda { KashflowApi::SoapObject.new("foo") }.should raise_exception
+  end
+  
+  it "should create additional methods" do
+    instance.customerid = 12345
+    instance.customerid.should eq 12345
+  end
+  
+  it "should have placed some classes into the soap_objects array" do
+    KashflowApi.soap_objects.should be_a Array
+    KashflowApi.soap_objects.first.should be_a Class
+  end
+end

data/spec/objects/customer_spec.rb

@@ -0,0 +1,11 @@
+describe KashflowApi::Customer do
+  include ModelMacros
+  
+  it_should_be_a_soap_model(KashflowApi::Customer)
+  it_should_have_arguments(KashflowApi::Customer, :get_customer, "foo", /CustomerCode/, :insert_customer, /custr/)
+  
+  it "should make a call for all" do
+    results = KashflowApi::Customer.all
+    results.first.api_call.should be_a KashflowApi::ApiCall
+  end
+end

data/spec/objects/inherited_methods_spec.rb

@@ -0,0 +1,45 @@
+describe "Inherited Methods" do
+  class SampleClass < KashflowApi::SoapObject
+    Keys = [ "Foo", "Bar", ["Widget", "hello"] ]
+
+    Finds = [ "foo", "bar" ]
+      
+    KFObject = { singular: "foo", plural: "foos" }
+    
+    XMLKey = "Foo"
+    
+    define_methods
+  end
+  
+  it "should define find_* methods" do
+    SampleClass.methods.include?(:find_by_bar).should be_true
+  end
+  
+  it "should define find" do
+    SampleClass.methods.include?(:find).should be_true
+  end
+  
+  it "should set the find_method" do
+    SampleClass.find_method.should eq :find_by_foo
+    SampleClass.send(SampleClass.find_method, "foo")
+  end
+  
+  it "should find all" do
+    SampleClass.all.should be_a Array
+  end
+  
+  it "should find by bar" do
+    SampleClass.find_by_bar("search")
+  end
+  
+  it "should set defaults in hash" do
+    instance = SampleClass.new
+    instance.foo.should eq ""
+    instance.widget.should eq "hello"
+  end
+  
+  it "should generate some HTML" do
+    instance = SampleClass.new
+    instance.to_xml.should be_a String
+  end
+end

data/spec/objects/invoice_spec.rb

@@ -0,0 +1,6 @@
+describe KashflowApi::Invoice do
+  include ModelMacros
+  
+  it_should_be_a_soap_model(KashflowApi::Invoice)
+  it_should_have_arguments(KashflowApi::Invoice, :get_invoice, "100", /<InvoiceNumber>/, :insert_invoice, /<Inv>/)
+end

data/spec/objects/line_spec.rb

@@ -0,0 +1,5 @@
+describe KashflowApi::Line do
+  include ModelMacros
+  
+  it_should_be_a_soap_model(KashflowApi::Line)
+end

data/spec/objects/nominal_code_spec.rb

@@ -0,0 +1,5 @@
+describe KashflowApi::NominalCode do
+  include ModelMacros
+  
+  it_should_be_a_soap_model(KashflowApi::NominalCode)
+end

data/spec/objects/quote_spec.rb

@@ -0,0 +1,10 @@
+describe KashflowApi::Quote do
+  include ModelMacros
+  
+  it_should_be_a_soap_model(KashflowApi::Quote)
+  it_should_have_arguments(KashflowApi::Quote, :get_quote_by_number, "100", /<QuoteNumber>/, :insert_quote, /<Inv>/)
+  
+  it "should have overriden kfobjects from invoice" do
+    KashflowApi::Quote::KFObject[:singular].should eq "quote"
+  end
+end

data/spec/objects/receipt_spec.rb

@@ -0,0 +1,6 @@
+describe KashflowApi::Receipt do
+  include ModelMacros
+  
+  it_should_be_a_soap_model(KashflowApi::Receipt)
+  it_should_have_arguments(KashflowApi::Receipt, :get_receipt, "100", /<ReceiptNumber>/, :insert_receipt, /<Inv>/)
+end

data/spec/objects/supplier_spec.rb

@@ -0,0 +1,6 @@
+describe KashflowApi::Supplier do
+  include ModelMacros
+  
+  it_should_be_a_soap_model(KashflowApi::Supplier)
+  it_should_have_arguments(KashflowApi::Supplier, :get_supplier, "100", /<SupplierCode>/, :insert_supplier, /<supl>/)
+end

data/spec/spec_helper.rb

@@ -1,21 +1,66 @@
 require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
 SimpleCov.start
 
-require 'yaml'
-require './lib/kashflow_api'
+require 'kashflow_api'
 
-def default_config
-    KashflowApi.configure do |c|
-        c.username = yaml["username"]
-        c.password = yaml["password"]
-        c.loggers = false
-    end
-end
-
-def yaml
-    @yaml ||= YAML::load(File.open('spec/test_data.yml'))
-end
+require 'support/macros'
 
-def test_data(field)
-    @yaml[field]
+module KashflowApi
+  def self.blank
+    @api = nil
+    @client = nil
+    @config = nil
+  end
+  
+  class Client
+    def call(api_call)
+      klass = Class.new do
+        def initialize(call)
+          @call = call
+        end
+        
+        def hash
+          { envelope: { body: { get_customers_response: { get_customers_result: { customer: [ { api_call: @call } ] } } } } }
+        end
+      end
+      return klass.new(api_call)
+    end
+  end
+  
+  class Api
+    def get_foos
+      klass = Class.new do
+        def hash
+          { envelope: { body: { get_foos_response: { get_foos_result: { foo: [] } } } } }
+        end
+      end
+      
+      return klass.new
+    end
+    
+    def get_foo(search)
+      klass = Class.new do
+        def hash
+          { envelope: { body: { get_foo_response: { get_foo_result: { foo: [] } } } } }
+        end
+      end
+      
+      return klass.new
+    end
+    
+    def get_foo_by_bar(search)
+      klass = Class.new do
+        def hash
+          { envelope: { body: { get_foo_by_bar_response: { get_foo_by_bar_result: { foo: [] } } } } }
+        end
+      end
+      
+      return klass.new
+    end
+  end
 end

data/spec/support/macros.rb

@@ -0,0 +1,53 @@
+module ModelMacros
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    def it_should_be_a_soap_model(klass)
+      it "should have the correct constants" do
+        klass::Keys.should be_a Array
+        klass::Finds.should be_a Array
+        klass::KFObject.should be_a Hash
+        klass::XMLKey.should be_a String
+      end
+      
+      it "should have a new object hash" do
+        klass.new.methods.include?(klass::Keys.first.downcase.to_sym).should be_true
+      end
+    end
+    
+    def it_should_have_arguments(klass, get_method, get_argument, get_should_find, complex_method, complex_should_find)
+      it "should have the build_arguments method" do
+        klass.methods.include?(:build_arguments).should be_true
+      end
+      
+      it "should have 2 branches to build_arguments" do
+        klass.build_arguments(:foo, :bar, :widget, "string")
+        klass.build_arguments(:foo, :bar, :widget, klass.new)
+      end
+      
+      it "should be called by ApiCall" do
+        KashflowApi.configure do |c|
+          c.username = "foo"
+          c.password = "bar"
+          c.loggers = false
+        end
+    
+        call = KashflowApi::ApiCall.new(get_method, get_argument)
+        call.xml.should =~ get_should_find
+      end
+      
+      it "should be called by ApiCall" do
+        KashflowApi.configure do |c|
+          c.username = "foo"
+          c.password = "bar"
+          c.loggers = false
+        end
+    
+        call = KashflowApi::ApiCall.new(complex_method, klass.new)
+        call.xml.should =~ complex_should_find
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kashflow_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Adam "Arcath" Laycock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '2.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: savon
+  name: expects
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 0.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 0.0.3
 description: Provides an interface for the Kashflow API
 email:
 - gems@arcath.net
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.markdown
 - Rakefile
@@ -79,15 +80,30 @@ files:
 - lib/kashflow_api/models/supplier.rb
 - lib/kashflow_api/soap_object.rb
 - lib/kashflow_api/version.rb
-- spec/kashflow_api_customer_balance_spec.rb
-- spec/kashflow_api_customer_spec.rb
-- spec/kashflow_api_nominal_codes_spec.rb
-- spec/kashflow_api_quote_spec.rb
-- spec/kashflow_api_receipt_spec.rb
-- spec/kashflow_api_spec.rb
-- spec/kashflow_api_supplier_spec.rb
+- spec-old/kashflow_api_customer_balance_spec.rb
+- spec-old/kashflow_api_customer_spec.rb
+- spec-old/kashflow_api_nominal_codes_spec.rb
+- spec-old/kashflow_api_quote_spec.rb
+- spec-old/kashflow_api_receipt_spec.rb
+- spec-old/kashflow_api_spec.rb
+- spec-old/kashflow_api_supplier_spec.rb
+- spec-old/spec_helper.rb
+- spec-old/test_data.example.yml
+- spec/core/api_call_spec.rb
+- spec/core/api_spec.rb
+- spec/core/client_spec.rb
+- spec/core/kashflow_api_spec.rb
+- spec/core/soap_object_spec.rb
+- spec/objects/customer_spec.rb
+- spec/objects/inherited_methods_spec.rb
+- spec/objects/invoice_spec.rb
+- spec/objects/line_spec.rb
+- spec/objects/nominal_code_spec.rb
+- spec/objects/quote_spec.rb
+- spec/objects/receipt_spec.rb
+- spec/objects/supplier_spec.rb
 - spec/spec_helper.rb
-- spec/test_data.example.yml
+- spec/support/macros.rb
 homepage: http://ed-itsolutions.github.io/KashflowAPI
 licenses: []
 metadata: {}
@@ -112,13 +128,19 @@ signing_key:
 specification_version: 4
 summary: Provides an interface for the Kashflow API
 test_files:
-- spec/kashflow_api_customer_balance_spec.rb
-- spec/kashflow_api_customer_spec.rb
-- spec/kashflow_api_nominal_codes_spec.rb
-- spec/kashflow_api_quote_spec.rb
-- spec/kashflow_api_receipt_spec.rb
-- spec/kashflow_api_spec.rb
-- spec/kashflow_api_supplier_spec.rb
+- spec/core/api_call_spec.rb
+- spec/core/api_spec.rb
+- spec/core/client_spec.rb
+- spec/core/kashflow_api_spec.rb
+- spec/core/soap_object_spec.rb
+- spec/objects/customer_spec.rb
+- spec/objects/inherited_methods_spec.rb
+- spec/objects/invoice_spec.rb
+- spec/objects/line_spec.rb
+- spec/objects/nominal_code_spec.rb
+- spec/objects/quote_spec.rb
+- spec/objects/receipt_spec.rb
+- spec/objects/supplier_spec.rb
 - spec/spec_helper.rb
-- spec/test_data.example.yml
+- spec/support/macros.rb
 has_rdoc: