opsource_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d712d0ada0a834e9dd720bd956e83f7982ce19d6
+  data.tar.gz: e82a84a1716dd37e43c8b689bd6f02a521a71314
+SHA512:
+  metadata.gz: a9f9bb74a08c8e27e0d2093b50e2c4e02cee5f9051d62c263723f35b764e7ca5d1a4da9698b4b6bfea871c46a7b6c5f51dbf273f10fcfe35ff99eda7638c18d1
+  data.tar.gz: f15b452f1b761fefc44fa28c8ed06f0b0519ca9babe284bebb85b4758b2e505a4fcf2cfba5692beec43ea3d15fa39ae2cf421b41cc4944ef5763ac576be8d0ae

data/Gemfile

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

data/README.md

@@ -0,0 +1,43 @@
+## ruby-opsource
+=============
+
+(WORK IN PROGRESS ...)
+
+Ruby client for Opsource cloud's REST API. Opsource cloud is formally Dimension Data now.
+
+0. API spec - https://github.com/udayakiran/opsource_client/raw/master/doc/Cloud-REST-API-v09-032113.pdf
+
+0. API details - http://cloud.dimensiondata.com/saas-solutions/services/public-cloud/api
+
+To use it as a gem -
+
+     gem 'opsource_client', git: 'https://github.com/udayakiran/opsource_client.git'
+
+To use it as a rails plugin -
+
+     git clone https://github.com/udayakiran/opsource_client.git
+
+     copy opsource_client to vendors/plugins
+
+## Configuration -
+
+This is a one time configuration where you specify your opsource account's organization id,
+username and password of the admin account using which API calls need to be made.
+
+    client = OpsourceClient::Client.new
+    client.organization_id = organization_id
+    client.admin_username =  admin_username
+    client.admin_password =  admin_password
+  
+
+## Sample API call -
+
+To create a NAT rule
+
+    opc = OpsourceClient::Client.new
+
+    # ...
+
+    opc.create_natrule({:net_id => network_id, :sourceIp => private_ip, :name => private_ip})
+
+

data/Rakefile

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

data/lib/opsource_client/client.rb

@@ -0,0 +1,105 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'xmlsimple'
+require 'cgi'
+require 'singleton'
+require 'active_support'
+
+module OpsourceClient
+  class Client
+
+    API_ENDPOINT = "https://api.opsourcecloud.net/oec/0.9/"
+    
+    attr_accessor :api_endpoint, :organization_id, :admin_username, :admin_password
+
+    def initialize
+      self.api_endpoint = API_ENDPOINT
+      self.organization_id = '123456'
+      self.admin_username    = 'USER'
+      self.admin_password    = 'PWD'
+    end
+
+    def api_base_url
+      "#{api_endpoint}/#{@org_id}"
+    end
+
+    protected
+
+    def request(type, endpoint, body = nil)
+      begin
+        uri = URI.parse(api_base_url + endpoint)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+
+        # construct the call data and access token
+        req = Net::HTTP.const_get(type.to_s.camelize).new(uri.request_uri, initheader = {'Content-Type' =>'application/json', 'User-Agent' => 'WePay Ruby SDK'})
+        req.content_type = "text/xml" if body
+        req.body = body if body
+        req.basic_auth @username, @password
+        response = http.request(req)
+
+      rescue TimeoutError => error
+        raise OpsourceClient::Exceptions::ConnectionError.new("Timeout error. Invalid Api URL or Opsource server is probably down: \"#{@url}\"")
+      rescue  SocketError, Errno::ECONNREFUSED => se
+        raise OpsourceClient::Exceptions::ConnectionError.new("Socket error. Could not connect to Opsource server.")
+      end
+      
+      response
+    end
+
+    def post(endpoint, request_xml = nil)
+      res = request(:post, endpoint, request_xml)
+      handle_response res
+    end
+
+    def get(endpoint, request_xml = nil)
+      res = request(:get, endpoint, request_xml)
+      handle_response res
+    end
+
+    def handle_response(response)
+      begin
+        h = symbolize_response(response.body)
+      rescue OpsourceClient::Exceptions::RequestError => e
+        raise OpsourceClient::Exceptions::ApiError.new("Received an Invalid Response. This might mean you sent an invalid request or Opsource is having issues.")
+      rescue => e
+        raise OpsourceClient::Exceptions::ApiError.new("There was an error while trying to connect to Opsource - #{e.inspect}")
+      end
+      h
+    end
+
+    def symbolize_response(response)
+      begin
+        # we'll not use 'KeyToSymbol' because it doesn't symbolize the keys for node attributes
+        opts = { 'ForceArray' => false, 'ForceContent' => false } #
+        hash = XmlSimple.xml_in(response, opts)
+        hash.delete_if {|k, v| k =~ /(xmlns|xmlns:ns)/ } #removing the namespaces from response
+        return symbolize_keys(hash)
+      rescue Exception => e
+        raise OpsourceClient::Exceptions::RequestError.new("Impossible to convert XML to hash. Error: #{e.message}")
+      end
+    end
+
+    def symbolize_keys(arg)
+      case arg
+      when Array
+        arg.map {  |elem| symbolize_keys elem }
+      when Hash
+        Hash[
+          arg.map {  |key, value|
+            k = key.is_a?(String) ? key.to_sym : key
+            v = symbolize_keys value
+            [k,v]
+          }]
+      else
+        arg
+      end
+    end
+
+    def xml_header
+      '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'
+    end
+
+  end
+end

data/lib/opsource_client/exceptions.rb

@@ -0,0 +1,14 @@
+module OpsourceClient
+  module Exceptions
+    CODES = {
+      "REASON_10" => "Failure at network",
+      "REASON_20" => "Unrecoverable failure cause by a timeout.",
+      "REASON_250" => "Network does not exist for this organization.",
+      "REASON_320" => "Invalid Input Data - SourceIP must be a valid IPv4 address."
+    }
+    
+    class ApiError < StandardError; end
+    class ConnectionError < StandardError; end
+    class RequestError < StandardError; end
+  end
+end

data/lib/opsource_client/network/natrule.rb

@@ -0,0 +1,28 @@
+module OpsourceClient
+  class Client
+    
+      def all_natrules(params)
+        req_params = {:net_id => ''}.merge(params)
+        self.get("/network/#{req_params[:net_id]}/natrule", nil)
+      end
+
+      def create_natrule(params)
+        req_params = {:net_id => '', :sourceIp => '', :name => ''}.merge(params)
+        self.post("/network/#{req_params[:net_id]}/natrule", create_natrule_request_xml(req_params))
+      end
+
+      def delete(params)
+        req_params = {:net_id => '', :natrule_id => ''}.merge(params)
+        self.get("/network/#{req_params[:net_id]}/natrule/#{req_params[:natrule_id]}?delete", nil)
+      end
+
+      def create_natrule_request_xml(params)
+        xml = xml_header
+        xml += '<NatRule xmlns="http://oec.api.opsource.net/schemas/network">'
+        xml += "<name>#{params[:name]}</name> <sourceIp>#{params[:sourceIp]}</sourceIp>"
+        xml += "</NatRule>"
+        xml
+      end
+      
+    end
+end

data/lib/opsource_client/version.rb

@@ -0,0 +1,22 @@
+module OpsourceClient
+  VERSION = "0.0.1"
+
+  {"xmlns:ns3"=>"http://oec.api.opsource.net/schemas/organization",
+    "xmlns:ns4"=>"http://oec.api.opsource.net/schemas/network",
+    "xmlns:ns2"=>"http://oec.api.opsource.net/schemas/directory",
+    "xmlns:ns8"=>"http://oec.api.opsource.net/schemas/general",
+    "xmlns:ns7"=>"http://oec.api.opsource.net/schemas/datacenter",
+    "xmlns:ns6"=>"http://oec.api.opsource.net/schemas/whitelabel",
+    "xmlns:ns5"=>"http://oec.api.opsource.net/schemas/vip",
+    "xmlns:ns9"=>"http://oec.api.opsource.net/schemas/admin",
+    "natIp"=>["207.20.54.2"],
+    "xmlns"=>"http://oec.api.opsource.net/schemas/server",
+    "sourceIp"=>["10.166.152.201"],
+    "id"=>["ac371318-f755-4dc1-bbc3-51a1522ca2fe"],
+    "name"=>["10.166.152.201"],
+    "xmlns:ns11"=>"http://oec.api.opsource.net/schemas/reset",
+    "xmlns:ns10"=>"http://oec.api.opsource.net/schemas/multigeo",
+    "xmlns:ns13"=>"http://oec.api.opsource.net/schemas/storage",
+    "xmlns:ns12"=>"http://oec.api.opsource.net/schemas/support",
+    "xmlns:ns14"=>"http://oec.api.opsource.net/schemas/manualimport"}
+end

data/lib/opsource_client.rb

@@ -0,0 +1,4 @@
+require 'opsource_client/version'
+require 'opsource_client/client'
+require 'opsource_client/network/natrule'
+require 'opsource_client/exceptions'

data/opsource_client.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "opsource_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "opsource_client"
+  s.version     = OpsourceClient::VERSION
+  s.authors     = ["Udaya Kiran"]
+  s.email       = ["udaykiran.vit@gmail.com"]
+  s.licenses    = ['MIT']
+  s.summary     = %q{Opsource REST API client gem}
+  s.description = %q{Simple wrapper to access opsource cloud's api'}
+
+  s.rubyforge_project = "opsource_client"
+  s.homepage = "https://github.com/udayakiran/opsource_client"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'xml-simple', '~> 1'
+  s.add_development_dependency 'rspec', '~> 0'
+  s.add_dependency "activesupport", ">= 2"
+end

data/spec/lib/opsource_client/client_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe OpsourceClient::Client do
+
+  it "should be configurable" do
+     client = OpsourceClient::Client.new
+     client.api_endpoint.should == "https://api.opsourcecloud.net/oec/0.9/"
+
+     client.api_endpoint = "http://google.com/"
+     client.api_endpoint.should == "http://google.com/"
+
+     client.admin_username = "hi"
+     client.admin_username.should == "hi"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+
+Bundler.require :default, :test
+spec_root = File.expand_path(File.dirname(__FILE__))
+
+
+$: << spec_root
+
+require File.join(File.dirname(__FILE__), '..', 'lib','opsource_client')
+
+Dir[File.join(spec_root, "support/*.rb")].each { |f| require f }
+
+RSpec.configure do |config|
+  config.expect_with :rspec, :stdlib
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: opsource_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Udaya Kiran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Simple wrapper to access opsource cloud's api'
+email:
+- udaykiran.vit@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- doc/Cloud-REST-API-v09-032113.pdf
+- lib/opsource_client.rb
+- lib/opsource_client/client.rb
+- lib/opsource_client/exceptions.rb
+- lib/opsource_client/network/natrule.rb
+- lib/opsource_client/version.rb
+- opsource_client.gemspec
+- spec/lib/opsource_client/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/udayakiran/opsource_client
+licenses:
+- MIT
+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: opsource_client
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Opsource REST API client gem
+test_files: []