taxamo-ns 2.2.0

data/taxamo.gemspec

@@ -0,0 +1,28 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'taxamo/version'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'taxamo-ns'
+  s.version = Taxamo::VERSION
+  s.summary = 'Ruby bindings for the Taxamo API (namespaced)'
+  s.description = 'Taxamo provides a real-time Software as a Service (SaaS) solution for compliance with the new 2015 EU VAT rules on the sale of e-services. http://www.taxamo.com'
+  s.authors = ['Tomek Lipski']
+  s.email = ['tom@taxamo.com']
+  s.homepage = 'https://www.taxamo.com/apidocs/index.html'
+  s.license = 'Apache'
+
+  s.add_dependency('addressable', '~> 2')
+  s.add_dependency('typhoeus', '> 0.6.0')
+  s.add_dependency('require_all', '~> 1.3.2')
+
+  s.add_development_dependency('mocha', '~> 0.13.2')
+  s.add_development_dependency('shoulda', '~> 3.4.0')
+  s.add_development_dependency('test-unit')
+  s.add_development_dependency('rake')
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/test/taxamo/connectivity_test.rb

@@ -0,0 +1,55 @@
+# Copyright 2014-2015 Taxamo, Ltd.
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'test/unit'
+require 'shoulda'
+require 'taxamo'
+
+class ConnectivityTest < Test::Unit::TestCase
+
+  should 'test_validate' do
+    Swagger.configure do |config|
+      config.api_key = 'SamplePrivateTestKey1'
+    end
+
+    assert_raise(ValidationError) {
+      Taxamo.calculate_tax ({'__transaction' => {
+                               'currency_code' => 'USD',
+                               'buyer_ip' => '127.0.0.1',
+                               'billing_country_code' => 'IE',
+                               'force_country_code' => 'FR',
+                               'transaction_lines' => [{'amount' => 200,
+                                                        'custom_id' => 'line1'},
+                                                       {'amount' => 100,
+                                                        'product_type' => 'e-book',
+                                                        'custom_id' => 'line2'}]}}) }
+  end
+
+  should 'test_auth' do
+    Swagger.configure do |config|
+      config.api_key = 'SamplePrivateTestKey1!'
+    end
+    assert_raise(AuthenticationError) {
+      Taxamo.calculate_tax ({'__transaction' => {
+                               'currency_code' => 'USD',
+                               'buyer_ip' => '127.0.0.1',
+                               'billing_country_code' => 'IE',
+                               'force_country_code' => 'FR',
+                               'transaction_lines' => [{'amount' => 200,
+                                                        'custom_id' => 'line1'},
+                                                       {'amount' => 100,
+                                                        'product_type' => 'e-book',
+                                                        'custom_id' => 'line2'}]}})}
+
+
+  end
+end

data/test/taxamo/tax_test.rb

@@ -0,0 +1,152 @@
+# Copyright 2014-2015 Taxamo, Ltd.
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'test/unit'
+require 'shoulda'
+require 'taxamo'
+
+
+class TaxTest < Test::Unit::TestCase
+
+  should 'basic tax calculation works' do
+
+    Swagger.configure do |config|
+      config.api_key = 'SamplePrivateTestKey1'
+    end
+    resp = Taxamo.calculate_tax(
+        {'transaction' => {
+            'currency_code' => 'USD',
+            'buyer_ip' => '127.0.0.1',
+            'billing_country_code' => 'IE',
+            'force_country_code' => 'FR',
+            'transaction_lines' => [{'amount' => 200,
+                                     'custom_id' => 'line1'},
+                                    {'amount' => 100,
+                                     'product_type' => 'e-book',
+                                     'custom_id' => 'line2'}]}})
+
+    assert_equal resp.transaction.countries.detected.code, 'IE'
+    assert_equal resp.transaction.amount, 300
+    assert_equal resp.transaction.tax_amount, 45.5
+    assert_equal resp.transaction.total_amount, 345.5
+
+    assert_equal resp.transaction.transaction_lines[0].custom_id, 'line1'
+    assert_equal resp.transaction.transaction_lines[0].tax_rate, 20
+    assert_equal resp.transaction.transaction_lines[0].tax_amount, 40
+    assert_equal resp.transaction.transaction_lines[1].custom_id, 'line2'
+    assert_equal resp.transaction.transaction_lines[1].tax_rate, 5.5
+    assert_equal resp.transaction.transaction_lines[1].tax_amount, 5.5
+  end
+
+
+  should 'data model works' do
+
+    Swagger.configure do |config|
+      config.api_key = 'SamplePrivateTestKey1'
+    end
+
+    taxIn = Taxamo::CalculateTaxIn.new
+    taxIn.transaction = Taxamo::InputTransaction.new
+    taxIn.transaction.currency_code = 'USD'
+    taxIn.transaction.buyer_ip = '127.0.0.1'
+    taxIn.transaction.billing_country_code = 'IE'
+    taxIn.transaction.force_country_code = 'FR'
+    taxIn.transaction.transaction_lines = [Taxamo::InputTransactionLine.new, Taxamo::InputTransactionLine.new]
+    taxIn.transaction.transaction_lines[0].amount = 200
+    taxIn.transaction.transaction_lines[0].custom_id = 'line1'
+    taxIn.transaction.transaction_lines[1].amount = 100
+    taxIn.transaction.transaction_lines[1].custom_id = 'line2'
+    taxIn.transaction.transaction_lines[1].product_type = 'e-book'
+
+    resp = Taxamo.calculate_tax(taxIn)
+
+    assert_equal resp.transaction.countries.detected.code, 'IE'
+    assert_equal resp.transaction.amount, 300
+    assert_equal resp.transaction.tax_amount, 45.5
+    assert_equal resp.transaction.total_amount, 345.5
+
+    assert_equal resp.transaction.transaction_lines[0].custom_id, 'line1'
+    assert_equal resp.transaction.transaction_lines[0].tax_rate, 20
+    assert_equal resp.transaction.transaction_lines[0].tax_amount, 40
+    assert_equal resp.transaction.transaction_lines[1].custom_id, 'line2'
+    assert_equal resp.transaction.transaction_lines[1].tax_rate, 5.5
+    assert_equal resp.transaction.transaction_lines[1].tax_amount, 5.5
+  end
+
+  should 'test simple calculate' do
+
+    Swagger.configure do |config|
+      config.api_key = 'SamplePrivateTestKey1'
+    end
+    #,,,,,
+    resp = Taxamo.calculate_simple_tax('e-book', #product_type
+                                       nil, #invoice_address_city
+                                       nil, #buyer_credit_card_prefix
+                                       'USD', #currency_code
+                                       nil, #invoice_address_region
+                                       nil, #unit_price
+                                       nil, #quantity
+                                       nil, #buyer_tax_number
+                                       'FR', #force_country_code
+                                       nil, #order_date
+                                       100, #amount
+                                       'IE', #billing_country_code
+                                       nil, #invoice_address_postal_code
+                                       nil, #total_amount
+                                       nil  #tax_deducted
+                                       )
+
+    assert_equal resp.transaction.tax_country_code, 'FR'
+    assert_equal resp.transaction.amount, 100
+    assert_equal resp.transaction.tax_amount, 5.5
+    assert_equal resp.transaction.total_amount, 105.5
+
+    assert_equal resp.transaction.transaction_lines[0].tax_rate, 5.5
+    assert_equal resp.transaction.transaction_lines[0].tax_rate, 5.5
+    assert_equal resp.transaction.transaction_lines[0].total_amount, 105.5
+
+  end
+
+  should 'test validate tax number' do
+
+    Swagger.configure do |config|
+      config.api_key = 'SamplePrivateTestKey1'
+    end
+    resp = Taxamo.validate_tax_number(nil, 'IE6388047V')
+    assert_equal resp.tax_deducted, true
+    assert_equal resp.billing_country_code, 'IE'
+
+    resp = Taxamo.validate_tax_number('IE', '6388047V')
+    assert_equal resp.tax_deducted, true
+    assert_equal resp.billing_country_code, 'IE'
+
+    resp = Taxamo.validate_tax_number('IE', '6388047V12121')
+
+    assert_equal resp.tax_deducted, nil
+  end
+
+
+  should 'test_location_calculate' do
+
+    Swagger.configure do |config|
+      config.api_key = 'SamplePrivateTestKey1'
+    end
+
+    resp = Taxamo.calculate_tax_location('BE', '424242')
+    assert_equal resp.tax_country_code, 'BE'
+    assert_equal resp.tax_supported, true
+    assert_equal resp.countries.detected.code, 'BE'
+    assert_equal resp.countries.by_billing.code, 'BE'
+    assert_equal resp.countries.by_cc.code, 'BE'
+
+  end
+end

data/test/taxamo/transactions_api_test.rb

@@ -0,0 +1,326 @@
+# Copyright 2014-2015 Taxamo, Ltd.
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'test/unit'
+require 'shoulda'
+require 'taxamo'
+
+class TransactionsApiTest < Test::Unit::TestCase
+
+  should 'test_ops' do
+    Swagger.configure do |config|
+      config.api_key = 'SamplePrivateTestKey1'
+    end
+
+    resp = Taxamo.create_transaction(
+        {
+            'transaction' => {
+                'currency_code' => 'USD',
+                'buyer_ip' => '127.0.0.1',
+                'billing_country_code' => 'IE',
+                'force_country_code' => 'FR',
+                'order_date' => '2014-06-01',
+                'buyer_email' => 'test-ruby@taxamo.com',
+                'transaction_lines' => [{'amount' => 200,
+                                         'custom_id' => 'line1'},
+                                        {'amount' => 100,
+                                         'product_type' => 'e-book',
+                                         'custom_id' => 'line2'}]
+            }})
+    assert_false resp.transaction.key.nil?
+    assert_equal resp.transaction.countries.detected.code, 'IE'
+    assert_equal resp.transaction.amount, 300
+    assert_equal resp.transaction.tax_amount, 45.5
+    assert_equal resp.transaction.total_amount, 345.5
+    assert_equal resp.transaction.status, 'N'
+
+    resp = Taxamo.get_transaction(resp.transaction.key)
+
+    assert_false resp.transaction.key.nil?
+    assert_equal resp.transaction.amount, 300
+    assert_equal resp.transaction.tax_amount, 45.5
+    assert_equal resp.transaction.total_amount, 345.5
+    assert_equal resp.transaction.status, 'N'
+    assert_equal resp.transaction.evidence.by_billing.resolved_country_code, 'IE'
+    assert_equal resp.transaction.evidence.by_ip.resolved_country_code, 'IE'
+    assert_equal resp.transaction.evidence.forced.resolved_country_code, 'FR'
+    assert_equal resp.transaction.buyer_email, 'test-ruby@taxamo.com'
+
+
+    resp = Taxamo.update_transaction(resp.transaction.key,
+                                     {'transaction' =>
+                                          {'buyer_name' => 'Ruby tester #2',
+                                           'currency_code' => 'CHF',
+                                           'invoice_address' => {'street_name' => 'Test street #4'},
+                                           'transaction_lines' => [{'amount' => 30,
+                                                                    'custom_id' => 'line1'},
+                                                                   {'amount' => 40,
+                                                                    'product_type' => 'e-book',
+                                                                    'custom_id' => 'line2'}]}})
+
+    assert_false resp.transaction.key.nil?
+
+    assert_equal resp.transaction.status, 'N'
+    assert_equal resp.transaction.amount, 70
+    assert_equal resp.transaction.tax_amount, 8.2
+    assert_equal resp.transaction.total_amount, 78.2
+
+    resp = Taxamo.get_transaction(resp.transaction.key)
+
+    assert_false resp.transaction.key.nil?
+    assert_equal resp.transaction.buyer_name, 'Ruby tester #2'
+    assert_equal resp.transaction.invoice_address.street_name, 'Test street #4'
+
+    assert_equal resp.transaction.status, 'N'
+    assert_equal resp.transaction.amount, 70
+    assert_equal resp.transaction.tax_amount, 8.2
+    assert_equal resp.transaction.total_amount, 78.2
+    assert_equal resp.transaction.evidence.by_billing.resolved_country_code, 'IE'
+    assert_equal resp.transaction.evidence.by_ip.resolved_country_code, 'IE'
+    assert_equal resp.transaction.evidence.forced.resolved_country_code, 'FR'
+
+    resp = Taxamo.confirm_transaction(resp.transaction.key,
+                                      {'transaction' =>
+                                           {'buyer_name' => 'Ruby tester',
+                                            'invoice_place' => 'Rubytown',
+                                            'currency_code' => 'EUR',
+                                            'transaction_lines' => [{'amount' => 300,
+                                                                     'custom_id' => 'line1'},
+                                                                    {'amount' => 400,
+                                                                     'product_type' => 'e-book',
+                                                                     'custom_id' => 'line2'}]}})
+
+    assert_false resp.transaction.key.nil?
+    assert_equal resp.transaction.status, 'C'
+    assert_equal resp.transaction.amount, 700
+    assert_equal resp.transaction.tax_amount, 82
+    assert_equal resp.transaction.total_amount, 782
+
+    resp = Taxamo.get_transaction(resp.transaction.key)
+
+    assert_false resp.transaction.key.nil?
+    assert_equal resp.transaction.status, 'C'
+    assert_equal resp.transaction.amount, 700
+    assert_equal resp.transaction.tax_amount, 82
+    assert_equal resp.transaction.total_amount, 782
+    assert_equal resp.transaction.evidence.by_billing.resolved_country_code, 'IE'
+    assert_equal resp.transaction.evidence.by_ip.resolved_country_code, 'IE'
+    assert_equal resp.transaction.evidence.forced.resolved_country_code, 'FR'
+
+    #filter_text,offset,key_or_custom_id,currency_code,order_date_to,sort_reverse,limit,invoice_number,statuses,order_date_from,total_amount_greater_than,format,total_amount_less_than,tax_country_code
+    resp = Taxamo.list_transactions(nil, #filter_text
+                                    0, #offset
+                                    nil, #key_or_custom_id
+                                    nil, #currency_code,
+                                    nil, #order_date_to,
+                                    'true', #sort_reverse
+                                    100, #limit
+                                    nil,#invoice_number
+                                    'C', #statuses
+                                    nil, #order_date_from
+                                    nil, #total_amount_greater_than
+                                    nil, #format,
+                                    nil, #total_amount_less_than
+                                    nil, #tax_country_code
+                                    nil, #original_transaction_key
+                                    nil, #has_note
+                                    nil #tax_country_codes
+                                    )
+
+    assert_true resp.transactions.length > 0
+    assert_true resp.transactions.length <= 100
+
+    resp.transactions.each do |transaction|
+      assert_equal transaction.status, 'C'
+      assert_equal transaction.currency_code, 'EUR'
+    end
+    resp = Taxamo.list_transactions(nil, #filter_text
+                                    0, #offset
+                                    nil, #key_or_custom_id
+                                    nil, #currency_code,
+                                    nil, #order_date_to,
+                                    'true', #sort_reverse
+                                    10, #limit
+                                    nil,#invoice_number
+                                    'N', #statuses
+                                    nil, #order_date_from
+                                    nil, #total_amount_greater_than
+                                    nil, #format,
+                                    nil, #total_amount_less_than
+                                    nil, #tax_country_code
+                                    nil, #original_transaction_key
+                                    nil, #has_note
+                                    nil #tax_country_codes
+                                    )
+    assert_true resp.transactions.length != 0
+
+  end
+
+  should "cancel test" do
+    Swagger.configure do |config|
+      config.api_key = 'SamplePrivateTestKey1'
+    end
+    resp = Taxamo.create_transaction(
+        {'transaction' => {
+            'currency_code' => 'USD',
+            'buyer_ip' => '127.0.0.1',
+            'billing_country_code' => 'IE',
+            'force_country_code' => 'FR',
+            'transaction_lines' => [{'amount' => 200,
+                                     'custom_id' => 'line1'},
+                                    {'amount' => 100,
+                                     'product_type' => 'e-book',
+                                     'custom_id' => 'line2'}]
+        }})
+    assert_false resp.transaction.key.nil?
+    assert_equal resp.transaction.status, 'N'
+
+    resp = Taxamo.cancel_transaction(resp.transaction.key)
+
+    assert_true resp.success
+  end
+
+  should 'evidence fields test' do
+
+    Swagger.configure do |config|
+      config.api_key = 'SamplePrivateTestKey1'
+    end
+
+    resp = Taxamo.create_transaction(
+        {'transaction' => {
+            'currency_code' => 'USD',
+            'evidence' => {
+                'other_commercially_relevant_info' => {'evidence_value' => 'GR'},
+                'self_declaration' => {'evidence_value' => 'GR'}
+            },
+            'billing_country_code' => 'GR',
+            'order_date' => '2014-06-01',
+            'buyer_email' => 'test-Ruby@taxamo.com',
+            'transaction_lines' => [{'amount' => 200,
+                                     'custom_id' => 'line1'},
+                                    {'amount' => 100,
+                                     'product_type' => 'e-book',
+                                     'custom_id' => 'line2'}]
+        }})
+    assert_false resp.transaction.key.nil?
+    assert_equal resp.transaction.countries.detected.code, 'GR'
+    assert_equal resp.transaction.countries.other_commercially_relevant_info.code, 'GR'
+    assert_equal resp.transaction.countries.self_declaration.code, 'GR'
+    assert_equal resp.transaction.status, 'N'
+
+    resp = Taxamo.get_transaction(resp.transaction.key)
+
+    assert_false resp.transaction.key.nil?
+    assert_equal resp.transaction.status, 'N'
+    assert_equal resp.transaction.evidence.by_billing.resolved_country_code, 'GR'
+    assert_equal resp.transaction.evidence.other_commercially_relevant_info.resolved_country_code, 'GR'
+    assert_equal resp.transaction.evidence.self_declaration.resolved_country_code, 'GR'
+
+  end
+
+  should "test custom fields" do
+    resp = Taxamo.create_transaction(
+        {'transaction' => {
+            'currency_code' => 'USD',
+            'buyer_ip' => '127.0.0.1',
+            'billing_country_code' => 'IE',
+            'force_country_code' => 'FR',
+            'order_date' => '2014-06-01',
+            'custom_fields' => [{'key' => 'test1', 'value' => 'test2'},
+                                {'key' => 'test1', 'value' => 'test3'}],
+            'transaction_lines' => [{'amount' => 200,
+                                     'custom_id' => 'line1',
+                                     'custom_fields' => [{'key' => 'test11', 'value' => 'test22'},
+                                                         {'key' => 'test41', 'value' => 'test23'}]},
+                                    {'amount' => 100,
+                                     'product_type' => 'e-book',
+                                     'custom_id' => 'line2'}]
+        }})
+
+    assert_false resp.transaction.key.nil?
+    assert_equal resp.transaction.status, 'N'
+    assert_equal resp.transaction.custom_fields[0].key, 'test1'
+    assert_equal resp.transaction.custom_fields[1].value, 'test3'
+
+    resp = Taxamo.get_transaction(resp.transaction.key)
+
+    assert_false resp.transaction.key.nil?
+    assert_equal resp.transaction.status, 'N'
+    assert_equal resp.transaction.custom_fields[0].key, 'test1'
+    assert_equal resp.transaction.custom_fields[1].value, 'test3'
+    assert_equal resp.transaction.transaction_lines[0].custom_fields[1].value, 'test23'
+
+    resp = Taxamo.update_transaction(resp.transaction.key,
+                                    {'transaction' =>
+                                         {'buyer_name' => 'Ruby tester #2',
+                                          'currency_code' => 'CHF',
+                                          'invoice_address' => {'street_name' => 'Test street #4'},
+                                          'custom_fields' => [{'key' => 'test51', 'value' => 'test52'},
+                                                              {'key' => 'test51', 'value' => 'test53'},
+                                                              {'key' => 'test61', 'value' => 'test63'}],
+                                          'transaction_lines' => [{'amount' => 30,
+                                                                   'custom_id' => 'line1',
+                                                                   'custom_fields' => [{'key' => 'test11', 'value' => 'test22'},
+                                                                                       {'key' => 'test41', 'value' => 'test43'}]},
+                                                                  {'amount' => 40,
+                                                                   'product_type' => 'e-book',
+                                                                   'custom_id' => 'line2',
+                                                                   'custom_fields' => [{'key' => 'test21', 'value' => 'test82'},
+                                                                                       {'key' => 'test71', 'value' => 'test83'}]}]}})
+
+    assert_false resp.transaction.key.nil?
+
+
+
+
+    resp = Taxamo.get_transaction(resp.transaction.key)
+
+    assert_false resp.transaction.key.nil?
+    assert_equal resp.transaction.status, 'N'
+    assert_equal resp.transaction.custom_fields[0].key, 'test51'
+    assert_equal resp.transaction.custom_fields[1].value, 'test53'
+    assert_equal resp.transaction.custom_fields[2].value, 'test63'
+    assert_equal resp.transaction.transaction_lines[0].custom_fields[1].value, 'test43'
+    assert_equal resp.transaction.transaction_lines[1].custom_fields[1].value, 'test83'
+
+    assert_raise(ValidationError) { Taxamo.capture_payment(resp.transaction.key)}
+
+ resp = Taxamo.list_transactions(   nil, #filter_text
+                                    0, #offset
+                                    nil, #key_or_custom_id
+                                    nil, #currency_code,
+                                    nil, #order_date_to,
+                                    'true', #sort_reverse
+                                    10, #limit
+                                    nil,#invoice_number
+                                    'N', #statuses
+                                    nil, #order_date_from
+                                    nil, #total_amount_greater_than
+                                    nil, #format,
+                                    nil, #total_amount_less_than
+                                    nil, #tax_country_code
+                                    nil, #original_transaction_key
+                                    nil, #has_note
+                                    nil #tax_country_codes
+                                    )
+
+    assert_false resp.transactions[0].key.nil?
+    assert_equal resp.transactions[0].status, 'N'
+    assert_equal resp.transactions[0].custom_fields[0].key, 'test51'
+    assert_equal resp.transactions[0].custom_fields[1].value, 'test53'
+    assert_equal resp.transactions[0].custom_fields[2].value, 'test63'
+    assert_equal resp.transactions[0].transaction_lines[0].custom_fields[1].value, 'test43'
+    assert_equal resp.transactions[0].transaction_lines[1].custom_fields[1].value, 'test83'
+
+  end
+
+end