fishbowl 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@fishbowl --create

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode
+jdk:
+  - openjdk7
+  - oraclejdk7
+  - openjdk6
+matrix:
+  exclude:
+    - rvm: 1.9.3
+      jdk: oraclejdk7
+    - rvm: 1.9.3
+      jdk: openjdk6
+    - rvm: rbx-19mode
+      jdk: oraclejdk7
+    - rvm: rbx-19mode
+      jdk: openjdk6

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'simplecov'
+
+gem 'equivalent-xml'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 The Ready Project, LLC
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Fishbowl
+
+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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fishbowl'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fishbowl
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new

data/fishbowl.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.summary       = %q{Fishbowl Inventory API}
+  gem.homepage      = "https://github.com/readyproject/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'
+end

data/lib/fishbowl.rb

@@ -0,0 +1,110 @@
+require 'socket'
+require 'base64'
+require 'singleton'
+
+require 'nokogiri'
+
+require 'fishbowl/version'
+require 'fishbowl/errors'
+require 'fishbowl/objects'
+
+module Fishbowl # :nodoc:
+  class Connection
+    include Singleton
+
+    def self.connect(options = {})
+      raise Fishbowl::Errors::MissingHost if options[:host].nil?
+
+      @host = options[:host]
+      @port = options[:port].nil? ? 28192 : options[:port]
+
+      @connection = TCPSocket.new @host, @port
+
+      self.instance
+    end
+
+    def self.login(options = {})
+      raise Fishbowl::Errors::ConnectionNotEstablished if @connection.nil?
+      raise Fishbowl::Errors::MissingUsername if options[:username].nil?
+      raise Fishbowl::Errors::MissingPassword if options[:password].nil?
+
+      @username, @password = options[:username], options[:password]
+
+      Fishbowl::Objects::BaseObject.new.send_request(login_request, true)
+
+      code, message, _ = get_response('LoginRs')
+
+      Fishbowl::Errors.confirm_success_or_raise(code, message)
+
+      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)
+      write(request)
+    end
+
+    def self.close
+      @connection.close
+      @connection = nil
+    end
+
+    def self.get_response(expectation = 'FbiMsgRs')
+      response = read
+
+      status_code = response.xpath("//#{expectation}/@statusCode").first.value
+      status_message = response.xpath("//#{expectation}/@statusMessage").first.value
+
+      [status_code, status_message, response]
+    end
+
+  private
+
+    def self.login_request
+      Nokogiri::XML::Builder.new do |xml|
+        xml.request {
+          xml.LoginRq {
+            xml.IAID          "fishbowl-ruby"
+            xml.IAName        "Fishbowl Ruby Gem"
+            xml.IADescription "Fishbowl Ruby Gem"
+            xml.UserName      @username
+            xml.UserPassword  encoded_password
+          }
+        }
+      end
+    end
+
+    def self.encoded_password
+      Base64.encode64(@password)
+    end
+
+    def self.write(request)
+      body = request.to_xml
+      size = [body.size].pack("L>")
+
+      @connection.write(size)
+      @connection.write(body)
+    end
+
+    def self.read
+      length = @connection.recv(3).unpack('L>').join('').to_i
+      Nokogiri::XML.parse(@connection.recv(length))
+    end
+
+  end
+end

data/lib/fishbowl/errors.rb

@@ -0,0 +1,12 @@
+module Fishbowl::Errors
+  class ConnectionNotEstablished < RuntimeError; end;
+  class MissingHost < ArgumentError; end;
+  class MissingUsername < ArgumentError; end;
+  class MissingPassword < ArgumentError; end;
+
+  class StatusError < RuntimeError; end;
+
+  def self.confirm_success_or_raise(code, message)
+    code.to_i == 1000 ? true : raise(StatusError, message)
+  end
+end

data/lib/fishbowl/objects.rb

@@ -0,0 +1,6 @@
+module Fishbowl
+  module Objects; end; # :nodoc:
+end
+
+require 'fishbowl/objects/base_object'
+require 'fishbowl/objects/account'

data/lib/fishbowl/objects/account.rb

@@ -0,0 +1,19 @@
+module Fishbowl::Objects
+  class Account < BaseObject
+    def self.get_list
+      self.new.send_request("GetAccountListRq")
+    end
+
+    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
+
+      self.new.send_request(builder, true)
+    end
+  end
+end

data/lib/fishbowl/objects/base_object.rb

@@ -0,0 +1,29 @@
+module Fishbowl::Objects
+  class BaseObject
+    attr_accessor :ticket
+
+    def send_request(request, fragment = false)
+      Fishbowl::Connection.send(build_request(request, fragment))
+    end
+
+  private
+
+    def build_request(request, fragment = false)
+      Nokogiri::XML::Builder.new do |xml|
+        xml.FbiXml {
+          if @ticket.nil?
+            xml.Ticket
+          else
+            xml.Ticket @ticket
+          end
+
+          xml.FbiMsgsRq {
+            xml << request.doc.xpath("request/*").to_xml if fragment
+            xml.send(request.to_s) unless fragment
+          }
+        }
+      end
+    end
+
+  end
+end

data/lib/fishbowl/version.rb

@@ -0,0 +1,3 @@
+module Fishbowl # :nodoc:
+  VERSION = "0.0.1"
+end

data/spec/connection_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe Fishbowl::Connection do
+  before :each do
+    mock_tcp_connection
+  end
+
+  after :each do
+    unmock_tcp
+  end
+
+  describe '.connect' do
+    it 'should require a host' do
+      lambda {
+        Fishbowl::Connection.connect
+      }.should raise_error(Fishbowl::Errors::MissingHost)
+    end
+
+    it 'should default to port 28192' do
+      Fishbowl::Connection.connect(host: 'localhost')
+      Fishbowl::Connection.port.should eq(28192)
+    end
+  end
+
+  describe '.login' do
+    before :each do
+      Fishbowl::Connection.connect(host: 'localhost')
+    end
+
+    it 'should require the connection to be established' do
+      lambda {
+        Fishbowl::Connection.close
+        Fishbowl::Connection.login
+      }.should raise_error(Fishbowl::Errors::ConnectionNotEstablished)
+    end
+
+    it 'should require a username' do
+      lambda {
+        Fishbowl::Connection.login(password: 'secret')
+      }.should raise_error(Fishbowl::Errors::MissingUsername)
+    end
+
+    it 'should require a password' do
+      lambda {
+        Fishbowl::Connection.login(username: 'johndoe')
+      }.should raise_error(Fishbowl::Errors::MissingPassword)
+    end
+
+    it 'should connect to Fishbowl API' do
+      mock_login_response
+      Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+    end
+  end
+
+  describe '.close' do
+    it "should close the connection" do
+      lambda {
+        mock_login_response
+        Fishbowl::Connection.connect(host: 'localhost')
+        Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+
+        Fishbowl::Connection.close
+        Fishbowl::Connection.login
+      }.should raise_error(Fishbowl::Errors::ConnectionNotEstablished)
+    end
+  end
+
+  describe '.host' do
+    it 'should return the host value' do
+      Fishbowl::Connection.connect(host: 'localhost')
+      Fishbowl::Connection.host.should eq('localhost')
+    end
+  end
+
+  describe '.port' do
+    it "should return the port value" do
+      Fishbowl::Connection.connect(host: 'localhost', port: 1234)
+      Fishbowl::Connection.port.should eq(1234)
+    end
+  end
+
+  describe '.username' do
+    it 'should return the username value' do
+      mock_login_response
+      Fishbowl::Connection.connect(host: 'localhost')
+      Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+      Fishbowl::Connection.username.should eq('johndoe')
+    end
+  end
+
+  describe '.password' do
+    it 'should return the password value' do
+      mock_login_response
+      Fishbowl::Connection.connect(host: 'localhost')
+      Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+      Fishbowl::Connection.password.should eq('secret')
+    end
+  end
+end

data/spec/errors_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Fishbowl::Errors do
+  describe '.confirm_success_or_raise' do
+    it "should return true is code is 1000" do
+      Fishbowl::Errors.confirm_success_or_raise('1000', '').should be_true
+    end
+
+    it "should raise an error on any other code" do
+      10.times do
+        code = rand(3004) + 1000
+        lambda {
+          Fishbowl::Errors.confirm_success_or_raise(code, '')
+        }.should raise_error(Fishbowl::Errors::StatusError)
+      end
+    end
+  end
+end

data/spec/objects/account_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Fishbowl::Objects::Account do
+  before :each do
+    mock_tcp_connection
+    mock_login_response
+    Fishbowl::Connection.connect(host: 'localhost')
+    Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+  end
+
+  after :each do
+    unmock_tcp
+  end
+
+  let(:connection) { FakeTCPSocket.instance }
+
+  describe ".get_list" do
+    let(:proper_request) do
+      Nokogiri::XML::Builder.new do |xml|
+        xml.FbiXml {
+          xml.Ticket
+          xml.FbiMsgsRq {
+            xml.GetAccountListRq
+          }
+        }
+      end
+    end
+
+    let(:canned_response) do
+
+    end
+
+    it "should properly format the request" do
+      Fishbowl::Objects::Account.get_list
+      connection.last_write.should be_equivalent_to(proper_request.to_xml)
+    end
+
+    it "should return array of Accounts"
+
+    it "should return empty array when no accounts" do
+
+    end
+  end
+
+  describe ".get_balance" do
+    let(:proper_request) do
+      Nokogiri::XML::Builder.new do |xml|
+        xml.FbiXml {
+          xml.Ticket
+          xml.FbiMsgsRq {
+            xml.GetAccountBalanceRq {
+              xml.Account "General Account"
+            }
+          }
+        }
+      end
+    end
+
+    it "should properly format the request" do
+      Fishbowl::Objects::Account.get_balance("General Account")
+      connection.last_write.should be_equivalent_to(proper_request.to_xml)
+    end
+
+    it "should return the balance for the requested Account"
+  end
+end

data/spec/objects/base_object_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Fishbowl::Objects::BaseObject do
+  let(:ticket) { "thisisasample" }
+  let(:base_object) { Fishbowl::Objects::BaseObject.new }
+
+  let(:empty_ticket_builder) do
+    Nokogiri::XML::Builder.new do |xml|
+      xml.FbiXml {
+        xml.Ticket
+
+        xml.FbiMsgsRq {
+          xml.SampleRequest
+        }
+      }
+    end
+  end
+
+  let(:ticket_builder) do
+    Nokogiri::XML::Builder.new do |xml|
+      xml.FbiXml {
+        xml.Ticket ticket
+
+        xml.FbiMsgsRq {
+          xml.SampleRequest
+        }
+      }
+    end
+  end
+
+  context "Protected Methods" do
+    describe "#send_request" do
+
+    end
+  end
+
+  context "Private Methods" do
+    describe "#build_request" do
+      it "should build a request document" do
+        base_object.send(:build_request, "SampleRequest").to_xml.should be_equivalent_to(empty_ticket_builder.to_xml)
+      end
+
+      it "should accept an XML Builder" do
+        builder = Nokogiri::XML::Builder.new { |xml| xml.request { xml.SampleRequest } }
+        base_object.send(:build_request, builder, true).to_xml.should be_equivalent_to(empty_ticket_builder.to_xml)
+      end
+
+      context "when ticket is empty" do
+        it "should return an empty Nokogiri::XML::Builder" do
+          base_object.send(:build_request, "SampleRequest").to_xml.should be_equivalent_to(empty_ticket_builder.to_xml)
+        end
+      end
+
+      context "when ticket is set" do
+        before :each do
+          base_object.ticket = ticket
+        end
+
+        it "should return the ticket wrapped in a Nokogiri::XML::Builder" do
+          base_object.send(:build_request, "SampleRequest").to_xml.should be_equivalent_to(ticket_builder.to_xml)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+require 'equivalent-xml/rspec_matchers'
+
+require 'fishbowl'
+
+require 'support/fake_socket'
+require 'support/fake_login'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/spec/support/fake_login.rb

@@ -0,0 +1,15 @@
+require 'support/fake_socket'
+
+def mock_login_response
+  fake_login_response = Nokogiri::XML::Builder.new do |xml|
+    xml.FbiXml {
+      xml.Ticket
+
+      xml.FbiMsgsRs(statusCode: '1000', statusMessage: "Success!") {
+        xml.LoginRs(statusCode: '1000', statusMessage: "Success!")
+      }
+    }
+  end
+
+  FakeTCPSocket.instance.set_canned(fake_login_response.to_xml)
+end

data/spec/support/fake_socket.rb

@@ -0,0 +1,46 @@
+require 'socket'
+require 'singleton'
+require 'rspec/mocks'
+
+TCP_NEW = TCPSocket.method(:new) unless defined? TCP_NEW
+
+class FakeTCPSocket
+  include Singleton
+
+  attr_reader :last_write
+
+  def flush; end
+
+  def write(some_text = nil)
+    @last_write = some_text
+  end
+
+  def readchar
+    6
+  end
+
+  def read(num)
+    set_canned('') if @canned_response.nil?
+    num > @canned_response.size ? @canned_response : @canned_response.slice!(0..num)
+  end
+  alias_method :recv, :read
+
+  def set_canned(response)
+    body = response
+    size = [body.size].pack("L>")
+
+    @canned_response = size + body
+  end
+
+  def close; end
+end
+
+def mock_tcp_connection
+  TCPSocket.stub(:new).and_return {
+    FakeTCPSocket.instance
+  }
+end
+
+def unmock_tcp
+  TCPSocket.stub(:new).and_return { TCP_NEW.call }
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: fishbowl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- James Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+description: Provides an interface to the Fishbowl Inventory API.
+email:
+- james@plainprograms.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fishbowl.gemspec
+- lib/fishbowl.rb
+- lib/fishbowl/errors.rb
+- lib/fishbowl/objects.rb
+- lib/fishbowl/objects/account.rb
+- lib/fishbowl/objects/base_object.rb
+- lib/fishbowl/version.rb
+- spec/connection_spec.rb
+- spec/errors_spec.rb
+- spec/objects/account_spec.rb
+- spec/objects/base_object_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_login.rb
+- spec/support/fake_socket.rb
+homepage: https://github.com/readyproject/fishbowl
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3228914196506736409
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3228914196506736409
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Fishbowl Inventory API
+test_files:
+- spec/connection_spec.rb
+- spec/errors_spec.rb
+- spec/objects/account_spec.rb
+- spec/objects/base_object_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_login.rb
+- spec/support/fake_socket.rb