ledger_sync-xero 0.1.0

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

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

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

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

data/lib/ledger_sync/xero/deserializer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Xero
+    class Deserializer < LedgerSync::Deserializer
+    end
+  end
+end

data/lib/ledger_sync/xero/oauth_client.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Xero
+    class OAuthClient
+      AUTHORIZE_URL = 'https://login.xero.com/identity/connect/authorize'
+      RESPONSE_TYPE = 'code'
+      SITE_URL = 'https://api.xero.com/api.xro/2.0'
+      TOKEN_URL = 'https://identity.xero.com/connect/token'
+      SCOPE = %w[
+        offline_access
+        openid
+        profile
+        email
+        accounting.transactions
+        accounting.contacts
+      ].freeze
+
+      class RedirectURIParser
+        attr_reader :uri
+
+        def initialize(uri:)
+          @uri = uri
+        end
+
+        def code
+          @code ||= query.fetch('code').first
+        end
+
+        def parsed_uri
+          @parsed_uri = URI.parse(uri)
+        end
+
+        def query
+          @query ||= CGI.parse(parsed_uri.query)
+        end
+
+        def realm_id
+          @realm_id ||= query.fetch('realmId').first
+        end
+
+        def redirect_uri
+          @redirect_uri ||= begin
+            use_uri = parsed_uri.dup
+            use_uri.fragment = nil
+            use_uri.query = nil
+            ret = use_uri.to_s
+            ret = ret[0..-2] if ret.end_with?('/')
+            ret
+          end
+        end
+      end
+
+      attr_reader :client_id,
+                  :client_secret
+
+      def initialize(client_id:, client_secret:)
+        @client_id = client_id
+        @client_secret = client_secret
+      end
+
+      def authorization_url(redirect_uri:)
+        client.auth_code.authorize_url(
+          redirect_uri: redirect_uri,
+          response_type: RESPONSE_TYPE,
+          state: SecureRandom.hex(12),
+          scope: SCOPE.join(' ')
+        )
+      end
+
+      def auth_code
+        client.auth_code
+      end
+
+      def client
+        @client ||= OAuth2::Client.new(
+          client_id,
+          client_secret,
+          authorize_url: AUTHORIZE_URL,
+          site: SITE_URL,
+          token_url: TOKEN_URL
+        )
+      end
+
+      def get_token(code:, redirect_uri:)
+        auth_code.get_token(
+          code,
+          redirect_uri: redirect_uri
+        )
+      end
+
+      def self.new_from_env
+        new(
+          client_id: ENV.fetch('XERO_CLIENT_ID'),
+          client_secret: ENV.fetch('XERO_CLIENT_SECRET')
+        )
+      end
+    end
+  end
+end

data/lib/ledger_sync/xero/operation.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Xero
+    class Operation
+      module Mixin
+        def self.included(base)
+          base.include Ledgers::Operation::Mixin
+          base.include InstanceMethods # To ensure these override parent methods
+        end
+
+        module InstanceMethods
+          def deserialized_resource(response:)
+            deserializer.deserialize(
+              hash: response,
+              resource: resource
+            )
+          end
+
+          def ledger_resource_path
+            @ledger_resource_path ||= "#{ledger_resource_type_for_path}/#{resource.ledger_id}"
+          end
+
+          def ledger_resource_type_for_path
+            Util::StringHelpers.camelcase(xero_resource_type.pluralize)
+          end
+
+          def response_to_operation_result(response:)
+            if response.success?
+              success(
+                resource: deserialized_resource(
+                  response: response.body[ledger_resource_type_for_path.to_s.capitalize]&.first
+                ),
+                response: response
+              )
+            else
+              failure
+              # TODO: implement failure handler
+            end
+          end
+
+          def perform
+            super
+          rescue LedgerSync::Error::OperationError, OAuth2::Error => e
+            failure(e)
+          ensure
+            client.update_secrets_in_dotenv
+          end
+
+          def xero_resource_type
+            @xero_resource_type ||= client.class.ledger_resource_type_for(resource_class: resource.class)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/xero/operation/create.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../operation'
+
+module LedgerSync
+  module Xero
+    class Operation
+      class Create
+        include Xero::Operation::Mixin
+
+        private
+
+        def operate
+          response_to_operation_result(
+            response: client.post(
+              path: ledger_resource_type_for_path,
+              payload: [
+                serializer.serialize(resource: resource)
+              ]
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/xero/operation/find.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '../operation'
+
+module LedgerSync
+  module Xero
+    class Operation
+      class Find
+        include Xero::Operation::Mixin
+
+        private
+
+        def operate
+          response_to_operation_result(
+            response: client.find(
+              path: ledger_resource_path
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/xero/operation/update.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../operation'
+
+module LedgerSync
+  module Xero
+    class Operation
+      class Update
+        include Xero::Operation::Mixin
+
+        private
+
+        def operate
+          response_to_operation_result(
+            response: client.post(
+              path: ledger_resource_type_for_path,
+              payload: [
+                serializer.serialize(resource: resource)
+              ]
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/xero/request.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Xero
+    class Request < Ledgers::Request
+      attr_reader :client
+
+      def initialize(*args, client:, **keywords)
+        @client = client
+        super(*args, **keywords)
+      end
+
+      def perform
+        raise 'Request already performed' if performed?
+
+        @response = generate_response(
+          body: body,
+          headers: headers,
+          method: method,
+          url: url
+        )
+      ensure
+        @performed = true
+      end
+
+      def refresh!
+        oauth.refresh!
+      rescue OAuth2::Error => e
+        raise e # parse_error(error: e)
+      end
+
+      private
+
+      def generate_response(body:, headers:, method:, url:)
+        oauth_response = oauth.send(
+          method,
+          url,
+          body: (body.to_json unless body.nil?),
+          headers: headers
+        )
+
+        LedgerSync::Ledgers::Response.new_from_oauth_response(
+          oauth_response: oauth_response,
+          request: self
+        )
+      end
+
+      def oauth
+        client.oauth
+      end
+
+      def oauth_client
+        client.oauth_client
+      end
+    end
+  end
+end

data/lib/ledger_sync/xero/resource.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Xero
+    class Resource < LedgerSync::Resource
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Xero
+    class Contact < Xero::Resource
+      attribute :Name, type: Type::String
+      attribute :EmailAddress, type: Type::String
+    end
+  end
+end

data/lib/ledger_sync/xero/serializer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Xero
+    class Serializer < LedgerSync::Serializer
+    end
+  end
+end

data/lib/ledger_sync/xero/version.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# :nocov:
+module LedgerSync
+  module Xero
+    VERSION = '0.1.0'
+
+    def self.version(args = {})
+      pre = args.fetch(:pre, false)
+
+      if !pre && (!ENV['TRAVIS'] || ENV.fetch('TRAVIS_TAG', '') != '')
+        VERSION
+      else
+        "#{VERSION}.pre.#{ENV['TRAVIS_BUILD_NUMBER']}"
+      end
+    end
+  end
+end
+# :nocov:

metadata

@@ -0,0 +1,301 @@
+--- !ruby/object:Gem::Specification
+name: ledger_sync-xero
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Modern Treasury
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ledger_sync
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: LedgerSync is a simple library that allows you to sync common objects
+  to popular accounting software like QuickBooks Online, Xero, NetSuite, etc.
+email:
+- ledgersync@moderntreasury.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".env.test"
+- ".gitignore"
+- ".overcommit.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/xero_oauth_server.rb
+- ledger_sync-xero.gemspec
+- lib/ledger_sync/xero.rb
+- lib/ledger_sync/xero/client.rb
+- lib/ledger_sync/xero/config.rb
+- lib/ledger_sync/xero/contact/deserializer.rb
+- lib/ledger_sync/xero/contact/operations/create.rb
+- lib/ledger_sync/xero/contact/operations/find.rb
+- lib/ledger_sync/xero/contact/operations/update.rb
+- lib/ledger_sync/xero/contact/serializer.rb
+- lib/ledger_sync/xero/deserializer.rb
+- lib/ledger_sync/xero/oauth_client.rb
+- lib/ledger_sync/xero/operation.rb
+- lib/ledger_sync/xero/operation/create.rb
+- lib/ledger_sync/xero/operation/find.rb
+- lib/ledger_sync/xero/operation/update.rb
+- lib/ledger_sync/xero/request.rb
+- lib/ledger_sync/xero/resource.rb
+- lib/ledger_sync/xero/resources/contact.rb
+- lib/ledger_sync/xero/serializer.rb
+- lib/ledger_sync/xero/version.rb
+homepage: https://www.ledgersync.dev
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Sync common objects to accounting software.
+test_files: []