twinfieldrb 0.3.0

data/spec/stubs/finder_stubs.rb

@@ -0,0 +1,19 @@
+module FinderStubs
+  def stub_finder type, oauth: false
+    stub_request(:post, "https://accounting.twinfield.com/webservices/finder.asmx")
+      .with(
+        body: /<Search xmlns="http:\/\/www.twinfield.com\/"><type>#{type}<\/type><pattern>\*<\/pattern><field>0<\/field><firstRow>1<\/firstRow><maxRows>100<\/maxRows><options><\/options><\/Search>/,
+        headers: {
+          "Soapaction" => '"http://www.twinfield.com/Search"'
+        }
+      )
+      .to_return(status: 200, body: File.read(File.expand_path("../../fixtures/cluster/finder/#{type.downcase}.xml", __FILE__)), headers: {})
+  end
+
+  private
+
+  def twinfield_header(oauth, company = nil)
+    company_fragment = company ? "<CompanyCode>#{company}</CompanyCode>" : ""
+    oauth ? "<Header xmlns=\"http://www.twinfield.com/\"><AccessToken>2b128baa05dd3cabc61e534435884961</AccessToken>#{company_fragment}</Header>" : "<Header xmlns=\"http://www.twinfield.com/\"><SessionID>session_id</SessionID></Header>"
+  end
+end

data/spec/stubs/processxml_stubs.rb

@@ -0,0 +1,41 @@
+module ProcessxmlStubs
+  def stub_processxml_list_dimensions dimension_type: "DEB", company: "company", oauth: false
+    stub_request(:post, "https://accounting.twinfield.com/webservices/processxml.asmx")
+      .with(
+        body: /<soap:Body><ProcessXmlString xmlns="http:\/\/www.twinfield.com\/"><xmlRequest><!\[CDATA\[\n            <list>\n              <type>dimensions<\/type>\n              <dimtype>#{dimension_type}<\/dimtype>\n<office>#{company}<\/office>\n            <\/list>\n          \]\]><\/xmlRequest><\/ProcessXmlString><\/soap:Body>/,
+        headers: {
+          "Soapaction" => '"http://www.twinfield.com/ProcessXmlString"'
+        }
+      )
+      .to_return(status: 200, body: File.read(File.expand_path("../../fixtures/cluster/processxml/response.xml", __FILE__)), headers: {})
+  end
+
+  def stub_processxml_list_offices oauth: false, company: nil
+    stub_request(:post, "https://accounting.twinfield.com/webservices/processxml.asmx")
+      .with(
+        body: /<soap:Body><ProcessXmlString xmlns="http:\/\/www.twinfield.com\/"><xmlRequest><!\[CDATA\[\n            <list>\n              <type>offices<\/type>\n              \n            <\/list>\n          \]\]><\/xmlRequest><\/ProcessXmlString><\/soap:Body>/,
+        headers: {
+          "Soapaction" => '"http://www.twinfield.com/ProcessXmlString"'
+        }
+      )
+      .to_return(status: 200, body: File.read(File.expand_path("../../fixtures/cluster/processxml/response.xml", __FILE__)), headers: {})
+  end
+
+  def stub_processxml_read_dimensions dimtype, oauth: false, company: nil
+    stub_request(:post, "https://accounting.twinfield.com/webservices/processxml.asmx")
+      .with(
+        body: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><soap:Envelope xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://www.twinfield.com/\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\"><soap:Header>#{twinfield_header(oauth, company)}</soap:Header><soap:Body><ProcessXmlString xmlns=\"http://www.twinfield.com/\"><xmlRequest><![CDATA[\n            <read>\n              <type>dimensions</type>\n              <dimtype>#{dimtype}</dimtype>\n            </read>\n          ]]></xmlRequest></ProcessXmlString></soap:Body></soap:Envelope>",
+        headers: {
+          "Soapaction" => '"http://www.twinfield.com/ProcessXmlString"'
+        }
+      )
+      .to_return(status: 200, body: File.read(File.expand_path("../../fixtures/cluster/processxml/read/#{dimtype.downcase}.xml", __FILE__)), headers: {})
+  end
+
+  private
+
+  def twinfield_header(oauth, company = nil)
+    company_fragment = company ? "<CompanyCode>#{company}</CompanyCode>" : ""
+    oauth ? "<Header xmlns=\"http://www.twinfield.com/\"><AccessToken>2b128baa05dd3cabc61e534435884961</AccessToken>#{company_fragment}</Header>" : "<Header xmlns=\"http://www.twinfield.com/\"><SessionID>session_id</SessionID></Header>"
+  end
+end

data/spec/stubs/session_stubs.rb

@@ -0,0 +1,28 @@
+module SessionStubs
+  def stub_create_session username: "username", password: "password", organisation: "organisation", response: "Ok"
+    stub_request(:post, "https://login.twinfield.com/webservices/session.asmx")
+      .with(
+        body: /<tns:user>#{username}<\/tns:user><tns:password>#{password}<\/tns:password><tns:organisation>#{organisation}<\/tns:organisation><\/tns:Logon>/,
+        headers: {
+          Soapaction: '"http://www.twinfield.com/Logon"'
+
+        }
+      ).to_return(status: 200, body: "<env:Envelope><env:Header><Header><SessionId>session_id</SessionId></Header></env:Header><env:Body><LogonResponse><LogonResult>#{response}</LogonResult><Cluster>https://accounting.twinfield.com</Cluster></LogonResponse></env:Body></env:Envelope>")
+  end
+
+  def stub_cluster_session_wsdl
+    stub_request(:get, "https://accounting.twinfield.com/webservices/session.asmx?wsdl")
+      .to_return(status: 200, body: File.read(File.expand_path("../../../wsdls/accounting/session.wsdl", __FILE__)))
+  end
+
+  def stub_select_company company: "company"
+    stub_request(:post, "https://accounting.twinfield.com/webservices/session.asmx")
+      .with(
+        body: /<soap:Body><SelectCompany xmlns="http:\/\/www.twinfield.com\/"><company>#{company}<\/company><\/SelectCompany><\/soap:Body>/,
+        headers: {
+          "Soapaction" => '"http://www.twinfield.com/SelectCompany"'
+        }
+      )
+      .to_return(status: 200, body: "", headers: {})
+  end
+end

data/spec/twinfield/api/oauth_session_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+describe Twinfield::Api::OAuthSession do
+  include SessionStubs
+
+  context "OAuth configured" do
+    before do
+      Twinfield.configure do |config|
+        config.session_type = "Twinfield::Api::OAuthSession"
+        config.cluster = "https://accounting.twinfield.com"
+        config.access_token = "2b128baa05dd3cabc61e534435884961"
+      end
+    end
+
+    after do
+      Twinfield.configure do |config|
+        config.session_type = nil
+        config.cluster = nil
+        config.access_token = nil
+      end
+    end
+
+    it "returns true when oauth is configured" do
+      session = Twinfield::Api::OAuthSession.new
+
+      expect(session.connected?).to be_truthy
+    end
+  end
+
+  describe "#connected?" do
+    it "returns false when no access token is supplied" do
+      session = Twinfield::Api::OAuthSession.new
+
+      expect(session.connected?).to be_falsey
+    end
+  end
+end

data/spec/twinfield/api/process_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe Twinfield::Api::Process do
+  it "...." do
+    # TODO
+  end
+end

data/spec/twinfield/browse/transaction/cost_center_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+describe Twinfield::Browse::Transaction::CostCenter do
+  include SessionStubs
+  include FinderStubs
+  include ProcessxmlStubs
+
+  before do
+    stub_create_session
+    stub_cluster_session_wsdl
+    stub_select_company
+  end
+
+  describe "class methods" do
+    describe ".where" do
+      it "returns transactions" do
+        stub_request(:post, "https://accounting.twinfield.com/webservices/processxml.asmx")
+          .to_return(body: File.read(File.expand_path("../../../../fixtures/cluster/processxml/columns/sales_transactions.xml", __FILE__)))
+
+        transaction = Twinfield::Browse::Transaction::CostCenter.where.first
+
+        expect(transaction).to be_a(Twinfield::Browse::Transaction::CostCenter)
+        expect(transaction.value).to eql(2200.0)
+      end
+
+      it "accepts a customer code" do
+        stub_request(:post, "https://accounting.twinfield.com/webservices/processxml.asmx")
+          .with(body: /<from>1000\/01<\/from>/)
+          .to_return(body: File.read(File.expand_path("../../../../fixtures/cluster/processxml/columns/sales_transactions.xml", __FILE__)))
+
+        transaction = Twinfield::Browse::Transaction::CostCenter.where(years: 1000..2000).first
+
+        expect(transaction).to be_a(Twinfield::Browse::Transaction::CostCenter)
+        expect(transaction.value).to eql(2200.0)
+      end
+
+      it "accepts a customer code" do
+        stub_request(:post, "https://accounting.twinfield.com/webservices/processxml.asmx")
+          .with(body: /<from>4040<\/from>\s*<to>4040<\/to>/)
+          .to_return(body: File.read(File.expand_path("../../../../fixtures/cluster/processxml/columns/sales_transactions.xml", __FILE__)))
+
+        transaction = Twinfield::Browse::Transaction::CostCenter.where(dim1: "4040").first
+
+        expect(transaction).to be_a(Twinfield::Browse::Transaction::CostCenter)
+        expect(transaction.value).to eql(2200.0)
+      end
+
+      it "accepts a invoice number" do
+        stub_request(:post, "https://accounting.twinfield.com/webservices/processxml.asmx")
+          .with(body: /abcd12002/)
+          .to_return(body: File.read(File.expand_path("../../../../fixtures/cluster/processxml/columns/sales_transactions.xml", __FILE__)))
+
+        transaction = Twinfield::Browse::Transaction::CostCenter.where(dim2: "abcd12002").first
+
+        expect(transaction).to be_a(Twinfield::Browse::Transaction::CostCenter)
+        expect(transaction.value).to eql(2200.0)
+      end
+    end
+  end
+end

data/spec/twinfield/browse/transaction/general_ledger_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+describe Twinfield::Browse::Transaction::GeneralLedger do
+  include SessionStubs
+  include FinderStubs
+  include ProcessxmlStubs
+
+  before do
+    stub_create_session
+    stub_cluster_session_wsdl
+    stub_select_company
+  end
+
+  describe "class methods" do
+    describe ".where" do
+      it "returns transactions" do
+        stub_request(:post, "https://accounting.twinfield.com/webservices/processxml.asmx")
+          .to_return(body: File.read(File.expand_path("../../../../fixtures/cluster/processxml/columns/sales_transactions.xml", __FILE__)))
+
+        transaction = Twinfield::Browse::Transaction::GeneralLedger.where.first
+
+        expect(transaction).to be_a(Twinfield::Browse::Transaction::GeneralLedger)
+        expect(transaction.value).to eql(2200.0)
+      end
+
+      it "accepts a customer code" do
+        stub_request(:post, "https://accounting.twinfield.com/webservices/processxml.asmx")
+          .with(body: /<from>1000\/01<\/from>/)
+          .to_return(body: File.read(File.expand_path("../../../../fixtures/cluster/processxml/columns/sales_transactions.xml", __FILE__)))
+
+        transaction = Twinfield::Browse::Transaction::GeneralLedger.where(years: 1000..2000).first
+
+        expect(transaction).to be_a(Twinfield::Browse::Transaction::GeneralLedger)
+        expect(transaction.value).to eql(2200.0)
+      end
+
+      it "accepts a customer code" do
+        stub_request(:post, "https://accounting.twinfield.com/webservices/processxml.asmx")
+          .with(body: /<from>4040<\/from>\s*<to>4040<\/to>/)
+          .to_return(body: File.read(File.expand_path("../../../../fixtures/cluster/processxml/columns/sales_transactions.xml", __FILE__)))
+
+        transaction = Twinfield::Browse::Transaction::GeneralLedger.where(dim1: "4040").first
+
+        expect(transaction).to be_a(Twinfield::Browse::Transaction::GeneralLedger)
+        expect(transaction.value).to eql(2200.0)
+      end
+
+      it "accepts a invoice number" do
+        stub_request(:post, "https://accounting.twinfield.com/webservices/processxml.asmx")
+          .with(body: /abcd12002/)
+          .to_return(body: File.read(File.expand_path("../../../../fixtures/cluster/processxml/columns/sales_transactions.xml", __FILE__)))
+
+        transaction = Twinfield::Browse::Transaction::GeneralLedger.where(dim2: "abcd12002").first
+
+        expect(transaction).to be_a(Twinfield::Browse::Transaction::GeneralLedger)
+        expect(transaction.value).to eql(2200.0)
+      end
+    end
+  end
+end

data/spec/twinfield/browse/transaction/transaction_spec.rb

@@ -0,0 +1,72 @@
+require "spec_helper"
+
+describe Twinfield::Browse::Transaction::Customer do
+  include SessionStubs
+  include FinderStubs
+  include ProcessxmlStubs
+
+  before do
+    stub_create_session
+    stub_cluster_session_wsdl
+    stub_select_company
+  end
+
+  describe "instance methods" do
+    describe "#to_transaction_match_line_xml" do
+      it "returns a valid piece of xml" do
+        xml = Nokogiri::XML(Twinfield::Browse::Transaction::Customer.new(code: "VRK", number: "20210120").to_transaction_match_line_xml(1))
+        xml.css("line transcode").text
+        xml.css("line transnumber").text
+        xml.css("line transline").text == "1"
+      end
+    end
+  end
+
+  describe "class methods" do
+    describe ".where" do
+      it "returns transactions" do
+        stub_request(:post, "https://accounting.twinfield.com/webservices/processxml.asmx")
+          .to_return(body: File.read(File.expand_path("../../../../fixtures/cluster/processxml/columns/sales_transactions.xml", __FILE__)))
+
+        transaction = Twinfield::Browse::Transaction::Customer.where.first
+
+        expect(transaction).to be_a(Twinfield::Browse::Transaction::Customer)
+        expect(transaction.value).to eql(2200.0)
+      end
+
+      it "accepts a customer code" do
+        stub_request(:post, "https://accounting.twinfield.com/webservices/processxml.asmx")
+          .with(body: /abcd12002/)
+          .to_return(body: File.read(File.expand_path("../../../../fixtures/cluster/processxml/columns/sales_transactions.xml", __FILE__)))
+
+        transaction = Twinfield::Browse::Transaction::Customer.where(customer_code: "abcd12002").first
+
+        expect(transaction).to be_a(Twinfield::Browse::Transaction::Customer)
+        expect(transaction.value).to eql(2200.0)
+        expect(transaction.date).to eql(Date.new(2021, 12, 5))
+      end
+
+      it "accepts a customer code" do
+        stub_request(:post, "https://accounting.twinfield.com/webservices/processxml.asmx")
+          .with(body: /abcd12002/)
+          .to_return(body: File.read(File.expand_path("../../../../fixtures/cluster/processxml/columns/sales_transactions.xml", __FILE__)))
+
+        transaction = Twinfield::Browse::Transaction::Customer.where(customer_code: "abcd12002").first
+
+        expect(transaction).to be_a(Twinfield::Browse::Transaction::Customer)
+        expect(transaction.value).to eql(2200.0)
+      end
+
+      it "accepts a invoice number" do
+        stub_request(:post, "https://accounting.twinfield.com/webservices/processxml.asmx")
+          .with(body: /abcd12002/)
+          .to_return(body: File.read(File.expand_path("../../../../fixtures/cluster/processxml/columns/sales_transactions.xml", __FILE__)))
+
+        transaction = Twinfield::Browse::Transaction::Customer.where(invoice_number: "abcd12002").first
+
+        expect(transaction).to be_a(Twinfield::Browse::Transaction::Customer)
+        expect(transaction.value).to eql(2200.0)
+      end
+    end
+  end
+end

data/spec/twinfield/config_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+describe Twinfield::Configuration do
+  after do
+    reset_config
+  end
+
+  it "configures username" do
+    Twinfield.configure do |config|
+      config.username = "my_username"
+    end
+    expect(Twinfield.configuration.username).to eq "my_username"
+  end
+
+  it "configures password" do
+    Twinfield.configure do |config|
+      config.password = "my_password"
+    end
+    expect(Twinfield.configuration.password).to eq "my_password"
+  end
+
+  it "configures organisation" do
+    Twinfield.configure do |config|
+      config.organisation = "my_organisation"
+    end
+    expect(Twinfield.configuration.organisation).to eq "my_organisation"
+  end
+
+  describe "#session_class" do
+    it "returns a session class" do
+      expect(Twinfield.configuration.session_class).to eq(Twinfield::Api::Session)
+    end
+
+    it "returns a oauth session class when configured" do
+      Twinfield.configure do |config|
+        config.session_type = "Twinfield::Api::OAuthSession"
+      end
+      expect(Twinfield.configuration.session_class).to eq(Twinfield::Api::OAuthSession)
+      Twinfield.configure do |config|
+        config.session_type = nil
+      end
+    end
+  end
+
+  describe "#access_token_expired?" do
+    it "raises when no access token is given" do
+      expect { Twinfield.configuration.access_token_expired? }.to raise_error(Twinfield::Configuration::Error)
+    end
+
+    it "returns expired on an old access token" do
+      Twinfield.configuration.access_token = "abc.#{Base64.encode64(JSON({exp: (Time.now - 100).to_i}))}.abc"
+      expect(Twinfield.configuration.access_token_expired?).to eq(true)
+    end
+
+    it "returns not expired on an old access token" do
+      Twinfield.configuration.access_token = "abc.#{Base64.encode64(JSON({exp: (Time.now + 100).to_i}))}.abc"
+      expect(Twinfield.configuration.access_token_expired?).to eq(false)
+    end
+  end
+end