freeagentrb 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b570455fe0bf3cdc90330ad013a8f878f3c48405116d2033932ebc2db86bbb0f
-  data.tar.gz: ca6b9f1bc67606328cddabfb1261beb77ec482c054214f58f0635041119c164e
+  metadata.gz: f8595ccfc827174d460c8aa3fe331018a409fc931f03cbc52d030a272af2b784
+  data.tar.gz: b5b2faca0fcad6bdd9975f5087ecae66fb5e5317b396b7920267ddbc0b6280d1
 SHA512:
-  metadata.gz: 8d6349663051511f41b43b2312e01529549a13c5a36bbee06855ce3e1f10abe6c9eaff4002e847f1e3b706d9164bc7ba85278e23f82ac0d7ece82d4c81d858b6
-  data.tar.gz: b03dd9e7852da63914f12ad3a6b0e93ebd22d2dff80f865b8810739ecc4cb6df2900cb4e8a0ae7e6563f9ac7a2c93fc7c140e6ae2622f4eee5db867492a0521f
+  metadata.gz: 43b7f6005955e663027d132d64e372a5757f90b66130f07c89766b55a47faea4d6932e2d2ce63d558049974aecefd221a11adf3763a46dd4e50769b93d848b10
+  data.tar.gz: cb5c620d30116b17f889ceeef7bafb84c09a0689a0b837711f88859245ddd49f9174fe3182ec6f8b2e2a8e1593df0caf4955217a5777bbbfcfc6aaa1f1327de3

data/.rubocop.yml

@@ -0,0 +1,11 @@
+# Omakase Ruby styling for Rails
+inherit_gem: { rubocop-rails-omakase: rubocop.yml }
+
+# Overwrite or add rules to create your own house style
+#
+# # Use `[a, [b, c]]` not `[ a, [ b, c ] ]`
+# Layout/SpaceInsideArrayLiteralBrackets:
+#   Enabled: false
+
+Rails/RefuteMethods:
+  Enabled: false

data/Gemfile

@@ -6,4 +6,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
-gem "dotenv"
+gem "dotenv"
+gem "minitest", "~> 5.0"
+gem "vcr"
+gem "rubocop-rails-omakase", require: false

data/Gemfile.lock

@@ -1,43 +1,98 @@
 PATH
   remote: .
   specs:
-    freeagentrb (0.1.0)
-      faraday (~> 1.7)
+    freeagentrb (0.1.1)
+      faraday (~> 2.11)
       faraday-multipart (~> 1.0)
-      faraday_middleware (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    dotenv (2.7.6)
-    faraday (1.9.3)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    faraday_middleware (1.2.0)
-      faraday (~> 1.0)
-    multipart-post (2.1.1)
-    rake (13.0.6)
-    ruby2_keywords (0.0.5)
+    activesupport (8.0.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    ast (2.4.2)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    dotenv (3.1.7)
+    drb (2.2.1)
+    faraday (2.12.2)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-multipart (1.1.0)
+      multipart-post (~> 2.0)
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    json (2.9.1)
+    language_server-protocol (3.17.0.4)
+    logger (1.6.5)
+    minitest (5.25.4)
+    multipart-post (2.4.1)
+    net-http (0.6.0)
+      uri
+    parallel (1.26.3)
+    parser (3.3.7.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
+    rack (3.1.8)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rubocop (1.71.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    rubocop-minitest (0.36.0)
+      rubocop (>= 1.61, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-performance (1.23.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.29.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.52.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails-omakase (1.0.0)
+      rubocop
+      rubocop-minitest
+      rubocop-performance
+      rubocop-rails
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.2)
+    vcr (6.3.1)
+      base64
 
 PLATFORMS
   x86_64-linux
@@ -45,7 +100,10 @@ PLATFORMS
 DEPENDENCIES
   dotenv
   freeagentrb!
+  minitest (~> 5.0)
   rake (~> 13.0)
+  rubocop-rails-omakase
+  vcr
 
 BUNDLED WITH
-   2.2.33
+   2.6.3

data/Rakefile

@@ -1,4 +1,10 @@
-# frozen_string_literal: true
-
 require "bundler/gem_tasks"
-task default: %i[]
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/freeagentrb.gemspec

@@ -5,17 +5,17 @@ require_relative "lib/free_agent/version"
 Gem::Specification.new do |spec|
   spec.name = "freeagentrb"
   spec.version = FreeAgent::VERSION
-  spec.authors = ["Dean Perry"]
-  spec.email = ["dean@deanpcmad.com"]
+  spec.authors = [ "Dean Perry" ]
+  spec.email = [ "dean@deanpcmad.com" ]
 
-  spec.summary = "A Ruby library for interacting with the FreeAgent v2 API"
+  spec.summary = "Ruby library for the FreeAgent v2 API"
   spec.homepage = "https://deanpcmad.com"
+
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata["source_code_uri"] = "https://github.com/deanpcmad/freeagentrb"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -24,11 +24,8 @@ Gem::Specification.new do |spec|
       (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = [ "lib" ]
 
-  spec.add_dependency "faraday", "~> 1.7"
-  spec.add_dependency "faraday_middleware", "~> 1.1"
+  spec.add_dependency "faraday", "~> 2.11"
   spec.add_dependency "faraday-multipart", "~> 1.0"
 end

data/lib/free_agent/client.rb

@@ -25,7 +25,7 @@ module FreeAgent
     def bank_accounts
       BankAccountsResource.new(self)
     end
-    
+
     def bank_transactions
       BankTransactionsResource.new(self)
     end
@@ -74,14 +74,20 @@ module FreeAgent
       BillsResource.new(self)
     end
 
+    def categories
+      CategoriesResource.new(self)
+    end
+
     def connection
       url = (sandbox == true ? SANDBOX_BASE_URL : BASE_URL)
       @connection ||= Faraday.new(url) do |conn|
         conn.request :authorization, :Bearer, access_token
         conn.request :json
+        conn.response :json
 
-        conn.response :dates
-        conn.response :json, content_type: "application/json"
+        conn.headers = {
+          "User-Agent" => "freeagentrb/v#{VERSION} (github.com/deanpcmad/freeagentrb)"
+        }
 
         conn.adapter adapter, @stubs
       end
@@ -95,6 +101,5 @@ module FreeAgent
         conn.request :multipart
       end
     end
-
   end
 end

data/lib/free_agent/collection.rb

@@ -1,27 +1,46 @@
 module FreeAgent
   class Collection
-    attr_reader :data, :total
+    attr_reader :data, :total, :pagination
 
-    def self.from_response(response, type:, key: nil)
+    def self.from_response(response, type:)
       body = response.body
 
-      if key.is_a?(String)
-        data = body[key].map { |attrs| type.new(attrs) }
-      else
-        data = body.map { |attrs| type.new(attrs) }
-      end
+      data = body.values.first.map { |attrs| type.new(attrs) }
 
       total = response.headers["X-total-count"]
 
+      pagination = response.headers["Link"]&.split(", ")&.map do |link|
+        url, rel = link.match(/<(.+)>; rel='(.+)'/)&.captures
+        [ rel, url ]
+      end&.to_h
+
       new(
         data: data,
-        total: total
+        total: total,
+        pagination: pagination
       )
     end
 
-    def initialize(data:, total:)
+    def initialize(data:, total:, pagination: nil)
       @data = data
       @total = total
+      @pagination = pagination
+    end
+
+    def count
+      data.count
+    end
+
+    def each(&block)
+      data.each(&block)
+    end
+
+    def first
+      data.first
+    end
+
+    def last
+      data.last
     end
   end
 end

data/lib/free_agent/error_generator.rb

@@ -0,0 +1,128 @@
+module FreeAgent
+  class ErrorGenerator < StandardError
+    attr_reader :http_status_code
+    attr_reader :freeagent_error_code
+    attr_reader :freeagent_error_message
+
+    def initialize(response_body, http_status_code)
+      @response_body = response_body
+      @http_status_code = http_status_code
+      set_freeagent_error_values
+      super(build_message)
+    end
+
+    private
+
+    def set_freeagent_error_values
+      @freeagent_error_code = @response_body.dig("error")
+      @freeagent_error_message = @response_body.dig("message")
+    end
+
+    def error_message
+      @freeagent_error_message || @response_body.dig("error")
+    rescue NoMethodError
+      "An unknown error occurred."
+    end
+
+    def build_message
+      if freeagent_error_code.nil?
+        return "Error #{@http_status_code}: #{error_message}"
+      end
+      "Error #{@http_status_code}: #{error_message} '#{freeagent_error_message}'"
+    end
+  end
+
+  module Errors
+    class BadRequestError < ErrorGenerator
+      private
+
+      def error_message
+        "Your request was malformed."
+      end
+    end
+
+    class AuthenticationMissingError < ErrorGenerator
+      private
+
+      def error_message
+        "You did not supply valid authentication credentials."
+      end
+    end
+
+    class ForbiddenError < ErrorGenerator
+      private
+
+      def error_message
+        "You are not allowed to perform that action."
+      end
+    end
+
+    class EntityNotFoundError < ErrorGenerator
+      private
+
+      def error_message
+        "No results were found for your request."
+      end
+    end
+
+    class ConflictError < ErrorGenerator
+      private
+
+      def error_message
+        "Your request was a conflict."
+      end
+    end
+
+    class TooManyRequestsError < ErrorGenerator
+      private
+
+      def error_message
+        "Your request exceeded the API rate limit."
+      end
+    end
+
+    class InternalError < ErrorGenerator
+      private
+
+      def error_message
+        "We were unable to perform the request due to server-side problems."
+      end
+    end
+
+    class ServiceUnavailableError < ErrorGenerator
+      private
+
+      def error_message
+        "You have been rate limited for sending more than 20 requests per second."
+      end
+    end
+
+    class NotImplementedError < ErrorGenerator
+      private
+
+      def error_message
+        "This resource has not been implemented."
+      end
+    end
+  end
+
+  class ErrorFactory
+    HTTP_ERROR_MAP = {
+      400 => Errors::BadRequestError,
+      401 => Errors::AuthenticationMissingError,
+      403 => Errors::ForbiddenError,
+      404 => Errors::EntityNotFoundError,
+      409 => Errors::ConflictError,
+      429 => Errors::TooManyRequestsError,
+      500 => Errors::InternalError,
+      503 => Errors::ServiceUnavailableError,
+      501 => Errors::NotImplementedError
+    }.freeze
+
+    def self.create(response_body, http_status_code)
+      status = http_status_code
+      error_class = HTTP_ERROR_MAP[status] || ErrorGenerator
+      error_class.new(response_body, http_status_code) if error_class
+    end
+  end
+end

data/lib/free_agent/object.rb

@@ -5,7 +5,7 @@ module FreeAgent
     def initialize(attributes)
       super to_ostruct(attributes)
 
-      # The FreeAgent API doesn't send an ID so generate it from the URL 
+      # The FreeAgent API doesn't send an ID so generate it from the URL
       if attributes["url"]
         number = attributes["url"].match(/\d{2,}/)
         self.id = number[0] unless number.nil?
@@ -14,7 +14,7 @@ module FreeAgent
 
     def to_ostruct(obj)
       if obj.is_a?(Hash)
-        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+        OpenStruct.new(obj.map { |key, val| [ key, to_ostruct(val) ] }.to_h)
       elsif obj.is_a?(Array)
         obj.map { |o| to_ostruct(o) }
       else # Assumed to be a primitive value

data/lib/free_agent/objects/bank_transaction.rb

@@ -1,4 +1,21 @@
 module FreeAgent
   class BankTransaction < Object
+    def initialize(attributes)
+      super to_ostruct(attributes)
+
+      # Convert amounts to BigDecimal
+      self.amount = BigDecimal(self.amount.to_s).to_f if self.amount
+      self.unexplained_amount = BigDecimal(self.unexplained_amount.to_s).to_f if self.unexplained_amount
+
+      # Convert amounts in bank_transaction_explanations to BigDecimal
+      if self.bank_transaction_explanations
+        self.bank_transaction_explanations.each do |explanation|
+          explanation.id = explanation.url.match(/\d{2,}/)[0] if explanation.url
+          explanation.gross_value = BigDecimal(explanation.gross_value.to_s).to_f if explanation.gross_value
+          explanation.foreign_currency_value = BigDecimal(explanation.foreign_currency_value.to_s).to_f if explanation.foreign_currency_value
+          explanation.transfer_value = BigDecimal(explanation.transfer_value.to_s).to_f if explanation.transfer_value
+        end
+      end
+    end
   end
 end

data/lib/free_agent/objects/category.rb

@@ -0,0 +1,4 @@
+module FreeAgent
+  class Category < Object
+  end
+end

data/lib/free_agent/objects/invoice.rb

@@ -1,4 +1,13 @@
 module FreeAgent
   class Invoice < Object
+    def initialize(attributes)
+      super to_ostruct(attributes)
+
+      # Convert amounts to BigDecimal
+      self.net_value = BigDecimal(self.net_value.to_s).to_f if self.net_value
+      self.total_value = BigDecimal(self.total_value.to_s).to_f if self.total_value
+      self.paid_value = BigDecimal(self.paid_value.to_s).to_f if self.paid_value
+      self.due_value = BigDecimal(self.due_value.to_s).to_f if self.due_value
+    end
   end
 end

data/lib/free_agent/resource.rb

@@ -29,32 +29,20 @@ module FreeAgent
     end
 
     def handle_response(response)
-      case response.status
-      when 400
-        raise Error, "Error 400: Your request was malformed. '#{response.body["errors"]["error"]["message"]}'"
-      when 401
-        raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["errors"]["error"]["message"]}'"
-      when 403
-        raise Error, "Error 403: You are not allowed to perform that action. '#{response.body["errors"]["error"]["message"]}'"
-      when 404
-        raise Error, "Error 404: No results were found for your request. '#{response.body["errors"]["error"]["message"]}'"
-      when 409
-        raise Error, "Error 409: Your request was a conflict. '#{response.body["errors"]["error"]["message"]}'"
-      when 422
-        if response.body["errors"].is_a? Array
-          raise Error, "Error 422: Unprocessable Entity. '#{response.body["errors"].map {|e| e['message']}.join(" & ")}'"
-        else
-          raise Error, "Error 422: Unprocessable Entity. '#{response.body["errors"]["error"]["message"]}'"
-        end
-      when 429
-        raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["errors"]["error"]["message"]}'"
-      when 500
-        raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body["errors"]["error"]["message"]}'"
-      when 503
-        raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["errors"]["error"]["message"]}'"
-      end
-
-      response
+      return true if response.status == 204
+      return response unless error?(response)
+
+      raise_error(response)
+    end
+
+    def error?(response)
+      [ 400, 401, 403, 404, 409, 429, 500, 501, 503 ].include?(response.status) ||
+        response.body&.key?("error")
+    end
+
+    def raise_error(response)
+      error = FreeAgent::ErrorFactory.create(response.body, response.status)
+      raise error if error
     end
   end
 end

data/lib/free_agent/resources/attachments.rb

@@ -1,6 +1,5 @@
 module FreeAgent
   class AttachmentsResource < Resource
-
     def retrieve(id:)
       response = get_request("attachments/#{id}")
       Attachment.new(response.body["attachment"])
@@ -10,6 +9,5 @@ module FreeAgent
       response = delete_request("attachments/#{id}")
       response.success?
     end
-
   end
 end

data/lib/free_agent/resources/bank_accounts.rb

@@ -1,11 +1,10 @@
 module FreeAgent
   class BankAccountsResource < Resource
-
     def list(view: nil)
       url = view.nil? ? "bank_accounts" : "bank_accounts?view=#{view}"
 
       response = get_request(url)
-      Collection.from_response(response, type: BankAccount, key: "bank_accounts")
+      Collection.from_response(response, type: BankAccount)
     end
 
     def retrieve(id:)
@@ -14,7 +13,7 @@ module FreeAgent
     end
 
     def create(type:, name:, opening_balance:, **params)
-      attributes = {type: type, name: name, opening_balance: opening_balance}
+      attributes = { type: type, name: name, opening_balance: opening_balance }
       response = post_request("bank_accounts", body: attributes.merge(params))
       BankAccount.new(response.body["bank_account"]) if response.success?
     end
@@ -28,6 +27,5 @@ module FreeAgent
       response = delete_request("bank_accounts/#{id}")
       response.success?
     end
-
   end
 end

data/lib/free_agent/resources/bank_transaction_explanations.rb

@@ -1,11 +1,10 @@
 module FreeAgent
   class BankTransactionExplanationsResource < Resource
-
     def list(bank_account:, **params)
-      attributes = {bank_account: bank_account}
+      attributes = { bank_account: bank_account }
 
       response = get_request("bank_transaction_explanations", params: attributes.merge(params))
-      Collection.from_response(response, type: BankTransactionExplanation, key: "bank_transaction_explanations")
+      Collection.from_response(response, type: BankTransactionExplanation)
     end
 
     def retrieve(id:)
@@ -13,17 +12,15 @@ module FreeAgent
       BankTransactionExplanation.new(response.body["bank_transaction_explanation"])
     end
 
-    # Commented out as it needs more work
-    # def create(**params)
-    #   raise "bank_account or bank_transaction is required" unless !params[:bank_account].nil? || !params[:bank_transaction].nil?
-    #   response = post_request("bank_transaction_explanations", body: params)
-    #   response.body
-    # end
+    def create(**params)
+      raise "bank_account or bank_transaction is required" unless !params[:bank_account].nil? || !params[:bank_transaction].nil?
+      response = post_request("bank_transaction_explanations", body: params)
+      BankTransactionExplanation.new(response.body["bank_transaction_explanation"])
+    end
 
     def delete(id:)
       response = delete_request("bank_transaction_explanations/#{id}")
       response.success?
     end
-
   end
 end

data/lib/free_agent/resources/bank_transactions.rb

@@ -1,11 +1,10 @@
 module FreeAgent
   class BankTransactionsResource < Resource
-
     def list(bank_account:, **params)
-      attributes = {bank_account: bank_account}
+      attributes = { bank_account: bank_account }
 
       response = get_request("bank_transactions", params: attributes.merge(params))
-      Collection.from_response(response, type: BankTransaction, key: "bank_transactions")
+      Collection.from_response(response, type: BankTransaction)
     end
 
     def retrieve(id:)
@@ -15,14 +14,14 @@ module FreeAgent
 
     # Statement should be an array of transactions
     def create(bank_account:, statement:)
-      response = post_request("bank_transactions/statement?bank_account=#{bank_account}", body: {statement: statement})
+      response = post_request("bank_transactions/statement?bank_account=#{bank_account}", body: { statement: statement })
       response.success?
     end
 
     def upload(bank_account:, statement:)
       # This method uses Faraday Multipart (lostisland/faraday-multipart)
       payload = {}
-      payload[:statement] = Faraday::Multipart::FilePart.new(statement, 'text/x-ruby')
+      payload[:statement] = Faraday::Multipart::FilePart.new(statement, "text/x-ruby")
 
       response = client.connection_upload.post "bank_transactions/statement?bank_account=#{bank_account}", payload
       response.success?
@@ -32,6 +31,5 @@ module FreeAgent
       response = delete_request("bank_transactions/#{id}")
       response.success?
     end
-
   end
 end

data/lib/free_agent/resources/bills.rb

@@ -1,19 +1,18 @@
 module FreeAgent
   class BillsResource < Resource
-
     def list(**params)
       response = get_request("bills", params: params)
-      Collection.from_response(response, type: Bill, key: "bills")
+      Collection.from_response(response, type: Bill)
     end
 
     def list_for_contact(contact:, **params)
       response = get_request("bills?contact=#{contact}", params: params)
-      Collection.from_response(response, type: Bill, key: "bills")
+      Collection.from_response(response, type: Bill)
     end
 
     def list_for_project(project:, **params)
       response = get_request("bills?project=#{project}", params: params)
-      Collection.from_response(response, type: Bill, key: "bills")
+      Collection.from_response(response, type: Bill)
     end
 
     def retrieve(id:)
@@ -22,14 +21,14 @@ module FreeAgent
     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}
+      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)})
+      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})
+      response = put_request("bills/#{id}", body: { bill: params })
       Bill.new(response.body["bill"]) if response.success?
     end
 
@@ -37,6 +36,5 @@ module FreeAgent
       response = delete_request("bills/#{id}")
       response.success?
     end
-
   end
 end

data/lib/free_agent/resources/categories.rb

@@ -0,0 +1,18 @@
+module FreeAgent
+  class CategoriesResource < Resource
+    def list(**params)
+      response = get_request("categories", params: params)
+
+      responses = []
+
+      response.body.keys.each do |key|
+        response.body[key].each do |value|
+          value["category_type"] = key
+          responses << Category.new(value)
+        end
+      end
+
+      responses
+    end
+  end
+end

data/lib/free_agent/resources/company.rb

@@ -1,10 +1,8 @@
 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

@@ -1,9 +1,8 @@
 module FreeAgent
   class ContactsResource < Resource
-
     def list(**params)
       response = get_request("contacts", params: params)
-      Collection.from_response(response, type: Contact, key: "contacts")
+      Collection.from_response(response, type: Contact)
     end
 
     def retrieve(id:)
@@ -27,6 +26,5 @@ module FreeAgent
       response = delete_request("contacts/#{id}")
       response.success?
     end
-
   end
 end

data/lib/free_agent/resources/credit_notes.rb

@@ -1,19 +1,18 @@
 module FreeAgent
   class CreditNotesResource < Resource
-
     def list(**params)
       response = get_request("credit_notes", params: params)
-      Collection.from_response(response, type: CreditNote, key: "credit_notes")
+      Collection.from_response(response, type: CreditNote)
     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")
+      Collection.from_response(response, type: CreditNote)
     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")
+      Collection.from_response(response, type: CreditNote)
     end
 
     def retrieve(id:)
@@ -28,9 +27,9 @@ module FreeAgent
     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}
+      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)})
+      response = post_request("credit_notes", body: { credit_note: attributes.merge(params) })
       CreditNote.new(response.body["credit_note"]) if response.success?
     end
 
@@ -40,7 +39,7 @@ module FreeAgent
     # end
 
     def update(id:, **params)
-      response = put_request("credit_notes/#{id}", body: {credit_note: params})
+      response = put_request("credit_notes/#{id}", body: { credit_note: params })
       CreditNote.new(response.body["credit_note"]) if response.success?
     end
 
@@ -50,8 +49,8 @@ module FreeAgent
     end
 
     def email(id:, to:, **params)
-      attributes = {to: to}
-      response = post_request("credit_notes/#{id}/send_email", body: {credit_note: {email: attributes.merge(params)}})
+      attributes = { to: to }
+      response = post_request("credit_notes/#{id}/send_email", body: { credit_note: { email: attributes.merge(params) } })
       response.success?
     end
 
@@ -69,6 +68,5 @@ module FreeAgent
       response = put_request("credit_notes/#{id}/transitions/mark_as_cancelled", body: {})
       response.success?
     end
-
   end
 end

data/lib/free_agent/resources/estimate_items.rb

@@ -1,8 +1,7 @@
 module FreeAgent
   class EstimateItemsResource < Resource
-
     def create(estimate:, **params)
-      attributes = {estimate: estimate}
+      attributes = { estimate: estimate }
 
       response = post_request("estimate_items", body: attributes.merge(params))
       EstimateItem.new(response.body["estimate_item"]) if response.success?
@@ -17,6 +16,5 @@ module FreeAgent
       response = delete_request("estimate_items/#{id}")
       response.success?
     end
-
   end
 end

data/lib/free_agent/resources/estimates.rb

@@ -1,24 +1,23 @@
 module FreeAgent
   class EstimatesResource < Resource
-
     def list(**params)
       response = get_request("estimates", params: params)
-      Collection.from_response(response, type: Estimate, key: "estimates")
+      Collection.from_response(response, type: Estimate)
     end
 
     def list_for_contact(contact:, **params)
       response = get_request("estimates?contact=#{contact}", params: params)
-      Collection.from_response(response, type: Estimate, key: "estimates")
+      Collection.from_response(response, type: Estimate)
     end
 
     def list_for_project(project:, **params)
       response = get_request("estimates?project=#{project}", params: params)
-      Collection.from_response(response, type: Estimate, key: "estimates")
+      Collection.from_response(response, type: Estimate)
     end
 
     def list_for_invoice(invoice:, **params)
       response = get_request("estimates?invoice=#{invoice}", params: params)
-      Collection.from_response(response, type: Estimate, key: "estimates")
+      Collection.from_response(response, type: Estimate)
     end
 
     def retrieve(id:)
@@ -33,9 +32,9 @@ module FreeAgent
     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}
+      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)})
+      response = post_request("estimates", body: { estimate: attributes.merge(params) })
       Estimate.new(response.body["estimate"]) if response.success?
     end
 
@@ -50,8 +49,8 @@ module FreeAgent
     end
 
     def email(id:, to:, **params)
-      attributes = {to: to}
-      response = post_request("estimates/#{id}/send_email", body: {estimate: {email: attributes.merge(params)}})
+      attributes = { to: to }
+      response = post_request("estimates/#{id}/send_email", body: { estimate: { email: attributes.merge(params) } })
       response.success?
     end
 
@@ -74,6 +73,5 @@ module FreeAgent
       response = put_request("estimates/#{id}/transitions/mark_as_rejected", body: {})
       response.success?
     end
-
   end
 end

data/lib/free_agent/resources/invoices.rb

@@ -1,19 +1,18 @@
 module FreeAgent
   class InvoicesResource < Resource
-
     def list(**params)
       response = get_request("invoices", params: params)
-      Collection.from_response(response, type: Invoice, key: "invoices")
+      Collection.from_response(response, type: Invoice)
     end
 
     def list_for_contact(contact:, **params)
       response = get_request("invoices?contact=#{contact}", params: params)
-      Collection.from_response(response, type: Invoice, key: "invoices")
+      Collection.from_response(response, type: Invoice)
     end
 
     def list_for_project(project:, **params)
       response = get_request("invoices?project=#{project}", params: params)
-      Collection.from_response(response, type: Invoice, key: "invoices")
+      Collection.from_response(response, type: Invoice)
     end
 
     def retrieve(id:)
@@ -28,9 +27,9 @@ module FreeAgent
     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}
+      attributes = { contact: contact, dated_on: dated_on, payment_terms_in_days: payment_terms_in_days }
 
-      response = post_request("invoices", body: {invoice: attributes.merge(params)})
+      response = post_request("invoices", body: { invoice: attributes.merge(params) })
       Invoice.new(response.body["invoice"]) if response.success?
     end
 
@@ -40,7 +39,7 @@ module FreeAgent
     end
 
     def update(id:, **params)
-      response = put_request("invoices/#{id}", body: {invoice: params})
+      response = put_request("invoices/#{id}", body: { invoice: params })
       Invoice.new(response.body["invoice"]) if response.success?
     end
 
@@ -50,8 +49,8 @@ module FreeAgent
     end
 
     def email(id:, to:, **params)
-      attributes = {to: to}
-      response = post_request("invoices/#{id}/send_email", body: {invoice: {email: attributes.merge(params)}})
+      attributes = { to: to }
+      response = post_request("invoices/#{id}/send_email", body: { invoice: { email: attributes.merge(params) } })
       response.success?
     end
 
@@ -84,6 +83,5 @@ module FreeAgent
       response = post_request("invoices/#{id}/direct_debit", body: {})
       response.success?
     end
-
   end
 end

data/lib/free_agent/resources/projects.rb

@@ -1,14 +1,13 @@
 module FreeAgent
   class ProjectsResource < Resource
-
     def list(**params)
       response = get_request("projects", params: params)
-      Collection.from_response(response, type: Project, key: "projects")
+      Collection.from_response(response, type: Project)
     end
 
     def list_for_contact(contact:, **params)
       response = get_request("projects?contact=#{contact}", params: params)
-      Collection.from_response(response, type: Project, key: "projects")
+      Collection.from_response(response, type: Project)
     end
 
     def retrieve(id:)
@@ -17,7 +16,7 @@ module FreeAgent
     end
 
     def create(contact:, name:, status:, currency:, budget_units:, **params)
-      attributes = {contact: contact, name: name, status: status, currency: currency, budget_units: budget_units}
+      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?
@@ -32,6 +31,5 @@ module FreeAgent
       response = delete_request("projects/#{id}")
       response.success?
     end
-
   end
 end

data/lib/free_agent/resources/tasks.rb

@@ -1,14 +1,13 @@
 module FreeAgent
   class TasksResource < Resource
-
     def list(**params)
       response = get_request("tasks", params: params)
-      Collection.from_response(response, type: Task, key: "tasks")
+      Collection.from_response(response, type: Task)
     end
 
     def list_for_project(project:, **params)
       response = get_request("tasks?project=#{project}", params: params)
-      Collection.from_response(response, type: Task, key: "tasks")
+      Collection.from_response(response, type: Task)
     end
 
     def retrieve(id:)
@@ -17,7 +16,7 @@ module FreeAgent
     end
 
     def create(project:, name:,  **params)
-      attributes = {project: project, name: name}
+      attributes = { project: project, name: name }
 
       response = post_request("tasks", body: attributes.merge(params))
       Task.new(response.body["task"]) if response.success?
@@ -32,6 +31,5 @@ module FreeAgent
       response = delete_request("tasks/#{id}")
       response.success?
     end
-
   end
 end

data/lib/free_agent/resources/timeslips.rb

@@ -1,24 +1,23 @@
 module FreeAgent
   class TimeslipsResource < Resource
-
     def list(**params)
       response = get_request("timeslips", params: params)
-      Collection.from_response(response, type: Timeslip, key: "timeslips")
+      Collection.from_response(response, type: Timeslip)
     end
 
     def list_for_user(user:, **params)
       response = get_request("timeslips?user=#{user}", params: params)
-      Collection.from_response(response, type: Timeslip, key: "timeslips")
+      Collection.from_response(response, type: Timeslip)
     end
 
     def list_for_task(task:, **params)
       response = get_request("timeslips?task=#{task}", params: params)
-      Collection.from_response(response, type: Timeslip, key: "timeslips")
+      Collection.from_response(response, type: Timeslip)
     end
 
     def list_for_project(project:, **params)
       response = get_request("timeslips?project=#{project}", params: params)
-      Collection.from_response(response, type: Timeslip, key: "timeslips")
+      Collection.from_response(response, type: Timeslip)
     end
 
     def retrieve(id:)
@@ -27,7 +26,7 @@ module FreeAgent
     end
 
     def create(task:, user:, project:, dated_on:, hours:,  **params)
-      attributes = {task: task, user: user, project: project, dated_on: dated_on, hours: hours}
+      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?
@@ -42,6 +41,5 @@ module FreeAgent
       response = delete_request("timeslips/#{id}")
       response.success?
     end
-
   end
 end

data/lib/free_agent/resources/users.rb

@@ -1,6 +1,5 @@
 module FreeAgent
   class UsersResource < Resource
-
     def me
       response = get_request("users/me")
       User.new(response.body["user"])
@@ -8,7 +7,7 @@ module FreeAgent
 
     def list(**params)
       response = get_request("users", params: params)
-      Collection.from_response(response, type: User, key: "users")
+      Collection.from_response(response, type: User)
     end
 
     def retrieve(id:)
@@ -17,7 +16,7 @@ module FreeAgent
     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}
+      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?
@@ -29,7 +28,7 @@ module FreeAgent
     end
 
     def update_me(**params)
-      response = put_request("users/me", body: {user: params})
+      response = put_request("users/me", body: { user: params })
       User.new(response.body["user"]) if response.success?
     end
 
@@ -37,6 +36,5 @@ module FreeAgent
       response = delete_request("users/#{id}")
       response.success?
     end
-
   end
 end

data/lib/free_agent/version.rb

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

data/lib/free_agent.rb

@@ -1,11 +1,14 @@
 require "faraday"
-require "faraday_middleware"
 require "faraday/multipart"
 require "json"
 
 require_relative "free_agent/version"
 
 module FreeAgent
+  autoload :Error, "free_agent/error"
+  autoload :Errors, "free_agent/error_generator"
+  autoload :ErrorGenerator, "free_agent/error_generator"
+  autoload :ErrorFactory, "free_agent/error_generator"
 
   autoload :Client, "free_agent/client"
   autoload :Collection, "free_agent/collection"
@@ -28,6 +31,7 @@ module FreeAgent
   autoload :EstimateItemsResource, "free_agent/resources/estimate_items"
   autoload :CreditNotesResource, "free_agent/resources/credit_notes"
   autoload :BillsResource, "free_agent/resources/bills"
+  autoload :CategoriesResource, "free_agent/resources/categories"
 
   autoload :Company, "free_agent/objects/company"
   autoload :Contact, "free_agent/objects/contact"
@@ -44,5 +48,5 @@ module FreeAgent
   autoload :EstimateItem, "free_agent/objects/estimate_item"
   autoload :CreditNote, "free_agent/objects/credit_note"
   autoload :Bill, "free_agent/objects/bill"
-
+  autoload :Category, "free_agent/objects/category"
 end

data/lib/freeagentrb.rb

@@ -1 +1 @@
-require "free_agent"
+require "free_agent"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: freeagentrb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dean Perry
-autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-01-09 00:00:00.000000000 Z
+date: 2025-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,28 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +37,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: 
 email:
 - dean@deanpcmad.com
 executables: []
@@ -60,6 +44,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.example"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -72,12 +57,14 @@ files:
 - lib/free_agent/client.rb
 - lib/free_agent/collection.rb
 - lib/free_agent/error.rb
+- lib/free_agent/error_generator.rb
 - lib/free_agent/object.rb
 - lib/free_agent/objects/attachment.rb
 - lib/free_agent/objects/bank_account.rb
 - lib/free_agent/objects/bank_transaction.rb
 - lib/free_agent/objects/bank_transaction_explanation.rb
 - lib/free_agent/objects/bill.rb
+- lib/free_agent/objects/category.rb
 - lib/free_agent/objects/company.rb
 - lib/free_agent/objects/contact.rb
 - lib/free_agent/objects/credit_note.rb
@@ -94,6 +81,7 @@ files:
 - lib/free_agent/resources/bank_transaction_explanations.rb
 - lib/free_agent/resources/bank_transactions.rb
 - lib/free_agent/resources/bills.rb
+- lib/free_agent/resources/categories.rb
 - lib/free_agent/resources/company.rb
 - lib/free_agent/resources/contacts.rb
 - lib/free_agent/resources/credit_notes.rb
@@ -111,7 +99,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://deanpcmad.com
-post_install_message: 
+  source_code_uri: https://github.com/deanpcmad/freeagentrb
 rdoc_options: []
 require_paths:
 - lib
@@ -126,8 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
-summary: A Ruby library for interacting with the FreeAgent v2 API
+summary: Ruby library for the FreeAgent v2 API
 test_files: []