gotransverse-tract-api 0.0.1

data/.ruby-gemset

@@ -0,0 +1 @@
+gotransverse-tract-api

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.3

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem "httpclient"
+gem "nokogiri"
+
+# Specify your gem's dependencies in gotransverse-tract-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Julien DeFrance
+
+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,79 @@
+# GoTransverseTractApi Ruby Gem
+
+A ruby gem allowing developers to integrate with GoTransverse's TRACT API.
+
+Current supported version is 1.19 REST API (XML)
+http://devdoc.gotransverse.com.php53-14.ord1-1.websitetestlink.com/Developer-Guides/TRACT-API-1.19/API-1.19-REST-Mount-Points
+
+For more details, please refer to GoTransverse's TRACT API Documentation available at:
+http://devdoc.gotransverse.com.php53-14.ord1-1.websitetestlink.com/Developer-Guide
+
+
+## Disclaimer
+
+While we are all gladly contributing to the community...
+
+This gem is unofficial, may contain bugs, and its use is at your own risk.
+None of the project owners, developers, contributors may be held accountable for any defect or disaster resulting of the use of this gem.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gotransverse-tract-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gotransverse-tract-api
+
+
+## Configuration
+
+From the application utilizing the gem, create a gotransverse-tract-api.rb file to your config/initializers folder, with content:
+
+```
+#!ruby
+GoTransverseTractApi.configure do |config|
+  config.user_id = <gotransverse_tract_user_id>
+  config.password = <gotransverse_tract_password>
+end
+```
+
+
+## Usage
+
+```
+#!ruby
+GoTransverseTractApi::BillingAccount::Invoice.find_by_eid(<eid>)
+```
+
+## Version History & Changelog
+
+Visit https://rubygems.org/gems/gotransverse-tract-api
+
+
+## Roadmap
+
+Nov 2015: Initial Release, basic REST/XML API Support
+Dec 2015: PCI-Compliant Hosted Payment Page URL Support
+Q1 2016: Automated Test Coverage
+Q2 2016: REST/JSON API Support
+
+
+## Contributing
+
+Help and advice is gladly appreciated! :)
+Feel free to contribute and be part of this project, helping the community staying on top of any new API version release.
+
+Please keep version number increments under control :)
+
+1. Fork it ( https://github.com/[my-github-username]/gotransverse-tract-api/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/gotransverse-tract-api.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gotransverse-tract-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gotransverse-tract-api"
+  spec.version       = GoTransverseTractApi::VERSION
+  spec.authors       = ["Julien DeFrance"]
+  spec.email         = ["jdefrance@smartzip.com"]
+  spec.summary       = "A ruby gem allowing developers to integrate with GoTransverse's TRACT API."
+  spec.description   = "TRACT is a billing engine edited by GoTransverse that supports various revenue models like one-time purchases, simple subscriptions, and more complex, usage-based models."
+  spec.homepage      = "https://rubygems.org/gems/gotransverse-tract-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency 'httpclient'
+  spec.add_runtime_dependency 'nokogiri'
+end

data/lib/gotransverse-tract-api.rb

@@ -0,0 +1,181 @@
+require "gotransverse-tract-api/version"
+require "gotransverse-tract-api/configuration"
+
+require "gotransverse-tract-api/billing_account/adjustment"
+require "gotransverse-tract-api/billing_account/adjustment_reason"
+require "gotransverse-tract-api/billing_account/billing_account"
+require "gotransverse-tract-api/billing_account/custom_field"
+require "gotransverse-tract-api/billing_account/custom_field_value"
+require "gotransverse-tract-api/billing_account/invoice"
+require "gotransverse-tract-api/billing_account/invoice_item"
+require "gotransverse-tract-api/billing_account/invoice_item_charge"
+require "gotransverse-tract-api/billing_account/payment"
+require "gotransverse-tract-api/billing_account/reason"
+require "gotransverse-tract-api/billing_account/recurring_payment"
+require "gotransverse-tract-api/billing_account/refund"
+require "gotransverse-tract-api/billing_account/scheduled_charge"
+
+require "gotransverse-tract-api/general/system_setting"
+
+require "gotransverse-tract-api/general_ledger/gl_account"
+require "gotransverse-tract-api/general_ledger/gl_account_category"
+require "gotransverse-tract-api/general_ledger/gl_accounting_entry"
+require "gotransverse-tract-api/general_ledger/gl_aggregate_batch"
+require "gotransverse-tract-api/general_ledger/gl_aggregate_entry"
+
+require "gotransverse-tract-api/order/agreement"
+require "gotransverse-tract-api/order/bill_cycle"
+require "gotransverse-tract-api/order/billing_account_category"
+require "gotransverse-tract-api/order/order_item"
+require "gotransverse-tract-api/order/order_item_charge"
+require "gotransverse-tract-api/order/organization"
+require "gotransverse-tract-api/order/party_category"
+require "gotransverse-tract-api/order/person"
+require "gotransverse-tract-api/order/product_relation"
+require "gotransverse-tract-api/order/renewal_order"
+require "gotransverse-tract-api/order/sales_order"
+
+require "gotransverse-tract-api/product/action"
+require "gotransverse-tract-api/product/operation"
+require "gotransverse-tract-api/product/price_list"
+require "gotransverse-tract-api/product/price_range"
+require "gotransverse-tract-api/product/product"
+require "gotransverse-tract-api/product/product_category"
+require "gotransverse-tract-api/product/product_price"
+require "gotransverse-tract-api/product/usage_rule"
+
+require "gotransverse-tract-api/service/service"
+require "gotransverse-tract-api/service/service_device_inventory_item"
+require "gotransverse-tract-api/service/service_period"
+require "gotransverse-tract-api/service/service_price"
+require "gotransverse-tract-api/service/service_price_range"
+require "gotransverse-tract-api/service/service_resource"
+require "gotransverse-tract-api/service/service_resource_category"
+
+require "gotransverse-tract-api/usage/order_item_usage_rule"
+require "gotransverse-tract-api/usage/product_usage_rule"
+require "gotransverse-tract-api/usage/rate_table"
+require "gotransverse-tract-api/usage/service_usage_rule"
+require "gotransverse-tract-api/usage/usage_event"
+require "gotransverse-tract-api/usage/usage_lookup_table"
+require "gotransverse-tract-api/usage/usage_lookup_table_entry"
+require "gotransverse-tract-api/usage/usage_rule"
+
+require "httpclient"
+require "nokogiri"
+
+module GoTransverseTractApi
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  #
+  # self.configure
+  #
+  # Call this method to modify defaults in your initializers.
+  # Yields SmartZipSDK configuration
+  #
+  # Examples:
+  #
+  #  GoTransverseTractApi.configure do |config|
+  #    config.user_id = <gotransverse_tract_user_id>
+  #    config.password = <gotransverse_tract_password>
+  #  end
+  #
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  #
+  # self.get_api_url_for
+  #
+  # @param {Class} klass
+  #
+  def self.get_api_url_for klass
+    "#{GoTransverseTractApi.configuration.tract_api_url}/#{klass.classname.camelize(:lower).pluralize}"
+  end
+
+  #
+  # self.get_response_from
+  #
+  # @param {String} api_url
+  # @param {Hash} api_params
+  # @param {Hash} headers (optional)
+  #
+  def self.get_response_from(api_url, api_params, headers={})
+
+    if GoTransverseTractApi.configuration.cache_enabled
+      return self.get_cached_response_from(api_url, api_params, headers)
+    end
+
+    # Unless cached
+    self.call(api_url, api_params, headers, :get)
+  end
+
+  #
+  # self.post_request_to
+  #
+  # @param {String} api_url
+  # @param {Hash} api_params
+  # @param {Hash} headers (optional)
+  #
+  def self.post_request_to(api_url, api_params, headers={})
+    self.call(api_url, api_params, headers, :post)
+  end
+
+  #
+  # self.put_request_to
+  #
+  # @param {String} api_url
+  # @param {Hash} api_params
+  # @param {Hash} headers (optional)
+  #
+  def self.put_request_to(api_url, api_params, headers={})
+    self.call(api_url, api_params, headers, :put)
+  end
+
+  private
+
+  #
+  # self.get_cached_response_from
+  #
+  # @param {String} api_url
+  # @param {Hash} api_params
+  # @param {Hash} headers (optional)
+  #
+  def self.get_cached_response_from(api_url, api_params, headers={})
+    key = "#{api_url}.#{api_params.sort}"
+
+    return Rails.cache.fetch(key, expires_in: 10.minutes) do
+      self.get_response_from(api_url, api_params, headers)
+    end
+
+    return self.get_response_from(api_url, api_params, headers)
+  end
+
+  #
+  # self.call
+  #
+  # @param {String} api_url
+  # @param {Hash} api_params
+  # @param {Hash} headers (optional)
+  # @param {String} method (optional)
+  #
+  def self.call(api_url, api_params, headers={}, method=:get)
+
+    http_client = HTTPClient.new
+    case method
+      when :get
+        response = http_client.get(api_url, api_params, headers)
+      when :post
+        response = http_client.post(api_url, api_params, headers)
+      when :put
+        response = http_client.put(api_url, api_params, headers)
+    end
+
+    Nokogiri::XML(response.body.to_s)
+  end
+
+end

data/lib/gotransverse-tract-api/billing_account/adjustment.rb

@@ -0,0 +1,11 @@
+module GoTransverseTractApi
+
+  module BillingAccount
+
+    class Adjustment
+
+    end
+
+  end
+
+end

data/lib/gotransverse-tract-api/billing_account/adjustment_reason.rb

@@ -0,0 +1,11 @@
+module GoTransverseTractApi
+
+  module BillingAccount
+
+    class AdjustmentReason
+
+    end
+
+  end
+
+end

data/lib/gotransverse-tract-api/billing_account/billing_account.rb

@@ -0,0 +1,11 @@
+module GoTransverseTractApi
+
+  module BillingAccount
+
+    class BillingAccount
+
+    end
+
+  end
+
+end

data/lib/gotransverse-tract-api/billing_account/custom_field.rb

@@ -0,0 +1,11 @@
+module GoTransverseTractApi
+
+  module BillingAccount
+
+    class CustomField
+
+    end
+
+  end
+
+end

data/lib/gotransverse-tract-api/billing_account/custom_field_value.rb

@@ -0,0 +1,11 @@
+module GoTransverseTractApi
+
+  module BillingAccount
+
+    class CustomFieldValue
+
+    end
+
+  end
+
+end

data/lib/gotransverse-tract-api/billing_account/invoice.rb

@@ -0,0 +1,11 @@
+module GoTransverseTractApi
+
+  module BillingAccount
+
+    class Invoice
+
+    end
+
+  end
+
+end

data/lib/gotransverse-tract-api/billing_account/invoice_item.rb

@@ -0,0 +1,11 @@
+module GoTransverseTractApi
+
+  module BillingAccount
+
+    class InvoiceItem
+
+    end
+
+  end
+
+end

data/lib/gotransverse-tract-api/billing_account/invoice_item_charge.rb

@@ -0,0 +1,11 @@
+module GoTransverseTractApi
+
+  module BillingAccount
+
+    class InvoiceItemCharge
+
+    end
+
+  end
+
+end

data/lib/gotransverse-tract-api/billing_account/payment.rb

@@ -0,0 +1,11 @@
+module GoTransverseTractApi
+
+  module BillingAccount
+
+    class Payment
+
+    end
+
+  end
+
+end