beanie 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 297dce11f464e9e22ea0b53404a0119a7e18db84
-  data.tar.gz: 53cc9bcd2dd55924eb3abf17d1147ad004e8aa50
+  metadata.gz: d12f97b41e0c32526bf8f6db1f0e7a7db200266d
+  data.tar.gz: 219bd84135de543e3e986624b6dec48f10b8899d
 SHA512:
-  metadata.gz: 6abf1a6363ef226c8bfc55c0c2ee2ab2326e48c35f2dd3ffe8ae881b2a5ec9283cd8415449ea21d312d5404c1a36a21d064f0506d139cf0c0eef27cfdc28a8c4
-  data.tar.gz: edbe418d0c04294b8e9e492d3bf07ee1ecb53c07e1d72b774099de7af2d34bfae0b88de765d372ae73c6a3c3be385756872a44b3764636d4a02b3200d8de8356
+  metadata.gz: 2842992bf0caa0f58a118cbb6e424b99f3f465a985c3cd23eb3a5ec48611450a037877072d914a71c57d75d59de31eb2808ecad9400c07346b3860bd13c31940
+  data.tar.gz: ed3891c4ff76b46fa78373c0fdc99880c932005f7e9f4f79e55b1a1164828ffe22963ceab08c11a46d222393957e03067fdf896d635e03262397fbd06e770eac

data/README.md

@@ -1,4 +1,3 @@
-<<<<<<< HEAD
 # Beanie API Bindings
 
 This gem provides an API interface into the Beanie cloud-based ERP system.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/beanie.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rest-client", "~> 2.0"
 end

data/lib/beanie/api.rb

@@ -31,10 +31,63 @@ require 'active_support/inflector'
 
 module Beanie
   class Api
+    #
+    # Find all the objects
+    def self.all(opts = {})
+      data = get(opts)
+      objlist = []
+      data[new.object_name.pluralize].each do |objdata|
+        objlist << new.populate(objdata)
+      end
+      objlist
+    end
+
+    #
+    # Find an object based on its ID
+    def self.find(id)
+      data = get(:id => id)
+      obj = new
+      obj.populate(data[obj.object_name])
+    end
+
+    #
+    # Save the customer data
+    def save!(opts = {})
+      data = extract()
+      data.delete("id")
+      objdata = {object_name => data}
+      response = self.class.post(objdata, opts)
+      self.populate(response[self.object_name])
+    end
+
+    #
+    # Populate the instance variables from the provided hash.
+    def populate(data)
+      self.instance_variables.each do |var|
+        self.instance_variable_set(var, data[field_name(var)])
+      end
+      self
+    end
+
+    #
+    # Populate the instance variables from the provided hash.
+    def extract
+      data = {}
+      self.instance_variables.each do |var|
+        data[field_name(var)] = self.instance_variable_get(var)
+      end
+      data
+    end
+
+    #
+    # Determine the field name
+    def field_name(var)
+      var.to_s.gsub(/^@/, '')
+    end
+
     #
     # Run a REST GET against the Beanie API.
     def self.get(opts = {})
-      puts "Beanie GET..."
       response = RestClient.get(build_url(opts), headers=set_headers)
       JSON.parse(response.body)
     end
@@ -42,7 +95,6 @@ module Beanie
     #
     # Run a REST PUT against the Beanie API.
     def self.put(data, opts = {})
-      puts "Beanie PUT..."
       response = RestClient.put(build_url(opts), data, headers=set_headers)
       JSON.parse(response.body)
     end
@@ -50,15 +102,13 @@ module Beanie
     #
     # Run a REST POST against the Beanie API.
     def self.post(data, opts = {})
-      puts "Beanie POST..."
-      response = RestClient.post(build_url(opts), data, headers=set_headers)
+      response = RestClient.post(build_url(opts), data.to_json, headers=set_headers)
       JSON.parse(response.body)
     end
 
     #
     # Run a REST DELETE against the Beanie API.
     def self.delete(data, opts = {})
-      puts "Beanie DELETE..."
       response = RestClient.delete(build_url(opts), headers=set_headers)
       JSON.parse(response.body)
     end
@@ -66,22 +116,23 @@ module Beanie
     #
     #
     def self.build_url(opts = {})
-      puts "BUILD URL. Opts:-"
-      p opts
       if opts[:url]
-        url = "#{Beanie.base_uri}#{opts[:url]}.json"
+        url = "#{Beanie.base_uri}#{opts[:url]}"
         opts.delete(:url)
       else
-        url = "#{Beanie.base_uri}/#{new.object_name.pluralize}.json"
+        url = "#{Beanie.base_uri}/#{new.construct_path(opts)}"
+      end
+      if opts[:id]
+        url += "/#{opts[:id]}"
+        opts.delete(:id)
       end
+      url += ".json"
       optstr = ""
       opts.each_key do |key|
         optstr += (optstr.length == 0) ? "?" : "&"
         optstr += "#{key.to_s}=#{opts[key]}"
       end
-      url += optstr
-      puts "URL: #{url}"
-      url
+      url + optstr
     end
 
     #
@@ -94,6 +145,12 @@ module Beanie
       headers
     end
 
+    #
+    # Default mechanism for constructing a path
+    def construct_path(opts = {})
+      object_name.pluralize
+    end
+
     #
     # Compute a Beanie object name from the class name.
     def object_name
@@ -104,14 +161,5 @@ module Beanie
           tr("-", "_").
           downcase
     end
-
-    #
-    # Populate the instance variables from the provided hash.
-    def populate(data, *vars)
-      vars.each do |var|
-        varsym = var.to_s.gsub(/^/, '@').to_sym
-        self.instance_variable_set(varsym, data[var.to_s])
-      end
-    end
   end
 end

data/lib/beanie/bank_account.rb

@@ -29,6 +29,16 @@
 #
 module Beanie
   class BankAccount < Api
-    attr_accessor :id, :iban, :name, :swift, :nominal_account_id, :contact_id
+    attr_accessor :id, :iban, :name, :swift, :nominal_account_id
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @iban = nil
+      @name = nil
+      @swift = nil
+      @nominal_account_id = nil
+    end
   end
 end

data/lib/beanie/bank_statement.rb

@@ -30,5 +30,16 @@
 module Beanie
   class BankStatement < Api
     attr_accessor :id, :end_date, :start_date, :upload_file, :bank_account_id, :document_id
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @end_date = nil
+      @start_date = nil
+      @upload_file = nil
+      @bank_account_id = nil
+      @document_id = nil
+    end
   end
 end

data/lib/beanie/bank_statement_data.rb

@@ -31,5 +31,21 @@ module Beanie
   class BankStatementData < Api
     attr_accessor :id, :cr_amount, :date, :dr_amount, :balance, :bank_statement_id
     attr_accessor :narrative1, :narrative2, :narrative3, :narrative4, :narrative5
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @cr_amount = nil
+      @date = nil
+      @dr_amount = nil
+      @balance = nil
+      @bank_statement_id = nil
+      @narrative1 = nil
+      @narrative2 = nil
+      @narrative3 = nil
+      @narrative4 = nil
+      @narrative5 = nil
+    end
   end
 end

data/lib/beanie/beanie_alert.rb

@@ -40,6 +40,16 @@ module Beanie
       ["Acknowledged (Read)", STATE_READ],
       ["Archived", STATE_ARCHIVED]
     ].freeze
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @state = nil
+      @message = nil
+      @url = nil
+      @member_id = nil
+    end
   
     #
     # Printable form of the state name

data/lib/beanie/{contact.rb → bill_of_material.rb}

@@ -28,28 +28,17 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #
 module Beanie
-  class Contact < Api
-    attr_accessor :id, :first_name, :last_name, :suffix, :title, :company_name, :email, :phone, :website
-    attr_accessor :id, :address1, :address2, :address3, :city, :state_county, :zip_postcode, :country
-  
-    TITLE_NONE = 0
-    TITLE_MR = 1
-    TITLE_MRS = 2
-    TITLE_MS = 3
-    TITLE_MASTER = 4
-    TITLE_DR = 5
-    TITLE_FR = 6
-    TITLE_REV = 7
-  
-    TITLE_NAMES = [
-      ["", TITLE_NONE],
-      ["Mr", TITLE_MR],
-      ["Mrs", TITLE_MRS],
-      ["Ms", TITLE_MS],
-      ["Master", TITLE_MASTER],
-      ["Dr", TITLE_DR],
-      ["Fr", TITLE_FR],
-      ["Rev", TITLE_REV]
-    ].freeze
+  class ProductionOrder < Api
+    attr_accessor :id, :name, :revision, :description, :stock_item_id
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @name = nil
+      @revision = nil
+      @description = nil
+      @stock_item_id = nil
+    end
   end
 end

data/lib/beanie/billable.rb

@@ -31,5 +31,16 @@ module Beanie
   class Billable < Api
     attr_accessor :id, :sales_invoice_item_id, :sales_order_item_id
     attr_accessor :quantity, :start, :description
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @sales_invoice_item_id = nil
+      @sales_order_item_id = nil
+      @quantity = nil
+      @start = nil
+      @description = nil
+    end
   end
 end

data/lib/beanie/bom_item.rb

@@ -0,0 +1,44 @@
+#
+# 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.
+#
+module Beanie
+  class BomItem < Api
+    attr_accessor :id, :stock_item_id, :quantity, :notes, :designators
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @stock_item_id = nil
+      @quantity = nil
+      @notes = nil
+      @designators = nil
+    end
+  end
+end

data/lib/beanie/company.rb

@@ -36,5 +36,32 @@ module Beanie
     attr_accessor :sales_shipping_nominal_account_id
     attr_accessor :accounts_receivable_nominal_account_id
     attr_accessor :accounts_payable_nominal_account_id
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @name = nil
+      @email = nil
+      @address1 = nil
+      @address2 = nil
+      @address3 = nil
+      @city = nil
+      @state_county = nil
+      @website = nil
+      @phone = nil
+      @fax = nil
+      @zip_postcode = nil
+      @registration = nil
+      @next_fye = nil
+      @runcom = nil
+      @country = nil
+      @currency = nil
+      @invoice_template_id = nil
+      @purchase_shipping_nominal_account_id = nil
+      @sales_shipping_nominal_account_id = nil
+      @accounts_receivable_nominal_account_id = nil
+      @accounts_payable_nominal_account_id = nil
+    end
   end
 end

data/lib/beanie/company_member.rb

@@ -30,5 +30,14 @@
 module Beanie
   class CompanyMember < Api
     attr_accessor :id, :member_id, :role, :member_email
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @member_id = nil
+      @role = nil
+      @member_email = nil
+    end
   end
 end

data/lib/beanie/config_type.rb

@@ -30,6 +30,18 @@
 module Beanie
   class ConfigType < Api
     attr_accessor :id, :defvalue, :description, :name, :regexp, :tag, :typecode
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @defvalue = nil
+      @description = nil
+      @name = nil
+      @regexp = nil
+      @tag = nil
+      @typecode = nil
+    end
   
     TYPE_BOOLEAN = 0
     TYPE_INTEGER = 1

data/lib/beanie/config_value.rb

@@ -30,5 +30,13 @@
 module Beanie
   class ConfigValue < Api
     attr_accessor :id, :value, :config_type
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @value = nil
+      @config_type = nil
+    end
   end
 end

data/lib/beanie/customer.rb

@@ -29,6 +29,23 @@
 #
 module Beanie
   class Customer < Api
-    attr_accessor :id, :balance, :state, :terms, :customer_vat, :contact_id, :currency
+    attr_accessor :id, :name, :state, :balance, :terms, :customer_vat, :currency
+    attr_accessor :internal_ref, :credit_limit, :credit_hold, :invoice_method
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @name = nil
+      @state = nil
+      @balance = nil
+      @terms = nil
+      @customer_vat = nil
+      @currency = nil
+      @internal_ref = nil
+      @credit_limit = nil
+      @credit_hold = nil
+      @invoice_method = nil
+    end
   end
 end

data/lib/beanie/customer_address.rb

@@ -0,0 +1,63 @@
+#
+# 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.
+#
+module Beanie
+  class CustomerAddress < Api
+    attr_accessor :customer_id, :id, :label, :name, :address1, :address2, :address3, :city
+    attr_accessor :state_county, :zip_postcode, :country_id, :email, :phone, :website
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @customer_id = nil
+      @label = nil
+      @name = nil
+      @address1 = nil
+      @address2 = nil
+      @address3 = nil
+      @city = nil
+      @state_county = nil
+      @zip_postcode = nil
+      @country = nil
+      @email = nil
+      @phone = nil
+      @website = nil
+    end
+
+    #
+    # Construct the path a little differently...
+    def construct_path(opts = {})
+      raise ":customer_id is not defined" unless opts[:customer_id]
+      path = "/customers/#{opts[:customer_id]}/customer_addresses"
+      opts.delete(:customer_id)
+      path
+    end
+  end
+end

data/lib/beanie/{contact_address.rb → customer_note.rb}

@@ -28,8 +28,15 @@
 # POSSIBILITY OF SUCH DAMAGE.
 #
 module Beanie
-  class ContactAddress < Api
-    attr_accessor :id, :address_type, :address1, :address2, :address3, :city, :state_county
-    attr_accessor :zip_postcode, :contact_id, :country
+  class CustomerNote < Api
+    attr_accessor :id, :member, :note
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @member = nil
+      @note = nil
+    end
   end
 end

data/lib/beanie/document.rb

@@ -50,6 +50,17 @@ module Beanie
       ["Contracts", CATEGORY_CONTRACTS],
       ["Miscellaneous", CATEGORY_MISCELLANEOUS]
     ].freeze
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @bxref = nil
+      @mime_type = nil
+      @size = nil
+      @src_file = nil
+      @category = nil
+    end
   
     #
     # Display a name for the document category

data/lib/beanie/fixed_asset.rb

@@ -30,5 +30,16 @@
 module Beanie
   class FixedAsset < Api
     attr_accessor :id, :acquired, :cost, :name, :value, :nominal_account_id
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @acquired = nil
+      @cost = nil
+      @name = nil
+      @value = nil
+      @nominal_account_id = nil
+    end
   end
 end

data/lib/beanie/journal.rb

@@ -30,5 +30,15 @@
 module Beanie
   class Journal < Api
     attr_accessor :id, :date, :folio, :title, :number
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @date = nil
+      @folio = nil
+      @title = nil
+      @number = nil
+    end
   end
 end

data/lib/beanie/journal_item.rb

@@ -30,5 +30,15 @@
 module Beanie
   class JournalItem < Api
     attr_accessor :id, :amount, :is_credit, :journal_id, :nominal_account_id
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @amount = nil
+      @is_credit = nil
+      @journal_id = nil
+      @nominal_account_id = nil
+    end
   end
 end

data/lib/beanie/nominal_account.rb

@@ -30,5 +30,14 @@
 module Beanie
   class NominalAccount < Api
     attr_accessor :id, :code, :name, :nominal_account_category_id
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @code = nil
+      @name = nil
+      @nominal_account_category_id = nil
+    end
   end
 end

data/lib/beanie/nominal_account_category.rb

@@ -54,6 +54,15 @@ module Beanie
       ["Other Expense", NA_TYPE_OTHER_EXPENSE],
       ["Other Income", NA_TYPE_OTHER_INCOME]
     ].freeze
+
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @na_type = nil
+      @name = nil
+      @parent_category_id = nil
+    end
   
     #
     # Show proper name for type

data/lib/beanie/product.rb

@@ -32,6 +32,19 @@ module Beanie
     attr_accessor :id, :description, :name, :sku, :is_service
     attr_accessor :nominal_account_id, :product_category_id, :unit_of_measure
 
+    #
+    # Initialize instance variables
+    def initialize
+      @id = nil
+      @description = nil
+      @name = nil
+      @sku = nil
+      @is_service = nil
+      @nominal_account_id = nil
+      @product_category_id = nil
+      @unit_of_measure = nil
+    end
+
     def self.find_by_name(name)
       puts "Find by name: #{name}"
       Beanie.find("products", "name", name)