agaon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3cd3a70b7769e992af1b5991ff70847e7d57f33b
+  data.tar.gz: 007aa63bb9eb36a39c1a1848f5534bc456ba3dcd
+SHA512:
+  metadata.gz: ebb5d8bca78e05807ae09a36ff6b5eb65033bda17c949785d8e7086236a95326c0a475eae0f0e9a252ea73a97e831cbfc635e9854b4b4ae5a7fa521ddc23185e
+  data.tar.gz: 848800d468807a8b30f9ab3f00d8f8e261fbbbd1a3e1a48364841beb46cffb909ed2ff5e3f94b3158a73fc9b505dd82466b3d78cfe29de2e9aac85e688505a2a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in agaon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Espen Antonsen
+
+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,83 @@
+# Agaon
+
+Ruby API wrapper for Fiken. See https://fiken.no/api/doc/ for information about the API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'agaon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install agaon
+
+## Usage
+
+### Authentication
+
+```ruby
+fiken = Agaon::Client.new( username, password )
+```
+
+This will allow you to only list companies connected to your user account.
+
+To access data in each company you need to specify a company for the Agaon client.
+
+```ruby
+fiken = Agaon::Client.new( username, password, company_href )
+```
+
+### Endpoints
+
+#### Companies
+
+```ruby
+companies = fiken.companies
+```
+
+#### Sales, Contacts, Accounts, Invoices
+
+Using examples for the contacts endpoint.
+
+List:
+```ruby
+client.contacts
+```
+Get:
+```ruby
+client.get_contact(contact_href)
+```
+Create:
+```ruby
+client.contact(contact_attributes)
+```
+Update:
+```ruby
+client.contact(contact_href,contact_attributes)
+```
+
+#### Create Invoice, Document Sending Service, Create General Journal Entry Service, Search
+
+Using example for the create invoice endpoint.
+
+Action:
+```ruby
+client.create_invoice(invoice_attributes)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/espen/agaon.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+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/agaon.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'agaon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "agaon"
+  spec.version       = Agaon::VERSION
+  spec.authors       = ["Espen Antonsen"]
+  spec.email         = ["espen@inspired.no"]
+
+  spec.summary       = "Fiken API wrapper"
+  spec.homepage      = "https://github.com/espen/agaon"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency "hyperclient"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "dotenv"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "agaon"
+
+# 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/lib/agaon.rb

@@ -0,0 +1,4 @@
+require 'hyperclient'
+
+require 'agaon/version'
+require 'agaon/client'

data/lib/agaon/client.rb

@@ -0,0 +1,125 @@
+module Agaon
+  class Client
+    class Error < StandardError; end
+    class NotAuthenticated < Error; end
+    [:NotAuthenticated].each do |const|
+      Error.const_set(const, Agaon::Client.const_get(const))
+    end
+
+    API_BASE = 'https://fiken.no/api/v1'
+
+    attr_accessor :email, :password, :company_href
+
+    def initialize(email, password, company_href=nil)
+      @email = email
+      @password = password
+      @company_href = company_href
+    end
+
+    def who_am_i
+      url = API_BASE + '/whoAmI'
+
+      response = get(url)
+      response.to_hash
+    end
+
+    def current_company
+      get_company(@company_href)
+    end
+
+    def get_company(href)
+      response = get(href)
+      response.to_hash
+    end
+
+    [:companies, :accounts, :bank_accounts, :contacts, :products, :invoices, :sales].each do |method_name|
+      define_method method_name do |*args|
+        raise 'No company set' if method_name != :companies && !self.company_href
+        if method_name == :companies
+          base_url = API_BASE
+        else
+          base_url = self.company_href
+        end
+        url = base_url + '/' + method_name.to_s.tr('_'.freeze, '-'.freeze)
+        if method_name == :accounts
+          raise 'No year set' if args.length == 0
+          year = args.first.to_s
+          url += '/' + year
+        end
+
+        response = get(url)
+        response._embedded.first.last.collect{|c|c.to_hash.merge('href' => c._links['self'].to_s) }
+      end
+    end
+
+    [:account, :bank_account, :contact, :product, :invoice, :sale].each do |method_name|
+      define_method method_name do |*args|
+        url = self.company_href + '/' + method_name.to_s.tr('_'.freeze, '-'.freeze) + 's'
+        if method_name == :account
+          raise 'No year set' if args.length < 2
+          year = args.first.to_s
+          object = args.second
+          url += '/' + year
+        else
+          object = args.first
+        end
+
+        response = post(url,object)
+        response._response.headers[:location]
+      end
+
+      define_method "get_#{method_name}" do |href|
+        response = get(href)
+        response.to_hash
+      end
+
+      define_method "update_#{method_name}" do |href, object|
+        response = put(href,object)
+        response.to_s
+      end
+    end
+
+    [:create_invoice, :create_general_journal_entry, :document_sending].each do |method_name|
+      define_method method_name do |object|
+        endpoint = method_name.to_s.tr('_'.freeze, '-'.freeze) + '-service'
+        endpoint = 'createGeneralJournalEntriesService' if endpoint == 'create-general-journal-entry-service'
+        url = self.company_href + '/' + endpoint
+
+        response = post(url,object)
+        response._response.headers[:location]
+      end
+    end
+
+    def search(object)
+      endpoint = 'search'
+      url = self.company_href + '/' + endpoint
+
+      response = post(url,object)
+      response._embedded.first.last.collect{|c|c.to_hash.merge('href' => c._links['self'].to_s) }
+    end
+
+    private
+
+    [:get, :post, :put, :delete].each do |method_name|
+      define_method method_name do |url,object=nil|
+        api = Hyperclient.new(url) do |client|
+          client.basic_auth(self.email, self.password)
+        end
+        begin
+          if method_name == :get
+            api.send("_#{method_name}")
+          else
+            api.send("_#{method_name}", object)
+          end
+        rescue => e
+          if e.response[:status] == 401
+            raise Agaon::Client::Error::NotAuthenticated
+          else
+            raise "ERROR: #{e.response[:body]}"
+          end
+        end
+        api
+      end
+    end
+  end
+end

data/lib/agaon/version.rb

@@ -0,0 +1,3 @@
+module Agaon
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: agaon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Espen Antonsen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hyperclient
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- espen@inspired.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- agaon.gemspec
+- bin/console
+- bin/setup
+- lib/agaon.rb
+- lib/agaon/client.rb
+- lib/agaon/version.rb
+homepage: https://github.com/espen/agaon
+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.11
+signing_key: 
+specification_version: 4
+summary: Fiken API wrapper
+test_files: []