frilans_finans_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '0012708294cbf004471c28d9c74c12eb34aff89f'
+  data.tar.gz: fcae44a56ac49405fad283e6ab5a66e5289ef68a
+SHA512:
+  metadata.gz: 5290b1c50fc7d003885038c10aef303dc98fcd47c4792009ab2eadb2f3feca18f8883b358be4d57590e71c24569d3fef73071a9f6d42fcbe1d8e271ddf581c62
+  data.tar.gz: 3f08bab11dab79cf670ef17293262d2117568b94a3b95de3d6651ae0ad43b223216881e8acb428f15d7a7b2aac5574b0389f9e9fd78255fa937748d597d12e50

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jacob Burenstam
+
+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,64 @@
+# FrilansFinansApi
+
+Interact with Frilans Finans API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'frilans_finans_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install frilans_finans_api
+
+__Configure__
+
+```ruby
+FrilansFinansApi.configure do |config|
+  config.client_klass  = FrilansFinansApi::Client
+  config.base_uri      = ENV.fetch('FRILANS_FINANS_BASE_URI')
+  config.client_id     = ENV.fetch('FRILANS_FINANS_CLIENT_ID')
+  config.client_secret = ENV.fetch('FRILANS_FINANS_CLIENT_SECRET')
+end
+```
+
+## Usage
+
+```ruby
+include FrilansFinansApi
+
+# GET /professions?page=1
+document = Profession.index(page: 1)
+document.resources.each do |profession|
+  puts profession.attributes['title']
+end
+document.total_pages
+
+# Iterate over all professions, page by page
+Profession.walk(page: 1) do |document|
+  document.resources.each do |profession|
+    puts profession.attributes['title']
+  end
+end
+```
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/buren/frilans_finans_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'frilans_finans_api'
+
+# 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,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/frilans_finans_api/document.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module FrilansFinansApi
+  class Document
+    attr_reader :status, :json, :uri
+
+    def initialize(response)
+      @json = JSON.parse(response.body)
+      @status = response.code
+      @uri = response.request.uri.to_s
+    end
+
+    def resources
+      @resources ||= begin
+        if collection?
+          data.map { |resource| Resource.new(resource) }
+        else
+          [Resource.new(data)]
+        end
+      end
+    end
+
+    def resource
+      @resource ||= begin
+        resource_data = collection? ? data.first : data
+        Resource.new(resource_data)
+      end
+    end
+
+    def collection?
+      data = json['data']
+      return false if data.nil? || data.is_a?(Hash)
+
+      true
+    end
+
+    def data
+      json['data']
+    end
+
+    def next_page_link
+      json.dig('links', 'next')
+    end
+
+    def current_page
+      json.dig('meta', 'pagination', 'page', 'number')
+    end
+
+    def per_page
+      json.dig('meta', 'pagination', 'page', 'size')
+    end
+
+    def total_pages
+      json.dig('meta', 'pagination', 'pages')
+    end
+
+    def total
+      json.dig('meta', 'pagination', 'items')
+    end
+
+    def count
+      json.dig('meta', 'pagination', 'items')
+    end
+
+    def error_status?
+      # Consider HTTP status 3XX, 4XX and 5XX as errors
+      status >= 300
+    end
+  end
+end

data/lib/frilans_finans_api/nil_event_logger.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module FrilansFinansApi
+  class NilEventLogger
+    def request_event(*); end
+  end
+end

data/lib/frilans_finans_api/nil_logger.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module FrilansFinansApi
+  class NilLogger < ::Logger
+    def initialize(*args); end
+
+    def add(*args); end
+  end
+end

data/lib/frilans_finans_api/parse_log.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module FrilansFinansApi
+  module ParseLog
+    class LogRequest
+      attr_reader :uri, :params, :body, :status
+
+      def initialize(uri:, params:, body:, status:)
+        @uri = uri
+        @params = params
+        @body = body
+        @status = status
+      end
+
+      def access_token_request?
+        uri.include?('auth/accesstoken')
+      end
+
+      def inspect
+        parts = [
+          "status: #{status}",
+          "uri: #{uri}",
+          "params: #{params}",
+          "body: #{body}"
+        ].join(', ')
+        "#<#{self.class.name} #{parts}"
+      end
+    end
+
+    def self.call(filename)
+      lines = []
+      File.foreach(filename) do |log_line|
+        next unless log_line.index('[FrilansFinansApi::Request]')
+
+        # MATCH BODY
+        body_match = 'BODY: '
+        body_match_index = log_line.index(body_match)
+        body_content_index = body_match_index + body_match.length
+        body_json = log_line[body_content_index..-1].strip
+        body = JSON.parse(body_json)
+
+        # MATCH STATUS
+        status = string_between_markers(log_line, ' STATUS: ', ' BODY: ')
+
+        # MATCH PARAM
+        json_string = string_between_markers(log_line, ' PARAMS: ', ' STATUS: ')
+        params = JSON.parse(json_string)
+
+        # MATCH URI
+        uri = string_between_markers(log_line, ' URI: ', ' PARAMS: ')
+
+        lines << LogRequest.new(uri: uri, params: params, body: body, status: status)
+      end
+      lines
+    end
+
+    def self.string_between_markers(string, start_marker, end_marker)
+      string[/#{Regexp.escape(start_marker)}(.*?)#{Regexp.escape(end_marker)}/m, 1]
+    end
+  end
+end

data/lib/frilans_finans_api/resource.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module FrilansFinansApi
+  class Resource
+    def initialize(document)
+      @data = document || {}
+    end
+
+    def type
+      @data['type']
+    end
+
+    def id
+      @data['id']
+    end
+
+    def attributes
+      @data['attributes']
+    end
+
+    def self_link
+      @data.dig('links', 'self')
+    end
+  end
+end

data/lib/frilans_finans_api/statuses.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module FrilansFinansApi
+  module Statuses
+    module Invoice
+      STATUSES = {
+        1  => 'Not paid',
+        2  => 'Paid',
+        3  => 'Credit invoice',
+        4  => 'Credited',
+        5  => 'Client loss',
+        6  => 'Partly paid',
+        7  => 'Saved',
+        9  => 'Credit errand',
+        10 => 'Dummy invoice',
+        11 => 'ROT/RUT invoice',
+        12 => 'ROT/RUT',
+        13 => 'Skatteverket (Swedish Tax Agency)'
+      }.freeze
+
+      PAYMENT_STATUS = {
+        1 => 'Not paid',
+        2 => 'Paid',
+        3 => 'Partly paid',
+        4 => 'Started'
+      }.freeze
+
+      APPROVAL_STATUS = {
+        1 => 'Waiting on approval',
+        2 => 'Approved',
+        3 => 'Not approved',
+        4 => 'Waiting on payment',
+        5 => 'Saved'
+      }.freeze
+
+      def self.status(status_int, with_id: false)
+        _format_name(status_int, STATUSES[status_int], with_id)
+      end
+
+      def self.payment_status(status_int, with_id: false)
+        _format_name(status_int, PAYMENT_STATUS[status_int], with_id)
+      end
+
+      def self.approval_status(status_int, with_id: false)
+        _format_name(status_int, APPROVAL_STATUS[status_int], with_id)
+      end
+
+      def self._format_name(status_int, name, with_id)
+        return nil if name.nil?
+        return "##{status_int} " + name if with_id
+        name
+      end
+    end
+  end
+end

data/lib/frilans_finans_api/test_helper.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module FrilansFinansApi
+  module TestHelper
+    module_function
+
+    def isolate_frilans_finans_client(klass)
+      before_klass = FrilansFinansApi.config.client_klass
+      FrilansFinansApi.config.client_klass = klass
+      result = yield(before_klass)
+      FrilansFinansApi.config.client_klass = before_klass
+      result
+    end
+
+    def stub_frilans_finans_auth_request
+      # Stub auth request
+      base_uri = FrilansFinansApi.config.base_uri
+      headers = { 'User-Agent' => 'FrilansFinansAPI - Ruby client' }
+      body = [
+        'grant_type=client_credentials',
+        "client_id=#{FrilansFinansApi.config.client_id}",
+        "client_secret=#{FrilansFinansApi.config.client_secret}"
+      ].join('&')
+
+      response_body =  JSON.dump(
+        'access_token' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+        'token_type' => 'Bearer',
+        'expires_in' => 1200
+      )
+
+      stub_request(:post, "#{base_uri}/auth/accesstoken").
+        with(body: body, headers: headers).
+        to_return(status: 200, body: response_body, headers: {})
+    end
+
+    def frilans_finans_authed_request_headers
+      {
+        'Authorization' => 'Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+        'Content-Type' => 'application/json',
+        'User-Agent' => 'FrilansFinansAPI - Ruby client'
+      }
+    end
+
+    def mock_httparty_response(code: 200, body: '{}', uri: 'http://example.com')
+      request_struct = Struct.new(:uri)
+      request = request_struct.new(URI(uri))
+
+      response_struct = Struct.new(:code, :body, :request)
+      response_struct.new(code, body, request)
+    end
+  end
+end

data/lib/frilans_finans_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FrilansFinansApi
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: frilans_finans_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jacob Burenstam
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: Interact with Frilans Finans API (still under development)
+email:
+- burenstam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.MD
+- bin/console
+- bin/setup
+- lib/frilans_finans_api/document.rb
+- lib/frilans_finans_api/nil_event_logger.rb
+- lib/frilans_finans_api/nil_logger.rb
+- lib/frilans_finans_api/parse_log.rb
+- lib/frilans_finans_api/resource.rb
+- lib/frilans_finans_api/statuses.rb
+- lib/frilans_finans_api/test_helper.rb
+- lib/frilans_finans_api/version.rb
+homepage: https://github.com/buren/frilans_finans_api
+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.13
+signing_key: 
+specification_version: 4
+summary: Interact with Frilans Finans API
+test_files: []