fakturoid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 076c161dacf951eb18acf2852ef982e0105ca544
+  data.tar.gz: dadf19899fa9ee0eda8bb8e96ca8e225ac166194
+SHA512:
+  metadata.gz: 8b46b7684942b394c3bd00dcd256e5a66ff388737371be5f61441b73b10920fe1cb0197892de2ee79d2433a47a1e33c5974bdc4fbc70383209d003ff98aa5359
+  data.tar.gz: 68ebfce58da609f156a85657f8d05057ca7888f0ae703e654f2514e4fb4698dd7b454256faa80fa38bf534a1e1566a8f75daf2b585a2f20c3e20117b4ad47942

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+Gemfile.lock
+coverage/
+doc/
+pkg/
+.DS_Store

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/CHANGELOG.md

@@ -0,0 +1 @@
+## 0.1.0 (Initial version)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Eda Riedl
+
+MIT License
+
+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,262 @@
+# Fakturoid
+
+The Fakturoid gem is ruby library for API communication with web based invoicing service [www.fakturoid.cz](https://fakturoid.cz).
+Fakturoid [API documentation](http://docs.fakturoid.apiary.io). 
+
+[![Circle CI](https://circleci.com/gh/fakturoid/fakturoid-ruby.svg?style=svg)](https://circleci.com/gh/fakturoid/fakturoid-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fakturoid', git: 'https://github.com/fakturoid/fakturoid-ruby.git'
+```
+
+And then run:
+
+    $ bundle
+
+Gem is not officially released and is under construction. So if you want to use it please install it from this repository
+and specify `:ref` option. API of the Fakturoid gem can be still changed.
+
+## Configuration
+
+Fakturoid gem is configured within config block placed in `config/initializers/fakturoid.rb`:
+
+```ruby
+Fakturoid.configure do |config|
+  config.email = 'yourfakturoid@email.com'
+  config.api_key = 'fasdff823fdasWRFKW843ladfjklasdf834'
+  config.account = 'applecorp' # former subdomain (first part of URL)
+  config.user_agent = 'Name of your app (your@email.com)'
+end
+```
+
+## Usage
+
+### Account resource
+
+To get informations about your account in Fakturoid run following code:
+
+```ruby
+response = Fakturoid::Client::Account.current
+response.status_code # returns response http code
+response.body # contains hash with returned body
+```
+
+Accessing content of returned body:
+
+```ruby
+response.body['name'] # return name of your company
+response.name # alternative way of getting the name of your company
+```
+
+For the list of all returned account fields see the [Account API documentation](http://docs.fakturoid.apiary.io/#account)
+
+### User resource
+
+For the information about current user use following code:
+
+```ruby
+response = Fakturoid::Client::User.current
+```
+
+For all the users which belongs to current account:
+
+```ruby
+response = Fakturoid::Client::User.all
+```
+
+If you want to get information about one user which belongs to account use:
+
+```ruby
+response = Fakturoid::Client::User.find(user_id)
+```
+
+For the list of all returned user fields see the [Users API documentation](http://docs.fakturoid.apiary.io/#users)
+
+### Subject resource
+
+To get all subjects run (Subjects are paginated by 20 per page):
+
+```ruby
+response = Fakturoid::Client::Subject.all page: 2
+```
+
+Fulltext search subjects:
+
+```ruby
+response = Fakturoid::Client::Subject.search 'Client name'
+```
+
+To find one subject use:
+
+```ruby
+response = Fakturoid::Client::Subject.find subject_id
+```
+
+You can create new subject with:
+
+```ruby
+response = Fakturoid::Client::Subject.create name: 'New client'
+```
+
+To update subject use following code:
+
+```ruby
+response = Fakturoid::Client::Subject.update subject_id, name: 'Updated client'
+```
+
+Delete subject:
+
+```ruby
+Fakturoid::Client::Subject.delete subject_id
+```
+
+For the list of all subject fields and options see the [Subjects API documentation](http://docs.fakturoid.apiary.io/#subjects)
+
+### Invoice resource
+
+To get all invoices run (Invoices are paginated by 20 per page):
+
+```ruby
+response = Fakturoid::Client::Invoice.all page: 2
+```
+
+Fulltext search invoices:
+
+```ruby
+response = Fakturoid::Client::Invoice.search 'Client name'
+```
+
+To find one invoice use:
+
+```ruby
+response = Fakturoid::Client::Invoice.find invoice_id
+```
+
+To download invoice in PDF format you can use following code:
+
+```ruby
+response = Fakturoid::Client::Invoice.download_pdf invoice_id
+
+File.open '/path/to/file.pdf', 'w' do |f|
+  f.write response.body
+end
+```
+
+You can create new invoice with:
+
+```ruby
+invoice = {
+  subject_id: 123, 
+  lines: [
+    { 
+      quantity: 5, 
+      unit_name: 'kg', 
+      name: 'Sand',
+      unit_price: '100',
+      vat_rate: 21
+    }
+  ]
+}
+response = Fakturoid::Client::Invoice.create invoice
+```
+
+Invoice actions (eg. pay invoice):
+
+```ruby
+response = Fakturoid::Client::Invoice.fire invoice_id, 'pay'
+```
+
+Send invoice with customized message (for more information see [the API Documentation](http://docs.fakturoid.apiary.io/#messages)):
+
+```ruby
+message = {
+  email: 'testemail@testemail.cz',
+  email_copy: 'some@emailcopy.cz',
+  subject: 'I have an invoice for you',
+  message: "Hi,\n\nyou can find invoice no. #no# on the following page #link#\n\nHave a nice day"
+}
+
+response = Fakturoid::Client::Invoice.deliver_message(181, message)
+response.status_code # => 201
+```
+
+To update invoice use following code:
+
+```ruby
+response = Fakturoid::Client::Invoice.update invoice_id, number: '2015-0015'
+```
+
+Delete invoice:
+
+```ruby
+response = Fakturoid::Client::Invoice.delete invoice_id
+```
+
+For the list of all invoice fields and options see the [Invoices API documentation](http://docs.fakturoid.apiary.io/#invoices)
+
+## Handling error responses
+
+The Fakturoid gem raises exceptions if error response is returned from the servers. All exceptions contains following attributes:
+
+  - `message` - Error description
+  - `response_code` - http code of error (only number)
+  - `response_body` - response body parsed in the hash
+
+<table>
+  <thead>
+    <tr>
+      <th>Error class</th><th>Response code</th><th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>ContentTypeError</td><td>415 Unsupported Media Type</td><td>Wrong content type</td>
+    </tr>
+    <tr>
+      <td>UserAgentError</td><td>400 Bad Request</td><td>Missing `user_agent` configuration</td>
+    </tr>
+    <tr>
+      <td>PaginationError</td><td>400 Bad Request</td><td>Page with given number does not exist</td>
+    </tr>
+    <tr>
+      <td>AuthenticationError</td><td>401 Unauthorized</td><td>Wrong authentication `email` or `api_key` configuration</td>
+    </tr>
+    <tr>
+      <td>BlockedAccountError</td><td>402 Payment Required</td><td>Fakturoid account is blocked</td>
+    </tr>
+    <tr>
+      <td>RateLimitError</td><td>429 Too Many Requests</td><td>Too many request sent during last 5 minutes</td>
+    </tr>
+    <tr>
+      <td>ReadOnlySiteError</td><td>503 Service Unavailable</td><td>Fakturoid is read only</td>
+    </tr>
+    <tr>
+      <td>RecordNotFoundError</td><td>404 Not Found</td><td>Document with given ID does not exists or current account has read only permission and trying to edit something</td>
+    </tr>
+    <tr>
+      <td>InvalidRecordError</td><td>422 Unprocessable Entity</td><td>Invalid data sent to server</td>
+    </tr>
+    <tr>
+      <td>DestroySubjectError</td><td>403 Forbidden</td><td>Subject has invoices or expenses and cannot be deleted</td>
+    </tr>
+    <tr>
+      <td>SubjectLimitError</td><td>403 Forbidden</td><td>Subject quota reached for adding more subjects upgrade to higher plan</td>
+    </tr>
+    <tr>
+      <td>GeneratorLimitError</td><td>403 Forbidden</td><td>Generator quota reached for adding more recurring generators upgrade to higher plan</td>
+    </tr>
+    <tr>
+      <td>UnsupportedFeatureError</td><td>403 Forbidden</td><td>Feature is not supported in your plan to use this feature upgrade to higher plan</td>
+    </tr>
+    <tr>
+      <td>ClientError</td><td>4XX</td><td>Server returns response code which is not specified above</td>
+    </tr>
+    <tr>
+      <td>ServerError</td><td>5XX</td><td>Server returns response code which is not specified above</td>
+    </tr>
+  </tbody>
+</table>

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/fakturoid.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fakturoid/version'
+
+Gem::Specification.new do |s|
+  s.name          = "fakturoid"
+  s.version       = Fakturoid::VERSION
+  s.authors       = ["Eda Riedl", "Lukáš Konarovský"]
+  s.email         = ["podpora@fakturoid.cz"]
+  s.summary       = %q{Ruby client for web based invoicing service www.fakturoid.cz}
+  s.description   = %q{Ruby client for web based invoicing service www.fakturoid.cz}
+  s.homepage      = "https://github.com/fakturoid/fakturoid-ruby"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+  
+  s.add_dependency 'multi_json'
+  s.add_dependency 'faraday'
+  
+  s.add_development_dependency "bundler", "> 1"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "shoulda-context"
+  s.add_development_dependency "mocha"
+end

data/lib/fakturoid.rb

@@ -0,0 +1,47 @@
+require 'uri'
+require 'multi_json'
+require 'faraday'
+
+require 'fakturoid/config'
+require 'fakturoid/connection'
+require 'fakturoid/request'
+require 'fakturoid/response'
+require 'fakturoid/api'
+require 'fakturoid/client'
+require 'fakturoid/version'
+require 'fakturoid/railtie' if defined?(::Rails)
+
+module Fakturoid
+  
+  class ApiError < StandardError
+    attr_accessor :response_code, :response_body
+    
+    def initialize(message = nil, response_code = nil, response_body = nil)
+      super(message)
+      self.response_code = response_code
+      self.response_body = response_body
+    end
+  end
+  
+  class ContentTypeError        < ApiError; end
+  class UserAgentError          < ApiError; end
+  class AuthenticationError     < ApiError; end
+  class BlockedAccountError     < ApiError; end
+  class RateLimitError          < ApiError; end
+  class ReadOnlySiteError       < ApiError; end
+  class PaginationError         < ApiError; end
+
+  class RecordNotFoundError     < ApiError; end
+  class InvalidRecordError      < ApiError; end
+  class DestroySubjectError     < ApiError; end
+  class SubjectLimitError       < ApiError; end
+  class GeneratorLimitError     < ApiError; end
+  class UnsupportedFeatureError < ApiError; end
+  
+  class ClientError < ApiError; end
+  class ServerError < ApiError; end
+  
+  def self.configure(&block)
+    Fakturoid::Api.configure(&block)
+  end
+end

data/lib/fakturoid/api.rb

@@ -0,0 +1,17 @@
+require 'fakturoid/api/arguments'
+require 'fakturoid/api/http_methods'
+
+module Fakturoid
+  class Api
+    extend Arguments
+    extend HttpMethods
+    
+    def self.configure(&block)
+      @config ||= Fakturoid::Config.new(&block)
+    end
+    
+    def self.config
+      @config
+    end
+  end
+end

data/lib/fakturoid/api/arguments.rb

@@ -0,0 +1,19 @@
+module Fakturoid
+  class Api
+    module Arguments
+      def permit_params(params_hash, *permitted_params)
+        params_hash.select { |param, value| permitted_params.include?(param.to_sym) }
+      end
+      
+      def validate_numerical_id(id)
+        raise ArgumentError, "Wrong ID given: #{id}" if !id.is_a?(Integer) && !(id.is_a?(String) && id =~ /\A\d+\z/)
+        true
+      end
+      
+      def validate_search_query(query)
+        raise ArgumentError, 'Query parameter is required' if query.nil? || query.empty?
+        true
+      end
+    end
+  end
+end

data/lib/fakturoid/api/http_methods.rb

@@ -0,0 +1,21 @@
+module Fakturoid
+  class Api
+    module HttpMethods
+      def get_request(path, params = {})
+        Request.new(:get, path, self).call(params)
+      end
+    
+      def post_request(path, params = {})
+        Request.new(:post, path, self).call(params)
+      end
+    
+      def patch_request(path, params = {})
+        Request.new(:patch, path, self).call(params)
+      end
+    
+      def delete_request(path, params = {})
+        Request.new(:delete, path, self).call(params)
+      end
+    end
+  end
+end

data/lib/fakturoid/client.rb

@@ -0,0 +1,9 @@
+require 'fakturoid/client/account'
+require 'fakturoid/client/bank_account'
+require 'fakturoid/client/user'
+require 'fakturoid/client/subject'
+require 'fakturoid/client/invoice'
+require 'fakturoid/client/expense'
+require 'fakturoid/client/generator'
+require 'fakturoid/client/event'
+require 'fakturoid/client/todo'

data/lib/fakturoid/client/account.rb

@@ -0,0 +1,9 @@
+module Fakturoid
+  module Client
+    class Account < Fakturoid::Api
+      def self.current
+        get_request('account.json')
+      end
+    end
+  end
+end

data/lib/fakturoid/client/bank_account.rb

@@ -0,0 +1,9 @@
+module Fakturoid
+  module Client
+    class BankAccount < Fakturoid::Api
+      def self.all        
+        get_request('bank_accounts.json')
+      end
+    end
+  end
+end

data/lib/fakturoid/client/event.rb

@@ -0,0 +1,17 @@
+module Fakturoid
+  module Client
+    class Event < Fakturoid::Api
+      def self.all(params = {})
+        request_params = permit_params(params, :page, :since, :subject_id) || {}
+        
+        get_request('events.json', request_params: request_params)
+      end
+      
+      def self.paid(params = {})
+        request_params = permit_params(params, :page, :since, :subject_id) || {}
+        
+        get_request('events/paid.json', request_params: request_params)
+      end
+    end
+  end
+end

data/lib/fakturoid/client/expense.rb

@@ -0,0 +1,40 @@
+module Fakturoid
+  module Client
+    class Expense < Fakturoid::Api
+      def self.all(params = {})
+        request_params = permit_params(params, :page, :since, :number, :variable_symbol, :status, :subject_id) || {}
+        
+        get_request('expenses.json', request_params: request_params)
+      end
+      
+      def self.find(id)
+        validate_numerical_id(id)
+        get_request("expenses/#{id}.json")
+      end
+      
+      def self.search(query)
+        validate_search_query(query)
+        get_request('expenses/search.json', request_params: { query: query })
+      end
+      
+      def self.fire(id, event)
+        validate_numerical_id(id)
+        post_request("expenses/#{id}/fire.json", request_params: { event: event })
+      end
+      
+      def self.create(payload = {})
+        post_request('expenses.json', payload: payload)
+      end
+      
+      def self.update(id, payload = {})
+        validate_numerical_id(id)
+        patch_request("expenses/#{id}.json", payload: payload)
+      end
+      
+      def self.delete(id)
+        validate_numerical_id(id)
+        delete_request("expenses/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/client/generator.rb

@@ -0,0 +1,42 @@
+module Fakturoid
+  module Client
+    class Generator < Fakturoid::Api
+      def self.all(params = {})
+        request_params = permit_params(params, :page, :since, :subject_id) || {}
+        
+        get_request('generators.json', request_params: request_params)
+      end
+      
+      def self.recurring(params = {})
+        request_params = permit_params(params, :page, :since, :subject_id) || {}
+        
+        get_request('generators/recurring.json', request_params: request_params)
+      end
+      
+      def self.template(params = {})
+        request_params = permit_params(params, :page, :since, :subject_id) || {}
+        
+        get_request('generators/template.json', request_params: request_params)
+      end
+      
+      def self.find(id)
+        validate_numerical_id(id)
+        get_request("generators/#{id}.json")
+      end
+      
+      def self.create(payload = {})
+        post_request('generators.json', payload: payload)
+      end
+      
+      def self.update(id, payload = {})
+        validate_numerical_id(id)
+        patch_request("generators/#{id}.json", payload: payload)
+      end
+      
+      def self.delete(id)
+        validate_numerical_id(id)
+        delete_request("generators/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/client/invoice.rb

@@ -0,0 +1,62 @@
+module Fakturoid
+  module Client
+    class Invoice < Fakturoid::Api
+      def self.all(params = {})
+        request_params = permit_params(params, :page, :since, :number, :status, :subject_id) || {}
+        
+        get_request('invoices.json', request_params: request_params)
+      end
+      
+      def self.regular(params = {})
+        request_params = permit_params(params, :page, :since, :number, :status, :subject_id) || {}
+        
+        get_request('invoices/regular.json', request_params: request_params)
+      end
+      
+      def self.proforma(params = {})
+        request_params = permit_params(params, :page, :since, :number, :status, :subject_id) || {}
+        
+        get_request('invoices/proforma.json', request_params: request_params)
+      end
+      
+      def self.find(id)
+        validate_numerical_id(id)
+        get_request("invoices/#{id}.json")
+      end
+      
+      def self.search(query)
+        validate_search_query(query)
+        get_request('invoices/search.json', request_params: { query: query })
+      end
+      
+      def self.download_pdf(id)
+        validate_numerical_id(id)
+        get_request("invoices/#{id}/download.pdf", headers: { content_type: 'application/pdf' })
+      end
+      
+      def self.fire(id, event)
+        validate_numerical_id(id)
+        post_request("invoices/#{id}/fire.json", request_params: { event: event })
+      end
+      
+      def self.deliver_message(invoice_id, payload = {})
+        validate_numerical_id(invoice_id)
+        post_request("invoices/#{invoice_id}/message.json", payload: payload)
+      end
+      
+      def self.create(payload = {})
+        post_request('invoices.json', payload: payload)
+      end
+      
+      def self.update(id, payload = {})
+        validate_numerical_id(id)
+        patch_request("invoices/#{id}.json", payload: payload)
+      end
+      
+      def self.delete(id)
+        validate_numerical_id(id)
+        delete_request("invoices/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/client/subject.rb

@@ -0,0 +1,35 @@
+module Fakturoid
+  module Client
+    class Subject < Fakturoid::Api
+      def self.all(params = {})
+        request_params = permit_params(params, :page, :since, :custom_id) || {}
+        
+        get_request('subjects.json', request_params: request_params)
+      end
+      
+      def self.find(id)
+        validate_numerical_id(id)
+        get_request("subjects/#{id}.json")
+      end
+      
+      def self.search(query)
+        validate_search_query(query)
+        get_request('subjects/search.json', request_params: { query: query })
+      end
+      
+      def self.create(payload = {})
+        post_request('subjects.json', payload: payload)
+      end
+      
+      def self.update(id, payload = {})
+        validate_numerical_id(id)
+        patch_request("subjects/#{id}.json", payload: payload)
+      end
+      
+      def self.delete(id)
+        validate_numerical_id(id)
+        delete_request("subjects/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/client/todo.rb

@@ -0,0 +1,16 @@
+module Fakturoid
+  module Client
+    class Todo < Fakturoid::Api
+      def self.all(params = {})
+        request_params = permit_params(params, :page, :since) || {}
+        
+        get_request('todos.json', request_params: request_params)
+      end
+      
+      def self.toggle_completion(id)
+        validate_numerical_id(id)
+        post_request("todos/#{id}/toggle_completion.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/client/user.rb

@@ -0,0 +1,18 @@
+module Fakturoid
+  module Client
+    class User < Api
+      def self.current
+        get_request('user.json', url: Fakturoid::Api.config.endpoint_without_account)
+      end
+      
+      def self.find(id)
+        validate_numerical_id(id)
+        get_request("users/#{id}.json")
+      end
+      
+      def self.all
+        get_request('users.json')
+      end
+    end
+  end
+end

data/lib/fakturoid/config.rb

@@ -0,0 +1,28 @@
+module Fakturoid
+  class Config
+    attr_accessor :email, :api_key, :account
+    attr_writer :user_agent
+    
+    ENDPOINT = 'https://app.fakturoid.cz/api/v2'
+    
+    def initialize(&block)
+      yield self
+    end
+    
+    def user_agent
+      if @user_agent.nil? || @user_agent.empty?
+        "Fakturoid ruby gem (#{email})"
+      else
+        @user_agent
+      end
+    end
+    
+    def endpoint
+      "#{ENDPOINT}/accounts/#{account}"
+    end
+    
+    def endpoint_without_account
+      ENDPOINT
+    end
+  end
+end

data/lib/fakturoid/connection.rb

@@ -0,0 +1,22 @@
+module Fakturoid
+  module Connection
+    
+    def default_options(options = {})
+      content_type = options[:headers] && options[:headers][:content_type]
+      {
+        headers: {
+          content_type: content_type || 'application/json',
+          user_agent: Fakturoid::Api.config.user_agent
+        },
+        url: options[:url] || Fakturoid::Api.config.endpoint
+      }
+    end
+    
+    def connection(options = {})
+      @connection = Faraday.new default_options(options)
+      @connection.basic_auth(Fakturoid::Api.config.email, Fakturoid::Api.config.api_key)
+      
+      @connection
+    end
+  end
+end

data/lib/fakturoid/railtie.rb

@@ -0,0 +1,4 @@
+module Fakturoid
+  class Railtie < Rails::Railtie
+  end
+end

data/lib/fakturoid/request.rb

@@ -0,0 +1,28 @@
+module Fakturoid
+  class Request
+    include Connection
+    
+    attr_reader :method, :path, :caller
+    HTTP_METHODS = [:get, :post, :patch, :delete]
+    
+    def initialize(method, path, caller)
+      @method = method
+      @path   = path
+      @caller = caller
+    end
+    
+    def call(params = {})
+      unless HTTP_METHODS.include?(method.to_sym)
+        raise ArgumentError, "Unknown http method: #{method}"
+      end
+      request_params = params[:request_params] || {}
+      
+      http_connection = connection(params)
+      response = http_connection.send(method) do |req|
+        req.url path, request_params
+        req.body = MultiJson.dump(params[:payload]) if params.key?(:payload)
+      end
+      Response.new(response, caller, method)
+    end
+  end
+end

data/lib/fakturoid/response.rb

@@ -0,0 +1,70 @@
+module Fakturoid
+  class Response
+    attr_reader :response, :caller, :env, :body, :request_method
+    
+    def initialize(faraday_response, caller, request_method)
+      @response = faraday_response
+      @caller = caller
+      @env = faraday_response.env
+      @request_method = request_method.to_sym
+      
+      if !(env.body.nil? || env.body.empty? || (json? && env.body =~ /\A\s+\z/))
+        @body = json? ? MultiJson.load(env.body) : env.body
+      end
+      handle_response
+    end
+    
+    def method_missing(method, *args, &block)
+      if body && body.is_a?(Hash) && body.key?(method.to_s)
+        body[method.to_s]
+      else
+        super
+      end
+    end
+    
+    def status_code
+      env['status']
+    end
+    
+    def json?
+      env.request_headers['Content-Type'] == 'application/json'
+    end
+    
+    def headers
+      env.response_headers
+    end
+    
+    def inspect
+      "#<#{self.class.name}:#{object_id} @body=\"#{self.body}\" @status_code=\"#{status_code}\">"
+    end
+  
+  private
+  
+    def handle_response
+      case status_code
+        when 400 
+          raise error(UserAgentError,  'User-Agent header missing') if env.request_headers['User-Agent'].nil? || env.request_headers['User-Agent'].empty?
+          raise error(PaginationError, 'Page does not exist')
+        when 401 then raise error(AuthenticationError, 'Authentification failed')
+        when 402 then raise error(BlockedAccountError, 'Account is blocked')
+        when 403 then 
+          raise error(DestroySubjectError, 'Cannot destroy subject with invoices')          if caller == Client::Subject && request_method == :delete
+          raise error(SubjectLimitError,   'Subject limit for account reached')             if caller == Client::Subject && request_method == :post
+          raise error(GeneratorLimitError, 'Recurring generator limit for account reached') if caller == Client::Generator
+          raise error(UnsupportedFeatureError, 'Feature unavailable for account plan')
+        when 404 then raise error(RecordNotFoundError, 'Record not found')
+        when 415 then raise error(ContentTypeError,    'Unsupported Content-Type')
+        when 422 then raise error(InvalidRecordError,  'Invalid record')
+        when 429 then raise error(RateLimitError,      'Rate limit reached')
+        when 503 then raise error(ReadOnlySiteError,   'Fakturoid is in read only state')
+        else
+          raise error(ServerError, 'Server error') if status_code >= 500
+          raise error(ClientError, 'Client error') if status_code >= 400
+      end
+    end
+    
+    def error(klass, message = nil)
+      klass.new message, status_code, body
+    end
+  end
+end

data/lib/fakturoid/version.rb

@@ -0,0 +1,3 @@
+module Fakturoid
+  VERSION = '0.1.0'
+end

data/test/api_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class Fakturoid::ApiTest < Fakturoid::TestCase
+  should "permit only required arguments" do
+    hash = { page: 4, number: '2015-0015', account: 15 }
+    permitted_params = Fakturoid::Api.permit_params(hash, :page, :number, :status)
+    assert_equal({ page: 4, number: '2015-0015' }, permitted_params)
+  end
+  
+  should "raise argument error if id is in wrong format" do
+    assert_raises(ArgumentError) { Fakturoid::Api.validate_numerical_id(nil) }
+    assert_raises(ArgumentError) { Fakturoid::Api.validate_numerical_id("nil") }
+    assert Fakturoid::Api.validate_numerical_id(15)
+    assert Fakturoid::Api.validate_numerical_id("15")
+  end
+  
+  should "raise argument error if search query is not given" do
+    assert_raises(ArgumentError) { Fakturoid::Api.validate_search_query(nil) }
+    assert_raises(ArgumentError) { Fakturoid::Api.validate_search_query("") }
+    assert Fakturoid::Api.validate_search_query("Company name")
+  end
+end

data/test/config_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class Fakturoid::ConfigTest < Fakturoid::TestCase
+  should "configure with block param" do
+    config = Fakturoid::Config.new do |config|
+      config.email   = 'test@email.cz'
+      config.api_key = 'XXXXXXXXXXX'
+      config.account = 'testaccount'
+      config.user_agent = 'My test app (test@email.cz)'
+    end
+    
+    assert_equal 'test@email.cz', config.email
+    assert_equal 'XXXXXXXXXXX',   config.api_key
+    assert_equal 'testaccount',   config.account
+    assert_equal 'My test app (test@email.cz)', config.user_agent
+  end
+  
+  should "use default user agent" do
+    config = Fakturoid::Config.new do |config|
+      config.email   = 'test@email.cz'
+      config.api_key = 'XXXXXXXXXXX'
+      config.account = 'testaccount'
+    end
+
+    assert_equal 'Fakturoid ruby gem (test@email.cz)', config.user_agent
+  end
+  
+  should "return correct endpoints" do
+    config = Fakturoid::Config.new do |config|
+      config.email   = 'test@email.cz'
+      config.api_key = 'XXXXXXXXXXX'
+      config.account = 'testaccount'
+    end
+    
+    assert_equal 'https://app.fakturoid.cz/api/v2/accounts/testaccount', config.endpoint
+    assert_equal 'https://app.fakturoid.cz/api/v2', config.endpoint_without_account
+  end
+end

data/test/fixtures/invoice.json

@@ -0,0 +1,81 @@
+{
+    "id": 5,
+    "proforma": false,
+    "number": "2012-0004",
+    "variable_symbol": "20120004",
+    "your_name": "Alexandr Hejsek",
+    "your_street": "Hopsinkov\u00e1 14",
+    "your_street2": null,
+    "your_city": "Praha",
+    "your_zip": "10000",
+    "your_country": "CZ",
+    "your_registration_no": "87654321",
+    "your_vat_no": "CZ87654321",
+    "client_name": "Microsoft a. s.",
+    "client_street": "Trojanova 1216/46",
+    "client_street2": null,
+    "client_city": "Praha",
+    "client_zip": "11000",
+    "client_country": "CZ",
+    "client_registration_no": "28444501",
+    "client_vat_no": "CZ28444501",
+    "subject_id": 4,
+    "generator_id": 4,
+    "related_id": null,
+    "correction": false,
+    "correction_id": null,
+    "token": "udDTG8Q88M",
+    "status": "paid",
+    "order_number": null,
+    "issued_on": "2011-10-13",
+    "taxable_fulfillment_due": "2011-10-13",
+    "due": 10,
+    "due_on": "2011-10-23",
+    "sent_at": null,
+    "paid_at": "2011-10-20T12:11:37+02:00",
+    "reminder_sent_at": null,
+    "accepted_at": null,
+    "cancelled_at": null,
+    "note": null,
+    "footer_note": null,
+    "bank_account": "1234/1234",
+    "iban": null,
+    "swift_bic": null,
+    "payment_method": "bank",
+    "currency": "CZK",
+    "exchange_rate": "1.0",
+    "language": "cz",
+    "transferred_tax_liability": false,
+    "vat_price_mode": "without_vat",
+    "subtotal": "40000.0",
+    "total": "48400.0",
+    "native_subtotal": "40000.0",
+    "native_total": "48400.0",
+    "lines": [
+        {
+            "id": 1234,
+            "name": "PC",
+            "quantity": "1.0",
+            "unit_name": "",
+            "unit_price": "20000.0",
+            "vat_rate": 21,
+            "unit_price_without_vat": "20000.0",
+            "unit_price_with_vat": "24200.0"
+        },
+        {
+            "id": 1235,
+            "name": "Notebook",
+            "quantity": "1.0",
+            "unit_name": "",
+            "unit_price": "20000.0",
+            "vat_rate": 21,
+            "unit_price_without_vat": "20000.0",
+            "unit_price_with_vat": "24200.0"
+        }
+    ],
+    "html_url": "https://app.fakturoid.cz/applecorp/invoices/9",
+    "public_html_url": "https://app.fakturoid.cz/applecorp/p/udDTG8Q88M/2012-0004",
+    "url": "https://app.fakturoid.cz/api/v2/accounts/applecorp/invoices/9.json",
+    "subject_url": "https://app.fakturoid.cz/api/v2/accounts/applecorp/subjects/4.json",
+    "updated_at": "2012-05-13T12:11:37+02:00"
+}

data/test/request_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class Fakturoid::RequestTest < Fakturoid::TestCase
+  should "should return pdf" do
+    pdf = load_fixture('invoice.pdf')
+    test_connection = Faraday.new do |builder|
+      builder.adapter :test do |stub|
+        stub.get('invoices/5/download.pdf') { |env| [ 200, {content_type: 'application/pdf'}, pdf ]}
+      end
+      builder.headers = { content_type: 'applicatoin/pdf' }
+    end
+    Fakturoid::Request.any_instance.stubs(:connection).returns(test_connection)
+    
+    response = Fakturoid::Request.new(:get, 'invoices/5/download.pdf', Fakturoid::Client::Invoice).call
+    assert !response.json?
+    assert_raises(NoMethodError) { response.name }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'shoulda-context'
+require 'pathname'
+require 'fakturoid'
+
+module Fakturoid
+  class TestCase < Minitest::Test
+    def test_path
+      Pathname.new(File.dirname(__FILE__))
+    end
+    
+    def load_fixture(file_name)
+      File.read(test_path.join('fixtures', file_name))
+    end
+  end
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: fakturoid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eda Riedl
+- Lukáš Konarovský
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  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
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  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: shoulda-context
+  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: mocha
+  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'
+description: Ruby client for web based invoicing service www.fakturoid.cz
+email:
+- podpora@fakturoid.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fakturoid.gemspec
+- lib/fakturoid.rb
+- lib/fakturoid/api.rb
+- lib/fakturoid/api/arguments.rb
+- lib/fakturoid/api/http_methods.rb
+- lib/fakturoid/client.rb
+- lib/fakturoid/client/account.rb
+- lib/fakturoid/client/bank_account.rb
+- lib/fakturoid/client/event.rb
+- lib/fakturoid/client/expense.rb
+- lib/fakturoid/client/generator.rb
+- lib/fakturoid/client/invoice.rb
+- lib/fakturoid/client/subject.rb
+- lib/fakturoid/client/todo.rb
+- lib/fakturoid/client/user.rb
+- lib/fakturoid/config.rb
+- lib/fakturoid/connection.rb
+- lib/fakturoid/railtie.rb
+- lib/fakturoid/request.rb
+- lib/fakturoid/response.rb
+- lib/fakturoid/version.rb
+- test/api_test.rb
+- test/config_test.rb
+- test/fixtures/invoice.json
+- test/fixtures/invoice.pdf
+- test/request_test.rb
+- test/test_helper.rb
+homepage: https://github.com/fakturoid/fakturoid-ruby
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby client for web based invoicing service www.fakturoid.cz
+test_files:
+- test/api_test.rb
+- test/config_test.rb
+- test/fixtures/invoice.json
+- test/fixtures/invoice.pdf
+- test/request_test.rb
+- test/test_helper.rb