freeagentrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b570455fe0bf3cdc90330ad013a8f878f3c48405116d2033932ebc2db86bbb0f
+  data.tar.gz: ca6b9f1bc67606328cddabfb1261beb77ec482c054214f58f0635041119c164e
+SHA512:
+  metadata.gz: 8d6349663051511f41b43b2312e01529549a13c5a36bbee06855ce3e1f10abe6c9eaff4002e847f1e3b706d9164bc7ba85278e23f82ac0d7ece82d4c81d858b6
+  data.tar.gz: b03dd9e7852da63914f12ad3a6b0e93ebd22d2dff80f865b8810739ecc4cb6df2900cb4e8a0ae7e6563f9ac7a2c93fc7c140e6ae2622f4eee5db867492a0521f

data/.env.example

@@ -0,0 +1 @@
+ACCESS_TOKEN=

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in igdbrb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "dotenv"

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    freeagentrb (0.1.0)
+      faraday (~> 1.7)
+      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)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv
+  freeagentrb!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.2.33

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Dean Perry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# FreeAgentRB
+
+**This library is a work in progress**
+
+FreeAgentRB is a Ruby library for interacting with the FreeAgent v2 API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "freeagentrb"
+```
+
+## Usage
+
+### Set Client Details
+
+Firstly you'll need to set an Access Token, which would be created from OAuth.
+See [this page](https://dev.freeagent.com/docs/quick_start) for more info.
+
+```ruby
+@client = FreeAgent::Client.new(access_token: "", sandbox: true)
+```
+
+### Bank Accounts
+
+```ruby
+@client.bank_accounts.list
+@client.bank_accounts.list(view: "paypal_accounts")
+@client.bank_accounts.retrieve(id: "12345")
+@client.bank_accounts.create type: "StandardBankAccount", name: "My Account", opening_balance: "10"
+@client.bank_accounts.update id: "12345", name: "My Other Account"
+```

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "free_agent"
+
+# Load environment variables from .env file
+require 'dotenv/load'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+# @access_token = Igdb::AccessToken.new(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
+
+@client = FreeAgent::Client.new(access_token: ENV["ACCESS_TOKEN"], sandbox: true)
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/freeagentrb.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+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.summary = "A Ruby library for interacting with 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."
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (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.add_dependency "faraday", "~> 1.7"
+  spec.add_dependency "faraday_middleware", "~> 1.1"
+  spec.add_dependency "faraday-multipart", "~> 1.0"
+end

data/lib/free_agent/client.rb

@@ -0,0 +1,100 @@
+module FreeAgent
+  class Client
+    BASE_URL = "https://api.freeagent.com/v2"
+    SANDBOX_BASE_URL = "https://api.sandbox.freeagent.com/v2"
+
+    attr_reader :access_token, :sandbox, :adapter
+
+    def initialize(access_token:, sandbox: false, adapter: Faraday.default_adapter, stubs: nil)
+      @access_token = access_token
+      @sandbox = sandbox
+      @adapter = adapter
+
+      # Test stubs for requests
+      @stubs = stubs
+    end
+
+    def company
+      CompanyResource.new(self)
+    end
+
+    def contacts
+      ContactsResource.new(self)
+    end
+
+    def bank_accounts
+      BankAccountsResource.new(self)
+    end
+    
+    def bank_transactions
+      BankTransactionsResource.new(self)
+    end
+
+    def bank_transaction_explanations
+      BankTransactionExplanationsResource.new(self)
+    end
+
+    def projects
+      ProjectsResource.new(self)
+    end
+
+    def tasks
+      TasksResource.new(self)
+    end
+
+    def timeslips
+      TimeslipsResource.new(self)
+    end
+
+    def users
+      UsersResource.new(self)
+    end
+
+    def attachments
+      AttachmentsResource.new(self)
+    end
+
+    def invoices
+      InvoicesResource.new(self)
+    end
+
+    def estimates
+      EstimatesResource.new(self)
+    end
+
+    def estimate_items
+      EstimateItemsResource.new(self)
+    end
+
+    def credit_notes
+      CreditNotesResource.new(self)
+    end
+
+    def bills
+      BillsResource.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 :dates
+        conn.response :json, content_type: "application/json"
+
+        conn.adapter adapter, @stubs
+      end
+    end
+
+    # Uses Faraday Multipart (lostisland/faraday-multipart)
+    def connection_upload
+      url = (sandbox == true ? SANDBOX_BASE_URL : BASE_URL)
+      @connection ||= Faraday.new(url) do |conn|
+        conn.request :authorization, :Bearer, access_token
+        conn.request :multipart
+      end
+    end
+
+  end
+end

data/lib/free_agent/collection.rb

@@ -0,0 +1,27 @@
+module FreeAgent
+  class Collection
+    attr_reader :data, :total
+
+    def self.from_response(response, type:, key: nil)
+      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
+
+      total = response.headers["X-total-count"]
+
+      new(
+        data: data,
+        total: total
+      )
+    end
+
+    def initialize(data:, total:)
+      @data = data
+      @total = total
+    end
+  end
+end

data/lib/free_agent/error.rb

@@ -0,0 +1,4 @@
+module FreeAgent
+  class Error < StandardError
+  end
+end

data/lib/free_agent/object.rb

@@ -0,0 +1,25 @@
+require "ostruct"
+
+module FreeAgent
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+
+      # 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?
+      end
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        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
+        obj
+      end
+    end
+  end
+end

data/lib/free_agent/objects/attachment.rb

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

data/lib/free_agent/objects/bank_account.rb

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

data/lib/free_agent/objects/bank_transaction.rb

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

data/lib/free_agent/objects/bank_transaction_explanation.rb

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

data/lib/free_agent/objects/bill.rb

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

data/lib/free_agent/objects/company.rb

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

data/lib/free_agent/objects/contact.rb

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

data/lib/free_agent/objects/credit_note.rb

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

data/lib/free_agent/objects/estimate.rb

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

data/lib/free_agent/objects/estimate_item.rb

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

data/lib/free_agent/objects/invoice.rb

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

data/lib/free_agent/objects/project.rb

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

data/lib/free_agent/objects/task.rb

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

data/lib/free_agent/objects/timeslip.rb

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

data/lib/free_agent/objects/user.rb

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

data/lib/free_agent/resource.rb

@@ -0,0 +1,60 @@
+module FreeAgent
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, headers)
+    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
+    end
+  end
+end

data/lib/free_agent/resources/attachments.rb

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

data/lib/free_agent/resources/bank_accounts.rb

@@ -0,0 +1,33 @@
+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")
+    end
+
+    def retrieve(id:)
+      response = get_request("bank_accounts/#{id}")
+      BankAccount.new(response.body["bank_account"])
+    end
+
+    def create(type:, name:, opening_balance:, **params)
+      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
+
+    def update(id:, **params)
+      response = put_request("bank_accounts/#{id}", body: params)
+      BankAccount.new(response.body["bank_account"]) if response.success?
+    end
+
+    def delete(id:)
+      response = delete_request("bank_accounts/#{id}")
+      response.success?
+    end
+
+  end
+end

data/lib/free_agent/resources/bank_transaction_explanations.rb

@@ -0,0 +1,29 @@
+module FreeAgent
+  class BankTransactionExplanationsResource < Resource
+
+    def list(bank_account:, **params)
+      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")
+    end
+
+    def retrieve(id:)
+      response = get_request("bank_transaction_explanations/#{id}")
+      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 delete(id:)
+      response = delete_request("bank_transaction_explanations/#{id}")
+      response.success?
+    end
+
+  end
+end

data/lib/free_agent/resources/bank_transactions.rb

@@ -0,0 +1,37 @@
+module FreeAgent
+  class BankTransactionsResource < Resource
+
+    def list(bank_account:, **params)
+      attributes = {bank_account: bank_account}
+
+      response = get_request("bank_transactions", params: attributes.merge(params))
+      Collection.from_response(response, type: BankTransaction, key: "bank_transactions")
+    end
+
+    def retrieve(id:)
+      response = get_request("bank_transactions/#{id}")
+      BankTransaction.new(response.body["bank_transaction"])
+    end
+
+    # 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.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')
+
+      response = client.connection_upload.post "bank_transactions/statement?bank_account=#{bank_account}", payload
+      response.success?
+    end
+
+    def delete(id:)
+      response = delete_request("bank_transactions/#{id}")
+      response.success?
+    end
+
+  end
+end