saasu2 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef4f91281902664f17b2c52ee2871df934c51d42
+  data.tar.gz: 43f634972cb7b6b9645d908e2961bf6c311c4f27
+SHA512:
+  metadata.gz: 25149c64b15e36ca720edd0fb41f238fcdad0d97eb8ec6760b59016ab952a72c2398f30c472fff8e21a97ec7860f7f1b5f2d1a0de66d8d1cccf86e099db2af62
+  data.tar.gz: 9c6bda2d041394d1a57e92407ae9f3f20e8558d8c89e42296cd77fc43e49e75a2f6d55ccaa7910fea15c77c3b00267464a94e0e0463ed7690f6937de4670eda9

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Saasu
+
+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,30 @@
+## Ruby Software Development Kit for Saasu API
+This repository is a version of the Saasu software development kit in the Ruby language, for working with the Saasu API.
+For help on the API itself, you can look at the [help documentation](https://api.saasu.com/).
+
+[![Gem Version](https://badge.fury.io/rb/saasu2.svg)](http://badge.fury.io/rb/saasu2)
+[![Build Status](https://travis-ci.org/nsinenko/saasu-rails.svg?branch=master)](https://travis-ci.org/nsinenko/saasu-rails)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'saasu2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install saasu2
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/saasu2/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

data/Rakefile

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

data/bin/console

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

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/lib/saasu/account.rb

@@ -0,0 +1,4 @@
+class Saasu::Account < Saasu::Base
+  allowed_methods :show, :index, :destroy, :update, :create
+  filter_by %W(IsActive IsBankAccount AccountType IncludeBuiltIn)
+end

data/lib/saasu/auth.rb

@@ -0,0 +1,59 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Saasu
+  module Auth
+    extend self
+
+    def authenticate
+      Saasu::Client.connection.authorization :Bearer, token
+    end
+
+    private
+    def token_expired?
+      @token_expiry ||= Date.yesterday
+      @token_expiry < DateTime.now
+    end
+
+    def token
+      if @access_token && !token_expired?
+        @access_token
+      elsif @access_token && token_expired?
+        refresh_access_token
+      else
+        get_access_token
+      end
+    end
+
+    def refresh_access_token
+      result = Saasu::Client.connection.post('authorisation/refresh') do |request|
+        request.body = { grant_type: 'refresh_token', refresh_token: @refresh_token }.to_json
+      end
+
+      unless result.status == 200
+        raise "Failed to authenicate Saasu API. Please check your username and password."
+      end
+
+      @access_token = result.body['access_token']
+      @token_expiry = DateTime.now + (result.body['expires_in']).to_i.seconds
+
+      @access_token
+    end
+
+    def get_access_token
+      result = Saasu::Client.connection.post('authorisation/token') do |request|
+        request.body = { grant_type: 'password', scope: 'full', username: Saasu::Config.username, password: Saasu::Config.password }.to_json
+      end
+
+      unless result.status == 200
+        raise "Failed to authenicate Saasu API. Please check your username and password."
+      end
+
+      @access_token = result.body['access_token']
+      @refresh_token = result.body['refresh_token']
+      @token_expiry = DateTime.now + (result.body['expires_in']).to_i.seconds
+
+      @access_token
+    end
+  end
+end

data/lib/saasu/base.rb

@@ -0,0 +1,144 @@
+module Saasu
+  class Base
+    def initialize(params = {})
+      @attributes = params.deep_stringify_keys
+    end
+
+    def self.all
+      validate_method_is_implemented_in_saasu_api(:index)
+
+      Saasu::Client.request(:get, resource_url.pluralize).values.first.map do |record|
+        self.new(record)
+      end
+    end
+
+    def self.find(id)
+      validate_method_is_implemented_in_saasu_api(:show)
+
+      response = Saasu::Client.request(:get, resource_url(id))
+
+      if response.present?
+        self.new(response)
+      else
+        response.body
+      end
+    end
+
+    def self.where(params)
+      validate_method_is_implemented_in_saasu_api(:index)
+      validate_filters(params)
+
+      Saasu::Client.request(:get, resource_url.pluralize, params).values.first.map do |record|
+        self.new(record)
+      end
+    end
+
+    def delete
+      validate_method_is_implemented_in_saasu_api(:destroy)
+
+      if Saasu::Client.request(:delete, self.class.resource_url(id))["StatusMessage"] == "Ok"
+        self['Id'] = nil
+        true
+      else
+        false
+      end
+    end
+
+    def self.delete(id)
+      validate_method_is_implemented_in_saasu_api(:destroy)
+
+      Saasu::Client.request(:delete, resource_url(id))
+    end
+
+    def save
+      if self.id.present?
+        validate_method_is_implemented_in_saasu_api(:update)
+        Saasu::Client.request(:put, self.class.resource_url(id), @attributes)
+      else
+        validate_method_is_implemented_in_saasu_api(:create)
+        self['Id'] = Saasu::Client.request(:post, self.class.resource_url, @attributes).values.first
+      end
+
+      @attributes = Saasu::Client.request(:get, self.class.resource_url(id))
+      true
+    end
+
+    def update(params)
+      validate_method_is_implemented_in_saasu_api(:update)
+
+      params.each do |key, value|
+        self[key] = value
+      end
+
+      save
+    end
+
+    def self.create(params)
+      validate_method_is_implemented_in_saasu_api(:create)
+
+      id = Saasu::Client.request(:post, resource_url, params).values.first
+      new(Saasu::Client.request(:get, resource_url(id)))
+    end
+
+    def validate_method_is_implemented_in_saasu_api(method_name)
+      self.class.validate_method_is_implemented_in_saasu_api(method_name)
+    end
+
+    def self.validate_method_is_implemented_in_saasu_api(method_name)
+      raise "This method is not currently supported by Saasu API" unless @api_methods.include?(method_name)
+    end
+
+    def [](key)
+      @attributes[key.to_s]
+    end
+
+    def []=(key, value)
+      @attributes[key.to_s] = value
+    end
+
+    def method_missing meth, *args, &cb
+      if meth.in?(getter_methods)
+        @attributes[meth.to_s.classify]
+      elsif meth.in?(setter_methods)
+        @attributes[meth.to_s.gsub('=','').classify] = args.flatten.compact.first
+      else
+        super meth, *args, &cb
+      end
+    end
+
+    def to_s
+      "#{self.class.name.demodulize} ##{self.id}"
+    end
+
+    def id
+      @attributes['Id']
+    end
+
+    protected
+    def getter_methods
+      @attributes.keys.map { |k| k.underscore.to_sym }
+    end
+
+    def setter_methods
+      @attributes.keys.map { |k| "#{k.underscore}=".to_sym }
+    end
+
+    def self.allowed_methods(*params)
+      @api_methods = params
+    end
+
+    def self.filter_by(params)
+      @filters = params
+    end
+
+    def self.resource_url(id = nil)
+      [name.demodulize.downcase, id].compact.join('/')
+    end
+
+    def self.validate_filters(params)
+      params.keys.each do |key|
+        raise "Filter not supported by Saasu API: #{key}. Supported filters: #{@filters.join(", ")}" unless key.to_s.in?(@filters)
+      end
+    end
+  end
+end

data/lib/saasu/client.rb

@@ -0,0 +1,47 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Saasu
+  class Client
+    class_attribute :connection
+
+    class << self
+      def request(method, url, params = {})
+        Saasu::Auth.authenticate
+        request_url = url + "?FileId=#{Saasu::Config.file_id}"
+        response = connection.send(method, request_url, params)
+
+        if response.status == 200
+          response.body
+        elsif response.status == 404
+          raise "Resource not found."
+        else
+          raise "Server did not return a valid response. Response status: #{response.status}. Response body: #{response.body}"
+        end
+      end
+
+      def connection
+        @@connection ||= initialize_connection
+      end
+
+      private
+      def initialize_connection
+        con = Faraday.new(url: api_url) do |c|
+          c.request :json
+
+          c.response :json, :content_type => /\bjson$/
+
+          c.use :instrumentation
+          c.adapter  Faraday.default_adapter
+        end
+
+        con.headers['X-Api-Version'] = '1.0'
+        con
+      end
+
+      def api_url
+        Saasu::Config.api_url || 'https://api.saasu.com/'
+      end
+    end
+  end
+end

data/lib/saasu/company.rb

@@ -0,0 +1,4 @@
+class Saasu::Company < Saasu::Base
+  allowed_methods :show, :index, :destroy, :update, :create
+  filter_by %W(LastModifiedFromDate LastModifiedToDate CompanyName=)
+end

data/lib/saasu/config.rb

@@ -0,0 +1,11 @@
+module Saasu
+  class Config
+    class_attribute :username, :password, :file_id, :api_url
+
+    class << self
+      def configure
+        yield self
+      end
+    end
+  end
+end

data/lib/saasu/contact.rb

@@ -0,0 +1,4 @@
+class Saasu::Contact < Saasu::Base
+  allowed_methods :show, :index, :destroy, :update, :create
+  filter_by %W(LastModifiedFromDate LastModifiedToDate GivenName FamilyName IsActive IsCustomer IsSupplier IsContractor IsPartner Tags TagSelection Email ContactId)
+end

data/lib/saasu/invoice.rb

@@ -0,0 +1,4 @@
+class Saasu::Invoice < Saasu::Base
+  allowed_methods :show, :index, :destroy, :update, :create
+  filter_by %W(InvoiceNumber LastModifiedFromDate LastModifiedToDate TransactionType Tags TagSelection InvoiceFromDate InvoiceToDate InvoiceStatus PaymentStatus ContactId)
+end

data/lib/saasu/invoice_attachment.rb

@@ -0,0 +1,3 @@
+class Saasu::InvoiceAttachment < Saasu::Base
+  allowed_methods :show, :destroy, :update, :create
+end

data/lib/saasu/item.rb

@@ -0,0 +1,4 @@
+class Saasu::Item < Saasu::Base
+  allowed_methods :show, :index
+  filter_by %W(ItemType SearchMethod SearchText)
+end

data/lib/saasu/payment.rb

@@ -0,0 +1,4 @@
+class Saasu::Payment < Saasu::Base
+  allowed_methods :show, :index, :destroy, :update, :create
+  filter_by %W(LastModifiedFromDate LastModifiedToDate ForInvoiceId ClearedFromDate ClearedToDate TransactionType PaymentFromDate PaymentToDate PaymentAccountId)
+end

data/lib/saasu/tax_code.rb

@@ -0,0 +1,4 @@
+class Saasu::TaxCode < Saasu::Base
+  allowed_methods :show, :index
+  filter_by %W(IsActive)
+end

data/lib/saasu/version.rb

@@ -0,0 +1,3 @@
+module Saasu
+  VERSION = "0.1.0.pre"
+end

data/lib/saasu.rb

@@ -0,0 +1,16 @@
+require "saasu/version"
+require "saasu/client"
+require "saasu/base"
+require "saasu/contact"
+require "saasu/invoice_attachment"
+require "saasu/item"
+require "saasu/invoice"
+require "saasu/company"
+require "saasu/payment"
+require "saasu/account"
+require "saasu/tax_code"
+require "saasu/config"
+require "saasu/auth"
+
+module Saasu
+end

data/saasu2.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'saasu/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "saasu2"
+  spec.version       = Saasu::VERSION
+  spec.authors       = ["Nick Sinenko"]
+  spec.email         = ["nick.sinenko@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper for Saasu API.}
+  spec.homepage      = "https://api.saasu.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 1.9.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'byebug', '3.2.0'
+  spec.add_development_dependency 'pry-rails'
+  spec.add_development_dependency 'awesome_print'
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "webmock"
+  spec.add_dependency 'activesupport'
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: saasu2
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Nick Sinenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  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: 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: faraday
+  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: faraday_middleware
+  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: webmock
+  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: activesupport
+  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:
+- nick.sinenko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/saasu.rb
+- lib/saasu/account.rb
+- lib/saasu/auth.rb
+- lib/saasu/base.rb
+- lib/saasu/client.rb
+- lib/saasu/company.rb
+- lib/saasu/config.rb
+- lib/saasu/contact.rb
+- lib/saasu/invoice.rb
+- lib/saasu/invoice_attachment.rb
+- lib/saasu/item.rb
+- lib/saasu/payment.rb
+- lib/saasu/tax_code.rb
+- lib/saasu/version.rb
+- saasu2.gemspec
+homepage: https://api.saasu.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Saasu API.
+test_files: []
+has_rdoc: