easybill 0.2.17

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db9c7e5fbf2f0dce0f22b7d1f39e084c8f9de86b
+  data.tar.gz: 4da8f71c973ed2478394a282f1565854783df254
+SHA512:
+  metadata.gz: 08e76ed6811ec5901323ec690aeafc8ea1bf6522c467dc15ab334c7e388be54950f83f3000d6ecba22ee00364e75af81bdadab804e94274a6db51740f9f6e3f5
+  data.tar.gz: d792eee33d7edd5bf772d6ee96f323602d9dbaf0524863200a51c5ddd600dedac4195729f1f701c0c6bc2717edc725c9bb4783c88e0e1590a5f724205630cc8c

data/.gitignore

@@ -0,0 +1,24 @@
+Gemfile.lock
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+log
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+apikey
+
+*~

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.1.4

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Lars Henrik Mai
+
+MIT License
+
+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.md

@@ -0,0 +1,74 @@
+# Easybill
+
+A wrapper for the [Easybill](http://easybill.de) online invoice service.
+Create invoices, manage customer information and their payments using
+the SOAP API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'easybill'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easybill
+
+## Usage
+
+    client = Easybill::Client.new(key: <your apikey>)
+    # => <Easybill::Client @key=<asdf>>
+    # Note: the 'key' argument can be left out if you store the key in a
+    # file name 'apikey' in the project root.
+    customer = client.get_customer_by_customer_number(700)
+    # => <Easybill::Customer ... > # a [OpenStruct](http://www.ruby-doc.org/stdlib-2.0/libdoc/ostruct/rdoc/OpenStruct.html)
+    client.search_customers("Foo")
+    # => [<Easybill::Customer>...] # Array[OpenStruct]
+    customer.company_name
+    # => "ACME Inc."
+
+See lib/easybill/client.rb for currently supported operations.
+
+If you need access to unmapped SOAP operations you can always use the
+underlying savonrb client:
+
+    client.client.class
+    # => Savon::Client
+    client.client.operations
+    # => [:get_customer, :get_customer_by_customer_number, :set_customer ... ]
+    client.client.call(<operation>, message: <hash>)
+
+For exploration of the API and ease of development, there are some
+fixtures in place in fixtures.yaml:
+
+    require 'easybill/fixture'
+    include Easybill::Fixture
+    # provides "customer", "document" and "position" helper methods
+    invoice = document(:basic)
+    # => {...} # corresponding hash from the yaml fixtures
+    
+    # the customer_id in the fixtures is probably not valid anymore:
+    customer_id = client.get_customer_by_customer_number(10001).customer_id
+    invoice["customerID"] = customer_id    
+
+    client.client.call(:create_document, message: invoice)
+    # (lots of debug output)
+
+## Testing 
+    
+If you need to update the vcr cassettes you can pass a valid api key to
+your test setting the EASYBILL_APIKEY environment variable.
+
+    EASYBILL_APIKEY='120931...' bundle exec rspec spec
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/easybill.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easybill/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'easybill'
+  gem.version       = Easybill::VERSION
+  gem.authors       = ['ad2games GmbH']
+  gem.email         = ['developers@ad2games.com']
+  gem.description   = 'Create invoices with Easybill'
+  gem.summary       = 'A client library to the SOAP API of Easybill.de'
+  gem.homepage      = ''
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'sekken'
+  gem.add_runtime_dependency 'php-serialize'
+  gem.add_runtime_dependency 'local_copy'
+
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rspec', '>= 3.0.0'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock'
+end

data/lib/easybill.rb

@@ -0,0 +1,52 @@
+require 'sekken'
+require 'sekken_patches/importer'
+require 'ostruct'
+
+require 'easybill/configuration'
+require 'easybill/version'
+require 'easybill/error'
+require 'easybill/client'
+require 'easybill/document'
+require 'easybill/customer'
+require 'easybill/payment'
+
+require 'easybill/railtie' if defined?(Rails::Railtie)
+
+module Easybill
+  class << self
+    # The Easybill configuration object. Must act like a hash and return sensible
+    # values for all Easybill configuration options. See Easybill::Configuration.
+    attr_writer :configuration
+
+    # Public: Call this method to modify defaults in your initializers.
+    #
+    # Examples:
+    #
+    #   Easybill.configure do |config|
+    #     config.api_key = '1234678...'
+    #   end
+    #
+    # Yields Easybill configuration
+    def configure
+      yield(configuration)
+    end
+
+    # Public: The configuration object.
+    #
+    # Returns Easybill configuration
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def wsdl
+      return @wsdl if @wsdl
+      wsdl_path = File.join(root_path, 'wsdl')
+      @wsdl = File.read(File.join(root_path, 'wsdl/soap.easybill.wsdl'))
+        .gsub('WSDL_PATH', wsdl_path)
+    end
+
+    def root_path
+      File.expand_path(File.join(__FILE__, '../..'))
+    end
+  end
+end

data/lib/easybill/client.rb

@@ -0,0 +1,116 @@
+require 'local_copy'
+
+module Easybill
+  class Client
+    # default is 60 seconds which is too low
+    HTTP_RECEIVE_TIMEOUT = 300
+
+    CLIENT_METHODS = {
+      get_customer: { op_name: 'getCustomer', result_type: 'customer' },
+      get_customer_by_customer_number: { op_name: 'getCustomerByCustomerNumber', result_type: 'customer' },
+      set_customer: { op_name: 'setCustomer', result_type: 'customer' },
+      create_document: { op_name: 'createDocument', result_type: 'document' },
+      get_documents: { op_name: 'getDocuments', result_type: 'document' },
+      add_document_payment: { op_name: 'addDocumentPayment', result_type: nil },
+      get_document_payments: { op_name: 'getDocumentPayments', result_type: 'payment' },
+      find_documents_by_document_number: { op_name: 'findDocumentsByDocumentNumber', result_type: 'document' },
+      get_document_pdf: { op_name: 'getDocumentPDF', result_type: 'document' },
+      create_dunning: { op_name: 'createDunning', result_type: 'document' },
+      get_document_sent: { op_name: 'getDocumentSent', result_type: 'document' },
+    }
+
+    def initialize(options = {})
+      @options = Easybill.configuration.merge(options)
+    end
+
+    def client
+      sekken = Sekken.new(Easybill.wsdl)
+      sekken.http.receive_timeout = HTTP_RECEIVE_TIMEOUT
+      sekken
+    end
+
+    CLIENT_METHODS.each do |method_name, method_details|
+      define_method method_name do |arg|
+        response = save_call do
+          operation = client.operation('easybillService', 'easybillPort', method_details[:op_name])
+          operation.header = { 'UserAuthKey' => @options[:api_key] }
+          operation.body = { "#{method_details[:op_name][0].upcase}#{method_details[:op_name][1..-1]}Request".to_sym => arg }
+
+          operation.call
+        end
+        build_proper_response(method_name, method_details[:result_type], response)
+      end
+    end
+
+    def search_customers(term)
+      response = save_call do
+        operation = client.operation('easybillService', 'easybillPort', :searchCustomers)
+        operation.header = { 'UserAuthKey' => @options[:api_key] }
+        operation.body = { SearchCustomersRequest: term }
+
+        operation.call
+      end
+      return [] if response.body[:search_customers_response].nil?
+
+      records = response.body[:search_customers_response][:search_customer]
+      records = [records] if records.is_a?(Hash)
+      records.map { |hsh| Easybill::Customer.new(hsh) }
+    end
+
+    private
+
+    def save_call
+      response = yield
+
+      begin
+        if response.body.empty? || (response.body.is_a?(Hash) && response.body.key?(:fault))
+          fail Easybill::Error, response.body[:fault][:faultstring]
+        end
+      rescue NoMethodError
+        raise Easybill::Error, 'Could not parse response: ' \
+          "#{response.respond_to?(:raw) ? response.raw : ''}"
+      end
+
+      response
+    rescue HTTPClient::ConnectTimeoutError
+      raise Easybill::Error, 'Timeout, please switch to different billing service.'
+    end
+
+    def response_array(result, result_type, klass)
+      return [] if result.blank?
+
+      if result.is_a?(Hash) && result[result_type]
+        if result[result_type].is_a?(Hash)
+          [klass.new(result[result_type])]
+        else
+          result[result_type].map { |element| klass.new(element) }
+        end
+      else
+        [klass.new(result)]
+      end
+    end
+
+    def build_proper_response(method_name, result_type, response)
+      result = response.body[:"#{method_name}_response"]
+
+      if method_name == :get_documents
+        response_array(result, result_type.to_sym, Easybill::Document)
+      elsif method_name == :get_document_payments
+        response_array(result, result_type.to_sym, Easybill::Payment)
+      elsif method_name == :find_documents_by_document_number
+        response_array(result, result_type.to_sym, Easybill::Document)
+      else
+        case result_type
+        when 'customer'
+          Easybill::Customer.new(result)
+        when 'document'
+          Easybill::Document.new(result)
+        when 'payment'
+          Easybill::Payment.new(result)
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/easybill/configuration.rb

@@ -0,0 +1,43 @@
+module Easybill
+  class Configuration
+    OPTIONS = [:api_key, :logger].freeze
+
+    # The API key for your user taken from the easybill website.
+    attr_accessor :api_key
+
+    # The logger used by Easybill
+    attr_accessor :logger
+
+    def initialize
+      OPTIONS.each do |option|
+        env_key = "EASYBILL_#{option.upcase}"
+        send("#{option}=", ENV[env_key]) if ENV[env_key]
+      end
+    end
+
+    # Public: Returns a hash of all configurable options.
+    def to_hash
+      Hash[OPTIONS.map do |option|
+        [option, send(option)]
+      end]
+    end
+
+    # Public: Allows config options to be read like a hash.
+    #
+    # key - Name of the option to retrieve
+    #
+    # Returns the value of the requested attribute
+    def[](key)
+      send(key) if OPTIONS.include?(key)
+    end
+
+    # Public
+    #
+    # hash - A set of configuration options that will take precedence over the defaults
+    #
+    # Returns a hash of all configurable options merged with +hash+
+    def merge(hash)
+      to_hash.merge(hash)
+    end
+  end
+end

data/lib/easybill/customer.rb

@@ -0,0 +1,4 @@
+module Easybill
+  class Customer < OpenStruct
+  end
+end

data/lib/easybill/document.rb

@@ -0,0 +1,34 @@
+require 'php_serialize'
+
+module Easybill
+  class Document < OpenStruct
+    def service_period
+      plain_service_date = PHP.unserialize(service_date)
+
+      if plain_service_date.nil?
+        ''
+      else
+        if plain_service_date.key?('serviceDateFrom')
+          "#{parse_date(plain_service_date['serviceDateFrom'])} - #{parse_date(plain_service_date['serviceDateThru'])}"
+        else
+          plain_service_date['serviceDateString']
+        end
+      end
+    end
+
+    def service_period_end
+      service_period_dates = service_period.split(' - ')
+      service_period_dates.length == 2 ? Date.parse(service_period_dates[1]) : nil
+    end
+
+    def cancellation?
+      document_type == 'STORNO'
+    end
+
+    private
+
+    def parse_date(date)
+      Date.parse(date).strftime('%d.%m.%Y')
+    end
+  end
+end

data/lib/easybill/error.rb

@@ -0,0 +1,3 @@
+module Easybill
+  class Error < Sekken::Error; end
+end

data/lib/easybill/payment.rb

@@ -0,0 +1,4 @@
+module Easybill
+  class Payment < OpenStruct
+  end
+end

data/lib/easybill/railtie.rb

@@ -0,0 +1,12 @@
+require 'easybill'
+require 'rails'
+
+module Easybill
+  class Railtie < Rails::Railtie
+    config.before_initialize do
+      Easybill.configure do |config|
+        config.logger = Rails.logger
+      end
+    end
+  end
+end