billomat 0.1.4 → 0.3.0

data/lib/billomat/models/base.rb

@@ -4,50 +4,49 @@ require 'ostruct'
 
 module Billomat
   module Models
-    ##
     # This class is the base for all other models (resources).
     # It handles the communication with the gateway to talk to the API.
     class Base
       attr_accessor :data
 
-      ##
-      # Tries to find the resource for the given id
+      # Tries to find the resource for the given id.
       #
-      # @param [String] id The resource id
-      # @return [Billomat::Models::Base, nil] The found resource or nil
+      # @param id [String] the resource id
+      # @return [Billomat::Models::Base, nil] the found resource or nil
       def self.find(id)
         return nil if id.nil?
+
         resp = Billomat::Gateway.new(:get, "#{base_path}/#{id}").run
         new(resp[resource_name])
       end
 
-      ##
-      # Allows to query for a record
+      # Allows to query for a record.
       #
-      # @param [Hash] hash The query parameters
-      # @return [Array<Billomat::Models::Base>] The found records
+      # @param hash [Hash] the query parameters
+      # @return [Array<Billomat::Models::Base>] the found records
       def self.where(hash = {})
         Billomat::Search.new(self, hash).run
       end
 
       ##
-      # Initializes a new model
+      # Initializes a new model.
       #
-      # @param [Hash] data The attributes of the object
-      # @return [Billomat::Models::Base] The record as an object
+      # @param data [Hash] the attributes of the object
+      # @return [Billomat::Models::Base] the record as an object
       def initialize(data = {})
         @data = OpenStruct.new(data)
       end
 
-      ##
       # Persists the current object in the API.
       # When record is new it calls create, otherwise it saves the object.
       #
       # @return [TrueClass]
       def save
         return create if id.nil?
+
         update
       end
+      alias save! save
 
       # @return [TrueClass]
       def create
@@ -59,6 +58,7 @@ module Billomat
 
         true
       end
+      alias create! create
 
       # @return [TrueClass]
       def update
@@ -68,6 +68,7 @@ module Billomat
 
         true
       end
+      alias update! update
 
       # @return [TrueClass]
       def delete
@@ -76,52 +77,50 @@ module Billomat
 
         true
       end
+      alias delete! delete
 
-      # @return [String, nil] The object's ID
+      # @return [String, nil] the object's ID
       def id
         @data['id'] || nil
       end
 
-      ##
-      # Wraps the data so the API accepts the request
+      # Wraps the data so the API accepts the request.
       #
       # @example
       #   some_invoice.wrapped_data
       #   #=> { "invoice" => { "id" => "12345"  } }
       #
-      # @return [Hash] The wrapped data
+      # @return [Hash] the wrapped data
       def wrapped_data
         { self.class.resource_name => @data.to_h }
       end
 
-      ##
-      # Returns the object with the right JSON structure
+      # Returns the object with the right JSON structure.
       #
-      # @return [Hash] The objects data
-      def as_json(options = nil)
+      # @return [Hash] the objects data
+      def as_json(_options = nil)
         @data.to_h
       end
 
-      ##
-      # All values in the @data hash can be accessed like a 'normal' method
+      # All values in the @data hash can be accessed like a 'normal' method.
       #
       # @example
       #   invoice = Billomat::Models::Invoice.new(invoice_number: '123')
       #   invoice.invoice_number
       #   #=> '123'
       def method_missing(method, *args, &block)
-        return @data[method] if @data.to_h.keys.include?(method)
+        return @data[method] if @data.to_h.key?(method)
+
         super
       end
 
-      ##
-      # Necessary for method_missing
+      # Necessary for method_missing.
       #
       # @param [Symbol] method The method name
       # @param [TrueClass, FalseClass] include_privat
       # @return [TrueClass, FalseClass]
       def respond_to_missing?(method, include_privat = false)
-        @data.to_h.keys.include?(method.to_s) || super
+        @data.to_h.key?(method.to_s) || super
       end
     end
   end

data/lib/billomat/models/client.rb

@@ -2,15 +2,14 @@
 
 module Billomat
   module Models
-    ##
-    # Representation of the client resource
+    # Representation of the client resource.
     class Client < Base
-      # @return [String] The resource's base path
+      # @return [String] the resource's base path
       def self.base_path
         '/clients'
       end
 
-      # @return [String] The resource's name
+      # @return [String] the resource's name
       def self.resource_name
         'client'
       end

data/lib/billomat/models/contact.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Billomat
+  module Models
+    # Representation of the client resource.
+    class Contact < Base
+      # @return [String] the resource's base path
+      def self.base_path
+        '/contacts'
+      end
+
+      # @return [String] the resource's name
+      def self.resource_name
+        'contact'
+      end
+    end
+  end
+end

data/lib/billomat/models/credit_note.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Billomat
+  module Models
+    # Representation of the credit note resource
+    class CreditNote < Base
+      # @return [String] the resource's base path
+      def self.base_path
+        '/credit-notes'
+      end
+
+      # @return [String] the resource's name
+      def self.resource_name
+        'credit-note'
+      end
+    end
+  end
+end

data/lib/billomat/models/credit_note_item.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Billomat
+  module Models
+    # Representation of the credit note item resource
+    class CreditNoteItem < Base
+      # @return [String] the resource's base path
+      def self.base_path
+        '/credit-note-items'
+      end
+
+      # @return [String] the resource's name
+      def self.resource_name
+        'credit-note-item'
+      end
+    end
+  end
+end

data/lib/billomat/models/invoice.rb

@@ -2,33 +2,29 @@
 
 module Billomat
   module Models
-    ##
     # Representation of the invoice resource
     class Invoice < Base
-      # @return [String] The resource's base path
+      # @return [String] the resource's base path
       def self.base_path
         '/invoices'
       end
 
-      # @return [String] The resource's name
+      # @return [String] the resource's name
       def self.resource_name
         'invoice'
       end
 
-      ##
-      # Completes the invoice by calling the Complete action
+      # Completes the invoice by calling the Complete action.
       def complete!
         Billomat::Actions::Complete.new(id).call
       end
 
-      ##
-      # Cancels the invoice by calling the Cancel action
+      # Cancels the invoice by calling the Cancel action.
       def cancel!
         Billomat::Actions::Cancel.new(id).call
       end
 
-      ##
-      # Sends the invoice as an email to the given recipient
+      # Sends the invoice as an email to the given recipient.
       #
       # @param [String] recipient The email address of the recipient
       def send_email(recipient)
@@ -37,8 +33,7 @@ module Billomat
         Billomat::Actions::Email.new(id, email_params).call
       end
 
-      ##
-      # Allows to download the invoice as an PDF
+      # Allows to download the invoice as an PDF.
       def to_pdf
         Billomat::Actions::Pdf.new(id).call
       end

data/lib/billomat/models/invoice_item.rb

@@ -3,14 +3,14 @@
 module Billomat
   module Models
     ##
-    # Representation of the invoice item resource
+    # Representation of the invoice item resource.
     class InvoiceItem < Base
-      # @return [String] The resource's base path
+      # @return [String] the resource's base path
       def self.base_path
         '/invoice-items'
       end
 
-      # @return [String] The resource's name
+      # @return [String] the resource's name
       def self.resource_name
         'invoice-item'
       end

data/lib/billomat/models/invoice_payment.rb

@@ -2,15 +2,14 @@
 
 module Billomat
   module Models
-    ##
-    # Representation of the invoice payment resource
+    # Representation of the invoice payment resource.
     class InvoicePayment < Base
-      # @return [String] The resource's base path
+      # @return [String] the resource's base path
       def self.base_path
         '/invoice-payments'
       end
 
-      # @return [String] The resource's name
+      # @return [String] the resource's name
       def self.resource_name
         'invoice-payment'
       end

data/lib/billomat/models/tag.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Billomat
+  module Models
+    # Representation of the tag resource.
+    class Tag < Base
+      # @return [String] the resource's base path
+      def self.base_path
+        '/tags'
+      end
+
+      # @return [String] the resource's name
+      def self.resource_name
+        'tag'
+      end
+    end
+  end
+end

data/lib/billomat/models/template.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Billomat
+  module Models
+    # Representation of the template resource.
+    class Template < Base
+      # @return [String] the resource's base path
+      def self.base_path
+        '/templates'
+      end
+
+      # @return [String] the resource's name
+      def self.resource_name
+        'template'
+      end
+    end
+  end
+end

data/lib/billomat/models.rb

@@ -2,12 +2,16 @@
 
 require 'billomat/models/base'
 require 'billomat/models/client'
+require 'billomat/models/credit_note'
+require 'billomat/models/credit_note_item'
 require 'billomat/models/invoice'
 require 'billomat/models/invoice_item'
 require 'billomat/models/invoice_payment'
+require 'billomat/models/contact'
+require 'billomat/models/tag'
+require 'billomat/models/template'
 
 module Billomat
-  ##
-  # Models represent a resource in the API, e.g. invoices, clients
+  # Models represent a resource in the API, e.g. invoices, clients.
   module Models; end
 end

data/lib/billomat/search.rb

@@ -3,11 +3,9 @@
 require 'uri'
 
 module Billomat
-  ##
-  # This class provides the possibility to query the resources
+  # This class provides the possibility to query the resources.
   class Search
-    ##
-    # Creates a new search object
+    # Creates a new search object.
     #
     # @param [Class] resource The resource class to be queried
     # @param [Hash] hash The query
@@ -16,23 +14,22 @@ module Billomat
       @hash     = hash
     end
 
-    # @return [String] The path including the query
+    # @return [String] the path including the query
     def path
       "#{@resource.base_path}?#{hash_to_query}"
     end
 
-    ##
-    # Runs the query and calls the gateway
-    # Currently it will always return an empty array when no query is provided
+    # Runs the query and calls the gateway.
+    # Currently it will always return an empty array when no query is provided.
     #
     # @return [Array<Billomat::Model::Base>]
     def run
-      return [] if @hash.reject { |k, v| v.nil? }.empty?
+      return [] if @hash.reject { |_k, v| v.nil? }.empty?
+
       to_array(Billomat::Gateway.new(:get, path).run)
     end
 
-    ##
-    # Corrects the response to always return an array
+    # Corrects the response to always return an array.
     #
     # @todo Due to a strange API behaviour we have to fix the reponse here.
     #   This may be fixed in a new API version.
@@ -53,21 +50,22 @@ module Billomat
       end
     end
 
-    # @return [String] The name of the resource
+    # @return [String] the name of the resource
     def name
       @resource.resource_name
     end
 
     # @param [Hash] resp The response from the gateway
-    # @return [Integer] The number of records found
+    # @return [Integer] the number of records found
     def count(resp)
       return 0 if resp.nil?
+
       resp["#{name}s"]['@total'].to_i
     end
 
     private
 
-    # @return [String] The query as www encoded string
+    # @return [String] the query as www encoded string
     def hash_to_query
       URI.encode_www_form(@hash)
     end

data/lib/billomat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Billomat
-  VERSION = "0.1.4"
+  VERSION = '0.3.0'
 end

data/lib/billomat.rb

@@ -7,28 +7,25 @@ require 'billomat/actions'
 require 'billomat/search'
 require 'billomat/gateway'
 
-##
-# An wrapper for the
-# <a href="https://billomat.com">Billomat</a>
-# API
+# An wrapper for the Billomat API.
 module Billomat
   class << self
     attr_writer :configuration
-  end
 
-  # @return [Billomat::Configuration] The global billomat configuration
-  def self.configuration
-    @configuration ||= Billomat::Configuration.new
-  end
+    # @return [Billomat::Configuration] the global billomat configuration
+    def configuration
+      @configuration ||= Billomat::Configuration.new
+    end
 
-  # Class method to set and change the global configuration
-  #
-  # @example
-  #   Billomat.configure do |config|
-  #     config.subdomain = 'your-business-name'
-  #     config.api_key = 'a3b148a61cb642389b4f9953f6233f20'
-  #   end
-  def self.configure
-    yield(configuration)
+    # Class method to set and change the global configuration.
+    #
+    # @example
+    #   Billomat.configure do |config|
+    #     config.subdomain = 'your-business-name'
+    #     config.api_key = 'a3b148a61cb642389b4f9953f6233f20'
+    #   end
+    def configure
+      yield(configuration)
+    end
   end
 end