frilans_finans_api 0.1.0 → 0.2.0

data/fixtures/tax_fixture.json

@@ -0,0 +1,13 @@
+{
+  "data": {
+    "type": "taxes",
+    "id": "1",
+    "attributes": {
+      "standard": 0,
+      "percent": 0
+    },
+    "links": {
+      "self": "https://frilansfinans.se/api/tax/1"
+    }
+  }
+}

data/fixtures/taxes_fixture.json

@@ -0,0 +1,59 @@
+{
+  "data": [
+    {
+      "type": "taxes",
+      "id": "0",
+      "attributes": {
+        "standard": 0,
+        "percent": 0
+      },
+      "links": {
+        "self": "https://frilansfinans.se/api/tax/0"
+      }
+    },
+    {
+      "type": "taxes",
+      "id": "1",
+      "attributes": {
+        "standard": 0,
+        "percent": 6
+      },
+      "links": {
+        "self": "https://frilansfinans.se/api/tax/1"
+      }
+    },
+    {
+      "type": "taxes",
+      "id": "2",
+      "attributes": {
+        "standard": 0,
+        "percent": 12
+      },
+      "links": {
+        "self": "https://frilansfinans.se/api/tax/2"
+      }
+    },
+    {
+      "type": "taxes",
+      "id": "3",
+      "attributes": {
+        "standard": 1,
+        "percent": 25
+      },
+      "links": {
+        "self": "https://frilansfinans.se/api/tax/3"
+      }
+    }
+  ],
+  "meta": {
+    "pagination": {
+      "page": {
+        "size": 25,
+        "number": 1,
+        "items": 25
+      },
+      "items": 4,
+      "pages": 1
+    }
+  }
+}

data/fixtures/user_fixture.json

@@ -0,0 +1,30 @@
+{
+  "data": {
+    "type": "users",
+    "id": "1",
+    "attributes": {
+      "first_name": "Jacob",
+      "last_name": "Burenstam",
+      "social_security_number": null,
+      "account_clearing_number": null,
+      "account_number": null,
+      "user_status_id": null,
+      "profession_title": null,
+      "user_id_owner": null,
+      "created_at": {
+        "date": "2016-04-25 19:16:00.000000",
+        "timezone_type": 3,
+        "timezone": "UTC"
+      },
+      "verify_password": null,
+      "default_taxkey_id": null,
+      "show_reg_invoice_page": null,
+      "company_name": null,
+      "api_consumer_id": null,
+      "last_login": null
+    },
+    "links": {
+      "self": "https://frilansfinans.se/api/user/2"
+    }
+  }
+}

data/fixtures/user_post_body_fixture.json

@@ -0,0 +1,9 @@
+{
+    "access_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+    "data": {
+        "attributes": {
+          "first_name": "Jacob",
+          "last_name": "Burenstam"
+        }
+    }
+}

data/fixtures/user_post_fixture.json

@@ -0,0 +1,30 @@
+{
+  "data": {
+    "type": "users",
+    "id": "1",
+    "attributes": {
+      "first_name": "Jacob",
+      "last_name": "Burenstam",
+      "social_security_number": null,
+      "account_clearing_number": null,
+      "account_number": null,
+      "user_status_id": null,
+      "profession_title": null,
+      "user_id_owner": null,
+      "created_at": {
+        "date": "2016-04-25 19:16:00.000000",
+        "timezone_type": 3,
+        "timezone": "UTC"
+      },
+      "verify_password": null,
+      "default_taxkey_id": null,
+      "show_reg_invoice_page": null,
+      "company_name": null,
+      "api_consumer_id": null,
+      "last_login": null
+    },
+    "links": {
+      "self": "https://frilansfinans.se/api/user/1"
+    }
+  }
+}

data/fixtures/users_fixture.json

@@ -0,0 +1,56 @@
+{
+  "data": [
+    {
+      "type": "users",
+      "id": "1",
+      "attributes": {
+        "email": "account@example.com",
+        "co": "",
+        "street": "Dag Hammarskjölds väg 13",
+        "zip": "752 37",
+        "city": "UPPSALA",
+        "country": "SWEDEN",
+        "telephone": "",
+        "cellphone": "0771151000",
+        "autogen": 0,
+        "role": "normal",
+        "foreclosure": 0,
+        "bankgiro": null,
+        "postgiro": null,
+        "first_name": "Firstname",
+        "last_name": "Lastname",
+        "social_security_number": 7405280269,
+        "account_clearing_number": "4569-80",
+        "account_number": "401.062.424-2",
+        "user_status_id": 1,
+        "profession_title": "Grafisk formgivare",
+        "user_id_owner": 0,
+        "created_at": {
+          "date": "2016-04-05 12:21:38.000000",
+          "timezone_type": 3,
+          "timezone": "UTC"
+        },
+        "verify_password": "",
+        "default_taxkey_id": 1,
+        "show_reg_invoice_page": 1,
+        "company_name": "",
+        "api_consumer_id": null,
+        "last_login": "2016-04-05 12:21:38"
+      },
+      "links": {
+        "self": "https://frilansfinans.se/api/user/1"
+      }
+    }
+  ],
+  "meta": {
+    "pagination": {
+      "page": {
+        "size": 25,
+        "number": 1,
+        "items": 25
+      },
+      "items": 1,
+      "pages": 1
+    }
+  }
+}

data/frilans_finans_api.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'frilans_finans_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'frilans_finans_api'
+  spec.version       = FrilansFinansApi::VERSION
+  spec.authors       = ['Jacob Burenstam']
+  spec.email         = ['burenstam@gmail.com']
+
+  spec.summary       = 'Interact with Frilans Finans API'
+  spec.description   = 'Interact with Frilans Finans API (still under development)'
+  spec.homepage      = 'https://github.com/buren/frilans_finans_api'
+  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.require_paths = ['lib']
+
+  spec.add_dependency 'httparty', '~> 0.13' # Easy HTTP requests
+
+  spec.add_development_dependency 'webmock', '~> 2.0'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/frilans_finans_api/client/client.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'frilans_finans_api/client/request'
+
+module FrilansFinansApi
+  class Client
+    attr_reader :request
+
+    def initialize(base_uri: nil, client_id: nil, client_secret: nil)
+      @request = Request.new(
+        base_uri: base_uri,
+        client_id: client_id,
+        client_secret: client_secret
+      )
+    end
+
+    def currencies(page: 1)
+      request.get(uri: '/currencies', query: build_query(page: page))
+    end
+
+    def professions(page: 1)
+      request.get(uri: '/professions', query: build_query(page: page))
+    end
+
+    def salaries(invoice_id:, page: 1)
+      request.get(uri: "/invoices/#{invoice_id}/salaries", query: build_query(page: page))
+    end
+
+    def users(page: 1, email: nil)
+      filter = email ? { email: email } : {}
+      request.get(uri: '/users', query: build_query(page: page, filter: filter))
+    end
+
+    def taxes(page: 1, only_standard: false)
+      filter = only_standard ? { standard: 1 } : {}
+      request.get(uri: '/taxes', query: build_query(page: page, filter: filter))
+    end
+
+    def invoice(id:)
+      request.get(uri: "/invoices/#{id}")
+    end
+
+    def user(id:)
+      request.get(uri: "/users/#{id}")
+    end
+
+    def profession(id:)
+      request.get(uri: "/professions/#{id}")
+    end
+
+    def create_user(attributes: {})
+      request.post(uri: '/users', body: build_attributes(attributes))
+    end
+
+    def create_company(attributes: {})
+      request.post(uri: '/companies', body: build_attributes(attributes))
+    end
+
+    def create_employment_certificate(attributes: {})
+      request.post(uri: '/employment-certificate', body: build_attributes(attributes))
+    end
+
+    def create_invoice(attributes: {})
+      request.post(uri: '/invoices', body: build_attributes(attributes))
+    end
+
+    def update_invoice(id:, attributes: {})
+      request.patch(uri: "/invoices/#{id}", body: build_attributes(attributes))
+    end
+
+    def update_user(id:, attributes: {})
+      request.patch(uri: "/users/#{id}", body: build_attributes(attributes))
+    end
+
+    private
+
+    def build_attributes(attributes)
+      { data: { attributes: attributes } }
+    end
+
+    def build_query(page:, filter: {})
+      {
+        page: { number: page },
+        filter: filter
+      }
+    end
+  end
+end

data/lib/frilans_finans_api/client/fixture_client.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module FrilansFinansApi
+  class FixtureClient
+    # NOTE: If this is extracted out of just_match_api, this will need to change
+    BASE_PATH = __dir__ + '/../../../fixtures'
+
+    HTTP_STATUS = 200
+    FIXTURE_URI = URI('http://example.com')
+
+    Request = Struct.new(:uri)
+    Response = Struct.new(:code, :body, :request)
+
+    def currencies(**_args)
+      mock_response(read(:currencies))
+    end
+
+    def professions(**_args)
+      mock_response(read(:professions))
+    end
+
+    def users(**_args)
+      mock_response(read(:users))
+    end
+
+    def salaries(**_args)
+      mock_response(read(:salaries))
+    end
+
+    def taxes(**_args)
+      mock_response(read(:taxes))
+    end
+
+    def user(**_args)
+      mock_response(read(:user))
+    end
+
+    def profession(**_args)
+      mock_response(read(:profession))
+    end
+
+    def invoice(**_args)
+      mock_response(read(:invoice))
+    end
+
+    def create_user(**_args)
+      mock_response(read(:user))
+    end
+
+    def create_company(**_args)
+      mock_response(read(:company))
+    end
+
+    def create_employment_certificate(**_args)
+      mock_response('{}')
+    end
+
+    def create_invoice(**_args)
+      mock_response(read(:invoice))
+    end
+
+    def update_invoice(**_args)
+      mock_response(read(:invoice))
+    end
+
+    def update_user(**_args)
+      mock_response(read(:user))
+    end
+
+    def read(type)
+      File.read("#{BASE_PATH}/#{type}_fixture.json")
+    end
+
+    private
+
+    def mock_response(body)
+      request = Request.new(FIXTURE_URI)
+      Response.new(HTTP_STATUS, body, request)
+    end
+  end
+end

data/lib/frilans_finans_api/client/nil_client.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module FrilansFinansApi
+  class NilClient
+    HTTP_STATUS = 200
+    NIL_URI = URI('http://example.com')
+
+    Request = Struct.new(:uri)
+    Response = Struct.new(:code, :body, :request)
+
+    def currencies(**_args)
+      body = '{}'
+      request = Request.new(NIL_URI)
+      Response.new(HTTP_STATUS, body, request)
+    end
+
+    alias_method :professions, :currencies
+    alias_method :salaries, :currencies
+    alias_method :taxes, :currencies
+    alias_method :users, :currencies
+    alias_method :invoice, :currencies
+    alias_method :user, :currencies
+    alias_method :profession, :currencies
+    alias_method :create_user, :currencies
+    alias_method :create_company, :currencies
+    alias_method :create_employment_certificate, :currencies
+    alias_method :create_invoice, :currencies
+    alias_method :update_invoice, :currencies
+    alias_method :update_user, :currencies
+  end
+end

data/lib/frilans_finans_api/client/request.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module FrilansFinansApi
+  class Request
+    USER_AGENT = {
+      'User-Agent' => 'FrilansFinansAPI - Ruby client'
+    }.freeze
+
+    HEADERS = {
+      'Content-Type' => 'application/json',
+      'Accept' => 'application/vnd.api.v2+json'
+    }.merge!(USER_AGENT).freeze
+
+    GRANT_TYPE = 'client_credentials'
+
+    attr_reader :credentials, :base_uri, :access_token
+
+    def initialize(base_uri: nil, client_id: nil, client_secret: nil)
+      @base_uri = base_uri || FrilansFinansApi.config.base_uri
+      @credentials = {
+        grant_type: GRANT_TYPE,
+        client_id: client_id || FrilansFinansApi.config.client_id,
+        client_secret: client_secret || FrilansFinansApi.config.client_secret
+      }
+      @access_token = nil
+    end
+
+    def get(uri:, query: {})
+      authorized_request do
+        _get(uri: uri, query: query)
+      end
+    end
+
+    def post(uri:, query: {}, body: {})
+      authorized_request do
+        _post(uri: uri, query: query, body: body.to_json)
+      end
+    end
+
+    def patch(uri:, query: {}, body: {})
+      authorized_request do
+        _patch(uri: uri, query: query, body: body.to_json)
+      end
+    end
+
+    def _get(uri:, query: {})
+      opts = build_get_opts(query: query)
+      response = HTTParty.get("#{base_uri}#{uri}", opts)
+      log_response(:get, uri: uri, params: opts, response: response)
+      response
+    end
+
+    def _post(uri:, query: {}, body: {})
+      opts = build_post_opts(query: query, body: body)
+      response = HTTParty.post("#{base_uri}#{uri}", opts)
+      log_response(:post, uri: uri, params: opts, response: response)
+      response
+    end
+
+    def _patch(uri:, query: {}, body: {})
+      opts = build_post_opts(query: query, body: body)
+      response = HTTParty.patch("#{base_uri}#{uri}", opts)
+      log_response(:patch, uri: uri, params: opts, response: response)
+      response
+    end
+
+    private
+
+    def build_get_opts(query: {})
+      { query: query }.merge(headers: headers)
+    end
+
+    def build_post_opts(query: {}, body: {})
+      {
+        query: query,
+        body: body
+      }.merge(headers: headers)
+    end
+
+    def headers
+      HEADERS.merge(auth_headers).dup
+    end
+
+    def authorized_request
+      fetch_access_token if access_token.nil?
+
+      response = yield
+      return response unless reauthorize?(response)
+
+      fetch_access_token
+      yield
+    end
+
+    def reauthorize?(response)
+      response.code == '401'
+    end
+
+    def auth_headers
+      { 'Authorization' => "Bearer #{access_token}" }
+    end
+
+    def fetch_access_token
+      uri = "#{base_uri}/auth/accesstoken"
+      response = HTTParty.post(uri, body: credentials, headers: USER_AGENT)
+      log_response(:post, uri: uri, params: {}, response: response)
+
+      @access_token = extract_access_token(response)
+      response
+    end
+
+    def extract_access_token(response)
+      parsed = response.parsed_response
+
+      # In tests HTTParty and Webmock aren't friends, causing HTTParty to return a string
+      # from #parsed_response instead of a Hash
+      parsed = JSON.parse(parsed) if parsed.is_a?(String)
+
+      parsed['access_token']
+    end
+
+    def log_response(method, uri:, params:, response:)
+      log_id = "[#{self.class.name}]"
+      verb = method.to_s.upcase
+      body = response.body
+      json_params = params.to_json
+      status = response.code
+      log_body = [
+        log_id,
+        verb,
+        "URI: #{uri}",
+        "PARAMS: #{json_params}",
+        "STATUS: #{status}",
+        "BODY: #{body}"
+      ].join(' ')
+      FrilansFinansApi.config.event_logger.request_event(params: json_params,
+                                                         status: status,
+                                                         verb: verb,
+                                                         uri: uri,
+                                                         body: body)
+      FrilansFinansApi.config.logger.info log_body
+    end
+  end
+end

data/lib/frilans_finans_api/client/terms.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module FrilansFinansApi
+  class Terms
+    USER_URL = 'https://www.frilansfinans.se/just-arrived-employment-agreement/'.freeze
+    COMPANY_USER_URL = 'https://www.frilansfinans.se/just-arrived-consultancy-agreement/'.freeze
+
+    HEADERS = Request::HEADERS
+
+    def self.get(type:)
+      url = case type
+            when :company then COMPANY_USER_URL
+            when :user then USER_URL
+            else
+              fail(ArgumentError, "Unknown type: '#{type}'")
+            end
+
+      HTTParty.get(url, headers: headers).parsed_response
+    end
+
+    def self.headers
+      # Must be dup frozen hash, since HTTParty modifies it
+      HEADERS.dup
+    end
+  end
+end

data/lib/frilans_finans_api/client/walker.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FrilansFinansApi
+  module Walker
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def walk(client: FrilansFinansApi.config.client_klass.new)
+        current_page = 1
+        total_pages = 2
+
+        resources = []
+
+        while total_pages >= current_page
+          resource_index = index(page: current_page, client: client)
+          total_pages = resource_index.total_pages
+
+          yield(resource_index) if block_given?
+          resources += resource_index.resources
+
+          current_page += 1
+        end
+        resources
+      end
+    end
+  end
+end

data/lib/frilans_finans_api/models/company.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module FrilansFinansApi
+  class Company
+    def self.create(attributes:, client: FrilansFinansApi.config.client_klass.new)
+      response = client.create_company(attributes: attributes)
+      Document.new(response)
+    end
+  end
+end

data/lib/frilans_finans_api/models/currency.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module FrilansFinansApi
+  class Currency
+    include Walker
+
+    def self.index(page: 1, client: FrilansFinansApi.config.client_klass.new)
+      response = client.currencies(page: page)
+      Document.new(response)
+    end
+  end
+end

data/lib/frilans_finans_api/models/employment_certificate.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module FrilansFinansApi
+  class EmploymentCertificate
+    def self.create(attributes:, client: FrilansFinansApi.config.client_klass.new)
+      client.create_employment_certificate(attributes: attributes)
+      nil
+    end
+  end
+end