octobat 0.0.12 → 2.0.0

data/lib/octobat/credit_note.rb

@@ -0,0 +1,35 @@
+module Octobat
+  class CreditNote < APIResource
+    extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+
+    def send_by_email(email_data = {})
+      response, api_key = Octobat.request(:post, send_url, @api_key, email_data)
+      refresh_from(response, api_key)
+    end
+
+    def confirm
+      response, api_key = Octobat.request(:patch, confirm_url, @api_key)
+      refresh_from(response, api_key)
+    end
+
+    def items(params = {})
+      Item.list(params.merge({ :invoice => id }), @api_key)
+    end
+
+    def transactions(params = {})
+      Transaction.list(params.merge(invoice: id), @api_key)
+    end
+
+    private
+
+      def send_url
+        url + '/send'
+      end
+
+      def confirm_url
+        url + '/confirm'
+      end
+  end
+end

data/lib/octobat/credit_note_numbering_sequence.rb

@@ -1,5 +1,18 @@
 module Octobat
   class CreditNoteNumberingSequence < APIResource
     extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+
+    def set_to_default
+      response, api_key = Octobat.request(:patch, set_to_default_url, @api_key)
+      refresh_from(response, api_key)
+    end
+
+    private
+
+      def set_to_default_url
+        url + '/default'
+      end
   end
 end

data/lib/octobat/customer.rb

@@ -3,10 +3,18 @@ module Octobat
     extend Octobat::APIOperations::List
     include Octobat::APIOperations::Create
     include Octobat::APIOperations::Update
-    
+
     def invoices(params = {})
       Invoice.all(params.merge({ :customer => id }), @api_key)
     end
-    
+
+    def credit_notes(params = {})
+      CreditNote.all(params.merge({ :customer => id }), @api_key)
+    end
+
+    def payment_sources(params = {})
+      PaymentSource.all(params.merge({ :customer => id }), @api_key)
+    end
+
   end
 end

data/lib/octobat/document.rb

@@ -0,0 +1,17 @@
+module Octobat
+  class Document < APIResource
+    
+    
+    def self.csv_export(params = {}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      api_key ||= @api_key
+      opts[:api_key] = api_key
+
+      instance = self.new(nil, opts)
+
+      response, api_key = Octobat.request(:post, url + '/csv_export', api_key, params)
+      return true
+    end
+    
+  end
+end

data/lib/octobat/document_email_template.rb

@@ -0,0 +1,19 @@
+module Octobat
+  class DocumentEmailTemplate < APIResource
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+
+    def self.default(params = {}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      api_key ||= @api_key
+      opts[:api_key] = api_key
+
+      instance = self.new(nil, opts)
+
+      response, api_key = Octobat.request(:get, url + '/default', api_key, params)
+      instance.refresh_from(response, api_key)
+      instance
+    end
+
+  end
+end

data/lib/octobat/document_language.rb

@@ -0,0 +1,19 @@
+module Octobat
+  class DocumentLanguage < APIResource
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+
+    def self.default(params = {}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      api_key ||= @api_key
+      opts[:api_key] = api_key
+
+      instance = self.new(nil, opts)
+
+      response, api_key = Octobat.request(:get, url + '/default', api_key, params)
+      instance.refresh_from(response, api_key)
+      instance
+    end
+
+  end
+end

data/lib/octobat/document_template.rb

@@ -0,0 +1,33 @@
+module Octobat
+  class DocumentTemplate < APIResource
+    extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+
+    def duplicate(params = {})
+      response, api_key = Octobat.request(:post, duplicate_url, @api_key, params)
+      refresh_from(response, api_key)
+    end
+
+    def activate
+      response, api_key = Octobat.request(:patch, activate_url, @api_key)
+      refresh_from(response, api_key)
+    end
+
+    def delete
+      response, api_key = Octobat.request(:delete, url, @api_key)
+      refresh_from(response, api_key)
+    end
+
+    private
+
+      def duplicate_url
+        url + '/duplicate'
+      end
+
+      def activate_url
+        url + '/activate'
+      end
+
+  end
+end

data/lib/octobat/emails_setting.rb

@@ -0,0 +1,19 @@
+module Octobat
+  class EmailsSetting < APIResource
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+
+    def self.default(params = {}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      api_key ||= @api_key
+      opts[:api_key] = api_key
+
+      instance = self.new(nil, opts)
+
+      response, api_key = Octobat.request(:get, url + '/default', api_key, params)
+      instance.refresh_from(response, api_key)
+      instance
+    end
+
+  end
+end

data/lib/octobat/errors/api_connection_error.rb

@@ -1,4 +1,4 @@
 module Octobat
-  class APIConnectionError < OctobatError
+  class APIConnectionError < OctobatLibError
   end
 end

data/lib/octobat/errors/api_error.rb

@@ -1,4 +1,4 @@
 module Octobat
-  class APIError < OctobatError
+  class APIError < OctobatLibError
   end
 end

data/lib/octobat/errors/authentication_error.rb

@@ -1,4 +1,4 @@
 module Octobat
-  class AuthenticationError < OctobatError
+  class AuthenticationError < OctobatLibError
   end
 end

data/lib/octobat/errors/invalid_request_error.rb

@@ -1,10 +1,8 @@
 module Octobat
   class InvalidRequestError < OctobatError
-    attr_accessor :param
 
-    def initialize(message, param, http_status=nil, http_body=nil, json_body=nil)
-      super(message, http_status, http_body, json_body)
-      @param = param
+    def initialize(error, http_status=nil, http_body=nil, json_body=nil)
+      super(error, http_status, http_body, json_body)
     end
   end
 end

data/lib/octobat/errors/octobat_error.rb

@@ -1,20 +1,46 @@
 module Octobat
   class OctobatError < StandardError
-    attr_reader :message
+    attr_accessor :message
+    attr_reader :error
     attr_reader :http_status
     attr_reader :http_body
     attr_reader :json_body
 
-    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
-      @message = message
+    def initialize(error=nil, http_status=nil, http_body=nil, json_body=nil)
+      @error = error
       @http_status = http_status
       @http_body = http_body
       @json_body = json_body
     end
+    
+    def message
+      @message ||= generate_message_from_error
+    end
 
     def to_s
       status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
-      "#{status_string}#{@message}"
+      "#{status_string}#{message}"
+    end
+    
+    def generate_message_from_error
+      return "" if @error.nil?
+      a = []
+      
+      @error.each_key do |k|
+        msg = k.eql?(:global) ? "" : "#{k.to_s}: "
+        msg << "#{serialize_errors_from(@error[k])}"
+        a << msg
+      end
+      
+      a.join(". ")
+    end
+    
+    def serialize_errors_from(err)
+      a = []
+      err.each do |e|
+        a << "#{e[:details]}"
+      end
+      a.join(', ')
     end
   end
-end
+end

data/lib/octobat/errors/octobat_lib_error.rb

@@ -0,0 +1,20 @@
+module Octobat
+  class OctobatLibError < StandardError
+    attr_reader :message
+    attr_reader :http_status
+    attr_reader :http_body
+    attr_reader :json_body
+
+    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @json_body = json_body
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end

data/lib/octobat/exports_setting.rb

@@ -0,0 +1,19 @@
+module Octobat
+  class ExportsSetting < APIResource
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+
+    def self.default(params = {}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      api_key ||= @api_key
+      opts[:api_key] = api_key
+
+      instance = self.new(nil, opts)
+
+      response, api_key = Octobat.request(:get, url + '/default', api_key, params)
+      instance.refresh_from(response, api_key)
+      instance
+    end
+
+  end
+end

data/lib/octobat/invoice.rb

@@ -3,35 +3,84 @@ module Octobat
     extend Octobat::APIOperations::List
     include Octobat::APIOperations::Create
     include Octobat::APIOperations::Update
+    
+    
+    def self.pdf_export(params = {}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      api_key ||= @api_key
+      opts[:api_key] = api_key
 
-    def pay(payment_data)
-      response, api_key = Octobat.request(:patch, pay_url, @api_key, {payment: payment_data})
-      refresh_from(response, api_key)
+      instance = self.new(nil, opts)
+
+      response, api_key = Octobat.request(:post, url + '/pdf_export', api_key, params)
+      return true
     end
     
-    def send(enforce_errors = false)
-      response, api_key = Octobat.request(:post, send_url, @api_key, {enforce_errors: enforce_errors})
-      refresh_from(response, api_key)
+    def self.csv_export(params = {}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      api_key ||= @api_key
+      opts[:api_key] = api_key
+
+      instance = self.new(nil, opts)
+
+      response, api_key = Octobat.request(:post, url + '/csv_export', api_key, params)
+      return true
     end
     
-    
+
+    def send_by_email(email_data = {})
+      response, api_key = Octobat.request(:post, send_url, @api_key, email_data)
+      refresh_from(response, api_key)
+    end
+
     def confirm
       response, api_key = Octobat.request(:patch, confirm_url, @api_key)
       refresh_from(response, api_key)
     end
 
+    def cancel
+      response, api_key = Octobat.request(:patch, cancel_url, @api_key)
+      refresh_from(response, api_key)
+    end
+
+    def cancel_and_replace
+      response, api_key = Octobat.request(:patch, cancel_and_replace_url, @api_key)
+      refresh_from(response, api_key)
+    end
+
+    def delete
+      response, api_key = Octobat.request(:delete, url, @api_key)
+      refresh_from(response, api_key)
+    end
+
+    def items(params = {})
+      Item.list(params.merge({ :invoice => id }), @api_key)
+    end
+
+    def transactions(params = {})
+      Transaction.list(params.merge(invoice: id), @api_key)
+    end
+
+
     private
 
-      def pay_url
-        url + '/pay'
-      end
-    
       def send_url
         url + '/send'
       end
-      
+
       def confirm_url
         url + '/confirm'
       end
+
+      def cancel_url
+        url + '/cancel'
+      end
+
+      def cancel_and_replace_url
+        url + '/cancel_and_replace'
+      end
+
   end
+
+
 end

data/lib/octobat/invoice_numbering_sequence.rb

@@ -0,0 +1,18 @@
+module Octobat
+  class InvoiceNumberingSequence < APIResource
+    extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+
+    def set_to_default
+      response, api_key = Octobat.request(:patch, set_to_default_url, @api_key)
+      refresh_from(response, api_key)
+    end
+
+    private
+
+      def set_to_default_url
+        url + '/default'
+      end
+  end
+end

data/lib/octobat/item.rb

@@ -0,0 +1,64 @@
+module Octobat
+  class Item < APIResource
+    extend Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+    include Octobat::APIOperations::Delete
+    
+    
+    def url
+      !parent_obj.nil? ? parentize_url : super
+    end
+    
+    
+    def save_url
+      if self[:id] == nil && self.class.respond_to?(:create)
+        self.relative_save_url
+      else
+        url
+      end
+    end
+    
+    
+    def parentize_url
+      if parent_obj.include?(:transaction)
+        "#{Transaction.url}/#{CGI.escape(parent_obj[:transaction])}/items/#{CGI.escape(id)}"
+      elsif parent_obj.include?(:invoice)
+        "#{Invoice.url}/#{CGI.escape(parent_obj[:invoice])}/items/#{CGI.escape(id)}"
+      elsif parent_obj.include?(:credit_note)
+        "#{CreditNote.url}/#{CGI.escape(parent_obj[:credit_note])}/items/#{CGI.escape(id)}"
+      else
+        url
+      end
+    end
+    
+    
+    
+    def relative_save_url
+      if self[:transaction]
+        "#{Transaction.url}/#{CGI.escape(self[:transaction])}/items"
+      elsif self[:invoice]
+        "#{Invoice.url}/#{CGI.escape(self[:invoice])}/items"
+      elsif self[:credit_note]
+        "#{CreditNote.url}/#{CGI.escape(self[:credit_note])}/items"
+      end
+    end
+    
+
+    def self.url
+      if @parent_resource.include?(:transaction)
+        "#{Transaction.url}/#{CGI.escape(@parent_resource[:transaction])}/items"
+      elsif @parent_resource.include?(:invoice)
+        "#{Invoice.url}/#{CGI.escape(@parent_resource[:invoice])}/items"
+      elsif @parent_resource.include?(:credit_note)
+        "#{CreditNote.url}/#{CGI.escape(@parent_resource[:credit_note])}/items"
+      end
+    end
+
+    def self.set_parent_resource(filters)
+      @parent_resource = filters.select{|k, v| [:transaction, :invoice, :credit_note].include?(k)}
+    end
+    
+    
+  end
+end