fortnox-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f1466d40cd25ca27f10b6fa317327c3bcba7236
-  data.tar.gz: a9fcefa8243d5cb60a65d245f2ebeddc71fff753
+  metadata.gz: 6bca3361bd95f700ce751571429bc8463554b7d7
+  data.tar.gz: be033a769fa8d6bf4ca66ec4891b7d244826706c
 SHA512:
-  metadata.gz: ec7fc6f96555849d2d08d99e92dbaacab3e1e79283e84f839c761afa48132905e8f4c7fd794a2fac2f613d2e35931073932d350a22852d686ea904f67f55e6ea
-  data.tar.gz: 7525f5ee4e7ccd3aa903bd4eb9f8e230d740b8cd775eaf0c1434f8b27b0c88e93a0c161324e29aad4e01078cc2e1a3fdfd5b5cc0d3dd366fb573820670e60dd0
+  metadata.gz: eb4e66f6bf2cf68ac7c2221f44a5e2e3b1e2fe82e6506ff5d409d24f37b347dca2c757dc53cbc861d673cb38cb14c213d383805e007062c4feacde911d16ce90
+  data.tar.gz: 53978bd089c4023f1cbaccd21b643663bb014217f98c4dfa850df792b85a4dd12e893f33f2371662b52c228a0ae8e05fb9b3588bdfd4858e60511f72bc331b60

data/.gitignore

@@ -1,17 +1,3 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+.DS_Store
+.env
+.rspec

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - "2.0.0"
+  - "2.1.6"
+  - "2.2.2"

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,127 @@
+PATH
+  remote: .
+  specs:
+    fortnox-api (0.0.2)
+      dotenv (~> 2.0)
+      httparty (~> 0.13)
+      vanguard (~> 0.0)
+      virtus (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.7)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    addressable (2.3.8)
+    anima (0.2.0)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.1)
+      equalizer (~> 0.0.8)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    dotenv (2.0.1)
+    equalizer (0.0.11)
+    ffi (1.9.8)
+    formatador (0.2.5)
+    guard (2.12.5)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.5.0)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hitimes (1.2.2)
+    httparty (0.13.3)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    ice_nine (0.11.1)
+    json (1.8.2)
+    listen (2.10.0)
+      celluloid (~> 0.16.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    method_source (0.8.2)
+    multi_xml (0.5.5)
+    nenv (0.2.0)
+    notiffany (0.0.6)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    safe_yaml (1.0.4)
+    shellany (0.0.1)
+    slop (3.6.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    timers (4.0.1)
+      hitimes
+    vanguard (0.0.5)
+      abstract_type (~> 0.0.6)
+      adamantium (~> 0.2.0)
+      anima (~> 0.2.0)
+      descendants_tracker (~> 0.0.1)
+      equalizer (~> 0.0.9)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.9)
+  fortnox-api!
+  guard (~> 2.12)
+  guard-rspec (~> 4.5)
+  pry
+  rake (~> 10.4)
+  rspec (~> 3.2)
+  webmock (~> 1.21)

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'bundle exec rspec --color', all_after_pass: true do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Jonas Schubert Erlandsson
+Copyright (c) 2014-2015 Jonas Schubert Erlandsson
 
 MIT License
 

data/README.md

@@ -1,28 +1,152 @@
-# Fortnox::Api
+# Fortnox::API
 
-TODO: Write a gem description
+Wrapper gem for Fortnox AB's version 3 API.
+
+[![Gem Version](https://badge.fury.io/rb/fortnox-api.png)](http://badge.fury.io/rb/fortnox-api)
+[![Build Status](https://travis-ci.org/my-codeworks/fortnox-api.png)](https://travis-ci.org/my-codeworks/fortnox-api)
+[![Code Climate](https://codeclimate.com/github/my-codeworks/fortnox-api.png)](https://codeclimate.com/github/my-codeworks/fortnox-api)
+[![Dependency Status](https://gemnasium.com/my-codeworks/fortnox-api.svg)](https://gemnasium.com/my-codeworks/fortnox-api)
+
+## Features
+
+Quick overview of the current status of this gem vs the API it integrates
+against:
+
+API resource                               | Status
+------------------------------------------ | --------
+Exchange AuthorizationCode for AccessToken | :white_check_mark:
+Entity base class with immutability        | :white_check_mark:
+Validator base class based on Vanguard     | :white_check_mark:
+Customer::Validator                        | :white_check_mark:
+Customers                                  | :hourglass:
+Repository READ from API functionality     | :hourglass:
+
+## Requirements
+
+This gem is build for Ruby 2.0 or higher, it's tested agains Ruby 2.0.0 and
+2.1.2. Since it uses the keywords argument feature it won't work on Ruby 1.9.
+
+If you want or need Ruby 1.9 compatability please contact us or better yet,
+submit a pull request. Instructions are to be found below :)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'fortnox-api'
+```ruby
+gem 'fortnox-api'
+```
 
 And then execute:
 
-    $ bundle
+```shell
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install fortnox-api
+```shell
+$ gem install fortnox-api
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Getting an AccessToken
+
+Unless you have an AccessToken already you will need to exchange your
+AuthorizationCode for one to make calls. In a ruby shell do the following
+
+```ruby
+require 'fortnox-api' # Load the gem, it needs to be installed first
+Fortnox::API.get_access_token(
+  base_url: 'https://api.fortnox.se/3',
+  client_secret: 'P5K5wE3Kun',
+  authorization_code: 'ea3862b1-189c-464b-8e25-1b9702365fa1',
+)
+```
+
+This will output a new token like `3f08d038-f380-4893-94a0a0-8f6e60e67a` that is
+your access token, **save it!** You will need to save it since it will be used
+every time you instansiate a Fortnox::API object.
+
+### Using environment variables
+
+You can save your settings in environment variables that will be used by the gem
+when you instantiate it. The following variables are recognized:
+
+```
+FORTNOX_API_BASE_URL
+FORTNOX_API_CLIENT_SECRET
+FORTNOX_API_ACCESS_TOKEN
+FORTNOX_API_AUTHORIZATION_CODE
+```
+
+Their values should match their name. Note that the authorization code is only
+ever used once and only when you call the `get_access_token` method described
+above.
+
+### Collections
+
+To get something to work with you instantiate a new Fortnox::API object
+
+```ruby
+fortnox = Fortnox::API.new(
+  base_url: 'https://api.fortnox.se/3',
+  client_secret: 'P5K5wE3Kun',
+  access_token: '3f08d038-f380-4893-94a0a0-8f6e60e67a',
+)
+```
+
+On this you can then call things like
+
+```ruby
+# Get a list of all the customers (slow, don't use unless you have to)
+fortnox.customer.all #=> [<Fortnox::API::Customer:0x007fdf21033ee8>, <Fortnox::API::Customer:0x007fdf22994310>, ... ]
+
+# Get single customer by id
+fortnox.customer.find( 5 ) #=> <Fortnox::API::Customer:0x007fdf21100b00>
+
+# Get single customer by customer number
+fortnox.customer.find_by( customer_number: 5 ) #=> <Fortnox::API::Customer:0x007fdf22949298>
+
+# Get all customers matching some criteria
+fortnox.customer.find_all_by( name: 'test' ) #=> [<Fortnox::API::Customer:0x007fdf22949298>, ... ]
+```
+
+### Entities
+
+All the above methods return instances or arrays of instances of some resource
+class such as customer, invoice, item, voucher and so on.
+
+Instances are immutable and any update returns a new instance with the
+appropriate attributes changed.
+
+> :warning: Ruby implements assignment statements so that `LHS = RHS`
+> always returns `RHS`. This is regardless of what an assignment method is
+> implemented to return.
+>
+> This means that assignments like `customer.name = 'Test'` will return
+> `'Test'` and not a new instance of `Customer`, which is what you want in this
+> case. So assignment methods to update objects is not possible. Use the
+> `.update()` method instead.
+
+Each entity class has it's own methods and properties but they also all respond
+to a few common methods, such as for persistence.
+
+```ruby
+customer #=> <Fortnox::API::Customer:0x007fdf228db310>
+customer.name #=> "Nelly Bloom"
+customer.update( name: "Ned Stark" ) #=> <Fortnox::API::Customer:0x0193a456ff0307>
+customer.name #=> "Nelly Bloom"
+updated_customer = customer.update( name: "Ned Stark" )
+updated_customer.name #=> "Nelly Bloom"
+updated_customer.save #=> true on success or false on failure
+updated_customer.save! #=> true on success or raises Fortnox::API::RequestFailed exception on failure
+```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/fortnox-api/fork )
+1. Fork it ( http://github.com/my-codeworks/fortnox-api/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`)

data/Rakefile

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

data/fortnox-api.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jonas Schubert Erlandsson"]
   spec.email         = ["jonas.schubert.erlandsson@my-codeworks.com"]
   spec.summary       = "Gem to use Fortnox REST API in Ruby."
-  spec.description   = "This gem uses an HTTP library to abstract the REST calls from everyday use. Simply use the builtin classes to create, access, update and destroy entries in your Fortnox database."
+  spec.description   = "This gem uses the HTTParty library to abstract away the REST calls. It gives you access to a number of objects that behave a lot like ActiveRecord instances, giving you access to methods like `all`, `find`, `find_by_...` and so on. And each individual instance can be easaly persistable to Fortnox again using the `save` method."
   spec.homepage      = "http://github.com/my-codeworks/fortnox-api"
   spec.license       = "MIT"
 
@@ -18,6 +18,16 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  spec.add_dependency "httparty", "~> 0.13"
+  spec.add_dependency "dotenv", "~> 2.0"
+  spec.add_dependency "virtus", "~> 1.0"
+  spec.add_dependency "vanguard", "~> 0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "guard", "~> 2.12"
+  spec.add_development_dependency "guard-rspec", "~> 4.5"
+  spec.add_development_dependency "webmock", "~> 1.21"
+  spec.add_development_dependency "pry"
 end

data/lib/fortnox/api.rb

@@ -1,7 +1,17 @@
+require "set"
+require "dotenv"
 require "fortnox/api/version"
+require "fortnox/api/customer"
+
+Dotenv.load unless ENV['RUBY_ENV'] == 'test'
 
 module Fortnox
   module API
-    # Your code goes here...
+
+    class << self
+      extend Forwardable
+      delegate [ :new, :get_access_token ] => Fortnox::API::Base
+    end
+
   end
 end

data/lib/fortnox/api/base.rb

@@ -0,0 +1,56 @@
+require "fortnox/api/class_methods"
+require "httparty"
+
+module Fortnox
+  module API
+    class Base
+
+      include HTTParty
+      extend Forwardable
+      extend Fortnox::API::ClassMethods
+
+      def_delegators self, :set_header, :set_headers, :remove_header,
+        :remove_headers, :validate_base_url, :validate_client_secret,
+        :validate_access_token, :validate_authorization_code
+
+      def initialize( base_url: nil, client_secret: nil, access_token: nil )
+        base_url = validate_base_url( base_url )
+        client_secret = validate_client_secret( client_secret )
+        access_token = validate_access_token( access_token )
+
+        self.class.base_uri( base_url )
+
+        set_headers(
+          'Accept' => 'application/json',
+          'Client-Secret' => client_secret,
+          'Access-Token' => access_token,
+        )
+      end
+
+      def get( *args )
+        resp = self.class.get( *args )
+        # Insert error handling here
+        resp.parsed_response
+      end
+
+      def put( *args )
+        resp = self.class.get( *args )
+        # Insert error handling here
+        resp.parsed_response
+      end
+
+      def post( *args )
+        resp = self.class.get( *args )
+        # Insert error handling here
+        resp.parsed_response
+      end
+
+      def delete( *args )
+        resp = self.class.get( *args )
+        # Insert error handling here
+        resp.parsed_response
+      end
+
+    end
+  end
+end