Skip to content

Commit 618d333

Browse files
committed
Add missing documentation
1 parent 38ee31c commit 618d333

12 files changed

+13
-3
lines changed

lib/sageone_sdk.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
require "sageone_sdk/client"
22
require "sageone_sdk/default"
3-
3+
# SageoneSdk
44
module SageoneSdk
55
autoload :SDataResponse, "sageone_sdk/sdata_response"
66
class << self

lib/sageone_sdk/authentication.rb

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
module SageoneSdk
2+
# Authentication
23
module Authentication
34
def token_authenticated?
45
!!@access_token

lib/sageone_sdk/client.rb

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
require "sageone_sdk/client/transactions"
2929

3030
module SageoneSdk
31+
# Client
3132
class Client
3233
include SageoneSdk::Authentication
3334
include SageoneSdk::Configurable

lib/sageone_sdk/client/chart_of_accounts.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
module SageoneSdk
22
class Client
33

4-
# Represents the chart of accounts. This is a list
4+
# Represents the chart of accounts. This is a list
55
# of all of the accounts used by your business. It defines the structure
66
# of your income, expenditure, assets, liabilities and capital when
77
# running your management reports.

lib/sageone_sdk/client/expenditures.rb

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
module SageoneSdk
22
class Client
3+
# Expenditures
34
module Expenditures
45
def expenditures(options = {})
56
paginate "expenditures", options

lib/sageone_sdk/configurable.rb

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
module SageoneSdk
2+
# Configurable
23
module Configurable
34
attr_accessor :access_token, :connection_options, :default_media_type, :user_agent, :signing_secret
45

lib/sageone_sdk/default.rb

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
require 'sageone_sdk/version'
22

33
module SageoneSdk
4+
# Default
45
module Default
5-
ACCESS_TOKEN = "default_access_token"
6+
ACCESS_TOKEN = "ACCESS_TOKEN"
67
SIGNING_SECRET = "default_signing_secret"
78
API_ENDPOINT = "https://api.sageone.com".freeze
89
USER_AGENT = "sageone_sdk Ruby Gem #{SageoneSdk::VERSION}".freeze

lib/sageone_sdk/middleware/sdata_parser.rb

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
module SageoneSdk
88
module Middleware
9+
# Sdata parser
910
class SDataParser < Faraday::Middleware
1011
def call(environment)
1112
@app.call(environment).on_complete do |env|

lib/sageone_sdk/middleware/signature.rb

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
module SageoneSdk
55
module Middleware
6+
# Signature
67
class Signature < Faraday::Middleware
78
def initialize(app, access_token, signing_secret)
89
super(app)

lib/sageone_sdk/sdata_error_response.rb

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
module SageoneSdk
2+
# SData error response
23
class SDataErrorResponse
34
attr_reader :data
45

lib/sageone_sdk/sdata_response.rb

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
module SageoneSdk
2+
# SData response
23
class SDataResponse
34
attr_reader :data
45

lib/sageone_sdk/signature.rb

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
require 'cgi'
44

55
module SageoneSdk
6+
# Signature
67
class Signature
78
attr_reader :http_method, :nonce
89

0 commit comments

Comments
 (0)