fastbill-automatic 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b1fd723a730eb7892d3ded62364d414f43ba603
+  data.tar.gz: 5baecfd6d6cd8d66edc9b2e46b2ddac57200579f
+SHA512:
+  metadata.gz: cf0bac650fc90c0c61c480616dee3bd943503b45d3de6d9bed84d0a160864f7f73e12e1f019cc49ad4c027a372133e4b69b254831e9f1f680eec9d28e917ffa8
+  data.tar.gz: e4d0036c4d2d464dd686625cb357308a1f101a1eab3ab9c93df47fb16f2d0a21ff0880607124519f0ce4b06f292db00f59f2f0fc19574dfdbb9672c1dcf96282

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.html
+/.rvmrc
+.project
+.ruby-version
+.ruby-gemset
+

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rspec"
+gem "rake"
+gem "webmock"
+gem "pry"

data/LICENSE

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright (c) 2013 Sascha Korth
+Copyright (c) 2013 Reputami GmbH
+
+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,203 @@
+Fastbill Automatic
+==================
+
+This is a Ruby wrapper for FastBill's Automatic API based on API-Documentation v1.8 (PA. 04.09.2013)
+
+Usage
+======
+
+First, you've to install the gem
+
+    gem 'fastbill-automatic', git: 'git://github.com/reputami/fastbill-automatic.git', tag: 'v0.0.3'
+
+and require it
+
+    require "fastbill-automatic"
+
+Then you have to set your Email Adress & API key:
+
+    Fastbill::Automatic.api_key = "your-api-key"
+    Fastbill::Automatic.email = "your-email-adress"
+
+Article
+-------
+
+Find existing articles (see API limits):
+
+    Fastbill::Automatic::Article.get()
+
+    Due to the API implementation the result is an array.
+
+Coupon
+------
+
+Find existing coupons (see API limits):
+
+    Fastbill::Automatic::Coupon.get()
+
+    Due to the API implementation the result is an array.
+
+Customer
+--------
+
+Creating a new customer:
+
+    Fastbill::Automatic::Customer.create(customer_type: 'business', organization: 'Company name', country_code: 'DE', payment_type: 1)
+
+Find existing customers (see API limits):
+
+    Fastbill::Automatic::Customer.get(customer_id: "123456") # With filters
+    Fastbill::Automatic::Customer.get() # Without filters
+
+    Due to the API implementation the result in both cases is an array.
+
+Updating an existing customer only works on an instance:
+
+    customer = Fastbill::Automatic::Customer.get(customer_id: "123456").first
+    customer.update_attributes(first_name: 'Max', last_name: 'Mustermann')
+
+Deleting a customer:
+
+    Fastbill::Automatic::Customer.delete("123456")
+
+
+Subscription
+------------
+
+Creating a new subscription:
+
+    Fastbill::Automatic::Subscription.create(article_number: '123', customer_id: '123456')
+
+Find existing subscriptions (see API limits):
+
+    Fastbill::Automatic::Subscription.get(customer_id: '123456') # With filter
+    Fastbill::Automatic::Subscription.get(subscription_id: '1234') # # With filter
+    Fastbill::Automatic::Subscription.get() # Without filters
+
+    Due to the API implementation the result in both cases is an array.
+
+Updating an existing subscription only works on an instance:
+
+    subscription = Fastbill::Automatic::Subscription.get(subscription_id: "123456").first
+    subscription.update_attributes(next_event: '2013-07-10')
+
+Changing an article for a given subscription:
+
+    Fastbill::Automatic::Subscription.changearticle(subscription_id: '1234', article_number: '123')
+
+Create new addon for a given subscription:
+
+    Fastbill::Automatic::Subscription.setaddon(subscription_id: '1234', article_number: '123', quantity: '10')
+
+    API Bug! => (Subscription Error: Missing / invalid field: ARTICLE_NUMBER)
+
+Set usage data for given subscription:
+
+    Fastbill::Automatic::Subscription.setusagedata(subscription_id: '1234', article_number: '123', quantity: '10')
+
+Cancel a subscription:
+
+    Fastbill::Subscription.cancel('1234')
+
+Invoice
+-------
+
+Creating a new invoice:
+
+    item = {description: 'Some info text', unit_price: '60.00', vat_percent: '19.00'}
+    items = (Array.new << item)
+
+    Fastbill::Automatic::Invoice.create(customer_id: '123456', items: items)
+
+Find existing invoices (see API limits):
+
+    Fastbill::Automatic::Invoive.get(invoice_id: '123456') # With filter
+    Fastbill::Automatic::Invoive.get(customer_id: '123456') # # With filter
+    Fastbill::Automatic::Invoive.get() # Without filters
+
+    Due to the API implementation the result in both cases is an array.
+
+Updating an existing invoice only works on an instance:
+
+    invoice = Fastbill::Automatic::Invoice.get(invoice_id: '123456').first
+    invoice.update_attributes(currency_code: 'USD', introtext: 'Some intro text')
+
+Deleting an invoice (type needs to be 'draft'):
+
+    Fastbill::Automatic::Invoice.delete('123456')
+
+Complete an invoice (type needs to be 'draft'):
+
+    Fastbill::Automatic::Invoice.complete('123456')
+
+Cancel an invoice (type needs to be 'draft'):
+
+    Fastbill::Automatic::Invoice.cancel('123456')
+
+Sign and invoice:
+
+    Fastbill::Automatic::Invoice.sign('123456')
+
+Send invoice via email:
+
+    Fastbill::Automatic::Invoice.sendbyemail(invoice_id: '123456', recipient: { to: 'info@example.com', cc: 'support@example.com' }, subject: 'Some subject text', message: 'Some message text')
+
+Send invoice by post:
+
+    Fastbill::Automatic::Invoice.sendbypost('123456')
+
+Set invoice as paid:
+
+    Fastbill::Automatic::Invoice.setpaid(invoice_id: '123456', paid_date: '2013-03-05')
+
+Item
+----
+
+Find existing items (see API limits):
+
+    Fastbill::Automatic::Item.get(invoice_id: '123456') # With filter
+    Fastbill::Automatic::Item.get() # Without filters
+
+    Due to the API implementation the result in both cases is an array.
+
+Deleting an item:
+
+    Fastbill::Automatic::Item.delete('123456')
+
+Template
+--------
+
+Find existing templates (see API limits):
+
+    Fastbill::Automatic::Template.get()
+
+    Due to the API implementation the result is an array.
+
+
+Testing
+=======
+
+To make testing easier in your app use change the default request mode from `:https` to:
+
+    Fastbill::Automatic.request_method = :test
+
+Instead of actual requests you find an array with the request infos that you can inspect:
+
+    Fastbill::Automatic::Base.request_infos
+
+To clear the request infos before or after your test runs do:
+
+    Fastbill::Automatic::Base.clear_request_infos
+
+
+
+
+
+
+
+
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: :spec

data/fastbill-automatic.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require "fastbill-automatic/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fastbill-automatic"
+  s.version     = Fastbill::Automatic::VERSION
+  s.authors     = ["Sascha Korth"]
+  s.email       = ["sascha.korth@zweitag.de"]
+  s.homepage    = "https://github.com/skorth/fastbill-automatic"
+  s.summary     = %q{API wrapper for Fastbill.}
+  s.description = %q{API wrapper for Fastbill.}
+  s.license     = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency "json"
+  s.add_development_dependency "rspec"
+end

data/lib/data/fastbill.crt

@@ -0,0 +1,17 @@
+-----BEGIN CERTIFICATE-----
+MIIDJzCCApCgAwIBAgIBATANBgkqhkiG9w0BAQQFADCBzjELMAkGA1UEBhMCWkExFTATBgNVBAgT
+DFdlc3Rlcm4gQ2FwZTESMBAGA1UEBxMJQ2FwZSBUb3duMR0wGwYDVQQKExRUaGF3dGUgQ29uc3Vs
+dGluZyBjYzEoMCYGA1UECxMfQ2VydGlmaWNhdGlvbiBTZXJ2aWNlcyBEaXZpc2lvbjEhMB8GA1UE
+AxMYVGhhd3RlIFByZW1pdW0gU2VydmVyIENBMSgwJgYJKoZIhvcNAQkBFhlwcmVtaXVtLXNlcnZl
+ckB0aGF3dGUuY29tMB4XDTk2MDgwMTAwMDAwMFoXDTIwMTIzMTIzNTk1OVowgc4xCzAJBgNVBAYT
+AlpBMRUwEwYDVQQIEwxXZXN0ZXJuIENhcGUxEjAQBgNVBAcTCUNhcGUgVG93bjEdMBsGA1UEChMU
+VGhhd3RlIENvbnN1bHRpbmcgY2MxKDAmBgNVBAsTH0NlcnRpZmljYXRpb24gU2VydmljZXMgRGl2
+aXNpb24xITAfBgNVBAMTGFRoYXd0ZSBQcmVtaXVtIFNlcnZlciBDQTEoMCYGCSqGSIb3DQEJARYZ
+cHJlbWl1bS1zZXJ2ZXJAdGhhd3RlLmNvbTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA0jY2
+aovXwlue2oFBYo847kkEVdbQ7xwblRZH7xhINTpS9CtqBo87L+pW46+GjZ4X9560ZXUCTe/LCaIh
+Udib0GfQug2SBhRz1JPLlyoAnFxODLz6FVL88kRu2hFKbgifLy3j+ao6hnO2RlNYyIkFvYMRuHM/
+qgeN9EJN50CdHDcCAwEAAaMTMBEwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQQFAAOBgQAm
+SCwWwlj66BZ0DKqqX1Q/8tfJeGBeXm43YyJ3Nn6yF8Q0ufUIhfzJATj/Tb7yFkJD57taRvvBxhEf
+8UqwKEbJw8RCfbz6q1lu1bdRiBHjpIUZa4JMpAwSremkrj/xw0llmozFyD4lt5SZu5IycQfwhl7t
+UCemDaYj+bvLpgcUQg==
+-----END CERTIFICATE-----

data/lib/fastbill-automatic/article.rb

@@ -0,0 +1,14 @@
+module Fastbill
+  module Automatic
+    class Article < Base
+
+      attr_reader :article_number, :title, :description, :unit_price, :allow_multiple, :is_addon, :currency_code,
+                  :vat_percent, :setup_fee, :subscription_interval, :subscription_number_events, :subscription_trail,
+                  :subscription_duration, :subscription_cancellation, :return_url_success, :return_url_cancel, :checkout_url
+
+      def self.create(attributes)
+        raise FastbillError.new('Create method not implemented.')
+      end
+    end
+  end
+end

data/lib/fastbill-automatic/base.rb

@@ -0,0 +1,35 @@
+module Fastbill
+  module Automatic
+    class Base
+      include Fastbill::Automatic::Services::Get
+      include Fastbill::Automatic::Services::Create
+
+      attr_accessor :attributes
+
+      @@request_infos = []
+
+      def self.request_infos 
+        @@request_infos
+      end
+
+      def self.request_infos=(info_array)
+        @@request_infos = info_array
+      end
+
+      def self.clear_request_infos 
+        @@request_infos = []
+      end
+
+      def initialize(attributes = {})
+        self.attributes = attributes
+        set_attributes(attributes)
+      end
+
+      def set_attributes(attributes)
+        attributes.each_pair do |key, value|
+          instance_variable_set("@#{key.downcase}", value)
+        end
+      end
+    end
+  end
+end

data/lib/fastbill-automatic/coupon.rb

@@ -0,0 +1,12 @@
+module Fastbill
+  module Automatic
+    class Coupon < Base
+
+      attr_reader :code, :title, :discount, :discount_period, :valid_from, :valid_to, :assigned_articles
+
+      def self.create(attributes)
+        raise FastbillError.new('Create method not implemented.')
+      end
+    end
+  end
+end

data/lib/fastbill-automatic/customer.rb

@@ -0,0 +1,16 @@
+module Fastbill
+  module Automatic
+    class Customer < Base
+      include Fastbill::Automatic::Services::Update
+      include Fastbill::Automatic::Services::Delete
+
+      attr_accessor :customer_number, :country_code, :city, :term, :comment, :changedata_url, :paymill_token,
+                    :customer_ext_uid, :customer_type, :organization, :position, :salutation, :first_name, :last_name,
+                    :address, :address_2, :zipcode, :phone, :phone_2, :fax, :mobile, :email, :account_receivable, :currency_code,
+                    :vat_id, :days_for_payment, :payment_type, :show_payment_notice, :bank_name, :bank_code, :bank_account_number,
+                    :bank_account_owner, :newsletter_optin, :language_code
+
+      attr_reader   :customer_id, :dashboard_url, :changedata_url, :status
+    end
+  end
+end

data/lib/fastbill-automatic/invoice.rb

@@ -0,0 +1,25 @@
+module Fastbill
+  module Automatic
+    class Invoice < Base
+      include Fastbill::Automatic::Services::Update
+      include Fastbill::Automatic::Services::Delete
+      include Fastbill::Automatic::Services::Complete
+      include Fastbill::Automatic::Services::Cancel
+      include Fastbill::Automatic::Services::Sign
+      include Fastbill::Automatic::Services::Sendbyemail
+      include Fastbill::Automatic::Services::Sendbypost
+      include Fastbill::Automatic::Services::Setpaid
+
+      attr_accessor :invoice_id, :type, :customer_id, :customer_number, :customer_costcenter_id,
+                    :organization, :salutation, :first_name, :last_name, :address, :address_2,
+                    :zipcode, :city, :comment, :payment_type, :days_for_payment, :bank_name, 
+                    :bank_account_number, :bank_code, :bank_account_owner, :bank_iban, :bank_bic,
+                    :affiliate, :country_code, :vat_id, :currency_code, :template_id, :subscription_id,
+                    :subscription_invoice_counter, :invoice_number, :invoice_title, :introtext, :paid_date,
+                    :is_canceled, :invoice_date, :due_date, :delivery_date, :cash_discount_percent, :cash_discount_days,
+                    :sub_total, :vat_total, :vat_items, :items, :total, :payment_info, :document_url, :paypal_url
+
+      attr_reader   :remaining_credits
+    end
+  end
+end

data/lib/fastbill-automatic/item.rb

@@ -0,0 +1,10 @@
+module Fastbill
+  module Automatic
+    class Item < Base
+      include Fastbill::Automatic::Services::DeleteItem
+
+      attr_accessor :invoice_id, :invoice_item_id, :article_number, :description,
+                    :quantity, :unit_price, :vat_percent, :sort_order
+    end
+  end
+end

data/lib/fastbill-automatic/request/base.rb

@@ -0,0 +1,36 @@
+module Fastbill
+  module Automatic
+    module Request
+      class Base
+        attr_reader :info
+        attr_accessor :response
+
+        def initialize(info)
+          @info = info
+        end
+
+        def perform
+          raise AuthenticationError if Fastbill::Automatic.api_key.nil? || Fastbill::Automatic.email.nil?
+          connection.setup_https
+          send_request
+
+          validator.validated_data_for(response)
+        end
+
+        protected
+
+        def send_request
+          self.response = connection.request
+        end
+
+        def connection
+          @connection ||= Connection.new(info)
+        end
+
+        def validator
+          @validator ||= Validator.new(info)
+        end
+      end
+    end
+  end
+end

data/lib/fastbill-automatic/request/connection.rb

@@ -0,0 +1,37 @@
+module Fastbill
+  module Automatic
+    module Request
+      class Connection
+        attr_reader :https
+
+        def initialize(request_info)
+          @info = request_info
+        end
+
+        def setup_https
+          @https             = Net::HTTP.new(API_BASE, Net::HTTP.https_default_port)
+          @https.use_ssl     = true
+          @https.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          @https.ca_file     = File.join(ROOT_PATH, "data/fastbill.crt")
+        end
+
+        def request
+          https.start do |connection|
+            https.request(https_request)
+          end
+        end
+
+        protected
+
+        def https_request
+          https_request = Net::HTTP::Post.new(@info.url)
+          https_request.basic_auth(Fastbill::Automatic.email, Fastbill::Automatic.api_key)
+          body = {service: @info.service}
+          body[(@info.service.include?('.get') ? :filter : :data)] = @info.data
+          https_request.body = body.to_json
+          https_request
+        end
+      end
+    end
+  end
+end

data/lib/fastbill-automatic/request/info.rb

@@ -0,0 +1,32 @@
+module Fastbill
+  module Automatic
+    module Request
+      class Info
+        attr_accessor :service, :data
+
+        def ==(other)
+          @service == other.service && @data == other.data
+        end
+
+        def initialize(service, data)
+          @service = service
+          @data    = data
+        end
+
+        def url
+          url = "/api/#{API_VERSION}/api.php"
+          url
+        end
+
+        def path_with_params(path, params)
+          unless params.empty?
+            encoded_params = URI.encode_www_form(params)
+            [path, encoded_params].join("?")
+          else
+            path
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fastbill-automatic/request/validator.rb

@@ -0,0 +1,33 @@
+module Fastbill
+  module Automatic
+    module Request
+      class Validator
+        attr_reader :info
+        attr_accessor :response
+
+        def initialize(info)
+          @info = info
+        end
+
+        def validated_data_for(incoming_response)
+          self.response = incoming_response
+          verify_response_code
+          info.data = JSON.parse(response.body)
+          validate_response_data
+          info.data
+        end
+
+        protected
+
+        def verify_response_code
+          raise AuthenticationError if response.code.to_i == 401
+          raise APIError if response.code.to_i >= 500
+        end
+
+        def validate_response_data
+          raise APIError.new(info.data["RESPONSE"]["ERRORS"]) if info.data["RESPONSE"]["ERRORS"]
+        end
+      end
+    end
+  end
+end

data/lib/fastbill-automatic/services/cancel.rb

@@ -0,0 +1,22 @@
+module Fastbill
+  module Automatic
+    module Services
+      module Cancel
+        module ClassMethods
+
+          def cancel(id)
+            id_attribute = "#{self.name.split("::").last.downcase}_id".to_sym
+            attributes = {}
+            attributes[id_attribute] = id
+            response = Fastbill::Automatic.request("#{self.name.split("::").last.downcase}.cancel", attributes)
+            true
+          end
+        end
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+      end
+    end
+  end
+end

data/lib/fastbill-automatic/services/changearticle.rb

@@ -0,0 +1,19 @@
+module Fastbill
+  module Automatic
+    module Services
+      module Changearticle
+        module ClassMethods
+
+          def changearticle(attributes)
+            response = Fastbill::Automatic.request("#{self.name.split("::").last.downcase}.changearticle", attributes)
+            true
+          end
+        end
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+      end
+    end
+  end
+end

data/lib/fastbill-automatic/services/complete.rb

@@ -0,0 +1,22 @@
+module Fastbill
+  module Automatic
+    module Services
+      module Complete
+        module ClassMethods
+
+          def complete(id)
+            id_attribute = "#{self.name.split("::").last.downcase}_id".to_sym
+            attributes = {}
+            attributes[id_attribute] = id
+            response = Fastbill::Automatic.request("#{self.name.split("::").last.downcase}.complete", attributes)
+            true
+          end
+        end
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+      end
+    end
+  end
+end

data/lib/fastbill-automatic/services/create.rb

@@ -0,0 +1,19 @@
+module Fastbill
+  module Automatic
+    module Services
+      module Create
+        module ClassMethods
+
+          def create(attributes)
+            response = Fastbill::Automatic.request("#{self.name.split("::").last.downcase}.create", attributes)
+            self.new(response["RESPONSE"])
+          end
+        end
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+      end
+    end
+  end
+end

data/lib/fastbill-automatic/services/delete.rb

@@ -0,0 +1,22 @@
+module Fastbill
+  module Automatic
+    module Services
+      module Delete
+        module ClassMethods
+
+          def delete(id)
+            id_attribute = "#{self.name.split("::").last.downcase}_id".to_sym
+            attributes = {}
+            attributes[id_attribute] = id
+            response = Fastbill::Automatic.request("#{self.name.split("::").last.downcase}.delete", attributes)
+            true
+          end
+        end
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+      end
+    end
+  end
+end