fortnox-api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e14de06afe9e870c90a72663071002f8acb19e5
-  data.tar.gz: 4dc0b9ee89a977e576736102451ef54efa1fcdbf
+  metadata.gz: 124c4cde46325d41cffa7a3bf092375697cb6b1d
+  data.tar.gz: cb91dde384a1c59e4304f29dc9dbdd9ea0c64d4f
 SHA512:
-  metadata.gz: 64e08b1aa313475699bb3e6f9ce31f19bab00ab9104df525dc71dd05bf3c6b6503a9a0405931cb4e92b5d3eba1b1f4143e4b334d207d9f4451a0ad5d78bbae08
-  data.tar.gz: 171f54a4cca2ec7567e357c7141df4b689e0ccf4622e42ebdac04411a6109b90cd200a4052e056ffa7c03c6699084cce94678514afa2ce223bea34a6c18ced23
+  metadata.gz: 8f7bc215cb29128bb0c8385c3769f9aa3576006d69ac84d275b8df4a8799583148e73b77a788538ed4d0fee45e700b7144b803b0a3dca4a2cfe430da1206b0de
+  data.tar.gz: d962b0e1dbb2e05900846866f69a585100b59ac993002dfb1bcef7d89dc8887ecb0e6eaa993be1355971d6d7e09cc4ae67b6881b2609b0a3abe260839aae5436

data/.gitignore

@@ -6,3 +6,6 @@ Gemfile.lock
 
 # Vim swap files
 *.swp
+
+# rbenv Ruby version file
+.ruby-version

data/.travis.yml

@@ -2,7 +2,7 @@ rvm:
   - "2.2.5"
   - "2.3.0"
   - "2.3.1"
-  - "2.4.0-preview2"
+  # - "2.4.0" TODO: Ruby 2.4 not supported yet. See issue #93.
 addons:
   code_climate:
     repo_token: 397c19af63ca3467cff6fd640b0460b691f687118332b5989f530d28f82adcb8

data/fortnox-api.gemspec

@@ -18,7 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "httparty", "~> 0.13"
+  spec.required_ruby_version = ['> 2.2', '< 2.4'] # TODO: Gem breaks with Ruby 2.4 or higher. See issue #93.
+
+  spec.add_dependency "httparty", "~> 0.14.0" # TODO: Temporary lockdown. See issue #103 for more info.
   spec.add_dependency "dotenv", "~> 2.0"
   spec.add_dependency "dry-struct", "~> 0.1"
   spec.add_dependency "dry-types", "~> 0.8"

data/lib/fortnox/api/mappers.rb

@@ -47,3 +47,4 @@ require 'fortnox/api/mappers/invoice_row'
 require 'fortnox/api/mappers/invoice'
 require 'fortnox/api/mappers/order_row'
 require 'fortnox/api/mappers/order'
+require 'fortnox/api/mappers/project'

data/lib/fortnox/api/mappers/project.rb

@@ -0,0 +1,15 @@
+require "fortnox/api/mappers/base"
+
+module Fortnox
+  module API
+    module Mapper
+      class Project < Fortnox::API::Mapper::Base
+        KEY_MAP = {}.freeze
+        JSON_ENTITY_WRAPPER = 'Project'.freeze
+        JSON_COLLECTION_WRAPPER = 'Projects'.freeze
+      end
+
+      Registry.register( Project.canonical_name_sym, Project )
+    end
+  end
+end

data/lib/fortnox/api/models.rb

@@ -1,3 +1,4 @@
 require "fortnox/api/models/customer"
 require "fortnox/api/models/invoice"
 require "fortnox/api/models/order"
+require "fortnox/api/models/project"

data/lib/fortnox/api/models/base.rb

@@ -79,7 +79,7 @@ module Fortnox
       private_class_method
 
         # dry-types filter anything that isn't specified as an attribute on the
-        # class that is being instansiated. This wrapper preserves the meta
+        # class that is being instantiated. This wrapper preserves the meta
         # properties we need to track object state during that initilisation and
         # sets them on the object after dry-types is done with it.
         def self.preserve_meta_properties( hash )

data/lib/fortnox/api/models/project.rb

@@ -0,0 +1,40 @@
+require "fortnox/api/types"
+require "fortnox/api/models/base"
+
+module Fortnox
+  module API
+    module Model
+      class Project < Fortnox::API::Model::Base
+        UNIQUE_ID = :project_number
+        STUB = { description: '' }.freeze
+
+        # Url Direct URL to the record
+        attribute :url, Types::Nullable::String.with( read_only: true )
+
+        # Comments Comments on project. 512 characters
+        attribute :comments, Types::Sized::String[ 512 ]
+
+        # ContactPerson ContactPerson for project. 50 characters
+        attribute :contact_person, Types::Sized::String[ 50 ]
+
+        # Description Description of the project. 50 characters
+        attribute :description, Types::Sized::String[ 50 ]
+
+        # EndDate End date of the project.
+        attribute :end_date, Types::Nullable::Date
+
+        # ProjectLeader Projectleader. 50 characters
+        attribute :project_leader, Types::Sized::String[ 50 ]
+
+        # ProjectNumber Projectnumber. 20 characters
+        attribute :project_number, Types::Sized::String[ 20 ]
+
+        # Status Status of the project
+        attribute :status, Types::ProjectStatusType
+
+        # StartDate Start date of the project
+        attribute :start_date, Types::Nullable::Date
+      end
+    end
+  end
+end

data/lib/fortnox/api/repositories.rb

@@ -1,3 +1,4 @@
 require "fortnox/api/repositories/customer"
 require "fortnox/api/repositories/invoice"
 require "fortnox/api/repositories/order"
+require "fortnox/api/repositories/project"

data/lib/fortnox/api/repositories/base.rb

@@ -21,7 +21,7 @@ module Fortnox
 
         private
 
-          def instansiate( hash )
+          def instantiate( hash )
             hash[ :new ] = false
             hash[ :unsaved ] = false
             self.class::MODEL.new( hash )

data/lib/fortnox/api/repositories/base/loaders.rb

@@ -7,18 +7,20 @@ module Fortnox
 
         def all()
           response_hash = get( self.class::URI )
-          instansiate_collection_response( response_hash )
+          instantiate_collection_response( response_hash )
         end
 
         def only( filter )
           response_hash = get( "#{ self.class::URI }?filter=#{ filter }" )
-          instansiate_collection_response( response_hash )
+          instantiate_collection_response( response_hash )
         end
 
         def search( hash )
           attribute, value = hash.first
-          response_hash = get( "#{ self.class::URI }?#{ attribute }=#{ value }" )
-          instansiate_collection_response( response_hash )
+          uri_encoded_value = URI.encode(value)
+          uri = "#{ self.class::URI }?#{ attribute }=#{ uri_encoded_value }".freeze
+          response_hash = get( uri )
+          instantiate_collection_response( response_hash )
         end
 
         def find( id_or_hash )
@@ -33,12 +35,13 @@ module Fortnox
 
         def find_one_by( id )
           response_hash = get( "#{ self.class::URI }#{ id }" )
-          instansiate( @mapper.wrapped_json_hash_to_entity_hash( response_hash ) )
+          instantiate( @mapper.wrapped_json_hash_to_entity_hash( response_hash ) )
         end
 
-        # def find_all_by( hash )
-
-        # end
+        def find_all_by( hash )
+          response_hash = get( "#{ self.class::URI }?#{ to_query( hash ) }" )
+          instantiate_collection_response( response_hash )
+        end
 
         def to_query( hash )
           hash.collect do |key, value|
@@ -52,10 +55,10 @@ module Fortnox
 
         private
 
-          def instansiate_collection_response( response_hash )
+          def instantiate_collection_response( response_hash )
             entities_hash = @mapper.wrapped_json_collection_to_entities_hash( response_hash )
             entities_hash.map do |entity_hash|
-              instansiate( entity_hash )
+              instantiate( entity_hash )
             end
           end
 

data/lib/fortnox/api/repositories/base/savers.rb

@@ -14,7 +14,7 @@ module Fortnox
         def execute_save( entity )
           body = get_changes_on( entity ).to_json
           result = yield body
-          instansiate_saved( result )
+          instantiate_saved( result )
         end
 
         def save_new( entity )
@@ -40,8 +40,8 @@ module Fortnox
           "#{ self.class::URI }#{ entity.unique_id }"
         end
 
-        def instansiate_saved( wrapped_json_hash )
-          instansiate(
+        def instantiate_saved( wrapped_json_hash )
+          instantiate(
             @mapper.wrapped_json_hash_to_entity_hash(
               wrapped_json_hash
             )

data/lib/fortnox/api/repositories/project.rb

@@ -0,0 +1,15 @@
+require "fortnox/api/repositories/base"
+require "fortnox/api/models/project"
+require "fortnox/api/mappers/project"
+
+module Fortnox
+  module API
+    module Repository
+      class Project < Fortnox::API::Repository::Base
+        MODEL = Fortnox::API::Model::Project
+        MAPPER = Fortnox::API::Mapper::Project
+        URI = '/projects/'.freeze
+      end
+    end
+  end
+end

data/lib/fortnox/api/types.rb

@@ -32,6 +32,8 @@ module Fortnox
 
       DefaultDeliveryType = Strict::String.constrained( included_in: DefaultDeliveryTypeValues.values ).optional.constructor( EnumConstructors.default )
 
+      ProjectStatusType = Strict::String.constrained( included_in: ProjectStatusTypes.values ).optional.constructor( EnumConstructors.default )
+
       require 'fortnox/api/types/model'
       require 'fortnox/api/types/default_delivery_types'
       require 'fortnox/api/types/default_templates'

data/lib/fortnox/api/types/enums.rb

@@ -70,6 +70,9 @@ module Fortnox
       DefaultDeliveryTypeValues = Types::Strict::String.enum(
         'PRINT', 'EMAIL', 'PRINTSERVICE'
       )
+      ProjectStatusTypes = Types::Strict::String.enum(
+        'NOTSTARTED', 'ONGOING', 'COMPLETED'
+      )
     end
   end
 end

data/lib/fortnox/api/version.rb

@@ -1,5 +1,5 @@
 module Fortnox
   module API
-    VERSION = "0.2.0".freeze
+    VERSION = "0.3.0".freeze
   end
 end

data/spec/fortnox/api/mappers/project_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'fortnox/api'
+require 'fortnox/api/mappers/project'
+require 'fortnox/api/mappers/examples/mapper'
+
+describe Fortnox::API::Mapper::Project do
+  it_behaves_like 'mapper', {}, 'Project', 'Projects' do
+    let(:mapper){ described_class.new }
+  end
+end

data/spec/fortnox/api/models/customer_spec.rb

@@ -3,7 +3,5 @@ require 'fortnox/api/models/customer'
 require 'fortnox/api/models/examples/model'
 
 describe Fortnox::API::Model::Customer, type: :model do
-  valid_hash = { name: 'Arthur Dent' }
-
-  it_behaves_like 'a model', valid_hash, :customer_number, '5'
+  it_behaves_like 'a model', '1'
 end

data/spec/fortnox/api/models/examples/document_base.rb

@@ -1,7 +1,7 @@
 require 'fortnox/api/models/examples/model'
 
-shared_examples_for 'DocumentBase Model' do |row_class, row_attribute, valid_hash, valid_row_hash: {}|
-  it_behaves_like 'a model', valid_hash, :document_number, 1
+shared_examples_for 'DocumentBase Model' do |row_class, row_attribute, valid_row_hash: {}|
+  it_behaves_like 'a model', 1
 
   context "when having a(n) #{ row_class }" do
     it 'returns the correct object' do

data/spec/fortnox/api/models/examples/model.rb

@@ -1,13 +1,19 @@
-shared_examples_for 'a model' do |valid_hash, unique_id_attribute, value|
+shared_examples_for 'a model' do |unique_id|
+  let( :required_attributes ){ described_class::STUB.dup }
+  let( :unique_id_attribute ){ described_class::UNIQUE_ID }
+
   it 'can be initialized' do
-    expect{ described_class.new(valid_hash) }.not_to raise_error
+    expect{ described_class.new( required_attributes ) }.not_to raise_error
   end
 
   describe '.unique_id' do
-    let( :model ){ described_class.new( valid_hash.merge({ unique_id_attribute => value })) }
+    subject{ model.unique_id }
+
+    before{ expect(model.send(unique_id_attribute)).to eq unique_id }
 
-    before{ expect(model.send(unique_id_attribute)).to eq value }
+    let( :attributes ){ required_attributes.merge(unique_id_attribute => unique_id) }
+    let( :model ){ described_class.new( attributes ) }
 
-    it{ expect(model.unique_id).to eq value }
+    it{ is_expected.to eq unique_id }
   end
 end

data/spec/fortnox/api/models/invoice_spec.rb

@@ -3,10 +3,7 @@ require 'fortnox/api/models/invoice'
 require 'fortnox/api/models/examples/document_base'
 
 describe Fortnox::API::Model::Invoice, type: :model do
-  valid_hash = { customer_number: '12345' }
-
   it_behaves_like 'DocumentBase Model',
                   Fortnox::API::Types::InvoiceRow,
-                  :invoice_rows,
-                  valid_hash
+                  :invoice_rows
 end

data/spec/fortnox/api/models/order_spec.rb

@@ -3,11 +3,8 @@ require 'fortnox/api/models/order'
 require 'fortnox/api/models/examples/document_base'
 
 describe Fortnox::API::Model::Order, type: :model do
-  valid_hash = { customer_number: '12345' }
-
   it_behaves_like 'DocumentBase Model',
                   Fortnox::API::Types::OrderRow,
                   :order_rows,
-                  valid_hash,
                   valid_row_hash: { ordered_quantity: 1.1 }
 end

data/spec/fortnox/api/models/project_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+require 'fortnox/api/models/project'
+require 'fortnox/api/models/examples/model'
+
+describe Fortnox::API::Model::Project, type: :model do
+  it_behaves_like 'a model', '1'
+end

data/spec/fortnox/api/repositories/customer_spec.rb

@@ -23,7 +23,14 @@ describe Fortnox::API::Repository::Customer, order: :defined, integration: true
   # (until 100, which is max by default).
   include_examples '.all', 100
 
-  include_examples '.find', '1'
+  include_examples '.find', '1' do
+    let( :find_by_hash_failure ){ { city: 'Not Found' } }
+    let( :single_param_find_by_hash ){ { find_hash: { city: 'New York' }, matches: 2 } }
+
+    let( :multi_param_find_by_hash ) do
+      { find_hash: { city: 'New York', zipcode: '10001' }, matches: 1 }
+    end
+  end
 
   include_examples '.search', :name, 'Test', 23
 end

data/spec/fortnox/api/repositories/examples/find.rb

@@ -1,24 +1,79 @@
 # rubocop:disable RSpec/DescribeClass
 shared_examples_for '.find' do |searched_entity_id|
-  describe '.find' do
-    let( :find_id_1 ) do
+  describe '.find by id' do
+    let( :returned_object ) do
       VCR.use_cassette( "#{ vcr_dir }/find_id_1" ){ repository.find( searched_entity_id ) }
     end
 
-    specify 'returns correct class' do
-      expect( find_id_1.class ).to be described_class::MODEL
+    context 'when found' do
+      describe 'returned object' do
+        subject{ returned_object }
+        it{ is_expected.to be_saved }
+        it{ is_expected.not_to be_new }
+      end
+
+      describe 'class' do
+        subject{ returned_object.class }
+        it{ is_expected.to be described_class::MODEL }
+      end
+
+      describe 'unique id' do
+        subject{ returned_object.unique_id }
+        it{ is_expected.to eq searched_entity_id }
+      end
     end
 
-    specify 'returns correct Customer' do
-      expect( find_id_1.unique_id ).to eq( searched_entity_id )
+    context 'when not found' do
+      subject{ find_failure }
+
+      let( :not_found_id ){ '123456789' }
+      let( :find_failure ) do
+        when_performing do
+          VCR.use_cassette( "#{ vcr_dir }/find_failure" ){ repository.find( not_found_id ) }
+        end
+      end
+
+      it{ is_expected.to raise_error( Fortnox::API::RemoteServerError, /Kan inte hitta /) }
     end
+  end
+
+  describe '.find by hash' do
+    context 'when found' do
+      let( :returned_array ) do
+        VCR.use_cassette( "#{ vcr_dir }/#{ cassette }" ){ repository.find( find_hash ) }
+      end
 
-    specify 'returned Customer is marked as saved' do
-      expect( find_id_1 ).to be_saved
+      context 'with single parameter' do
+        let( :cassette ){ 'single_param_find_by_hash' }
+        let( :find_hash ){ single_param_find_by_hash[:find_hash] }
+
+        describe 'returned array size' do
+          subject{ returned_array.size }
+          it{ is_expected.to eq single_param_find_by_hash[:matches] }
+        end
+      end
+
+      context 'with multiple parameters' do
+        let( :cassette ){ 'multi_param_find_by_hash' }
+        let( :find_hash ){ multi_param_find_by_hash[:find_hash] }
+
+        describe 'returned array size' do
+          subject{ returned_array.size }
+          it{ is_expected.to eq multi_param_find_by_hash[:matches] }
+        end
+      end
     end
 
-    specify 'returned Customer is not markes as new' do
-      expect( find_id_1 ).not_to be_new
+    context 'when not found' do
+      subject{ find_failure }
+
+      let( :find_failure ) do
+        VCR.use_cassette( "#{ vcr_dir }/find_by_hash_failure" ) do
+          repository.find( find_by_hash_failure )
+        end
+      end
+
+      it{ is_expected.to eq [] }
     end
   end
 end