aria_sdk_unofficial 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e454fb1fa17335eac9885753778b4ce1eb2eef85
+  data.tar.gz: 7170aa70f4d0c1597318330d4b41feadd60de532
+SHA512:
+  metadata.gz: 0e2da8af2ee543b95c74de07f34386c304af9f5d1d69352e4cc5bdea7287e081c637a1b5896602513af129a2e8be2c7287c1257347d21723210f615526351c05
+  data.tar.gz: d2514e028e06abbf484a8bf697bd6bd1420be75539dcd2acfd50212065a8a44849e692cff23a928b43be8a82cfec6f5aef0bb584e890e4facb7d5e9772a3602b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aria_sdk_unofficial.gemspec
+gemspec

data/README.md

@@ -0,0 +1,97 @@
+# AriaSdkUnofficial
+
+This is an unofficial Aria SDK gem meant to be a bit simpler while also implementing all of the end points instead of a limited number of them.
+This product is issued with no warranty and is in no way any representation of Aria Systems.
+
+The official sdk can be found [here](https://github.com/AriaSystems/ruby_sdk).
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aria_sdk_unofficial'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install aria_sdk_unofficial
+
+## Usage
+
+To use this gem, instantiate the Aria object and use the call method to make an API call.
+
+To instaniate the Aria object, a dictionary with the following keys is passed in as the only argument:
+```ruby
+{
+	client_no: 123456, 
+	auth_key:'auth_key_here', 
+	api_type: 0, 
+	env_type: 1
+}
+```
+### Valid api types are as follows:
+* 0 = Core API
+* 1 = Object Query API
+* 2 = Admintools API
+
+### Valid environment types are as follows:
+* 0 = Stage Future
+* 1 = Stage Current
+* 2 = Production
+* 3 = Stage Future CPH
+* 4 = Production CPH
+
+**Note:** One optional parameter can be assed in named api_name.  This will be ignored, but is allowed.
+
+```ruby
+aria = Aria.new({client_no: 123456, auth_key:'nfjhfruiebire', api_type: 0, env_type: 0})
+```
+After instantiating the object, the client_no, auth_key, and url are all accessible
+
+```ruby
+puts aria.url
+```
+
+### To make and API call,  use the call method with the following parameters:
+
+```ruby
+{
+	api_name: set_session, 
+	options: {acct_no: 123456}, 
+	remove_nil: true
+}
+```
+
+options and remove_nil are both optional parameters.
+
+Options are the additional API parameters used.
+
+Removing nill will strip parameters with nil values from the options prior to sending to Aria.
+
+**Defaults:** remove_nil=false, options = {}
+
+```ruby
+aria = Aria.new({client_no: 123456, auth_key:'nfjhfruiebire', api_type: 0, env_type: 0})
+response = aria.call('authenticate_caller', {acct_no: 123456})
+puts response.['session_id']
+```
+
+### Admintools example
+```ruby
+aria = Aria.new({client_no: 123456, auth_key:'nfjhfruiebire', api_type: 2, env_type: 0})
+if response['error_code'] == 0
+	response['coa_list'].each do |coa|
+		puts "coa id #{coa['coa_id']}"
+		puts "coa code #{coa['coa_code']}"
+		puts "coa description #{coa['coa_description']}"
+	end
+else
+	puts "API call failed, error code #{response['error_msg']}"
+end
+```
+
+#### The response element is an [httparty](https://github.com/jnunemaker/httparty) response.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/aria_sdk_unofficial.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aria_sdk_unofficial/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aria_sdk_unofficial"
+  spec.version       = AriaSdkUnofficial::VERSION
+  spec.authors       = ["Austin Turner"]
+  spec.email         = ["paustint@gmail.com"]
+
+  spec.summary       = "Aria REST SDK based on the official Aria SDK located here: https://github.com/AriaSystems/ruby_sdk"
+  spec.description   = "Wrapper to connect to the Aria API's in an easy to use manner"
+  spec.homepage      = "https://github.com/paustint/aria_sdk_unofficial"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.13"
+  spec.add_dependency "json", "~> 1.8"
+
+  spec.add_development_dependency "rspec"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "aria_sdk_unofficial"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/aria_sdk_unofficial.rb

@@ -0,0 +1,54 @@
+require "aria_sdk_unofficial/version"
+require 'httparty'
+require 'json'
+
+class Aria
+
+  attr_accessor :client_no, :auth_key, :url
+
+  def initialize(client_no:, auth_key:, api_type:, env_type:, api_name: nil)
+        self.client_no = client_no
+        self.auth_key = auth_key
+        self.url = get_url api_type, env_type
+    end
+
+    def call(api_name, options = {}, remove_nil=false)
+
+        defaults = {
+            :output_format => 'json',
+            :client_no => self.client_no,
+            :auth_key => self.auth_key,
+            :rest_call => api_name
+        }
+
+        if remove_nil
+          options.keys.each { |x| options.delete x if options[x].nil? }
+        end
+
+        options.merge!(defaults)
+        HTTParty.post(self.url, :body => options)
+    end
+
+    def get_url(api_type, env_type)
+      env_url = ''
+      full_url = ''
+      if env_type == 0 # SF
+        env_url += '.future.stage'
+      elsif env_type == 1 # SC
+        env_url += '.current.stage'
+      elsif env_type == 3 # SF CPH
+        env_url += '.future.stage.cph'
+      elsif env_type == 4 # Prod CPH
+        env_url = '.cph'
+      end
+
+      if api_type == 0 # core
+        full_url = "https://secure#{env_url}.ariasystems.net/api/ws/api_ws_class_dispatcher.php"
+      elsif api_type == 1 # object
+        full_url = "https://secure#{env_url}.ariasystems.net/api/AriaQuery/objects.php"
+      else # admin
+        full_url = "https://admintools#{env_url}.ariasystems.net/AdminTools.php/Dispatcher"
+      end
+        return full_url
+    end
+end

data/lib/aria_sdk_unofficial/version.rb

@@ -0,0 +1,3 @@
+module AriaSdkUnofficial
+  VERSION = "1.0.0"
+end

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: aria_sdk_unofficial
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Austin Turner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper to connect to the Aria API's in an easy to use manner
+email:
+- paustint@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- aria_sdk_unofficial.gemspec
+- bin/console
+- bin/setup
+- lib/aria_sdk_unofficial.rb
+- lib/aria_sdk_unofficial/version.rb
+- tasks/rspec.rake
+homepage: https://github.com/paustint/aria_sdk_unofficial
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: 'Aria REST SDK based on the official Aria SDK located here: https://github.com/AriaSystems/ruby_sdk'
+test_files: []