sageone_sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f5d8913f681c7abbf20eb961e6f70f8a2739ce8
+  data.tar.gz: b51a5a7e33ee0dea22fd0a77b00c7af91342e609
+SHA512:
+  metadata.gz: 731ed54acd1fbe639d71622d99688d8d62a757bfcafd6270f43655fda3fb87fd1427616e9c2e07f9ff7f73a0e7e0523800d8da8099aeb2b43df4453d7841d62c
+  data.tar.gz: 357ddf19b61efa98d5afdc85ddd34fd978621f13a6d77ad6cc939c3f27582f9c30fb47832498bdbd0dd106cfe5f7629bb09d980557daf8d58eaaf20fac123805

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.2.4
+  - 2.2.3
+  - 2.2.1
+  - 2.2.0
+  - 2.1.8
+  - 2.1.7
+  - 2.1.6
+  - 2.1.5
+  - 2.1.4
+  - 2.1.3
+  - 2.1.1
+  - 2.0.0

data/Fudgefile

@@ -0,0 +1,27 @@
+task_group :spec do
+  rspec :coverage => 80
+end
+
+task_group :docs do
+  task :yard, :coverage => 68
+end
+
+task_group :codestyle do
+  task :cane, :max_width => 120
+end
+
+task_group :duplication do
+  task :flay, :exclude => '^\.\/spec\/'
+end
+
+task_group :complexity do
+  task :flog, :exclude => '^\.\/spec\/', :methods => true
+end
+
+build :default do
+  task_group :docs
+  task_group :codestyle
+  task_group :complexity
+  task_group :duplication
+  task_group :spec
+end

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sageone.gemspec
+gemspec
+
+group :test do
+  gem "guard-rspec", require: false
+  gem 'webmock'
+  gem 'pry'
+  gem 'simplecov'
+  gem 'vcr'
+end

data/Guardfile

@@ -0,0 +1,33 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  watch('spec/rails_helper.rb')                       { "spec" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Sage
+
+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,57 @@
+# SageoneSdk
+
+[![Build Status](https://travis-ci.org/Sage/sageone_api_ruby_sdk.svg?branch=master)](https://travis-ci.org/Sage/sageone_api_ruby_sdk)
+
+The `sageone_sdk` gem provides Ruby methods for accessing the Sage One API endpoints.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sageone_sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sageone_sdk
+
+## Usage
+
+To create a `SageoneSdk::Client`, you need to provide your access_token and signing_secret:
+
+```
+@client = SageoneSdk::Client.new({access_token: @access_token,
+                                  signing_secret: @signing_secret})
+```
+
+Further information about obtaining these is available [here](https://developers.sageone.com/docs/en/v1#overview).
+
+You can then call the required method on the `@client`:
+
+```
+@client.bank_accounts
+=> #<SageoneSdk::SDataResponse:0x007faaa9eb1760
+   @data=
+    {"$totalResults"=>2,
+     "$startIndex"=>0,
+     "$itemsPerPage"=>20,
+     "$resources"=>
+      [{"id"=>214227,
+        "account_name"=>"Current",
+        #...}]
+    }>
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sageone/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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :fudge
+
+# Test Fudge using Fudge
+task :fudge do
+  exec 'fudge build 2> /dev/null'
+end

data/fudge_settings.yml

@@ -0,0 +1,5 @@
+flay:
+  max: 498
+flog:
+  max: 28
+  average: 5.5

data/lib/sageone_sdk.rb

@@ -0,0 +1,16 @@
+require "sageone_sdk/client"
+require "sageone_sdk/default"
+# SageoneSdk
+module SageoneSdk
+  autoload :SDataResponse, "sageone_sdk/sdata_response"
+  class << self
+    include SageoneSdk::Configurable
+
+    def client
+      @client = SageoneSdk::Client.new unless defined?(@client)
+      @client
+    end
+  end
+end
+
+SageoneSdk.setup

data/lib/sageone_sdk/authentication.rb

@@ -0,0 +1,8 @@
+module SageoneSdk
+  # Authentication
+  module Authentication
+    def token_authenticated?
+      !!@access_token
+    end
+  end
+end

data/lib/sageone_sdk/client.rb

@@ -0,0 +1,117 @@
+require "sawyer"
+require "faraday_middleware"
+require "sageone_sdk/authentication"
+require "sageone_sdk/configurable"
+require "sageone_sdk/middleware"
+require "sageone_sdk/client/account_types"
+require "sageone_sdk/client/bank_accounts"
+require "sageone_sdk/client/chart_of_accounts"
+require "sageone_sdk/client/contact_types"
+require "sageone_sdk/client/contacts"
+require "sageone_sdk/client/countries"
+require "sageone_sdk/client/expenditures"
+require "sageone_sdk/client/expense_methods"
+require "sageone_sdk/client/expense_types"
+require "sageone_sdk/client/financial_settings"
+require "sageone_sdk/client/income_methods"
+require "sageone_sdk/client/income_types"
+require "sageone_sdk/client/incomes"
+require "sageone_sdk/client/journals"
+require "sageone_sdk/client/ledger_accounts"
+require "sageone_sdk/client/payment_statuses"
+require "sageone_sdk/client/period_types"
+require "sageone_sdk/client/purchase_invoices"
+require "sageone_sdk/client/products"
+require "sageone_sdk/client/sales_invoices"
+require "sageone_sdk/client/services"
+require "sageone_sdk/client/tax_rates"
+require "sageone_sdk/client/transactions"
+
+module SageoneSdk
+  # Client
+  class Client
+    include SageoneSdk::Authentication
+    include SageoneSdk::Configurable
+    include SageoneSdk::Client::AccountTypes
+    include SageoneSdk::Client::BankAccounts
+    include SageoneSdk::Client::ChartOfAccounts
+    include SageoneSdk::Client::ContactTypes
+    include SageoneSdk::Client::Contacts
+    include SageoneSdk::Client::Countries
+    include SageoneSdk::Client::Expenditures
+    include SageoneSdk::Client::ExpenseMethods
+    include SageoneSdk::Client::ExpenseTypes
+    include SageoneSdk::Client::FinancialSettings
+    include SageoneSdk::Client::IncomeMethods
+    include SageoneSdk::Client::IncomeTypes
+    include SageoneSdk::Client::Incomes
+    include SageoneSdk::Client::Journals
+    include SageoneSdk::Client::LedgerAccounts
+    include SageoneSdk::Client::PaymentStatuses
+    include SageoneSdk::Client::PeriodTypes
+    include SageoneSdk::Client::PurchaseInvoices
+    include SageoneSdk::Client::Products
+    include SageoneSdk::Client::SalesInvoices
+    include SageoneSdk::Client::Services
+    include SageoneSdk::Client::TaxRates
+    include SageoneSdk::Client::Transactions
+
+    def initialize(options = {})
+      SageoneSdk::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || SageoneSdk.instance_variable_get(:"@#{key}"))
+      end
+    end
+
+    def last_response
+      @last_response if defined? @last_response
+    end
+
+    def paginate(resource, options = {})
+      data = get(resource, options)
+      data
+    end
+
+    def get(path, data={})
+      request(:get, path, data)
+    end
+
+    def post(path, data={})
+      request(:post, path, data)
+    end
+
+    def put(path, data={})
+      request(:put, path, data)
+    end
+
+    def delete(path, data={})
+      request(:delete, path, data)
+    end
+
+    def request(method, path, data, options = {})
+      path = File.join("accounts", "v1", path)
+      @last_response = response = agent.public_send(method, URI::Parser.new.escape(path.to_s), data, options)
+      response.body
+    end
+
+    def agent
+      @agent ||= Faraday.new(api_endpoint, faraday_options) do |builder|
+        builder.request :url_encoded
+        builder.headers['Accept'] = default_media_type
+        builder.headers['Content-Type'] = "application/x-www-form-urlencoded"
+        builder.headers['User-Agent'] = user_agent
+        if token_authenticated?
+          builder.authorization 'Bearer', @access_token
+        end
+        builder.use SageoneSdk::Middleware::Signature, access_token, signing_secret
+        builder.use SageoneSdk::Middleware::SDataParser
+        builder.adapter Faraday.default_adapter
+      end
+    end
+
+    private
+
+    def faraday_options
+      {}
+    end
+  end
+end

data/lib/sageone_sdk/client/account_types.rb

@@ -0,0 +1,19 @@
+module SageoneSdk
+  class Client
+
+    # Represents the bank account types in Sage One.
+    # For example, Savings or Cash in Hand.
+    module AccountTypes
+
+      # @return [object] Returns all of the bank account types in Sage One.
+      def account_types(options = {})
+        get "account_types", options
+      end
+
+      # @return [object] Returns the bank account type with the given id.
+      def account_type(id, options = {})
+        get "account_types/#{id}", options
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/bank_accounts.rb

@@ -0,0 +1,18 @@
+module SageoneSdk
+  class Client
+
+    # Represents the bank accounts for the authenticated user's business.
+    module BankAccounts
+
+      # @return [object] Returns all bank accounts for the authenticated user's business.
+      def bank_accounts(options = {})
+        paginate "bank_accounts", options
+      end
+
+      # @return [object] Returns the bank account with the given id.
+      def bank_account(id, options = {})
+        get "bank_accounts/#{id}", options
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/chart_of_accounts.rb

@@ -0,0 +1,21 @@
+module SageoneSdk
+  class Client
+
+    # Represents the chart of accounts. This is a list
+    # of all of the accounts used by your business. It defines the structure
+    # of your income, expenditure, assets, liabilities and capital when
+    # running your management reports.
+    module ChartOfAccounts
+
+      # @return [object] Returns all chart of accounts templates.
+      def coa_templates(options = {})
+        get "coa_templates", options
+      end
+
+      # @return [object] Returns the chart of accounts for the authenticated user's business.
+      def coa_structure(options = {})
+        get "coa_structure", options
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/contact_types.rb

@@ -0,0 +1,20 @@
+module SageoneSdk
+  class Client
+
+    # Represents the types of contact records in Sage One such as Customer or Supplier.
+    module ContactTypes
+      CUSTOMER = 1.freeze
+      SUPPLIER = 2.freeze
+
+      # @return [object] Returns all of the contact types in Sage One. For example, Customer.
+      def contact_types(options = {})
+        get "contact_types", options
+      end
+
+      # @return [object] Returns the contact type with the given id.
+      def contact_type(id, options = {})
+        get "contact_types/#{id}", options
+      end
+    end
+  end
+end