ledger_sync-xero 0.1.0

data/README.md

@@ -0,0 +1,23 @@
+# LedgerSync::Xero
+
+[ledgersync.dev](www.ledgersync.dev)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ledger_sync-xero'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ledger_sync-xero
+
+## Usage
+
+Please visit [ledgersync.dev](www.ledgersync.dev) for full documentation, guidelines, and contribution help.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ledger_sync/xero'
+
+# 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
+
+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/bin/xero_oauth_server.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+# Setup
+#
+# gem install bundler
+# Ensure you have http://localhost:5678 (or PORT) as a Redirect URI in Xero.
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'dotenv'
+  # gem 'ledger_sync', git: 'https://www.github.com/LedgerSync/ledger_sync', branch: 'feature/dotenv'
+  gem 'ledger_sync', path: '../ledger_sync'
+  gem 'ledger_sync-xero', path: './'
+  gem 'rack'
+  gem 'pd_ruby'
+  gem 'byebug'
+end
+
+puts 'Gems installed and loaded!'
+
+require 'pd_ruby'
+require 'byebug'
+require 'socket'
+require 'dotenv'
+require 'rack'
+require 'ledger_sync/xero'
+require 'rack/lobster'
+Dotenv.load('.env.local')
+
+port = ENV.fetch('PORT', 5678)
+server = TCPServer.new(port)
+
+base_url = "http://localhost:#{port}"
+
+puts "Listening at #{base_url}"
+
+client_id = ENV.fetch('XERO_CLIENT_ID')
+
+raise 'XERO_CLIENT_ID not set in ../.env' if client_id.blank?
+
+client = LedgerSync::Xero::Client.new_from_env
+
+puts 'Go to the following URL:'
+puts client.authorization_url(redirect_uri: base_url)
+
+while (session = server.accept) # rubocop:disable Lint/UnreachableLoop
+  request = session.gets
+
+  puts request
+
+  # 1
+  _method, full_path = request.split(' ')
+
+  # 2
+  _path, query = full_path.split('?')
+
+  params = Hash[query.split('&').map { |e| e.split('=') }] if query.present?
+
+  client.set_credentials_from_oauth_code(
+    code: params.fetch('code'),
+    redirect_uri: base_url
+  )
+
+  puts "\n"
+
+  puts 'access_token:'
+  puts client.access_token
+  puts ''
+  puts 'client_id:'
+  puts client.client_id
+  puts ''
+  puts 'client_secret:'
+  puts client.client_secret
+  puts ''
+  puts 'refresh_token:'
+  puts client.refresh_token
+  puts ''
+  puts 'expires_at:'
+  puts Time&.at(client.oauth.expires_at.to_i)&.to_datetime
+  puts ''
+  puts 'tenants:'
+  client = LedgerSync::Xero::Client.new_from_env
+  client.tenants.each do |t|
+    puts "#{t['tenantName']} (#{t['tenantType']}) - #{t['tenantId']}"
+  end
+  puts ''
+  puts 'Done!'
+
+  status = 200
+  body = 'Done'
+  headers = {
+    'Content-Length' => body.size
+  }
+
+  session.print "HTTP/1.1 #{status}\r\n"
+
+  headers.each do |key, value|
+    session.print "#{key}: #{value}\r\n"
+  end
+
+  session.print "\r\n"
+
+  session.print body
+
+  session.close
+
+  break
+end

data/ledger_sync-xero.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ledger_sync/xero/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'ledger_sync-xero'
+  spec.version = LedgerSync::Xero::VERSION
+  spec.authors = ['Modern Treasury']
+  spec.email = ['ledgersync@moderntreasury.com']
+
+  spec.required_ruby_version = '>= 2.5.8'
+
+  spec.summary = 'Sync common objects to accounting software.'
+  spec.description = 'LedgerSync is a simple library that allows you to sync common objects to popular accounting '\
+                     'software like QuickBooks Online, Xero, NetSuite, etc.'
+  spec.homepage = 'https://www.ledgersync.dev'
+
+  # 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 { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency('awesome_print', '>= 0')
+  spec.add_development_dependency('bump', '~> 0.9.0')
+  spec.add_development_dependency('bundler', '~> 2.1')
+  spec.add_development_dependency('byebug')
+  spec.add_development_dependency('climate_control')
+  spec.add_development_dependency('coveralls', '~> 0.8.23')
+  spec.add_development_dependency('factory_bot', '~> 6.1.0')
+  spec.add_development_dependency('overcommit', '~> 0.57.0')
+  spec.add_development_dependency('rake', '~> 13.0')
+  spec.add_development_dependency('rspec', '~> 3.2')
+  spec.add_development_dependency('rubocop', '>= 0')
+  spec.add_development_dependency('webmock', '>= 0')
+  spec.add_runtime_dependency('dotenv')
+  spec.add_runtime_dependency('ledger_sync')
+  spec.add_runtime_dependency('nokogiri', '>= 0')
+  spec.add_runtime_dependency('oauth2', '>= 0')
+end

data/lib/ledger_sync/xero.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'ledger_sync'
+
+module LedgerSync
+  module Xero
+    def self.root(*paths)
+      File.join(File.expand_path('../..', __dir__), *paths.map(&:to_s))
+    end
+  end
+end
+
+require_relative 'xero/config'

data/lib/ledger_sync/xero/client.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require_relative 'oauth_client'
+
+module LedgerSync
+  module Xero
+    class Client
+      include Ledgers::Client::Mixin
+
+      ROOT_URI = 'https://api.xero.com/api.xro/2.0'
+      OAUTH_HEADERS = { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }.freeze
+
+      attr_reader :access_token,
+                  :client_id,
+                  :client_secret,
+                  :expires_at,
+                  :previous_refresh_tokens,
+                  :refresh_token,
+                  :refresh_token_expires_at,
+                  :tenant_id,
+                  :update_dotenv
+
+      def initialize(args = {})
+        @access_token = args.fetch(:access_token)
+        @client_id = args.fetch(:client_id)
+        @client_secret = args.fetch(:client_secret)
+        @refresh_token = args.fetch(:refresh_token)
+        @tenant_id = args.fetch(:tenant_id)
+        @update_dotenv = args.fetch(:update_dotenv, true)
+
+        @previous_access_tokens = []
+        @previous_refresh_tokens = []
+
+        update_secrets_in_dotenv if update_dotenv
+      end
+
+      def authorization_url(redirect_uri:)
+        oauth_client.authorization_url(redirect_uri: redirect_uri)
+      end
+
+      def find(path:)
+        url = "#{ROOT_URI}/#{path.capitalize}"
+
+        request(
+          headers: oauth_headers,
+          method: :get,
+          url: url
+        )
+      end
+
+      def post(path:, payload:)
+        url = "#{ROOT_URI}/#{path.capitalize}"
+
+        request(
+          headers: oauth_headers,
+          method: :post,
+          body: {
+            path.capitalize => payload
+          },
+          url: url
+        )
+      end
+
+      def oauth_headers
+        OAUTH_HEADERS.dup.merge('Xero-tenant-id' => @tenant_id)
+      end
+
+      def oauth
+        OAuth2::AccessToken.new(
+          oauth_client.client,
+          access_token,
+          refresh_token: refresh_token
+        )
+      end
+
+      def oauth_client
+        @oauth_client ||= LedgerSync::Xero::OAuthClient.new(
+          client_id: client_id,
+          client_secret: client_secret
+        )
+      end
+
+      def refresh!
+        set_credentials_from_oauth_token(
+          token: Request.new(
+            client: self
+          ).refresh!
+        )
+        self
+      end
+
+      def tenants
+        response = oauth.get(
+          '/connections',
+          body: nil,
+          headers: LedgerSync::Xero::Client::OAUTH_HEADERS.dup
+        )
+        JSON.parse(response.body)
+      end
+
+      def request(method:, url:, body: nil, headers: {})
+        Request.new(
+          client: self,
+          body: body,
+          headers: headers,
+          method: method,
+          url: url
+        ).perform
+      end
+
+      def self.new_from_env(**override)
+        new(
+          {
+            access_token: ENV.fetch('XERO_ACCESS_TOKEN'),
+            client_id: ENV.fetch('XERO_CLIENT_ID'),
+            client_secret: ENV.fetch('XERO_CLIENT_SECRET'),
+            refresh_token: ENV.fetch('XERO_REFRESH_TOKEN'),
+            tenant_id: ENV.fetch('XERO_TENANT_ID')
+          }.merge(override)
+        )
+      end
+
+      def set_credentials_from_oauth_code(code:, redirect_uri:)
+        oauth_token = oauth_client.get_token(
+          code: code,
+          redirect_uri: redirect_uri
+        )
+
+        set_credentials_from_oauth_token(
+          token: oauth_token
+        )
+
+        oauth_token
+      end
+
+      def set_credentials_from_oauth_token(token:) # rubocop:disable Metrics/CyclomaticComplexity,Naming/AccessorMethodName,Metrics/PerceivedComplexity
+        @previous_access_tokens << access_token if access_token.present?
+        @access_token = token.token
+
+        @expires_at = Time&.at(token.expires_at.to_i)&.to_datetime
+        unless token.params['x_refresh_token_expires_in'].nil?
+          @refresh_token_expires_at = Time&.at(
+            Time.now.to_i + token.params['x_refresh_token_expires_in']
+          )&.to_datetime
+        end
+
+        @previous_refresh_tokens << refresh_token if refresh_token.present?
+        @refresh_token = token.refresh_token
+      ensure
+        update_secrets_in_dotenv if update_dotenv
+      end
+
+      def self.ledger_attributes_to_save
+        %i[access_token expires_at refresh_token refresh_token_expires_at]
+      end
+    end
+  end
+end

data/lib/ledger_sync/xero/config.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'client'
+
+LedgerSync.register_ledger(:xero, base_module: LedgerSync::Xero, root_path: 'ledger_sync/xero') do |config|
+  config.name = 'Xero'
+end

data/lib/ledger_sync/xero/contact/deserializer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Xero
+    class Contact
+      class Deserializer < Xero::Deserializer
+        attribute :ledger_id,
+                  hash_attribute: 'ContactID'
+        attribute :Name
+        attribute :EmailAddress
+      end
+    end
+  end
+end

data/lib/ledger_sync/xero/contact/operations/create.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Xero
+    class Contact
+      module Operations
+        class Create < Xero::Operation::Create
+          class Contract < LedgerSync::Ledgers::Contract
+            params do
+              required(:external_id).filled(:string)
+              required(:ledger_id).value(:nil)
+              required(:Name).maybe(:string)
+              required(:EmailAddress).maybe(:string)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/xero/contact/operations/find.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Xero
+    class Contact
+      module Operations
+        class Find < Xero::Operation::Find
+          class Contract < LedgerSync::Ledgers::Contract
+            params do
+              optional(:external_id).filled(:string)
+              required(:ledger_id).filled(:string)
+              optional(:Name).maybe(:string)
+              optional(:EmailAddress).maybe(:string)
+            end
+          end
+        end
+      end
+    end
+  end
+end