fortnox-api 0.1.0 → 0.2.0

data/spec/fortnox/api/types/nullable_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'dry-struct'
+require 'fortnox/api/types'
+
+describe Fortnox::API::Types::Nullable, type: :type do
+  subject{ TestStruct }
+
+  describe 'String' do
+    using_test_class do
+      class TestStruct < Dry::Struct
+        attribute :string, Fortnox::API::Types::Nullable::String
+      end
+    end
+
+    it{ is_expected.to have_nullable(:string, 'A simple message', 0, '0') }
+  end
+
+  describe 'Float' do
+    using_test_class do
+      class TestStruct < Dry::Struct
+        attribute :float, Fortnox::API::Types::Nullable::Float
+      end
+    end
+
+    it{ is_expected.to have_nullable(:float, 14.0, 'Not a Float!', 0.0) }
+  end
+
+  describe 'Integer' do
+    using_test_class do
+      class TestStruct < Dry::Struct
+        attribute :integer, Fortnox::API::Types::Nullable::Integer
+      end
+    end
+
+    it{ is_expected.to have_nullable(:integer, 14, 14.0, 14) }
+  end
+
+  describe 'Boolean' do
+    using_test_class do
+      class TestStruct < Dry::Struct
+        attribute :boolean, Fortnox::API::Types::Nullable::Boolean
+      end
+    end
+
+    it{ is_expected.to have_nullable(:boolean, true, 'Not a Boolean!', false) }
+  end
+
+  describe 'Date' do
+    using_test_class do
+      class TestStruct < Dry::Struct
+        attribute :date, Fortnox::API::Types::Nullable::Date
+      end
+    end
+
+    it{ is_expected.to have_nullable_date(:date, Date.new(2016, 1, 1), 'Not a Date!') }
+  end
+end

data/spec/fortnox/api/types/order_row_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'fortnox/api/types/order_row'
+require 'fortnox/api/types/examples/document_row'
+
+RSpec.describe Fortnox::API::Types::OrderRow, type: :type do
+  valid_hash = { ordered_quantity: 10.5 }
+
+  subject{ described_class }
+
+  it{ is_expected.to require_attribute( :ordered_quantity, valid_hash ) }
+
+  it_behaves_like 'DocumentRow', valid_hash
+end

data/spec/fortnox/api/types/required_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'fortnox/api/types'
+require 'fortnox/api/types/required'
+
+describe Fortnox::API::Types::Required, type: :type do
+  using_test_class do
+    class TestClass < Dry::Struct
+    end
+  end
+
+  shared_examples_for 'required attribute' do |_type|
+    subject{ ->{ TestClass.new({}) } }
+
+    let(:error_message) do
+      "[#{ TestClass }.new] #{ :required_attribute.inspect } is missing in Hash input"
+    end
+
+    it 'raises an error' do
+      is_expected.to raise_error(Dry::Struct::Error, error_message)
+    end
+  end
+
+  describe 'String' do
+    before do
+      class TestClass
+        attribute :required_attribute, Fortnox::API::Types::Required::String
+      end
+    end
+
+    include_examples 'required attribute', String
+  end
+
+  describe 'Float' do
+    before do
+      class TestClass
+        attribute :required_attribute, Fortnox::API::Types::Required::Float
+      end
+    end
+
+    include_examples 'required attribute', Float
+  end
+end

data/spec/fortnox/api/types/sized_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'fortnox/api/types'
+require 'fortnox/api/types/examples/types'
+
+describe Fortnox::API::Types::Sized do
+
+  shared_examples_for 'Sized Types' do
+    context 'created with nil' do
+      subject{ klass[ nil ] }
+      it{ is_expected.to be_nil }
+    end
+  end
+
+  describe 'String' do
+    max_size = 5
+    let( :klass ){ described_class::String[ max_size ] }
+
+    it_behaves_like 'Sized Types'
+
+    context 'created with empty string' do
+      include_examples 'equals input', ''
+    end
+
+    context 'created with fewer characters than the limit' do
+      include_examples 'equals input', 'a' * (max_size - 1)
+    end
+
+    context 'created with valid string' do
+      include_examples 'equals input', 'a' * max_size
+    end
+
+    context 'created with more characters than the limit' do
+      include_examples 'raises ConstraintError', 'a' * (max_size + 1)
+    end
+  end
+
+  shared_examples_for 'Sized Numeric' do |type, min, max, step|
+    let( :klass ){ described_class.const_get(type)[ min, max ] }
+
+    it_behaves_like 'Sized Types'
+
+    context 'created with value below the lower limit' do
+      include_examples 'raises ConstraintError', min - step
+    end
+
+    context 'created with value at the lower limit' do
+      include_examples 'equals input', min
+    end
+
+    context 'created with valid number near lower limit' do
+      include_examples 'equals input', min + step
+    end
+
+    context 'created with valid number near upper limit' do
+      include_examples 'equals input', max - step
+    end
+
+    context 'created with value at the upper limit' do
+      include_examples 'equals input', max
+    end
+
+    context 'created with value above the upper limit' do
+      include_examples 'raises ConstraintError', max + step
+    end
+  end
+
+  describe 'Float' do
+    it_behaves_like 'Sized Numeric', 'Float', 0.0, 100.0, 0.1
+  end
+
+  describe 'Integer' do
+    it_behaves_like 'Sized Numeric', 'Integer', 0, 100, 1
+  end
+end

data/spec/fortnox/api_spec.rb

@@ -2,16 +2,17 @@ require 'spec_helper'
 require 'fortnox/api'
 
 describe Fortnox::API do
+  include Helpers::Environment
 
   context 'get access token' do
     before do
-      ENV['FORTNOX_API_BASE_URL'] = 'http://api.fortnox.se/3/'
-      ENV['FORTNOX_API_CLIENT_SECRET'] = 'P5K5vE3Kun'
-      ENV['FORTNOX_API_ACCESS_TOKEN'] = '3f08d038-f380-4893-94a0-a08f6e60e67a'
-      ENV['FORTNOX_API_AUTHORIZATION_CODE'] = 'ea3862b0-189c-464b-8e23-1b9702365ea1'
-    end
+      stub_environment(
+        'FORTNOX_API_BASE_URL' => 'http://api.fortnox.se/3/',
+        'FORTNOX_API_CLIENT_SECRET' => 'P5K5vE3Kun',
+        'FORTNOX_API_ACCESS_TOKEN' => '3f08d038-f380-4893-94a0-a08f6e60e67a',
+        'FORTNOX_API_AUTHORIZATION_CODE' => 'ea3862b0-189c-464b-8e23-1b9702365ea1'
+      )
 
-    it 'works' do
       stub_request(
         :get,
         'http://api.fortnox.se/3/',
@@ -21,16 +22,16 @@ describe Fortnox::API do
           'Client-Secret' => 'P5K5vE3Kun',
           'Accept' => 'application/json',
         }
-      ).to_return(
-        status: 200,
-        body: { 'Authorisation' => { 'AccessToken' => '3f08d038-f380-4893-94a0-a08f6e60e67a' } }.to_json,
-        headers: { 'Content-Type' => 'application/json' },
-      )
+        ).to_return(
+          status: 200,
+          body: { 'Authorisation' => { 'AccessToken' => '3f08d038-f380-4893-94a0-a08f6e60e67a' } }.to_json,
+          headers: { 'Content-Type' => 'application/json' },
+        )
+    end
 
-      response = Fortnox::API.get_access_token
 
-      expect( response).to eql( "3f08d038-f380-4893-94a0-a08f6e60e67a" )
-    end
-  end
+    subject{ described_class.get_access_token }
 
+    it{ is_expected.to eql( "3f08d038-f380-4893-94a0-a08f6e60e67a" ) }
+  end
 end

data/spec/spec_helper.rb

@@ -1,31 +1,41 @@
 ENV['RUBY_ENV'] = 'test'
 
+require 'rspec/collection_matchers'
 require 'webmock/rspec'
 require 'pry'
 require "codeclimate-test-reporter"
 require 'support/matchers'
 require 'support/helpers'
 require 'support/vcr_setup'
+require 'dotenv'
 
 CodeClimate::TestReporter.start
+Dotenv.load('.env.test')
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 
-  config.extend Helpers
+  config.extend Helpers # Allow access to helpers in describe and context blocks
+  config.include Helpers # Allow access to helpers in it and let blocks
+
+  config.include Helpers::Repositories, integration: true
+  config.include Matchers::Type, type: :type
 
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
   config.order = 'random'
 
   WebMock.disable_net_connect!( allow: 'codeclimate.com' )
 
-  config.after( :each ) do
-    ENV['FORTNOX_API_BASE_URL'] = nil
-    ENV['FORTNOX_API_CLIENT_SECRET'] = nil
-    ENV['FORTNOX_API_ACCESS_TOKEN'] = nil
+  config.before do
+    module Test
+      def self.remove_constants
+        constants.each{ |const| remove_const(const) }
+        self
+      end
+    end
+  end
+
+  config.after do
+    Object.send(:remove_const, Test.remove_constants.name)
   end
 end

data/spec/support/helpers/dummy_class_helper.rb

@@ -1,8 +1,12 @@
+require 'dry-types'
+
 module Helpers
   def using_test_classes
     around( :all ) do |example|
       classes_before_examples = Object.constants
 
+      save_dry_types_state
+
       yield
 
       classes_after_examples = Object.constants
@@ -10,6 +14,8 @@ module Helpers
 
       example.run
 
+      clean_up_dry_types
+
       classes_created_by_block.each do |klass|
         Object.send(:remove_const, klass)
       end
@@ -17,4 +23,17 @@ module Helpers
   end
 
   alias_method :using_test_class, :using_test_classes
+
+private
+
+  def save_dry_types_state
+    @types = Dry::Types.container._container.keys
+  end
+
+  def clean_up_dry_types
+    container = Dry::Types.container._container
+    (container.keys - @types).each{ |key| container.delete(key) }
+    Dry::Types.instance_variable_set('@type_map', Concurrent::Map.new)
+  end
+
 end

data/spec/support/helpers/environment_helper.rb

@@ -0,0 +1,7 @@
+module Helpers
+  module Environment
+    def stub_environment( hash )
+      stub_const( 'ENV', ENV.to_hash.merge( hash ))
+    end
+  end
+end

data/spec/support/helpers/repository_helper.rb

@@ -0,0 +1,8 @@
+module Helpers
+  module Repositories
+    # Returns directory for VCR.
+    def vcr_dir
+      described_class::MAPPER::JSON_COLLECTION_WRAPPER.downcase
+    end
+  end
+end

data/spec/support/helpers/when_performing_helper.rb

@@ -0,0 +1,5 @@
+module Helpers
+  def when_performing &block
+    block.to_proc
+  end
+end

data/spec/support/matchers.rb

@@ -1 +1 @@
-Dir[File.expand_path('spec/support/matchers/*.rb')].each{ |file| require file }
+require 'support/matchers/type'

data/spec/support/matchers/type.rb

@@ -0,0 +1,17 @@
+require 'support/matchers/type/attribute_matcher'
+require 'support/matchers/type/type_matcher'
+require 'support/matchers/type/have_nullable_matcher'
+require 'support/matchers/type/enum_matcher'
+require 'support/matchers/type/numeric_matcher'
+
+require 'support/matchers/type/have_nullable_date_matcher'
+require 'support/matchers/type/require_attribute_matcher'
+require 'support/matchers/type/have_email_matcher'
+require 'support/matchers/type/have_sized_string_matcher'
+require 'support/matchers/type/have_default_delivery_type_matcher'
+require 'support/matchers/type/have_nullable_string_matcher'
+require 'support/matchers/type/have_sized_float_matcher'
+require 'support/matchers/type/have_house_work_type_matcher'
+require 'support/matchers/type/have_account_number_matcher'
+require 'support/matchers/type/have_discount_type_matcher'
+require 'support/matchers/type/have_sized_integer_matcher'

data/spec/support/matchers/type/attribute_matcher.rb

@@ -0,0 +1,39 @@
+module Matchers
+  module Type
+    class AttributeMatcher
+      def initialize( attribute, valid_hash, attribute_type )
+        @attribute = attribute
+        @valid_hash = valid_hash.dup
+        @attribute_type = attribute_type
+        @errors = ''
+      end
+
+      def matches? ( klass )
+        @klass = klass
+      end
+
+      def description
+        "have #{ @attribute_type } attribute #{ @attribute.inspect }"
+      end
+
+      def failure_message
+        "Expected class to have attribute #{ @attribute.inspect } defined as #{ @attribute_type }, "\
+        "but got following errors:
+        #{ @errors }"
+      end
+
+      protected
+
+        def expect_error(msg)
+          yield
+
+          @errors << msg
+          false # Fail test since expected error not thrown
+        rescue Dry::Struct::Error
+          # TODO: check if error message is correct
+          true
+        end
+
+    end
+  end
+end

data/spec/support/matchers/type/enum_matcher.rb

@@ -0,0 +1,21 @@
+module Matchers
+  module Type
+    class EnumMatcher < TypeMatcher
+      def initialize( attribute, valid_hash, enum_type, enum_types, nonsense_value: 'NONSENSE'.freeze )
+        valid_value = Fortnox::API::Types.const_get(enum_types).values.first
+
+        super( attribute, valid_hash, enum_type, valid_value, nonsense_value )
+
+        @enum_type = Fortnox::API::Types.const_get(enum_type)
+        @expected_error = "Exception missing for nonsense value #{ @invalid_value.inspect }"
+      end
+
+      private
+
+        def expected_type?
+          @actual_type = @klass.schema[@attribute]
+          @actual_type == @enum_type
+        end
+    end
+  end
+end

data/spec/support/matchers/type/have_account_number_matcher.rb

@@ -0,0 +1,21 @@
+module Matchers
+  module Type
+    def have_account_number( attribute, valid_hash = {} )
+      HaveAccountNumberMatcher.new( attribute, valid_hash )
+    end
+
+    class HaveAccountNumberMatcher < TypeMatcher
+      def initialize( attribute, valid_hash )
+        super( attribute, valid_hash, 'account number', 1000, -1 )
+        @expected_error = "Exception missing for invalid value #{ @invalid_value.inspect }".freeze
+      end
+
+      private
+
+        def expected_type?
+          @actual_type = @klass.schema[@attribute]
+          @actual_type == Fortnox::API::Types::AccountNumber
+        end
+    end
+  end
+end