freeagentrb 0.1.0

data/lib/free_agent/resources/bills.rb

@@ -0,0 +1,42 @@
+module FreeAgent
+  class BillsResource < Resource
+
+    def list(**params)
+      response = get_request("bills", params: params)
+      Collection.from_response(response, type: Bill, key: "bills")
+    end
+
+    def list_for_contact(contact:, **params)
+      response = get_request("bills?contact=#{contact}", params: params)
+      Collection.from_response(response, type: Bill, key: "bills")
+    end
+
+    def list_for_project(project:, **params)
+      response = get_request("bills?project=#{project}", params: params)
+      Collection.from_response(response, type: Bill, key: "bills")
+    end
+
+    def retrieve(id:)
+      response = get_request("bills/#{id}")
+      Bill.new(response.body["bill"])
+    end
+
+    def create(contact:, dated_on:, due_on:, reference:, bill_items:, **params)
+      attributes = {contact: contact, dated_on: dated_on, due_on: due_on, reference: reference, bill_items: bill_items}
+
+      response = post_request("bills", body: {bill: attributes.merge(params)})
+      Bill.new(response.body["bill"]) if response.success?
+    end
+
+    def update(id:, **params)
+      response = put_request("bills/#{id}", body: {bill: params})
+      Bill.new(response.body["bill"]) if response.success?
+    end
+
+    def delete(id:)
+      response = delete_request("bills/#{id}")
+      response.success?
+    end
+
+  end
+end

data/lib/free_agent/resources/company.rb

@@ -0,0 +1,10 @@
+module FreeAgent
+  class CompanyResource < Resource
+
+    def retrieve
+      response = get_request("company")
+      Company.new(response.body["company"])
+    end
+
+  end
+end

data/lib/free_agent/resources/contacts.rb

@@ -0,0 +1,32 @@
+module FreeAgent
+  class ContactsResource < Resource
+
+    def list(**params)
+      response = get_request("contacts", params: params)
+      Collection.from_response(response, type: Contact, key: "contacts")
+    end
+
+    def retrieve(id:)
+      response = get_request("contacts/#{id}")
+      Contact.new(response.body["contact"])
+    end
+
+    def create(**params)
+      raise "first_name and last_name or organisation_name is required" unless !params[:first_name].nil? || !params[:organisation_name].nil?
+
+      response = post_request("contacts", body: params)
+      Contact.new(response.body["contact"]) if response.success?
+    end
+
+    def update(id:, **params)
+      response = put_request("contacts/#{id}", body: params)
+      Contact.new(response.body["contact"]) if response.success?
+    end
+
+    def delete(id:)
+      response = delete_request("contacts/#{id}")
+      response.success?
+    end
+
+  end
+end

data/lib/free_agent/resources/credit_notes.rb

@@ -0,0 +1,74 @@
+module FreeAgent
+  class CreditNotesResource < Resource
+
+    def list(**params)
+      response = get_request("credit_notes", params: params)
+      Collection.from_response(response, type: CreditNote, key: "credit_notes")
+    end
+
+    def list_for_contact(contact:, **params)
+      response = get_request("credit_notes?contact=#{contact}", params: params)
+      Collection.from_response(response, type: CreditNote, key: "credit_notes")
+    end
+
+    def list_for_project(project:, **params)
+      response = get_request("credit_notes?project=#{project}", params: params)
+      Collection.from_response(response, type: CreditNote, key: "credit_notes")
+    end
+
+    def retrieve(id:)
+      response = get_request("credit_notes/#{id}")
+      CreditNote.new(response.body["credit_note"])
+    end
+
+    # Returns a Base64-encoded PDF
+    def retrieve_pdf(id:)
+      response = get_request("credit_notes/#{id}/pdf")
+      response.body["pdf"]["content"] if response.success?
+    end
+
+    def create(contact:, dated_on:, payment_terms_in_days: 0, **params)
+      attributes = {contact: contact, dated_on: dated_on, payment_terms_in_days: payment_terms_in_days}
+
+      response = post_request("credit_notes", body: {credit_note: attributes.merge(params)})
+      CreditNote.new(response.body["credit_note"]) if response.success?
+    end
+
+    # def duplicate(id:)
+    #   response = post_request("invoices/#{id}/duplicate", body: {})
+    #   Invoice.new(response.body["invoice"]) if response.success?
+    # end
+
+    def update(id:, **params)
+      response = put_request("credit_notes/#{id}", body: {credit_note: params})
+      CreditNote.new(response.body["credit_note"]) if response.success?
+    end
+
+    def delete(id:)
+      response = delete_request("credit_notes/#{id}")
+      response.success?
+    end
+
+    def email(id:, to:, **params)
+      attributes = {to: to}
+      response = post_request("credit_notes/#{id}/send_email", body: {credit_note: {email: attributes.merge(params)}})
+      response.success?
+    end
+
+    def mark_as_sent(id:)
+      response = put_request("credit_notes/#{id}/transitions/mark_as_sent", body: {})
+      response.success?
+    end
+
+    def mark_as_draft(id:)
+      response = put_request("credit_notes/#{id}/transitions/mark_as_draft", body: {})
+      response.success?
+    end
+
+    def mark_as_cancelled(id:)
+      response = put_request("credit_notes/#{id}/transitions/mark_as_cancelled", body: {})
+      response.success?
+    end
+
+  end
+end

data/lib/free_agent/resources/estimate_items.rb

@@ -0,0 +1,22 @@
+module FreeAgent
+  class EstimateItemsResource < Resource
+
+    def create(estimate:, **params)
+      attributes = {estimate: estimate}
+
+      response = post_request("estimate_items", body: attributes.merge(params))
+      EstimateItem.new(response.body["estimate_item"]) if response.success?
+    end
+
+    def update(id:, **params)
+      response = put_request("estimate_items/#{id}", body: params)
+      EstimateItem.new(response.body["estimate_item"]) if response.success?
+    end
+
+    def delete(id:)
+      response = delete_request("estimate_items/#{id}")
+      response.success?
+    end
+
+  end
+end

data/lib/free_agent/resources/estimates.rb

@@ -0,0 +1,79 @@
+module FreeAgent
+  class EstimatesResource < Resource
+
+    def list(**params)
+      response = get_request("estimates", params: params)
+      Collection.from_response(response, type: Estimate, key: "estimates")
+    end
+
+    def list_for_contact(contact:, **params)
+      response = get_request("estimates?contact=#{contact}", params: params)
+      Collection.from_response(response, type: Estimate, key: "estimates")
+    end
+
+    def list_for_project(project:, **params)
+      response = get_request("estimates?project=#{project}", params: params)
+      Collection.from_response(response, type: Estimate, key: "estimates")
+    end
+
+    def list_for_invoice(invoice:, **params)
+      response = get_request("estimates?invoice=#{invoice}", params: params)
+      Collection.from_response(response, type: Estimate, key: "estimates")
+    end
+
+    def retrieve(id:)
+      response = get_request("estimates/#{id}")
+      Estimate.new(response.body["estimate"])
+    end
+
+    # Returns a Base64-encoded PDF
+    def retrieve_pdf(id:)
+      response = get_request("estimates/#{id}/pdf")
+      response.body["pdf"]["content"] if response.success?
+    end
+
+    def create(contact:, dated_on:, currency:, reference:, status: "Draft", estimate_type: "Estimate", **params)
+      attributes = {contact: contact, dated_on: dated_on, status: status, estimate_type: estimate_type, currency: currency, reference: reference}
+
+      response = post_request("estimates", body: {estimate: attributes.merge(params)})
+      Estimate.new(response.body["estimate"]) if response.success?
+    end
+
+    def update(id:, **params)
+      response = put_request("estimates/#{id}", body: params)
+      Estimate.new(response.body["estimate"]) if response.success?
+    end
+
+    def delete(id:)
+      response = delete_request("estimates/#{id}")
+      response.success?
+    end
+
+    def email(id:, to:, **params)
+      attributes = {to: to}
+      response = post_request("estimates/#{id}/send_email", body: {estimate: {email: attributes.merge(params)}})
+      response.success?
+    end
+
+    def mark_as_sent(id:)
+      response = put_request("estimaates/#{id}/transitions/mark_as_sent", body: {})
+      response.success?
+    end
+
+    def mark_as_draft(id:)
+      response = put_request("estimaates/#{id}/transitions/mark_as_draft", body: {})
+      response.success?
+    end
+
+    def mark_as_approved(id:)
+      response = put_request("estimates/#{id}/transitions/mark_as_approved", body: {})
+      response.success?
+    end
+
+    def mark_as_rejected(id:)
+      response = put_request("estimates/#{id}/transitions/mark_as_rejected", body: {})
+      response.success?
+    end
+
+  end
+end

data/lib/free_agent/resources/invoices.rb

@@ -0,0 +1,89 @@
+module FreeAgent
+  class InvoicesResource < Resource
+
+    def list(**params)
+      response = get_request("invoices", params: params)
+      Collection.from_response(response, type: Invoice, key: "invoices")
+    end
+
+    def list_for_contact(contact:, **params)
+      response = get_request("invoices?contact=#{contact}", params: params)
+      Collection.from_response(response, type: Invoice, key: "invoices")
+    end
+
+    def list_for_project(project:, **params)
+      response = get_request("invoices?project=#{project}", params: params)
+      Collection.from_response(response, type: Invoice, key: "invoices")
+    end
+
+    def retrieve(id:)
+      response = get_request("invoices/#{id}")
+      Invoice.new(response.body["invoice"])
+    end
+
+    # Returns a Base64-encoded PDF
+    def retrieve_pdf(id:)
+      response = get_request("invoices/#{id}/pdf")
+      response.body["pdf"]["content"] if response.success?
+    end
+
+    def create(contact:, dated_on:, payment_terms_in_days: 0, **params)
+      attributes = {contact: contact, dated_on: dated_on, payment_terms_in_days: payment_terms_in_days}
+
+      response = post_request("invoices", body: {invoice: attributes.merge(params)})
+      Invoice.new(response.body["invoice"]) if response.success?
+    end
+
+    def duplicate(id:)
+      response = post_request("invoices/#{id}/duplicate", body: {})
+      Invoice.new(response.body["invoice"]) if response.success?
+    end
+
+    def update(id:, **params)
+      response = put_request("invoices/#{id}", body: {invoice: params})
+      Invoice.new(response.body["invoice"]) if response.success?
+    end
+
+    def delete(id:)
+      response = delete_request("invoices/#{id}")
+      response.success?
+    end
+
+    def email(id:, to:, **params)
+      attributes = {to: to}
+      response = post_request("invoices/#{id}/send_email", body: {invoice: {email: attributes.merge(params)}})
+      response.success?
+    end
+
+    def mark_as_sent(id:)
+      response = put_request("invoices/#{id}/transitions/mark_as_sent", body: {})
+      response.success?
+    end
+
+    def mark_as_scheduled(id:)
+      response = put_request("invoices/#{id}/transitions/mark_as_scheduled", body: {})
+      response.success?
+    end
+
+    def mark_as_draft(id:)
+      response = put_request("invoices/#{id}/transitions/mark_as_draft", body: {})
+      response.success?
+    end
+
+    def mark_as_cancelled(id:)
+      response = put_request("invoices/#{id}/transitions/mark_as_cancelled", body: {})
+      response.success?
+    end
+
+    def convert_to_credit_note(id:)
+      response = put_request("invoices/#{id}/transitions/convert_to_credit_note", body: {})
+      response.success?
+    end
+
+    def direct_debit(id:)
+      response = post_request("invoices/#{id}/direct_debit", body: {})
+      response.success?
+    end
+
+  end
+end

data/lib/free_agent/resources/projects.rb

@@ -0,0 +1,37 @@
+module FreeAgent
+  class ProjectsResource < Resource
+
+    def list(**params)
+      response = get_request("projects", params: params)
+      Collection.from_response(response, type: Project, key: "projects")
+    end
+
+    def list_for_contact(contact:, **params)
+      response = get_request("projects?contact=#{contact}", params: params)
+      Collection.from_response(response, type: Project, key: "projects")
+    end
+
+    def retrieve(id:)
+      response = get_request("projects/#{id}")
+      Project.new(response.body["project"])
+    end
+
+    def create(contact:, name:, status:, currency:, budget_units:, **params)
+      attributes = {contact: contact, name: name, status: status, currency: currency, budget_units: budget_units}
+
+      response = post_request("projects", body: attributes.merge(params))
+      Project.new(response.body["project"]) if response.success?
+    end
+
+    def update(id:, **params)
+      response = put_request("projects/#{id}", body: params)
+      Project.new(response.body["project"]) if response.success?
+    end
+
+    def delete(id:)
+      response = delete_request("projects/#{id}")
+      response.success?
+    end
+
+  end
+end

data/lib/free_agent/resources/tasks.rb

@@ -0,0 +1,37 @@
+module FreeAgent
+  class TasksResource < Resource
+
+    def list(**params)
+      response = get_request("tasks", params: params)
+      Collection.from_response(response, type: Task, key: "tasks")
+    end
+
+    def list_for_project(project:, **params)
+      response = get_request("tasks?project=#{project}", params: params)
+      Collection.from_response(response, type: Task, key: "tasks")
+    end
+
+    def retrieve(id:)
+      response = get_request("tasks/#{id}")
+      Task.new(response.body["task"])
+    end
+
+    def create(project:, name:,  **params)
+      attributes = {project: project, name: name}
+
+      response = post_request("tasks", body: attributes.merge(params))
+      Task.new(response.body["task"]) if response.success?
+    end
+
+    def update(id:, **params)
+      response = put_request("tasks/#{id}", body: params)
+      Task.new(response.body["task"]) if response.success?
+    end
+
+    def delete(id:)
+      response = delete_request("tasks/#{id}")
+      response.success?
+    end
+
+  end
+end

data/lib/free_agent/resources/timeslips.rb

@@ -0,0 +1,47 @@
+module FreeAgent
+  class TimeslipsResource < Resource
+
+    def list(**params)
+      response = get_request("timeslips", params: params)
+      Collection.from_response(response, type: Timeslip, key: "timeslips")
+    end
+
+    def list_for_user(user:, **params)
+      response = get_request("timeslips?user=#{user}", params: params)
+      Collection.from_response(response, type: Timeslip, key: "timeslips")
+    end
+
+    def list_for_task(task:, **params)
+      response = get_request("timeslips?task=#{task}", params: params)
+      Collection.from_response(response, type: Timeslip, key: "timeslips")
+    end
+
+    def list_for_project(project:, **params)
+      response = get_request("timeslips?project=#{project}", params: params)
+      Collection.from_response(response, type: Timeslip, key: "timeslips")
+    end
+
+    def retrieve(id:)
+      response = get_request("timeslips/#{id}")
+      Timeslip.new(response.body["timeslip"])
+    end
+
+    def create(task:, user:, project:, dated_on:, hours:,  **params)
+      attributes = {task: task, user: user, project: project, dated_on: dated_on, hours: hours}
+
+      response = post_request("timeslips", body: attributes.merge(params))
+      Timeslip.new(response.body["timeslip"]) if response.success?
+    end
+
+    def update(id:, **params)
+      response = put_request("timeslips/#{id}", body: params)
+      Timeslip.new(response.body["timeslip"]) if response.success?
+    end
+
+    def delete(id:)
+      response = delete_request("timeslips/#{id}")
+      response.success?
+    end
+
+  end
+end

data/lib/free_agent/resources/users.rb

@@ -0,0 +1,42 @@
+module FreeAgent
+  class UsersResource < Resource
+
+    def me
+      response = get_request("users/me")
+      User.new(response.body["user"])
+    end
+
+    def list(**params)
+      response = get_request("users", params: params)
+      Collection.from_response(response, type: User, key: "users")
+    end
+
+    def retrieve(id:)
+      response = get_request("users/#{id}")
+      User.new(response.body["user"])
+    end
+
+    def create(email:, first_name:, last_name:, role:, opening_mileage: 0,  **params)
+      attributes = {email: email, first_name: first_name, last_name: last_name, role: role, opening_mileage: opening_mileage}
+
+      response = post_request("users", body: attributes.merge(params))
+      User.new(response.body["user"]) if response.success?
+    end
+
+    def update(id:, **params)
+      response = put_request("users/#{id}", body: params)
+      User.new(response.body["user"]) if response.success?
+    end
+
+    def update_me(**params)
+      response = put_request("users/me", body: {user: params})
+      User.new(response.body["user"]) if response.success?
+    end
+
+    def delete(id:)
+      response = delete_request("users/#{id}")
+      response.success?
+    end
+
+  end
+end

data/lib/free_agent/version.rb

@@ -0,0 +1,3 @@
+module FreeAgent
+  VERSION = "0.1.0"
+end

data/lib/free_agent.rb

@@ -0,0 +1,48 @@
+require "faraday"
+require "faraday_middleware"
+require "faraday/multipart"
+require "json"
+
+require_relative "free_agent/version"
+
+module FreeAgent
+
+  autoload :Client, "free_agent/client"
+  autoload :Collection, "free_agent/collection"
+  autoload :Error, "free_agent/error"
+  autoload :Resource, "free_agent/resource"
+  autoload :Object, "free_agent/object"
+
+  autoload :CompanyResource, "free_agent/resources/company"
+  autoload :ContactsResource, "free_agent/resources/contacts"
+  autoload :BankAccountsResource, "free_agent/resources/bank_accounts"
+  autoload :BankTransactionsResource, "free_agent/resources/bank_transactions"
+  autoload :BankTransactionExplanationsResource, "free_agent/resources/bank_transaction_explanations"
+  autoload :ProjectsResource, "free_agent/resources/projects"
+  autoload :TasksResource, "free_agent/resources/tasks"
+  autoload :TimeslipsResource, "free_agent/resources/timeslips"
+  autoload :UsersResource, "free_agent/resources/users"
+  autoload :AttachmentsResource, "free_agent/resources/attachments"
+  autoload :InvoicesResource, "free_agent/resources/invoices"
+  autoload :EstimatesResource, "free_agent/resources/estimates"
+  autoload :EstimateItemsResource, "free_agent/resources/estimate_items"
+  autoload :CreditNotesResource, "free_agent/resources/credit_notes"
+  autoload :BillsResource, "free_agent/resources/bills"
+
+  autoload :Company, "free_agent/objects/company"
+  autoload :Contact, "free_agent/objects/contact"
+  autoload :BankAccount, "free_agent/objects/bank_account"
+  autoload :BankTransaction, "free_agent/objects/bank_transaction"
+  autoload :BankTransactionExplanation, "free_agent/objects/bank_transaction_explanation"
+  autoload :Project, "free_agent/objects/project"
+  autoload :Task, "free_agent/objects/task"
+  autoload :Timeslip, "free_agent/objects/timeslip"
+  autoload :User, "free_agent/objects/user"
+  autoload :Attachment, "free_agent/objects/attachment"
+  autoload :Invoice, "free_agent/objects/invoice"
+  autoload :Estimate, "free_agent/objects/estimate"
+  autoload :EstimateItem, "free_agent/objects/estimate_item"
+  autoload :CreditNote, "free_agent/objects/credit_note"
+  autoload :Bill, "free_agent/objects/bill"
+
+end

data/lib/freeagentrb.rb

@@ -0,0 +1 @@
+require "free_agent"