fortnox 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+*.swp
+spec/fixtures/cassettes/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fortnox.gemspec
+gemspec

data/README

@@ -0,0 +1,15 @@
+# Fortnox Ruby Wrapper
+Based on HTTParty
+For Invoicing, Customers
+
+## Testing
+* RSpec
+* Fakeweb/VCR?
+* guard start
+
+## Poor mans docs
+
+* Som det fungerar nu är det Fortnox::Invoice.create .update .destroy som gäller
+* Du får ett ID tillbaka när det gick bra annars false.
+* ID behövs användas för att exempelvis uppdatera.
+* Värt att notera är att när du lägger till en kontakt på en faktura är det inte ID du får när du skapar en kontakt som gäller, ID då är kundnr.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fortnox.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fortnox/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fortnox"
+  s.version     = Fortnox::VERSION
+  s.authors     = ["Jonas Arnklint", "Kevin Sjöberg"]
+  s.email       = ["jonas@fkw.se", "kev.sjoberg@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Handle invoices and customers through the Fortnox API}
+  s.description = %q{Handle invoices and customers through the Fortnox API}
+
+  s.rubyforge_project = "fortnox"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "webmock"
+  
+  s.add_runtime_dependency "httparty"
+  s.add_runtime_dependency "gyoku"
+end

data/lib/fortnox.rb

@@ -0,0 +1,11 @@
+require "httparty"
+require "gyoku"
+
+require "fortnox/version"
+require "fortnox/api"
+require "fortnox/invoice"
+require "fortnox/customer"
+require "fortnox/errors"
+
+module Fortnox
+end

data/lib/fortnox/api.rb

@@ -0,0 +1,43 @@
+module Fortnox
+  class API
+    include HTTParty
+
+    base_uri  'https://kund2.fortnox.se/ext/'
+    format    :xml
+
+    class << self
+      def establish_connection(opts={})
+        @@token = opts[:token] || ENV['fortnox_token']
+        @@database = opts[:database] || ENV['fortnox_database']
+        @@query_parameters = connection
+      end
+
+      def connection
+        { :token => @@token, :db => @@database }
+      end
+
+      def run(method, call, attributes={})
+        self.query_parameters = attributes[:query] if attributes[:query]
+        self.send(method, "/#{call.to_s}.php", {
+          :query  => query_parameters,
+          :body   => {:xml => build_xml(attributes)}
+        })
+      end
+
+      def query_parameters
+        @@query_parameters
+      end
+
+      def query_parameters=(params={})
+        @@query_parameters = query_parameters.merge(params)
+      end
+
+      private
+
+      def build_xml(attributes)
+        attributes.delete(:query) if attributes[:query]
+        @@xml = Gyoku.xml(attributes)
+      end
+    end
+  end
+end

data/lib/fortnox/customer.rb

@@ -0,0 +1,23 @@
+module Fortnox
+  class Customer < API
+    class << self
+      def create(attributes={})
+        attributes = attributes.reject { |k,v| k == :id } if attributes[:id]
+
+        response = run(:post, :set_contact, with_root(attributes))
+        response['result'] ? response['result']['id'].to_i : false
+      end
+
+      def update(attributes={})
+        response = run :post, :set_contact, with_root(attributes)
+        response['result'] ? response['result']['id'].to_i : false
+      end
+
+      private
+
+      def with_root(attributes)
+        {:contact => attributes}
+      end
+    end
+  end
+end

data/lib/fortnox/errors.rb

@@ -0,0 +1,3 @@
+module Fortnox
+  class Error < StandardError; end
+end

data/lib/fortnox/invoice.rb

@@ -0,0 +1,32 @@
+module Fortnox
+  class Invoice < API
+    class << self
+      def create(attributes={})
+        attributes = attributes.reject { |k,v| k == :id } if attributes[:id]
+
+        response = run :post, :set_invoice, with_root(attributes)
+        if response['result']
+          return response['result']['id'].to_i
+        else
+          raise Error, response.body
+        end
+      end
+      
+      def update(attributes={})
+	      response = run :post, :set_invoice, with_root(attributes)
+        response['result'] ? response['result']['id'].to_i : false
+      end
+
+      def destroy(id)
+        response = run :post, :set_invoice_cancel, { :query => { :id => id } }
+        response['result'] ? response['result'].to_i : false
+      end
+      
+      private
+      
+      def with_root(attributes)
+        { :invoice => attributes }
+	    end
+    end
+  end
+end

data/lib/fortnox/version.rb

@@ -0,0 +1,3 @@
+module Fortnox
+  VERSION = "0.0.1"
+end

data/spec/fixtures/invoice.yml

@@ -0,0 +1,23 @@
+id: 1
+tdate: '2012-01-04'
+ddate: '2012-02-03'
+edate: '2012-02-03'
+ourref: 'Foo Bar'
+yourref: 'Bar Foo'
+roundoff: 1.0
+freight: 0.0
+totalvat: 50.0
+total: 250.0
+contact:
+  id: 1
+  name: 'Example AB'
+  address: 'Example street'
+  city: 'Example'
+  zip: '123 45'
+  pricelist: 'A'
+invoicerows:
+  invoicerow:
+    descr: 'Sample product'
+    price: 100.0
+    amount: 2.0
+    vat: 25.0

data/spec/integration/customer_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module Fortnox
+  describe Customer do
+    before(:each) { API.establish_connection }
+
+    it "should create customer and return it's id" do
+      VCR.use_cassette('customer/create') do
+        customer_id = Customer.create(fixtures(:invoice)["contact"])
+        customer_id.should be_a(Integer)
+      end
+    end
+
+    it "should update customer given by id and return it's id" do
+      VCR.use_cassette('customer/update') do
+        customer_id = Customer.update(fixtures(:invoice)["contact"].merge(:name => 'Example Customer'))
+        customer_id.should be_a(Integer)
+        customer_id.should eq(1)
+      end
+    end
+  end
+end

data/spec/integration/invoice_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module Fortnox
+  describe Invoice do
+    before(:each) { API.establish_connection }
+
+    it "should raise error on invalid invoice creation" do
+      VCR.use_cassette('invoice/create_invalid') do
+        lambda {
+          Invoice.create(fixtures(:invoice).delete('tdate'))
+        }.should raise_error(Error)
+      end
+    end
+
+    it "should create invoice and return it's id" do
+      VCR.use_cassette('invoice/create') do
+        invoice_no = Invoice.create(fixtures(:invoice))
+        invoice_no.should be_a(Integer)
+      end
+    end
+
+    it "should update invoice given by id and return it's id" do
+      VCR.use_cassette('invoice/update') do
+        invoice_no = Invoice.update(fixtures(:invoice).merge(:ourref => 'Foo Foo'))
+        invoice_no.should be_a(Integer)
+        invoice_no.should eq(1)
+      end
+    end
+
+    it "should destroy invoice given by id and return it's id" do
+      VCR.use_cassette('invoice/destroy') do
+        invoice_no = Invoice.destroy(1)
+        invoice_no.should be_a(Integer)
+        invoice_no.should eq(1)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require "fortnox"
+require "yaml"
+require "vcr"
+
+
+def fixtures(fixture)
+  @@fixtures ||= load_fixtures
+  @@fixtures[fixture]
+end
+
+def load_fixtures
+  fixtures = {}
+
+  Dir['spec/fixtures/*.yml'].each do |file|
+    name = File.basename(file, File.extname(file)).to_sym
+    fixtures[name] = YAML::load(File.open(file).read)
+  end
+
+  fixtures
+end
+
+VCR.config do |c|
+  c.default_cassette_options = {:match_requests_on => [:method, :uri, :body]}
+  c.cassette_library_dir = 'spec/fixtures/cassettes'
+  c.stub_with :webmock
+end

data/spec/unit/api_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module Fortnox
+  describe API do
+    let(:query_params) { {:token => 'foo', :db => 'bar'} }
+
+    before :each do
+      API.establish_connection({:token => 'foo', :database => 'bar'})
+      API.stub(:post)
+    end
+
+    it "can establish a connection" do
+      API.connection.should eq(query_params)
+    end
+
+    it "can make post request" do
+      attributes = {:foo => 'bar'}
+
+      API.should_receive(:post).with('/test.php', {
+        :query  => query_params,
+        :body   => {:xml => '<foo>bar</foo>'}
+      })
+
+      API.run(:post, 'test', attributes)
+    end
+
+    it "can make post request with query parameters" do
+      attributes = {:foo => 'bar', :query => {:id => 1}}
+
+      API.should_receive(:post).with('/test.php', {
+        :query  => query_params.merge(attributes[:query]),
+        :body   => {:xml => '<foo>bar</foo>'}
+      })
+
+      API.run(:post, 'test', attributes)
+    end
+  end
+end

data/spec/unit/customer_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+module Fortnox
+  describe Customer do
+    let(:attributes) { {:id => 1, :name => 'Example AB'} }
+    
+    it "makes a post request and dismisses specified id" do
+      Customer.stub(:run) { { 'result' => { 'id' => '2' } } }
+
+      Customer.should_receive(:run).with(:post, :set_contact, { :contact => attributes.reject { |k, v| k == :id } })
+      customer_number = Customer.create(attributes)
+
+      customer_number.should_not eq(attributes[:id])
+    end
+
+    it "makes a post request and preserves specified id" do
+      Customer.stub(:run) { {'result' => {'id' => '1'}} }
+
+      Customer.should_receive(:run).with(:post, :set_contact, {:contact => attributes})
+      customer_number = Customer.update(attributes)
+    end
+  end
+end

data/spec/unit/invoice_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+module Fortnox
+  describe Invoice do
+    let(:attributes) { {:id => 1, :ourref => 'Foo Bar', :yourref => 'Bar Foo'} }
+
+    before :each do
+      Invoice.stub(:run) { {'result' => {'id' => '2'}} }
+    end
+    
+    it "makes a post request and dismisses specified id" do
+      Invoice.should_receive(:run).with(:post, :set_invoice, {:invoice => attributes.reject { |k,v| k == :id }})
+      invoice_number = Invoice.create(attributes)
+      invoice_number.should_not eq(attributes[:id])
+    end
+
+    it "makes a post request and preserves specified id" do
+      Invoice.should_receive(:run).with(:post, :set_invoice, {:invoice => attributes})
+      Invoice.update(attributes)
+    end
+
+    it "makes a post request with query parameter id" do
+      Invoice.stub(:run) { {'result' => '2'} }
+      Invoice.should_receive(:run).with(:post, :set_invoice_cancel, {:query => {:id => 2}})
+      Invoice.destroy(2)
+    end
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification 
+name: fortnox
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jonas Arnklint
+- "Kevin Sj\xC3\xB6berg"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-20 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: vcr
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: gyoku
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+description: Handle invoices and customers through the Fortnox API
+email: 
+- jonas@fkw.se
+- kev.sjoberg@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README
+- Rakefile
+- fortnox.gemspec
+- lib/fortnox.rb
+- lib/fortnox/api.rb
+- lib/fortnox/customer.rb
+- lib/fortnox/errors.rb
+- lib/fortnox/invoice.rb
+- lib/fortnox/version.rb
+- spec/fixtures/invoice.yml
+- spec/integration/customer_spec.rb
+- spec/integration/invoice_spec.rb
+- spec/spec_helper.rb
+- spec/unit/api_spec.rb
+- spec/unit/customer_spec.rb
+- spec/unit/invoice_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: fortnox
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Handle invoices and customers through the Fortnox API
+test_files: 
+- spec/fixtures/invoice.yml
+- spec/integration/customer_spec.rb
+- spec/integration/invoice_spec.rb
+- spec/spec_helper.rb
+- spec/unit/api_spec.rb
+- spec/unit/customer_spec.rb
+- spec/unit/invoice_spec.rb