fishbowl 0.0.1 → 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d19ab01cc4985f080ac26eda680a01a02c15b278172ffc4f18d2b6c6090c3de
+  data.tar.gz: a24fcb59434941c7af2a4747b91eb09d0e4e7293cd11a50d8885080dc62e94af
+SHA512:
+  metadata.gz: dd3cc10062e90203f9a688548b344221684e84f02fe90561435913d825b0fe27fdd8026935636b7b424693783ee3accda60fef44a61e8cdedf2125ad18cada71
+  data.tar.gz: 29e6eaa2e0be585ce71138b2e62748721a58bc43f2e8fc267c5d750559ce376d3ba538479d1a3be757c07b66528460139be249c9a4d6217f03ef3567de33653b

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea/

data/.travis.yml

@@ -1,19 +1,24 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - jruby-19mode # JRuby in 1.9 mode
+  - "1.9.3"
+  - jruby-19mode
+  - jruby-head
   - rbx-19mode
 jdk:
   - openjdk7
   - oraclejdk7
   - openjdk6
+bundler_args: --without=localtest
 matrix:
   exclude:
-    - rvm: 1.9.3
+    - rvm: "1.9.3"
       jdk: oraclejdk7
-    - rvm: 1.9.3
+    - rvm: "1.9.3"
       jdk: openjdk6
     - rvm: rbx-19mode
       jdk: oraclejdk7
     - rvm: rbx-19mode
       jdk: openjdk6
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: rbx-19mode

data/Gemfile

@@ -4,6 +4,13 @@ gemspec
 
 gem 'rake'
 gem 'rspec'
-gem 'simplecov'
-
 gem 'equivalent-xml'
+gem 'nokogiri', '>= 1.8.5'
+
+group :localtest do
+  gem 'pry'
+end
+
+group :test do
+  gem 'spork'
+end

data/Guardfile

@@ -0,0 +1,13 @@
+guard 'spork' do
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+end
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+end

data/README.md

@@ -2,10 +2,6 @@
 
 Provides an interface to the Fishbowl Inventory API.
 
-[![Build Status](https://travis-ci.org/readyproject/fishbowl.png)](https://travis-ci.org/readyproject/fishbowl)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/readyproject/fishbowl)
-[![Dependency Status](https://gemnasium.com/readyproject/fishbowl.png)](https://gemnasium.com/readyproject/fishbowl)
-
 ## Requirements
 
 A Ruby 1.9 compatible interpreter
@@ -26,7 +22,31 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Add this to your env.rb file or as an initializer
+
+```ruby
+Fishbowl.configure do |config|
+  config.username = "joe"
+  config.password = "joes_password"
+  config.host = "999.888.77.666"
+  config.app_id = "1234"
+  config.app_name = "Fishbowl Ruby Gem"
+  config.app_description = "Fishbowl Ruby Gem"
+  config.debug = true
+end
+```
+
+Now you are setup to make API calls in your application code
+
+```ruby
+Fishbowl::Connection.connect
+Fishbowl::Connection.login
+carriers = Fishbowl::Requests.get_carrier_list
+```
+
+The 'connect' method establishes the connection socket to the server, the 'login' method authenticates the connection to the server using a username and password.
+
+Once the login method is successful (The Fishbowl API responds with statusCode=1000 for successful requests, see a [complete list](../master/lib/status_codes.yml) of status codes)
 
 ## Contributing
 

data/fishbowl.gemspec

@@ -6,16 +6,16 @@ require 'fishbowl/version'
 Gem::Specification.new do |gem|
   gem.name          = "fishbowl"
   gem.version       = Fishbowl::VERSION
-  gem.authors       = ["James Thompson"]
-  gem.email         = ["james@plainprograms.com"]
-  gem.description   = %q{Provides an interface to the Fishbowl Inventory API.}
+  gem.authors       = ["James Thompson, Simeon Berns"]
+  gem.email         = ["james@plainprograms.com, simeonberns@gmail.com"]
+  gem.description   = %q{Provides an interface to the Fishbowl Inventory API}
   gem.summary       = %q{Fishbowl Inventory API}
-  gem.homepage      = "https://github.com/readyproject/fishbowl"
+  gem.homepage      = "https://github.com/zion/fishbowl"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'nokogiri', '~> 1.5.5'
+  gem.add_dependency 'nokogiri', '>= 1.8.5'
 end

data/lib/fishbowl/configuration.rb

@@ -0,0 +1,9 @@
+module Fishbowl
+  class Configuration
+    attr_accessor :username, :password, :host, :port, :app_id, :app_name, :app_description, :debug
+
+    def initialize
+      @debug = false
+    end
+  end
+end

data/lib/fishbowl/connection.rb

@@ -0,0 +1,100 @@
+require 'nokogiri'
+
+module Fishbowl
+  class Connection
+    include Singleton
+
+    def self.connect()
+      raise Fishbowl::Errors::MissingHost if Fishbowl.configuration.host.nil?
+
+      @host = Fishbowl.configuration.host
+      @port = Fishbowl.configuration.port.nil? ? 28192 : Fishbowl.configuration.port
+
+      @connection = TCPSocket.new @host, @port
+
+      self.instance
+    end
+
+    def self.login()
+      raise Fishbowl::Errors::ConnectionNotEstablished if @connection.nil?
+      raise Fishbowl::Errors::MissingUsername if Fishbowl.configuration.host.nil?
+      raise Fishbowl::Errors::MissingPassword if Fishbowl.configuration.host.nil?
+
+      @username = Fishbowl.configuration.username
+      @password = Fishbowl.configuration.password
+
+      code, _ = Fishbowl::Objects::BaseObject.new.send_request(login_request)
+      Fishbowl::Errors.confirm_success_or_raise(code)
+
+      raise "Login failed" unless code.eql? "1000"
+
+      self.instance
+    end
+
+    def self.host
+      @host
+    end
+
+    def self.port
+      @port
+    end
+
+    def self.username
+      @username
+    end
+
+    def self.password
+      @password
+    end
+
+    def self.send(request, expected_response = 'FbiMsgsRs')
+      puts 'opening connection...' if Fishbowl.configuration.debug.eql? true
+      puts request if Fishbowl.configuration.debug.eql? true
+      puts 'waiting for response...' if Fishbowl.configuration.debug.eql? true
+      write(request)
+      get_response(expected_response)
+    end
+
+    def self.close
+      @connection.close
+      @connection = nil
+    end
+
+    private
+
+    def self.login_request
+      Nokogiri::XML::Builder.new do |xml|
+        xml.request {
+          xml.LoginRq {
+            xml.IAID          Fishbowl.configuration.app_id
+            xml.IAName        Fishbowl.configuration.app_name
+            xml.IADescription Fishbowl.configuration.app_description
+            xml.UserName      Fishbowl.configuration.username
+            xml.UserPassword  encoded_password
+          }
+        }
+      end
+    end
+
+    def self.encoded_password
+      Digest::MD5.base64digest(@password)
+    end
+
+    def self.write(request)
+      body = request.to_xml
+      size = [body.size].pack("L>")
+      @connection.write(size)
+      @connection.write(body)
+    end
+
+    def self.get_response(expectation)
+      puts "reading response" if Fishbowl.configuration.debug.eql? true
+      length = @connection.read(4).unpack('L>').join('').to_i
+      response = Nokogiri::XML.parse(@connection.read(length))
+      puts response if Fishbowl.configuration.debug.eql? true
+      status_code = response.xpath("/FbiXml/FbiMsgsRs").attr("statusCode").value
+      [status_code, response]
+    end
+
+  end
+end

data/lib/fishbowl/errors.rb

@@ -1,12 +1,22 @@
-module Fishbowl::Errors
-  class ConnectionNotEstablished < RuntimeError; end;
-  class MissingHost < ArgumentError; end;
-  class MissingUsername < ArgumentError; end;
-  class MissingPassword < ArgumentError; end;
+require 'yaml'
 
-  class StatusError < RuntimeError; end;
+module Fishbowl
+  module Errors
+    class ConnectionNotEstablished < RuntimeError; end;
+    class MissingHost < ArgumentError; end;
+    class MissingUsername < ArgumentError; end;
+    class MissingPassword < ArgumentError; end;
+    class EmptyResponse < RuntimeError; end;
 
-  def self.confirm_success_or_raise(code, message)
-    code.to_i == 1000 ? true : raise(StatusError, message)
+    class StatusError < RuntimeError; end;
+
+    def self.confirm_success_or_raise(code)
+      (code.to_i.eql? 1000) ? true : raise(StatusError, get_status(code))
+    end
+
+    def self.get_status(code)
+      status_codes = YAML.load_file('./lib/status_codes.yml')['codes']
+      status_codes[code]['message']
+    end
   end
 end

data/lib/fishbowl/ext.rb

@@ -0,0 +1,15 @@
+class String
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+end
+
+class Hash
+  def symbolize_keys
+    self.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+  end
+end

data/lib/fishbowl/objects/account.rb

@@ -1,19 +1,15 @@
 module Fishbowl::Objects
   class Account < BaseObject
-    def self.get_list
-      self.new.send_request("GetAccountListRq")
-    end
+    attr_reader :name, :accounting_id, :account_type, :balance
 
-    def self.get_balance(account)
-      builder = Nokogiri::XML::Builder.new do |xml|
-        xml.request {
-          xml.GetAccountBalanceRq {
-            xml.Account (account.is_a?(Account) ? account.name : account)
-          }
-        }
-      end
+    def self.attributes
+      %w{Name AccountingID AccountType Balance}
+    end
 
-      self.new.send_request(builder, true)
+    def initialize(account_xml)
+      @xml = account_xml
+      parse_attributes
+      self
     end
   end
 end

data/lib/fishbowl/objects/address.rb

@@ -0,0 +1,86 @@
+module Fishbowl::Objects
+  class Address < BaseObject
+    attr_reader :db_id, :temp_account, :name, :attn, :street, :city, :zip
+    attr_reader :location_group_id, :default, :residential, :type, :state
+    attr_reader :country, :address_information_list
+
+    def self.attributes
+      %w{ID Name Attn Street City Zip LocationGroupID Default Residential Type}
+    end
+
+    def initialize(address_xml)
+      @xml = address_xml
+      parse_attributes
+
+      @temp_account
+      @state = get_state(address_xml)
+      @country = get_country(address_xml)
+      @address_information_list = get_address_information(address_xml)
+
+      self
+    end
+
+  private
+
+    def get_state(address_xml)
+      State.new(address_xml.xpath("State"))
+    end
+
+    def get_country(address_xml)
+      Country.new(address_xml.xpath("Country"))
+    end
+
+    def get_address_information(address_xml)
+      results = []
+
+      address_xml.xpath("AddressInformationList").each do |address_info_xml|
+        results << AddressInformation.new(address_info_xml)
+      end
+
+      results
+    end
+
+  end
+
+  class State < BaseObject
+    attr_reader :db_id, :name, :code, :country_id
+
+    def self.attributes
+      %w{ID Name Code CountryID}
+    end
+
+    def initialize(state_xml)
+      @xml = state_xml
+      parse_attributes
+      self
+    end
+  end
+
+  class Country < BaseObject
+    attr_reader :db_id, :name, :code
+
+    def self.attributes
+      %w{ID Name Code}
+    end
+
+    def initialize(country_xml)
+      @xml = country_xml
+      parse_attributes
+      self
+    end
+  end
+
+  class AddressInformation < BaseObject
+    attr_reader :db_id, :name, :data, :default, :type
+
+    def self.attributes
+      %w{ID Name Data Default Type}
+    end
+
+    def initialize(address_info_xml)
+      @xml = address_info_xml
+      parse_attributes
+      self
+    end
+  end
+end

data/lib/fishbowl/objects/base_object.rb

@@ -1,28 +1,61 @@
 module Fishbowl::Objects
   class BaseObject
-    attr_accessor :ticket
+    @@ticket = nil
+    def send_request(request, expected_response = 'FbiMsgsRs')
+      code, response = Fishbowl::Connection.send(build_request(request), expected_response)
+      Fishbowl::Errors.confirm_success_or_raise(code)
+      puts "Response successful" if Fishbowl.configuration.debug.eql? true
+      @@ticket = response.xpath("/FbiXml/Ticket/Key").text
+      [code, response]
+    end
+
+  protected
+
+    def self.attributes
+      %w{ID}
+    end
 
-    def send_request(request, fragment = false)
-      Fishbowl::Connection.send(build_request(request, fragment))
+    def parse_attributes
+      self.class.attributes.each do |field|
+        field = field.to_s
+
+        if field == 'ID'
+          instance_var = 'db_id'
+        elsif field.match(/^[A-Z]{3,}$/)
+          instance_var = field.downcase
+        else
+          instance_var = field.gsub(/ID$/, 'Id').underscore
+        end
+
+        instance_var = '@' + instance_var
+        value = @xml.children.nil? ? nil : @xml.children.text
+        instance_variable_set(instance_var, value)
+      end
     end
 
   private
 
-    def build_request(request, fragment = false)
-      Nokogiri::XML::Builder.new do |xml|
+    def build_request(request)
+      new_req = Nokogiri::XML::Builder.new do |xml|
         xml.FbiXml {
-          if @ticket.nil?
+          if @@ticket.nil?
             xml.Ticket
           else
-            xml.Ticket @ticket
+            xml.Ticket {
+              xml.Key @@ticket
+            }
           end
 
           xml.FbiMsgsRq {
-            xml << request.doc.xpath("request/*").to_xml if fragment
-            xml.send(request.to_s) unless fragment
+            if request.respond_to?(:to_xml)
+              xml << request.doc.xpath("request/*").to_xml
+            else
+              xml.send(request.to_s)
+            end
           }
         }
       end
+      Nokogiri::XML(new_req.to_xml).root
     end
 
   end

data/lib/fishbowl/objects/carrier.rb

@@ -0,0 +1,15 @@
+module Fishbowl::Objects
+  class Carrier < BaseObject
+    attr_accessor :name
+
+    def self.attributes
+      %w{Name}
+    end
+
+    def initialize(carrier_xml)
+      @xml = carrier_xml
+      parse_attributes
+      self
+    end
+  end
+end

data/lib/fishbowl/objects/carton.rb

@@ -0,0 +1,54 @@
+module Fishbowl::Objects
+  class Carton < BaseObject
+    attr_reader :db_id, :ship_id, :carton_num, :tracking_num, :freight_weight, :freight_amount, :shipping_items
+
+    def self.attributes
+      %w{ID ShipID CartonNum TrackingNum FreightWeight FreightAmount}
+    end
+
+    def initialize(carton_xml)
+      @xml = carton_xml
+      parse_attributes
+
+      @shipping_items = get_shipping_items
+
+      self
+    end
+
+  private
+
+    def get_shipping_items
+      results = []
+
+      @xml.xpath('ShippingItems/ShippingItem').each do |xml|
+        results << Fishbowl::Objects::ShippingItem.new(xml)
+      end
+
+      results
+    end
+  end
+
+  class ShippingItem < BaseObject
+    attr_reader :ship_item_id, :product_number, :product_description
+    attr_reader :qty_shipped, :cost, :sku, :upc, :order_item_id
+    attr_reader :order_line_item, :carton_name, :carton_id, :tag_num, :weight
+    attr_reader :display_weight, :tracking, :uom, :weight_uom, :display_weight_uom
+
+    def self.attributes
+      %w{ShipItemID ProductNumber ProductDescription QtyShipped Cost SKU UPC
+         OrderItemID OrderLineItem CartonName CartonID TagNum Weight
+         DisplayWeight Tracking}
+    end
+
+    def initialize(shipping_item_xml)
+      @xml = shipping_item_xml
+      parse_attributes
+
+      @uom = Fishbowl::Objects::UOM.new(@xml.xpath("UOM"))
+      @weight_uom = Fishbowl::Objects::UOM.new(@xml.xpath("WeightUOM/UOM"))
+      @display_weight_uom = Fishbowl::Objects::UOM.new(@xml.xpath("DisplayWeightUOM/UOM"))
+
+      self
+    end
+  end
+end

data/lib/fishbowl/objects/uom.rb

@@ -0,0 +1,47 @@
+module Fishbowl::Objects
+  class UOM < BaseObject
+    attr_accessor :uomid, :name, :code, :integral, :active, :type
+    attr_accessor :uom_conversions
+
+    def self.attributes
+      %w{UOMID Name Code Integral Active Type}
+    end
+
+    def initialize(uom_xml)
+      @xml = uom_xml
+      parse_attributes
+
+      @uom_conversions = get_uom_conversions
+
+      self
+    end
+
+  private
+
+    def get_uom_conversions
+      results = []
+
+      @xml.xpath("//UOMConversions/UOMConversion").each do |xml|
+        results << Fishbowl::Objects::UOMConversion.new(xml)
+      end
+
+      results
+    end
+
+  end
+
+  class UOMConversion < BaseObject
+    attr_accessor :main_uom_id, :to_uom_id, :to_uom_code, :conversion_multiply
+    attr_accessor :conversion_factor, :to_uom_is_integral
+
+    def self.attributes
+      %w{MainUOMID ToUOMID ToUOMCode ConversionMultiply ConversionFactor ToUOMIsIntegral}
+    end
+
+    def initialize(uom_conversion_xml)
+      @xml = uom_conversion_xml
+      parse_attributes
+      self
+    end
+  end
+end

data/lib/fishbowl/objects/user.rb

@@ -0,0 +1,15 @@
+module Fishbowl::Objects
+  class User < BaseObject
+    attr_accessor :db_id, :user_name, :first_name, :last_name, :initials, :active
+
+    def self.attributes
+      %w{ID UserName FirstName LastName Initials Active}
+    end
+
+    def initialize(user_xml)
+      @xml = user_xml
+      parse_attributes
+      self
+    end
+  end
+end

data/lib/fishbowl/objects.rb

@@ -3,4 +3,9 @@ module Fishbowl
 end
 
 require 'fishbowl/objects/base_object'
+require 'fishbowl/objects/uom'
 require 'fishbowl/objects/account'
+require 'fishbowl/objects/address'
+require 'fishbowl/objects/carton'
+require 'fishbowl/objects/user'
+require 'fishbowl/objects/carrier'

data/lib/fishbowl/requests/add_inventory.rb

@@ -0,0 +1,34 @@
+module Fishbowl::Requests
+  def self.add_inventory(options = {})
+    options = options.symbolize_keys
+
+    %w{part_number quantity uom_id cost location_tag_number tag_number}.each do |required_field|
+      raise ArgumentError if options[required_field.to_sym].nil?
+    end
+
+    raise ArgumentError unless options[:tracking].nil? || options[:tracking].is_a?(Fishbowl::Object::Tracking)
+
+    request = format_add_inventory_request(options)
+    Fishbowl::Objects::BaseObject.new.send_request(request, 'AddInventoryRs')
+  end
+
+private
+
+  def self.format_add_inventory_request(options)
+    Nokogiri::XML::Builder.new do |xml|
+      xml.request {
+        xml.AddInventoryRq {
+          xml.PartNum options[:part_number]
+          xml.Quantity options[:quantity]
+          xml.UOMID options[:uom_id]
+          xml.Cost options[:cost]
+          xml.Note options[:note] unless options[:note].nil?
+          xml.Tracking options[:tracking] unless options[:tracking].nil?
+          xml.LocationTagNum options[:location_tag_number]
+          xml.TagNum options[:tag_number]
+        }
+      }
+    end
+  end
+
+end