moneybird 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec58b660402eefbeb290851cfff6c05e1c530450
-  data.tar.gz: c3181e0c093d371ec5514c05b1dcb942a7491b5d
+  metadata.gz: 780e8a422f459674c1fc1cb8bf87321ead351b25
+  data.tar.gz: 9c221b4dd29c65fef045d3cf0bb2bbc9bec28d8f
 SHA512:
-  metadata.gz: fa6dbfc0163ba772bde29b234a85b3b6d7a980dc2b2e633678900323edac711835cd49ed2897bb584a9819489e15ee406996d31390e28b23ab5605e56d91fa65
-  data.tar.gz: 9078757aeaa5c8d6d405015e253ba5b4713568ed65b7c3fe7649ab6b4d5c820538988e1dc5120b256efdb3ebe431199b5d323ee15680625d4069a36153ed31b6
+  metadata.gz: 4241fa82ab6679c464c1ab06eb9146ad30b2776ec0d145aad7026d8d8a318700fc24b1e0e0525f87ceca3b1cc6d8b1576f2feee0cad631473f509c97b4d83e23
+  data.tar.gz: 1c6ac8b29bd8c2835d564d8ffde48b127efa23de615bbfcfdb886cedb0452b171d22b266cf3aff0ab23f0eea16e6ab4b6563614e556af56008dcba361fd2bc1b

data/README.md

@@ -2,6 +2,8 @@
 
 Gem to talk to the Moneybird REST API. Right now you'll need to get a 'bearer' token for the client to work, oauth2 support may added later. This gem is still under construction and any methods may still change signature without notice until 1.0 is released.
 
+The library is modelled after http://developer.moneybird.com/ Any inconsistencies or errors in the documentation may also be present in the library.
+
 Feel free to file Pull Requests
 
 ## Installation
@@ -23,8 +25,29 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
+# Client uses bearer token (see: http://developer.moneybird.com/authentication/)
+Moneybird::Client.new('fe3f7f9e239e7d925f9caf695028e60fd3e5c2085f7aebb983cea731dea6b44f')
+
+# List administrations
+administrations = client.administrations
+
+administration = administrations.first
+
+# List invoices
+administration.sales_invoices.all
+
+# List contacts
+administration.contacts.all
+
+# Create contact
+administrations.contacts.create(company_name: 'ACME', firstname: 'Foo', lastname: 'Bar')
+
+# Update contact
+contact = administration.contacts.all.first
+contact.company_name = 'Something new'
+administrations.contacts.save(contact)
 
-Moneybird::Client.new('fe3f7f9e239e7d925f9caf695028e60fd3e5c2085f7aebb983cea731dea6b44f').administrations.first.sales_invoices.first
+# Works similarly with other resources
 
 ```
 

data/lib/moneybird.rb

@@ -8,39 +8,38 @@ module Moneybird
 end
 
 require "moneybird/traits/administration_service"
+require "moneybird/traits/find"
 require "moneybird/traits/find_all"
 require "moneybird/traits/service"
 require "moneybird/traits/save"
+require "moneybird/traits/delete"
+require "moneybird/client"
+require "moneybird/resource"
+require "moneybird/resource/invoice/details"
+require "moneybird/webhook"
 
-require "moneybird/service/administration"
-require "moneybird/service/contact"
-require "moneybird/service/document_style"
-require "moneybird/service/estimate"
-require "moneybird/service/financial_account"
-require "moneybird/service/financial_mutation"
-require "moneybird/service/identity"
-require "moneybird/service/product"
-require "moneybird/service/recurring_sales_invoice"
-require "moneybird/service/sales_invoice"
-require "moneybird/service/tax_rate"
-require "moneybird/service/webhook"
-require "moneybird/service/workflow"
+resources = %w(
+ administration
+ contact
+ document_style
+ estimate
+ financial_account
+ financial_mutation
+ identity
+ ledger_account
+ product
+ recurring_sales_invoice
+ sales_invoice
+ tax_rate
+ webhook
+ workflow
+)
+
+resources.each do |resource|
+  require "moneybird/service/#{resource}"
+  require "moneybird/resource/#{resource}"
+end
 
-require "moneybird/client"
 
-require "moneybird/resource"
-require "moneybird/resource/administration"
-require "moneybird/resource/contact"
-require "moneybird/resource/document_style"
-require "moneybird/resource/estimate"
-require "moneybird/resource/financial_account"
-require "moneybird/resource/financial_mutation"
-require "moneybird/resource/identity"
-require "moneybird/resource/product"
-require "moneybird/resource/recurring_sales_invoice"
-require "moneybird/resource/sales_invoice"
-require "moneybird/resource/tax_rate"
-require "moneybird/resource/webhook"
-require "moneybird/resource/workflow"
 
 require "moneybird/version"

data/lib/moneybird/resource/contact.rb

@@ -16,6 +16,7 @@ module Moneybird::Resource
       country
       email
       phone
+      send_method
       delivery_method
       customer_id
       tax_number

data/lib/moneybird/resource/estimate.rb

@@ -40,5 +40,13 @@ module Moneybird::Resource
       notes
       attachments
     )
+
+    def contact=(attributes)
+      @contact ||= Moneybird::Resource::Contact.build(attributes)
+    end
+
+    def details=(line_items)
+      @details ||= line_items.map{ |line_item| Moneybird::Resource::Invoice::Details.build(line_item) }
+    end
   end
 end

data/lib/moneybird/resource/invoice/details.rb

@@ -0,0 +1,25 @@
+module Moneybird::Resource::Invoice
+  class Details
+    include Moneybird::Resource
+    extend Moneybird::Resource::ClassMethods
+
+    has_attributes %i(
+      tax_rate_id
+      ledger_account_id
+      amount
+      price
+      description
+      row_order
+      total_price_excl_tax_with_discount
+      total_price_excl_tax_with_discount_base
+      tax_report_reference
+      id
+      created_at
+      updated_at
+    )
+
+    def contact=(attributes)
+      @contact = Moneybird::Resource::Contact.build(attributes)
+    end
+  end
+end

data/lib/moneybird/resource/ledger_account.rb

@@ -0,0 +1,16 @@
+module Moneybird::Resource
+  class LedgerAccount
+    include Moneybird::Resource
+    extend Moneybird::Resource::ClassMethods
+
+    has_attributes %i(
+      id
+      name
+      account_type
+      account_id
+      parent_id
+      created_at
+      updated_at
+    )
+  end
+end

data/lib/moneybird/resource/recurring_sales_invoice.rb

@@ -34,6 +34,14 @@ module Moneybird::Resource
       notes
       attachments
     )
+
+    def contact=(attributes)
+      @contact ||= Moneybird::Resource::Contact.build(attributes)
+    end
+
+    def details=(line_items)
+      @details ||= line_items.map{ |line_item| Moneybird::Resource::Invoice::Details.build(line_item) }
+    end
   end
 end
 

data/lib/moneybird/resource/sales_invoice.rb

@@ -38,6 +38,14 @@ module Moneybird::Resource
       url
       workflow_id
     )
+
+    def contact=(attributes)
+      @contact ||= Moneybird::Resource::Contact.build(attributes)
+    end
+
+    def details=(line_items)
+      @details ||= line_items.map{ |line_item| Moneybird::Resource::Invoice::Details.build(line_item) }
+    end
   end
 end
 

data/lib/moneybird/service/administration.rb

@@ -13,6 +13,10 @@ module Moneybird::Service
       Moneybird::Resource::Administration
     end
 
+    def find(id)
+      all.find{ |administration| administration.id.to_i == id }
+    end
+
     def path
       '/administrations'
     end

data/lib/moneybird/service/contact.rb

@@ -2,8 +2,10 @@ module Moneybird::Service
   class Contact
     include Moneybird::Traits::AdministrationService
     include Moneybird::Traits::Service
+    include Moneybird::Traits::Find
     include Moneybird::Traits::FindAll
     include Moneybird::Traits::Save
+    include Moneybird::Traits::Delete
 
     def resource_class
       Moneybird::Resource::Contact
@@ -12,5 +14,11 @@ module Moneybird::Service
     def path
       "#{administration_id}/contacts"
     end
+
+    def find_by_customer_id(customer_id)
+      result = client.get("#{path}/customer_id/#{customer_id}")
+
+      build(JSON.parse(result.body))
+    end
   end
 end

data/lib/moneybird/service/estimate.rb

@@ -2,8 +2,10 @@ module Moneybird::Service
   class Estimate
     include Moneybird::Traits::AdministrationService
     include Moneybird::Traits::Service
+    include Moneybird::Traits::Find
     include Moneybird::Traits::FindAll
     include Moneybird::Traits::Save
+    include Moneybird::Traits::Delete
 
     def resource_class
       Moneybird::Resource::Estimate

data/lib/moneybird/service/identity.rb

@@ -2,8 +2,10 @@ module Moneybird::Service
   class Identity
     include Moneybird::Traits::AdministrationService
     include Moneybird::Traits::Service
+    include Moneybird::Traits::Find
     include Moneybird::Traits::FindAll
     include Moneybird::Traits::Save
+    include Moneybird::Traits::Delete
 
     def resource_class
       Moneybird::Resource::Identity

data/lib/moneybird/service/ledger_account.rb

@@ -0,0 +1,18 @@
+module Moneybird::Service
+  class LedgerAccount
+    include Moneybird::Traits::AdministrationService
+    include Moneybird::Traits::Service
+    include Moneybird::Traits::Find
+    include Moneybird::Traits::FindAll
+    include Moneybird::Traits::Save
+    include Moneybird::Traits::Delete
+
+    def resource_class
+      Moneybird::Resource::LedgerAccount
+    end
+
+    def path
+      "#{administration_id}/ledger_accounts"
+    end
+  end
+end

data/lib/moneybird/service/product.rb

@@ -2,8 +2,10 @@ module Moneybird::Service
   class Product
     include Moneybird::Traits::AdministrationService
     include Moneybird::Traits::Service
+    include Moneybird::Traits::Find
     include Moneybird::Traits::FindAll
     include Moneybird::Traits::Save
+    include Moneybird::Traits::Delete
 
     def resource_class
       Moneybird::Resource::Product

data/lib/moneybird/service/recurring_sales_invoice.rb

@@ -2,8 +2,10 @@ module Moneybird::Service
   class RecurringSalesInvoice
     include Moneybird::Traits::AdministrationService
     include Moneybird::Traits::Service
+    include Moneybird::Traits::Find
     include Moneybird::Traits::FindAll
     include Moneybird::Traits::Save
+    include Moneybird::Traits::Delete
 
     def resource_class
       Moneybird::Resource::RecurringSalesInvoice

data/lib/moneybird/service/sales_invoice.rb

@@ -2,8 +2,10 @@ module Moneybird::Service
   class SalesInvoice
     include Moneybird::Traits::AdministrationService
     include Moneybird::Traits::Service
+    include Moneybird::Traits::Find
     include Moneybird::Traits::FindAll
     include Moneybird::Traits::Save
+    include Moneybird::Traits::Delete
 
     def resource_class
       Moneybird::Resource::SalesInvoice

data/lib/moneybird/service/webhook.rb

@@ -3,6 +3,7 @@ module Moneybird::Service
     include Moneybird::Traits::AdministrationService
     include Moneybird::Traits::Service
     include Moneybird::Traits::FindAll
+    include Moneybird::Traits::Delete
 
     def resource_class
       Moneybird::Resource::Webhook

data/lib/moneybird/traits/delete.rb

@@ -0,0 +1,16 @@
+module Moneybird
+  module Traits
+    module Delete
+      DELETE_SUCCESS_CODE = 200
+
+      def delete(resource)
+        client.delete(resource_path(resource))
+        if client._last_response.code.to_i != DELETE_SUCCESS_CODE
+          resource.errors = client._last_response.body
+          return false
+        end
+        true
+      end
+    end
+  end
+end

data/lib/moneybird/traits/find.rb

@@ -0,0 +1,11 @@
+module Moneybird
+  module Traits
+    module Find
+      def find(id)
+        result = client.get("#{path}/#{id}")
+
+        build(JSON.parse(result.body))
+      end
+    end
+  end
+end

data/lib/moneybird/version.rb

@@ -1,3 +1,3 @@
 module Moneybird
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/moneybird/webhook.rb

@@ -0,0 +1,27 @@
+module Moneybird
+  class Webhook
+    include Moneybird::Resource
+    extend Moneybird::Resource::ClassMethods
+
+    has_attributes %i(
+      administration_id
+      webhook_id
+      entity_type
+      entity_id
+      state
+      entity
+    )
+
+    def build_entity
+      entity_resource_class.new(entity)
+    end
+
+    def entity_resource_class
+      Object.const_get "Moneybird::Resource::#{entity_type}"
+    end
+
+    def self.from_json(payload)
+      build(JSON.parse(payload))
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moneybird
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Maarten van Vliet
@@ -66,6 +66,8 @@ files:
 - lib/moneybird/resource/financial_account.rb
 - lib/moneybird/resource/financial_mutation.rb
 - lib/moneybird/resource/identity.rb
+- lib/moneybird/resource/invoice/details.rb
+- lib/moneybird/resource/ledger_account.rb
 - lib/moneybird/resource/product.rb
 - lib/moneybird/resource/recurring_sales_invoice.rb
 - lib/moneybird/resource/sales_invoice.rb
@@ -79,6 +81,7 @@ files:
 - lib/moneybird/service/financial_account.rb
 - lib/moneybird/service/financial_mutation.rb
 - lib/moneybird/service/identity.rb
+- lib/moneybird/service/ledger_account.rb
 - lib/moneybird/service/product.rb
 - lib/moneybird/service/recurring_sales_invoice.rb
 - lib/moneybird/service/sales_invoice.rb
@@ -86,10 +89,13 @@ files:
 - lib/moneybird/service/webhook.rb
 - lib/moneybird/service/workflow.rb
 - lib/moneybird/traits/administration_service.rb
+- lib/moneybird/traits/delete.rb
+- lib/moneybird/traits/find.rb
 - lib/moneybird/traits/find_all.rb
 - lib/moneybird/traits/save.rb
 - lib/moneybird/traits/service.rb
 - lib/moneybird/version.rb
+- lib/moneybird/webhook.rb
 - moneybird.gemspec
 homepage: https://github.com/maartenvanvliet/moneybird
 licenses: