invoice2go 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38e2b724f8ceed2662a5f4b2ebf22e26316c6812
+  data.tar.gz: 737e195013a9365a38a90cf17508e8f1722a1f15
+SHA512:
+  metadata.gz: 878b102378c66b0fc7ba4754bee920a5dd01355c110d30e797732989c21bf23058d9b381ab86fa5f50149433c87bc71c6e130d0648062ce3661801325308d22f
+  data.tar.gz: c0a0b739e3486495f2b33341dead7cf2b7f31483e3ed9e8a1f294da3a376f36deea1ec871bb55b0c849457c0e7152eff189597cfd6b2c963724cc9b1a5bed277

data/.gitignore

@@ -0,0 +1,18 @@
+.ruby-version
+.ruby-gemset
+.DS_Store
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 1.0.0 (2016-01-01)
+
+* First public gem release
+
+## 0.1.0
+
+* First release

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in service_monster.gemspec
+gemspec
+
+gem 'httpclient'
+gem 'patron'

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    invoice2go (0.0.2)
+      activesupport (~> 4.2)
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.10)
+      hashie (~> 3.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    byebug (8.2.1)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.0)
+      faraday (>= 0.7.4, < 0.10)
+    hashie (3.4.3)
+    httpclient (2.6.0.1)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.3)
+    multipart-post (2.0.0)
+    patron (0.5.0)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    safe_yaml (1.0.4)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  byebug (~> 8.2)
+  httpclient
+  invoice2go!
+  patron
+  rake (~> 10.4)
+  rspec (~> 3.1)
+  webmock (~> 1.6)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Customer Lobby
+
+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,58 @@
+# Invoice2go
+
+A Ruby wrapper for the Invoice2go REST API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'invoice2go'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install invoice2go
+
+## Usage
+
+### Configuration
+
+Before you can make calls to Invoice2go you must configure the library with a valid API Token. You can request
+a token be generated by Invoice2go. The API Token ties the API request to a particular Invoice2go company id.
+
+There are two ways to configure the gem. You can pass a hash of configuration options when you create
+a client, or you can use a configure block.
+
+```ruby
+client = Invoice2go.client({api_key: "YOUR_TOKEN_HERE"})
+```
+
+Middleware has been built in to automatically refresh the api_token when it expires if the details below are provided.
+
+```ruby
+Invoice2go.configure do |config|
+  config.api_key = "YOUR_TOKEN_HERE"
+  config.client_id = "YOUR_CLIENT_ID"
+  config.client_secret = "YOUR_CLIENT_SECRET"
+  config.refresh_token = "YOUR_REFRESH_TOKEN"
+end
+
+client = Invoice2go.client
+
+You can manually refresh the api and refresh tokens by calling client.refresh_token!
+```
+
+```
+There are only a limited number of calls available currently:
+
+client.accounts
+client.clients(account_id)
+client.documents(account_id)
+
+You can pass params to these calls as defined in the invoice2go api. i.e.
+
+client.documents(account_id, {page: 1, page_size: 1000})
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec "irb -r invoice2go -I ./lib"
+end

data/invoice2go.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'invoice2go/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "invoice2go"
+  spec.version       = Invoice2go::VERSION
+  spec.authors       = ["Customer Lobby"]
+  spec.email         = ["dev@customerlobby.com"]
+  spec.description   = %q{Client for the Invoice2go API}
+  spec.summary       = 'Client to interact with the Invoice2go API'
+  spec.homepage      = "https://bitbucket.org/customerlobby/invoice2go"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency('rspec', '~> 3.1')
+  spec.add_development_dependency('webmock', '~> 1.6')
+  spec.add_development_dependency('byebug', '~> 8.2')
+  spec.add_runtime_dependency('hashie', '~> 3.4')
+  spec.add_runtime_dependency('faraday', '~> 0.9')
+  spec.add_runtime_dependency('faraday_middleware', '~> 0.10')
+  spec.add_runtime_dependency('activesupport', '~> 4.2')
+end

data/lib/faraday/auth.rb

@@ -0,0 +1,14 @@
+module FaradayMiddleware
+  class Invoice2goAuth < Faraday::Middleware
+
+    def initialize(app, api_key)
+      @app          = app
+      @api_key      = api_key
+    end
+
+    def call(env)
+      env[:request_headers] = env[:request_headers].merge('Authorization' => "Bearer #{@api_key}")
+      @app.call env
+    end
+  end
+end

data/lib/invoice2go.rb

@@ -0,0 +1,25 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'active_support/all'
+require 'invoice2go/version'
+
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+require File.expand_path('../invoice2go/configuration', __FILE__)
+require File.expand_path('../invoice2go/api', __FILE__)
+require File.expand_path('../invoice2go/client', __FILE__)
+
+module Invoice2go
+
+  extend Configuration
+  # Alias for Invoice2go::Client.new
+  # @return [Invoice2go::Client]
+  def self.client(options = {})
+    Invoice2go::Client.new(options)
+  end
+
+  # Delegate to Invoice2go::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+end

data/lib/invoice2go/api.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../request', __FILE__)
+require File.expand_path('../response', __FILE__)
+require File.expand_path('../connection', __FILE__)
+
+module Invoice2go
+  class API
+
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    def initialize(options={})
+      options = Invoice2go.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    include Request
+    include Response
+    include Connection
+  end
+end

data/lib/invoice2go/client.rb

@@ -0,0 +1,10 @@
+module Invoice2go
+  # Wrapper for the Invoice2go REST API.
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+
+    include Invoice2go::Client::Accounts
+    include Invoice2go::Client::Documents
+    include Invoice2go::Client::Clients
+  end
+end

data/lib/invoice2go/client/accounts.rb

@@ -0,0 +1,13 @@
+module Invoice2go
+  class Client
+    module Accounts
+      def accounts(params = {})
+        get("accounts", params)
+      end
+
+      def account(id, params = {})
+        get("accounts/#{id}", params)
+      end
+    end
+  end
+end

data/lib/invoice2go/client/clients.rb

@@ -0,0 +1,9 @@
+module Invoice2go
+  class Client
+    module Clients
+      def clients(id, params = {})
+        get("accounts/#{id}/clients", params)
+      end
+    end
+  end
+end

data/lib/invoice2go/client/documents.rb

@@ -0,0 +1,13 @@
+module Invoice2go
+  class Client
+    module Documents
+      def documents(account_id, params = {})
+        get("accounts/#{account_id}/documents", params)
+      end
+
+      def document(account_id, id, params = {})
+        get("accounts/#{account_id}/documents/#{id}", params)
+      end
+    end
+  end
+end

data/lib/invoice2go/configuration.rb

@@ -0,0 +1,56 @@
+module Invoice2go
+  module Configuration
+
+    VALID_OPTIONS_KEYS = [
+      :api_key,
+      :api_version,
+      :adapter,
+      :endpoint,
+      :client_id,
+      :client_secret,
+      :grant_type,
+      :refresh_token
+    ].freeze
+
+    # By default don't set the api key.
+    DEFAULT_API_KEY = nil
+
+    # By default use V1 of the API.
+    DEFAULT_API_VERSION = ''.freeze
+
+    # Use the Patron adapter as default tends to break on certain headers.
+    DEFAULT_ADAPTER = Faraday::Adapter::Patron
+
+    # By default use the main api URL.
+    DEFAULT_ENDPOINT = 'https://api.2go.com'.freeze
+
+    # By default request JSON data to be returned from the API.
+    DEFAULT_FORMAT = :json
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # When this module is extended, reset all settings.
+    def self.extended(base)
+      base.reset
+    end
+
+    # Reset all configuration settings to default values.
+    def reset
+      self.api_key     = DEFAULT_API_KEY
+      self.api_version = DEFAULT_API_VERSION
+      self.endpoint    = DEFAULT_ENDPOINT
+      self.adapter     = DEFAULT_ADAPTER
+    end
+  end
+end

data/lib/invoice2go/connection.rb

@@ -0,0 +1,33 @@
+require 'faraday_middleware'
+require 'httpclient'
+require 'patron'
+
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module Invoice2go
+  module Connection
+    private
+
+    def connection
+      options = { url: endpoint }
+
+      Faraday::Connection.new(options) do |connection|
+        connection.use FaradayMiddleware::Invoice2goAuth, api_key
+        connection.use FaradayMiddleware::Mashify
+        connection.use Faraday::Response::RaiseError
+        connection.request  :url_encoded
+        connection.response :json, :content_type => 'application/json'
+        connection.adapter :patron
+      end
+    end
+
+    def connection_refresh
+      Faraday::Connection.new('https://oauth.2go.com/identity/connect/token') do |connection|
+        connection.use FaradayMiddleware::Mashify
+        connection.request  :url_encoded
+        connection.response :json, :content_type => /\bjson$/
+        connection.adapter :patron
+      end
+    end
+  end
+end