beanie 0.1.4 → 0.2.0

data/lib/beanie/models/error_model.rb

@@ -0,0 +1,202 @@
+=begin
+#Beanie ERP API
+
+#An API specification for interacting with the Beanie ERP system
+
+OpenAPI spec version: 0.1
+Contact: dev@bean.ie
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module Beanie
+  class ErrorModel
+    attr_accessor :code
+
+    attr_accessor :message
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'code' => :'code',
+        :'message' => :'message'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'code' => :'Integer',
+        :'message' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.has_key?(:'message')
+        self.message = attributes[:'message']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @code.nil?
+        invalid_properties.push('invalid value for "code", code cannot be nil.')
+      end
+
+      if @message.nil?
+        invalid_properties.push('invalid value for "message", message cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @code.nil?
+      return false if @message.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          code == o.code &&
+          message == o.message
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [code, message].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = Beanie.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/beanie/version.rb

@@ -1,32 +1,15 @@
-#
-# Copyright (c) 2017-2018, AltoYield Limited.  All rights reserved.
-#
-# This is free software; you can redistribute it and/or modify it
-# under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2, or (at your option)
-# any later version.
-#
-# It is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
-# for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this product; see the file COPYING.  If not, write to the Free
-# Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
-#
-# THIS SOFTWARE IS PROVIDED BY ALTOYIELD LIMITED "AS IS" AND ANY EXPRESS
-# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED.  IN NO EVENT SHALL ALTOYIELD LIMITED BE LIABLE FOR
-# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
-# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
-#
+=begin
+#Beanie ERP API
+
+#An API specification for interacting with the Beanie ERP system
+
+OpenAPI spec version: 0.1
+Contact: dev@bean.ie
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.0-SNAPSHOT
+
+=end
+
 module Beanie
-  VERSION = "0.1.4"
+  VERSION = '0.2.0'
 end

data/lib/beanie.rb

@@ -1,126 +1,43 @@
-#
-# Copyright (c) 2017-2018, AltoYield Limited.  All rights reserved.
-#
-# This is free software; you can redistribute it and/or modify it
-# under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2, or (at your option)
-# any later version.
-#
-# It is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
-# for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this product; see the file COPYING.  If not, write to the Free
-# Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
-#
-# THIS SOFTWARE IS PROVIDED BY ALTOYIELD LIMITED "AS IS" AND ANY EXPRESS
-# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED.  IN NO EVENT SHALL ALTOYIELD LIMITED BE LIABLE FOR
-# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
-# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
-#
-# Ruby bindings for the Beanie API
-# Docs at http://bean.ie/help/api/ruby
-require 'rest-client'
-require 'json'
+=begin
+#Beanie ERP API
 
-require File.dirname(__FILE__) + '/beanie/api'
-require File.dirname(__FILE__) + '/beanie/version'
-require File.dirname(__FILE__) + '/beanie/company'
-require File.dirname(__FILE__) + '/beanie/company_member'
-require File.dirname(__FILE__) + '/beanie/bank_account'
-require File.dirname(__FILE__) + '/beanie/bank_statement'
-require File.dirname(__FILE__) + '/beanie/bank_statement_data'
-require File.dirname(__FILE__) + '/beanie/beanie_alert'
-require File.dirname(__FILE__) + '/beanie/billable'
-require File.dirname(__FILE__) + '/beanie/bill_of_material'
-require File.dirname(__FILE__) + '/beanie/bom_item'
-require File.dirname(__FILE__) + '/beanie/config_type'
-require File.dirname(__FILE__) + '/beanie/config_value'
-require File.dirname(__FILE__) + '/beanie/customer'
-require File.dirname(__FILE__) + '/beanie/customer_address'
-require File.dirname(__FILE__) + '/beanie/customer_note'
-require File.dirname(__FILE__) + '/beanie/document'
-require File.dirname(__FILE__) + '/beanie/fixed_asset'
-require File.dirname(__FILE__) + '/beanie/journal'
-require File.dirname(__FILE__) + '/beanie/journal_item'
-require File.dirname(__FILE__) + '/beanie/nominal_account_category'
-require File.dirname(__FILE__) + '/beanie/nominal_account'
-require File.dirname(__FILE__) + '/beanie/product_category'
-require File.dirname(__FILE__) + '/beanie/product'
-require File.dirname(__FILE__) + '/beanie/product_price'
-require File.dirname(__FILE__) + '/beanie/work_centre_group'
-require File.dirname(__FILE__) + '/beanie/work_centre'
-require File.dirname(__FILE__) + '/beanie/production_order'
-require File.dirname(__FILE__) + '/beanie/purchase_invoice'
-require File.dirname(__FILE__) + '/beanie/purchase_order'
-require File.dirname(__FILE__) + '/beanie/purchase_order_item'
-require File.dirname(__FILE__) + '/beanie/sales_invoice'
-require File.dirname(__FILE__) + '/beanie/sales_invoice_item'
-require File.dirname(__FILE__) + '/beanie/sales_order'
-require File.dirname(__FILE__) + '/beanie/sales_order_item'
-require File.dirname(__FILE__) + '/beanie/stock_location'
-require File.dirname(__FILE__) + '/beanie/stock_category'
-require File.dirname(__FILE__) + '/beanie/stock_item'
-require File.dirname(__FILE__) + '/beanie/stock_adjustment'
-require File.dirname(__FILE__) + '/beanie/stock_supplier'
-require File.dirname(__FILE__) + '/beanie/supplier'
-require File.dirname(__FILE__) + '/beanie/supplier_address'
-require File.dirname(__FILE__) + '/beanie/supplier_note'
-require File.dirname(__FILE__) + '/beanie/tax_registration'
-require File.dirname(__FILE__) + '/beanie/vat_record'
-require File.dirname(__FILE__) + '/beanie/vat_return'
+#An API specification for interacting with the Beanie ERP system
 
-DEFAULT_URI = "https://bean.ie"
+OpenAPI spec version: 0.1
+Contact: dev@bean.ie
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.0-SNAPSHOT
 
-module Beanie
-  @@token = nil
+=end
 
-  class << self
-    attr_accessor :api_key, :api_version, :secret_key
-  end
+# Common files
+require 'beanie/api_client'
+require 'beanie/api_error'
+require 'beanie/version'
+require 'beanie/configuration'
 
-  def self.api_url(url='', api_base_uri=nil)
-    (api_base_uri || @base_uri) + url
-  end
+# Models
+require 'beanie/models/bank_account'
+require 'beanie/models/error_model'
+require 'beanie/models/bank_account_input'
 
-  def self.connect(opts = {})
-    @base_uri = opts[:base_uri] ? opts[:base_uri] : DEFAULT_URI
-    @api_key = opts[:api_key] if opts[:api_key]
-    @secret_key = opts[:secret_key] if opts[:secret_key]
-  end
+# APIs
+require 'beanie/api/bank_account_api'
 
-  def self.get_token
-    unless @@token
-      #
-      # We need to get an authentication token from the server
-      unless @api_key and @secret_key
-        raise AuthenticationError.new('No API Key / Secret Key provided.' \
-                                      'Set your API Key using "Beanie.api_key = <API-KEY>". ' \
-                                      'Set your Secret Key using "Beanie.secret_key = <SECRET>". ' \
-                                      'You can generate API keys from the Beanie web interface. ' \
-                                      'See #{DEFAULT_URI}/help/api/key for details or email ' \
-                                      'support@bean.ie for further assistance.')
+module Beanie
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Beanie.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
       end
-      url = "#{@base_uri}/api/authenticate"
-      data = {:api_key => @api_key, :secret_key => @secret_key}
-      response = RestClient.post(url, data.to_json, :content_type => :json, :accept => :json)
-      raise AuthenticationError.new('Authentication failure.') unless response.code == 202
-      data = JSON.parse(response.body)
-      @@token = data['token']
     end
-    @@token
-  end
-
-  def self.base_uri
-    @base_uri
   end
 end

data/spec/api/bank_account_api_spec.rb

@@ -0,0 +1,71 @@
+=begin
+#Beanie ERP API
+
+#An API specification for interacting with the Beanie ERP system
+
+OpenAPI spec version: 0.1
+Contact: dev@bean.ie
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Beanie::BankAccountApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'BankAccountApi' do
+  before do
+    # run before each test
+    @instance = Beanie::BankAccountApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of BankAccountApi' do
+    it 'should create an instance of BankAccountApi' do
+      expect(@instance).to be_instance_of(Beanie::BankAccountApi)
+    end
+  end
+
+  # unit tests for add_bank_account
+  # Creates a new bank account in the system
+  # @param bank_account Bank account to add to the system
+  # @param [Hash] opts the optional parameters
+  # @return [BankAccount]
+  describe 'add_bank_account test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for find_bank_account_by_id
+  # Find Bank Account by ID
+  # Returns a single bank account if the user has access
+  # @param id ID of bank account to fetch
+  # @param [Hash] opts the optional parameters
+  # @return [BankAccount]
+  describe 'find_bank_account_by_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for find_bank_accounts
+  # All bank accounts
+  # Returns all bank accounts from the system that the user has access to
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :tags tags to filter by
+  # @option opts [Integer] :limit maximum number of results to return
+  # @return [Array<BankAccount>]
+  describe 'find_bank_accounts test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end