billomat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40a474e94aa0c704209fa2ebd99a4981730be955
+  data.tar.gz: efc188086b6124410a52c6d6796541a38fddb7af
+SHA512:
+  metadata.gz: 11510e2136f9f04d213b44459bb9459628c67e38d5a469b9491300ad4f68faef00f8bad55817eb4e88048f4f167aa745607062c41ac15debfeaba631cb477c08
+  data.tar.gz: cbf6cbb1066541439b77030703b2a5085f0975dbdf7a089ca46e5c0dd2ad8fb4fec789d5091af2a8b77543fa95658176a95cb82ccc41de2533a6e7bad99b0102

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+billomat*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 HAUSGOLD | talocasa GmbH
+
+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,63 @@
+# Billomat
+[![Build Status](https://travis-ci.org/hausgold/billomat.svg?branch=master)](https://travis-ci.org/hausgold/billomat)
+
+This gem provides a Ruby API for [billomat.com](https://billomat.com) - an online accounting service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'billomat'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install billomat
+
+## Usage
+
+### Configuration
+
+The configuration takes two settings: `api_key` and `subdomain`. The latter is e.g. the name of your organization.
+
+```
+Billomat.configure do |config|
+  config.subdomain = 'your-company'
+  config.api_key   = 'a3b148a61cb642389b4f9953f6233f20'
+end
+```
+
+### Basic usage
+
+Currently there is basic support for the models `Invoice`, `Client`, `InvoicePayment`, `InvoiceItem`
+
+```
+Billomat::Models::Invoice.where(invoice_number: 'RE1234')
+=> [#<Billomat::Models::Invoice:0x005574b58d6510 ...]
+
+Billomat::Models::Invoice.find('1234')
+=> #<Billomat::Models::Invoice:0x005574b58d6510
+
+client = Billomat::Models::Client.find('1234')
+client.save
+=> true
+
+client.delete
+=> true
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hausgold/billomat.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/billomat.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "billomat/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "billomat"
+  spec.version       = Billomat::VERSION
+  spec.licenses      = ['MIT']
+  spec.authors       = ["Henning Vogt"]
+  spec.email         = ["henning.vogt@hausgold.de"]
+
+  spec.summary       = %q{Wrapper for the Billomat API}
+  spec.homepage      = "https://github.com/hausgold/billomat"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rest-client', '~> 2.0', '>= 2.0.2'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.15"
+end

data/bin/console

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Billomat
+  module Actions
+    class Cancel
+      def initialize(invoice_id)
+        @invoice_id = invoice_id
+      end
+
+      def call
+        Billomat::Gateway.new(:put, path).run
+
+        true
+      end
+
+      def path
+        "/invoices/#{@invoice_id}/cancel"
+      end
+    end
+  end
+end

data/lib/billomat/actions/complete.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Billomat
+  module Actions
+    class Complete
+      def initialize(invoice_id, opts = {})
+        @invoice_id = invoice_id
+        @opts = opts
+      end
+
+      def call
+        Billomat::Gateway.new(:put, path, wrapped_data).run
+
+        true
+      end
+
+      def wrapped_data
+        { complete: @opts }
+      end
+
+      def path
+        "/invoices/#{@invoice_id}/complete"
+      end
+    end
+  end
+end

data/lib/billomat/actions/email.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# This actions sends an invoice email
+# Recipients must be passed like this:
+# { recipients: { to: 'bob@example.org' } }
+
+module Billomat
+  module Actions
+    class Email
+      def initialize(invoice_id, opts = {})
+        @invoice_id = invoice_id
+        @opts = opts
+      end
+
+      def call
+        Billomat::Gateway.new(:post, path, wrapped_data).run
+
+        true
+      end
+
+      def wrapped_data
+        { email: @opts }
+      end
+
+      def path
+        "/invoices/#{@invoice_id}/email"
+      end
+    end
+  end
+end

data/lib/billomat/actions/pdf.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Billomat
+  module Actions
+    class Pdf
+      def initialize(invoice_id, opts = {})
+        @invoice_id = invoice_id
+        @opts = opts
+      end
+
+      def call
+        resp = Billomat::Gateway.new(:get, path).run
+        resp['pdf']
+      end
+
+      def path
+        "/invoices/#{@invoice_id}/pdf"
+      end
+    end
+  end
+end

data/lib/billomat/actions/uncancel.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Billomat
+  module Actions
+    class Uncancel
+      def initialize(invoice_id)
+        @invoice_id = invoice_id
+      end
+
+      def call
+        Billomat::Gateway.new(:put, path).run
+
+        true
+      end
+
+      def path
+        "/invoices/#{@invoice_id}/uncancel"
+      end
+    end
+  end
+end

data/lib/billomat/actions.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'billomat/actions/complete'
+require 'billomat/actions/email'
+require 'billomat/actions/pdf'
+require 'billomat/actions/cancel'
+require 'billomat/actions/uncancel'
+
+module Billomat
+  module Actions; end
+end

data/lib/billomat/configuration.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Billomat
+  class Configuration
+    attr_accessor :api_key, :subdomain
+  end
+end

data/lib/billomat/gateway.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+require 'json'
+
+module Billomat
+  class GatewayError < StandardError; end
+
+  class Gateway
+    attr_reader :method, :path, :body
+
+    def initialize(method, path, body = {})
+      @method   = method.to_sym
+      @path     = path
+      @body     = body
+    end
+
+    def run
+      resp = RestClient::Request.execute(
+        method:   method,
+        url:      url,
+        timeout:  timeout,
+        headers:  headers,
+        payload:  body.to_json
+      )
+
+      raise GatewayError, resp.body if resp.code > 299
+      return nil if resp.body.empty?
+
+      JSON.parse(resp.body)
+    end
+
+    def url
+      "https://#{config.subdomain}.billomat.net/api#{path}"
+    end
+
+    def timeout
+      5
+    end
+
+    def headers
+      {
+        'Accept'           => 'application/json',
+        'Content-Type'     => 'application/json',
+        'X-BillomatApiKey' => config.api_key
+      }
+    end
+
+    def config
+      Billomat.configuration
+    end
+  end
+end

data/lib/billomat/models/base.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+module Billomat
+  module Models
+    class Base
+      attr_accessor :data
+
+      def self.find(id)
+        return nil if id.nil?
+        resp = Billomat::Gateway.new(:get, "#{base_path}/#{id}").run
+        new(resp[resource_name])
+      end
+
+      def self.where(hash = {})
+        Billomat::Search.new(self, hash).run
+      end
+
+      def initialize(data = {})
+        @data = OpenStruct.new(data)
+      end
+
+      def save
+        return create if id.blank?
+        update
+      end
+
+      def create
+        resp = Billomat::Gateway.new(
+          :post, self.class.base_path, wrapped_data
+        ).run
+
+        @data = OpenStruct.new(resp[self.class.resource_name])
+
+        true
+      end
+
+      def update
+        path = "#{self.class.base_path}/#{id}"
+        resp = Billomat::Gateway.new(:put, path, wrapped_data).run
+        @data = resp[self.class.resource_name]
+
+        true
+      end
+
+      def delete
+        path = "#{self.class.base_path}/#{id}"
+        Billomat::Gateway.new(:delete, path).run
+
+        true
+      end
+
+      def id
+        @data['id'] || nil
+      end
+
+      def wrapped_data
+        { self.class.resource_name => @data.to_h }
+      end
+
+      def method_missing(method, *args, &block)
+        return @data[method] if @data.to_h.keys.include?(method)
+        super
+      end
+
+      def respond_to_missing?(method, include_privat = false)
+        @data.to_h.keys.include?(method.to_s) || super
+      end
+    end
+  end
+end

data/lib/billomat/models/client.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Billomat
+  module Models
+    class Client < Base
+      def self.base_path
+        '/clients'
+      end
+
+      def self.resource_name
+        'client'
+      end
+    end
+  end
+end

data/lib/billomat/models/invoice.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Billomat
+  module Models
+    class Invoice < Base
+      def self.base_path
+        '/invoices'
+      end
+
+      def self.resource_name
+        'invoice'
+      end
+
+      def complete!
+        Billomat::Actions::Complete.new(id).call
+      end
+
+      def cancel!
+        Billomat::Actions::Cancel.new(id).call
+      end
+
+      def send_email(recipient)
+        email_params = { recipients: { to: recipient } }
+
+        Billomat::Actions::Email.new(id, email_params).call
+      end
+
+      def to_pdf
+        Billomat::Actions::Pdf.new(id).call
+      end
+    end
+  end
+end

data/lib/billomat/models/invoice_item.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Billomat
+  module Models
+    class InvoiceItem < Base
+      def self.base_path
+        '/invoice-items'
+      end
+
+      def self.resource_name
+        'invoice-item'
+      end
+    end
+  end
+end

data/lib/billomat/models/invoice_payment.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Billomat
+  module Models
+    class InvoicePayment < Base
+      def self.base_path
+        '/invoice-payments'
+      end
+
+      def self.resource_name
+        'invoice-payment'
+      end
+    end
+  end
+end

data/lib/billomat/models.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'billomat/models/base'
+require 'billomat/models/client'
+require 'billomat/models/invoice'
+require 'billomat/models/invoice_item'
+require 'billomat/models/invoice_payment'
+
+module Billomat
+  module Models; end
+end

data/lib/billomat/search.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module Billomat
+  class Search
+    def initialize(resource, hash)
+      @resource = resource
+      @hash     = hash
+    end
+
+    def path
+      "#{@resource.base_path}?#{hash_to_query}"
+    end
+
+    def run
+      return [] if @hash.compact.empty?
+      to_array(Billomat::Gateway.new(:get, path).run)
+    end
+
+    def to_array(resp)
+      case count(resp)
+      when 0
+        []
+      when 1
+        # Necessary due to strange API behaviour
+        [@resource.new(resp["#{name}s"][name])]
+      else
+        resp["#{name}s"][name].map do |c|
+          @resource.new(c)
+        end
+      end
+    end
+
+    def name
+      @resource.resource_name
+    end
+
+    def count(resp)
+      return 0 if resp.nil?
+      resp["#{name}s"]['@total'].to_i
+    end
+
+    private
+
+    def hash_to_query
+      URI.encode_www_form(@hash)
+    end
+  end
+end

data/lib/billomat/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Billomat
+  VERSION = "0.1.0"
+end

data/lib/billomat.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'billomat/version'
+require 'billomat/configuration'
+require 'billomat/models'
+require 'billomat/actions'
+require 'billomat/search'
+require 'billomat/gateway'
+
+module Billomat
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Billomat::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: billomat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henning Vogt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: 
+email:
+- henning.vogt@hausgold.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- billomat.gemspec
+- bin/console
+- bin/setup
+- lib/billomat.rb
+- lib/billomat/actions.rb
+- lib/billomat/actions/cancel.rb
+- lib/billomat/actions/complete.rb
+- lib/billomat/actions/email.rb
+- lib/billomat/actions/pdf.rb
+- lib/billomat/actions/uncancel.rb
+- lib/billomat/configuration.rb
+- lib/billomat/gateway.rb
+- lib/billomat/models.rb
+- lib/billomat/models/base.rb
+- lib/billomat/models/client.rb
+- lib/billomat/models/invoice.rb
+- lib/billomat/models/invoice_item.rb
+- lib/billomat/models/invoice_payment.rb
+- lib/billomat/search.rb
+- lib/billomat/version.rb
+homepage: https://github.com/hausgold/billomat
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Wrapper for the Billomat API
+test_files: []