sendregning 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Inge Jørgensen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,47 @@
+= Sendregning
+
+Ruby client for the SendRegning Web Service.
+
+== Getting started
+
+Install with RubyGems:
+
+ $ gem install sendregning
+
+Now start sending invoices:
+
+ # Create a new client
+ client = Sendregning::Client.new('my@email.com', 'myawesomepassword')
+
+ # Start a new email invoice
+ invoice = client.new_invoice(
+	:name           => 'My Client', 
+	:zip            => '0123', 
+	:city           => 'Oslo', 
+	:shipment       => :email, 
+	:emailaddresses => 'my@email.com'
+ )
+
+ # Add an item
+ invoice.add_line :qty => 1, :desc => 'Bananaphone', :unitPrice => '500,00'
+
+ # Send it away!
+ invoice.send!
+
+ # Get the invoice number for future reference
+ id = invoice.invoiceNo
+
+Now, let's check how we're doing
+
+ invoice = client.find_invoice(id)
+ invoice.paid? # => true
+
+Pass :test => true to the constructor to use the test API
+
+ # Create a new client
+ client = Sendregning::Client.new('my@email.com', 'myawesomepassword', :test => true)
+
+
+== Copyright
+
+Copyright (c) 2010 Inge Jørgensen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+	require 'jeweler'
+	Jeweler::Tasks.new do |gem|
+		gem.name = "sendregning"
+		gem.summary = "Ruby client for the SendRegning Web Service"
+		gem.description = "Ruby client for the SendRegning Web Service"
+		gem.email = "inge@manualdesign.no"
+		gem.homepage = "http://github.com/elektronaut/sendregning"
+		gem.authors = ["Inge Jørgensen"]
+		gem.add_dependency "httparty", ">= 0.6.1"
+		gem.add_dependency "builder", ">= 2.1.2"
+		gem.add_dependency "multipart-post", ">= 1.0.1"
+		#gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+		# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+	end
+	Jeweler::GemcutterTasks.new
+rescue LoadError
+	puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+	test.libs << 'lib' << 'test'
+	test.pattern = 'test/**/test_*.rb'
+	test.verbose = true
+end
+
+begin
+	require 'rcov/rcovtask'
+	Rcov::RcovTask.new do |test|
+		test.libs << 'test'
+		test.pattern = 'test/**/test_*.rb'
+		test.verbose = true
+	end
+rescue LoadError
+	task :rcov do
+		abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+	end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+	version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+	rdoc.rdoc_dir = 'rdoc'
+	rdoc.title = "sendregning #{version}"
+	rdoc.rdoc_files.include('README*')
+	rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/sendregning.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'builder'
+require 'net/http/post/multipart'
+require 'httparty'
+
+dir = Pathname(__FILE__).dirname.expand_path
+
+require dir + 'sendregning/client'
+require dir + 'sendregning/invoice'
+require dir + 'sendregning/line'
+
+module Sendregning
+end

data/lib/sendregning/client.rb

@@ -0,0 +1,118 @@
+require 'yaml'
+
+module Sendregning
+
+	# Client for the SendRegning Web Services.
+	#
+	# Usage example:
+	#
+	#  client = SendRegning::Client.new(my_username, my_password)
+	
+	class Client
+		include HTTParty
+
+		base_uri 'https://www.sendregning.no'
+		format   :xml
+
+		def initialize(username, password, options={})
+			@auth = {:username => username, :password => password}
+			@test = true if options[:test]
+		end
+		
+		public
+
+			# Performs a GET request
+			def get(query={})
+				self.class.get('/ws/butler.do', query_options(query))
+			end
+
+			# Performs a POST request
+			def post(query=nil)
+				self.class.post('/ws/butler.do', query_options(query))
+			end
+			
+			# Performs a POST request with an XML payload
+			def post_xml(xml, body={})
+				# Prepare the request
+				url = URI.parse("#{self.class.base_uri}/ws/butler.do")
+				body[:xml] = UploadIO.new(StringIO.new(xml), 'text/xml', 'request.xml')
+				body[:test] = true if @test
+				request = Net::HTTP::Post::Multipart.new(url.path, body)
+				request.basic_auth @auth[:username], @auth[:password]
+				
+				# Perform request
+				http = Net::HTTP.new(url.host, url.port)
+				http.use_ssl = true
+		        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+				res = http.start{|http| http.request(request)}
+
+				# Parse the response
+				response = Response.new(res, self.class.parser.call(res.body, :xml))
+			end
+		
+			# Returns a list of recipients
+			def recipients
+				response = get(:action => 'select', :type => 'recipient')
+				response['recipients']['recipient']
+			end
+			
+			# Instances a new invoice
+			def new_invoice(attributes={})
+				Sendregning::Invoice.new(attributes.merge({:client => self}))
+			end
+			
+			# Sends an invoice
+			def send_invoice(invoice)
+				response = post_xml(invoice.to_xml, {:action => 'send', :type => 'invoice'})
+				parse_invoice(response['invoices']['invoice'], invoice)
+			end
+			
+			# Finds an invoice by invoice number
+			def find_invoice(invoice_id)
+				builder = Builder::XmlMarkup.new(:indent=>2)
+				builder.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+				request_xml = builder.select do |select|
+					select.invoiceNumbers do |numbers| 
+						numbers.invoiceNumber invoice_id
+					end
+				end
+				response = post_xml(request_xml, {:action => 'select', :type => 'invoice'})
+				parse_invoice(response['invoices']['invoice']) rescue nil
+			end
+			
+
+		protected
+
+			def flatten_xml_hash(hash)
+				new_hash = {}
+				hash.each do |key, value|
+					new_hash[key] = "#{value}"
+				end
+				new_hash
+			end
+
+			def parse_invoice(response, invoice=Sendregning::Invoice.new)
+				attributes = response.dup
+				if attributes['optional']
+					attributes = attributes.merge(attributes['optional'])
+					attributes.delete('optional')
+				end
+				if attributes['shipment']
+					attributes = attributes.merge(attributes['shipment'])
+					attributes.delete('shipment')
+				end
+				lines = attributes['lines']['line']; attributes.delete('lines')
+
+				invoice.update(flatten_xml_hash(attributes))
+				invoice.lines = lines.map{|l| Sendregning::Line.new(flatten_xml_hash(l))}
+				invoice
+			end
+
+			# Prepares options for a request
+			def query_options(query={})
+				query[:test] = 'true' if @test
+				{:basic_auth => @auth, :query => query}
+			end
+
+	end
+end

data/lib/sendregning/invoice.rb

@@ -0,0 +1,144 @@
+module Sendregning
+
+	class Invoice
+
+		OPTIONAL_ATTRIBUTES = [
+			# Request
+			:invoiceType, :creditedId, :orderNo, :invoiceDate, :orderNo,
+			:invoiceDate, :dueDate, :orderDate, :recipientNo, :address1, :address2,
+			:country, :email, :ourRef, :yourRef, :comment, :invoiceText, :printDunningInfo,
+			:itemTaxInclude,
+
+			# Response
+			:tax, :dueDate, :dunningFee, :invoiceNo, :total, :accountNo, :orgNrSuffix, :kid, :orgNo, :interestRate, :state
+		]
+
+		SHIPMENT_ATTRIBUTES = [
+			:shipment, :emailaddresses, :copyaddresses
+		]
+		
+		SHIPMENT_MODES = {
+			:paper           => 'PAPER',
+			:email           => 'EMAIL',
+			:paper_and_email => 'PAPER_AND_EMAIL'
+		}
+
+		attr_accessor :client
+		attr_accessor :name, :zip, :city
+		attr_accessor :optional, :shipment
+		attr_accessor :lines
+
+		def initialize(attributes={})
+			self.update(attributes)
+			@lines = []
+		end
+		
+		def update(attributes={})
+			@client  = attributes[:client] if attributes[:client]
+			@name    = attributes[:name]   if attributes[:name]
+			@zip     = attributes[:zip]    if attributes[:zip]
+			@city    = attributes[:city]   if attributes[:city]
+			self.optional = attributes
+			self.shipment = attributes
+		end
+
+		def add_line(line)
+			line = Sendregning::Line.new(line) unless line.kind_of?(Sendregning::Line)
+			@lines << line
+			line
+		end
+		
+		# Sends an invoice
+		def send!
+			self.client.send_invoice(self)
+		end
+		
+		def paid?
+			state == 'paid'
+		end
+
+		# Renders invoice to XML
+		def to_xml(options={})
+			if options[:builder]
+				xml = options[:builder]
+			else
+				xml = Builder::XmlMarkup.new(:indent=>2)
+				xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+			end
+			xml.invoices do |invoices|
+				invoices.invoice do |invoice|
+					invoice.name @name
+					invoice.zip  @zip
+					invoice.city @city
+					
+					# Lines
+					if @lines.length > 0
+						invoice.lines do |line_builder|
+							@lines.each{|l| l.to_xml(:builder => line_builder)}
+						end
+					end
+
+					# Optional attributes
+					if @optional.length > 0
+						invoice.optional do |optional|
+							@optional.each do |key, value|
+								key = key.to_sym
+								optional.tag! key, value
+							end
+						end
+					end
+
+					# Shipment attributes
+					if @shipment.length > 0
+						invoice.shipment do |shipment|
+							shipment_mode = (@shipment[:shipment] || :paper).to_sym
+							raise 'Invalid shipment mode!' unless SHIPMENT_MODES.keys.include?(shipment_mode)
+							shipment_mode = SHIPMENT_MODES[shipment_mode]
+
+							shipment.text! shipment_mode
+							@shipment.each do |key, values|
+								key = key.to_sym
+								unless key == :shipment
+									values = [values] unless values.kind_of?(Enumerable)
+									shipment.tag! key do |emails|
+										values.each{|v| emails.email v}
+									end
+								end
+							end
+						end
+					end
+				end
+			end
+		end
+
+		protected
+		
+			def optional=(attributes)
+				@optional ||= {}
+				attributes.each do |key, value|
+					@optional[key.to_sym] = value if OPTIONAL_ATTRIBUTES.include?(key.to_sym)
+				end
+				@optional
+			end
+		
+			def shipment=(attributes)
+				@shipment ||= {}
+				attributes.each do |key, value|
+					@shipment[key.to_sym] = value if SHIPMENT_ATTRIBUTES.include?(key.to_sym)
+				end
+				@shipment
+			end
+			
+			def method_missing(method, *args)
+				if OPTIONAL_ATTRIBUTES.include?(method)
+					@optional[method]
+				elsif SHIPPING_ATTRIBUTES.include?(method)
+					@shipping[method]
+				else
+					super
+				end
+			end
+		
+	end
+
+end

data/lib/sendregning/line.rb

@@ -0,0 +1,59 @@
+module Sendregning
+
+	class Line
+
+		# Quantity, as decimal. Example: '7,5'
+		attr_accessor :qty
+		
+		# Product code. String, max length: 9
+		attr_accessor :prodCode
+		
+		# Description. String, max length: 75
+		attr_accessor :desc
+		
+		# Price per unit in decimal. Example: '250,00'
+		attr_accessor :unitPrice
+		
+		# Discount in percentage as decimal. Optional, defaults to 0
+		attr_accessor :discount
+
+		# Tax rate. Valid rates are: '0', '8', '13' and '25'. Default: '25'
+		attr_accessor :tax
+		
+		attr_accessor :itemNo, :lineTaxAmount, :lineTotal
+
+		def initialize(new_attributes={})
+			self.attributes = new_attributes
+		end
+		
+		# Renders line to XML
+		def to_xml(options={})
+			if options[:builder]
+				xml = options[:builder]
+			else
+				xml = Builder::XmlMarkup.new(:indent=>2)
+				xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+			end
+			xml.line do |line|
+				line.qty       self.qty       if @qty
+				line.prodCode  self.prodCode  if @prodCode
+				line.desc      self.desc      if @desc
+				line.unitPrice self.unitPrice if @unitPrice
+				line.discount  self.discount  if @discount
+				line.tax       self.tax       if @tax
+			end
+		end
+
+		protected
+
+			def attributes=(attributes={})
+				attributes.each do |key, value|
+					set_method = "#{key.to_s}=".to_sym
+					self.send(set_method, value) if self.respond_to?(set_method)
+				end
+				attributes
+			end
+
+	end
+	
+end

data/sendregning.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sendregning}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Inge J\303\270rgensen"]
+  s.date = %q{2010-10-20}
+  s.description = %q{Ruby client for the SendRegning Web Service}
+  s.email = %q{inge@manualdesign.no}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/sendregning.rb",
+     "lib/sendregning/client.rb",
+     "lib/sendregning/invoice.rb",
+     "lib/sendregning/line.rb",
+     "sendregning.gemspec",
+     "test/helper.rb",
+     "test/test_sendregning.rb"
+  ]
+  s.homepage = %q{http://github.com/elektronaut/sendregning}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby client for the SendRegning Web Service}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_sendregning.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_runtime_dependency(%q<builder>, [">= 2.1.2"])
+      s.add_runtime_dependency(%q<multipart-post>, [">= 1.0.1"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_dependency(%q<builder>, [">= 2.1.2"])
+      s.add_dependency(%q<multipart-post>, [">= 1.0.1"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.6.1"])
+    s.add_dependency(%q<builder>, [">= 2.1.2"])
+    s.add_dependency(%q<multipart-post>, [">= 1.0.1"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sendregning'
+
+class Test::Unit::TestCase
+end

data/test/test_sendregning.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSendregning < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: sendregning
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Inge J\xC3\xB8rgensen"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-20 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: multipart-post
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id003
+description: Ruby client for the SendRegning Web Service
+email: inge@manualdesign.no
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/sendregning.rb
+- lib/sendregning/client.rb
+- lib/sendregning/invoice.rb
+- lib/sendregning/line.rb
+- sendregning.gemspec
+- test/helper.rb
+- test/test_sendregning.rb
+has_rdoc: true
+homepage: http://github.com/elektronaut/sendregning
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby client for the SendRegning Web Service
+test_files: 
+- test/helper.rb
+- test/test_sendregning.rb