fortnox-api 0.0.1 → 0.0.2

data/lib/fortnox/api/repository/loaders.rb

@@ -0,0 +1,49 @@
+require "cgi"
+
+module Fortnox
+  module API
+    module Repository
+      module Loaders
+
+        def all
+          response_hash = get( @base_uri )
+          entities_hash = response_hash[ @json_list_wrapper ]
+          entities_hash.map do |entity_hash|
+            hash_to_entity( entity_hash )
+          end
+        end
+
+        def find( id_or_hash )
+          return find_all_by( id_or_hash ) if id_or_hash.is_a? Hash
+
+          id = Integer( id_or_hash )
+          find_one_by( id )
+
+        catch ArgumentError
+          raise ArgumentError, "find only accepts a number or hash as argument"
+        end
+
+        def find_one_by( id )
+          response_hash = get( @base_uri + id )
+          entity_hash = response_hash[ @json_entity_wrapper ]
+          hash_to_entity( entity_hash )
+        end
+
+        def find_all_by( hash )
+
+        end
+
+        def to_query( hash )
+          hash.collect do |key, value|
+            escape( key, value )
+          end.sort * '&'
+        end
+
+        def escape( key, value )
+          "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
+        end
+
+      end
+    end
+  end
+end

data/lib/fortnox/api/repository/savers.rb

@@ -0,0 +1,15 @@
+module Fortnox
+  module API
+    module Repository
+      module Savers
+
+        def save( customer )
+          # hash = entity_to_hash( customer )
+          # json = hash.to_json
+          # Fortnox::API::Repository::Base.
+        end
+
+      end
+    end
+  end
+end

data/lib/fortnox/api/validator.rb

@@ -0,0 +1,32 @@
+require "vanguard"
+
+module Fortnox
+  module API
+    module Validator
+
+      def validate( instance )
+        raise ArgumentError, "No validator given for #{name}" unless @validator
+
+        validation_result = @validator.call( instance )
+        @violations = validation_result.violations
+
+        return validation_result.valid?
+      end
+
+      def violations
+        @violations ||= Set.new
+      end
+
+      def using_validations &block
+        @validator = Vanguard::Validator.build &block
+      end
+
+      def instance
+        raise ArgumentError, "No validator given for #{name}" unless @validator
+
+        self
+      end
+
+    end
+  end
+end

data/lib/fortnox/api/version.rb

@@ -1,5 +1,5 @@
 module Fortnox
   module API
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/spec/fortnox/api/base_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe Fortnox::API do
+
+  describe 'creation' do
+    context 'without parameters' do
+      it 'fails when given as argument' do
+        expect{
+          Fortnox::API.new()
+        }.to raise_error(
+          ArgumentError,
+          /base url/
+        )
+      end
+    end
+
+    context 'with only client_secret' do
+      it 'fails when given as argument' do
+        expect{
+          Fortnox::API.new(
+            base_url: ''
+          )
+        }.to raise_error(
+          ArgumentError,
+          /client secret/
+        )
+      end
+
+      it 'fails when given as ENV' do
+        stub_const('ENV', ENV.to_hash.merge('FORTNOX_API_BASE_URL' => 'xxx'))
+        expect{
+          Fortnox::API.new()
+        }.to raise_error(
+          ArgumentError,
+          /client secret/
+        )
+      end
+    end
+
+    context 'with both base url and client secret' do
+      it 'fails when given as argument' do
+        expect{
+          Fortnox::API.new(
+            base_url: '',
+            client_secret: '',
+          )
+        }.to raise_error(
+          ArgumentError,
+          /access token/
+        )
+      end
+
+      it 'fails when given as ENV' do
+        stub_const('ENV', ENV.to_hash.merge('FORTNOX_API_CLIENT_SECRET' => 'xxx', 'FORTNOX_API_ACCESS_TOKEN' => 'xxx'))
+        expect{
+          Fortnox::API.new()
+        }.to raise_error(
+          ArgumentError,
+          /base url/
+        )
+      end
+    end
+
+  end
+
+  context 'get access token' do
+    it 'works' do
+      stub_request(
+        :get,
+        'http://api.fortnox.se/3/',
+      ).with(
+        headers: {
+          'Authorisation-Code' => 'ea3862b0-189c-464b-8e23-1b9702365ea1',
+          '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' },
+      )
+
+      response = Fortnox::API.get_access_token(
+        base_url: 'http://api.fortnox.se/3/',
+        client_secret: 'P5K5vE3Kun',
+        authorization_code: 'ea3862b0-189c-464b-8e23-1b9702365ea1',
+      )
+
+      response.should == "3f08d038-f380-4893-94a0-a08f6e60e67a"
+    end
+  end
+
+end

data/spec/fortnox/api/customer/validator_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Fortnox::API::Customer::Validator do
+
+  describe '.validate' do
+    context 'Customer with valid, simple attributes' do
+      it 'is valid' do
+        customer = Fortnox::API::Customer.new( name: 'Test' )
+        validator = Fortnox::API::Customer::Validator
+
+        expect( validator.validate( customer )).to eql( true )
+      end
+    end
+
+    context 'Customer with invalid sales_account' do
+
+      let( :customer ){ Fortnox::API::Customer.new( sales_account: 99999 )}
+      let( :validator ){ Fortnox::API::Customer::Validator }
+
+      it 'is invalid' do
+        expect( validator.validate( customer )).to eql( false )
+      end
+
+      it 'includes "sales_account" in violations' do
+        validator.validate( customer )
+
+        expect( validator.violations.inspect ).to include( 'sales_account' )
+      end
+    end
+  end
+
+end

data/spec/fortnox/api/entity_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+class TestEntity < Fortnox::API::Entity
+  attribute :private, String, writer: :private
+  attribute :string, String
+  attribute :number, Integer, default: 42
+end
+
+describe Fortnox::API::Entity do
+
+  describe '.new' do
+    context 'with basic attribute' do
+      it 'works' do
+        test = TestEntity.new( string: 'Test' )
+
+        expect( test.class ).to eql( TestEntity )
+      end
+    end
+  end
+
+  describe '.update' do
+    context 'with new, simple value' do
+      it 'returns a new object' do
+        original = TestEntity.new( string: 'Test' )
+        variant = original.update( string: 'Variant' )
+
+        expect( variant ).to_not eql( original )
+      end
+
+      it 'returns a object of the same class' do
+        original = TestEntity.new( string: 'Test' )
+        variant = original.update( string: 'Variant' )
+
+        expect( variant.class ).to eql( original.class )
+      end
+
+      it 'returns a object with the new value' do
+        original = TestEntity.new( string: 'Test' )
+        variant = original.update( string: 'Variant' )
+
+        expect( variant.string ).to eql( 'Variant' )
+      end
+    end
+
+    context 'with the same, simple value' do
+      it 'returns the same object' do
+        original = TestEntity.new( string: 'Test' )
+        variant = original.update( string: 'Test' )
+
+        expect( variant ).to eql( original )
+      end
+
+      it 'returns a object with the same value' do
+        original = TestEntity.new( string: 'Test' )
+        variant = original.update( string: 'Test' )
+
+        expect( variant.string ).to eql( 'Test' )
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+ENV['RUBY_ENV'] = 'test'
+
+require 'fortnox/api'
+require 'webmock/rspec'
+require 'pry'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+end
+
+# Force disable the dotenv gem
+ENV = {}

metadata

@@ -1,31 +1,157 @@
 --- !ruby/object:Gem::Specification
 name: fortnox-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jonas Schubert Erlandsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-28 00:00:00.000000000 Z
+date: 2015-04-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: vanguard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,9 +164,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This gem uses an HTTP library to abstract the REST calls from everyday
-  use. Simply use the builtin classes to create, access, update and destroy entries
-  in your Fortnox database.
+description: This gem uses the HTTParty library to abstract away the REST calls. It
+  gives you access to a number of objects that behave a lot like ActiveRecord instances,
+  giving you access to methods like `all`, `find`, `find_by_...` and so on. And each
+  individual instance can be easaly persistable to Fortnox again using the `save`
+  method.
 email:
 - jonas.schubert.erlandsson@my-codeworks.com
 executables: []
@@ -48,13 +176,35 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
+- Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - fortnox-api.gemspec
 - lib/fortnox/api.rb
+- lib/fortnox/api/base.rb
+- lib/fortnox/api/class_methods.rb
+- lib/fortnox/api/customer.rb
+- lib/fortnox/api/customer/entity.rb
+- lib/fortnox/api/customer/repository.rb
+- lib/fortnox/api/customer/validator.rb
+- lib/fortnox/api/entity.rb
+- lib/fortnox/api/repository/base.rb
+- lib/fortnox/api/repository/json_convertion.rb
+- lib/fortnox/api/repository/loaders.rb
+- lib/fortnox/api/repository/savers.rb
+- lib/fortnox/api/validator.rb
 - lib/fortnox/api/version.rb
+- spec/fortnox/api/base_spec.rb
+- spec/fortnox/api/customer/repository_spec.rb
+- spec/fortnox/api/customer/validator_spec.rb
+- spec/fortnox/api/entity_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/my-codeworks/fortnox-api
 licenses:
 - MIT
@@ -79,4 +229,9 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Gem to use Fortnox REST API in Ruby.
-test_files: []
+test_files:
+- spec/fortnox/api/base_spec.rb
+- spec/fortnox/api/customer/repository_spec.rb
+- spec/fortnox/api/customer/validator_spec.rb
+- spec/fortnox/api/entity_spec.rb
+- spec/spec_helper.rb