huginn_xero_agent 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8fa7c298f35b0481e97e5444162566836ee87b6
+  data.tar.gz: e0906c462cc539d1a8433864578547f21f3a5804
+SHA512:
+  metadata.gz: 882691fc0a528cc67425e87d6ba14b1be81b2828b995f8112435233c41020f8b6027ec3d1a9baa502d7e216a892d09e4fe3037895c1e0efdc12adab63559ea7d
+  data.tar.gz: 1e983e090c697b4ebfd4934493c4aa970d4437aa1fba77536b04075593bc8ea15f8801f1dbeaed72fae41d09064e6fa83fd6fc8c2a90ad9117ca3204e0444a3d

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2017 Andrew Cantino
+
+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/lib/huginn_xero_agent.rb

@@ -0,0 +1,4 @@
+require 'huginn_agent'
+
+#HuginnAgent.load 'huginn_xero_agent/concerns/my_agent_concern'
+HuginnAgent.register 'huginn_xero_agent/xero_agent'

data/lib/huginn_xero_agent/xero_agent.rb

@@ -0,0 +1,90 @@
+require 'xero_gateway'
+
+module Agents
+  class XeroAgent < Agent
+    cannot_be_scheduled!
+
+    gem_dependency_check { defined?(XeroGateway) }
+
+    description <<-MD
+      Create Invoices in Xero based on incoming Events.
+
+      See [this Agent's GitHub page](https://github.com/cantino/huginn_xero_agent) for instructions on setting up this Agent to access your Xero data.
+
+      All options support [Liquid templating](https://github.com/huginn/huginn/wiki/Formatting-Events-using-Liquid).
+
+      Options
+
+        * `expected_receive_period_in_days` - How often you expect data to be received by this Agent from other Agents.
+        * `due_in_days` - The number of days from now when the invoice is due.
+        * The options `contact_name`, `contact_phone_number`, `contact_email`, `contact_address_line_1`, `contact_address_line_2`, `contact_address_city`, `contact_address_region`, `contact_address_country`, and `contact_address_post_code` allow setting details for a new contact.
+        * You can set an `item_path` if you'd like to create multiple invoices, one per record at that [JSONPath](http://goessner.net/articles/JsonPath/).
+        * The options `item_description`, `item_account_code`, and `item_amount` allow configuring of invoice details and can contain [Liquid templating](https://github.com/huginn/huginn/wiki/Formatting-Events-using-Liquid), allowing you to make them dynamic based on Event input.
+    MD
+
+    def default_options
+      {
+        due_in_days: 14,
+        contact_name: '{{name}}',
+        contact_phone_number: '{{phone}}',
+        contact_email: '{{email}}',
+        item_path: 'items',
+        item_description: 'Widget',
+        item_account_code: '123',
+        item_amount: 20,
+        expected_receive_period_in_days: 10
+      }
+    end
+
+    def working?
+      last_receive_at && last_receive_at > options['expected_receive_period_in_days'].to_i.days.ago && !recent_error_logs?
+    end
+
+    def validate_options
+      errors.add(:base, "due_in_days must be a number") if options['due_in_days'].present? && options['due_in_days'].to_s !~ /\A\d+\z/
+      errors.add(:base, "item_description and item_amount are required") unless options['item_description'].present? && options['item_amount'].present?
+      errors.add(:base, "expected_receive_period_in_days is required") unless options['expected_receive_period_in_days'].present?
+    end
+
+    def gateway
+      @gateway ||= XeroGateway::PrivateApp.new(ENV['XERO_CONSUMER_KEY'], ENV['XERO_CONSUMER_SECRET'], ENV['XERO_PRIVATE_KEY_PATH'])
+    end
+
+    def receive(incoming_events)
+      incoming_events.each do |event|
+        invoice = create_invoice(event)
+        create_event payload: { id: invoice.invoice_id }
+      end
+    end
+
+    def create_invoice(event)
+      interpolate_with(event.payload) do
+        invoice = gateway.build_invoice({
+          invoice_type: "ACCREC",
+          due_date: (interpolated['due_in_days'].presence || 14).to_i.days.from_now
+        })
+        invoice.contact.name = interpolated['contact_name'].presence
+        invoice.contact.phone.number = interpolated['contact_phone_number'].presence
+        invoice.contact.email = interpolated['contact_email'].presence
+        invoice.contact.address.line_1 = interpolated['contact_address_line_1'].presence
+        invoice.contact.address.line_2 = interpolated['contact_address_line_2'].presence
+        invoice.contact.address.city = interpolated['contact_address_city'].presence
+        invoice.contact.address.region = interpolated['contact_address_region'].presence
+        invoice.contact.address.country = interpolated['contact_address_country'].presence
+        invoice.contact.address.post_code = interpolated['contact_address_post_code'].presence
+
+        [Utils.value_at(event.payload, interpolated['item_path']) || {}].flatten.each do |item|
+          line_item = XeroGateway::LineItem.new(
+            :description => interpolated(item)['item_description'],
+            :account_code => interpolated(item)['item_account_code'].presence,
+            :unit_amount => interpolated(item)['item_amount']
+          )
+          invoice.line_items << line_item
+        end
+
+        invoice.create
+        invoice
+      end
+    end
+  end
+end

data/spec/xero_agent_spec.rb

@@ -0,0 +1,46 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+describe Agents::XeroAgent do
+  before(:each) do
+    @valid_options = Agents::XeroAgent.new.default_options
+    @checker = Agents::XeroAgent.new(:name => "XeroAgent", :options => @valid_options)
+    @checker.user = users(:bob)
+    @checker.save!
+  end
+
+  describe "validation" do
+    before do
+      expect(@checker).to be_valid
+    end
+
+    it "should validate integer nature of due_in_days" do
+      @checker.options[:due_in_days] = "a"
+      expect(@checker).not_to be_valid
+
+      @checker.options[:due_in_days] = "1.1"
+      expect(@checker).not_to be_valid
+
+      @checker.options[:due_in_days] = "1"
+      expect(@checker).to be_valid
+
+      @checker.options[:due_in_days] = 1
+      expect(@checker).to be_valid
+    end
+
+    it "should validate presence of expected_receive_period_in_days" do
+      @checker.options[:expected_receive_period_in_days] = nil
+      expect(@checker).not_to be_valid
+    end
+
+    it "should validate presence of item_description" do
+      @checker.options[:item_description] = nil
+      expect(@checker).not_to be_valid
+    end
+
+    it "should validate presence of item_amount" do
+      @checker.options[:item_amount] = nil
+      expect(@checker).not_to be_valid
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: huginn_xero_agent
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Andrew Cantino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: huginn_agent
+  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: xero_gateway
+  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: 
+email:
+- cantino@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/huginn_xero_agent.rb
+- lib/huginn_xero_agent/xero_agent.rb
+- spec/xero_agent_spec.rb
+homepage: https://github.com/cantino/huginn_xero_agent
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Huginn Agent for interfacing with Xero
+test_files:
+- spec/xero_agent_spec.rb