sageone_sdk 0.0.1

data/lib/sageone_sdk/client/purchase_invoices.rb

@@ -0,0 +1,61 @@
+module SageoneSdk
+  class Client
+
+    # Represents the purchase invoices for the authenticated user's business.
+    module PurchaseInvoices
+
+      # @return [object] Returns all purchase invoices for the authenticated user's business.
+      def purchase_invoices(options = {})
+        paginate "purchase_invoices", options
+      end
+
+      # @return [object] Returns the purchase invoice with the given id.
+      def purchase_invoice(id, options = {})
+        get "purchase_invoices/#{id}", options
+      end
+
+      # Creates a purchase invoice with the data provided.
+      # @example Create a new purchase invoice
+      #   @client.create_purchase_invoice({"contact_id" => "371",
+      #                                    "contact_name" => "Bob's Building Supplies",
+      #                                    "due_date" => "2016-01-31",
+      #                                    "date" => "2016-01-01",
+      #                                    "line_items_attributes[0][description]" => "Line item description",
+      #                                    "line_items_attributes[0][quantity]" => 10.0,
+      #                                    "line_items_attributes[0][unit_price]" => 19.5,
+      #                                    "line_items_attributes[0][tax_code_id]" => 1,
+      #                                    "line_items_attributes[0][ledger_account_id]" => 434})
+      # @param data [hash] The purchase invoice information.
+      # @param options [hash]
+      def create_purchase_invoice(data, options = {})
+        lines = data.delete(:line_items)
+
+        if lines
+          data[:line_items_attributes] = {}
+          lines.each_with_index do |value, index|
+            data[:line_items_attributes][index] = value
+          end
+        end
+
+        post "purchase_invoices", :purchase_invoice => data
+      end
+
+      # Updates the given purchase invoice with the data provided.
+      # @example Update a purchase invoice due_date
+      #   @client.update_purchase_invoice(11243, {"due_date" => "2016-01-31"})
+      # @param id [integer] The id of the purchase invoice to update.
+      # @param data [hash] The purchase invoice information to update.
+      # @param options [hash]
+      def update_purchase_invoice(id, data, options = {})
+        put "purchase_invoices/#{id}", :purchase_invoice => data
+      end
+
+      # Deletes the purchase invoice with the given id.
+      # @param id [integer] The id of the purchase invoice to delete.
+      # @param options [hash]
+      def delete_purchase_invoice(id, options = {})
+        delete "purchase_invoices/#{id}"
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/sales_invoices.rb

@@ -0,0 +1,65 @@
+module SageoneSdk
+  class Client
+
+    # Represents the sales invoices for the authenticated user's business.
+    module SalesInvoices
+
+      # @return [object] Returns all sales invoices for the authenticated user's business.
+      def sales_invoices(options = {})
+        paginate "sales_invoices", options
+      end
+
+      # @return [object] Returns the sales invoice with the given id.
+      def sales_invoice(id, options = {})
+        get "sales_invoices/#{id}", options
+      end
+
+      # Creates a sales invoice with the data provided.
+      # @example Create a new sales invoice
+      #   @client.create_sales_invoice({"contact_id" => "237",
+      #                                 "contact_name" => "My best customer",
+      #                                 "due_date" => "2016-01-31",
+      #                                 "date" => "2016-01-01",
+      #                                 "main_address" => "25 Station Road...",
+      #                                 "carriage_tax_code_id" => 1,
+      #                                 "line_items_attributes[0][description]" => "Line item description",
+      #                                 "line_items_attributes[0][product_id]" => 17,
+      #                                 "line_items_attributes[0][product_code]" => "PROD001",
+      #                                 "line_items_attributes[0][quantity]" => 10.0,
+      #                                 "line_items_attributes[0][unit_price]" => 29.5,
+      #                                 "line_items_attributes[0][tax_code_id]" => 1,
+      #                                 "line_items_attributes[0][ledger_account_id]" => 434})
+      # @param data [hash] The sales invoice information.
+      # @param options [hash]
+      def create_sales_invoice(data, options = {})
+        lines = data.delete(:line_items)
+
+        if lines
+          data[:line_items_attributes] = {}
+          lines.each_with_index do |value, index|
+            data[:line_items_attributes][index] = value
+          end
+        end
+
+        post "sales_invoices", :sales_invoice => data
+      end
+
+      # Updates the given sales invoice with the data provided.
+      # @example Update a sales invoice due_date
+      #   @client.update_sales_invoice(1243, {"due_date" => "2016-01-31"})
+      # @param id [integer] The id of the sales invoice to update.
+      # @param data [hash] The sales invoice information to update.
+      # @param options [hash]
+      def update_sales_invoice(id, data, options = {})
+        put "sales_invoices/#{id}", :sales_invoice => data
+      end
+
+      # Deletes the sales invoice with the given id.
+      # @param id [integer] The id of the sales invoice to delete.
+      # @param options [hash]
+      def delete_sales_invoice(id, options = {})
+        delete "sales_invoices/#{id}"
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/services.rb

@@ -0,0 +1,48 @@
+module SageoneSdk
+  class Client
+
+    # Represents the services for the authenticated user's business.
+    module Services
+
+      # @return [object] Returns all services for the authenticated user's business.
+      def services(options = {})
+        paginate "services", options
+      end
+
+      # @return [object] Returns the service record with the given id.
+      def service(id, options = {})
+        get "services/#{id}", options
+      end
+
+      # Creates a service record with the data provided.
+      # @example Create a new service record
+      #   @client.create_service({description: "My new service",
+      #                           rate_includes_tax: false,
+      #                           ledger_account_id: 438,
+      #                           tax_code_id: 1,
+      #                           period_rate_price: 99.99})
+      # @param data [hash] The service record information.
+      # @param options [hash]
+      def create_service(data, options = {})
+        post "services", :service => data
+      end
+
+      # Updates the given service record with the data provided.
+      # @example Update a service record description
+      #   @client.update_service(11232, {description: "My updated service"})
+      # @param id [integer] The id of the service record to update.
+      # @param data [hash] The service information to update.
+      # @param options [hash]
+      def update_service(id, data, options = {})
+        put "services/#{id}", :service => data
+      end
+
+      # Deletes the given service record.
+      # @param id [integer] The id of the service record to delete.
+      # @param options [hash]
+      def delete_service(id, options = {})
+        delete "services/#{id}"
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/tax_rates.rb

@@ -0,0 +1,18 @@
+module SageoneSdk
+  class Client
+
+    # Represents the tax rates in Sage One. For example, standard or zero-rated.
+    module TaxRates
+
+      # @return [object] Returns all tax rates.
+      def tax_rates(options = {})
+        get "tax_rates", options
+      end
+
+      # @return [object] Returns the tax rate with the given id.
+      def tax_rate(id, options = {})
+        get "tax_rates/#{id}", options
+      end
+    end
+  end
+end

data/lib/sageone_sdk/client/transactions.rb

@@ -0,0 +1,13 @@
+module SageoneSdk
+  class Client
+
+    # Represents the transactions for the authenticated user's business.
+    module Transactions
+
+      # @return [object] Returns all transactions for the authenticated user's business.
+      def transactions(options = {})
+        get "transactions", options
+      end
+    end
+  end
+end

data/lib/sageone_sdk/configurable.rb

@@ -0,0 +1,43 @@
+module SageoneSdk
+  # Configurable
+  module Configurable
+    attr_accessor :access_token, :connection_options, :default_media_type, :user_agent, :signing_secret
+
+    attr_writer :api_endpoint
+
+    class << self
+      def keys
+        @keys ||= [
+          :access_token,
+          :signing_secret,
+          :api_endpoint,
+          :connection_options,
+          :default_media_type,
+          :user_agent
+        ]
+      end
+    end
+
+    def configure
+      yield self
+    end
+
+    def reset!
+      SageoneSdk::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", SageoneSdk::Default.options[key])
+      end
+      self
+    end
+    alias :setup :reset!
+
+    def api_endpoint
+      File.join(@api_endpoint, "")
+    end
+
+    private
+
+    def options
+      Hash[SageoneSdk::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+    end
+  end
+end

data/lib/sageone_sdk/default.rb

@@ -0,0 +1,47 @@
+require 'sageone_sdk/version'
+
+module SageoneSdk
+  # Default
+  module Default
+    ACCESS_TOKEN = "default_access_token"
+    SIGNING_SECRET = "default_signing_secret"
+    API_ENDPOINT = "https://api.sageone.com".freeze
+    USER_AGENT = "sageone_sdk Ruby Gem #{SageoneSdk::VERSION}".freeze
+    MEDIA_TYPE = "application/json"
+
+    class << self
+      def options
+        Hash[SageoneSdk::Configurable.keys.map{|key| [key, send(key)]}]
+      end
+
+      def access_token
+        ENV["SAGE_ONE_ACCESS_TOKEN"] || ACCESS_TOKEN
+      end
+
+      def signing_secret
+        ENV["SAGE_ONE_SIGNING_SECRET"] || SIGNING_SECRET
+      end
+
+      def api_endpoint
+        ENV["SAGE_ONE_API_ENDPOINT"] || API_ENDPOINT
+      end
+
+      def default_media_type
+        ENV["SAGE_ONE_DEFAULT_MEDIA_TYPE"] || MEDIA_TYPE
+      end
+
+      def user_agent
+        ENV["SAGE_ONE_USER_AGENT"] || USER_AGENT
+      end
+
+      def connection_options
+        {
+          :headers => {
+            :accept => default_media_type,
+            :user_agent => user_agent
+          }
+        }
+      end
+    end
+  end
+end

data/lib/sageone_sdk/middleware.rb

@@ -0,0 +1,6 @@
+module SageoneSdk
+  module Middleware
+    autoload :Signature, "sageone_sdk/middleware/signature"
+    autoload :SDataParser, "sageone_sdk/middleware/sdata_parser"
+  end
+end

data/lib/sageone_sdk/middleware/sdata_parser.rb

@@ -0,0 +1,29 @@
+require 'sageone_sdk/signature'
+require 'sageone_sdk/sdata_error_response'
+require 'sageone_sdk/sdata_response'
+require "json"
+require "hashie/mash"
+
+module SageoneSdk
+  module Middleware
+    # Sdata parser
+    class SDataParser < Faraday::Middleware
+      def call(environment)
+        @app.call(environment).on_complete do |env|
+          element = ::JSON.parse(env[:body])
+
+          if element.respond_to?(:each_pair)
+            response_body = Hashie::Mash.new(element)
+            if env.success?
+              env[:body] = SageoneSdk::SDataResponse.new(response_body)
+            else
+              env[:body] = SageoneSdk::SDataErrorResponse.new(response_body)
+            end
+          else
+            env[:body] = element.map { |x| Hashie::Mash.new(x) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sageone_sdk/middleware/signature.rb

@@ -0,0 +1,26 @@
+require 'sageone_sdk/signature'
+require "active_support/core_ext"
+
+module SageoneSdk
+  module Middleware
+    # Signature
+    class Signature < Faraday::Middleware
+      def initialize(app, access_token, signing_secret)
+        super(app)
+
+        @access_token = access_token
+        @signing_secret = signing_secret
+      end
+
+      def call(env)
+        nonce = SageoneSdk::Signature.generate_nonce
+        signature = SageoneSdk::Signature.new(env.method, env.url, env.body, nonce, @signing_secret, @access_token)
+
+        env[:request_headers]['X-Nonce'] = nonce
+        env[:request_headers]['X-Signature'] = signature.to_s
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/sageone_sdk/sdata_error_response.rb

@@ -0,0 +1,36 @@
+module SageoneSdk
+  # SData error response
+  class SDataErrorResponse
+    attr_reader :data
+
+    def initialize(data = {})
+      @data = data
+    end
+
+    def diagnoses
+      @data["$diagnoses"]
+    end
+
+    def full_messages
+      diagnoses.map do |x|
+        "#{x["$source"].humanize}: #{x["$message"]}"
+      end
+    end
+
+    def error?
+      true
+    end
+
+    def respond_to_missing?(method, include_private =  false)
+      resources.respond_to?(method, include_private)
+    end
+
+    def method_missing(method, *args, &block)
+      if diagnoses.respond_to?(method)
+        diagnoses.send(method, *args)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/sageone_sdk/sdata_response.rb

@@ -0,0 +1,58 @@
+module SageoneSdk
+  # SData response
+  class SDataResponse
+    attr_reader :data
+
+    def initialize(data = {})
+      @data = data
+    end
+
+    def total_results
+      @data["$totalResults"]
+    end
+
+    def start_index
+      @data["startIndex"]
+    end
+
+    def items_per_page
+      @data["$itemsPerPage"]
+    end
+
+    def resources
+      @data["$resources"]
+    end
+
+    def error?
+      false
+    end
+
+    def find_by(conditions)
+      resources.detect do |resource|
+        @skip = false
+        conditions.each do |field, value|
+          unless resource.public_send(field) == value
+            @skip = true
+            break
+          end
+        end
+
+        !@skip
+      end
+    end
+
+    def respond_to_missing?(method, include_private =  false)
+      resources.respond_to?(method, include_private) || data.respond_to?(method, include_private)
+    end
+
+    def method_missing(method, *args, &block)
+      if resources.respond_to?(method)
+        resources.send(method, *args)
+      elsif data.respond_to?(method)
+        data.send(method, *args)
+      else
+        super
+      end
+    end
+  end
+end