tallyable 0.0.2

data/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License
+===============
+
+Copyright (c) 2014 Supreeth Burji
+
+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,46 @@
+## Tallyable
+
+* Basic Tally ERP.9 integration using xml api
+* The motivation is to provide a "Get Started" framework for Tally integration. This has to be essentially extended as per custom requirements.
+* This requires Tally ERP.9 to be running with the Company selected from the Tally interface
+* To be used as a guide to develope integration capabilities for your rails application with Tally ERP.9
+* Authentication is interestingly kept open with default configuration, for the xml interface
+  * This is because Authentication is not yet configurable in Tally ERP.9 remote user using xml api interface
+  * Allows only Tally .NET user's Application login for now
+* TDL (Tally Domain Language) was found to be the most relevant and easy to use for integration purposes
+* Refer test cases for usage
+  * To run test cases use `rake test`
+* Disclaimer
+  * Author does not endorse TALLY, nor has any links with TALLY trademark or brand
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tallyable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tallyable
+
+## Usage
+
+    require 'tallyable'
+
+    class Employee
+      acts_as_tallyable "http://example.com", 9002 # Tally host and port options
+
+      self.class.employee_request
+    end
+
+## 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,34 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tallyable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/tallyable.rb

@@ -0,0 +1,4 @@
+require 'tallyable/acts_as_tallyable'
+
+module Tallyable
+end

data/lib/tallyable/acts_as_tallyable.rb

@@ -0,0 +1,82 @@
+require 'net/http'
+require 'nokogiri'
+
+module Tallyable
+  module ActsAsTallyable
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def acts_as_tallyable(host, port = 9002, options = {})
+        @@host = host
+        @@port = port
+      end
+
+      def employee_request
+        result = tally_request("#{ File.dirname(__FILE__) }/employee_request.xml")
+        employees = []
+
+        unless result.is_a? String
+          xml = Nokogiri.XML(result.body)
+          xml.xpath("ENVELOPE").each do |nodes|
+            params = {}
+            nodes.children.each do |node|
+              params[:name] = node.text if node.name == "EMPPROFILENAME" 
+              %w[EMPPROFILEEMAILID 
+                EMPPROFILEGENDER 
+                EMPPROFILEDATEOFBIRTH 
+                EMPPROFILECONTACTNUMBER 
+                EMPPROFILEEMPLOYEEADDRESS].each do |tag|
+                  if node.at(tag)
+                    case node.at(tag).name
+                      when "EMPPROFILEEMAILID" 
+                        params[:email] = node.at(tag).text
+                      when "EMPPROFILEGENDER" 
+                        params[:gender] = node.at(tag).text
+                      when "EMPPROFILEDATEOFBIRTH" 
+                        params[:date_of_birth] = node.at(tag).text
+                      when "EMPPROFILECONTACTNUMBER" 
+                        params[:phone] = node.at(tag).text
+                      when "EMPPROFILEEMPLOYEEADDRESS" 
+                        params[:address] = node.at(tag).text
+                    end
+                  end
+              end
+
+              # hack to find a record delimiter, hierarchical tags are better
+              if node.name == "EMPPROFILESNO" and !params.empty?
+                employees << params
+                params = {}
+              end
+            end
+            employees << params
+          end
+        end
+        
+        employees
+      end
+
+      private
+      # helper method for "POST" ing XML request to Tally
+      def tally_request(tdl_file)
+        uri = URI.parse("#{ @@host }:#{ @@port }")
+        http_handler = Net::HTTP.new(uri.host, uri.port)
+
+        request_handler = Net::HTTP::Post.new(uri.to_s)
+        begin
+          request_handler.body = File.read(tdl_file)
+          http_handler.request(request_handler)
+        rescue Exception => e
+          "#{e.message}"
+        end
+      end
+    end    
+  end
+end
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send(:include, Tallyable::ActsAsTallyable)
+else
+  include Tallyable::ActsAsTallyable
+end

data/lib/tallyable/employee_request.xml

@@ -0,0 +1,16 @@
+<ENVELOPE>
+  <HEADER>
+    <VERSION>1</VERSION>
+    <TALLYREQUEST>Export</TALLYREQUEST>
+    <TYPE>Data</TYPE>
+    <ID>All Employee Profile</ID>
+  </HEADER>
+  <BODY>
+    <DESC>
+      <STATICVARIABLES>
+        <EXPLODEFLAG>Yes</EXPLODEFLAG>
+        <SVEXPORTFORMAT>$$SysName:XML</SVEXPORTFORMAT>
+      </STATICVARIABLES>
+    </DESC>
+  </BODY>
+</ENVELOPE>

data/lib/tallyable/version.rb

@@ -0,0 +1,3 @@
+module Tallyable
+  VERSION = "0.0.2"
+end

data/test/acts_as_tallyable_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+require 'employee'
+
+class ActsAsTallyableTest < Minitest::Test
+  def employee_stub(stub_response)
+    stub_request(:post, "http://example.com:9002").
+      with( body: File.read("lib/tallyable/employee_request.xml") ).
+        to_return(stub_response)
+  end
+
+  def test_an_employee_tallyable_for_invalid_request
+    employee_stub(status: 500, body: "Internal Server Error", headers: {})
+
+    result = Employee.employee_request
+    assert_equal result, []
+  end
+
+  def test_an_employee_tallyable_on_a_valid_request
+    employee_stub(status: 200, 
+      body: File.read("test/fixtures/employee_response.xml"), headers: {})
+
+    result = Employee.employee_request
+    assert_equal result.count, 3
+  end
+
+  def test_an_employee_tallyable_response_on_a_valid_request
+    employee_stub(status: 200, 
+      body: File.read("test/fixtures/employee_response.xml"), headers: {})
+
+    result = Employee.employee_request
+    assert_equal result.first[:name], "test_employee_1"
+    assert_equal result.first[:email], "test_employee_1@example.com"
+    assert_equal result.first[:date_of_birth], '20-July-1970'
+    assert_equal result.first[:gender], "Male"
+    assert_equal result.first[:address], "Bangalore"
+    assert_equal result.first[:phone], "1234567890"
+  end
+end

data/test/employee.rb

@@ -0,0 +1,5 @@
+require 'tallyable/acts_as_tallyable'
+
+class Employee
+  acts_as_tallyable "http://example.com"
+end

data/test/fixtures/employee_response.xml

@@ -0,0 +1,31 @@
+<ENVELOPE>
+  <EMPPROFILESNO>1</EMPPROFILESNO>
+  <EMPPROFILENAME>test_employee_1</EMPPROFILENAME>
+  <SVCURRENTEMPLOYEE>
+    <EMPPROFILEEMAILID>test_employee_1@example.com</EMPPROFILEEMAILID>
+    <EMPPROFILEGENDER>Male</EMPPROFILEGENDER>
+    <EMPPROFILEEMPLOYEEADDRESS>Bangalore</EMPPROFILEEMPLOYEEADDRESS>
+    <EMPPROFILECONTACTNUMBER>1234567890</EMPPROFILECONTACTNUMBER>
+    <EMPPROFILEDATEOFBIRTH>20-July-1970</EMPPROFILEDATEOFBIRTH>
+  </SVCURRENTEMPLOYEE>
+
+  <EMPPROFILESNO>2</EMPPROFILESNO>
+  <EMPPROFILENAME>test_employee_2</EMPPROFILENAME>
+  <SVCURRENTEMPLOYEE>
+    <EMPPROFILEEMAILID>test_employee_2@example.com</EMPPROFILEEMAILID>
+    <EMPPROFILEGENDER>Female</EMPPROFILEGENDER>
+    <EMPPROFILEEMPLOYEEADDRESS>Mysore</EMPPROFILEEMPLOYEEADDRESS>
+    <EMPPROFILECONTACTNUMBER>1234567891</EMPPROFILECONTACTNUMBER>
+    <EMPPROFILEDATEOFBIRTH>20-July-1980</EMPPROFILEDATEOFBIRTH>
+  </SVCURRENTEMPLOYEE>
+
+  <EMPPROFILESNO>3</EMPPROFILESNO>
+  <EMPPROFILENAME>test_employee_3</EMPPROFILENAME>
+  <SVCURRENTEMPLOYEE>
+    <EMPPROFILEEMAILID>test_employee_3@example.com</EMPPROFILEEMAILID>
+    <EMPPROFILEGENDER>Male</EMPPROFILEGENDER>
+    <EMPPROFILEEMPLOYEEADDRESS>Belgaum</EMPPROFILEEMPLOYEEADDRESS>
+    <EMPPROFILECONTACTNUMBER>1234567892</EMPPROFILECONTACTNUMBER>
+    <EMPPROFILEDATEOFBIRTH>20-July-1990</EMPPROFILEDATEOFBIRTH>
+  </SVCURRENTEMPLOYEE>
+</ENVELOPE>

data/test/tallyable_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class TallyableTest < Minitest::Test
+  def test_truth
+    assert_kind_of Module, Tallyable
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'webmock/minitest'

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: tallyable
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Supreeth Burji
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-08 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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Proof of concept.
+email:
+- supreethjburji@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tallyable/employee_request.xml
+- lib/tallyable/acts_as_tallyable.rb
+- lib/tallyable/version.rb
+- lib/tallyable.rb
+- LICENSE.md
+- Rakefile
+- README.md
+- test/tallyable_test.rb
+- test/fixtures/employee_response.xml
+- test/test_helper.rb
+- test/employee.rb
+- test/acts_as_tallyable_test.rb
+homepage: https://github.com/sjburji/tallyable
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Tally ERP 0.9 integration using xml api
+test_files:
+- test/tallyable_test.rb
+- test/fixtures/employee_response.xml
+- test/test_helper.rb
+- test/employee.rb
+- test/acts_as_tallyable_test.rb