elmas 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ad5e2f6e04bc4bbb0d56e770fae4bd99ada5fca
+  data.tar.gz: 37bbce0d0945e16dbfd38ec787cb0280324b183e
+SHA512:
+  metadata.gz: 8019c2c6edbf2e50598dd5d671f9390e1cd5c89bcc923df4f62018598be77cdfddb1647082b6ff1695d3c5ff68b9cf4f3d135e5472c8c383641577890fcefa6d
+  data.tar.gz: f58ab43a5cb1884ec87acad7725dd3d10ce6bf900c9d68e0cff88c71581cde7d9d9eb6ba6a7c69e46ff341d62726d78b96b46db857e612432090051eac739f81

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+.env
+.log

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,52 @@
+Documentation:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+  Exclude:
+    - 'db/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - 'bin/**/*'
+    - 'log/**/*'
+    - 'spec/**/*'
+    - 'config/**/*'
+  RunRailsCops: true
+
+Metrics/AbcSize:
+  Max: 30
+Metrics/BlockNesting:
+  Max: 3
+Metrics/ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 100
+Metrics/CyclomaticComplexity:
+  Max: 6
+Metrics/LineLength:
+  Max: 150
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 13
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+Metrics/PerceivedComplexity:
+  Max: 7
+Style/PerlBackrefs:
+  Enabled: false
+Lint/AmbiguousOperator:
+  Enabled: false
+Rails/Delegate:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+cache: bundler

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard :rubocop, all_on_start: false, cli: ['--format', 'clang', '--rails'] do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})
+  watch('spec/spec_helper.rb')  
+end

data/README.md

@@ -0,0 +1,149 @@
+# Elmas
+
+Elmas means diamond, but in this case it's an API wrapper for [Exact Online](https://developers.exactonline.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elmas'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elmas
+
+## Usage
+
+You have to have an Exact Online account and an app setup to connect with.
+
+You have to set a few variables to make a connection possible. I'd suggest using environment variables set with [dotenv](https://github.com/bkeepers/dotenv) for that. (You can of course hardcode them, but that is not very secure :-) )
+
+
+Then configure Elmas like this
+
+```ruby
+Elmas.configure do |config|
+  config.client_id = ENV['CLIENT_ID']
+  config.client_secret = ENV['CLIENT_SECRET']
+  config.access_token = Elmas.authorize(ENV['EXACT_USER_NAME'], ENV['EXACT_PASSWORD']).access_token
+end
+
+#The client will now be authorized for 10 minutes,
+# if there are requests the time will be reset,
+# otherwise authorization should be called again.
+unless Elmas.authorized?
+  Elmas.configure do |config|
+    config.access_token = Elmas.authorize(ENV['EXACT_USER_NAME'], ENV['EXACT_PASSWORD']).access_token
+  end
+end
+```
+
+To find a contact
+
+```ruby
+contact = Elmas::Contact.new(id: "23445")
+contact.find
+# path = /crm/Contacts?$filter=ID eq guid'23445'
+```
+
+To find a contact with specific filters
+```ruby
+contact = Elmas::Contact.new(first_name: "Karel", id: "23")
+contact.find_by(filters: [:first_name])
+# path = /crm/Contacts?$filter=first_name eq 'Karel'
+```
+
+To find contacts with an order and a filter
+```ruby
+contact = Elmas::Contact.new(first_name: "Karel")
+contact.find_by(filters: [:first_name], order_by: :first_name)
+# path = /crm/Contacts?$order_by=first_name&$filter=first_name eq 'Karel'
+```
+
+To find contacts with an order, a filter and selecting relationships
+```ruby
+contact = Elmas::Contact.new(first_name: "Karel")
+contact.find_by(filters: [:first_name], order_by: :first_name, select: [:invoice])
+# path = /crm/Contacts?$select=invoice&$order_by=first_name&$filter=first_name eq 'Karel'
+```
+
+So with find_by you can combine Filters, Select and OrderBy. For more information on this way of selecting data look here http://www.odata.org/
+There's also a method find_all, which does a get without filters. You can however set the select and order by params.
+
+To find all contacts
+```ruby
+contact = Elmas::Contact.new
+contact.find_all
+# path = /crm/Contacts
+```
+
+To find all contacts and order by first_name
+```ruby
+contact = Elmas::Contact.new
+contact.find_all(order_by: :first_name)
+# path = /crm/Contacts?$order_by=first_name
+```
+
+To find all contacts and select invoices and items
+```ruby
+contact = Elmas::Contact.new
+contact.find_all(select: [:invoice, :item])
+# path = /crm/Contacts?$select=invoice,item
+```
+
+To create a new contact
+
+```ruby
+contact = Elmas::Contact.new(first_name: "Karel", last_name: "Appel", id: "2378712")
+contact.save
+```
+
+###Divisions and Endpoints
+
+Usually in the exact wrapper you need a division number, this one will be set on authorization checks (with `/Current/Me` endpoint). Sometimes you need to do a request without the division number, or even without the standard `/api/v1` endpoint. Like so:
+
+```ruby
+response = Elmas.get('/api/oauth2/token', no_endpoint: true, no_division: true)
+response = Elmas.get('/Current/Me', no_division: true)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/elmas/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Testing
+
+We use Rspec for normal unit testing. We aim for coverage above 90%. Also the current suite should succeed when you commit something.
+We use Rubocop for style checking, this should also succeed before you commit anything.
+
+We're also experimenting with Mutation testing, which alters your code to test if your specs fail when there's faulty code. This is important when you
+alter a vital part of the code, make sure the mutation percentage is higher than 80%. To run a part of the code with mutant run the follwing
+`mutant --include lib/elmas --require elmas --use rspec Elmas::ClassYoureWorkingOn`
+
+To test the vital classes run this
+`mutant --include lib --require elmas --use rspec Elmas::Response Elmas::Client Elmas::Utils Elmas::Resource Elmas::Request Elmas::Parser Elmas::Config`
+This will take a few minutes
+
+When you're editing code it's advised you run guard, which watches file changes and automatically runs Rspec and Rubocop.
+
+## Hoppinger
+
+This gem was created by [Hoppinger](http://www.hoppinger.com)
+
+[![forthebadge](http://forthebadge.com/images/badges/built-with-ruby.svg)](http://www.hoppinger.com)

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+task :rubocop do
+  sh "rubocop"
+end
+
+task :rspec do
+  sh "rspec"
+end
+
+task default: [:rubocop, :rspec]

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "elmas"
+
+# 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"
+require "dotenv"
+Dotenv.load
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/elmas.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elmas/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elmas"
+  spec.authors       = ["Marthyn"]
+  spec.email         = ["MarthynOlthof@hoppinger.nl"]
+
+  spec.summary       = %q{API wrapper for Exact Online}
+  spec.homepage      = "https://www.hoppinger.com"
+  spec.licenses      = %w(MIT)
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.require_paths = %w(lib)
+  spec.version       = Elmas::Version.to_s
+
+  spec.add_dependency "faraday", [">= 0.8", "< 0.10"]
+  spec.add_dependency "mechanize", "2.6.0"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency("rspec", "~> 3.0")
+  spec.add_development_dependency("simplecov")
+  spec.add_development_dependency("simplecov-rcov")
+  spec.add_development_dependency("webmock", "~> 1.6")
+  spec.add_development_dependency("rubycritic", "~> 1.4.0")
+  spec.add_development_dependency("guard-rspec")
+  spec.add_development_dependency("guard-rubocop")
+  spec.add_development_dependency("mutant-rspec")
+  spec.add_development_dependency("dotenv")
+end

data/jenkins.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+export RAILS_ENV=test
+export COVERAGE=true
+
+bundle install
+
+if [[ -d coverage ]]; then
+  echo "Removing old coverage report"
+  rm -r coverage
+fi
+
+echo "--- Check style"
+
+rubocop
+
+if [[ $? -ne 0 ]]; then
+  echo "--- Style checks failed."
+  exit 1
+fi
+
+echo "--- Doing a static analysis"
+
+rubycritic app lib config
+
+echo "--- Running RSpec"
+
+rspec --color spec --format progress --format html --out rspec.html
+rspec=$?
+
+if [[ $rspec -ne 0 ]]; then
+  echo "--- Some tests have failed."
+  exit 1
+fi

data/lib/elmas.rb

@@ -0,0 +1,33 @@
+require "elmas/version"
+require "elmas/api"
+require "elmas/config"
+require "elmas/response"
+require "elmas/client"
+require "elmas/log"
+require "elmas/resource"
+require "elmas/resources/contact"
+require "elmas/resources/invoice"
+require "elmas/resources/journal"
+require "elmas/resources/item"
+require "elmas/resources/invoice_line"
+require "elmas/resources/account"
+
+module Elmas
+  extend Config
+  extend Log
+
+  def self.client(options = {})
+    Elmas::Client.new(options)
+  end
+
+  # Delegate to Elmas::Client
+  def self.method_missing(method, *args, &block)
+    super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Elmas::Client
+  def self.respond_to?(method, include_all = false)
+    client.respond_to?(method, include_all) || super
+  end
+end

data/lib/elmas/api.rb

@@ -0,0 +1,30 @@
+require File.expand_path("../request", __FILE__)
+require File.expand_path("../config", __FILE__)
+require File.expand_path("../oauth", __FILE__)
+
+module Elmas
+  # @private
+  class API
+    # @private
+    attr_accessor *(Config::VALID_OPTIONS_KEYS)
+
+    # Creates a new API
+    def initialize(options = {})
+      options = Elmas.options.merge(options)
+      Config::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Config::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    include Request
+    include OAuth
+  end
+end

data/lib/elmas/client.rb

@@ -0,0 +1,11 @@
+require "faraday"
+
+module Elmas
+  class Client < API
+    def connection
+      Faraday.new do |faraday|
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/elmas/config.rb

@@ -0,0 +1,96 @@
+require "faraday"
+
+module Elmas
+  module Config
+    # An array of valid keys in the options hash
+    VALID_OPTIONS_KEYS = [
+      :access_token,
+      :adapter,
+      :client_id,
+      :client_secret,
+      :connection_options,
+      :redirect_uri,
+      :response_format,
+      :user_agent,
+      :endpoint,
+      :division,
+      :base_url,
+      :refresh_token
+    ].freeze
+
+    # By default, don't set a user access token
+    DEFAULT_ACCESS_TOKEN = ""
+
+    DEFAULT_REFRESH_TOKEN = ""
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, client id should be set in .env
+    DEFAULT_CLIENT_ID = ""
+
+    # By default, client secret should be set in .env
+    DEFAULT_CLIENT_SECRET = ""
+
+    # By default, don't set any connection options
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+    DEFAULT_BASE_URL = "https://start.exactonline.nl"
+
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_ENDPOINT = "api/v1".freeze
+
+    # the division code you want to connect with
+    DEFAULT_DIVISION =  "797636"
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    DEFAULT_FORMAT = :json
+
+    DEFAULT_REDIRECT_URI = "https://www.getpostman.com/oauth2/callback"
+
+    # By default, don't set user agent
+    DEFAULT_USER_AGENT = nil
+
+    # An array of valid request/response formats
+    VALID_FORMATS = [:json].freeze
+
+    # @private
+    attr_accessor *(VALID_OPTIONS_KEYS)
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.access_token       = DEFAULT_ACCESS_TOKEN
+      self.adapter            = DEFAULT_ADAPTER
+      self.client_id          = DEFAULT_CLIENT_ID
+      self.client_secret      = DEFAULT_CLIENT_SECRET
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.redirect_uri       = DEFAULT_REDIRECT_URI
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.division           = DEFAULT_DIVISION
+      self.base_url           = DEFAULT_BASE_URL
+      self.response_format    = DEFAULT_FORMAT
+      self.user_agent         = DEFAULT_USER_AGENT
+      self.refresh_token      = DEFAULT_REFRESH_TOKEN
+    end
+  end
+end