freshbooks_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 748fc62390ccbf1098d43cd5fb6d90fd02a99b6f
+  data.tar.gz: 377f8cb452c673762cf61764b2e3d06e83f48294
+SHA512:
+  metadata.gz: 27b485e8a759689419a28cce1a15399f896dc8e61e53034b83ddfbe29aa62bf2f833e311917937f68ef6b4c64dc607b8e37720770252a2f4ac506bec9600c70a
+  data.tar.gz: 9194fef7e8739d2d04590583fee7e0895d3bf078255863d773832a44b203cf7a1b8d7bd24cbfb5e7b345d5e0d8e14d91cf9d81b21bebbe9b54670e325dba977a

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+- 2.2.2
+before_install: gem install bundler -v 1.10.5
+env:
+  global:
+  - secure: Cj3e9OkrWcIUvjW7hsVwMlBOPdZaiVw163xig0gIi/L5V7wQXj3cDj2V0kHBuo9NGGp18E91TBOhhWFuYLRCnsE/1K3YLB7B9zvyvw/ZB9Sy2EovlieJksd8c5kf5mM4hip68Aer9v7VuC5WMB/NfDWgPfVy5n8G+Uu1Dtdw9fHEouIthExubGW7f/gZ+L5/VHfWZkaC2Rqb+3UVIYjpNre/+8ihOdWI0LVd1Xz3n7mKmKNzu/CZlE1QkP25q2OQ9dEvxX3+Y6NtBLdDk5V6y7/pbB3+JfuAF3hgio2KKp7BnLimMbip3tQ3ZyhVYRrnLVjOJnHsIYHacgb5h9Hs4wcN77WUX/RvjyAIbdXMxa4ubJJeLK2zeo+1Eo6bJs2FQ/O8qi9VBSIEsXEyclv8DH2k3ODTjBVxF+GJNES9LCNqXVnPhKC2/klTcyS5DXm2GiTgxicgreqj/wuI1NoxSvGINp58u/TAoyNZ03W7Xu+IAISgCFQtoRxuEM7S2AIJ4SkQnYUwAFXz3JU5uy16X1o+i0UI26YQN8eYN7tQ/P7LXQW2FHtGxL+7I2KgCgSkF0OY87y087Ppi3F0fDl/kzCOuJKFVo7Wpk3Y18Ha/H87OC4A8uKxeONfVAo7gV2/MR8Ii+paN9sZzyl/tg4Lldj2vR9PZy4b06ziw7/2XVU=
+  - secure: CEJSSVJyjJZJYv3rSkxZdv+XkeQYFB8Wdi7r7qVA2+pbefcNirRJdwD3/qeiZyzMUri1wY5Sbj9FkgFzXHpM7QH4/2OKylWu59y/QdWqS3Ad0DGhfZ/eu56qYIpRfHekkQSLCrnSkDzgDWc4Q1L9/izY6kS872lkJS+guZ3FVgxc/As7+aPJh4hcVfZfUcJakLN12dl7fgf6SWRKj00MYbpvQPGaK2pcQhTsjVOqcC/R3wSKCDvTb4W1eDY1mTtNP2NFjvPX7yQMlkSyDQMNP95jcD0i1/mE2dmPDBqzs1qgrCYEyGR1SVgUtzpJOm1jc/ff4wohtQVEFNym9sensTOXx7JxPORNBGcxN3K0mjoymHTO+hKzGxU8HcVE1oJ4C2XNitaO4vFFss3LugDpBR5zC4Pk/jYaCIH+hqtUtMpUawLjqsW1JBrFiRRNXHF8xlKd04PlAk5i6CTJRKkDPsifNFwxkwE2AYfa7hDyuTqOdC7G97tb+8Jwbgzj/paMj6YOoBnZNgC697emAtA9QHhxPXVN5S+29aPrkqAtqeuDRR5sNWai5oTZZ88U0VBrvLCcwomLGMgLhensN9cGWcpVlFcEL6gJyCLRaxm1tcKPc9NiAUrSClaks4yI278XpDqyYwzTqrgH863bg+OSqqwZYVNTofqJL9SGbbdQv9Y=

data/Gemfile

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

data/README.md

@@ -0,0 +1,8 @@
+# Freshbooks API Client
+
+![Inch
+Documentation](http://inch-ci.org/github/littlelines/freshbooks_client.svg?branch=master)
+[![Build Status](http://img.shields.io/travis/littlelines/freshbooks_client.svg)](https://travis-ci.org/littlelines/freshbooks_client)
+[![Dependency Status](http://img.shields.io/gemnasium/littlelines/freshbooks_client.svg)](https://gemnasium.com/littlelines/freshbooks_client)
+[![Code Climate](http://img.shields.io/codeclimate/github/littlelines/freshbooks_client.svg)](https://codeclimate.com/github/littlelines/freshbooks_client)
+[![Gem Version](http://img.shields.io/gem/v/freshbooks_client.svg)](https://rubygems.org/gems/freshbooks_client)

data/Rakefile

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

data/bin/console

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "freshbooks"
+
+# 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 "pry"
+require "dotenv"
+
+Dotenv.load
+
+@client = Freshbooks::Client.new do |config|
+  config.api_url = ENV['BASE_URL']
+  config.token = ENV['TOKEN']
+end
+
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/freshbooks_client.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freshbooks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "freshbooks_client"
+  spec.version       = Freshbooks::VERSION
+  spec.authors       = ["Jesse Herrick"]
+  spec.email         = ["jesse@littlelines.com"]
+
+  spec.summary       = %q{An awesome API client for Freshbooks.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/littlelines/freshbooks_client"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "multi_xml", "~> 0.5.5"
+  spec.add_runtime_dependency "nokogiri", "~> 1.6.6"
+  spec.add_runtime_dependency "hashie", "~> 3.4.2"
+  spec.add_runtime_dependency "faraday_middleware", "~> 0.10.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "simplecov"
+end

data/lib/freshbooks.rb

@@ -0,0 +1,30 @@
+require 'freshbooks/version'
+require 'freshbooks/api/methods'
+require 'freshbooks/api/crud'
+require 'freshbooks/api/no_crud'
+require 'freshbooks/api/no_cd'
+require 'freshbooks/api/no_crudl'
+require 'freshbooks/client'
+require 'freshbooks/api/callback'
+require 'freshbooks/api/category'
+require 'freshbooks/api/client'
+require 'freshbooks/api/estimate'
+require 'freshbooks/api/expense'
+require 'freshbooks/api/gateway'
+require 'freshbooks/api/invoice'
+require 'freshbooks/api/item'
+require 'freshbooks/api/language'
+require 'freshbooks/api/payment'
+require 'freshbooks/api/project'
+require 'freshbooks/api/receipt'
+require 'freshbooks/api/recurring'
+require 'freshbooks/api/staff'
+require 'freshbooks/api/system'
+require 'freshbooks/api/task'
+require 'freshbooks/api/tax'
+require 'freshbooks/api/time_entry'
+require 'freshbooks/api/contractor'
+require 'freshbooks/api/default_term'
+require 'freshbooks/api/report'
+require 'freshbooks/api/currency'
+require 'freshbooks/api/email_template'

data/lib/freshbooks/api/callback.rb

@@ -0,0 +1,23 @@
+module Freshbooks
+  # A namespace for all classes and methods making direct calls to the
+  # Freshbooks API.
+  module API
+    # http://www.freshbooks.com/developers/docs/callbacks
+    class Callback < Freshbooks::Client
+      # Verifies a callback using a unique verification code.
+      #
+      # @param params [Hash] a hash of params to verify a callback
+      def verify(params = {})
+        call('callback.verify', callback: params)
+      end
+
+      # Resends a verification code to an unverified callback.
+      #
+      # @param params [Hash] a hash of params to resend a callback token
+      def resend_token(params = {})
+        call('callback.resendToken', params)
+      end
+    end
+  end
+end
+

data/lib/freshbooks/api/category.rb

@@ -0,0 +1,8 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/categories
+    class Category < Freshbooks::Client
+      # CRUD
+    end
+  end
+end

data/lib/freshbooks/api/client.rb

@@ -0,0 +1,8 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/clients
+    class Client < Freshbooks::Client
+      # CRUD
+    end
+  end
+end

data/lib/freshbooks/api/contractor.rb

@@ -0,0 +1,8 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/contractors
+    class Contractor < Freshbooks::Client
+      # CRUD
+    end
+  end
+end

data/lib/freshbooks/api/crud.rb

@@ -0,0 +1,61 @@
+module Freshbooks
+  module API
+    # Methods for CRUD in [Freshbooks::Client].
+    module CRUD
+      # Creates something based on params.
+      #
+      # @example Create a new project.
+      #   @clients.projects.create(name: "Some Project", bill_method: "project-rate")
+      #   # => { "project_id" => "1234" }
+      #
+      # @param params [Hash] A hash of params to create something.
+      def create(params = {})
+        call("#{@endpoint}.create", { @endpoint => params })
+      end
+
+      # Updates something based on params.
+      #
+      # @example Update an existing project.
+      #   @client.projects.update(project_id: 1234, bill_method: "credit-card")
+      #   # => { "project_id" => "1234" }
+      #
+      # @param params [Hash] A hash of params to update something.
+      def update(params = {})
+        call("#{@endpoint}.update", { @endpoint => params })
+      end
+
+      # Get something's details based on the `<something>_id`.
+      #
+      # @example Get a project by `project_id`.
+      #   @client.projects.get(project_id: 1234)
+      #   # => {"projects" => [...]}
+      #
+      # @param params [Hash] A hash of params to get something's details.
+      def get(params = {})
+        call("#{@endpoint}.get", params)
+      end
+
+      # Delete something based on its `<something>_id`.
+      #
+      # @example Delete a project.
+      #   @client.projects.delete(project_id: 1234)
+      #   # => 200 OK
+      #
+      # @param params [Hash] A hash of params to delete something.
+      def delete(params = {})
+        call("#{@endpoint}.delete", params)
+      end
+
+      # List a bunch of somethings.
+      #
+      # @example List all projects.
+      #   @client.projects.list
+      #   # => {"projects" => [...]}
+      #
+      # @param params [Hash] A hash of params ot filter the listing.
+      def list(params = {})
+        call("#{@endpoint}.list", params)
+      end
+    end
+  end
+end

data/lib/freshbooks/api/currency.rb

@@ -0,0 +1,8 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/currency
+    class Currency < Freshbooks::Client
+      include Freshbooks::API::NoCRUD
+    end
+  end
+end

data/lib/freshbooks/api/default_term.rb

@@ -0,0 +1,21 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/default_terms
+    class DefaultTerm < Freshbooks::Client
+      include NoCD
+
+      # List/Get/Update
+      def list(params = {})
+        call('default_terms.list', params)
+      end
+
+      def get(params = {})
+        call('default_terms.get', params)
+      end
+
+      def update(params = {})
+        call('default_terms.update', params)
+      end
+    end
+  end
+end

data/lib/freshbooks/api/email_template.rb

@@ -0,0 +1,8 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/email_templates
+    class EmailTemplate < Freshbooks::Client
+      include NoCD
+    end
+  end
+end

data/lib/freshbooks/api/estimate.rb

@@ -0,0 +1,34 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/estimates
+    class Estimate < Freshbooks::Client
+      # Send an estimate to the associated client via e-mail.
+      #
+      # @param params [Hash] A hash of params to send an estimate via email.
+      def send_by_email(params = {})
+        call('estimate.sendByEmail', params)
+      end
+
+      # Returns the specified estimate in PDF format.
+      #
+      # @param params [Hash] A hash of params to get an estimate's PDF.
+      def get_pdf(params = {})
+        call('estimate.getPDF', params)
+      end
+
+      # Change an existing estimate's status to "Accepted".
+      #
+      # @param params [Hash] A hash of params to accept an estimate.
+      def accept(params = {})
+        call('estimate.accept', params)
+      end
+
+      # Move a draft estimate into "Sent" status without issuing the estimate.
+      #
+      # @param params [Hash] A hash of params to mark a draft estimate as sent.
+      def mark_as_sent(params = {})
+        call('markAsSent', params)
+      end
+    end
+  end
+end

data/lib/freshbooks/api/expense.rb

@@ -0,0 +1,8 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/expenses
+    class Expense < Freshbooks::Client
+      # CRUD
+    end
+  end
+end

data/lib/freshbooks/api/gateway.rb

@@ -0,0 +1,8 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/gateway
+    class Gateway < Freshbooks::Client
+      include Freshbooks::API::NoCRUD
+    end
+  end
+end

data/lib/freshbooks/api/invoice.rb

@@ -0,0 +1,41 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/invoices#invoice.getPDF
+    class Invoice < Freshbooks::Client
+      # CRUD
+
+      # Returns the specified invoice in PDF format.
+      def get_pdf(params = {})
+        call('invoice.getPDF', params)
+      end
+
+      # Send an existing invoice to your client via e-mail.
+      def send_by_email(params = {})
+        call('invoice.sendByEmail', params)
+      end
+
+      # Send an existing invoice to your client via snail mail.
+      def send_by_snail_mail(params = {})
+        call('invoice.sendBySnailMail', params)
+      end
+
+      # Adds a new line/lines to an existing invoice.
+      def add_lines(params = {})
+        call('invoice.lines.add', params)
+      end
+      alias_method :add_line, :add_lines
+
+      # Deletes a line from an existing invoice.
+      def delete_lines(params = {})
+        call('invoice.lines.delete', params)
+      end
+      alias_method :delete_line, :delete_lines
+
+      # Updates a line on an existing invoice.
+      def update_lines(params = {})
+        call('invoice.lines.update', params)
+      end
+      alias_method :update_line, :update_lines
+    end
+  end
+end

data/lib/freshbooks/api/item.rb

@@ -0,0 +1,8 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/items
+    class Item < Freshbooks::Client
+      # CRUD
+    end
+  end
+end

data/lib/freshbooks/api/language.rb

@@ -0,0 +1,8 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/languages
+    class Language < Freshbooks::Client
+      include Freshbooks::API::NoCRUD
+    end
+  end
+end

data/lib/freshbooks/api/methods.rb

@@ -0,0 +1,119 @@
+module Freshbooks::API
+  # Defines methods for accessing API endpoints from the main [Freshbooks::Client] class.
+  module Methods
+    # @return [Freshbooks::API::Callback]
+    def callbacks
+      Freshbooks::API::Callback.new(options)
+    end
+
+    # @return [Freshbooks::API::Category]
+    def categories
+      Freshbooks::API::Category.new(options)
+    end
+
+    # @return [Freshbooks::API::Client]
+    def clients
+      Freshbooks::API::Client.new(options)
+    end
+
+    # @return [Freshbooks::API::Estimate]
+    def estimates
+      Freshbooks::API::Estimate.new(options)
+    end
+
+    # @return [Freshbooks::API::Expense]
+    def expenses
+      Freshbooks::API::Expense.new(options)
+    end
+
+    # @return [Freshbooks::API::Gateway]
+    def gateways
+      Freshbooks::API::Gateway.new(options)
+    end
+
+    # @return [Freshbooks::API::Invoice]
+    def invoices
+      Freshbooks::API::Invoice.new(options)
+    end
+
+    # @return [Freshbooks::API::Item]
+    def items
+      Freshbooks::API::Item.new(options)
+    end
+
+    # @return [Freshbooks::API::Language]
+    def languages
+      Freshbooks::API::Language.new(options)
+    end
+
+    # @return [Freshbooks::API::Payment]
+    def payments
+      Freshbooks::API::Payment.new(options)
+    end
+
+    # @return [Freshbooks::API::Project]
+    def projects
+      Freshbooks::API::Project.new(options)
+    end
+
+    # @return [Freshbooks::API::Receipt]
+    def receipts
+      Freshbooks::API::Receipt.new(options)
+    end
+
+    # @return [Freshbooks::API::Recurring]
+    def recurring
+      Freshbooks::API::Recurring.new(options)
+    end
+
+    # @return [Freshbooks::API::Staff]
+    def staff
+      Freshbooks::API::Staff.new(options)
+    end
+
+    # @return [Freshbooks::API::System]
+    def systems
+      Freshbooks::API::System.new(options)
+    end
+
+    # @return [Freshbooks::API::Task]
+    def tasks
+      Freshbooks::API::Task.new(options)
+    end
+
+    # @return [Freshbooks::API::Tax]
+    def taxes
+      Freshbooks::API::Tax.new(options)
+    end
+
+    # @return [Freshbooks::API::TimeEntry]
+    def time_entries
+      Freshbooks::API::TimeEntry.new(options)
+    end
+
+    # @return [Freshbooks::API::Contractor]
+    def contractors
+      Freshbooks::API::Contractor.new(options)
+    end
+
+    # @return [Freshbooks::API::DefaultTerm]
+    def default_terms
+      Freshbooks::API::DefaultTerm.new(options)
+    end
+
+    # @return [Freshbooks::API::Report]
+    def reports
+      Freshbooks::API::Report.new(options)
+    end
+
+    # @return [Freshbooks::API::Currency]
+    def currencies
+      Freshbooks::API::Currency.new(options)
+    end
+
+    # @return [Freshbooks::API::EmailTemplate]
+    def email_templates
+      Freshbooks::API::EmailTemplate.new(options)
+    end
+  end
+end

data/lib/freshbooks/api/no_cd.rb

@@ -0,0 +1,15 @@
+module Freshbooks
+  module API
+    # Prevents default create and delete ability in [Freshbooks::Client].
+    module NoCD
+      def self.included(_)
+        [:create, :delete].each do |method|
+          define_method method do
+            abort "Sorry, this endpoint has no CRUD or listing actions."
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freshbooks/api/no_crud.rb

@@ -0,0 +1,18 @@
+module Freshbooks
+  module API
+    # Prevents default CRUD ability in [Freshbooks::Client].
+    module NoCRUD
+      def self.included(_)
+        no_crud
+      end
+
+      def self.no_crud
+        [:create, :get, :update, :delete].each do |method|
+          define_method method do
+            abort "Sorry, this endpoint only has a listing action."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freshbooks/api/no_crudl.rb

@@ -0,0 +1,15 @@
+module Freshbooks
+  module API
+    # Prevents default CRUD and listing ability in [Freshbooks::Client].
+    module NoCRUDL
+      def self.included(_)
+        include NoCRUD
+
+        define_method :list do
+          abort "Sorry, this endpoint has no CRUD or listing actions."
+
+        end
+      end
+    end
+  end
+end

data/lib/freshbooks/api/payment.rb

@@ -0,0 +1,8 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/payments
+    class Payment < Freshbooks::Client
+      # CRUD
+    end
+  end
+end

data/lib/freshbooks/api/project.rb

@@ -0,0 +1,8 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/projects
+    class Project < Freshbooks::Client
+      # CRUD
+    end
+  end
+end

data/lib/freshbooks/api/receipt.rb

@@ -0,0 +1,12 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/receipts
+    class Receipt < Freshbooks::Client
+      # CRUD (no index)
+
+      def list(params = {})
+        abort "Sorry, this endpoint doesn't have a listing action."
+      end
+    end
+  end
+end

data/lib/freshbooks/api/recurring.rb

@@ -0,0 +1,26 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/recurring
+    class Recurring < Freshbooks::Client
+      # CRUD
+
+      # Add a new line/lines to an existing recurring profile.
+      def add_lines(params = {})
+        call('recurring.lines.add', params)
+      end
+      alias_method :add_line, :add_lines
+
+      # Deletes a single line from an existing recurring profile.
+      def delete_lines(params = {})
+        call('recurring.lines.delete', params)
+      end
+      alias_method :delete_line, :delete_lines
+
+      # Updates an existing line/lines on an existing recurring profile.
+      def update_lines(params = {})
+        call('recurring.lines.update', params)
+      end
+      alias_method :update_line, :update_lines
+    end
+  end
+end

data/lib/freshbooks/api/report.rb

@@ -0,0 +1,33 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/reports
+    class Report < Freshbooks::Client
+      include Freshbooks::API::NoCRUDL
+
+      # Returns profit and account standing details for the specified client.
+      def get_client_details(params = {})
+        call('report.getClientDetails', params)
+      end
+
+      # Returns total estimated, accepted and invoiced values for invoices; broken down by currency.
+      def get_estimate_details(params = {})
+        call('report.getEstimateDetails', params)
+      end
+
+      # Returns information about all, or a filtered set of expenses.
+      def get_expense_details(params = {})
+        call('report.getExpenseDetails', params)
+      end
+
+      # Returns information about all, or a filtered set of invoices.
+      def get_invoice_details(params = {})
+        call('report.getInvoiceDetails', params)
+      end
+
+      # Reports profit and loss details.
+      def get_profit_details(params = {})
+        call('report.getProfitDetails', params)
+      end
+    end
+  end
+end

data/lib/freshbooks/api/staff.rb

@@ -0,0 +1,13 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/staff
+    class Staff < Freshbooks::Client
+      # CRUD
+
+      # Returns the current user's details.
+      def current(params = {})
+        call('staff.current', params)
+      end
+    end
+  end
+end

data/lib/freshbooks/api/system.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/system
+    class System < Freshbooks::Client
+      include Freshbooks::API::NoCRUDL
+
+      # Returns the current system’s information (beta).
+      def current(params = {})
+        call('system.current', params)
+      end
+    end
+  end
+end

data/lib/freshbooks/api/task.rb

@@ -0,0 +1,8 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/tasks
+    class Task < Freshbooks::Client
+      # CRUD
+    end
+  end
+end

data/lib/freshbooks/api/tax.rb

@@ -0,0 +1,8 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/taxes
+    class Tax < Freshbooks::Client
+      # CRUD
+    end
+  end
+end

data/lib/freshbooks/api/time_entry.rb

@@ -0,0 +1,8 @@
+module Freshbooks
+  module API
+    # http://www.freshbooks.com/developers/docs/time-entries
+    class TimeEntry < Freshbooks::Client
+      # CRUD
+    end
+  end
+end

data/lib/freshbooks/client.rb

@@ -0,0 +1,169 @@
+require 'multi_xml'
+require 'faraday'
+require 'faraday_middleware'
+require 'hashie'
+
+# Namespace for all methods, attributes, and classes used to
+# wrap the Freshbooks API.
+module Freshbooks
+  # Superclass that contains all logic and methods needed to send
+  # and parse XML from the Freshbooks API.
+  #
+  # @author Jesse Herrick
+  # @abstract
+  # @since 0.1.0
+  #
+  # @attr [String] token auth token provided by Freshbooks
+  # @attr [String] api_url the base URL of the API endpoint provided
+  #                by Freshbooks
+  class Client
+    attr_accessor :token
+    attr_accessor :api_url
+
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+
+      @endpoint = underscore(self.class.to_s.split('::').last)
+
+      yield(self) if block_given?
+    end
+
+    include Freshbooks::API::Methods
+    include Freshbooks::API::CRUD
+
+    # Makes an API call via the #post method.
+    #
+    # @param method [String] The API method as defined in the Freshbooks API docs.
+    # @param struct [Array] All required parameters for the request.
+    # @param params [Hash] The parameters passed to the request.
+    #
+    # @example Create a callback.
+    #   call('callback.create', [:event, :uri], {event: 'Foo', uri: 'https://jesse.codes/'})
+    #   # => {...}
+    #
+    # @example List projects.
+    #   call('project.list')
+    #   # => {...}
+    #
+    # @return [Hash] An API request hash.
+    def call(method, params = {})
+      # unless params.empty?
+      #   # ensure that params definied in the struct exist
+      #   struct.each do |p|
+      #     body[p] = params.fetch(p)
+      #     params.delete(p)
+      #   end
+      #
+      #   body.merge(params) unless params.empty?
+      # end
+
+      post_body = {method: method}
+      post_body = post_body.merge(params) unless params.empty?
+
+      post(post_body)
+    end
+
+    # Send post request to the API.
+    #
+    # @return HTTP request
+    def post(body)
+      @connection = Faraday.new(@api_url) do |conn|
+        conn.use FaradayMiddleware::Mashify
+        conn.response :xml
+        conn.basic_auth @token, 'X'
+        conn.adapter Faraday.default_adapter
+      end
+
+      resp = @connection.post do |req|
+        req.url '/api/2.1/xml-in'
+        req.headers['Content-Type'] = 'application/xml'
+        req.body = to_request(body)
+      end
+
+      body = resp.body.response
+      if body.empty?
+        resp.status
+      else
+        body
+      end
+    end
+
+    # Parses XML response into a hash.
+    #
+    # @param xml_content [String] A string of XML to be parsed.
+    #
+    # @return [Hash] A hash of the converted XML response.
+    def parse(xml_content)
+      MultiXml.parser = :nokogiri
+      MultiXml.parse(xml_content)['response']
+    end
+
+    # Converts a data hash into a usable Freshbooks API XML request.
+    #
+    # It parses the hash and removes relevant request attributes. Then
+    # it uses the method, #hash_to_raw_xml to convert it into XML.
+    #
+    # @param data_hash [Hash] a hash to build the request from
+    #
+    def to_request(data_hash)
+      req_method = data_hash.delete(:method)
+      '<?xml version="1.0" encoding="utf-8"?>' +
+      "<request method=\"#{req_method}\">" +
+        hash_to_raw_xml(data_hash) +
+      '</request>'
+    end
+
+    # Converts a raw hash into raw XML.
+    #
+    # @param object [Hash] a hash to build the XML from
+    # @param built [String] a string of built XML added recursively by the method
+    #
+    # @example convert hash to XML
+    #   data = {foo: {bar: {this: 'that'}}}
+    #   hash_to_raw_xml(data)
+    #   # => "<foo><bar><this>that</this></bar></foo>"
+    #
+    # @return [String] a raw XML string
+    def hash_to_raw_xml(object, built = '')
+      case object
+      when Hash
+        case
+        when object.count > 1
+          object.each { |h| built += "<#{h.first.to_s}>#{hash_to_raw_xml(h.last)}</#{h.first.to_s}>" }
+        when object.count == 1
+          object.each { |h| built += "<#{h.first.to_s}>#{hash_to_raw_xml(h.last, built)}</#{h.first.to_s}>" }
+        end
+      when String
+        built += object
+      when Integer
+        built += object.to_s
+      end
+      built
+    end
+
+    # Generates a hash of options to pass to {Freshbooks::Client}.
+    #
+    # @return [Hash] a hash of options.
+    def options
+      {
+        api_url: @api_url,
+        token: @token
+      }
+    end
+
+    # Converts a CamelCased word with an underscored_one.
+    #
+    # @param camel_cased_word [String] A string to underscore.
+    #
+    # @return An underscored string.
+    def underscore(camel_cased_word)
+      camel_cased_word.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+  end
+end

data/lib/freshbooks/version.rb

@@ -0,0 +1,3 @@
+module Freshbooks
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,252 @@
+--- !ruby/object:Gem::Specification
+name: freshbooks_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jesse Herrick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: dotenv
+  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: minitest-reporters
+  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: pry
+  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: 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: simplecov
+  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: An awesome API client for Freshbooks.
+email:
+- jesse@littlelines.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- freshbooks_client.gemspec
+- lib/freshbooks.rb
+- lib/freshbooks/api/callback.rb
+- lib/freshbooks/api/category.rb
+- lib/freshbooks/api/client.rb
+- lib/freshbooks/api/contractor.rb
+- lib/freshbooks/api/crud.rb
+- lib/freshbooks/api/currency.rb
+- lib/freshbooks/api/default_term.rb
+- lib/freshbooks/api/email_template.rb
+- lib/freshbooks/api/estimate.rb
+- lib/freshbooks/api/expense.rb
+- lib/freshbooks/api/gateway.rb
+- lib/freshbooks/api/invoice.rb
+- lib/freshbooks/api/item.rb
+- lib/freshbooks/api/language.rb
+- lib/freshbooks/api/methods.rb
+- lib/freshbooks/api/no_cd.rb
+- lib/freshbooks/api/no_crud.rb
+- lib/freshbooks/api/no_crudl.rb
+- lib/freshbooks/api/payment.rb
+- lib/freshbooks/api/project.rb
+- lib/freshbooks/api/receipt.rb
+- lib/freshbooks/api/recurring.rb
+- lib/freshbooks/api/report.rb
+- lib/freshbooks/api/staff.rb
+- lib/freshbooks/api/system.rb
+- lib/freshbooks/api/task.rb
+- lib/freshbooks/api/tax.rb
+- lib/freshbooks/api/time_entry.rb
+- lib/freshbooks/client.rb
+- lib/freshbooks/version.rb
+homepage: https://github.com/littlelines/freshbooks_client
+licenses: []
+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: An awesome API client for Freshbooks.
+test_files: []
+has_rdoc: