Merge pull request #1 from Sage/add_travis

add Travis CI

Author: chrisbarber86

.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

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

README.md

@@ -1,5 +1,7 @@
 # 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

Rakefile

@@ -1,2 +1,10 @@
-require "bundler/gem_tasks"
+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

fudge_settings.yml

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

lib/sageone_sdk.rb

@@ -1,6 +1,6 @@
 require "sageone_sdk/client"
 require "sageone_sdk/default"
-
+# SageoneSdk
 module SageoneSdk
   autoload :SDataResponse, "sageone_sdk/sdata_response"
   class << self

lib/sageone_sdk/authentication.rb

@@ -1,4 +1,5 @@
 module SageoneSdk
+  # Authentication
   module Authentication
     def token_authenticated?
       !!@access_token

lib/sageone_sdk/client.rb

@@ -28,6 +28,7 @@
 require "sageone_sdk/client/transactions"
 
 module SageoneSdk
+  # Client
   class Client
     include SageoneSdk::Authentication
     include SageoneSdk::Configurable

lib/sageone_sdk/client/chart_of_accounts.rb

@@ -1,7 +1,7 @@
 module SageoneSdk
   class Client
 
-    # Represents the chart of accounts. This is a list 
+    # 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.

lib/sageone_sdk/client/expenditures.rb

@@ -1,5 +1,6 @@
 module SageoneSdk
   class Client
+    # Expenditures
     module Expenditures
       def expenditures(options = {})
         paginate "expenditures", options

lib/sageone_sdk/configurable.rb

@@ -1,4 +1,5 @@
 module SageoneSdk
+  # Configurable
   module Configurable
     attr_accessor :access_token, :connection_options, :default_media_type, :user_agent, :signing_secret
 

lib/sageone_sdk/default.rb

@@ -1,6 +1,7 @@
 require 'sageone_sdk/version'
 
 module SageoneSdk
+  # Default
   module Default
     ACCESS_TOKEN = "default_access_token"
     SIGNING_SECRET = "default_signing_secret"

lib/sageone_sdk/middleware/sdata_parser.rb

@@ -6,6 +6,7 @@
 
 module SageoneSdk
   module Middleware
+    # Sdata parser
     class SDataParser < Faraday::Middleware
       def call(environment)
         @app.call(environment).on_complete do |env|

lib/sageone_sdk/middleware/signature.rb

@@ -3,6 +3,7 @@
 
 module SageoneSdk
   module Middleware
+    # Signature
     class Signature < Faraday::Middleware
       def initialize(app, access_token, signing_secret)
         super(app)

lib/sageone_sdk/sdata_error_response.rb

@@ -1,4 +1,5 @@
 module SageoneSdk
+  # SData error response
   class SDataErrorResponse
     attr_reader :data
 

lib/sageone_sdk/sdata_response.rb

@@ -1,4 +1,5 @@
 module SageoneSdk
+  # SData response
   class SDataResponse
     attr_reader :data
 

lib/sageone_sdk/signature.rb

@@ -3,6 +3,7 @@
 require 'cgi'
 
 module SageoneSdk
+  # Signature
   class Signature
     attr_reader :http_method, :nonce
 

sageone_sdk.gemspec

@@ -26,4 +26,13 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'cane'
+  spec.add_development_dependency 'flay'
+  spec.add_development_dependency 'flog'
+  spec.add_development_dependency 'fudge'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'yard'
 end

spec/cassettes/SageoneSdk_Client_LedgerAccounts/ledger_accounts/_id/returns_a_specific_contact_type.json renamed to spec/cassettes/SageoneSdk_Client_LedgerAccounts/ledger_accounts/_id/returns_a_specific_ledger_account.json

@@ -1 +1 @@
-{"http_interactions":[{"request":{"method":"get","uri":"https://api.sageone.com/accounts/v1/ledger_accounts/7686","body":{"encoding":"US-ASCII","string":""},"headers":{"Accept":["application/json"],"Content-Type":["application/x-www-form-urlencoded"],"User-Agent":["Sage One Ruby Gem 0.0.1"],"Authorization":["Bearer \u003CACCESS_TOKEN\u003E"],"X-Nonce":["d173e55f52f91b951d9ccb2bbebcc124"],"X-Signature":["GW5iI+Fjnp+c7b/6qKWvQGrzumY="],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":200,"message":"OK"},"headers":{"Cache-Control":["must-revalidate, private, max-age=0"],"Content-Type":["application/json;vnd.sage=sdata"],"Date":["Wed, 31 Dec 2014 11:49:17 GMT"],"Etag":["\"48ab5784e043cfce44d4c1bde3fc0fd7\""],"Server":["openresty"],"Status":["200"],"Vary":["Accept-Encoding"],"X-Rack-Cache":["miss"],"X-Request-Id":["2656c17b7b126041d2e902873c2ad4ba"],"X-Runtime":["0.061587"],"X-Server":["accounts.sageone.com (uat)"],"X-Ua-Compatible":["IE=Edge,chrome=1"],"Content-Length":["298"],"Connection":["keep-alive"]},"body":{"encoding":"UTF-8","string":"{\"id\":7686,\"included_in_chart\":true,\"ledger_name\":\"Office equipment and IT - Cost\",\"name\":\"IT equipment cost\",\"nominal_code\":30,\"last_updated\":\"2014-12-31T10:03:43+00:00\",\"tax_code\":{\"id\":1,\"name\":\"STANDARD\",\"$key\":1},\"category\":{\"id\":7,\"name\":\"Fixed Assets\",\"$key\":7},\"category_group\":{\"id\":7,\"name\":\"Asset\",\"$key\":7},\"is_bank_account\":false,\"coa_account\":{\"id\":9,\"included_in_chart\":true,\"ledger_name\":\"Office equipment and IT - Cost\",\"display_name\":\"IT equipment cost\",\"nominal_code\":30,\"control_name\":null,\"last_updated\":\"2010-06-29T14:52:41+01:00\",\"category\":{\"id\":7,\"name\":\"Fixed Assets\",\"$key\":7},\"category_group\":{\"id\":7,\"name\":\"Asset\",\"$key\":7},\"$key\":9},\"$key\":7686}"},"http_version":null},"recorded_at":"Wed, 31 Dec 2014 11:49:17 GMT"}],"recorded_with":"VCR 2.9.3"}
+{"http_interactions":[{"request":{"method":"get","uri":"https://api.sageone.com/accounts/v1/ledger_accounts/7686","body":{"encoding":"US-ASCII","string":""},"headers":{"Accept":["application/json"],"Content-Type":["application/x-www-form-urlencoded"],"User-Agent":["Sage One Ruby Gem 0.0.1"],"Authorization":["Bearer \u003CACCESS_TOKEN\u003E"],"X-Nonce":["d173e55f52f91b951d9ccb2bbebcc124"],"X-Signature":["GW5iI+Fjnp+c7b/6qKWvQGrzumY="],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":200,"message":"OK"},"headers":{"Cache-Control":["must-revalidate, private, max-age=0"],"Content-Type":["application/json;vnd.sage=sdata"],"Date":["Wed, 31 Dec 2014 11:49:17 GMT"],"Etag":["\"48ab5784e043cfce44d4c1bde3fc0fd7\""],"Server":["openresty"],"Status":["200"],"Vary":["Accept-Encoding"],"X-Rack-Cache":["miss"],"X-Request-Id":["2656c17b7b126041d2e902873c2ad4ba"],"X-Runtime":["0.061587"],"X-Server":["accounts.sageone.com (uat)"],"X-Ua-Compatible":["IE=Edge,chrome=1"],"Content-Length":["298"],"Connection":["keep-alive"]},"body":{"encoding":"UTF-8","string":"{\"id\":7686,\"included_in_chart\":true,\"ledger_name\":\"Office equipment and IT - Cost\",\"name\":\"IT equipment cost\",\"nominal_code\":30,\"last_updated\":\"2014-12-31T10:03:43+00:00\",\"tax_code\":{\"id\":1,\"name\":\"STANDARD\",\"$key\":1},\"category\":{\"id\":7,\"name\":\"Fixed Assets\",\"$key\":7},\"category_group\":{\"id\":7,\"name\":\"Asset\",\"$key\":7},\"is_bank_account\":false,\"coa_account\":{\"id\":9,\"included_in_chart\":true,\"ledger_name\":\"Office equipment and IT - Cost\",\"display_name\":\"IT equipment cost\",\"nominal_code\":30,\"control_name\":null,\"last_updated\":\"2010-06-29T14:52:41+01:00\",\"category\":{\"id\":7,\"name\":\"Fixed Assets\",\"$key\":7},\"category_group\":{\"id\":7,\"name\":\"Asset\",\"$key\":7},\"$key\":9},\"$key\":7686}"},"http_version":null},"recorded_at":"Wed, 31 Dec 2014 11:49:17 GMT"}],"recorded_with":"VCR 2.9.3"}

spec/sageone_sdk/client/journals_spec.rb

@@ -21,7 +21,7 @@
        "journal_lines[1][details]" => "detail",
        "journal_lines[1][ledger_account][nominal_code]" => 9999}
     end
-    
+
     it "creates a journal" do
       journal = client.create_journal(data)
       expect(journal.reference).not_to be_nil